snps,dwmac.yaml

Version: - FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10
    1 # SPDX-License-Identifier: GPL-2.0
    2 %YAML 1.2
    3 ---
    4 $id: http://devicetree.org/schemas/net/snps,dwmac.yaml#
    5 $schema: http://devicetree.org/meta-schemas/core.yaml#
    6 
    7 title: Synopsys DesignWare MAC Device Tree Bindings
    8 
    9 maintainers:
   10   - Alexandre Torgue <alexandre.torgue@foss.st.com>
   11   - Giuseppe Cavallaro <peppe.cavallaro@st.com>
   12   - Jose Abreu <joabreu@synopsys.com>
   13 
   14 # Select every compatible, including the deprecated ones. This way, we
   15 # will be able to report a warning when we have that compatible, since
   16 # we will validate the node thanks to the select, but won't report it
   17 # as a valid value in the compatible property description
   18 select:
   19   properties:
   20     compatible:
   21       contains:
   22         enum:
   23           - snps,dwmac
   24           - snps,dwmac-3.40a
   25           - snps,dwmac-3.50a
   26           - snps,dwmac-3.610
   27           - snps,dwmac-3.70a
   28           - snps,dwmac-3.710
   29           - snps,dwmac-4.00
   30           - snps,dwmac-4.10a
   31           - snps,dwmac-4.20a
   32           - snps,dwmac-5.10a
   33           - snps,dwxgmac
   34           - snps,dwxgmac-2.10
   35 
   36           # Deprecated
   37           - st,spear600-gmac
   38 
   39   required:
   40     - compatible
   41 
   42 properties:
   43 
   44   # We need to include all the compatibles from schemas that will
   45   # include that schemas, otherwise compatible won't validate for
   46   # those.
   47   compatible:
   48     contains:
   49       enum:
   50         - allwinner,sun7i-a20-gmac
   51         - allwinner,sun8i-a83t-emac
   52         - allwinner,sun8i-h3-emac
   53         - allwinner,sun8i-r40-gmac
   54         - allwinner,sun8i-v3s-emac
   55         - allwinner,sun50i-a64-emac
   56         - amlogic,meson6-dwmac
   57         - amlogic,meson8b-dwmac
   58         - amlogic,meson8m2-dwmac
   59         - amlogic,meson-gxbb-dwmac
   60         - amlogic,meson-axg-dwmac
   61         - ingenic,jz4775-mac
   62         - ingenic,x1000-mac
   63         - ingenic,x1600-mac
   64         - ingenic,x1830-mac
   65         - ingenic,x2000-mac
   66         - loongson,ls2k-dwmac
   67         - loongson,ls7a-dwmac
   68         - renesas,r9a06g032-gmac
   69         - renesas,rzn1-gmac
   70         - rockchip,px30-gmac
   71         - rockchip,rk3128-gmac
   72         - rockchip,rk3228-gmac
   73         - rockchip,rk3288-gmac
   74         - rockchip,rk3328-gmac
   75         - rockchip,rk3366-gmac
   76         - rockchip,rk3368-gmac
   77         - rockchip,rk3399-gmac
   78         - rockchip,rv1108-gmac
   79         - snps,dwmac
   80         - snps,dwmac-3.40a
   81         - snps,dwmac-3.50a
   82         - snps,dwmac-3.610
   83         - snps,dwmac-3.70a
   84         - snps,dwmac-3.710
   85         - snps,dwmac-4.00
   86         - snps,dwmac-4.10a
   87         - snps,dwmac-4.20a
   88         - snps,dwmac-5.10a
   89         - snps,dwxgmac
   90         - snps,dwxgmac-2.10
   91 
   92   reg:
   93     minItems: 1
   94     maxItems: 2
   95 
   96   interrupts:
   97     minItems: 1
   98     items:
   99       - description: Combined signal for various interrupt events
  100       - description: The interrupt to manage the remote wake-up packet detection
  101       - description: The interrupt that occurs when Rx exits the LPI state
  102 
  103   interrupt-names:
  104     minItems: 1
  105     items:
  106       - const: macirq
  107       - const: eth_wake_irq
  108       - const: eth_lpi
  109 
  110   clocks:
  111     minItems: 1
  112     maxItems: 8
  113     additionalItems: true
  114     items:
  115       - description: GMAC main clock
  116       - description: Peripheral registers interface clock
  117       - description:
  118           PTP reference clock. This clock is used for programming the
  119           Timestamp Addend Register. If not passed then the system
  120           clock will be used and this is fine on some platforms.
  121 
  122   clock-names:
  123     minItems: 1
  124     maxItems: 8
  125     additionalItems: true
  126     contains:
  127       enum:
  128         - stmmaceth
  129         - pclk
  130         - ptp_ref
  131 
  132   resets:
  133     maxItems: 1
  134     description:
  135       MAC Reset signal.
  136 
  137   reset-names:
  138     const: stmmaceth
  139 
  140   power-domains:
  141     maxItems: 1
  142 
  143   mac-mode:
  144     $ref: ethernet-controller.yaml#/properties/phy-connection-type
  145     description:
  146       The property is identical to 'phy-mode', and assumes that there is mode
  147       converter in-between the MAC & PHY (e.g. GMII-to-RGMII). This converter
  148       can be passive (no SW requirement), and requires that the MAC operate
  149       in a different mode than the PHY in order to function.
  150 
  151   snps,axi-config:
  152     $ref: /schemas/types.yaml#/definitions/phandle
  153     description:
  154       AXI BUS Mode parameters. Phandle to a node that can contain the
  155       following properties
  156         * snps,lpi_en, enable Low Power Interface
  157         * snps,xit_frm, unlock on WoL
  158         * snps,wr_osr_lmt, max write outstanding req. limit
  159         * snps,rd_osr_lmt, max read outstanding req. limit
  160         * snps,kbbe, do not cross 1KiB boundary.
  161         * snps,blen, this is a vector of supported burst length.
  162         * snps,fb, fixed-burst
  163         * snps,mb, mixed-burst
  164         * snps,rb, rebuild INCRx Burst
  165 
  166   snps,mtl-rx-config:
  167     $ref: /schemas/types.yaml#/definitions/phandle
  168     description:
  169       Multiple RX Queues parameters. Phandle to a node that can
  170       contain the following properties
  171         * snps,rx-queues-to-use, number of RX queues to be used in the
  172           driver
  173         * Choose one of these RX scheduling algorithms
  174           * snps,rx-sched-sp, Strict priority
  175           * snps,rx-sched-wsp, Weighted Strict priority
  176         * For each RX queue
  177           * Choose one of these modes
  178             * snps,dcb-algorithm, Queue to be enabled as DCB
  179             * snps,avb-algorithm, Queue to be enabled as AVB
  180           * snps,map-to-dma-channel, Channel to map
  181           * Specifiy specific packet routing
  182             * snps,route-avcp, AV Untagged Control packets
  183             * snps,route-ptp, PTP Packets
  184             * snps,route-dcbcp, DCB Control Packets
  185             * snps,route-up, Untagged Packets
  186             * snps,route-multi-broad, Multicast & Broadcast Packets
  187           * snps,priority, bitmask of the tagged frames priorities assigned to
  188             the queue
  189 
  190   snps,mtl-tx-config:
  191     $ref: /schemas/types.yaml#/definitions/phandle
  192     description:
  193       Multiple TX Queues parameters. Phandle to a node that can
  194       contain the following properties
  195         * snps,tx-queues-to-use, number of TX queues to be used in the
  196           driver
  197         * Choose one of these TX scheduling algorithms
  198           * snps,tx-sched-wrr, Weighted Round Robin
  199           * snps,tx-sched-wfq, Weighted Fair Queuing
  200           * snps,tx-sched-dwrr, Deficit Weighted Round Robin
  201           * snps,tx-sched-sp, Strict priority
  202         * For each TX queue
  203           * snps,weight, TX queue weight (if using a DCB weight
  204             algorithm)
  205           * Choose one of these modes
  206             * snps,dcb-algorithm, TX queue will be working in DCB
  207             * snps,avb-algorithm, TX queue will be working in AVB
  208               [Attention] Queue 0 is reserved for legacy traffic
  209                           and so no AVB is available in this queue.
  210           * Configure Credit Base Shaper (if AVB Mode selected)
  211             * snps,send_slope, enable Low Power Interface
  212             * snps,idle_slope, unlock on WoL
  213             * snps,high_credit, max write outstanding req. limit
  214             * snps,low_credit, max read outstanding req. limit
  215           * snps,priority, bitmask of the priorities assigned to the queue.
  216             When a PFC frame is received with priorities matching the bitmask,
  217             the queue is blocked from transmitting for the pause time specified
  218             in the PFC frame.
  219 
  220   snps,reset-gpio:
  221     deprecated: true
  222     maxItems: 1
  223     description:
  224       PHY Reset GPIO
  225 
  226   snps,reset-active-low:
  227     deprecated: true
  228     $ref: /schemas/types.yaml#/definitions/flag
  229     description:
  230       Indicates that the PHY Reset is active low
  231 
  232   snps,reset-delays-us:
  233     deprecated: true
  234     description:
  235       Triplet of delays. The 1st cell is reset pre-delay in micro
  236       seconds. The 2nd cell is reset pulse in micro seconds. The 3rd
  237       cell is reset post-delay in micro seconds.
  238     minItems: 3
  239     maxItems: 3
  240 
  241   snps,aal:
  242     $ref: /schemas/types.yaml#/definitions/flag
  243     description:
  244       Use Address-Aligned Beats
  245 
  246   snps,fixed-burst:
  247     $ref: /schemas/types.yaml#/definitions/flag
  248     description:
  249       Program the DMA to use the fixed burst mode
  250 
  251   snps,mixed-burst:
  252     $ref: /schemas/types.yaml#/definitions/flag
  253     description:
  254       Program the DMA to use the mixed burst mode
  255 
  256   snps,force_thresh_dma_mode:
  257     $ref: /schemas/types.yaml#/definitions/flag
  258     description:
  259       Force DMA to use the threshold mode for both tx and rx
  260 
  261   snps,force_sf_dma_mode:
  262     $ref: /schemas/types.yaml#/definitions/flag
  263     description:
  264       Force DMA to use the Store and Forward mode for both tx and
  265       rx. This flag is ignored if force_thresh_dma_mode is set.
  266 
  267   snps,en-tx-lpi-clockgating:
  268     $ref: /schemas/types.yaml#/definitions/flag
  269     description:
  270       Enable gating of the MAC TX clock during TX low-power mode
  271 
  272   snps,multicast-filter-bins:
  273     $ref: /schemas/types.yaml#/definitions/uint32
  274     description:
  275       Number of multicast filter hash bins supported by this device
  276       instance
  277 
  278   snps,perfect-filter-entries:
  279     $ref: /schemas/types.yaml#/definitions/uint32
  280     description:
  281       Number of perfect filter entries supported by this device
  282       instance
  283 
  284   snps,ps-speed:
  285     $ref: /schemas/types.yaml#/definitions/uint32
  286     description:
  287       Port selection speed that can be passed to the core when PCS
  288       is supported. For example, this is used in case of SGMII and
  289       MAC2MAC connection.
  290 
  291   mdio:
  292     $ref: mdio.yaml#
  293     unevaluatedProperties: false
  294     description:
  295       Creates and registers an MDIO bus.
  296 
  297     properties:
  298       compatible:
  299         const: snps,dwmac-mdio
  300 
  301     required:
  302       - compatible
  303 
  304 required:
  305   - compatible
  306   - reg
  307   - interrupts
  308   - interrupt-names
  309   - phy-mode
  310 
  311 dependencies:
  312   snps,reset-active-low: ["snps,reset-gpio"]
  313   snps,reset-delay-us: ["snps,reset-gpio"]
  314 
  315 allOf:
  316   - $ref: "ethernet-controller.yaml#"
  317   - if:
  318       properties:
  319         compatible:
  320           contains:
  321             enum:
  322               - allwinner,sun7i-a20-gmac
  323               - allwinner,sun8i-a83t-emac
  324               - allwinner,sun8i-h3-emac
  325               - allwinner,sun8i-r40-gmac
  326               - allwinner,sun8i-v3s-emac
  327               - allwinner,sun50i-a64-emac
  328               - ingenic,jz4775-mac
  329               - ingenic,x1000-mac
  330               - ingenic,x1600-mac
  331               - ingenic,x1830-mac
  332               - ingenic,x2000-mac
  333               - snps,dwmac-3.50a
  334               - snps,dwmac-4.10a
  335               - snps,dwmac-4.20a
  336               - snps,dwxgmac
  337               - snps,dwxgmac-2.10
  338               - st,spear600-gmac
  339 
  340     then:
  341       properties:
  342         snps,pbl:
  343           description:
  344             Programmable Burst Length (tx and rx)
  345           $ref: /schemas/types.yaml#/definitions/uint32
  346           enum: [1, 2, 4, 8, 16, 32]
  347 
  348         snps,txpbl:
  349           description:
  350             Tx Programmable Burst Length. If set, DMA tx will use this
  351             value rather than snps,pbl.
  352           $ref: /schemas/types.yaml#/definitions/uint32
  353           enum: [1, 2, 4, 8, 16, 32]
  354 
  355         snps,rxpbl:
  356           description:
  357             Rx Programmable Burst Length. If set, DMA rx will use this
  358             value rather than snps,pbl.
  359           $ref: /schemas/types.yaml#/definitions/uint32
  360           enum: [1, 2, 4, 8, 16, 32]
  361 
  362         snps,no-pbl-x8:
  363           $ref: /schemas/types.yaml#/definitions/flag
  364           description:
  365             Don\'t multiply the pbl/txpbl/rxpbl values by 8. For core
  366             rev < 3.50, don\'t multiply the values by 4.
  367 
  368   - if:
  369       properties:
  370         compatible:
  371           contains:
  372             enum:
  373               - allwinner,sun7i-a20-gmac
  374               - allwinner,sun8i-a83t-emac
  375               - allwinner,sun8i-h3-emac
  376               - allwinner,sun8i-r40-gmac
  377               - allwinner,sun8i-v3s-emac
  378               - allwinner,sun50i-a64-emac
  379               - loongson,ls2k-dwmac
  380               - loongson,ls7a-dwmac
  381               - ingenic,jz4775-mac
  382               - ingenic,x1000-mac
  383               - ingenic,x1600-mac
  384               - ingenic,x1830-mac
  385               - ingenic,x2000-mac
  386               - snps,dwmac-4.00
  387               - snps,dwmac-4.10a
  388               - snps,dwmac-4.20a
  389               - snps,dwmac-5.10a
  390               - snps,dwxgmac
  391               - snps,dwxgmac-2.10
  392               - st,spear600-gmac
  393 
  394     then:
  395       properties:
  396         snps,tso:
  397           $ref: /schemas/types.yaml#/definitions/flag
  398           description:
  399             Enables the TSO feature otherwise it will be managed by
  400             MAC HW capability register.
  401 
  402 additionalProperties: true
  403 
  404 examples:
  405   - |
  406     stmmac_axi_setup: stmmac-axi-config {
  407         snps,wr_osr_lmt = <0xf>;
  408         snps,rd_osr_lmt = <0xf>;
  409         snps,blen = <256 128 64 32 0 0 0>;
  410     };
  411 
  412     mtl_rx_setup: rx-queues-config {
  413         snps,rx-queues-to-use = <1>;
  414         snps,rx-sched-sp;
  415         queue0 {
  416             snps,dcb-algorithm;
  417             snps,map-to-dma-channel = <0x0>;
  418             snps,priority = <0x0>;
  419         };
  420     };
  421 
  422     mtl_tx_setup: tx-queues-config {
  423         snps,tx-queues-to-use = <2>;
  424         snps,tx-sched-wrr;
  425         queue0 {
  426             snps,weight = <0x10>;
  427             snps,dcb-algorithm;
  428             snps,priority = <0x0>;
  429         };
  430 
  431         queue1 {
  432             snps,avb-algorithm;
  433             snps,send_slope = <0x1000>;
  434             snps,idle_slope = <0x1000>;
  435             snps,high_credit = <0x3E800>;
  436             snps,low_credit = <0xFFC18000>;
  437             snps,priority = <0x1>;
  438         };
  439     };
  440 
  441     gmac0: ethernet@e0800000 {
  442         compatible = "snps,dwxgmac-2.10", "snps,dwxgmac";
  443         reg = <0xe0800000 0x8000>;
  444         interrupt-parent = <&vic1>;
  445         interrupts = <24 23 22>;
  446         interrupt-names = "macirq", "eth_wake_irq", "eth_lpi";
  447         mac-address = [000000000000]; /* Filled in by U-Boot */
  448         max-frame-size = <3800>;
  449         phy-mode = "gmii";
  450         snps,multicast-filter-bins = <256>;
  451         snps,perfect-filter-entries = <128>;
  452         rx-fifo-depth = <16384>;
  453         tx-fifo-depth = <16384>;
  454         clocks = <&clock>;
  455         clock-names = "stmmaceth";
  456         snps,axi-config = <&stmmac_axi_setup>;
  457         snps,mtl-rx-config = <&mtl_rx_setup>;
  458         snps,mtl-tx-config = <&mtl_tx_setup>;
  459         mdio0 {
  460             #address-cells = <1>;
  461             #size-cells = <0>;
  462             compatible = "snps,dwmac-mdio";
  463             phy1: ethernet-phy@0 {
  464                 reg = <0>;
  465             };
  466         };
  467     };
  468 
  469 # FIXME: We should set it, but it would report all the generic
  470 # properties as additional properties.
  471 # additionalProperties: false
  472 
  473 ...
Cache object: 1d152f6c8d5d7df28997090bd7e7bd18
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]
This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.
FreeBSD/Linux Kernel Cross Reference sys/contrib/device-tree/Bindings/net/snps,dwmac.yaml

FreeBSD/Linux Kernel Cross Reference
sys/contrib/device-tree/Bindings/net/snps,dwmac.yaml
