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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
/***************************************************************************
* 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"
#ifdef UX_SLAVE_CLASS_STORAGE_INCLUDE_MMC
#define USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_CDROM_LENGTH (0x42 + 2)
UCHAR usbx_device_class_storage_mode_sense_page_cdrom[USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_CDROM_LENGTH] = {
0x2A, 0x42, 0x3F, 0x37, 0xF1, 0x77, 0x29, 0x23,
0x10, 0x89, 0x01, 0x00, 0x02, 0x00, 0x05, 0x84,
0x00, 0x10, 0x10, 0x89, 0x00, 0x00, 0x00, 0x01,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00
};
#else
#define USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_CDROM_LENGTH (0)
#endif
#define USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_CACHE_LENGTH (UX_SLAVE_CLASS_STORAGE_CACHING_MODE_PAGE_PAGE_LENGTH + 2)
#define USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_IEC_LENGTH (UX_SLAVE_CLASS_STORAGE_IEC_MODE_PAGE_PAGE_LENGTH + 2)
/* Ensure sense pages can fit in the bulk in endpoint's transfer buffer. */
#define USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_ALL_RESPONSE_LENGTH ( \
UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_HEADER_LENGTH_10 + \
USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_CDROM_LENGTH + \
USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_CACHE_LENGTH + \
USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_IEC_LENGTH)
#if USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_ALL_RESPONSE_LENGTH > UX_SLAVE_REQUEST_DATA_MAX_LENGTH
/* #error "The maximum-sized MODE_SENSE response cannot fit inside the bulk in endpoint's data buffer." */
/* Build option checked runtime by UX_ASSERT */
#endif
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_class_storage_mode_sense PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs a MODE_SENSE SCSI command. It supports */
/* the standard page for the CD-ROM. */
/* */
/* 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_stack_transfer_request Transfer request */
/* _ux_device_class_storage_csw_send Send CSW */
/* _ux_utility_short_get_big_endian Get 16-bit big endian */
/* _ux_utility_short_put_big_endian Put 16-bit big endian */
/* _ux_utility_memory_set Set memory */
/* _ux_utility_memory_copy Copy memory */
/* */
/* CALLED BY */
/* */
/* Device Storage Class */
/* */
/**************************************************************************/
UINT _ux_device_class_storage_mode_sense(UX_SLAVE_CLASS_STORAGE *storage,
ULONG lun,
UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out,
UCHAR *cbwcb)
{
UINT status;
UX_SLAVE_TRANSFER *transfer_request;
ULONG mode_sense_reply_length;
ULONG page_code;
ULONG mode_sense_command;
UCHAR read_only_flag;
ULONG response_header_length;
ULONG flags_index;
ULONG mode_data_length;
UCHAR *page_pointer;
ULONG page_length;
UX_PARAMETER_NOT_USED(endpoint_out);
/* Build option check. */
UX_ASSERT(USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_ALL_RESPONSE_LENGTH <= UX_SLAVE_REQUEST_DATA_MAX_LENGTH);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_STORAGE_MODE_SENSE, storage, lun, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
/* Obtain the pointer to the transfer request. */
transfer_request = &endpoint_in -> ux_slave_endpoint_transfer_request;
/* Get the command format : we have 1a and 5a. */
mode_sense_command = (ULONG) *(cbwcb + UX_SLAVE_CLASS_STORAGE_MODE_SENSE_OPERATION);
/* Extract the notification from the cbwcb. */
page_code = (ULONG) *(cbwcb + UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PC_PAGE_CODE);
/* Check the command. */
if (mode_sense_command == UX_SLAVE_CLASS_STORAGE_SCSI_MODE_SENSE_SHORT)
{
/* Extract the length to be returned by the cbwcb. */
mode_sense_reply_length = (ULONG) *(cbwcb + UX_SLAVE_CLASS_STORAGE_MODE_SENSE_ALLOCATION_LENGTH_6);
flags_index = UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_FLAGS_6;
response_header_length = UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_HEADER_LENGTH_6;
}
else
{
/* Extract the length to be returned by the cbwcb. */
mode_sense_reply_length = _ux_utility_short_get_big_endian(cbwcb + UX_SLAVE_CLASS_STORAGE_MODE_SENSE_ALLOCATION_LENGTH_10);
flags_index = UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_FLAGS_10;
response_header_length = UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_HEADER_LENGTH_10;
}
/* Ensure reply not exceed storage buffer. */
if (mode_sense_reply_length > UX_SLAVE_CLASS_STORAGE_BUFFER_SIZE)
mode_sense_reply_length = UX_SLAVE_CLASS_STORAGE_BUFFER_SIZE;
/* Ensure memory buffer cleaned. */
_ux_utility_memory_set(transfer_request -> ux_slave_transfer_request_data_pointer, 0, mode_sense_reply_length); /* Use case of memset is verified. */
/* Establish READ ONLY flag. */
if (storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_read_only_flag == UX_TRUE)
/* This device is Read Only. */
read_only_flag = UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_FLAG_WP;
else
/* This device can be written to. */
read_only_flag = 0;
/* Build response based on expected page codes. */
/* Initialize length and page pointer. */
mode_data_length = response_header_length;
page_pointer = transfer_request -> ux_slave_transfer_request_data_pointer + response_header_length;
#ifdef UX_SLAVE_CLASS_STORAGE_INCLUDE_MMC
/* CD Capabilities and Mechanical Status mode page. */
if(page_code == UX_SLAVE_CLASS_STORAGE_MMC2_PAGE_CODE_CDROM ||
page_code == UX_SLAVE_CLASS_STORAGE_PAGE_CODE_ALL)
{
page_length = USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_CDROM_LENGTH;
/* Copy page data. */
_ux_utility_memory_copy(page_pointer, usbx_device_class_storage_mode_sense_page_cdrom, page_length); /* Use case of memcpy is verified. */
/* Update pointer and length. */
mode_data_length += page_length;
page_pointer += page_length;
}
#endif
/* Caching mode page is returned if cache flush callback implemented. */
if (storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_flush != UX_NULL &&
(page_code == UX_SLAVE_CLASS_STORAGE_PAGE_CODE_CACHE ||
page_code == UX_SLAVE_CLASS_STORAGE_PAGE_CODE_ALL))
{
page_length = USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_CACHE_LENGTH;
/* Store page code. */
*(page_pointer) = UX_SLAVE_CLASS_STORAGE_PAGE_CODE_CACHE;
/* Store the length of the page data. */
*(page_pointer + UX_SLAVE_CLASS_STORAGE_CACHING_MODE_PAGE_LENGTH) =
UX_SLAVE_CLASS_STORAGE_CACHING_MODE_PAGE_PAGE_LENGTH;
/* Set the Write Cache Enabled (WCE) bit. */
*(page_pointer + UX_SLAVE_CLASS_STORAGE_CACHING_MODE_PAGE_FLAGS) |=
UX_SLAVE_CLASS_STORAGE_CACHING_MODE_PAGE_FLAG_WCE;
mode_data_length += page_length;
page_pointer += page_length;
}
/* Informational Exceptions Control mode page. */
if (page_code == UX_SLAVE_CLASS_STORAGE_PAGE_CODE_IEC ||
page_code == UX_SLAVE_CLASS_STORAGE_PAGE_CODE_ALL)
{
page_length = USBX_DEVICE_CLASS_STORAGE_MODE_SENSE_PAGE_IEC_LENGTH;
/* Store page code. */
*(page_pointer) = UX_SLAVE_CLASS_STORAGE_PAGE_CODE_IEC;
/* Store the length of the page data. */
*(page_pointer + 1) = UX_SLAVE_CLASS_STORAGE_IEC_MODE_PAGE_PAGE_LENGTH;
mode_data_length += page_length;
}
/* Put the payload length in the header. */
if (mode_sense_command == UX_SLAVE_CLASS_STORAGE_SCSI_MODE_SENSE_SHORT)
* transfer_request -> ux_slave_transfer_request_data_pointer = (UCHAR)(mode_data_length);
else
_ux_utility_short_put_big_endian(transfer_request -> ux_slave_transfer_request_data_pointer, (USHORT)mode_data_length);
/* Store the write protection flag. */
*(transfer_request -> ux_slave_transfer_request_data_pointer + flags_index) = read_only_flag;
#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 = mode_data_length;
storage -> ux_device_class_storage_data_length = mode_data_length;
storage -> ux_device_class_storage_data_count = 0;
#else
/* Send a payload with the response buffer. */
_ux_device_stack_transfer_request(transfer_request, mode_sense_reply_length, mode_sense_reply_length);
#endif
/* Now we set the CSW with success. */
storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_PASSED;
status = UX_SUCCESS;
/* Return completion status. */
return(status);
}
|
