/
bulk_usb.h
195 lines (167 loc) · 6.74 KB
/
bulk_usb.h
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
/*
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
2011,2012,2013 Giovanni Di Sirio.
This file is part of ChibiOS/RT.
ChibiOS/RT is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
ChibiOS/RT is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file bulk_usb.h
* @brief Bulk USB Driver macros and structures.
*
* @addtogroup BULK_USB
* @{
*/
#ifndef _BULK_USB_H_
#define _BULK_USB_H_
#if 1 //HAL_USE_BULK_USB || defined(__DOXYGEN__)
#include "hal.h"
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name BULK_USB configuration options
* @{
*/
/**
* @brief Bulk USB buffers size.
* @details Configuration parameter, the buffer size must be a multiple of
* the USB data endpoint maximum packet size.
* @note The default is 256 bytes for both the transmission and receive
* buffers.
*/
#if !defined(BULK_USB_BUFFERS_SIZE) || defined(__DOXYGEN__)
#define BULK_USB_BUFFERS_SIZE 256
#endif
/**
* @brief Bulk USB number of buffers.
* @note The default is 2 buffers.
*/
#if !defined(BULK_USB_BUFFERS_NUMBER) || defined(__DOXYGEN__)
#define BULK_USB_BUFFERS_NUMBER 2
#endif
/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if HAL_USE_USB == FALSE
#error "Bulk USB Driver requires HAL_USE_USB"
#endif
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Driver state machine possible states.
*/
typedef enum {
BDU_UNINIT = 0, /**< Not initialized. */
BDU_STOP = 1, /**< Stopped. */
BDU_READY = 2 /**< Ready. */
} bdustate_t;
/**
* @brief Structure representing a bulk USB driver.
*/
typedef struct BulkUSBDriver BulkUSBDriver;
/**
* @brief Bulk USB Driver configuration structure.
* @details An instance of this structure must be passed to @p bduStart()
* in order to configure and start the driver operations.
*/
typedef struct {
/**
* @brief USB driver to use.
*/
USBDriver *usbp;
/**
* @brief Bulk IN endpoint used for outgoing data transfer.
*/
usbep_t bulk_in;
/**
* @brief Bulk OUT endpoint used for incoming data transfer.
*/
usbep_t bulk_out;
} BulkUSBConfig;
/**
* @brief @p BulkUSBDriver specific data.
*/
#define _bulk_usb_driver_data \
_base_asynchronous_channel_data \
/* Driver state.*/ \
bdustate_t state; \
/* Input buffers queue.*/ \
input_buffers_queue_t ibqueue; \
/* Output queue.*/ \
output_buffers_queue_t obqueue; \
/* Input buffer.*/ \
uint8_t ib[BQ_BUFFER_SIZE(BULK_USB_BUFFERS_NUMBER, \
BULK_USB_BUFFERS_SIZE)]; \
/* Output buffer.*/ \
uint8_t ob[BQ_BUFFER_SIZE(BULK_USB_BUFFERS_NUMBER, \
BULK_USB_BUFFERS_SIZE)]; \
/* End of the mandatory fields.*/ \
/* Current configuration data.*/ \
const BulkUSBConfig *config;
/**
* @brief @p BulkUSBDriver specific methods.
*/
#define _bulk_usb_driver_methods \
_base_asynchronous_channel_methods
/**
* @extends BaseAsynchronousChannelVMT
*
* @brief @p BulkUSBDriver virtual methods table.
*/
struct BulkUSBDriverVMT {
_bulk_usb_driver_methods
};
/**
* @extends BaseAsynchronousChannel
*
* @brief Full duplex bulk driver class.
* @details This class extends @p BaseAsynchronousChannel by adding physical
* I/O queues.
*/
struct BulkUSBDriver {
/** @brief Virtual Methods Table.*/
const struct BulkUSBDriverVMT *vmt;
_bulk_usb_driver_data
};
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void bduInit(void);
void bduObjectInit(BulkUSBDriver *bdup);
void bduStart(BulkUSBDriver *bdup, const BulkUSBConfig *config);
void bduStop(BulkUSBDriver *bdup);
void bduSuspendHookI(BulkUSBDriver *bdup);
void bduWakeupHookI(BulkUSBDriver *bdup);
void bduConfigureHookI(BulkUSBDriver *bdup);
bool bduRequestsHook(USBDriver *usbp);
void bduSOFHookI(BulkUSBDriver *bdup);
void bduDataTransmitted(USBDriver *usbp, usbep_t ep);
void bduDataReceived(USBDriver *usbp, usbep_t ep);
void bduInterruptTransmitted(USBDriver *usbp, usbep_t ep);
msg_t bduControl(USBDriver *usbp, unsigned int operation, void *arg);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_BULK_USB */
#endif /* _BULK_USB_H_ */
/** @} */