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 /**   Video 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_video.h"
29 #include "ux_host_stack.h"
30 
31 
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _ux_host_class_video_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 video transfer request or      */
45 /*    isochronous video transfer request list to the USBX stack.          */
46 /*                                                                        */
47 /*    Note if the transfer request is not linked (next pointer is NULL),  */
48 /*    a single request is submitted. If the transfer request links into a */
49 /*    list, the whole list is submitted.                                  */
50 /*                                                                        */
51 /*  INPUT                                                                 */
52 /*                                                                        */
53 /*    video                                 Pointer to video class        */
54 /*    video_transfer_request                Pointer to transfer request   */
55 /*                                                                        */
56 /*  OUTPUT                                                                */
57 /*                                                                        */
58 /*    Completion Status                                                   */
59 /*                                                                        */
60 /*  CALLS                                                                 */
61 /*                                                                        */
62 /*    _ux_host_stack_transfer_request       Process transfer request      */
63 /*                                                                        */
64 /*  CALLED BY                                                             */
65 /*                                                                        */
66 /*    Video Class                                                         */
67 /*                                                                        */
68 /*  RELEASE HISTORY                                                       */
69 /*                                                                        */
70 /*    DATE              NAME                      DESCRIPTION             */
71 /*                                                                        */
72 /*  05-19-2020     Chaoqiong Xiao           Initial Version 6.0           */
73 /*  09-30-2020     Chaoqiong Xiao           Modified comment(s),          */
74 /*                                            resulting in version 6.1    */
75 /*  07-29-2022     Chaoqiong Xiao           Modified comment(s),          */
76 /*                                            set pending on endpoint,    */
77 /*                                            resulting in version 6.1.12 */
78 /*                                                                        */
79 /**************************************************************************/
_ux_host_class_video_transfer_request(UX_HOST_CLASS_VIDEO * video,UX_HOST_CLASS_VIDEO_TRANSFER_REQUEST * video_transfer_request)80 UINT  _ux_host_class_video_transfer_request(UX_HOST_CLASS_VIDEO *video,
81                                             UX_HOST_CLASS_VIDEO_TRANSFER_REQUEST *video_transfer_request)
82 {
83 
84 UINT            status;
85 UX_ENDPOINT     *endpoint;
86 UX_TRANSFER     *transfer_list;
87 UX_TRANSFER     *transfer_request;
88 UX_TRANSFER     *previous_transfer;
89 
90     /* Get transfer request list head.  */
91     transfer_list = &video_transfer_request -> ux_host_class_video_transfer_request;
92 
93     /* Get endpoint.  */
94     endpoint = video -> ux_host_class_video_isochronous_endpoint;
95 
96     /* Process the transfer request list (if multiple found).  */
97     previous_transfer = UX_NULL;
98     while(video_transfer_request)
99     {
100 
101         /* The transfer request is embedded in the application transfer request.  */
102         transfer_request =  &video_transfer_request -> ux_host_class_video_transfer_request;
103 
104         /* Select the direction. We do this by taking the endpoint direction.  */
105         transfer_request -> ux_transfer_request_type =  video -> ux_host_class_video_isochronous_endpoint ->
106             ux_endpoint_descriptor.bEndpointAddress & UX_REQUEST_DIRECTION;
107 
108         /* Fill the transfer request with all the required fields.  */
109         transfer_request -> ux_transfer_request_endpoint =             endpoint;
110         transfer_request -> ux_transfer_request_data_pointer =         video_transfer_request -> ux_host_class_video_transfer_request_data_pointer;
111         transfer_request -> ux_transfer_request_requested_length =     video_transfer_request -> ux_host_class_video_transfer_request_requested_length;
112         transfer_request -> ux_transfer_request_completion_function =  _ux_host_class_video_transfer_request_completed;
113         transfer_request -> ux_transfer_request_class_instance =       video;
114 
115         /* We memorize the application transfer request in the local transfer request.  */
116         transfer_request -> ux_transfer_request_user_specific =  (VOID *) video_transfer_request;
117 
118         /* Confirm transfer is not linking to others  */
119         transfer_request -> ux_transfer_request_next_transfer_request = UX_NULL;
120 
121         /* Add it to transfer list tail.  */
122         if (previous_transfer != UX_NULL)
123             previous_transfer -> ux_transfer_request_next_transfer_request = transfer_request;
124 
125         /* Save as previous transfer.  */
126         previous_transfer = transfer_request;
127 
128         /* Check next transfer request.  */
129         video_transfer_request = video_transfer_request -> ux_host_class_video_transfer_request_next_video_transfer_request;
130     }
131 
132     /* Set endpoint status to pending, for callback and abort to check.  */
133     endpoint -> ux_endpoint_transfer_request.ux_transfer_request_completion_code = UX_TRANSFER_STATUS_PENDING;
134 
135     /* Transfer the transfer request (list).  */
136     status =  _ux_host_stack_transfer_request(transfer_list);
137 
138     /* Return completion status.  */
139     return(status);
140 }
141