Re: [PATCH v2 01/10] dt-bindings: soc: fsl: cpm_qe: Add TSA controller

From: Krzysztof Kozlowski
Date: Sun Jan 08 2023 - 10:10:53 EST

Next message: Haiyue Wang: "[PATCH bpf-next v1] bpf: Remove the unnecessary insn buffer comparison"
Previous message: Krzysztof Kozlowski: "Re: [PATCH v8 7/9] dt/bindings: display: bridge: it6505: Add mode-switch support"
Next in thread: Herve Codina: "Re: [PATCH v2 01/10] dt-bindings: soc: fsl: cpm_qe: Add TSA controller"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

On 06/01/2023 17:37, Herve Codina wrote:
> Add support for the time slot assigner (TSA)
> available in some PowerQUICC SoC such as MPC885
> or MPC866.
>
> Signed-off-by: Herve Codina <herve.codina@xxxxxxxxxxx>
> ---
> .../bindings/soc/fsl/cpm_qe/fsl,tsa.yaml | 262 ++++++++++++++++++
> include/dt-bindings/soc/fsl-tsa.h | 15 +
> 2 files changed, 277 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/soc/fsl/cpm_qe/fsl,tsa.yaml
> create mode 100644 include/dt-bindings/soc/fsl-tsa.h
>
> diff --git a/Documentation/devicetree/bindings/soc/fsl/cpm_qe/fsl,tsa.yaml b/Documentation/devicetree/bindings/soc/fsl/cpm_qe/fsl,tsa.yaml
> new file mode 100644
> index 000000000000..7542c0fd8435
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/soc/fsl/cpm_qe/fsl,tsa.yaml
> @@ -0,0 +1,262 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/soc/fsl/cpm_qe/fsl,tsa.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: PowerQUICC CPM Time-slot assigner (TSA) controller
> +
> +maintainers:
> + - Herve Codina <herve.codina@xxxxxxxxxxx>
> +
> +description: |
> + The TSA is the time-slot assigner that can be found on some
> + PowerQUICC SoC.
> + Its purpose is to route some TDM time-slots to other internal
> + serial controllers.
> +
> +properties:
> + compatible:
> + items:
> + - enum:
> + - fsl,mpc885-tsa
> + - fsl,mpc866-tsa
> + - const: fsl,cpm1-tsa
> +
> + reg:
> + items:
> + - description: SI (Serial Interface) register base
> + - description: SI RAM base
> +
> + reg-names:
> + items:
> + - const: si_regs
> + - const: si_ram
> +
> + '#address-cells':
> + const: 1
> +
> + '#size-cells':
> + const: 0
> +
> +patternProperties:
> + "^tdm@[0-1]$":

Use consistent quotes - either ' or "

> + description:
> + The TDM managed by this controller
> + type: object
> +
> + properties:
> + reg:
> + minimum: 0
> + maximum: 1
> + description:
> + The TDM number for this TDM, 0 for TDMa and 1 for TDMb
> +
> + fsl,common-rxtx-pins:
> + $ref: /schemas/types.yaml#/definitions/flag
> + description:
> + Use common pins for both transmit and receive

What are the "common" pins? Without this property device is using
uncommon pins? This does not make sense...

> +
> + clocks: true
> + clock-names: true

Both need constraints.

> +
> + fsl,mode:
> + $ref: /schemas/types.yaml#/definitions/string
> + enum: [normal, echo, internal-loopback, control-loopback]
> + default: normal
> + description: |
> + Operational mode:
> + - normal:
> + Normal operation
> + - echo:
> + Automatic echo. Rx data is resent on Tx
> + - internal-loopback:
> + The TDM transmitter is connected to the receiver.
> + Data appears on Tx pin.
> + - control-loopback:
> + The TDM transmitter is connected to the receiver.
> + The Tx pin is disconnected.
> +
> + fsl,rx-frame-sync-delay:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [0, 1, 2, 3]
> + default: 0
> + description: |
> + Receive frame sync delay.

