csl_cdc.h

Go to the documentation of this file.

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005, 2008, 2011
 *
 *   Use of this software is controlled by the terms and conditions found in the
 *   license agreement under which this software has been supplied.
 *  ============================================================================
 */

/* ============================================================================
 * Revision History
 * ================
 * 02-May-2011 Created
 * ============================================================================
 */

#ifndef _CSL_CDC_H_
#define _CSL_CDC_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <cslr.h>
#include <csl_error.h>
#include <csl_types.h>
#include <cslr_usb.h>
#include <csl_usb.h>
#include <soc.h>
#include <csl_general.h>


/*****************************************************************************\
          USB CDC global macro declarations                                   *
\*****************************************************************************/
#define CSL_CDC_PORT_MAX                                1
#define CSL_CDC_NO_ENDPTOBJECT                          8

#define CSL_CDC_ERROR_BASE                             (CSL_EUSB_FIRST)

#define CSL_CDC_INVALID_REQUEST_HANDLER                (CSL_CDC_ERROR_BASE - 1)

#define CSL_CDC_INTR_IN_EP                                  CSL_USB_EP1
#define CSL_CDC_BULK_OUT_EP                                 CSL_USB_EP2
#define CSL_CDC_BULK_IN_EP                                  CSL_USB_EP3

#define CSL_USB_CDC_DATA_BUF_SIZE                           512

#define CSL_CDC_REQUEST_SEND_ENCAPSULATED_COMMAND           (0x2100)

#define CSL_CDC_REQUEST_GET_ENCAPSULATED_RESPONSE           (0xA101)

#define CSL_CDC_REQUEST_SET_COMM_FEATURE                    (0x2102)

#define CSL_CDC_REQUEST_GET_COMM_FEATURE                    (0xA103)
//** Host clears the settings for a particular communication feature.  */
#define CSL_CDC_REQUEST_CLEAR_COMM_FEATURE                  (0x2104)

#define CSL_CDC_REQUEST_SET_LINE_CODING                     (0x2120)

#define CSL_CDC_REQUEST_GET_LINE_CODING                     (0xA121)

#define CSL_CDC_REQUEST_SET_CONTROL_LINE_STATE              (0x2122)
//** Sends special carrier modulation used to specify RS-232 style break    */
#define CSL_CDC_REQUEST_SEND_BREAK                          (0x2123)

#define CSL_CDC_REQUEST_ARGS     CSL_UsbDevNum         devNum,           \
                                 CSL_UsbSetupStruct    *usbSetup,        \
                                 pUsbEpHandle          hInEp,            \
                                 pUsbEpHandle          hOutEp,           \
                                 void                  *pCdc

/**************************************************************************\
* USB CDC global typedef declarations                                      *
\**************************************************************************/

typedef enum {
    /* Don't call request again until new SETUP                              */
    CSL_CDC_REQUEST_DONE = 0,
    /* STALL the control endpoint                                            */
    CSL_CDC_REQUEST_STALL,
    /* Send a 0 length IN packet                                             */
    CSL_CDC_REQUEST_SEND_ACK,
    /* Prepare to receive 0 length OUT packet                                */
    CSL_CDC_REQUEST_GET_ACK,
    /* Notify handler when IN data has been transmitted                      */
    CSL_CDC_REQUEST_DATA_IN,
    /* Notify handler when OUT data has been received                        */
    CSL_CDC_REQUEST_DATA_OUT
} CSL_CdcRequestRet;

typedef enum {
    CSL_CDC_MEDIACCESS_OVERFLOW,
    CSL_CDC_MEDIACCESS_SUCCESS,
    CSL_CDC_MEDIACCESS_NOTPRESENT,
    CSL_CDC_MEDIACCESS_WRITEPROTECT,
    CSL_CDC_MEDIACCESS_BADMEDIA
} CSL_CdcMediaStatus;

/**************************************************************************\
* USB CDC global data structure declarations                               *
\**************************************************************************/

