dt-bindings: doc: reflect new NVMEM of_get_mac_address behaviour
authorPetr Štetiar <ynezz@true.cz>
Fri, 3 May 2019 14:27:07 +0000 (16:27 +0200)
committerDavid S. Miller <davem@davemloft.net>
Mon, 6 May 2019 04:47:07 +0000 (21:47 -0700)
As of_get_mac_address now supports NVMEM under the hood, we need to update
the bindings documentation with the new nvmem-cell* properties, which would
mean copy&pasting a lot of redundant information to every binding
documentation currently referencing some of the MAC address properties.

So I've just removed all the references to the optional MAC address
properties and replaced them with the small note referencing
net/ethernet.txt file.

Signed-off-by: Petr Štetiar <ynezz@true.cz>
Signed-off-by: David S. Miller <davem@davemloft.net>
21 files changed:
Documentation/devicetree/bindings/net/altera_tse.txt
Documentation/devicetree/bindings/net/amd-xgbe.txt
Documentation/devicetree/bindings/net/brcm,amac.txt
Documentation/devicetree/bindings/net/cpsw.txt
Documentation/devicetree/bindings/net/davinci_emac.txt
Documentation/devicetree/bindings/net/dsa/dsa.txt
Documentation/devicetree/bindings/net/ethernet.txt
Documentation/devicetree/bindings/net/hisilicon-femac.txt
Documentation/devicetree/bindings/net/hisilicon-hix5hd2-gmac.txt
Documentation/devicetree/bindings/net/keystone-netcp.txt
Documentation/devicetree/bindings/net/macb.txt
Documentation/devicetree/bindings/net/marvell-pxa168.txt
Documentation/devicetree/bindings/net/microchip,enc28j60.txt
Documentation/devicetree/bindings/net/microchip,lan78xx.txt
Documentation/devicetree/bindings/net/qca,qca7000.txt
Documentation/devicetree/bindings/net/samsung-sxgbe.txt
Documentation/devicetree/bindings/net/snps,dwc-qos-ethernet.txt
Documentation/devicetree/bindings/net/socionext,uniphier-ave4.txt
Documentation/devicetree/bindings/net/socionext-netsec.txt
Documentation/devicetree/bindings/net/wireless/mediatek,mt76.txt
Documentation/devicetree/bindings/net/wireless/qca,ath9k.txt

index 0e21df94a53ffa221e6262f4323dc2ff60068a00..0b7d4d3758ead7ae64ad73a224bb1c80c92b1b3c 100644 (file)
@@ -46,9 +46,8 @@ Required properties:
        - reg: phy id used to communicate to phy.
        - device_type: Must be "ethernet-phy".
 
-Optional properties:
-- local-mac-address: See ethernet.txt in the same directory.
-- max-frame-size: See ethernet.txt in the same directory.
+The MAC address will be determined using the optional properties defined in
+ethernet.txt.
 
 Example:
 
index 93dcb79a5f16408ac92694a2831b66b74e232a4f..9c27dfcd11334b9f1dc870815b4ae011b08cd51f 100644 (file)
@@ -24,8 +24,6 @@ Required properties:
 - phy-mode: See ethernet.txt file in the same directory
 
 Optional properties:
-- mac-address: mac address to be assigned to the device. Can be overridden
-  by UEFI.
 - dma-coherent: Present if dma operations are coherent
 - amd,per-channel-interrupt: Indicates that Rx and Tx complete will generate
   a unique interrupt for each DMA channel - this requires an additional
@@ -34,6 +32,9 @@ Optional properties:
     0 - 1GbE and 10GbE (default)
     1 - 2.5GbE and 10GbE
 
+The MAC address will be determined using the optional properties defined in
+ethernet.txt.
+
 The following optional properties are represented by an array with each
 value corresponding to a particular speed. The first array value represents
 the setting for the 1GbE speed, the second value for the 2.5GbE speed and
index 0bfad656a9ff26fc4f672e06f1123198bb9259e7..0120ebe932624379fc9f19b5ee809a26d16a8e30 100644 (file)
@@ -16,8 +16,8 @@ Required properties:
                                registers (required for Northstar2)
  - interrupts: Interrupt number
 
-Optional properties:
-- mac-address: See ethernet.txt file in the same directory
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
 
 Examples:
 
