Outline ![]()
Files ![]()
loading...
CodeScope![]()
STM32 Libraries and Samples![]()
usbx![]()
common/usbx_device_classes/src/ux_device_class_storage_write.c
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** 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"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_class_storage_write PORTABLE C */
/* 6.1.10 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs a WRITE command in 32 or 16 bits. */
/* */
/* INPUT */
/* */
/* storage Pointer to storage class */
/* endpoint_in Pointer to IN endpoint */
/* endpoint_out Pointer to OUT endpoint */
/* cbwcb Pointer to the CBWCB */
/* scsi_command SCSI command */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* (ux_slave_class_storage_media_status) Get media status */
/* (ux_slave_class_storage_media_write) Write to media */
/* _ux_device_class_storage_csw_send Send CSW */
/* _ux_device_stack_endpoint_stall Stall endpoint */
/* _ux_device_stack_transfer_request Transfer request */
/* _ux_utility_long_get_big_endian Get 32-bit big endian */
/* _ux_utility_memory_allocate Allocate memory */
/* _ux_utility_memory_free Release memory */
/* _ux_utility_long_get_big_endian Get 32-bit big endian */
/* _ux_utility_short_get_big_endian Get 16-bit big endian */
/* */
/* CALLED BY */
/* */
/* Device Storage Class */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
/* optimized command logic, */
/* resulting in version 6.1 */
/* 12-31-2020 Chaoqiong Xiao Modified comment(s), */
/* fixed USB CV test issues, */
/* resulting in version 6.1.3 */
/* 01-31-2022 Chaoqiong Xiao Modified comment(s), */
/* added standalone support, */
/* resulting in version 6.1.10 */
/* */
/**************************************************************************/
UINT _ux_device_class_storage_write(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun,
UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR * cbwcb, UCHAR scsi_command)
{
UINT status;
UX_SLAVE_TRANSFER *transfer_request;
ULONG lba;
ULONG total_number_blocks;
ULONG media_status;
ULONG total_length;
#if !defined(UX_DEVICE_STANDALONE)
ULONG number_blocks;
ULONG transfer_length;
ULONG done_length;
#endif
UX_PARAMETER_NOT_USED(endpoint_in);
/* Get the LBA from the CBWCB. */
lba = _ux_utility_long_get_big_endian(cbwcb + UX_SLAVE_CLASS_STORAGE_WRITE_LBA);
/* The type of commands will tell us the width of the field containing the number
of sectors to read. */
if (scsi_command == UX_SLAVE_CLASS_STORAGE_SCSI_WRITE16)
/* Get the number of blocks from the CBWCB in 16 bits. */
total_number_blocks = _ux_utility_short_get_big_endian(cbwcb + UX_SLAVE_CLASS_STORAGE_WRITE_TRANSFER_LENGTH_16);
else
/* Get the number of blocks from the CBWCB in 32 bits. */
total_number_blocks = _ux_utility_long_get_big_endian(cbwcb + UX_SLAVE_CLASS_STORAGE_WRITE_TRANSFER_LENGTH_32);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_STORAGE_WRITE, storage, lun, lba, total_number_blocks, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
/* Obtain the pointer to the transfer request. */
transfer_request = &endpoint_out -> ux_slave_endpoint_transfer_request;
/* Obtain the status of the device. */
status = storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_status(storage,
lun, storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_id, &media_status);
/* Update the request sense. */
storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_request_sense_status = media_status;
/* Default CSW to failed. */
storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_FAILED;
/* If there is a problem, return a failed command. */
if (status != UX_SUCCESS)
{
/* We have a problem, media status error. Return a bad completion and wait for the
REQUEST_SENSE command. */
#if !defined(UX_DEVICE_STANDALONE)
_ux_device_stack_endpoint_stall(endpoint_out);
#endif
/* We are done here. */
return(UX_ERROR);
}
/* Check Read Only flag. */
if (storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_read_only_flag == UX_TRUE)
{
/* Update the request sense. */
storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_request_sense_status =
UX_DEVICE_CLASS_STORAGE_SENSE_STATUS(UX_SLAVE_CLASS_STORAGE_SENSE_KEY_DATA_PROTECT,
UX_SLAVE_CLASS_STORAGE_REQUEST_CODE_MEDIA_PROTECTED,0);
/* We have a problem, cannot write to RO drive. Return a bad completion and wait for the
REQUEST_SENSE command. */
#if !defined(UX_DEVICE_STANDALONE)
_ux_device_stack_endpoint_stall(endpoint_out);
#endif
/* We are done here. */
return(UX_ERROR);
}
/* Compute the total length to transfer and how much remains. */
total_length = total_number_blocks * storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_block_length;
#if defined(UX_DEVICE_STANDALONE)
/* Next: Transfer (DATA) -> Disk write. */
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_WRITE;
storage -> ux_device_class_storage_disk_state = UX_DEVICE_CLASS_STORAGE_DISK_USB_WAIT;
storage -> ux_device_class_storage_buffer_state[0] = UX_DEVICE_CLASS_STORAGE_BUFFER_EMPTY;
storage -> ux_device_class_storage_buffer_state[1] = UX_DEVICE_CLASS_STORAGE_BUFFER_EMPTY;
storage -> ux_device_class_storage_buffer_usb = 0;
storage -> ux_device_class_storage_buffer_disk = 0;
storage -> ux_device_class_storage_transfer = transfer_request;
storage -> ux_device_class_storage_device_length = total_length;
storage -> ux_device_class_storage_data_length = total_length;
storage -> ux_device_class_storage_data_count = 0;
storage -> ux_device_class_storage_cmd_lba = lba;
storage -> ux_device_class_storage_cmd_n_lb = total_number_blocks;
#else
/* Check transfer length. */
/* Case (3) Hn < Do. */
if (total_length > storage -> ux_slave_class_storage_host_length)
{
_ux_device_stack_endpoint_stall(endpoint_out);
storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_PHASE_ERROR;
return(UX_ERROR);
}
/* Case (8). Hi <> Do. */
if ((storage -> ux_slave_class_storage_cbw_flags & 0x80) != 0)
{
_ux_device_stack_endpoint_stall(endpoint_in);
storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_PHASE_ERROR;
return(UX_ERROR);
}
/* Default status to success. */
status = UX_SUCCESS;
/* It may take several transfers to send the requested data. */
done_length = 0;
while (total_length)
{
/* How much can we receive in this transfer? */
if (total_length > UX_SLAVE_CLASS_STORAGE_BUFFER_SIZE)
transfer_length = UX_SLAVE_CLASS_STORAGE_BUFFER_SIZE;
else
transfer_length = total_length;
/* Get the data payload from the host. */
status = _ux_device_stack_transfer_request(transfer_request, transfer_length, transfer_length);
/* Check the status. */
if (status != UX_SUCCESS)
{
/* We have a problem, request error. Return a bad completion and wait for the
REQUEST_SENSE command. */
_ux_device_stack_endpoint_stall(endpoint_out);
/* Update residue. */
storage -> ux_slave_class_storage_csw_residue = storage -> ux_slave_class_storage_host_length - done_length;
/* 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(0x02,0x54,0x00);
/* Return an error. */
return(UX_ERROR);
}
/* Compute the number of blocks to transfer. */
number_blocks = transfer_length / storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_block_length;
/* Execute the write command to the local media. */
status = storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_media_write(storage, lun, transfer_request -> ux_slave_transfer_request_data_pointer, number_blocks, lba, &media_status);
/* If there is a problem, return a failed command. */
if (status != UX_SUCCESS)
{
/* We have a problem, request error. Return a bad completion and wait for the
REQUEST_SENSE command. */
_ux_device_stack_endpoint_stall(endpoint_out);
/* Update residue. */
storage -> ux_slave_class_storage_csw_residue = storage -> ux_slave_class_storage_host_length - done_length;
/* And update the REQUEST_SENSE codes. */
storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_request_sense_status = media_status;
/* Return an error. */
return(UX_ERROR);
}
/* Update the lba. */
lba += number_blocks;
/* Update the length to remain. */
total_length -= transfer_length;
done_length += transfer_length;
}
/* Update residue. */
storage -> ux_slave_class_storage_csw_residue = storage -> ux_slave_class_storage_host_length - done_length;
/* Case (9), (11). If host expects more transfer, stall it. */
if (storage -> ux_slave_class_storage_csw_residue)
_ux_device_stack_endpoint_stall(endpoint_out);
#endif /* else defined(UX_DEVICE_STANDALONE) */
/* Now we set the CSW with success. */
storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_PASSED;
/* Return completion status. */
return(status);
}