182 lines
5.3 KiB
C++
182 lines
5.3 KiB
C++
/******************************************************************************
|
|
* The MIT License
|
|
*
|
|
* Copyright (c) 2010 Perry Hung.
|
|
* Copyright (c) 2011, 2012 LeafLabs, LLC.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use, copy,
|
|
* modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
* of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*****************************************************************************/
|
|
|
|
/**
|
|
* @file wirish/include/wirish/HardwareSerial.h
|
|
* @brief Wirish serial port interface.
|
|
*/
|
|
|
|
#ifndef _WIRISH_HARDWARESERIAL_H_
|
|
#define _WIRISH_HARDWARESERIAL_H_
|
|
|
|
#include <libmaple/libmaple_types.h>
|
|
|
|
#include "Print.h"
|
|
#include "boards.h"
|
|
#include "stream.h"
|
|
/*
|
|
* IMPORTANT:
|
|
*
|
|
* This class documented "by hand" (i.e., not using Doxygen) in the
|
|
* leaflabs-docs/ repository.
|
|
*
|
|
* If you alter the public HardwareSerial interface, you MUST update
|
|
* the documentation accordingly.
|
|
*/
|
|
|
|
|
|
|
|
// Define constants and variables for buffering incoming serial data. We're
|
|
// using a ring buffer (I think), in which head is the index of the location
|
|
// to which to write the next incoming character and tail is the index of the
|
|
// location from which to read.
|
|
#if !(defined(SERIAL_TX_BUFFER_SIZE) && defined(SERIAL_RX_BUFFER_SIZE))
|
|
#if (RAMEND < 1000)
|
|
#define SERIAL_TX_BUFFER_SIZE 16
|
|
#define SERIAL_RX_BUFFER_SIZE 16
|
|
#else
|
|
#define SERIAL_TX_BUFFER_SIZE 64
|
|
#define SERIAL_RX_BUFFER_SIZE 64
|
|
#endif
|
|
#endif
|
|
#if (SERIAL_TX_BUFFER_SIZE>256)
|
|
typedef uint16_t tx_buffer_index_t;
|
|
#else
|
|
typedef uint8_t tx_buffer_index_t;
|
|
#endif
|
|
#if (SERIAL_RX_BUFFER_SIZE>256)
|
|
typedef uint16_t rx_buffer_index_t;
|
|
#else
|
|
typedef uint8_t rx_buffer_index_t;
|
|
#endif
|
|
|
|
struct usart_dev;
|
|
|
|
/* Roger clark. Changed class inheritance from Print to Stream.
|
|
* Also added new functions for peek() and availableForWrite()
|
|
* Note. AvailableForWrite is only a stub function in the cpp
|
|
*/
|
|
class HardwareSerial : public Stream {
|
|
|
|
public:
|
|
HardwareSerial(struct usart_dev *usart_device,
|
|
uint8 tx_pin,
|
|
uint8 rx_pin);
|
|
|
|
/* Set up/tear down */
|
|
void begin(uint32 baud);
|
|
void end();
|
|
virtual int available(void);
|
|
virtual int peek(void);
|
|
virtual int read(void);
|
|
int availableForWrite(void);
|
|
virtual void flush(void);
|
|
virtual size_t write(uint8_t);
|
|
inline size_t write(unsigned long n) { return write((uint8_t)n); }
|
|
inline size_t write(long n) { return write((uint8_t)n); }
|
|
inline size_t write(unsigned int n) { return write((uint8_t)n); }
|
|
inline size_t write(int n) { return write((uint8_t)n); }
|
|
using Print::write;
|
|
|
|
/* Pin accessors */
|
|
int txPin(void) { return this->tx_pin; }
|
|
int rxPin(void) { return this->rx_pin; }
|
|
|
|
operator bool() { return true; }
|
|
|
|
/* Escape hatch into libmaple */
|
|
/* FIXME [0.0.13] documentation */
|
|
struct usart_dev* c_dev(void) { return this->usart_device; }
|
|
private:
|
|
struct usart_dev *usart_device;
|
|
uint8 tx_pin;
|
|
uint8 rx_pin;
|
|
protected:
|
|
#if 0
|
|
volatile uint8_t * const _ubrrh;
|
|
volatile uint8_t * const _ubrrl;
|
|
volatile uint8_t * const _ucsra;
|
|
volatile uint8_t * const _ucsrb;
|
|
volatile uint8_t * const _ucsrc;
|
|
volatile uint8_t * const _udr;
|
|
// Has any byte been written to the UART since begin()
|
|
bool _written;
|
|
|
|
volatile rx_buffer_index_t _rx_buffer_head;
|
|
volatile rx_buffer_index_t _rx_buffer_tail;
|
|
volatile tx_buffer_index_t _tx_buffer_head;
|
|
volatile tx_buffer_index_t _tx_buffer_tail;
|
|
// Don't put any members after these buffers, since only the first
|
|
// 32 bytes of this struct can be accessed quickly using the ldd
|
|
// instruction.
|
|
unsigned char _rx_buffer[SERIAL_RX_BUFFER_SIZE];
|
|
unsigned char _tx_buffer[SERIAL_TX_BUFFER_SIZE];
|
|
#endif
|
|
};
|
|
|
|
#ifdef BOOTLOADER_maple
|
|
#if BOARD_HAVE_USART1
|
|
extern HardwareSerial Serial1;
|
|
#endif
|
|
#if BOARD_HAVE_USART2
|
|
extern HardwareSerial Serial2;
|
|
#endif
|
|
#if BOARD_HAVE_USART3
|
|
extern HardwareSerial Serial3;
|
|
#endif
|
|
#if BOARD_HAVE_UART4
|
|
extern HardwareSerial Serial4;
|
|
#endif
|
|
#if BOARD_HAVE_UART5
|
|
extern HardwareSerial Serial5;
|
|
#endif
|
|
#if BOARD_HAVE_USART6
|
|
extern HardwareSerial Serial6;
|
|
#endif
|
|
#else
|
|
#if BOARD_HAVE_USART1
|
|
extern HardwareSerial Serial;
|
|
#endif
|
|
#if BOARD_HAVE_USART2
|
|
extern HardwareSerial Serial1;
|
|
#endif
|
|
#if BOARD_HAVE_USART3
|
|
extern HardwareSerial Serial2;
|
|
#endif
|
|
#if BOARD_HAVE_UART4
|
|
extern HardwareSerial Serial3;
|
|
#endif
|
|
#if BOARD_HAVE_UART5
|
|
extern HardwareSerial Serial4;
|
|
#endif
|
|
#if BOARD_HAVE_USART6
|
|
extern HardwareSerial Serial5;
|
|
#endif
|
|
#endif
|
|
|
|
#endif
|