1/*
2 * Copyright (c) 2004-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
| 1/*
2 * Copyright (c) 2004-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
27 */
28
29#ifndef __DEV_IO_DEVICE_HH__
30#define __DEV_IO_DEVICE_HH__
31
32#include "base/chunk_generator.hh"
33#include "mem/mem_object.hh"
34#include "mem/packet_impl.hh"
35#include "sim/eventq.hh"
36#include "sim/sim_object.hh"
37
38class Platform;
39class PioDevice;
40class DmaDevice;
41class System;
42
43/**
44 * The PioPort class is a programmed i/o port that all devices that are
45 * sensitive to an address range use. The port takes all the memory
46 * access types and roles them into one read() and write() call that the device
47 * must respond to. The device must also provide the addressRanges() function
48 * with which it returns the address ranges it is interested in. An extra
49 * sendTiming() function is implemented which takes an delay. In this way the
50 * device can immediatly call sendTiming(pkt, time) after processing a request
51 * and the request will be handled by the port even if the port bus the device
52 * connects to is blocked.
53 */
54class PioPort : public Port
55{
56 protected:
57 /** The device that this port serves. */
58 PioDevice *device;
59
60 /** The platform that device/port are in. This is used to select which mode
61 * we are currently operating in. */
62 Platform *platform;
63
64 /** A list of outgoing timing response packets that haven't been serviced
65 * yet. */
66 std::list<Packet*> transmitList;
67
68 /** The current status of the peer(bus) that we are connected to. */
69 Status peerStatus;
70
71 virtual bool recvTiming(Packet *pkt);
72
73 virtual Tick recvAtomic(Packet *pkt);
74
75 virtual void recvFunctional(Packet *pkt) ;
76
77 virtual void recvStatusChange(Status status)
78 { peerStatus = status; }
79
80 virtual void getDeviceAddressRanges(AddrRangeList &resp, AddrRangeList &snoop);
81
82 /**
83 * This class is used to implemented sendTiming() with a delay. When a delay
84 * is requested a new event is created. When the event time expires it
85 * attempts to send the packet. If it cannot, the packet is pushed onto the
86 * transmit list to be sent when recvRetry() is called. */
87 class SendEvent : public Event
88 {
89 PioPort *port;
90 Packet *packet;
91
92 SendEvent(PioPort *p, Packet *pkt, Tick t)
93 : Event(&mainEventQueue), port(p), packet(pkt)
94 { schedule(curTick + t); }
95
96 virtual void process();
97
98 virtual const char *description()
99 { return "Future scheduled sendTiming event"; }
100
101 friend class PioPort;
102 };
103
104 /** Schedule a sendTiming() event to be called in the future. */
105 void sendTiming(Packet *pkt, Tick time)
106 { new PioPort::SendEvent(this, pkt, time); }
107
108 /** This function is notification that the device should attempt to send a
109 * packet again. */
110 virtual void recvRetry();
111
112 public:
113 PioPort(PioDevice *dev, Platform *p);
114
115 friend class PioPort::SendEvent;
116};
117
118
119struct DmaReqState : public Packet::SenderState
120{
121 Event *completionEvent;
122 bool final;
123 DmaReqState(Event *ce, bool f)
124 : completionEvent(ce), final(f)
125 {}
126};
127
128class DmaPort : public Port
129{
130 protected:
131 DmaDevice *device;
132 std::list<Packet*> transmitList;
133
134 /** The platform that device/port are in. This is used to select which mode
135 * we are currently operating in. */
136 Platform *platform;
137
138 /** Number of outstanding packets the dma port has. */
139 int pendingCount;
140
141 virtual bool recvTiming(Packet *pkt);
142 virtual Tick recvAtomic(Packet *pkt)
143 { panic("dma port shouldn't be used for pio access."); }
144 virtual void recvFunctional(Packet *pkt)
145 { panic("dma port shouldn't be used for pio access."); }
146
147 virtual void recvStatusChange(Status status)
148 { ; }
149
150 virtual void recvRetry() ;
151
152 virtual void getDeviceAddressRanges(AddrRangeList &resp, AddrRangeList &snoop)
153 { resp.clear(); snoop.clear(); }
154
155 void sendDma(Packet *pkt);
156
157 public:
158 DmaPort(DmaDevice *dev, Platform *p);
159
160 void dmaAction(Packet::Command cmd, Addr addr, int size, Event *event,
161 uint8_t *data = NULL);
162
163 bool dmaPending() { return pendingCount > 0; }
164
165};
166
167/**
168 * This device is the base class which all devices senstive to an address range
169 * inherit from. There are three pure virtual functions which all devices must
170 * implement addressRanges(), read(), and write(). The magic do choose which
171 * mode we are in, etc is handled by the PioPort so the device doesn't have to
172 * bother.
173 */
174
175class PioDevice : public MemObject
176{
177 protected:
178
179 /** The platform we are in. This is used to decide what type of memory
180 * transaction we should perform. */
181 Platform *platform;
182
183 /** The pioPort that handles the requests for us and provides us requests
184 * that it sees. */
185 PioPort *pioPort;
186
187 virtual void addressRanges(AddrRangeList &range_list) = 0;
188
189 /** As far as the devices are concerned they only accept atomic transactions
190 * which are converted to either a write or a read. */
191 Tick recvAtomic(Packet *pkt)
192 { return pkt->isRead() ? this->read(pkt) : this->write(pkt); }
193
194 /** Pure virtual function that the device must implement. Called when a read
195 * command is recieved by the port.
196 * @param pkt Packet describing this request
197 * @return number of ticks it took to complete
198 */
199 virtual Tick read(Packet *pkt) = 0;
200
201 /** Pure virtual function that the device must implement. Called when a
202 * write command is recieved by the port.
203 * @param pkt Packet describing this request
204 * @return number of ticks it took to complete
205 */
206 virtual Tick write(Packet *pkt) = 0;
207
208 public:
209 /** Params struct which is extended through each device based on the
210 * parameters it needs. Since we are re-writing everything, we might as well
211 * start from the bottom this time. */
212
213 struct Params
214 {
215 std::string name;
216 Platform *platform;
217 System *system;
218 };
219
220 protected:
221 Params *_params;
222
223 public:
224 const Params *params() const { return _params; }
225
226 PioDevice(Params *p)
227 : MemObject(p->name), platform(p->platform), pioPort(NULL),
228 _params(p)
229 {}
230
231 virtual ~PioDevice();
232
233 virtual void init();
234
235 virtual Port *getPort(const std::string &if_name)
236 {
237 if (if_name == "pio") {
238 if (pioPort != NULL)
239 panic("pio port already connected to.");
240 pioPort = new PioPort(this, params()->platform);
241 return pioPort;
242 } else
243 return NULL;
244 }
245 friend class PioPort;
246
247};
248
249class BasicPioDevice : public PioDevice
250{
251 public:
252 struct Params : public PioDevice::Params
253 {
254 Addr pio_addr;
255 Tick pio_delay;
256 };
257
258 protected:
259 /** Address that the device listens to. */
260 Addr pioAddr;
261
262 /** Size that the device's address range. */
263 Addr pioSize;
264
265 /** Delay that the device experinces on an access. */
266 Tick pioDelay;
267
268 public:
269 BasicPioDevice(Params *p)
270 : PioDevice(p), pioAddr(p->pio_addr), pioSize(0), pioDelay(p->pio_delay)
271 {}
272
273 /** return the address ranges that this device responds to.
274 * @params range_list range list to populate with ranges
275 */
276 void addressRanges(AddrRangeList &range_list);
277
278};
279
280class DmaDevice : public PioDevice
281{
282 protected:
283 DmaPort *dmaPort;
284
285 public:
286 DmaDevice(Params *p);
287 virtual ~DmaDevice();
288
289 void dmaWrite(Addr addr, int size, Event *event, uint8_t *data)
290 { dmaPort->dmaAction(Packet::WriteReq, addr, size, event, data) ; }
291
292 void dmaRead(Addr addr, int size, Event *event, uint8_t *data = NULL)
293 { dmaPort->dmaAction(Packet::ReadReq, addr, size, event, data); }
294
295 bool dmaPending() { return dmaPort->dmaPending(); }
296
297 virtual Port *getPort(const std::string &if_name)
298 {
299 if (if_name == "pio") {
300 if (pioPort != NULL)
301 panic("pio port already connected to.");
302 pioPort = new PioPort(this, params()->platform);
303 return pioPort;
304 } else if (if_name == "dma") {
305 if (dmaPort != NULL)
306 panic("dma port already connected to.");
307 dmaPort = new DmaPort(this, params()->platform);
308 return dmaPort;
309 } else
310 return NULL;
311 }
312
313 friend class DmaPort;
314};
315
316
317#endif // __DEV_IO_DEVICE_HH__
| 30 */
31
32#ifndef __DEV_IO_DEVICE_HH__
33#define __DEV_IO_DEVICE_HH__
34
35#include "base/chunk_generator.hh"
36#include "mem/mem_object.hh"
37#include "mem/packet_impl.hh"
38#include "sim/eventq.hh"
39#include "sim/sim_object.hh"
40
41class Platform;
42class PioDevice;
43class DmaDevice;
44class System;
45
46/**
47 * The PioPort class is a programmed i/o port that all devices that are
48 * sensitive to an address range use. The port takes all the memory
49 * access types and roles them into one read() and write() call that the device
50 * must respond to. The device must also provide the addressRanges() function
51 * with which it returns the address ranges it is interested in. An extra
52 * sendTiming() function is implemented which takes an delay. In this way the
53 * device can immediatly call sendTiming(pkt, time) after processing a request
54 * and the request will be handled by the port even if the port bus the device
55 * connects to is blocked.
56 */
57class PioPort : public Port
58{
59 protected:
60 /** The device that this port serves. */
61 PioDevice *device;
62
63 /** The platform that device/port are in. This is used to select which mode
64 * we are currently operating in. */
65 Platform *platform;
66
67 /** A list of outgoing timing response packets that haven't been serviced
68 * yet. */
69 std::list<Packet*> transmitList;
70
71 /** The current status of the peer(bus) that we are connected to. */
72 Status peerStatus;
73
74 virtual bool recvTiming(Packet *pkt);
75
76 virtual Tick recvAtomic(Packet *pkt);
77
78 virtual void recvFunctional(Packet *pkt) ;
79
80 virtual void recvStatusChange(Status status)
81 { peerStatus = status; }
82
83 virtual void getDeviceAddressRanges(AddrRangeList &resp, AddrRangeList &snoop);
84
85 /**
86 * This class is used to implemented sendTiming() with a delay. When a delay
87 * is requested a new event is created. When the event time expires it
88 * attempts to send the packet. If it cannot, the packet is pushed onto the
89 * transmit list to be sent when recvRetry() is called. */
90 class SendEvent : public Event
91 {
92 PioPort *port;
93 Packet *packet;
94
95 SendEvent(PioPort *p, Packet *pkt, Tick t)
96 : Event(&mainEventQueue), port(p), packet(pkt)
97 { schedule(curTick + t); }
98
99 virtual void process();
100
101 virtual const char *description()
102 { return "Future scheduled sendTiming event"; }
103
104 friend class PioPort;
105 };
106
107 /** Schedule a sendTiming() event to be called in the future. */
108 void sendTiming(Packet *pkt, Tick time)
109 { new PioPort::SendEvent(this, pkt, time); }
110
111 /** This function is notification that the device should attempt to send a
112 * packet again. */
113 virtual void recvRetry();
114
115 public:
116 PioPort(PioDevice *dev, Platform *p);
117
118 friend class PioPort::SendEvent;
119};
120
121
122struct DmaReqState : public Packet::SenderState
123{
124 Event *completionEvent;
125 bool final;
126 DmaReqState(Event *ce, bool f)
127 : completionEvent(ce), final(f)
128 {}
129};
130
131class DmaPort : public Port
132{
133 protected:
134 DmaDevice *device;
135 std::list<Packet*> transmitList;
136
137 /** The platform that device/port are in. This is used to select which mode
138 * we are currently operating in. */
139 Platform *platform;
140
141 /** Number of outstanding packets the dma port has. */
142 int pendingCount;
143
144 virtual bool recvTiming(Packet *pkt);
145 virtual Tick recvAtomic(Packet *pkt)
146 { panic("dma port shouldn't be used for pio access."); }
147 virtual void recvFunctional(Packet *pkt)
148 { panic("dma port shouldn't be used for pio access."); }
149
150 virtual void recvStatusChange(Status status)
151 { ; }
152
153 virtual void recvRetry() ;
154
155 virtual void getDeviceAddressRanges(AddrRangeList &resp, AddrRangeList &snoop)
156 { resp.clear(); snoop.clear(); }
157
158 void sendDma(Packet *pkt);
159
160 public:
161 DmaPort(DmaDevice *dev, Platform *p);
162
163 void dmaAction(Packet::Command cmd, Addr addr, int size, Event *event,
164 uint8_t *data = NULL);
165
166 bool dmaPending() { return pendingCount > 0; }
167
168};
169
170/**
171 * This device is the base class which all devices senstive to an address range
172 * inherit from. There are three pure virtual functions which all devices must
173 * implement addressRanges(), read(), and write(). The magic do choose which
174 * mode we are in, etc is handled by the PioPort so the device doesn't have to
175 * bother.
176 */
177
178class PioDevice : public MemObject
179{
180 protected:
181
182 /** The platform we are in. This is used to decide what type of memory
183 * transaction we should perform. */
184 Platform *platform;
185
186 /** The pioPort that handles the requests for us and provides us requests
187 * that it sees. */
188 PioPort *pioPort;
189
190 virtual void addressRanges(AddrRangeList &range_list) = 0;
191
192 /** As far as the devices are concerned they only accept atomic transactions
193 * which are converted to either a write or a read. */
194 Tick recvAtomic(Packet *pkt)
195 { return pkt->isRead() ? this->read(pkt) : this->write(pkt); }
196
197 /** Pure virtual function that the device must implement. Called when a read
198 * command is recieved by the port.
199 * @param pkt Packet describing this request
200 * @return number of ticks it took to complete
201 */
202 virtual Tick read(Packet *pkt) = 0;
203
204 /** Pure virtual function that the device must implement. Called when a
205 * write command is recieved by the port.
206 * @param pkt Packet describing this request
207 * @return number of ticks it took to complete
208 */
209 virtual Tick write(Packet *pkt) = 0;
210
211 public:
212 /** Params struct which is extended through each device based on the
213 * parameters it needs. Since we are re-writing everything, we might as well
214 * start from the bottom this time. */
215
216 struct Params
217 {
218 std::string name;
219 Platform *platform;
220 System *system;
221 };
222
223 protected:
224 Params *_params;
225
226 public:
227 const Params *params() const { return _params; }
228
229 PioDevice(Params *p)
230 : MemObject(p->name), platform(p->platform), pioPort(NULL),
231 _params(p)
232 {}
233
234 virtual ~PioDevice();
235
236 virtual void init();
237
238 virtual Port *getPort(const std::string &if_name)
239 {
240 if (if_name == "pio") {
241 if (pioPort != NULL)
242 panic("pio port already connected to.");
243 pioPort = new PioPort(this, params()->platform);
244 return pioPort;
245 } else
246 return NULL;
247 }
248 friend class PioPort;
249
250};
251
252class BasicPioDevice : public PioDevice
253{
254 public:
255 struct Params : public PioDevice::Params
256 {
257 Addr pio_addr;
258 Tick pio_delay;
259 };
260
261 protected:
262 /** Address that the device listens to. */
263 Addr pioAddr;
264
265 /** Size that the device's address range. */
266 Addr pioSize;
267
268 /** Delay that the device experinces on an access. */
269 Tick pioDelay;
270
271 public:
272 BasicPioDevice(Params *p)
273 : PioDevice(p), pioAddr(p->pio_addr), pioSize(0), pioDelay(p->pio_delay)
274 {}
275
276 /** return the address ranges that this device responds to.
277 * @params range_list range list to populate with ranges
278 */
279 void addressRanges(AddrRangeList &range_list);
280
281};
282
283class DmaDevice : public PioDevice
284{
285 protected:
286 DmaPort *dmaPort;
287
288 public:
289 DmaDevice(Params *p);
290 virtual ~DmaDevice();
291
292 void dmaWrite(Addr addr, int size, Event *event, uint8_t *data)
293 { dmaPort->dmaAction(Packet::WriteReq, addr, size, event, data) ; }
294
295 void dmaRead(Addr addr, int size, Event *event, uint8_t *data = NULL)
296 { dmaPort->dmaAction(Packet::ReadReq, addr, size, event, data); }
297
298 bool dmaPending() { return dmaPort->dmaPending(); }
299
300 virtual Port *getPort(const std::string &if_name)
301 {
302 if (if_name == "pio") {
303 if (pioPort != NULL)
304 panic("pio port already connected to.");
305 pioPort = new PioPort(this, params()->platform);
306 return pioPort;
307 } else if (if_name == "dma") {
308 if (dmaPort != NULL)
309 panic("dma port already connected to.");
310 dmaPort = new DmaPort(this, params()->platform);
311 return dmaPort;
312 } else
313 return NULL;
314 }
315
316 friend class DmaPort;
317};
318
319
320#endif // __DEV_IO_DEVICE_HH__
|