Ethernet.py revision 11263
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 6110923SN/Aclass MultiEtherLink(EtherObject): 6210923SN/A type = 'MultiEtherLink' 6311263Sandreas.sandberg@arm.com cxx_header = "dev/net/multi_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") 6910923SN/A multi_rank = Param.UInt32('0', "Rank of the this gem5 process (multi run)") 7010923SN/A sync_start = Param.Latency('5200000000000t', "first multi sync barrier") 7110923SN/A sync_repeat = Param.Latency('10us', "multi sync barrier repeat") 7210923SN/A server_name = Param.String('localhost', "Message server name") 7310923SN/A server_port = Param.UInt32('2200', "Message server port") 7410923SN/A 754981SN/Aclass EtherBus(EtherObject): 761366SN/A type = 'EtherBus' 7711263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherbus.hh" 781634SN/A loopback = Param.Bool(True, "send packet back to the sending interface") 791310SN/A dump = Param.EtherDump(NULL, "dump object") 801634SN/A speed = Param.NetworkBandwidth('100Mbps', "bus speed in bits per second") 811310SN/A 824981SN/Aclass EtherTap(EtherObject): 831366SN/A type = 'EtherTap' 8411263Sandreas.sandberg@arm.com cxx_header = "dev/net/ethertap.hh" 851310SN/A bufsz = Param.Int(10000, "tap buffer size") 861310SN/A dump = Param.EtherDump(NULL, "dump object") 871310SN/A port = Param.UInt16(3500, "tap port") 881310SN/A 891692SN/Aclass EtherDump(SimObject): 901366SN/A type = 'EtherDump' 9111263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherdump.hh" 921310SN/A file = Param.String("dump file") 931880SN/A maxlen = Param.Int(96, "max portion of packet data to dump") 941310SN/A 954981SN/Aclass EtherDevice(PciDevice): 964981SN/A type = 'EtherDevice' 974981SN/A abstract = True 9811263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherdevice.hh" 998839SN/A interface = MasterPort("Ethernet Interface") 1004981SN/A 1014981SN/Aclass IGbE(EtherDevice): 1025763SN/A # Base class for two IGbE adapters listed above 1033116SN/A type = 'IGbE' 10411263Sandreas.sandberg@arm.com cxx_header = "dev/net/i8254xGBe.hh" 1054597SN/A hardware_address = Param.EthernetAddr(NextEthernetAddr, 1064597SN/A "Ethernet Hardware Address") 1074283SN/A rx_fifo_size = Param.MemorySize('384kB', "Size of the rx FIFO") 1084283SN/A tx_fifo_size = Param.MemorySize('384kB', "Size of the tx FIFO") 1094486SN/A rx_desc_cache_size = Param.Int(64, 1104486SN/A "Number of enteries in the rx descriptor cache") 1114486SN/A tx_desc_cache_size = Param.Int(64, 1124486SN/A "Number of enteries in the rx descriptor cache") 1133116SN/A VendorID = 0x8086 1143116SN/A SubsystemID = 0x1008 1153116SN/A SubsystemVendorID = 0x8086 1163116SN/A Status = 0x0000 1173116SN/A SubClassCode = 0x00 1183116SN/A ClassCode = 0x02 1193116SN/A ProgIF = 0x00 1203116SN/A BAR0 = 0x00000000 1213116SN/A BAR1 = 0x00000000 1223116SN/A BAR2 = 0x00000000 1233116SN/A BAR3 = 0x00000000 1243116SN/A BAR4 = 0x00000000 1253116SN/A BAR5 = 0x00000000 1263116SN/A MaximumLatency = 0x00 1273116SN/A MinimumGrant = 0xff 1283116SN/A InterruptLine = 0x1e 1293116SN/A InterruptPin = 0x01 1303116SN/A BAR0Size = '128kB' 1315535SN/A wb_delay = Param.Latency('10ns', "delay before desc writeback occurs") 1325535SN/A fetch_delay = Param.Latency('10ns', "delay before desc fetch occurs") 1335535SN/A fetch_comp_delay = Param.Latency('10ns', "delay after desc fetch occurs") 1345535SN/A wb_comp_delay = Param.Latency('10ns', "delay after desc wb occurs") 1355535SN/A tx_read_delay = Param.Latency('0ns', "delay after tx dma read") 1365535SN/A rx_write_delay = Param.Latency('0ns', "delay after rx dma read") 1375781SN/A phy_pid = Param.UInt16("Phy PID that corresponds to device ID") 1385781SN/A phy_epid = Param.UInt16("Phy EPID that corresponds to device ID") 1393116SN/A 1405763SN/Aclass IGbE_e1000(IGbE): 1415763SN/A # Older Intel 8254x based gigabit ethernet adapter 1425763SN/A # Uses Intel e1000 driver 1435763SN/A DeviceID = 0x1075 1445781SN/A phy_pid = 0x02A8 1455781SN/A phy_epid = 0x0380 1465763SN/A 1475763SN/Aclass IGbE_igb(IGbE): 1485763SN/A # Newer Intel 8257x based gigabit ethernet adapter 1495763SN/A # Uses Intel igb driver and in theory supports packet splitting and LRO 1505763SN/A DeviceID = 0x10C9 1515781SN/A phy_pid = 0x0141 1525781SN/A phy_epid = 0x0CC0 1535763SN/A 1544981SN/Aclass EtherDevBase(EtherDevice): 1554597SN/A type = 'EtherDevBase' 1564597SN/A abstract = True 15711263Sandreas.sandberg@arm.com cxx_header = "dev/net/etherdevice.hh" 1589339SN/A 1591310SN/A hardware_address = Param.EthernetAddr(NextEthernetAddr, 1601310SN/A "Ethernet Hardware Address") 1611310SN/A 1621634SN/A dma_read_delay = Param.Latency('0us', "fixed delay for dma reads") 1631634SN/A dma_read_factor = Param.Latency('0us', "multiplier for dma reads") 1641634SN/A dma_write_delay = Param.Latency('0us', "fixed delay for dma writes") 1651634SN/A dma_write_factor = Param.Latency('0us', "multiplier for dma writes") 1661647SN/A 1671925SN/A rx_delay = Param.Latency('1us', "Receive Delay") 1681925SN/A tx_delay = Param.Latency('1us', "Transmit Delay") 1691925SN/A rx_fifo_size = Param.MemorySize('512kB', "max size of rx fifo") 1701925SN/A tx_fifo_size = Param.MemorySize('512kB', "max size of tx fifo") 1711310SN/A 1721369SN/A rx_filter = Param.Bool(True, "Enable Receive Filter") 1732008SN/A intr_delay = Param.Latency('10us', "Interrupt propagation delay") 1742008SN/A rx_thread = Param.Bool(False, "dedicated kernel thread for transmit") 1752008SN/A tx_thread = Param.Bool(False, "dedicated kernel threads for receive") 1762210SN/A rss = Param.Bool(False, "Receive Side Scaling") 1771310SN/A 1784982SN/Aclass NSGigE(EtherDevBase): 1794982SN/A type = 'NSGigE' 18011263Sandreas.sandberg@arm.com cxx_header = "dev/net/ns_gige.hh" 1814982SN/A 1824982SN/A dma_data_free = Param.Bool(False, "DMA of Data is free") 1834982SN/A dma_desc_free = Param.Bool(False, "DMA of Descriptors is free") 1844982SN/A dma_no_allocate = Param.Bool(True, "Should we allocate cache on read") 1854982SN/A 1862916SN/A VendorID = 0x100B 1872916SN/A DeviceID = 0x0022 1882916SN/A Status = 0x0290 1892916SN/A SubClassCode = 0x00 1902916SN/A ClassCode = 0x02 1912916SN/A ProgIF = 0x00 1922916SN/A BAR0 = 0x00000001 1932916SN/A BAR1 = 0x00000000 1942916SN/A BAR2 = 0x00000000 1952916SN/A BAR3 = 0x00000000 1962916SN/A BAR4 = 0x00000000 1972916SN/A BAR5 = 0x00000000 1982916SN/A MaximumLatency = 0x34 1992916SN/A MinimumGrant = 0xb0 2002916SN/A InterruptLine = 0x1e 2012916SN/A InterruptPin = 0x01 2022916SN/A BAR0Size = '256B' 2032916SN/A BAR1Size = '4kB' 2042916SN/A 2051310SN/A 2061644SN/A 2074982SN/Aclass Sinic(EtherDevBase): 2084982SN/A type = 'Sinic' 2095610SN/A cxx_class = 'Sinic::Device' 21011263Sandreas.sandberg@arm.com cxx_header = "dev/net/sinic.hh" 2112916SN/A 2124982SN/A rx_max_copy = Param.MemorySize('1514B', "rx max copy") 2134982SN/A tx_max_copy = Param.MemorySize('16kB', "tx max copy") 2144982SN/A rx_max_intr = Param.UInt32(10, "max rx packets per interrupt") 2154982SN/A rx_fifo_threshold = Param.MemorySize('384kB', "rx fifo high threshold") 2164982SN/A rx_fifo_low_mark = Param.MemorySize('128kB', "rx fifo low threshold") 2174982SN/A tx_fifo_high_mark = Param.MemorySize('384kB', "tx fifo high threshold") 2184982SN/A tx_fifo_threshold = Param.MemorySize('128kB', "tx fifo low threshold") 2194982SN/A virtual_count = Param.UInt32(1, "Virtualized SINIC") 2205603SN/A zero_copy_size = Param.UInt32(64, "Bytes to copy if below threshold") 2215603SN/A zero_copy_threshold = Param.UInt32(256, 2225603SN/A "Only zero copy above this threshold") 2234982SN/A zero_copy = Param.Bool(False, "Zero copy receive") 2244982SN/A delay_copy = Param.Bool(False, "Delayed copy transmit") 2254982SN/A virtual_addr = Param.Bool(False, "Virtual addressing") 2261310SN/A 2272916SN/A VendorID = 0x1291 2282916SN/A DeviceID = 0x1293 2292916SN/A Status = 0x0290 2302916SN/A SubClassCode = 0x00 2312916SN/A ClassCode = 0x02 2322916SN/A ProgIF = 0x00 2332916SN/A BAR0 = 0x00000000 2342916SN/A BAR1 = 0x00000000 2352916SN/A BAR2 = 0x00000000 2362916SN/A BAR3 = 0x00000000 2372916SN/A BAR4 = 0x00000000 2382916SN/A BAR5 = 0x00000000 2392916SN/A MaximumLatency = 0x34 2402916SN/A MinimumGrant = 0xb0 2412916SN/A InterruptLine = 0x1e 2422916SN/A InterruptPin = 0x01 2432916SN/A BAR0Size = '64kB' 2442916SN/A 2451310SN/A 246