lkml.org 
[lkml]   [2021]   [Jul]   [29]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v2 2/2] dt-bindings: net: can: c_can: convert to json-schema
On Mon, Jul 26, 2021 at 03:15:26PM +0200, Dario Binacchi wrote:
> Convert the Bosch C_CAN/D_CAN controller device tree binding
> documentation to json-schema.
>
> Document missing properties.
> Remove "ti,hwmods" as it is no longer used in TI dts.
> Make "clocks" required as it is used in all dts.
> Correct nodename in the example.
>
> Signed-off-by: Dario Binacchi <dariobin@libero.it>
>
> ---
>
> Changes in v2:
> - Drop Documentation references
>
> .../bindings/net/can/bosch,c_can.yaml | 83 +++++++++++++++++++
> .../devicetree/bindings/net/can/c_can.txt | 65 ---------------
> 2 files changed, 83 insertions(+), 65 deletions(-)
> create mode 100644 Documentation/devicetree/bindings/net/can/bosch,c_can.yaml
> delete mode 100644 Documentation/devicetree/bindings/net/can/c_can.txt
>
> diff --git a/Documentation/devicetree/bindings/net/can/bosch,c_can.yaml b/Documentation/devicetree/bindings/net/can/bosch,c_can.yaml
> new file mode 100644
> index 000000000000..f937c37e9199
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/can/bosch,c_can.yaml
> @@ -0,0 +1,83 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/can/bosch,c_can.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Bosch C_CAN/D_CAN controller Device Tree Bindings
> +
> +description: Bosch C_CAN/D_CAN controller for CAN bus
> +
> +maintainers:
> + - Dario Binacchi <dariobin@libero.it>
> +
> +allOf:
> + - $ref: can-controller.yaml#
> +
> +properties:
> + compatible:
> + oneOf:
> + - enum:
> + - bosch,c_can
> + - bosch,d_can
> + - ti,dra7-d_can
> + - ti,am3352-d_can
> + - items:
> + - enum:
> + - ti,am4372-d_can
> + - const: ti,am3352-d_can
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + power-domains:
> + description: |
> + Should contain a phandle to a PM domain provider node and an args
> + specifier containing the DCAN device id value. It's mandatory for
> + Keystone 2 66AK2G SoCs only.
> + maxItems: 1
> +
> + clocks:
> + description: |
> + CAN functional clock phandle.
> + maxItems: 1
> +
> + clock-names:
> + maxItems: 1
> +
> + syscon-raminit:

Needs a type (phandle-array) and size (maxItems: 2)

> + description: |
> + Handle to system control region that contains the RAMINIT register,
> + register offset to the RAMINIT register and the CAN instance number (0
> + offset).
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - clocks
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + can@481d0000 {
> + compatible = "bosch,d_can";
> + reg = <0x481d0000 0x2000>;
> + interrupts = <55>;
> + interrupt-parent = <&intc>;
> + status = "disabled";
> + };
> + - |
> + can@0 {
> + compatible = "ti,am3352-d_can";
> + reg = <0x0 0x2000>;
> + clocks = <&dcan1_fck>;
> + clock-names = "fck";
> + syscon-raminit = <&scm_conf 0x644 1>;
> + interrupts = <55>;
> + status = "disabled";
> + };
> diff --git a/Documentation/devicetree/bindings/net/can/c_can.txt b/Documentation/devicetree/bindings/net/can/c_can.txt
> deleted file mode 100644
> index 366479806acb..000000000000
> --- a/Documentation/devicetree/bindings/net/can/c_can.txt
> +++ /dev/null
> @@ -1,65 +0,0 @@
> -Bosch C_CAN/D_CAN controller Device Tree Bindings
> --------------------------------------------------
> -
> -Required properties:
> -- compatible : Should be "bosch,c_can" for C_CAN controllers and
> - "bosch,d_can" for D_CAN controllers.
> - Can be "ti,dra7-d_can", "ti,am3352-d_can" or
> - "ti,am4372-d_can".
> -- reg : physical base address and size of the C_CAN/D_CAN
> - registers map
> -- interrupts : property with a value describing the interrupt
> - number
> -
> -The following are mandatory properties for DRA7x, AM33xx and AM43xx SoCs only:
> -- ti,hwmods : Must be "d_can<n>" or "c_can<n>", n being the
> - instance number
> -
> -The following are mandatory properties for Keystone 2 66AK2G SoCs only:
> -- power-domains : Should contain a phandle to a PM domain provider node
> - and an args specifier containing the DCAN device id
> - value. This property is as per the binding,
> - Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
> -- clocks : CAN functional clock phandle. This property is as per the
> - binding,
> - Documentation/devicetree/bindings/clock/ti,sci-clk.yaml
> -
> -Optional properties:
> -- syscon-raminit : Handle to system control region that contains the
> - RAMINIT register, register offset to the RAMINIT
> - register and the CAN instance number (0 offset).
> -
> -Note: "ti,hwmods" field is used to fetch the base address and irq
> -resources from TI, omap hwmod data base during device registration.
> -Future plan is to migrate hwmod data base contents into device tree
> -blob so that, all the required data will be used from device tree dts
> -file.
> -
> -Example:
> -
> -Step1: SoC common .dtsi file
> -
> - dcan1: d_can@481d0000 {
> - compatible = "bosch,d_can";
> - reg = <0x481d0000 0x2000>;
> - interrupts = <55>;
> - interrupt-parent = <&intc>;
> - status = "disabled";
> - };
> -
> -(or)
> -
> - dcan1: d_can@481d0000 {
> - compatible = "bosch,d_can";
> - ti,hwmods = "d_can1";
> - reg = <0x481d0000 0x2000>;
> - interrupts = <55>;
> - interrupt-parent = <&intc>;
> - status = "disabled";
> - };
> -
> -Step 2: board specific .dts file
> -
> - &dcan1 {
> - status = "okay";
> - };
> --
> 2.17.1
>
>

\
 
 \ /
  Last update: 2021-07-30 01:40    [W:0.050 / U:0.936 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site