Embedded/usbx
1
0
Fork 0
mirror of https://github.com/azure-rtos/usbx.git synced 2025-02-04 07:13:12 +08:00
Code Issues Projects Releases Wiki Activity
usbx/common/usbx_host_classes/inc/ux_host_class_audio.h
Scott Larson 3f1e20df86 6.1 Release
2020-10-09 12:39:54 -07:00

451 lines
20 KiB
C
Raw Blame History

/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** Audio Class */
/** */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/* */
/* COMPONENT DEFINITION RELEASE */
/* */
/* ux_host_class_audio.h PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This file contains all the header and extern functions used by the */
/* USBX audio class. */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
/* used UX prefix to refer to */
/* TX symbols instead of using */
/* them directly, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
#ifndef UX_HOST_CLASS_AUDIO_H
#define UX_HOST_CLASS_AUDIO_H
/* Define Audio Class main constants. */
#define UX_HOST_CLASS_AUDIO_CLASS_TRANSFER_TIMEOUT 30
#define UX_HOST_CLASS_AUDIO_CLASS 1
#define UX_HOST_CLASS_AUDIO_SUBCLASS_UNDEFINED 0
#define UX_HOST_CLASS_AUDIO_SUBCLASS_CONTROL 1
#define UX_HOST_CLASS_AUDIO_SUBCLASS_STREAMING 2
#define UX_HOST_CLASS_AUDIO_SUBCLASS_MIDI_STREAMING 3
#define UX_HOST_CLASS_AUDIO_PROTOCOL_UNDEFINED 0
/* Define Audio Class main descriptor types. */
#define UX_HOST_CLASS_AUDIO_CS_UNDEFINED 0x20
#define UX_HOST_CLASS_AUDIO_CS_DEVICE 0x21
#define UX_HOST_CLASS_AUDIO_CS_CONFIGURATION 0x22
#define UX_HOST_CLASS_AUDIO_CS_STRING 0x23
#define UX_HOST_CLASS_AUDIO_CS_INTERFACE 0x24
#define UX_HOST_CLASS_AUDIO_CS_ENDPOINT 0x25
/* Define Audio Class specific AC interface descriptor subclasses. */
#define UX_HOST_CLASS_AUDIO_CS_AC_UNDEFINED 0x00
#define UX_HOST_CLASS_AUDIO_CS_HEADER 0x01
#define UX_HOST_CLASS_AUDIO_CS_INPUT_TERMINAL 0x02
#define UX_HOST_CLASS_AUDIO_CS_OUTPUT_TERMINAL 0x03
#define UX_HOST_CLASS_AUDIO_CS_MIXER_UNIT 0x04
#define UX_HOST_CLASS_AUDIO_CS_SELECTOR_UNIT 0x05
#define UX_HOST_CLASS_AUDIO_CS_FEATURE_UNIT 0x06
#define UX_HOST_CLASS_AUDIO_CS_PROCESSING_UNIT 0x07
#define UX_HOST_CLASS_AUDIO_CS_EXTENSION_UNIT 0x08
/* Define Audio Class specific AS interface descriptor subclasses. */
#define UX_HOST_CLASS_AUDIO_CS_AS_UNDEFINED 0x00
#define UX_HOST_CLASS_AUDIO_CS_AS_GENERAL 0x01
#define UX_HOST_CLASS_AUDIO_CS_FORMAT_TYPE 0x02
#define UX_HOST_CLASS_AUDIO_CS_FORMAT_SPECIFIC 0x03
/* Define Audio Class specific processing unit process types. */
#define UX_HOST_CLASS_AUDIO_PROCESS_UNDEFINED 0x00
#define UX_HOST_CLASS_AUDIO_UP_DOWN_MIX_PROCESS 0x01
#define UX_HOST_CLASS_AUDIO_DOLBY_PROLOGIC_PROCESS 0x02
#define UX_HOST_CLASS_AUDIO_3D_STEREO_EXTENDED_PROCESS 0x03
#define UX_HOST_CLASS_AUDIO_REVERBERATION_PROCESS 0x04
#define UX_HOST_CLASS_AUDIO_CHORUS_PROCESS 0x05
#define UX_HOST_CLASS_AUDIO_DYN_RANGE_COMP_PROCESS 0x06
/* Define Audio Class specific endpoint descriptor subtypes. */
#define UX_HOST_CLASS_AUDIO_DESCRIPTOR_UNDEFINED 0x00
#define UX_HOST_CLASS_AUDIO_EP_GENERAL 0x01
/* Define Audio Class specific request codes. */
#define UX_HOST_CLASS_AUDIO_REQUEST_CODE_UNDEFINED 0x00
#define UX_HOST_CLASS_AUDIO_SET_CUR 0x01
#define UX_HOST_CLASS_AUDIO_GET_CUR 0x81
#define UX_HOST_CLASS_AUDIO_SET_MIN 0x02
#define UX_HOST_CLASS_AUDIO_GET_MIN 0x82
#define UX_HOST_CLASS_AUDIO_SET_MAX 0x03
#define UX_HOST_CLASS_AUDIO_GET_MAX 0x83
#define UX_HOST_CLASS_AUDIO_SET_RES 0x04
#define UX_HOST_CLASS_AUDIO_GET_RES 0x84
#define UX_HOST_CLASS_AUDIO_SET_MEM 0x05
#define UX_HOST_CLASS_AUDIO_GET_MEM 0x85
#define UX_HOST_CLASS_AUDIO_GET_STAT 0xFF
/* Define Audio Class specific terminal control selectors. */
#define UX_HOST_CLASS_AUDIO_TE_CONTROL_UNDEFINED 0x00
#define UX_HOST_CLASS_AUDIO_COPY_PROTECT_CONTROL 0x01
/* Define Audio Class specific feature unit control selectors. */
#define UX_HOST_CLASS_AUDIO_FU_CONTROL_UNDEFINED 0x00
#define UX_HOST_CLASS_AUDIO_MUTE_CONTROL 0x01
#define UX_HOST_CLASS_AUDIO_VOLUME_CONTROL 0x02
#define UX_HOST_CLASS_AUDIO_BASS_CONTROL 0x03
#define UX_HOST_CLASS_AUDIO_MID_CONTROL 0x04
#define UX_HOST_CLASS_AUDIO_TREBLE_CONTROL 0x05
#define UX_HOST_CLASS_AUDIO_GRAPHIC_EQUALIZER_CONTROL 0x06
#define UX_HOST_CLASS_AUDIO_AUTOMATIC_GAIN_CONTROL 0x07
#define UX_HOST_CLASS_AUDIO_DELAY_CONTROL 0x08
#define UX_HOST_CLASS_AUDIO_BASS_BOOST_CONTROL 0x09
#define UX_HOST_CLASS_AUDIO_LOUNDNESS_CONTROL 0x0A
/* Define Audio Class input terminal types. */
#define UX_HOST_CLASS_AUDIO_INPUT 0x0200
#define UX_HOST_CLASS_AUDIO_MICROPHONE 0x0201
#define UX_HOST_CLASS_AUDIO_DESKTOP_MICROPHONE 0x0202
#define UX_HOST_CLASS_AUDIO_PERSONAL_MICROPHONE 0x0203
#define UX_HOST_CLASS_AUDIO_OMNI_DIRECTIONAL_MICROPHONE 0x0204
#define UX_HOST_CLASS_AUDIO_MICROPHONE_ARRAY 0x0205
#define UX_HOST_CLASS_AUDIO_PROCESSING_MICROPHONE_ARRAY 0x0206
/* Define Audio Class output terminal types. */
#define UX_HOST_CLASS_AUDIO_OUTPUT 0x0300
#define UX_HOST_CLASS_AUDIO_SPEAKER 0x0301
#define UX_HOST_CLASS_AUDIO_HEADPHONES 0x0302
#define UX_HOST_CLASS_AUDIO_HEAD_MOUNTED_DISPLAY 0x0303
#define UX_HOST_CLASS_AUDIO_DESKTOP_SPEAKER 0x0304
#define UX_HOST_CLASS_AUDIO_ROOM_SPEAKER 0x0305
#define UX_HOST_CLASS_AUDIO_COMMUNICATION_SPEAKER 0x0306
#define UX_HOST_CLASS_AUDIO_LOW_FREQUENCY_SPEAKER 0x0307
/* Define Audio Class bidirectional terminal types. */
#define UX_HOST_CLASS_AUDIO_BIDIRECTIONAL_UNDEFINED 0x0400
#define UX_HOST_CLASS_AUDIO_HANDSET 0x0401
#define UX_HOST_CLASS_AUDIO_HEADSET 0x0402
#define UX_HOST_CLASS_AUDIO_SPEAKERPHONE 0x0403
#define UX_HOST_CLASS_AUDIO_ECHO_SUPRESS_SPEAKERPHONE 0x0404
#define UX_HOST_CLASS_AUDIO_ECHO_CANCEL_SPEAKERPHONE 0x0405
/* Define Audio Class telephony terminal types. */
#define UX_HOST_CLASS_AUDIO_TELEPHONTY_UNDEFINED 0x0400
#define UX_HOST_CLASS_AUDIO_PHONE_LINE 0x0401
#define UX_HOST_CLASS_AUDIO_TELEPHONE 0x0402
#define UX_HOST_CLASS_AUDIO_DOWN_LINE_PHONE 0x0403
/* Define Audio Class encoding format types. */
#define UX_HOST_CLASS_AUDIO_FORMAT_TYPE_UNDEFINED 0
#define UX_HOST_CLASS_AUDIO_FORMAT_TYPE_I 1
#define UX_HOST_CLASS_AUDIO_FORMAT_TYPE_II 2
#define UX_HOST_CLASS_AUDIO_FORMAT_TYPE_III 3
#define UX_HOST_CLASS_AUDIO_FORMAT_PCM 1
#define UX_HOST_CLASS_AUDIO_FORMAT_PCM8 2
#define UX_HOST_CLASS_AUDIO_FORMAT_IEEE_FLOAT 3
#define UX_HOST_CLASS_AUDIO_FORMAT_ALAW 4
#define UX_HOST_CLASS_AUDIO_FORMAT_MULAW 5
#define UX_HOST_CLASS_AUDIO_INTERFACE_DESCRIPTOR_ENTRIES 8
#define UX_HOST_CLASS_AUDIO_INTERFACE_DESCRIPTOR_LENGTH 8
#define UX_HOST_CLASS_AUDIO_INPUT_TERMINAL_DESCRIPTOR_ENTRIES 10
#define UX_HOST_CLASS_AUDIO_INPUT_TERMINAL_DESCRIPTOR_LENGTH 12
#define UX_HOST_CLASS_AUDIO_OUTPUT_TERMINAL_DESCRIPTOR_ENTRIES 8
#define UX_HOST_CLASS_AUDIO_OUTPUT_TERMINAL_DESCRIPTOR_LENGTH 9
#define UX_HOST_CLASS_AUDIO_FEATURE_UNIT_DESCRIPTOR_ENTRIES 7
#define UX_HOST_CLASS_AUDIO_FEATURE_UNIT_DESCRIPTOR_LENGTH 7
#define UX_HOST_CLASS_AUDIO_STREAMING_INTERFACE_DESCRIPTOR_ENTRIES 6
#define UX_HOST_CLASS_AUDIO_STREAMING_INTERFACE_DESCRIPTOR_LENGTH 6
#define UX_HOST_CLASS_AUDIO_STREAMING_ENDPOINT_DESCRIPTOR_ENTRIES 6
#define UX_HOST_CLASS_AUDIO_STREAMING_ENDPOINT_DESCRIPTOR_LENGTH 6
/* Define Audio Class specific interface descriptor. */
#define UX_HOST_CLASS_AUDIO_MAX_CHANNEL 8
#define UX_HOST_CLASS_AUDIO_NAME_LENGTH 64
typedef struct UX_HOST_CLASS_AUDIO_INTERFACE_DESCRIPTOR_STRUCT
{
ULONG bLength;
ULONG bDescriptorType;
ULONG bDescriptorSubType;
ULONG bFormatType;
ULONG bNrChannels;
ULONG bSubframeSize;
ULONG bBitResolution;
ULONG bSamFreqType;
} UX_HOST_CLASS_AUDIO_INTERFACE_DESCRIPTOR;
/* Define Audio Class specific input terminal interface descriptor. */
typedef struct UX_HOST_CLASS_AUDIO_INPUT_TERMINAL_DESCRIPTOR_STRUCT
{
ULONG bLength;
ULONG bDescriptorType;
ULONG bDescriptorSubType;
ULONG bTerminalID;
ULONG wTerminalType;
ULONG bAssocTerminal;
ULONG bNrChannels;
ULONG wChannelConfig;
ULONG iChannelNames;
ULONG iTerminal;
} UX_HOST_CLASS_AUDIO_INPUT_TERMINAL_DESCRIPTOR;
/* Define Audio Class specific output terminal interface descriptor. */
typedef struct UX_HOST_CLASS_AUDIO_OUTPUT_TERMINAL_DESCRIPTOR_STRUCT
{
ULONG bLength;
ULONG bDescriptorType;
ULONG bDescriptorSubType;
ULONG bTerminalID;
ULONG wTerminalType;
ULONG bAssocTerminal;
ULONG bSourceID;
ULONG iTerminal;
} UX_HOST_CLASS_AUDIO_OUTPUT_TERMINAL_DESCRIPTOR;
/* Define Audio Class specific feature unit descriptor. */
typedef struct UX_HOST_CLASS_AUDIO_FEATURE_UNIT_DESCRIPTOR_STRUCT
{
ULONG bLength;
ULONG bDescriptorType;
ULONG bDescriptorSubType;
ULONG bUnitID;
ULONG bSourceID;
ULONG bControlSize;
ULONG bmaControls;
} UX_HOST_CLASS_AUDIO_FEATURE_UNIT_DESCRIPTOR;
/* Define Audio Class streaming interface descriptor. */
typedef struct UX_HOST_CLASS_AUDIO_STREAMING_INTERFACE_DESCRIPTOR_STRUCT
{
ULONG bLength;
ULONG bDescriptorType;
ULONG bDescriptorSubtype;
ULONG bTerminalLink;
ULONG bDelay;
ULONG wFormatTag;
} UX_HOST_CLASS_AUDIO_STREAMING_INTERFACE_DESCRIPTOR;
/* Define Audio Class specific streaming endpoint descriptor. */
typedef struct UX_HOST_CLASS_AUDIO_STREAMING_ENDPOINT_DESCRIPTOR_STRUCT
{
ULONG bLength;
ULONG bDescriptorType;
ULONG bDescriptorSubtype;
ULONG bmAttributes;
ULONG bLockDelayUnits;
ULONG wLockDelay;
} UX_HOST_CLASS_AUDIO_STREAMING_ENDPOINT_DESCRIPTOR;
/* Define Audio Class instance structure. */
typedef struct UX_HOST_CLASS_AUDIO_STRUCT
{
struct UX_HOST_CLASS_AUDIO_STRUCT
*ux_host_class_audio_next_instance;
UX_HOST_CLASS *ux_host_class_audio_class;
UX_DEVICE *ux_host_class_audio_device;
UX_INTERFACE *ux_host_class_audio_streaming_interface;
ULONG ux_host_class_audio_control_interface_number;
UX_ENDPOINT *ux_host_class_audio_isochronous_endpoint;
struct UX_HOST_CLASS_AUDIO_TRANSFER_REQUEST_STRUCT
*ux_host_class_audio_head_transfer_request;
struct UX_HOST_CLASS_AUDIO_TRANSFER_REQUEST_STRUCT
*ux_host_class_audio_tail_transfer_request;
UINT ux_host_class_audio_state;
ULONG ux_host_class_audio_terminal_link;
ULONG ux_host_class_audio_type;
UCHAR * ux_host_class_audio_configuration_descriptor;
ULONG ux_host_class_audio_configuration_descriptor_length;
ULONG ux_host_class_audio_feature_unit_id;
UINT ux_host_class_audio_channels;
ULONG ux_host_class_audio_channel_control[UX_HOST_CLASS_AUDIO_MAX_CHANNEL];
UCHAR ux_host_class_audio_name[UX_HOST_CLASS_AUDIO_NAME_LENGTH];
UX_SEMAPHORE ux_host_class_audio_semaphore;
} UX_HOST_CLASS_AUDIO;
/* Define Audio Class isochronous USB transfer request structure. */
typedef struct UX_HOST_CLASS_AUDIO_TRANSFER_REQUEST_STRUCT
{
ULONG ux_host_class_audio_transfer_request_status;
UCHAR * ux_host_class_audio_transfer_request_data_pointer;
ULONG ux_host_class_audio_transfer_request_requested_length;
ULONG ux_host_class_audio_transfer_request_actual_length;
VOID (*ux_host_class_audio_transfer_request_completion_function) (struct UX_HOST_CLASS_AUDIO_TRANSFER_REQUEST_STRUCT *);
UX_SEMAPHORE ux_host_class_audio_transfer_request_semaphore;
VOID *ux_host_class_audio_transfer_request_class_instance;
UINT ux_host_class_audio_transfer_request_completion_code;
struct UX_HOST_CLASS_AUDIO_TRANSFER_REQUEST_STRUCT
*ux_host_class_audio_transfer_request_next_audio_transfer_request;
UX_TRANSFER ux_host_class_audio_transfer_request;
} UX_HOST_CLASS_AUDIO_TRANSFER_REQUEST;
/* Define Audio Class channel/value control structures. */
typedef struct UX_HOST_CLASS_AUDIO_CONTROL_STRUCT
{
ULONG ux_host_class_audio_control;
ULONG ux_host_class_audio_control_channel;
ULONG ux_host_class_audio_control_min;
ULONG ux_host_class_audio_control_max;
ULONG ux_host_class_audio_control_res;
ULONG ux_host_class_audio_control_cur;
} UX_HOST_CLASS_AUDIO_CONTROL;
typedef struct UX_HOST_CLASS_AUDIO_CHANNEL_STRUCT
{
ULONG ux_host_class_audio_channel_control;
ULONG ux_host_class_audio_channel;
} UX_HOST_CLASS_AUDIO_CHANNEL;
/* Define Audio Class sampling selection structure. */
typedef struct UX_HOST_CLASS_AUDIO_SAMPLING_STRUCT
{
ULONG ux_host_class_audio_sampling_channels;
ULONG ux_host_class_audio_sampling_frequency;
ULONG ux_host_class_audio_sampling_resolution;
} UX_HOST_CLASS_AUDIO_SAMPLING;
/* Define Audio Class sampling characteristics structure. */
typedef struct UX_HOST_CLASS_AUDIO_SAMPLING_CHARACTERISTICS_STRUCT
{
ULONG ux_host_class_audio_sampling_characteristics_channels;
ULONG ux_host_class_audio_sampling_characteristics_frequency_low;
ULONG ux_host_class_audio_sampling_characteristics_frequency_high;
ULONG ux_host_class_audio_sampling_characteristics_resolution;
} UX_HOST_CLASS_AUDIO_SAMPLING_CHARACTERISTICS;
/* Define Audio Class function prototypes. */
UINT _ux_host_class_audio_activate(UX_HOST_CLASS_COMMAND *command);
UINT _ux_host_class_audio_alternate_setting_locate(UX_HOST_CLASS_AUDIO *audio, UX_HOST_CLASS_AUDIO_SAMPLING *audio_sampling, UINT *alternate_setting);
UINT _ux_host_class_audio_configure(UX_HOST_CLASS_AUDIO *audio);
UINT _ux_host_class_audio_control_get(UX_HOST_CLASS_AUDIO *audio, UX_HOST_CLASS_AUDIO_CONTROL *audio_control);
UINT _ux_host_class_audio_control_value_get(UX_HOST_CLASS_AUDIO *audio, UX_HOST_CLASS_AUDIO_CONTROL *audio_control);
UINT _ux_host_class_audio_control_value_set(UX_HOST_CLASS_AUDIO *audio, UX_HOST_CLASS_AUDIO_CONTROL *audio_control);
UINT _ux_host_class_audio_deactivate(UX_HOST_CLASS_COMMAND *command);
UINT _ux_host_class_audio_descriptor_get(UX_HOST_CLASS_AUDIO *audio);
UINT _ux_host_class_audio_device_controls_list_get(UX_HOST_CLASS_AUDIO *audio);
UINT _ux_host_class_audio_device_type_get(UX_HOST_CLASS_AUDIO *audio);
UINT _ux_host_class_audio_endpoints_get(UX_HOST_CLASS_AUDIO *audio);
UINT _ux_host_class_audio_entry(UX_HOST_CLASS_COMMAND *command);
UINT _ux_host_class_audio_read(UX_HOST_CLASS_AUDIO *audio, UX_HOST_CLASS_AUDIO_TRANSFER_REQUEST *audio_transfer_request);
UINT _ux_host_class_audio_streaming_sampling_get(UX_HOST_CLASS_AUDIO *audio, UX_HOST_CLASS_AUDIO_SAMPLING_CHARACTERISTICS *audio_sampling);
UINT _ux_host_class_audio_streaming_sampling_set(UX_HOST_CLASS_AUDIO *audio, UX_HOST_CLASS_AUDIO_SAMPLING *audio_sampling);
UINT _ux_host_class_audio_streaming_terminal_get(UX_HOST_CLASS_AUDIO *audio);
UINT _ux_host_class_audio_transfer_request(UX_HOST_CLASS_AUDIO *audio, UX_HOST_CLASS_AUDIO_TRANSFER_REQUEST *audio_transfer_request);
VOID _ux_host_class_audio_transfer_request_completed(UX_TRANSFER *transfer_request);
UINT _ux_host_class_audio_write(UX_HOST_CLASS_AUDIO *audio, UX_HOST_CLASS_AUDIO_TRANSFER_REQUEST *audio_transfer_request);
/* Define Asix Class API prototypes. */
#define ux_host_class_audio_entry _ux_host_class_audio_entry
#define ux_host_class_audio_control_get _ux_host_class_audio_control_get
#define ux_host_class_audio_control_value_get _ux_host_class_audio_control_value_get
#define ux_host_class_audio_control_value_set _ux_host_class_audio_control_value_set
#define ux_host_class_audio_read _ux_host_class_audio_read
#define ux_host_class_audio_streaming_sampling_get _ux_host_class_audio_streaming_sampling_get
#define ux_host_class_audio_streaming_sampling_set _ux_host_class_audio_streaming_sampling_set
#define ux_host_class_audio_streaming_terminal_get _ux_host_class_audio_streaming_terminal_get
#define ux_host_class_audio_write _ux_host_class_audio_write
#endif
Reference in New Issue View Git Blame Copy Permalink