- uint8_t SampleFrequencyType; /**< Total number of sample frequencies supported by the device */ \r
- AudioSampleFreq_t SampleFrequencies[1]; /**< Sample frequencies supported by the device */\r
- } USB_AudioFormat_t;\r
- \r
- /** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint \r
- * descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint */\r
-\r
- uint8_t Refresh; /**< Always set to zero */\r
- uint8_t SyncEndpointNumber; /**< Endpoint address to send synchronisation information to, if needed (zero otherwise) */\r
- } USB_AudioStreamEndpoint_Std_t;\r
- \r
- /** Type define for an Audio class specific extended endpoint descriptor. This contains extra information\r
- * on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio\r
- * class specific extended endpoint descriptor. See the USB Audio specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
- \r
- uint8_t Attributes; /**< Audio class specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS */\r
-\r
- uint8_t LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification */\r
- uint16_t LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry */\r
- } USB_AudioStreamEndpoint_Spc_t; \r
-\r
- /** Type define for an Audio Class interface configuration and state structure. This structure should be used for each Audio\r
- * Class unit within the device, and passed (per-interface) to the Audio Class driver functions so that each Audio interface\r
- * has seperate state and configuration data and can be controlled seperately.\r
- */\r
- typedef struct\r
- {\r
- uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls */\r
-\r
- uint8_t DataINEndpointNumber; /**< Endpoint number of the incomming Audio Streaming data, if available (zero if unused) */\r
- uint16_t DataINEndpointSize; /**< Size in bytes of the incomming Audio Streaming data endpoint, if available (zero if unused) */\r
-\r
- uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available (zero if unused) */\r
- uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available (zero if unused) */\r
-\r
- bool InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints\r
- * of the Audio Streaming interface\r
- */\r
- } USB_ClassInfo_Audio_t;\r
- \r
- /* Function Prototypes: */\r
- /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library\r
- * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
- * given Audio interface is selected.\r
- *\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- *\r
- * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
- */\r
- bool USB_Audio_ConfigureEndpoints(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-\r
- /** Processes incomming control requests from the host, that are directed to the given Audio class interface. This should be\r
- * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
- *\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- */\r
- void USB_Audio_ProcessControlPacket(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-\r
- /** General management task for a given Audio class interface, required for the correct operation of the interface. This should\r
- * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
- *\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- */\r
- void USB_Audio_USBTask(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
- \r
- /** Reads the next 8-bit audio sample from the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \return Signed 8-bit audio sample from the audio interface\r
- */\r
- int8_t USB_Audio_ReadSample8(void);\r
-\r
- /** Reads the next 16-bit audio sample from the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \return Signed 16-bit audio sample from the audio interface\r
- */\r
- int16_t USB_Audio_ReadSample16(void);\r
-\r
- /** Reads the next 24-bit audio sample from the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \return Signed 24-bit audio sample from the audio interface\r
- */\r
- int32_t USB_Audio_ReadSample24(void);\r
-\r
- /** Writes the next 8-bit audio sample to the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \param Sample Signed 8-bit audio sample\r
- */\r
- void USB_Audio_WriteSample8(int8_t Sample);\r
-\r
- /** Writes the next 16-bit audio sample to the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \param Sample Signed 16-bit audio sample\r
- */\r
- void USB_Audio_WriteSample16(int16_t Sample);\r
-\r
- /** Writes the next 24-bit audio sample to the current audio interface.\r
- *\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
- * the correct endpoint is selected and ready for data.\r
- *\r
- * \param Sample Signed 24-bit audio sample\r
- */\r
- void USB_Audio_WriteSample24(int32_t Sample);\r
-\r
- /** Determines if the given audio interface is ready for a sample to be read from it.\r
- *\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- *\r
- * \return Boolean true if the given Audio interface has a sample to be read, false otherwise\r
- */\r
- bool USB_Audio_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-\r
- /** Determines if the given audio interface is ready to accept the next sample to be written to it.\r
- *\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- *\r
- * \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise\r
- */\r
- bool USB_Audio_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
projects / pub / USBasp.git / blobdiff