Defines
USB AC Symbols Defined
AC

Defines

#define CSL_AC_DEVICE_DESCRIPTOR_TYPE   (0x01)
 USB AC Descriptor Type Values.
#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)
 USB AC Defined Feature selectors.
#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)
 USB AC status and size definitions.
#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)
 Symbolic constants for USB AC requests.
#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)
 AC Status query API return values.
#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
 AC Request arguments.

Define Documentation

#define CSL_AC_16BIT_MASK   (0xFFFF)

AC 16 bit Mask value

#define CSL_AC_16BIT_SHIFT   (16)

AC 16 bit shift value

#define CSL_AC_24BIT_SHIFT   (24)

AC 24 bit shift value

#define CSL_AC_8BIT_HIGH_MASK   (0xFF00)

AC 8 bit Mask value

#define CSL_AC_8BIT_MASK   (0xFF)
#define CSL_AC_8BIT_SHIFT   (8)

AC 8 bit shift value

Referenced by AC_Ctrl(), AC_reqGetCurrent(), AC_reqGetDescriptor(), and AC_reqSetCurrent().

#define CSL_AC_ACTIVITY_NOT_PRESENT   (0x0)

Return value for activity not present case

#define CSL_AC_ACTIVITY_PRESENT   (0x01)

Return value for activity present case

#define CSL_AC_AUDIO_TYPE_MONO   (0x01)

Macro for Mono type audio data

#define CSL_AC_AUDIO_TYPE_STEREO   (0x02)

Macro for Stereo type audio data

#define CSL_AC_CBWSIZE   (17)

Command block word size in words

#define CSL_AC_CONFDESC_LEN   (6)

Configuration descriptor length in words

#define CSL_AC_CONFIG_DESCR_MAX_LEN   (124)

Maximum allowed length of configuration descriptor

Referenced by AC_initDescriptors().

#define CSL_AC_CONFIGURATION_DESCRIPTOR_TYPE   (0x02)

USB AC configuration descriptor type macro

#define CSL_AC_CSW0_DEFVAL   (0)

Command status word 0 default value

Referenced by AC_initAcVal().

#define CSL_AC_CSW1_DEFVAL   (0x5355)

Command status word 1 default value

Referenced by AC_initAcVal().

#define CSL_AC_CSW2_DEFVAL   (0x5342)

Command status word 2 default value

Referenced by AC_initAcVal().

#define CSL_AC_CSWSIZE   (8)

Command status word size in words

#define CSL_AC_CTRLBUFF_LEN   (5)

Control buffer length in words

#define CSL_AC_CURRDEV_STAT   (0x01)

Current USB device status

Referenced by AC_reqGetStatus().

#define CSL_AC_CURRINTRF_STAT   (0x00)

Current USB interface status

#define CSL_AC_DEV_QUAL_DESCR_MAX_LEN   (12)

Maximum allowed length of device qualifier descriptor

Referenced by AC_initDescriptors().

#define CSL_AC_DEVDESC_LEN   (10)

Device descriptor length in words

#define CSL_AC_DEVICE_CLASS_STORAGE   (0x08)

Mass storage call definition macro

#define CSL_AC_DEVICE_DESCR_MAX_LEN   (20)

Maximum allowed length of device descriptor

Referenced by AC_initDescriptors().

#define CSL_AC_DEVICE_DESCRIPTOR_TYPE   (0x01)

USB AC Descriptor Type Values.

USB AC device descriptor type macro

#define CSL_AC_DEVICE_NOT_SUSPENDED   (0x0)

Return value for USB device not suspended case

#define CSL_AC_DEVICE_SUSPENDED   (0x01)

AC Status query API return values.

Return value for USB device suspended case

#define CSL_AC_ENDPOINT_DESCRIPTOR_TYPE   (0x05)

USB AC end point descriptor type macro

#define CSL_AC_ERROR_BASE   (CSL_EUSB_FIRST)

Error Code base

#define CSL_AC_FEATURE_ENDPOINT_STALL   (0x0000)

USB AC Defined Feature selectors.

Ac host request to set/clear end point stall

