evie/android_kernel_oneplus_msm8998
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

stmmac: review driver documentation

Browse source 
This patch reviews the driver documentation file;
for example, there were some new fields (in the driver
module parameter section) and the ptp files were
not documented.

Signed-off-by: Giuseppe Cavallaro <peppe.cavallaro@st.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
Giuseppe CAVALLARO 2013-04-08 02:09:59 +00:00 • committed by David S. Miller
parent 4d8f082547
commit 49cfbf675c
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Documentation/networking/stmmac.txt
View file

@ -1,6 +1,6 @@
STMicroelectronics 10/100/1000 Synopsys Ethernet driver STMicroelectronics 10/100/1000 Synopsys Ethernet driver
Copyright (C) 2007-2010 STMicroelectronics Ltd Copyright (C) 2007-2013 STMicroelectronics Ltd
Author: Giuseppe Cavallaro <peppe.cavallaro@st.com> Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
This is the driver for the MAC 10/100/1000 on-chip Ethernet controllers This is the driver for the MAC 10/100/1000 on-chip Ethernet controllers
@ -10,7 +10,7 @@ Currently this network device driver is for all STM embedded MAC/GMAC
(i.e. 7xxx/5xxx SoCs), SPEAr (arm), Loongson1B (mips) and XLINX XC2V3000 (i.e. 7xxx/5xxx SoCs), SPEAr (arm), Loongson1B (mips) and XLINX XC2V3000
FF1152AMT0221 D1215994A VIRTEX FPGA board. FF1152AMT0221 D1215994A VIRTEX FPGA board.
DWC Ether MAC 10/100/1000 Universal version 3.60a (and older) and DWC Ether DWC Ether MAC 10/100/1000 Universal version 3.70a (and older) and DWC Ether
MAC 10/100 Universal version 4.0 have been used for developing this driver. MAC 10/100 Universal version 4.0 have been used for developing this driver.
This driver supports both the platform bus and PCI. This driver supports both the platform bus and PCI.
@ -32,6 +32,8 @@ The kernel configuration option is STMMAC_ETH:
watchdog: transmit timeout (in milliseconds); watchdog: transmit timeout (in milliseconds);
flow_ctrl: Flow control ability [on/off]; flow_ctrl: Flow control ability [on/off];
pause: Flow Control Pause Time; pause: Flow Control Pause Time;
eee_timer: tx EEE timer;
chain_mode: select chain mode instead of ring.
3) Command line options 3) Command line options
Driver parameters can be also passed in command line by using: Driver parameters can be also passed in command line by using:
@ -164,12 +166,12 @@ Where:
o bus_setup: perform HW setup of the bus. For example, on some ST platforms o bus_setup: perform HW setup of the bus. For example, on some ST platforms
this field is used to configure the AMBA bridge to generate more this field is used to configure the AMBA bridge to generate more
efficient STBus traffic. efficient STBus traffic.
o init/exit: callbacks used for calling a custom initialisation; o init/exit: callbacks used for calling a custom initialization;
this is sometime necessary on some platforms (e.g. ST boxes) this is sometime necessary on some platforms (e.g. ST boxes)
where the HW needs to have set some PIO lines or system cfg where the HW needs to have set some PIO lines or system cfg
registers. registers.
o custom_cfg/custom_data: this is a custom configuration that can be passed o custom_cfg/custom_data: this is a custom configuration that can be passed
while initialising the resources. while initializing the resources.
o bsp_priv: another private poiter. o bsp_priv: another private poiter.
For MDIO bus The we have: For MDIO bus The we have:
@ -273,6 +275,8 @@ reset procedure etc).
o norm_desc.c: functions for handling normal descriptors; o norm_desc.c: functions for handling normal descriptors;
o chain_mode.c/ring_mode.c:: functions to manage RING/CHAINED modes; o chain_mode.c/ring_mode.c:: functions to manage RING/CHAINED modes;
o mmc_core.c/mmc.h: Management MAC Counters; o mmc_core.c/mmc.h: Management MAC Counters;
o stmmac_hwtstamp.c: HW timestamp support for PTP
o stmmac_ptp.c: PTP 1588 clock
5) Debug Information 5) Debug Information