teensy3/usb_seremu.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 USBseremu_h_
  32 #define USBseremu_h_
  33
  34 #if defined(USB_HID) || defined(USB_MIDI) || defined(USB_RAWHID) || defined(USB_FLIGHTSIM)
  35
  36 #include <inttypes.h>
  37
  38 // C language implementation
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42 int usb_seremu_getchar(void);
  43 int usb_seremu_peekchar(void);
  44 int usb_seremu_available(void);
  45 void usb_seremu_flush_input(void);
  46 int usb_seremu_putchar(uint8_t c);
  47 int usb_seremu_write(const void *buffer, uint32_t size);
  48 void usb_seremu_flush_output(void);
  49 void usb_seremu_flush_callback(void);
  50 extern volatile uint8_t usb_seremu_transmit_flush_timer;
  51 extern volatile uint8_t usb_configuration;
  52 #ifdef __cplusplus
  53 }
  54 #endif
  55
  56
  57 // C++ interface
  58 #ifdef __cplusplus
  59 #include "Stream.h"
  60 class usb_seremu_class : public Stream
  61 {
  62 public:
  63         void begin(long) { /* TODO: call a function that tries to wait for enumeration */ };
  64         void end() { /* TODO: flush output and shut down USB port */ };
  65         virtual int available() { return usb_seremu_available(); }
  66         virtual int read() { return usb_seremu_getchar(); }
  67         virtual int peek() { return usb_seremu_peekchar(); }
  68         virtual void flush() { usb_seremu_flush_output(); }
  69         virtual size_t write(uint8_t c) { return usb_seremu_putchar(c); }
  70         virtual size_t write(const uint8_t *buffer, size_t size) { return usb_seremu_write(buffer, size); }
  71         size_t write(unsigned long n) { return write((uint8_t)n); }
  72         size_t write(long n) { return write((uint8_t)n); }
  73         size_t write(unsigned int n) { return write((uint8_t)n); }
  74         size_t write(int n) { return write((uint8_t)n); }
  75         using Print::write;
  76         void send_now(void) { usb_seremu_flush_output(); };
  77         uint32_t baud(void) { return 9600; }
  78         uint8_t stopbits(void) { return 1; }
  79         uint8_t paritytype(void) { return 0; }
  80         uint8_t numbits(void) { return 8; }
  81         uint8_t dtr(void) { return 1; }
  82         uint8_t rts(void) { return 1; }
  83         operator bool() { return usb_configuration; }
  84 };
  85
  86 extern usb_seremu_class Serial;
  87
  88 #endif // __cplusplus
  89
  90 #endif // USB_HID
  91 #endif // USBseremu_h_