src/dev/serial/serial.cc

   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
  48 SerialDevice::~SerialDevice()
  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.
  58     fatal_if(interfaceCallback,
  59              "A UART has already been associated with this device.");
  60     interfaceCallback = callback;
  61 }
  62
  63 void
  64 SerialDevice::notifyInterface()
  65 {
  66     assert(dataAvailable());
  67     // Registering a callback is optional.
  68     if (interfaceCallback)
  69         interfaceCallback();
  70 }
  71
  72
  73
  74
  75 SerialNullDevice::SerialNullDevice(const SerialNullDeviceParams &p)
  76     : SerialDevice(p)
  77 {
  78 }
  79
  80 uint8_t
  81 SerialNullDevice::readData()
  82 {
  83     panic("SerialNullDevice does not have pending data.\n");
  84 }
  85
  86
  87
  88 SerialNullDevice *
  89 SerialNullDeviceParams::create() const
  90 {
  91     return new SerialNullDevice(*this);
  92 }