csl_audioClass.h

Go to the documentation of this file.

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005, 2008
 *
 *   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
 * ================
 * 10-Dec-2008 Created
 * 21-Jan-2009 Modified for code review comments
 * ============================================================================
 */

#ifndef _CSL_AUDIOCLASS_H_
#define _CSL_AUDIOCLASS_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 AC global macro declarations                                    *
\*****************************************************************************/
#define CSL_AC_DEVICE_DESCRIPTOR_TYPE                         (0x01)

#define CSL_AC_CONFIGURATION_DESCRIPTOR_TYPE                  (0x02)

#define CSL_AC_STRING_DESCRIPTOR_TYPE                         (0x03)

#define CSL_AC_INTERFACE_DESCRIPTOR_TYPE                      (0x04)

#define CSL_AC_ENDPOINT_DESCRIPTOR_TYPE                       (0x05)

#define CSL_AC_POWER_DESCRIPTOR_TYPE                          (0x06)

#define CSL_AC_HID_DESCRIPTOR_TYPE                            (0x21)

#define CSL_AC_FEATURE_ENDPOINT_STALL                         (0x0000)

#define CSL_AC_FEATURE_REMOTE_WAKEUP                          (0x0001)

#define CSL_AC_DEVICE_DESCR_MAX_LEN                           (20)

#define CSL_AC_DEV_QUAL_DESCR_MAX_LEN                         (12)

#define CSL_AC_CONFIG_DESCR_MAX_LEN                           (124)

#define CSL_AC_INTER_DESCR_MAX_LEN                            (12)

#define CSL_AC_STRING_DESCR_LANGID_MAX_LEN                    (12)

#define CSL_AC_AUDIO_TYPE_MONO                                (0x01)

#define CSL_AC_AUDIO_TYPE_STEREO                              (0x02)

#define CSL_AC_VERIFY_PASSED                                  (0x0)

#define CSL_AC_VERIFY_FAILED                                  (0x1)

#define CSL_AC_UNIT_REMOVEABLE                                (0x1)

#define CSL_AC_CURRDEV_STAT                                   (0x01)

#define CSL_AC_CURRINTRF_STAT                                 (0x00)

#define CSL_AC_NO_ENDPTOBJECT                                 (5)

#define CSL_AC_DEVDESC_LEN                                    (10)

#define CSL_AC_CONFDESC_LEN                                   (6)

#define CSL_AC_MS_INTDESC_LEN                                 (6)

#define CSL_AC_MS_ISOOUT_ENDPTDESC_LEN                        (5)

#define CSL_AC_MS_ISOIN_ENDPTDESC_LEN                         (5)

#define CSL_AC_STRDESC_LANGID_LEN                             (4)

#define CSL_AC_SCSI_INQUIRY_LEN                               (50)

#define CSL_AC_SENSEDATA_LEN                                  (15)

#define CSL_AC_LUN_MAX                                        (4)

#define CSL_AC_CBWSIZE                                        (17)

#define CSL_AC_CSWSIZE                                        (8)

#define CSL_AC_READCAP                                        (6)

#define CSL_AC_CTRLBUFF_LEN                                   (5)

#define CSL_AC_SCSI_INQUIRY_CONF_LEN                          (24)

#define CSL_AC_DEVICE_CLASS_STORAGE                           (0x08)

#define CSL_AC_SCSI_DATA_PROTECT                              (0x0007)

#define CSL_AC_REQUEST_AUDIO_CLASS                            (0x20)

#define CSL_AC_GET_BUF_LEN                                    (0x04)

#define CSL_AC_REQUEST_GET_STATUS                             (0x8000)

#define CSL_AC_REQUEST_CLEAR_FEATURE                          (0x0001)

#define CSL_AC_REQUEST_SET_CUR                                (0x2001)

#define CSL_AC_REQUEST_GET_CUR                                (0xA081)

#define CSL_AC_REQUEST_SET_MIN                                (0x2002)

#define CSL_AC_REQUEST_GET_MIN                                (0xA082)

