1/*
2 * Copyright (c) 2012 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 * Copyright (c) 2004-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Ali Saidi
41 * Nathan Binkert
42 */
43
44#ifndef __DEV_IO_DEVICE_HH__
45#define __DEV_IO_DEVICE_HH__
46
47#include "mem/mem_object.hh"
48#include "mem/tport.hh"
49#include "params/BasicPioDevice.hh"
50#include "params/PioDevice.hh"
51
52class PioDevice;
53class System;
54
55/**
56 * The PioPort class is a programmed i/o port that all devices that are
57 * sensitive to an address range use. The port takes all the memory
58 * access types and roles them into one read() and write() call that the device
59 * must respond to. The device must also provide getAddrRanges() function
60 * with which it returns the address ranges it is interested in.
61 */
62class PioPort : public SimpleTimingPort
63{
64 protected:
65 /** The device that this port serves. */
66 PioDevice *device;
67
68 virtual Tick recvAtomic(PacketPtr pkt);
69
70 virtual AddrRangeList getAddrRanges() const;
71
72 public:
73
74 PioPort(PioDevice *dev);
75};
76
77/**
78 * This device is the base class which all devices senstive to an address range
79 * inherit from. There are three pure virtual functions which all devices must
80 * implement getAddrRanges(), read(), and write(). The magic do choose which
81 * mode we are in, etc is handled by the PioPort so the device doesn't have to
82 * bother.
83 */
84class PioDevice : public MemObject
85{
86 protected:
87 System *sys;
88
89 /** The pioPort that handles the requests for us and provides us requests
90 * that it sees. */
91 PioPort pioPort;
92
93 /**
94 * Every PIO device is obliged to provide an implementation that
95 * returns the address ranges the device responds to.
96 *
97 * @return a list of non-overlapping address ranges
98 */
99 virtual AddrRangeList getAddrRanges() const = 0;
100
101 /** Pure virtual function that the device must implement. Called
102 * when a read command is recieved by the port.
103 * @param pkt Packet describing this request
104 * @return number of ticks it took to complete
105 */
106 virtual Tick read(PacketPtr pkt) = 0;
107
108 /** Pure virtual function that the device must implement. Called when a
109 * write command is recieved by the port.
110 * @param pkt Packet describing this request
111 * @return number of ticks it took to complete
112 */
113 virtual Tick write(PacketPtr pkt) = 0;
114
115 public:
116 typedef PioDeviceParams Params;
117 PioDevice(const Params *p);
118 virtual ~PioDevice();
119
120 const Params *
121 params() const
122 {
123 return dynamic_cast<const Params *>(_params);
124 }
125
126 virtual void init();
127
128 unsigned int drain(DrainManager *drainManger);
129
130 virtual BaseSlavePort &getSlavePort(const std::string &if_name,
131 PortID idx = InvalidPortID);
132
133 friend class PioPort;
134
135};
136
137class BasicPioDevice : public PioDevice
138{
139 protected:
140 /** Address that the device listens to. */
141 Addr pioAddr;
142
143 /** Size that the device's address range. */
144 Addr pioSize;
145
146 /** Delay that the device experinces on an access. */
147 Tick pioDelay;
148
149 public:
150 typedef BasicPioDeviceParams Params;
| 1/*
2 * Copyright (c) 2012 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 * Copyright (c) 2004-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Ali Saidi
41 * Nathan Binkert
42 */
43
44#ifndef __DEV_IO_DEVICE_HH__
45#define __DEV_IO_DEVICE_HH__
46
47#include "mem/mem_object.hh"
48#include "mem/tport.hh"
49#include "params/BasicPioDevice.hh"
50#include "params/PioDevice.hh"
51
52class PioDevice;
53class System;
54
55/**
56 * The PioPort class is a programmed i/o port that all devices that are
57 * sensitive to an address range use. The port takes all the memory
58 * access types and roles them into one read() and write() call that the device
59 * must respond to. The device must also provide getAddrRanges() function
60 * with which it returns the address ranges it is interested in.
61 */
62class PioPort : public SimpleTimingPort
63{
64 protected:
65 /** The device that this port serves. */
66 PioDevice *device;
67
68 virtual Tick recvAtomic(PacketPtr pkt);
69
70 virtual AddrRangeList getAddrRanges() const;
71
72 public:
73
74 PioPort(PioDevice *dev);
75};
76
77/**
78 * This device is the base class which all devices senstive to an address range
79 * inherit from. There are three pure virtual functions which all devices must
80 * implement getAddrRanges(), read(), and write(). The magic do choose which
81 * mode we are in, etc is handled by the PioPort so the device doesn't have to
82 * bother.
83 */
84class PioDevice : public MemObject
85{
86 protected:
87 System *sys;
88
89 /** The pioPort that handles the requests for us and provides us requests
90 * that it sees. */
91 PioPort pioPort;
92
93 /**
94 * Every PIO device is obliged to provide an implementation that
95 * returns the address ranges the device responds to.
96 *
97 * @return a list of non-overlapping address ranges
98 */
99 virtual AddrRangeList getAddrRanges() const = 0;
100
101 /** Pure virtual function that the device must implement. Called
102 * when a read command is recieved by the port.
103 * @param pkt Packet describing this request
104 * @return number of ticks it took to complete
105 */
106 virtual Tick read(PacketPtr pkt) = 0;
107
108 /** Pure virtual function that the device must implement. Called when a
109 * write command is recieved by the port.
110 * @param pkt Packet describing this request
111 * @return number of ticks it took to complete
112 */
113 virtual Tick write(PacketPtr pkt) = 0;
114
115 public:
116 typedef PioDeviceParams Params;
117 PioDevice(const Params *p);
118 virtual ~PioDevice();
119
120 const Params *
121 params() const
122 {
123 return dynamic_cast<const Params *>(_params);
124 }
125
126 virtual void init();
127
128 unsigned int drain(DrainManager *drainManger);
129
130 virtual BaseSlavePort &getSlavePort(const std::string &if_name,
131 PortID idx = InvalidPortID);
132
133 friend class PioPort;
134
135};
136
137class BasicPioDevice : public PioDevice
138{
139 protected:
140 /** Address that the device listens to. */
141 Addr pioAddr;
142
143 /** Size that the device's address range. */
144 Addr pioSize;
145
146 /** Delay that the device experinces on an access. */
147 Tick pioDelay;
148
149 public:
150 typedef BasicPioDeviceParams Params;
|