gem5  v20.1.0.0
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 SerialDevice::SerialDevice(const SerialDeviceParams *p) : SimObject(p)
45 {
46 }
47 
49 {
50 }
51 
52 void
53 SerialDevice::regInterfaceCallback(const std::function<void()> &callback)
54 {
55  // This can happen if the user has connected multiple UARTs to the
56  // same terminal. In that case, each of them tries to register
57  // callbacks.
59  "A UART has already been associated with this device.");
60  interfaceCallback = callback;
61 }
62 
63 void
65 {
66  assert(dataAvailable());
67  // Registering a callback is optional.
70 }
71 
72 
73 
74 
75 SerialNullDevice::SerialNullDevice(const SerialNullDeviceParams *p)
76  : SerialDevice(p)
77 {
78 }
79 
80 uint8_t
82 {
83  panic("SerialNullDevice does not have pending data.\n");
84 }
85 
86 
87 
89 SerialNullDeviceParams::create()
90 {
91  return new SerialNullDevice(this);
92 }
SerialDevice::~SerialDevice
~SerialDevice()
Definition: serial.cc:48
SerialNullDevice::SerialNullDevice
SerialNullDevice(const SerialNullDeviceParams *p)
Definition: serial.cc:75
SerialDevice::regInterfaceCallback
void regInterfaceCallback(const std::function< void()> &callback)
Register a data available callback into the host interface layer.
Definition: serial.cc:53
SerialDevice::dataAvailable
virtual bool dataAvailable() const =0
Check if there is pending data from the serial device.
serial.hh
SerialDevice::SerialDevice
SerialDevice(const SerialDeviceParams *p)
Definition: serial.cc:44
SerialDevice::notifyInterface
void notifyInterface()
Notify the host interface of pending data.
Definition: serial.cc:64
SerialNullDevice::readData
uint8_t readData() override
Read a character from the device.
Definition: serial.cc:81
SerialDevice
Base class for serial devices such as terminals.
Definition: serial.hh:91
SerialDevice::interfaceCallback
std::function< void()> interfaceCallback
Currently regisxtered host interface layer callback.
Definition: serial.hh:140
SerialNullDevice
Dummy serial device that discards all data sent to it.
Definition: serial.hh:146
logging.hh
MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:323
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:219
panic
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:171
SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:92

Generated on Wed Sep 30 2020 14:02:11 for gem5 by doxygen 1.8.17