Outline ![]()
Files ![]()
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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
/**************************************************************************/
/* */
/* 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 */
/** */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/* */
/* COMPONENT DEFINITION RELEASE */
/* */
/* ux_device_class_storage.h PORTABLE C */
/* 6.1.10 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This file contains all the header and extern functions used by the */
/* USBX 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 */
/* 08-02-2021 Chaoqiong Xiao Modified comment(s), */
/* added extern "C" keyword */
/* for compatibility with C++, */
/* resulting in version 6.1.8 */
/* 10-15-2021 Chaoqiong Xiao Modified comment(s), */
/* improved TAG management, */
/* resulting in version 6.1.9 */
/* 01-31-2022 Chaoqiong Xiao Modified comment(s), */
/* added standalone support, */
/* resulting in version 6.1.10 */
/* */
/**************************************************************************/
#ifndef UX_DEVICE_CLASS_STORAGE_H
#define UX_DEVICE_CLASS_STORAGE_H
/* Determine if a C++ compiler is being used. If so, ensure that standard
C is used to process the API information. */
#ifdef __cplusplus
/* Yes, C++ compiler is present. Use standard C. */
extern "C" {
#endif
/* Define User configurable Storage Class constants. */
#ifndef UX_MAX_SLAVE_LUN
#define UX_MAX_SLAVE_LUN 2
#endif
/* Define Storage Class USB Class constants. */
#define UX_SLAVE_CLASS_STORAGE_CLASS 8
#define UX_SLAVE_CLASS_STORAGE_SUBCLASS_RBC 1
#define UX_SLAVE_CLASS_STORAGE_SUBCLASS_SFF8020 2
#define UX_SLAVE_CLASS_STORAGE_SUBCLASS_UFI 4
#define UX_SLAVE_CLASS_STORAGE_SUBCLASS_SFF8070 5
#define UX_SLAVE_CLASS_STORAGE_SUBCLASS_SCSI 6
#define UX_SLAVE_CLASS_STORAGE_PROTOCOL_CBI 0
#define UX_SLAVE_CLASS_STORAGE_PROTOCOL_CB 1
#define UX_SLAVE_CLASS_STORAGE_PROTOCOL_BO 0x50
/* Define Storage Class USB MEDIA types. */
#define UX_SLAVE_CLASS_STORAGE_MEDIA_FAT_DISK 0
#define UX_SLAVE_CLASS_STORAGE_MEDIA_CDROM 5
#define UX_SLAVE_CLASS_STORAGE_MEDIA_OPTICAL_DISK 7
#define UX_SLAVE_CLASS_STORAGE_MEDIA_IOMEGA_CLICK 0x55
/* Define Storage Class SCSI command constants. */
#define UX_SLAVE_CLASS_STORAGE_SCSI_TEST_READY 0x00
#define UX_SLAVE_CLASS_STORAGE_SCSI_REQUEST_SENSE 0x03
#define UX_SLAVE_CLASS_STORAGE_SCSI_FORMAT 0x04
#define UX_SLAVE_CLASS_STORAGE_SCSI_INQUIRY 0x12
#define UX_SLAVE_CLASS_STORAGE_SCSI_MODE_SENSE_SHORT 0x1a
#define UX_SLAVE_CLASS_STORAGE_SCSI_START_STOP 0x1b
#define UX_SLAVE_CLASS_STORAGE_SCSI_PREVENT_ALLOW_MEDIA_REMOVAL 0x1e
#define UX_SLAVE_CLASS_STORAGE_SCSI_READ_FORMAT_CAPACITY 0x23
#define UX_SLAVE_CLASS_STORAGE_SCSI_READ_CAPACITY 0x25
#define UX_SLAVE_CLASS_STORAGE_SCSI_READ16 0x28
#define UX_SLAVE_CLASS_STORAGE_SCSI_WRITE16 0x2a
#define UX_SLAVE_CLASS_STORAGE_SCSI_VERIFY 0x2f
#define UX_SLAVE_CLASS_STORAGE_SCSI_SYNCHRONIZE_CACHE 0x35
#define UX_SLAVE_CLASS_STORAGE_SCSI_READ_TOC 0x43
#define UX_SLAVE_CLASS_STORAGE_SCSI_GET_CONFIGURATION 0x46
#define UX_SLAVE_CLASS_STORAGE_SCSI_GET_STATUS_NOTIFICATION 0x4A
#define UX_SLAVE_CLASS_STORAGE_SCSI_READ_DISK_INFORMATION 0x51
#define UX_SLAVE_CLASS_STORAGE_SCSI_MODE_SELECT 0x55
#define UX_SLAVE_CLASS_STORAGE_SCSI_MODE_SENSE 0x5a
#define UX_SLAVE_CLASS_STORAGE_SCSI_READ32 0xa8
#define UX_SLAVE_CLASS_STORAGE_SCSI_REPORT_KEY 0xa4
#define UX_SLAVE_CLASS_STORAGE_SCSI_WRITE32 0xaa
#define UX_SLAVE_CLASS_STORAGE_SCSI_GET_PERFORMANCE 0xac
#define UX_SLAVE_CLASS_STORAGE_SCSI_READ_DVD_STRUCTURE 0xad
/* Define Storage Class SCSI command block wrapper constants. */
#define UX_SLAVE_CLASS_STORAGE_CBW_SIGNATURE_MASK 0x43425355
#define UX_SLAVE_CLASS_STORAGE_CBW_SIGNATURE 0
#define UX_SLAVE_CLASS_STORAGE_CBW_TAG 4
#define UX_SLAVE_CLASS_STORAGE_CBW_DATA_LENGTH 8
#define UX_SLAVE_CLASS_STORAGE_CBW_FLAGS 12
#define UX_SLAVE_CLASS_STORAGE_CBW_LUN 13
#define UX_SLAVE_CLASS_STORAGE_CBW_CB_LENGTH 14
#define UX_SLAVE_CLASS_STORAGE_CBW_CB 15
#define UX_SLAVE_CLASS_STORAGE_CBW_LENGTH 31
#define UX_DEVICE_CLASS_STORAGE_CBW_FLAG_DIR (1u<<7)
#define UX_DEVICE_CLASS_STORAGE_CBW_FLAG_IN (1u<<7)
#define UX_DEVICE_CLASS_STORAGE_CBW_FLAG_D2H (1u<<7)
#define UX_DEVICE_CLASS_STORAGE_CBW_FLAG_OUT (0u)
#define UX_DEVICE_CLASS_STORAGE_CBW_FLAG_H2D (0u)
/* Define Storage Class SCSI response status wrapper constants. */
#define UX_SLAVE_CLASS_STORAGE_CSW_SIGNATURE_MASK 0x53425355
#define UX_SLAVE_CLASS_STORAGE_CSW_SIGNATURE 0
#define UX_SLAVE_CLASS_STORAGE_CSW_TAG 4
#define UX_SLAVE_CLASS_STORAGE_CSW_DATA_RESIDUE 8
#define UX_SLAVE_CLASS_STORAGE_CSW_STATUS 12
#define UX_SLAVE_CLASS_STORAGE_CSW_LENGTH 13
/* Define Storage Class SCSI inquiry command constants. */
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_OPERATION 0
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_LUN 1
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_PAGE_CODE 2
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_ALLOCATION_LENGTH 4
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_COMMAND_LENGTH_UFI 12
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_COMMAND_LENGTH_SBC 06
/* Define Storage Class SCSI inquiry response constants. */
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_PERIPHERAL_TYPE 0
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_REMOVABLE_MEDIA 1
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_DATA_FORMAT 3
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_ADDITIONAL_LENGTH 4
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_VENDOR_INFORMATION 8
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_PRODUCT_ID 16
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_PRODUCT_REVISION 32
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_LENGTH 36
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_RESPONSE_LENGTH_CD_ROM 0x5b
/* Define Storage Class SCSI start/stop command constants. */
#define UX_SLAVE_CLASS_STORAGE_START_STOP_OPERATION 0
#define UX_SLAVE_CLASS_STORAGE_START_STOP_LBUFLAGS 1
#define UX_SLAVE_CLASS_STORAGE_START_STOP_START_BIT 4
#define UX_SLAVE_CLASS_STORAGE_START_STOP_COMMAND_LENGTH_UFI 12
#define UX_SLAVE_CLASS_STORAGE_START_STOP_COMMAND_LENGTH_SBC 6
/* Define Storage Class SCSI mode sense command constants. */
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_OPERATION 0
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_LUN 1
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PC_PAGE_CODE 2
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_LIST_LENGTH_6 4
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_LIST_LENGTH_10 7
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_ALLOCATION_LENGTH_6 4
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_ALLOCATION_LENGTH_10 7
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_MEDIUM_TYPE_6 1
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_MEDIUM_TYPE_10 2
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_FLAGS_6 2
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_FLAGS_10 3
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_FLAG_WP 0x80
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_HEADER_LENGTH_6 4
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_PARAMETER_HEADER_LENGTH_10 8
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_COMMAND_LENGTH_UFI 12
#define UX_SLAVE_CLASS_STORAGE_MODE_SENSE_COMMAND_LENGTH_SBC 12
#define UX_SLAVE_CLASS_STORAGE_IEC_MODE_PAGE_PAGE_LENGTH 0x0A
#define UX_SLAVE_CLASS_STORAGE_CACHING_MODE_PAGE_PAGE_LENGTH 0x12
#define UX_SLAVE_CLASS_STORAGE_CACHING_MODE_PAGE_CODE 0
#define UX_SLAVE_CLASS_STORAGE_CACHING_MODE_PAGE_LENGTH 1
#define UX_SLAVE_CLASS_STORAGE_CACHING_MODE_PAGE_FLAGS 2
#define UX_SLAVE_CLASS_STORAGE_CACHING_MODE_PAGE_FLAG_WCE (1u<<2)
/* Define Storage Class SCSI request sense command constants. */
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_OPERATION 0
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_LUN 1
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_ALLOCATION_LENGTH 4
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_COMMAND_LENGTH_UFI 12
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_COMMAND_LENGTH_SBC 12
/* Define Storage Class request sense response constants. */
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_ERROR_CODE 0
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_SENSE_KEY 2
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_INFORMATION 3
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_ADD_LENGTH 7
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_CODE 12
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_CODE_QUALIFIER 13
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_LENGTH 18
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_HEADER_LENGTH 8
/* Define Storage Class read capacity command constants. */
#define UX_SLAVE_CLASS_STORAGE_READ_CAPACITY_OPERATION 0
#define UX_SLAVE_CLASS_STORAGE_READ_CAPACITY_LUN 1
#define UX_SLAVE_CLASS_STORAGE_READ_CAPACITY_LBA 2
#define UX_SLAVE_CLASS_STORAGE_READ_CAPACITY_COMMAND_LENGTH_UFI 12
#define UX_SLAVE_CLASS_STORAGE_READ_CAPACITY_COMMAND_LENGTH_SBC 10
/* Define Storage Class read capacity response constants. */
#define UX_SLAVE_CLASS_STORAGE_READ_CAPACITY_RESPONSE_LAST_LBA 0
#define UX_SLAVE_CLASS_STORAGE_READ_CAPACITY_RESPONSE_BLOCK_SIZE 4
#define UX_SLAVE_CLASS_STORAGE_READ_CAPACITY_RESPONSE_LENGTH 8
/* Define Storage Class read capacity response constants. */
#define UX_SLAVE_CLASS_STORAGE_READ_FORMAT_CAPACITY_RESPONSE_SIZE 0
#define UX_SLAVE_CLASS_STORAGE_READ_FORMAT_CAPACITY_RESPONSE_LAST_LBA 4
#define UX_SLAVE_CLASS_STORAGE_READ_FORMAT_CAPACITY_RESPONSE_DESC_CODE 8
#define UX_SLAVE_CLASS_STORAGE_READ_FORMAT_CAPACITY_RESPONSE_BLOCK_SIZE 8
#define UX_SLAVE_CLASS_STORAGE_READ_FORMAT_CAPACITY_RESPONSE_LENGTH 12
/* Define Storage Class test unit read command constants. */
#define UX_SLAVE_CLASS_STORAGE_TEST_READY_OPERATION 0
#define UX_SLAVE_CLASS_STORAGE_TEST_READY_LUN 1
#define UX_SLAVE_CLASS_STORAGE_TEST_READY_COMMAND_LENGTH_UFI 12
#define UX_SLAVE_CLASS_STORAGE_TEST_READY_COMMAND_LENGTH_SBC 6
/* Define Storage Class SCSI read command constants. */
#define UX_SLAVE_CLASS_STORAGE_READ_OPERATION 0
#define UX_SLAVE_CLASS_STORAGE_READ_LUN 1
#define UX_SLAVE_CLASS_STORAGE_READ_LBA 2
#define UX_SLAVE_CLASS_STORAGE_READ_TRANSFER_LENGTH_32 6
#define UX_SLAVE_CLASS_STORAGE_READ_TRANSFER_LENGTH_16 7
#define UX_SLAVE_CLASS_STORAGE_READ_COMMAND_LENGTH_UFI 12
#define UX_SLAVE_CLASS_STORAGE_READ_COMMAND_LENGTH_SBC 10
/* Define Storage Class SCSI write command constants. */
#define UX_SLAVE_CLASS_STORAGE_WRITE_OPERATION 0
#define UX_SLAVE_CLASS_STORAGE_WRITE_LUN 1
#define UX_SLAVE_CLASS_STORAGE_WRITE_LBA 2
#define UX_SLAVE_CLASS_STORAGE_WRITE_TRANSFER_LENGTH_32 6
#define UX_SLAVE_CLASS_STORAGE_WRITE_TRANSFER_LENGTH_16 7
#define UX_SLAVE_CLASS_STORAGE_WRITE_COMMAND_LENGTH_UFI 12
#define UX_SLAVE_CLASS_STORAGE_WRITE_COMMAND_LENGTH_SBC 10
/* Define Storage Class SCSI sense key definition constants. */
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_NO_SENSE 0x0
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_RECOVERED_ERROR 0x1
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_NOT_READY 0x2
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_MEDIUM_ERROR 0x3
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_HARDWARE_ERROR 0x4
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_ILLEGAL_REQUEST 0x5
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_UNIT_ATTENTION 0x6
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_DATA_PROTECT 0x7
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_BLANK_CHECK 0x8
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_ABORTED_COMMAND 0x0b
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_VOLUME_OVERFLOW 0x0d
#define UX_SLAVE_CLASS_STORAGE_SENSE_KEY_MISCOMPARE 0x0e
/* Define Storage Class SCSI sense key definition constants. */
#define UX_SLAVE_CLASS_STORAGE_REQUEST_CODE_MEDIA_PROTECTED 0x27
/* Define Storage Class SCSI GET CONFIGURATION command constants. */
#define UX_SLAVE_CLASS_STORAGE_GET_CONFIGURATION_OPERATION 0
#define UX_SLAVE_CLASS_STORAGE_GET_CONFIGURATION_RT 1
#define UX_SLAVE_CLASS_STORAGE_GET_CONFIGURATION_STARTING_FEATURE 2
#define UX_SLAVE_CLASS_STORAGE_GET_CONFIGURATION_ALLOCATION_LENGTH 7
#define UX_SLAVE_CLASS_STORAGE_GET_CONFIGURATION_COMMAND_LENGTH_SBC 9
/* Define Storage Class SCSI ASC return codes. */
#define UX_SLAVE_CLASS_STORAGE_ASC_KEY_INVALID_COMMAND 0x20
/* Define Storage Class CSW status. */
#define UX_SLAVE_CLASS_STORAGE_CSW_PASSED 0
#define UX_SLAVE_CLASS_STORAGE_CSW_FAILED 1
#define UX_SLAVE_CLASS_STORAGE_CSW_PHASE_ERROR 2
/* Define generic SCSI values. */
#define UX_SLAVE_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_ERROR_CODE_VALUE 0x70
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_PAGE_CODE_STANDARD 0x00
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_PAGE_CODE_SERIAL 0x80
#define UX_SLAVE_CLASS_STORAGE_INQUIRY_PERIPHERAL_TYPE 0x00
#define UX_SLAVE_CLASS_STORAGE_RESET 0xff
#define UX_SLAVE_CLASS_STORAGE_GET_MAX_LUN 0xfe
#define UX_SLAVE_CLASS_STORAGE_MAX_LUN 0
#define UX_SLAVE_CLASS_STORAGE_RESPONSE_LENGTH 64
/* Define Storage Class SCSI read disk information command constants. */
#define UX_SLAVE_CLASS_STORAGE_READ_DISK_INFORMATION_OPERATION 0
#define UX_SLAVE_CLASS_STORAGE_READ_DISK_INFORMATION_STATUS 2
#define UX_SLAVE_CLASS_STORAGE_READ_DISK_INFORMATION_ALLOCATION_LENGTH 7
#define UX_SLAVE_CLASS_STORAGE_READ_DISK_INFORMATION_LENGTH 10
/* Define Storage Class Feature Descriptor generic format. */
#define USBX_DEVICE_CLASS_STORAGE_FEATURE_DESCRIPTOR_FEATURE_CODE 0
#define USBX_DEVICE_CLASS_STORAGE_FEATURE_DESCRIPTOR_FEATURE_PARAMETER 2
#define USBX_DEVICE_CLASS_STORAGE_FEATURE_DESCRIPTOR_FEATURE_ADD_LENGTH 3
#define USBX_DEVICE_CLASS_STORAGE_FEATURE_DESCRIPTOR_FEATURE_LENGTH 4
/* Define Storage Class SCSI REPORT_KEY command constants. */
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_OPERATION 0
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_ALLOCATION_LENGTH 8
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_FORMAT 10
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_ANSWER_LENGTH 8
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_ANSWER_PAYLOAD 6
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_ANSWER_RESET_FIELD 4
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_ANSWER_REGION_MASK 5
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_ANSWER_RPC_SCHEME 6
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_FORMAT_AGID 0
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_FORMAT_CHALLENGE 1
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_FORMAT_KEY2 2
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_FORMAT_TITLE 4
#define UX_SLAVE_CLASS_STORAGE_REPORT_KEY_FORMAT_RPC 8
/* Define Storage Class SCSI get event status notification command constants. */
#define UX_SLAVE_CLASS_STORAGE_EVENT_NOTIFICATION_OPCODE 0
#define UX_SLAVE_CLASS_STORAGE_EVENT_NOTIFICATION_IMMEDIATE 1
#define UX_SLAVE_CLASS_STORAGE_EVENT_NOTIFICATION_CLASS_REQUEST 4
#define UX_SLAVE_CLASS_STORAGE_EVENT_NOTIFICATION_ALLOCATION_LENGTH 7
#define UX_SLAVE_CLASS_STORAGE_EVENT_NOTIFICATION_LENGTH 10
/* Define Storage Class SCSI read toc command constants. */
#define UX_SLAVE_CLASS_STORAGE_READ_TOC_OPCODE 0
#define UX_SLAVE_CLASS_STORAGE_READ_TOC_FORMAT 2
#define UX_SLAVE_CLASS_STORAGE_READ_TOC_TRACK_NUMBER 6
#define UX_SLAVE_CLASS_STORAGE_READ_TOC_ALLOCATION_LENGTH 7
/* Define Storage Class SCSI read DVD structure command constants. */
#define UX_SLAVE_CLASS_STORAGE_READ_DVD_STRUCTURE_OPCODE 0
#define UX_SLAVE_CLASS_STORAGE_READ_DVD_STRUCTURE_ADDRESS 2
#define UX_SLAVE_CLASS_STORAGE_READ_DVD_STRUCTURE_FORMAT 7
#define UX_SLAVE_CLASS_STORAGE_READ_DVD_STRUCTURE_ALLOCATION_LENGTH 8
#define UX_SLAVE_CLASS_STORAGE_READ_DVD_STRUCTURE_RESP_LENGTH 0
#define UX_SLAVE_CLASS_STORAGE_READ_DVD_STRUCTURE_BOOK_TYPE 4
#define UX_SLAVE_CLASS_STORAGE_READ_DVD_STRUCTURE_DS_MR 5
/* Define Storage Class SCSI get performance command constants. */
#define UX_SLAVE_CLASS_STORAGE_GET_PERFORMANCE_PAGE 1
#define UX_SLAVE_CLASS_STORAGE_GET_PERFORMANCE_PAGE_14 0x14
#define UX_SLAVE_CLASS_STORAGE_GET_PERFORMANCE_PAGE_0 0x00
#define UX_SLAVE_CLASS_STORAGE_GET_PERFORMANCE_PAYLOAD_LENGTH 4
#define UX_SLAVE_CLASS_STORAGE_GET_PERFORMANCE_RESPONSE_LENGTH 8
#define UX_SLAVE_CLASS_STORAGE_GET_PERFORMANCE_PAYLOAD 0x20000000
/* Define buffer length for IN/OUT pipes. This should match the size of the endpoint maximum buffer size. */
#define UX_SLAVE_CLASS_STORAGE_BUFFER_SIZE UX_SLAVE_REQUEST_DATA_MAX_LENGTH
/* Define MMC2 CD-ROM / DVD-ROM bit fields */
#define UX_SLAVE_CLASS_STORAGE_MMC2_DISK_STATUS_EMPTY 0
#define UX_SLAVE_CLASS_STORAGE_MMC2_DISK_STATUS_INCOMPLETE 1
#define UX_SLAVE_CLASS_STORAGE_MMC2_DISK_STATUS_COMPLETE 2
#define UX_SLAVE_CLASS_STORAGE_MMC2_DISK_STATUS_OTHERS 3
#define UX_SLAVE_CLASS_STORAGE_MMC2_LAT_SESSION_EMPTY 0
#define UX_SLAVE_CLASS_STORAGE_MMC2_LAT_SESSION_INCOMPLETE 1
#define UX_SLAVE_CLASS_STORAGE_MMC2_LAT_SESSION_COMPLETE 3
/* Define Storage Class SCSI synchronize cache constants. */
#define UX_SLAVE_CLASS_STORAGE_SYNCHRONIZE_CACHE_FLAGS 1
#define UX_SLAVE_CLASS_STORAGE_SYNCHRONIZE_CACHE_LBA 2
#define UX_SLAVE_CLASS_STORAGE_SYNCHRONIZE_CACHE_NUMBER_OF_BLOCKS 7
#define UX_SLAVE_CLASS_STORAGE_SYNCHRONIZE_CACHE_FLAGS_IMMED 0x02
/* Define MODE SENSE Page Codes. */
#define UX_SLAVE_CLASS_STORAGE_MMC2_PAGE_CODE_CDROM 0x2a
#define UX_SLAVE_CLASS_STORAGE_PAGE_CODE_CACHE 0x08
#define UX_SLAVE_CLASS_STORAGE_PAGE_CODE_IEC 0x1C
#define UX_SLAVE_CLASS_STORAGE_PAGE_CODE_ALL 0x3F
#if defined(UX_DEVICE_STANDALONE)
/* Define Device Storage Class states. */
#define UX_DEVICE_CLASS_STORAGE_STATE_IDLE (UX_STATE_STEP + 0)
#define UX_DEVICE_CLASS_STORAGE_STATE_RESET (UX_STATE_STEP + 1)
#define UX_DEVICE_CLASS_STORAGE_STATE_RESET_WAIT (UX_STATE_STEP + 2)
#define UX_DEVICE_CLASS_STORAGE_STATE_TRANS_START (UX_STATE_STEP + 3)
#define UX_DEVICE_CLASS_STORAGE_STATE_TRANS_WAIT (UX_STATE_STEP + 4)
#define UX_DEVICE_CLASS_STORAGE_STATE_TRANS_NEXT (UX_STATE_STEP + 5)
#define UX_DEVICE_CLASS_STORAGE_STATE_DISK_WAIT (UX_STATE_STEP + 6)
#define UX_DEVICE_CLASS_STORAGE_STATE_DISK_ERROR (UX_STATE_STEP + 7)
#define UX_DEVICE_CLASS_STORAGE_DISK_IDLE (0)
#define UX_DEVICE_CLASS_STORAGE_DISK_OP_START (1)
#define UX_DEVICE_CLASS_STORAGE_DISK_OP_WAIT (2)
#define UX_DEVICE_CLASS_STORAGE_DISK_OP_NEXT (3)
#define UX_DEVICE_CLASS_STORAGE_DISK_USB_WAIT (4)
#define UX_DEVICE_CLASS_STORAGE_DISK_USB_ERROR (5)
#define UX_DEVICE_CLASS_STORAGE_BUFFER_IDLE (0)
#define UX_DEVICE_CLASS_STORAGE_BUFFER_EMPTY (1)
#define UX_DEVICE_CLASS_STORAGE_BUFFER_FULL (2)
#define UX_DEVICE_CLASS_STORAGE_CMD_IDLE (0)
#define UX_DEVICE_CLASS_STORAGE_CMD_CBW (1)
#define UX_DEVICE_CLASS_STORAGE_CMD_ERR (2)
#define UX_DEVICE_CLASS_STORAGE_CMD_CSW (3)
#define UX_DEVICE_CLASS_STORAGE_CMD_WRITE (4)
#define UX_DEVICE_CLASS_STORAGE_CMD_READ (5)
#define UX_DEVICE_CLASS_STORAGE_CMD_DISK_OP (6)
#endif
/* Define Slave Storage Class LUN structure. */
typedef struct UX_SLAVE_CLASS_STORAGE_LUN_STRUCT
{
ULONG ux_slave_class_storage_media_last_lba;
ULONG ux_slave_class_storage_media_block_length;
ULONG ux_slave_class_storage_media_type;
ULONG ux_slave_class_storage_media_removable_flag;
ULONG ux_slave_class_storage_media_read_only_flag;
ULONG ux_slave_class_storage_media_id;
ULONG ux_slave_class_storage_request_sense_status;
ULONG ux_slave_class_storage_disk_status;
ULONG ux_slave_class_storage_last_session_state;
UINT (*ux_slave_class_storage_media_read)(VOID *storage, ULONG lun, UCHAR *data_pointer, ULONG number_blocks, ULONG lba, ULONG *media_status);
UINT (*ux_slave_class_storage_media_write)(VOID *storage, ULONG lun, UCHAR *data_pointer, ULONG number_blocks, ULONG lba, ULONG *media_status);
UINT (*ux_slave_class_storage_media_flush)(VOID *storage, ULONG lun, ULONG number_blocks, ULONG lba, ULONG *media_status);
UINT (*ux_slave_class_storage_media_status)(VOID *storage, ULONG lun, ULONG media_id, ULONG *media_status);
UINT (*ux_slave_class_storage_media_notification)(VOID *storage, ULONG lun, ULONG media_id, ULONG notification_class, UCHAR **media_notification, ULONG *media_notification_length);
} UX_SLAVE_CLASS_STORAGE_LUN;
/* Sense status value (key at bit0-7, code at bit8-15 and qualifier at bit16-23). */
#define UX_DEVICE_CLASS_STORAGE_SENSE_STATUS(key,code,qualifier) (((key) & 0xFF)|(((code) & 0xFF) << 8)|(((qualifier) & 0xFF) << 16))
#define UX_DEVICE_CLASS_STORAGE_SENSE_KEY(status) ((status) & 0xFF)
#define UX_DEVICE_CLASS_STORAGE_SENSE_CODE(status) (((status) >> 8) & 0xFF)
#define UX_DEVICE_CLASS_STORAGE_SENSE_QUALIFIER(status) (((status) >> 16) & 0xFF)
/* Define Slave Storage Class structure. */
typedef struct UX_SLAVE_CLASS_STORAGE_STRUCT
{
UX_SLAVE_INTERFACE *ux_slave_class_storage_interface;
ULONG ux_slave_class_storage_number_lun;
UX_SLAVE_CLASS_STORAGE_LUN ux_slave_class_storage_lun[UX_MAX_SLAVE_LUN];
ULONG ux_slave_class_storage_host_length;
UCHAR ux_slave_class_storage_cbw_flags;
UCHAR ux_slave_class_storage_cbw_lun;
UCHAR ux_slave_class_storage_reserved[2];
ULONG ux_slave_class_storage_scsi_tag;
ULONG ux_slave_class_storage_csw_residue;
ULONG ux_slave_class_storage_csw_status;
VOID (*ux_slave_class_storage_instance_activate)(VOID *);
VOID (*ux_slave_class_storage_instance_deactivate)(VOID *);
UCHAR *ux_slave_class_storage_vendor_id;
UCHAR *ux_slave_class_storage_product_id;
UCHAR *ux_slave_class_storage_product_rev;
UCHAR *ux_slave_class_storage_product_serial;
#if defined(UX_DEVICE_STANDALONE)
UCHAR *ux_device_class_storage_buffer[2];
UCHAR ux_device_class_storage_buffer_state[2];
UCHAR ux_device_class_storage_buffer_usb;
UCHAR ux_device_class_storage_buffer_disk;
UCHAR ux_device_class_storage_cmd;
UCHAR ux_device_class_storage_cmd_state;
UCHAR ux_device_class_storage_disk_state;
UCHAR ux_device_class_storage_state;
UX_SLAVE_ENDPOINT *ux_device_class_storage_ep_out;
UX_SLAVE_ENDPOINT *ux_device_class_storage_ep_in;
UX_SLAVE_TRANSFER *ux_device_class_storage_transfer;
ULONG ux_device_class_storage_device_length;
UCHAR *ux_device_class_storage_data_buffer;
ULONG ux_device_class_storage_data_length;
ULONG ux_device_class_storage_data_count;
ULONG ux_device_class_storage_trans_host_length;
ULONG ux_device_class_storage_trans_device_length;
ULONG ux_device_class_storage_cmd_lba;
ULONG ux_device_class_storage_cmd_n_lb;
ULONG ux_device_class_storage_disk_n_lb;
ULONG ux_device_class_storage_media_status;
#endif
} UX_SLAVE_CLASS_STORAGE;
#define UX_DEVICE_CLASS_STORAGE_CSW_STATUS(p) (((UCHAR*)(p))[0])
#define UX_DEVICE_CLASS_STORAGE_CSW_SKIP(p) (((UCHAR*)(p))[3])
/* Define Slave Storage Class Calling Parameter structure */
typedef struct UX_SLAVE_CLASS_STORAGE_PARAMETER_STRUCT
{
VOID (*ux_slave_class_storage_instance_activate)(VOID *);
VOID (*ux_slave_class_storage_instance_deactivate)(VOID *);
ULONG ux_slave_class_storage_parameter_number_lun;
UX_SLAVE_CLASS_STORAGE_LUN ux_slave_class_storage_parameter_lun[UX_MAX_SLAVE_LUN];
UCHAR *ux_slave_class_storage_parameter_vendor_id;
UCHAR *ux_slave_class_storage_parameter_product_id;
UCHAR *ux_slave_class_storage_parameter_product_rev;
UCHAR *ux_slave_class_storage_parameter_product_serial;
} UX_SLAVE_CLASS_STORAGE_PARAMETER;
/* Define Device Storage Class prototypes. */
UINT _ux_device_class_storage_initialize(UX_SLAVE_CLASS_COMMAND *command);
UINT _ux_device_class_storage_uninitialize(UX_SLAVE_CLASS_COMMAND *command);
UINT _ux_device_class_storage_activate(UX_SLAVE_CLASS_COMMAND *command);
UINT _ux_device_class_storage_control_request(UX_SLAVE_CLASS_COMMAND *command);
UINT _ux_device_class_storage_csw_send(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in, UCHAR csw_status);
UINT _ux_device_class_storage_deactivate(UX_SLAVE_CLASS_COMMAND *command);
UINT _ux_device_class_storage_entry(UX_SLAVE_CLASS_COMMAND *command);
UINT _ux_device_class_storage_format(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
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 _ux_device_class_storage_mode_select(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
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 _ux_device_class_storage_prevent_allow_media_removal(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun,
UX_SLAVE_ENDPOINT *endpoint_in, UX_SLAVE_ENDPOINT *endpoint_out, UCHAR * cbwcb);
UINT _ux_device_class_storage_read(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb, UCHAR scsi_command);
UINT _ux_device_class_storage_read_capacity(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
UINT _ux_device_class_storage_read_format_capacity(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
UINT _ux_device_class_storage_read_toc(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR * cbwcb);
UINT _ux_device_class_storage_request_sense(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
UINT _ux_device_class_storage_start_stop(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
UINT _ux_device_class_storage_test_ready(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
VOID _ux_device_class_storage_thread(ULONG storage_instance);
UINT _ux_device_class_storage_verify(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
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 _ux_device_class_storage_synchronize_cache(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun, UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb, UCHAR scsi_command);
UINT _ux_device_class_storage_read_disk_information(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun,
UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
UINT _ux_device_class_storage_get_configuration(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun,
UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
UINT _ux_device_class_storage_get_status_notification(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun,
UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
UINT _ux_device_class_storage_report_key(UX_SLAVE_CLASS_STORAGE *storage,
ULONG lun,
UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out,
UCHAR *cbwcb);
UINT _ux_device_class_storage_get_performance(UX_SLAVE_CLASS_STORAGE *storage,
ULONG lun,
UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out,
UCHAR *cbwcb);
UINT _ux_device_class_storage_read_dvd_structure(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun,
UX_SLAVE_ENDPOINT *endpoint_in,
UX_SLAVE_ENDPOINT *endpoint_out, UCHAR *cbwcb);
UINT _ux_device_class_storage_tasks_run(VOID *instance);
/* Define Device Storage Class API prototypes. */
#define ux_device_class_storage_entry _ux_device_class_storage_entry
/* Determine if a C++ compiler is being used. If so, complete the standard
C conditional started above. */
#ifdef __cplusplus
}
#endif
#endif
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.