2 * Copyright (c) 2001-2005 The Regents of The University of Michigan
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.
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.
28 * Authors: Nathan Binkert
33 * User Terminal Interface
36 #ifndef __DEV_TERMINAL_HH__
37 #define __DEV_TERMINAL_HH__
41 #include "base/callback.hh"
42 #include "base/circlebuf.hh"
43 #include "base/pollevent.hh"
44 #include "base/socket.hh"
45 #include "cpu/intr_control.hh"
46 #include "params/Terminal.hh"
47 #include "sim/sim_object.hh"
50 class TerminalListener;
52 class Terminal : public SimObject
56 * Register a data available callback into the transport layer.
58 * The terminal needs to call the underlying transport layer to
59 * inform it of available data. The transport layer uses this
60 * method to register a callback that informs it of pending data.
62 * @param c Callback instance from transport layer.
64 void regDataAvailCallback(Callback *c);
67 /** Currently registered transport layer callbacks */
68 Callback *termDataAvail;
71 class ListenEvent : public PollEvent
77 ListenEvent(Terminal *t, int fd, int e);
78 void process(int revent);
81 friend class ListenEvent;
82 ListenEvent *listenEvent;
84 class DataEvent : public PollEvent
90 DataEvent(Terminal *t, int fd, int e);
91 void process(int revent);
94 friend class DataEvent;
102 typedef TerminalParams Params;
103 Terminal(const Params *p);
107 ListenSocket listener;
109 void listen(int port);
113 CircleBuf<char> txbuf;
114 CircleBuf<char> rxbuf;
115 OutputStream *outfile;
117 CircleBuf<char> linebuf;
121 ///////////////////////
122 // Terminal Interface
126 void read(uint8_t &c) { read(&c, 1); }
127 size_t read(uint8_t *buf, size_t len);
128 void write(uint8_t c) { write(&c, 1); }
129 size_t write(const uint8_t *buf, size_t len);
136 // Get a character from the terminal.
139 // get a character from the terminal in the console specific format
140 // corresponds to GETC:
142 // 000: success: character received
143 // 001: success: character received, more pending
144 // 100: failure: no character ready
145 // 110: failure: character received with error
146 // 111: failure: character received with error, more pending
148 // character read from console
150 // Interrupts are cleared when the buffer is empty.
151 uint64_t console_in();
153 // Send a character to the terminal
156 // Ask the terminal if data is available
157 bool dataAvailable() { return !rxbuf.empty(); }
160 #endif // __DEV_TERMINAL_HH__