Re: [PATCH 01/19] dt-bindings: PCI: Endpoint: Add DT bindings for PCI EPF NTB Device
Hi RobH,
On 5/14/2020 8:29 PM, Kishon Vijay Abraham I wrote:
> Add device tree schema for PCI endpoint function bus to which
> endpoint function devices should be attached. Then add device tree
> schema for PCI endpoint function device to include bindings thats
> generic to all endpoint functions. Finally add device tree schema
> for PCI endpoint NTB function device by including the generic
> device tree schema for PCIe endpoint function.
>
> Signed-off-by: Kishon Vijay Abraham I
> ---
> .../bindings/pci/endpoint/pci-epf-bus.yaml| 42 +++
> .../bindings/pci/endpoint/pci-epf-device.yaml | 69 +++
> .../bindings/pci/endpoint/pci-epf-ntb.yaml| 68 ++
> 3 files changed, 179 insertions(+)
> create mode 100644
> Documentation/devicetree/bindings/pci/endpoint/pci-epf-bus.yaml
> create mode 100644
> Documentation/devicetree/bindings/pci/endpoint/pci-epf-device.yaml
> create mode 100644
> Documentation/devicetree/bindings/pci/endpoint/pci-epf-ntb.yaml
>
> diff --git a/Documentation/devicetree/bindings/pci/endpoint/pci-epf-bus.yaml
> b/Documentation/devicetree/bindings/pci/endpoint/pci-epf-bus.yaml
> new file mode 100644
> index ..1c504f2e85e4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pci/endpoint/pci-epf-bus.yaml
> @@ -0,0 +1,42 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (C) 2020 Texas Instruments Incorporated - http://www.ti.com/
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pci/endpoint/pci-epf-bus.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: PCI Endpoint Function Bus
> +
> +maintainers:
> + - Kishon Vijay Abraham I
> +
> +properties:
> + compatible:
> +const: pci-epf-bus
> +
> +patternProperties:
> + "^func@[0-9a-f]+$":
> +type: object
> +description: |
> + PCI Endpoint Function Bus node should have subnodes for each of
> + the implemented endpoint function. It should follow the bindings
> + specified for endpoint function in
> + Documentation/devicetree/bindings/pci/endpoint/
> +
> +examples:
> + - |
> +epf_bus {
> + compatible = "pci-epf-bus";
> +
> + func@0 {
> +compatible = "pci-epf-ntb";
> +epcs = <&pcie0_ep>, <&pcie1_ep>;
> +epc-names = "primary", "secondary";
> +reg = <0>;
I'm not sure how to represent "reg" property properly for cases like this where
it represents ID and not a memory resource. I seem to get warning for
"reg_format" even after adding address-cells and size-cells property in
epf_bus. Can you give some hints here please?
> +epf,vendor-id = /bits/ 16 <0x104c>;
I want to make vendor-id and device-id as 16 bits from the beginning at-least
for PCIe endpoint. So I'm prefixing these properties with "epf,". However I get
this "do not match any of the regexes:". Can we add "epf" as a standard prefix?
Thanks
Kishon
> +epf,device-id = /bits/ 16 <0xb00d>;
> +num-mws = <4>;
> +mws-size = <0x0 0x10>, <0x0 0x10>, <0x0 0x10>, <0x0
> 0x10>;
> + };
> +};
> +...
> diff --git
> a/Documentation/devicetree/bindings/pci/endpoint/pci-epf-device.yaml
> b/Documentation/devicetree/bindings/pci/endpoint/pci-epf-device.yaml
> new file mode 100644
> index ..cee72864c8ca
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pci/endpoint/pci-epf-device.yaml
> @@ -0,0 +1,69 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (C) 2020 Texas Instruments Incorporated - http://www.ti.com/
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pci/endpoint/pci-epf-device.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: PCI Endpoint Function Device
> +
> +maintainers:
> + - Kishon Vijay Abraham I
> +
> +properties:
> + compatible:
> +const: pci-epf-bus
> +
> +properties:
> + $nodename:
> +pattern: "^func@"
> +
> + epcs:
> +description:
> + Phandle to the endpoint controller device. Should have "2" entries for
> + NTB endpoint function and "1" entry for others.
> +minItems: 1
> +maxItems: 2
> +
> + epc-names:
> +description:
> + Must contain an entry for each entry in "epcs" when "epcs" have more
> than
> + one entry.
> +
> + reg:
> +maxItems: 0
> +description: Must contain the index number of the function.
> +
> + epf,vendor-id:
> +description:
> + The PCI vendor ID
> +allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint16
> +
> + epf,device-id:
> +description:
> + The PCI device ID
> +allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint16
> +
> + epf,baseclass-code:
> +description: Code to classify the type of operation the function performs
> +allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint8
> +
> + epf,subclass-code:
> +description:
> + Specifies a base class sub-class, which identifies more specifically
Re: [PATCH 01/19] dt-bindings: PCI: Endpoint: Add DT bindings for PCI EPF NTB Device
On Thu, 14 May 2020 20:29:09 +0530, Kishon Vijay Abraham I wrote:
> Add device tree schema for PCI endpoint function bus to which
> endpoint function devices should be attached. Then add device tree
> schema for PCI endpoint function device to include bindings thats
> generic to all endpoint functions. Finally add device tree schema
> for PCI endpoint NTB function device by including the generic
> device tree schema for PCIe endpoint function.
>
> Signed-off-by: Kishon Vijay Abraham I
> ---
> .../bindings/pci/endpoint/pci-epf-bus.yaml| 42 +++
> .../bindings/pci/endpoint/pci-epf-device.yaml | 69 +++
> .../bindings/pci/endpoint/pci-epf-ntb.yaml| 68 ++
> 3 files changed, 179 insertions(+)
> create mode 100644
> Documentation/devicetree/bindings/pci/endpoint/pci-epf-bus.yaml
> create mode 100644
> Documentation/devicetree/bindings/pci/endpoint/pci-epf-device.yaml
> create mode 100644
> Documentation/devicetree/bindings/pci/endpoint/pci-epf-ntb.yaml
>
My bot found errors running 'make dt_binding_check' on your patch:
Traceback (most recent call last):
File "/usr/local/bin/dt-doc-validate", line 64, in
ret = check_doc(args.yamldt)
File "/usr/local/bin/dt-doc-validate", line 25, in check_doc
testtree = dtschema.load(filename, line_number=line_number,
duplicate_keys=False)
File "/usr/local/lib/python3.6/dist-packages/dtschema/lib.py", line 592, in
load
return yaml.load(f.read())
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/main.py", line 343,
in load
return constructor.get_single_data()
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py",
line 113, in get_single_data
return self.construct_document(node)
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py",
line 123, in construct_document
for _dummy in generator:
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py",
line 723, in construct_yaml_map
value = self.construct_mapping(node)
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py",
line 440, in construct_mapping
return BaseConstructor.construct_mapping(self, node, deep=deep)
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py",
line 257, in construct_mapping
if self.check_mapping_key(node, key_node, mapping, key, value):
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py",
line 295, in check_mapping_key
raise DuplicateKeyError(*args)
ruamel.yaml.constructor.DuplicateKeyError: while constructing a mapping
in "", line 5, column 1
found duplicate key "properties" with value "{}" (original value: "{}")
in "", line 17, column 1
To suppress this check see:
http://yaml.readthedocs.io/en/latest/api.html#duplicate-keys
Duplicate keys will become an error in future releases, and are errors
by default when using the new API.
Documentation/devicetree/bindings/Makefile:12: recipe for target
'Documentation/devicetree/bindings/pci/endpoint/pci-epf-device.example.dts'
failed
make[1]: ***
[Documentation/devicetree/bindings/pci/endpoint/pci-epf-device.example.dts]
Error 1
make[1]: *** Waiting for unfinished jobs
Documentation/devicetree/bindings/pci/endpoint/pci-epf-ntb.yaml: while
constructing a mapping
in "", line 5, column 1
found duplicate key "properties" with value "{}" (original value: "{}")
in "", line 17, column 1
To suppress this check see:
http://yaml.readthedocs.io/en/latest/api.html#duplicate-keys
Duplicate keys will become an error in future releases, and are errors
by default when using the new API.
Traceback (most recent call last):
File "/usr/local/bin/dt-mk-schema", line 34, in
schemas = dtschema.process_schemas(args.schemas, core_schema=(not
args.useronly))
File "/usr/local/lib/python3.6/dist-packages/dtschema/lib.py", line 554, in
process_schemas
sch = process_schema(os.path.abspath(filename))
File "/usr/local/lib/python3.6/dist-packages/dtschema/lib.py", line 507, in
process_schema
schema = load_schema(filename)
File "/usr/local/lib/python3.6/dist-packages/dtschema/lib.py", line 123, in
load_schema
return do_load(os.path.join(schema_basedir, schema))
File "/usr/local/lib/python3.6/dist-packages/dtschema/lib.py", line 108, in
do_load
return yaml.load(tmp)
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/main.py", line 343,
in load
return constructor.get_single_data()
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py",
line 113, in get_single_data
return self.construct_document(node)
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py",
line 123, in construct_document
for _dummy in generator:
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py",
line 723, in construct_yaml_map
value = self.construct_mapping(node)
File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.p
[PATCH 01/19] dt-bindings: PCI: Endpoint: Add DT bindings for PCI EPF NTB Device
Add device tree schema for PCI endpoint function bus to which
endpoint function devices should be attached. Then add device tree
schema for PCI endpoint function device to include bindings thats
generic to all endpoint functions. Finally add device tree schema
for PCI endpoint NTB function device by including the generic
device tree schema for PCIe endpoint function.
Signed-off-by: Kishon Vijay Abraham I
---
.../bindings/pci/endpoint/pci-epf-bus.yaml| 42 +++
.../bindings/pci/endpoint/pci-epf-device.yaml | 69 +++
.../bindings/pci/endpoint/pci-epf-ntb.yaml| 68 ++
3 files changed, 179 insertions(+)
create mode 100644
Documentation/devicetree/bindings/pci/endpoint/pci-epf-bus.yaml
create mode 100644
Documentation/devicetree/bindings/pci/endpoint/pci-epf-device.yaml
create mode 100644
Documentation/devicetree/bindings/pci/endpoint/pci-epf-ntb.yaml
diff --git a/Documentation/devicetree/bindings/pci/endpoint/pci-epf-bus.yaml
b/Documentation/devicetree/bindings/pci/endpoint/pci-epf-bus.yaml
new file mode 100644
index ..1c504f2e85e4
--- /dev/null
+++ b/Documentation/devicetree/bindings/pci/endpoint/pci-epf-bus.yaml
@@ -0,0 +1,42 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2020 Texas Instruments Incorporated - http://www.ti.com/
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pci/endpoint/pci-epf-bus.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: PCI Endpoint Function Bus
+
+maintainers:
+ - Kishon Vijay Abraham I
+
+properties:
+ compatible:
+const: pci-epf-bus
+
+patternProperties:
+ "^func@[0-9a-f]+$":
+type: object
+description: |
+ PCI Endpoint Function Bus node should have subnodes for each of
+ the implemented endpoint function. It should follow the bindings
+ specified for endpoint function in
+ Documentation/devicetree/bindings/pci/endpoint/
+
+examples:
+ - |
+epf_bus {
+ compatible = "pci-epf-bus";
+
+ func@0 {
+compatible = "pci-epf-ntb";
+epcs = <&pcie0_ep>, <&pcie1_ep>;
+epc-names = "primary", "secondary";
+reg = <0>;
+epf,vendor-id = /bits/ 16 <0x104c>;
+epf,device-id = /bits/ 16 <0xb00d>;
+num-mws = <4>;
+mws-size = <0x0 0x10>, <0x0 0x10>, <0x0 0x10>, <0x0
0x10>;
+ };
+};
+...
diff --git a/Documentation/devicetree/bindings/pci/endpoint/pci-epf-device.yaml
b/Documentation/devicetree/bindings/pci/endpoint/pci-epf-device.yaml
new file mode 100644
index ..cee72864c8ca
--- /dev/null
+++ b/Documentation/devicetree/bindings/pci/endpoint/pci-epf-device.yaml
@@ -0,0 +1,69 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2020 Texas Instruments Incorporated - http://www.ti.com/
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pci/endpoint/pci-epf-device.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: PCI Endpoint Function Device
+
+maintainers:
+ - Kishon Vijay Abraham I
+
+properties:
+ compatible:
+const: pci-epf-bus
+
+properties:
+ $nodename:
+pattern: "^func@"
+
+ epcs:
+description:
+ Phandle to the endpoint controller device. Should have "2" entries for
+ NTB endpoint function and "1" entry for others.
+minItems: 1
+maxItems: 2
+
+ epc-names:
+description:
+ Must contain an entry for each entry in "epcs" when "epcs" have more than
+ one entry.
+
+ reg:
+maxItems: 0
+description: Must contain the index number of the function.
+
+ epf,vendor-id:
+description:
+ The PCI vendor ID
+allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint16
+
+ epf,device-id:
+description:
+ The PCI device ID
+allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint16
+
+ epf,baseclass-code:
+description: Code to classify the type of operation the function performs
+allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint8
+
+ epf,subclass-code:
+description:
+ Specifies a base class sub-class, which identifies more specifically the
+ operation of the Function
+allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint8
+
+ epf,subsys-vendor-id:
+description: Code to identify vendor of the add-in card or subsystem
+allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint16
+
+ epf,subsys-id:
+description: Code to specify an id that is specific to a vendor
+allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint16
diff --git a/Documentation/devicetree/bindings/pci/endpoint/pci-epf-ntb.yaml
b/Documentation/devicetree/bindings/pci/endpoint/pci-epf-ntb.yaml
new file mode 100644
index ..92c2e522b9e5
--- /dev/null
+++ b/Documentation/devicetree/bindings/pci/endpoint/pci-epf-ntb.yaml
@@ -0,0 +1,68 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2020 Texas Instruments Incorporated - http://www.ti.com/
