gem5  v21.1.0.2
uart.hh
Go to the documentation of this file.
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 
33 #ifndef __UART_HH__
34 #define __UART_HH__
35 
36 #include "base/callback.hh"
37 #include "dev/io_device.hh"
38 #include "dev/serial/serial.hh"
39 #include "params/Uart.hh"
40 
41 namespace gem5
42 {
43 
44 class Platform;
45 
46 const int RX_INT = 0x1;
47 const int TX_INT = 0x2;
48 
49 class Uart : public BasicPioDevice
50 {
51  protected:
52  int status;
55 
56  public:
57  using Params = UartParams;
58  Uart(const Params &p, Addr pio_size);
59 
63  virtual void dataAvailable() = 0;
64 
69  bool intStatus() { return status ? true : false; }
70 };
71 
72 } // namespace gem5
73 
74 #endif // __UART_HH__
gem5::SerialDevice
Base class for serial devices such as terminals.
Definition: serial.hh:94
gem5::scmi::Platform
Definition: scmi_platform.hh:264
gem5::auxv::Platform
@ Platform
Definition: aux_vector.hh:84
io_device.hh
gem5::Uart::intStatus
bool intStatus()
Return if we have an interrupt pending.
Definition: uart.hh:69
gem5::Uart::status
int status
Definition: uart.hh:52
gem5::PioDevice::Params
PioDeviceParams Params
Definition: io_device.hh:134
gem5::RX_INT
const int RX_INT
Definition: uart.hh:46
gem5::Uart
Definition: uart.hh:49
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
serial.hh
gem5::Uart::device
SerialDevice * device
Definition: uart.hh:54
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::Uart::dataAvailable
virtual void dataAvailable()=0
Inform the uart that there is data available.
gem5::Uart::platform
Platform * platform
Definition: uart.hh:53
gem5::Uart::Uart
Uart(const Params &p, Addr pio_size)
Definition: uart.cc:38
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::BasicPioDevice
Definition: io_device.hh:147
callback.hh
gem5::TX_INT
const int TX_INT
Definition: uart.hh:47

Generated on Tue Sep 21 2021 12:25:18 for gem5 by doxygen 1.8.17