1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2026-present Eclipse ThreadX contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** Device Storage Class */
/** */
/**************************************************************************/
/**************************************************************************/
#define UX_SOURCE_CODE
/* Include necessary system files. */
#include "ux_api.h"
#include "ux_device_class_storage.h"
#include "ux_device_stack.h"
#if UX_SLAVE_REQUEST_DATA_MAX_LENGTH < 24
/* #error UX_SLAVE_REQUEST_DATA_MAX_LENGTH is too small, please check */
/* Build option checked runtime by UX_ASSERT */
#endif
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_class_storage_inquiry PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs a INQUIRY command. */
/* */
/* INPUT */
/* */
/* storage Pointer to storage class */
/* endpoint_in Pointer to IN endpoint */
/* endpoint_out Pointer to OUT endpoint */
/* cbwcb Pointer to CBWCB */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_device_class_storage_csw_send Send CSW */
/* _ux_device_stack_transfer_request Transfer request */
/* _ux_device_stack_endpoint_stall Stall endpoint */
/* _ux_utility_memory_copy Copy memory */
/* _ux_utility_memory_set Set memory */
/* _ux_utility_short_put_big_endian Put 16-bit big endian */
/* */
/* CALLED BY */
/* */
/* Device Storage Class */
/* */
/**************************************************************************/
UINT _ux_device_class_storage_inquiry(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR * cbwcb)
{
UINT status = UX_SUCCESS;
UX_SLAVE_TRANSFER *transfer_request;
UCHAR inquiry_page_code;
ULONG inquiry_length;
UCHAR *inquiry_buffer;
UX_PARAMETER_NOT_USED(endpoint_out);
/* Build option check. */
UX_ASSERT(UX_SLAVE_REQUEST_DATA_MAX_LENGTH >= 24);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_STORAGE_INQUIRY, storage, lun, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
#if !defined(UX_DEVICE_STANDALONE)
/* Check direction. */
if (storage -> ux_slave_class_storage_host_length &&
(storage -> ux_slave_class_storage_cbw_flags & 0x80) == 0)
{
_ux_device_stack_endpoint_stall(endpoint_out);
storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_PHASE_ERROR;
return(UX_ERROR);
}
#endif
/* From the SCSI Inquiry payload, get the page code. */
inquiry_page_code = *(cbwcb + UX_SLAVE_CLASS_STORAGE_INQUIRY_PAGE_CODE);
/* And the length to be returned. */
inquiry_length = storage -> ux_slave_class_storage_host_length;
/* Obtain the pointer to the transfer request. */
transfer_request = &endpoint_in -> ux_slave_endpoint_transfer_request;
/* Obtain inquiry buffer pointer. */
inquiry_buffer = transfer_request -> ux_slave_transfer_request_data_pointer;
/* Ensure the data buffer is cleaned. */
_ux_utility_memory_set(inquiry_buffer, 0, UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_LENGTH); /* Use case of memset is verified. */
/* Check for the maximum length to be returned. */
if (inquiry_length > UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_LENGTH)
inquiry_length = UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_LENGTH;
/* Default CSW to passed. */
storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_PASSED;
/* Ensure we know about the page code. */
switch (inquiry_page_code)
{
case UX_SLAVE_CLASS_STORAGE_INQUIRY_PAGE_CODE_STANDARD:
/* Store the product type. */
inquiry_buffer[UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_PERIPHERAL_TYPE] = (UCHAR)storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_type;
/* Store the Media Removable bit. */
inquiry_buffer[UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_REMOVABLE_MEDIA] = (UCHAR)storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_removable_flag;
/* Store the Data Format bit. */
if (storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_type == UX_SLAVE_CLASS_STORAGE_MEDIA_CDROM)
inquiry_buffer[UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_DATA_FORMAT] = 0x32;
else
inquiry_buffer[UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_DATA_FORMAT] = 0x00;
/* Store the length of the response. There is a hack here. For CD-ROM, the data lg is fixed to 0x5B ! */
if (storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_type != UX_SLAVE_CLASS_STORAGE_MEDIA_CDROM)
inquiry_buffer[UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_ADDITIONAL_LENGTH] = UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_LENGTH;
else
inquiry_buffer[UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_ADDITIONAL_LENGTH] = UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_LENGTH_CD_ROM;
/* Fill in the storage vendor ID. */
_ux_utility_memory_copy(inquiry_buffer + UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_VENDOR_INFORMATION,
storage -> ux_slave_class_storage_vendor_id, 8); /* Use case of memcpy is verified. */
/* Fill in the product vendor ID. */
_ux_utility_memory_copy(inquiry_buffer + UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_PRODUCT_ID,
storage -> ux_slave_class_storage_product_id, 16); /* Use case of memcpy is verified. */
/* Fill in the product revision number. */
_ux_utility_memory_copy(inquiry_buffer + UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_PRODUCT_REVISION,
storage -> ux_slave_class_storage_product_rev, 4); /* Use case of memcpy is verified. */
break;
case UX_SLAVE_CLASS_STORAGE_INQUIRY_PAGE_CODE_SERIAL:
/* Initialize the page code in response buffer. */
_ux_utility_short_put_big_endian(transfer_request -> ux_slave_transfer_request_data_pointer, UX_SLAVE_CLASS_STORAGE_INQUIRY_PAGE_CODE_SERIAL);
/* Initialize the length of the serial number in response buffer. */
_ux_utility_short_put_big_endian(transfer_request -> ux_slave_transfer_request_data_pointer + 2, 20);
/* Copy the serial number buffer into the transfer request memory. */
_ux_utility_memory_copy(transfer_request -> ux_slave_transfer_request_data_pointer + 4, storage -> ux_slave_class_storage_product_serial, 20); /* Use case of memcpy is verified. */
/* Send a data payload with the inquiry response buffer. */
if (inquiry_length > 24)
inquiry_length = 24;
break;
default:
#if !defined(UX_DEVICE_STANDALONE)
/* The page code is not supported. */
_ux_device_stack_endpoint_stall(endpoint_in);
#endif
/* And update the REQUEST_SENSE codes. */
storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_request_sense_status =
UX_DEVICE_CLASS_STORAGE_SENSE_STATUS(0x05,0x26,0x01);
/* Now we set the CSW with failure. */
storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_FAILED;
/* Return error. */
status = UX_ERROR;
break;
}
/* Error cases. */
if (status != UX_SUCCESS)
return(status);
#if defined(UX_DEVICE_STANDALONE)
/* Next: Transfer (DATA). */
storage -> ux_device_class_storage_state = UX_DEVICE_CLASS_STORAGE_STATE_TRANS_START;
storage -> ux_device_class_storage_cmd_state = UX_DEVICE_CLASS_STORAGE_CMD_READ;
storage -> ux_device_class_storage_transfer = transfer_request;
storage -> ux_device_class_storage_device_length = inquiry_length;
storage -> ux_device_class_storage_data_length = inquiry_length;
storage -> ux_device_class_storage_data_count = 0;
#else
/* Send a data payload with the inquiry response buffer. */
if (inquiry_length)
_ux_device_stack_transfer_request(transfer_request, inquiry_length, inquiry_length);
/* Check length. */
if (storage -> ux_slave_class_storage_host_length != inquiry_length)
{
storage -> ux_slave_class_storage_csw_residue = storage -> ux_slave_class_storage_host_length - inquiry_length;
_ux_device_stack_endpoint_stall(endpoint_in);
}
#endif
/* Return completion status. */
return(status);
}
|
