1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** USBX Component */
17 /** */
18 /** Storage Class */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23
24 /* Include necessary system files. */
25
26 #define UX_SOURCE_CODE
27
28 #include "ux_api.h"
29 #include "ux_host_class_storage.h"
30 #include "ux_host_stack.h"
31
32
33 /**************************************************************************/
34 /* */
35 /* FUNCTION RELEASE */
36 /* */
37 /* _ux_host_class_storage_unit_ready_test PORTABLE C */
38 /* 6.1.10 */
39 /* AUTHOR */
40 /* */
41 /* Chaoqiong Xiao, Microsoft Corporation */
42 /* */
43 /* DESCRIPTION */
44 /* */
45 /* This function will verify that a SCSI unit is ready for data */
46 /* transfer. This command is used when the device does not mount */
47 /* when power is supplied. */
48 /* */
49 /* INPUT */
50 /* */
51 /* storage Pointer to storage class */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* Completion Status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _ux_host_class_storage_cbw_initialize Initialize the CBW */
60 /* _ux_host_class_storage_transport Send transport layer command */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Storage Class */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
71 /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* 01-31-2022 Chaoqiong Xiao Modified comment(s), */
74 /* added standalone support, */
75 /* resulting in version 6.1.10 */
76 /* */
77 /**************************************************************************/
_ux_host_class_storage_unit_ready_test(UX_HOST_CLASS_STORAGE * storage)78 UINT _ux_host_class_storage_unit_ready_test(UX_HOST_CLASS_STORAGE *storage)
79 {
80
81 UINT status;
82 UCHAR *cbw;
83 UINT command_length;
84
85 /* If trace is enabled, insert this event into the trace buffer. */
86 UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_STORAGE_UNIT_READY_TEST, storage, 0, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
87
88 /* Use a pointer for the CBW, easier to manipulate. */
89 cbw = (UCHAR *) storage -> ux_host_class_storage_cbw;
90
91 /* Get the Unit Ready Test Command Length. */
92 #ifdef UX_HOST_CLASS_STORAGE_INCLUDE_LEGACY_PROTOCOL_SUPPORT
93 if (storage -> ux_host_class_storage_interface -> ux_interface_descriptor.bInterfaceSubClass == UX_HOST_CLASS_STORAGE_SUBCLASS_UFI)
94 command_length = UX_HOST_CLASS_STORAGE_TEST_READY_COMMAND_LENGTH_UFI;
95 else
96 command_length = UX_HOST_CLASS_STORAGE_TEST_READY_COMMAND_LENGTH_SBC;
97 #else
98 command_length = UX_HOST_CLASS_STORAGE_TEST_READY_COMMAND_LENGTH_SBC;
99 #endif
100
101 /* Initialize the CBW for this command. */
102 _ux_host_class_storage_cbw_initialize(storage, 0, 0, command_length);
103
104 /* Prepare the TEST UNIT READY command block. */
105 *(cbw + UX_HOST_CLASS_STORAGE_CBW_CB + UX_HOST_CLASS_STORAGE_TEST_READY_OPERATION) = UX_HOST_CLASS_STORAGE_SCSI_TEST_READY;
106
107 #if defined(UX_HOST_STANDALONE)
108
109 /* Prepare states. */
110 UX_HOST_CLASS_STORAGE_TRANS_STATE_RESET(storage);
111 storage -> ux_host_class_storage_state_state = UX_HOST_CLASS_STORAGE_STATE_TRANSPORT;
112 storage -> ux_host_class_storage_state_next = UX_HOST_CLASS_STORAGE_STATE_TEST_CHECK;
113 status = UX_SUCCESS;
114 #else
115
116 /* Send the command to transport layer. */
117 status = _ux_host_class_storage_transport(storage, UX_NULL);
118 #endif
119
120 /* Return completion status. */
121 return(status);
122 }
123
