i.MX6ULL驱动开发 | 33 - NXP原厂网络设备驱动浅读（LAN8720 PHY）

Posted 2022-08-25 Mculover666

一、硬件原理

1. 以太网硬件架构

正点原子imx6ull开发板的以太网硬件整体架构如下图：

2. LAN8720A PHY芯片

3. RJ45接口

用来插网线的是RJ45座，与PHY芯片相连的时候中间还需要接网络变压器。

RJ45座子上一般有两个灯，黄色灯闪烁表示当前正在进行网络通信，绿色灯亮表示网络连接正常。

二、设备树节点

在开发板的设备树描述文件中，两个以太网口的描述如下：

&fec1 
	pinctrl-names = "default";
	pinctrl-0 = <&pinctrl_enet1 &pinctrl_fec1_reset>;
	phy-mode = "rmii";
	phy-handle = <&ethphy0>;
	phy-reset-gpios = <&gpio5 7 GPIO_ACTIVE_LOW>;
	phy-reset-duration = <200>;
	status = "okay";
;

&fec2 
	pinctrl-names = "default";
	pinctrl-0 = <&pinctrl_enet2 &pinctrl_fec2_reset>;
	phy-mode = "rmii";
	phy-handle = <&ethphy1>;
	phy-reset-gpios = <&gpio5 8 GPIO_ACTIVE_LOW>;
	phy-reset-duration = <200>;
	status = "okay";

	mdio 
		#address-cells = <1>;
		#size-cells = <0>;

		ethphy0: ethernet-phy@0 
			compatible = "ethernet-phy-ieee802.3-c22";
			smsc,disable-energy-detect;
			reg = <0>;
		;

		ethphy1: ethernet-phy@1 
			compatible = "ethernet-phy-ieee802.3-c22";
			smsc,disable-energy-detect;
			reg = <1>;
		;
	;
;

1. imx6ull MAC外设节点描述

以太网外设节点名称为fec1和fec2，并且这是补充描述，所以在imx6ull芯片级的描述文件找到描述：

&fec1 
	pinctrl-names = "default";
	pinctrl-0 = <&pinctrl_enet1 &pinctrl_fec1_reset>;
	phy-mode = "rmii";
	phy-handle = <&ethphy0>;
	phy-reset-gpios = <&gpio5 7 GPIO_ACTIVE_LOW>;
	phy-reset-duration = <200>;
	status = "okay";
;

&fec2 
	pinctrl-names = "default";
	pinctrl-0 = <&pinctrl_enet2 &pinctrl_fec2_reset>;
	phy-mode = "rmii";
	phy-handle = <&ethphy1>;
	phy-reset-gpios = <&gpio5 8 GPIO_ACTIVE_LOW>;
	phy-reset-duration = <200>;
	status = "okay";

	mdio 
		#address-cells = <1>;
		#size-cells = <0>;

		ethphy0: ethernet-phy@0 
			compatible = "ethernet-phy-ieee802.3-c22";
			smsc,disable-energy-detect;
			reg = <0>;
		;

		ethphy1: ethernet-phy@1 
			compatible = "ethernet-phy-ieee802.3-c22";
			smsc,disable-energy-detect;
			reg = <1>;
		;
	;
;

找到兼容性为"fsl,imx6ul-fec"，根据此兼容性可以找到驱动源码为drivers/net/ethernet/freescale/fec_main.c。

绑定文档为：Documentation/devicetree/bindings/net/fsl-fec.txt，在绑定文档中给出FEC外设所必须的描述：

• compatible : Should be “fsl,-fec”
• reg : Address and length of the register set for the device
• interrupts : Should contain fec interrupt
• phy-mode : See ethernet.txt file in the same directory

其中phy-mode节点的值如下：

• phy-mode: string, operation mode of the PHY interface;
  supported values are “mii”, “gmii”, “sgmii”, “qsgmii”, “tbi”, “rev-mii”, “rmii”, “rgmii”,“rgmii-id”, “rgmii-rxid”, “rgmii-txid”, “rtbi”, “smii”, “xgmii”; this is now a de-facto standard property;

一些可选属性如下（节选）：

• phy-reset-gpios : Should specify the gpio for phy reset
• phy-reset-duration : Reset duration in milliseconds.
• phy-supply : regulator that powers the Ethernet PHY.
• phy-handle : phandle to the PHY device connected to this device.
• fixed-link : Assume a fixed link. See fixed-link.txt in the same directory. Use instead of phy-handle.

2. mdio总线节点描述

mdio用于和外接的PHY芯片通信，和实际开发板上外接的PHY芯片有关，兼容性是"ethernet-phy-ieee802.3-c22"，根据该兼容性找到对应的绑定文档为Documentation/devicetree/bindings/net/phy.txt。

