src/dev/uart.hh

   1 /*
   2  * Copyright (c) 2004-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Ali Saidi
  29  */
  30
  31 /** @file
  32  * Base class for UART
  33  */
  34
  35 #ifndef __UART_HH__
  36 #define __UART_HH__
  37
  38 #include "base/range.hh"
  39 #include "dev/io_device.hh"
  40 #include "params/Uart.hh"
  41
  42 class SimConsole;
  43 class Platform;
  44
  45 const int RX_INT = 0x1;
  46 const int TX_INT = 0x2;
  47
  48 class Uart : public BasicPioDevice
  49 {
  50
  51   protected:
  52     int status;
  53     Platform *platform;
  54     SimConsole *cons;
  55
  56   public:
  57     typedef UartParams Params;
  58     Uart(const Params *p);
  59
  60     const Params *
  61     params() const
  62     {
  63         return dynamic_cast<const Params *>(_params);
  64     }
  65
  66     /**
  67      * Inform the uart that there is data available.
  68      */
  69     virtual void dataAvailable() = 0;
  70
  71     /**
  72      * Return if we have an interrupt pending
  73      * @return interrupt status
  74      */
  75     bool intStatus() { return status ? true : false; }
  76 };
  77
  78 #endif // __UART_HH__