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 PIMA 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_pima.h"
28 #include "ux_device_stack.h"
29
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _ux_device_class_pima_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 pima class. It */
44 /* will be called by the device stack enumeration module when the */
45 /* host has sent a SET_CONFIGURATION command and the pima 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_pima_initialize Initialize pima class */
59 /* _ux_device_class_pima_activate Activate pima class */
60 /* _ux_device_class_pima_deactivate Deactivate pima class */
61 /* _ux_device_class_pima_control_request Request control */
62 /* */
63 /* CALLED BY */
64 /* */
65 /* PIMA Class */
66 /* */
67 /* RELEASE HISTORY */
68 /* */
69 /* DATE NAME DESCRIPTION */
70 /* */
71 /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
72 /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
73 /* resulting in version 6.1 */
74 /* 10-31-2023 Chaoqiong Xiao Modified comment(s), */
75 /* added error checks support, */
76 /* resulting in version 6.3.0 */
77 /* */
78 /**************************************************************************/
_ux_device_class_pima_entry(UX_SLAVE_CLASS_COMMAND * command)79 UINT _ux_device_class_pima_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
92 /* Call the init function of the PIMA class. */
93 #if defined(UX_DEVICE_CLASS_PIMA_ENABLE_ERROR_CHECKING)
94 status = _uxe_device_class_pima_initialize(command);
95 #else
96 status = _ux_device_class_pima_initialize(command);
97 #endif
98
99 /* Return the completion status. */
100 return(status);
101
102 case UX_SLAVE_CLASS_COMMAND_QUERY:
103
104 /* Check the CLASS definition in the interface descriptor. */
105 if (command -> ux_slave_class_command_class == UX_DEVICE_CLASS_PIMA_CLASS)
106 return(UX_SUCCESS);
107 else
108 return(UX_NO_CLASS_MATCH);
109
110 case UX_SLAVE_CLASS_COMMAND_ACTIVATE:
111
112 /* The activate command is used when the host has sent a SET_CONFIGURATION command
113 and this interface has to be mounted. Both Bulk endpoints have to be mounted
114 and the pima thread needs to be activated. */
115 status = _ux_device_class_pima_activate(command);
116
117 /* Return the completion status. */
118 return(status);
119
120 case UX_SLAVE_CLASS_COMMAND_DEACTIVATE:
121
122 /* The deactivate command is used when the device has been extracted.
123 The device endpoints have to be dismounted and the pima thread canceled. */
124 status = _ux_device_class_pima_deactivate(command);
125
126 /* Return the completion status. */
127 return(status);
128
129 case UX_SLAVE_CLASS_COMMAND_REQUEST:
130
131 /* The request command is used when the host sends a command on the control endpoint. */
132 status = _ux_device_class_pima_control_request(command);
133
134 /* Return the completion status. */
135 return(status);
136
137 default:
138
139 /* If trace is enabled, insert this event into the trace buffer. */
140 UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_FUNCTION_NOT_SUPPORTED, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)
141
142 /* Return an error. */
143 return(UX_FUNCTION_NOT_SUPPORTED);
144 }
145 }
146
147
