SFBHWSerialBoard.h

Go to the documentation of this file.

/*                                             -*- mode:C++; fill-column:100 -*-
  SFBHWSerialBoard.h Low-level serial support for the board
  Copyright (C) 2009 The Regents of the University of New Mexico.  All rights reserved.

  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 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

  $Id$
*/
#ifdef SFBHWSERIALHOST_H
#error SFBHWSerialBoard.h and SFBHWSerialHost.h must not be #included together!
#endif

#ifndef SFBHWSERIALBOARD_H
#define SFBHWSERIALBOARD_H

#include "SFBFrame.h"
#include "lpc/LPC23xx.h" /* get the hardware definitions */

class SFBSerial; /* FORWARD DECLARATION */

#define CAN_WRITE(fd) (REGISTER_OFFSET(fd,UxLSR) & 0x20)
#define WRITE_BYTE(fd,byte) (REGISTER_OFFSET(fd,UxTHR) = (byte))
#define CAN_READ(fd) (REGISTER_OFFSET(fd,UxLSR) & 0x01)
#define READ_BYTE(fd) REGISTER_OFFSET(fd,UxRBR)

class SFBHWSerial {  /* Note we are defining 'SFBHWSerial', not 'SFBHWSerialBoard'! */

public:

  SFBHWSerial(int face) ;

  SFBFrame & getFrame() { return theFrame; }

  void putcBlocking(const u8 byte) ;

  static u32 getFirstFace() { return NORTH; }
  static bool moreFaces(u32 face) ;
  static u32 nextFace(u32 face) ;

  static SFBSerial & getFace(u32 face) ;

  bool getPreferOddParity() { return true; } // N(one) wins unless both sides say O(dd).  But we like odd for robustness.

  u8 getPreferredBaudCode() ; // Code 4 is SFBAUD115200.  Often 5==SFBAUD230400 is doable, tbough..
  void setPreferredBaudCode(u8 code) ;

  u8 getLowBaudCode() { return 0; }

  u8 getHighBaudCode() ;
  void setHighBaudCode(u8 code) ;

  void predispatch() { /* nothing to do */ }

  void start(u32 baud, bool oddParity = false);
  void stop() ;
  void setBaudRate(u32 baud, bool oddParity = false) ;
  void checkTx() ;
  u32 getFD();
  SFBRxByteBuffer & getRx() { return rxBytes; }
  SFBTxByteBuffer & getTx() { return txBytes; }
private:

  void uartCommonHandler() ;    /* The interrupt routine */
  friend void Uart0Handler();   /* Which these guys can call*/ 
  friend void Uart1Handler();
  friend void Uart2Handler();
  friend void Uart3Handler();

  void reinit();

  PacketBuffer & rxBuf;         /* Inbound packets are dispatched from here */
  SFBRxByteBuffer rxBytes;      /* Interrupt level writes raw inbound UART RX data to here */
  SFBTxByteBuffer txBytes;      /* Interrupt level reads raw outbound UART TX data from here */
  SFBFrame theFrame;            /* Packets are framed and deframed here */
  u32 lastInputActivity;        /* millis() of last char read */ 
  u32 currentBaudRate;          /* baud rate we're set for, if active*/ 
  u8 flags;                     /* flags_and baud speed code */ 
  const u8 face;
  u8 preferredBaudCode;
  u8 maxBaudCode;               /* maximum user specified baud code, or SFBAUD_CODE_COUNT if unspecified */ 

  enum {
    FLAG_TX_ACTIVE =  0x01,     /* Interrupt is TXing, we don't need to initiate it */
    FLAG_STARTED =    0x02,     /* Set if current started and not stopped */ 
    FLAG_ODD_PARITY = 0x04,     /* Set if odd parity in use */ 
    FLAG_RESERVED3 =  0x08,     /* Rserved */ 
    FLAG_RESERVED4 =  0x10,     /* Rserved */ 
    FLAG_RESERVED5 =  0x20,     /* Rserved */ 
    FLAG_RESERVED6 =  0x40,     /* Rserved */ 
    FLAG_RESERVED7 =  0x80      /* Rserved */ 
  };

public:

  static void reinitAll();
};

#endif  /* SFBHWSERIALBOARD_H */