Re: [RFC 6/7] dt-bindings: net: bgmac: add bindings documentation for bgmac

From: Florian Fainelli
Date: Wed Jun 29 2016 - 14:38:04 EST


On 06/28/2016 12:34 PM, Jon Mason wrote:
> Signed-off-by: Jon Mason <jon.mason@xxxxxxxxxxxx>
> ---
> .../devicetree/bindings/net/brcm,bgmac-enet.txt | 21 +++++++++++++++++++++
> 1 file changed, 21 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/net/brcm,bgmac-enet.txt
>
> diff --git a/Documentation/devicetree/bindings/net/brcm,bgmac-enet.txt b/Documentation/devicetree/bindings/net/brcm,bgmac-enet.txt
> new file mode 100644
> index 0000000..efd36d5
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/brcm,bgmac-enet.txt
> @@ -0,0 +1,21 @@
> +Broadcom GMAC Ethernet Controller Device Tree Bindings
> +-------------------------------------------------------------
> +
> +Required properties:
> + - compatible: "brcm,bgmac-enet"

You might want something a bit more explicit like "brcm,bgmac-nsp" for
instance and also define a compatible string for the Northstar family maybe?

> + - reg: Address and length of the GMAC registers,
> + Address and length of the GMAC IDM registers
> + - interrupts: Interrupt number
> +
> +Optional properties:
> +- mac-address: mac address to be assigned to the device
> +
> +Examples:
> +
> +gmac0: enet@18022000 {
> + compatible = "brcm,bgmac-enet";
> + reg = <0x18022000 0x1000>,
> + <0x18110000 0x1000>;
> + interrupts = <GIC_SPI 147 IRQ_TYPE_LEVEL_HIGH>;
> + status = "disabled";
> +};
>


--
Florian