Ethernet.py revision 11317:766c3eb44fd8
1# Copyright (c) 2015 ARM Limited 2# All rights reserved. 3# 4# The license below extends only to copyright in the software and shall 5# not be construed as granting a license to any other intellectual 6# property including but not limited to intellectual property relating 7# to a hardware implementation of the functionality of the software 8# licensed hereunder. You may use the software subject to the license 9# terms below provided that you ensure that this notice is replicated 10# unmodified and in its entirety in all distributions of the software, 11# modified or unmodified, in source code or in binary form. 12# 13# Copyright (c) 2005-2007 The Regents of The University of Michigan 14# All rights reserved. 15# 16# Redistribution and use in source and binary forms, with or without 17# modification, are permitted provided that the following conditions are 18# met: redistributions of source code must retain the above copyright 19# notice, this list of conditions and the following disclaimer; 20# redistributions in binary form must reproduce the above copyright 21# notice, this list of conditions and the following disclaimer in the 22# documentation and/or other materials provided with the distribution; 23# neither the name of the copyright holders nor the names of its 24# contributors may be used to endorse or promote products derived from 25# this software without specific prior written permission. 26# 27# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 28# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 29# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 30# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 31# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 32# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 33# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 34# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 35# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 36# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 37# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 38# 39# Authors: Nathan Binkert 40 41from m5.SimObject import SimObject 42from m5.params import * 43from m5.proxy import * 44from PciDevice import PciDevice 45 46class EtherObject(SimObject): 47 type = 'EtherObject' 48 abstract = True 49 cxx_header = "dev/net/etherobject.hh" 50 51class EtherLink(EtherObject): 52 type = 'EtherLink' 53 cxx_header = "dev/net/etherlink.hh" 54 int0 = SlavePort("interface 0") 55 int1 = SlavePort("interface 1") 56 delay = Param.Latency('0us', "packet transmit delay") 57 delay_var = Param.Latency('0ns', "packet transmit delay variability") 58 speed = Param.NetworkBandwidth('1Gbps', "link speed") 59 dump = Param.EtherDump(NULL, "dump object") 60 61class DistEtherLink(EtherObject): 62 type = 'DistEtherLink' 63 cxx_header = "dev/net/dist_etherlink.hh" 64 int0 = SlavePort("interface 0") 65 delay = Param.Latency('0us', "packet transmit delay") 66 delay_var = Param.Latency('0ns', "packet transmit delay variability") 67 speed = Param.NetworkBandwidth('1Gbps', "link speed") 68 dump = Param.EtherDump(NULL, "dump object") 69 dist_rank = Param.UInt32('0', "Rank of this gem5 process (dist run)") 70 dist_size = Param.UInt32('1', "Number of gem5 processes (dist run)") 71 sync_start = Param.Latency('5200000000000t', "first dist sync barrier") 72 sync_repeat = Param.Latency('10us', "dist sync barrier repeat") 73 server_name = Param.String('localhost', "Message server name") 74 server_port = Param.UInt32('2200', "Message server port") 75 is_switch = Param.Bool(False, "true if this a link in etherswitch") 76 num_nodes = Param.UInt32('2', "Number of simulate nodes") 77 78class EtherBus(EtherObject): 79 type = 'EtherBus' 80 cxx_header = "dev/net/etherbus.hh" 81 loopback = Param.Bool(True, "send packet back to the sending interface") 82 dump = Param.EtherDump(NULL, "dump object") 83 speed = Param.NetworkBandwidth('100Mbps', "bus speed in bits per second") 84 85class EtherSwitch(EtherObject): 86 type = 'EtherSwitch' 87 cxx_header = "dev/net/etherswitch.hh" 88 dump = Param.EtherDump(NULL, "dump object") 89 fabric_speed = Param.NetworkBandwidth('10Gbps', "switch fabric speed in bits " 90 "per second") 91 interface = VectorMasterPort("Ethernet Interface") 92 output_buffer_size = Param.MemorySize('1MB', "size of output port buffers") 93 delay = Param.Latency('0us', "packet transmit delay") 94 delay_var = Param.Latency('0ns', "packet transmit delay variability") 95 time_to_live = Param.Latency('10ms', "time to live of MAC address maping") 96 97class EtherTap(EtherObject): 98 type = 'EtherTap' 99 cxx_header = "dev/net/ethertap.hh" 100 bufsz = Param.Int(10000, "tap buffer size") 101 dump = Param.EtherDump(NULL, "dump object") 102 port = Param.UInt16(3500, "tap port") 103 104class EtherDump(SimObject): 105 type = 'EtherDump' 106 cxx_header = "dev/net/etherdump.hh" 107 file = Param.String("dump file") 108 maxlen = Param.Int(96, "max portion of packet data to dump") 109 110class EtherDevice(PciDevice): 111 type = 'EtherDevice' 112 abstract = True 113 cxx_header = "dev/net/etherdevice.hh" 114 interface = MasterPort("Ethernet Interface") 115 116class IGbE(EtherDevice): 117 # Base class for two IGbE adapters listed above 118 type = 'IGbE' 119 cxx_header = "dev/net/i8254xGBe.hh" 120 hardware_address = Param.EthernetAddr(NextEthernetAddr, 121 "Ethernet Hardware Address") 122 rx_fifo_size = Param.MemorySize('384kB', "Size of the rx FIFO") 123 tx_fifo_size = Param.MemorySize('384kB', "Size of the tx FIFO") 124 rx_desc_cache_size = Param.Int(64, 125 "Number of enteries in the rx descriptor cache") 126 tx_desc_cache_size = Param.Int(64, 127 "Number of enteries in the rx descriptor cache") 128 VendorID = 0x8086 129 SubsystemID = 0x1008 130 SubsystemVendorID = 0x8086 131 Status = 0x0000 132 SubClassCode = 0x00 133 ClassCode = 0x02 134 ProgIF = 0x00 135 BAR0 = 0x00000000 136 BAR1 = 0x00000000 137 BAR2 = 0x00000000 138 BAR3 = 0x00000000 139 BAR4 = 0x00000000 140 BAR5 = 0x00000000 141 MaximumLatency = 0x00 142 MinimumGrant = 0xff 143 InterruptLine = 0x1e 144 InterruptPin = 0x01 145 BAR0Size = '128kB' 146 wb_delay = Param.Latency('10ns', "delay before desc writeback occurs") 147 fetch_delay = Param.Latency('10ns', "delay before desc fetch occurs") 148 fetch_comp_delay = Param.Latency('10ns', "delay after desc fetch occurs") 149 wb_comp_delay = Param.Latency('10ns', "delay after desc wb occurs") 150 tx_read_delay = Param.Latency('0ns', "delay after tx dma read") 151 rx_write_delay = Param.Latency('0ns', "delay after rx dma read") 152 phy_pid = Param.UInt16("Phy PID that corresponds to device ID") 153 phy_epid = Param.UInt16("Phy EPID that corresponds to device ID") 154 155class IGbE_e1000(IGbE): 156 # Older Intel 8254x based gigabit ethernet adapter 157 # Uses Intel e1000 driver 158 DeviceID = 0x1075 159 phy_pid = 0x02A8 160 phy_epid = 0x0380 161 162class IGbE_igb(IGbE): 163 # Newer Intel 8257x based gigabit ethernet adapter 164 # Uses Intel igb driver and in theory supports packet splitting and LRO 165 DeviceID = 0x10C9 166 phy_pid = 0x0141 167 phy_epid = 0x0CC0 168 169class EtherDevBase(EtherDevice): 170 type = 'EtherDevBase' 171 abstract = True 172 cxx_header = "dev/net/etherdevice.hh" 173 174 hardware_address = Param.EthernetAddr(NextEthernetAddr, 175 "Ethernet Hardware Address") 176 177 dma_read_delay = Param.Latency('0us', "fixed delay for dma reads") 178 dma_read_factor = Param.Latency('0us', "multiplier for dma reads") 179 dma_write_delay = Param.Latency('0us', "fixed delay for dma writes") 180 dma_write_factor = Param.Latency('0us', "multiplier for dma writes") 181 182 rx_delay = Param.Latency('1us', "Receive Delay") 183 tx_delay = Param.Latency('1us', "Transmit Delay") 184 rx_fifo_size = Param.MemorySize('512kB', "max size of rx fifo") 185 tx_fifo_size = Param.MemorySize('512kB', "max size of tx fifo") 186 187 rx_filter = Param.Bool(True, "Enable Receive Filter") 188 intr_delay = Param.Latency('10us', "Interrupt propagation delay") 189 rx_thread = Param.Bool(False, "dedicated kernel thread for transmit") 190 tx_thread = Param.Bool(False, "dedicated kernel threads for receive") 191 rss = Param.Bool(False, "Receive Side Scaling") 192 193class NSGigE(EtherDevBase): 194 type = 'NSGigE' 195 cxx_header = "dev/net/ns_gige.hh" 196 197 dma_data_free = Param.Bool(False, "DMA of Data is free") 198 dma_desc_free = Param.Bool(False, "DMA of Descriptors is free") 199 dma_no_allocate = Param.Bool(True, "Should we allocate cache on read") 200 201 VendorID = 0x100B 202 DeviceID = 0x0022 203 Status = 0x0290 204 SubClassCode = 0x00 205 ClassCode = 0x02 206 ProgIF = 0x00 207 BAR0 = 0x00000001 208 BAR1 = 0x00000000 209 BAR2 = 0x00000000 210 BAR3 = 0x00000000 211 BAR4 = 0x00000000 212 BAR5 = 0x00000000 213 MaximumLatency = 0x34 214 MinimumGrant = 0xb0 215 InterruptLine = 0x1e 216 InterruptPin = 0x01 217 BAR0Size = '256B' 218 BAR1Size = '4kB' 219 220 221 222class Sinic(EtherDevBase): 223 type = 'Sinic' 224 cxx_class = 'Sinic::Device' 225 cxx_header = "dev/net/sinic.hh" 226 227 rx_max_copy = Param.MemorySize('1514B', "rx max copy") 228 tx_max_copy = Param.MemorySize('16kB', "tx max copy") 229 rx_max_intr = Param.UInt32(10, "max rx packets per interrupt") 230 rx_fifo_threshold = Param.MemorySize('384kB', "rx fifo high threshold") 231 rx_fifo_low_mark = Param.MemorySize('128kB', "rx fifo low threshold") 232 tx_fifo_high_mark = Param.MemorySize('384kB', "tx fifo high threshold") 233 tx_fifo_threshold = Param.MemorySize('128kB', "tx fifo low threshold") 234 virtual_count = Param.UInt32(1, "Virtualized SINIC") 235 zero_copy_size = Param.UInt32(64, "Bytes to copy if below threshold") 236 zero_copy_threshold = Param.UInt32(256, 237 "Only zero copy above this threshold") 238 zero_copy = Param.Bool(False, "Zero copy receive") 239 delay_copy = Param.Bool(False, "Delayed copy transmit") 240 virtual_addr = Param.Bool(False, "Virtual addressing") 241 242 VendorID = 0x1291 243 DeviceID = 0x1293 244 Status = 0x0290 245 SubClassCode = 0x00 246 ClassCode = 0x02 247 ProgIF = 0x00 248 BAR0 = 0x00000000 249 BAR1 = 0x00000000 250 BAR2 = 0x00000000 251 BAR3 = 0x00000000 252 BAR4 = 0x00000000 253 BAR5 = 0x00000000 254 MaximumLatency = 0x34 255 MinimumGrant = 0xb0 256 InterruptLine = 0x1e 257 InterruptPin = 0x01 258 BAR0Size = '64kB' 259 260 261