Ethernet.py revision 13665
110923SN/A# Copyright (c) 2015 ARM Limited 210923SN/A# All rights reserved. 310923SN/A# 410923SN/A# The license below extends only to copyright in the software and shall 510923SN/A# not be construed as granting a license to any other intellectual 610923SN/A# property including but not limited to intellectual property relating 710923SN/A# to a hardware implementation of the functionality of the software 810923SN/A# licensed hereunder. You may use the software subject to the license 910923SN/A# terms below provided that you ensure that this notice is replicated 1010923SN/A# unmodified and in its entirety in all distributions of the software, 1110923SN/A# modified or unmodified, in source code or in binary form. 1210923SN/A# 134486SN/A# Copyright (c) 2005-2007 The Regents of The University of Michigan 144486SN/A# All rights reserved. 154486SN/A# 164486SN/A# Redistribution and use in source and binary forms, with or without 174486SN/A# modification, are permitted provided that the following conditions are 184486SN/A# met: redistributions of source code must retain the above copyright 194486SN/A# notice, this list of conditions and the following disclaimer; 204486SN/A# redistributions in binary form must reproduce the above copyright 214486SN/A# notice, this list of conditions and the following disclaimer in the 224486SN/A# documentation and/or other materials provided with the distribution; 234486SN/A# neither the name of the copyright holders nor the names of its 244486SN/A# contributors may be used to endorse or promote products derived from 254486SN/A# this software without specific prior written permission. 264486SN/A# 274486SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 284486SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 294486SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 304486SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 314486SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 324486SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 334486SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 344486SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 354486SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 364486SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 374486SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 384486SN/A# 394486SN/A# Authors: Nathan Binkert 404486SN/A 4112056Sgabeblack@google.comfrom m5.defines import buildEnv 423102SN/Afrom m5.SimObject import SimObject 433102SN/Afrom m5.params import * 443102SN/Afrom m5.proxy import * 4513665Sandreas.sandberg@arm.comfrom m5.objects.PciDevice import PciDevice 461310SN/A 474981SN/Aclass EtherObject(SimObject): 484981SN/A type = 'EtherObject' 491310SN/A abstract = True 5011263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherobject.hh" 511310SN/A 524981SN/Aclass EtherLink(EtherObject): 531366SN/A type = 'EtherLink' 5411263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherlink.hh" 558839SN/A int0 = SlavePort("interface 0") 568839SN/A int1 = SlavePort("interface 1") 571634SN/A delay = Param.Latency('0us', "packet transmit delay") 581952SN/A delay_var = Param.Latency('0ns', "packet transmit delay variability") 591702SN/A speed = Param.NetworkBandwidth('1Gbps', "link speed") 601310SN/A dump = Param.EtherDump(NULL, "dump object") 611310SN/A 6211290Sgabor.dozsa@arm.comclass DistEtherLink(EtherObject): 6311290Sgabor.dozsa@arm.com type = 'DistEtherLink' 6411290Sgabor.dozsa@arm.com cxx_header = "dev/net/dist_etherlink.hh" 6510923SN/A int0 = SlavePort("interface 0") 6610923SN/A delay = Param.Latency('0us', "packet transmit delay") 6710923SN/A delay_var = Param.Latency('0ns', "packet transmit delay variability") 6810923SN/A speed = Param.NetworkBandwidth('1Gbps', "link speed") 6910923SN/A dump = Param.EtherDump(NULL, "dump object") 7011290Sgabor.dozsa@arm.com dist_rank = Param.UInt32('0', "Rank of this gem5 process (dist run)") 7111290Sgabor.dozsa@arm.com dist_size = Param.UInt32('1', "Number of gem5 processes (dist run)") 7211290Sgabor.dozsa@arm.com sync_start = Param.Latency('5200000000000t', "first dist sync barrier") 7311290Sgabor.dozsa@arm.com sync_repeat = Param.Latency('10us', "dist sync barrier repeat") 7410923SN/A server_name = Param.String('localhost', "Message server name") 7510923SN/A server_port = Param.UInt32('2200', "Message server port") 7611290Sgabor.dozsa@arm.com is_switch = Param.Bool(False, "true if this a link in etherswitch") 7711703Smichael.lebeane@amd.com dist_sync_on_pseudo_op = Param.Bool(False, "Start sync with pseudo_op") 7811290Sgabor.dozsa@arm.com num_nodes = Param.UInt32('2', "Number of simulate nodes") 7910923SN/A 804981SN/Aclass EtherBus(EtherObject): 811366SN/A type = 'EtherBus' 8211263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherbus.hh" 831634SN/A loopback = Param.Bool(True, "send packet back to the sending interface") 841310SN/A dump = Param.EtherDump(NULL, "dump object") 851634SN/A speed = Param.NetworkBandwidth('100Mbps', "bus speed in bits per second") 861310SN/A 8711317Sm.alian1369@gmail.comclass EtherSwitch(EtherObject): 8811317Sm.alian1369@gmail.com type = 'EtherSwitch' 8911317Sm.alian1369@gmail.com cxx_header = "dev/net/etherswitch.hh" 9011317Sm.alian1369@gmail.com dump = Param.EtherDump(NULL, "dump object") 9111317Sm.alian1369@gmail.com fabric_speed = Param.NetworkBandwidth('10Gbps', "switch fabric speed in bits " 9211317Sm.alian1369@gmail.com "per second") 9311317Sm.alian1369@gmail.com interface = VectorMasterPort("Ethernet Interface") 9411317Sm.alian1369@gmail.com output_buffer_size = Param.MemorySize('1MB', "size of output port buffers") 9511317Sm.alian1369@gmail.com delay = Param.Latency('0us', "packet transmit delay") 9611317Sm.alian1369@gmail.com delay_var = Param.Latency('0ns', "packet transmit delay variability") 9711317Sm.alian1369@gmail.com time_to_live = Param.Latency('10ms', "time to live of MAC address maping") 9811317Sm.alian1369@gmail.com 9912055Sgabeblack@google.comclass EtherTapBase(EtherObject): 10012055Sgabeblack@google.com type = 'EtherTapBase' 10112055Sgabeblack@google.com abstract = True 10211263Sandreas.sandberg@arm.com cxx_header = "dev/net/ethertap.hh" 1031310SN/A bufsz = Param.Int(10000, "tap buffer size") 1041310SN/A dump = Param.EtherDump(NULL, "dump object") 10512055Sgabeblack@google.com tap = SlavePort("Ethernet interface to connect to gem5's network") 10612055Sgabeblack@google.com 10712056Sgabeblack@google.comif buildEnv['USE_TUNTAP']: 10812056Sgabeblack@google.com class EtherTap(EtherTapBase): 10912056Sgabeblack@google.com type = 'EtherTap' 11012056Sgabeblack@google.com cxx_header = "dev/net/ethertap.hh" 11112056Sgabeblack@google.com tun_clone_device = Param.String('/dev/net/tun', 11212056Sgabeblack@google.com "Path to the tun clone device node") 11312056Sgabeblack@google.com tap_device_name = Param.String('gem5-tap', "Tap device name") 11412056Sgabeblack@google.com 11512055Sgabeblack@google.comclass EtherTapStub(EtherTapBase): 11612055Sgabeblack@google.com type = 'EtherTapStub' 11712055Sgabeblack@google.com cxx_header = "dev/net/ethertap.hh" 11812054Sgabeblack@google.com port = Param.UInt16(3500, "Port helper should send packets to") 1191310SN/A 1201692SN/Aclass EtherDump(SimObject): 1211366SN/A type = 'EtherDump' 12211263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherdump.hh" 1231310SN/A file = Param.String("dump file") 1241880SN/A maxlen = Param.Int(96, "max portion of packet data to dump") 1251310SN/A 1264981SN/Aclass EtherDevice(PciDevice): 1274981SN/A type = 'EtherDevice' 1284981SN/A abstract = True 12911263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherdevice.hh" 1308839SN/A interface = MasterPort("Ethernet Interface") 1314981SN/A 1324981SN/Aclass IGbE(EtherDevice): 1335763SN/A # Base class for two IGbE adapters listed above 1343116SN/A type = 'IGbE' 13511263Sandreas.sandberg@arm.com cxx_header = "dev/net/i8254xGBe.hh" 1364597SN/A hardware_address = Param.EthernetAddr(NextEthernetAddr, 1374597SN/A "Ethernet Hardware Address") 1384283SN/A rx_fifo_size = Param.MemorySize('384kB', "Size of the rx FIFO") 1394283SN/A tx_fifo_size = Param.MemorySize('384kB', "Size of the tx FIFO") 1404486SN/A rx_desc_cache_size = Param.Int(64, 1414486SN/A "Number of enteries in the rx descriptor cache") 1424486SN/A tx_desc_cache_size = Param.Int(64, 1434486SN/A "Number of enteries in the rx descriptor cache") 1443116SN/A VendorID = 0x8086 1453116SN/A SubsystemID = 0x1008 1463116SN/A SubsystemVendorID = 0x8086 1473116SN/A Status = 0x0000 1483116SN/A SubClassCode = 0x00 1493116SN/A ClassCode = 0x02 1503116SN/A ProgIF = 0x00 1513116SN/A BAR0 = 0x00000000 1523116SN/A BAR1 = 0x00000000 1533116SN/A BAR2 = 0x00000000 1543116SN/A BAR3 = 0x00000000 1553116SN/A BAR4 = 0x00000000 1563116SN/A BAR5 = 0x00000000 1573116SN/A MaximumLatency = 0x00 1583116SN/A MinimumGrant = 0xff 1593116SN/A InterruptLine = 0x1e 1603116SN/A InterruptPin = 0x01 1613116SN/A BAR0Size = '128kB' 1625535SN/A wb_delay = Param.Latency('10ns', "delay before desc writeback occurs") 1635535SN/A fetch_delay = Param.Latency('10ns', "delay before desc fetch occurs") 1645535SN/A fetch_comp_delay = Param.Latency('10ns', "delay after desc fetch occurs") 1655535SN/A wb_comp_delay = Param.Latency('10ns', "delay after desc wb occurs") 1665535SN/A tx_read_delay = Param.Latency('0ns', "delay after tx dma read") 1675535SN/A rx_write_delay = Param.Latency('0ns', "delay after rx dma read") 1685781SN/A phy_pid = Param.UInt16("Phy PID that corresponds to device ID") 1695781SN/A phy_epid = Param.UInt16("Phy EPID that corresponds to device ID") 1703116SN/A 1715763SN/Aclass IGbE_e1000(IGbE): 1725763SN/A # Older Intel 8254x based gigabit ethernet adapter 1735763SN/A # Uses Intel e1000 driver 1745763SN/A DeviceID = 0x1075 1755781SN/A phy_pid = 0x02A8 1765781SN/A phy_epid = 0x0380 1775763SN/A 1785763SN/Aclass IGbE_igb(IGbE): 1795763SN/A # Newer Intel 8257x based gigabit ethernet adapter 1805763SN/A # Uses Intel igb driver and in theory supports packet splitting and LRO 1815763SN/A DeviceID = 0x10C9 1825781SN/A phy_pid = 0x0141 1835781SN/A phy_epid = 0x0CC0 1845763SN/A 1854981SN/Aclass EtherDevBase(EtherDevice): 1864597SN/A type = 'EtherDevBase' 1874597SN/A abstract = True 18811263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherdevice.hh" 1899339SN/A 1901310SN/A hardware_address = Param.EthernetAddr(NextEthernetAddr, 1911310SN/A "Ethernet Hardware Address") 1921310SN/A 1931634SN/A dma_read_delay = Param.Latency('0us', "fixed delay for dma reads") 1941634SN/A dma_read_factor = Param.Latency('0us', "multiplier for dma reads") 1951634SN/A dma_write_delay = Param.Latency('0us', "fixed delay for dma writes") 1961634SN/A dma_write_factor = Param.Latency('0us', "multiplier for dma writes") 1971647SN/A 1981925SN/A rx_delay = Param.Latency('1us', "Receive Delay") 1991925SN/A tx_delay = Param.Latency('1us', "Transmit Delay") 2001925SN/A rx_fifo_size = Param.MemorySize('512kB', "max size of rx fifo") 2011925SN/A tx_fifo_size = Param.MemorySize('512kB', "max size of tx fifo") 2021310SN/A 2031369SN/A rx_filter = Param.Bool(True, "Enable Receive Filter") 2042008SN/A intr_delay = Param.Latency('10us', "Interrupt propagation delay") 2052008SN/A rx_thread = Param.Bool(False, "dedicated kernel thread for transmit") 2062008SN/A tx_thread = Param.Bool(False, "dedicated kernel threads for receive") 2072210SN/A rss = Param.Bool(False, "Receive Side Scaling") 2081310SN/A 2094982SN/Aclass NSGigE(EtherDevBase): 2104982SN/A type = 'NSGigE' 21111263Sandreas.sandberg@arm.com cxx_header = "dev/net/ns_gige.hh" 2124982SN/A 2134982SN/A dma_data_free = Param.Bool(False, "DMA of Data is free") 2144982SN/A dma_desc_free = Param.Bool(False, "DMA of Descriptors is free") 2154982SN/A dma_no_allocate = Param.Bool(True, "Should we allocate cache on read") 2164982SN/A 2172916SN/A VendorID = 0x100B 2182916SN/A DeviceID = 0x0022 2192916SN/A Status = 0x0290 2202916SN/A SubClassCode = 0x00 2212916SN/A ClassCode = 0x02 2222916SN/A ProgIF = 0x00 2232916SN/A BAR0 = 0x00000001 2242916SN/A BAR1 = 0x00000000 2252916SN/A BAR2 = 0x00000000 2262916SN/A BAR3 = 0x00000000 2272916SN/A BAR4 = 0x00000000 2282916SN/A BAR5 = 0x00000000 2292916SN/A MaximumLatency = 0x34 2302916SN/A MinimumGrant = 0xb0 2312916SN/A InterruptLine = 0x1e 2322916SN/A InterruptPin = 0x01 2332916SN/A BAR0Size = '256B' 2342916SN/A BAR1Size = '4kB' 2352916SN/A 2361310SN/A 2371644SN/A 2384982SN/Aclass Sinic(EtherDevBase): 2394982SN/A type = 'Sinic' 2405610SN/A cxx_class = 'Sinic::Device' 24111263Sandreas.sandberg@arm.com cxx_header = "dev/net/sinic.hh" 2422916SN/A 2434982SN/A rx_max_copy = Param.MemorySize('1514B', "rx max copy") 2444982SN/A tx_max_copy = Param.MemorySize('16kB', "tx max copy") 2454982SN/A rx_max_intr = Param.UInt32(10, "max rx packets per interrupt") 2464982SN/A rx_fifo_threshold = Param.MemorySize('384kB', "rx fifo high threshold") 2474982SN/A rx_fifo_low_mark = Param.MemorySize('128kB', "rx fifo low threshold") 2484982SN/A tx_fifo_high_mark = Param.MemorySize('384kB', "tx fifo high threshold") 2494982SN/A tx_fifo_threshold = Param.MemorySize('128kB', "tx fifo low threshold") 2504982SN/A virtual_count = Param.UInt32(1, "Virtualized SINIC") 2515603SN/A zero_copy_size = Param.UInt32(64, "Bytes to copy if below threshold") 2525603SN/A zero_copy_threshold = Param.UInt32(256, 2535603SN/A "Only zero copy above this threshold") 2544982SN/A zero_copy = Param.Bool(False, "Zero copy receive") 2554982SN/A delay_copy = Param.Bool(False, "Delayed copy transmit") 2564982SN/A virtual_addr = Param.Bool(False, "Virtual addressing") 2571310SN/A 2582916SN/A VendorID = 0x1291 2592916SN/A DeviceID = 0x1293 2602916SN/A Status = 0x0290 2612916SN/A SubClassCode = 0x00 2622916SN/A ClassCode = 0x02 2632916SN/A ProgIF = 0x00 2642916SN/A BAR0 = 0x00000000 2652916SN/A BAR1 = 0x00000000 2662916SN/A BAR2 = 0x00000000 2672916SN/A BAR3 = 0x00000000 2682916SN/A BAR4 = 0x00000000 2692916SN/A BAR5 = 0x00000000 2702916SN/A MaximumLatency = 0x34 2712916SN/A MinimumGrant = 0xb0 2722916SN/A InterruptLine = 0x1e 2732916SN/A InterruptPin = 0x01 2742916SN/A BAR0Size = '64kB' 2752916SN/A 2761310SN/A 277