terminal.hh revision 14249 
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 * Authors: Nathan Binkert
41 *          Ali Saidi
42 */
43
44/* @file
45 * User Terminal Interface
46 */
47
48#ifndef __DEV_TERMINAL_HH__
49#define __DEV_TERMINAL_HH__
50
51#include <iostream>
52
53#include "base/callback.hh"
54#include "base/circlebuf.hh"
55#include "base/pollevent.hh"
56#include "base/socket.hh"
57#include "dev/serial/serial.hh"
58#include "params/Terminal.hh"
59#include "sim/sim_object.hh"
60
61class OutputStream;
62class TerminalListener;
63
64class Terminal : public SerialDevice
65{
66  protected:
67    class ListenEvent : public PollEvent
68    {
69      protected:
70        Terminal *term;
71
72      public:
73        ListenEvent(Terminal *t, int fd, int e);
74        void process(int revent);
75    };
76
77    friend class ListenEvent;
78    ListenEvent *listenEvent;
79
80    class DataEvent : public PollEvent
81    {
82      protected:
83        Terminal *term;
84
85      public:
86        DataEvent(Terminal *t, int fd, int e);
87        void process(int revent);
88    };
89
90    friend class DataEvent;
91    DataEvent *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:
104    ListenSocket listener;
105
106    void listen(int port);
107    void accept();
108
109  protected:
110    CircleBuf<char> txbuf;
111    CircleBuf<char> rxbuf;
112    OutputStream *outfile;
113#if TRACING_ON == 1
114    CircleBuf<char> linebuf;
115#endif
116
117  public:
118    ///////////////////////
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:
135    /////////////////
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#endif // __DEV_TERMINAL_HH__
154