by Krzysztof Kozlowski

[permalink] [raw]

Subject: Re: [PATCH v4 1/5] dt-bindings: mfd: Add the Lantiq PEF2256 E1/T1/J1 framer

On 28/03/2023 09:48, Herve Codina wrote:
> The Lantiq PEF2256 is a framer and line interface component designed to
> fulfill all required interfacing between an analog E1/T1/J1 line and the
> digital PCM system highway/H.100 bus.
>
> Signed-off-by: Herve Codina <[email protected]>
> ---
> .../bindings/mfd/lantiq,pef2256.yaml | 270 ++++++++++++++++++
> 1 file changed, 270 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/mfd/lantiq,pef2256.yaml

> + pinctrl:
> + $ref: /schemas/pinctrl/pinctrl.yaml#
> +
> + patternProperties:
> + '-pins$':
> + type: object
> + $ref: /schemas/pinctrl/pincfg-node.yaml#
> +
> + properties:
> + pins:
> + enum: [ RPA, RPB, RPC, RPD, XPA, XPB, XPC, XPD ]
> +
> + function:
> + enum: [ SYPR, RFM, RFMB, RSIGM, RSIG, DLR, FREEZE, RFSP, LOS,
> + SYPX, XFMS, XSIG, TCLK, XMFB, XSIGM, DLX, XCLK, XLT,
> + GPI, GPOH, GPOL ]
> +
> + additionalProperties: false

Move it up (Put it after $ref: /schemas/pinctrl/pincfg-node.yaml#)

> +
> + required:
> + - pins
> + - function
> +
> + additionalProperties: false

Put it after $ref

> +
> + lantiq,line-interface:
> + $ref: /schemas/types.yaml#/definitions/string
> + enum: [e1, t1j1]
> + default: e1
> + description: |
> + The line interface type
> + - e1: E1 line
> + - t1j1: T1/J1 line
> +
> + lantiq,frame-format:
> + $ref: /schemas/types.yaml#/definitions/string
> + description:
> + The line interface frame format.
> +
> + lantiq,data-rate-bps:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [2048000, 4096000, 8192000, 16384000]
> + default: 2048000
> + description:
> + Data rate (bit per seconds) on the system highway.
> +
> + lantiq,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).
> +
> + lantiq,channel-phase:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [0, 1, 2, 3, 4, 5, 6, 7]
> + default: 0
> + description:
> + The pef2256 delivers a full frame (32 8bit time-slots in E1 and 24 8bit
> + time-slots 8 8bit signaling in E1/J1) every 125us. This lead to a data
> + rate of 2048000 bit/s. When lantiq,data-rate-bps is more than 2048000
> + bit/s, the data (all 32 8bit) present in the frame are interleave with
> + unused time-slots. The lantiq,channel-phase property allows to set the
> + correct alignment of the interleave mechanism.
> + For instance, suppose lantiq,data-rate-bps = 8192000 (ie 4*2048000), and
> + lantiq,channel-phase = 2, the interleave schema with unused time-slots
> + (nu) and used time-slots (XX) for TSi is
> + nu nu XX nu nu nu XX nu nu nu XX nu
> + <-- TSi --> <- TSi+1 -> <- TSi+2 ->
> + With lantiq,data-rate-bps = 8192000, and lantiq,channel-phase = 1, the
> + interleave schema is
> + nu XX nu nu nu XX nu nu nu XX nu nu
> + <-- TSi --> <- TSi+1 -> <- TSi+2 ->
> + With lantiq,data-rate-bps = 4096000 (ie 2*2048000), and
> + lantiq,channel-phase = 1, the interleave schema is
> + nu XX nu XX nu XX
> + <-- TSi --> <- TSi+1 -> <- TSi+2 ->
> +
> + lantiq,subordinate:
> + $ref: /schemas/types.yaml#/definitions/flag
> + description:
> + If present, the pef2256 works in subordinate mode. In this mode it
> + synchronizes on line interface clock signals. Otherwise, it synchronizes
> + on internal clocks.
> +
> +patternProperties:
> + '^codec([0-9]|[1-2][0-9]|3[0-1])?$':

Missing '-' before suffix numbers.

> + type: object
> + $ref: /schemas/sound/dai-common.yaml
> + description:
> + Codec provided by the pef2256. This codec allows to use some of the PCM
> + system highway time-slots as audio channels to transport audio data over
> + the E1/T1/J1 lines.
> + The time-slots used by the codec must be set and so, the properties
> + 'dai-tdm-slot-num', 'dai-tdm-slot-width', 'dai-tdm-slot-tx-mask' and
> + 'dai-tdm-slot-rx-mask' must be present in the sound card node for
> + sub-nodes that involve the codec. The codec uses 8bit time-slots.
> + 'dai-tdm-tdm-slot-with' must be set to 8.
> + The tx and rx masks define the pef2256 time-slots assigned to the codec.
> +
> + properties:
> + compatible:
> + const: lantiq,pef2256-codec
> +
> + '#sound-dai-cells':
> + const: 0
> +
> + required:
> + - compatible
> + - '#sound-dai-cells'
> +
> + unevaluatedProperties: false

Put it after $ref

> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - clock-names
> + - interrupts
> +
> +allOf:
> + - if:
> + properties:
> + lantiq,line-interface:
> + contains:
> + const: e1
> + then:
> + properties:
> + lantiq,frame-format:
> + enum: [doubleframe, crc4-multiframe, auto-multiframe]
> + default: doubleframe
> + description: |
> + The E1 line interface frame format
> + - doubleframe: Doubleframe format
> + - crc4-multiframe: CRC4 multiframe format
> + - auto-multiframe: CRC4 multiframe format with interworking
> + capabilities (ITU-T G.706 Annex B)
> +
> + else:
> + # T1/J1 line
> + properties:
> + lantiq,frame-format:
> + enum: [4frame, 12frame, 24frame, 72frame]
> + default: 12frame
> + description: |
> + The T1/J1 line interface frame format
> + - 4frame: 4-frame multiframe format (F4)
> + - 12frame: 12-frame multiframe format (F12, D3/4)
> + - 24frame: 24-frame multiframe format (ESF)
> + - 72frame: 72-frame multiframe format (F72, remote switch mode)
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> + #include <dt-bindings/interrupt-controller/irq.h>
> +
> + framer@2000000 {
> + compatible = "lantiq,pef2256", "simple-mfd";
> + reg = <0x2000000 0x100>;
> + interrupts = <8 IRQ_TYPE_LEVEL_LOW>;
> + interrupt-parent = <&intc>;
> + clocks = <&clk_mclk>, <&clk_sclkr>, <&clk_sclkx>;
> + clock-names = "mclk", "sclkr", "sclkx";
> + reset-gpios = <&gpio 11 GPIO_ACTIVE_LOW>;
> + lantiq,data-rate-bps = <4096000>;
> +
> + pinctrl {
> + pef2256_rpa_sypr: rpa-pins {
> + pins = "RPA";
> + function = "SYPR";
> + };
> + pef2256_xpa_sypx: xpa-pins {
> + pins = "XPA";
> + function = "SYPX";
> + };
> + };
> +
> + pef2256_codec0: codec0 {

codec-0

> + compatible = "lantiq,pef2256-codec";
> + #sound-dai-cells = <0>;
> + sound-name-prefix = "PEF2256_0";
> + };
> +
> + pef2256_codec1: codec1 {

codec-1

> + compatible = "lantiq,pef2256-codec";
> + #sound-dai-cells = <0>;
> + sound-name-prefix = "PEF2256_1";
> + };
> + };
> +

Best regards,
Krzysztof