diff mbox series

[RFC,v3,10/35] Documentation/devicetree/bindings/pci: renesas,pci-sh7751.yaml new file.

Message ID ef935285edcc1ddf56616ec0c7291749a266922e.1697199949.git.ysato@users.sourceforge.jp (mailing list archive)
State New, archived
Headers show
Series Device Tree support for SH7751 based board | expand

Commit Message

Yoshinori Sato Oct. 14, 2023, 2:53 p.m. UTC
binding document for renesas,pci-sh7751.

Signed-off-by: Yoshinori Sato <ysato@users.sourceforge.jp>
---
 .../bindings/pci/renesas,pci-sh7751.yaml      | 123 ++++++++++++++++++
 1 file changed, 123 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/pci/renesas,pci-sh7751.yaml

Comments

Krzysztof Kozlowski Oct. 16, 2023, 5:28 a.m. UTC | #1
On 14/10/2023 16:53, Yoshinori Sato wrote:
> binding document for renesas,pci-sh7751.

It's still RFC, so I assume it is not ready for merging and it is not
meant to be reviewed. In case it is not correct - some people actually
expect RFC to be merged - trivial comments:

1. Please use subject prefixes matching the subsystem. You can get them
for example with `git log --oneline -- DIRECTORY_OR_FILE` on the
directory your patch is touching.

2. Drop final full stop from subject.

3. Missing commit msg

> 
> Signed-off-by: Yoshinori Sato <ysato@users.sourceforge.jp>
> ---
>  .../bindings/pci/renesas,pci-sh7751.yaml      | 123 ++++++++++++++++++
>  1 file changed, 123 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/pci/renesas,pci-sh7751.yaml

If sh7751 is the name of SoC or device:
renesas,sh7751-pci.yaml

> 
> diff --git a/Documentation/devicetree/bindings/pci/renesas,pci-sh7751.yaml b/Documentation/devicetree/bindings/pci/renesas,pci-sh7751.yaml
> new file mode 100644
> index 000000000000..a6081c3de51d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pci/renesas,pci-sh7751.yaml
> @@ -0,0 +1,123 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pci/renesas,pci-sh7751.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Renesas SH7751 PCI Host controller
> +
> +maintainers:
> +  - Yoshinori Sato <ysato@users.sourceforge.jp>
> +
> +allOf:
> +  - $ref: /schemas/pci/pci-bus.yaml#
> +
> +properties:
> +  compatible:
> +    items:

You can drop items

> +      - enum:
> +          - renesas,pci-sh7751

renesas,sh7751-pci

> +
> +  reg:
> +    minItems: 3

maxItems instead

> +
> +  "#interrupt-cells":
> +    const: 1
> +
> +  "#address-cells":
> +    const: 3
> +
> +  "#size-cells":
> +    const: 2
> +
> +  ranges:
> +    description: |
> +      The PCI bus memory area and I/O area.

Drop description, just ranges: true.

....

> +
> +examples:
> +  - |
> +        pci@fe200000 {

Use 4 spaces for example indentation.


Best regards,
Krzysztof
Krzysztof Kozlowski Oct. 16, 2023, 11:55 a.m. UTC | #2
On 14/10/2023 16:53, Yoshinori Sato wrote:
> binding document for renesas,pci-sh7751.
> 
> 

One more comment - this was not tested so is not ready for review.
Standard disclaimer:

Please use scripts/get_maintainers.pl to get a list of necessary people
and lists to CC. It might happen, that command when run on an older
kernel, gives you outdated entries. Therefore please be sure you base
your patches on recent Linux kernel.

You missed at least devicetree list (maybe more), so this won't be
tested by automated tooling. Performing review on untested code might be
a waste of time, thus I will skip this patch entirely till you follow
the process allowing the patch to be tested.

Please kindly resend and include all necessary To/Cc entries.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/pci/renesas,pci-sh7751.yaml b/Documentation/devicetree/bindings/pci/renesas,pci-sh7751.yaml
new file mode 100644
index 000000000000..a6081c3de51d
--- /dev/null
+++ b/Documentation/devicetree/bindings/pci/renesas,pci-sh7751.yaml
@@ -0,0 +1,123 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pci/renesas,pci-sh7751.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Renesas SH7751 PCI Host controller
+
+maintainers:
+  - Yoshinori Sato <ysato@users.sourceforge.jp>
+
+allOf:
+  - $ref: /schemas/pci/pci-bus.yaml#
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - renesas,pci-sh7751
+
+  reg:
+    minItems: 3
+
+  "#interrupt-cells":
+    const: 1
+
+  "#address-cells":
+    const: 3
+
+  "#size-cells":
+    const: 2
+
+  ranges:
+    description: |
+      The PCI bus memory area and I/O area.
+
+  interrupt-controller: true
+
+  renesas,bcr1:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      SH7751 PCIC PCIBCR1 value. This value makes add the value of BSC's BCR1.
+
+  renesas,mcrmask:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      SH7751 PCIC PCIMCR value. This value makes clear bit in the value of BSC's MCR.
+
+  renesas,intm:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      SH7751 PCIC PCIINTM value.
+
+  renesas,aintm:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      SH7751 PCIC PCIIANTM value.
+
+  renesas,lsr:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      SH7751 PCIC PCILSR0 and PCILSR1 values.
+      First word is PCILSR0, Second word is PCILSR1.
+
+  renesas,lar:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      SH7751 PCIC PCILSA0 and PCILAR1 values.
+      First word is PCILAR0, Second word is PCILAR1.
+
+  renesas,dmabt:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      SH7751 PCIC PCIDMABT value.
+
+  renesas,pintm:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      SH7751 PCIC PCIPINTM value.
+
+  renesas,config:
+    $ref: /schemas/types.yaml#/definitions/uint32-array
+    description: |
+      SH7751 PCIC PCICONFIG values array. Register Number and value pair list.
+
+required:
+  - compatible
+  - reg
+  - "#interrupt-cells"
+  - "#address-cells"
+  - "#size-cells"
+  - ranges
+  - interrupt-map
+  - interrupt-map-mask
+
+unevaluatedProperties: false
+
+examples:
+  - |
+        pci@fe200000 {
+                compatible = "renesas,pci-sh7751";
+                #address-cells = <3>;
+                #size-cells = <2>;
+                ranges = <0x02000000 0 0xfd000000 0xfd000000 0 0x01000000>,
+                         <0x01000000 0 0x00000000 0xfe240000 0 0x00040000>;
+                reg = <0xfe200000 0x0400>,
+                      <0x0c000000 0x04000000>,
+                      <0xff800000 0x0030>;
+                #interrupt-cells = <1>;
+                interrupt-map = <0x0000 0 0 1 &julianintc 5>,
+                                <0x0000 0 0 2 &julianintc 6>,
+                                <0x0000 0 0 3 &julianintc 7>,
+                                <0x0000 0 0 4 &julianintc 8>,
+                                <0x0800 0 0 1 &julianintc 6>,
+                                <0x0800 0 0 2 &julianintc 7>,
+                                <0x0800 0 0 3 &julianintc 8>,
+                                <0x0800 0 0 4 &julianintc 5>,
+                                <0x1000 0 0 1 &julianintc 7>,
+                                <0x1000 0 0 2 &julianintc 8>,
+                                <0x1000 0 0 3 &julianintc 5>,
+                                <0x1000 0 0 4 &julianintc 6>;
+                interrupt-map-mask = <0x1800 0 0 7>;
+        };