device.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2018 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.
 *
 * Copyright (c) 2008 The Regents of The University of Michigan
 * All rights reserved.
 *
 * 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_PS2_DEVICE_HH__
#define __DEV_PS2_DEVICE_HH__
 
#include <cstdint>
#include <deque>
#include <functional>
#include <vector>
 
#include "base/compiler.hh"
#include "sim/sim_object.hh"
 
namespace gem5
{
 
struct PS2DeviceParams;
 
namespace ps2
{
 
class Device : public SimObject
{
  public:
    Device(const PS2DeviceParams &p);
 
    void serialize(CheckpointOut &cp) const override;
    void unserialize(CheckpointIn &cp) override;
 
  public: /* Host interface */
    void hostRegDataAvailable(const std::function<void()> &c);
 
    bool hostDataAvailable() const  { return !outBuffer.empty(); }
 
    uint8_t hostRead();
 
    void hostWrite(uint8_t c);
 
  protected: /* Device interface */
    virtual bool recv(const std::vector<uint8_t> &data) = 0;
 
    void send(const uint8_t *data, size_t size);
    void send(const std::vector<uint8_t> &data) {
        send(data.data(), data.size());
    }
 
    void send(uint8_t data) { send(&data, 1); }
 
    void sendAck();
 
    size_t sendPending() const { return outBuffer.size(); }
 
  private:
    std::deque<uint8_t> outBuffer;
 
    std::vector<uint8_t> inBuffer;
 
    std::function<void()> dataAvailableCallback;
};
 
} // namespace ps2
} // namespace gem5
 
GEM5_DEPRECATED_CLASS(PS2Device, gem5::ps2::Device);
 
#endif // __DEV_PS2_HOUSE_HH__