net: stmmac: add documentation for stmmac_dma_cfg members

Add documentation of each of the struct stmmac_dma_cfg members. dche
remains undocumented as I don't have documentation that covers this.

Signed-off-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>
Tested-by: Mohd Ayaan Anwar <mohd.anwar@oss.qualcomm.com>
Link: https://patch.msgid.link/E1vzX5U-0000000CVsQ-162V@rmk-PC.armlinux.org.uk
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

diff --git a/include/linux/stmmac.h b/include/linux/stmmac.h
index 11886189bf510674b81b0623d6dd93eed853c9c5..1af3a5e197c91309479d0cfff41ce43fee116a34 100644 (file)
--- a/include/linux/stmmac.h
+++ b/include/linux/stmmac.h
@@ -93,16 +93,37 @@ struct stmmac_mdio_bus_data {
 };
 
 struct stmmac_dma_cfg {
+       /* pbl: programmable burst limit
+        * txpbl: transmit programmable burst limit
+        * rxpbl: receive programmable burst limit
+        * If txpbl or rxpbl are zero, the value of pbl will be substituted.
+        * Range 0 - 63.
+        */
        int pbl;
        int txpbl;
        int rxpbl;
+       /* pblx8: multiplies pbl, txpbl, rxpbl by a factor of 8 for dwmac >=
+        * 3.50a, or a factor of 4 for previous versions.
+        */
        bool pblx8;
+       /* fixed_burst:
+        *  when set, AXI bursts defined by axi_blen_regval are permitted.
+        *   AHB uses SINGLE, INCR4, INCR8 or INCR16 during burst transfers.
+        *  when clear, AXI and AHB use SINGLE or INCR bursts.
+        */
        bool fixed_burst;
+       /* mixed_burst:
+        *  when set and fixed_burst is clear, AHB uses INCR for bursts > 16
+        *  and SINGLE or INCRx for bursts <= 16.
+        */
        bool mixed_burst;
+       /* aal: address aligned bursts for AHB and AXI master interface */
        bool aal;
+       bool dche;
        bool eame;
+       /* multi_msi_en: stmmac core internal */
        bool multi_msi_en;
-       bool dche;
+       /* atds: stmmac core internal */
        bool atds;
 };