Re: [PATCH v2 2/4] dt-bindings: can: Add CAST CAN Bus Controller

Rob Herring
2024-09-24T20:03:23Z

On Sun, Sep 22, 2024 at 10:51:48PM +0800, Hal Feng wrote:
> From: William Qiu <william.qiu@starfivetech.com>
>
> Add bindings for CAST CAN Bus Controller.
>
> Signed-off-by: William Qiu <william.qiu@starfivetech.com>
> Signed-off-by: Hal Feng <hal.feng@starfivetech.com>
> ---
> .../bindings/net/can/cast,can-ctrl.yaml | 106 ++++++++++++++++++
> 1 file changed, 106 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/net/can/cast,can-ctrl.yaml
>
> diff --git a/Documentation/devicetree/bindings/net/can/cast,can-ctrl.yaml b/Documentation/devicetree/bindings/net/can/cast,can-ctrl.yaml
> new file mode 100644
> index 000000000000..2870cff80164
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/can/cast,can-ctrl.yaml
> @@ -0,0 +1,106 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/can/cast,can-ctrl.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: CAST CAN Bus Controller
> +
> +description:
> + This CAN Bus Controller, also called CAN-CTRL, implements a highly
> + featured and reliable CAN bus controller that performs serial
> + communication according to the CAN protocol.
> +
> + The CAN-CTRL comes in three variants, they are CC, FD, and XL.
> + The CC variant supports only Classical CAN, the FD variant adds support
> + for CAN FD, and the XL variant supports the Classical CAN, CAN FD, and
> + CAN XL standards.
> +
> +maintainers:
> + - William Qiu <william.qiu@starfivetech.com>
> + - Hal Feng <hal.feng@starfivetech.com>
> +
> +properties:
> + compatible:
> + items:
> + - enum:
> + - starfive,jh7110-can
> + - const: cast,can-ctrl-fd-7x10N00S00

What's the 7x10...? Perhaps some explanation on it.

> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + clocks:
> + minItems: 3
> +
> + clock-names:
> + items:
> + - const: apb
> + - const: timer
> + - const: core
> +
> + resets:
> + minItems: 3
> +
> + reset-names:
> + items:
> + - const: apb
> + - const: timer
> + - const: core
> +
> + starfive,syscon:
> + $ref: /schemas/types.yaml#/definitions/phandle-array
> + items:
> + - items:
> + - description: phandle to System Register Controller syscon node
> + - description: offset of SYS_SYSCONSAIF__SYSCFG register for CAN controller
> + - description: shift of SYS_SYSCONSAIF__SYSCFG register for CAN controller
> + - description: mask of SYS_SYSCONSAIF__SYSCFG register for CAN controller
> + description:
> + Should be four parameters, the phandle to System Register Controller
> + syscon node and the offset/shift/mask of SYS_SYSCONSAIF__SYSCFG register
> + for CAN controller.

This just repeats what the schema says. More useful would be what you
need to access/control in this register.

Rob