1 /*************************************************************************** 2 * Copyright (c) 2024 Microsoft Corporation 3 * 4 * This program and the accompanying materials are made available under the 5 * terms of the MIT License which is available at 6 * https://opensource.org/licenses/MIT. 7 * 8 * SPDX-License-Identifier: MIT 9 **************************************************************************/ 10 11 12 /**************************************************************************/ 13 /**************************************************************************/ 14 /** */ 15 /** USBX Component */ 16 /** */ 17 /** Audio Class */ 18 /** */ 19 /**************************************************************************/ 20 /**************************************************************************/ 21 22 23 /* Include necessary system files. */ 24 25 #define UX_SOURCE_CODE 26 27 #include "ux_api.h" 28 #include "ux_host_class_audio.h" 29 #include "ux_host_stack.h" 30 31 32 /**************************************************************************/ 33 /* */ 34 /* FUNCTION RELEASE */ 35 /* */ 36 /* _ux_host_class_audio_transfer_request PORTABLE C */ 37 /* 6.1.12 */ 38 /* AUTHOR */ 39 /* */ 40 /* Chaoqiong Xiao, Microsoft Corporation */ 41 /* */ 42 /* DESCRIPTION */ 43 /* */ 44 /* This function submits an isochronous audio transfer request to the */ 45 /* USBX stack. */ 46 /* */ 47 /* INPUT */ 48 /* */ 49 /* audio Pointer to audio class */ 50 /* audio_transfer_request Pointer to transfer request */ 51 /* */ 52 /* OUTPUT */ 53 /* */ 54 /* Completion Status */ 55 /* */ 56 /* CALLS */ 57 /* */ 58 /* _ux_host_stack_transfer_request Process transfer request */ 59 /* */ 60 /* CALLED BY */ 61 /* */ 62 /* Audio Class */ 63 /* */ 64 /* RELEASE HISTORY */ 65 /* */ 66 /* DATE NAME DESCRIPTION */ 67 /* */ 68 /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */ 69 /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */ 70 /* resulting in version 6.1 */ 71 /* 07-29-2022 Chaoqiong Xiao Modified comment(s), */ 72 /* refined transfer implement, */ 73 /* resulting in version 6.1.12 */ 74 /* */ 75 /**************************************************************************/ _ux_host_class_audio_transfer_request(UX_HOST_CLASS_AUDIO * audio,UX_HOST_CLASS_AUDIO_TRANSFER_REQUEST * audio_transfer_request)76UINT _ux_host_class_audio_transfer_request(UX_HOST_CLASS_AUDIO *audio, 77 UX_HOST_CLASS_AUDIO_TRANSFER_REQUEST *audio_transfer_request) 78 { 79 80 UX_INTERRUPT_SAVE_AREA 81 UINT status; 82 UX_TRANSFER *transfer_request; 83 84 /* The transfer request is embedded in the application transfer request. */ 85 transfer_request = &audio_transfer_request -> ux_host_class_audio_transfer_request; 86 87 /* Saved the direction, by taking the endpoint transfer direction. */ 88 transfer_request -> ux_transfer_request_type = 89 audio -> ux_host_class_audio_isochronous_endpoint -> 90 ux_endpoint_transfer_request.ux_transfer_request_type; 91 92 /* Fill the transfer request with all the required fields. */ 93 transfer_request -> ux_transfer_request_endpoint = audio -> ux_host_class_audio_isochronous_endpoint; 94 transfer_request -> ux_transfer_request_data_pointer = audio_transfer_request -> ux_host_class_audio_transfer_request_data_pointer; 95 transfer_request -> ux_transfer_request_requested_length = audio_transfer_request -> ux_host_class_audio_transfer_request_requested_length; 96 transfer_request -> ux_transfer_request_packet_length = audio_transfer_request -> ux_host_class_audio_transfer_request_packet_size; 97 transfer_request -> ux_transfer_request_completion_function = _ux_host_class_audio_transfer_request_completed; 98 transfer_request -> ux_transfer_request_class_instance = audio; 99 transfer_request -> ux_transfer_request_next_transfer_request = UX_NULL; /* Add one by one. */ 100 101 /* We memorize the application transfer request in the local transfer request. */ 102 transfer_request -> ux_transfer_request_user_specific = (VOID *) audio_transfer_request; 103 104 UX_DISABLE 105 106 /* Hook the audio transfer request to the chain of transfer requests in the audio instance. */ 107 audio_transfer_request -> ux_host_class_audio_transfer_request_next_audio_transfer_request = 108 audio -> ux_host_class_audio_tail_transfer_request; 109 audio -> ux_host_class_audio_tail_transfer_request = audio_transfer_request; 110 111 /* Check if this is the first time we have had a transfer request, if so update the head as well. */ 112 if (audio -> ux_host_class_audio_head_transfer_request == UX_NULL) 113 audio -> ux_host_class_audio_head_transfer_request = audio_transfer_request; 114 115 UX_RESTORE 116 117 /* Transfer the transfer request (queued in lower level). */ 118 status = _ux_host_stack_transfer_request(transfer_request); 119 120 /* Return completion status. */ 121 return(status); 122 } 123
