有线网络和服务介绍

有线网络和服务介绍

适用人员

本文适用于想要了解Siflower有线网络和服务的相关从业人员。

开发环境

Siflower代码编译环境以及开发板测试环境。

功能概述

本文主要介绍Siflower以太网软硬件组成，目前提供的服务和接口，以及对接调试方法。

硬件组成

Siflower有线网络现有成员如下：

graph TB
  title(Siflower Ethernet Family)
  A(GMAC-HNAT<br>千兆MAC) --> |connect| B[GPHY]
  A --> |connect| C[GSWITCH]

GMAC-HNAT: 表示Siflower的千兆MAC, 其包含了HNAT硬件地址转换模块；
HNAT模块介绍参考: HNAT对接和使用手册　　 GPHY: 表示外围千兆PHY, 包含不同厂家的PHY芯片；
GSWITCH: 表示外围千兆SWITCH, 包含不同厂家的SWITCH芯片；
支持的外围芯片型号列表见: 支持的外围芯片列表

软件服务

基于现有以太网我们提供的基础软件服务：

graph TB
  title(Siflower Ethernet Service)
  A(Ethernet Driver) --> |provide| B[DPS<br>设备上下线通知]
  A(Ethernet Driver) --> |provide| C[VLAN划分]
  A(Ethernet Driver) --> |provide| D[Ethtool<br>速度双工设置]
  A(Ethernet Driver) --> |provide| E[WAN/LAN自适应]
  A(Ethernet Driver) --> |provide| F[TS流量统计]

DPS服务介绍

DPS全称为Detect Port Status，用于检测设备上下线状态，在网页和APP上正确显示，整体的流程如下。

graph TB
  title(DPS 流程图)
  A(以太网驱动循环检测phy link状态) --> |设备发生断开/连接| B[发送netlink消息通知应用层]
  B --> |应用层服务监听| C[应用层监听到设备断连事件]
  C -->  D[通过http post方式调用本地lua接口]
  D -->  E[lua接口更新在线设备列表]
  E -->  F[网页正确显示设备在线状态]
  D -->  G[lua接口将消息通知给APP]
  G -->  H[APP通知用户设备上下线]

设备上下线示例：在路由器串口下，执行logread -f &然后插拔网线，可以看到设备上下线日志如下：

root@OpenWrt:/# logread -f &
Wed Aug 26 16:42:28 2020 user.crit : dps msg received!
Wed Aug 26 16:42:28 2020 daemon.notice netifd: sf_eth_event port 3 updown 1 is_wan 0 vlanid 1 ifname eth0
Wed Aug 26 16:42:32 2020 user.crit : dps_check_newdev_process has finished!

Wed Aug 26 16:42:40 2020 user.crit : dps msg received!
Wed Aug 26 16:42:40 2020 daemon.notice netifd: sf_eth_event port 3 updown 0 is_wan 0 vlanid 1 ifname eth0
Wed Aug 26 16:42:44 2020 user.crit : dps_check_newdev_process has finished!

在设备插上或者拔出后可以去网页查看设备列表显示是否正常。

VLAN划分

参考: 以太网WAN-LAN划分指南

Ethtool速度双工设置

为了支持SWITCH多口ethtool设置，Siflower进行了自有开发，使用方法详细见：Ethtool使用方法

WAN-LAN自适应

参考: wan-lan自适应开发手册

TS流量统计

TS全称为Traffic Statistic，用于针对设备进行流量统计，主要原理是通过netfilter hook点 + hnat硬件转换报文统计进行流量统计, 目前仅支持下载速度显示．

如何基于Siflower的硬件进行二次开发

环境搭建

参考：快速入门

对外提供的接口

标准接口

提供了标准net_device_ops接口，switch_dev_ops接口，ethtool_ops接口，以intel7084 gswitch为例，展示详细接口介绍如下。

net_device_ops接口

我们提供的net_device_ops接口为标准接口，如下：

static const struct net_device_ops sgmac_netdev_ops = {    
        .ndo_open = sgmac_open,                            
        .ndo_start_xmit = sgmac_xmit,                      
        .ndo_stop = sgmac_stop,                            
        .ndo_change_mtu = sgmac_change_mtu,                
        .ndo_set_rx_mode = sgmac_set_rx_mode,              
        .ndo_tx_timeout = sgmac_tx_timeout,                
        .ndo_get_stats64 = sgmac_get_stats64,              
        .ndo_do_ioctl = sgmac_do_ioctl,                    
#ifdef CONFIG_NET_POLL_CONTROLLER                          
        .ndo_poll_controller = sgmac_poll_controller,      
#endif                                                     
        .ndo_validate_addr = eth_validate_addr,            
        .ndo_set_mac_address = sgmac_set_mac_address,      
        .ndo_vlan_rx_add_vid = sgmac_vlan_rx_add_vid,      
        .ndo_vlan_rx_kill_vid = sgmac_vlan_rx_kill_vid,    
        .ndo_set_features = sgmac_set_features,            
#if IS_ENABLED(CONFIG_NF_FLOW_TABLE)                       
    .ndo_flow_offload_check = sgmac_ndo_flow_offload_check,
    .ndo_flow_offload = sgmac_ndo_flow_offload,            
#endif                                                     
};                                                         