typedef struct {
    Uint32 dwBaudRate;
    Uint16 wCharFormat;
    Uint16 wParityType;
    Uint16 wDataBits;
} CSL_CdcLineCoding;

typedef struct CSL_CdcInitStructApp {
    void                    *pCdcObj;
    Uint16                  pId;
    Uint16                  vId;
    Uint16                  *rxBufferPtr;
    Uint16                  rxStartIdx;
    Uint16                  rxEndIdx;
    Uint16                  *txBufferPtr;
    Uint16                  txStartIdx;
    Uint16                  txEndIdx;
    Uint16                  *txWorkBufPtr;
    Uint16                  txWorkBufIdx;
    void                    (*bulkHandler)();
    void                    (*ctrlHandler)();
    void                    (*intrHandler)();
    void                    (*bulkInCallback)();
    void                    (*bulkOutCallback)();
    void                    (*intrInCallback)();
} CSL_CdcInitStructApp;

typedef CSL_CdcInitStructApp  *pCdcAppClassHandle;

typedef  CSL_CdcRequestRet (*fpCDC_REQ_HANDLER)(CSL_CDC_REQUEST_ARGS);

typedef struct CSL_CdcObject {
    Uint16                *lbaBuffer;
    Uint16                activityPresentFlag;
    CSL_UsbEpObj          bulkInEpObj;
    CSL_UsbEpObj          bulkOutEpObj;
    CSL_UsbEpObj          intrInEpObj;
    CSL_UsbEpObj          intrOutEpObj;
    CSL_CdcLineCoding   lineCoding;
    Uint16              controlLineState;
} CSL_CdcObject;

typedef struct CSL_CdcCtrlObject {
    CSL_UsbEpObj             ctrlInEpObj;
    CSL_UsbDevNum            devNum;
    CSL_UsbEpObj             ctrlOutEpObj;
    Uint16                   suspendFlag;
    pUsbEpHandle             hEpObjArray[CSL_USB_ENDPOINT_COUNT];
    CSL_UsbSetupStruct       usbSetup;
    Uint16                   curConfigStat;
    Bool                     usbSpeedCfg;
} CSL_CdcCtrlObject;

typedef struct CSL_CdcClassStruct {
    CSL_CdcCtrlObject    ctrlHandle;
    CSL_CdcObject        cdcHandle;
} CSL_CdcClassStruct;

typedef CSL_CdcClassStruct  *pCdcClassHandle;

extern CSL_UsbContext     gUsbContext;
extern CSL_UsbRegsOvly    usbRegisters;

/**************************************************************************\
* USB CDC function declarations                                            *
\**************************************************************************/

CSL_Status CDC_Open(pCdcAppClassHandle    pAppClassHandle);

CSL_Status CDC_OpenFullspeed(pCdcAppClassHandle    pAppClassHandle);

static CSL_Status CDC_Setup(pCdcAppClassHandle    pAppClassHandle,
                            Bool                  usbSpeedCfg);

CSL_Status CDC_Close(pCdcAppClassHandle    pAppClassHandle);

Uint16 CDC_GetactivityFlagStatus(void    *pCDC);

Uint16 CDC_GetsuspendFlagStatus(void    *pCDC);

CSL_CdcRequestRet CDC_eventHandler(pUsbContext pContext, CSL_CdcClassStruct *hCdcClass);

CSL_Status CDC_bulkOutHandler(pUsbContext pContext, CSL_CdcInitStructApp *cdcAppHandle);


CSL_Status CDC_bulkInHandler(pUsbContext pContext, CSL_CdcInitStructApp *cdcAppHandle);

 Uint16 CDC_getData(pUsbContext pContext, CSL_CdcInitStructApp *cdcAppHandle, Uint16 *data);

Uint16 CDC_putData(pUsbContext pContext, CSL_CdcInitStructApp *cdcAppHandle, Uint16 *data, Uint16 size);

#ifdef __cplusplus
}
#endif

#endif    //_CSL_CDC_H_