#define CSL_AC_REQUEST_SET_MAX                                (0x2003)

#define CSL_AC_REQUEST_GET_MAX                                (0xA083)

#define CSL_AC_REQUEST_SET_RES                                (0x2004)

#define CSL_AC_REQUEST_GET_RES                                (0xA084)

#define CSL_AC_VOLUME_CTRL_BUF_LEN                            (6)

#define USB_AC_FEATURE_UNIT_MUTE_CTRL                         (0x01)

#define USB_AC_FEATURE_UNIT_VOLUME_CTRL                       (0x02)

#define USB_AC_FEATURE_UNIT_LEFT_RIGHT_VOLUME                 (0x00)

#define USB_AC_FEATURE_UNIT_LEFT_VOLUME                       (0x01)

#define USB_AC_FEATURE_UNIT_RIGHT_VOLUME                      (0x02)

#define CSL_AC_REQUEST_SET_FEATURE                            (0x0003)

#define CSL_AC_REQUEST_SET_ADDRESS                            (0x0005)

#define CSL_AC_REQUEST_GET_DESCRIPTOR                         (0x8006)

#define CSL_AC_REQUEST_SET_DESCRIPTOR                         (0x0007)

#define CSL_AC_REQUEST_GET_CONFIGURATION                      (0x8008)

#define CSL_AC_REQUEST_SET_CONFIGURATION                      (0x0009)

#define CSL_AC_REQUEST_GET_INTERFACE                          (0x800A)

#define CSL_AC_REQUEST_SET_INTERFACE                          (0x000B)

#define CSL_AC_REQUEST_SYNC_FRAME                             (0x800C)

#define CSL_AC_REQUEST_ISO_ONLY_RESET                         (0x20FF)

#define CSL_AC_REQUEST_GET_MAX_LUN                            (0xA0FE)

#define CSL_AC_REQUEST_TYPE_BASE                              (0x80)

#define CSL_AC_REQUEST_TYPE_DEVICE_STATUS                     (0x0)

#define CSL_AC_REQUEST_TYPE_INTERFACE_STATUS                  (0x1)

#define CSL_AC_REQUEST_TYPE_EP_STATUS                         (0x2)

#define CSL_AC_DEVICE_SUSPENDED                               (0x01)

#define CSL_AC_DEVICE_NOT_SUSPENDED                           (0x0)

#define CSL_AC_LUN_LOCKED                                     (0x01)

#define CSL_AC_LUN_NOT_LOCKED                                 (0x0)

#define CSL_AC_ACTIVITY_PRESENT                               (0x01)

#define CSL_AC_ACTIVITY_NOT_PRESENT                           (0x0)

#define CSL_AC_16BIT_MASK                                     (0xFFFF)

#define CSL_AC_16BIT_SHIFT                                    (16)

#define CSL_AC_24BIT_SHIFT                                    (24)

#define CSL_AC_8BIT_MASK                                      (0xFF)

#define CSL_AC_8BIT_HIGH_MASK                                 (0xFF00)

#define CSL_AC_8BIT_SHIFT                                     (8)

#define CSL_AC_UNICODE_SIZE                                   (66)

#define CSL_AC_SENSE_DATA0_DEFVAL                             (26)

#define CSL_AC_SENSE_DATA1_DEFVAL                             (0)

#define CSL_AC_SENSE_DATA2_DEFVAL                             (0x0070)

#define CSL_AC_SENSE_DATA3_DEFVAL                             (0x0000)

#define CSL_AC_SENSE_DATA4_DEFVAL                             (0x0000)

#define CSL_AC_SENSE_DATA5_DEFVAL                             ((11<<8) | 0)

#define CSL_AC_READ_CAPACITY0_DEFVAL                          (8)

#define CSL_AC_CSW0_DEFVAL                                    (0)

#define CSL_AC_CSW1_DEFVAL                                    (0x5355)

#define CSL_AC_CSW2_DEFVAL                                    (0x5342)

#define CSL_AC_ERROR_BASE                             (CSL_EUSB_FIRST)

