uart.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED -- DO NOT EDIT!         -*- c++ -*-

#ifndef uart_h
#define uart_h

#include "console.h"

#include "types.h"

//
// INTERFACE definition follows 
//


class Uart 
  : public Console
{
public:
  typedef unsigned TransferMode;

  typedef unsigned BaudRate;

  /* These constants must be defined in the 
     arch part of the uart. To define them there
     has the advantage of most efficent definition
     for the hardware.

  static unsigned const PAR_NONE = xxx;
  static unsigned const PAR_EVEN = xxx;
  static unsigned const PAR_ODD  = xxx;
  static unsigned const DAT_5    = xxx;
  static unsigned const DAT_6    = xxx;
  static unsigned const DAT_7    = xxx;
  static unsigned const DAT_8    = xxx;
  static unsigned const STOP_1   = xxx;
  static unsigned const STOP_2   = xxx;

  static unsigned const MODE_8N1 = PAR_NONE | DAT_8 | STOP_1;
  static unsigned const MODE_7E1 = PAR_EVEN | DAT_7 | STOP_1;

  // these two values are to leave either mode
  // or baud rate unchanged on a call to change_mode
  static unsigned const MODE_NC  = xxx;
  static unsigned const BAUD_NC  = xxx;

  */

public:
  /* Interface definition - implemented in the arch part */
  Uart();

  ~Uart();

  void shutdown();

  int const irq() const;

  void enable_rcv_irq();

  void disable_rcv_irq();

  bool change_mode(TransferMode m, BaudRate r);

  TransferMode get_mode();

  int write( char const *str, size_t len );

  int getchar( bool blocking = true );

  int char_avail() const;

  Mword get_attributes() const;
private:

public:
  enum {
    Base_rate     = 115200,
    Base_ier_bits = 0,
  };
private:

public:

  bool startup(Address port, int irq);

  enum {
    PAR_NONE = 0x00,
    PAR_EVEN = 0x18,
    PAR_ODD  = 0x08,
    DAT_5    = 0x00,
    DAT_6    = 0x01,
    DAT_7    = 0x02,
    DAT_8    = 0x03,
    STOP_1   = 0x00,
    STOP_2   = 0x04,

    MODE_8N1 = PAR_NONE | DAT_8 | STOP_1,
    MODE_7E1 = PAR_EVEN | DAT_7 | STOP_1,

  // these two values are to leave either mode
  // or baud rate unchanged on a call to change_mode
    MODE_NC  = 0x1000000,
    BAUD_NC  = 0x1000000,

  };

private:

  enum Registers {
    TRB      = 0, // Transmit/Receive Buffer  (read/write)
    BRD_LOW  = 0, // Baud Rate Divisor LSB if bit 7 of LCR is set  (read/write)
    IER      = 1, // Interrupt Enable Register  (read/write)
    BRD_HIGH = 1, // Baud Rate Divisor MSB if bit 7 of LCR is set  (read/write)
    IIR      = 2, // Interrupt Identification Register  (read only)
    FCR      = 2, // 16550 FIFO Control Register  (write only)
    LCR      = 3, // Line Control Register  (read/write)
    MCR      = 4, // Modem Control Register  (read/write)
    LSR      = 5, // Line Status Register  (read only)
    MSR      = 6, // Modem Status Register  (read only)
    SPR      = 7, // Scratch Pad Register  (read/write)
  };

  Address port;
  int _irq;


private:  
  inline void outb( Unsigned8 b, Registers reg );
  
  inline Unsigned8 inb( Registers reg ) const;
  
  inline void mcr( Unsigned8 b );
  
  inline Unsigned8 mcr() const;
  
  inline void fcr( Unsigned8 b );
  
  inline void lcr( Unsigned8 b );
  
  inline Unsigned8 lcr() const;
  
  inline void ier( Unsigned8 b );
  
  inline Unsigned8 ier() const;
  
  inline Unsigned8 iir() const;
  
  inline Unsigned8 msr() const;
  
  inline Unsigned8 lsr() const;
  
  inline void trb( Unsigned8 b );
  
  inline Unsigned8 trb() const;
  
  bool valid();
};

//
// IMPLEMENTATION includes follow (for use by inline functions)
//


#include "io.h"

//
// IMPLEMENTATION of inline functions (and needed classes)
//




inline void Uart::outb( Unsigned8 b, Registers reg )
{
  Io::out8(b,port+reg);
}



inline Unsigned8 Uart::inb( Registers reg ) const
{
  return Io::in8(port+reg);
}



inline void Uart::ier( Unsigned8 b )
{
  outb(b, IER);
}



inline Unsigned8 Uart::ier() const
{
  return inb(IER);
}



inline int const Uart::irq() const
{
  return _irq;
}



inline void Uart::disable_rcv_irq()
{
  ier(ier() & ~1);
}



inline void Uart::enable_rcv_irq()
{
  ier(ier() | 1);
}

#endif // uart_h

---