/****************************************************************************** RedBotSoftwareSerial.cpp This portion of the RedBot library inherits heavily from the SoftwareSerial library distributed with Arduino; specifically, it started life as the SoftwareSerial library from Arduino 1.0.5. The original license and change history can be found below this, and the entire contents of the file can be found, commented out, at the bottom of the file. The reason for this change is that the RedBot uses the pin change interrupts for other functions in, and so I needed to re-write this library to reflect that fact. While I'm at it, though, I can reduce the size of the footprint, since I know a few facts (target processor, processor speed, pin options, etc). I can also tailor it to the application a bit more, so that rather than a soft serial constructor, the user does a RedBotXBee constructor. You'll see, just wait. 31 Oct 2013, Mike Hord, SparkFun Electronics SoftwareSerial.cpp (formerly NewSoftSerial.cpp) - Multi-instance software serial library for Arduino/Wiring -- Interrupt-driven receive and other improvements by ladyada (http://ladyada.net) -- Tuning, circular buffer, derivation from class Print/Stream, multi-instance support, porting to 8MHz processors, various optimizations, PROGMEM delay tables, inverse logic and direct port writing by Mikal Hart (http://www.arduiniana.org) -- Pin change interrupt macros by Paul Stoffregen (http://www.pjrc.com) -- 20MHz processor support by Garrett Mace (http://www.macetech.com) -- ATmega1280/2560 support by Brett Hagman (http://www.roguerobotics.com/) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA The latest version of this library can always be found at http://arduiniana.org. */ #include "RedBot.h" #include #include // // Lookup table // typedef struct _DELAY_TABLE { long baud; unsigned short rx_delay_centering; unsigned short rx_delay_intrabit; unsigned short rx_delay_stopbit; unsigned short tx_delay; } DELAY_TABLE; // Once upon a time, there was an ifdef here; I got rid of it, because I only // need the 16MHz table for the RedBot. static const DELAY_TABLE __attribute__((section(".progmem.data"))) table[] = { // baud rxcenter rxintra rxstop tx { 115200, 1, 17, 17, 12, }, { 57600, 10, 37, 37, 33, }, { 38400, 25, 57, 57, 54, }, { 31250, 31, 70, 70, 68, }, { 28800, 34, 77, 77, 74, }, { 19200, 54, 117, 117, 114, }, { 14400, 74, 156, 156, 153, }, { 9600, 114, 236, 236, 233, }, { 4800, 233, 474, 474, 471, }, { 2400, 471, 950, 950, 947, }, { 1200, 947, 1902, 1902, 1899, }, { 600, 1902, 3804, 3804, 3800, }, { 300, 3804, 7617, 7617, 7614, }, }; const int XMIT_START_ADJUSTMENT = 5; // // Statics // //RedBotSoftwareSerial *RedBotSoftwareSerial::active_object = 0; extern RedBotSoftwareSerial *RBSPObject; char RedBotSoftwareSerial::_receive_buffer[_SS_MAX_RX_BUFF]; volatile uint8_t RedBotSoftwareSerial::_receive_buffer_tail = 0; volatile uint8_t RedBotSoftwareSerial::_receive_buffer_head = 0; // // Private methods // // static inline void RedBotSoftwareSerial::tunedDelay(uint16_t delay) { uint8_t tmp=0; asm volatile("sbiw %0, 0x01 \n\t" "ldi %1, 0xFF \n\t" "cpi %A0, 0xFF \n\t" "cpc %B0, %1 \n\t" "brne .-10 \n\t" : "+r" (delay), "+a" (tmp) : "0" (delay) ); } // // The receive routine called by the interrupt handler // void RedBotSoftwareSerial::recv() { #if GCC_VERSION < 40302 // Work-around for avr-gcc 4.3.0 OSX version bug // Preserve the registers that the compiler misses // (courtesy of Arduino forum user *etracer*) asm volatile( "push r18 \n\t" "push r19 \n\t" "push r20 \n\t" "push r21 \n\t" "push r22 \n\t" "push r23 \n\t" "push r26 \n\t" "push r27 \n\t" ::); #endif uint8_t d = 0; // Wait approximately 1/2 of a bit width to "center" the sample tunedDelay(_rx_delay_centering); // Read each of the 8 bits for (uint8_t i=0x1; i; i <<= 1) { tunedDelay(_rx_delay_intrabit); uint8_t noti = ~i; if (rx_pin_read()) d |= i; else // else clause added to ensure function timing is ~balanced d &= noti; } // skip the stop bit tunedDelay(_rx_delay_stopbit); // if buffer full, set the overflow flag and return if ((_receive_buffer_tail + 1) % _SS_MAX_RX_BUFF != _receive_buffer_head) { // save new data in buffer: tail points to where byte goes _receive_buffer[_receive_buffer_tail] = d; // save new byte _receive_buffer_tail = (_receive_buffer_tail + 1) % _SS_MAX_RX_BUFF; } else { _buffer_overflow = true; } #if GCC_VERSION < 40302 // Work-around for avr-gcc 4.3.0 OSX version bug // Restore the registers that the compiler misses asm volatile( "pop r27 \n\t" "pop r26 \n\t" "pop r23 \n\t" "pop r22 \n\t" "pop r21 \n\t" "pop r20 \n\t" "pop r19 \n\t" "pop r18 \n\t" ::); #endif } void RedBotSoftwareSerial::tx_pin_write(uint8_t pin_state) { if (pin_state == LOW) *_transmitPortRegister &= ~_transmitBitMask; else *_transmitPortRegister |= _transmitBitMask; } uint8_t RedBotSoftwareSerial::rx_pin_read() { return *_receivePortRegister & _receiveBitMask; } // // Interrupt handling- this is the area that needs the biggest change for // supporting the RedBot. After all, we need to be capable of dealing with // PCINT triggers from three different sources: encoders, whisker bumpers, and // the software serial port. HOWEVER, we can constrain things a bit: after all, // we're only expecting software serial input on ONE pin: PC1, AKA pin 15. That, // plus the pre-determined processing targeting knowledge of the processor, can // allow for some serious streamlining of this. We can remove PCINTO, 2, and 3 // from consideration entirely, and we know that we won't have more than one // SWSP in operation, so we can remove some of the support for that, too. // // Constructor // RedBotSoftwareSerial::RedBotSoftwareSerial() : _rx_delay_centering(0), _rx_delay_intrabit(0), _rx_delay_stopbit(0), _tx_delay(0), _buffer_overflow(false) { setPinChangeInterrupt(15, SW_SERIAL); RBSPObject = this; setTX(14); setRX(15); } // // Destructor // RedBotSoftwareSerial::~RedBotSoftwareSerial() { end(); } void RedBotSoftwareSerial::setTX(uint8_t tx) { pinMode(tx, OUTPUT); digitalWrite(tx, HIGH); _transmitBitMask = digitalPinToBitMask(tx); uint8_t port = digitalPinToPort(tx); _transmitPortRegister = portOutputRegister(port); } void RedBotSoftwareSerial::setRX(uint8_t rx) { pinMode(rx, INPUT); _receivePin = rx; _receiveBitMask = digitalPinToBitMask(rx); uint8_t port = digitalPinToPort(rx); _receivePortRegister = portInputRegister(port); } // // Public methods // void RedBotSoftwareSerial::begin(long speed) { _rx_delay_centering = _rx_delay_intrabit = _rx_delay_stopbit = _tx_delay = 0; for (unsigned i=0; i #include #include #include // // Lookup table // typedef struct _DELAY_TABLE { long baud; unsigned short rx_delay_centering; unsigned short rx_delay_intrabit; unsigned short rx_delay_stopbit; unsigned short tx_delay; } DELAY_TABLE; #if F_CPU == 16000000 static const DELAY_TABLE PROGMEM table[] = { // baud rxcenter rxintra rxstop tx { 115200, 1, 17, 17, 12, }, { 57600, 10, 37, 37, 33, }, { 38400, 25, 57, 57, 54, }, { 31250, 31, 70, 70, 68, }, { 28800, 34, 77, 77, 74, }, { 19200, 54, 117, 117, 114, }, { 14400, 74, 156, 156, 153, }, { 9600, 114, 236, 236, 233, }, { 4800, 233, 474, 474, 471, }, { 2400, 471, 950, 950, 947, }, { 1200, 947, 1902, 1902, 1899, }, { 600, 1902, 3804, 3804, 3800, }, { 300, 3804, 7617, 7617, 7614, }, }; const int XMIT_START_ADJUSTMENT = 5; #elif F_CPU == 8000000 static const DELAY_TABLE table[] PROGMEM = { // baud rxcenter rxintra rxstop tx { 115200, 1, 5, 5, 3, }, { 57600, 1, 15, 15, 13, }, { 38400, 2, 25, 26, 23, }, { 31250, 7, 32, 33, 29, }, { 28800, 11, 35, 35, 32, }, { 19200, 20, 55, 55, 52, }, { 14400, 30, 75, 75, 72, }, { 9600, 50, 114, 114, 112, }, { 4800, 110, 233, 233, 230, }, { 2400, 229, 472, 472, 469, }, { 1200, 467, 948, 948, 945, }, { 600, 948, 1895, 1895, 1890, }, { 300, 1895, 3805, 3805, 3802, }, }; const int XMIT_START_ADJUSTMENT = 4; #elif F_CPU == 20000000 // 20MHz support courtesy of the good people at macegr.com. // Thanks, Garrett! static const DELAY_TABLE PROGMEM table[] = { // baud rxcenter rxintra rxstop tx { 115200, 3, 21, 21, 18, }, { 57600, 20, 43, 43, 41, }, { 38400, 37, 73, 73, 70, }, { 31250, 45, 89, 89, 88, }, { 28800, 46, 98, 98, 95, }, { 19200, 71, 148, 148, 145, }, { 14400, 96, 197, 197, 194, }, { 9600, 146, 297, 297, 294, }, { 4800, 296, 595, 595, 592, }, { 2400, 592, 1189, 1189, 1186, }, { 1200, 1187, 2379, 2379, 2376, }, { 600, 2379, 4759, 4759, 4755, }, { 300, 4759, 9523, 9523, 9520, }, }; const int XMIT_START_ADJUSTMENT = 6; #else #error This version of SoftwareSerial supports only 20, 16 and 8MHz processors #endif // // Statics // SoftwareSerial *SoftwareSerial::active_object = 0; char SoftwareSerial::_receive_buffer[_SS_MAX_RX_BUFF]; volatile uint8_t SoftwareSerial::_receive_buffer_tail = 0; volatile uint8_t SoftwareSerial::_receive_buffer_head = 0; // // Debugging // // This function generates a brief pulse // for debugging or measuring on an oscilloscope. inline void DebugPulse(uint8_t pin, uint8_t count) { #if _DEBUG volatile uint8_t *pport = portOutputRegister(digitalPinToPort(pin)); uint8_t val = *pport; while (count--) { *pport = val | digitalPinToBitMask(pin); *pport = val; } #endif } // // Private methods // // static inline void SoftwareSerial::tunedDelay(uint16_t delay) { uint8_t tmp=0; asm volatile("sbiw %0, 0x01 \n\t" "ldi %1, 0xFF \n\t" "cpi %A0, 0xFF \n\t" "cpc %B0, %1 \n\t" "brne .-10 \n\t" : "+r" (delay), "+a" (tmp) : "0" (delay) ); } // This function sets the current object as the "listening" // one and returns true if it replaces another bool SoftwareSerial::listen() { if (active_object != this) { _buffer_overflow = false; uint8_t oldSREG = SREG; cli(); _receive_buffer_head = _receive_buffer_tail = 0; active_object = this; SREG = oldSREG; return true; } return false; } // // The receive routine called by the interrupt handler // void SoftwareSerial::recv() { #if GCC_VERSION < 40302 // Work-around for avr-gcc 4.3.0 OSX version bug // Preserve the registers that the compiler misses // (courtesy of Arduino forum user *etracer*) asm volatile( "push r18 \n\t" "push r19 \n\t" "push r20 \n\t" "push r21 \n\t" "push r22 \n\t" "push r23 \n\t" "push r26 \n\t" "push r27 \n\t" ::); #endif uint8_t d = 0; // If RX line is high, then we don't see any start bit // so interrupt is probably not for us if (_inverse_logic ? rx_pin_read() : !rx_pin_read()) { // Wait approximately 1/2 of a bit width to "center" the sample tunedDelay(_rx_delay_centering); DebugPulse(_DEBUG_PIN2, 1); // Read each of the 8 bits for (uint8_t i=0x1; i; i <<= 1) { tunedDelay(_rx_delay_intrabit); DebugPulse(_DEBUG_PIN2, 1); uint8_t noti = ~i; if (rx_pin_read()) d |= i; else // else clause added to ensure function timing is ~balanced d &= noti; } // skip the stop bit tunedDelay(_rx_delay_stopbit); DebugPulse(_DEBUG_PIN2, 1); if (_inverse_logic) d = ~d; // if buffer full, set the overflow flag and return if ((_receive_buffer_tail + 1) % _SS_MAX_RX_BUFF != _receive_buffer_head) { // save new data in buffer: tail points to where byte goes _receive_buffer[_receive_buffer_tail] = d; // save new byte _receive_buffer_tail = (_receive_buffer_tail + 1) % _SS_MAX_RX_BUFF; } else { #if _DEBUG // for scope: pulse pin as overflow indictator DebugPulse(_DEBUG_PIN1, 1); #endif _buffer_overflow = true; } } #if GCC_VERSION < 40302 // Work-around for avr-gcc 4.3.0 OSX version bug // Restore the registers that the compiler misses asm volatile( "pop r27 \n\t" "pop r26 \n\t" "pop r23 \n\t" "pop r22 \n\t" "pop r21 \n\t" "pop r20 \n\t" "pop r19 \n\t" "pop r18 \n\t" ::); #endif } void SoftwareSerial::tx_pin_write(uint8_t pin_state) { if (pin_state == LOW) *_transmitPortRegister &= ~_transmitBitMask; else *_transmitPortRegister |= _transmitBitMask; } uint8_t SoftwareSerial::rx_pin_read() { return *_receivePortRegister & _receiveBitMask; } // // Interrupt handling // // static inline void SoftwareSerial::handle_interrupt() { if (active_object) { active_object->recv(); } } #if defined(PCINT0_vect) ISR(PCINT0_vect) { SoftwareSerial::handle_interrupt(); } #endif #if defined(PCINT1_vect) ISR(PCINT1_vect) { SoftwareSerial::handle_interrupt(); } #endif #if defined(PCINT2_vect) ISR(PCINT2_vect) { SoftwareSerial::handle_interrupt(); } #endif #if defined(PCINT3_vect) ISR(PCINT3_vect) { SoftwareSerial::handle_interrupt(); } #endif // // Constructor // SoftwareSerial::SoftwareSerial(uint8_t receivePin, uint8_t transmitPin, bool inverse_logic) : _rx_delay_centering(0), _rx_delay_intrabit(0), _rx_delay_stopbit(0), _tx_delay(0), _buffer_overflow(false), _inverse_logic(inverse_logic) { setTX(transmitPin); setRX(receivePin); } // // Destructor // SoftwareSerial::~SoftwareSerial() { end(); } void SoftwareSerial::setTX(uint8_t tx) { pinMode(tx, OUTPUT); digitalWrite(tx, HIGH); _transmitBitMask = digitalPinToBitMask(tx); uint8_t port = digitalPinToPort(tx); _transmitPortRegister = portOutputRegister(port); } void SoftwareSerial::setRX(uint8_t rx) { pinMode(rx, INPUT); if (!_inverse_logic) digitalWrite(rx, HIGH); // pullup for normal logic! _receivePin = rx; _receiveBitMask = digitalPinToBitMask(rx); uint8_t port = digitalPinToPort(rx); _receivePortRegister = portInputRegister(port); } // // Public methods // void SoftwareSerial::begin(long speed) { _rx_delay_centering = _rx_delay_intrabit = _rx_delay_stopbit = _tx_delay = 0; for (unsigned i=0; i