Linux Driver for the Synopsys Ethernet Controllers "stmmac"

지원 컨트롤러와 기능

이 문서는 `GPL-2.0+` 라이선스를 따릅니다.

Synopsys(R) Ethernet 컨트롤러용 Linux 드라이버 "stmmac"

작성자: Giuseppe Cavallaro <[email protected]>, Alexandre Torgue <[email protected]>, Jose Abreu <[email protected]>

목차

• 이번 릴리스
• 기능 목록
• 커널 구성
• 명령줄 매개변수
• 드라이버 정보와 참고 사항
• 디버그 정보
• 지원

이번 릴리스

이 파일은 모든 Synopsys(R) Ethernet 컨트롤러를 위한 `stmmac` Linux 드라이버를 설명합니다.

현재 이 네트워크 장치 드라이버는 모든 STi 내장 MAC/GMAC, 즉 7xxx/5xxx SoC와 SPEAr(Arm), Loongson1B(MIPS), XILINX XC2V3000 FF1152AMT0221 D1215994A VIRTEX FPGA 보드를 지원합니다. Synopsys Ethernet QoS 5.0 IPK도 지원합니다.

드라이버 개발에는 DesignWare Cores Ethernet MAC 10/100/1000 Universal 3.70a 이하와 Ethernet Quality-of-Service 4.0 이상, XGMAC 10G Ethernet MAC, Enterprise MAC 100G Ethernet MAC이 사용되었습니다.

이 드라이버는 platform bus와 PCI를 모두 지원합니다.

지원하는 Synopsys DesignWare Ethernet 컨트롤러와 최소·최대 버전은 다음과 같습니다.

하드웨어 요구 사항에 관한 질문은 Ethernet 어댑터와 함께 제공된 문서를 참조하십시오. 나열된 모든 하드웨어 요구 사항은 Linux에서 사용할 때도 적용됩니다.

기능 목록

• GMII, MII, RGMII, SGMII, RMII, XGMII, XLGMII 인터페이스
• 반이중 및 전이중 동작
• EEE(Energy Efficient Ethernet)
• IEEE 802.3x PAUSE 패킷 기반 흐름 제어
• RMON/MIB 카운터
• IEEE 1588 타임스탬프(PTP)와 PPS 출력
• MDIO Clause 22 및 Clause 45 인터페이스
• MAC loopback과 ARP offload
• 자동 CRC/PAD 삽입 및 검사
• 송수신 패킷 체크섬 오프로딩
• 표준 및 점보 Ethernet 패킷
• 송신 주소 삽입 및 교체
• VLAN TAG 삽입·교체·삭제와 HASH/PERFECT 필터링
• 프로그래밍 가능한 TX/RX watchdog 및 coalesce
• PERFECT 목적지 주소 필터와 multicast HASH 필터
• Layer 3 및 Layer 4 필터링
• 원격 wake-up 감지
• RSS(Receive Side Scaling)
• TX/RX frame preemption
• 프로그래밍 가능한 burst length, threshold, queue size
• 최대 8개의 다중 큐
• TX의 WRR·DWRR·WFQ·SP·CBS·EST·TBS와 RX의 WRR·SP 스케줄러
• 유연한 RX parser
• TCP/UDP segmentation offload(TSO, USO)
• SPH(Split Header)
• ECC 및 데이터 parity 보호를 포함한 safety 기능
• Ethtool 기반 selftest

.. SPDX-License-Identifier: GPL-2.0+

==============================================================
Linux Driver for the Synopsys(R) Ethernet Controllers "stmmac"
==============================================================

Authors: Giuseppe Cavallaro <[email protected]>,
Alexandre Torgue <[email protected]>, Jose Abreu <[email protected]>

Contents
========

- In This Release
- Feature List
- Kernel Configuration
- Command Line Parameters
- Driver Information and Notes
- Debug Information
- Support

In This Release
===============

This file describes the stmmac Linux Driver for all the Synopsys(R) Ethernet
Controllers.

