Skip to content

Commit 0ec2ccd

Browse files
cavagiudavem330
authored andcommitted
stmmac: update the driver Documentation and add EEE
This patch updates the stmmac's documentation adding some missing files in the section used to describe the internal driver's structure. Also the patch adds a new section to describe the EEE support. Signed-off-by: Giuseppe Cavallaro <peppe.cavallaro@st.com> Signed-off-by: David S. Miller <davem@davemloft.net>
1 parent ea2ab87 commit 0ec2ccd

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

Documentation/networking/stmmac.txt

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,11 @@ reset procedure etc).
257257
o Makefile
258258
o stmmac_main.c: main network device driver;
259259
o stmmac_mdio.c: mdio functions;
260+
o stmmac_pci: PCI driver;
261+
o stmmac_platform.c: platform driver
260262
o stmmac_ethtool.c: ethtool support;
261263
o stmmac_timer.[ch]: timer code used for mitigating the driver dma interrupts
262-
Only tested on ST40 platforms based.
264+
(only tested on ST40 platforms based);
263265
o stmmac.h: private driver structure;
264266
o common.h: common definitions and VFTs;
265267
o descs.h: descriptor structure definitions;
@@ -269,9 +271,11 @@ reset procedure etc).
269271
o dwmac100_core: MAC 100 core and dma code;
270272
o dwmac100_dma.c: dma funtions for the MAC chip;
271273
o dwmac1000.h: specific header file for the MAC;
272-
o dwmac_lib.c: generic DMA functions shared among chips
273-
o enh_desc.c: functions for handling enhanced descriptors
274-
o norm_desc.c: functions for handling normal descriptors
274+
o dwmac_lib.c: generic DMA functions shared among chips;
275+
o enh_desc.c: functions for handling enhanced descriptors;
276+
o norm_desc.c: functions for handling normal descriptors;
277+
o chain_mode.c/ring_mode.c:: functions to manage RING/CHAINED modes;
278+
o mmc_core.c/mmc.h: Management MAC Counters;
275279

276280
5) Debug Information
277281

@@ -304,7 +308,27 @@ All these are only useful during the developing stage
304308
and should never enabled inside the code for general usage.
305309
In fact, these can generate an huge amount of debug messages.
306310

307-
6) TODO:
311+
6) Energy Efficient Ethernet
312+
313+
Energy Efficient Ethernet(EEE) enables IEEE 802.3 MAC sublayer along
314+
with a family of Physical layer to operate in the Low power Idle(LPI)
315+
mode. The EEE mode supports the IEEE 802.3 MAC operation at 100Mbps,
316+
1000Mbps & 10Gbps.
317+
318+
The LPI mode allows power saving by switching off parts of the
319+
communication device functionality when there is no data to be
320+
transmitted & received. The system on both the side of the link can
321+
disable some functionalities & save power during the period of low-link
322+
utilization. The MAC controls whether the system should enter or exit
323+
the LPI mode & communicate this to PHY.
324+
325+
As soon as the interface is opened, the driver verifies if the EEE can
326+
be supported. This is done by looking at both the DMA HW capability
327+
register and the PHY devices MCD registers.
328+
To enter in Tx LPI mode the driver needs to have a software timer
329+
that enable and disable the LPI mode when there is nothing to be
330+
transmitted.
331+
332+
7) TODO:
308333
o XGMAC is not supported.
309-
o Add the EEE - Energy Efficient Ethernet
310334
o Add the PTP - precision time protocol

0 commit comments

Comments
 (0)