Re: [PATCH v2 1/1] dt-bindings: can: convert microchip,mcp251x.txt to yaml

From: Frank Li
Date: Mon Sep 09 2024 - 16:39:13 EST


On Wed, Aug 14, 2024 at 12:44:06PM -0400, Frank Li wrote:
> Convert binding doc microchip,mcp251x.txt to yaml.
> Additional change:
> - add ref to spi-peripheral-props.yaml
>
> Fix below warning:
> arch/arm64/boot/dts/freescale/imx8dx-colibri-eval-v3.dtb: /bus@5a000000/spi@5a020000/can@0:
> failed to match any schema with compatible: ['microchip,mcp2515']
>
> Signed-off-by: Frank Li <Frank.Li@xxxxxxx>
> ---

Marc:

Ping. Conor Dooley already acked it.

Frank

> change from v1 to v2
> - Change maintainer to can's maintainer
> - remove label 'can0' in example
> - file name use microchip,mcp2510.yaml
> ---
> .../bindings/net/can/microchip,mcp2510.yaml | 70 +++++++++++++++++++
> .../bindings/net/can/microchip,mcp251x.txt | 30 --------
> 2 files changed, 70 insertions(+), 30 deletions(-)
> create mode 100644 Documentation/devicetree/bindings/net/can/microchip,mcp2510.yaml
> delete mode 100644 Documentation/devicetree/bindings/net/can/microchip,mcp251x.txt
>
> diff --git a/Documentation/devicetree/bindings/net/can/microchip,mcp2510.yaml b/Documentation/devicetree/bindings/net/can/microchip,mcp2510.yaml
> new file mode 100644
> index 0000000000000..db446dde68420
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/can/microchip,mcp2510.yaml
> @@ -0,0 +1,70 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/can/microchip,mcp2510.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Microchip MCP251X stand-alone CAN controller
> +
> +maintainers:
> + - Marc Kleine-Budde <mkl@xxxxxxxxxxxxxx>
> +
> +properties:
> + compatible:
> + enum:
> + - microchip,mcp2510
> + - microchip,mcp2515
> + - microchip,mcp25625
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + vdd-supply:
> + description: Regulator that powers the CAN controller.
> +
> + xceiver-supply:
> + description: Regulator that powers the CAN transceiver.
> +
> + gpio-controller: true
> +
> + "#gpio-cells":
> + const: 2
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - interrupts
> +
> +allOf:
> + - $ref: /schemas/spi/spi-peripheral-props.yaml#
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> +
> + spi {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + can@1 {
> + compatible = "microchip,mcp2515";
> + reg = <1>;
> + clocks = <&clk24m>;
> + interrupt-parent = <&gpio4>;
> + interrupts = <13 IRQ_TYPE_LEVEL_LOW>;
> + vdd-supply = <&reg5v0>;
> + xceiver-supply = <&reg5v0>;
> + gpio-controller;
> + #gpio-cells = <2>;
> + };
> + };
> +
> diff --git a/Documentation/devicetree/bindings/net/can/microchip,mcp251x.txt b/Documentation/devicetree/bindings/net/can/microchip,mcp251x.txt
> deleted file mode 100644
> index 381f8fb3e865a..0000000000000
> --- a/Documentation/devicetree/bindings/net/can/microchip,mcp251x.txt
> +++ /dev/null
> @@ -1,30 +0,0 @@
> -* Microchip MCP251X stand-alone CAN controller device tree bindings
> -
> -Required properties:
> - - compatible: Should be one of the following:
> - - "microchip,mcp2510" for MCP2510.
> - - "microchip,mcp2515" for MCP2515.
> - - "microchip,mcp25625" for MCP25625.
> - - reg: SPI chip select.
> - - clocks: The clock feeding the CAN controller.
> - - interrupts: Should contain IRQ line for the CAN controller.
> -
> -Optional properties:
> - - vdd-supply: Regulator that powers the CAN controller.
> - - xceiver-supply: Regulator that powers the CAN transceiver.
> - - gpio-controller: Indicates this device is a GPIO controller.
> - - #gpio-cells: Should be two. The first cell is the pin number and
> - the second cell is used to specify the gpio polarity.
> -
> -Example:
> - can0: can@1 {
> - compatible = "microchip,mcp2515";
> - reg = <1>;
> - clocks = <&clk24m>;
> - interrupt-parent = <&gpio4>;
> - interrupts = <13 IRQ_TYPE_LEVEL_LOW>;
> - vdd-supply = <&reg5v0>;
> - xceiver-supply = <&reg5v0>;
> - gpio-controller;
> - #gpio-cells = <2>;
> - };
> --
> 2.34.1
>