1/*
2 * Copyright (c) 2001-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: Nathan Binkert
29 * Ali Saidi
30 */
31
32/* @file
33 * User Terminal Interface
34 */
35
36#ifndef __DEV_TERMINAL_HH__
37#define __DEV_TERMINAL_HH__
38
39#include <iostream>
40
41#include "base/callback.hh"
42#include "base/circlebuf.hh"
43#include "base/pollevent.hh"
44#include "base/socket.hh"
45#include "dev/serial/serial.hh"
46#include "params/Terminal.hh"
47#include "sim/sim_object.hh"
48
49class OutputStream;
50class TerminalListener;
51
52class Terminal : public SerialDevice
53{
54 protected:
55 class ListenEvent : public PollEvent
56 {
57 protected:
58 Terminal *term;
59
60 public:
61 ListenEvent(Terminal *t, int fd, int e);
62 void process(int revent);
63 };
64
65 friend class ListenEvent;
66 ListenEvent *listenEvent;
67
68 class DataEvent : public PollEvent
69 {
70 protected:
71 Terminal *term;
72
73 public:
74 DataEvent(Terminal *t, int fd, int e);
75 void process(int revent);
76 };
77
78 friend class DataEvent;
79 DataEvent *dataEvent;
80
81 protected:
82 int number;
83 int data_fd;
84
85 public:
86 typedef TerminalParams Params;
87 Terminal(const Params *p);
88 ~Terminal();
89
90 protected:
91 ListenSocket listener;
92
93 void listen(int port);
94 void accept();
95
96 protected:
97 CircleBuf<char> txbuf;
98 CircleBuf<char> rxbuf;
99 OutputStream *outfile;
100#if TRACING_ON == 1
101 CircleBuf<char> linebuf;
102#endif
103
104 public:
105 ///////////////////////
106 // Terminal Interface
107
108 void data();
109
110 void read(uint8_t &c) { read(&c, 1); }
111 size_t read(uint8_t *buf, size_t len);
112 void write(uint8_t c) { write(&c, 1); }
113 size_t write(const uint8_t *buf, size_t len);
114 void detach();
115
116 public: // SerialDevice interface
117 uint8_t readData() override;
118 void writeData(uint8_t c) override;
119 bool dataAvailable() const override { return !rxbuf.empty(); }
120
121 public:
122 /////////////////
123 // OS interface
124
125 // get a character from the terminal in the console specific format
126 // corresponds to GETC:
127 // retval<63:61>
128 // 000: success: character received
129 // 001: success: character received, more pending
130 // 100: failure: no character ready
131 // 110: failure: character received with error
132 // 111: failure: character received with error, more pending
133 // retval<31:0>
134 // character read from console
135 //
136 // Interrupts are cleared when the buffer is empty.
137 uint64_t console_in();
138};
139
140#endif // __DEV_TERMINAL_HH__