VSF Documented
vsf_usbd_MSC.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __VSF_USBD_MSC_H__
19#define __VSF_USBD_MSC_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "component/usb/vsf_usb_cfg.h"
24
25#if VSF_USE_USB_DEVICE == ENABLED && VSF_USBD_USE_MSC == ENABLED
26
27#include "component/usb/common/class/MSC/vsf_usb_MSC.h"
28#include "./vsf_usbd_MSC_desc.h"
29#include "component/scsi/vsf_scsi.h"
30
31#if defined(__VSF_USBD_MSC_CLASS_IMPLEMENT)
32# undef __VSF_USBD_MSC_CLASS_IMPLEMENT
33# define __VSF_CLASS_IMPLEMENT__
34#endif
35#include "utilities/ooc_class.h"
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/*============================ MACROS ========================================*/
42
43#if VSF_USE_SCSI != ENABLED
44# error msc uses scsi!!!
45#endif
46#if VSF_USBD_CFG_STREAM_EN != ENABLED
47# error msc need stream
48#endif
49
50
51
52#define USB_MSC_PARAM(__BULK_IN_EP, __BULK_OUT_EP, __STREAM, __MAX_LUN, __SCSI_PDEVS)\
53 .ep_out = (__BULK_OUT_EP), \
54 .ep_in = (__BULK_IN_EP), \
55 .stream = (__STREAM), \
56 .max_lun = (__MAX_LUN), \
57 .scsi_devs = (__SCSI_PDEVS),
58
59#define USB_MSC_IFS_NUM 1
60#define USB_MSCBOT_IFS_NUM USB_MSC_IFS_NUM
61#define USB_MSC_IFS(__MSC_PARAM) USB_IFS(&vk_usbd_msc, &(__MSC_PARAM))
62
63
64#define __usbd_mscbot_desc(__name, __ifs, __i_func, __bulk_in_ep, __bulk_out_ep, __bulk_ep_size)\
65 USB_DESC_MSCBOT((__ifs), 4 + (__i_func), (__bulk_in_ep), (__bulk_out_ep), (__bulk_ep_size))
66#define __usbd_mscbot_desc_iad(__name, __ifs, __i_func, __bulk_in_ep, __bulk_out_ep, __bulk_ep_size)\
67 USB_DESC_MSCBOT_IAD((__ifs), 4 + (__i_func), (__bulk_in_ep), (__bulk_out_ep), (__bulk_ep_size))
68
69#define __usbd_mscbot_func(__name, __func_id, __str_func, __i_func, __ifs, \
70 __bulk_in_ep, __bulk_out_ep, __bulk_ep_size, __stream, ...) \
71 enum { \
72 __##__name##_MSCBOT##__func_id##_IFS = (__ifs), \
73 __##__name##_MSCBOT##__func_id##_I_FUNC = (__i_func), \
74 __##__name##_MSCBOT##__func_id##_BULKIN_EP = (__bulk_in_ep), \
75 __##__name##_MSCBOT##__func_id##_BULKOUT_EP = (__bulk_out_ep), \
76 __##__name##_MSCBOT##__func_id##_BULK_EP_SIZE = (__bulk_ep_size),\
77 }; \
78 usbd_func_str_desc(__name, __func_id, __str_func) \
79 vk_scsi_t * __##__name##_MSC##__scsi_devs[] = { \
80 __VA_ARGS__ \
81 }; \
82 vk_usbd_msc_t __##__name##_MSC##__func_id = { \
83 USB_MSC_PARAM((__bulk_in_ep), (__bulk_out_ep), (__stream), \
84 dimof(__##__name##_MSC##__scsi_devs) - 1, \
85 __##__name##_MSC##__scsi_devs) \
86 };
87
88#define __usbd_msc_ifs(__name, __func_id) \
89 USB_MSC_IFS(__##__name##_MSC##__func_id)
90
91#define usbd_mscbot_desc(__name, __func_id) \
92 __usbd_mscbot_desc(__name, \
93 __##__name##_MSCBOT##__func_id##_IFS, \
94 __##__name##_MSCBOT##__func_id##_I_FUNC, \
95 __##__name##_MSCBOT##__func_id##_BULKIN_EP, \
96 __##__name##_MSCBOT##__func_id##_BULKOUT_EP, \
97 __##__name##_MSCBOT##__func_id##_BULK_EP_SIZE)
98#define usbd_mscbot_desc_iad(__name, __func_id) \
99 __usbd_mscbot_desc_iad(__name, \
100 __##__name##_MSCBOT##__func_id##_IFS, \
101 __##__name##_MSCBOT##__func_id##_I_FUNC, \
102 __##__name##_MSCBOT##__func_id##_BULKIN_EP, \
103 __##__name##_MSCBOT##__func_id##_BULKOUT_EP, \
104 __##__name##_MSCBOT##__func_id##_BULK_EP_SIZE)
105#define usbd_mscbot_desc_table(__name, __func_id) \
106 usbd_func_str_desc_table(__name, __func_id)
107#define usbd_mscbot_func(__name, __func_id, __str_func, __i_func, __ifs, \
108 __bulk_in_ep, __bulk_out_ep, __bulk_ep_size, __stream, ...) \
109 __usbd_mscbot_func(__name, __func_id, (__str_func), (__i_func), (__ifs),\
110 (__bulk_in_ep), (__bulk_out_ep), (__bulk_ep_size), \
111 (__stream), __VA_ARGS__)
112#define usbd_mscbot_ifs(__name, __func_id) \
113 __usbd_msc_ifs(__name, __func_id)
114
115// usbd_mscbot_scsi_config MUST be called for each scsi device before usbd startup.
116#define usbd_mscbot_scsi_config(__name, __func_id, __scsi_idx, __is_inited)\
117 extern vk_usbd_msc_t __##__name##_MSC##__func_id; \
118 vk_usbd_mscbot_scsi_config(&__##__name##_MSC##__func_id, (__scsi_idx), (__is_inited))
119
120/*============================ MACROFIED FUNCTIONS ===========================*/
121/*============================ TYPES =========================================*/
122
123typedef union vk_usbd_msc_scsi_ctx_t {
124 usb_msc_cbw_t cbw;
125 struct {
126 usb_msc_csw_t csw;
127 struct {
128 uint32_t cur_size;
129 uint32_t reply_size;
130 };
131 };
132} vk_usbd_msc_scsi_ctx_t;
133
134vsf_class(vk_usbd_msc_t) {
135
136 private_member(
137 vsf_eda_t eda;
138 vk_usbd_msc_scsi_ctx_t ctx;
139 int32_t reply_len;
140 vk_usbd_dev_t *dev;
141 vk_usbd_ep_stream_t ep_stream;
142 uint8_t scsi_inited_mask;
143 uint8_t is_scsi_init : 1;
144 uint8_t is_stream : 1;
145 uint8_t is_scsi_done : 1;
146 uint8_t is_data_done : 1;
147 )
148
149 public_member(
150 const uint8_t ep_out;
151 const uint8_t ep_in;
152 const uint8_t max_lun;
153 vsf_stream_t *stream;
154 vk_scsi_t **scsi_devs;
155 )
156};
157
158/*============================ GLOBAL VARIABLES ==============================*/
159
160extern const vk_usbd_class_op_t vk_usbd_msc;
161
162/*============================ PROTOTYPES ====================================*/
163
164// vk_usbd_mscbot_scsi_config MUST be called for each scsi device before usbd startup.
165void vk_usbd_mscbot_scsi_config(vk_usbd_msc_t *msc, uint8_t idx, bool is_inited);
166
167#ifdef __cplusplus
168}
169#endif
170
171#endif // VSF_USE_USB_DEVICE && VSF_USBD_USE_MSC
172#endif // __VSF_USBD_MSC_H__
vk_scsi_t
Definition vsf_scsi.h:146
vk_usbd_msc_t
Definition vsf_usbd_MSC.h:134
vsf_eda_t
Definition vsf_eda.h:766
vsf_stream_t
Definition vsf_simple_stream.h:254
uint32_t
unsigned int uint32_t
Definition lvgl.h:43
int32_t
signed int int32_t
Definition lvgl.h:44
uint8_t
unsigned char uint8_t
Definition lvgl.h:40
ooc_class.h
vsf_class
#define vsf_class(__name)
Definition ooc_class.h:48
usb_msc_cbw_t
Definition vsf_usb_MSC.h:35
usb_msc_csw_t
Definition vsf_usb_MSC.h:46
vk_usbd_msc_scsi_ctx_t
Definition vsf_usbd_MSC.h:123
vk_usbd_msc_scsi_ctx_t::csw
usb_msc_csw_t csw
Definition vsf_usbd_MSC.h:126
vk_usbd_msc_scsi_ctx_t::cur_size
uint32_t cur_size
Definition vsf_usbd_MSC.h:128
vk_usbd_msc_scsi_ctx_t::cbw
usb_msc_cbw_t cbw
Definition vsf_usbd_MSC.h:124
vk_usbd_msc_scsi_ctx_t::reply_size
uint32_t reply_size
Definition vsf_usbd_MSC.h:129
vsf_scsi.h
vsf_usb_MSC.h
vsf_usb_cfg.h
vk_usbd_msc
const vk_usbd_class_op_t vk_usbd_msc
vk_usbd_mscbot_scsi_config
void vk_usbd_mscbot_scsi_config(vk_usbd_msc_t *msc, uint8_t idx, bool is_inited)
vsf_usbd_MSC_desc.h
Generated by doxygen 1.9.8