2 * Copyright (c) 2014 ARM Limited
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.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 * Authors: Andreas Sandberg
40 #ifndef __DEV_VIRTIO_CONSOLE_HH__
41 #define __DEV_VIRTIO_CONSOLE_HH__
43 #include "dev/serial/serial.hh"
44 #include "dev/virtio/base.hh"
46 struct VirtIOConsoleParams;
51 * The VirtIO console uses the following queues:
52 * -# Port0 receive (from host to guest)
53 * -# Port0 transmit (from guest to host)
54 * -# Control receive (optional)
55 * -# Control transmit (optional)
56 * -# Port1 receive (optional)
57 * -# Port1 transmit (optional)
59 * This implementation implements the minimum of features for one
60 * port, which means that the multiport feature is not announced and
61 * only queue 0 and 1 are available.
63 * @see https://github.com/rustyrussell/virtio-spec
64 * @see http://docs.oasis-open.org/virtio/virtio/v1.0/virtio-v1.0.html
66 class VirtIOConsole : public VirtIODeviceBase
69 typedef VirtIOConsoleParams Params;
70 VirtIOConsole(Params *params);
71 virtual ~VirtIOConsole();
73 void readConfig(PacketPtr pkt, Addr cfgOffset);
77 * Console configuration structure
79 * @note This needs to be changed if the multiport feature is
87 /** Currently active configuration (host byte order) */
90 /** VirtIO device ID */
91 static const DeviceId ID_CONSOLE = 0x03;
96 /** Provides the size information */
97 static const FeatureBits F_SIZE = 0x01;
98 /** Supports the multi-port interface */
99 static const FeatureBits F_MULTIPORT = 0x02;
105 * Virtqueue for data going from the host to the guest.
111 TermRecvQueue(PortProxy &proxy, ByteOrder bo,
112 uint16_t size, VirtIOConsole &_parent)
113 : VirtQueue(proxy, bo, size), parent(_parent) {}
114 virtual ~TermRecvQueue() {}
116 void onNotify() { trySend(); }
118 /** Try to send data pending data from the terminal. */
121 std::string name() const { return parent.name() + ".qRecv"; }
124 VirtIOConsole &parent;
126 /** Receive queue for port 0 */
130 * Virtqueue for data going from the guest to the host.
136 TermTransQueue(PortProxy &proxy, ByteOrder bo,
137 uint16_t size, VirtIOConsole &_parent)
138 : VirtQueue(proxy, bo, size), parent(_parent) {}
139 virtual ~TermTransQueue() {}
141 void onNotifyDescriptor(VirtDescriptor *desc);
143 std::string name() const { return parent.name() + ".qTrans"; }
146 VirtIOConsole &parent;
148 /** Transmit queue for port 0 */
149 TermTransQueue qTrans;
152 SerialDevice &device;
153 MakeCallback<VirtIOConsole::TermRecvQueue,
154 &VirtIOConsole::TermRecvQueue::trySend> callbackDataAvail;
157 #endif // __DEV_VIRTIO_CONSOLE_HH__