#define CSL_AC_INVALID_REQUEST_HANDLER                (CSL_AC_ERROR_BASE - 1)

#define CSL_AC_REQUEST_ARGS     CSL_UsbDevNum         devNum,           \
                                CSL_UsbSetupStruct    *usbSetup,        \
                                pUsbEpHandle          hInEp,            \
                                pUsbEpHandle          hOutEp,           \
                                void                  *pAcObj

/**************************************************************************\
* USB AC global typedef declarations                                       *
\**************************************************************************/

typedef enum {
    /* Don't call request again until new SETUP                              */
    CSL_AC_REQUEST_DONE = 0,
    /* STALL the control endpoint                                            */
    CSL_AC_REQUEST_STALL,
    /* Send a 0 length IN packet                                             */
    CSL_AC_REQUEST_SEND_ACK,
    /* Prepare to receive 0 length OUT packet                                */
    CSL_AC_REQUEST_GET_ACK,
    /* Notify handler when IN data has been transmitted                      */
    CSL_AC_REQUEST_DATA_IN,
    /* Notify handler when OUT data has been received                        */
    CSL_AC_REQUEST_DATA_OUT
} CSL_AcRequestRet;

typedef enum {
    CSL_AC_MEDIACCESS_OVERFLOW,
    CSL_AC_MEDIACCESS_SUCCESS,
    CSL_AC_MEDIACCESS_NOTPRESENT,
    CSL_AC_MEDIACCESS_WRITEPROTECT,
    CSL_AC_MEDIACCESS_BADMEDIA
} CSL_AcMediaStatus;

typedef enum {
    CSL_AC_UNLOCK = 0,
    CSL_AC_LOCK
} CSL_AcMediaLockStatus;

typedef enum {
    CSL_AC_DEVICE_DESCR = 0,
    CSL_AC_DEVICE_QUAL_DESCR,
    CSL_AC_CONFIG_DESCR,
    CSL_AC_INTERFACE_DESCR,
    CSL_AC_STRING_LANGID_DESC
} CSL_AcDescrId;

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

typedef struct CSL_AcRequestStruct {
    WORD                request;
    CSL_AcRequestRet    (*fpRequestHandler)(CSL_AC_REQUEST_ARGS);
} CSL_AcRequestStruct;

typedef struct CSL_AcInitStructApp {
    void                   *pAcObj;
    Uint16                 pId;
    Uint16                 vId;
    Uint16                 numLun;
    Uint16                 txPktSize;
    Uint16                 rxPktSize;
    char                   **strDescrApp;
    Uint16                 *lbaBufferApp;
    CSL_AcRequestStruct    *acReqTableApp;
    void                   (*isoHandler)();
    void                   (*ctrlHandler)();
    CSL_AcMediaStatus      (*playAudioApp)(Uint16 , Uint16* , Uint16*, void*);
    CSL_AcMediaStatus      (*stopAudioApp)(Uint16 , void* );
    CSL_AcMediaStatus      (*recordAudioApp)(Uint16 , Uint16* , Uint16*, void*);
    CSL_AcMediaStatus      (*mediaGetPresentStateApp)(Uint16);
    CSL_AcMediaStatus      (*mediaInitApp)(Uint16);
    CSL_AcMediaStatus      (*mediaEjectApp)(Uint16);
    CSL_AcMediaStatus      (*mediaLockUnitApp)(Uint16,CSL_AcMediaLockStatus);
    Uint32                 (*getMediaSizeApp)(Uint16);
} CSL_AcInitStructApp;

typedef CSL_AcInitStructApp  *pAcAppClassHandle;

typedef struct CSL_AcLunAttribApp {
    Uint32    lbaSizeApp;
    Uint32    mediaSizeApp;
    Uint16    removeableApp;
    Uint16    scsiInquiryConfData [CSL_AC_SCSI_INQUIRY_CONF_LEN];
    Uint16    mediaStateApp;
    Uint16    readwriteApp;
} CSL_AcLunAttribApp;