Currently, this network device driver is for all STi embedded MAC/GMAC
(i.e. 7xxx/5xxx SoCs), SPEAr (arm), Loongson1B (mips) and XILINX XC2V3000
FF1152AMT0221 D1215994A VIRTEX FPGA board. The Synopsys Ethernet QoS 5.0 IPK
is also supported.

DesignWare(R) Cores Ethernet MAC 10/100/1000 Universal version 3.70a
(and older) and DesignWare(R) Cores Ethernet Quality-of-Service version 4.0
(and upper) have been used for developing this driver as well as
DesignWare(R) Cores XGMAC - 10G Ethernet MAC and DesignWare(R) Cores
Enterprise MAC - 100G Ethernet MAC.

This driver supports both the platform bus and PCI.

This driver includes support for the following Synopsys(R) DesignWare(R)
Cores Ethernet Controllers and corresponding minimum and maximum versions:

+-------------------------------+--------------+--------------+--------------+
| Controller Name               | Min. Version | Max. Version | Abbrev. Name |
+===============================+==============+==============+==============+
| Ethernet MAC Universal        | N/A          | 3.73a        | GMAC         |
+-------------------------------+--------------+--------------+--------------+
| Ethernet Quality-of-Service   | 4.00a        | N/A          | GMAC4+       |
+-------------------------------+--------------+--------------+--------------+
| XGMAC - 10G Ethernet MAC      | 2.10a        | N/A          | XGMAC2+      |
+-------------------------------+--------------+--------------+--------------+
| XLGMAC - 100G Ethernet MAC    | 2.00a        | N/A          | XLGMAC2+     |
+-------------------------------+--------------+--------------+--------------+

For questions related to hardware requirements, refer to the documentation
supplied with your Ethernet adapter. All hardware requirements listed apply
to use with Linux.

Feature List
============

The following features are available in this driver:
 - GMII/MII/RGMII/SGMII/RMII/XGMII/XLGMII Interface
 - Half-Duplex / Full-Duplex Operation
 - Energy Efficient Ethernet (EEE)
 - IEEE 802.3x PAUSE Packets (Flow Control)
 - RMON/MIB Counters
 - IEEE 1588 Timestamping (PTP)
 - Pulse-Per-Second Output (PPS)
 - MDIO Clause 22 / Clause 45 Interface
 - MAC Loopback
 - ARP Offloading
 - Automatic CRC / PAD Insertion and Checking
 - Checksum Offload for Received and Transmitted Packets
 - Standard or Jumbo Ethernet Packets
 - Source Address Insertion / Replacement
 - VLAN TAG Insertion / Replacement / Deletion / Filtering (HASH and PERFECT)
 - Programmable TX and RX Watchdog and Coalesce Settings
 - Destination Address Filtering (PERFECT)
 - HASH Filtering (Multicast)
 - Layer 3 / Layer 4 Filtering
 - Remote Wake-Up Detection
 - Receive Side Scaling (RSS)
 - Frame Preemption for TX and RX
 - Programmable Burst Length, Threshold, Queue Size
 - Multiple Queues (up to 8)
 - Multiple Scheduling Algorithms (TX: WRR, DWRR, WFQ, SP, CBS, EST, TBS;
   RX: WRR, SP)
 - Flexible RX Parser
 - TCP / UDP Segmentation Offload (TSO, USO)
 - Split Header (SPH)
 - Safety Features (ECC Protection, Data Parity Protection)
 - Selftests using Ethtool

커널 구성과 명령줄 매개변수

커널 구성

주 커널 구성 옵션은 `CONFIG_STMMAC_ETH`입니다. `CONFIG_STMMAC_PLATFORM`은 platform driver를 활성화하고, `CONFIG_STMMAC_PCI`는 PCI driver를 활성화합니다.

명령줄 매개변수

드라이버를 모듈로 빌드한 경우 다음 구문으로 `modprobe` 명령에 선택적 매개변수를 지정할 수 있습니다. 예시는 PCI 모듈 기준입니다.

modprobe stmmac_pci [<option>=<VAL1>,<VAL2>,...]

다음과 같이 커널 명령줄로도 드라이버 매개변수를 전달할 수 있습니다.

stmmaceth=watchdog:100,chain_mode=1

