You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1766 line
65KB

  1. /* USB EHCI Host for Teensy 3.6
  2. * Copyright 2017 Paul Stoffregen (paul@pjrc.com)
  3. *
  4. * Permission is hereby granted, free of charge, to any person obtaining a
  5. * copy of this software and associated documentation files (the
  6. * "Software"), to deal in the Software without restriction, including
  7. * without limitation the rights to use, copy, modify, merge, publish,
  8. * distribute, sublicense, and/or sell copies of the Software, and to
  9. * permit persons to whom the Software is furnished to do so, subject to
  10. * the following conditions:
  11. *
  12. * The above copyright notice and this permission notice shall be included
  13. * in all copies or substantial portions of the Software.
  14. *
  15. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  16. * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  19. * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  20. * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  21. * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22. */
  23. #ifndef USB_HOST_TEENSY36_
  24. #define USB_HOST_TEENSY36_
  25. #include <stdint.h>
  26. #if !defined(__MK66FX1M0__) && !defined(__IMXRT1052__) && !defined(__IMXRT1062__)
  27. #error "USBHost_t36 only works with Teensy 3.6. Please select it in Tools > Boards"
  28. #endif
  29. #include "utility/imxrt_usbhs.h"
  30. // Dear inquisitive reader, USB is a complex protocol defined with
  31. // very specific terminology. To have any chance of understand this
  32. // source code, you absolutely must have solid knowledge of specific
  33. // USB terms such as host, device, endpoint, pipe, enumeration....
  34. // You really must also have at least a basic knowledge of the
  35. // different USB transfers: control, bulk, interrupt, isochronous.
  36. //
  37. // The USB 2.0 specification explains these in chapter 4 (pages 15
  38. // to 24), and provides more detail in the first part of chapter 5
  39. // (pages 25 to 55). The USB spec is published for free at
  40. // www.usb.org. Here is a convenient link to just the main PDF:
  41. //
  42. // https://www.pjrc.com/teensy/beta/usb20.pdf
  43. //
  44. // This is a huge file, but chapter 4 is short and easy to read.
  45. // If you're not familiar with the USB lingo, please do yourself
  46. // a favor by reading at least chapter 4 to get up to speed on the
  47. // meaning of these important USB concepts and terminology.
  48. //
  49. // If you wish to ask questions (which belong on the forum, not
  50. // github issues) or discuss development of this library, you
  51. // ABSOLUTELY MUST know the basic USB terminology from chapter 4.
  52. // Please repect other people's valuable time & effort by making
  53. // your best effort to read chapter 4 before asking USB questions!
  54. //#define USBHOST_PRINT_DEBUG
  55. #define USBHDBGSerial Serial1
  56. #ifndef USBHDBGSerial
  57. #define USBHDBGSerial Serial
  58. #endif
  59. /************************************************/
  60. /* Data Types */
  61. /************************************************/
  62. // These 6 types are the key to understanding how this USB Host
  63. // library really works.
  64. // USBHost is a static class controlling the hardware.
  65. // All common USB functionality is implemented here.
  66. class USBHost;
  67. // These 3 structures represent the actual USB entities
  68. // USBHost manipulates. One Device_t is created for
  69. // each active USB device. One Pipe_t is create for
  70. // each endpoint. Transfer_t structures are created
  71. // when any data transfer is added to the EHCI work
  72. // queues, and then returned to the free pool after the
  73. // data transfer completes and the driver has processed
  74. // the results.
  75. typedef struct Device_struct Device_t;
  76. typedef struct Pipe_struct Pipe_t;
  77. typedef struct Transfer_struct Transfer_t;
  78. typedef enum { CLAIM_NO=0, CLAIM_REPORT, CLAIM_INTERFACE} hidclaim_t;
  79. // All USB device drivers inherit use these classes.
  80. // Drivers build user-visible functionality on top
  81. // of these classes, which receive USB events from
  82. // USBHost.
  83. class USBDriver;
  84. class USBDriverTimer;
  85. /************************************************/
  86. /* Added Defines */
  87. /************************************************/
  88. // Keyboard special Keys
  89. #define KEYD_UP 0xDA
  90. #define KEYD_DOWN 0xD9
  91. #define KEYD_LEFT 0xD8
  92. #define KEYD_RIGHT 0xD7
  93. #define KEYD_INSERT 0xD1
  94. #define KEYD_DELETE 0xD4
  95. #define KEYD_PAGE_UP 0xD3
  96. #define KEYD_PAGE_DOWN 0xD6
  97. #define KEYD_HOME 0xD2
  98. #define KEYD_END 0xD5
  99. #define KEYD_F1 0xC2
  100. #define KEYD_F2 0xC3
  101. #define KEYD_F3 0xC4
  102. #define KEYD_F4 0xC5
  103. #define KEYD_F5 0xC6
  104. #define KEYD_F6 0xC7
  105. #define KEYD_F7 0xC8
  106. #define KEYD_F8 0xC9
  107. #define KEYD_F9 0xCA
  108. #define KEYD_F10 0xCB
  109. #define KEYD_F11 0xCC
  110. #define KEYD_F12 0xCD
  111. // USBSerial formats - Lets encode format into bits
  112. // Bits: 0-4 - Number of data bits
  113. // Bits: 5-7 - Parity (0=none, 1=odd, 2 = even)
  114. // bits: 8-9 - Stop bits. 0=1, 1=2
  115. #define USBHOST_SERIAL_7E1 0x047
  116. #define USBHOST_SERIAL_7O1 0x027
  117. #define USBHOST_SERIAL_8N1 0x08
  118. #define USBHOST_SERIAL_8N2 0x108
  119. #define USBHOST_SERIAL_8E1 0x048
  120. #define USBHOST_SERIAL_8O1 0x028
  121. /************************************************/
  122. /* Data Structure Definitions */
  123. /************************************************/
  124. // setup_t holds the 8 byte USB SETUP packet data.
  125. // These unions & structs allow convenient access to
  126. // the setup fields.
  127. typedef union {
  128. struct {
  129. union {
  130. struct {
  131. uint8_t bmRequestType;
  132. uint8_t bRequest;
  133. };
  134. uint16_t wRequestAndType;
  135. };
  136. uint16_t wValue;
  137. uint16_t wIndex;
  138. uint16_t wLength;
  139. };
  140. struct {
  141. uint32_t word1;
  142. uint32_t word2;
  143. };
  144. } setup_t;
  145. typedef struct {
  146. enum {STRING_BUF_SIZE=50};
  147. enum {STR_ID_MAN=0, STR_ID_PROD, STR_ID_SERIAL, STR_ID_CNT};
  148. uint8_t iStrings[STR_ID_CNT]; // Index into array for the three indexes
  149. uint8_t buffer[STRING_BUF_SIZE];
  150. } strbuf_t;
  151. #define DEVICE_STRUCT_STRING_BUF_SIZE 50
  152. // Device_t holds all the information about a USB device
  153. struct Device_struct {
  154. Pipe_t *control_pipe;
  155. Pipe_t *data_pipes;
  156. Device_t *next;
  157. USBDriver *drivers;
  158. strbuf_t *strbuf;
  159. uint8_t speed; // 0=12, 1=1.5, 2=480 Mbit/sec
  160. uint8_t address;
  161. uint8_t hub_address;
  162. uint8_t hub_port;
  163. uint8_t enum_state;
  164. uint8_t bDeviceClass;
  165. uint8_t bDeviceSubClass;
  166. uint8_t bDeviceProtocol;
  167. uint8_t bmAttributes;
  168. uint8_t bMaxPower;
  169. uint16_t idVendor;
  170. uint16_t idProduct;
  171. uint16_t LanguageID;
  172. };
  173. // Pipe_t holes all information about each USB endpoint/pipe
  174. // The first half is an EHCI QH structure for the pipe.
  175. struct Pipe_struct {
  176. // Queue Head (QH), EHCI page 46-50
  177. struct { // must be aligned to 32 byte boundary
  178. volatile uint32_t horizontal_link;
  179. volatile uint32_t capabilities[2];
  180. volatile uint32_t current;
  181. volatile uint32_t next;
  182. volatile uint32_t alt_next;
  183. volatile uint32_t token;
  184. volatile uint32_t buffer[5];
  185. } qh;
  186. Device_t *device;
  187. uint8_t type; // 0=control, 1=isochronous, 2=bulk, 3=interrupt
  188. uint8_t direction; // 0=out, 1=in (changes for control, others fixed)
  189. uint8_t start_mask;
  190. uint8_t complete_mask;
  191. Pipe_t *next;
  192. void (*callback_function)(const Transfer_t *);
  193. uint16_t periodic_interval;
  194. uint16_t periodic_offset;
  195. uint16_t bandwidth_interval;
  196. uint16_t bandwidth_offset;
  197. uint16_t bandwidth_shift;
  198. uint8_t bandwidth_stime;
  199. uint8_t bandwidth_ctime;
  200. uint32_t unused1;
  201. uint32_t unused2;
  202. uint32_t unused3;
  203. uint32_t unused4;
  204. uint32_t unused5;
  205. };
  206. // Transfer_t represents a single transaction on the USB bus.
  207. // The first portion is an EHCI qTD structure. Transfer_t are
  208. // allocated as-needed from a memory pool, loaded with pointers
  209. // to the actual data buffers, linked into a followup list,
  210. // and placed on ECHI Queue Heads. When the ECHI interrupt
  211. // occurs, the followup lists are used to find the Transfer_t
  212. // in memory. Callbacks are made, and then the Transfer_t are
  213. // returned to the memory pool.
  214. struct Transfer_struct {
  215. // Queue Element Transfer Descriptor (qTD), EHCI pg 40-45
  216. struct { // must be aligned to 32 byte boundary
  217. volatile uint32_t next;
  218. volatile uint32_t alt_next;
  219. volatile uint32_t token;
  220. volatile uint32_t buffer[5];
  221. } qtd;
  222. // Linked list of queued, not-yet-completed transfers
  223. Transfer_t *next_followup;
  224. Transfer_t *prev_followup;
  225. Pipe_t *pipe;
  226. // Data to be used by callback function. When a group
  227. // of Transfer_t are created, these fields and the
  228. // interrupt-on-complete bit in the qTD token are only
  229. // set in the last Transfer_t of the list.
  230. void *buffer;
  231. uint32_t length;
  232. setup_t setup;
  233. USBDriver *driver;
  234. };
  235. /************************************************/
  236. /* Main USB EHCI Controller */
  237. /************************************************/
  238. class USBHost {
  239. public:
  240. static void begin();
  241. static void Task();
  242. static void countFree(uint32_t &devices, uint32_t &pipes, uint32_t &trans, uint32_t &strs);
  243. protected:
  244. static Pipe_t * new_Pipe(Device_t *dev, uint32_t type, uint32_t endpoint,
  245. uint32_t direction, uint32_t maxlen, uint32_t interval=0);
  246. static bool queue_Control_Transfer(Device_t *dev, setup_t *setup,
  247. void *buf, USBDriver *driver);
  248. static bool queue_Data_Transfer(Pipe_t *pipe, void *buffer,
  249. uint32_t len, USBDriver *driver);
  250. static Device_t * new_Device(uint32_t speed, uint32_t hub_addr, uint32_t hub_port);
  251. static void disconnect_Device(Device_t *dev);
  252. static void enumeration(const Transfer_t *transfer);
  253. static void driver_ready_for_device(USBDriver *driver);
  254. static volatile bool enumeration_busy;
  255. public: // Maybe others may want/need to contribute memory example HID devices may want to add transfers.
  256. static void contribute_Devices(Device_t *devices, uint32_t num);
  257. static void contribute_Pipes(Pipe_t *pipes, uint32_t num);
  258. static void contribute_Transfers(Transfer_t *transfers, uint32_t num);
  259. static void contribute_String_Buffers(strbuf_t *strbuf, uint32_t num);
  260. private:
  261. static void isr();
  262. static void convertStringDescriptorToASCIIString(uint8_t string_index, Device_t *dev, const Transfer_t *transfer);
  263. static void claim_drivers(Device_t *dev);
  264. static uint32_t assign_address(void);
  265. static bool queue_Transfer(Pipe_t *pipe, Transfer_t *transfer);
  266. static void init_Device_Pipe_Transfer_memory(void);
  267. static Device_t * allocate_Device(void);
  268. static void delete_Pipe(Pipe_t *pipe);
  269. static void free_Device(Device_t *q);
  270. static Pipe_t * allocate_Pipe(void);
  271. static void free_Pipe(Pipe_t *q);
  272. static Transfer_t * allocate_Transfer(void);
  273. static void free_Transfer(Transfer_t *q);
  274. static strbuf_t * allocate_string_buffer(void);
  275. static void free_string_buffer(strbuf_t *strbuf);
  276. static bool allocate_interrupt_pipe_bandwidth(Pipe_t *pipe,
  277. uint32_t maxlen, uint32_t interval);
  278. static void add_qh_to_periodic_schedule(Pipe_t *pipe);
  279. static bool followup_Transfer(Transfer_t *transfer);
  280. static void followup_Error(void);
  281. protected:
  282. #ifdef USBHOST_PRINT_DEBUG
  283. static void print_(const Transfer_t *transfer);
  284. static void print_(const Transfer_t *first, const Transfer_t *last);
  285. static void print_token(uint32_t token);
  286. static void print_(const Pipe_t *pipe);
  287. static void print_driverlist(const char *name, const USBDriver *driver);
  288. static void print_qh_list(const Pipe_t *list);
  289. static void print_device_descriptor(const uint8_t *p);
  290. static void print_config_descriptor(const uint8_t *p, uint32_t maxlen);
  291. static void print_string_descriptor(const char *name, const uint8_t *p);
  292. static void print_hexbytes(const void *ptr, uint32_t len);
  293. static void print_(const char *s) { USBHDBGSerial.print(s); }
  294. static void print_(int n) { USBHDBGSerial.print(n); }
  295. static void print_(unsigned int n) { USBHDBGSerial.print(n); }
  296. static void print_(long n) { USBHDBGSerial.print(n); }
  297. static void print_(unsigned long n) { USBHDBGSerial.print(n); }
  298. static void println_(const char *s) { USBHDBGSerial.println(s); }
  299. static void println_(int n) { USBHDBGSerial.println(n); }
  300. static void println_(unsigned int n) { USBHDBGSerial.println(n); }
  301. static void println_(long n) { USBHDBGSerial.println(n); }
  302. static void println_(unsigned long n) { USBHDBGSerial.println(n); }
  303. static void println_() { USBHDBGSerial.println(); }
  304. static void print_(uint32_t n, uint8_t b) { USBHDBGSerial.print(n, b); }
  305. static void println_(uint32_t n, uint8_t b) { USBHDBGSerial.println(n, b); }
  306. static void print_(const char *s, int n, uint8_t b = DEC) {
  307. USBHDBGSerial.print(s); USBHDBGSerial.print(n, b); }
  308. static void print_(const char *s, unsigned int n, uint8_t b = DEC) {
  309. USBHDBGSerial.print(s); USBHDBGSerial.print(n, b); }
  310. static void print_(const char *s, long n, uint8_t b = DEC) {
  311. USBHDBGSerial.print(s); USBHDBGSerial.print(n, b); }
  312. static void print_(const char *s, unsigned long n, uint8_t b = DEC) {
  313. USBHDBGSerial.print(s); USBHDBGSerial.print(n, b); }
  314. static void println_(const char *s, int n, uint8_t b = DEC) {
  315. USBHDBGSerial.print(s); USBHDBGSerial.println(n, b); }
  316. static void println_(const char *s, unsigned int n, uint8_t b = DEC) {
  317. USBHDBGSerial.print(s); USBHDBGSerial.println(n, b); }
  318. static void println_(const char *s, long n, uint8_t b = DEC) {
  319. USBHDBGSerial.print(s); USBHDBGSerial.println(n, b); }
  320. static void println_(const char *s, unsigned long n, uint8_t b = DEC) {
  321. USBHDBGSerial.print(s); USBHDBGSerial.println(n, b); }
  322. friend class USBDriverTimer; // for access to print & println
  323. #else
  324. static void print_(const Transfer_t *transfer) {}
  325. static void print_(const Transfer_t *first, const Transfer_t *last) {}
  326. static void print_token(uint32_t token) {}
  327. static void print_(const Pipe_t *pipe) {}
  328. static void print_driverlist(const char *name, const USBDriver *driver) {}
  329. static void print_qh_list(const Pipe_t *list) {}
  330. static void print_device_descriptor(const uint8_t *p) {}
  331. static void print_config_descriptor(const uint8_t *p, uint32_t maxlen) {}
  332. static void print_string_descriptor(const char *name, const uint8_t *p) {}
  333. static void print_hexbytes(const void *ptr, uint32_t len) {}
  334. static void print_(const char *s) {}
  335. static void print_(int n) {}
  336. static void print_(unsigned int n) {}
  337. static void print_(long n) {}
  338. static void print_(unsigned long n) {}
  339. static void println_(const char *s) {}
  340. static void println_(int n) {}
  341. static void println_(unsigned int n) {}
  342. static void println_(long n) {}
  343. static void println_(unsigned long n) {}
  344. static void println_() {}
  345. static void print_(uint32_t n, uint8_t b) {}
  346. static void println_(uint32_t n, uint8_t b) {}
  347. static void print_(const char *s, int n, uint8_t b = DEC) {}
  348. static void print_(const char *s, unsigned int n, uint8_t b = DEC) {}
  349. static void print_(const char *s, long n, uint8_t b = DEC) {}
  350. static void print_(const char *s, unsigned long n, uint8_t b = DEC) {}
  351. static void println_(const char *s, int n, uint8_t b = DEC) {}
  352. static void println_(const char *s, unsigned int n, uint8_t b = DEC) {}
  353. static void println_(const char *s, long n, uint8_t b = DEC) {}
  354. static void println_(const char *s, unsigned long n, uint8_t b = DEC) {}
  355. #endif
  356. static void mk_setup(setup_t &s, uint32_t bmRequestType, uint32_t bRequest,
  357. uint32_t wValue, uint32_t wIndex, uint32_t wLength) {
  358. s.word1 = bmRequestType | (bRequest << 8) | (wValue << 16);
  359. s.word2 = wIndex | (wLength << 16);
  360. }
  361. };
  362. /************************************************/
  363. /* USB Device Driver Common Base Class */
  364. /************************************************/
  365. // All USB device drivers inherit from this base class.
  366. class USBDriver : public USBHost {
  367. public:
  368. operator bool() {
  369. Device_t *dev = *(Device_t * volatile *)&device;
  370. return dev != nullptr;
  371. }
  372. uint16_t idVendor() {
  373. Device_t *dev = *(Device_t * volatile *)&device;
  374. return (dev != nullptr) ? dev->idVendor : 0;
  375. }
  376. uint16_t idProduct() {
  377. Device_t *dev = *(Device_t * volatile *)&device;
  378. return (dev != nullptr) ? dev->idProduct : 0;
  379. }
  380. const uint8_t *manufacturer() {
  381. Device_t *dev = *(Device_t * volatile *)&device;
  382. if (dev == nullptr || dev->strbuf == nullptr) return nullptr;
  383. return &dev->strbuf->buffer[dev->strbuf->iStrings[strbuf_t::STR_ID_MAN]];
  384. }
  385. const uint8_t *product() {
  386. Device_t *dev = *(Device_t * volatile *)&device;
  387. if (dev == nullptr || dev->strbuf == nullptr) return nullptr;
  388. return &dev->strbuf->buffer[dev->strbuf->iStrings[strbuf_t::STR_ID_PROD]];
  389. }
  390. const uint8_t *serialNumber() {
  391. Device_t *dev = *(Device_t * volatile *)&device;
  392. if (dev == nullptr || dev->strbuf == nullptr) return nullptr;
  393. return &dev->strbuf->buffer[dev->strbuf->iStrings[strbuf_t::STR_ID_SERIAL]];
  394. }
  395. protected:
  396. USBDriver() : next(NULL), device(NULL) {}
  397. // Check if a driver wishes to claim a device or interface or group
  398. // of interfaces within a device. When this function returns true,
  399. // the driver is considered bound or loaded for that device. When
  400. // new devices are detected, enumeration.cpp calls this function on
  401. // all unbound driver objects, to give them an opportunity to bind
  402. // to the new device.
  403. // device has its vid&pid, class/subclass fields initialized
  404. // type is 0 for device level, 1 for interface level, 2 for IAD
  405. // descriptors points to the specific descriptor data
  406. virtual bool claim(Device_t *device, int type, const uint8_t *descriptors, uint32_t len);
  407. // When an unknown (not chapter 9) control transfer completes, this
  408. // function is called for all drivers bound to the device. Return
  409. // true means this driver originated this control transfer, so no
  410. // more drivers need to be offered an opportunity to process it.
  411. // This function is optional, only needed if the driver uses control
  412. // transfers and wishes to be notified when they complete.
  413. virtual void control(const Transfer_t *transfer) { }
  414. // When any of the USBDriverTimer objects a driver creates generates
  415. // a timer event, this function is called.
  416. virtual void timer_event(USBDriverTimer *whichTimer) { }
  417. // When the user calls USBHost::Task, this Task function for all
  418. // active drivers is called, so they may update state and/or call
  419. // any attached user callback functions.
  420. virtual void Task() { }
  421. // When a device disconnects from the USB, this function is called.
  422. // The driver must free all resources it allocated and update any
  423. // internal state necessary to deal with the possibility of user
  424. // code continuing to call its API. However, pipes and transfers
  425. // are the handled by lower layers, so device drivers do not free
  426. // pipes they created or cancel transfers they had in progress.
  427. virtual void disconnect();
  428. // Drivers are managed by this single-linked list. All inactive
  429. // (not bound to any device) drivers are linked from
  430. // available_drivers in enumeration.cpp. When bound to a device,
  431. // drivers are linked from that Device_t drivers list.
  432. USBDriver *next;
  433. // The device this object instance is bound to. In words, this
  434. // is the specific device this driver is using. When not bound
  435. // to any device, this must be NULL. Drivers may set this to
  436. // any non-NULL value if they are in a state where they do not
  437. // wish to claim any device or interface (eg, if getting data
  438. // from the HID parser).
  439. Device_t *device;
  440. friend class USBHost;
  441. };
  442. // Device drivers may create these timer objects to schedule a timer call
  443. class USBDriverTimer {
  444. public:
  445. USBDriverTimer() { }
  446. USBDriverTimer(USBDriver *d) : driver(d) { }
  447. void init(USBDriver *d) { driver = d; };
  448. void start(uint32_t microseconds);
  449. void stop();
  450. void *pointer;
  451. uint32_t integer;
  452. uint32_t started_micros; // testing only
  453. private:
  454. USBDriver *driver;
  455. uint32_t usec;
  456. USBDriverTimer *next;
  457. USBDriverTimer *prev;
  458. friend class USBHost;
  459. };
  460. // Device drivers may inherit from this base class, if they wish to receive
  461. // HID input data fully decoded by the USBHIDParser driver
  462. class USBHIDParser;
  463. class USBHIDInput {
  464. public:
  465. operator bool() { return (mydevice != nullptr); }
  466. uint16_t idVendor() { return (mydevice != nullptr) ? mydevice->idVendor : 0; }
  467. uint16_t idProduct() { return (mydevice != nullptr) ? mydevice->idProduct : 0; }
  468. const uint8_t *manufacturer()
  469. { return ((mydevice == nullptr) || (mydevice->strbuf == nullptr)) ? nullptr : &mydevice->strbuf->buffer[mydevice->strbuf->iStrings[strbuf_t::STR_ID_MAN]]; }
  470. const uint8_t *product()
  471. { return ((mydevice == nullptr) || (mydevice->strbuf == nullptr)) ? nullptr : &mydevice->strbuf->buffer[mydevice->strbuf->iStrings[strbuf_t::STR_ID_PROD]]; }
  472. const uint8_t *serialNumber()
  473. { return ((mydevice == nullptr) || (mydevice->strbuf == nullptr)) ? nullptr : &mydevice->strbuf->buffer[mydevice->strbuf->iStrings[strbuf_t::STR_ID_SERIAL]]; }
  474. private:
  475. virtual hidclaim_t claim_collection(USBHIDParser *driver, Device_t *dev, uint32_t topusage);
  476. virtual bool hid_process_in_data(const Transfer_t *transfer) {return false;}
  477. virtual bool hid_process_out_data(const Transfer_t *transfer) {return false;}
  478. virtual void hid_input_begin(uint32_t topusage, uint32_t type, int lgmin, int lgmax);
  479. virtual void hid_input_data(uint32_t usage, int32_t value);
  480. virtual void hid_input_end();
  481. virtual void disconnect_collection(Device_t *dev);
  482. void add_to_list();
  483. USBHIDInput *next = NULL;
  484. friend class USBHIDParser;
  485. protected:
  486. Device_t *mydevice = NULL;
  487. };
  488. // Device drivers may inherit from this base class, if they wish to receive
  489. // HID input like data from Bluetooth HID device.
  490. class BluetoothController;
  491. class BTHIDInput {
  492. public:
  493. operator bool() { return (btdevice != nullptr); }
  494. uint16_t idVendor() { return (btdevice != nullptr) ? btdevice->idVendor : 0; }
  495. uint16_t idProduct() { return (btdevice != nullptr) ? btdevice->idProduct : 0; }
  496. const uint8_t *manufacturer()
  497. { return ((btdevice == nullptr) || (btdevice->strbuf == nullptr)) ? nullptr : &btdevice->strbuf->buffer[btdevice->strbuf->iStrings[strbuf_t::STR_ID_MAN]]; }
  498. const uint8_t *product()
  499. { return ((btdevice == nullptr) || (btdevice->strbuf == nullptr)) ? nullptr : &btdevice->strbuf->buffer[btdevice->strbuf->iStrings[strbuf_t::STR_ID_PROD]]; }
  500. const uint8_t *serialNumber()
  501. { return ((btdevice == nullptr) || (btdevice->strbuf == nullptr)) ? nullptr : &btdevice->strbuf->buffer[btdevice->strbuf->iStrings[strbuf_t::STR_ID_SERIAL]]; }
  502. private:
  503. virtual bool claim_bluetooth(BluetoothController *driver, uint32_t bluetooth_class) {return false;}
  504. virtual bool process_bluetooth_HID_data(const uint8_t *data, uint16_t length) {return false;}
  505. virtual void release_bluetooth() {};
  506. virtual void remoteNameComplete(const uint8_t *remoteName) {};
  507. virtual void connectionComplete(void) {};
  508. void add_to_list();
  509. BTHIDInput *next = NULL;
  510. friend class BluetoothController;
  511. protected:
  512. enum {SP_NEED_CONNECT=0x1, SP_PS3_IDS=0x2};
  513. uint8_t special_process_required = 0;
  514. Device_t *btdevice = NULL;
  515. };
  516. /************************************************/
  517. /* USB Device Drivers */
  518. /************************************************/
  519. class USBHub : public USBDriver {
  520. public:
  521. USBHub(USBHost &host) : debouncetimer(this), resettimer(this) { init(); }
  522. USBHub(USBHost *host) : debouncetimer(this), resettimer(this) { init(); }
  523. // Hubs with more more than 7 ports are built from two tiers of hubs
  524. // using 4 or 7 port hub chips. While the USB spec seems to allow
  525. // hubs to have up to 255 ports, in practice all hub chips on the
  526. // market are only 2, 3, 4 or 7 ports.
  527. enum { MAXPORTS = 7 };
  528. typedef uint8_t portbitmask_t;
  529. enum {
  530. PORT_OFF = 0,
  531. PORT_DISCONNECT = 1,
  532. PORT_DEBOUNCE1 = 2,
  533. PORT_DEBOUNCE2 = 3,
  534. PORT_DEBOUNCE3 = 4,
  535. PORT_DEBOUNCE4 = 5,
  536. PORT_DEBOUNCE5 = 6,
  537. PORT_RESET = 7,
  538. PORT_RECOVERY = 8,
  539. PORT_ACTIVE = 9
  540. };
  541. protected:
  542. virtual bool claim(Device_t *dev, int type, const uint8_t *descriptors, uint32_t len);
  543. virtual void control(const Transfer_t *transfer);
  544. virtual void timer_event(USBDriverTimer *whichTimer);
  545. virtual void disconnect();
  546. void init();
  547. bool can_send_control_now();
  548. void send_poweron(uint32_t port);
  549. void send_getstatus(uint32_t port);
  550. void send_clearstatus_connect(uint32_t port);
  551. void send_clearstatus_enable(uint32_t port);
  552. void send_clearstatus_suspend(uint32_t port);
  553. void send_clearstatus_overcurrent(uint32_t port);
  554. void send_clearstatus_reset(uint32_t port);
  555. void send_setreset(uint32_t port);
  556. void send_setinterface();
  557. static void callback(const Transfer_t *transfer);
  558. void status_change(const Transfer_t *transfer);
  559. void new_port_status(uint32_t port, uint32_t status);
  560. void start_debounce_timer(uint32_t port);
  561. void stop_debounce_timer(uint32_t port);
  562. private:
  563. Device_t mydevices[MAXPORTS];
  564. Pipe_t mypipes[2] __attribute__ ((aligned(32)));
  565. Transfer_t mytransfers[4] __attribute__ ((aligned(32)));
  566. strbuf_t mystring_bufs[1];
  567. USBDriverTimer debouncetimer;
  568. USBDriverTimer resettimer;
  569. setup_t setup;
  570. Pipe_t *changepipe;
  571. Device_t *devicelist[MAXPORTS];
  572. uint32_t changebits;
  573. uint32_t statusbits;
  574. uint8_t hub_desc[16];
  575. uint8_t interface_count;
  576. uint8_t interface_number;
  577. uint8_t altsetting;
  578. uint8_t protocol;
  579. uint8_t endpoint;
  580. uint8_t interval;
  581. uint8_t numports;
  582. uint8_t characteristics;
  583. uint8_t powertime;
  584. uint8_t sending_control_transfer;
  585. uint8_t port_doing_reset;
  586. uint8_t port_doing_reset_speed;
  587. uint8_t portstate[MAXPORTS];
  588. portbitmask_t send_pending_poweron;
  589. portbitmask_t send_pending_getstatus;
  590. portbitmask_t send_pending_clearstatus_connect;
  591. portbitmask_t send_pending_clearstatus_enable;
  592. portbitmask_t send_pending_clearstatus_suspend;
  593. portbitmask_t send_pending_clearstatus_overcurrent;
  594. portbitmask_t send_pending_clearstatus_reset;
  595. portbitmask_t send_pending_setreset;
  596. portbitmask_t debounce_in_use;
  597. static volatile bool reset_busy;
  598. };
  599. //--------------------------------------------------------------------------
  600. class USBHIDParser : public USBDriver {
  601. public:
  602. USBHIDParser(USBHost &host) { init(); }
  603. static void driver_ready_for_hid_collection(USBHIDInput *driver);
  604. bool sendPacket(const uint8_t *buffer, int cb=-1);
  605. void setTXBuffers(uint8_t *buffer1, uint8_t *buffer2, uint8_t cb);
  606. bool sendControlPacket(uint32_t bmRequestType, uint32_t bRequest,
  607. uint32_t wValue, uint32_t wIndex, uint32_t wLength, void *buf);
  608. protected:
  609. enum { TOPUSAGE_LIST_LEN = 4 };
  610. enum { USAGE_LIST_LEN = 24 };
  611. virtual bool claim(Device_t *device, int type, const uint8_t *descriptors, uint32_t len);
  612. virtual void control(const Transfer_t *transfer);
  613. virtual void disconnect();
  614. static void in_callback(const Transfer_t *transfer);
  615. static void out_callback(const Transfer_t *transfer);
  616. void in_data(const Transfer_t *transfer);
  617. void out_data(const Transfer_t *transfer);
  618. bool check_if_using_report_id();
  619. void parse();
  620. USBHIDInput * find_driver(uint32_t topusage);
  621. void parse(uint16_t type_and_report_id, const uint8_t *data, uint32_t len);
  622. void init();
  623. // Atempt for RAWhid to take over processing of data
  624. //
  625. uint16_t inSize(void) {return in_size;}
  626. uint16_t outSize(void) {return out_size;}
  627. uint8_t activeSendMask(void) {return txstate;}
  628. private:
  629. Pipe_t *in_pipe;
  630. Pipe_t *out_pipe;
  631. static USBHIDInput *available_hid_drivers_list;
  632. //uint32_t topusage_list[TOPUSAGE_LIST_LEN];
  633. USBHIDInput *topusage_drivers[TOPUSAGE_LIST_LEN];
  634. uint16_t in_size;
  635. uint16_t out_size;
  636. setup_t setup;
  637. uint8_t descriptor[512];
  638. uint8_t report[64];
  639. uint16_t descsize;
  640. bool use_report_id;
  641. Pipe_t mypipes[3] __attribute__ ((aligned(32)));
  642. Transfer_t mytransfers[4] __attribute__ ((aligned(32)));
  643. strbuf_t mystring_bufs[1];
  644. uint8_t txstate = 0;
  645. uint8_t *tx1 = nullptr;
  646. uint8_t *tx2 = nullptr;
  647. bool hid_driver_claimed_control_ = false;
  648. };
  649. //--------------------------------------------------------------------------
  650. class KeyboardController : public USBDriver , public USBHIDInput, public BTHIDInput {
  651. public:
  652. typedef union {
  653. struct {
  654. uint8_t numLock : 1;
  655. uint8_t capsLock : 1;
  656. uint8_t scrollLock : 1;
  657. uint8_t compose : 1;
  658. uint8_t kana : 1;
  659. uint8_t reserved : 3;
  660. };
  661. uint8_t byte;
  662. } KBDLeds_t;
  663. public:
  664. KeyboardController(USBHost &host) { init(); }
  665. KeyboardController(USBHost *host) { init(); }
  666. // need their own versions as both USBDriver and USBHIDInput provide
  667. uint16_t idVendor();
  668. uint16_t idProduct();
  669. const uint8_t *manufacturer();
  670. const uint8_t *product();
  671. const uint8_t *serialNumber();
  672. operator bool() { return ((device != nullptr) || (btdevice != nullptr)); }
  673. // Main boot keyboard functions.
  674. uint16_t getKey() { return keyCode; }
  675. uint8_t getModifiers() { return modifiers; }
  676. uint8_t getOemKey() { return keyOEM; }
  677. void attachPress(void (*f)(int unicode)) { keyPressedFunction = f; }
  678. void attachRelease(void (*f)(int unicode)) { keyReleasedFunction = f; }
  679. void LEDS(uint8_t leds);
  680. uint8_t LEDS() {return leds_.byte;}
  681. void updateLEDS(void);
  682. bool numLock() {return leds_.numLock;}
  683. bool capsLock() {return leds_.capsLock;}
  684. bool scrollLock() {return leds_.scrollLock;}
  685. void numLock(bool f);
  686. void capsLock(bool f);
  687. void scrollLock(bool f);
  688. // Added for extras information.
  689. void attachExtrasPress(void (*f)(uint32_t top, uint16_t code)) { extrasKeyPressedFunction = f; }
  690. void attachExtrasRelease(void (*f)(uint32_t top, uint16_t code)) { extrasKeyReleasedFunction = f; }
  691. void forceBootProtocol();
  692. enum {MAX_KEYS_DOWN=4};
  693. protected:
  694. virtual bool claim(Device_t *device, int type, const uint8_t *descriptors, uint32_t len);
  695. virtual void control(const Transfer_t *transfer);
  696. virtual void disconnect();
  697. static void callback(const Transfer_t *transfer);
  698. void new_data(const Transfer_t *transfer);
  699. void init();
  700. // Bluetooth data
  701. virtual bool claim_bluetooth(BluetoothController *driver, uint32_t bluetooth_class);
  702. virtual bool process_bluetooth_HID_data(const uint8_t *data, uint16_t length);
  703. virtual void release_bluetooth();
  704. protected: // HID functions for extra keyboard data.
  705. virtual hidclaim_t claim_collection(USBHIDParser *driver, Device_t *dev, uint32_t topusage);
  706. virtual void hid_input_begin(uint32_t topusage, uint32_t type, int lgmin, int lgmax);
  707. virtual void hid_input_data(uint32_t usage, int32_t value);
  708. virtual void hid_input_end();
  709. virtual void disconnect_collection(Device_t *dev);
  710. private:
  711. void update();
  712. uint16_t convert_to_unicode(uint32_t mod, uint32_t key);
  713. void key_press(uint32_t mod, uint32_t key);
  714. void key_release(uint32_t mod, uint32_t key);
  715. void (*keyPressedFunction)(int unicode);
  716. void (*keyReleasedFunction)(int unicode);
  717. Pipe_t *datapipe;
  718. setup_t setup;
  719. uint8_t report[8];
  720. uint16_t keyCode;
  721. uint8_t modifiers;
  722. uint8_t keyOEM;
  723. uint8_t prev_report[8];
  724. KBDLeds_t leds_ = {0};
  725. Pipe_t mypipes[2] __attribute__ ((aligned(32)));
  726. Transfer_t mytransfers[4] __attribute__ ((aligned(32)));
  727. strbuf_t mystring_bufs[1];
  728. // Added to process secondary HID data.
  729. void (*extrasKeyPressedFunction)(uint32_t top, uint16_t code);
  730. void (*extrasKeyReleasedFunction)(uint32_t top, uint16_t code);
  731. uint32_t topusage_ = 0; // What top report am I processing?
  732. uint8_t collections_claimed_ = 0;
  733. volatile bool hid_input_begin_ = false;
  734. volatile bool hid_input_data_ = false; // did we receive any valid data with report?
  735. uint8_t count_keys_down_ = 0;
  736. uint16_t keys_down[MAX_KEYS_DOWN];
  737. bool force_boot_protocol; // User or VID/PID said force boot protocol?
  738. bool control_queued;
  739. };
  740. class MouseController : public USBHIDInput, public BTHIDInput {
  741. public:
  742. MouseController(USBHost &host) { init(); }
  743. bool available() { return mouseEvent; }
  744. void mouseDataClear();
  745. uint8_t getButtons() { return buttons; }
  746. int getMouseX() { return mouseX; }
  747. int getMouseY() { return mouseY; }
  748. int getWheel() { return wheel; }
  749. int getWheelH() { return wheelH; }
  750. protected:
  751. virtual hidclaim_t claim_collection(USBHIDParser *driver, Device_t *dev, uint32_t topusage);
  752. virtual void hid_input_begin(uint32_t topusage, uint32_t type, int lgmin, int lgmax);
  753. virtual void hid_input_data(uint32_t usage, int32_t value);
  754. virtual void hid_input_end();
  755. virtual void disconnect_collection(Device_t *dev);
  756. // Bluetooth data
  757. virtual bool claim_bluetooth(BluetoothController *driver, uint32_t bluetooth_class);
  758. virtual bool process_bluetooth_HID_data(const uint8_t *data, uint16_t length);
  759. virtual void release_bluetooth();
  760. private:
  761. void init();
  762. BluetoothController *btdriver_ = nullptr;
  763. uint8_t collections_claimed = 0;
  764. volatile bool mouseEvent = false;
  765. volatile bool hid_input_begin_ = false;
  766. uint8_t buttons = 0;
  767. int mouseX = 0;
  768. int mouseY = 0;
  769. int wheel = 0;
  770. int wheelH = 0;
  771. };
  772. //--------------------------------------------------------------------------
  773. class JoystickController : public USBDriver, public USBHIDInput, public BTHIDInput {
  774. public:
  775. JoystickController(USBHost &host) { init(); }
  776. uint16_t idVendor();
  777. uint16_t idProduct();
  778. const uint8_t *manufacturer();
  779. const uint8_t *product();
  780. const uint8_t *serialNumber();
  781. operator bool() { return (((device != nullptr) || (mydevice != nullptr || (btdevice != nullptr))) && connected_); } // override as in both USBDriver and in USBHIDInput
  782. bool available() { return joystickEvent; }
  783. void joystickDataClear();
  784. uint32_t getButtons() { return buttons; }
  785. int getAxis(uint32_t index) { return (index < (sizeof(axis)/sizeof(axis[0]))) ? axis[index] : 0; }
  786. uint64_t axisMask() {return axis_mask_;}
  787. uint64_t axisChangedMask() { return axis_changed_mask_;}
  788. uint64_t axisChangeNotifyMask() {return axis_change_notify_mask_;}
  789. void axisChangeNotifyMask(uint64_t notify_mask) {axis_change_notify_mask_ = notify_mask;}
  790. // set functions functionality depends on underlying joystick.
  791. bool setRumble(uint8_t lValue, uint8_t rValue, uint8_t timeout=0xff);
  792. // setLEDs on PS4(RGB), PS3 simple LED setting (only uses lr)
  793. bool setLEDs(uint8_t lr, uint8_t lg=0, uint8_t lb=0); // sets Leds,
  794. enum { STANDARD_AXIS_COUNT = 10, ADDITIONAL_AXIS_COUNT = 54, TOTAL_AXIS_COUNT = (STANDARD_AXIS_COUNT+ADDITIONAL_AXIS_COUNT) };
  795. typedef enum { UNKNOWN=0, PS3, PS4, XBOXONE, XBOX360} joytype_t;
  796. joytype_t joystickType = UNKNOWN;
  797. protected:
  798. // From USBDriver
  799. virtual bool claim(Device_t *device, int type, const uint8_t *descriptors, uint32_t len);
  800. virtual void control(const Transfer_t *transfer);
  801. virtual void disconnect();
  802. // From USBHIDInput
  803. virtual hidclaim_t claim_collection(USBHIDParser *driver, Device_t *dev, uint32_t topusage);
  804. virtual void hid_input_begin(uint32_t topusage, uint32_t type, int lgmin, int lgmax);
  805. virtual void hid_input_data(uint32_t usage, int32_t value);
  806. virtual void hid_input_end();
  807. virtual void disconnect_collection(Device_t *dev);
  808. virtual bool hid_process_out_data(const Transfer_t *transfer);
  809. // Bluetooth data
  810. virtual bool claim_bluetooth(BluetoothController *driver, uint32_t bluetooth_class);
  811. virtual bool process_bluetooth_HID_data(const uint8_t *data, uint16_t length);
  812. virtual void release_bluetooth();
  813. virtual void remoteNameComplete(const uint8_t *remoteName);
  814. virtual void connectionComplete(void);
  815. private:
  816. // Class specific
  817. void init();
  818. USBHIDParser *driver_ = nullptr;
  819. BluetoothController *btdriver_ = nullptr;
  820. joytype_t mapVIDPIDtoJoystickType(uint16_t idVendor, uint16_t idProduct, bool exclude_hid_devices);
  821. bool transmitPS4UserFeedbackMsg();
  822. bool transmitPS3UserFeedbackMsg();
  823. bool anychange = false;
  824. volatile bool joystickEvent = false;
  825. uint32_t buttons = 0;
  826. int axis[TOTAL_AXIS_COUNT] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
  827. uint64_t axis_mask_ = 0; // which axis have valid data
  828. uint64_t axis_changed_mask_ = 0;
  829. uint64_t axis_change_notify_mask_ = 0x3ff; // assume the low 10 values only.
  830. uint16_t additional_axis_usage_page_ = 0;
  831. uint16_t additional_axis_usage_start_ = 0;
  832. uint16_t additional_axis_usage_count_ = 0;
  833. // State values to output to Joystick.
  834. uint8_t rumble_lValue_ = 0;
  835. uint8_t rumble_rValue_ = 0;
  836. uint8_t rumble_timeout_ = 0;
  837. uint8_t leds_[3] = {0,0,0};
  838. uint8_t connected_ = 0; // what type of device if any is connected xbox 360...
  839. // Used by HID code
  840. uint8_t collections_claimed = 0;
  841. // Used by USBDriver code
  842. static void rx_callback(const Transfer_t *transfer);
  843. static void tx_callback(const Transfer_t *transfer);
  844. void rx_data(const Transfer_t *transfer);
  845. void tx_data(const Transfer_t *transfer);
  846. Pipe_t mypipes[3] __attribute__ ((aligned(32)));
  847. Transfer_t mytransfers[7] __attribute__ ((aligned(32)));
  848. strbuf_t mystring_bufs[1];
  849. uint8_t rx_ep_ = 0; // remember which end point this object is...
  850. uint16_t rx_size_ = 0;
  851. uint16_t tx_size_ = 0;
  852. Pipe_t *rxpipe_;
  853. Pipe_t *txpipe_;
  854. uint8_t rxbuf_[64]; // receive circular buffer
  855. uint8_t txbuf_[64]; // buffer to use to send commands to joystick
  856. // Mapping table to say which devices we handle
  857. typedef struct {
  858. uint16_t idVendor;
  859. uint16_t idProduct;
  860. joytype_t joyType;
  861. bool hidDevice;
  862. } product_vendor_mapping_t;
  863. static product_vendor_mapping_t pid_vid_mapping[];
  864. };
  865. //--------------------------------------------------------------------------
  866. class MIDIDevice : public USBDriver {
  867. public:
  868. enum { SYSEX_MAX_LEN = 290 };
  869. // Message type names for compatibility with Arduino MIDI library 4.3.1
  870. enum MidiType {
  871. InvalidType = 0x00, // For notifying errors
  872. NoteOff = 0x80, // Note Off
  873. NoteOn = 0x90, // Note On
  874. AfterTouchPoly = 0xA0, // Polyphonic AfterTouch
  875. ControlChange = 0xB0, // Control Change / Channel Mode
  876. ProgramChange = 0xC0, // Program Change
  877. AfterTouchChannel = 0xD0, // Channel (monophonic) AfterTouch
  878. PitchBend = 0xE0, // Pitch Bend
  879. SystemExclusive = 0xF0, // System Exclusive
  880. TimeCodeQuarterFrame = 0xF1, // System Common - MIDI Time Code Quarter Frame
  881. SongPosition = 0xF2, // System Common - Song Position Pointer
  882. SongSelect = 0xF3, // System Common - Song Select
  883. TuneRequest = 0xF6, // System Common - Tune Request
  884. Clock = 0xF8, // System Real Time - Timing Clock
  885. Start = 0xFA, // System Real Time - Start
  886. Continue = 0xFB, // System Real Time - Continue
  887. Stop = 0xFC, // System Real Time - Stop
  888. ActiveSensing = 0xFE, // System Real Time - Active Sensing
  889. SystemReset = 0xFF, // System Real Time - System Reset
  890. };
  891. MIDIDevice(USBHost &host) { init(); }
  892. MIDIDevice(USBHost *host) { init(); }
  893. void sendNoteOff(uint8_t note, uint8_t velocity, uint8_t channel, uint8_t cable=0) {
  894. send(0x80, note, velocity, channel, cable);
  895. }
  896. void sendNoteOn(uint8_t note, uint8_t velocity, uint8_t channel, uint8_t cable=0) {
  897. send(0x90, note, velocity, channel, cable);
  898. }
  899. void sendPolyPressure(uint8_t note, uint8_t pressure, uint8_t channel, uint8_t cable=0) {
  900. send(0xA0, note, pressure, channel, cable);
  901. }
  902. void sendAfterTouchPoly(uint8_t note, uint8_t pressure, uint8_t channel, uint8_t cable=0) {
  903. send(0xA0, note, pressure, channel, cable);
  904. }
  905. void sendControlChange(uint8_t control, uint8_t value, uint8_t channel, uint8_t cable=0) {
  906. send(0xB0, control, value, channel, cable);
  907. }
  908. void sendProgramChange(uint8_t program, uint8_t channel, uint8_t cable=0) {
  909. send(0xC0, program, 0, channel, cable);
  910. }
  911. void sendAfterTouch(uint8_t pressure, uint8_t channel, uint8_t cable=0) {
  912. send(0xD0, pressure, 0, channel, cable);
  913. }
  914. void sendPitchBend(int value, uint8_t channel, uint8_t cable=0) {
  915. if (value < -8192) {
  916. value = -8192;
  917. } else if (value > 8191) {
  918. value = 8191;
  919. }
  920. value += 8192;
  921. send(0xE0, value, value >> 7, channel, cable);
  922. }
  923. void sendSysEx(uint32_t length, const uint8_t *data, bool hasTerm=false, uint8_t cable=0) {
  924. //if (cable >= MIDI_NUM_CABLES) return;
  925. if (hasTerm) {
  926. send_sysex_buffer_has_term(data, length, cable);
  927. } else {
  928. send_sysex_add_term_bytes(data, length, cable);
  929. }
  930. }
  931. void sendRealTime(uint8_t type, uint8_t cable=0) {
  932. switch (type) {
  933. case 0xF8: // Clock
  934. case 0xFA: // Start
  935. case 0xFB: // Continue
  936. case 0xFC: // Stop
  937. case 0xFE: // ActiveSensing
  938. case 0xFF: // SystemReset
  939. send(type, 0, 0, 0, cable);
  940. break;
  941. default: // Invalid Real Time marker
  942. break;
  943. }
  944. }
  945. void sendTimeCodeQuarterFrame(uint8_t type, uint8_t value, uint8_t cable=0) {
  946. send(0xF1, ((type & 0x07) << 4) | (value & 0x0F), 0, 0, cable);
  947. }
  948. void sendSongPosition(uint16_t beats, uint8_t cable=0) {
  949. send(0xF2, beats, beats >> 7, 0, cable);
  950. }
  951. void sendSongSelect(uint8_t song, uint8_t cable=0) {
  952. send(0xF3, song, 0, 0, cable);
  953. }
  954. void sendTuneRequest(uint8_t cable=0) {
  955. send(0xF6, 0, 0, 0, cable);
  956. }
  957. void beginRpn(uint16_t number, uint8_t channel, uint8_t cable=0) {
  958. sendControlChange(101, number >> 7, channel, cable);
  959. sendControlChange(100, number, channel, cable);
  960. }
  961. void sendRpnValue(uint16_t value, uint8_t channel, uint8_t cable=0) {
  962. sendControlChange(6, value >> 7, channel, cable);
  963. sendControlChange(38, value, channel, cable);
  964. }
  965. void sendRpnIncrement(uint8_t amount, uint8_t channel, uint8_t cable=0) {
  966. sendControlChange(96, amount, channel, cable);
  967. }
  968. void sendRpnDecrement(uint8_t amount, uint8_t channel, uint8_t cable=0) {
  969. sendControlChange(97, amount, channel, cable);
  970. }
  971. void endRpn(uint8_t channel, uint8_t cable=0) {
  972. sendControlChange(101, 0x7F, channel, cable);
  973. sendControlChange(100, 0x7F, channel, cable);
  974. }
  975. void beginNrpn(uint16_t number, uint8_t channel, uint8_t cable=0) {
  976. sendControlChange(99, number >> 7, channel, cable);
  977. sendControlChange(98, number, channel, cable);
  978. }
  979. void sendNrpnValue(uint16_t value, uint8_t channel, uint8_t cable=0) {
  980. sendControlChange(6, value >> 7, channel, cable);
  981. sendControlChange(38, value, channel, cable);
  982. }
  983. void sendNrpnIncrement(uint8_t amount, uint8_t channel, uint8_t cable=0) {
  984. sendControlChange(96, amount, channel, cable);
  985. }
  986. void sendNrpnDecrement(uint8_t amount, uint8_t channel, uint8_t cable=0) {
  987. sendControlChange(97, amount, channel, cable);
  988. }
  989. void endNrpn(uint8_t channel, uint8_t cable=0) {
  990. sendControlChange(99, 0x7F, channel, cable);
  991. sendControlChange(98, 0x7F, channel, cable);
  992. }
  993. void send(uint8_t type, uint8_t data1, uint8_t data2, uint8_t channel, uint8_t cable=0) {
  994. //if (cable >= MIDI_NUM_CABLES) return;
  995. if (type < 0xF0) {
  996. if (type < 0x80) return;
  997. type &= 0xF0;
  998. write_packed((type << 8) | (type >> 4) | ((cable & 0x0F) << 4)
  999. | (((channel - 1) & 0x0F) << 8) | ((data1 & 0x7F) << 16)
  1000. | ((data2 & 0x7F) << 24));
  1001. } else if (type >= 0xF8 || type == 0xF6) {
  1002. write_packed((type << 8) | 0x0F | ((cable & 0x0F) << 4));
  1003. } else if (type == 0xF1 || type == 0xF3) {
  1004. write_packed((type << 8) | 0x02 | ((cable & 0x0F) << 4)
  1005. | ((data1 & 0x7F) << 16));
  1006. } else if (type == 0xF2) {
  1007. write_packed((type << 8) | 0x03 | ((cable & 0x0F) << 4)
  1008. | ((data1 & 0x7F) << 16) | ((data2 & 0x7F) << 24));
  1009. }
  1010. }
  1011. void send_now(void) __attribute__((always_inline)) {
  1012. }
  1013. bool read(uint8_t channel=0);
  1014. uint8_t getType(void) {
  1015. return msg_type;
  1016. };
  1017. uint8_t getCable(void) {
  1018. return msg_cable;
  1019. }
  1020. uint8_t getChannel(void) {
  1021. return msg_channel;
  1022. };
  1023. uint8_t getData1(void) {
  1024. return msg_data1;
  1025. };
  1026. uint8_t getData2(void) {
  1027. return msg_data2;
  1028. };
  1029. uint8_t * getSysExArray(void) {
  1030. return msg_sysex;
  1031. }
  1032. uint16_t getSysExArrayLength(void) {
  1033. return msg_data2 << 8 | msg_data1;
  1034. }
  1035. void setHandleNoteOff(void (*fptr)(uint8_t channel, uint8_t note, uint8_t velocity)) {
  1036. // type: 0x80 NoteOff
  1037. handleNoteOff = fptr;
  1038. }
  1039. void setHandleNoteOn(void (*fptr)(uint8_t channel, uint8_t note, uint8_t velocity)) {
  1040. // type: 0x90 NoteOn
  1041. handleNoteOn = fptr;
  1042. }
  1043. void setHandleVelocityChange(void (*fptr)(uint8_t channel, uint8_t note, uint8_t velocity)) {
  1044. // type: 0xA0 AfterTouchPoly
  1045. handleVelocityChange = fptr;
  1046. }
  1047. void setHandleAfterTouchPoly(void (*fptr)(uint8_t channel, uint8_t note, uint8_t pressure)) {
  1048. // type: 0xA0 AfterTouchPoly
  1049. handleVelocityChange = fptr;
  1050. }
  1051. void setHandleControlChange(void (*fptr)(uint8_t channel, uint8_t control, uint8_t value)) {
  1052. // type: 0xB0 ControlChange
  1053. handleControlChange = fptr;
  1054. }
  1055. void setHandleProgramChange(void (*fptr)(uint8_t channel, uint8_t program)) {
  1056. // type: 0xC0 ProgramChange
  1057. handleProgramChange = fptr;
  1058. }
  1059. void setHandleAfterTouch(void (*fptr)(uint8_t channel, uint8_t pressure)) {
  1060. // type: 0xD0 AfterTouchChannel
  1061. handleAfterTouch = fptr;
  1062. }
  1063. void setHandleAfterTouchChannel(void (*fptr)(uint8_t channel, uint8_t pressure)) {
  1064. // type: 0xD0 AfterTouchChannel
  1065. handleAfterTouch = fptr;
  1066. }
  1067. void setHandlePitchChange(void (*fptr)(uint8_t channel, int pitch)) {
  1068. // type: 0xE0 PitchBend
  1069. handlePitchChange = fptr;
  1070. }
  1071. void setHandleSysEx(void (*fptr)(const uint8_t *data, uint16_t length, bool complete)) {
  1072. // type: 0xF0 SystemExclusive - multiple calls for message bigger than buffer
  1073. handleSysExPartial = (void (*)(const uint8_t *, uint16_t, uint8_t))fptr;
  1074. }
  1075. void setHandleSystemExclusive(void (*fptr)(const uint8_t *data, uint16_t length, bool complete)) {
  1076. // type: 0xF0 SystemExclusive - multiple calls for message bigger than buffer
  1077. handleSysExPartial = (void (*)(const uint8_t *, uint16_t, uint8_t))fptr;
  1078. }
  1079. void setHandleSystemExclusive(void (*fptr)(uint8_t *data, unsigned int size)) {
  1080. // type: 0xF0 SystemExclusive - single call, message larger than buffer is truncated
  1081. handleSysExComplete = fptr;
  1082. }
  1083. void setHandleTimeCodeQuarterFrame(void (*fptr)(uint8_t data)) {
  1084. // type: 0xF1 TimeCodeQuarterFrame
  1085. handleTimeCodeQuarterFrame = fptr;
  1086. }
  1087. void setHandleSongPosition(void (*fptr)(uint16_t beats)) {
  1088. // type: 0xF2 SongPosition
  1089. handleSongPosition = fptr;
  1090. }
  1091. void setHandleSongSelect(void (*fptr)(uint8_t songnumber)) {
  1092. // type: 0xF3 SongSelect
  1093. handleSongSelect = fptr;
  1094. }
  1095. void setHandleTuneRequest(void (*fptr)(void)) {
  1096. // type: 0xF6 TuneRequest
  1097. handleTuneRequest = fptr;
  1098. }
  1099. void setHandleClock(void (*fptr)(void)) {
  1100. // type: 0xF8 Clock
  1101. handleClock = fptr;
  1102. }
  1103. void setHandleStart(void (*fptr)(void)) {
  1104. // type: 0xFA Start
  1105. handleStart = fptr;
  1106. }
  1107. void setHandleContinue(void (*fptr)(void)) {
  1108. // type: 0xFB Continue
  1109. handleContinue = fptr;
  1110. }
  1111. void setHandleStop(void (*fptr)(void)) {
  1112. // type: 0xFC Stop
  1113. handleStop = fptr;
  1114. }
  1115. void setHandleActiveSensing(void (*fptr)(void)) {
  1116. // type: 0xFE ActiveSensing
  1117. handleActiveSensing = fptr;
  1118. }
  1119. void setHandleSystemReset(void (*fptr)(void)) {
  1120. // type: 0xFF SystemReset
  1121. handleSystemReset = fptr;
  1122. }
  1123. void setHandleRealTimeSystem(void (*fptr)(uint8_t realtimebyte)) {
  1124. // type: 0xF8-0xFF - if more specific handler not configured
  1125. handleRealTimeSystem = fptr;
  1126. }
  1127. protected:
  1128. virtual bool claim(Device_t *device, int type, const uint8_t *descriptors, uint32_t len);
  1129. virtual void disconnect();
  1130. static void rx_callback(const Transfer_t *transfer);
  1131. static void tx_callback(const Transfer_t *transfer);
  1132. void rx_data(const Transfer_t *transfer);
  1133. void tx_data(const Transfer_t *transfer);
  1134. void init();
  1135. void write_packed(uint32_t data);
  1136. void send_sysex_buffer_has_term(const uint8_t *data, uint32_t length, uint8_t cable);
  1137. void send_sysex_add_term_bytes(const uint8_t *data, uint32_t length, uint8_t cable);
  1138. void sysex_byte(uint8_t b);
  1139. private:
  1140. Pipe_t *rxpipe;
  1141. Pipe_t *txpipe;
  1142. enum { MAX_PACKET_SIZE = 64 };
  1143. enum { RX_QUEUE_SIZE = 80 }; // must be more than MAX_PACKET_SIZE/4
  1144. uint32_t rx_buffer[MAX_PACKET_SIZE/4];
  1145. uint32_t tx_buffer1[MAX_PACKET_SIZE/4];
  1146. uint32_t tx_buffer2[MAX_PACKET_SIZE/4];
  1147. uint16_t rx_size;
  1148. uint16_t tx_size;
  1149. uint32_t rx_queue[RX_QUEUE_SIZE];
  1150. bool rx_packet_queued;
  1151. uint16_t rx_head;
  1152. uint16_t rx_tail;
  1153. volatile uint8_t tx1_count;
  1154. volatile uint8_t tx2_count;
  1155. uint8_t rx_ep;
  1156. uint8_t tx_ep;
  1157. uint8_t rx_ep_type;
  1158. uint8_t tx_ep_type;
  1159. uint8_t msg_cable;
  1160. uint8_t msg_channel;
  1161. uint8_t msg_type;
  1162. uint8_t msg_data1;
  1163. uint8_t msg_data2;
  1164. uint8_t msg_sysex[SYSEX_MAX_LEN];
  1165. uint16_t msg_sysex_len;
  1166. void (*handleNoteOff)(uint8_t ch, uint8_t note, uint8_t vel);
  1167. void (*handleNoteOn)(uint8_t ch, uint8_t note, uint8_t vel);
  1168. void (*handleVelocityChange)(uint8_t ch, uint8_t note, uint8_t vel);
  1169. void (*handleControlChange)(uint8_t ch, uint8_t control, uint8_t value);
  1170. void (*handleProgramChange)(uint8_t ch, uint8_t program);
  1171. void (*handleAfterTouch)(uint8_t ch, uint8_t pressure);
  1172. void (*handlePitchChange)(uint8_t ch, int pitch);
  1173. void (*handleSysExPartial)(const uint8_t *data, uint16_t length, uint8_t complete);
  1174. void (*handleSysExComplete)(uint8_t *data, unsigned int size);
  1175. void (*handleTimeCodeQuarterFrame)(uint8_t data);
  1176. void (*handleSongPosition)(uint16_t beats);
  1177. void (*handleSongSelect)(uint8_t songnumber);
  1178. void (*handleTuneRequest)(void);
  1179. void (*handleClock)(void);
  1180. void (*handleStart)(void);
  1181. void (*handleContinue)(void);
  1182. void (*handleStop)(void);
  1183. void (*handleActiveSensing)(void);
  1184. void (*handleSystemReset)(void);
  1185. void (*handleRealTimeSystem)(uint8_t rtb);
  1186. Pipe_t mypipes[3] __attribute__ ((aligned(32)));
  1187. Transfer_t mytransfers[7] __attribute__ ((aligned(32)));
  1188. strbuf_t mystring_bufs[1];
  1189. };
  1190. //--------------------------------------------------------------------------
  1191. class USBSerial: public USBDriver, public Stream {
  1192. public:
  1193. // FIXME: need different USBSerial, with bigger buffers for 480 Mbit & faster speed
  1194. enum { BUFFER_SIZE = 648 }; // must hold at least 6 max size packets, plus 2 extra bytes
  1195. enum { DEFAULT_WRITE_TIMEOUT = 3500};
  1196. USBSerial(USBHost &host) : txtimer(this) { init(); }
  1197. void begin(uint32_t baud, uint32_t format=USBHOST_SERIAL_8N1);
  1198. void end(void);
  1199. uint32_t writeTimeout() {return write_timeout_;}
  1200. void writeTimeOut(uint32_t write_timeout) {write_timeout_ = write_timeout;} // Will not impact current ones.
  1201. virtual int available(void);
  1202. virtual int peek(void);
  1203. virtual int read(void);
  1204. virtual int availableForWrite();
  1205. virtual size_t write(uint8_t c);
  1206. virtual void flush(void);
  1207. using Print::write;
  1208. protected:
  1209. virtual bool claim(Device_t *device, int type, const uint8_t *descriptors, uint32_t len);
  1210. virtual void control(const Transfer_t *transfer);
  1211. virtual void disconnect();
  1212. virtual void timer_event(USBDriverTimer *whichTimer);
  1213. private:
  1214. static void rx_callback(const Transfer_t *transfer);
  1215. static void tx_callback(const Transfer_t *transfer);
  1216. void rx_data(const Transfer_t *transfer);
  1217. void tx_data(const Transfer_t *transfer);
  1218. void rx_queue_packets(uint32_t head, uint32_t tail);
  1219. void init();
  1220. static bool check_rxtx_ep(uint32_t &rxep, uint32_t &txep);
  1221. bool init_buffers(uint32_t rsize, uint32_t tsize);
  1222. void ch341_setBaud(uint8_t byte_index);
  1223. private:
  1224. Pipe_t mypipes[3] __attribute__ ((aligned(32)));
  1225. Transfer_t mytransfers[7] __attribute__ ((aligned(32)));
  1226. strbuf_t mystring_bufs[1];
  1227. USBDriverTimer txtimer;
  1228. uint32_t bigbuffer[(BUFFER_SIZE+3)/4];
  1229. setup_t setup;
  1230. uint8_t setupdata[16]; //
  1231. uint32_t baudrate;
  1232. uint32_t format_;
  1233. uint32_t write_timeout_ = DEFAULT_WRITE_TIMEOUT;
  1234. Pipe_t *rxpipe;
  1235. Pipe_t *txpipe;
  1236. uint8_t *rx1; // location for first incoming packet
  1237. uint8_t *rx2; // location for second incoming packet
  1238. uint8_t *rxbuf; // receive circular buffer
  1239. uint8_t *tx1; // location for first outgoing packet
  1240. uint8_t *tx2; // location for second outgoing packet
  1241. uint8_t *txbuf;
  1242. volatile uint16_t rxhead;// receive head
  1243. volatile uint16_t rxtail;// receive tail
  1244. volatile uint16_t txhead;
  1245. volatile uint16_t txtail;
  1246. uint16_t rxsize;// size of receive circular buffer
  1247. uint16_t txsize;// size of transmit circular buffer
  1248. volatile uint8_t rxstate;// bitmask: which receive packets are queued
  1249. volatile uint8_t txstate;
  1250. uint8_t pending_control;
  1251. uint8_t setup_state; // PL2303 - has several steps... Could use pending control?
  1252. uint8_t pl2303_v1; // Which version do we have
  1253. uint8_t pl2303_v2;
  1254. uint8_t interface;
  1255. bool control_queued; // Is there already a queued control messaged
  1256. typedef enum { UNKNOWN=0, CDCACM, FTDI, PL2303, CH341, CP210X } sertype_t;
  1257. sertype_t sertype;
  1258. typedef struct {
  1259. uint16_t idVendor;
  1260. uint16_t idProduct;
  1261. sertype_t sertype;
  1262. } product_vendor_mapping_t;
  1263. static product_vendor_mapping_t pid_vid_mapping[];
  1264. };
  1265. //--------------------------------------------------------------------------
  1266. class AntPlus: public USBDriver {
  1267. // Please post any AntPlus feedback or contributions on this forum thread:
  1268. // https://forum.pjrc.com/threads/43110-Ant-libarary-and-USB-driver-for-Teensy-3-5-6
  1269. public:
  1270. AntPlus(USBHost &host) : /* txtimer(this),*/ updatetimer(this) { init(); }
  1271. void begin(const uint8_t key=0);
  1272. void onStatusChange(void (*function)(int channel, int status)) {
  1273. user_onStatusChange = function;
  1274. }
  1275. void onDeviceID(void (*function)(int channel, int devId, int devType, int transType)) {
  1276. user_onDeviceID = function;
  1277. }
  1278. void onHeartRateMonitor(void (*f)(int bpm, int msec, int seqNum), uint32_t devid=0) {
  1279. profileSetup_HRM(&ant.dcfg[PROFILE_HRM], devid);
  1280. memset(&hrm, 0, sizeof(hrm));
  1281. user_onHeartRateMonitor = f;
  1282. }
  1283. void onSpeedCadence(void (*f)(float speed, float distance, float rpm), uint32_t devid=0) {
  1284. profileSetup_SPDCAD(&ant.dcfg[PROFILE_SPDCAD], devid);
  1285. memset(&spdcad, 0, sizeof(spdcad));
  1286. user_onSpeedCadence = f;
  1287. }
  1288. void onSpeed(void (*f)(float speed, float distance), uint32_t devid=0) {
  1289. profileSetup_SPEED(&ant.dcfg[PROFILE_SPEED], devid);
  1290. memset(&spd, 0, sizeof(spd));
  1291. user_onSpeed = f;
  1292. }
  1293. void onCadence(void (*f)(float rpm), uint32_t devid=0) {
  1294. profileSetup_CADENCE(&ant.dcfg[PROFILE_CADENCE], devid);
  1295. memset(&cad, 0, sizeof(cad));
  1296. user_onCadence = f;
  1297. }
  1298. void setWheelCircumference(float meters) {
  1299. wheelCircumference = meters * 1000.0f;
  1300. }
  1301. protected:
  1302. virtual void Task();
  1303. virtual bool claim(Device_t *device, int type, const uint8_t *descriptors, uint32_t len);
  1304. virtual void disconnect();
  1305. virtual void timer_event(USBDriverTimer *whichTimer);
  1306. private:
  1307. static void rx_callback(const Transfer_t *transfer);
  1308. static void tx_callback(const Transfer_t *transfer);
  1309. void rx_data(const Transfer_t *transfer);
  1310. void tx_data(const Transfer_t *transfer);
  1311. void init();
  1312. size_t write(const void *data, const size_t size);
  1313. int read(void *data, const size_t size);
  1314. void transmit();
  1315. private:
  1316. Pipe_t mypipes[2] __attribute__ ((aligned(32)));
  1317. Transfer_t mytransfers[3] __attribute__ ((aligned(32)));
  1318. strbuf_t mystring_bufs[1];
  1319. //USBDriverTimer txtimer;
  1320. USBDriverTimer updatetimer;
  1321. Pipe_t *rxpipe;
  1322. Pipe_t *txpipe;
  1323. bool first_update;
  1324. uint8_t txbuffer[240];
  1325. uint8_t rxpacket[64];
  1326. volatile uint16_t txhead;
  1327. volatile uint16_t txtail;
  1328. volatile bool txready;
  1329. volatile uint8_t rxlen;
  1330. volatile bool do_polling;
  1331. private:
  1332. enum _eventi {
  1333. EVENTI_MESSAGE = 0,
  1334. EVENTI_CHANNEL,
  1335. EVENTI_TOTAL
  1336. };
  1337. enum _profiles {
  1338. PROFILE_HRM = 0,
  1339. PROFILE_SPDCAD,
  1340. PROFILE_POWER,
  1341. PROFILE_STRIDE,
  1342. PROFILE_SPEED,
  1343. PROFILE_CADENCE,
  1344. PROFILE_TOTAL
  1345. };
  1346. typedef struct {
  1347. uint8_t channel;
  1348. uint8_t RFFreq;
  1349. uint8_t networkNumber;
  1350. uint8_t stub;
  1351. uint8_t searchTimeout;
  1352. uint8_t channelType;
  1353. uint8_t deviceType;
  1354. uint8_t transType;
  1355. uint16_t channelPeriod;
  1356. uint16_t searchWaveform;
  1357. uint32_t deviceNumber; // deviceId
  1358. struct {
  1359. uint8_t chanIdOnce;
  1360. uint8_t keyAccepted;
  1361. uint8_t profileValid;
  1362. uint8_t channelStatus;
  1363. uint8_t channelStatusOld;
  1364. } flags;
  1365. } TDCONFIG;
  1366. struct {
  1367. uint8_t initOnce;
  1368. uint8_t key; // key index
  1369. int iDevice; // index to the antplus we're interested in, if > one found
  1370. TDCONFIG dcfg[PROFILE_TOTAL]; // channel config, we're using one channel per device
  1371. } ant;
  1372. void (*user_onStatusChange)(int channel, int status);
  1373. void (*user_onDeviceID)(int channel, int devId, int devType, int transType);
  1374. void (*user_onHeartRateMonitor)(int beatsPerMinute, int milliseconds, int sequenceNumber);
  1375. void (*user_onSpeedCadence)(float speed, float distance, float cadence);
  1376. void (*user_onSpeed)(float speed, float distance);
  1377. void (*user_onCadence)(float cadence);
  1378. void dispatchPayload(TDCONFIG *cfg, const uint8_t *payload, const int len);
  1379. static const uint8_t *getAntKey(const uint8_t keyIdx);
  1380. static uint8_t calcMsgChecksum (const uint8_t *buffer, const uint8_t len);
  1381. static uint8_t * findStreamSync(uint8_t *stream, const size_t rlen, int *pos);
  1382. static int msgCheckIntegrity(uint8_t *stream, const int len);
  1383. static int msgGetLength(uint8_t *stream);
  1384. int handleMessages(uint8_t *buffer, int tBytes);
  1385. void sendMessageChannelStatus(TDCONFIG *cfg, const uint32_t channelStatus);
  1386. void message_channel(const int chan, const int eventId,
  1387. const uint8_t *payload, const size_t dataLength);
  1388. void message_response(const int chan, const int msgId,
  1389. const uint8_t *payload, const size_t dataLength);
  1390. void message_event(const int channel, const int msgId,
  1391. const uint8_t *payload, const size_t dataLength);
  1392. int ResetSystem();
  1393. int RequestMessage(const int channel, const int message);
  1394. int SetNetworkKey(const int netNumber, const uint8_t *key);
  1395. int SetChannelSearchTimeout(const int channel, const int searchTimeout);
  1396. int SetChannelPeriod(const int channel, const int period);
  1397. int SetChannelRFFreq(const int channel, const int freq);
  1398. int SetSearchWaveform(const int channel, const int wave);
  1399. int OpenChannel(const int channel);
  1400. int CloseChannel(const int channel);
  1401. int AssignChannel(const int channel, const int channelType, const int network);
  1402. int SetChannelId(const int channel, const int deviceNum, const int deviceType,
  1403. const int transmissionType);
  1404. int SendBurstTransferPacket(const int channelSeq, const uint8_t *data);
  1405. int SendBurstTransfer(const int channel, const uint8_t *data, const int nunPackets);
  1406. int SendBroadcastData(const int channel, const uint8_t *data);
  1407. int SendAcknowledgedData(const int channel, const uint8_t *data);
  1408. int SendExtAcknowledgedData(const int channel, const int devNum, const int devType,
  1409. const int TranType, const uint8_t *data);
  1410. int SendExtBroadcastData(const int channel, const int devNum, const int devType,
  1411. const int TranType, const uint8_t *data);
  1412. int SendExtBurstTransferPacket(const int chanSeq, const int devNum,
  1413. const int devType, const int TranType, const uint8_t *data);
  1414. int SendExtBurstTransfer(const int channel, const int devNum, const int devType,
  1415. const int tranType, const uint8_t *data, const int nunPackets);
  1416. static void profileSetup_HRM(TDCONFIG *cfg, const uint32_t deviceId);
  1417. static void profileSetup_SPDCAD(TDCONFIG *cfg, const uint32_t deviceId);
  1418. static void profileSetup_POWER(TDCONFIG *cfg, const uint32_t deviceId);
  1419. static void profileSetup_STRIDE(TDCONFIG *cfg, const uint32_t deviceId);
  1420. static void profileSetup_SPEED(TDCONFIG *cfg, const uint32_t deviceId);
  1421. static void profileSetup_CADENCE(TDCONFIG *cfg, const uint32_t deviceId);
  1422. struct {
  1423. struct {
  1424. uint8_t bpm;
  1425. uint8_t sequence;
  1426. uint16_t time;
  1427. } previous;
  1428. } hrm;
  1429. void payload_HRM(TDCONFIG *cfg, const uint8_t *data, const size_t dataLength);
  1430. struct {
  1431. struct {
  1432. uint16_t cadenceTime;
  1433. uint16_t cadenceCt;
  1434. uint16_t speedTime;
  1435. uint16_t speedCt;
  1436. } previous;
  1437. float distance;
  1438. } spdcad;
  1439. void payload_SPDCAD(TDCONFIG *cfg, const uint8_t *data, const size_t dataLength);
  1440. /* struct {
  1441. struct {
  1442. uint8_t sequence;
  1443. uint16_t pedalPowerContribution;
  1444. uint8_t pedalPower;
  1445. uint8_t instantCadence;
  1446. uint16_t sumPower;
  1447. uint16_t instantPower;
  1448. } current;
  1449. struct {
  1450. uint16_t stub;
  1451. } previous;
  1452. } pwr; */
  1453. void payload_POWER(TDCONFIG *cfg, const uint8_t *data, const size_t dataLength);
  1454. /* struct {
  1455. struct {
  1456. uint16_t speed;
  1457. uint16_t cadence;
  1458. uint8_t strides;
  1459. } current;
  1460. struct {
  1461. uint8_t strides;
  1462. uint16_t speed;
  1463. uint16_t cadence;
  1464. } previous;
  1465. } stride; */
  1466. void payload_STRIDE(TDCONFIG *cfg, const uint8_t *data, const size_t dataLength);
  1467. struct {
  1468. struct {
  1469. uint16_t speedTime;
  1470. uint16_t speedCt;
  1471. } previous;
  1472. float distance;
  1473. } spd;
  1474. void payload_SPEED(TDCONFIG *cfg, const uint8_t *data, const size_t dataLength);
  1475. struct {
  1476. struct {
  1477. uint16_t cadenceTime;
  1478. uint16_t cadenceCt;
  1479. } previous;
  1480. } cad;
  1481. void payload_CADENCE(TDCONFIG *cfg, const uint8_t *data, const size_t dataLength);
  1482. uint16_t wheelCircumference; // default is WHEEL_CIRCUMFERENCE (2122cm)
  1483. };
  1484. //--------------------------------------------------------------------------
  1485. class RawHIDController : public USBHIDInput {
  1486. public:
  1487. RawHIDController(USBHost &host, uint32_t usage = 0) : fixed_usage_(usage) { init(); }
  1488. uint32_t usage(void) {return usage_;}
  1489. void attachReceive(bool (*f)(uint32_t usage, const uint8_t *data, uint32_t len)) {receiveCB = f;}
  1490. bool sendPacket(const uint8_t *buffer);
  1491. protected:
  1492. virtual hidclaim_t claim_collection(USBHIDParser *driver, Device_t *dev, uint32_t topusage);
  1493. virtual bool hid_process_in_data(const Transfer_t *transfer);
  1494. virtual bool hid_process_out_data(const Transfer_t *transfer);
  1495. virtual void hid_input_begin(uint32_t topusage, uint32_t type, int lgmin, int lgmax);
  1496. virtual void hid_input_data(uint32_t usage, int32_t value);
  1497. virtual void hid_input_end();
  1498. virtual void disconnect_collection(Device_t *dev);
  1499. private:
  1500. void init();
  1501. USBHIDParser *driver_;
  1502. enum { MAX_PACKET_SIZE = 64 };
  1503. bool (*receiveCB)(uint32_t usage, const uint8_t *data, uint32_t len) = nullptr;
  1504. uint8_t collections_claimed = 0;
  1505. //volatile bool hid_input_begin_ = false;
  1506. uint32_t fixed_usage_;
  1507. uint32_t usage_ = 0;
  1508. // See if we can contribute transfers
  1509. Transfer_t mytransfers[2] __attribute__ ((aligned(32)));
  1510. };
  1511. //--------------------------------------------------------------------------
  1512. class BluetoothController: public USBDriver {
  1513. public:
  1514. BluetoothController(USBHost &host, bool pair = false, const char *pin = "0000") : do_pair_device_(pair), pair_pincode_(pin), delayTimer_(this)
  1515. { init(); }
  1516. enum {MAX_ENDPOINTS=4, NUM_SERVICES=4, }; // Max number of Bluetooth services - if you need more than 4 simply increase this number
  1517. enum {BT_CLASS_DEVICE= 0x0804}; // Toy - Robot
  1518. static void driver_ready_for_bluetooth(BTHIDInput *driver);
  1519. const uint8_t* myBDAddr(void) {return my_bdaddr_;}
  1520. // BUGBUG version to allow some of the controlled objects to call?
  1521. enum {CONTROL_SCID=-1};
  1522. void sendL2CapCommand(uint8_t* data, uint8_t nbytes, int channel = (int)0x0001);
  1523. protected:
  1524. virtual bool claim(Device_t *device, int type, const uint8_t *descriptors, uint32_t len);
  1525. virtual void control(const Transfer_t *transfer);
  1526. virtual void disconnect();
  1527. virtual void timer_event(USBDriverTimer *whichTimer);
  1528. BTHIDInput * find_driver(uint32_t device_type);
  1529. // Hack to allow PS3 to maybe change values
  1530. uint16_t connection_rxid_ = 0;
  1531. uint16_t control_dcid_ = 0x70;
  1532. uint16_t interrupt_dcid_ = 0x71;
  1533. uint16_t interrupt_scid_;
  1534. uint16_t control_scid_;
  1535. private:
  1536. friend class BTHIDInput;
  1537. static void rx_callback(const Transfer_t *transfer);
  1538. static void rx2_callback(const Transfer_t *transfer);
  1539. static void tx_callback(const Transfer_t *transfer);
  1540. void rx_data(const Transfer_t *transfer);
  1541. void rx2_data(const Transfer_t *transfer);
  1542. void tx_data(const Transfer_t *transfer);
  1543. void init();
  1544. // HCI support functions...
  1545. void sendHCICommand(uint16_t hciCommand, uint16_t cParams, const uint8_t* data);
  1546. //void sendHCIReadLocalSupportedFeatures();
  1547. void inline sendHCI_INQUIRY();
  1548. void inline sendHCIInquiryCancel();
  1549. void inline sendHCICreateConnection();
  1550. void inline sendHCIAuthenticationRequested();
  1551. void inline sendHCIAcceptConnectionRequest();
  1552. void inline sendHCILinkKeyNegativeReply();
  1553. void inline sendHCIPinCodeReply();
  1554. void inline sendResetHCI();
  1555. void inline sendHDCWriteClassOfDev();
  1556. void inline sendHCIReadBDAddr();
  1557. void inline sendHCIReadLocalVersionInfo();
  1558. void inline sendHCIWriteScanEnable(uint8_t scan_op);
  1559. void inline sendHCIRemoteNameRequest();
  1560. void inline sendHCIRemoteVersionInfoRequest();
  1561. void handle_hci_command_complete();
  1562. void handle_hci_command_status();
  1563. void handle_hci_inquiry_result();
  1564. void handle_hci_inquiry_complete();
  1565. void handle_hci_incoming_connect();
  1566. void handle_hci_connection_complete();
  1567. void handle_hci_disconnect_complete();
  1568. void handle_hci_authentication_complete();
  1569. void handle_hci_remote_name_complete();
  1570. void handle_hci_remote_version_information_complete();
  1571. void handle_hci_pin_code_request();
  1572. void handle_hci_link_key_notification();
  1573. void handle_hci_link_key_request();
  1574. void queue_next_hci_command();
  1575. void sendl2cap_ConnectionResponse(uint16_t handle, uint8_t rxid, uint16_t dcid, uint16_t scid, uint8_t result);
  1576. void sendl2cap_ConnectionRequest(uint16_t handle, uint8_t rxid, uint16_t scid, uint16_t psm);
  1577. void sendl2cap_ConfigRequest(uint16_t handle, uint8_t rxid, uint16_t dcid);
  1578. void sendl2cap_ConfigResponse(uint16_t handle, uint8_t rxid, uint16_t scid);
  1579. void sendL2CapCommand(uint16_t handle, uint8_t* data, uint8_t nbytes, uint8_t channelLow = 0x01, uint8_t channelHigh = 0x00);
  1580. void process_l2cap_connection_request(uint8_t *data);
  1581. void process_l2cap_connection_response(uint8_t *data);
  1582. void process_l2cap_config_request(uint8_t *data);
  1583. void process_l2cap_config_response(uint8_t *data);
  1584. void process_l2cap_command_reject(uint8_t *data);
  1585. void process_l2cap_disconnect_request(uint8_t *data);
  1586. void setHIDProtocol(uint8_t protocol);
  1587. void handleHIDTHDRData(uint8_t *buffer); // Pass the whole buffer...
  1588. static BTHIDInput *available_bthid_drivers_list;
  1589. setup_t setup;
  1590. Pipe_t mypipes[4] __attribute__ ((aligned(32)));
  1591. Transfer_t mytransfers[7] __attribute__ ((aligned(32)));
  1592. strbuf_t mystring_bufs[2]; // 2 string buffers - one for our device - one for remote device...
  1593. uint16_t pending_control_ = 0;
  1594. uint16_t pending_control_tx_ = 0;
  1595. uint16_t rx_size_ = 0;
  1596. uint16_t rx2_size_ = 0;
  1597. uint16_t tx_size_ = 0;
  1598. Pipe_t *rxpipe_;
  1599. Pipe_t *rx2pipe_;
  1600. Pipe_t *txpipe_;
  1601. uint8_t rxbuf_[256]; // used to receive data from RX, which may come with several packets...
  1602. uint8_t rx_packet_data_remaining=0; // how much data remaining
  1603. uint8_t rx2buf_[64]; // receive buffer from Bulk end point
  1604. uint8_t txbuf_[256]; // buffer to use to send commands to bluetooth
  1605. uint8_t hciVersion; // what version of HCI do we have?
  1606. bool do_pair_device_; // Should we do a pair for a new device?
  1607. const char *pair_pincode_; // What pin code to use for the pairing
  1608. USBDriverTimer delayTimer_;
  1609. uint8_t my_bdaddr_[6]; // The bluetooth dongles Bluetooth address.
  1610. uint8_t features[8]; // remember our local features.
  1611. BTHIDInput * device_driver_ = nullptr;;
  1612. uint8_t device_bdaddr_[6];// remember devices address
  1613. uint8_t device_ps_repetion_mode_ ; // mode
  1614. uint8_t device_clock_offset_[2];
  1615. uint32_t device_class_; // class of device.
  1616. uint16_t device_connection_handle_; // handle to connection
  1617. uint8_t remote_ver_;
  1618. uint16_t remote_man_;
  1619. uint8_t remote_subv_;
  1620. uint8_t connection_complete_ = false; //
  1621. typedef struct {
  1622. uint16_t idVendor;
  1623. uint16_t idProduct;
  1624. } product_vendor_mapping_t;
  1625. static product_vendor_mapping_t pid_vid_mapping[];
  1626. };
  1627. #endif