src/dev/terminal.hh

   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 "cpu/intr_control.hh"
  46 #include "params/Terminal.hh"
  47 #include "sim/sim_object.hh"
  48
  49 class TerminalListener;
  50
  51 class Terminal : public SimObject
  52 {
  53   public:
  54     /**
  55      * Register a data available callback into the transport layer.
  56      *
  57      * The terminal needs to call the underlying transport layer to
  58      * inform it of available data. The transport layer uses this
  59      * method to register a callback that informs it of pending data.
  60      *
  61      * @param c Callback instance from transport layer.
  62      */
  63     void regDataAvailCallback(Callback *c);
  64
  65   protected:
  66     /** Currently registered transport layer callbacks */
  67     Callback *termDataAvail;
  68
  69   protected:
  70     class ListenEvent : public PollEvent
  71     {
  72       protected:
  73         Terminal *term;
  74
  75       public:
  76         ListenEvent(Terminal *t, int fd, int e);
  77         void process(int revent);
  78     };
  79
  80     friend class ListenEvent;
  81     ListenEvent *listenEvent;
  82
  83     class DataEvent : public PollEvent
  84     {
  85       protected:
  86         Terminal *term;
  87
  88       public:
  89         DataEvent(Terminal *t, int fd, int e);
  90         void process(int revent);
  91     };
  92
  93     friend class DataEvent;
  94     DataEvent *dataEvent;
  95
  96   protected:
  97     int number;
  98     int data_fd;
  99
 100   public:
 101     typedef TerminalParams Params;
 102     Terminal(const Params *p);
 103     ~Terminal();
 104
 105   protected:
 106     ListenSocket listener;
 107
 108     void listen(int port);
 109     void accept();
 110
 111   protected:
 112     CircleBuf txbuf;
 113     CircleBuf rxbuf;
 114     std::ostream *outfile;
 115 #if TRACING_ON == 1
 116     CircleBuf linebuf;
 117 #endif
 118
 119   public:
 120     ///////////////////////
 121     // Terminal Interface
 122
 123     void data();
 124
 125     void read(uint8_t &c) { read(&c, 1); }
 126     size_t read(uint8_t *buf, size_t len);
 127     void write(uint8_t c) { write(&c, 1); }
 128     size_t write(const uint8_t *buf, size_t len);
 129     void detach();
 130
 131   public:
 132     /////////////////
 133     // OS interface
 134
 135     // Get a character from the terminal.
 136     uint8_t  in();
 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     // Send a character to the terminal
 153     void out(char c);
 154
 155     // Ask the terminal if data is available
 156     bool dataAvailable() { return !rxbuf.empty(); }
 157 };
 158
 159 #endif // __DEV_TERMINAL_HH__