별도 설명이 없다면 각 매개변수의 기본값이 일반적으로 권장 설정입니다.

Kernel Configuration
====================

The kernel configuration option is ``CONFIG_STMMAC_ETH``:
 - ``CONFIG_STMMAC_PLATFORM``: is to enable the platform driver.
 - ``CONFIG_STMMAC_PCI``: is to enable the pci driver.

Command Line Parameters
=======================

If the driver is built as a module the following optional parameters are used
by entering them on the command line with the modprobe command using this
syntax (e.g. for PCI module)::

    modprobe stmmac_pci [<option>=<VAL1>,<VAL2>,...]

Driver parameters can be also passed in command line by using::

    stmmaceth=watchdog:100,chain_mode=1

The default value for each parameter is generally the recommended setting,
unless otherwise noted.

watchdog
--------
:Valid Range: 5000-None
:Default Value: 5000

This parameter overrides the transmit timeout in milliseconds.

debug
-----
:Valid Range: 0-16 (0=none,...,16=all)
:Default Value: 0

This parameter adjusts the level of debug messages displayed in the system
logs.

phyaddr
-------
:Valid Range: 0-31
:Default Value: -1

This parameter overrides the physical address of the PHY device.

flow_ctrl
---------
:Valid Range: 0-3 (0=off,1=rx,2=tx,3=rx/tx)
:Default Value: 3

This parameter changes the default Flow Control ability.

pause
-----
:Valid Range: 0-65535
:Default Value: 65535

This parameter changes the default Flow Control Pause time.

tc
--
:Valid Range: 64-256
:Default Value: 64

This parameter changes the default HW FIFO Threshold control value.

buf_sz
------
:Valid Range: 1536-16384
:Default Value: 1536

This parameter changes the default RX DMA packet buffer size.

eee_timer
---------
:Valid Range: 0-None
:Default Value: 1000

This parameter changes the default LPI TX Expiration time in milliseconds.

chain_mode
----------
:Valid Range: 0-1 (0=off,1=on)
:Default Value: 0

This parameter changes the default mode of operation from Ring Mode to
Chain Mode.

송수신 경로, 인터럽트와 DMA descriptor

드라이버 정보와 참고 사항

송신 과정

커널이 패킷을 보내야 할 때 xmit 메서드가 호출됩니다. 이 메서드는 ring의 descriptor를 설정하고 DMA 엔진에 송신할 패킷이 준비되었음을 알립니다.

기본적으로 드라이버는 `net_device` 구조체의 features 필드에 `NETIF_F_SG` 비트를 설정하여 scatter-gather를 활성화합니다. 하드웨어가 체크섬을 처리할 수 있는 칩과 구성에서 적용됩니다.

컨트롤러가 패킷 송신을 마치면 송신 자원을 해제하도록 timer를 예약합니다.

수신 과정

패킷을 하나 이상 받으면 인터럽트가 발생합니다. 인터럽트는 큐에 쌓이지 않으므로 수신 과정에서 드라이버가 ring의 모든 descriptor를 검사해야 합니다.

이 과정은 NAPI 기반입니다. 인터럽트 핸들러는 처리할 작업이 있을 때만 신호를 남기고 종료하며, poll 메서드는 이후 시점에 예약됩니다.

DMA는 수신 패킷을 미리 할당된 socket buffer 목록에 저장하여 `memcpy`를 피합니다. 즉 zero-copy 방식입니다.

인터럽트 완화

3.50보다 오래된 칩에서는 NAPI를 이용해 DMA 수신 인터럽트 수를 줄입니다. 새 칩은 하드웨어 RX Watchdog을 사용합니다. 완화 매개변수는 `ethtool`로 조정할 수 있습니다.

WoL

GMAC, GMAC4/5, XGMAC 코어에서 Magic 및 Unicast 프레임을 통한 Wake on LAN을 지원합니다.

DMA descriptor

드라이버는 normal descriptor와 alternate descriptor를 모두 처리합니다. alternate 형식은 DesignWare Ethernet MAC Universal 3.41a 이상에서만 시험되었습니다.

