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
|
/*
ChibiOS/HAL - Copyright (C) 2016 Uladzimir Pylinsky aka barthess
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file hal_usb_msd.h
* @brief USM mass storage device driver macros and structures.
*
* @addtogroup usb_msd
* @{
*/
#ifndef HAL_USB_MSD_H
#define HAL_USB_MSD_H
#if (HAL_USE_USB_MSD == TRUE) || defined(__DOXYGEN__)
#include "lib_scsi.h"
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
#define USB_MSD_DATA_EP 0x01
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if !HAL_USE_USB
#error "Mass storage Driver requires HAL_USE_USB"
#endif
#if !USB_USE_WAIT
#error "Mass storage Driver requires USB_USE_WAIT"
#endif
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Type of a structure representing an USB mass storage driver.
*/
typedef struct USBMassStorageDriver USBMassStorageDriver;
/**
* @brief Type of a driver state machine possible states.
*/
typedef enum {
USB_MSD_UNINIT = 0,
USB_MSD_STOP,
USB_MSD_READY,
} usbmsdstate_t;
/**
* @brief Represents command block wrapper structure.
* @details See USB Mass Storage Class Specification.
*/
typedef struct PACKED_VAR {
uint32_t signature;
uint32_t tag;
uint32_t data_len;
uint8_t flags;
uint8_t lun;
uint8_t cmd_len;
uint8_t cmd_data[16];
} msd_cbw_t;
/**
* @brief Represents command status wrapper structure.
* @details See USB Mass Storage Class Specification.
*/
typedef struct PACKED_VAR {
uint32_t signature;
uint32_t tag;
uint32_t data_residue;
uint8_t status;
} msd_csw_t;
/**
* @brief Transport handler passed to SCSI layer.
*/
typedef struct {
/**
* @brief Pointer to the @p USBDriver object.
*/
USBDriver *usbp;
/**
* @brief USB endpoint number.
*/
usbep_t ep;
} usb_scsi_transport_handler_t;
/**
* @brief Structure representing an USB mass storage driver.
*/
struct USBMassStorageDriver {
/**
* @brief Pointer to the @p USBDriver object.
*/
USBDriver *usbp;
/**
* @brief Driver state.
*/
usbmsdstate_t state;
/**
* @brief CBW structure.
*/
msd_cbw_t cbw;
/**
* @brief CSW structure.
*/
msd_csw_t csw;
/**
* @brief Thread working area.
*/
THD_WORKING_AREA( waMSDWorker, 512);
/**
* @brief Worker thread handler.
*/
thread_reference_t worker;
/**
* @brief SCSI target driver structure.
*/
SCSITarget scsi_target;
/**
* @brief SCSI target configuration structure.
*/
SCSITargetConfig scsi_config;
/**
* @brief SCSI transport structure.
*/
SCSITransport scsi_transport;
/**
* @brief SCSI over USB transport handler structure.
*/
usb_scsi_transport_handler_t usb_scsi_transport_handler;
};
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
extern USBMassStorageDriver USBMSD1;
#ifdef __cplusplus
extern "C" {
#endif
void msdObjectInit(USBMassStorageDriver *msdp);
void msdStart(USBMassStorageDriver *msdp, USBDriver *usbp,
BaseBlockDevice *blkdev, uint8_t *blkbuf,
const scsi_inquiry_response_t *scsi_inquiry_response,
const scsi_unit_serial_number_inquiry_response_t *serialInquiry);
void msdStop(USBMassStorageDriver *msdp);
bool msd_request_hook(USBDriver *usbp);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_USB_MSD */
#endif /* HAL_USB_MSD_H */
/** @} */
|
