nz_serUSB.h

Go to the documentation of this file.

#ifndef NZ_USB_BUFFERED_H
#define    NZ_USB_BUFFERED_H

//"Serial Data Port" contain circular buffers, this include is required
#include "nz_circularBuffer.h"

#if defined(HAS_SERPORT_USB)

#if !defined(SERPORT_USB_CREATE_OWN_CIRBUFS)
#include "nz_serDataPorts.h"
#endif


#if !defined(USB_CONTROLS_SYSLED)
#define USB_CONTROLS_SYSLED     0
#endif

#if !defined(USB_TXBUF_SIZE)
#define USB_TXBUF_SIZE 256
#endif

#if !defined(USB_RXBUF_SIZE)
#define USB_RXBUF_SIZE 32
#endif

//TX and RX "Circular Buffers". Use SERPORT_USB_CREATE_OWN_CIRBUFS define to use this
//module without SERPORTs. If NOT defined, this modules requires nz_serDataPorts.c
#if defined(SERPORT_USB_CREATE_OWN_CIRBUFS)
    //This is used by others
    #ifndef THIS_IS_NZ_SER_USB_C
    #if !defined(CIRBUF_TX_USB)
        extern CIRBUF cbufTxUsb;
        #define CIRBUF_TX_USB  (&cbufTxUsb)
    #endif

    #if !defined(CIRBUF_RX_USB)
        extern CIRBUF cbufRxUsb;
        #define CIRBUF_RX_USB  (&cbufRxUsb)
    #endif
    #endif  //#ifndef THIS_IS_NZ_SER_USB_C
#endif


//Defines

//USB "Serial Data Port"
#if defined(NZ_USBHID_ENABLE) && !defined(HAS_SERPORT_USB_HID)
    #define HAS_SERPORT_USB_HID
#endif
#if defined(NZ_USBCDC_ENABLE) && !defined(HAS_SERPORT_USB_CDC)
    #define HAS_SERPORT_USB_CDC
#endif
#if defined(NZ_USBMIDI_ENABLE) && !defined(HAS_SERPORT_USB_MIDI)
    #define HAS_SERPORT_USB_MIDI
#endif
#if defined(HAS_SERPORT_USB_HID) || defined(HAS_SERPORT_USB_CDC) || defined(HAS_SERPORT_USB_MIDI)
    #if !defined(HAS_A_SERPORT)
        #define HAS_A_SERPORT
    #endif
#endif



//If "Power of 2" buffer used, size must by a power of 2
#if defined(CIRBUF_USE_CIRCULAR_BUFFER_PWR2)
#if defined(HAS_SERPORT_USB)
    //Ensure size is power of 2
    #if ((USB_TXBUF_SIZE & ~(USB_TXBUF_SIZE-1))!=USB_TXBUF_SIZE)
    #error "USB USB_TXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif

    //Ensure size is power of 2
    #if ((USB_RXBUF_SIZE & ~(USB_RXBUF_SIZE-1))!=USB_RXBUF_SIZE)
    #error "USB USB_RXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif
#endif
#endif


void serUSBTask(void);


void serUSBInit(void);


void usbCBSendResume(void);


/*
#define serUSBEmptyTxBuf()              cbufEmpty(&cbufTxUsb)
#define serUSBIsTxBufEmpty()            cbufIsEmpty(&cbufTxUsb)
#define serUSBIsTxBufFull()             cbufIsFull(&cbufTxUsb)
#define serUSBGetTxBufCount()           cbufGetCount(&cbufTxUsb)
#define serUSBGetTxBufFree()            cbufGetFree(&cbufTxUsb)
#define serUSBPeekTxBuf()               cbufPeekByte(&cbufTxUsb)
#define serUSBPeekTxBufAt(offset)       cbufPeekByteAt(&cbufTxUsb, offset)
#define serUSBTxBufRemoveByte()         cbufRemoveByte(&cbufTxUsb)
#define serUSBTxBufRemoveBytes(n)       cbufRemoveBytes(&cbufTxUsb, n)
*/


BOOL serUSBIsSuspended(void);


#define serUSBEmptyTxBuf() cbufEmpty(&serports.usb.cbufTx)


#define serUSBIsTxBufEmpty()  cbufIsEmpty(&serports.usb.cbufTx)


#define serUSBIsTxBufFull() cbufIsFull(&serports.usb.cbufTx)

#endif  //#if defined(HAS_SERPORT_USB)

#endif  //#ifndef NZ_USB_BUFFERED_H