`stmmac`은 DMA descriptor를 dual-buffer RING 모드와 linked-list CHAINED 모드로 운용할 수 있습니다. RING에서는 descriptor 하나가 데이터 버퍼 포인터 두 개를 가리키고, CHAINED에서는 하나만 가리킵니다. 기본값은 RING입니다.

CHAINED 모드에서는 각 descriptor 안에 다음 descriptor를 가리키는 포인터가 있어 명시적인 연결 목록을 만듭니다. RING 모드에서는 이와 같은 명시적 연결을 만들 수 없습니다.

확장 descriptor

확장 descriptor는 Ethernet payload가 PTP 패킷이거나 IP 위의 TCP, UDP, ICMP일 때 추가 정보를 제공합니다. 3.50보다 오래된 GMAC Synopsys 칩에서는 사용할 수 없습니다. probe 시점에 드라이버가 실제 사용 가능 여부를 결정합니다. 하드웨어 timestamp와 Extended Status를 저장할 추가 descriptor가 필요하므로 PTPv2에도 필수입니다.

Driver Information and Notes
============================

Transmit Process
----------------

The xmit method is invoked when the kernel needs to transmit a packet; it sets
the descriptors in the ring and informs the DMA engine that there is a packet
ready to be transmitted.

By default, the driver sets the ``NETIF_F_SG`` bit in the features field of
the ``net_device`` structure, enabling the scatter-gather feature. This is
true on chips and configurations where the checksum can be done in hardware.

Once the controller has finished transmitting the packet, timer will be
scheduled to release the transmit resources.

Receive Process
---------------

When one or more packets are received, an interrupt happens. The interrupts
are not queued, so the driver has to scan all the descriptors in the ring
during the receive process.

This is based on NAPI, so the interrupt handler signals only if there is work
to be done, and it exits. Then the poll method will be scheduled at some
future point.

The incoming packets are stored, by the DMA, in a list of pre-allocated socket
buffers in order to avoid the memcpy (zero-copy).

Interrupt Mitigation
--------------------

The driver is able to mitigate the number of its DMA interrupts using NAPI for
the reception on chips older than the 3.50. New chips have an HW RX Watchdog
used for this mitigation.

Mitigation parameters can be tuned by ethtool.

WoL
---

Wake up on Lan feature through Magic and Unicast frames are supported for the
GMAC, GMAC4/5 and XGMAC core.

DMA Descriptors
---------------

Driver handles both normal and alternate descriptors. The latter has been only
tested on DesignWare(R) Cores Ethernet MAC Universal version 3.41a and later.

stmmac supports DMA descriptor to operate both in dual buffer (RING) and
linked-list(CHAINED) mode. In RING each descriptor points to two data buffer
pointers whereas in CHAINED mode they point to only one data buffer pointer.
RING mode is the default.

In CHAINED mode each descriptor will have pointer to next descriptor in the
list, hence creating the explicit chaining in the descriptor itself, whereas
such explicit chaining is not possible in RING mode.

Extended Descriptors
--------------------

The extended descriptors give us information about the Ethernet payload when
it is carrying PTP packets or TCP/UDP/ICMP over IP. These are not available on
GMAC Synopsys(R) chips older than the 3.50. At probe time the driver will
decide if these can be actually used. This support also is mandatory for PTPv2
because the extra descriptors are used for saving the hardware timestamps and
Extended Status.

Ethtool, segmentation, EEE, PTP와 PHY

Ethtool 지원

Ethtool을 지원합니다. RMON을 포함한 드라이버 통계와 내부 오류는 다음 명령으로 확인할 수 있습니다.

ethtool -S ethX

Ethtool selftest도 지원합니다. MAC과 PHY loopback을 이용해 하드웨어의 기본 정상 여부를 조기에 검사할 수 있습니다.

ethtool -t ethX

점보 프레임과 segmentation offload

점보 프레임은 GMAC에서 지원되고 시험되었습니다. GSO도 추가되었지만 소프트웨어로 수행됩니다. LRO는 지원하지 않습니다.

TSO 지원