typedef CSL_AcLunAttribApp   *pAcAppLunAttribHandle;

typedef  CSL_AcRequestRet (*fpAC_REQ_HANDLER)(CSL_AC_REQUEST_ARGS);

typedef struct CSL_AcLogicalUnit {
    Uint16    scsiInquiryData[CSL_AC_SCSI_INQUIRY_LEN];
    Uint32    mediaSize;
    Uint32    currLba;
    Uint32    lbaSize;
    Uint16    removeable;
    Uint16    mediaState;
    Uint16    readwrite;
    Uint16    lbaCnt;
    Uint16    verifyFlag;
} CSL_AcLogicalUnit;

typedef struct CSL_AcObject {
    CSL_AcMediaStatus    (*recordAudio)(Uint16 , Uint16* , Uint16*, void*);
    CSL_AcMediaStatus    (*playAudio)(Uint16 , Uint16* , Uint16*, void*);
    CSL_AcMediaStatus    (*stopAudio)(Uint16 , void*);
    CSL_AcMediaStatus    (*mediaGetPresentState)(Uint16 );
    CSL_AcMediaStatus    (*mediaInit)(Uint16 );
    CSL_AcMediaStatus    (*mediaEject)(Uint16 );
    CSL_AcMediaStatus    (*mediaLockUnit)(Uint16,CSL_AcMediaLockStatus);
    Uint32               (*getMediaSize)(Uint16 );
    Uint16               *lbaBuffer;
    Uint32                cbwDataTransferLength;
    CSL_AcLogicalUnit    lun[CSL_AC_LUN_MAX];
    Uint16               senseData[CSL_AC_SENSEDATA_LEN];
    Uint16               activityPresentFlag;
    Uint16               csw[CSL_AC_CSWSIZE];
    Uint16               readCapacity[CSL_AC_READCAP];
    Uint16               cbw[CSL_AC_CBWSIZE];
    CSL_UsbEpObj         isoInEpObj;
    CSL_UsbEpObj         isoOutEpObj;
    Uint16               noOfLun;
    Uint16               mediaState;
    Uint16               playBackActive;
    Uint16               mediaInitDone;
    Uint16               tempBuffer[4];
} CSL_AcObject;

typedef struct CSL_AcCtrlObject {
    CSL_UsbEpObj           ctrlInEpObj;
    CSL_UsbDevNum          devNum;
    CSL_UsbEpObj           ctrlOutEpObj;
    Uint16                 suspendFlag;
    pUsbEpHandle           hEpObjArray[CSL_AC_NO_ENDPTOBJECT];
    CSL_UsbSetupStruct     usbSetup;
    Uint16                 leftVolBuf[CSL_AC_VOLUME_CTRL_BUF_LEN];
    Uint16                 rightVolBuf[CSL_AC_VOLUME_CTRL_BUF_LEN];
    Uint16                 leftRightVolBuf[2*CSL_AC_VOLUME_CTRL_BUF_LEN];
    Uint16                 muteCtrlBuf[CSL_AC_VOLUME_CTRL_BUF_LEN];
    Uint16                 getMinBuffer[CSL_AC_GET_BUF_LEN];
    Uint16                 getMaxBuffer[CSL_AC_GET_BUF_LEN];
    Uint16                 getResBuffer[CSL_AC_GET_BUF_LEN];
    Uint16                 dummydesc[63];
    Uint16                 deviceQualifierDescr[CSL_AC_DEV_QUAL_DESCR_MAX_LEN];
    Uint16                 deviceDescr[CSL_AC_DEVICE_DESCR_MAX_LEN];
    Uint16                 confDescr[CSL_AC_CONFIG_DESCR_MAX_LEN];
    Uint16                 audioClassIntDescr[CSL_AC_INTER_DESCR_MAX_LEN];
    Uint16 audioClassIsoOutEndptDescr[CSL_AC_MS_ISOOUT_ENDPTDESC_LEN];
    CSL_UsbDataStruct      audioClassInterfcLnk;
    Uint16 audioClassIsoInEndptDescr[CSL_AC_MS_ISOIN_ENDPTDESC_LEN];
    CSL_UsbDataStruct      audioClassIsoOutEndptLnk;
    Uint16                 stringDescrLangid[CSL_AC_STRING_DESCR_LANGID_MAX_LEN];
    Uint16                 curConfigStat;
    CSL_UsbDataStruct      audioClassIsoInEndptLnk;
    Uint16                 ctrlBuffer[CSL_AC_CTRLBUFF_LEN];
    CSL_UsbDataStruct      configDescrLnk;
    char                   **strDescr;
    CSL_AcRequestStruct    *acReqTable;
    CSL_AcRequestRet        (*fpRequestHandler)(CSL_AC_REQUEST_ARGS);
} CSL_AcCtrlObject;