#define CSL_AC_FEATURE_REMOTE_WAKEUP   (0x0001)

Ac host request to set/reset remote wakeup feature

#define CSL_AC_GET_BUF_LEN   (0x04)

Length of buffer to service get request from host

#define CSL_AC_HID_DESCRIPTOR_TYPE   (0x21)

USB AC Human Interface Device descriptor type macro

#define CSL_AC_INTER_DESCR_MAX_LEN   (12)

Maximum allowed length of interface descriptor

Referenced by AC_initDescriptors().

#define CSL_AC_INTERFACE_DESCRIPTOR_TYPE   (0x04)

USB AC interface descriptor type macro

#define CSL_AC_INVALID_REQUEST_HANDLER   (CSL_AC_ERROR_BASE - 1)

Returned when the AC request handler is invalid

Referenced by AC_Ctrl().

#define CSL_AC_LUN_LOCKED   (0x01)

Return value for Logical unit locked case

#define CSL_AC_LUN_MAX   (4)

Maximum logical unit number

#define CSL_AC_LUN_NOT_LOCKED   (0x0)

Return value for Logical unit not locked case

#define CSL_AC_MS_INTDESC_LEN   (6)

Interface descriptor length in words

#define CSL_AC_MS_ISOIN_ENDPTDESC_LEN   (5)

Iso in end point descriptor length in words

#define CSL_AC_MS_ISOOUT_ENDPTDESC_LEN   (5)

Iso out end point descriptor length in words

#define CSL_AC_NO_ENDPTOBJECT   (5)

No end point object is available

#define CSL_AC_POWER_DESCRIPTOR_TYPE   (0x06)

USB AC power descriptor type macro

#define CSL_AC_READ_CAPACITY0_DEFVAL   (8)

Read capacity 0 default value

Referenced by AC_initAcVal().

#define CSL_AC_READCAP   (6)

AC read capacity

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

AC Request arguments.

#define CSL_AC_REQUEST_AUDIO_CLASS   (0x20)

USB Audio Class specific request macro

#define CSL_AC_REQUEST_CLEAR_FEATURE   (0x0001)

Host request to clear feature

#define CSL_AC_REQUEST_GET_CONFIGURATION   (0x8008)

Host request to get configuration

#define CSL_AC_REQUEST_GET_CUR   (0xA081)

Host request to get current

#define CSL_AC_REQUEST_GET_DESCRIPTOR   (0x8006)

Host request to get descriptor

#define CSL_AC_REQUEST_GET_INTERFACE   (0x800A)

Host request to get interface

#define CSL_AC_REQUEST_GET_MAX   (0xA083)

Host request to get maximum

#define CSL_AC_REQUEST_GET_MAX_LUN   (0xA0FE)

Host request to get maximum logical unit number

#define CSL_AC_REQUEST_GET_MIN   (0xA082)

Host request to get minimum

#define CSL_AC_REQUEST_GET_RES   (0xA084)

Host request to get resolution

#define CSL_AC_REQUEST_GET_STATUS   (0x8000)

Symbolic constants for USB AC requests.

Host request to get status

#define CSL_AC_REQUEST_ISO_ONLY_RESET   (0x20FF)

Host request for Iso only reset

#define CSL_AC_REQUEST_SET_ADDRESS   (0x0005)

Host request to set address

#define CSL_AC_REQUEST_SET_CONFIGURATION   (0x0009)

Host request to set configuration

#define CSL_AC_REQUEST_SET_CUR   (0x2001)

Host request to set current

#define CSL_AC_REQUEST_SET_DESCRIPTOR   (0x0007)

Host request to set descriptor

#define CSL_AC_REQUEST_SET_FEATURE   (0x0003)

Host request to set feature

#define CSL_AC_REQUEST_SET_INTERFACE   (0x000B)

Host request to set interface

#define CSL_AC_REQUEST_SET_MAX   (0x2003)

Host request to set maximum

#define CSL_AC_REQUEST_SET_MIN   (0x2002)

Host request to set minimum

#define CSL_AC_REQUEST_SET_RES   (0x2004)