TSO(TCP Segmentation Offload)는 GMAC 4.x 초과 버전과 XGMAC 제품군에서 지원됩니다. 일반적인 TCP 송신에서는 TCP stack이 하위 드라이버에 넘기는 SKB가 최대 프레임 길이에 맞도록 보장합니다. MTU가 1500이면 IP header, TCP header, payload 합계가 1500바이트 이하여야 합니다. header를 포함한 길이가 1514바이트를 넘으면 소프트웨어가 payload를 나누고 각 조각에 TCP/IP header를 붙여 여러 TCP 패킷을 만듭니다.

TSO를 활성화하면 TCP stack은 최대 프레임 길이를 고려하지 않고 SKB를 그대로 `stmmac`에 전달합니다. GMAC IP가 최대 프레임 길이에 맞게 직접 segmentation을 수행합니다.

device tree의 `snps,tso` 항목으로 이 기능을 활성화할 수 있습니다.

Energy Efficient Ethernet

EEE(Energy Efficient Ethernet)는 IEEE 802.3 MAC sublayer와 Physical layer 제품군이 LPI(Low Power Idle) 모드로 동작하게 합니다. EEE 모드는 100Mbps, 1000Mbps, 1Gbps의 IEEE 802.3 MAC 동작을 지원합니다.

LPI는 송수신할 데이터가 없을 때 통신 장치의 일부 기능을 꺼 전력을 절감합니다. 링크 양쪽 시스템이 링크 이용률이 낮은 동안 기능 일부를 비활성화할 수 있습니다. MAC은 LPI 진입과 이탈을 결정해 PHY에 알립니다.

인터페이스를 열면 드라이버가 DMA 하드웨어 capability register와 PHY 장치 MCD register를 모두 확인하여 EEE 지원 여부를 검증합니다. TX LPI 모드에 들어가려면 송신할 것이 없을 때 LPI를 켜고 끄는 software timer가 필요합니다.

PTP(Precision Time Protocol)

드라이버는 네트워크 통신 기반 측정 및 제어 시스템의 시계를 정밀하게 동기화하는 IEEE 1588-2002 PTP를 지원합니다. 새 GMAC 코어는 IEEE 1588-2002의 기본 timestamp 기능에 더해 고급 timestamp 기능도 지원합니다. 커널 구성에서 IEEE 1588-2008을 활성화할 수 있습니다.

SGMII/RGMII 지원

새 GMAC 장치는 RGMII/SGMII를 자체적으로 관리합니다. 하드웨어 capability register를 런타임에 확인할 수 있으므로 `stmmac`은 PHYLIB 없이 auto-negotiation과 링크 상태를 관리할 수 있습니다. 하드웨어의 확장 register 일부를 이용해 ANE를 재시작하고 전이중·반이중 모드와 속도를 확인하며, auto-negotiation으로 합의한 link partner capability도 읽을 수 있습니다.

Physical

드라이버는 Physical Abstraction Layer와 호환되며 PHY 및 GPHY 장치에 연결할 수 있습니다.

Ethtool Support
---------------

Ethtool is supported. For example, driver statistics (including RMON),
internal errors can be taken using::

    ethtool -S ethX

Ethtool selftests are also supported. This allows to do some early sanity
checks to the HW using MAC and PHY loopback mechanisms::

    ethtool -t ethX

Jumbo and Segmentation Offloading
---------------------------------

Jumbo frames are supported and tested for the GMAC. The GSO has been also
added but it's performed in software. LRO is not supported.

TSO Support
-----------

TSO (TCP Segmentation Offload) feature is supported by GMAC > 4.x and XGMAC
chip family. When a packet is sent through TCP protocol, the TCP stack ensures
that the SKB provided to the low level driver (stmmac in our case) matches
with the maximum frame len (IP header + TCP header + payload <= 1500 bytes
(for MTU set to 1500)). It means that if an application using TCP want to send
a packet which will have a length (after adding headers) > 1514 the packet
will be split in several TCP packets: The data payload is split and headers
(TCP/IP ..) are added. It is done by software.

When TSO is enabled, the TCP stack doesn't care about the maximum frame length
and provide SKB packet to stmmac as it is. The GMAC IP will have to perform
the segmentation by it self to match with maximum frame length.

