console.cc 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#include "dev/virtio/console.hh"
41
42#include "debug/VIOConsole.hh"
43#include "params/VirtIOConsole.hh"
44#include "sim/system.hh"
45
46VirtIOConsole::VirtIOConsole(Params *params)
47    : VirtIODeviceBase(params, ID_CONSOLE, sizeof(Config), F_SIZE),
48      qRecv(params->system->physProxy, params->qRecvSize, *this),
49      qTrans(params->system->physProxy, params->qTransSize, *this),
50      device(*params->device), callbackDataAvail(qRecv)
51{
52    registerQueue(qRecv);
53    registerQueue(qTrans);
54
55    config.cols = 80;
56    config.rows = 24;
57
58    device.regInterfaceCallback(&callbackDataAvail);
59}
60
61
62VirtIOConsole::~VirtIOConsole()
63{
64}
65void
66VirtIOConsole::readConfig(PacketPtr pkt, Addr cfgOffset)
67{
68    Config cfg_out;
69    cfg_out.rows = htov_legacy(config.rows);
70    cfg_out.cols = htov_legacy(config.cols);
71
72    readConfigBlob(pkt, cfgOffset, (uint8_t *)&cfg_out);
73}
74
75void
76VirtIOConsole::TermRecvQueue::trySend()
77{
78    DPRINTF(VIOConsole, "trySend\n");
79
80    // Send data as long as the terminal has outgoing data and we can
81    // get free descriptors (i.e., there are buffers available to
82    // send) from the guest.
83    VirtDescriptor *d;
84    while (parent.device.dataAvailable() && (d = consumeDescriptor())) {
85        DPRINTF(VIOConsole, "Got descriptor (len: %i)\n", d->size());
86        size_t len(0);
87        while (parent.device.dataAvailable() && len < d->size()) {
88            uint8_t in(parent.device.readData());
89            d->chainWrite(len, &in, sizeof(uint8_t));
90            ++len;
91        }
92
93        // Tell the guest that we are done with this descriptor.
94        produceDescriptor(d, len);
95        parent.kick();
96    }
97}
98
99void
100VirtIOConsole::TermTransQueue::onNotifyDescriptor(VirtDescriptor *desc)
101{
102    DPRINTF(VIOConsole, "Got input data descriptor (len: %i)\n",
103            desc->size());
104
105    // Copy the data from the guest and forward it to the
106    // terminal.
107    const size_t size(desc->chainSize());
108    uint8_t data[size];
109    desc->chainRead(0, data, size);
110    for (int i = 0; i < desc->size(); ++i)
111        parent.device.writeData(data[i]);
112
113    // Tell the guest that we are done with this descriptor.
114    produceDescriptor(desc, 0);
115    parent.kick();
116}
117
118VirtIOConsole *
119VirtIOConsoleParams::create()
120{
121    return new VirtIOConsole(this);
122}
123