Outline ![]()
Files ![]()
loading...
CodeScope![]()
STM32 Libraries and Samples![]()
usbx![]()
common/usbx_host_classes/src/ux_host_class_storage_media_open.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
/**************************************************************************/
/* */
/* 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 */
/** */
/** 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"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_storage_media_open PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function will ask UX_MEDIA (default FileX) to mount a new */
/* partition for this device. This function has some */
/* UX_MEDIA (default FileX) dependencies. */
/* */
/* INPUT */
/* */
/* storage Pointer to storage class */
/* hidden_sectors Number of hidden sectors */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* ux_media_open Media open */
/* _ux_host_class_storage_media_protection_check */
/* Check for protection */
/* _ux_utility_memory_allocate Allocate memory block */
/* _ux_utility_memory_free Free memory block */
/* */
/* CALLED BY */
/* */
/* _ux_host_class_storage_media_mount Media open */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
/* added option to disable FX */
/* media integration, used UX_ */
/* things instead of FX_ */
/* things directly, used host */
/* class extension pointer for */
/* class specific structured */
/* data, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _ux_host_class_storage_media_open(UX_HOST_CLASS_STORAGE *storage, ULONG hidden_sectors)
{
#if defined(UX_HOST_CLASS_STORAGE_NO_FILEX)
UX_PARAMETER_NOT_USED(storage);
UX_PARAMETER_NOT_USED(hidden_sectors);
return(UX_FUNCTION_NOT_SUPPORTED);
#else
UINT status;
UINT media_index;
UX_HOST_CLASS_STORAGE_MEDIA *storage_media;
UX_MEDIA *media;
UX_HOST_CLASS *class_inst;
/* We need the class container. */
class_inst = storage -> ux_host_class_storage_class;
/* Point the media structure to the first media in the container. */
storage_media = (UX_HOST_CLASS_STORAGE_MEDIA *) class_inst -> ux_host_class_media;
/* Locate a free partition in the storage instance. */
for (media_index = 0; media_index < UX_HOST_CLASS_STORAGE_MAX_MEDIA; media_index++)
{
/* Get the USBX Integrated Media pointer for that media. */
media = &storage_media -> ux_host_class_storage_media;
/* Is the media valid? */
if (ux_media_id_get(media) == 0)
{
/* Save the storage instance in the media instance. */
ux_media_driver_info_set(media, storage);
/* Save the number of hidden sectors in this partition. */
storage_media -> ux_host_class_storage_media_partition_start = hidden_sectors;
/* Save the LUN number in the storage media instance. */
storage_media -> ux_host_class_storage_media_lun = storage -> ux_host_class_storage_lun;
/* Save the Sector size in the storage media instance. */
storage_media -> ux_host_class_storage_media_sector_size = storage -> ux_host_class_storage_sector_size;
/* Save the storage media instance in the user reserved area in the UX_MEDIA structure. */
ux_media_reserved_for_user_set(media, storage_media);
/* We now need to allocate a block of memory for UX_MEDIA (default FileX) to use when doing transfers
The default buffer size is 8K. The value used for the definition is UX_HOST_CLASS_STORAGE_MEMORY_BUFFER_SIZE.
This value can be changed to save on memory space but should not be smaller than
the media sector size (which should be 512 bytes). Because USB devices are SCSI
devices and there is a great deal of overhead when doing read/writes, it is better
to leave the default buffer size or even increase it. */
storage_media -> ux_host_class_storage_media_memory = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, UX_HOST_CLASS_STORAGE_MEMORY_BUFFER_SIZE);
if (storage_media -> ux_host_class_storage_media_memory == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_STORAGE_MEDIA_OPEN, storage, media, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* Ask UX_MEDIA (default FileX) to mount the partition. */
status = ux_media_open(media, UX_HOST_CLASS_STORAGE_MEDIA_NAME, _ux_host_class_storage_driver_entry,
storage, storage_media -> ux_host_class_storage_media_memory,
UX_HOST_CLASS_STORAGE_MEMORY_BUFFER_SIZE);
/* If the media is mounted, update the status for the application. */
if (status == UX_SUCCESS)
storage_media -> ux_host_class_storage_media_status = UX_HOST_CLASS_STORAGE_MEDIA_MOUNTED;
else
/* Free the memory resources. */
_ux_utility_memory_free(storage_media -> ux_host_class_storage_media_memory);
/* Return completion status. */
return(status);
}
/* Move to next entry in the media array. */
storage_media++;
}
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_MEMORY_ERROR);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_MEMORY_ERROR, storage, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* Return error. */
return(UX_HOST_CLASS_MEMORY_ERROR);
#endif /* !defined(UX_HOST_CLASS_STORAGE_NO_FILEX) */
}