This feature can be enabled in device tree through ``snps,tso`` entry.

Energy Efficient Ethernet
-------------------------

Energy Efficient Ethernet (EEE) enables IEEE 802.3 MAC sublayer along with a
family of Physical layer to operate in the Low Power Idle (LPI) mode. The EEE
mode supports the IEEE 802.3 MAC operation at 100Mbps, 1000Mbps and 1Gbps.

The LPI mode allows power saving by switching off parts of the communication
device functionality when there is no data to be transmitted & received.
The system on both the side of the link can disable some functionalities and
save power during the period of low-link utilization. The MAC controls whether
the system should enter or exit the LPI mode and communicate this to PHY.

As soon as the interface is opened, the driver verifies if the EEE can be
supported. This is done by looking at both the DMA HW capability register and
the PHY devices MCD registers.

To enter in TX LPI mode the driver needs to have a software timer that enable
and disable the LPI mode when there is nothing to be transmitted.

Precision Time Protocol (PTP)
-----------------------------

The driver supports the IEEE 1588-2002, Precision Time Protocol (PTP), which
enables precise synchronization of clocks in measurement and control systems
implemented with technologies such as network communication.

In addition to the basic timestamp features mentioned in IEEE 1588-2002
Timestamps, new GMAC cores support the advanced timestamp features.
IEEE 1588-2008 can be enabled when configuring the Kernel.

SGMII/RGMII Support
-------------------

New GMAC devices provide own way to manage RGMII/SGMII. This information is
available at run-time by looking at the HW capability register. This means
that the stmmac can manage auto-negotiation and link status w/o using the
PHYLIB stuff. In fact, the HW provides a subset of extended registers to
restart the ANE, verify Full/Half duplex mode and Speed. Thanks to these
registers, it is possible to look at the Auto-negotiated Link Parter Ability.

Physical
--------

The driver is compatible with Physical Abstraction Layer to be connected with
PHY and GPHY devices.

platform data의 MAC, DMA와 보드 설정

Platform 정보

여러 정보를 platform data와 device tree를 통해 전달할 수 있습니다. `struct plat_stmmacenet_data`의 필드는 다음과 같습니다.

`fix_mac_speed` callback은 physical layer가 협상한 속도에 따라 일부 ST SoC의 syscfg register를 수정합니다. `init`과 `exit` callback은 PIO line이나 system configuration register를 미리 설정해야 하는 platform에서 쓰며 platform data를 사용하거나 변경해서는 안 됩니다.

`setup` callback은 버스 하드웨어 설정을 수행합니다. 일부 ST platform에서는 AMBA bridge가 더 효율적인 STBus traffic을 만들도록 구성하는 데 사용됩니다.

Platform Information
--------------------

Several information can be passed through the platform and device-tree.

::

    struct plat_stmmacenet_data {

1) Bus identifier::

        int bus_id;

2) PHY Physical Address. If set to -1 the driver will pick the first PHY it
finds::

        int phy_addr;

3) PHY Device Interface::

        int interface;

4) Specific platform fields for the MDIO bus::

        struct stmmac_mdio_bus_data *mdio_bus_data;

5) Internal DMA parameters::

        struct stmmac_dma_cfg *dma_cfg;

6) Fixed CSR Clock Range selection::

        int clk_csr;

7) HW uses the GMAC core::

        int has_gmac;

8) If set the MAC will use Enhanced Descriptors::

        int enh_desc;

9) Core is able to perform TX Checksum and/or RX Checksum in HW::

        int tx_coe;
        int rx_coe;

11) Some HWs are not able to perform the csum in HW for over-sized frames due
to limited buffer sizes. Setting this flag the csum will be done in SW on
JUMBO frames::

        int bugged_jumbo;

12) Core has the embedded power module::

        int pmt;

13) Force DMA to use the Store and Forward mode or Threshold mode::

        int force_sf_dma_mode;
        int force_thresh_dma_mode;

15) Force to disable the RX Watchdog feature and switch to NAPI mode::

        int riwt_off;

16) Limit the maximum operating speed and MTU::

        int max_speed;
        int maxmtu;

