gem5  v21.1.0.2
terminal.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 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  * Copyright (c) 2001-2005 The Regents of The University of Michigan
15  * All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions are
19  * met: redistributions of source code must retain the above copyright
20  * notice, this list of conditions and the following disclaimer;
21  * redistributions in binary form must reproduce the above copyright
22  * notice, this list of conditions and the following disclaimer in the
23  * documentation and/or other materials provided with the distribution;
24  * neither the name of the copyright holders nor the names of its
25  * contributors may be used to endorse or promote products derived from
26  * this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 /* @file
42  * User Terminal Interface
43  */
44 
45 #ifndef __DEV_TERMINAL_HH__
46 #define __DEV_TERMINAL_HH__
47 
48 #include <iostream>
49 
50 #include "base/callback.hh"
51 #include "base/circlebuf.hh"
52 #include "base/pollevent.hh"
53 #include "base/socket.hh"
54 #include "dev/serial/serial.hh"
55 #include "params/Terminal.hh"
56 #include "sim/sim_object.hh"
57 
58 namespace gem5
59 {
60 
61 class OutputStream;
62 class TerminalListener;
63 
64 class Terminal : public SerialDevice
65 {
66  protected:
67  class ListenEvent : public PollEvent
68  {
69  protected:
71 
72  public:
73  ListenEvent(Terminal *t, int fd, int e);
74  void process(int revent);
75  };
76 
77  friend class ListenEvent;
79 
80  class DataEvent : public PollEvent
81  {
82  protected:
84 
85  public:
86  DataEvent(Terminal *t, int fd, int e);
87  void process(int revent);
88  };
89 
90  friend class DataEvent;
92 
93  protected:
94  int number;
95  int data_fd;
96 
97  public:
98  typedef TerminalParams Params;
99  Terminal(const Params &p);
100  ~Terminal();
101  OutputStream * terminalDump(const TerminalParams &p);
102 
103  protected:
105 
106  void listen(int port);
107  void accept();
108 
109  protected:
113 #if TRACING_ON == 1
114  CircleBuf<char> linebuf;
115 #endif
116 
117  public:
119  // Terminal Interface
120 
121  void data();
122 
123  void read(uint8_t &c) { read(&c, 1); }
124  size_t read(uint8_t *buf, size_t len);
125  void write(uint8_t c) { write(&c, 1); }
126  size_t write(const uint8_t *buf, size_t len);
127  void detach();
128 
129  public: // SerialDevice interface
130  uint8_t readData() override;
131  void writeData(uint8_t c) override;
132  bool dataAvailable() const override { return !rxbuf.empty(); }
133 
134  public:
136  // OS interface
137 
138  // get a character from the terminal in the console specific format
139  // corresponds to GETC:
140  // retval<63:61>
141  // 000: success: character received
142  // 001: success: character received, more pending
143  // 100: failure: no character ready
144  // 110: failure: character received with error
145  // 111: failure: character received with error, more pending
146  // retval<31:0>
147  // character read from console
148  //
149  // Interrupts are cleared when the buffer is empty.
150  uint64_t console_in();
151 };
152 
153 } // namespace gem5
154 
155 #endif // __DEV_TERMINAL_HH__
gem5::SerialDevice
Base class for serial devices such as terminals.
Definition: serial.hh:94
gem5::Terminal::outfile
OutputStream * outfile
Definition: terminal.hh:112
gem5::Terminal::terminalDump
OutputStream * terminalDump(const TerminalParams &p)
Definition: terminal.cc:146
gem5::Terminal::data
void data()
Definition: terminal.cc:240
socket.hh
gem5::ArmISA::len
Bitfield< 18, 16 > len
Definition: misc_types.hh:444
gem5::Terminal::DataEvent::process
void process(int revent)
Definition: terminal.cc:102
gem5::ArmISA::fd
Bitfield< 14, 12 > fd
Definition: types.hh:150
gem5::Terminal::read
void read(uint8_t &c)
Definition: terminal.hh:123
gem5::Terminal::DataEvent
Definition: terminal.hh:80
circlebuf.hh
gem5::Terminal::Terminal
Terminal(const Params &p)
Definition: terminal.cc:118
gem5::ListenSocket
Definition: socket.hh:35
gem5::ArmISA::e
Bitfield< 9 > e
Definition: misc_types.hh:64
gem5::Terminal::listen
void listen(int port)
Definition: terminal.cc:167
gem5::Terminal::write
void write(uint8_t c)
Definition: terminal.hh:125
gem5::PollEvent
Definition: pollevent.hh:43
gem5::Terminal::txbuf
CircleBuf< char > txbuf
Definition: terminal.hh:110
gem5::Terminal::ListenEvent::term
Terminal * term
Definition: terminal.hh:70
gem5::CircleBuf::empty
bool empty() const
Definition: circlebuf.hh:71
gem5::Terminal::listener
ListenSocket listener
Definition: terminal.hh:104
gem5::Terminal::readData
uint8_t readData() override
Read a character from the device.
Definition: terminal.cc:295
gem5::Terminal::listenEvent
ListenEvent * listenEvent
Definition: terminal.hh:78
sim_object.hh
gem5::Terminal::DataEvent::term
Terminal * term
Definition: terminal.hh:83
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
pollevent.hh
gem5::Terminal
Definition: terminal.hh:64
gem5::Terminal::accept
void accept()
Definition: terminal.cc:189
gem5::CircleBuf< char >
gem5::Terminal::dataEvent
DataEvent * dataEvent
Definition: terminal.hh:91
gem5::Terminal::dataAvailable
bool dataAvailable() const override
Check if there is pending data from the serial device.
Definition: terminal.hh:132
serial.hh
gem5::ArmISA::t
Bitfield< 5 > t
Definition: misc_types.hh:70
gem5::ArmISA::c
Bitfield< 29 > c
Definition: misc_types.hh:53
gem5::Terminal::writeData
void writeData(uint8_t c) override
Transmit a character from the host interface to the device.
Definition: terminal.cc:327
gem5::Terminal::console_in
uint64_t console_in()
Definition: terminal.cc:309
gem5::Terminal::detach
void detach()
Definition: terminal.cc:225
gem5::Terminal::number
int number
Definition: terminal.hh:94
gem5::Terminal::rxbuf
CircleBuf< char > rxbuf
Definition: terminal.hh:111
gem5::Terminal::data_fd
int data_fd
Definition: terminal.hh:95
gem5::Terminal::ListenEvent::process
void process(int revent)
Definition: terminal.cc:88
gem5::Terminal::ListenEvent::ListenEvent
ListenEvent(Terminal *t, int fd, int e)
Definition: terminal.cc:82
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::Terminal::~Terminal
~Terminal()
Definition: terminal.cc:133
gem5::OutputStream
Definition: output.hh:56
gem5::Terminal::Params
TerminalParams Params
Definition: terminal.hh:98
callback.hh
gem5::Terminal::DataEvent::DataEvent
DataEvent(Terminal *t, int fd, int e)
Definition: terminal.cc:96
gem5::Terminal::ListenEvent
Definition: terminal.hh:67

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