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
|
/***************************************************************************
* 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 */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_storage.h"
#include "ux_host_stack.h"
#if defined(UX_HOST_STANDALONE)
VOID _ux_host_class_storage_read_initialize(UX_HOST_CLASS_STORAGE *storage,
ULONG sector_start, ULONG sector_count);
VOID
#else
static inline VOID
#endif
_ux_host_class_storage_read_initialize(UX_HOST_CLASS_STORAGE *storage,
ULONG sector_start, ULONG sector_count)
{
UCHAR *cbw;
UCHAR *cbw_cb;
ULONG command_length;
/* Use a pointer for the cbw, easier to manipulate. */
cbw = (UCHAR *)storage -> ux_host_class_storage_cbw;
cbw_cb = cbw + UX_HOST_CLASS_STORAGE_CBW_CB;
/* Get the Read Command Length. */
#ifdef UX_HOST_CLASS_STORAGE_INCLUDE_LEGACY_PROTOCOL_SUPPORT
if (storage -> ux_host_class_storage_interface -> ux_interface_descriptor.bInterfaceSubClass ==
UX_HOST_CLASS_STORAGE_SUBCLASS_UFI)
command_length = UX_HOST_CLASS_STORAGE_READ_COMMAND_LENGTH_UFI;
else
command_length = UX_HOST_CLASS_STORAGE_READ_COMMAND_LENGTH_SBC;
#else
command_length = UX_HOST_CLASS_STORAGE_READ_COMMAND_LENGTH_SBC;
#endif
/* Initialize the CBW for this command. */
_ux_host_class_storage_cbw_initialize(storage,
UX_HOST_CLASS_STORAGE_DATA_IN,
sector_count * storage -> ux_host_class_storage_sector_size,
command_length);
/* Prepare the MEDIA READ command block. */
*(cbw_cb + UX_HOST_CLASS_STORAGE_READ_OPERATION) = UX_HOST_CLASS_STORAGE_SCSI_READ16;
/* Store the sector start (LBA field). */
_ux_utility_long_put_big_endian(cbw_cb + UX_HOST_CLASS_STORAGE_READ_LBA, sector_start);
/* Store the number of sectors to read. */
_ux_utility_short_put_big_endian(cbw_cb + UX_HOST_CLASS_STORAGE_READ_TRANSFER_LENGTH, (USHORT) sector_count);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_storage_media_read PORTABLE C */
/* 6.2.1 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function will read one or more logical sector from the media. */
/* */
/* INPUT */
/* */
/* storage Pointer to storage class */
/* sector_start Starting sector */
/* sector_count Number of sectors to read */
/* data_pointer Pointer to data to read */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_storage_cbw_initialize Initialize the CBW */
/* _ux_host_class_storage_transport Send command */
/* _ux_utility_long_put_big_endian Put 32-bit word */
/* _ux_utility_short_put_big_endian Put 16-bit word */
/* */
/* CALLED BY */
/* */
/* Storage Class */
/* */
/**************************************************************************/
UINT _ux_host_class_storage_media_read(UX_HOST_CLASS_STORAGE *storage, ULONG sector_start,
ULONG sector_count, UCHAR *data_pointer)
{
#if defined(UX_HOST_STANDALONE)
UINT status;
do {
status = _ux_host_class_storage_read_write_run(storage, UX_TRUE,
sector_start, sector_count, data_pointer);
} while(status == UX_STATE_WAIT);
if (status < UX_STATE_IDLE)
return(UX_HOST_CLASS_INSTANCE_UNKNOWN);
return(storage -> ux_host_class_storage_status);
#else
UINT status;
UINT media_retry;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_STORAGE_MEDIA_READ, storage, sector_start, sector_count, data_pointer, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* Reset the retry count. */
media_retry = UX_HOST_CLASS_STORAGE_REQUEST_SENSE_RETRY;
/* We may need several attempts. */
while (media_retry-- != 0)
{
/* Initialize CBW. */
_ux_host_class_storage_read_initialize(storage, sector_start, sector_count);
/* Send the command to transport layer. */
status = _ux_host_class_storage_transport(storage, data_pointer);
if (status != UX_SUCCESS)
return(status);
/* Did the command succeed? */
if (storage -> ux_host_class_storage_sense_code == UX_SUCCESS)
{
/* Check for completeness of sector read. */
if (storage -> ux_host_class_storage_data_phase_length != sector_count * storage -> ux_host_class_storage_sector_size)
{
/* This can happen if the device sent less data than the host
requested. This does not fit our definition of success and
retrying shouldn't change the outcome, so we return an error. */
/* We got an error during read. Packet not complete. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_TRANSFER_DATA_LESS_THAN_EXPECTED);
/* Return to UX_MEDIA (default FileX). */
return(UX_ERROR);
}
/* The read succeeded. */
return(UX_SUCCESS);
}
/* The command did not succeed. Retry. */
}
/* Check if the media in the device has been removed. If so
we have to tell UX_MEDIA (default FileX) that the media is closed. */
return(UX_HOST_CLASS_STORAGE_SENSE_ERROR);
#endif
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_storage_media_read PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in storage media read function call. */
/* */
/* INPUT */
/* */
/* storage Pointer to storage class */
/* sector_start Starting sector */
/* sector_count Number of sectors to read */
/* data_pointer Pointer to data to read */
/* */
/* OUTPUT */
/* */
/* Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_storage_media_read Read storage media */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _uxe_host_class_storage_media_read(UX_HOST_CLASS_STORAGE *storage, ULONG sector_start,
ULONG sector_count, UCHAR *data_pointer)
{
/* Sanity checks. */
if ((storage == UX_NULL) || (data_pointer == UX_NULL))
return(UX_INVALID_PARAMETER);
/* Invoke storage media read function. */
return(_ux_host_class_storage_media_read(storage, sector_start, sector_count, data_pointer));
}
|
