1 Altera Triple-Speed Ethernet MAC driver 2 3Copyright (C) 2008-2014 Altera Corporation 4 5This is the driver for the Altera Triple-Speed Ethernet (TSE) controllers 6using the SGDMA and MSGDMA soft DMA IP components. The driver uses the 7platform bus to obtain component resources. The designs used to test this 8driver were built for a Cyclone(R) V SOC FPGA board, a Cyclone(R) V FPGA board, 9and tested with ARM and NIOS processor hosts separately. The anticipated use 10cases are simple communications between an embedded system and an external peer 11for status and simple configuration of the embedded system. 12 13For more information visit www.altera.com and www.rocketboards.org. Support 14forums for the driver may be found on www.rocketboards.org, and a design used 15to test this driver may be found there as well. Support is also available from 16the maintainer of this driver, found in MAINTAINERS. 17 18The Triple-Speed Ethernet, SGDMA, and MSGDMA components are all soft IP 19components that can be assembled and built into an FPGA using the Altera 20Quartus toolchain. Quartus 13.1 and 14.0 were used to build the design that 21this driver was tested against. The sopc2dts tool is used to create the 22device tree for the driver, and may be found at rocketboards.org. 23 24The driver probe function examines the device tree and determines if the 25Triple-Speed Ethernet instance is using an SGDMA or MSGDMA component. The 26probe function then installs the appropriate set of DMA routines to 27initialize, setup transmits, receives, and interrupt handling primitives for 28the respective configurations. 29 30The SGDMA component is to be deprecated in the near future (over the next 1-2 31years as of this writing in early 2014) in favor of the MSGDMA component. 32SGDMA support is included for existing designs and reference in case a 33developer wishes to support their own soft DMA logic and driver support. Any 34new designs should not use the SGDMA. 35 36The SGDMA supports only a single transmit or receive operation at a time, and 37therefore will not perform as well compared to the MSGDMA soft IP. Please 38visit www.altera.com for known, documented SGDMA errata. 39 40Scatter-gather DMA is not supported by the SGDMA or MSGDMA at this time. 41Scatter-gather DMA will be added to a future maintenance update to this 42driver. 43 44Jumbo frames are not supported at this time. 45 46The driver limits PHY operations to 10/100Mbps, and has not yet been fully 47tested for 1Gbps. This support will be added in a future maintenance update. 48 491) Kernel Configuration 50The kernel configuration option is ALTERA_TSE: 51 Device Drivers ---> Network device support ---> Ethernet driver support ---> 52 Altera Triple-Speed Ethernet MAC support (ALTERA_TSE) 53 542) Driver parameters list: 55 debug: message level (0: no output, 16: all); 56 dma_rx_num: Number of descriptors in the RX list (default is 64); 57 dma_tx_num: Number of descriptors in the TX list (default is 64). 58 593) Command line options 60Driver parameters can be also passed in command line by using: 61 altera_tse=dma_rx_num:128,dma_tx_num:512 62 634) Driver information and notes 64 654.1) Transmit process 66When the driver's transmit routine is called by the kernel, it sets up a 67transmit descriptor by calling the underlying DMA transmit routine (SGDMA or 68MSGDMA), and initiates a transmit operation. Once the transmit is complete, an 69interrupt is driven by the transmit DMA logic. The driver handles the transmit 70completion in the context of the interrupt handling chain by recycling 71resource required to send and track the requested transmit operation. 72 734.2) Receive process 74The driver will post receive buffers to the receive DMA logic during driver 75initialization. Receive buffers may or may not be queued depending upon the 76underlying DMA logic (MSGDMA is able queue receive buffers, SGDMA is not able 77to queue receive buffers to the SGDMA receive logic). When a packet is 78received, the DMA logic generates an interrupt. The driver handles a receive 79interrupt by obtaining the DMA receive logic status, reaping receive 80completions until no more receive completions are available. 81 824.3) Interrupt Mitigation 83The driver is able to mitigate the number of its DMA interrupts 84using NAPI for receive operations. Interrupt mitigation is not yet supported 85for transmit operations, but will be added in a future maintenance release. 86 874.4) Ethtool support 88Ethtool is supported. Driver statistics and internal errors can be taken using: 89ethtool -S ethX command. It is possible to dump registers etc. 90 914.5) PHY Support 92The driver is compatible with PAL to work with PHY and GPHY devices. 93 944.7) List of source files: 95 o Kconfig 96 o Makefile 97 o altera_tse_main.c: main network device driver 98 o altera_tse_ethtool.c: ethtool support 99 o altera_tse.h: private driver structure and common definitions 100 o altera_msgdma.h: MSGDMA implementation function definitions 101 o altera_sgdma.h: SGDMA implementation function definitions 102 o altera_msgdma.c: MSGDMA implementation 103 o altera_sgdma.c: SGDMA implementation 104 o altera_sgdmahw.h: SGDMA register and descriptor definitions 105 o altera_msgdmahw.h: MSGDMA register and descriptor definitions 106 o altera_utils.c: Driver utility functions 107 o altera_utils.h: Driver utility function definitions 108 1095) Debug Information 110 111The driver exports debug information such as internal statistics, 112debug information, MAC and DMA registers etc. 113 114A user may use the ethtool support to get statistics: 115e.g. using: ethtool -S ethX (that shows the statistics counters) 116or sees the MAC registers: e.g. using: ethtool -d ethX 117 118The developer can also use the "debug" module parameter to get 119further debug information. 120 1216) Statistics Support 122 123The controller and driver support a mix of IEEE standard defined statistics, 124RFC defined statistics, and driver or Altera defined statistics. The four 125specifications containing the standard definitions for these statistics are 126as follows: 127 128 o IEEE 802.3-2012 - IEEE Standard for Ethernet. 129 o RFC 2863 found at http://www.rfc-editor.org/rfc/rfc2863.txt. 130 o RFC 2819 found at http://www.rfc-editor.org/rfc/rfc2819.txt. 131 o Altera Triple Speed Ethernet User Guide, found at http://www.altera.com 132 133The statistics supported by the TSE and the device driver are as follows: 134 135"tx_packets" is equivalent to aFramesTransmittedOK defined in IEEE 802.3-2012, 136Section 5.2.2.1.2. This statistics is the count of frames that are successfully 137transmitted. 138 139"rx_packets" is equivalent to aFramesReceivedOK defined in IEEE 802.3-2012, 140Section 5.2.2.1.5. This statistic is the count of frames that are successfully 141received. This count does not include any error packets such as CRC errors, 142length errors, or alignment errors. 143 144"rx_crc_errors" is equivalent to aFrameCheckSequenceErrors defined in IEEE 145802.3-2012, Section 5.2.2.1.6. This statistic is the count of frames that are 146an integral number of bytes in length and do not pass the CRC test as the frame 147is received. 148 149"rx_align_errors" is equivalent to aAlignmentErrors defined in IEEE 802.3-2012, 150Section 5.2.2.1.7. This statistic is the count of frames that are not an 151integral number of bytes in length and do not pass the CRC test as the frame is 152received. 153 154"tx_bytes" is equivalent to aOctetsTransmittedOK defined in IEEE 802.3-2012, 155Section 5.2.2.1.8. This statistic is the count of data and pad bytes 156successfully transmitted from the interface. 157 158"rx_bytes" is equivalent to aOctetsReceivedOK defined in IEEE 802.3-2012, 159Section 5.2.2.1.14. This statistic is the count of data and pad bytes 160successfully received by the controller. 161 162"tx_pause" is equivalent to aPAUSEMACCtrlFramesTransmitted defined in IEEE 163802.3-2012, Section 30.3.4.2. This statistic is a count of PAUSE frames 164transmitted from the network controller. 165 166"rx_pause" is equivalent to aPAUSEMACCtrlFramesReceived defined in IEEE 167802.3-2012, Section 30.3.4.3. This statistic is a count of PAUSE frames 168received by the network controller. 169 170"rx_errors" is equivalent to ifInErrors defined in RFC 2863. This statistic is 171a count of the number of packets received containing errors that prevented the 172packet from being delivered to a higher level protocol. 173 174"tx_errors" is equivalent to ifOutErrors defined in RFC 2863. This statistic 175is a count of the number of packets that could not be transmitted due to errors. 176 177"rx_unicast" is equivalent to ifInUcastPkts defined in RFC 2863. This 178statistic is a count of the number of packets received that were not addressed 179to the broadcast address or a multicast group. 180 181"rx_multicast" is equivalent to ifInMulticastPkts defined in RFC 2863. This 182statistic is a count of the number of packets received that were addressed to 183a multicast address group. 184 185"rx_broadcast" is equivalent to ifInBroadcastPkts defined in RFC 2863. This 186statistic is a count of the number of packets received that were addressed to 187the broadcast address. 188 189"tx_discards" is equivalent to ifOutDiscards defined in RFC 2863. This 190statistic is the number of outbound packets not transmitted even though an 191error was not detected. An example of a reason this might occur is to free up 192internal buffer space. 193 194"tx_unicast" is equivalent to ifOutUcastPkts defined in RFC 2863. This 195statistic counts the number of packets transmitted that were not addressed to 196a multicast group or broadcast address. 197 198"tx_multicast" is equivalent to ifOutMulticastPkts defined in RFC 2863. This 199statistic counts the number of packets transmitted that were addressed to a 200multicast group. 201 202"tx_broadcast" is equivalent to ifOutBroadcastPkts defined in RFC 2863. This 203statistic counts the number of packets transmitted that were addressed to a 204broadcast address. 205 206"ether_drops" is equivalent to etherStatsDropEvents defined in RFC 2819. 207This statistic counts the number of packets dropped due to lack of internal 208controller resources. 209 210"rx_total_bytes" is equivalent to etherStatsOctets defined in RFC 2819. 211This statistic counts the total number of bytes received by the controller, 212including error and discarded packets. 213 214"rx_total_packets" is equivalent to etherStatsPkts defined in RFC 2819. 215This statistic counts the total number of packets received by the controller, 216including error, discarded, unicast, multicast, and broadcast packets. 217 218"rx_undersize" is equivalent to etherStatsUndersizePkts defined in RFC 2819. 219This statistic counts the number of correctly formed packets received less 220than 64 bytes long. 221 222"rx_oversize" is equivalent to etherStatsOversizePkts defined in RFC 2819. 223This statistic counts the number of correctly formed packets greater than 1518 224bytes long. 225 226"rx_64_bytes" is equivalent to etherStatsPkts64Octets defined in RFC 2819. 227This statistic counts the total number of packets received that were 64 octets 228in length. 229 230"rx_65_127_bytes" is equivalent to etherStatsPkts65to127Octets defined in RFC 2312819. This statistic counts the total number of packets received that were 232between 65 and 127 octets in length inclusive. 233 234"rx_128_255_bytes" is equivalent to etherStatsPkts128to255Octets defined in 235RFC 2819. This statistic is the total number of packets received that were 236between 128 and 255 octets in length inclusive. 237 238"rx_256_511_bytes" is equivalent to etherStatsPkts256to511Octets defined in 239RFC 2819. This statistic is the total number of packets received that were 240between 256 and 511 octets in length inclusive. 241 242"rx_512_1023_bytes" is equivalent to etherStatsPkts512to1023Octets defined in 243RFC 2819. This statistic is the total number of packets received that were 244between 512 and 1023 octets in length inclusive. 245 246"rx_1024_1518_bytes" is equivalent to etherStatsPkts1024to1518Octets define 247in RFC 2819. This statistic is the total number of packets received that were 248between 1024 and 1518 octets in length inclusive. 249 250"rx_gte_1519_bytes" is a statistic defined specific to the behavior of the 251Altera TSE. This statistics counts the number of received good and errored 252frames between the length of 1519 and the maximum frame length configured 253in the frm_length register. See the Altera TSE User Guide for More details. 254 255"rx_jabbers" is equivalent to etherStatsJabbers defined in RFC 2819. This 256statistic is the total number of packets received that were longer than 1518 257octets, and had either a bad CRC with an integral number of octets (CRC Error) 258or a bad CRC with a non-integral number of octets (Alignment Error). 259 260"rx_runts" is equivalent to etherStatsFragments defined in RFC 2819. This 261statistic is the total number of packets received that were less than 64 octets 262in length and had either a bad CRC with an integral number of octets (CRC 263error) or a bad CRC with a non-integral number of octets (Alignment Error). 264