index 3264e1978d25fde513e8857b27348f9edc153203..7c7ac5eb0313ba5a358a236066a582c4afa43ff3 100644 (file)
@@ -49,10 +49,12 @@ Required properties:
 
 Optional properties:
 - dual_emac_res_vlan   : Specifies VID to be used to segregate the ports
-- mac-address          : See ethernet.txt file in the same directory
 - phy_id               : Specifies slave phy id (deprecated, use phy-handle)
 - phy-handle           : See ethernet.txt file in the same directory
 
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
+
 Slave sub-nodes:
 - fixed-link           : See fixed-link.txt file in the same directory
 
index ca83dcc84fb8ee5cfd876cf0bb3d8af5fd85ba6b..5e3579e72e2d041543628bf2a31dc28041f052d4 100644 (file)
@@ -20,11 +20,12 @@ Required properties:
 Optional properties:
 - phy-handle: See ethernet.txt file in the same directory.
               If absent, davinci_emac driver defaults to 100/FULL.
-- nvmem-cells: phandle, reference to an nvmem node for the MAC address
-- nvmem-cell-names: string, should be "mac-address" if nvmem is to be used
 - ti,davinci-rmii-en: 1 byte, 1 means use RMII
 - ti,davinci-no-bd-ram: boolean, does EMAC have BD RAM?
 
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
+
 Example (enbw_cmc board):
        eth0: emac@1e20000 {
                compatible = "ti,davinci-dm6467-emac";
index c107d2848888dee1ca82c9a43bd9390e5a234d45..f66bb7ecdb8277a10ff03f484d608e000868db51 100644 (file)
@@ -65,9 +65,8 @@ properties, described in binding documents:
                          Documentation/devicetree/bindings/net/fixed-link.txt
                          for details.
 
-- local-mac-address    : See
-                         Documentation/devicetree/bindings/net/ethernet.txt
-                         for details.
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
 
 Example
 
index a6862158058461f5af428498ea14c98aed1f7775..699244428a286865d7d7a9b29c3ea9d75e783f22 100644 (file)
@@ -4,12 +4,14 @@ NOTE: All 'phy*' properties documented below are Ethernet specific. For the
 generic PHY 'phys' property, see
 Documentation/devicetree/bindings/phy/phy-bindings.txt.
 
-- local-mac-address: array of 6 bytes, specifies the MAC address that was
-  assigned to the network device;
 - mac-address: array of 6 bytes, specifies the MAC address that was last used by
   the boot program; should be used in cases where the MAC address assigned to
   the device by the boot program is different from the "local-mac-address"
   property;
+- local-mac-address: array of 6 bytes, specifies the MAC address that was
+  assigned to the network device;
+- nvmem-cells: phandle, reference to an nvmem node for the MAC address
+- nvmem-cell-names: string, should be "mac-address" if nvmem is to be used
 - max-speed: number, specifies maximum speed in Mbit/s supported by the device;
 - max-frame-size: number, maximum transfer unit (IEEE defined MTU), rather than
   the maximum frame size (there's contradiction in the Devicetree
index d11af5ecace8594cfe92d72d5bcdc4d2b2e63932..5f96976f3cea7aeb777683b3ff5fb9290f6d6737 100644 (file)
@@ -14,7 +14,6 @@ Required properties:
        the PHY reset signal(optional).
 - reset-names: should contain the reset signal name "mac"(required)
        and "phy"(optional).
-- mac-address: see ethernet.txt [1].
 - phy-mode: see ethernet.txt [1].
 - phy-handle: see ethernet.txt [1].
 - hisilicon,phy-reset-delays-us: triplet of delays if PHY reset signal given.
@@ -22,6 +21,9 @@ Required properties:
        The 2nd cell is reset pulse in micro seconds.
        The 3rd cell is reset post-delay in micro seconds.
 
+The MAC address will be determined using the optional properties
+defined in ethernet.txt[1].
+
 [1] Documentation/devicetree/bindings/net/ethernet.txt
 
 Example:
index eea73adc678f963888c3171006516272abd37f62..cddf46bf6b634f9a89a99e707a767c5d5de6c3df 100644 (file)
@@ -18,7 +18,6 @@ Required properties:
 - #size-cells: must be <0>.
 - phy-mode: see ethernet.txt [1].
 - phy-handle: see ethernet.txt [1].
-- mac-address: see ethernet.txt [1].
 - clocks: clock phandle and specifier pair.
 - clock-names: contain the clock name "mac_core"(required) and "mac_ifc"(optional).
 - resets: should contain the phandle to the MAC core reset signal(optional),
@@ -31,6 +30,9 @@ Required properties:
        The 2nd cell is reset pulse in micro seconds.
        The 3rd cell is reset post-delay in micro seconds.
 
+The MAC address will be determined using the properties defined in
+ethernet.txt[1].
+
 - PHY subnode: inherits from phy binding [2]
 
 [1] Documentation/devicetree/bindings/net/ethernet.txt
index 04ba1dc34fd62150ae1357e8c0c7804907f56313..3a65aabc76a247eb420746b542b31515fdb96725 100644 (file)
@@ -135,14 +135,14 @@ Optional properties:
                are swapped.  The netcp driver will swap the two DWORDs
                back to the proper order when this property is set to 2
                when it obtains the mac address from efuse.
-- local-mac-address:   the driver is designed to use the of_get_mac_address api
-                       only if efuse-mac is 0. When efuse-mac is 0, the MAC
-                       address is obtained from local-mac-address. If this
-                       attribute is not present, then the driver will use a
-                       random MAC address.
 - "netcp-device label":        phandle to the device specification for each of NetCP
                        sub-module attached to this interface.
 
+The MAC address will be determined using the optional properties defined in
+ethernet.txt, as provided by the of_get_mac_address API and only if efuse-mac
+is set to 0. If any of the optional MAC address properties are not present,
+then the driver will use random MAC address.
+
 Example binding:
 
 netcp: netcp@2000000 {
index 8b80515729d7145cc05c9293857212ba914e0607..9c5e94482b5f39dc3d34abb63ac0435454f21312 100644 (file)
@@ -26,9 +26,8 @@ Required properties:
        Optional elements: 'tsu_clk'
 - clocks: Phandles to input clocks.
 
-Optional properties:
-- nvmem-cells: phandle, reference to an nvmem node for the MAC address
-- nvmem-cell-names: string, should be "mac-address" if nvmem is to be used
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
 
 Optional properties for PHY child node:
 - reset-gpios : Should specify the gpio for phy reset
index 845a148a346e9265e92f93f966a2e091b39ed058..5574af3554aaa57782249c97a036c1c732dbb8c3 100644 (file)
@@ -11,7 +11,9 @@ Optional properties:
 - #address-cells: must be 1 when using sub-nodes.
 - #size-cells: must be 0 when using sub-nodes.
 - phy-handle: see ethernet.txt file in the same directory.
-- local-mac-address: see ethernet.txt file in the same directory.
+
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
 
 Sub-nodes:
 Each PHY can be represented as a sub-node. This is not mandatory.
index 24626e082b838f25a33e6fea0cebd8a0f75fcfef..a8275921a8964683fa7be15699b1ca4ce019abe0 100644 (file)
@@ -21,8 +21,9 @@ Optional properties:
 - spi-max-frequency: Maximum frequency of the SPI bus when accessing the ENC28J60.
   According to the ENC28J80 datasheet, the chip allows a maximum of 20 MHz, however,
   board designs may need to limit this value.
-- local-mac-address: See ethernet.txt in the same directory.
 
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
 
 Example (for NXP i.MX28 with pin control stuff for GPIO irq):
 
index 76786a0f6d3d7c06d5ce09ba15c311621def50cf..11a679530ae65a2ae59bf740b210d15d26924a3d 100644 (file)
@@ -7,9 +7,8 @@ The Device Tree properties, if present, override the OTP and EEPROM.
 Required properties:
 - compatible: Should be one of "usb424,7800", "usb424,7801" or "usb424,7850".
 
-Optional properties:
-- local-mac-address:   see ethernet.txt
-- mac-address:         see ethernet.txt
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
 
 Optional properties of the embedded PHY:
 - microchip,led-modes: a 0..4 element vector, with each element configuring
index e4a8a51086dfcbc2d766d7b3d21eb15b900f79fd..21c36e5249936c4c25677e396a457acbe3c9202e 100644 (file)
@@ -23,7 +23,6 @@ Optional properties:
                      Numbers smaller than 1000000 or greater than 16000000
                      are invalid. Missing the property will set the SPI
                      frequency to 8000000 Hertz.
-- local-mac-address : see ./ethernet.txt
 - qca,legacy-mode   : Set the SPI data transfer of the QCA7000 to legacy mode.
                      In this mode the SPI master must toggle the chip select
                      between each data word. In burst mode these gaps aren't
@@ -31,6 +30,9 @@ Optional properties:
                      the QCA7000 is setup via GPIO pin strapping. If the
                      property is missing the driver defaults to burst mode.
 
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
+
 SPI Example:
 
 /* Freescale i.MX28 SPI master*/
index 46e591178911d28399c69b95f8b564b7f6d99dae..2cff6d8a585ac599dfb9fed7078b58821599cf24 100644 (file)
@@ -21,10 +21,12 @@ Required properties:
   range.
 
 Optional properties:
-- mac-address: 6 bytes, mac address
 - max-frame-size: Maximum Transfer Unit (IEEE defined MTU), rather
                  than the maximum frame size.
 
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
+
 Example:
 
        aliases {
index 36f1aef585f03fbf6ee6e4b0b3a7a216a07fad09..ad3c6e109ce18f383d9ceb74fab85dd5723bf7af 100644 (file)
@@ -103,8 +103,6 @@ Required properties:
 
 Optional properties:
 - dma-coherent: Present if dma operations are coherent
-- mac-address: See ethernet.txt in the same directory
-- local-mac-address: See ethernet.txt in the same directory
 - phy-reset-gpios: Phandle and specifier for any GPIO used to reset the PHY.
   See ../gpio/gpio.txt.
 - snps,en-lpi: If present it enables use of the AXI low-power interface
@@ -133,6 +131,9 @@ Optional properties:
     - device_type: Must be "ethernet-phy".
     - fixed-mode device tree subnode: see fixed-link.txt in the same directory
 
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
+
 Examples:
 ethernet2@40010000 {
        clock-names = "phy_ref_clk", "apb_pclk";
index fc8f01718690d2cbbbf271cbb0d3117ea8c6041c..4e85fc495e87ce33333681657f019b8b2f408d2e 100644 (file)
@@ -31,8 +31,8 @@ Required properties:
  - socionext,syscon-phy-mode: A phandle to syscon with one argument
        that configures phy mode. The argument is the ID of MAC instance.
 
-Optional properties:
- - local-mac-address: See ethernet.txt in the same directory.
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
 
 Required subnode:
  - mdio: A container for child nodes representing phy nodes.
index 0cff94fb04334926a1c3eb8c08969db29993bd71..9d6c9feb12ff191b707821b3314be092fbb7b393 100644 (file)
@@ -26,11 +26,12 @@ Required properties:
 Optional properties: (See ethernet.txt file in the same directory)
 - dma-coherent: Boolean property, must only be present if memory
        accesses performed by the device are cache coherent.
-- local-mac-address: See ethernet.txt in the same directory.
-- mac-address: See ethernet.txt in the same directory.
 - max-speed: See ethernet.txt in the same directory.
 - max-frame-size: See ethernet.txt in the same directory.
 
+The MAC address will be determined using the optional properties
+defined in ethernet.txt.
+
 Example:
        eth0: ethernet@522d0000 {
                compatible = "socionext,synquacer-netsec";
index 7b9a776230c05e6b349949344a8ecc1be32f9921..74665502f4cfd60a0a49692e31a2ad54e48c2682 100644 (file)
@@ -13,11 +13,12 @@ properties:
 
 Optional properties:
 
-- mac-address: See ethernet.txt in the parent directory
-- local-mac-address: See ethernet.txt in the parent directory
 - ieee80211-freq-limit: See ieee80211.txt
 - mediatek,mtd-eeprom: Specify a MTD partition + offset containing EEPROM data
 
+The driver is using of_get_mac_address API, so the MAC address can be as well
+be set with corresponding optional properties defined in net/ethernet.txt.
+
 Optional nodes:
 - led: Properties for a connected LED
   Optional properties:
index b7396c8c271cd339784b777a234862aa3786cf1d..aaaeeb5f935bc8a3b0794dfd75aaf66e8701942b 100644 (file)
@@ -34,9 +34,9 @@ Optional properties:
                        ath9k wireless chip (in this case the calibration /
                        EEPROM data will be loaded from userspace using the
                        kernel firmware loader).
-- mac-address: See ethernet.txt in the parent directory
-- local-mac-address: See ethernet.txt in the parent directory
 
+The MAC address will be determined using the optional properties defined in
+net/ethernet.txt.
 
 In this example, the node is defined as child node of the PCI controller:
 &pci0 {