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 /** USBX Component                                                        */
15 /**                                                                       */
16 /**   Device Video Class                                                  */
17 /**                                                                       */
18 /**************************************************************************/
19 /**************************************************************************/
20 
21 #define UX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "ux_api.h"
27 #include "ux_device_class_video.h"
28 #include "ux_device_stack.h"
29 
30 
31 /**************************************************************************/
32 /*                                                                        */
33 /*  FUNCTION                                               RELEASE        */
34 /*                                                                        */
35 /*    _ux_device_class_video_entry                        PORTABLE C      */
36 /*                                                           6.3.0        */
37 /*  AUTHOR                                                                */
38 /*                                                                        */
39 /*    Chaoqiong Xiao, Microsoft Corporation                               */
40 /*                                                                        */
41 /*  DESCRIPTION                                                           */
42 /*                                                                        */
43 /*    This function is the entry point of the video class. It             */
44 /*    will be called by the device stack enumeration module when the      */
45 /*    host has sent a SET_CONFIGURATION command and the video interface   */
46 /*    needs to be mounted.                                                */
47 /*                                                                        */
48 /*  INPUT                                                                 */
49 /*                                                                        */
50 /*    command                               Pointer to class command      */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    Completion Status                                                   */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    _ux_device_class_video_initialize         Initialize video class    */
59 /*    _ux_device_class_video_uninitialize       Uninitialize video class  */
60 /*    _ux_device_class_video_activate           Activate video class      */
61 /*    _ux_device_class_video_change             Change video interface    */
62 /*    _ux_device_class_video_deactivate         Deactivate video class    */
63 /*    _ux_device_class_video_control_request    Request control           */
64 /*                                                                        */
65 /*  CALLED BY                                                             */
66 /*                                                                        */
67 /*    Device Stack                                                        */
68 /*                                                                        */
69 /*  RELEASE HISTORY                                                       */
70 /*                                                                        */
71 /*    DATE              NAME                      DESCRIPTION             */
72 /*                                                                        */
73 /*  04-25-2022     Chaoqiong Xiao           Initial Version 6.1.11        */
74 /*  10-31-2023     Yajun xia                Modified comment(s),          */
75 /*                                            added error checks support, */
76 /*                                            resulting in version 6.3.0  */
77 /*                                                                        */
78 /**************************************************************************/
_ux_device_class_video_entry(UX_SLAVE_CLASS_COMMAND * command)79 UINT  _ux_device_class_video_entry(UX_SLAVE_CLASS_COMMAND *command)
80 {
81 
82 UINT        status;
83 
84 
85     /* The command request will tell us we need to do here, either a enumeration
86        query, an activation or a deactivation.  */
87     switch (command -> ux_slave_class_command_request)
88     {
89 
90     case UX_SLAVE_CLASS_COMMAND_INITIALIZE:
91 #if defined(UX_DEVICE_CLASS_VIDEO_ENABLE_ERROR_CHECKING)
92 
93         /* Call the init function of the Video class.  */
94         status =  _uxe_device_class_video_initialize(command);
95 #else
96 
97         /* Call the init function of the Video class.  */
98         status =  _ux_device_class_video_initialize(command);
99 #endif  /* UX_DEVICE_CLASS_VIDEO_ENABLE_ERROR_CHECKING */
100 
101         /* Return the completion status.  */
102         return(status);
103 
104     case UX_SLAVE_CLASS_COMMAND_UNINITIALIZE:
105 
106         /* Call the init function of the Video class.  */
107         status =  _ux_device_class_video_uninitialize(command);
108 
109         /* Return the completion status.  */
110         return(status);
111 
112     case UX_SLAVE_CLASS_COMMAND_QUERY:
113 
114         /* Check the CLASS definition in the interface descriptor. */
115         if (command -> ux_slave_class_command_class == UX_DEVICE_CLASS_VIDEO_CLASS)
116         {
117             if (command -> ux_slave_class_command_subclass == UX_DEVICE_CLASS_VIDEO_SUBCLASS_CONTROL)
118                 return(UX_SUCCESS);
119             if (command -> ux_slave_class_command_subclass == UX_DEVICE_CLASS_VIDEO_SUBCLASS_STREAMING)
120                 return(UX_SUCCESS);
121         }
122         return(UX_NO_CLASS_MATCH);
123 
124     case UX_SLAVE_CLASS_COMMAND_ACTIVATE:
125 
126         /* The activate command is used when the host has sent a SET_CONFIGURATION command
127            and this interface has to be mounted. Both Bulk endpoints have to be mounted
128            and the video thread needs to be activated.  */
129         status =  _ux_device_class_video_activate(command);
130 
131         /* Return the completion status.  */
132         return(status);
133 
134     case UX_SLAVE_CLASS_COMMAND_CHANGE:
135 
136         /* The change command is used when the host has sent a SET_INTERFACE command
137            to go from Alternate Setting 0 to 1 or revert to the default mode.  */
138         status =  _ux_device_class_video_change(command);
139 
140         /* Return the completion status.  */
141         return(status);
142 
143     case UX_SLAVE_CLASS_COMMAND_DEACTIVATE:
144 
145         /* The deactivate command is used when the device has been extracted.
146            The device endpoints have to be dismounted and the video thread canceled.  */
147         status =  _ux_device_class_video_deactivate(command);
148 
149         /* Return the completion status.  */
150         return(status);
151 
152     case UX_SLAVE_CLASS_COMMAND_REQUEST:
153 
154         /* The request command is used when the host sends a command on the control endpoint.  */
155         _ux_device_class_video_control_request(command);
156 
157         /* Return the completion status.  */
158         return(UX_SUCCESS);
159 
160     default:
161 
162         /* Return an error.  */
163         return(UX_FUNCTION_NOT_SUPPORTED);
164     }
165 }
166