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
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
|
/***************************************************************************
* 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 */
/** */
/** Storage Class */
/** */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/* */
/* COMPONENT DEFINITION RELEASE */
/* */
/* ux_host_class_storage.h PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This file contains all the header and extern functions used by the */
/* USBX storage class. */
/* */
/**************************************************************************/
#ifndef UX_HOST_CLASS_STORAGE_H
#define UX_HOST_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
/* Internal option: enable the basic USBX error checking. This define is typically used
while debugging application. */
#if defined(UX_ENABLE_ERROR_CHECKING) && !defined(UX_HOST_CLASS_STORAGE_ENABLE_ERROR_CHECKING)
#define UX_HOST_CLASS_STORAGE_ENABLE_ERROR_CHECKING
#endif
#if !defined(UX_HOST_CLASS_STORAGE_NO_FILEX) && !defined(UX_HOST_STANDALONE)
/* Include the FileX API. */
#include "fx_api.h"
/* Refine media stubs. */
#ifndef UX_MEDIA
#define UX_MEDIA FX_MEDIA
#endif
#ifndef ux_media_id_get
#define ux_media_id_get(m) ((m)->fx_media_id)
#endif
#ifndef ux_media_id_set
#define ux_media_id_set(m,id) ((m)->fx_media_id=(id))
#endif
#ifndef ux_media_driver_info_get
#define ux_media_driver_info_get(m) ((m)->fx_media_driver_info)
#endif
#ifndef ux_media_driver_info_set
#define ux_media_driver_info_set(m,i) ((m)->fx_media_driver_info=(VOID*)(i))
#endif
#ifndef ux_media_reserved_for_user_get
#define ux_media_reserved_for_user_get(m) ((m)->fx_media_reserved_for_user)
#endif
#ifndef ux_media_reserved_for_user_set
#define ux_media_reserved_for_user_set(m,u) ((m)->fx_media_reserved_for_user=(ALIGN_TYPE)(u))
#endif
#ifndef ux_media_open
#define ux_media_open fx_media_open
#endif
#ifndef ux_media_close
#define ux_media_close fx_media_close
#endif
#endif
/* Define User configurable Storage Class constants. */
#ifndef UX_MAX_HOST_LUN
#define UX_MAX_HOST_LUN 1
#endif
#ifndef UX_HOST_CLASS_STORAGE_MAX_MEDIA
#define UX_HOST_CLASS_STORAGE_MAX_MEDIA 1
#endif
#ifndef UX_HOST_CLASS_STORAGE_MEMORY_BUFFER_SIZE
#define UX_HOST_CLASS_STORAGE_MEMORY_BUFFER_SIZE (1024)
#endif
#ifndef UX_HOST_CLASS_STORAGE_MAX_TRANSFER_SIZE
#define UX_HOST_CLASS_STORAGE_MAX_TRANSFER_SIZE (1024)
#endif
#ifndef UX_HOST_CLASS_STORAGE_THREAD_STACK_SIZE
#define UX_HOST_CLASS_STORAGE_THREAD_STACK_SIZE UX_THREAD_STACK_SIZE
#endif
#if defined(UX_HOST_STANDALONE) && !defined(UX_HOST_CLASS_STORAGE_NO_FILEX)
#define UX_HOST_CLASS_STORAGE_NO_FILEX
#endif
/* Define Storage Class constants. */
#define UX_HOST_CLASS_STORAGE_DEVICE_INIT_DELAY (200)
#define UX_HOST_CLASS_STORAGE_THREAD_SLEEP_TIME (2000)
#define UX_HOST_CLASS_STORAGE_INSTANCE_SHUTDOWN_TIMER (10)
#define UX_HOST_CLASS_STORAGE_THREAD_PRIORITY_CLASS 20
#define UX_HOST_CLASS_STORAGE_TRANSFER_TIMEOUT 10000
#define UX_HOST_CLASS_STORAGE_CBI_STATUS_TIMEOUT 3000
#define UX_HOST_CLASS_STORAGE_CLASS 8
#define UX_HOST_CLASS_STORAGE_SUBCLASS_RBC 1
#define UX_HOST_CLASS_STORAGE_SUBCLASS_SFF8020 2
#define UX_HOST_CLASS_STORAGE_SUBCLASS_UFI 4
#define UX_HOST_CLASS_STORAGE_SUBCLASS_SFF8070 5
#define UX_HOST_CLASS_STORAGE_SUBCLASS_SCSI 6
#define UX_HOST_CLASS_STORAGE_CBW_SIZE 64
#define UX_HOST_CLASS_STORAGE_PROTOCOL_CBI 0
#define UX_HOST_CLASS_STORAGE_PROTOCOL_CB 1
#define UX_HOST_CLASS_STORAGE_PROTOCOL_BO 0x50
#define UX_HOST_CLASS_STORAGE_DATA_OUT 0
#define UX_HOST_CLASS_STORAGE_DATA_IN 0x80
#define UX_HOST_CLASS_STORAGE_CSW_PASSED 0
#define UX_HOST_CLASS_STORAGE_CSW_FAILED 1
#define UX_HOST_CLASS_STORAGE_CSW_PHASE_ERROR 2
#define UX_HOST_CLASS_STORAGE_CBW_SIGNATURE_MASK 0x43425355
#define UX_HOST_CLASS_STORAGE_CBW_TAG_MASK 0x55534243
#define UX_HOST_CLASS_STORAGE_MEDIA_NAME "usb disk"
#define UX_HOST_CLASS_STORAGE_MEDIA_REMOVABLE 0x80
#define UX_HOST_CLASS_STORAGE_MEDIA_UNKNOWN 0
#define UX_HOST_CLASS_STORAGE_MEDIA_KNOWN 1
#define UX_HOST_CLASS_STORAGE_MEDIA_FAT_DISK 0
#define UX_HOST_CLASS_STORAGE_MEDIA_CDROM 5
#define UX_HOST_CLASS_STORAGE_MEDIA_OPTICAL_DISK 7
#define UX_HOST_CLASS_STORAGE_MEDIA_IOMEGA_CLICK 0x55
#define UX_HOST_CLASS_STORAGE_RESET 0xff
#define UX_HOST_CLASS_STORAGE_GET_MAX_LUN 0xfe
#define UX_HOST_CLASS_STORAGE_TRANSPORT_ERROR 1
#define UX_HOST_CLASS_STORAGE_COMMAND_ERROR 2
#define UX_HOST_CLASS_STORAGE_SENSE_ERROR 3
#define UX_HOST_CLASS_STORAGE_SECTOR_SIZE_FAT 512
#define UX_HOST_CLASS_STORAGE_SECTOR_SIZE_OTHER 2048
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_RETRY 10
#define UX_HOST_CLASS_STORAGE_START_MEDIA 1
#define UX_HOST_CLASS_STORAGE_STOP_MEDIA 0
#define UX_HOST_CLASS_STORAGE_MEDIA_UNMOUNTED 0
#define UX_HOST_CLASS_STORAGE_MEDIA_MOUNTED 1
/* Define Storage Class SCSI command constants. */
#define UX_HOST_CLASS_STORAGE_SCSI_TEST_READY 0x00
#define UX_HOST_CLASS_STORAGE_SCSI_REQUEST_SENSE 0x03
#define UX_HOST_CLASS_STORAGE_SCSI_FORMAT 0x04
#define UX_HOST_CLASS_STORAGE_SCSI_INQUIRY 0x12
#define UX_HOST_CLASS_STORAGE_SCSI_MODE_SENSE_SHORT 0x1a
#define UX_HOST_CLASS_STORAGE_SCSI_START_STOP 0x1b
#define UX_HOST_CLASS_STORAGE_SCSI_READ_FORMAT_CAPACITY 0x23
#define UX_HOST_CLASS_STORAGE_SCSI_READ_CAPACITY 0x25
#define UX_HOST_CLASS_STORAGE_SCSI_READ16 0x28
#define UX_HOST_CLASS_STORAGE_SCSI_WRITE16 0x2a
#define UX_HOST_CLASS_STORAGE_SCSI_VERIFY 0x2f
#define UX_HOST_CLASS_STORAGE_SCSI_MODE_SELECT 0x55
#define UX_HOST_CLASS_STORAGE_SCSI_MODE_SENSE 0x5a
#define UX_HOST_CLASS_STORAGE_SCSI_READ32 0xa8
#define UX_HOST_CLASS_STORAGE_SCSI_WRITE32 0xaa
/* Define Storage Class SCSI command block wrapper constants. */
#define UX_HOST_CLASS_STORAGE_CBW_SIGNATURE 0
#define UX_HOST_CLASS_STORAGE_CBW_TAG 4
#define UX_HOST_CLASS_STORAGE_CBW_DATA_LENGTH 8
#define UX_HOST_CLASS_STORAGE_CBW_FLAGS 12
#define UX_HOST_CLASS_STORAGE_CBW_LUN 13
#define UX_HOST_CLASS_STORAGE_CBW_CB_LENGTH 14
#define UX_HOST_CLASS_STORAGE_CBW_CB 15
/* Define Storage Class SCSI response status wrapper constants. */
#define UX_HOST_CLASS_STORAGE_CSW_SIGNATURE 0
#define UX_HOST_CLASS_STORAGE_CSW_TAG 4
#define UX_HOST_CLASS_STORAGE_CSW_DATA_RESIDUE 8
#define UX_HOST_CLASS_STORAGE_CSW_STATUS 12
#define UX_HOST_CLASS_STORAGE_CSW_LENGTH 13
/* Define Storage Class SCSI inquiry command constants. */
#define UX_HOST_CLASS_STORAGE_INQUIRY_OPERATION 0
#define UX_HOST_CLASS_STORAGE_INQUIRY_LUN 1
#define UX_HOST_CLASS_STORAGE_INQUIRY_PAGE_CODE 2
#define UX_HOST_CLASS_STORAGE_INQUIRY_ALLOCATION_LENGTH 4
#define UX_HOST_CLASS_STORAGE_INQUIRY_COMMAND_LENGTH_UFI 12
#define UX_HOST_CLASS_STORAGE_INQUIRY_COMMAND_LENGTH_SBC 06
/* Define Storage Class SCSI inquiry response constants. */
#define UX_HOST_CLASS_STORAGE_INQUIRY_RESPONSE_PERIPHERAL_TYPE 0
#define UX_HOST_CLASS_STORAGE_INQUIRY_RESPONSE_REMOVABLE_MEDIA 1
#define UX_HOST_CLASS_STORAGE_INQUIRY_RESPONSE_DATA_FORMAT 3
#define UX_HOST_CLASS_STORAGE_INQUIRY_RESPONSE_ADDITIONAL_LENGTH 4
#define UX_HOST_CLASS_STORAGE_INQUIRY_RESPONSE_VENDOR_INFORMATION 8
#define UX_HOST_CLASS_STORAGE_INQUIRY_RESPONSE_PRODUCT_ID 16
#define UX_HOST_CLASS_STORAGE_INQUIRY_RESPONSE_PRODUCT_REVISION 32
#define UX_HOST_CLASS_STORAGE_INQUIRY_RESPONSE_LENGTH 36
/* Define Storage Class SCSI start/stop command constants. */
#define UX_HOST_CLASS_STORAGE_START_STOP_OPERATION 0
#define UX_HOST_CLASS_STORAGE_START_STOP_LBUFLAGS 1
#define UX_HOST_CLASS_STORAGE_START_STOP_START_BIT 4
#define UX_HOST_CLASS_STORAGE_START_STOP_COMMAND_LENGTH_UFI 12
#define UX_HOST_CLASS_STORAGE_START_STOP_COMMAND_LENGTH_SBC 12
/* Define Storage Class SCSI mode sense command constants. */
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_OPERATION 0
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_LUN 1
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_PC_PAGE_CODE 2
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_PARAMETER_LIST_LENGTH 7
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_COMMAND_LENGTH_UFI 12
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_COMMAND_LENGTH_SBC 12
/* Define Storage Class SCSI mode sense command constants. */
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_RESPONSE_MODE_DATA_LENGTH 0
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_RESPONSE_MEDIUM_TYPE_CODE 2
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_RESPONSE_ATTRIBUTES_SHORT 2
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_RESPONSE_ATTRIBUTES 3
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_RESPONSE_ATTRIBUTES_WP 0x80
/* Define Storage Class SCSI request sense command constants. */
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_OPERATION 0
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_LUN 1
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_ALLOCATION_LENGTH 4
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_COMMAND_LENGTH_UFI 12
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_COMMAND_LENGTH_SBC 12
/* Define Storage Class request sense response constants. */
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_ERROR_CODE 0
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_SENSE_KEY 2
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_INFORMATION 3
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_ADD_LENGTH 7
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_CODE 12
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_CODE_QUALIFIER 13
#define UX_HOST_CLASS_STORAGE_REQUEST_SENSE_RESPONSE_LENGTH 18
/* Define Storage Class read format command constants. */
#define UX_HOST_CLASS_STORAGE_READ_FORMAT_OPERATION 0
#define UX_HOST_CLASS_STORAGE_READ_FORMAT_LUN 1
#define UX_HOST_CLASS_STORAGE_READ_FORMAT_LBA 2
#define UX_HOST_CLASS_STORAGE_READ_FORMAT_PARAMETER_LIST_LENGTH 7
#define UX_HOST_CLASS_STORAGE_READ_FORMAT_COMMAND_LENGTH_UFI 12
#define UX_HOST_CLASS_STORAGE_READ_FORMAT_COMMAND_LENGTH_SBC 10
#define UX_HOST_CLASS_STORAGE_READ_FORMAT_RESPONSE_LENGTH 0xFC
/* Define Storage Class read capacity command constants. */
#define UX_HOST_CLASS_STORAGE_READ_CAPACITY_OPERATION 0
#define UX_HOST_CLASS_STORAGE_READ_CAPACITY_LUN 1
#define UX_HOST_CLASS_STORAGE_READ_CAPACITY_LBA 2
#define UX_HOST_CLASS_STORAGE_READ_CAPACITY_COMMAND_LENGTH_UFI 12
#define UX_HOST_CLASS_STORAGE_READ_CAPACITY_COMMAND_LENGTH_SBC 10
#define UX_HOST_CLASS_STORAGE_READ_CAPACITY_RESPONSE_LENGTH 8
#define UX_HOST_CLASS_STORAGE_READ_CAPACITY_DATA_LBA 0
#define UX_HOST_CLASS_STORAGE_READ_CAPACITY_DATA_SECTOR_SIZE 4
/* Define Storage Class test unit read command constants. */
#define UX_HOST_CLASS_STORAGE_TEST_READY_OPERATION 0
#define UX_HOST_CLASS_STORAGE_TEST_READY_LUN 1
#define UX_HOST_CLASS_STORAGE_TEST_READY_COMMAND_LENGTH_UFI 12
#define UX_HOST_CLASS_STORAGE_TEST_READY_COMMAND_LENGTH_SBC 6
/* Define Storage Class SCSI read command constants. */
#define UX_HOST_CLASS_STORAGE_READ_OPERATION 0
#define UX_HOST_CLASS_STORAGE_READ_LUN 1
#define UX_HOST_CLASS_STORAGE_READ_LBA 2
#define UX_HOST_CLASS_STORAGE_READ_TRANSFER_LENGTH 7
#define UX_HOST_CLASS_STORAGE_READ_COMMAND_LENGTH_UFI 12
#define UX_HOST_CLASS_STORAGE_READ_COMMAND_LENGTH_SBC 10
/* Define Storage Class SCSI write command constants. */
#define UX_HOST_CLASS_STORAGE_WRITE_OPERATION 0
#define UX_HOST_CLASS_STORAGE_WRITE_LUN 1
#define UX_HOST_CLASS_STORAGE_WRITE_LBA 2
#define UX_HOST_CLASS_STORAGE_WRITE_TRANSFER_LENGTH 7
#define UX_HOST_CLASS_STORAGE_WRITE_COMMAND_LENGTH_UFI 12
#define UX_HOST_CLASS_STORAGE_WRITE_COMMAND_LENGTH_SBC 10
/* Define Storage Class SCSI sense key definition constants. */
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_NO_SENSE 0x0
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_RECOVERED_ERROR 0x1
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_NOT_READY 0x2
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_MEDIUM_ERROR 0x3
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_HARDWARE_ERROR 0x4
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_ILLEGAL_REQUEST 0x5
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_UNIT_ATTENTION 0x6
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_DATA_PROTECT 0x7
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_BLANK_CHECK 0x8
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_ABORTED_COMMAND 0x0b
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_VOLUME_OVERFLOW 0x0d
#define UX_HOST_CLASS_STORAGE_SENSE_KEY_MISCOMPARE 0x0e
#define UX_HOST_CLASS_STORAGE_SENSE_CODE_NOT_READY 0x04
#define UX_HOST_CLASS_STORAGE_SENSE_CODE_WRITE_PROTECTED 0x27
#define UX_HOST_CLASS_STORAGE_SENSE_CODE_NOT_READY_TO_READY 0x28
#define UX_HOST_CLASS_STORAGE_SENSE_CODE_NOT_PRESENT 0x3A
/* Convertion between sense status and sense key, ASC, ASCQ. */
#define UX_HOST_CLASS_STORAGE_SENSE_STATUS(key,ascode,ascqualifier) (((key) << 16) | ((ascode) << 8) | (ascqualifier))
#define UX_HOST_CLASS_STORAGE_SENSE_QUALIFIER(status) ((status) & 0xFF)
#define UX_HOST_CLASS_STORAGE_SENSE_CODE(status) (((status) >> 8) & 0xFF)
#define UX_HOST_CLASS_STORAGE_SENSE_KEY(status) (((status) >> 16) & 0xFF)
#define UX_HOST_CLASS_STORAGE_SENSE_ASCQ(status) UX_HOST_CLASS_STORAGE_SENSE_QUALIFIER(status)
#define UX_HOST_CLASS_STORAGE_SENSE_ASC(status) UX_HOST_CLASS_STORAGE_SENSE_CODE(status)
/* Define Mode Sense page codes. */
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_RWER_PAGE 0x01
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_FD_PAGE 0x05
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_RBAC_PAGE 0x1B
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_TP_PAGE 0x1C
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_ALL_PAGE 0x3F
/* Define Mode Sense page codes response length . */
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_HEADER_PAGE_LENGTH 0x08
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_RWER_PAGE_LENGTH 0x0c
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_FD_PAGE_LENGTH 0x20
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_RBAC_PAGE_LENGTH 0x0c
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_TP_PAGE_LENGTH 0x08
#define UX_HOST_CLASS_STORAGE_MODE_SENSE_ALL_PAGE_LENGTH 0xC0
/* Define Storage Class useful error sense key/code constant. */
#define UX_HOST_CLASS_STORAGE_ERROR_MEDIA_NOT_READ 0x023A00
/* Define Storage Class MS-DOS partition entry constants. */
#define UX_HOST_CLASS_STORAGE_PARTITION_SIGNATURE 0xaa55
#define UX_HOST_CLASS_STORAGE_PARTITION_TABLE_START 446
#define UX_HOST_CLASS_STORAGE_PARTITION_BOOT_FLAG 0
#define UX_HOST_CLASS_STORAGE_PARTITION_START_HEAD 1
#define UX_HOST_CLASS_STORAGE_PARTITION_START_SECTOR 2
#define UX_HOST_CLASS_STORAGE_PARTITION_START_TRACK 3
#define UX_HOST_CLASS_STORAGE_PARTITION_TYPE 4
#define UX_HOST_CLASS_STORAGE_PARTITION_END_HEAD 5
#define UX_HOST_CLASS_STORAGE_PARTITION_END_SECTOR 6
#define UX_HOST_CLASS_STORAGE_PARTITION_END_TRACK 7
#define UX_HOST_CLASS_STORAGE_PARTITION_SECTORS_BEFORE 8
#define UX_HOST_CLASS_STORAGE_PARTITION_NUMBER_SECTORS 12
#define UX_HOST_CLASS_STORAGE_PARTITION_TABLE_SIZE 16
#define UX_HOST_CLASS_STORAGE_PARTITION_FAT_12 1
#define UX_HOST_CLASS_STORAGE_PARTITION_FAT_16 4
#define UX_HOST_CLASS_STORAGE_PARTITION_EXTENDED 5
#define UX_HOST_CLASS_STORAGE_PARTITION_FAT_16L 6
#define UX_HOST_CLASS_STORAGE_PARTITION_EXFAT 7
#define UX_HOST_CLASS_STORAGE_PARTITION_FAT_32_1 0x0b
#define UX_HOST_CLASS_STORAGE_PARTITION_FAT_32_2 0x0c
#define UX_HOST_CLASS_STORAGE_PARTITION_FAT_16_LBA_MAPPED 0x0e
#define UX_HOST_CLASS_STORAGE_PARTITION_EXTENDED_LBA_MAPPED 0x0f
/* Define Storage Class instance structure. */
#define UX_HOST_CLASS_STORAGE_CBW_LENGTH 31
#define UX_HOST_CLASS_STORAGE_CSW_LENGTH 13
#define UX_HOST_CLASS_STORAGE_CBW_LENGTH_ALIGNED 32
#define UX_HOST_CLASS_STORAGE_CSW_LENGTH_ALIGNED 16
typedef struct UX_HOST_CLASS_STORAGE_STRUCT
{
struct UX_HOST_CLASS_STORAGE_STRUCT
*ux_host_class_storage_next_instance;
UX_HOST_CLASS *ux_host_class_storage_class;
UX_DEVICE *ux_host_class_storage_device;
UX_INTERFACE *ux_host_class_storage_interface;
UX_ENDPOINT *ux_host_class_storage_bulk_out_endpoint;
UX_ENDPOINT *ux_host_class_storage_bulk_in_endpoint;
UX_ENDPOINT *ux_host_class_storage_interrupt_endpoint;
UCHAR ux_host_class_storage_cbw[UX_HOST_CLASS_STORAGE_CBW_LENGTH_ALIGNED];
UCHAR ux_host_class_storage_saved_cbw[UX_HOST_CLASS_STORAGE_CBW_LENGTH_ALIGNED];
UCHAR ux_host_class_storage_csw[UX_HOST_CLASS_STORAGE_CSW_LENGTH_ALIGNED];
UINT ux_host_class_storage_state;
UINT ux_host_class_storage_media_type;
UINT ux_host_class_storage_lun_removable_media_flags[UX_MAX_HOST_LUN];
UINT ux_host_class_storage_write_protected_media;
UINT ux_host_class_storage_max_lun;
UINT ux_host_class_storage_lun;
UINT ux_host_class_storage_lun_types[UX_MAX_HOST_LUN];
#if defined(UX_HOST_CLASS_STORAGE_NO_FILEX)
ULONG ux_host_class_storage_last_sector_number;
#else
ULONG ux_host_class_storage_mounted_partitions_count;
#endif
ULONG ux_host_class_storage_sector_size;
ULONG ux_host_class_storage_data_phase_length;
ULONG ux_host_class_storage_sense_code;
UCHAR *ux_host_class_storage_memory;
#if !defined(UX_HOST_STANDALONE)
UINT (*ux_host_class_storage_transport) (struct UX_HOST_CLASS_STORAGE_STRUCT *storage, UCHAR * data_pointer);
UX_SEMAPHORE ux_host_class_storage_semaphore;
#else
ULONG ux_host_class_storage_flags;
UINT ux_host_class_storage_status;
UCHAR *ux_host_class_storage_sense_memory;
/* State info for transport state machine. */
UX_TRANSFER *ux_host_class_storage_trans;
UCHAR *ux_host_class_storage_trans_data;
UCHAR *ux_host_class_storage_trans_data_bak;
UCHAR ux_host_class_storage_trans_state;
UCHAR ux_host_class_storage_trans_stage;
UCHAR ux_host_class_storage_trans_retry;
UCHAR ux_host_class_storage_trans_status;
/* State info for media main state machine. */
ULONG ux_host_class_storage_delay_start;
ULONG ux_host_class_storage_delay_ms;
UCHAR ux_host_class_storage_state_state;
UCHAR ux_host_class_storage_state_next;
UCHAR ux_host_class_storage_check_lun;
UCHAR ux_host_class_storage_op_state;
UCHAR ux_host_class_storage_dbg_state;
UCHAR ux_host_class_storage_dbg_rw_state;
UCHAR ux_host_class_storage_dbg_trans_state;
UCHAR ux_host_class_storage_dbg_trans_stage;
ULONG ux_host_class_storage_dbg_state_count;
ULONG ux_host_class_storage_dbg_rw_state_count;
ULONG ux_host_class_storage_dbg_trans_state_count;
#endif
} UX_HOST_CLASS_STORAGE;
#define UX_HOST_CLASS_STORAGE_FLAG_PROTECT (1ul << 0)
#define UX_HOST_CLASS_STORAGE_FLAG_LOCK (1ul << 1)
#define UX_HOST_CLASS_STORAGE_FLAG_CHECK_CURRENT (1ul << 2)
/* Read/write states. */
#define UX_HOST_CLASS_STORAGE_RW_STATE_RESET(s) ((s) -> ux_host_class_storage_op_state = UX_STATE_RESET)
#define UX_HOST_CLASS_STORAGE_RW_STATE_IS_IDLE(s) ((s) -> ux_host_class_storage_op_state == UX_STATE_IDLE)
#define UX_HOST_CLASS_STORAGE_RW_STATE_IS_RESET(s) ((s) -> ux_host_class_storage_op_state == UX_STATE_RESET)
#define UX_HOST_CLASS_STORAGE_RW_IS_IDLE(s) (UX_HOST_CLASS_STORAGE_RW_STATE_IS_IDLE(s) || UX_HOST_CLASS_STORAGE_RW_STATE_IS_RESET(s))
/* Main states. */
#define UX_HOST_CLASS_STORAGE_STATE_MAX_LUN_GET (UX_STATE_CLASS_STEP + 0)
#define UX_HOST_CLASS_STORAGE_STATE_MAX_LUN_SAVE (UX_STATE_CLASS_STEP + 1)
#define UX_HOST_CLASS_STORAGE_STATE_CHECK_START (UX_STATE_CLASS_STEP + 2)
#define UX_HOST_CLASS_STORAGE_STATE_LOCK_WAIT (UX_STATE_CLASS_STEP + 3)
#define UX_HOST_CLASS_STORAGE_STATE_TEST_READY (UX_STATE_CLASS_STEP + 4)
#define UX_HOST_CLASS_STORAGE_STATE_TEST_CHECK (UX_STATE_CLASS_STEP + 5)
#define UX_HOST_CLASS_STORAGE_STATE_INQUIRY (UX_STATE_CLASS_STEP + 6)
#define UX_HOST_CLASS_STORAGE_STATE_INQUIRY_SAVE (UX_STATE_CLASS_STEP + 7)
#define UX_HOST_CLASS_STORAGE_STATE_FORMAT_CAP_GET (UX_STATE_CLASS_STEP + 8)
#define UX_HOST_CLASS_STORAGE_STATE_FORMAT_CAP_SAVE (UX_STATE_CLASS_STEP + 9)
#define UX_HOST_CLASS_STORAGE_STATE_CAP_GET (UX_STATE_CLASS_STEP + 10)
#define UX_HOST_CLASS_STORAGE_STATE_CAP_SAVE (UX_STATE_CLASS_STEP + 11)
#define UX_HOST_CLASS_STORAGE_STATE_NEXT_LUN (UX_STATE_CLASS_STEP + 12)
#define UX_HOST_CLASS_STORAGE_STATE_DELAY_WAIT (UX_STATE_CLASS_STEP + 13)
#define UX_HOST_CLASS_STORAGE_STATE_TRANSPORT (UX_STATE_CLASS_STEP + 14)
#define UX_HOST_CLASS_STORAGE_STATE_TRANSFER (UX_STATE_CLASS_STEP + 15)
#define UX_HOST_CLASS_STORAGE_STATE_CHECK_DONE (UX_STATE_CLASS_STEP + 16)
/* Transport states. */
#define UX_HOST_CLASS_STORAGE_TRANS_STATE_RESET(s) do { \
(s) -> ux_host_class_storage_trans_state = UX_STATE_RESET; \
(s) -> ux_host_class_storage_trans_data = UX_NULL; \
} while(0) \
#define UX_HOST_CLASS_STORAGE_TRANS_CBW (UX_STATE_CLASS_STEP + 0)
#define UX_HOST_CLASS_STORAGE_TRANS_IN_NEXT (UX_STATE_CLASS_STEP + 1)
#define UX_HOST_CLASS_STORAGE_TRANS_OUT_NEXT (UX_STATE_CLASS_STEP + 2)
#define UX_HOST_CLASS_STORAGE_TRANS_CSW (UX_STATE_CLASS_STEP + 3)
#define UX_HOST_CLASS_STORAGE_TRANS_REQ_SENSE (UX_STATE_CLASS_STEP + 4)
#define UX_HOST_CLASS_STORAGE_TRANS_WAIT (UX_STATE_CLASS_STEP + 5)
#define UX_HOST_CLASS_STORAGE_TRANS_STATUS (UX_STATE_CLASS_STEP + 6)
#define UX_HOST_CLASS_STORAGE_TRANS_MS_RESET (UX_STATE_CLASS_STEP + 7)
#define UX_HOST_CLASS_STORAGE_TRANS_EP_RESET (UX_STATE_CLASS_STEP + 8)
#define UX_HOST_CLASS_STORAGE_TRANS_RESET_NEXT (UX_STATE_CLASS_STEP + 9)
#define UX_HOST_CLASS_STORAGE_STAGE_CBW (0x00u)
#define UX_HOST_CLASS_STORAGE_STAGE_DATA (0x01u)
#define UX_HOST_CLASS_STORAGE_STAGE_CSW (0x02u)
#define UX_HOST_CLASS_STORAGE_STAGE_MS_RESET (0x04u)
#define UX_HOST_CLASS_STORAGE_STAGE_EP_RESET (0x08u)
typedef struct UX_HOST_CLASS_STORAGE_EXT_STRUCT
{
#if !defined(UX_HOST_STANDALONE)
UX_THREAD ux_host_class_thread;
CHAR ux_host_class_thread_stack[UX_HOST_CLASS_STORAGE_THREAD_STACK_SIZE];
#else
ALIGN_TYPE reserved;
#endif
} UX_HOST_CLASS_STORAGE_EXT;
/* Define Host Storage Class Media structure. */
typedef struct UX_HOST_CLASS_STORAGE_MEDIA_STRUCT
{
#if !defined(UX_HOST_CLASS_STORAGE_NO_FILEX)
UX_MEDIA ux_host_class_storage_media;
ULONG ux_host_class_storage_media_partition_start;
VOID *ux_host_class_storage_media_memory;
ULONG ux_host_class_storage_media_status;
ULONG ux_host_class_storage_media_lun;
ULONG ux_host_class_storage_media_sector_size;
#else
struct UX_HOST_CLASS_STORAGE_STRUCT
*ux_host_class_storage_media_storage;
ULONG ux_host_class_storage_media_number_sectors;
USHORT ux_host_class_storage_media_sector_size;
UCHAR ux_host_class_storage_media_lun;
UCHAR ux_host_class_storage_media_status;
#endif
} UX_HOST_CLASS_STORAGE_MEDIA;
/* Define Storage Class function prototypes. */
UINT _ux_host_class_storage_activate(UX_HOST_CLASS_COMMAND *command);
VOID _ux_host_class_storage_cbw_initialize(UX_HOST_CLASS_STORAGE *storage, UINT flags,
ULONG data_transfer_length, UINT command_length);
UINT _ux_host_class_storage_configure(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_deactivate(UX_HOST_CLASS_COMMAND *command);
UINT _ux_host_class_storage_device_initialize(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_device_reset(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_device_support_check(UX_HOST_CLASS_STORAGE *storage);
#if !defined(UX_HOST_CLASS_STORAGE_NO_FILEX)
VOID _ux_host_class_storage_driver_entry(UX_MEDIA *media);
#endif
UINT _ux_host_class_storage_endpoints_get(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_entry(UX_HOST_CLASS_COMMAND *command);
UINT _ux_host_class_storage_max_lun_get(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_media_capacity_get(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_media_characteristics_get(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_media_format_capacity_get(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_media_mount(UX_HOST_CLASS_STORAGE *storage, ULONG sector);
UINT _ux_host_class_storage_media_open(UX_HOST_CLASS_STORAGE *storage, ULONG hidden_sectors);
UINT _ux_host_class_storage_media_protection_check(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_media_read(UX_HOST_CLASS_STORAGE *storage, ULONG sector_start,
ULONG sector_count, UCHAR *data_pointer);
UINT _ux_host_class_storage_media_recovery_sense_get(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_media_write(UX_HOST_CLASS_STORAGE *storage, ULONG sector_start,
ULONG sector_count, UCHAR *data_pointer);
UINT _ux_host_class_storage_partition_read(UX_HOST_CLASS_STORAGE *storage, UCHAR *sector_memory, ULONG sector);
UINT _ux_host_class_storage_request_sense(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_sense_code_translate(UX_HOST_CLASS_STORAGE *storage, UINT status);
UINT _ux_host_class_storage_start_stop(UX_HOST_CLASS_STORAGE *storage,
ULONG start_stop_signal);
VOID _ux_host_class_storage_thread_entry(ULONG class_address);
UINT _ux_host_class_storage_transport(UX_HOST_CLASS_STORAGE *storage, UCHAR *data_pointer);
UINT _ux_host_class_storage_transport_bo(UX_HOST_CLASS_STORAGE *storage, UCHAR *data_pointer);
UINT _ux_host_class_storage_transport_cb(UX_HOST_CLASS_STORAGE *storage, UCHAR *data_pointer);
UINT _ux_host_class_storage_transport_cbi(UX_HOST_CLASS_STORAGE *storage, UCHAR *data_pointer);
UINT _ux_host_class_storage_unit_ready_test(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_media_get(UX_HOST_CLASS_STORAGE *storage, ULONG media_lun, UX_HOST_CLASS_STORAGE_MEDIA **storage_media);
UINT _ux_host_class_storage_media_lock(UX_HOST_CLASS_STORAGE_MEDIA *storage_media, ULONG wait);
#if defined(UX_HOST_STANDALONE)
UINT _ux_host_class_storage_lock(UX_HOST_CLASS_STORAGE *storage, ULONG wait);
UINT _uxe_host_class_storage_lock(UX_HOST_CLASS_STORAGE *storage, ULONG wait);
#define _ux_host_class_storage_unlock(s) do { (s) -> ux_host_class_storage_flags &= ~UX_HOST_CLASS_STORAGE_FLAG_LOCK; } while(0)
#define _uxe_host_class_storage_unlock(s) do { if((s) != UX_NULL) (s) -> ux_host_class_storage_flags &= ~UX_HOST_CLASS_STORAGE_FLAG_LOCK; } while(0)
#define _ux_host_class_storage_media_unlock(m) _ux_host_class_storage_unlock((m) -> ux_host_class_storage_media_storage)
#define _uxe_host_class_storage_media_unlock(m) do { if((m) != UX_NULL) _uxe_host_class_storage_unlock((m) -> ux_host_class_storage_media_storage); } while(0)
#else
#define _ux_host_class_storage_lock(s,w) _ux_host_semaphore_get(&(s) -> ux_host_class_storage_semaphore, (w))
#define _uxe_host_class_storage_lock(s,w) (((s) != UX_NULL) ? _ux_host_semaphore_get(&(s) -> ux_host_class_storage_semaphore, (w)) : UX_INVALID_PARAMETER)
#define _ux_host_class_storage_unlock(s) _ux_host_semaphore_put(&(s) -> ux_host_class_storage_semaphore)
#define _uxe_host_class_storage_unlock(s) (((s) != UX_NULL) ? _ux_host_semaphore_put(&(s) -> ux_host_class_storage_semaphore) : UX_INVALID_PARAMETER)
#define _ux_host_class_storage_media_unlock(m) _ux_host_class_storage_unlock((m) -> ux_host_class_storage_media_storage)
#define _uxe_host_class_storage_media_unlock(m) (((m) != UX_NULL) ? _uxe_host_class_storage_unlock((m) -> ux_host_class_storage_media_storage) : UX_INVALID_PARAMETER)
#endif
#define _ux_host_class_storage_max_lun(s) ((s) -> ux_host_class_storage_max_lun)
#define _ux_host_class_storage_lun(s) ((s) -> ux_host_class_storage_lun)
#define _ux_host_class_storage_lun_select(s,l) do { (s) -> ux_host_class_storage_lun = (l); } while(0)
#define _uxe_host_class_storage_lun_select(s,l) do { if ((s) != UX_NULL) (s) -> ux_host_class_storage_lun = (l); } while(0)
#define _ux_host_class_storage_sense_status(s) ((s) -> ux_host_class_storage_sense_code)
UINT _ux_host_class_storage_media_check(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_tasks_run(UX_HOST_CLASS *storage_class);
UINT _ux_host_class_storage_transport_run(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_check_run(UX_HOST_CLASS_STORAGE *storage);
UINT _ux_host_class_storage_read_write_run(UX_HOST_CLASS_STORAGE *storage,
ULONG read_write, ULONG sector_start, ULONG sector_count, UCHAR *data_pointer);
UINT _uxe_host_class_storage_media_read(UX_HOST_CLASS_STORAGE *storage, ULONG sector_start,
ULONG sector_count, UCHAR *data_pointer);
UINT _uxe_host_class_storage_media_write(UX_HOST_CLASS_STORAGE *storage, ULONG sector_start,
ULONG sector_count, UCHAR *data_pointer);
UINT _uxe_host_class_storage_media_check(UX_HOST_CLASS_STORAGE *storage);
UINT _uxe_host_class_storage_media_get(UX_HOST_CLASS_STORAGE *storage, ULONG media_lun, UX_HOST_CLASS_STORAGE_MEDIA **storage_media);
UINT _uxe_host_class_storage_media_lock(UX_HOST_CLASS_STORAGE_MEDIA *storage_media, ULONG wait);
/* Define Storage Class API prototypes. */
#define ux_host_class_storage_entry _ux_host_class_storage_entry
#define ux_host_class_storage_sense_status _ux_host_class_storage_sense_status
#if defined(UX_HOST_CLASS_STORAGE_ENABLE_ERROR_CHECKING)
#define ux_host_class_storage_lock _uxe_host_class_storage_lock
#define ux_host_class_storage_unlock _uxe_host_class_storage_unlock
#define ux_host_class_storage_lun_select _uxe_host_class_storage_lun_select
#define ux_host_class_storage_media_read _uxe_host_class_storage_media_read
#define ux_host_class_storage_media_write _uxe_host_class_storage_media_write
#define ux_host_class_storage_media_get _uxe_host_class_storage_media_get
#define ux_host_class_storage_media_lock _uxe_host_class_storage_media_lock
#define ux_host_class_storage_media_unlock _uxe_host_class_storage_media_unlock
#define ux_host_class_storage_media_check _uxe_host_class_storage_media_check
#else
#define ux_host_class_storage_lock _ux_host_class_storage_lock
#define ux_host_class_storage_unlock _ux_host_class_storage_unlock
#define ux_host_class_storage_lun_select _ux_host_class_storage_lun_select
#define ux_host_class_storage_media_read _ux_host_class_storage_media_read
#define ux_host_class_storage_media_write _ux_host_class_storage_media_write
#define ux_host_class_storage_media_get _ux_host_class_storage_media_get
#define ux_host_class_storage_media_lock _ux_host_class_storage_media_lock
#define ux_host_class_storage_media_unlock _ux_host_class_storage_media_unlock
#define ux_host_class_storage_media_check _ux_host_class_storage_media_check
#endif
/* Determine if a C++ compiler is being used. If so, complete the standard
C conditional started above. */
#ifdef __cplusplus
}
#endif
#endif
|
