-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathmidi_usb.h
199 lines (170 loc) · 6.93 KB
/
midi_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
196
197
198
199
/*
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 midi_usb.h
* @brief MIDI USB Driver macros and structures.
*
* @addtogroup MIDI_USB
* @{
*/
#ifndef _MIDI_USB_H_
#define _MIDI_USB_H_
#if 1 //HAL_USE_MIDI_USB || defined(__DOXYGEN__)
#include "hal.h"
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name MIDI_USB configuration options
* @{
*/
/**
* @brief Midi 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 64 bytes for both the transmission and receive
* buffers.
*/
#if !defined(MIDI_USB_BUFFERS_SIZE) || defined(__DOXYGEN__)
#define MIDI_USB_BUFFERS_SIZE 64
#endif
/**
* @brief Midi USB number of buffers.
* @note The default is 2 buffers.
*/
#if !defined(MIDI_USB_BUFFERS_NUMBER) || defined(__DOXYGEN__)
#define MIDI_USB_BUFFERS_NUMBER 2
#endif
/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if HAL_USE_USB == FALSE
#error "Midi USB Driver requires HAL_USE_USB"
#endif
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Driver state machine possible states.
*/
typedef enum {
MDU_UNINIT = 0, /**< Not initialized. */
MDU_STOP = 1, /**< Stopped. */
MDU_READY = 2 /**< Ready. */
} mdustate_t;
/**
* @brief Structure representing a midi USB driver.
*/
typedef struct MidiUSBDriver MidiUSBDriver;
/**
* @brief Midi USB Driver configuration structure.
* @details An instance of this structure must be passed to @p mduStart()
* 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;
} MidiUSBConfig;
/**
* @brief @p MidiUSBDriver specific data.
*/
#define _midi_usb_driver_data \
_base_asynchronous_channel_data \
/* Driver state.*/ \
mdustate_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(MIDI_USB_BUFFERS_NUMBER, \
MIDI_USB_BUFFERS_SIZE)]; \
/* Output buffer.*/ \
uint8_t ob[BQ_BUFFER_SIZE(MIDI_USB_BUFFERS_NUMBER, \
MIDI_USB_BUFFERS_SIZE)]; \
/* End of the mandatory fields.*/ \
/* Current configuration data.*/ \
const MidiUSBConfig *config;
/**
* @brief @p MidiUSBDriver specific methods.
*/
#define _midi_usb_driver_methods \
_base_asynchronous_channel_methods
/**
* @extends BaseAsynchronousChannelVMT
*
* @brief @p MidiUSBDriver virtual methods table.
*/
struct MidiUSBDriverVMT {
_midi_usb_driver_methods
};
/**
* @extends BaseAsynchronousChannel
*
* @brief Full duplex midi driver class.
* @details This class extends @p BaseAsynchronousChannel by adding physical
* I/O queues.
*/
struct MidiUSBDriver {
/** @brief Virtual Methods Table.*/
const struct MidiUSBDriverVMT *vmt;
_midi_usb_driver_data
};
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void mduInit(void);
void mduObjectInit(MidiUSBDriver *mdup);
void mduStart(MidiUSBDriver *mdup, const MidiUSBConfig *config);
void mduStop(MidiUSBDriver *mdup);
void mduSuspendHookI(MidiUSBDriver *mdup);
void mduWakeupHookI(MidiUSBDriver *mdup);
void mduConfigureHookI(MidiUSBDriver *mdup);
bool mduRequestsHook(USBDriver *usbp);
void mduSOFHookI(MidiUSBDriver *mdup);
void mduDataTransmitted(USBDriver *usbp, usbep_t ep);
void mduDataReceived(USBDriver *usbp, usbep_t ep);
void mduInterruptTransmitted(USBDriver *usbp, usbep_t ep);
msg_t mduControl(USBDriver *usbp, unsigned int operation, void *arg);
void midi_usb_MidiSend1(uint8_t port, uint8_t b0);
void midi_usb_MidiSend2(uint8_t port, uint8_t b0, uint8_t b1);
void midi_usb_MidiSend3(uint8_t port, uint8_t b0, uint8_t b1, uint8_t b2);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_MIDI_USB */
#endif /* _MIDI_USB_H_ */
/** @} */