gem5  v21.1.0.2
console.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef __DEV_VIRTIO_CONSOLE_HH__
39 #define __DEV_VIRTIO_CONSOLE_HH__
40 
41 #include "base/compiler.hh"
42 #include "dev/serial/serial.hh"
43 #include "dev/virtio/base.hh"
44 
45 namespace gem5
46 {
47 
48 struct VirtIOConsoleParams;
49 
69 {
70  public:
71  typedef VirtIOConsoleParams Params;
72  VirtIOConsole(const Params &params);
73  virtual ~VirtIOConsole();
74 
75  void readConfig(PacketPtr pkt, Addr cfgOffset);
76 
77  protected:
84  struct GEM5_PACKED Config
85  {
86  uint16_t cols;
87  uint16_t rows;
88  };
89 
92 
94  static const DeviceId ID_CONSOLE = 0x03;
95 
100  static const FeatureBits F_SIZE = 0x01;
102  static const FeatureBits F_MULTIPORT = 0x02;
106  protected:
111  : public VirtQueue
112  {
113  public:
114  TermRecvQueue(PortProxy &proxy, ByteOrder bo,
115  uint16_t size, VirtIOConsole &_parent)
116  : VirtQueue(proxy, bo, size), parent(_parent) {}
117  virtual ~TermRecvQueue() {}
118 
119  void onNotify() { trySend(); }
120 
122  void trySend();
123 
124  std::string name() const { return parent.name() + ".qRecv"; }
125 
126  protected:
128  };
131 
136  : public VirtQueue
137  {
138  public:
139  TermTransQueue(PortProxy &proxy, ByteOrder bo,
140  uint16_t size, VirtIOConsole &_parent)
141  : VirtQueue(proxy, bo, size), parent(_parent) {}
142  virtual ~TermTransQueue() {}
143 
145 
146  std::string name() const { return parent.name() + ".qTrans"; }
147 
148  protected:
150  };
153 
154  protected:
156 };
157 
158 } // namespace gem5
159 
160 #endif // __DEV_VIRTIO_CONSOLE_HH__
gem5::SerialDevice
Base class for serial devices such as terminals.
Definition: serial.hh:94
gem5::VirtIOConsole::qTrans
TermTransQueue qTrans
Transmit queue for port 0.
Definition: console.hh:152
gem5::VirtIOConsole::Config::cols
uint16_t cols
Definition: console.hh:86
gem5::VirtIOConsole::ID_CONSOLE
static const DeviceId ID_CONSOLE
VirtIO device ID.
Definition: console.hh:94
gem5::VirtIOConsole::TermTransQueue::TermTransQueue
TermTransQueue(PortProxy &proxy, ByteOrder bo, uint16_t size, VirtIOConsole &_parent)
Definition: console.hh:139
gem5::VirtIODeviceBase::DeviceId
uint16_t DeviceId
Device Type (sometimes known as subsystem ID)
Definition: base.hh:599
gem5::VirtIOConsole::TermTransQueue::onNotifyDescriptor
void onNotifyDescriptor(VirtDescriptor *desc)
Notify queue of pending incoming descriptor.
Definition: console.cc:101
gem5::VirtIOConsole::F_SIZE
static const FeatureBits F_SIZE
Provides the size information.
Definition: console.hh:100
gem5::VirtIOConsole::TermTransQueue::~TermTransQueue
virtual ~TermTransQueue()
Definition: console.hh:142
gem5::VirtIOConsole::TermTransQueue
Virtqueue for data going from the guest to the host.
Definition: console.hh:135
gem5::VirtIOConsole::device
SerialDevice & device
Definition: console.hh:155
gem5::VirtIOConsole::readConfig
void readConfig(PacketPtr pkt, Addr cfgOffset)
Read from the configuration space of a device.
Definition: console.cc:67
base.hh
gem5::VirtQueue
Base wrapper around a virtqueue.
Definition: base.hh:302
gem5::VirtIOConsole::Config::rows
uint16_t rows
Definition: console.hh:87
gem5::Named::name
virtual std::string name() const
Definition: named.hh:47
gem5::VirtIOConsole::TermRecvQueue::parent
VirtIOConsole & parent
Definition: console.hh:127
gem5::SimObject::params
const Params & params() const
Definition: sim_object.hh:176
gem5::VirtIOConsole::Params
VirtIOConsoleParams Params
Definition: console.hh:71
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::VirtIOConsole::~VirtIOConsole
virtual ~VirtIOConsole()
Definition: console.cc:63
gem5::PowerISA::bo
Bitfield< 25, 21 > bo
Definition: types.hh:82
gem5::VirtIOConsole
VirtIO console.
Definition: console.hh:68
gem5::PortProxy
This object is a proxy for a port or other object which implements the functional response protocol,...
Definition: port_proxy.hh:86
compiler.hh
gem5::VirtIODeviceBase
Base class for all VirtIO-based devices.
Definition: base.hh:587
serial.hh
gem5::VirtIOConsole::TermTransQueue::name
std::string name() const
Definition: console.hh:146
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::VirtIOConsole::config
Config config
Currently active configuration (host byte order)
Definition: console.hh:91
gem5::VirtIODeviceBase::FeatureBits
uint32_t FeatureBits
Definition: base.hh:591
gem5::VirtIOConsole::TermRecvQueue::trySend
void trySend()
Try to send data pending data from the terminal.
Definition: console.cc:77
gem5::VirtIOConsole::F_MULTIPORT
static const FeatureBits F_MULTIPORT
Supports the multi-port interface.
Definition: console.hh:102
gem5::VirtIOConsole::VirtIOConsole
VirtIOConsole(const Params &params)
Definition: console.cc:47
gem5::VirtIOConsole::TermRecvQueue::onNotify
void onNotify()
Notify queue of pending events.
Definition: console.hh:119
gem5::VirtDescriptor
VirtIO descriptor (chain) wrapper.
Definition: base.hh:117
gem5::VirtIOConsole::TermTransQueue::parent
VirtIOConsole & parent
Definition: console.hh:149
gem5::VirtIOConsole::TermRecvQueue::TermRecvQueue
TermRecvQueue(PortProxy &proxy, ByteOrder bo, uint16_t size, VirtIOConsole &_parent)
Definition: console.hh:114
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::VirtIOConsole::TermRecvQueue::~TermRecvQueue
virtual ~TermRecvQueue()
Definition: console.hh:117
gem5::VirtIOConsole::qRecv
TermRecvQueue qRecv
Receive queue for port 0.
Definition: console.hh:130
gem5::VirtIOConsole::Config
Console configuration structure.
Definition: console.hh:84
gem5::VirtIOConsole::TermRecvQueue::name
std::string name() const
Definition: console.hh:124
gem5::VirtIOConsole::TermRecvQueue
Virtqueue for data going from the host to the guest.
Definition: console.hh:110

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