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/circlebuf.hh"
  42 #include "base/pollevent.hh"
  43 #include "base/socket.hh"
  44 #include "cpu/intr_control.hh"
  45 #include "params/Terminal.hh"
  46 #include "sim/sim_object.hh"
  47
  48 class TerminalListener;
  49 class Uart;
  50
  51 class Terminal : public SimObject
  52 {
  53   public:
  54     Uart *uart;
  55
  56   protected:
  57     class ListenEvent : public PollEvent
  58     {
  59       protected:
  60         Terminal *term;
  61
  62       public:
  63         ListenEvent(Terminal *t, int fd, int e);
  64         void process(int revent);
  65     };
  66
  67     friend class ListenEvent;
  68     ListenEvent *listenEvent;
  69
  70     class DataEvent : public PollEvent
  71     {
  72       protected:
  73         Terminal *term;
  74
  75       public:
  76         DataEvent(Terminal *t, int fd, int e);
  77         void process(int revent);
  78     };
  79
  80     friend class DataEvent;
  81     DataEvent *dataEvent;
  82
  83   protected:
  84     int number;
  85     int data_fd;
  86
  87   public:
  88     typedef TerminalParams Params;
  89     Terminal(const Params *p);
  90     ~Terminal();
  91
  92   protected:
  93     ListenSocket listener;
  94
  95     void listen(int port);
  96     void accept();
  97
  98   protected:
  99     CircleBuf txbuf;
 100     CircleBuf rxbuf;
 101     std::ostream *outfile;
 102 #if TRACING_ON == 1
 103     CircleBuf linebuf;
 104 #endif
 105
 106   public:
 107     ///////////////////////
 108     // Terminal Interface
 109
 110     void data();
 111
 112     void read(uint8_t &c) { read(&c, 1); }
 113     size_t read(uint8_t *buf, size_t len);
 114     void write(uint8_t c) { write(&c, 1); }
 115     size_t write(const uint8_t *buf, size_t len);
 116     void detach();
 117
 118   public:
 119     /////////////////
 120     // OS interface
 121
 122     // Get a character from the terminal.
 123     uint8_t  in();
 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     // Send a character to the terminal
 140     void out(char c);
 141
 142     // Ask the terminal if data is available
 143     bool dataAvailable() { return !rxbuf.empty(); }
 144 };
 145
 146 #endif // __DEV_TERMINAL_HH__