src/dev/serial/terminal.hh

   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 class OutputStream;
  59 class TerminalListener;
  60
  61 class Terminal : public SerialDevice
  62 {
  63   protected:
  64     class ListenEvent : public PollEvent
  65     {
  66       protected:
  67         Terminal *term;
  68
  69       public:
  70         ListenEvent(Terminal *t, int fd, int e);
  71         void process(int revent);
  72     };
  73
  74     friend class ListenEvent;
  75     ListenEvent *listenEvent;
  76
  77     class DataEvent : public PollEvent
  78     {
  79       protected:
  80         Terminal *term;
  81
  82       public:
  83         DataEvent(Terminal *t, int fd, int e);
  84         void process(int revent);
  85     };
  86
  87     friend class DataEvent;
  88     DataEvent *dataEvent;
  89
  90   protected:
  91     int number;
  92     int data_fd;
  93
  94   public:
  95     typedef TerminalParams Params;
  96     Terminal(const Params *p);
  97     ~Terminal();
  98     OutputStream * terminalDump(const TerminalParams* p);
  99
 100   protected:
 101     ListenSocket listener;
 102
 103     void listen(int port);
 104     void accept();
 105
 106   protected:
 107     CircleBuf<char> txbuf;
 108     CircleBuf<char> rxbuf;
 109     OutputStream *outfile;
 110 #if TRACING_ON == 1
 111     CircleBuf<char> linebuf;
 112 #endif
 113
 114   public:
 115     ///////////////////////
 116     // Terminal Interface
 117
 118     void data();
 119
 120     void read(uint8_t &c) { read(&c, 1); }
 121     size_t read(uint8_t *buf, size_t len);
 122     void write(uint8_t c) { write(&c, 1); }
 123     size_t write(const uint8_t *buf, size_t len);
 124     void detach();
 125
 126   public: // SerialDevice interface
 127     uint8_t readData() override;
 128     void writeData(uint8_t c) override;
 129     bool dataAvailable() const override { return !rxbuf.empty(); }
 130
 131   public:
 132     /////////////////
 133     // OS interface
 134
 135     // get a character from the terminal in the console specific format
 136     // corresponds to GETC:
 137     // retval<63:61>
 138     //     000: success: character received
 139     //     001: success: character received, more pending
 140     //     100: failure: no character ready
 141     //     110: failure: character received with error
 142     //     111: failure: character received with error, more pending
 143     // retval<31:0>
 144     //     character read from console
 145     //
 146     // Interrupts are cleared when the buffer is empty.
 147     uint64_t console_in();
 148 };
 149
 150 #endif // __DEV_TERMINAL_HH__