From 573e53e52aceebec86d43b03a881ecff66968bd0 Mon Sep 17 00:00:00 2001 From: Lauszus Date: Mon, 23 Nov 2020 13:54:46 +0000 Subject: [PATCH] deploy: 1ee088bcad350f12981dabbc0271c81f8bde9581 --- _r_e_a_d_m_e_8md_source.html | 2 +- class_u_s_b_h___m_i_d_i.html | 24 ++++++++++++------------ index.html | 2 +- usbh__midi_8cpp_source.html | 24 ++++++++++++------------ usbh__midi_8h_source.html | 22 +++++++++++----------- 5 files changed, 37 insertions(+), 37 deletions(-) diff --git a/_r_e_a_d_m_e_8md_source.html b/_r_e_a_d_m_e_8md_source.html index 1cd4fb8e..8518808d 100644 --- a/_r_e_a_d_m_e_8md_source.html +++ b/_r_e_a_d_m_e_8md_source.html @@ -63,7 +63,7 @@ $(function() {
README.md
-Go to the documentation of this file.
1 # USB Host Library Rev. 2.0
2 
3 The code is released under the GNU General Public License.
4 __________
5 [![](https://github.com/felis/USB_Host_Shield_2.0/workflows/CI/badge.svg)](https://github.com/felis/USB_Host_Shield_2.0/actions?query=branch%3Amaster)
6 
7 # Summary
8 This is Revision 2.0 of MAX3421E-based USB Host Shield Library for AVR's.
9 
10 Project main web site is: <https://chome.nerpa.tech/arduino_usb_host_shield_projects/>.
11 
12 Some information can also be found at: <http://blog.tkjelectronics.dk/>.
13 
14 The shield can be purchased from [TKJ Electronics](http://tkjelectronics.com/): <http://shop.tkjelectronics.dk/product_info.php?products_id=43>.
15 
16 ![USB Host Shield](http://shop.tkjelectronics.dk/images/USB_Host_Shield1.jpg)
17 
18 For more information about the hardware see the [Hardware Manual](https://chome.nerpa.tech/usb-host-shield-hardware-manual/).
19 
20 # Developed By
21 
22 * __Oleg Mazurov__ - <mazurov@gmail.com>
23 * __Alexei Glushchenko__ - <alex-gl@mail.ru>
24  * Developers of the USB Core, HID, FTDI, ADK, ACM, and PL2303 libraries
25 * __Kristian Sloth Lauszus__ - <lauszus@gmail.com>
26  * Developer of the [BTD](#bluetooth-libraries), [BTHID](#bthid-library), [SPP](#spp-library), [PS4](#ps4-library), [PS3](#ps3-library), [Wii](#wii-library), [Xbox](#xbox-library), and [PSBuzz](#ps-buzz-library) libraries
27 * __Andrew Kroll__ - <xxxajk@gmail.com>
28  * Major contributor to mass storage code
29 * __guruthree__
30  * [Xbox ONE](#xbox-one-library) controller support
31 * __Yuuichi Akagawa__ - [\@YuuichiAkagawa](https://twitter.com/yuuichiakagawa)
32  * Developer of the [MIDI](#midi-library) library
33 
34 
35 # Table of Contents
36 
37 * [How to include the library](#how-to-include-the-library)
38  * [Arduino Library Manager](#arduino-library-manager)
39  * [Manual installation](#manual-installation)
40 * [How to use the library](#how-to-use-the-library)
41  * [Documentation](#documentation)
42  * [Enable debugging](#enable-debugging)
43  * [Boards](#boards)
44  * [Bluetooth libraries](#bluetooth-libraries)
45  * [BTHID library](#bthid-library)
46  * [SPP library](#spp-library)
47  * [PS4 Library](#ps4-library)
48  * [PS3 Library](#ps3-library)
49  * [Xbox Libraries](#xbox-libraries)
50  * [Xbox library](#xbox-library)
51  * [Xbox 360 Library](#xbox-360-library)
52  * [Xbox ONE Library](#xbox-one-library)
53  * [Xbox ONE S Library](#xbox-one-s-library)
54  * [Wii library](#wii-library)
55  * [PS Buzz Library](#ps-buzz-library)
56  * [HID Libraries](#hid-libraries)
57  * [MIDI Library](#midi-library)
58 * [Interface modifications](#interface-modifications)
59 * [FAQ](#faq)
60 
61 # How to include the library
62 
63 ### Arduino Library Manager
64 
65 First install Arduino IDE version 1.6.2 or newer, then simply use the Arduino Library Manager to install the library.
66 
67 Please see the following page for instructions: <http://www.arduino.cc/en/Guide/Libraries#toc3>.
68 
69 ### Manual installation
70 
71 First download the library by clicking on the following link: <https://github.com/felis/USB_Host_Shield_2.0/archive/master.zip>.
72 
73 Then uncompress the zip folder and rename the directory to "USB\_Host\_Shield\_20", as any special characters are not supported by the Arduino IDE.
74 
75 Now open up the Arduino IDE and open "File>Preferences". There you will see the location of your sketchbook. Open that directory and create a directory called "libraries" inside that directory.
76 Now move the "USB\_Host\_Shield\_20" directory to the "libraries" directory.
77 
78 The final structure should look like this:
79 
80 * Arduino/
81  * libraries/
82  * USB\_Host\_Shield\_20/
83 
84 Now quit the Arduino IDE and reopen it.
85 
86 Now you should be able to go open all the examples codes by navigating to "File>Examples>USB\_Host\_Shield\_20" and then select the example you will like to open.
87 
88 For more information visit the following sites: <http://arduino.cc/en/Guide/Libraries> and <https://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use>.
89 
90 # How to use the library
91 
92 ### Documentation
93 
94 Documentation for the library can be found at the following link: <https://felis.github.io/USB_Host_Shield_2.0/>.
95 
96 ### Enable debugging
97 
98 By default serial debugging is disabled. To turn it on simply change ```ENABLE_UHS_DEBUGGING``` to 1 in [settings.h](settings.h) like so:
99 
100 ```C++
101 #define ENABLE_UHS_DEBUGGING 1
102 ```
103 
104 ### Boards
105 
106 Currently the following boards are supported by the library:
107 
108 * All official Arduino AVR boards (Uno, Duemilanove, Mega, Mega 2560, Mega ADK, Leonardo etc.)
109 * Arduino Due, Intel Galileo, Intel Galileo 2, and Intel Edison
110  * Note that the Intel Galileo uses pin 2 and 3 as INT and SS pin respectively by default, so some modifications to the shield are needed. See the "Interface modifications" section in the [hardware manual](https://chome.nerpa.tech/usb-host-shield-hardware-manual) for more information.
111  * Note native USB host is not supported on any of these platforms. You will have to use the shield for now.
112 * Teensy (Teensy++ 1.0, Teensy 2.0, Teensy++ 2.0, Teensy 3.x, Teensy LC and Teensy 4.x)
113  * Note if you are using the Teensy 3.x you should download this SPI library as well: <https://github.com/xxxajk/spi4teensy3>. You should then add ```#include <spi4teensy3.h>``` to your .ino file.
114 * Balanduino
115 * Sanguino
116 * Black Widdow
117 * RedBearLab nRF51822
118 * Digilent chipKIT
119  * Please see: <https://chome.nerpa.tech/mcu/usb/running-usb-host-code-on-digilent-chipkit-board>.
120 * STM32F4
121  * Currently the [NUCLEO-F446RE](http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1847/PF262063) is supported featuring the STM32F446. Take a look at the following example code: <https://github.com/Lauszus/Nucleo_F446RE_USBHost>.
122 * ESP8266 is supported using the [ESP8266 Arduino core](https://github.com/esp8266/Arduino)
123  * Note it uses pin 15 and 5 for SS and INT respectively
124  * Also please be aware that:
125  * GPIO16 is **NOT** usable, as it will be used for some other purposes. For example, reset the SoC itself from sleep mode.
126  * GPIO6 to 11 is also **NOT** usable, as they are used to connect SPI flash chip and it is used for storing the executable binary content.
127 * ESP32 is supported using the [arduino-esp32](https://github.com/espressif/arduino-esp32/)
128  * GPIO5 : SS, GPIO17 : INT, GPIO18 : SCK, GPIO19 : MISO, GPIO23 : MOSI
129 
130 The following boards need to be activated manually in [settings.h](settings.h):
131 
132 * Arduino Mega ADK
133  * If you are using Arduino 1.5.5 or newer there is no need to activate the Arduino Mega ADK manually
134 * Black Widdow
135 
136 Simply set the corresponding value to 1 instead of 0.
137 
138 ### [Bluetooth libraries](BTD.cpp)
139 
140 The [BTD library](BTD.cpp) is a general purpose library for an ordinary Bluetooth dongle.
141 This library make it easy to add support for different Bluetooth services like a PS3 or a Wii controller or SPP which is a virtual serial port via Bluetooth.
142 Some different examples can be found in the [example directory](examples/Bluetooth).
143 
144 The BTD library also makes it possible to use multiple services at once, the following example sketch is an example of this:
145 [PS3SPP.ino](examples/Bluetooth/PS3SPP/PS3SPP.ino).
146 
147 ### [BTHID library](BTHID.cpp)
148 
149 The [Bluetooth HID library](BTHID.cpp) allows you to connect HID devices via Bluetooth to the USB Host Shield.
150 
151 Currently HID mice and keyboards are supported.
152 
153 It uses the standard Boot protocol by default, but it is also able to use the Report protocol as well. You would simply have to call ```setProtocolMode()``` and then parse ```HID_RPT_PROTOCOL``` as an argument. You will then have to modify the parser for your device. See the example: [BTHID.ino](examples/Bluetooth/BTHID/BTHID.ino) for more information.
154 
155 The [PS4 library](#ps4-library) also uses this class to handle all Bluetooth communication.
156 
157 For information see the following blog post: <http://blog.tkjelectronics.dk/2013/12/bluetooth-hid-devices-now-supported-by-the-usb-host-library/>.
158 
159 ### [SPP library](SPP.cpp)
160 
161 SPP stands for "Serial Port Profile" and is a Bluetooth protocol that implements a virtual comport which allows you to send data back and forth from your computer/phone to your Arduino via Bluetooth.
162 It has been tested successfully on Windows, Mac OS X, Linux, and Android.
163 
164 Take a look at the [SPP.ino](examples/Bluetooth/SPP/SPP.ino) example for more information.
165 
166 More information can be found at these blog posts:
167 
168 * <http://chome.nerpa.tech/mcu/bluetooth-rfcommspp-service-support-for-usb-host-2-0-library-released>
169 * <http://blog.tkjelectronics.dk/2012/07/rfcommspp-library-for-arduino/>
170 
171 To implement the SPP protocol I used a Bluetooth sniffing tool called [PacketLogger](http://www.tkjelectronics.com/uploads/PacketLogger.zip) developed by Apple.
172 It enables me to see the Bluetooth communication between my Mac and any device.
173 
174 ### PS4 Library
175 
176 The PS4BT library is split up into the [PS4BT](PS4BT.h) and the [PS4USB](PS4USB.h) library. These allow you to use the Sony PS4 controller via Bluetooth and USB.
177 
178 The [PS4BT.ino](examples/Bluetooth/PS4BT/PS4BT.ino) and [PS4USB.ino](examples/PS4USB/PS4USB.ino) examples shows how to easily read the buttons, joysticks, touchpad and IMU on the controller via Bluetooth and USB respectively. It is also possible to control the rumble and light on the controller and get the battery level.
179 
180 Before you can use the PS4 controller via Bluetooth you will need to pair with it.
181 
182 Simply create the PS4BT instance like so: ```PS4BT PS4(&Btd, PAIR);``` and then hold down the Share button and then hold down the PS without releasing the Share button. The PS4 controller will then start to blink rapidly indicating that it is in pairing mode.
183 
184 It should then automatically pair the dongle with your controller. This only have to be done once.
185 
186 For information see the following blog post: <http://blog.tkjelectronics.dk/2014/01/ps4-controller-now-supported-by-the-usb-host-library/>.
187 
188 Also check out this excellent Wiki by Frank Zhao about the PS4 controller: <http://eleccelerator.com/wiki/index.php?title=DualShock_4> and this Linux driver: <https://github.com/chrippa/ds4drv>.
189 
190 Several guides on how to use the PS4 library has been written by Dr. James E. Barger and are available at the following link: <https://sites.google.com/view/vbatc-engineeringtechnology2/control-system-tutorials/ps4-tutorials>.
191 
192 ### PS3 Library
193 
194 These libraries consist of the [PS3BT](PS3BT.cpp) and [PS3USB](PS3USB.cpp). These libraries allows you to use a Dualshock 3, Navigation or a Motion controller with the USB Host Shield both via Bluetooth and USB.
195 
196 In order to use your Playstation controller via Bluetooth you have to set the Bluetooth address of the dongle internally to your PS3 Controller. This can be achieved by first plugging in the Bluetooth dongle and wait a few seconds. Now plug in the controller via USB and wait until the LEDs start to flash. The library has now written the Bluetooth address of the dongle to the PS3 controller.
197 
198 Finally simply plug in the Bluetooth dongle again and press PS on the PS3 controller. After a few seconds it should be connected to the dongle and ready to use.
199 
200 __Note:__ You will have to plug in the Bluetooth dongle before connecting the controller, as the library needs to read the address of the dongle. Alternatively you could set it in code like so: [PS3BT.ino#L20](examples/Bluetooth/PS3BT/PS3BT.ino#L20).
201 
202 For more information about the PS3 protocol see the official wiki: <https://github.com/felis/USB_Host_Shield_2.0/wiki/PS3-Information>.
203 
204 Also take a look at the blog posts:
205 
206 * <http://blog.tkjelectronics.dk/2012/01/ps3-controller-bt-library-for-arduino/>
207 * <http://chome.nerpa.tech/mcu/sony-ps3-controller-support-added-to-usb-host-library>
208 * <http://chome.nerpa.tech/mcu/arduino/interfacing-ps3-controllers-via-usb>
209 
210 A special thanks go to the following people:
211 
212 1. _Richard Ibbotson_ who made this excellent guide: <http://chome.nerpa.tech/mcu/ps3-and-wiimote-game-controllers-on-the-arduino-host-shield-part>
213 2. _Tomoyuki Tanaka_ for releasing his code for the Arduino USB Host shield connected to the wiimote: <http://chome.nerpa.tech/mcu/rc-car-controlled-by-wii-remote-on-arduino>
214 
215 Also a big thanks all the people behind these sites about the Motion controller:
216 
217 * <http://thp.io/2010/psmove/>
218 * <http://www.copenhagengamecollective.org/unimove/>
219 * <https://github.com/thp/psmoveapi>
220 * <http://code.google.com/p/moveonpc/>
221 
222 ### Xbox Libraries
223 
224 The library supports both the original Xbox controller via USB and the Xbox 360 controller both via USB and wirelessly.
225 
226 #### Xbox library
227 
228 The [XBOXOLD](XBOXOLD.cpp) class implements support for the original Xbox controller via USB.
229 
230 All the information are from the following sites:
231 
232 * <https://github.com/torvalds/linux/blob/master/Documentation/input/xpad.txt>
233 * <https://github.com/torvalds/linux/blob/master/drivers/input/joystick/xpad.c>
234 * <http://euc.jp/periphs/xbox-controller.ja.html>
235 * <https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL#L15>
236 
237 #### Xbox 360 Library
238 
239 The library support one Xbox 360 via USB or up to four Xbox 360 controllers wirelessly by using a [Xbox 360 wireless receiver](http://blog.tkjelectronics.dk/wp-content/uploads/xbox360-wireless-receiver.jpg).
240 
241 To use it via USB use the [XBOXUSB](XBOXUSB.cpp) library or to use it wirelessly use the [XBOXRECV](XBOXRECV.cpp) library.
242 
243 __Note that a Wireless controller can NOT be used via USB!__
244 
245 Examples code can be found in the [examples directory](examples/Xbox).
246 
247 Also see the following blog posts:
248 
249 * <http://chome.nerpa.tech/mcu/xbox360-controller-support-added-to-usb-host-shield-2-0-library>
250 * <http://blog.tkjelectronics.dk/2012/07/xbox-360-controller-support-added-to-the-usb-host-library/>
251 * <http://blog.tkjelectronics.dk/2012/12/xbox-360-receiver-added-to-the-usb-host-library/>
252 
253 All the information regarding the Xbox 360 controller protocol are form these sites:
254 
255 * <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/UsbInfo>
256 * <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/WirelessUsbInfo>
257 * <https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL>
258 
259 #### Xbox ONE Library
260 
261 A Xbox ONE controller is supported via USB in the [XBOXONE](XBOXONE.cpp) class. It is heavily based on the 360 library above. In addition to cross referencing the above, information on the protocol was found at:
262 
263 * <https://github.com/quantus/xbox-one-controller-protocol>
264 * <https://github.com/torvalds/linux/blob/master/drivers/input/joystick/xpad.c>
265 * <https://github.com/kylelemons/xbox/blob/master/xbox.go>
266 
267 #### Xbox ONE S Library
268 
269 A Xbox ONE controller is supported via Bluetooth in the [XBOXONESBT](XBOXONESBT.cpp) class.
270 
271 Special thanks to [HisashiKato](https://github.com/HisashiKato) for his help: <https://github.com/felis/USB_Host_Shield_2.0/issues/252#issuecomment-716912362>.
272 
273 ### [Wii library](Wii.cpp)
274 
275 The [Wii](Wii.cpp) library support the Wiimote, but also the Nunchuch and Motion Plus extensions via Bluetooth. The Wii U Pro Controller and Wii Balance Board are also supported via Bluetooth.
276 
277 First you have to pair with the controller, this is done automatically by the library if you create the instance like so:
278 
279 ```C++
280 WII Wii(&Btd, PAIR);
281 ```
282 
283 And then press 1 & 2 at once on the Wiimote or the SYNC buttons if you are using a Wii U Pro Controller or a Wii Balance Board.
284 
285 After that you can simply create the instance like so:
286 
287 ```C++
288 WII Wii(&Btd);
289 ```
290 
291 Then just press any button on the Wiimote and it will then connect to the dongle.
292 
293 Take a look at the example for more information: [Wii.ino](examples/Bluetooth/Wii/Wii.ino).
294 
295 Also take a look at the blog post:
296 
297 * <http://blog.tkjelectronics.dk/2012/08/wiimote-added-to-usb-host-library/>
298 
299 The Wii IR camera can also be used, but you will have to activate the code for it manually as it is quite large. Simply set ```ENABLE_WII_IR_CAMERA``` to 1 in [settings.h](settings.h).
300 
301 The [WiiIRCamera.ino](examples/Bluetooth/WiiIRCamera/WiiIRCamera.ino) example shows how it can be used.
302 
303 All the information about the Wii controllers are from these sites:
304 
305 * <http://wiibrew.org/wiki/Wiimote>
306 * <http://wiibrew.org/wiki/Wiimote/Extension_Controllers>
307 * <http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Nunchuck>
308 * <http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Wii_Motion_Plus>
309 * <http://wiibrew.org/wiki/Wii_Balance_Board>
310 * The old library created by _Tomoyuki Tanaka_: <https://github.com/moyuchin/WiiRemote_on_Arduino> also helped a lot.
311 
312 ### [PS Buzz Library](PSBuzz.cpp)
313 
314 This library implements support for the Playstation Buzz controllers via USB.
315 
316 It is essentially just a wrapper around the [HIDUniversal](hiduniversal.cpp) which takes care of the initializing and reading of the controllers. The [PSBuzz](PSBuzz.cpp) class simply inherits this and parses the data, so it is easy for users to read the buttons and turn the big red button on the controllers on and off.
317 
318 The example [PSBuzz.ino](examples/PSBuzz/PSBuzz.ino) shows how one can do this with just a few lines of code.
319 
320 More information about the controller can be found at the following sites:
321 
322 * http://www.developerfusion.com/article/84338/making-usb-c-friendly/
323 * https://github.com/torvalds/linux/blob/master/drivers/hid/hid-sony.c
324 
325 ### HID Libraries
326 
327 HID devices are also supported by the library. However these require you to write your own driver. A few example are provided in the [examples/HID](examples/HID) directory. Including an example for the [SteelSeries SRW-S1 Steering Wheel](examples/HID/SRWS1/SRWS1.ino).
328 
329 ### [MIDI Library](usbh_midi.cpp)
330 
331 The library support MIDI devices.
332 You can convert USB MIDI keyboard to legacy serial MIDI.
333 
334 * [USB_MIDI_converter.ino](examples/USBH_MIDI/USB_MIDI_converter/USB_MIDI_converter.ino)
335 * [USB_MIDI_converter_multi.ino](examples/USBH_MIDI/USB_MIDI_converter_multi/USB_MIDI_converter_multi.ino)
336 
337 For information see the following page: <http://yuuichiakagawa.github.io/USBH_MIDI/>.
338 
339 # Interface modifications
340 
341 The shield is using SPI for communicating with the MAX3421E USB host controller. It uses the SCK, MISO and MOSI pins via the ICSP on your board.
342 
343 Note this means that it uses pin 13, 12, 11 on an Arduino Uno, so these pins can not be used for anything else than SPI communication!
344 
345 Furthermore it uses one pin as SS and one INT pin. These are by default located on pin 10 and 9 respectively. They can easily be reconfigured in case you need to use them for something else by cutting the jumper on the shield and then solder a wire from the pad to the new pin.
346 
347 After that you need modify the following entry in [UsbCore.h](UsbCore.h):
348 
349 ```C++
350 typedef MAX3421e<P10, P9> MAX3421E;
351 ```
352 
353 For instance if you have rerouted SS to pin 7 it should read:
354 
355 ```C++
356 typedef MAX3421e<P7, P9> MAX3421E;
357 ```
358 
359 See the "Interface modifications" section in the [hardware manual](https://chome.nerpa.tech/usb-host-shield-hardware-manual) for more information.
360 
361 # FAQ
362 
363 > When I plug my device into the USB connector nothing happens?
364 
365 * Try to connect a external power supply to the Arduino - this solves the problem in most cases.
366 * You can also use a powered hub between the device and the USB Host Shield. You should then include the USB hub library: ```#include <usbhub.h>``` and create the instance like so: ```USBHub Hub1(&Usb);```.
367 
368 > When I connecting my PS3 controller I get a output like this:
369 
370 ```
371 Dualshock 3 Controller Enabled
372 
373 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
374 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
375 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
376 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
377 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
378 ```
379 
380 * This means that your dongle does not support 2.0+EDR, so you will need another dongle. Please see the following [list](https://github.com/felis/USB_Host_Shield_2.0/wiki/Bluetooth-dongles) for tested working dongles.
381 
382 > When compiling I am getting the following error: "fatal error: SPI.h: No such file or directory".
383 
384 * Please make sure to include the SPI library like so: ```#include <SPI.h>``` in your .ino file.
+Go to the documentation of this file.
1 # USB Host Library Rev. 2.0
2 
3 The code is released under the GNU General Public License.
4 __________
5 [![](https://github.com/felis/USB_Host_Shield_2.0/workflows/CI/badge.svg)](https://github.com/felis/USB_Host_Shield_2.0/actions?query=branch%3Amaster)
6 
7 # Summary
8 This is Revision 2.0 of MAX3421E-based USB Host Shield Library for AVR's.
9 
10 Project main web site is: <https://chome.nerpa.tech/arduino_usb_host_shield_projects/>.
11 
12 Some information can also be found at: <http://blog.tkjelectronics.dk/>.
13 
14 The shield can be purchased from [TKJ Electronics](http://tkjelectronics.com/): <http://shop.tkjelectronics.dk/product_info.php?products_id=43>.
15 
16 ![USB Host Shield](http://shop.tkjelectronics.dk/images/USB_Host_Shield1.jpg)
17 
18 For more information about the hardware see the [Hardware Manual](https://chome.nerpa.tech/usb-host-shield-hardware-manual/).
19 
20 # Developed By
21 
22 * __Oleg Mazurov__ - <mazurov@gmail.com>
23 * __Alexei Glushchenko__ - <alex-gl@mail.ru>
24  * Developers of the USB Core, HID, FTDI, ADK, ACM, and PL2303 libraries
25 * __Kristian Sloth Lauszus__ - <lauszus@gmail.com>
26  * Developer of the [BTD](#bluetooth-libraries), [BTHID](#bthid-library), [SPP](#spp-library), [PS4](#ps4-library), [PS3](#ps3-library), [Wii](#wii-library), [Xbox](#xbox-library), and [PSBuzz](#ps-buzz-library) libraries
27 * __Andrew Kroll__ - <xxxajk@gmail.com>
28  * Major contributor to mass storage code
29 * __guruthree__
30  * [Xbox ONE](#xbox-one-library) controller support
31 * __Yuuichi Akagawa__ - [\@YuuichiAkagawa](https://twitter.com/yuuichiakagawa)
32  * Developer of the [MIDI](#midi-library) library
33 
34 
35 # Table of Contents
36 
37 * [How to include the library](#how-to-include-the-library)
38  * [Arduino Library Manager](#arduino-library-manager)
39  * [Manual installation](#manual-installation)
40 * [How to use the library](#how-to-use-the-library)
41  * [Documentation](#documentation)
42  * [Enable debugging](#enable-debugging)
43  * [Boards](#boards)
44  * [Bluetooth libraries](#bluetooth-libraries)
45  * [BTHID library](#bthid-library)
46  * [SPP library](#spp-library)
47  * [PS4 Library](#ps4-library)
48  * [PS3 Library](#ps3-library)
49  * [Xbox Libraries](#xbox-libraries)
50  * [Xbox library](#xbox-library)
51  * [Xbox 360 Library](#xbox-360-library)
52  * [Xbox ONE Library](#xbox-one-library)
53  * [Xbox ONE S Library](#xbox-one-s-library)
54  * [Wii library](#wii-library)
55  * [PS Buzz Library](#ps-buzz-library)
56  * [HID Libraries](#hid-libraries)
57  * [MIDI Library](#midi-library)
58 * [Interface modifications](#interface-modifications)
59 * [FAQ](#faq)
60 
61 # How to include the library
62 
63 ### Arduino Library Manager
64 
65 First install Arduino IDE version 1.6.2 or newer, then simply use the Arduino Library Manager to install the library.
66 
67 Please see the following page for instructions: <http://www.arduino.cc/en/Guide/Libraries#toc3>.
68 
69 ### Manual installation
70 
71 First download the library by clicking on the following link: <https://github.com/felis/USB_Host_Shield_2.0/archive/master.zip>.
72 
73 Then uncompress the zip folder and rename the directory to "USB\_Host\_Shield\_20", as any special characters are not supported by the Arduino IDE.
74 
75 Now open up the Arduino IDE and open "File>Preferences". There you will see the location of your sketchbook. Open that directory and create a directory called "libraries" inside that directory.
76 Now move the "USB\_Host\_Shield\_20" directory to the "libraries" directory.
77 
78 The final structure should look like this:
79 
80 * Arduino/
81  * libraries/
82  * USB\_Host\_Shield\_20/
83 
84 Now quit the Arduino IDE and reopen it.
85 
86 Now you should be able to go open all the examples codes by navigating to "File>Examples>USB\_Host\_Shield\_20" and then select the example you will like to open.
87 
88 For more information visit the following sites: <http://arduino.cc/en/Guide/Libraries> and <https://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use>.
89 
90 # How to use the library
91 
92 ### Documentation
93 
94 Documentation for the library can be found at the following link: <https://felis.github.io/USB_Host_Shield_2.0/>.
95 
96 ### Enable debugging
97 
98 By default serial debugging is disabled. To turn it on simply change ```ENABLE_UHS_DEBUGGING``` to 1 in [settings.h](settings.h) like so:
99 
100 ```C++
101 #define ENABLE_UHS_DEBUGGING 1
102 ```
103 
104 ### Boards
105 
106 Currently the following boards are supported by the library:
107 
108 * All official Arduino AVR boards (Uno, Duemilanove, Mega, Mega 2560, Mega ADK, Leonardo etc.)
109 * Arduino Due, Intel Galileo, Intel Galileo 2, and Intel Edison
110  * Note that the Intel Galileo uses pin 2 and 3 as INT and SS pin respectively by default, so some modifications to the shield are needed. See the "Interface modifications" section in the [hardware manual](https://chome.nerpa.tech/usb-host-shield-hardware-manual) for more information.
111  * Note native USB host is not supported on any of these platforms. You will have to use the shield for now.
112 * Teensy (Teensy++ 1.0, Teensy 2.0, Teensy++ 2.0, Teensy 3.x, Teensy LC and Teensy 4.x)
113  * Note if you are using the Teensy 3.x you should download this SPI library as well: <https://github.com/xxxajk/spi4teensy3>. You should then add ```#include <spi4teensy3.h>``` to your .ino file.
114 * Balanduino
115 * Sanguino
116 * Black Widdow
117 * RedBearLab nRF51822
118 * Digilent chipKIT
119  * Please see: <https://chome.nerpa.tech/mcu/usb/running-usb-host-code-on-digilent-chipkit-board>.
120 * STM32F4
121  * Currently the [NUCLEO-F446RE](http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1847/PF262063) is supported featuring the STM32F446. Take a look at the following example code: <https://github.com/Lauszus/Nucleo_F446RE_USBHost>.
122 * ESP8266 is supported using the [ESP8266 Arduino core](https://github.com/esp8266/Arduino)
123  * Note it uses pin 15 and 5 for SS and INT respectively
124  * Also please be aware that:
125  * GPIO16 is **NOT** usable, as it will be used for some other purposes. For example, reset the SoC itself from sleep mode.
126  * GPIO6 to 11 is also **NOT** usable, as they are used to connect SPI flash chip and it is used for storing the executable binary content.
127 * ESP32 is supported using the [arduino-esp32](https://github.com/espressif/arduino-esp32/)
128  * GPIO5 : SS, GPIO17 : INT, GPIO18 : SCK, GPIO19 : MISO, GPIO23 : MOSI
129 
130 The following boards need to be activated manually in [settings.h](settings.h):
131 
132 * Arduino Mega ADK
133  * If you are using Arduino 1.5.5 or newer there is no need to activate the Arduino Mega ADK manually
134 * Black Widdow
135 
136 Simply set the corresponding value to 1 instead of 0.
137 
138 ### [Bluetooth libraries](BTD.cpp)
139 
140 The [BTD library](BTD.cpp) is a general purpose library for an ordinary Bluetooth dongle.
141 This library make it easy to add support for different Bluetooth services like a PS3 or a Wii controller or SPP which is a virtual serial port via Bluetooth.
142 Some different examples can be found in the [example directory](examples/Bluetooth).
143 
144 The BTD library also makes it possible to use multiple services at once, the following example sketch is an example of this:
145 [PS3SPP.ino](examples/Bluetooth/PS3SPP/PS3SPP.ino).
146 
147 ### [BTHID library](BTHID.cpp)
148 
149 The [Bluetooth HID library](BTHID.cpp) allows you to connect HID devices via Bluetooth to the USB Host Shield.
150 
151 Currently HID mice and keyboards are supported.
152 
153 It uses the standard Boot protocol by default, but it is also able to use the Report protocol as well. You would simply have to call ```setProtocolMode()``` and then parse ```HID_RPT_PROTOCOL``` as an argument. You will then have to modify the parser for your device. See the example: [BTHID.ino](examples/Bluetooth/BTHID/BTHID.ino) for more information.
154 
155 The [PS4 library](#ps4-library) also uses this class to handle all Bluetooth communication.
156 
157 For information see the following blog post: <http://blog.tkjelectronics.dk/2013/12/bluetooth-hid-devices-now-supported-by-the-usb-host-library/>.
158 
159 ### [SPP library](SPP.cpp)
160 
161 SPP stands for "Serial Port Profile" and is a Bluetooth protocol that implements a virtual comport which allows you to send data back and forth from your computer/phone to your Arduino via Bluetooth.
162 It has been tested successfully on Windows, Mac OS X, Linux, and Android.
163 
164 Take a look at the [SPP.ino](examples/Bluetooth/SPP/SPP.ino) example for more information.
165 
166 More information can be found at these blog posts:
167 
168 * <http://chome.nerpa.tech/mcu/bluetooth-rfcommspp-service-support-for-usb-host-2-0-library-released>
169 * <http://blog.tkjelectronics.dk/2012/07/rfcommspp-library-for-arduino/>
170 
171 To implement the SPP protocol I used a Bluetooth sniffing tool called [PacketLogger](http://www.tkjelectronics.com/uploads/PacketLogger.zip) developed by Apple.
172 It enables me to see the Bluetooth communication between my Mac and any device.
173 
174 ### PS4 Library
175 
176 The PS4BT library is split up into the [PS4BT](PS4BT.h) and the [PS4USB](PS4USB.h) library. These allow you to use the Sony PS4 controller via Bluetooth and USB.
177 
178 The [PS4BT.ino](examples/Bluetooth/PS4BT/PS4BT.ino) and [PS4USB.ino](examples/PS4USB/PS4USB.ino) examples shows how to easily read the buttons, joysticks, touchpad and IMU on the controller via Bluetooth and USB respectively. It is also possible to control the rumble and light on the controller and get the battery level.
179 
180 Before you can use the PS4 controller via Bluetooth you will need to pair with it.
181 
182 Simply create the PS4BT instance like so: ```PS4BT PS4(&Btd, PAIR);``` and then hold down the Share button and then hold down the PS without releasing the Share button. The PS4 controller will then start to blink rapidly indicating that it is in pairing mode.
183 
184 It should then automatically pair the dongle with your controller. This only have to be done once.
185 
186 For information see the following blog post: <http://blog.tkjelectronics.dk/2014/01/ps4-controller-now-supported-by-the-usb-host-library/>.
187 
188 Also check out this excellent Wiki by Frank Zhao about the PS4 controller: <http://eleccelerator.com/wiki/index.php?title=DualShock_4> and this Linux driver: <https://github.com/chrippa/ds4drv>.
189 
190 Several guides on how to use the PS4 library has been written by Dr. James E. Barger and are available at the following link: <https://sites.google.com/view/crosswaystation/ps4-tutorials>.
191 
192 ### PS3 Library
193 
194 These libraries consist of the [PS3BT](PS3BT.cpp) and [PS3USB](PS3USB.cpp). These libraries allows you to use a Dualshock 3, Navigation or a Motion controller with the USB Host Shield both via Bluetooth and USB.
195 
196 In order to use your Playstation controller via Bluetooth you have to set the Bluetooth address of the dongle internally to your PS3 Controller. This can be achieved by first plugging in the Bluetooth dongle and wait a few seconds. Now plug in the controller via USB and wait until the LEDs start to flash. The library has now written the Bluetooth address of the dongle to the PS3 controller.
197 
198 Finally simply plug in the Bluetooth dongle again and press PS on the PS3 controller. After a few seconds it should be connected to the dongle and ready to use.
199 
200 __Note:__ You will have to plug in the Bluetooth dongle before connecting the controller, as the library needs to read the address of the dongle. Alternatively you could set it in code like so: [PS3BT.ino#L20](examples/Bluetooth/PS3BT/PS3BT.ino#L20).
201 
202 For more information about the PS3 protocol see the official wiki: <https://github.com/felis/USB_Host_Shield_2.0/wiki/PS3-Information>.
203 
204 Also take a look at the blog posts:
205 
206 * <http://blog.tkjelectronics.dk/2012/01/ps3-controller-bt-library-for-arduino/>
207 * <http://chome.nerpa.tech/mcu/sony-ps3-controller-support-added-to-usb-host-library>
208 * <http://chome.nerpa.tech/mcu/arduino/interfacing-ps3-controllers-via-usb>
209 
210 A special thanks go to the following people:
211 
212 1. _Richard Ibbotson_ who made this excellent guide: <http://chome.nerpa.tech/mcu/ps3-and-wiimote-game-controllers-on-the-arduino-host-shield-part>
213 2. _Tomoyuki Tanaka_ for releasing his code for the Arduino USB Host shield connected to the wiimote: <http://chome.nerpa.tech/mcu/rc-car-controlled-by-wii-remote-on-arduino>
214 
215 Also a big thanks all the people behind these sites about the Motion controller:
216 
217 * <http://thp.io/2010/psmove/>
218 * <http://www.copenhagengamecollective.org/unimove/>
219 * <https://github.com/thp/psmoveapi>
220 * <http://code.google.com/p/moveonpc/>
221 
222 ### Xbox Libraries
223 
224 The library supports both the original Xbox controller via USB and the Xbox 360 controller both via USB and wirelessly.
225 
226 #### Xbox library
227 
228 The [XBOXOLD](XBOXOLD.cpp) class implements support for the original Xbox controller via USB.
229 
230 All the information are from the following sites:
231 
232 * <https://github.com/torvalds/linux/blob/master/Documentation/input/xpad.txt>
233 * <https://github.com/torvalds/linux/blob/master/drivers/input/joystick/xpad.c>
234 * <http://euc.jp/periphs/xbox-controller.ja.html>
235 * <https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL#L15>
236 
237 #### Xbox 360 Library
238 
239 The library support one Xbox 360 via USB or up to four Xbox 360 controllers wirelessly by using a [Xbox 360 wireless receiver](http://blog.tkjelectronics.dk/wp-content/uploads/xbox360-wireless-receiver.jpg).
240 
241 To use it via USB use the [XBOXUSB](XBOXUSB.cpp) library or to use it wirelessly use the [XBOXRECV](XBOXRECV.cpp) library.
242 
243 __Note that a Wireless controller can NOT be used via USB!__
244 
245 Examples code can be found in the [examples directory](examples/Xbox).
246 
247 Also see the following blog posts:
248 
249 * <http://chome.nerpa.tech/mcu/xbox360-controller-support-added-to-usb-host-shield-2-0-library>
250 * <http://blog.tkjelectronics.dk/2012/07/xbox-360-controller-support-added-to-the-usb-host-library/>
251 * <http://blog.tkjelectronics.dk/2012/12/xbox-360-receiver-added-to-the-usb-host-library/>
252 
253 All the information regarding the Xbox 360 controller protocol are form these sites:
254 
255 * <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/UsbInfo>
256 * <http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/WirelessUsbInfo>
257 * <https://github.com/Grumbel/xboxdrv/blob/master/PROTOCOL>
258 
259 #### Xbox ONE Library
260 
261 A Xbox ONE controller is supported via USB in the [XBOXONE](XBOXONE.cpp) class. It is heavily based on the 360 library above. In addition to cross referencing the above, information on the protocol was found at:
262 
263 * <https://github.com/quantus/xbox-one-controller-protocol>
264 * <https://github.com/torvalds/linux/blob/master/drivers/input/joystick/xpad.c>
265 * <https://github.com/kylelemons/xbox/blob/master/xbox.go>
266 
267 #### Xbox ONE S Library
268 
269 A Xbox ONE controller is supported via Bluetooth in the [XBOXONESBT](XBOXONESBT.cpp) class.
270 
271 Special thanks to [HisashiKato](https://github.com/HisashiKato) for his help: <https://github.com/felis/USB_Host_Shield_2.0/issues/252#issuecomment-716912362>.
272 
273 ### [Wii library](Wii.cpp)
274 
275 The [Wii](Wii.cpp) library support the Wiimote, but also the Nunchuch and Motion Plus extensions via Bluetooth. The Wii U Pro Controller and Wii Balance Board are also supported via Bluetooth.
276 
277 First you have to pair with the controller, this is done automatically by the library if you create the instance like so:
278 
279 ```C++
280 WII Wii(&Btd, PAIR);
281 ```
282 
283 And then press 1 & 2 at once on the Wiimote or the SYNC buttons if you are using a Wii U Pro Controller or a Wii Balance Board.
284 
285 After that you can simply create the instance like so:
286 
287 ```C++
288 WII Wii(&Btd);
289 ```
290 
291 Then just press any button on the Wiimote and it will then connect to the dongle.
292 
293 Take a look at the example for more information: [Wii.ino](examples/Bluetooth/Wii/Wii.ino).
294 
295 Also take a look at the blog post:
296 
297 * <http://blog.tkjelectronics.dk/2012/08/wiimote-added-to-usb-host-library/>
298 
299 The Wii IR camera can also be used, but you will have to activate the code for it manually as it is quite large. Simply set ```ENABLE_WII_IR_CAMERA``` to 1 in [settings.h](settings.h).
300 
301 The [WiiIRCamera.ino](examples/Bluetooth/WiiIRCamera/WiiIRCamera.ino) example shows how it can be used.
302 
303 All the information about the Wii controllers are from these sites:
304 
305 * <http://wiibrew.org/wiki/Wiimote>
306 * <http://wiibrew.org/wiki/Wiimote/Extension_Controllers>
307 * <http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Nunchuck>
308 * <http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Wii_Motion_Plus>
309 * <http://wiibrew.org/wiki/Wii_Balance_Board>
310 * The old library created by _Tomoyuki Tanaka_: <https://github.com/moyuchin/WiiRemote_on_Arduino> also helped a lot.
311 
312 ### [PS Buzz Library](PSBuzz.cpp)
313 
314 This library implements support for the Playstation Buzz controllers via USB.
315 
316 It is essentially just a wrapper around the [HIDUniversal](hiduniversal.cpp) which takes care of the initializing and reading of the controllers. The [PSBuzz](PSBuzz.cpp) class simply inherits this and parses the data, so it is easy for users to read the buttons and turn the big red button on the controllers on and off.
317 
318 The example [PSBuzz.ino](examples/PSBuzz/PSBuzz.ino) shows how one can do this with just a few lines of code.
319 
320 More information about the controller can be found at the following sites:
321 
322 * http://www.developerfusion.com/article/84338/making-usb-c-friendly/
323 * https://github.com/torvalds/linux/blob/master/drivers/hid/hid-sony.c
324 
325 ### HID Libraries
326 
327 HID devices are also supported by the library. However these require you to write your own driver. A few example are provided in the [examples/HID](examples/HID) directory. Including an example for the [SteelSeries SRW-S1 Steering Wheel](examples/HID/SRWS1/SRWS1.ino).
328 
329 ### [MIDI Library](usbh_midi.cpp)
330 
331 The library support MIDI devices.
332 You can convert USB MIDI keyboard to legacy serial MIDI.
333 
334 * [USB_MIDI_converter.ino](examples/USBH_MIDI/USB_MIDI_converter/USB_MIDI_converter.ino)
335 * [USB_MIDI_converter_multi.ino](examples/USBH_MIDI/USB_MIDI_converter_multi/USB_MIDI_converter_multi.ino)
336 
337 For information see the following page: <http://yuuichiakagawa.github.io/USBH_MIDI/>.
338 
339 # Interface modifications
340 
341 The shield is using SPI for communicating with the MAX3421E USB host controller. It uses the SCK, MISO and MOSI pins via the ICSP on your board.
342 
343 Note this means that it uses pin 13, 12, 11 on an Arduino Uno, so these pins can not be used for anything else than SPI communication!
344 
345 Furthermore it uses one pin as SS and one INT pin. These are by default located on pin 10 and 9 respectively. They can easily be reconfigured in case you need to use them for something else by cutting the jumper on the shield and then solder a wire from the pad to the new pin.
346 
347 After that you need modify the following entry in [UsbCore.h](UsbCore.h):
348 
349 ```C++
350 typedef MAX3421e<P10, P9> MAX3421E;
351 ```
352 
353 For instance if you have rerouted SS to pin 7 it should read:
354 
355 ```C++
356 typedef MAX3421e<P7, P9> MAX3421E;
357 ```
358 
359 See the "Interface modifications" section in the [hardware manual](https://chome.nerpa.tech/usb-host-shield-hardware-manual) for more information.
360 
361 # FAQ
362 
363 > When I plug my device into the USB connector nothing happens?
364 
365 * Try to connect a external power supply to the Arduino - this solves the problem in most cases.
366 * You can also use a powered hub between the device and the USB Host Shield. You should then include the USB hub library: ```#include <usbhub.h>``` and create the instance like so: ```USBHub Hub1(&Usb);```.
367 
368 > When I connecting my PS3 controller I get a output like this:
369 
370 ```
371 Dualshock 3 Controller Enabled
372 
373 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
374 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
375 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
376 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
377 LeftHatX: 0 LeftHatY: 0 RightHatX: 0 RightHatY: 0
378 ```
379 
380 * This means that your dongle does not support 2.0+EDR, so you will need another dongle. Please see the following [list](https://github.com/felis/USB_Host_Shield_2.0/wiki/Bluetooth-dongles) for tested working dongles.
381 
382 > When compiling I am getting the following error: "fatal error: SPI.h: No such file or directory".
383 
384 * Please make sure to include the SPI library like so: ```#include <SPI.h>``` in your .ino file.
Generated by   diff --git a/class_u_s_b_h___m_i_d_i.html b/class_u_s_b_h___m_i_d_i.html index 89c381ff..fa69ddee 100644 --- a/class_u_s_b_h___m_i_d_i.html +++ b/class_u_s_b_h___m_i_d_i.html @@ -247,7 +247,7 @@ Static Protected Attributes
-

Definition at line 253 of file usbh_midi.cpp.

+

Definition at line 260 of file usbh_midi.cpp.

@@ -275,7 +275,7 @@ Static Protected Attributes
-

Definition at line 532 of file usbh_midi.cpp.

+

Definition at line 549 of file usbh_midi.cpp.

@@ -302,7 +302,7 @@ Static Protected Attributes
-

Definition at line 345 of file usbh_midi.cpp.

+

Definition at line 352 of file usbh_midi.cpp.

@@ -413,7 +413,7 @@ Static Protected Attributes
-

Definition at line 357 of file usbh_midi.cpp.

+

Definition at line 374 of file usbh_midi.cpp.

@@ -443,7 +443,7 @@ Static Protected Attributes
-

Definition at line 370 of file usbh_midi.cpp.

+

Definition at line 387 of file usbh_midi.cpp.

@@ -463,7 +463,7 @@ Static Protected Attributes
-

Definition at line 411 of file usbh_midi.cpp.

+

Definition at line 428 of file usbh_midi.cpp.

@@ -493,7 +493,7 @@ Static Protected Attributes
-

Definition at line 417 of file usbh_midi.cpp.

+

Definition at line 434 of file usbh_midi.cpp.

@@ -523,7 +523,7 @@ Static Protected Attributes
-

Definition at line 481 of file usbh_midi.cpp.

+

Definition at line 498 of file usbh_midi.cpp.

@@ -559,7 +559,7 @@ Static Protected Attributes
-

Definition at line 556 of file usbh_midi.cpp.

+

Definition at line 573 of file usbh_midi.cpp.

@@ -589,7 +589,7 @@ Static Protected Attributes
-

Definition at line 620 of file usbh_midi.cpp.

+

Definition at line 637 of file usbh_midi.cpp.

@@ -619,7 +619,7 @@ Static Protected Attributes
-

Definition at line 614 of file usbh_midi.cpp.

+

Definition at line 631 of file usbh_midi.cpp.

@@ -760,7 +760,7 @@ Static Protected Attributes

Reimplemented from USBDeviceConfig.

-

Definition at line 334 of file usbh_midi.cpp.

+

Definition at line 341 of file usbh_midi.cpp.

diff --git a/index.html b/index.html index 0f843b10..66ea823c 100644 --- a/index.html +++ b/index.html @@ -230,7 +230,7 @@ $(function() {

It should then automatically pair the dongle with your controller. This only have to be done once.

For information see the following blog post: http://blog.tkjelectronics.dk/2014/01/ps4-controller-now-supported-by-the-usb-host-library/.

Also check out this excellent Wiki by Frank Zhao about the PS4 controller: http://eleccelerator.com/wiki/index.php?title=DualShock_4 and this Linux driver: https://github.com/chrippa/ds4drv.

-

Several guides on how to use the PS4 library has been written by Dr. James E. Barger and are available at the following link: https://sites.google.com/view/vbatc-engineeringtechnology2/control-system-tutorials/ps4-tutorials.

+

Several guides on how to use the PS4 library has been written by Dr. James E. Barger and are available at the following link: https://sites.google.com/view/crosswaystation/ps4-tutorials.

PS3 Library

These libraries consist of the PS3BT and PS3USB. These libraries allows you to use a Dualshock 3, Navigation or a Motion controller with the USB Host Shield both via Bluetooth and USB.

In order to use your Playstation controller via Bluetooth you have to set the Bluetooth address of the dongle internally to your PS3 Controller. This can be achieved by first plugging in the Bluetooth dongle and wait a few seconds. Now plug in the controller via USB and wait until the LEDs start to flash. The library has now written the Bluetooth address of the dongle to the PS3 controller.

diff --git a/usbh__midi_8cpp_source.html b/usbh__midi_8cpp_source.html index fc50c29b..415063fa 100644 --- a/usbh__midi_8cpp_source.html +++ b/usbh__midi_8cpp_source.html @@ -63,10 +63,10 @@ $(function() {
usbh_midi.cpp
-Go to the documentation of this file.
1 /*
2  *******************************************************************************
3  * USB-MIDI class driver for USB Host Shield 2.0 Library
4  * Copyright (c) 2012-2018 Yuuichi Akagawa
5  *
6  * Idea from LPK25 USB-MIDI to Serial MIDI converter
7  * by Collin Cunningham - makezine.com, narbotic.com
8  *
9  * for use with USB Host Shield 2.0 from Circuitsathome.com
10  * https://github.com/felis/USB_Host_Shield_2.0
11  *******************************************************************************
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>
24  *******************************************************************************
25  */
26 
27 #include "usbh_midi.h"
29 // MIDI MESAGES
30 // midi.org/techspecs/
32 // STATUS BYTES
33 // 0x8n == noteOff
34 // 0x9n == noteOn
35 // 0xAn == afterTouch
36 // 0xBn == controlChange
37 // n == Channel(0x0-0xf)
39 //DATA BYTE 1
40 // note# == (0-127)
41 // or
42 // control# == (0-119)
44 // DATA BYTE 2
45 // velocity == (0-127)
46 // or
47 // controlVal == (0-127)
49 // USB-MIDI Event Packets
50 // usb.org - Universal Serial Bus Device Class Definition for MIDI Devices 1.0
52 //+-------------+-------------+-------------+-------------+
53 //| Byte 0 | Byte 1 | Byte 2 | Byte 3 |
54 //+------+------+-------------+-------------+-------------+
55 //|Cable | Code | | | |
56 //|Number|Index | MIDI_0 | MIDI_1 | MIDI_2 |
57 //| |Number| | | |
58 //|(4bit)|(4bit)| (8bit) | (8bit) | (8bit) |
59 //+------+------+-------------+-------------+-------------+
60 // CN == 0x0-0xf
61 //+-----+-----------+-------------------------------------------------------------------
62 //| CIN |MIDI_x size|Description
63 //+-----+-----------+-------------------------------------------------------------------
64 //| 0x0 | 1, 2 or 3 |Miscellaneous function codes. Reserved for future extensions.
65 //| 0x1 | 1, 2 or 3 |Cable events. Reserved for future expansion.
66 //| 0x2 | 2 |Two-byte System Common messages like MTC, SongSelect, etc.
67 //| 0x3 | 3 |Three-byte System Common messages like SPP, etc.
68 //| 0x4 | 3 |SysEx starts or continues
69 //| 0x5 | 1 |Single-byte System Common Message or SysEx ends with following single byte.
70 //| 0x6 | 2 |SysEx ends with following two bytes.
71 //| 0x7 | 3 |SysEx ends with following three bytes.
72 //| 0x8 | 3 |Note-off
73 //| 0x9 | 3 |Note-on
74 //| 0xA | 3 |Poly-KeyPress
75 //| 0xB | 3 |Control Change
76 //| 0xC | 2 |Program Change
77 //| 0xD | 2 |Channel Pressure
78 //| 0xE | 3 |PitchBend Change
79 //| 0xF | 1 |Single Byte
80 //+-----+-----------+-------------------------------------------------------------------
81 
82 const uint8_t USBH_MIDI::epDataInIndex = 1;
83 const uint8_t USBH_MIDI::epDataOutIndex = 2;
84 const uint8_t USBH_MIDI::epDataInIndexVSP = 3;
85 const uint8_t USBH_MIDI::epDataOutIndexVSP = 4;
86 
87 USBH_MIDI::USBH_MIDI(USB *p) :
88 pUsb(p),
89 bAddress(0),
90 bNumEP(1),
91 bPollEnable(false),
92 isMidiFound(false),
93 readPtr(0) {
94  // initialize endpoint data structures
95  for(uint8_t i=0; i<MIDI_MAX_ENDPOINTS; i++) {
96  epInfo[i].epAddr = 0;
97  epInfo[i].maxPktSize = (i) ? 0 : 8;
98  epInfo[i].bmNakPower = (i) ? USB_NAK_NOWAIT : USB_NAK_MAX_POWER;
99 
100  }
101  // register in USB subsystem
102  if (pUsb) {
103  pUsb->RegisterDeviceClass(this);
104  }
105 }
106 
107 /* Connection initialization of an MIDI Device */
108 uint8_t USBH_MIDI::Init(uint8_t parent, uint8_t port, bool lowspeed)
109 {
110  uint8_t buf[sizeof (USB_DEVICE_DESCRIPTOR)];
111  USB_DEVICE_DESCRIPTOR * udd = reinterpret_cast<USB_DEVICE_DESCRIPTOR*>(buf);
112  uint8_t rcode;
113  UsbDevice *p = NULL;
114  EpInfo *oldep_ptr = NULL;
115  uint8_t num_of_conf; // number of configurations
116 
117  USBTRACE("\rMIDI Init\r\n");
118 
119  //for reconnect
120  for(uint8_t i=epDataInIndex; i<=epDataOutIndex; i++) {
121  epInfo[i].epAddr = (i==epDataInIndex) ? 0x81 : 0x01;
122  epInfo[i].maxPktSize = 0;
123  epInfo[i].bmSndToggle = 0;
124  epInfo[i].bmRcvToggle = 0;
125  }
126 
127  // get memory address of USB device address pool
128  AddressPool &addrPool = pUsb->GetAddressPool();
129 
130  // check if address has already been assigned to an instance
131  if (bAddress) {
132  return USB_ERROR_CLASS_INSTANCE_ALREADY_IN_USE;
133  }
134  // Get pointer to pseudo device with address 0 assigned
135  p = addrPool.GetUsbDevicePtr(bAddress);
136  if (!p) {
137  return USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL;
138  }
139  if (!p->epinfo) {
140  return USB_ERROR_EPINFO_IS_NULL;
141  }
142 
143  // Save old pointer to EP_RECORD of address 0
144  oldep_ptr = p->epinfo;
145 
146  // Temporary assign new pointer to epInfo to p->epinfo in order to avoid toggle inconsistence
147  p->epinfo = epInfo;
148  p->lowspeed = lowspeed;
149 
150  // Get device descriptor
151  rcode = pUsb->getDevDescr( 0, 0, sizeof(USB_DEVICE_DESCRIPTOR), (uint8_t*)buf );
152  vid = udd->idVendor;
153  pid = udd->idProduct;
154  // Restore p->epinfo
155  p->epinfo = oldep_ptr;
156 
157  if( rcode ){
158  goto FailGetDevDescr;
159  }
160 
161  // Allocate new address according to device class
162  bAddress = addrPool.AllocAddress(parent, false, port);
163  if (!bAddress) {
164  return USB_ERROR_OUT_OF_ADDRESS_SPACE_IN_POOL;
165  }
166 
167  // Extract Max Packet Size from device descriptor
168  epInfo[0].maxPktSize = udd->bMaxPacketSize0;
169 
170  // Assign new address to the device
171  rcode = pUsb->setAddr( 0, 0, bAddress );
172  if (rcode) {
173  p->lowspeed = false;
174  addrPool.FreeAddress(bAddress);
175  bAddress = 0;
176  return rcode;
177  }//if (rcode...
178  USBTRACE2("Addr:", bAddress);
179 
180  p->lowspeed = false;
181 
182  //get pointer to assigned address record
183  p = addrPool.GetUsbDevicePtr(bAddress);
184  if (!p) {
185  return USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL;
186  }
187  p->lowspeed = lowspeed;
188 
189  num_of_conf = udd->bNumConfigurations;
190 
191  // Assign epInfo to epinfo pointer
192  rcode = pUsb->setEpInfoEntry(bAddress, 1, epInfo);
193  if (rcode) {
194  USBTRACE("setEpInfoEntry failed");
195  goto FailSetDevTblEntry;
196  }
197 
198  USBTRACE("VID:"), D_PrintHex(vid, 0x80);
199  USBTRACE(" PID:"), D_PrintHex(pid, 0x80);
200  USBTRACE2(" #Conf:", num_of_conf);
201 
202  //Setup for well known vendor/device specific configuration
203  bTransferTypeMask = bmUSB_TRANSFER_TYPE;
204  setupDeviceSpecific();
205 
206  isMidiFound = false;
207  for (uint8_t i=0; i<num_of_conf; i++) {
208  rcode = parseConfigDescr(bAddress, i);
209  if( rcode )
210  goto FailGetConfDescr;
211  if (bNumEP > 1)
212  break;
213  } // for
214 
215  USBTRACE2("\r\nNumEP:", bNumEP);
216 
217  if( bNumEP < 2 ){ //Device not found.
218  rcode = 0xff;
219  goto FailGetConfDescr;
220  }
221 
222  if( !isMidiFound ){ //MIDI Device not found. Try last Bulk transfer device
223  USBTRACE("MIDI not found. Attempts bulk device\r\n");
224  epInfo[epDataInIndex].epAddr = epInfo[epDataInIndexVSP].epAddr;
225  epInfo[epDataInIndex].maxPktSize = epInfo[epDataInIndexVSP].maxPktSize;
226  epInfo[epDataOutIndex].epAddr = epInfo[epDataOutIndexVSP].epAddr;
227  epInfo[epDataOutIndex].maxPktSize = epInfo[epDataOutIndexVSP].maxPktSize;
228  }
229 
230  // Assign epInfo to epinfo pointer
231  rcode = pUsb->setEpInfoEntry(bAddress, 3, epInfo);
232  USBTRACE2("Conf:", bConfNum);
233  USBTRACE2("EPin :", (uint8_t)(epInfo[epDataInIndex].epAddr + 0x80));
234  USBTRACE2("EPout:", epInfo[epDataOutIndex].epAddr);
235 
236  // Set Configuration Value
237  rcode = pUsb->setConf(bAddress, 0, bConfNum);
238  if (rcode) {
239  goto FailSetConfDescr;
240  }
241  bPollEnable = true;
242  USBTRACE("Init done.\r\n");
243  return 0;
244 FailGetDevDescr:
245 FailSetDevTblEntry:
246 FailGetConfDescr:
247 FailSetConfDescr:
248  Release();
249  return rcode;
250 }
251 
252 /* get and parse config descriptor */
253 uint8_t USBH_MIDI::parseConfigDescr( uint8_t addr, uint8_t conf )
254 {
255  uint8_t buf[ DESC_BUFF_SIZE ];
256  uint8_t* buf_ptr = buf;
257  uint8_t rcode;
258  uint8_t descr_length;
259  uint8_t descr_type;
260  uint16_t total_length;
261  USB_ENDPOINT_DESCRIPTOR *epDesc;
262  bool isMidi = false;
263 
264  // get configuration descriptor (get descriptor size only)
265  rcode = pUsb->getConfDescr( addr, 0, 4, conf, buf );
266  if( rcode ){
267  return rcode;
268  }
269  total_length = buf[2] | ((int)buf[3] << 8);
270  if( total_length > DESC_BUFF_SIZE ) { //check if total length is larger than buffer
271  total_length = DESC_BUFF_SIZE;
272  }
273 
274  // get configuration descriptor (all)
275  rcode = pUsb->getConfDescr( addr, 0, total_length, conf, buf ); //get the whole descriptor
276  if( rcode ){
277  return rcode;
278  }
279 
280  //parsing descriptors
281  while( buf_ptr < buf + total_length ) {
282  descr_length = *( buf_ptr );
283  descr_type = *( buf_ptr + 1 );
284  switch( descr_type ) {
285  case USB_DESCRIPTOR_CONFIGURATION :
286  bConfNum = buf_ptr[5];
287  break;
288  case USB_DESCRIPTOR_INTERFACE :
289  USBTRACE("\r\nConf:"), D_PrintHex(bConfNum, 0x80);
290  USBTRACE(" Int:"), D_PrintHex(buf_ptr[2], 0x80);
291  USBTRACE(" Alt:"), D_PrintHex(buf_ptr[3], 0x80);
292  USBTRACE(" EPs:"), D_PrintHex(buf_ptr[4], 0x80);
293  USBTRACE(" IntCl:"), D_PrintHex(buf_ptr[5], 0x80);
294  USBTRACE(" IntSubCl:"), D_PrintHex(buf_ptr[6], 0x80);
295  USBTRACE("\r\n");
296 
297  if( buf_ptr[5] == USB_CLASS_AUDIO && buf_ptr[6] == USB_SUBCLASS_MIDISTREAMING ) { //p[5]; bInterfaceClass = 1(Audio), p[6]; bInterfaceSubClass = 3(MIDI Streaming)
298  isMidiFound = true; //MIDI device found.
299  isMidi = true;
300  USBTRACE("MIDI Device\r\n");
301  }else{
302  isMidi = false;
303  USBTRACE("No MIDI Device\r\n");
304  }
305  break;
306  case USB_DESCRIPTOR_ENDPOINT :
307  epDesc = (USB_ENDPOINT_DESCRIPTOR *)buf_ptr;
308  USBTRACE("-EPAddr:"), D_PrintHex(epDesc->bEndpointAddress, 0x80);
309  USBTRACE(" bmAttr:"), D_PrintHex(epDesc->bmAttributes, 0x80);
310  USBTRACE2(" MaxPktSz:", (uint8_t)epDesc->wMaxPacketSize);
311  if ((epDesc->bmAttributes & bTransferTypeMask) == USB_TRANSFER_TYPE_BULK) {//bulk
312  uint8_t index;
313  if( isMidi )
314  index = ((epDesc->bEndpointAddress & 0x80) == 0x80) ? epDataInIndex : epDataOutIndex;
315  else
316  index = ((epDesc->bEndpointAddress & 0x80) == 0x80) ? epDataInIndexVSP : epDataOutIndexVSP;
317  epInfo[index].epAddr = (epDesc->bEndpointAddress & 0x0F);
318  epInfo[index].maxPktSize = (uint8_t)epDesc->wMaxPacketSize;
319  bNumEP ++;
320 #ifdef DEBUG_USB_HOST
321  PrintEndpointDescriptor(epDesc);
322 #endif
323  }
324  break;
325  default:
326  break;
327  }//switch( descr_type
328  buf_ptr += descr_length; //advance buffer pointer
329  }//while( buf_ptr <=...
330  return 0;
331 }
332 
333 /* Performs a cleanup after failed Init() attempt */
334 uint8_t USBH_MIDI::Release()
335 {
336  pUsb->GetAddressPool().FreeAddress(bAddress);
337  bNumEP = 1; //must have to be reset to 1
338  bAddress = 0;
339  bPollEnable = false;
340  readPtr = 0;
341  return 0;
342 }
343 
344 /* Setup for well known vendor/device specific configuration */
345 void USBH_MIDI::setupDeviceSpecific()
346 {
347  // Novation
348  if( vid == 0x1235 ) {
349  // LaunchPad's endpoint attirbute is interrupt (0x20:S, 0x36:Mini, 0x51:Pro, 0x69:MK2, 0x7b:Launchkey25 MK2)
350  if(pid == 0x20 || pid == 0x36 || pid == 0x51 || pid == 0x69 || pid == 0x7b ) {
351  bTransferTypeMask = 2;
352  }
353  }
354 }
355 
356 /* Receive data from MIDI device */
357 uint8_t USBH_MIDI::RecvData(uint16_t *bytes_rcvd, uint8_t *dataptr)
358 {
359  *bytes_rcvd = (uint16_t)epInfo[epDataInIndex].maxPktSize;
360  uint8_t r = pUsb->inTransfer(bAddress, epInfo[epDataInIndex].epAddr, bytes_rcvd, dataptr);
361 
362  if( *bytes_rcvd < (MIDI_EVENT_PACKET_SIZE-4)){
363  dataptr[*bytes_rcvd] = '\0';
364  dataptr[(*bytes_rcvd)+1] = '\0';
365  }
366  return r;
367 }
368 
369 /* Receive data from MIDI device */
370 uint8_t USBH_MIDI::RecvData(uint8_t *outBuf, bool isRaw)
371 {
372  uint8_t rcode = 0; //return code
373  uint16_t rcvd;
374 
375  if( bPollEnable == false ) return 0;
376 
377  //Checking unprocessed message in buffer.
378  if( readPtr != 0 && readPtr < MIDI_EVENT_PACKET_SIZE ){
379  if(recvBuf[readPtr] == 0 && recvBuf[readPtr+1] == 0) {
380  //no unprocessed message left in the buffer.
381  }else{
382  goto RecvData_return_from_buffer;
383  }
384  }
385 
386  readPtr = 0;
387  rcode = RecvData( &rcvd, recvBuf);
388  if( rcode != 0 ) {
389  return 0;
390  }
391 
392  //if all data is zero, no valid data received.
393  if( recvBuf[0] == 0 && recvBuf[1] == 0 && recvBuf[2] == 0 && recvBuf[3] == 0 ) {
394  return 0;
395  }
396 
397 RecvData_return_from_buffer:
398  uint8_t m;
399  uint8_t cin = recvBuf[readPtr];
400  if( isRaw == true ) {
401  *(outBuf++) = cin;
402  }
403  readPtr++;
404  *(outBuf++) = m = recvBuf[readPtr++];
405  *(outBuf++) = recvBuf[readPtr++];
406  *(outBuf++) = recvBuf[readPtr++];
407  return lookupMsgSize(m, cin);
408 }
409 
410 /* Receive raw data from MIDI device */
411 uint8_t USBH_MIDI::RecvRawData(uint8_t *outBuf)
412 {
413  return RecvData(outBuf, true);
414 }
415 
416 /* Send data to MIDI device */
417 uint8_t USBH_MIDI::SendData(uint8_t *dataptr, uint8_t nCable)
418 {
419  uint8_t buf[4];
420  uint8_t msg;
421 
422  msg = dataptr[0];
423  // SysEx long message ?
424  if( msg == 0xf0 )
425  {
426  return SendSysEx(dataptr, countSysExDataSize(dataptr), nCable);
427  }
428 
429  buf[0] = (nCable << 4) | (msg >> 4);
430  if( msg < 0xf0 ) msg = msg & 0xf0;
431 
432 
433  //Building USB-MIDI Event Packets
434  buf[1] = dataptr[0];
435  buf[2] = dataptr[1];
436  buf[3] = dataptr[2];
437 
438  switch(lookupMsgSize(msg)) {
439  //3 bytes message
440  case 3 :
441  if(msg == 0xf2) {//system common message(SPP)
442  buf[0] = (nCable << 4) | 3;
443  }
444  break;
445 
446  //2 bytes message
447  case 2 :
448  if(msg == 0xf1 || msg == 0xf3) {//system common message(MTC/SongSelect)
449  buf[0] = (nCable << 4) | 2;
450  }
451  buf[3] = 0;
452  break;
453 
454  //1 byte message
455  case 1 :
456  default :
457  buf[2] = 0;
458  buf[3] = 0;
459  break;
460  }
461  return pUsb->outTransfer(bAddress, epInfo[epDataOutIndex].epAddr, 4, buf);
462 }
463 
464 #ifdef DEBUG_USB_HOST
465 void USBH_MIDI::PrintEndpointDescriptor( const USB_ENDPOINT_DESCRIPTOR* ep_ptr )
466 {
467  USBTRACE("Endpoint descriptor:\r\n");
468  USBTRACE2(" Length:\t", ep_ptr->bLength);
469  USBTRACE2(" Type:\t\t", ep_ptr->bDescriptorType);
470  USBTRACE2(" Address:\t", ep_ptr->bEndpointAddress);
471  USBTRACE2(" Attributes:\t", ep_ptr->bmAttributes);
472  USBTRACE2(" MaxPktSize:\t", ep_ptr->wMaxPacketSize);
473  USBTRACE2(" Poll Intrv:\t", ep_ptr->bInterval);
474 }
475 #endif
476 
477 /* look up a MIDI message size from spec */
478 /*Return */
479 /* 0 : undefined message */
480 /* 0<: Vaild message size(1-3) */
481 uint8_t USBH_MIDI::lookupMsgSize(uint8_t midiMsg, uint8_t cin)
482 {
483  uint8_t msgSize = 0;
484 
485  //SysEx message?
486  cin = cin & 0x0f;
487  if( (cin & 0xc) == 4 ) {
488  if( cin == 4 || cin == 7 ) return 3;
489  if( cin == 6 ) return 2;
490  if( cin == 5 ) return 1;
491  }
492 
493  if( midiMsg < 0xf0 ) midiMsg &= 0xf0;
494  switch(midiMsg) {
495  //3 bytes messages
496  case 0xf2 : //system common message(SPP)
497  case 0x80 : //Note off
498  case 0x90 : //Note on
499  case 0xa0 : //Poly KeyPress
500  case 0xb0 : //Control Change
501  case 0xe0 : //PitchBend Change
502  msgSize = 3;
503  break;
504 
505  //2 bytes messages
506  case 0xf1 : //system common message(MTC)
507  case 0xf3 : //system common message(SongSelect)
508  case 0xc0 : //Program Change
509  case 0xd0 : //Channel Pressure
510  msgSize = 2;
511  break;
512 
513  //1 byte messages
514  case 0xf8 : //system realtime message
515  case 0xf9 : //system realtime message
516  case 0xfa : //system realtime message
517  case 0xfb : //system realtime message
518  case 0xfc : //system realtime message
519  case 0xfe : //system realtime message
520  case 0xff : //system realtime message
521  msgSize = 1;
522  break;
523 
524  //undefine messages
525  default :
526  break;
527  }
528  return msgSize;
529 }
530 
531 /* SysEx data size counter */
532 uint16_t USBH_MIDI::countSysExDataSize(uint8_t *dataptr)
533 {
534  uint16_t c = 1;
535 
536  if( *dataptr != 0xf0 ){ //not SysEx
537  return 0;
538  }
539 
540  //Search terminator(0xf7)
541  while(*dataptr != 0xf7)
542  {
543  dataptr++;
544  c++;
545 
546  //Limiter (default: 256 bytes)
547  if(c > MIDI_MAX_SYSEX_SIZE){
548  c = 0;
549  break;
550  }
551  }
552  return c;
553 }
554 
555 /* Send SysEx message to MIDI device */
556 uint8_t USBH_MIDI::SendSysEx(uint8_t *dataptr, uint16_t datasize, uint8_t nCable)
557 {
558  uint8_t buf[MIDI_EVENT_PACKET_SIZE];
559  uint8_t rc = 0;
560  uint16_t n = datasize;
561  uint16_t pktSize = (n*10/3+7)/10*4; //Calculate total USB MIDI packet size
562  uint8_t wptr = 0;
563  uint8_t maxpkt = epInfo[epDataInIndex].maxPktSize;
564 
565  if( maxpkt > MIDI_EVENT_PACKET_SIZE ) maxpkt = MIDI_EVENT_PACKET_SIZE;
566 
567  USBTRACE("SendSysEx:\r\t");
568  USBTRACE2(" Length:\t", datasize);
569  USBTRACE2(" Total pktSize:\t", pktSize);
570 
571  while(n > 0) {
572  //Byte 0
573  buf[wptr] = (nCable << 4) | 0x4; //x4 SysEx starts or continues
574 
575  switch ( n ) {
576  case 1 :
577  buf[wptr++] = (nCable << 4) | 0x5; //x5 SysEx ends with following single byte.
578  buf[wptr++] = *(dataptr++);
579  buf[wptr++] = 0x00;
580  buf[wptr++] = 0x00;
581  n = n - 1;
582  break;
583  case 2 :
584  buf[wptr++] = (nCable << 4) | 0x6; //x6 SysEx ends with following two bytes.
585  buf[wptr++] = *(dataptr++);
586  buf[wptr++] = *(dataptr++);
587  buf[wptr++] = 0x00;
588  n = n - 2;
589  break;
590  case 3 :
591  buf[wptr] = (nCable << 4) | 0x7; //x7 SysEx ends with following three bytes.
592  // fall through
593  default :
594  wptr++;
595  buf[wptr++] = *(dataptr++);
596  buf[wptr++] = *(dataptr++);
597  buf[wptr++] = *(dataptr++);
598  n = n - 3;
599  break;
600  }
601 
602  if( wptr >= maxpkt || n == 0 ){ //Reach a maxPktSize or data end.
603  USBTRACE2(" wptr:\t", wptr);
604  if( (rc = pUsb->outTransfer(bAddress, epInfo[epDataOutIndex].epAddr, wptr, buf)) != 0 ){
605  break;
606  }
607  wptr = 0; //rewind data pointer
608  }
609  }
610  return(rc);
611 }
612 
613 /* Send raw data to MIDI device */
614 uint8_t USBH_MIDI::SendRawData(uint16_t bytes_send, uint8_t *dataptr)
615 {
616  return pUsb->outTransfer(bAddress, epInfo[epDataOutIndex].epAddr, bytes_send, dataptr);
617 
618 }
619 
620 uint8_t USBH_MIDI::extractSysExData(uint8_t *p, uint8_t *buf)
621 {
622  uint8_t rc = 0;
623  uint8_t cin = *(p) & 0x0f;
624 
625  //SysEx message?
626  if( (cin & 0xc) != 4 ) return rc;
627 
628  switch(cin) {
629  case 4:
630  case 7:
631  *buf++ = *(p+1);
632  *buf++ = *(p+2);
633  *buf++ = *(p+3);
634  rc = 3;
635  break;
636  case 6:
637  *buf++ = *(p+1);
638  *buf++ = *(p+2);
639  rc = 2;
640  break;
641  case 5:
642  *buf++ = *(p+1);
643  rc = 1;
644  break;
645  default:
646  break;
647  }
648  return(rc);
649 }
USB::getConfDescr
uint8_t getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t *dataptr)
Definition: Usb.cpp:801
+Go to the documentation of this file.
1 /*
2  *******************************************************************************
3  * USB-MIDI class driver for USB Host Shield 2.0 Library
4  * Copyright (c) 2012-2018 Yuuichi Akagawa
5  *
6  * Idea from LPK25 USB-MIDI to Serial MIDI converter
7  * by Collin Cunningham - makezine.com, narbotic.com
8  *
9  * for use with USB Host Shield 2.0 from Circuitsathome.com
10  * https://github.com/felis/USB_Host_Shield_2.0
11  *******************************************************************************
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>
24  *******************************************************************************
25  */
26 
27 #include "usbh_midi.h"
29 // MIDI MESAGES
30 // midi.org/techspecs/
32 // STATUS BYTES
33 // 0x8n == noteOff
34 // 0x9n == noteOn
35 // 0xAn == afterTouch
36 // 0xBn == controlChange
37 // n == Channel(0x0-0xf)
39 //DATA BYTE 1
40 // note# == (0-127)
41 // or
42 // control# == (0-119)
44 // DATA BYTE 2
45 // velocity == (0-127)
46 // or
47 // controlVal == (0-127)
49 // USB-MIDI Event Packets
50 // usb.org - Universal Serial Bus Device Class Definition for MIDI Devices 1.0
52 //+-------------+-------------+-------------+-------------+
53 //| Byte 0 | Byte 1 | Byte 2 | Byte 3 |
54 //+------+------+-------------+-------------+-------------+
55 //|Cable | Code | | | |
56 //|Number|Index | MIDI_0 | MIDI_1 | MIDI_2 |
57 //| |Number| | | |
58 //|(4bit)|(4bit)| (8bit) | (8bit) | (8bit) |
59 //+------+------+-------------+-------------+-------------+
60 // CN == 0x0-0xf
61 //+-----+-----------+-------------------------------------------------------------------
62 //| CIN |MIDI_x size|Description
63 //+-----+-----------+-------------------------------------------------------------------
64 //| 0x0 | 1, 2 or 3 |Miscellaneous function codes. Reserved for future extensions.
65 //| 0x1 | 1, 2 or 3 |Cable events. Reserved for future expansion.
66 //| 0x2 | 2 |Two-byte System Common messages like MTC, SongSelect, etc.
67 //| 0x3 | 3 |Three-byte System Common messages like SPP, etc.
68 //| 0x4 | 3 |SysEx starts or continues
69 //| 0x5 | 1 |Single-byte System Common Message or SysEx ends with following single byte.
70 //| 0x6 | 2 |SysEx ends with following two bytes.
71 //| 0x7 | 3 |SysEx ends with following three bytes.
72 //| 0x8 | 3 |Note-off
73 //| 0x9 | 3 |Note-on
74 //| 0xA | 3 |Poly-KeyPress
75 //| 0xB | 3 |Control Change
76 //| 0xC | 2 |Program Change
77 //| 0xD | 2 |Channel Pressure
78 //| 0xE | 3 |PitchBend Change
79 //| 0xF | 1 |Single Byte
80 //+-----+-----------+-------------------------------------------------------------------
81 
82 const uint8_t USBH_MIDI::epDataInIndex = 1;
83 const uint8_t USBH_MIDI::epDataOutIndex = 2;
84 const uint8_t USBH_MIDI::epDataInIndexVSP = 3;
85 const uint8_t USBH_MIDI::epDataOutIndexVSP = 4;
86 
87 USBH_MIDI::USBH_MIDI(USB *p) :
88 pUsb(p),
89 bAddress(0),
90 bNumEP(1),
91 bPollEnable(false),
92 isMidiFound(false),
93 readPtr(0) {
94  // initialize endpoint data structures
95  for(uint8_t i=0; i<MIDI_MAX_ENDPOINTS; i++) {
96  epInfo[i].epAddr = 0;
97  epInfo[i].maxPktSize = (i) ? 0 : 8;
98  epInfo[i].bmNakPower = (i) ? USB_NAK_NOWAIT : USB_NAK_MAX_POWER;
99 
100  }
101  // register in USB subsystem
102  if (pUsb) {
103  pUsb->RegisterDeviceClass(this);
104  }
105 }
106 
107 /* Connection initialization of an MIDI Device */
108 uint8_t USBH_MIDI::Init(uint8_t parent, uint8_t port, bool lowspeed)
109 {
110  uint8_t buf[sizeof (USB_DEVICE_DESCRIPTOR)];
111  USB_DEVICE_DESCRIPTOR * udd = reinterpret_cast<USB_DEVICE_DESCRIPTOR*>(buf);
112  uint8_t rcode;
113  UsbDevice *p = NULL;
114  EpInfo *oldep_ptr = NULL;
115  uint8_t num_of_conf; // number of configurations
116 
117  USBTRACE("\rMIDI Init\r\n");
118 
119  //for reconnect
120  for(uint8_t i=epDataInIndex; i<=epDataOutIndex; i++) {
121  epInfo[i].epAddr = (i==epDataInIndex) ? 0x81 : 0x01;
122  epInfo[i].maxPktSize = 0;
123  epInfo[i].bmSndToggle = 0;
124  epInfo[i].bmRcvToggle = 0;
125  }
126 
127  // get memory address of USB device address pool
128  AddressPool &addrPool = pUsb->GetAddressPool();
129 
130  // check if address has already been assigned to an instance
131  if (bAddress) {
132  return USB_ERROR_CLASS_INSTANCE_ALREADY_IN_USE;
133  }
134  // Get pointer to pseudo device with address 0 assigned
135  p = addrPool.GetUsbDevicePtr(bAddress);
136  if (!p) {
137  return USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL;
138  }
139  if (!p->epinfo) {
140  return USB_ERROR_EPINFO_IS_NULL;
141  }
142 
143  // Save old pointer to EP_RECORD of address 0
144  oldep_ptr = p->epinfo;
145 
146  // Temporary assign new pointer to epInfo to p->epinfo in order to avoid toggle inconsistence
147  p->epinfo = epInfo;
148  p->lowspeed = lowspeed;
149 
150  // First Device Descriptor Request (Initially first 8 bytes)
151  // https://techcommunity.microsoft.com/t5/microsoft-usb-blog/how-does-usb-stack-enumerate-a-device/ba-p/270685#_First_Device_Descriptor
152  rcode = pUsb->getDevDescr( 0, 0, 8, (uint8_t*)buf );
153 
154  // Restore p->epinfo
155  p->epinfo = oldep_ptr;
156 
157  if( rcode ){
158  goto FailGetDevDescr;
159  }
160 
161  // Allocate new address according to device class
162  bAddress = addrPool.AllocAddress(parent, false, port);
163  if (!bAddress) {
164  return USB_ERROR_OUT_OF_ADDRESS_SPACE_IN_POOL;
165  }
166 
167  // Extract Max Packet Size from device descriptor
168  epInfo[0].maxPktSize = udd->bMaxPacketSize0;
169 
170  // Assign new address to the device
171  rcode = pUsb->setAddr( 0, 0, bAddress );
172  if (rcode) {
173  p->lowspeed = false;
174  addrPool.FreeAddress(bAddress);
175  bAddress = 0;
176  return rcode;
177  }//if (rcode...
178  USBTRACE2("Addr:", bAddress);
179 
180  p->lowspeed = false;
181 
182  //get pointer to assigned address record
183  p = addrPool.GetUsbDevicePtr(bAddress);
184  if (!p) {
185  return USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL;
186  }
187  p->lowspeed = lowspeed;
188 
189  // Second Device Descriptor Request (Full)
190  rcode = pUsb->getDevDescr( bAddress, 0, sizeof(USB_DEVICE_DESCRIPTOR), (uint8_t*)buf );
191  if( rcode ){
192  goto FailGetDevDescr;
193  }
194  vid = udd->idVendor;
195  pid = udd->idProduct;
196  num_of_conf = udd->bNumConfigurations;
197 
198  // Assign epInfo to epinfo pointer
199  rcode = pUsb->setEpInfoEntry(bAddress, 1, epInfo);
200  if (rcode) {
201  USBTRACE("setEpInfoEntry failed");
202  goto FailSetDevTblEntry;
203  }
204 
205  USBTRACE("VID:"), D_PrintHex(vid, 0x80);
206  USBTRACE(" PID:"), D_PrintHex(pid, 0x80);
207  USBTRACE2(" #Conf:", num_of_conf);
208 
209  //Setup for well known vendor/device specific configuration
210  bTransferTypeMask = bmUSB_TRANSFER_TYPE;
211  setupDeviceSpecific();
212 
213  isMidiFound = false;
214  for (uint8_t i=0; i<num_of_conf; i++) {
215  rcode = parseConfigDescr(bAddress, i);
216  if( rcode )
217  goto FailGetConfDescr;
218  if (bNumEP > 1)
219  break;
220  } // for
221 
222  USBTRACE2("\r\nNumEP:", bNumEP);
223 
224  if( bNumEP < 2 ){ //Device not found.
225  rcode = 0xff;
226  goto FailGetConfDescr;
227  }
228 
229  if( !isMidiFound ){ //MIDI Device not found. Try last Bulk transfer device
230  USBTRACE("MIDI not found. Attempts bulk device\r\n");
231  epInfo[epDataInIndex].epAddr = epInfo[epDataInIndexVSP].epAddr;
232  epInfo[epDataInIndex].maxPktSize = epInfo[epDataInIndexVSP].maxPktSize;
233  epInfo[epDataOutIndex].epAddr = epInfo[epDataOutIndexVSP].epAddr;
234  epInfo[epDataOutIndex].maxPktSize = epInfo[epDataOutIndexVSP].maxPktSize;
235  }
236 
237  // Assign epInfo to epinfo pointer
238  rcode = pUsb->setEpInfoEntry(bAddress, 3, epInfo);
239  USBTRACE2("Conf:", bConfNum);
240  USBTRACE2("EPin :", (uint8_t)(epInfo[epDataInIndex].epAddr + 0x80));
241  USBTRACE2("EPout:", epInfo[epDataOutIndex].epAddr);
242 
243  // Set Configuration Value
244  rcode = pUsb->setConf(bAddress, 0, bConfNum);
245  if (rcode) {
246  goto FailSetConfDescr;
247  }
248  bPollEnable = true;
249  USBTRACE("Init done.\r\n");
250  return 0;
251 FailGetDevDescr:
252 FailSetDevTblEntry:
253 FailGetConfDescr:
254 FailSetConfDescr:
255  Release();
256  return rcode;
257 }
258 
259 /* get and parse config descriptor */
260 uint8_t USBH_MIDI::parseConfigDescr( uint8_t addr, uint8_t conf )
261 {
262  uint8_t buf[ DESC_BUFF_SIZE ];
263  uint8_t* buf_ptr = buf;
264  uint8_t rcode;
265  uint8_t descr_length;
266  uint8_t descr_type;
267  uint16_t total_length;
268  USB_ENDPOINT_DESCRIPTOR *epDesc;
269  bool isMidi = false;
270 
271  // get configuration descriptor (get descriptor size only)
272  rcode = pUsb->getConfDescr( addr, 0, 4, conf, buf );
273  if( rcode ){
274  return rcode;
275  }
276  total_length = buf[2] | ((int)buf[3] << 8);
277  if( total_length > DESC_BUFF_SIZE ) { //check if total length is larger than buffer
278  total_length = DESC_BUFF_SIZE;
279  }
280 
281  // get configuration descriptor (all)
282  rcode = pUsb->getConfDescr( addr, 0, total_length, conf, buf ); //get the whole descriptor
283  if( rcode ){
284  return rcode;
285  }
286 
287  //parsing descriptors
288  while( buf_ptr < buf + total_length ) {
289  descr_length = *( buf_ptr );
290  descr_type = *( buf_ptr + 1 );
291  switch( descr_type ) {
292  case USB_DESCRIPTOR_CONFIGURATION :
293  bConfNum = buf_ptr[5];
294  break;
295  case USB_DESCRIPTOR_INTERFACE :
296  USBTRACE("\r\nConf:"), D_PrintHex(bConfNum, 0x80);
297  USBTRACE(" Int:"), D_PrintHex(buf_ptr[2], 0x80);
298  USBTRACE(" Alt:"), D_PrintHex(buf_ptr[3], 0x80);
299  USBTRACE(" EPs:"), D_PrintHex(buf_ptr[4], 0x80);
300  USBTRACE(" IntCl:"), D_PrintHex(buf_ptr[5], 0x80);
301  USBTRACE(" IntSubCl:"), D_PrintHex(buf_ptr[6], 0x80);
302  USBTRACE("\r\n");
303 
304  if( buf_ptr[5] == USB_CLASS_AUDIO && buf_ptr[6] == USB_SUBCLASS_MIDISTREAMING ) { //p[5]; bInterfaceClass = 1(Audio), p[6]; bInterfaceSubClass = 3(MIDI Streaming)
305  isMidiFound = true; //MIDI device found.
306  isMidi = true;
307  USBTRACE("MIDI Device\r\n");
308  }else{
309  isMidi = false;
310  USBTRACE("No MIDI Device\r\n");
311  }
312  break;
313  case USB_DESCRIPTOR_ENDPOINT :
314  epDesc = (USB_ENDPOINT_DESCRIPTOR *)buf_ptr;
315  USBTRACE("-EPAddr:"), D_PrintHex(epDesc->bEndpointAddress, 0x80);
316  USBTRACE(" bmAttr:"), D_PrintHex(epDesc->bmAttributes, 0x80);
317  USBTRACE2(" MaxPktSz:", (uint8_t)epDesc->wMaxPacketSize);
318  if ((epDesc->bmAttributes & bTransferTypeMask) == USB_TRANSFER_TYPE_BULK) {//bulk
319  uint8_t index;
320  if( isMidi )
321  index = ((epDesc->bEndpointAddress & 0x80) == 0x80) ? epDataInIndex : epDataOutIndex;
322  else
323  index = ((epDesc->bEndpointAddress & 0x80) == 0x80) ? epDataInIndexVSP : epDataOutIndexVSP;
324  epInfo[index].epAddr = (epDesc->bEndpointAddress & 0x0F);
325  epInfo[index].maxPktSize = (uint8_t)epDesc->wMaxPacketSize;
326  bNumEP ++;
327 #ifdef DEBUG_USB_HOST
328  PrintEndpointDescriptor(epDesc);
329 #endif
330  }
331  break;
332  default:
333  break;
334  }//switch( descr_type
335  buf_ptr += descr_length; //advance buffer pointer
336  }//while( buf_ptr <=...
337  return 0;
338 }
339 
340 /* Performs a cleanup after failed Init() attempt */
341 uint8_t USBH_MIDI::Release()
342 {
343  pUsb->GetAddressPool().FreeAddress(bAddress);
344  bNumEP = 1; //must have to be reset to 1
345  bAddress = 0;
346  bPollEnable = false;
347  readPtr = 0;
348  return 0;
349 }
350 
351 /* Setup for well known vendor/device specific configuration */
352 void USBH_MIDI::setupDeviceSpecific()
353 {
354  // Novation
355  if( vid == 0x1235 ) {
356  // LaunchPad and LaunchKey endpoint attribute is interrupt
357  // https://github.com/YuuichiAkagawa/USBH_MIDI/wiki/Novation-USB-Product-ID-List
358 
359  // LaunchPad: 0x20:S, 0x36:Mini, 0x51:Pro, 0x69:MK2
360  if( pid == 0x20 || pid == 0x36 || pid == 0x51 || pid == 0x69 ) {
361  bTransferTypeMask = 2;
362  return;
363  }
364 
365  // LaunchKey: 0x30-32, 0x35:Mini, 0x7B-0x7D:MK2
366  if( ( 0x30 <= pid && pid <= 0x32) || pid == 0x35 || ( 0x7B <= pid && pid <= 0x7D) ) {
367  bTransferTypeMask = 2;
368  return;
369  }
370  }
371 }
372 
373 /* Receive data from MIDI device */
374 uint8_t USBH_MIDI::RecvData(uint16_t *bytes_rcvd, uint8_t *dataptr)
375 {
376  *bytes_rcvd = (uint16_t)epInfo[epDataInIndex].maxPktSize;
377  uint8_t r = pUsb->inTransfer(bAddress, epInfo[epDataInIndex].epAddr, bytes_rcvd, dataptr);
378 
379  if( *bytes_rcvd < (MIDI_EVENT_PACKET_SIZE-4)){
380  dataptr[*bytes_rcvd] = '\0';
381  dataptr[(*bytes_rcvd)+1] = '\0';
382  }
383  return r;
384 }
385 
386 /* Receive data from MIDI device */
387 uint8_t USBH_MIDI::RecvData(uint8_t *outBuf, bool isRaw)
388 {
389  uint8_t rcode = 0; //return code
390  uint16_t rcvd;
391 
392  if( bPollEnable == false ) return 0;
393 
394  //Checking unprocessed message in buffer.
395  if( readPtr != 0 && readPtr < MIDI_EVENT_PACKET_SIZE ){
396  if(recvBuf[readPtr] == 0 && recvBuf[readPtr+1] == 0) {
397  //no unprocessed message left in the buffer.
398  }else{
399  goto RecvData_return_from_buffer;
400  }
401  }
402 
403  readPtr = 0;
404  rcode = RecvData( &rcvd, recvBuf);
405  if( rcode != 0 ) {
406  return 0;
407  }
408 
409  //if all data is zero, no valid data received.
410  if( recvBuf[0] == 0 && recvBuf[1] == 0 && recvBuf[2] == 0 && recvBuf[3] == 0 ) {
411  return 0;
412  }
413 
414 RecvData_return_from_buffer:
415  uint8_t m;
416  uint8_t cin = recvBuf[readPtr];
417  if( isRaw == true ) {
418  *(outBuf++) = cin;
419  }
420  readPtr++;
421  *(outBuf++) = m = recvBuf[readPtr++];
422  *(outBuf++) = recvBuf[readPtr++];
423  *(outBuf++) = recvBuf[readPtr++];
424  return lookupMsgSize(m, cin);
425 }
426 
427 /* Receive raw data from MIDI device */
428 uint8_t USBH_MIDI::RecvRawData(uint8_t *outBuf)
429 {
430  return RecvData(outBuf, true);
431 }
432 
433 /* Send data to MIDI device */
434 uint8_t USBH_MIDI::SendData(uint8_t *dataptr, uint8_t nCable)
435 {
436  uint8_t buf[4];
437  uint8_t msg;
438 
439  msg = dataptr[0];
440  // SysEx long message ?
441  if( msg == 0xf0 )
442  {
443  return SendSysEx(dataptr, countSysExDataSize(dataptr), nCable);
444  }
445 
446  buf[0] = (nCable << 4) | (msg >> 4);
447  if( msg < 0xf0 ) msg = msg & 0xf0;
448 
449 
450  //Building USB-MIDI Event Packets
451  buf[1] = dataptr[0];
452  buf[2] = dataptr[1];
453  buf[3] = dataptr[2];
454 
455  switch(lookupMsgSize(msg)) {
456  //3 bytes message
457  case 3 :
458  if(msg == 0xf2) {//system common message(SPP)
459  buf[0] = (nCable << 4) | 3;
460  }
461  break;
462 
463  //2 bytes message
464  case 2 :
465  if(msg == 0xf1 || msg == 0xf3) {//system common message(MTC/SongSelect)
466  buf[0] = (nCable << 4) | 2;
467  }
468  buf[3] = 0;
469  break;
470 
471  //1 byte message
472  case 1 :
473  default :
474  buf[2] = 0;
475  buf[3] = 0;
476  break;
477  }
478  return pUsb->outTransfer(bAddress, epInfo[epDataOutIndex].epAddr, 4, buf);
479 }
480 
481 #ifdef DEBUG_USB_HOST
482 void USBH_MIDI::PrintEndpointDescriptor( const USB_ENDPOINT_DESCRIPTOR* ep_ptr )
483 {
484  USBTRACE("Endpoint descriptor:\r\n");
485  USBTRACE2(" Length:\t", ep_ptr->bLength);
486  USBTRACE2(" Type:\t\t", ep_ptr->bDescriptorType);
487  USBTRACE2(" Address:\t", ep_ptr->bEndpointAddress);
488  USBTRACE2(" Attributes:\t", ep_ptr->bmAttributes);
489  USBTRACE2(" MaxPktSize:\t", ep_ptr->wMaxPacketSize);
490  USBTRACE2(" Poll Intrv:\t", ep_ptr->bInterval);
491 }
492 #endif
493 
494 /* look up a MIDI message size from spec */
495 /*Return */
496 /* 0 : undefined message */
497 /* 0<: Vaild message size(1-3) */
498 uint8_t USBH_MIDI::lookupMsgSize(uint8_t midiMsg, uint8_t cin)
499 {
500  uint8_t msgSize = 0;
501 
502  //SysEx message?
503  cin = cin & 0x0f;
504  if( (cin & 0xc) == 4 ) {
505  if( cin == 4 || cin == 7 ) return 3;
506  if( cin == 6 ) return 2;
507  if( cin == 5 ) return 1;
508  }
509 
510  if( midiMsg < 0xf0 ) midiMsg &= 0xf0;
511  switch(midiMsg) {
512  //3 bytes messages
513  case 0xf2 : //system common message(SPP)
514  case 0x80 : //Note off
515  case 0x90 : //Note on
516  case 0xa0 : //Poly KeyPress
517  case 0xb0 : //Control Change
518  case 0xe0 : //PitchBend Change
519  msgSize = 3;
520  break;
521 
522  //2 bytes messages
523  case 0xf1 : //system common message(MTC)
524  case 0xf3 : //system common message(SongSelect)
525  case 0xc0 : //Program Change
526  case 0xd0 : //Channel Pressure
527  msgSize = 2;
528  break;
529 
530  //1 byte messages
531  case 0xf8 : //system realtime message
532  case 0xf9 : //system realtime message
533  case 0xfa : //system realtime message
534  case 0xfb : //system realtime message
535  case 0xfc : //system realtime message
536  case 0xfe : //system realtime message
537  case 0xff : //system realtime message
538  msgSize = 1;
539  break;
540 
541  //undefine messages
542  default :
543  break;
544  }
545  return msgSize;
546 }
547 
548 /* SysEx data size counter */
549 uint16_t USBH_MIDI::countSysExDataSize(uint8_t *dataptr)
550 {
551  uint16_t c = 1;
552 
553  if( *dataptr != 0xf0 ){ //not SysEx
554  return 0;
555  }
556 
557  //Search terminator(0xf7)
558  while(*dataptr != 0xf7)
559  {
560  dataptr++;
561  c++;
562 
563  //Limiter (default: 256 bytes)
564  if(c > MIDI_MAX_SYSEX_SIZE){
565  c = 0;
566  break;
567  }
568  }
569  return c;
570 }
571 
572 /* Send SysEx message to MIDI device */
573 uint8_t USBH_MIDI::SendSysEx(uint8_t *dataptr, uint16_t datasize, uint8_t nCable)
574 {
575  uint8_t buf[MIDI_EVENT_PACKET_SIZE];
576  uint8_t rc = 0;
577  uint16_t n = datasize;
578  uint16_t pktSize = (n*10/3+7)/10*4; //Calculate total USB MIDI packet size
579  uint8_t wptr = 0;
580  uint8_t maxpkt = epInfo[epDataInIndex].maxPktSize;
581 
582  if( maxpkt > MIDI_EVENT_PACKET_SIZE ) maxpkt = MIDI_EVENT_PACKET_SIZE;
583 
584  USBTRACE("SendSysEx:\r\t");
585  USBTRACE2(" Length:\t", datasize);
586  USBTRACE2(" Total pktSize:\t", pktSize);
587 
588  while(n > 0) {
589  //Byte 0
590  buf[wptr] = (nCable << 4) | 0x4; //x4 SysEx starts or continues
591 
592  switch ( n ) {
593  case 1 :
594  buf[wptr++] = (nCable << 4) | 0x5; //x5 SysEx ends with following single byte.
595  buf[wptr++] = *(dataptr++);
596  buf[wptr++] = 0x00;
597  buf[wptr++] = 0x00;
598  n = n - 1;
599  break;
600  case 2 :
601  buf[wptr++] = (nCable << 4) | 0x6; //x6 SysEx ends with following two bytes.
602  buf[wptr++] = *(dataptr++);
603  buf[wptr++] = *(dataptr++);
604  buf[wptr++] = 0x00;
605  n = n - 2;
606  break;
607  case 3 :
608  buf[wptr] = (nCable << 4) | 0x7; //x7 SysEx ends with following three bytes.
609  // fall through
610  default :
611  wptr++;
612  buf[wptr++] = *(dataptr++);
613  buf[wptr++] = *(dataptr++);
614  buf[wptr++] = *(dataptr++);
615  n = n - 3;
616  break;
617  }
618 
619  if( wptr >= maxpkt || n == 0 ){ //Reach a maxPktSize or data end.
620  USBTRACE2(" wptr:\t", wptr);
621  if( (rc = pUsb->outTransfer(bAddress, epInfo[epDataOutIndex].epAddr, wptr, buf)) != 0 ){
622  break;
623  }
624  wptr = 0; //rewind data pointer
625  }
626  }
627  return(rc);
628 }
629 
630 /* Send raw data to MIDI device */
631 uint8_t USBH_MIDI::SendRawData(uint16_t bytes_send, uint8_t *dataptr)
632 {
633  return pUsb->outTransfer(bAddress, epInfo[epDataOutIndex].epAddr, bytes_send, dataptr);
634 
635 }
636 
637 uint8_t USBH_MIDI::extractSysExData(uint8_t *p, uint8_t *buf)
638 {
639  uint8_t rc = 0;
640  uint8_t cin = *(p) & 0x0f;
641 
642  //SysEx message?
643  if( (cin & 0xc) != 4 ) return rc;
644 
645  switch(cin) {
646  case 4:
647  case 7:
648  *buf++ = *(p+1);
649  *buf++ = *(p+2);
650  *buf++ = *(p+3);
651  rc = 3;
652  break;
653  case 6:
654  *buf++ = *(p+1);
655  *buf++ = *(p+2);
656  rc = 2;
657  break;
658  case 5:
659  *buf++ = *(p+1);
660  rc = 1;
661  break;
662  default:
663  break;
664  }
665  return(rc);
666 }
USB::getConfDescr
uint8_t getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t *dataptr)
Definition: Usb.cpp:801
EpInfo::bmRcvToggle
uint8_t bmRcvToggle
Definition: address.h:48
-
USBH_MIDI::SendSysEx
uint8_t SendSysEx(uint8_t *dataptr, uint16_t datasize, uint8_t nCable=0)
Definition: usbh_midi.cpp:556
+
USBH_MIDI::SendSysEx
uint8_t SendSysEx(uint8_t *dataptr, uint16_t datasize, uint8_t nCable=0)
Definition: usbh_midi.cpp:573
USBH_MIDI::epDataInIndexVSP
static const uint8_t epDataInIndexVSP
Definition: usbh_midi.h:44
UsbDevice::epinfo
EpInfo * epinfo
Definition: address.h:83
UsbDevice::lowspeed
bool lowspeed
Definition: address.h:86
@@ -75,7 +75,7 @@ $(function() {
USBH_MIDI::readPtr
uint8_t readPtr
Definition: usbh_midi.h:60
EpInfo::bmNakPower
uint8_t bmNakPower
Definition: address.h:49
-
USBH_MIDI::RecvData
uint8_t RecvData(uint16_t *bytes_rcvd, uint8_t *dataptr)
Definition: usbh_midi.cpp:357
+
USBH_MIDI::RecvData
uint8_t RecvData(uint16_t *bytes_rcvd, uint8_t *dataptr)
Definition: usbh_midi.cpp:374
USB_ENDPOINT_DESCRIPTOR
Definition: usb_ch9.h:148
USB_ENDPOINT_DESCRIPTOR::bInterval
uint8_t bInterval
Definition: usb_ch9.h:154
USB_ENDPOINT_DESCRIPTOR::bLength
uint8_t bLength
Definition: usb_ch9.h:149
@@ -86,13 +86,13 @@ $(function() {
USB_SUBCLASS_MIDISTREAMING
#define USB_SUBCLASS_MIDISTREAMING
Definition: usbh_midi.h:33
USB::setEpInfoEntry
uint8_t setEpInfoEntry(uint8_t addr, uint8_t epcount, EpInfo *eprecord_ptr)
Definition: Usb.cpp:64
USBH_MIDI::pUsb
USB * pUsb
Definition: usbh_midi.h:48
-
USBH_MIDI::SendRawData
uint8_t SendRawData(uint16_t bytes_send, uint8_t *dataptr)
Definition: usbh_midi.cpp:614
-
USBH_MIDI::countSysExDataSize
uint16_t countSysExDataSize(uint8_t *dataptr)
Definition: usbh_midi.cpp:532
+
USBH_MIDI::SendRawData
uint8_t SendRawData(uint16_t bytes_send, uint8_t *dataptr)
Definition: usbh_midi.cpp:631
+
USBH_MIDI::countSysExDataSize
uint16_t countSysExDataSize(uint8_t *dataptr)
Definition: usbh_midi.cpp:549
AddressPool::FreeAddress
virtual void FreeAddress(uint8_t addr)=0
USBH_MIDI::epDataOutIndexVSP
static const uint8_t epDataOutIndexVSP
Definition: usbh_midi.h:45
USB_DESCRIPTOR_CONFIGURATION
#define USB_DESCRIPTOR_CONFIGURATION
Definition: usb_ch9.h:71
AddressPool::GetUsbDevicePtr
virtual UsbDevice * GetUsbDevicePtr(uint8_t addr)=0
-
USBH_MIDI::setupDeviceSpecific
void setupDeviceSpecific()
Definition: usbh_midi.cpp:345
+
USBH_MIDI::setupDeviceSpecific
void setupDeviceSpecific()
Definition: usbh_midi.cpp:352
USB_ENDPOINT_DESCRIPTOR::bmAttributes
uint8_t bmAttributes
Definition: usb_ch9.h:152
USBTRACE2
#define USBTRACE2(s, r)
Definition: macros.h:84
USB::setAddr
uint8_t setAddr(uint8_t oldaddr, uint8_t ep, uint8_t newaddr)
Definition: Usb.cpp:831
@@ -103,8 +103,8 @@ $(function() {
EpInfo
Definition: address.h:39
USBH_MIDI::pid
uint16_t pid
Definition: usbh_midi.h:54
USB::outTransfer
uint8_t outTransfer(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t *data)
Definition: Usb.cpp:303
-
USBH_MIDI::Release
virtual uint8_t Release()
Definition: usbh_midi.cpp:334
-
USBH_MIDI::RecvRawData
uint8_t RecvRawData(uint8_t *outBuf)
Definition: usbh_midi.cpp:411
+
USBH_MIDI::Release
virtual uint8_t Release()
Definition: usbh_midi.cpp:341
+
USBH_MIDI::RecvRawData
uint8_t RecvRawData(uint8_t *outBuf)
Definition: usbh_midi.cpp:428
USB_ENDPOINT_DESCRIPTOR::wMaxPacketSize
uint16_t wMaxPacketSize
Definition: usb_ch9.h:153
bmUSB_TRANSFER_TYPE
#define bmUSB_TRANSFER_TYPE
Definition: usb_ch9.h:94
USB_CLASS_AUDIO
#define USB_CLASS_AUDIO
Definition: UsbCore.h:70
@@ -118,7 +118,7 @@ $(function() {
USB_ENDPOINT_DESCRIPTOR::bDescriptorType
uint8_t bDescriptorType
Definition: usb_ch9.h:150
USBH_MIDI::epDataInIndex
static const uint8_t epDataInIndex
Definition: usbh_midi.h:42
MIDI_EVENT_PACKET_SIZE
#define MIDI_EVENT_PACKET_SIZE
Definition: usbh_midi.h:35
-
USBH_MIDI::lookupMsgSize
uint8_t lookupMsgSize(uint8_t midiMsg, uint8_t cin=0)
Definition: usbh_midi.cpp:481
+
USBH_MIDI::lookupMsgSize
uint8_t lookupMsgSize(uint8_t midiMsg, uint8_t cin=0)
Definition: usbh_midi.cpp:498
USB_NAK_NOWAIT
#define USB_NAK_NOWAIT
Definition: address.h:36
USBH_MIDI::recvBuf
uint8_t recvBuf[MIDI_EVENT_PACKET_SIZE]
Definition: usbh_midi.h:59
USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL
#define USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL
Definition: UsbCore.h:95
@@ -128,13 +128,13 @@ $(function() {
usbh_midi.h
USB::inTransfer
uint8_t inTransfer(uint8_t addr, uint8_t ep, uint16_t *nbytesptr, uint8_t *data, uint8_t bInterval=0)
Definition: Usb.cpp:209
USB_ERROR_OUT_OF_ADDRESS_SPACE_IN_POOL
#define USB_ERROR_OUT_OF_ADDRESS_SPACE_IN_POOL
Definition: UsbCore.h:93
-
USBH_MIDI::extractSysExData
uint8_t extractSysExData(uint8_t *p, uint8_t *buf)
Definition: usbh_midi.cpp:620
-
USBH_MIDI::SendData
uint8_t SendData(uint8_t *dataptr, uint8_t nCable=0)
Definition: usbh_midi.cpp:417
+
USBH_MIDI::extractSysExData
uint8_t extractSysExData(uint8_t *p, uint8_t *buf)
Definition: usbh_midi.cpp:637
+
USBH_MIDI::SendData
uint8_t SendData(uint8_t *dataptr, uint8_t nCable=0)
Definition: usbh_midi.cpp:434
USBH_MIDI::epDataOutIndex
static const uint8_t epDataOutIndex
Definition: usbh_midi.h:43
MIDI_MAX_ENDPOINTS
#define MIDI_MAX_ENDPOINTS
Definition: usbh_midi.h:32
EpInfo::maxPktSize
uint8_t maxPktSize
Definition: address.h:41
USB::GetAddressPool
AddressPool & GetAddressPool()
Definition: UsbCore.h:226
-
USBH_MIDI::parseConfigDescr
uint8_t parseConfigDescr(uint8_t addr, uint8_t conf)
Definition: usbh_midi.cpp:253
+
USBH_MIDI::parseConfigDescr
uint8_t parseConfigDescr(uint8_t addr, uint8_t conf)
Definition: usbh_midi.cpp:260
USB
Definition: UsbCore.h:210
USB_TRANSFER_TYPE_BULK
#define USB_TRANSFER_TYPE_BULK
Definition: usb_ch9.h:92
DESC_BUFF_SIZE
#define DESC_BUFF_SIZE
Definition: usbh_midi.h:34
diff --git a/usbh__midi_8h_source.html b/usbh__midi_8h_source.html index 267419d3..6c2176c5 100644 --- a/usbh__midi_8h_source.html +++ b/usbh__midi_8h_source.html @@ -63,13 +63,13 @@ $(function() {
usbh_midi.h
-Go to the documentation of this file.
1 /*
2  *******************************************************************************
3  * USB-MIDI class driver for USB Host Shield 2.0 Library
4  * Copyright (c) 2012-2018 Yuuichi Akagawa
5  *
6  * Idea from LPK25 USB-MIDI to Serial MIDI converter
7  * by Collin Cunningham - makezine.com, narbotic.com
8  *
9  * for use with USB Host Shield 2.0 from Circuitsathome.com
10  * https://github.com/felis/USB_Host_Shield_2.0
11  *******************************************************************************
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>
24  *******************************************************************************
25  */
26 
27 #if !defined(_USBH_MIDI_H_)
28 #define _USBH_MIDI_H_
29 //#define DEBUG_USB_HOST
30 #include "Usb.h"
31 
32 #define MIDI_MAX_ENDPOINTS 5 //endpoint 0, bulk_IN(MIDI), bulk_OUT(MIDI), bulk_IN(VSP), bulk_OUT(VSP)
33 #define USB_SUBCLASS_MIDISTREAMING 3
34 #define DESC_BUFF_SIZE 256
35 #define MIDI_EVENT_PACKET_SIZE 64
36 #define MIDI_MAX_SYSEX_SIZE 256
37 class USBH_MIDI;
38 
39 class USBH_MIDI : public USBDeviceConfig
40 {
41 protected:
42  static const uint8_t epDataInIndex; // DataIn endpoint index(MIDI)
43  static const uint8_t epDataOutIndex; // DataOUT endpoint index(MIDI)
44  static const uint8_t epDataInIndexVSP; // DataIn endpoint index(Vendor Specific Protocl)
45  static const uint8_t epDataOutIndexVSP; // DataOUT endpoint index(Vendor Specific Protocl)
46 
47  /* mandatory members */
48  USB *pUsb;
49  uint8_t bAddress;
50  uint8_t bConfNum; // configuration number
51  uint8_t bNumEP; // total number of EP in the configuration
52  bool bPollEnable;
53  bool isMidiFound;
54  uint16_t pid, vid; // ProductID, VendorID
55  uint8_t bTransferTypeMask;
56  /* Endpoint data structure */
57  EpInfo epInfo[MIDI_MAX_ENDPOINTS];
58  /* MIDI Event packet buffer */
59  uint8_t recvBuf[MIDI_EVENT_PACKET_SIZE];
60  uint8_t readPtr;
61 
62  uint8_t parseConfigDescr(uint8_t addr, uint8_t conf);
63  uint16_t countSysExDataSize(uint8_t *dataptr);
64  void setupDeviceSpecific();
65 #ifdef DEBUG_USB_HOST
66  void PrintEndpointDescriptor( const USB_ENDPOINT_DESCRIPTOR* ep_ptr );
67 #endif
68 public:
69  USBH_MIDI(USB *p);
70  // Misc functions
71  operator bool() { return (pUsb->getUsbTaskState()==USB_STATE_RUNNING); }
72  uint16_t idVendor() { return vid; }
73  uint16_t idProduct() { return pid; }
74  // Methods for recieving and sending data
75  uint8_t RecvData(uint16_t *bytes_rcvd, uint8_t *dataptr);
76  uint8_t RecvData(uint8_t *outBuf, bool isRaw=false);
77  uint8_t RecvRawData(uint8_t *outBuf);
78  uint8_t SendData(uint8_t *dataptr, uint8_t nCable=0);
79  uint8_t lookupMsgSize(uint8_t midiMsg, uint8_t cin=0);
80  uint8_t SendSysEx(uint8_t *dataptr, uint16_t datasize, uint8_t nCable=0);
81  uint8_t extractSysExData(uint8_t *p, uint8_t *buf);
82  uint8_t SendRawData(uint16_t bytes_send, uint8_t *dataptr);
83  // backward compatibility functions
84  inline uint8_t RcvData(uint16_t *bytes_rcvd, uint8_t *dataptr) { return RecvData(bytes_rcvd, dataptr); };
85  inline uint8_t RcvData(uint8_t *outBuf) { return RecvData(outBuf); };
86 
87  // USBDeviceConfig implementation
88  virtual uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed);
89  virtual uint8_t Release();
90  virtual uint8_t GetAddress() { return bAddress; };
91 };
92 #endif //_USBH_MIDI_H_
USBH_MIDI::SendSysEx
uint8_t SendSysEx(uint8_t *dataptr, uint16_t datasize, uint8_t nCable=0)
Definition: usbh_midi.cpp:556
+Go to the documentation of this file.
1 /*
2  *******************************************************************************
3  * USB-MIDI class driver for USB Host Shield 2.0 Library
4  * Copyright (c) 2012-2018 Yuuichi Akagawa
5  *
6  * Idea from LPK25 USB-MIDI to Serial MIDI converter
7  * by Collin Cunningham - makezine.com, narbotic.com
8  *
9  * for use with USB Host Shield 2.0 from Circuitsathome.com
10  * https://github.com/felis/USB_Host_Shield_2.0
11  *******************************************************************************
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>
24  *******************************************************************************
25  */
26 
27 #if !defined(_USBH_MIDI_H_)
28 #define _USBH_MIDI_H_
29 //#define DEBUG_USB_HOST
30 #include "Usb.h"
31 
32 #define MIDI_MAX_ENDPOINTS 5 //endpoint 0, bulk_IN(MIDI), bulk_OUT(MIDI), bulk_IN(VSP), bulk_OUT(VSP)
33 #define USB_SUBCLASS_MIDISTREAMING 3
34 #define DESC_BUFF_SIZE 256
35 #define MIDI_EVENT_PACKET_SIZE 64
36 #define MIDI_MAX_SYSEX_SIZE 256
37 class USBH_MIDI;
38 
39 class USBH_MIDI : public USBDeviceConfig
40 {
41 protected:
42  static const uint8_t epDataInIndex; // DataIn endpoint index(MIDI)
43  static const uint8_t epDataOutIndex; // DataOUT endpoint index(MIDI)
44  static const uint8_t epDataInIndexVSP; // DataIn endpoint index(Vendor Specific Protocl)
45  static const uint8_t epDataOutIndexVSP; // DataOUT endpoint index(Vendor Specific Protocl)
46 
47  /* mandatory members */
48  USB *pUsb;
49  uint8_t bAddress;
50  uint8_t bConfNum; // configuration number
51  uint8_t bNumEP; // total number of EP in the configuration
52  bool bPollEnable;
53  bool isMidiFound;
54  uint16_t pid, vid; // ProductID, VendorID
55  uint8_t bTransferTypeMask;
56  /* Endpoint data structure */
57  EpInfo epInfo[MIDI_MAX_ENDPOINTS];
58  /* MIDI Event packet buffer */
59  uint8_t recvBuf[MIDI_EVENT_PACKET_SIZE];
60  uint8_t readPtr;
61 
62  uint8_t parseConfigDescr(uint8_t addr, uint8_t conf);
63  uint16_t countSysExDataSize(uint8_t *dataptr);
64  void setupDeviceSpecific();
65 #ifdef DEBUG_USB_HOST
66  void PrintEndpointDescriptor( const USB_ENDPOINT_DESCRIPTOR* ep_ptr );
67 #endif
68 public:
69  USBH_MIDI(USB *p);
70  // Misc functions
71  operator bool() { return (pUsb->getUsbTaskState()==USB_STATE_RUNNING); }
72  uint16_t idVendor() { return vid; }
73  uint16_t idProduct() { return pid; }
74  // Methods for recieving and sending data
75  uint8_t RecvData(uint16_t *bytes_rcvd, uint8_t *dataptr);
76  uint8_t RecvData(uint8_t *outBuf, bool isRaw=false);
77  uint8_t RecvRawData(uint8_t *outBuf);
78  uint8_t SendData(uint8_t *dataptr, uint8_t nCable=0);
79  uint8_t lookupMsgSize(uint8_t midiMsg, uint8_t cin=0);
80  uint8_t SendSysEx(uint8_t *dataptr, uint16_t datasize, uint8_t nCable=0);
81  uint8_t extractSysExData(uint8_t *p, uint8_t *buf);
82  uint8_t SendRawData(uint16_t bytes_send, uint8_t *dataptr);
83  // backward compatibility functions
84  inline uint8_t RcvData(uint16_t *bytes_rcvd, uint8_t *dataptr) { return RecvData(bytes_rcvd, dataptr); };
85  inline uint8_t RcvData(uint8_t *outBuf) { return RecvData(outBuf); };
86 
87  // USBDeviceConfig implementation
88  virtual uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed);
89  virtual uint8_t Release();
90  virtual uint8_t GetAddress() { return bAddress; };
91 };
92 #endif //_USBH_MIDI_H_
USBH_MIDI::SendSysEx
uint8_t SendSysEx(uint8_t *dataptr, uint16_t datasize, uint8_t nCable=0)
Definition: usbh_midi.cpp:573
USBH_MIDI::epDataInIndexVSP
static const uint8_t epDataInIndexVSP
Definition: usbh_midi.h:44
USBH_MIDI::bTransferTypeMask
uint8_t bTransferTypeMask
Definition: usbh_midi.h:55
USBH_MIDI::readPtr
uint8_t readPtr
Definition: usbh_midi.h:60
USBH_MIDI::RcvData
uint8_t RcvData(uint16_t *bytes_rcvd, uint8_t *dataptr)
Definition: usbh_midi.h:84
USBH_MIDI
Definition: usbh_midi.h:39
-
USBH_MIDI::RecvData
uint8_t RecvData(uint16_t *bytes_rcvd, uint8_t *dataptr)
Definition: usbh_midi.cpp:357
+
USBH_MIDI::RecvData
uint8_t RecvData(uint16_t *bytes_rcvd, uint8_t *dataptr)
Definition: usbh_midi.cpp:374
USB_ENDPOINT_DESCRIPTOR
Definition: usb_ch9.h:148
USBH_MIDI::vid
uint16_t vid
Definition: usbh_midi.h:54
USBH_MIDI::GetAddress
virtual uint8_t GetAddress()
Definition: usbh_midi.h:90
@@ -77,35 +77,35 @@ $(function() {
Usb.h
USBH_MIDI::pUsb
USB * pUsb
Definition: usbh_midi.h:48
-
USBH_MIDI::SendRawData
uint8_t SendRawData(uint16_t bytes_send, uint8_t *dataptr)
Definition: usbh_midi.cpp:614
-
USBH_MIDI::countSysExDataSize
uint16_t countSysExDataSize(uint8_t *dataptr)
Definition: usbh_midi.cpp:532
+
USBH_MIDI::SendRawData
uint8_t SendRawData(uint16_t bytes_send, uint8_t *dataptr)
Definition: usbh_midi.cpp:631
+
USBH_MIDI::countSysExDataSize
uint16_t countSysExDataSize(uint8_t *dataptr)
Definition: usbh_midi.cpp:549
USBH_MIDI::epDataOutIndexVSP
static const uint8_t epDataOutIndexVSP
Definition: usbh_midi.h:45
-
USBH_MIDI::setupDeviceSpecific
void setupDeviceSpecific()
Definition: usbh_midi.cpp:345
+
USBH_MIDI::setupDeviceSpecific
void setupDeviceSpecific()
Definition: usbh_midi.cpp:352
USB_STATE_RUNNING
#define USB_STATE_RUNNING
Definition: UsbCore.h:131
USBH_MIDI::bNumEP
uint8_t bNumEP
Definition: usbh_midi.h:51
USBH_MIDI::bAddress
uint8_t bAddress
Definition: usbh_midi.h:49
EpInfo
Definition: address.h:39
USBH_MIDI::pid
uint16_t pid
Definition: usbh_midi.h:54
-
USBH_MIDI::Release
virtual uint8_t Release()
Definition: usbh_midi.cpp:334
-
USBH_MIDI::RecvRawData
uint8_t RecvRawData(uint8_t *outBuf)
Definition: usbh_midi.cpp:411
+
USBH_MIDI::Release
virtual uint8_t Release()
Definition: usbh_midi.cpp:341
+
USBH_MIDI::RecvRawData
uint8_t RecvRawData(uint8_t *outBuf)
Definition: usbh_midi.cpp:428
USBH_MIDI::isMidiFound
bool isMidiFound
Definition: usbh_midi.h:53
USBH_MIDI::bPollEnable
bool bPollEnable
Definition: usbh_midi.h:52
USBH_MIDI::USBH_MIDI
USBH_MIDI(USB *p)
Definition: usbh_midi.cpp:87
USBH_MIDI::idProduct
uint16_t idProduct()
Definition: usbh_midi.h:73
USBH_MIDI::epDataInIndex
static const uint8_t epDataInIndex
Definition: usbh_midi.h:42
MIDI_EVENT_PACKET_SIZE
#define MIDI_EVENT_PACKET_SIZE
Definition: usbh_midi.h:35
-
USBH_MIDI::lookupMsgSize
uint8_t lookupMsgSize(uint8_t midiMsg, uint8_t cin=0)
Definition: usbh_midi.cpp:481
+
USBH_MIDI::lookupMsgSize
uint8_t lookupMsgSize(uint8_t midiMsg, uint8_t cin=0)
Definition: usbh_midi.cpp:498
USBH_MIDI::recvBuf
uint8_t recvBuf[MIDI_EVENT_PACKET_SIZE]
Definition: usbh_midi.h:59
USB::getUsbTaskState
uint8_t getUsbTaskState(void)
Definition: Usb.cpp:36
USBH_MIDI::bConfNum
uint8_t bConfNum
Definition: usbh_midi.h:50
USBH_MIDI::epInfo
EpInfo epInfo[MIDI_MAX_ENDPOINTS]
Definition: usbh_midi.h:57
USBH_MIDI::idVendor
uint16_t idVendor()
Definition: usbh_midi.h:72
USBH_MIDI::RcvData
uint8_t RcvData(uint8_t *outBuf)
Definition: usbh_midi.h:85
-
USBH_MIDI::extractSysExData
uint8_t extractSysExData(uint8_t *p, uint8_t *buf)
Definition: usbh_midi.cpp:620
-
USBH_MIDI::SendData
uint8_t SendData(uint8_t *dataptr, uint8_t nCable=0)
Definition: usbh_midi.cpp:417
+
USBH_MIDI::extractSysExData
uint8_t extractSysExData(uint8_t *p, uint8_t *buf)
Definition: usbh_midi.cpp:637
+
USBH_MIDI::SendData
uint8_t SendData(uint8_t *dataptr, uint8_t nCable=0)
Definition: usbh_midi.cpp:434
USBH_MIDI::epDataOutIndex
static const uint8_t epDataOutIndex
Definition: usbh_midi.h:43
MIDI_MAX_ENDPOINTS
#define MIDI_MAX_ENDPOINTS
Definition: usbh_midi.h:32
-
USBH_MIDI::parseConfigDescr
uint8_t parseConfigDescr(uint8_t addr, uint8_t conf)
Definition: usbh_midi.cpp:253
+
USBH_MIDI::parseConfigDescr
uint8_t parseConfigDescr(uint8_t addr, uint8_t conf)
Definition: usbh_midi.cpp:260
USB
Definition: UsbCore.h:210