teensy3/usb_dev.h

   1 /* Teensyduino Core Library
   2  * http://www.pjrc.com/teensy/
   3  * Copyright (c) 2013 PJRC.COM, LLC.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * 1. The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * 2. If the Software is incorporated into a build system that allows
  17  * selection among a list of target devices, then similar target
  18  * devices manufactured by PJRC.COM must be included in the list of
  19  * target devices and selectable in the same manner.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  25  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  26  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  27  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28  * SOFTWARE.
  29  */
  30
  31 #ifndef _usb_dev_h_
  32 #define _usb_dev_h_
  33
  34 // This header is NOT meant to be included when compiling
  35 // user sketches in Arduino.  The low-level functions
  36 // provided by usb_dev.c are meant to be called only by
  37 // code which provides higher-level interfaces to the user.
  38
  39 #include "usb_mem.h"
  40 #include "usb_desc.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 void usb_init(void);
  47 void usb_init_serialnumber(void);
  48 void usb_isr(void);
  49 usb_packet_t *usb_rx(uint32_t endpoint);
  50 uint32_t usb_tx_byte_count(uint32_t endpoint);
  51 uint32_t usb_tx_packet_count(uint32_t endpoint);
  52 void usb_tx(uint32_t endpoint, usb_packet_t *packet);
  53 void usb_tx_isr(uint32_t endpoint, usb_packet_t *packet);
  54
  55 extern volatile uint8_t usb_configuration;
  56
  57 extern uint16_t usb_rx_byte_count_data[NUM_ENDPOINTS];
  58 static inline uint32_t usb_rx_byte_count(uint32_t endpoint) __attribute__((always_inline));
  59 static inline uint32_t usb_rx_byte_count(uint32_t endpoint)
  60 {
  61         endpoint--;
  62         if (endpoint >= NUM_ENDPOINTS) return 0;
  63         return usb_rx_byte_count_data[endpoint];
  64 }
  65
  66 #ifdef CDC_DATA_INTERFACE
  67 extern uint32_t usb_cdc_line_coding[2];
  68 extern volatile uint8_t usb_cdc_line_rtsdtr;
  69 extern volatile uint8_t usb_cdc_transmit_flush_timer;
  70 extern void usb_serial_flush_callback(void);
  71 #endif
  72
  73 #ifdef SEREMU_INTERFACE
  74 extern volatile uint8_t usb_seremu_transmit_flush_timer;
  75 extern void usb_seremu_flush_callback(void);
  76 #endif
  77
  78 #ifdef KEYBOARD_INTERFACE
  79 extern uint8_t keyboard_modifier_keys;
  80 extern uint8_t keyboard_keys[6];
  81 extern uint8_t keyboard_protocol;
  82 extern uint8_t keyboard_idle_config;
  83 extern uint8_t keyboard_idle_count;
  84 extern volatile uint8_t keyboard_leds;
  85 #endif
  86
  87 #ifdef MIDI_INTERFACE
  88 extern void usb_midi_flush_output(void);
  89 #endif
  90
  91 #ifdef FLIGHTSIM_INTERFACE
  92 extern void usb_flightsim_flush_callback(void);
  93 #endif
  94
  95
  96
  97
  98
  99 #ifdef __cplusplus
 100 }
 101 #endif
 102
 103
 104
 105 #endif