io_device.hh revision 2738
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
352384SN/A#include "base/chunk_generator.hh"
362542SN/A#include "mem/mem_object.hh"
372592SN/A#include "mem/packet_impl.hh"
382384SN/A#include "sim/eventq.hh"
392489SN/A#include "sim/sim_object.hh"
40545SN/A
411310SN/Aclass Platform;
422384SN/Aclass PioDevice;
432489SN/Aclass DmaDevice;
442522SN/Aclass System;
45545SN/A
462489SN/A/**
472489SN/A * The PioPort class is a programmed i/o port that all devices that are
482489SN/A * sensitive to an address range use. The port takes all the memory
492489SN/A * access types and roles them into one read() and write() call that the device
502489SN/A * must respond to. The device must also provide the addressRanges() function
512489SN/A * with which it returns the address ranges it is interested in. An extra
522489SN/A * sendTiming() function is implemented which takes an delay. In this way the
532489SN/A * device can immediatly call sendTiming(pkt, time) after processing a request
542489SN/A * and the request will be handled by the port even if the port bus the device
552489SN/A * connects to is blocked.
562489SN/A */
572384SN/Aclass PioPort : public Port
58545SN/A{
59545SN/A  protected:
602489SN/A    /** The device that this port serves. */
612384SN/A    PioDevice *device;
622384SN/A
632489SN/A    /** The platform that device/port are in. This is used to select which mode
642489SN/A     * we are currently operating in. */
652497SN/A    Platform *platform;
662489SN/A
672489SN/A    /** A list of outgoing timing response packets that haven't been serviced
682489SN/A     * yet. */
692489SN/A    std::list<Packet*> transmitList;
702489SN/A
712489SN/A    /** The current status of the peer(bus) that we are connected to. */
722489SN/A    Status peerStatus;
732489SN/A
742630SN/A    virtual bool recvTiming(Packet *pkt);
752384SN/A
762630SN/A    virtual Tick recvAtomic(Packet *pkt);
772384SN/A
782630SN/A    virtual void recvFunctional(Packet *pkt) ;
792384SN/A
802489SN/A    virtual void recvStatusChange(Status status)
812489SN/A    { peerStatus = status; }
822384SN/A
832521SN/A    virtual void getDeviceAddressRanges(AddrRangeList &resp, AddrRangeList &snoop);
842384SN/A
852489SN/A    /**
862489SN/A     * This class is used to implemented sendTiming() with a delay. When a delay
872489SN/A     * is requested a new event is created. When the event time expires it
882489SN/A     * attempts to send the packet. If it cannot, the packet is pushed onto the
892489SN/A     * transmit list to be sent when recvRetry() is called. */
902384SN/A    class SendEvent : public Event
912384SN/A    {
922384SN/A        PioPort *port;
932630SN/A        Packet *packet;
942384SN/A
952630SN/A        SendEvent(PioPort *p, Packet *pkt, Tick t)
962631SN/A            : Event(&mainEventQueue), port(p), packet(pkt)
972384SN/A        { schedule(curTick + t); }
982384SN/A
992384SN/A        virtual void process();
1002384SN/A
1012384SN/A        virtual const char *description()
1022384SN/A        { return "Future scheduled sendTiming event"; }
1032384SN/A
1042384SN/A        friend class PioPort;
1052489SN/A    };
1062489SN/A
1072489SN/A    /** Schedule a sendTiming() event to be called in the future. */
1082630SN/A    void sendTiming(Packet *pkt, Tick time)
1092489SN/A    { new PioPort::SendEvent(this, pkt, time); }
1102489SN/A
1112657Ssaidi@eecs.umich.edu    /** This function is notification that the device should attempt to send a
1122657Ssaidi@eecs.umich.edu     * packet again. */
1132657Ssaidi@eecs.umich.edu    virtual void recvRetry();
1142384SN/A
1152384SN/A  public:
1162489SN/A    PioPort(PioDevice *dev, Platform *p);
1172384SN/A
1182489SN/A  friend class PioPort::SendEvent;
1192384SN/A};
1202384SN/A
1212565SN/A
1222641Sstever@eecs.umich.edustruct DmaReqState : public Packet::SenderState
1232565SN/A{
1242685Ssaidi@eecs.umich.edu    /** Event to call on the device when this transaction (all packets)
1252685Ssaidi@eecs.umich.edu     * complete. */
1262565SN/A    Event *completionEvent;
1272685Ssaidi@eecs.umich.edu
1282685Ssaidi@eecs.umich.edu    /** Where we came from for some sanity checking. */
1292685Ssaidi@eecs.umich.edu    Port *outPort;
1302685Ssaidi@eecs.umich.edu
1312685Ssaidi@eecs.umich.edu    /** Total number of bytes that this transaction involves. */
1322685Ssaidi@eecs.umich.edu    Addr totBytes;
1332685Ssaidi@eecs.umich.edu
1342685Ssaidi@eecs.umich.edu    /** Number of bytes that have been acked for this transaction. */
1352685Ssaidi@eecs.umich.edu    Addr numBytes;
1362685Ssaidi@eecs.umich.edu
1372565SN/A    bool final;
1382685Ssaidi@eecs.umich.edu    DmaReqState(Event *ce, Port *p, Addr tb)
1392685Ssaidi@eecs.umich.edu        : completionEvent(ce), outPort(p), totBytes(tb), numBytes(0)
1402565SN/A    {}
1412565SN/A};
1422565SN/A
1432384SN/Aclass DmaPort : public Port
1442384SN/A{
1452384SN/A  protected:
1462565SN/A    DmaDevice *device;
1472384SN/A    std::list<Packet*> transmitList;
1482384SN/A
1492565SN/A    /** The platform that device/port are in. This is used to select which mode
1502565SN/A     * we are currently operating in. */
1512565SN/A    Platform *platform;
1522565SN/A
1532565SN/A    /** Number of outstanding packets the dma port has. */
1542565SN/A    int pendingCount;
1552384SN/A
1562630SN/A    virtual bool recvTiming(Packet *pkt);
1572630SN/A    virtual Tick recvAtomic(Packet *pkt)
1582384SN/A    { panic("dma port shouldn't be used for pio access."); }
1592630SN/A    virtual void recvFunctional(Packet *pkt)
1602384SN/A    { panic("dma port shouldn't be used for pio access."); }
1612384SN/A
1622384SN/A    virtual void recvStatusChange(Status status)
1632384SN/A    { ; }
1642384SN/A
1652657Ssaidi@eecs.umich.edu    virtual void recvRetry() ;
1662384SN/A
1672521SN/A    virtual void getDeviceAddressRanges(AddrRangeList &resp, AddrRangeList &snoop)
1682521SN/A    { resp.clear(); snoop.clear(); }
1692384SN/A
1702685Ssaidi@eecs.umich.edu    void sendDma(Packet *pkt, bool front = false);
1712489SN/A
1722384SN/A  public:
1732565SN/A    DmaPort(DmaDevice *dev, Platform *p);
1742565SN/A
1752641Sstever@eecs.umich.edu    void dmaAction(Packet::Command cmd, Addr addr, int size, Event *event,
1762641Sstever@eecs.umich.edu                   uint8_t *data = NULL);
1772565SN/A
1782565SN/A    bool dmaPending() { return pendingCount > 0; }
1792384SN/A
1802384SN/A};
1812384SN/A
1822489SN/A/**
1832489SN/A * This device is the base class which all devices senstive to an address range
1842489SN/A * inherit from. There are three pure virtual functions which all devices must
1852489SN/A * implement addressRanges(), read(), and write(). The magic do choose which
1862489SN/A * mode we are in, etc is handled by the PioPort so the device doesn't have to
1872489SN/A * bother.
1882489SN/A */
1892384SN/A
1902542SN/Aclass PioDevice : public MemObject
1912384SN/A{
1922384SN/A  protected:
1932384SN/A
1942489SN/A    /** The platform we are in. This is used to decide what type of memory
1952489SN/A     * transaction we should perform. */
1961310SN/A    Platform *platform;
1972384SN/A
1982489SN/A    /** The pioPort that handles the requests for us and provides us requests
1992489SN/A     * that it sees. */
2002384SN/A    PioPort *pioPort;
2012384SN/A
2022521SN/A    virtual void addressRanges(AddrRangeList &range_list) = 0;
2032384SN/A
2042489SN/A    /** As far as the devices are concerned they only accept atomic transactions
2052489SN/A     * which are converted to either a write or a read. */
2062630SN/A    Tick recvAtomic(Packet *pkt)
2072641Sstever@eecs.umich.edu    { return pkt->isRead() ? this->read(pkt) : this->write(pkt); }
2082384SN/A
2092489SN/A    /** Pure virtual function that the device must implement. Called when a read
2102523SN/A     * command is recieved by the port.
2112523SN/A     * @param pkt Packet describing this request
2122523SN/A     * @return number of ticks it took to complete
2132523SN/A     */
2142630SN/A    virtual Tick read(Packet *pkt) = 0;
2152384SN/A
2162489SN/A    /** Pure virtual function that the device must implement. Called when a
2172523SN/A     * write command is recieved by the port.
2182523SN/A     * @param pkt Packet describing this request
2192523SN/A     * @return number of ticks it took to complete
2202523SN/A     */
2212630SN/A    virtual Tick write(Packet *pkt) = 0;
222545SN/A
223545SN/A  public:
2242512SN/A    /** Params struct which is extended through each device based on the
2252512SN/A     * parameters it needs. Since we are re-writing everything, we might as well
2262512SN/A     * start from the bottom this time. */
2272512SN/A
2282512SN/A    struct Params
2292512SN/A    {
2302512SN/A        std::string name;
2312512SN/A        Platform *platform;
2322522SN/A        System *system;
2332512SN/A    };
2342521SN/A
2352512SN/A  protected:
2362512SN/A    Params *_params;
2372512SN/A
2382512SN/A  public:
2392512SN/A    const Params *params() const { return _params; }
2402512SN/A
2412521SN/A    PioDevice(Params *p)
2422542SN/A              : MemObject(p->name),  platform(p->platform), pioPort(NULL),
2432542SN/A                _params(p)
2442512SN/A              {}
2452384SN/A
246545SN/A    virtual ~PioDevice();
2472384SN/A
2482541SN/A    virtual void init();
2492541SN/A
2502738Sstever@eecs.umich.edu    virtual Port *getPort(const std::string &if_name, int idx = -1)
2512384SN/A    {
2522521SN/A        if (if_name == "pio") {
2532512SN/A            if (pioPort != NULL)
2542512SN/A                panic("pio port already connected to.");
2552512SN/A            pioPort = new PioPort(this, params()->platform);
2562384SN/A            return pioPort;
2572521SN/A        } else
2582384SN/A            return NULL;
2592384SN/A    }
2602489SN/A    friend class PioPort;
2612489SN/A
262545SN/A};
263545SN/A
2642512SN/Aclass BasicPioDevice : public PioDevice
2652512SN/A{
2662512SN/A  public:
2672521SN/A    struct Params :  public PioDevice::Params
2682512SN/A    {
2692512SN/A        Addr pio_addr;
2702512SN/A        Tick pio_delay;
2712512SN/A    };
2722512SN/A
2732512SN/A  protected:
2742512SN/A    /** Address that the device listens to. */
2752512SN/A    Addr pioAddr;
2762512SN/A
2772512SN/A    /** Size that the device's address range. */
2782521SN/A    Addr pioSize;
2792512SN/A
2802512SN/A    /** Delay that the device experinces on an access. */
2812512SN/A    Tick pioDelay;
2822512SN/A
2832512SN/A  public:
2842521SN/A    BasicPioDevice(Params *p)
2852521SN/A        : PioDevice(p), pioAddr(p->pio_addr), pioSize(0), pioDelay(p->pio_delay)
2862512SN/A    {}
2872512SN/A
2882539SN/A    /** return the address ranges that this device responds to.
2892539SN/A     * @params range_list range list to populate with ranges
2902539SN/A     */
2912542SN/A    void addressRanges(AddrRangeList &range_list);
2922539SN/A
2932512SN/A};
2942512SN/A
295545SN/Aclass DmaDevice : public PioDevice
296545SN/A{
297545SN/A  protected:
2982384SN/A    DmaPort *dmaPort;
299545SN/A
300545SN/A  public:
3012521SN/A    DmaDevice(Params *p);
302545SN/A    virtual ~DmaDevice();
3032384SN/A
3042565SN/A    void dmaWrite(Addr addr, int size, Event *event, uint8_t *data)
3052641Sstever@eecs.umich.edu    { dmaPort->dmaAction(Packet::WriteReq, addr, size, event, data) ; }
3062565SN/A
3072565SN/A    void dmaRead(Addr addr, int size, Event *event, uint8_t *data = NULL)
3082641Sstever@eecs.umich.edu    { dmaPort->dmaAction(Packet::ReadReq, addr, size, event, data); }
3092565SN/A
3102565SN/A    bool dmaPending() { return dmaPort->dmaPending(); }
3112565SN/A
3122738Sstever@eecs.umich.edu    virtual Port *getPort(const std::string &if_name, int idx = -1)
3132384SN/A    {
3142565SN/A        if (if_name == "pio") {
3152565SN/A            if (pioPort != NULL)
3162565SN/A                panic("pio port already connected to.");
3172565SN/A            pioPort = new PioPort(this, params()->platform);
3182384SN/A            return pioPort;
3192565SN/A        } else if (if_name == "dma") {
3202565SN/A            if (dmaPort != NULL)
3212565SN/A                panic("dma port already connected to.");
3222565SN/A            dmaPort = new DmaPort(this, params()->platform);
3232384SN/A            return dmaPort;
3242565SN/A        } else
3252384SN/A            return NULL;
3262384SN/A    }
3272489SN/A
3282489SN/A    friend class DmaPort;
329545SN/A};
330545SN/A
3312384SN/A
3321310SN/A#endif // __DEV_IO_DEVICE_HH__
333