18) Number of Multicast/Unicast filters::

        int multicast_filter_bins;
        int unicast_filter_entries;

20) Limit the maximum TX and RX FIFO size::

        int tx_fifo_size;
        int rx_fifo_size;

21) Use the specified number of TX and RX Queues::

        u32 rx_queues_to_use;
        u32 tx_queues_to_use;

22) Use the specified TX and RX scheduling algorithm::

        u8 rx_sched_algorithm;
        u8 tx_sched_algorithm;

23) Internal TX and RX Queue parameters::

        struct stmmac_rxq_cfg rx_queues_cfg[MTL_MAX_RX_QUEUES];
        struct stmmac_txq_cfg tx_queues_cfg[MTL_MAX_TX_QUEUES];

24) This callback is used for modifying some syscfg registers (on ST SoCs)
according to the link speed negotiated by the physical layer::

        void (*fix_mac_speed)(void *priv, unsigned int speed);

25) Callbacks used for calling a custom initialization; This is sometimes
necessary on some platforms (e.g. ST boxes) where the HW needs to have set
some PIO lines or system cfg registers. init/exit callbacks should not use
or modify platform data::

        int (*init)(struct platform_device *pdev, void *priv);
        void (*exit)(struct platform_device *pdev, void *priv);

26) Perform HW setup of the bus. For example, on some ST platforms this field
is used to configure the AMBA bridge to generate more efficient STBus traffic::

        struct mac_device_info *(*setup)(void *priv);
        void *bsp_priv;

27) Internal clocks and rates::

        struct clk *stmmac_clk;
        struct clk *pclk;
        struct clk *clk_ptp_ref;
        unsigned int clk_ptp_rate;
        unsigned int clk_ref_rate;
        s32 ptp_max_adj;

28) Main reset::

        struct reset_control *stmmac_rst;

29) AXI Internal Parameters::

        struct stmmac_axi *axi;

30) HW uses GMAC>4 cores::

        int has_gmac4;

31) HW is sun8i based::

        bool has_sun8i;

32) Enables TSO feature::

        bool tso_en;

33) Enables Receive Side Scaling (RSS) feature::

        int rss_en;

34) MAC Port selection::

        int mac_port_sel_speed;

35) Enables TX LPI Clock Gating::

        bool en_tx_lpi_clockgating;

36) HW uses XGMAC>2.10 cores::

        int has_xgmac;

::

    }

MDIO, DMA engine과 AXI 매개변수

MDIO 버스 데이터

`struct stmmac_mdio_bus_data`는 다음 정보를 가집니다.

DMA engine 구성

`struct stmmac_dma_cfg`는 다음 정보를 가집니다.

DMA AXI 매개변수

`struct stmmac_axi`는 다음 정보를 가집니다.

For MDIO bus data, we have:

::

    struct stmmac_mdio_bus_data {

1) PHY mask passed when MDIO bus is registered::

        unsigned int phy_mask;

2) List of IRQs, one per PHY::

        int *irqs;

3) If IRQs is NULL, use this for probed PHY::

        int probed_phy_irq;

4) Set to true if PHY needs reset::

        bool needs_reset;

::

    }

For DMA engine configuration, we have:

::

    struct stmmac_dma_cfg {

1) Programmable Burst Length (TX and RX)::

        int pbl;

2) If set, DMA TX / RX will use this value rather than pbl::

        int txpbl;
        int rxpbl;

3) Enable 8xPBL::

        bool pblx8;

4) Enable Fixed or Mixed burst::

        int fixed_burst;
        int mixed_burst;

5) Enable Address Aligned Beats::

        bool aal;

6) Enable Enhanced Addressing (> 32 bits)::

        bool eame;

::

    }

For DMA AXI parameters, we have:

::

    struct stmmac_axi {

1) Enable AXI LPI::

        bool axi_lpi_en;
        bool axi_xit_frm;

2) Set AXI Write / Read maximum outstanding requests::

        u32 axi_wr_osr_lmt;
        u32 axi_rd_osr_lmt;

3) Set AXI 4KB bursts::

        bool axi_kbbe;

4) Set AXI maximum burst length map::

        u32 axi_blen[AXI_BLEN];