Delay in what units?

> + Indicates the delay between the Rx sync and the first bit of the
> + Rx frame. 0 for no bit delay. 1, 2 or 3 for 1, 2 or 3 bits delay.
> +
> + fsl,tx-frame-sync-delay:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [0, 1, 2, 3]
> + default: 0
> + description: |
> + Transmit frame sync delay.
> + Indicates the delay between the Tx sync and the first bit of the
> + Tx frame. 0 for no bit delay. 1, 2 or 3 for 1, 2 or 3 bits delay.
> +
> + fsl,clock-falling-edge:
> + $ref: /schemas/types.yaml#/definitions/flag
> + description: |
> + Data is sent on falling edge of the clock (and received on the
> + rising edge).
> + If 'clock-falling-edge' is not present, data is sent on the
> + rising edge (and received on the falling edge).
> +
> + fsl,fsync-rising-edge:
> + $ref: /schemas/types.yaml#/definitions/flag
> + description:
> + Frame sync pulses are sampled with the rising edge of the channel
> + clock. If 'fsync-rising-edge' is not present, pulses are sample
> + with e falling edge.
> +
> + fsl,double-speed-clock:
> + $ref: /schemas/types.yaml#/definitions/flag
> + description:
> + The channel clock is twice the data rate.
> +
> + fsl,grant-mode:
> + $ref: /schemas/types.yaml#/definitions/flag
> + description:
> + Grant mode enabled.

This we know from property name. You need to describe what it is and
what it does.

> +
> + tx_ts_routes:

No underscores, missing vendor prefix.

> + $ref: /schemas/types.yaml#/definitions/uint32-matrix
> + description: |
> + A list of tupple that indicates the Tx time-slots routes.
> + tx_ts_routes =
> + < 2 0 0>, /* The first 2 time slots are not used */
> + < 3 1 0>, /* The next 3 ones are route to SCC2 */
> + < 4 0 0>, /* The next 4 ones are not used */
> + < 2 2 0>; /* The nest 2 ones are route to SCC3 */
> + items:
> + items:
> + - description:
> + The number of time-slots
> + minimum: 1
> + maximum: 64
> + - description: |
> + The source serial interface (dt-bindings/soc/fsl-tsa.h
> + defines these values)
> + - 0: No destination
> + - 1: SCC2
> + - 2: SCC3
> + - 3: SCC4
> + - 4: SMC1
> + - 5: SMC2
> + enum: [0, 1, 2, 3, 4, 5]
> + - description:
> + The route flags (reserved)

Why part of binding is reserved?

> + const: 0
> + minItems: 1
> + maxItems: 64
> +
> + rx_ts_routes:
> + $ref: /schemas/types.yaml#/definitions/uint32-matrix
> + description: |
> + A list of tupple that indicates the Rx time-slots routes.
> + tx_ts_routes =
> + < 2 0 0>, /* The first 2 time slots are not used */
> + < 3 1 0>, /* The next 3 ones are route from SCC2 */
> + < 4 0 0>, /* The next 4 ones are not used */
> + < 2 2 0>; /* The nest 2 ones are route from SCC3 */
> + items:
> + items:
> + - description:
> + The number of time-slots
> + minimum: 1
> + maximum: 64
> + - description: |
> + The destination serial interface (dt-bindings/soc/fsl-tsa.h
> + defines these values)
> + - 0: No destination
> + - 1: SCC2
> + - 2: SCC3
> + - 3: SCC4
> + - 4: SMC1
> + - 5: SMC2
> + enum: [0, 1, 2, 3, 4, 5]
> + - description:
> + The route flags (reserved)
> + const: 0
> + minItems: 1
> + maxItems: 64
> +
> + allOf:
> + - if:
> + properties:
> + fsl,common-rxtx-pins:
> + type: 'null'

