console.hh revision 12237 
1/*
2 * Copyright (c) 2014 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 * 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.
24 *
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.
36 *
37 * Authors: Andreas Sandberg
38 */
39
40#ifndef __DEV_VIRTIO_CONSOLE_HH__
41#define __DEV_VIRTIO_CONSOLE_HH__
42
43#include "dev/serial.hh"
44#include "dev/virtio/base.hh"
45
46struct VirtIOConsoleParams;
47
48/**
49 * VirtIO console
50 *
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)
58 *
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.
62 *
63 * @see https://github.com/rustyrussell/virtio-spec
64 * @see http://docs.oasis-open.org/virtio/virtio/v1.0/virtio-v1.0.html
65 */
66class VirtIOConsole : public VirtIODeviceBase
67{
68  public:
69    typedef VirtIOConsoleParams Params;
70    VirtIOConsole(Params *params);
71    virtual ~VirtIOConsole();
72
73    void readConfig(PacketPtr pkt, Addr cfgOffset);
74
75  protected:
76    /**
77     * Console configuration structure
78     *
79     * @note This needs to be changed if the multiport feature is
80     * announced!
81     */
82    struct Config {
83        uint16_t cols;
84        uint16_t rows;
85    } M5_ATTR_PACKED;
86
87    /** Currently active configuration (host byte order) */
88    Config config;
89
90    /** VirtIO device ID */
91    static const DeviceId ID_CONSOLE = 0x03;
92
93    /** @{
94     * @name Feature bits
95     */
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;
100    /** @} */
101
102
103  protected:
104    /**
105     * Virtqueue for data going from the host to the guest.
106     */
107    class TermRecvQueue
108        : public VirtQueue
109    {
110      public:
111        TermRecvQueue(PortProxy &proxy, uint16_t size, VirtIOConsole &_parent)
112            : VirtQueue(proxy, size), parent(_parent) {}
113        virtual ~TermRecvQueue() {}
114
115        void onNotify() { trySend(); }
116
117        /** Try to send data pending data from the terminal. */
118        void trySend();
119
120        std::string name() const { return parent.name() + ".qRecv"; }
121
122      protected:
123        VirtIOConsole &parent;
124    };
125    /** Receive queue for port 0 */
126    TermRecvQueue qRecv;
127
128    /**
129     * Virtqueue for data going from the guest to the host.
130     */
131    class TermTransQueue
132        : public VirtQueue
133    {
134      public:
135        TermTransQueue(PortProxy &proxy, uint16_t size, VirtIOConsole &_parent)
136            : VirtQueue(proxy, size), parent(_parent) {}
137        virtual ~TermTransQueue() {}
138
139        void onNotifyDescriptor(VirtDescriptor *desc);
140
141        std::string name() const { return parent.name() + ".qTrans"; }
142
143      protected:
144        VirtIOConsole &parent;
145    };
146    /** Transmit queue for port 0 */
147    TermTransQueue qTrans;
148
149  protected:
150    SerialDevice &device;
151    MakeCallback<VirtIOConsole::TermRecvQueue,
152                 &VirtIOConsole::TermRecvQueue::trySend> callbackDataAvail;
153};
154
155#endif // __DEV_VIRTIO_CONSOLE_HH__
156