5) Set AXI Fixed burst / mixed burst::

        bool axi_fb;
        bool axi_mb;

6) Set AXI rebuild incrx mode::

        bool axi_rb;

::

    }

RX/TX 큐, 하드웨어 기능, 디버깅과 지원

RX 큐 구성

`struct stmmac_rxq_cfg`는 다음 정보를 가집니다.

TX 큐 구성

`struct stmmac_txq_cfg`는 다음 정보를 가집니다.

Device Tree 정보

device tree 속성은 `Documentation/devicetree/bindings/net/snps,dwmac.yaml` 문서를 참조하십시오.

하드웨어 capability

capability register가 있는 새 칩에서는 EEE, hardware checksum, PTP, enhanced descriptor 같은 구성의 실제 지원 여부를 런타임에 많이 발견합니다. 이 드라이버의 전략상 하드웨어 capability register에서 얻은 정보가 platform에서 전달된 정보를 대체할 수 있습니다.

디버그 정보

드라이버는 내부 통계, 디버그 정보, MAC 및 DMA register 등 많은 정보를 내보냅니다. 필요한 정보의 종류에 따라 여러 방법으로 읽을 수 있습니다.

`ethtool -S ethX`는 지원되는 경우 MMC(Management Counter)를 포함한 통계를 보여 주고, `ethtool -d ethX`는 MAC/DMA register를 보여 줍니다.

커널을 `CONFIG_DEBUG_FS`와 함께 컴파일하면 드라이버가 다음 debugfs 항목을 제공합니다.

• `descriptors_status`: DMA TX/RX descriptor ring 표시
• `dma_cap`: 하드웨어 capability 표시

개발자는 `debug` 모듈 매개변수로 추가 디버그 정보를 얻을 수 있습니다. NETIF Message Level 설명도 참조하십시오.

지원

지원되는 커널과 어댑터에서 배포된 소스 코드의 문제를 발견했다면 문제와 관련된 구체적인 정보를 `[email protected]`로 보내십시오.

For the RX Queues configuration, we have:

::

    struct stmmac_rxq_cfg {

1) Mode to use (DCB or AVB)::

        u8 mode_to_use;

2) DMA channel to use::

        u32 chan;

3) Packet routing, if applicable::

        u8 pkt_route;

4) Use priority routing, and priority to route::

        bool use_prio;
        u32 prio;

::

    }

For the TX Queues configuration, we have:

::

    struct stmmac_txq_cfg {

1) Queue weight in scheduler::

        u32 weight;

2) Mode to use (DCB or AVB)::

        u8 mode_to_use;

3) Credit Base Shaper Parameters::

        u32 send_slope;
        u32 idle_slope;
        u32 high_credit;
        u32 low_credit;

4) Use priority scheduling, and priority::

        bool use_prio;
        u32 prio;

::

    }

Device Tree Information
-----------------------

Please refer to the following document:
Documentation/devicetree/bindings/net/snps,dwmac.yaml

HW Capabilities
---------------

Note that, starting from new chips, where it is available the HW capability
register, many configurations are discovered at run-time for example to
understand if EEE, HW csum, PTP, enhanced descriptor etc are actually
available. As strategy adopted in this driver, the information from the HW
capability register can replace what has been passed from the platform.

Debug Information
=================

The driver exports many information i.e. internal statistics, debug
information, MAC and DMA registers etc.

These can be read in several ways depending on the type of the information
actually needed.

For example a user can be use the ethtool support to get statistics: e.g.
using: ``ethtool -S ethX`` (that shows the Management counters (MMC) if
supported) or sees the MAC/DMA registers: e.g. using: ``ethtool -d ethX``

Compiling the Kernel with ``CONFIG_DEBUG_FS`` the driver will export the
following debugfs entries:

 - ``descriptors_status``: To show the DMA TX/RX descriptor rings
 - ``dma_cap``: To show the HW Capabilities

Developer can also use the ``debug`` module parameter to get further debug
information (please see: NETIF Msg Level).

Support
=======

If an issue is identified with the released source code on a supported kernel
with a supported adapter, email the specific information related to the
issue to [email protected]