typedef struct CSL_AcClassStruct {
    CSL_AcCtrlObject    ctrlHandle;
    CSL_AcObject        acHandle;
} CSL_AcClassStruct;

typedef CSL_AcClassStruct  *pAcClassHandle;

/**************************************************************************\
* USB AC function declarations                                            *
\**************************************************************************/

CSL_Status AC_Open(pAcAppClassHandle    pAppClassHandle);

CSL_Status AC_Close(pAcAppClassHandle    pAppClassHandle);

CSL_Status AC_Ctrl(void    *pAcObj);

CSL_Status AC_Iso(void    *pAcObj);

Uint16 AC_GetactivityFlagStatus(void    *pAcObj);

Uint16 AC_GetsuspendFlagStatus(void    *pAcObj);

CSL_Status AC_initDescriptors(void             *pAcObj,
                              Uint16           *descBuf,
                              CSL_AcDescrId    descrId,
                              Uint16           descrLen);

static CSL_Status AC_initAcVal(CSL_AcObject    *pAcHandle);

CSL_AcRequestRet AC_reqGetDescriptor(CSL_UsbDevNum         devNum,
                                     CSL_UsbSetupStruct    *usbSetup,
                                     pUsbEpHandle          hInEp,
                                     pUsbEpHandle          hOutEp,
                                     void                  *pAcObj);

CSL_AcRequestRet AC_reqSetCurrent(CSL_UsbDevNum           devNum,
                                    CSL_UsbSetupStruct    *usbSetup,
                                    pUsbEpHandle          hInEp,
                                    pUsbEpHandle          hOutEp,
                                    void                  *pAcObj);

CSL_AcRequestRet AC_reqGetCurrent(CSL_UsbDevNum         devNum,
                                  CSL_UsbSetupStruct    *usbSetup,
                                  pUsbEpHandle          hInEp,
                                  pUsbEpHandle          hOutEp,
                                  void                  *pAcObj);

CSL_AcRequestRet AC_reqGetMinimum(CSL_UsbDevNum         devNum,
                                  CSL_UsbSetupStruct    *usbSetup,
                                  pUsbEpHandle          hInEp,
                                  pUsbEpHandle          hOutEp,
                                  void                  *pAcObj);

CSL_AcRequestRet AC_reqGetMaximum(CSL_UsbDevNum         devNum,
                                  CSL_UsbSetupStruct    *usbSetup,
                                  pUsbEpHandle          hInEp,
                                  pUsbEpHandle          hOutEp,
                                  void                  *pAcObj);

CSL_AcRequestRet AC_reqGetResolution(CSL_UsbDevNum         devNum,
                                     CSL_UsbSetupStruct    *usbSetup,
                                     pUsbEpHandle          hInEp,
                                     pUsbEpHandle          hOutEp,
                                     void                  *pAcObj);

CSL_AcRequestRet AC_reqSetInterface(CSL_UsbDevNum         devNum,
                                    CSL_UsbSetupStruct    *usbSetup,
                                    pUsbEpHandle          hInEp,
                                    pUsbEpHandle          hOutEp,
                                    void                  *pAcObj);

#ifdef __cplusplus
}
#endif

#endif    // _CSL_AUDIOCLASS_H_