/**************************************************************************/ /* */ /* 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 */ /** */ /** Device Audio Class */ /** */ /**************************************************************************/ /**************************************************************************/ #define UX_SOURCE_CODE /* Include necessary system files. */ #include "ux_api.h" #include "ux_device_class_audio.h" #include "ux_device_class_audio10.h" #include "ux_device_stack.h" /**************************************************************************/ /* */ /* FUNCTION RELEASE */ /* */ /* _ux_device_class_audio10_control_process PORTABLE C */ /* 6.2.1 */ /* AUTHOR */ /* */ /* Chaoqiong Xiao, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function manages the based sent by the host on the control */ /* endpoints with a CLASS or VENDOR SPECIFIC type. */ /* */ /* INPUT */ /* */ /* audio Address of audio class */ /* instance */ /* transfer Address of transfer request */ /* instance */ /* group Request process data */ /* */ /* OUTPUT */ /* */ /* Completion Status */ /* */ /* CALLS */ /* */ /* _ux_utility_short_get Get 2-byte value from buffer */ /* _ux_utility_short_put Put 2-byte value to buffer */ /* _ux_device_stack_transfer_request Issue a transfer request */ /* _ux_device_stack_endpoint_stall Endpoint stall */ /* */ /* CALLED BY */ /* */ /* Application */ /* */ /* RELEASE HISTORY */ /* */ /* DATE NAME DESCRIPTION */ /* */ /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */ /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */ /* resulting in version 6.1 */ /* 04-02-2021 Chaoqiong Xiao Modified comment(s), */ /* added volume RES support, */ /* resulting in version 6.1.6 */ /* 04-25-2022 Chaoqiong Xiao Modified comment(s), */ /* internal clean up, */ /* resulting in version 6.1.11 */ /* 07-29-2022 Chaoqiong Xiao Modified comment(s), */ /* added sampling control, */ /* resulting in version 6.1.12 */ /* 03-08-2023 Chaoqiong Xiao Modified comment(s), */ /* fixed a macro name, */ /* resulting in version 6.2.1 */ /* */ /**************************************************************************/ UINT _ux_device_class_audio10_control_process(UX_DEVICE_CLASS_AUDIO *audio, UX_SLAVE_TRANSFER *transfer, UX_DEVICE_CLASS_AUDIO10_CONTROL_GROUP *group) { UX_SLAVE_ENDPOINT *endpoint; UX_DEVICE_CLASS_AUDIO10_CONTROL *control; UCHAR request; UCHAR request_type; UCHAR unit_id, ep_addr; UCHAR control_selector; UCHAR channel_number; ULONG request_length; UCHAR *desc; ULONG sam, min, max, pos; ULONG i; /* Get instances. */ endpoint = &audio -> ux_device_class_audio_device -> ux_slave_device_control_endpoint; transfer = &endpoint -> ux_slave_endpoint_transfer_request; /* Extract all necessary fields of the request. */ request = *(transfer -> ux_slave_transfer_request_setup + UX_DEVICE_CLASS_AUDIO_REQUEST_REQUEST); request_type = *(transfer -> ux_slave_transfer_request_setup + UX_DEVICE_CLASS_AUDIO_REQUEST_REQUEST_TYPE); unit_id = *(transfer -> ux_slave_transfer_request_setup + UX_DEVICE_CLASS_AUDIO_REQUEST_ENEITY_ID); ep_addr = *(transfer -> ux_slave_transfer_request_setup + UX_DEVICE_CLASS_AUDIO_REQUEST_ENDPOINT); control_selector = *(transfer -> ux_slave_transfer_request_setup + UX_DEVICE_CLASS_AUDIO_REQUEST_CONTROL_SELECTOR); channel_number = *(transfer -> ux_slave_transfer_request_setup + UX_DEVICE_CLASS_AUDIO_REQUEST_CHANNEL_NUMBER); request_length = _ux_utility_short_get(transfer -> ux_slave_transfer_request_setup + UX_SETUP_LENGTH); /* Process controls one by one. */ for (i = 0; i < group -> ux_device_class_audio10_control_group_controls_nb; i ++) { control = &group -> ux_device_class_audio10_control_group_controls[i]; /* Reset change map. */ control -> ux_device_class_audio10_control_changed = 0; /* We handle endpoint requests. */ if ((request_type & UX_REQUEST_TARGET) == UX_REQUEST_TARGET_ENDPOINT && ep_addr == control -> ux_device_class_audio10_control_ep_addr) { /* Handle the request. */ switch(request) { case UX_DEVICE_CLASS_AUDIO10_SET_CUR: /* Only sampling frequency control is supported. */ if (control_selector != UX_DEVICE_CLASS_AUDIO10_EP_SAMPLING_FREQ_CONTROL) break; /* Length check. */ if (request_length != 3) break; /* If frequencies not specified, no modification accepted. */ if (control -> ux_device_class_audio10_control_sam_freq_types == UX_NULL) return(UX_SUCCESS); /* Check sampling frequency types (UAC 1.0 Format Type I : bSamFreqType ..) for MIN and MAX. */ desc = control -> ux_device_class_audio10_control_sam_freq_types; if (desc[0] == 0) { min = ((ULONG)desc[1]) | ((ULONG)desc[2] << 8) | ((ULONG)desc[3] << 16); max = ((ULONG)desc[4]) | ((ULONG)desc[5] << 8) | ((ULONG)desc[6] << 16); } else { min = 0xFFFFFFFF; max = 0x00000000; for (pos = 1; pos < (ULONG)desc[0] * 3 + 1; /* Calculate from byte, no overflow. */ pos += 3) { sam = (ULONG)desc[pos + 0] | ((ULONG)desc[pos + 1] << 8) | ((ULONG)desc[pos + 2] << 16); if (sam > max) max = sam; if (sam < min) min = sam; } } /* Accept frequency any way. * If it's not in range, round to min or max. * If it's in range it's not rounded, application should check and round it. */ sam = ((ULONG)transfer -> ux_slave_transfer_request_data_pointer[0] ) | ((ULONG)transfer -> ux_slave_transfer_request_data_pointer[1] << 8) | ((ULONG)transfer -> ux_slave_transfer_request_data_pointer[2] << 16); if (sam < min) sam = min; if (sam > max) sam = max; control -> ux_device_class_audio10_control_sam_freq = sam; control -> ux_device_class_audio10_control_changed = UX_DEVICE_CLASS_AUDIO10_CONTROL_FREQUENCY_CHANGED; return(UX_SUCCESS); case UX_DEVICE_CLASS_AUDIO10_GET_CUR: /* Sampling frequency control is supported. */ if (control_selector != UX_DEVICE_CLASS_AUDIO10_EP_SAMPLING_FREQ_CONTROL) break; /* Check host buffer. */ if (request_length < 3) break; /* Put sample frequency. */ sam = control -> ux_device_class_audio10_control_sam_freq; transfer -> ux_slave_transfer_request_data_pointer[0] = UX_DW0(sam); transfer -> ux_slave_transfer_request_data_pointer[1] = UX_DW1(sam); transfer -> ux_slave_transfer_request_data_pointer[2] = UX_DW2(sam); _ux_device_stack_transfer_request(transfer, 3, request_length); return(UX_SUCCESS); default: break; } } /* We handle feature unit requests. */ if ((request_type & UX_REQUEST_TARGET) == UX_REQUEST_TARGET_INTERFACE && unit_id == control -> ux_device_class_audio10_control_fu_id) { /* Handle the request. */ switch(request) { case UX_DEVICE_CLASS_AUDIO10_SET_CUR: /* We only support master channel, so channel number must be 0 or 0xFF. */ if (channel_number != 0 && channel_number != 0xFF) break; /* Set request. */ switch(control_selector) { case UX_DEVICE_CLASS_AUDIO10_FU_MUTE_CONTROL: if (transfer -> ux_slave_transfer_request_actual_length < 1) /* No change applied. */ break; if (control -> ux_device_class_audio10_control_mute[0] != transfer -> ux_slave_transfer_request_data_pointer[0]) { control -> ux_device_class_audio10_control_changed = UX_DEVICE_CLASS_AUDIO10_CONTROL_MUTE_CHANGED; control -> ux_device_class_audio10_control_mute[0] = transfer -> ux_slave_transfer_request_data_pointer[0]; } /* Done success. */ return(UX_SUCCESS); case UX_DEVICE_CLASS_AUDIO10_FU_VOLUME_CONTROL: if (transfer -> ux_slave_transfer_request_actual_length < 2) /* No change applied. */ break; if (control -> ux_device_class_audio10_control_volume[0] != (SHORT)_ux_utility_short_get(transfer -> ux_slave_transfer_request_data_pointer)) { control -> ux_device_class_audio10_control_changed = UX_DEVICE_CLASS_AUDIO10_CONTROL_VOLUME_CHANGED; control -> ux_device_class_audio10_control_volume[0] = (SHORT)_ux_utility_short_get(transfer -> ux_slave_transfer_request_data_pointer); } /* Done success. */ return(UX_SUCCESS); default: /* No change applied. */ break; } /* Request or parameter problem. */ break; case UX_DEVICE_CLASS_AUDIO10_GET_MIN: case UX_DEVICE_CLASS_AUDIO10_GET_MAX: case UX_DEVICE_CLASS_AUDIO10_GET_RES: case UX_DEVICE_CLASS_AUDIO10_GET_CUR: /* We only support master channel, so channel number must be 0 or 0xFF. */ if (channel_number != 0 && channel_number != 0xFF) break; /* Get request. */ switch(control_selector) { case UX_DEVICE_CLASS_AUDIO10_FU_MUTE_CONTROL: /* We only support _CUR. */ if (request != UX_DEVICE_CLASS_AUDIO10_GET_CUR) break; /* Not enough buffer for data. */ if (request_length < 1) break; /* Send mute status. */ transfer -> ux_slave_transfer_request_data_pointer[0] = (UCHAR)control -> ux_device_class_audio10_control_mute[0]; _ux_device_stack_transfer_request(transfer, 1, request_length); /* Done success. */ return(UX_SUCCESS); case UX_DEVICE_CLASS_AUDIO10_FU_VOLUME_CONTROL: /* Not enough buffer for data. */ if (request_length < 2) break; /* Send volume value. */ _ux_utility_short_put(transfer -> ux_slave_transfer_request_data_pointer, (USHORT) (request == UX_DEVICE_CLASS_AUDIO10_GET_MIN ? control -> ux_device_class_audio10_control_volume_min[0] : (request == UX_DEVICE_CLASS_AUDIO10_GET_MAX ? control -> ux_device_class_audio10_control_volume_max[0] : (request == UX_DEVICE_CLASS_AUDIO10_GET_RES ? UX_MAX(1, control -> ux_device_class_audio10_control_volume_res[0]) : control -> ux_device_class_audio10_control_volume[0])))); _ux_device_stack_transfer_request(transfer, 2, request_length); /* Done success. */ return(UX_SUCCESS); default: break; } break; default: break; } /* We are here when there is error, break the loop. */ break; } /* Now try next. */ } /* Request or parameter not supported. */ _ux_device_stack_endpoint_stall(endpoint); /* Done error. */ return(UX_ERROR); } /**************************************************************************/ /* */ /* FUNCTION RELEASE */ /* */ /* _uxe_device_class_audio10_control_process PORTABLE C */ /* 6.2.1 */ /* AUTHOR */ /* */ /* Chaoqiong Xiao, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function checks errors in control processing function call. */ /* */ /* INPUT */ /* */ /* audio Address of audio class */ /* instance */ /* transfer Address of transfer request */ /* instance */ /* group Request process data */ /* */ /* OUTPUT */ /* */ /* Completion Status */ /* */ /* CALLS */ /* */ /* _ux_device_class_audio10_control_process */ /* Process control requests */ /* */ /* CALLED BY */ /* */ /* Application */ /* */ /* RELEASE HISTORY */ /* */ /* DATE NAME DESCRIPTION */ /* */ /* 03-08-2023 Chaoqiong Xiao Initial Version 6.2.1 */ /* */ /**************************************************************************/ UINT _uxe_device_class_audio10_control_process(UX_DEVICE_CLASS_AUDIO *audio, UX_SLAVE_TRANSFER *transfer, UX_DEVICE_CLASS_AUDIO10_CONTROL_GROUP *group) { /* Sanity checks. */ if (audio == UX_NULL || transfer == UX_NULL || group == UX_NULL) return(UX_INVALID_PARAMETER); /* Process control request. */ return(_ux_device_class_audio10_control_process(audio, transfer, group)); }