Host request to set resolution

#define CSL_AC_REQUEST_SYNC_FRAME   (0x800C)

Host request for the synchronization frame

#define CSL_AC_REQUEST_TYPE_BASE   (0x80)

Base value for host request to get status

Referenced by AC_reqGetStatus().

#define CSL_AC_REQUEST_TYPE_DEVICE_STATUS   (0x0)

Host request to get device status

Referenced by AC_reqGetStatus().

#define CSL_AC_REQUEST_TYPE_EP_STATUS   (0x2)

Host request to get end point status

Referenced by AC_reqGetStatus().

#define CSL_AC_REQUEST_TYPE_INTERFACE_STATUS   (0x1)

Host request to get interface status

Referenced by AC_reqGetStatus().

#define CSL_AC_SCSI_DATA_PROTECT   (0x0007)

SCSI data protect macro

#define CSL_AC_SCSI_INQUIRY_CONF_LEN   (24)

SCSI inquiry configuration length

#define CSL_AC_SCSI_INQUIRY_LEN   (50)

SCSI enquiry data length in words

#define CSL_AC_SENSE_DATA0_DEFVAL   (26)

Default value for element 0 in sense data array

Referenced by AC_initAcVal().

#define CSL_AC_SENSE_DATA1_DEFVAL   (0)

Default value for element 1 in sense data array

Referenced by AC_initAcVal().

#define CSL_AC_SENSE_DATA2_DEFVAL   (0x0070)

Default value for element 2 in sense data array

Referenced by AC_initAcVal().

#define CSL_AC_SENSE_DATA3_DEFVAL   (0x0000)

Default value for element 3 in sense data array

Referenced by AC_initAcVal().

#define CSL_AC_SENSE_DATA4_DEFVAL   (0x0000)

Default value for element 4 in sense data array

Referenced by AC_initAcVal().

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

Default value for element 5 in sense data array

Referenced by AC_initAcVal().

#define CSL_AC_SENSEDATA_LEN   (15)

Sense data length in words

#define CSL_AC_STRDESC_LANGID_LEN   (4)

String descriptor language Id length in words

#define CSL_AC_STRING_DESCR_LANGID_MAX_LEN   (12)

Maximum allowed length of string descriptor language Id

Referenced by AC_initDescriptors().

#define CSL_AC_STRING_DESCRIPTOR_TYPE   (0x03)

USB AC string descriptor type macro

#define CSL_AC_UNICODE_SIZE   (66)

AC Unicode data size

Referenced by AC_reqGetDescriptor().

#define CSL_AC_UNIT_REMOVEABLE   (0x1)

AC logical unit is removable

#define CSL_AC_VERIFY_FAILED   (0x1)

AC verification failed

#define CSL_AC_VERIFY_PASSED   (0x0)

USB AC status and size definitions.

AC verification passed

#define CSL_AC_VOLUME_CTRL_BUF_LEN   (6)

Audio Class Volume controlBuffer Length

#define USB_AC_FEATURE_UNIT_LEFT_RIGHT_VOLUME   (0x00)

Audio Class Feature Unit left/right volume Control request ID

Referenced by AC_reqGetCurrent(), and AC_reqSetCurrent().

#define USB_AC_FEATURE_UNIT_LEFT_VOLUME   (0x01)

Audio Class Feature Unit left volume Control request ID

Referenced by AC_reqGetCurrent(), and AC_reqSetCurrent().

#define USB_AC_FEATURE_UNIT_MUTE_CTRL   (0x01)

Audio Class Feature Unit Mute Control request ID

Referenced by AC_reqGetCurrent(), and AC_reqSetCurrent().

#define USB_AC_FEATURE_UNIT_RIGHT_VOLUME   (0x02)

Audio Class Feature Unit right volume Control request ID

Referenced by AC_reqGetCurrent(), and AC_reqSetCurrent().

#define USB_AC_FEATURE_UNIT_VOLUME_CTRL   (0x02)

Audio Class Feature Unit volume Control request ID

Referenced by AC_reqGetCurrent(), and AC_reqSetCurrent().