gem5  v21.1.0.2
serial.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014, 2017 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 
38 #include "dev/serial/serial.hh"
39 
40 #include "base/logging.hh"
41 #include "params/SerialDevice.hh"
42 #include "params/SerialNullDevice.hh"
43 
44 namespace gem5
45 {
46 
47 SerialDevice::SerialDevice(const SerialDeviceParams &p) : SimObject(p)
48 {
49 }
50 
52 {
53 }
54 
55 void
56 SerialDevice::regInterfaceCallback(const std::function<void()> &callback)
57 {
58  // This can happen if the user has connected multiple UARTs to the
59  // same terminal. In that case, each of them tries to register
60  // callbacks.
62  "A UART has already been associated with this device.");
63  interfaceCallback = callback;
64 }
65 
66 void
68 {
69  assert(dataAvailable());
70  // Registering a callback is optional.
73 }
74 
75 
76 
77 
78 SerialNullDevice::SerialNullDevice(const SerialNullDeviceParams &p)
79  : SerialDevice(p)
80 {
81 }
82 
83 uint8_t
85 {
86  panic("SerialNullDevice does not have pending data.\n");
87 }
88 
89 } // namespace gem5
gem5::SerialDevice
Base class for serial devices such as terminals.
Definition: serial.hh:94
gem5::SerialDevice::SerialDevice
SerialDevice(const SerialDeviceParams &p)
Definition: serial.cc:47
gem5::SerialDevice::interfaceCallback
std::function< void()> interfaceCallback
Currently regisxtered host interface layer callback.
Definition: serial.hh:143
gem5::SerialDevice::dataAvailable
virtual bool dataAvailable() const =0
Check if there is pending data from the serial device.
gem5::SerialNullDevice::readData
uint8_t readData() override
Read a character from the device.
Definition: serial.cc:84
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
serial.hh
gem5::SerialDevice::~SerialDevice
~SerialDevice()
Definition: serial.cc:51
gem5::SerialDevice::regInterfaceCallback
void regInterfaceCallback(const std::function< void()> &callback)
Register a data available callback into the host interface layer.
Definition: serial.cc:56
gem5::SerialDevice::notifyInterface
void notifyInterface()
Notify the host interface of pending data.
Definition: serial.cc:67
logging.hh
fatal_if
#define fatal_if(cond,...)
Conditional fatal macro that checks the supplied condition and only causes a fatal error if the condi...
Definition: logging.hh:225
gem5::SerialNullDevice::SerialNullDevice
SerialNullDevice(const SerialNullDeviceParams &p)
Definition: serial.cc:78
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
panic
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:177

Generated on Tue Sep 21 2021 12:25:18 for gem5 by doxygen 1.8.17