其中给出必须的属性如下：

• interrupts : <a b> where a is the interrupt number and b is a field that represents an encoding of the sense and level information for the interrupt. This should be encoded based on the information in section 2) depending on the type of interrupt controller you have.
• interrupt-parent : the phandle for the interrupt controller that services interrupts for this device.
• reg : The ID number for the phy, usually a small integer

兼容性是可选属性，指定PHY芯片内部寄存器的信息。

• compatible: Compatible list, may contain “ethernet-phy-ieee802.3-c22” or “ethernet-phy-ieee802.3-c45” for PHYs that implement IEEE802.3 clause 22 or IEEE802.3 clause 45 specifications. If neither of these are specified, the default is to assume clause 22. The compatible list may also contain other elements.

在原子的教程中写道，在开启两个网口的情况下，将GPIO1_IO07和GPIO_1O06设置为ENET1的MDC和MDIO会导致网络工作不正常，所以设置在ENET2上。

三、FEC外设网络驱动源码浅读

对于imx6ull而言，网络驱动主要分为两部分：imx6ull网络外设驱动以及PHY芯片驱动。

其中imx6ull网络外设驱动是NXP原厂写好的，PHY芯片驱动是通用驱动文件。

根据设备树描述找到兼容性为"fsl,imx6ul-fec"，根据此兼容性可以找到驱动源码为drivers/net/ethernet/freescale/fec_main.c。

1. fec_probe挂载函数

（1）申请net_device

alloc_etherdev_mqs函数在net/ethernet/eth.c文件中实现：

可以看到，底层调用的就是网络驱动框架的API，用来申请一个网卡设备，名称为 ethx。所以在系统中可以看到默认的以太网设备都是eth0、eth1之类的名称。

（2）处理fec私有数据
（3）从设备树获取phy-handle属性的值、获取phy-mode
（4）获取时钟并使能时钟
（5）复位PHY

phy复位函数如下：

（6）初始化enet

在该函数中会分配队列、申请DMA、设置MAC地址。初始化net_device的netdev_ops和ethtool_ops成员：

之后，还设置poll函数来支持NAPI机制：

（7）MII/RMII接口的初始化

（8）申请中断

（9）注册网卡到系统

2. fec_netdev_ops操作集

其中最重要的是 fec_enet_start_xmit 函数实现，用于启动发送数据包：

在该发送函数中，上层的数据通过skb传入，首先对skb进行判断，是否为GSO数据，如果是则使用 fec_enet_txq_submit_tso 发送，如果不是则使用 fec_enet_txq_submit_skb 发送。

3. napi机制

网络中断的服务函数如下，可以看到中断服务函数中最重要的是进行napi的调度：

启动napi调度后，就会用初始化的时候注册的napi轮询函数去接收数据：

四、Linux内核PHY子系统与MDIO总线

PHY子系统也是一个设备、总线和驱动模型，分为PHY设备、PHY驱动以及MDIO总线。

1. PHY设备

Linux内核使用phy_device结构体来表示PHY设备，定义在文件include/linux/phy.h中。

一个PHY设备对应一个phy_device实例，使用下面的API完成PHY设备的注册：

int phy_device_register(struct phy_device *phy);

2. PHY驱动

Linux内核使用phy_driver结构体表示PHY驱动，定义在文件include/linux/phy.h中。

这个结构体比较大，编写PHY驱动的主要工作就是实现这些函数。

3. MDIO总线

PHY子系统中，因为PHY设备是通过MDIO接口来管理的，总线模型就是MDIO总线，负责匹配PHY设备和PHY驱动。

在文件drivers/net/phy/mdio_bus.c中定义了mdio_bys_type结构体来表示MDIO总线：

总线的匹配函数是mdio_bus_match，该函数实现如下：

可以看到，如果PHY设备与PHY驱动匹配，则使用指定的PHY驱动，如果不匹配则使用Linux内核自带的通用PHY驱动。

五、Linux内核提供的通用PHY驱动

通用PHY驱动名字为“Generic PHY”，在drivers/net/phy/phy_device.c文件中实现。

phy_init是整个PHY子系统的入口函数，其中向内核注册一个通用PHY驱动：genphy_driver，该数组定义如下：

其中提供了两个通用的PHY驱动，一个是针对10/100/1000M网络，另一个是针对10G网络的。

六、LAN8720A PHY驱动

SMSC针对自家的PHY芯片也编写了对应的驱动文件，其中包含了LAN8720A这个PHY芯片，实现在drivers/net/phy/smsc.c文件中。

在Linux内核启动日志中可以看到PHY使用的驱动为SMSC LAN8720：