diff mbox series

[net-next,1/2] dt-bindings: net: document BCM4908 Ethernet controller

Message ID 20210205214417.11178-1-zajec5@gmail.com
State New
Headers show
Series [net-next,1/2] dt-bindings: net: document BCM4908 Ethernet controller | expand

Commit Message

Rafał Miłecki Feb. 5, 2021, 9:44 p.m. UTC
From: Rafał Miłecki <rafal@milecki.pl>

BCM4908 is a family of SoCs with integrated Ethernet controller.

Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
---
 .../bindings/net/brcm,bcm4908enet.yaml        | 45 +++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml

Comments

Rob Herring (Arm) Feb. 9, 2021, 9:43 p.m. UTC | #1
On Sun, Feb 07, 2021 at 11:26:31PM +0100, Rafał Miłecki wrote:
> From: Rafał Miłecki <rafal@milecki.pl>

> 

> BCM4908 is a family of SoCs with integrated Ethernet controller.

> 

> Signed-off-by: Rafał Miłecki <rafal@milecki.pl>

> ---

>  .../bindings/net/brcm,bcm4908enet.yaml        | 45 +++++++++++++++++++

>  1 file changed, 45 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml

> 

> diff --git a/Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml b/Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml

> new file mode 100644

> index 000000000000..5f12f51c5b19

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml

> @@ -0,0 +1,45 @@

> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/net/brcm,bcm4908enet.yaml#

> +$schema: http://devicetree.org/meta-schemas/core.yaml#

> +

> +title: Broadcom BCM4908 Ethernet controller

> +

> +description: Broadcom's Ethernet controller integrated into BCM4908 family SoCs

> +

> +maintainers:

> +  - Rafał Miłecki <rafal@milecki.pl>

> +


allOf:
  - $ref: 'ethernet-controller.yaml#'

> +properties:

> +  compatible:

> +    const: brcm,bcm4908enet


Normal convention is 'brcm,bcm4908-enet'. (And update the filename/$id)

> +

> +  reg:

> +    maxItems: 1

> +

> +  interrupts:

> +    description: RX interrupt

> +

> +  interrupt-names:

> +    const: rx


Don't really need *-names when only 1 possible entry.

> +

> +required:

> +  - reg

> +  - interrupts

> +  - interrupt-names

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    #include <dt-bindings/interrupt-controller/irq.h>

> +    #include <dt-bindings/interrupt-controller/arm-gic.h>

> +

> +    ethernet@80002000 {

> +        compatible = "brcm,bcm4908enet";

> +        reg = <0x80002000 0x1000>;

> +

> +        interrupts = <GIC_SPI 86 IRQ_TYPE_LEVEL_HIGH>;

> +        interrupt-names = "rx";

> +    };

> -- 

> 2.26.2

>
Rafał Miłecki Feb. 9, 2021, 10:07 p.m. UTC | #2
On 09.02.2021 22:43, Rob Herring wrote:
> On Sun, Feb 07, 2021 at 11:26:31PM +0100, Rafał Miłecki wrote:
>> From: Rafał Miłecki <rafal@milecki.pl>
>>
>> BCM4908 is a family of SoCs with integrated Ethernet controller.
>>
>> Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
>> ---
>>   .../bindings/net/brcm,bcm4908enet.yaml        | 45 +++++++++++++++++++
>>   1 file changed, 45 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml b/Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml
>> new file mode 100644
>> index 000000000000..5f12f51c5b19
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml
>> @@ -0,0 +1,45 @@
>> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/net/brcm,bcm4908enet.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Broadcom BCM4908 Ethernet controller
>> +
>> +description: Broadcom's Ethernet controller integrated into BCM4908 family SoCs
>> +
>> +maintainers:
>> +  - Rafał Miłecki <rafal@milecki.pl>
>> +
> 
> allOf:
>    - $ref: 'ethernet-controller.yaml#'

Thanks!


>> +properties:
>> +  compatible:
>> +    const: brcm,bcm4908enet
> 
> Normal convention is 'brcm,bcm4908-enet'. (And update the filename/$id)

Is it? ;) It seems we have:
brcm,bcmgenet (not brcm,bcmg-enet)
fsl-enetc (not e.g. fsl-enet-c)
xilinx_axienet (not xilinx_axi-enet)
apm,xgene1-sgenet (not apm,xgene1-sg-enet)

Of course, as you seem to prefer *-enet, I'll make it so! V3 soon.


>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  interrupts:
>> +    description: RX interrupt
>> +
>> +  interrupt-names:
>> +    const: rx
> 
> Don't really need *-names when only 1 possible entry.

I think this controller may have some more interrupts (I don't know about). We can "interrupt-names" later, when we find them out.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml b/Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml
new file mode 100644
index 000000000000..5f12f51c5b19
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/brcm,bcm4908enet.yaml
@@ -0,0 +1,45 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/brcm,bcm4908enet.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Broadcom BCM4908 Ethernet controller
+
+description: Broadcom's Ethernet controller integrated into BCM4908 family SoCs
+
+maintainers:
+  - Rafał Miłecki <rafal@milecki.pl>
+
+properties:
+  compatible:
+    const: brcm,bcm4908enet
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    description: RX interrupt
+
+  interrupt-names:
+    const: rx
+
+required:
+  - reg
+  - interrupts
+  - interrupt-names
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    ethernet@80002000 {
+        compatible = "brcm,bcm4908enet";
+        reg = <0x80002000 0x1000>;
+
+        interrupts = <GIC_SPI 86 IRQ_TYPE_LEVEL_HIGH>;
+        interrupt-names = "rx";
+    };