switch_dev_ops接口

我们提供的switch_dev_ops接口为标准接口，如下：

 struct switch_dev_ops gswitch_switch_ops = {
    .attr_global = {
        .attr = intel7084_globals,
        .n_attr = ARRAY_SIZE(intel7084_globals),
    },
    .attr_port = {
        .attr = intel7084_port,
        .n_attr = ARRAY_SIZE(intel7084_port),
    },
    .attr_vlan = {
        .attr = intel7084_vlan,
        .n_attr = ARRAY_SIZE(intel7084_vlan),
    },

    .get_vlan_ports = intel7084_get_vlan_ports,
    .set_vlan_ports = intel7084_set_vlan_ports,
    .get_port_pvid = intel7084_get_port_pvid,
    .set_port_pvid = intel7084_set_port_pvid,
    .get_port_link = intel7084_get_port_link,
    .reset_switch = intel7084_reset_switch,
};                                                    

ethtool_ops接口

针对ethtool_ops接口我们进行了优化，不仅支持单个GPHY的速度双工获取/设置，也支持GSWITCH每个口的速度双工获取/设置，详细使用方法如下：

GPHY Ethtool支持

支持的标准接口如下：

static const struct ethtool_ops sgmac_ethtool_ops = {     
.get_drvinfo = sgmac_ethtool_get_drvinfo,             
.get_link = ethtool_op_get_link,                      
.get_pauseparam = sgmac_ethtool_get_pauseparam,       
.set_pauseparam = sgmac_ethtool_set_pauseparam,       
.get_ethtool_stats = sgmac_ethtool_get_ethtool_stats, 
.get_strings = sgmac_ethtool_get_strings,             
.get_wol = sgmac_ethtool_get_wol,                     
.set_wol = sgmac_ethtool_set_wol,                     
.get_sset_count = sgmac_ethtool_get_sset_count,       
.get_regs_len = sgmac_ethtool_get_regs_len,           
.get_regs = sgmac_ethtool_gregs,                      
.nway_reset = sgmac_nway_reset,                       
.get_link_ksettings = phy_ethtool_get_link_ksettings, 
.set_link_ksettings = phy_ethtool_set_link_ksettings, 
};                                                        

使用方法：标准ethtool使用方法，可通过ethtool -h查看ethtool使用方法；

GSWITCH Ethtool支持

支持的标准接口如下：

struct ethtool_ops gswitch_ethtool_ops = {              
    .get_settings           = gsw_get_settings,     
    .set_settings           = gsw_set_settings,     
    .get_drvinfo            = gsw_get_drvinfo,      
    .get_sset_count         = gsw_get_sset_count,   
    .get_ethtool_stats      = gsw_get_ethtool_stats,
    .get_strings            = gsw_get_strings,      
    .get_link               = ethtool_op_get_link,  
    .nway_reset             = gsw_nway_reset,       
    .get_ringparam          = gsw_get_ringparam,    
};                                                      

使用方法：
- 获取指定phy速度双工：命令：
```
echo phyad phyid > /sys/kernel/debug/gmac_debug
ethtool eth0
```
  第一条命令：第一个参数phyad为固定字符串，表示选用此功能，第二个phyid为指定phy的id，取值0～5，表示指定phy；
  第二条命令：为标准ethtool获取速度双工命令，参数eth0为网卡名；
- 设置指定phy速度双工：命令：
```
ethtool -s eth0 speed 1000 duplex full phyad 3
```
  前面部分为标准ethtool设置速度双工命令，最后一个参数phyid为指定phy的id，取值0～5，为必填参数；

私有接口

提供了自定义的Debugfs节点供技术人员使用，如内部寄存器读写函数，phy/switch寄存器读写函数，检测phy link状态函数等等。不同的硬件对应不同的调用方法，以下将以Intel千兆switch为例展示提供的接口函数调用方法。

示例：

获取所有接口的帮助信息:
命令:
echo help > /sys/kernel/debug/esw_debug
结果展示如下:

echo help > /sys/kernel/debug/esw_debug
Attention: all example should append with '>  /sys/kernel/debug/esw_debug'
read/write switch reg, no value for read, witch value for write 
example: echo rwReg             [addr] [value] ,for realtek switch
example: echo rwReg             [addr] [shift] [size] [value] ,for intel switch
read/write switch phy reg, no value for read, witch value for write, support both intel/realtek switch
example: echo rwPHYReg          [port] [addr] [value]
set switch port egress mode, 0 for org, 1 for keep, only support realtek switch now
example: echo setPortEgressMode [port] [mode]
dump switch port tx/rx count, only support intel switch now
example: echo dumpSwitchCount           [port]          
clear switch port tx/rx count, only support intel switch now
example: echo clearSwitchCount          [port]          
enable software multicast function, only support intel switch now
example: echo enableMulticastFunc
port join/leave mc_ip group, only support intel switch now
example: echo setMulticastEntry [port] [type] [mc_ip]
dump multicast entries, only support intel switch now
example: echo dumpMulticastEntry

展示部分intel switch接口使用示例如下：　　

获取当前phylink状态：
命令：
cat /sys/kernel/debug/esw_debug
结果展示如下：

root@OpenWrt:/# cat /sys/kernel/debug/esw_debug
check phy link status
phy0    status 0
phy1    status 0
phy2    status 0
phy3    status 0
root@OpenWrt:/#

读写gswitch内部寄存器：
读命令：
echo rwReg [addr] [shift] [size] > /sys/kernel/debug/esw_debug
第一个参数表示读写寄存器，第二个为读取的寄存器地址，第三个为寄存器bit位地址偏移量，第四个为读取的bit位长度；
写命令：
echo rwReg [addr] [shift] [size] [value] > /sys/kernel/debug/esw_debug
第一个参数表示读写寄存器，第二个为读取的寄存器地址，第三个为寄存器bit位地址偏移量，第四个为读取的bit位长度，第五个参数为写入的值；
示例:
读写gswitch外围通用phy寄存器：
读命令：
echo rwPHYReg [port] [addr] > /sys/kernel/debug/esw_debug
第一个参数为选用此功能，第二个为phy的id，第三个为读取的寄存器地址；
写命令：
echo rwPHYReg [port] [addr] [value] > /sys/kernel/debug/esw_debug
第一个参数为选用此功能，第二个为phy的id，第三个为写寄存器的地址，第四个参数为写入的值；
示例:

展示部分realtek switch接口使用示例如下：

获取当前phylink状态：
命令：
cat /sys/kernel/debug/esw_debug
结果展示如下：

root@OpenWrt:/# cat /sys/kernel/debug/esw_debug
check phy link status
phy0    status 0
phy1    status 0
phy2    status 0
phy3    status 0
phy4    status 0
root@OpenWrt:/#

读写gswitch内部寄存器：
读命令：
echo rwReg [addr] > /sys/kernel/debug/esw_debug
第一个参数表示读写寄存器，第二个为读取的寄存器地址；
写命令：
echo rwReg [addr] [value] > /sys/kernel/debug/esw_debug
第一个参数表示读写寄存器，第二个为读取的寄存器地址，第三个参数为写入的值；
示例:
读写gswitch外围通用phy寄存器：
读命令：
echo rwPHYReg [port] [addr] > /sys/kernel/debug/esw_debug
第一个参数为选用此功能，第二个为phy的id，第三个为读取的寄存器地址；
写命令：
echo rwPHYReg [port] [addr] [value] > /sys/kernel/debug/esw_debug
第一个参数为选用此功能，第二个为phy的id，第三个为写寄存器的地址，第四个参数为写入的值；
示例:

支持的外围芯片列表

目前Siflower有线网络已支持如下外围芯片，如需增加新的外围设备可联系我们进行支持。

设备类型	设备型号
千兆PHY	Realtek8211
千兆PHY	Intel7061
千兆SWITCH	Realtek8367C
千兆SWITCH	Intel7084
千兆SWITCH	IP1707

项目引用

参考文档

快速入门 HNAT对接和使用手册以太网WAN-LAN划分指南 wan-lan自适应开发手册

FAQ

文档信息

本文作者：Phoenix
本文链接：https://siflower.github.io/2020/09/08/ethernetGuide/
版权声明：自由转载-非商用-非衍生-保持署名（创意共享3.0许可证）

矽昌通信

有线网络和服务介绍

有线网络和服务介绍

适用人员

开发环境

相关背景

功能概述

硬件组成

软件服务

DPS服务介绍

VLAN划分

Ethtool速度双工设置

WAN-LAN自适应

TS流量统计

如何基于Siflower的硬件进行二次开发

环境搭建

对外提供的接口

标准接口

net_device_ops接口

switch_dev_ops接口

ethtool_ops接口

私有接口

支持的外围芯片列表

项目引用

参考文档

FAQ

文档信息

Search

Table of Contents