io_device.hh revision 7607
1545SN/A/*
21762SN/A * Copyright (c) 2004-2005 The Regents of The University of Michigan
3545SN/A * All rights reserved.
4545SN/A *
5545SN/A * Redistribution and use in source and binary forms, with or without
6545SN/A * modification, are permitted provided that the following conditions are
7545SN/A * met: redistributions of source code must retain the above copyright
8545SN/A * notice, this list of conditions and the following disclaimer;
9545SN/A * redistributions in binary form must reproduce the above copyright
10545SN/A * notice, this list of conditions and the following disclaimer in the
11545SN/A * documentation and/or other materials provided with the distribution;
12545SN/A * neither the name of the copyright holders nor the names of its
13545SN/A * contributors may be used to endorse or promote products derived from
14545SN/A * this software without specific prior written permission.
15545SN/A *
16545SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17545SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18545SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19545SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20545SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21545SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22545SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23545SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24545SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25545SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26545SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
272665Ssaidi@eecs.umich.edu *
282665Ssaidi@eecs.umich.edu * Authors: Ali Saidi
292665Ssaidi@eecs.umich.edu *          Nathan Binkert
30545SN/A */
31545SN/A
321310SN/A#ifndef __DEV_IO_DEVICE_HH__
331310SN/A#define __DEV_IO_DEVICE_HH__
34545SN/A
355386Sstever@gmail.com#include "base/fast_alloc.hh"
362542SN/A#include "mem/mem_object.hh"
373348Sbinkertn@umich.edu#include "mem/packet.hh"
383348Sbinkertn@umich.edu#include "mem/tport.hh"
394762Snate@binkert.org#include "params/BasicPioDevice.hh"
404762Snate@binkert.org#include "params/DmaDevice.hh"
414762Snate@binkert.org#include "params/PioDevice.hh"
422489SN/A#include "sim/sim_object.hh"
43545SN/A
443090Sstever@eecs.umich.educlass Event;
451310SN/Aclass Platform;
462384SN/Aclass PioDevice;
472489SN/Aclass DmaDevice;
482522SN/Aclass System;
49545SN/A
502489SN/A/**
512489SN/A * The PioPort class is a programmed i/o port that all devices that are
522489SN/A * sensitive to an address range use. The port takes all the memory
532489SN/A * access types and roles them into one read() and write() call that the device
542489SN/A * must respond to. The device must also provide the addressRanges() function
553090Sstever@eecs.umich.edu * with which it returns the address ranges it is interested in.
563090Sstever@eecs.umich.edu */
572914Ssaidi@eecs.umich.educlass PioPort : public SimpleTimingPort
58545SN/A{
59545SN/A  protected:
602489SN/A    /** The device that this port serves. */
612384SN/A    PioDevice *device;
622384SN/A
633349Sbinkertn@umich.edu    virtual Tick recvAtomic(PacketPtr pkt);
642384SN/A
653090Sstever@eecs.umich.edu    virtual void getDeviceAddressRanges(AddrRangeList &resp,
664475Sstever@eecs.umich.edu                                        bool &snoop);
672384SN/A
682384SN/A  public:
693091Sstever@eecs.umich.edu
702901Ssaidi@eecs.umich.edu    PioPort(PioDevice *dev, System *s, std::string pname = "-pioport");
712384SN/A};
722384SN/A
732565SN/A
742384SN/Aclass DmaPort : public Port
752384SN/A{
762384SN/A  protected:
775386Sstever@gmail.com    struct DmaReqState : public Packet::SenderState, public FastAlloc
782784Ssaidi@eecs.umich.edu    {
792784Ssaidi@eecs.umich.edu        /** Event to call on the device when this transaction (all packets)
802784Ssaidi@eecs.umich.edu         * complete. */
812784Ssaidi@eecs.umich.edu        Event *completionEvent;
822784Ssaidi@eecs.umich.edu
832784Ssaidi@eecs.umich.edu        /** Where we came from for some sanity checking. */
842784Ssaidi@eecs.umich.edu        Port *outPort;
852784Ssaidi@eecs.umich.edu
862784Ssaidi@eecs.umich.edu        /** Total number of bytes that this transaction involves. */
872784Ssaidi@eecs.umich.edu        Addr totBytes;
882784Ssaidi@eecs.umich.edu
892784Ssaidi@eecs.umich.edu        /** Number of bytes that have been acked for this transaction. */
902784Ssaidi@eecs.umich.edu        Addr numBytes;
912784Ssaidi@eecs.umich.edu
925534Ssaidi@eecs.umich.edu        /** Amount to delay completion of dma by */
935534Ssaidi@eecs.umich.edu        Tick delay;
945534Ssaidi@eecs.umich.edu
957403SAli.Saidi@ARM.com
965534Ssaidi@eecs.umich.edu        DmaReqState(Event *ce, Port *p, Addr tb, Tick _delay)
975534Ssaidi@eecs.umich.edu            : completionEvent(ce), outPort(p), totBytes(tb), numBytes(0),
985534Ssaidi@eecs.umich.edu              delay(_delay)
992784Ssaidi@eecs.umich.edu        {}
1002784Ssaidi@eecs.umich.edu    };
1012784Ssaidi@eecs.umich.edu
1027403SAli.Saidi@ARM.com    MemObject *device;
1033349Sbinkertn@umich.edu    std::list<PacketPtr> transmitList;
1042384SN/A
1052901Ssaidi@eecs.umich.edu    /** The system that device/port are in. This is used to select which mode
1062565SN/A     * we are currently operating in. */
1072901Ssaidi@eecs.umich.edu    System *sys;
1082565SN/A
1092565SN/A    /** Number of outstanding packets the dma port has. */
1102565SN/A    int pendingCount;
1112384SN/A
1122901Ssaidi@eecs.umich.edu    /** If a dmaAction is in progress. */
1132901Ssaidi@eecs.umich.edu    int actionInProgress;
1142901Ssaidi@eecs.umich.edu
1152901Ssaidi@eecs.umich.edu    /** If we need to drain, keep the drain event around until we're done
1162901Ssaidi@eecs.umich.edu     * here.*/
1172901Ssaidi@eecs.umich.edu    Event *drainEvent;
1182901Ssaidi@eecs.umich.edu
1194435Ssaidi@eecs.umich.edu    /** time to wait between sending another packet, increases as NACKs are
1204435Ssaidi@eecs.umich.edu     * recived, decreases as responses are recived. */
1214435Ssaidi@eecs.umich.edu    Tick backoffTime;
1224435Ssaidi@eecs.umich.edu
1237403SAli.Saidi@ARM.com    /** Minimum time that device should back off for after failed sendTiming */
1247403SAli.Saidi@ARM.com    Tick minBackoffDelay;
1257403SAli.Saidi@ARM.com
1267403SAli.Saidi@ARM.com    /** Maximum time that device should back off for after failed sendTiming */
1277403SAli.Saidi@ARM.com    Tick maxBackoffDelay;
1287403SAli.Saidi@ARM.com
1294435Ssaidi@eecs.umich.edu    /** If the port is currently waiting for a retry before it can send whatever
1304435Ssaidi@eecs.umich.edu     * it is that it's sending. */
1314435Ssaidi@eecs.umich.edu    bool inRetry;
1324435Ssaidi@eecs.umich.edu
1333349Sbinkertn@umich.edu    virtual bool recvTiming(PacketPtr pkt);
1343349Sbinkertn@umich.edu    virtual Tick recvAtomic(PacketPtr pkt)
1353918Ssaidi@eecs.umich.edu    { panic("dma port shouldn't be used for pio access."); M5_DUMMY_RETURN }
1363349Sbinkertn@umich.edu    virtual void recvFunctional(PacketPtr pkt)
1372384SN/A    { panic("dma port shouldn't be used for pio access."); }
1382384SN/A
1392384SN/A    virtual void recvStatusChange(Status status)
1402384SN/A    { ; }
1412384SN/A
1422657Ssaidi@eecs.umich.edu    virtual void recvRetry() ;
1432384SN/A
1443090Sstever@eecs.umich.edu    virtual void getDeviceAddressRanges(AddrRangeList &resp,
1454475Sstever@eecs.umich.edu                                        bool &snoop)
1464475Sstever@eecs.umich.edu    { resp.clear(); snoop = false; }
1472384SN/A
1484435Ssaidi@eecs.umich.edu    void queueDma(PacketPtr pkt, bool front = false);
1494435Ssaidi@eecs.umich.edu    void sendDma();
1504435Ssaidi@eecs.umich.edu
1514435Ssaidi@eecs.umich.edu    /** event to give us a kick every time we backoff time is reached. */
1524435Ssaidi@eecs.umich.edu    EventWrapper<DmaPort, &DmaPort::sendDma> backoffEvent;
1532489SN/A
1542384SN/A  public:
1557403SAli.Saidi@ARM.com    DmaPort(MemObject *dev, System *s, Tick min_backoff, Tick max_backoff);
1562565SN/A
1572641Sstever@eecs.umich.edu    void dmaAction(Packet::Command cmd, Addr addr, int size, Event *event,
1587607SGene.Wu@arm.com                   uint8_t *data, Tick delay, Request::Flags flag = 0);
1592565SN/A
1602565SN/A    bool dmaPending() { return pendingCount > 0; }
1612384SN/A
1626227Snate@binkert.org    unsigned cacheBlockSize() const { return peerBlockSize(); }
1632901Ssaidi@eecs.umich.edu    unsigned int drain(Event *de);
1642384SN/A};
1652384SN/A
1662489SN/A/**
1672489SN/A * This device is the base class which all devices senstive to an address range
1682489SN/A * inherit from. There are three pure virtual functions which all devices must
1692489SN/A * implement addressRanges(), read(), and write(). The magic do choose which
1702489SN/A * mode we are in, etc is handled by the PioPort so the device doesn't have to
1712489SN/A * bother.
1722489SN/A */
1732542SN/Aclass PioDevice : public MemObject
1742384SN/A{
1752384SN/A  protected:
1762384SN/A
1772489SN/A    /** The platform we are in. This is used to decide what type of memory
1782489SN/A     * transaction we should perform. */
1791310SN/A    Platform *platform;
1802384SN/A
1812901Ssaidi@eecs.umich.edu    System *sys;
1822901Ssaidi@eecs.umich.edu
1832489SN/A    /** The pioPort that handles the requests for us and provides us requests
1842489SN/A     * that it sees. */
1852384SN/A    PioPort *pioPort;
1862384SN/A
1872521SN/A    virtual void addressRanges(AddrRangeList &range_list) = 0;
1882384SN/A
1893090Sstever@eecs.umich.edu    /** Pure virtual function that the device must implement. Called
1903090Sstever@eecs.umich.edu     * when a read command is recieved by the port.
1912523SN/A     * @param pkt Packet describing this request
1922523SN/A     * @return number of ticks it took to complete
1932523SN/A     */
1943349Sbinkertn@umich.edu    virtual Tick read(PacketPtr pkt) = 0;
1952384SN/A
1962489SN/A    /** Pure virtual function that the device must implement. Called when a
1972523SN/A     * write command is recieved by the port.
1982523SN/A     * @param pkt Packet describing this request
1992523SN/A     * @return number of ticks it took to complete
2002523SN/A     */
2013349Sbinkertn@umich.edu    virtual Tick write(PacketPtr pkt) = 0;
202545SN/A
203545SN/A  public:
2044762Snate@binkert.org    typedef PioDeviceParams Params;
2054762Snate@binkert.org    PioDevice(const Params *p);
2064762Snate@binkert.org    virtual ~PioDevice();
2074762Snate@binkert.org
2084762Snate@binkert.org    const Params *
2094762Snate@binkert.org    params() const
2102512SN/A    {
2114762Snate@binkert.org        return dynamic_cast<const Params *>(_params);
2124762Snate@binkert.org    }
2132384SN/A
2142541SN/A    virtual void init();
2152541SN/A
2162901Ssaidi@eecs.umich.edu    virtual unsigned int drain(Event *de);
2172901Ssaidi@eecs.umich.edu
2182738Sstever@eecs.umich.edu    virtual Port *getPort(const std::string &if_name, int idx = -1)
2192384SN/A    {
2202521SN/A        if (if_name == "pio") {
2212512SN/A            if (pioPort != NULL)
2225578SSteve.Reinhardt@amd.com                fatal("%s: pio port already connected to %s",
2235578SSteve.Reinhardt@amd.com                      name(), pioPort->getPeer()->name());
2242901Ssaidi@eecs.umich.edu            pioPort = new PioPort(this, sys);
2252384SN/A            return pioPort;
2262521SN/A        } else
2272384SN/A            return NULL;
2282384SN/A    }
2292489SN/A    friend class PioPort;
2302489SN/A
231545SN/A};
232545SN/A
2332512SN/Aclass BasicPioDevice : public PioDevice
2342512SN/A{
2352512SN/A  protected:
2362512SN/A    /** Address that the device listens to. */
2372512SN/A    Addr pioAddr;
2382512SN/A
2392512SN/A    /** Size that the device's address range. */
2402521SN/A    Addr pioSize;
2412512SN/A
2422512SN/A    /** Delay that the device experinces on an access. */
2432512SN/A    Tick pioDelay;
2442512SN/A
2452512SN/A  public:
2464762Snate@binkert.org    typedef BasicPioDeviceParams Params;
2474762Snate@binkert.org    BasicPioDevice(const Params *p);
2484762Snate@binkert.org
2494762Snate@binkert.org    const Params *
2504762Snate@binkert.org    params() const
2514762Snate@binkert.org    {
2524762Snate@binkert.org        return dynamic_cast<const Params *>(_params);
2534762Snate@binkert.org    }
2542512SN/A
2552539SN/A    /** return the address ranges that this device responds to.
2562982Sstever@eecs.umich.edu     * @param range_list range list to populate with ranges
2572539SN/A     */
2582542SN/A    void addressRanges(AddrRangeList &range_list);
2592539SN/A
2602512SN/A};
2612512SN/A
262545SN/Aclass DmaDevice : public PioDevice
263545SN/A{
2644435Ssaidi@eecs.umich.edu   protected:
2652384SN/A    DmaPort *dmaPort;
266545SN/A
267545SN/A  public:
2684762Snate@binkert.org    typedef DmaDeviceParams Params;
2694762Snate@binkert.org    DmaDevice(const Params *p);
270545SN/A    virtual ~DmaDevice();
2712384SN/A
2724762Snate@binkert.org    const Params *
2734762Snate@binkert.org    params() const
2744762Snate@binkert.org    {
2754762Snate@binkert.org        return dynamic_cast<const Params *>(_params);
2764762Snate@binkert.org    }
2774762Snate@binkert.org
2785534Ssaidi@eecs.umich.edu    void dmaWrite(Addr addr, int size, Event *event, uint8_t *data, Tick delay = 0)
2794022Sstever@eecs.umich.edu    {
2805534Ssaidi@eecs.umich.edu        dmaPort->dmaAction(MemCmd::WriteReq, addr, size, event, data, delay);
2814022Sstever@eecs.umich.edu    }
2822565SN/A
2835534Ssaidi@eecs.umich.edu    void dmaRead(Addr addr, int size, Event *event, uint8_t *data, Tick delay = 0)
2844263Ssaidi@eecs.umich.edu    {
2855534Ssaidi@eecs.umich.edu        dmaPort->dmaAction(MemCmd::ReadReq, addr, size, event, data, delay);
2864263Ssaidi@eecs.umich.edu    }
2872565SN/A
2882565SN/A    bool dmaPending() { return dmaPort->dmaPending(); }
2892565SN/A
2902901Ssaidi@eecs.umich.edu    virtual unsigned int drain(Event *de);
2912901Ssaidi@eecs.umich.edu
2926227Snate@binkert.org    unsigned cacheBlockSize() const { return dmaPort->cacheBlockSize(); }
2934263Ssaidi@eecs.umich.edu
2942738Sstever@eecs.umich.edu    virtual Port *getPort(const std::string &if_name, int idx = -1)
2952384SN/A    {
2962565SN/A        if (if_name == "pio") {
2972565SN/A            if (pioPort != NULL)
2985578SSteve.Reinhardt@amd.com                fatal("%s: pio port already connected to %s",
2995578SSteve.Reinhardt@amd.com                      name(), pioPort->getPeer()->name());
3002901Ssaidi@eecs.umich.edu            pioPort = new PioPort(this, sys);
3012384SN/A            return pioPort;
3022565SN/A        } else if (if_name == "dma") {
3032565SN/A            if (dmaPort != NULL)
3045578SSteve.Reinhardt@amd.com                fatal("%s: dma port already connected to %s",
3055732SSteve.Reinhardt@amd.com                      name(), dmaPort->getPeer()->name());
3067403SAli.Saidi@ARM.com            dmaPort = new DmaPort(this, sys, params()->min_backoff_delay,
3077403SAli.Saidi@ARM.com                    params()->max_backoff_delay);
3082384SN/A            return dmaPort;
3092565SN/A        } else
3102384SN/A            return NULL;
3112384SN/A    }
3122489SN/A
3132489SN/A    friend class DmaPort;
314545SN/A};
315545SN/A
3162384SN/A
3171310SN/A#endif // __DEV_IO_DEVICE_HH__
318