Ethernet.py revision 12055
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 413102SN/Afrom m5.SimObject import SimObject 423102SN/Afrom m5.params import * 433102SN/Afrom m5.proxy import * 4411260SN/Afrom PciDevice import PciDevice 451310SN/A 464981SN/Aclass EtherObject(SimObject): 474981SN/A type = 'EtherObject' 481310SN/A abstract = True 4911263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherobject.hh" 501310SN/A 514981SN/Aclass EtherLink(EtherObject): 521366SN/A type = 'EtherLink' 5311263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherlink.hh" 548839SN/A int0 = SlavePort("interface 0") 558839SN/A int1 = SlavePort("interface 1") 561634SN/A delay = Param.Latency('0us', "packet transmit delay") 571952SN/A delay_var = Param.Latency('0ns', "packet transmit delay variability") 581702SN/A speed = Param.NetworkBandwidth('1Gbps', "link speed") 591310SN/A dump = Param.EtherDump(NULL, "dump object") 601310SN/A 6111290Sgabor.dozsa@arm.comclass DistEtherLink(EtherObject): 6211290Sgabor.dozsa@arm.com type = 'DistEtherLink' 6311290Sgabor.dozsa@arm.com cxx_header = "dev/net/dist_etherlink.hh" 6410923SN/A int0 = SlavePort("interface 0") 6510923SN/A delay = Param.Latency('0us', "packet transmit delay") 6610923SN/A delay_var = Param.Latency('0ns', "packet transmit delay variability") 6710923SN/A speed = Param.NetworkBandwidth('1Gbps', "link speed") 6810923SN/A dump = Param.EtherDump(NULL, "dump object") 6911290Sgabor.dozsa@arm.com dist_rank = Param.UInt32('0', "Rank of this gem5 process (dist run)") 7011290Sgabor.dozsa@arm.com dist_size = Param.UInt32('1', "Number of gem5 processes (dist run)") 7111290Sgabor.dozsa@arm.com sync_start = Param.Latency('5200000000000t', "first dist sync barrier") 7211290Sgabor.dozsa@arm.com sync_repeat = Param.Latency('10us', "dist sync barrier repeat") 7310923SN/A server_name = Param.String('localhost', "Message server name") 7410923SN/A server_port = Param.UInt32('2200', "Message server port") 7511290Sgabor.dozsa@arm.com is_switch = Param.Bool(False, "true if this a link in etherswitch") 7611703Smichael.lebeane@amd.com dist_sync_on_pseudo_op = Param.Bool(False, "Start sync with pseudo_op") 7711290Sgabor.dozsa@arm.com num_nodes = Param.UInt32('2', "Number of simulate nodes") 7810923SN/A 794981SN/Aclass EtherBus(EtherObject): 801366SN/A type = 'EtherBus' 8111263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherbus.hh" 821634SN/A loopback = Param.Bool(True, "send packet back to the sending interface") 831310SN/A dump = Param.EtherDump(NULL, "dump object") 841634SN/A speed = Param.NetworkBandwidth('100Mbps', "bus speed in bits per second") 851310SN/A 8611317Sm.alian1369@gmail.comclass EtherSwitch(EtherObject): 8711317Sm.alian1369@gmail.com type = 'EtherSwitch' 8811317Sm.alian1369@gmail.com cxx_header = "dev/net/etherswitch.hh" 8911317Sm.alian1369@gmail.com dump = Param.EtherDump(NULL, "dump object") 9011317Sm.alian1369@gmail.com fabric_speed = Param.NetworkBandwidth('10Gbps', "switch fabric speed in bits " 9111317Sm.alian1369@gmail.com "per second") 9211317Sm.alian1369@gmail.com interface = VectorMasterPort("Ethernet Interface") 9311317Sm.alian1369@gmail.com output_buffer_size = Param.MemorySize('1MB', "size of output port buffers") 9411317Sm.alian1369@gmail.com delay = Param.Latency('0us', "packet transmit delay") 9511317Sm.alian1369@gmail.com delay_var = Param.Latency('0ns', "packet transmit delay variability") 9611317Sm.alian1369@gmail.com time_to_live = Param.Latency('10ms', "time to live of MAC address maping") 9711317Sm.alian1369@gmail.com 9812055Sgabeblack@google.comclass EtherTapBase(EtherObject): 9912055Sgabeblack@google.com type = 'EtherTapBase' 10012055Sgabeblack@google.com abstract = True 10111263Sandreas.sandberg@arm.com cxx_header = "dev/net/ethertap.hh" 1021310SN/A bufsz = Param.Int(10000, "tap buffer size") 1031310SN/A dump = Param.EtherDump(NULL, "dump object") 10412055Sgabeblack@google.com tap = SlavePort("Ethernet interface to connect to gem5's network") 10512055Sgabeblack@google.com 10612055Sgabeblack@google.comclass EtherTapStub(EtherTapBase): 10712055Sgabeblack@google.com type = 'EtherTapStub' 10812055Sgabeblack@google.com cxx_header = "dev/net/ethertap.hh" 10912054Sgabeblack@google.com port = Param.UInt16(3500, "Port helper should send packets to") 1101310SN/A 1111692SN/Aclass EtherDump(SimObject): 1121366SN/A type = 'EtherDump' 11311263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherdump.hh" 1141310SN/A file = Param.String("dump file") 1151880SN/A maxlen = Param.Int(96, "max portion of packet data to dump") 1161310SN/A 1174981SN/Aclass EtherDevice(PciDevice): 1184981SN/A type = 'EtherDevice' 1194981SN/A abstract = True 12011263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherdevice.hh" 1218839SN/A interface = MasterPort("Ethernet Interface") 1224981SN/A 1234981SN/Aclass IGbE(EtherDevice): 1245763SN/A # Base class for two IGbE adapters listed above 1253116SN/A type = 'IGbE' 12611263Sandreas.sandberg@arm.com cxx_header = "dev/net/i8254xGBe.hh" 1274597SN/A hardware_address = Param.EthernetAddr(NextEthernetAddr, 1284597SN/A "Ethernet Hardware Address") 1294283SN/A rx_fifo_size = Param.MemorySize('384kB', "Size of the rx FIFO") 1304283SN/A tx_fifo_size = Param.MemorySize('384kB', "Size of the tx FIFO") 1314486SN/A rx_desc_cache_size = Param.Int(64, 1324486SN/A "Number of enteries in the rx descriptor cache") 1334486SN/A tx_desc_cache_size = Param.Int(64, 1344486SN/A "Number of enteries in the rx descriptor cache") 1353116SN/A VendorID = 0x8086 1363116SN/A SubsystemID = 0x1008 1373116SN/A SubsystemVendorID = 0x8086 1383116SN/A Status = 0x0000 1393116SN/A SubClassCode = 0x00 1403116SN/A ClassCode = 0x02 1413116SN/A ProgIF = 0x00 1423116SN/A BAR0 = 0x00000000 1433116SN/A BAR1 = 0x00000000 1443116SN/A BAR2 = 0x00000000 1453116SN/A BAR3 = 0x00000000 1463116SN/A BAR4 = 0x00000000 1473116SN/A BAR5 = 0x00000000 1483116SN/A MaximumLatency = 0x00 1493116SN/A MinimumGrant = 0xff 1503116SN/A InterruptLine = 0x1e 1513116SN/A InterruptPin = 0x01 1523116SN/A BAR0Size = '128kB' 1535535SN/A wb_delay = Param.Latency('10ns', "delay before desc writeback occurs") 1545535SN/A fetch_delay = Param.Latency('10ns', "delay before desc fetch occurs") 1555535SN/A fetch_comp_delay = Param.Latency('10ns', "delay after desc fetch occurs") 1565535SN/A wb_comp_delay = Param.Latency('10ns', "delay after desc wb occurs") 1575535SN/A tx_read_delay = Param.Latency('0ns', "delay after tx dma read") 1585535SN/A rx_write_delay = Param.Latency('0ns', "delay after rx dma read") 1595781SN/A phy_pid = Param.UInt16("Phy PID that corresponds to device ID") 1605781SN/A phy_epid = Param.UInt16("Phy EPID that corresponds to device ID") 1613116SN/A 1625763SN/Aclass IGbE_e1000(IGbE): 1635763SN/A # Older Intel 8254x based gigabit ethernet adapter 1645763SN/A # Uses Intel e1000 driver 1655763SN/A DeviceID = 0x1075 1665781SN/A phy_pid = 0x02A8 1675781SN/A phy_epid = 0x0380 1685763SN/A 1695763SN/Aclass IGbE_igb(IGbE): 1705763SN/A # Newer Intel 8257x based gigabit ethernet adapter 1715763SN/A # Uses Intel igb driver and in theory supports packet splitting and LRO 1725763SN/A DeviceID = 0x10C9 1735781SN/A phy_pid = 0x0141 1745781SN/A phy_epid = 0x0CC0 1755763SN/A 1764981SN/Aclass EtherDevBase(EtherDevice): 1774597SN/A type = 'EtherDevBase' 1784597SN/A abstract = True 17911263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherdevice.hh" 1809339SN/A 1811310SN/A hardware_address = Param.EthernetAddr(NextEthernetAddr, 1821310SN/A "Ethernet Hardware Address") 1831310SN/A 1841634SN/A dma_read_delay = Param.Latency('0us', "fixed delay for dma reads") 1851634SN/A dma_read_factor = Param.Latency('0us', "multiplier for dma reads") 1861634SN/A dma_write_delay = Param.Latency('0us', "fixed delay for dma writes") 1871634SN/A dma_write_factor = Param.Latency('0us', "multiplier for dma writes") 1881647SN/A 1891925SN/A rx_delay = Param.Latency('1us', "Receive Delay") 1901925SN/A tx_delay = Param.Latency('1us', "Transmit Delay") 1911925SN/A rx_fifo_size = Param.MemorySize('512kB', "max size of rx fifo") 1921925SN/A tx_fifo_size = Param.MemorySize('512kB', "max size of tx fifo") 1931310SN/A 1941369SN/A rx_filter = Param.Bool(True, "Enable Receive Filter") 1952008SN/A intr_delay = Param.Latency('10us', "Interrupt propagation delay") 1962008SN/A rx_thread = Param.Bool(False, "dedicated kernel thread for transmit") 1972008SN/A tx_thread = Param.Bool(False, "dedicated kernel threads for receive") 1982210SN/A rss = Param.Bool(False, "Receive Side Scaling") 1991310SN/A 2004982SN/Aclass NSGigE(EtherDevBase): 2014982SN/A type = 'NSGigE' 20211263Sandreas.sandberg@arm.com cxx_header = "dev/net/ns_gige.hh" 2034982SN/A 2044982SN/A dma_data_free = Param.Bool(False, "DMA of Data is free") 2054982SN/A dma_desc_free = Param.Bool(False, "DMA of Descriptors is free") 2064982SN/A dma_no_allocate = Param.Bool(True, "Should we allocate cache on read") 2074982SN/A 2082916SN/A VendorID = 0x100B 2092916SN/A DeviceID = 0x0022 2102916SN/A Status = 0x0290 2112916SN/A SubClassCode = 0x00 2122916SN/A ClassCode = 0x02 2132916SN/A ProgIF = 0x00 2142916SN/A BAR0 = 0x00000001 2152916SN/A BAR1 = 0x00000000 2162916SN/A BAR2 = 0x00000000 2172916SN/A BAR3 = 0x00000000 2182916SN/A BAR4 = 0x00000000 2192916SN/A BAR5 = 0x00000000 2202916SN/A MaximumLatency = 0x34 2212916SN/A MinimumGrant = 0xb0 2222916SN/A InterruptLine = 0x1e 2232916SN/A InterruptPin = 0x01 2242916SN/A BAR0Size = '256B' 2252916SN/A BAR1Size = '4kB' 2262916SN/A 2271310SN/A 2281644SN/A 2294982SN/Aclass Sinic(EtherDevBase): 2304982SN/A type = 'Sinic' 2315610SN/A cxx_class = 'Sinic::Device' 23211263Sandreas.sandberg@arm.com cxx_header = "dev/net/sinic.hh" 2332916SN/A 2344982SN/A rx_max_copy = Param.MemorySize('1514B', "rx max copy") 2354982SN/A tx_max_copy = Param.MemorySize('16kB', "tx max copy") 2364982SN/A rx_max_intr = Param.UInt32(10, "max rx packets per interrupt") 2374982SN/A rx_fifo_threshold = Param.MemorySize('384kB', "rx fifo high threshold") 2384982SN/A rx_fifo_low_mark = Param.MemorySize('128kB', "rx fifo low threshold") 2394982SN/A tx_fifo_high_mark = Param.MemorySize('384kB', "tx fifo high threshold") 2404982SN/A tx_fifo_threshold = Param.MemorySize('128kB', "tx fifo low threshold") 2414982SN/A virtual_count = Param.UInt32(1, "Virtualized SINIC") 2425603SN/A zero_copy_size = Param.UInt32(64, "Bytes to copy if below threshold") 2435603SN/A zero_copy_threshold = Param.UInt32(256, 2445603SN/A "Only zero copy above this threshold") 2454982SN/A zero_copy = Param.Bool(False, "Zero copy receive") 2464982SN/A delay_copy = Param.Bool(False, "Delayed copy transmit") 2474982SN/A virtual_addr = Param.Bool(False, "Virtual addressing") 2481310SN/A 2492916SN/A VendorID = 0x1291 2502916SN/A DeviceID = 0x1293 2512916SN/A Status = 0x0290 2522916SN/A SubClassCode = 0x00 2532916SN/A ClassCode = 0x02 2542916SN/A ProgIF = 0x00 2552916SN/A BAR0 = 0x00000000 2562916SN/A BAR1 = 0x00000000 2572916SN/A BAR2 = 0x00000000 2582916SN/A BAR3 = 0x00000000 2592916SN/A BAR4 = 0x00000000 2602916SN/A BAR5 = 0x00000000 2612916SN/A MaximumLatency = 0x34 2622916SN/A MinimumGrant = 0xb0 2632916SN/A InterruptLine = 0x1e 2642916SN/A InterruptPin = 0x01 2652916SN/A BAR0Size = '64kB' 2662916SN/A 2671310SN/A 268