2 * Copyright (c) 2004-2005 The Regents of The University of Michigan
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.
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.
28 * Authors: Nathan Binkert
31 #ifndef __DEV_SINIC_HH__
32 #define __DEV_SINIC_HH__
34 #include "base/inet.hh"
35 #include "base/statistics.hh"
36 #include "dev/etherint.hh"
37 #include "dev/etherpkt.hh"
38 #include "dev/io_device.hh"
39 #include "dev/pcidev.hh"
40 #include "dev/pktfifo.hh"
41 #include "dev/sinicreg.hh"
42 #include "params/Sinic.hh"
43 #include "sim/eventq.hh"
48 class Base : public PciDev
54 inline Tick ticks(int numCycles) const { return numCycles * clock; }
61 void cpuIntrPost(Tick when);
65 typedef EventWrapper<Base, &Base::cpuInterrupt> IntrEvent;
66 friend void IntrEvent::process();
70 bool cpuIntrPending() const;
71 void cpuIntrAck() { cpuIntrClear(); }
77 virtual void serialize(std::ostream &os);
78 virtual void unserialize(Checkpoint *cp, const std::string §ion);
81 * Construction/Destruction/Parameters
84 typedef SinicParams Params;
85 const Params *params() const { return (const Params *)_params; }
86 Base(const Params *p);
89 class Device : public Base
92 /** Receive State Machine States */
101 /** Transmit State Machine states */
110 /** device register file */
112 uint32_t Config; // 0x00
113 uint32_t Command; // 0x04
114 uint32_t IntrStatus; // 0x08
115 uint32_t IntrMask; // 0x0c
116 uint32_t RxMaxCopy; // 0x10
117 uint32_t TxMaxCopy; // 0x14
118 uint32_t ZeroCopySize; // 0x18
119 uint32_t ZeroCopyMark; // 0x1c
120 uint32_t VirtualCount; // 0x20
121 uint32_t RxMaxIntr; // 0x24
122 uint32_t RxFifoSize; // 0x28
123 uint32_t TxFifoSize; // 0x2c
124 uint32_t RxFifoLow; // 0x30
125 uint32_t TxFifoLow; // 0x34
126 uint32_t RxFifoHigh; // 0x38
127 uint32_t TxFifoHigh; // 0x3c
128 uint64_t RxData; // 0x40
129 uint64_t RxDone; // 0x48
130 uint64_t RxWait; // 0x50
131 uint64_t TxData; // 0x58
132 uint64_t TxDone; // 0x60
133 uint64_t TxWait; // 0x68
134 uint64_t HwAddr; // 0x70
135 uint64_t RxStatus; // 0x78
144 PacketFifo::iterator rxIndex;
145 unsigned rxPacketOffset;
146 unsigned rxPacketBytes;
153 : RxData(0), RxDone(0), TxData(0), TxDone(0),
154 rxPacketOffset(0), rxPacketBytes(0), rxDoneData(0)
157 typedef std::vector<VirtualReg> VirtualRegs;
158 typedef std::list<unsigned> VirtualList;
161 VirtualRegs virtualRegs;
171 uint8_t ®Data8(Addr daddr) { return *((uint8_t *)®s + daddr); }
172 uint32_t ®Data32(Addr daddr) { return *(uint32_t *)®Data8(daddr); }
173 uint64_t ®Data64(Addr daddr) { return *(uint64_t *)®Data8(daddr); }
178 PacketFifo::iterator rxFifoPtr;
188 EthPacketPtr txPacket;
200 typedef EventWrapper<Device, &Device::rxKick> RxKickEvent;
201 friend void RxKickEvent::process();
205 typedef EventWrapper<Device, &Device::txKick> TxKickEvent;
206 friend void TxKickEvent::process();
212 void txEventTransmit()
215 if (txState == txFifoBlock)
218 typedef EventWrapper<Device, &Device::txEventTransmit> TxEvent;
219 friend void TxEvent::process();
226 * receive address filter
228 bool rxFilter(const EthPacketPtr &packet);
231 * device configuration
233 void changeConfig(uint32_t newconfig);
234 void command(uint32_t command);
237 * device ethernet interface
240 bool recvPacket(EthPacketPtr packet);
242 virtual EtherInt *getEthPort(const std::string &if_name, int idx);
249 friend class EventWrapper<Device, &Device::rxDmaDone>;
250 EventWrapper<Device, &Device::rxDmaDone> rxDmaEvent;
253 friend class EventWrapper<Device, &Device::txDmaDone>;
254 EventWrapper<Device, &Device::txDmaDone> txDmaEvent;
262 * Interrupt management
265 void devIntrPost(uint32_t interrupts);
266 void devIntrClear(uint32_t interrupts = Regs::Intr_All);
267 void devIntrChangeMask(uint32_t newmask);
273 virtual Tick read(PacketPtr pkt);
274 virtual Tick write(PacketPtr pkt);
275 virtual void resume();
277 void prepareIO(int cpu, int index);
278 void prepareRead(int cpu, int index);
279 void prepareWrite(int cpu, int index);
280 // Fault iprRead(Addr daddr, int cpu, uint64_t &result);
286 Stats::Scalar rxBytes;
287 Stats::Formula rxBandwidth;
288 Stats::Scalar rxPackets;
289 Stats::Formula rxPacketRate;
290 Stats::Scalar rxIpPackets;
291 Stats::Scalar rxTcpPackets;
292 Stats::Scalar rxUdpPackets;
293 Stats::Scalar rxIpChecksums;
294 Stats::Scalar rxTcpChecksums;
295 Stats::Scalar rxUdpChecksums;
297 Stats::Scalar txBytes;
298 Stats::Formula txBandwidth;
299 Stats::Formula totBandwidth;
300 Stats::Formula totPackets;
301 Stats::Formula totBytes;
302 Stats::Formula totPacketRate;
303 Stats::Scalar txPackets;
304 Stats::Formula txPacketRate;
305 Stats::Scalar txIpPackets;
306 Stats::Scalar txTcpPackets;
307 Stats::Scalar txUdpPackets;
308 Stats::Scalar txIpChecksums;
309 Stats::Scalar txTcpChecksums;
310 Stats::Scalar txUdpChecksums;
312 Stats::Scalar totalVnicDistance;
313 Stats::Scalar numVnicDistance;
314 Stats::Scalar maxVnicDistance;
315 Stats::Formula avgVnicDistance;
317 int _maxVnicDistance;
320 virtual void regStats();
321 virtual void resetStats();
324 * Serialization stuff
327 virtual void serialize(std::ostream &os);
328 virtual void unserialize(Checkpoint *cp, const std::string §ion);
331 Device(const Params *p);
336 * Ethernet Interface for an Ethernet Device
338 class Interface : public EtherInt
344 Interface(const std::string &name, Device *d)
345 : EtherInt(name), dev(d)
348 virtual bool recvPacket(EthPacketPtr pkt) { return dev->recvPacket(pkt); }
349 virtual void sendDone() { dev->transferDone(); }
352 /* namespace Sinic */ }
354 #endif // __DEV_SINIC_HH__