serial.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2014, 2017 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __DEV_SERIAL_HH__
#define __DEV_SERIAL_HH__
 
#include <functional>
 
#include "sim/sim_object.hh"
 
namespace gem5
{
 
struct SerialDeviceParams;
struct SerialNullDeviceParams;

class SerialDevice : public SimObject
{
  public:
    SerialDevice(const SerialDeviceParams &p);
    ~SerialDevice();
 
  public: // Serial device API (UART->Device)
    void regInterfaceCallback(const std::function<void()> &callback);

    virtual bool dataAvailable() const = 0;

    virtual void writeData(uint8_t c) = 0;

    virtual uint8_t readData() = 0;
 
  protected:
    void notifyInterface();
 
  private:
    std::function<void()> interfaceCallback;
};

class SerialNullDevice : public SerialDevice
{
  public:
    SerialNullDevice(const SerialNullDeviceParams &p);
 
  public:
    bool dataAvailable() const override { return false; }
    void writeData(uint8_t c) override {};
    uint8_t readData() override;
};
 
} // namespace gem5
 
#endif // __DEV_SERIAL_HH__