What is this exactly? If check for property present, it's wrong. Should
be test if it is in required.

> + then:
> + properties:
> + clocks:
> + items:
> + - description: External clock connected to L1RSYNC pin
> + - description: External clock connected to L1RCLK pin
> + - description: External clock connected to L1TSYNC pin
> + - description: External clock connected to L1TCLK pin
> + clock-names:
> + items:
> + - const: l1rsync
> + - const: l1rclk
> + - const: l1tsync
> + - const: l1tclk
> + else:
> + properties:
> + clocks:
> + items:
> + - description: External clock connected to L1RSYNC pin
> + - description: External clock connected to L1RCLK pin
> + clock-names:
> + items:
> + - const: l1rsync
> + - const: l1rclk
> +
> + required:
> + - reg
> + - clocks
> + - clock-names
> +
> +required:
> + - compatible
> + - reg
> + - reg-names
> + - '#address-cells'
> + - '#size-cells'
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/soc/fsl-tsa.h>
> +
> + tsa@ae0 {
> + compatible = "fsl,mpc885-tsa", "fsl,cpm1-tsa";
> + reg = <0xae0 0x10>,
> + <0xc00 0x200>;
> + reg-names = "si_regs", "si_ram";
> +
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + tdm@0 {
> + /* TDMa */
> + reg = <0>;
> +
> + clocks = <&clk_l1rsynca>, <&clk_l1rclka>;
> + clock-names = "l1rsync", "l1rclk";
> +
> + fsl,common-rxtx-pins;
> + fsl,fsync-rising-edge;
> +
> + tx_ts_routes = < 2 0 0>, /* TS 0..1 */
> + < 24 FSL_CPM_TSA_SCC4 0>, /* TS 2..25 */
> + < 1 0 0>, /* TS 26 */
> + < 5 FSL_CPM_TSA_SCC3 0>; /* TS 27..31 */
> +
> + rx_ts_routes = < 2 0 0>, /* TS 0..1 */
> + < 24 FSL_CPM_TSA_SCC4 0>, /* 2..25 */
> + < 1 0 0>, /* TS 26 */
> + < 5 FSL_CPM_TSA_SCC3 0>; /* TS 27..31 */
> + };
> + };
> diff --git a/include/dt-bindings/soc/fsl-tsa.h b/include/dt-bindings/soc/fsl-tsa.h
> new file mode 100644
> index 000000000000..9d09468694a2
> --- /dev/null
> +++ b/include/dt-bindings/soc/fsl-tsa.h

Filename should match binding filename.

> @@ -0,0 +1,15 @@
> +/* SPDX-License-Identifier: GPL-2.0-or-later OR MIT */

A bit weird license... cannot be the same as binding?

> +
> +#ifndef __DT_BINDINGS_SOC_FSL_TSA_H
> +#define __DT_BINDINGS_SOC_FSL_TSA_H
> +
> +#define FSL_CPM_TSA_NU 0 /* Pseuso Cell Id for not used item */

Why defining unused IDs in binding header? These are IDs, not some
hardware/register values.

> +#define FSL_CPM_TSA_SCC2 1
> +#define FSL_CPM_TSA_SCC3 2
> +#define FSL_CPM_TSA_SCC4 3
> +#define FSL_CPM_TSA_SMC1 4
> +#define FSL_CPM_TSA_SMC2 5
> +
> +#define FSL_CPM_TSA_NBCELL 6

Drop.

> +
> +#endif

Best regards,
Krzysztof

Next message: Haiyue Wang: "[PATCH bpf-next v1] bpf: Remove the unnecessary insn buffer comparison"
Previous message: Krzysztof Kozlowski: "Re: [PATCH v8 7/9] dt/bindings: display: bridge: it6505: Add mode-switch support"
Next in thread: Herve Codina: "Re: [PATCH v2 01/10] dt-bindings: soc: fsl: cpm_qe: Add TSA controller"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]