* [PATCH v5 1/5] dt-bindings: mfd: Add the Lantiq PEF2256 E1/T1/J1 framer
2023-03-28 9:26 [PATCH v5 0/5] Add the Lantiq PEF2256 audio support Herve Codina
@ 2023-03-28 9:26 ` Herve Codina
2023-03-28 10:39 ` Krzysztof Kozlowski
2023-03-28 9:26 ` Herve Codina via Alsa-devel
` (8 subsequent siblings)
9 siblings, 1 reply; 45+ messages in thread
From: Herve Codina @ 2023-03-28 9:26 UTC (permalink / raw)
To: Herve Codina, Lee Jones, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai
Cc: linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
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 <herve.codina@bootlin.com>
---
.../bindings/mfd/lantiq,pef2256.yaml | 267 ++++++++++++++++++
1 file changed, 267 insertions(+)
create mode 100644 Documentation/devicetree/bindings/mfd/lantiq,pef2256.yaml
diff --git a/Documentation/devicetree/bindings/mfd/lantiq,pef2256.yaml b/Documentation/devicetree/bindings/mfd/lantiq,pef2256.yaml
new file mode 100644
index 000000000000..7bc29e93cbc6
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/lantiq,pef2256.yaml
@@ -0,0 +1,267 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/lantiq,pef2256.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Lantiq PEF2256
+
+maintainers:
+ - Herve Codina <herve.codina@bootlin.com>
+
+description:
+ The Lantiq PEF2256, also known as Infineon PEF2256 or FALC56, 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.
+
+properties:
+ compatible:
+ items:
+ - const: lantiq,pef2256
+ - const: simple-mfd
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ items:
+ - description: Master clock
+ - description: Receive System Clock
+ - description: Transmit System Clock
+
+ clock-names:
+ items:
+ - const: mclk
+ - const: sclkr
+ - const: sclkx
+
+ interrupts:
+ maxItems: 1
+
+ reset-gpios:
+ description:
+ GPIO used to reset the device.
+ maxItems: 1
+
+ pinctrl:
+ $ref: /schemas/pinctrl/pinctrl.yaml#
+ additionalProperties: false
+
+ patternProperties:
+ '-pins$':
+ type: object
+ $ref: /schemas/pinctrl/pincfg-node.yaml#
+ additionalProperties: false
+
+ 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 ]
+
+ required:
+ - pins
+ - function
+
+ 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]))?$':
+ type: object
+ $ref: /schemas/sound/dai-common.yaml
+ unevaluatedProperties: false
+ 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'
+
+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: codec-0 {
+ compatible = "lantiq,pef2256-codec";
+ #sound-dai-cells = <0>;
+ sound-name-prefix = "PEF2256_0";
+ };
+
+ pef2256_codec1: codec-1 {
+ compatible = "lantiq,pef2256-codec";
+ #sound-dai-cells = <0>;
+ sound-name-prefix = "PEF2256_1";
+ };
+ };
+
+ sound {
+ compatible = "simple-audio-card";
+ #address-cells = <1>;
+ #size-cells = <0>;
+ simple-audio-card,dai-link@0 { /* CPU DAI1 - pef2256 codec 1 */
+ reg = <0>;
+ cpu {
+ sound-dai = <&cpu_dai1>;
+ };
+ codec {
+ sound-dai = <&pef2256_codec0>;
+ dai-tdm-slot-num = <4>;
+ dai-tdm-slot-width = <8>;
+ /* TS 1, 2, 3, 4 */
+ dai-tdm-slot-tx-mask = <0 1 1 1 1>;
+ dai-tdm-slot-rx-mask = <0 1 1 1 1>;
+ };
+ };
+ simple-audio-card,dai-link@1 { /* CPU DAI2 - pef2256 codec 2 */
+ reg = <1>;
+ cpu {
+ sound-dai = <&cpu_dai2>;
+ };
+ codec {
+ sound-dai = <&pef2256_codec1>;
+ dai-tdm-slot-num = <4>;
+ dai-tdm-slot-width = <8>;
+ /* TS 5, 6, 7, 8 */
+ dai-tdm-slot-tx-mask = <0 0 0 0 0 1 1 1 1>;
+ dai-tdm-slot-rx-mask = <0 0 0 0 0 1 1 1 1>;
+ };
+ };
+ };
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread* Re: [PATCH v5 1/5] dt-bindings: mfd: Add the Lantiq PEF2256 E1/T1/J1 framer
2023-03-28 9:26 ` [PATCH v5 1/5] dt-bindings: mfd: Add the Lantiq PEF2256 E1/T1/J1 framer Herve Codina
@ 2023-03-28 10:39 ` Krzysztof Kozlowski
0 siblings, 0 replies; 45+ messages in thread
From: Krzysztof Kozlowski @ 2023-03-28 10:39 UTC (permalink / raw)
To: Herve Codina, Lee Jones, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai
Cc: linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
On 28/03/2023 11:26, 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 <herve.codina@bootlin.com>
> ---
> .../bindings/mfd/lantiq,pef2256.yaml | 267 ++++++++++++++++++
> 1 file changed, 267 insertions(+)
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 45+ messages in thread
* [PATCH v5 1/5] dt-bindings: mfd: Add the Lantiq PEF2256 E1/T1/J1 framer
2023-03-28 9:26 [PATCH v5 0/5] Add the Lantiq PEF2256 audio support Herve Codina
2023-03-28 9:26 ` [PATCH v5 1/5] dt-bindings: mfd: Add the Lantiq PEF2256 E1/T1/J1 framer Herve Codina
@ 2023-03-28 9:26 ` Herve Codina via Alsa-devel
2023-03-28 9:26 ` [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer Herve Codina
` (7 subsequent siblings)
9 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-03-28 9:26 UTC (permalink / raw)
To: Herve Codina, Lee Jones, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai
Cc: linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 13028 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Herve Codina <herve.codina@bootlin.com>, Lee Jones <lee@kernel.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Jaroslav Kysela <perex@perex.cz>, Takashi Iwai <tiwai@suse.com>
Cc: linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: [PATCH v5 1/5] dt-bindings: mfd: Add the Lantiq PEF2256 E1/T1/J1 framer
Date: Tue, 28 Mar 2023 11:26:41 +0200
Message-ID: <20230328092645.634375-2-herve.codina@bootlin.com>
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 <herve.codina@bootlin.com>
---
.../bindings/mfd/lantiq,pef2256.yaml | 267 ++++++++++++++++++
1 file changed, 267 insertions(+)
create mode 100644 Documentation/devicetree/bindings/mfd/lantiq,pef2256.yaml
diff --git a/Documentation/devicetree/bindings/mfd/lantiq,pef2256.yaml b/Documentation/devicetree/bindings/mfd/lantiq,pef2256.yaml
new file mode 100644
index 000000000000..7bc29e93cbc6
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/lantiq,pef2256.yaml
@@ -0,0 +1,267 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/lantiq,pef2256.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Lantiq PEF2256
+
+maintainers:
+ - Herve Codina <herve.codina@bootlin.com>
+
+description:
+ The Lantiq PEF2256, also known as Infineon PEF2256 or FALC56, 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.
+
+properties:
+ compatible:
+ items:
+ - const: lantiq,pef2256
+ - const: simple-mfd
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ items:
+ - description: Master clock
+ - description: Receive System Clock
+ - description: Transmit System Clock
+
+ clock-names:
+ items:
+ - const: mclk
+ - const: sclkr
+ - const: sclkx
+
+ interrupts:
+ maxItems: 1
+
+ reset-gpios:
+ description:
+ GPIO used to reset the device.
+ maxItems: 1
+
+ pinctrl:
+ $ref: /schemas/pinctrl/pinctrl.yaml#
+ additionalProperties: false
+
+ patternProperties:
+ '-pins$':
+ type: object
+ $ref: /schemas/pinctrl/pincfg-node.yaml#
+ additionalProperties: false
+
+ 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 ]
+
+ required:
+ - pins
+ - function
+
+ 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]))?$':
+ type: object
+ $ref: /schemas/sound/dai-common.yaml
+ unevaluatedProperties: false
+ 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'
+
+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: codec-0 {
+ compatible = "lantiq,pef2256-codec";
+ #sound-dai-cells = <0>;
+ sound-name-prefix = "PEF2256_0";
+ };
+
+ pef2256_codec1: codec-1 {
+ compatible = "lantiq,pef2256-codec";
+ #sound-dai-cells = <0>;
+ sound-name-prefix = "PEF2256_1";
+ };
+ };
+
+ sound {
+ compatible = "simple-audio-card";
+ #address-cells = <1>;
+ #size-cells = <0>;
+ simple-audio-card,dai-link@0 { /* CPU DAI1 - pef2256 codec 1 */
+ reg = <0>;
+ cpu {
+ sound-dai = <&cpu_dai1>;
+ };
+ codec {
+ sound-dai = <&pef2256_codec0>;
+ dai-tdm-slot-num = <4>;
+ dai-tdm-slot-width = <8>;
+ /* TS 1, 2, 3, 4 */
+ dai-tdm-slot-tx-mask = <0 1 1 1 1>;
+ dai-tdm-slot-rx-mask = <0 1 1 1 1>;
+ };
+ };
+ simple-audio-card,dai-link@1 { /* CPU DAI2 - pef2256 codec 2 */
+ reg = <1>;
+ cpu {
+ sound-dai = <&cpu_dai2>;
+ };
+ codec {
+ sound-dai = <&pef2256_codec1>;
+ dai-tdm-slot-num = <4>;
+ dai-tdm-slot-width = <8>;
+ /* TS 5, 6, 7, 8 */
+ dai-tdm-slot-tx-mask = <0 0 0 0 0 1 1 1 1>;
+ dai-tdm-slot-rx-mask = <0 0 0 0 0 1 1 1 1>;
+ };
+ };
+ };
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread* [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-28 9:26 [PATCH v5 0/5] Add the Lantiq PEF2256 audio support Herve Codina
2023-03-28 9:26 ` [PATCH v5 1/5] dt-bindings: mfd: Add the Lantiq PEF2256 E1/T1/J1 framer Herve Codina
2023-03-28 9:26 ` Herve Codina via Alsa-devel
@ 2023-03-28 9:26 ` Herve Codina
2023-03-30 16:05 ` Lee Jones
2023-03-28 9:26 ` Herve Codina via Alsa-devel
` (6 subsequent siblings)
9 siblings, 1 reply; 45+ messages in thread
From: Herve Codina @ 2023-03-28 9:26 UTC (permalink / raw)
To: Herve Codina, Lee Jones, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai
Cc: linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
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 <herve.codina@bootlin.com>
---
drivers/mfd/Kconfig | 17 +
drivers/mfd/Makefile | 1 +
drivers/mfd/pef2256.c | 1355 +++++++++++++++++++++++++++++++++++
include/linux/mfd/pef2256.h | 28 +
4 files changed, 1401 insertions(+)
create mode 100644 drivers/mfd/pef2256.c
create mode 100644 include/linux/mfd/pef2256.h
diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
index fcc141e067b9..74c3750d21e4 100644
--- a/drivers/mfd/Kconfig
+++ b/drivers/mfd/Kconfig
@@ -1063,6 +1063,23 @@ config PCF50633_GPIO
Say yes here if you want to include support GPIO for pins on
the PCF50633 chip.
+config MFD_PEF2256
+ tristate "Lantiq PEF2256 (FALC56) framer"
+ depends on OF
+ select PINCTRL
+ select PINMUX
+ select GENERIC_PINCONF
+ help
+ This option enables support for the Lantiq PEF2256 framer, also known
+ as FALC56. This framer and its line interface component is designed
+ to fulfill all required interfacing between analog E1/T1/J1 lines and
+ the digital PCM system highway.
+
+ If unsure, say N.
+
+ To compile this driver as a module, choose M here: the
+ module will be called pef2256.
+
config MFD_PM8XXX
tristate "Qualcomm PM8xxx PMIC chips driver"
depends on (ARM || HEXAGON || COMPILE_TEST)
diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
index 2f6c89d1e277..b2bb6e6a141c 100644
--- a/drivers/mfd/Makefile
+++ b/drivers/mfd/Makefile
@@ -195,6 +195,7 @@ obj-$(CONFIG_MFD_SI476X_CORE) += si476x-core.o
obj-$(CONFIG_MFD_CS5535) += cs5535-mfd.o
obj-$(CONFIG_MFD_OMAP_USB_HOST) += omap-usb-host.o omap-usb-tll.o
+obj-$(CONFIG_MFD_PEF2256) += pef2256.o
obj-$(CONFIG_MFD_PM8XXX) += qcom-pm8xxx.o ssbi.o
obj-$(CONFIG_MFD_QCOM_RPM) += qcom_rpm.o
obj-$(CONFIG_MFD_SPMI_PMIC) += qcom-spmi-pmic.o
diff --git a/drivers/mfd/pef2256.c b/drivers/mfd/pef2256.c
new file mode 100644
index 000000000000..1a3896c2edcf
--- /dev/null
+++ b/drivers/mfd/pef2256.c
@@ -0,0 +1,1355 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * PEF2256 also known as FALC56 driver
+ *
+ * Copyright 2023 CS GROUP France
+ *
+ * Author: Herve Codina <herve.codina@bootlin.com>
+ */
+
+#include <linux/mfd/pef2256.h>
+#include <linux/clk.h>
+#include <linux/gpio/consumer.h>
+#include <linux/interrupt.h>
+#include <linux/io.h>
+#include <linux/iopoll.h>
+#include <linux/module.h>
+#include <linux/notifier.h>
+#include <linux/of.h>
+#include <linux/of_platform.h>
+#include <linux/pinctrl/pinctrl.h>
+#include <linux/pinctrl/pinconf-generic.h>
+#include <linux/pinctrl/pinmux.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+
+#define PEF2256_CMDR 0x02 /* Command Register */
+#define PEF2256_CMDR_RRES BIT(6)
+#define PEF2256_CMDR_XRES BIT(4)
+#define PEF2256_CMDR_SRES BIT(0)
+#define PEF2256_IMR0 0x14 /* Interrupt Mask Register 0 */
+#define PEF2256_IMR1 0x15 /* Interrupt Mask Register 1 */
+#define PEF2256_IMR2 0x16 /* Interrupt Mask Register 2 */
+#define PEF2256_IMR3 0x17 /* Interrupt Mask Register 3 */
+#define PEF2256_IMR4 0x18 /* Interrupt Mask Register 4 */
+#define PEF2256_IMR5 0x19 /* Interrupt Mask Register 5 */
+#define PEF2256_FMR0 0x1C /* Framer Mode Register 0 */
+#define PEF2256_FMR0_XC_MASK (0x3 << 6)
+#define PEF2256_FMR0_XC_NRZ (0x0 << 6)
+#define PEF2256_FMR0_XC_CMI (0x1 << 6)
+#define PEF2256_FMR0_XC_AMI (0x2 << 6)
+#define PEF2256_FMR0_XC_HDB3 (0x3 << 6)
+#define PEF2256_FMR0_RC_MASK (0x3 << 4)
+#define PEF2256_FMR0_RC_NRZ (0x0 << 4)
+#define PEF2256_FMR0_RC_CMI (0x1 << 4)
+#define PEF2256_FMR0_RC_AMI (0x2 << 4)
+#define PEF2256_FMR0_RC_HDB3 (0x3 << 4)
+#define PEF2256_FMR1 0x1D /* Framer Mode Register 1 */
+#define PEF2256_FMR1_XFS BIT(3)
+#define PEF2256_FMR1_ECM BIT(2)
+/* SSD is defined on 2 bits. The other bit is on SIC1 register */
+#define PEF2256_FMR1_SSD_MASK BIT(1)
+#define PEF2256_FMR1_SSD_2048 0
+#define PEF2256_FMR1_SSD_4096 BIT(1)
+#define PEF2256_FMR1_SSD_8192 0
+#define PEF2256_FMR1_SSD_16384 BIT(1)
+#define PEF2256_FMR2 0x1E /* Framer Mode Register 2 */
+#define PEF2256_FMR2_RFS_MASK (0x3 << 6)
+#define PEF2256_FMR2_RFS_DOUBLEFRAME (0x0 << 6)
+#define PEF2256_FMR2_RFS_CRC4_MULTIFRAME (0x2 << 6)
+#define PEF2256_FMR2_RFS_AUTO_MULTIFRAME (0x3 << 6)
+#define PEF2256_FMR2_AXRA BIT(1)
+#define PEF2256_LOOP 0x1F /* Channel Loop-Back */
+#define PEF2256_XSW 0x20 /* Transmit Service Word */
+#define PEF2256_XSW_XSIS BIT(7)
+#define PEF2256_XSW_XTM BIT(6)
+#define PEF2256_XSW_XY_MASK (0x1f << 0)
+#define PEF2256_XSW_XY(_v) ((_v) & 0x1f)
+#define PEF2256_XSP 0x21 /* Transmit Spare Bits */
+#define PEF2256_XSP_XSIF BIT(2)
+#define PEF2256_XC0 0x22 /* Transmit Control 0 */
+#define PEF2256_XC1 0x23 /* Transmit Control 1 */
+#define PEF2256_RC0 0x24 /* Receive Control 0 */
+#define PEF2256_RC0_SWD BIT(7)
+#define PEF2256_RC0_ASY4 BIT(6)
+#define PEF2256_RC1 0x25 /* Receive Control 1 */
+#define PEF2256_XPM0 0x26 /* Transmit Pulse Mask 0 */
+#define PEF2256_XPM1 0x27 /* Transmit Pulse Mask 1 */
+#define PEF2256_XPM2 0x28 /* Transmit Pulse Mask 2 */
+#define PEF2256_XPM2_XLT BIT(6)
+#define PEF2256_TSWM 0x29 /* Transparent Service Word Mask */
+#define PEF2256_LIM0 0x36 /* Line Interface Mode 0 */
+#define PEF2256_2X_LIM0_BIT3 BIT(3) /* v2.x, described as a forced '1' bit */
+#define PEF2256_LIM0_MAS BIT(0)
+#define PEF2256_LIM1 0x37 /* Line Interface Mode 1 */
+#define PEF2256_12_LIM1_RIL_MASK (0x7 << 4)
+#define PEF2256_12_LIM1_RIL_910 (0x0 << 4)
+#define PEF2256_12_LIM1_RIL_740 (0x1 << 4)
+#define PEF2256_12_LIM1_RIL_590 (0x2 << 4)
+#define PEF2256_12_LIM1_RIL_420 (0x3 << 4)
+#define PEF2256_12_LIM1_RIL_320 (0x4 << 4)
+#define PEF2256_12_LIM1_RIL_210 (0x5 << 4)
+#define PEF2256_12_LIM1_RIL_160 (0x6 << 4)
+#define PEF2256_12_LIM1_RIL_100 (0x7 << 4)
+#define PEF2256_2X_LIM1_RIL_MASK (0x7 << 4)
+#define PEF2256_2X_LIM1_RIL_2250 (0x0 << 4)
+#define PEF2256_2X_LIM1_RIL_1100 (0x1 << 4)
+#define PEF2256_2X_LIM1_RIL_600 (0x2 << 4)
+#define PEF2256_2X_LIM1_RIL_350 (0x3 << 4)
+#define PEF2256_2X_LIM1_RIL_210 (0x4 << 4)
+#define PEF2256_2X_LIM1_RIL_140 (0x5 << 4)
+#define PEF2256_2X_LIM1_RIL_100 (0x6 << 4)
+#define PEF2256_2X_LIM1_RIL_50 (0x7 << 4)
+#define PEF2256_PCD 0x38 /* Pulse Count Detection */
+#define PEF2256_PCR 0x39 /* Pulse Count Recovery */
+#define PEF2256_LIM2 0x3A /* Line Interface Mode 2 */
+#define PEF2256_LIM2_SLT_MASK (0x3 << 4)
+#define PEF2256_LIM2_SLT_THR55 (0x0 << 4)
+#define PEF2256_LIM2_SLT_THR67 (0x1 << 4)
+#define PEF2256_LIM2_SLT_THR50 (0x2 << 4)
+#define PEF2256_LIM2_SLT_THR45 (0x3 << 4)
+#define PEF2256_LIM2_ELT BIT(2)
+#define PEF2256_SIC1 0x3E /* System Interface Control 1 */
+#define PEF2256_SIC1_SSC_MASK (BIT(7) | BIT(3))
+#define PEF2256_SIC1_SSC_2048 (0)
+#define PEF2256_SIC1_SSC_4096 BIT(3)
+#define PEF2256_SIC1_SSC_8192 BIT(7)
+#define PEF2256_SIC1_SSC_16384 (BIT(7) | BIT(3))
+/* SSD is defined on 2 bits. The other bit is on FMR1 register */
+#define PEF2256_SIC1_SSD_MASK BIT(6)
+#define PEF2256_SIC1_SSD_2048 0
+#define PEF2256_SIC1_SSD_4096 0
+#define PEF2256_SIC1_SSD_8192 BIT(6)
+#define PEF2256_SIC1_SSD_16384 BIT(6)
+#define PEF2256_SIC1_RBS_MASK (0x3 << 4)
+#define PEF2256_SIC1_RBS_2FRAMES (0x0 << 4)
+#define PEF2256_SIC1_RBS_1FRAME (0x1 << 4)
+#define PEF2256_SIC1_RBS_96BITS (0x2 << 4)
+#define PEF2256_SIC1_RBS_BYPASS (0x3 << 4)
+#define PEF2256_SIC1_XBS_MASK (0x3 << 0)
+#define PEF2256_SIC1_XBS_BYPASS (0x0 << 0)
+#define PEF2256_SIC1_XBS_1FRAME (0x1 << 0)
+#define PEF2256_SIC1_XBS_2FRAMES (0x2 << 0)
+#define PEF2256_SIC1_XBS_96BITS (0x3 << 0)
+#define PEF2256_SIC2 0x3F /* System Interface Control 2 */
+#define PEF2256_SIC2_SICS_MASK (0x7 << 1)
+#define PEF2256_SIC2_SICS(_v) ((_v) << 1)
+#define PEF2256_SIC3 0x40 /* System Interface Control 3 */
+#define PEF2256_SIC3_RTRI BIT(5)
+#define PEF2256_SIC3_RESX BIT(3)
+#define PEF2256_SIC3_RESR BIT(2)
+#define PEF2256_CMR1 0x44 /* Clock Mode Register 1 */
+#define PEF2256_CMR1_RS_MASK (0x3 << 4)
+#define PEF2256_CMR1_RS_DPLL (0x0 << 4)
+#define PEF2256_CMR1_RS_DPLL_LOS_HIGH (0x1 << 4)
+#define PEF2256_CMR1_RS_DCOR_2048 (0x2 << 4)
+#define PEF2256_CMR1_RS_DCOR_8192 (0x3 << 4)
+#define PEF2256_CMR1_DCS BIT(3)
+#define PEF2256_CMR2 0x45 /* Clock Mode Register 2 */
+#define PEF2256_CMR2_DCOXC BIT(5)
+#define PEF2256_GCR 0x46 /* Global Configuration Register */
+#define PEF2256_GCR_SCI BIT(6)
+#define PEF2256_GCR_ECMC BIT(4)
+#define PEF2256_PC1 0x80 /* Port Configuration 1 */
+#define PEF2256_PC2 0x81 /* Port Configuration 2 */
+#define PEF2256_PC3 0x82 /* Port Configuration 3 */
+#define PEF2256_PC4 0x83 /* Port Configuration 4 */
+#define PEF2256_12_PC_RPC_MASK (0x7 << 4)
+#define PEF2256_12_PC_RPC_SYPR (0x0 << 4)
+#define PEF2256_12_PC_RPC_RFM (0x1 << 4)
+#define PEF2256_12_PC_RPC_RFMB (0x2 << 4)
+#define PEF2256_12_PC_RPC_RSIGM (0x3 << 4)
+#define PEF2256_12_PC_RPC_RSIG (0x4 << 4)
+#define PEF2256_12_PC_RPC_DLR (0x5 << 4)
+#define PEF2256_12_PC_RPC_FREEZE (0x6 << 4)
+#define PEF2256_12_PC_RPC_RFSP (0x7 << 4)
+#define PEF2256_12_PC_XPC_MASK (0xf << 0)
+#define PEF2256_12_PC_XPC_SYPX (0x0 << 0)
+#define PEF2256_12_PC_XPC_XFMS (0x1 << 0)
+#define PEF2256_12_PC_XPC_XSIG (0x2 << 0)
+#define PEF2256_12_PC_XPC_TCLK (0x3 << 0)
+#define PEF2256_12_PC_XPC_XMFB (0x4 << 0)
+#define PEF2256_12_PC_XPC_XSIGM (0x5 << 0)
+#define PEF2256_12_PC_XPC_DLX (0x6 << 0)
+#define PEF2256_12_PC_XPC_XCLK (0x7 << 0)
+#define PEF2256_12_PC_XPC_XLT (0x8 << 0)
+#define PEF2256_2X_PC_RPC_MASK (0xf << 4)
+#define PEF2256_2X_PC_RPC_SYPR (0x0 << 4)
+#define PEF2256_2X_PC_RPC_RFM (0x1 << 4)
+#define PEF2256_2X_PC_RPC_RFMB (0x2 << 4)
+#define PEF2256_2X_PC_RPC_RSIGM (0x3 << 4)
+#define PEF2256_2X_PC_RPC_RSIG (0x4 << 4)
+#define PEF2256_2X_PC_RPC_DLR (0x5 << 4)
+#define PEF2256_2X_PC_RPC_FREEZE (0x6 << 4)
+#define PEF2256_2X_PC_RPC_RFSP (0x7 << 4)
+#define PEF2256_2X_PC_RPC_GPI (0x9 << 4)
+#define PEF2256_2X_PC_RPC_GPOH (0xa << 4)
+#define PEF2256_2X_PC_RPC_GPOL (0xb << 4)
+#define PEF2256_2X_PC_RPC_LOS (0xc << 4)
+#define PEF2256_2X_PC_XPC_MASK (0xf << 0)
+#define PEF2256_2X_PC_XPC_SYPX (0x0 << 0)
+#define PEF2256_2X_PC_XPC_XFMS (0x1 << 0)
+#define PEF2256_2X_PC_XPC_XSIG (0x2 << 0)
+#define PEF2256_2X_PC_XPC_TCLK (0x3 << 0)
+#define PEF2256_2X_PC_XPC_XMFB (0x4 << 0)
+#define PEF2256_2X_PC_XPC_XSIGM (0x5 << 0)
+#define PEF2256_2X_PC_XPC_DLX (0x6 << 0)
+#define PEF2256_2X_PC_XPC_XCLK (0x7 << 0)
+#define PEF2256_2X_PC_XPC_XLT (0x8 << 0)
+#define PEF2256_2X_PC_XPC_GPI (0x9 << 0)
+#define PEF2256_2X_PC_XPC_GPOH (0xa << 0)
+#define PEF2256_2X_PC_XPC_GPOL (0xb << 0)
+#define PEF2256_PC5 0x84 /* Port Configuration 5 */
+#define PEF2256_PC5_CRP BIT(0)
+#define PEF2256_GPC1 0x85 /* Global Port Configuration 1 */
+#define PEF2256_GPC1_CSFP_MASK (0x3 << 5)
+#define PEF2256_GPC1_CSFP_SEC_IN_HIGH (0x0 << 5)
+#define PEF2256_GPC1_CSFP_SEC_OUT_HIGH (0x1 << 5)
+#define PEF2256_GPC1_CSFP_FSC_OUT_HIGH (0x2 << 5)
+#define PEF2256_GPC1_CSFP_FSC_OUT_LOW (0x3 << 5)
+#define PEF2256_PC6 0x86 /* Port Configuration 6 */
+#define PEF2256_GCM(_n) (0x92 + (_n) - 1) /* Global Counter Mode n=1..8 */
+#define PEF2256_GCM1 0x92 /* Global Counter Mode 1 */
+#define PEF2256_GCM2 0x93 /* Global Counter Mode 2 */
+#define PEF2256_GCM3 0x94 /* Global Counter Mode 3 */
+#define PEF2256_GCM4 0x95 /* Global Counter Mode 4 */
+#define PEF2256_GCM5 0x96 /* Global Counter Mode 5 */
+#define PEF2256_GCM6 0x97 /* Global Counter Mode 6 */
+#define PEF2256_GCM7 0x98 /* Global Counter Mode 7 */
+#define PEF2256_GCM8 0x99 /* Global Counter Mode 8 */
+
+#define PEF2256_VSTR 0x4A /* Version Status Register */
+#define PEF2256_VSTR_VERSION_12 0x00
+#define PEF2256_VSTR_VERSION_21 0x10
+#define PEF2256_VSTR_VERSION_2x 0x05
+#define PEF2256_FRS0 0x4C /* Framer Receive Status 0 */
+#define PEF2256_FRS0_LOS BIT(7)
+#define PEF2256_FRS0_AIS BIT(6)
+#define PEF2256_ISR(_n) (0x68 + (_n)) /* Interrupt Status Register (n=0..5) */
+#define PEF2256_ISR0 0x68 /* Interrupt Status Register 0 */
+#define PEF2256_ISR1 0x69 /* Interrupt Status Register 1 */
+#define PEF2256_ISR2 0x6A /* Interrupt Status Register 2 */
+#define PEF2256_ISR3 0x6B /* Interrupt Status Register 3 */
+#define PEF2256_ISR4 0x6C /* Interrupt Status Register 4 */
+#define PEF2256_ISR5 0x6D /* Interrupt Status Register 5 */
+#define PEF2256_GIS 0x6E /* Global Interrupt Status */
+#define PEF2256_GIS_ISR(_n) (1 << (_n))
+#define PEF2256_WID 0xEC /* Wafer Identification Register */
+#define PEF2256_12_WID_MASK 0x03
+#define PEF2256_12_WID_VERSION_12 0x03
+#define PEF2256_2X_WID_MASK 0xc0
+#define PEF2256_2X_WID_VERSION_21 0x00
+#define PEF2256_2X_WID_VERSION_22 0x40
+
+/* IMR2/ISR2 Interrupts */
+#define PEF2256_INT2_AIS BIT(3)
+#define PEF2256_INT2_LOS BIT(2)
+
+enum pef2256_version {
+ PEF2256_VERSION_UNKNOWN,
+ PEF2256_VERSION_1_2,
+ PEF2256_VERSION_2_1,
+ PEF2256_VERSION_2_2,
+};
+
+enum pef2256_frame_type {
+ PEF2256_FRAME_E1_DOUBLEFRAME,
+ PEF2256_FRAME_E1_CRC4_MULTIFRAME,
+ PEF2256_FRAME_E1_AUTO_MULTIFRAME,
+ PEF2256_FRAME_T1J1_4FRAME,
+ PEF2256_FRAME_T1J1_12FRAME,
+ PEF2256_FRAME_T1J1_24FRAME,
+ PEF2256_FRAME_T1J1_72FRAME,
+};
+
+struct pef2256_pinreg_desc {
+ int offset;
+ u8 mask;
+};
+
+struct pef2256_function_desc {
+ const char *name;
+ const char * const*groups;
+ unsigned int ngroups;
+ u8 func_val;
+};
+
+struct pef2256 {
+ struct device *dev;
+ void *__iomem regs;
+ enum pef2256_version version;
+ struct clk *mclk;
+ struct clk *sclkr;
+ struct clk *sclkx;
+ struct gpio_desc *reset_gpio;
+ struct {
+ struct pinctrl_desc pctrl_desc;
+ const struct pef2256_function_desc *functions;
+ unsigned int nfunctions;
+ } pinctrl;
+ bool is_e1;
+ unsigned long sysclk_rate;
+ u32 data_rate;
+ bool is_tx_falling_edge;
+ bool is_subordinate;
+ enum pef2256_frame_type frame_type;
+ u8 channel_phase;
+ atomic_t carrier;
+ struct atomic_notifier_head event_notifier_list;
+};
+
+static inline u8 pef2256_read8(struct pef2256 *pef2256, int offset)
+{
+ return ioread8(pef2256->regs + offset);
+}
+
+static inline void pef2256_write8(struct pef2256 *pef2256, int offset, u8 val)
+{
+ iowrite8(val, pef2256->regs + offset);
+}
+
+static inline void pef2256_clrbits8(struct pef2256 *pef2256, int offset, u8 clr)
+{
+ pef2256_write8(pef2256, offset, pef2256_read8(pef2256, offset) & ~clr);
+}
+
+static inline void pef2256_setbits8(struct pef2256 *pef2256, int offset, u8 set)
+{
+ pef2256_write8(pef2256, offset, pef2256_read8(pef2256, offset) | set);
+}
+
+
+static inline void pef2256_clrsetbits8(struct pef2256 *pef2256, int offset, u8 clr, u8 set)
+{
+ u8 v;
+
+ v = pef2256_read8(pef2256, offset);
+ v &= ~clr;
+ v |= set;
+ pef2256_write8(pef2256, offset, v);
+}
+
+static enum pef2256_version pef2256_get_version(struct pef2256 *pef2256)
+{
+ enum pef2256_version version = PEF2256_VERSION_UNKNOWN;
+ const char *version_txt;
+ u8 vstr, wid;
+
+ vstr = pef2256_read8(pef2256, PEF2256_VSTR);
+ wid = pef2256_read8(pef2256, PEF2256_WID);
+
+ switch (vstr) {
+ case PEF2256_VSTR_VERSION_12:
+ if ((wid & PEF2256_12_WID_MASK) == PEF2256_12_WID_VERSION_12) {
+ version_txt = "1.2";
+ version = PEF2256_VERSION_1_2;
+ }
+ break;
+ case PEF2256_VSTR_VERSION_2x:
+ switch (wid & PEF2256_2X_WID_MASK) {
+ case PEF2256_2X_WID_VERSION_21:
+ version_txt = "2.1 (2.x)";
+ version = PEF2256_VERSION_2_1;
+ break;
+ case PEF2256_2X_WID_VERSION_22:
+ version_txt = "2.2 (2.x)";
+ version = PEF2256_VERSION_2_2;
+ break;
+ }
+ break;
+ case PEF2256_VSTR_VERSION_21:
+ version_txt = "2.1";
+ version = PEF2256_VERSION_2_1;
+ break;
+ }
+
+ if (version == PEF2256_VERSION_UNKNOWN)
+ dev_err(pef2256->dev, "Unknown version (0x%02x, 0x%02x)\n", vstr, wid);
+ else
+ dev_info(pef2256->dev, "Version %s detected\n", version_txt);
+
+ return version;
+}
+
+enum pef2256_gcm_config_item {
+ PEF2256_GCM_CONFIG_1544000 = 0,
+ PEF2256_GCM_CONFIG_2048000,
+ PEF2256_GCM_CONFIG_8192000,
+ PEF2256_GCM_CONFIG_10000000,
+ PEF2256_GCM_CONFIG_12352000,
+ PEF2256_GCM_CONFIG_16384000,
+};
+
+struct pef2256_gcm_config {
+ u8 gcm_12[6];
+ u8 gcm_2x[8];
+};
+
+static const struct pef2256_gcm_config pef2256_gcm_configs[] = {
+ [PEF2256_GCM_CONFIG_1544000] = {
+ .gcm_12 = {0xF0, 0x51, 0x00, 0x80, 0x00, 0x15},
+ .gcm_2x = {0x00, 0x15, 0x00, 0x08, 0x00, 0x3F, 0x9C, 0xDF},
+ },
+ [PEF2256_GCM_CONFIG_2048000] = {
+ .gcm_12 = {0x00, 0x58, 0xD2, 0xC2, 0x00, 0x10},
+ .gcm_2x = {0x00, 0x18, 0xFB, 0x0B, 0x00, 0x2F, 0xDB, 0xDF},
+ },
+ [PEF2256_GCM_CONFIG_8192000] = {
+ .gcm_12 = {0x00, 0x58, 0xD2, 0xC2, 0x03, 0x10},
+ .gcm_2x = {0x00, 0x18, 0xFB, 0x0B, 0x00, 0x0B, 0xDB, 0xDF},
+ },
+ [PEF2256_GCM_CONFIG_10000000] = {
+ .gcm_12 = {0x90, 0x51, 0x81, 0x8F, 0x04, 0x10},
+ .gcm_2x = {0x40, 0x1B, 0x3D, 0x0A, 0x00, 0x07, 0xC9, 0xDC},
+ },
+ [PEF2256_GCM_CONFIG_12352000] = {
+ .gcm_12 = {0xF0, 0x51, 0x00, 0x80, 0x07, 0x15},
+ .gcm_2x = {0x00, 0x19, 0x00, 0x08, 0x01, 0x0A, 0x98, 0xDA},
+ },
+ [PEF2256_GCM_CONFIG_16384000] = {
+ .gcm_12 = {0x00, 0x58, 0xD2, 0xC2, 0x07, 0x10},
+ .gcm_2x = {0x00, 0x18, 0xFB, 0x0B, 0x01, 0x0B, 0xDB, 0xDF},
+ },
+};
+
+static int pef2256_setup_gcm(struct pef2256 *pef2256)
+{
+ enum pef2256_gcm_config_item item;
+ unsigned long mclk_rate;
+ const u8 *gcm;
+ int i, count;
+
+ mclk_rate = clk_get_rate(pef2256->mclk);
+ switch (mclk_rate) {
+ case 1544000:
+ item = PEF2256_GCM_CONFIG_1544000;
+ break;
+ case 2048000:
+ item = PEF2256_GCM_CONFIG_2048000;
+ break;
+ case 8192000:
+ item = PEF2256_GCM_CONFIG_8192000;
+ break;
+ case 10000000:
+ item = PEF2256_GCM_CONFIG_10000000;
+ break;
+ case 12352000:
+ item = PEF2256_GCM_CONFIG_12352000;
+ break;
+ case 16384000:
+ item = PEF2256_GCM_CONFIG_16384000;
+ break;
+ default:
+ dev_err(pef2256->dev, "Unsupported v2.x MCLK rate %lu\n", mclk_rate);
+ return -EINVAL;
+ }
+
+ BUILD_BUG_ON(item >= ARRAY_SIZE(pef2256_gcm_configs));
+
+ if (pef2256->version == PEF2256_VERSION_1_2) {
+ gcm = pef2256_gcm_configs[item].gcm_12;
+ count = ARRAY_SIZE(pef2256_gcm_configs[item].gcm_12);
+ } else {
+ gcm = pef2256_gcm_configs[item].gcm_2x;
+ count = ARRAY_SIZE(pef2256_gcm_configs[item].gcm_2x);
+ }
+
+ for (i = 0; i < count; i++)
+ pef2256_write8(pef2256, PEF2256_GCM(i+1), *(gcm + i));
+
+ return 0;
+}
+
+static int pef2256_setup_e1(struct pef2256 *pef2256)
+{
+ u8 fmr1, fmr2, sic1;
+ int ret;
+
+ /* Basic setup, Master clocking mode (GCM8..1) */
+ ret = pef2256_setup_gcm(pef2256);
+ if (ret)
+ return ret;
+
+ /* RCLK output : DPLL clock, DCO-X enabled, DCO-X internal ref clock */
+ pef2256_write8(pef2256, PEF2256_CMR1, 0x00);
+
+ /*
+ * SCLKR selected, SCLKX selected,
+ * receive synchro pulse sourced by SYPR,
+ * transmit synchro pulse sourced by SYPX
+ */
+ pef2256_write8(pef2256, PEF2256_CMR2, 0x00);
+
+ /* NRZ coding, no alarm simulation */
+ pef2256_write8(pef2256, PEF2256_FMR0, 0x00);
+
+ /*
+ * E1, frame format, 2 Mbit/s system data rate, no AIS
+ * transmission to remote end or system interface, payload loop
+ * off, transmit remote alarm on
+ */
+ fmr1 = 0x00;
+ fmr2 = PEF2256_FMR2_AXRA;
+ switch (pef2256->frame_type) {
+ case PEF2256_FRAME_E1_DOUBLEFRAME:
+ fmr2 |= PEF2256_FMR2_RFS_DOUBLEFRAME;
+ break;
+ case PEF2256_FRAME_E1_CRC4_MULTIFRAME:
+ fmr1 |= PEF2256_FMR1_XFS;
+ fmr2 |= PEF2256_FMR2_RFS_CRC4_MULTIFRAME;
+ break;
+ case PEF2256_FRAME_E1_AUTO_MULTIFRAME:
+ fmr1 |= PEF2256_FMR1_XFS;
+ fmr2 |= PEF2256_FMR2_RFS_AUTO_MULTIFRAME;
+ break;
+ default:
+ dev_err(pef2256->dev, "Unsupported frame type %d\n", pef2256->frame_type);
+ return -EINVAL;
+ }
+ pef2256_write8(pef2256, PEF2256_FMR1, fmr1);
+ pef2256_write8(pef2256, PEF2256_FMR2, fmr2);
+
+ /* E1 default for the receive slicer threshold */
+ pef2256_write8(pef2256, PEF2256_LIM2, PEF2256_LIM2_SLT_THR50);
+ if (!pef2256->is_subordinate) {
+ /* SEC input, active high */
+ pef2256_write8(pef2256, PEF2256_GPC1, PEF2256_GPC1_CSFP_SEC_IN_HIGH);
+ } else {
+ /* Loop-timed */
+ pef2256_setbits8(pef2256, PEF2256_LIM2, PEF2256_LIM2_ELT);
+ /* FSC output, active high */
+ pef2256_write8(pef2256, PEF2256_GPC1, PEF2256_GPC1_CSFP_FSC_OUT_HIGH);
+ }
+
+ /* internal second timer, power on */
+ pef2256_write8(pef2256, PEF2256_GCR, 0x00);
+
+ /*
+ * slave mode, local loop off, mode short-haul
+ * In v2.x, bit3 is a forced 1 bit in the datasheet -> Need to be set.
+ */
+ if (pef2256->version == PEF2256_VERSION_1_2)
+ pef2256_write8(pef2256, PEF2256_LIM0, 0x00);
+ else
+ pef2256_write8(pef2256, PEF2256_LIM0, PEF2256_2X_LIM0_BIT3);
+
+ /* analog interface selected, remote loop off */
+ pef2256_write8(pef2256, PEF2256_LIM1, 0x00);
+
+ /*
+ * SCLKR, SCLKX, RCLK configured to inputs,
+ * XFMS active low, CLK1 and CLK2 pin configuration
+ */
+ pef2256_write8(pef2256, PEF2256_PC5, 0x00);
+ pef2256_write8(pef2256, PEF2256_PC6, 0x00);
+
+ /*
+ * 2.048 MHz system clocking rate, receive buffer 2 frames, transmit
+ * buffer bypass, data sampled and transmitted on the falling edge of
+ * SCLKR/X, automatic freeze signaling, data is active in the first
+ * channel phase
+ */
+ pef2256_write8(pef2256, PEF2256_SIC1, 0x00);
+ pef2256_write8(pef2256, PEF2256_SIC2, 0x00);
+ pef2256_write8(pef2256, PEF2256_SIC3, 0x00);
+
+ /* channel loop-back and single frame mode are disabled */
+ pef2256_write8(pef2256, PEF2256_LOOP, 0x00);
+
+ /* all bits of the transmitted service word are cleared */
+ pef2256_write8(pef2256, PEF2256_XSW, PEF2256_XSW_XY(0x1F));
+ /* CAS disabled and clear spare bit values */
+ pef2256_write8(pef2256, PEF2256_XSP, 0x00);
+
+ /* no transparent mode active */
+ pef2256_write8(pef2256, PEF2256_TSWM, 0x00);
+
+ /*
+ * the transmit clock offset is cleared
+ * the transmit time slot offset is cleared
+ */
+ pef2256_write8(pef2256, PEF2256_XC0, 0x00);
+
+ /* Keep default value for the transmit offset */
+ pef2256_write8(pef2256, PEF2256_XC1, 0x9C);
+
+ /*
+ * transmit pulse mask, default value from datasheet
+ * transmitter in tristate mode
+ */
+ if (pef2256->version == PEF2256_VERSION_1_2)
+ pef2256_write8(pef2256, PEF2256_XPM0, 0x7B);
+ else
+ pef2256_write8(pef2256, PEF2256_XPM0, 0x9C);
+ pef2256_write8(pef2256, PEF2256_XPM1, 0x03);
+ pef2256_write8(pef2256, PEF2256_XPM2, PEF2256_XPM2_XLT | 0x00);
+
+ /* "master" mode */
+ if (!pef2256->is_subordinate)
+ pef2256_setbits8(pef2256, PEF2256_LIM0, PEF2256_LIM0_MAS);
+
+ /* transmit line in normal operation */
+ pef2256_clrbits8(pef2256, PEF2256_XPM2, PEF2256_XPM2_XLT);
+
+ /* receive input threshold = 0,21V */
+ if (pef2256->version == PEF2256_VERSION_1_2)
+ pef2256_clrsetbits8(pef2256, PEF2256_LIM1, PEF2256_12_LIM1_RIL_MASK,
+ PEF2256_12_LIM1_RIL_210);
+ else
+ pef2256_clrsetbits8(pef2256, PEF2256_LIM1, PEF2256_2X_LIM1_RIL_MASK,
+ PEF2256_2X_LIM1_RIL_210);
+
+ /* transmit line coding = HDB3 */
+ pef2256_clrsetbits8(pef2256, PEF2256_FMR0, PEF2256_FMR0_XC_MASK, PEF2256_FMR0_XC_HDB3);
+
+ /* receive line coding = HDB3 */
+ pef2256_clrsetbits8(pef2256, PEF2256_FMR0, PEF2256_FMR0_RC_MASK, PEF2256_FMR0_RC_HDB3);
+
+ /* detection of LOS alarm = 176 pulses (ie (10 + 1) * 16) */
+ pef2256_write8(pef2256, PEF2256_PCD, 10);
+
+ /* recovery of LOS alarm = 22 pulses (ie 21 + 1) */
+ pef2256_write8(pef2256, PEF2256_PCR, 21);
+
+ /* DCO-X center frequency enabled */
+ pef2256_setbits8(pef2256, PEF2256_CMR2, PEF2256_CMR2_DCOXC);
+
+ if (pef2256->is_subordinate) {
+ /* select RCLK source = 2M, disable switching from RCLK to SYNC */
+ pef2256_clrsetbits8(pef2256, PEF2256_CMR1, PEF2256_CMR1_RS_MASK,
+ PEF2256_CMR1_RS_DCOR_2048);
+ pef2256_setbits8(pef2256, PEF2256_CMR1, PEF2256_CMR1_DCS);
+
+ /* transmit buffer size = 2 frames, transparent mode */
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC1, PEF2256_SIC1_XBS_MASK,
+ PEF2256_SIC1_XBS_2FRAMES);
+ pef2256_setbits8(pef2256, PEF2256_XSW, PEF2256_XSW_XTM);
+ }
+
+ if (pef2256->version != PEF2256_VERSION_1_2) {
+ /* during inactive channel phase switch RDO/RSIG into tri-state */
+ pef2256_setbits8(pef2256, PEF2256_SIC3, PEF2256_SIC3_RTRI);
+ }
+
+ if (pef2256->is_tx_falling_edge) {
+ /* falling edge sync pulse transmit, rising edge sync pulse receive */
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC3, PEF2256_SIC3_RESX, PEF2256_SIC3_RESR);
+ } else {
+ /* rising edge sync pulse transmit, falling edge sync pulse receive */
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC3, PEF2256_SIC3_RESR, PEF2256_SIC3_RESX);
+ }
+
+ /* transmit offset counter (XCO10..0) = 4 */
+ pef2256_write8(pef2256, PEF2256_XC0, 0);
+ pef2256_write8(pef2256, PEF2256_XC1, 4);
+ /* receive offset counter (RCO10..0) = 4 */
+ pef2256_write8(pef2256, PEF2256_RC0, 0);
+ pef2256_write8(pef2256, PEF2256_RC1, 4);
+
+ /* system clock rate */
+ switch (pef2256->sysclk_rate) {
+ case 2048000:
+ sic1 = PEF2256_SIC1_SSC_2048;
+ break;
+ case 4096000:
+ sic1 = PEF2256_SIC1_SSC_4096;
+ break;
+ case 8192000:
+ sic1 = PEF2256_SIC1_SSC_8192;
+ break;
+ case 16384000:
+ sic1 = PEF2256_SIC1_SSC_16384;
+ break;
+ default:
+ dev_err(pef2256->dev, "Unsupported sysclk rate %lu\n", pef2256->sysclk_rate);
+ return -EINVAL;
+ }
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC1, PEF2256_SIC1_SSC_MASK, sic1);
+
+ /* data clock rate */
+ switch (pef2256->data_rate) {
+ case 2048000:
+ fmr1 = PEF2256_FMR1_SSD_2048;
+ sic1 = PEF2256_SIC1_SSD_2048;
+ break;
+ case 4096000:
+ fmr1 = PEF2256_FMR1_SSD_4096;
+ sic1 = PEF2256_SIC1_SSD_4096;
+ break;
+ case 8192000:
+ fmr1 = PEF2256_FMR1_SSD_8192;
+ sic1 = PEF2256_SIC1_SSD_8192;
+ break;
+ case 16384000:
+ fmr1 = PEF2256_FMR1_SSD_16384;
+ sic1 = PEF2256_SIC1_SSD_16384;
+ break;
+ default:
+ dev_err(pef2256->dev, "Unsupported data rate %u\n", pef2256->data_rate);
+ return -EINVAL;
+ }
+ pef2256_clrsetbits8(pef2256, PEF2256_FMR1, PEF2256_FMR1_SSD_MASK, fmr1);
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC1, PEF2256_SIC1_SSD_MASK, sic1);
+
+ /* channel phase */
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC2, PEF2256_SIC2_SICS_MASK,
+ PEF2256_SIC2_SICS(pef2256->channel_phase));
+
+ /* error counter latched every 1s */
+ pef2256_setbits8(pef2256, PEF2256_FMR1, PEF2256_FMR1_ECM);
+ /* error counter mode COFA */
+ pef2256_setbits8(pef2256, PEF2256_GCR, PEF2256_GCR_ECMC);
+ /* errors in service words have no influence */
+ pef2256_setbits8(pef2256, PEF2256_RC0, PEF2256_RC0_SWD);
+ /* 4 consecutive incorrect FAS causes loss of sync */
+ pef2256_setbits8(pef2256, PEF2256_RC0, PEF2256_RC0_ASY4);
+ /* Si-Bit, Spare bit For International, FAS word */
+ pef2256_setbits8(pef2256, PEF2256_XSW, PEF2256_XSW_XSIS);
+ pef2256_setbits8(pef2256, PEF2256_XSP, PEF2256_XSP_XSIF);
+
+ /* port RCLK is output */
+ pef2256_setbits8(pef2256, PEF2256_PC5, PEF2256_PC5_CRP);
+ /* status changed interrupt at both up and down */
+ pef2256_setbits8(pef2256, PEF2256_GCR, PEF2256_GCR_SCI);
+
+ /* Clear any ISR2 pending interrupts and unmask needed interrupts */
+ pef2256_read8(pef2256, PEF2256_ISR2);
+ pef2256_clrbits8(pef2256, PEF2256_IMR2, PEF2256_INT2_LOS | PEF2256_INT2_AIS);
+
+ /* reset lines */
+ pef2256_write8(pef2256, PEF2256_CMDR, PEF2256_CMDR_RRES | PEF2256_CMDR_XRES);
+ return 0;
+}
+
+static int pef2256_setup(struct pef2256 *pef2256)
+{
+ if (pef2256->is_e1)
+ return pef2256_setup_e1(pef2256);
+
+ dev_err(pef2256->dev, "Only E1 line is currently supported\n");
+ return -EOPNOTSUPP;
+}
+
+
+
+static void pef2256_isr_default_handler(struct pef2256 *pef2256, u8 nbr, u8 isr)
+{
+ dev_warn(pef2256->dev, "ISR%u: 0x%02x not handled\n", nbr, isr);
+}
+
+static bool pef2256_is_carrier_on(struct pef2256 *pef2256)
+{
+ u8 frs0;
+
+ frs0 = pef2256_read8(pef2256, PEF2256_FRS0);
+ return !(frs0 & (PEF2256_FRS0_LOS | PEF2256_FRS0_AIS));
+}
+
+static void pef2256_isr2_handler(struct pef2256 *pef2256, u8 nbr, u8 isr)
+{
+ bool carrier;
+
+ if (isr & (PEF2256_INT2_LOS | PEF2256_INT2_AIS)) {
+ carrier = pef2256_is_carrier_on(pef2256);
+ if (atomic_xchg(&pef2256->carrier, carrier) != carrier)
+ atomic_notifier_call_chain(&pef2256->event_notifier_list,
+ PEF2256_EVENT_CARRIER, NULL);
+ }
+}
+
+static irqreturn_t pef2256_irq_handler(int irq, void *priv)
+{
+ void (*pef2256_isr_handler[])(struct pef2256 *, u8, u8) = {
+ [0] = pef2256_isr_default_handler,
+ [1] = pef2256_isr_default_handler,
+ [2] = pef2256_isr2_handler,
+ [3] = pef2256_isr_default_handler,
+ [4] = pef2256_isr_default_handler,
+ [5] = pef2256_isr_default_handler
+ };
+ struct pef2256 *pef2256 = (struct pef2256 *)priv;
+ u8 gis;
+ u8 isr;
+ u8 n;
+
+ gis = pef2256_read8(pef2256, PEF2256_GIS);
+
+ for (n = 0; n < ARRAY_SIZE(pef2256_isr_handler) ; n++) {
+ if (gis & PEF2256_GIS_ISR(n)) {
+ isr = pef2256_read8(pef2256, PEF2256_ISR(n));
+ pef2256_isr_handler[n](pef2256, n, isr);
+ }
+ }
+
+ return IRQ_HANDLED;
+}
+
+static int pef2256_check_rates(struct pef2256 *pef2256, unsigned long sysclk_rate,
+ unsigned long data_rate)
+{
+ unsigned long rate;
+
+ switch (sysclk_rate) {
+ case 2048000:
+ case 4096000:
+ case 8192000:
+ case 16384000:
+ break;
+ default:
+ dev_err(pef2256->dev, "Unsupported system clock rate %lu\n", sysclk_rate);
+ return -EINVAL;
+ }
+
+ for (rate = data_rate; rate <= data_rate * 4; rate *= 2) {
+ if (rate == sysclk_rate)
+ return 0;
+ }
+ dev_err(pef2256->dev, "Unsupported data rate %lu with system clock rate %lu\n",
+ data_rate, sysclk_rate);
+ return -EINVAL;
+}
+
+static int pef2556_of_parse(struct pef2256 *pef2256, struct device_node *np)
+{
+ const char *str;
+ int ret;
+
+ str = "e1";
+ ret = of_property_read_string(np, "lantiq,line-interface", &str);
+ if (ret && ret != -EINVAL) {
+ dev_err(pef2256->dev, "%pOF: failed to read lantiq,line-interface\n",
+ np);
+ return ret;
+ }
+ if (!strcmp(str, "e1")) {
+ pef2256->is_e1 = true;
+ } else if (!strcmp(str, "t1j1")) {
+ pef2256->is_e1 = false;
+ } else {
+ dev_err(pef2256->dev, "%pOF: Invalid lantiq,line-interface (%s)\n",
+ np, str);
+ return -EINVAL;
+ }
+ dev_dbg(pef2256->dev, "config: %s line\n", pef2256->is_e1 ? "E1" : "T1/J1");
+
+ pef2256->data_rate = 2048000;
+ ret = of_property_read_u32(np, "lantiq,data-rate-bps", &pef2256->data_rate);
+ if (ret && ret != -EINVAL) {
+ dev_err(pef2256->dev, "%pOF: failed to read lantiq,data-rate-bps\n", np);
+ return ret;
+ }
+ dev_dbg(pef2256->dev, "config: data rate %u bps\n", pef2256->data_rate);
+
+ ret = pef2256_check_rates(pef2256, pef2256->sysclk_rate, pef2256->data_rate);
+ if (ret)
+ return ret;
+
+ pef2256->is_tx_falling_edge = of_property_read_bool(np, "lantiq,clock-falling-edge");
+ dev_dbg(pef2256->dev, "config: tx on %s edge\n",
+ pef2256->is_tx_falling_edge ? "falling" : "rising");
+
+ pef2256->is_subordinate = of_property_read_bool(np, "lantiq,subordinate");
+ dev_dbg(pef2256->dev, "config: subordinate %s\n",
+ pef2256->is_subordinate ? "on" : "off");
+
+ str = pef2256->is_e1 ? "doubleframe" : "12frame";
+ ret = of_property_read_string(np, "lantiq,frame-format", &str);
+ if (ret && ret != -EINVAL) {
+ dev_err(pef2256->dev, "%pOF: failed to read lantiq,frame-format\n",
+ np);
+ return ret;
+ }
+ if (pef2256->is_e1) {
+ if (!strcmp(str, "doubleframe")) {
+ pef2256->frame_type = PEF2256_FRAME_E1_DOUBLEFRAME;
+ } else if (!strcmp(str, "crc4-multiframe")) {
+ pef2256->frame_type = PEF2256_FRAME_E1_CRC4_MULTIFRAME;
+ } else if (!strcmp(str, "auto-multiframe")) {
+ pef2256->frame_type = PEF2256_FRAME_E1_AUTO_MULTIFRAME;
+ } else {
+ dev_err(pef2256->dev, "%pOF: Invalid lantiq,frame-format (%s)\n",
+ np, str);
+ return -EINVAL;
+ }
+ } else {
+ if (!strcmp(str, "4frame")) {
+ pef2256->frame_type = PEF2256_FRAME_T1J1_4FRAME;
+ } else if (!strcmp(str, "12frame")) {
+ pef2256->frame_type = PEF2256_FRAME_T1J1_12FRAME;
+ } else if (!strcmp(str, "24frame")) {
+ pef2256->frame_type = PEF2256_FRAME_T1J1_24FRAME;
+ } else if (!strcmp(str, "72frame")) {
+ pef2256->frame_type = PEF2256_FRAME_T1J1_72FRAME;
+ } else {
+ dev_err(pef2256->dev, "%pOF: Invalid lantiq,frame-format (%s)\n",
+ np, str);
+ return -EINVAL;
+ }
+ }
+ dev_dbg(pef2256->dev, "config: frame type %d\n", pef2256->frame_type);
+
+ pef2256->channel_phase = 0;
+ ret = of_property_read_u8(np, "lantiq,channel-phase", &pef2256->channel_phase);
+ if (ret && ret != -EINVAL) {
+ dev_err(pef2256->dev, "%pOF: failed to read lantiq,channel-phase\n",
+ np);
+ return ret;
+ }
+ if (pef2256->channel_phase >= pef2256->sysclk_rate / pef2256->data_rate) {
+ dev_err(pef2256->dev, "%pOF: Invalid lantiq,channel-phase %u\n",
+ np, pef2256->channel_phase);
+ return -EINVAL;
+ }
+ dev_dbg(pef2256->dev, "config: channel phase %u\n", pef2256->channel_phase);
+
+ return 0;
+}
+
+static int pef2256_get_groups_count(struct pinctrl_dev *pctldev)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ /* We map 1 group <-> 1 pin */
+ return pef2256->pinctrl.pctrl_desc.npins;
+}
+
+static const char *pef2256_get_group_name(struct pinctrl_dev *pctldev,
+ unsigned int selector)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ /* We map 1 group <-> 1 pin */
+ return pef2256->pinctrl.pctrl_desc.pins[selector].name;
+}
+
+static int pef2256_get_group_pins(struct pinctrl_dev *pctldev, unsigned int selector,
+ const unsigned int **pins,
+ unsigned int *num_pins)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ /* We map 1 group <-> 1 pin */
+ *pins = &pef2256->pinctrl.pctrl_desc.pins[selector].number;
+ *num_pins = 1;
+
+ return 0;
+}
+
+static const struct pinctrl_ops pef2256_pctlops = {
+ .get_groups_count = pef2256_get_groups_count,
+ .get_group_name = pef2256_get_group_name,
+ .get_group_pins = pef2256_get_group_pins,
+ .dt_node_to_map = pinconf_generic_dt_node_to_map_pin,
+ .dt_free_map = pinconf_generic_dt_free_map,
+};
+
+static int pef2256_get_functions_count(struct pinctrl_dev *pctldev)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ return pef2256->pinctrl.nfunctions;
+}
+
+static const char *pef2256_get_function_name(struct pinctrl_dev *pctldev,
+ unsigned int selector)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ return pef2256->pinctrl.functions[selector].name;
+}
+
+
+static int pef2256_get_function_groups(struct pinctrl_dev *pctldev, unsigned int selector,
+ const char * const **groups,
+ unsigned * const num_groups)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ *groups = pef2256->pinctrl.functions[selector].groups;
+ *num_groups = pef2256->pinctrl.functions[selector].ngroups;
+ return 0;
+}
+
+static int pef2256_set_mux(struct pinctrl_dev *pctldev, unsigned int func_selector,
+ unsigned int group_selector)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+ const struct pef2256_pinreg_desc *pinreg_desc;
+ u8 func_val;
+
+ dev_dbg(pef2256->dev, "set %s to %s function\n",
+ pef2256->pinctrl.pctrl_desc.pins[group_selector].name,
+ pef2256->pinctrl.functions[func_selector].name);
+
+ /* We map 1 group <-> 1 pin */
+ pinreg_desc = pef2256->pinctrl.pctrl_desc.pins[group_selector].drv_data;
+ func_val = pef2256->pinctrl.functions[func_selector].func_val;
+
+ pef2256_clrsetbits8(pef2256, pinreg_desc->offset, pinreg_desc->mask,
+ func_val & pinreg_desc->mask);
+
+ return 0;
+}
+
+static const struct pinmux_ops pef2256_pmxops = {
+ .get_functions_count = pef2256_get_functions_count,
+ .get_function_name = pef2256_get_function_name,
+ .get_function_groups = pef2256_get_function_groups,
+ .set_mux = pef2256_set_mux,
+};
+
+#define PEF2256_PINCTRL_PIN(_number, _name, _offset, _mask) { \
+ .number = _number, \
+ .name = _name, \
+ .drv_data = &(struct pef2256_pinreg_desc) { \
+ .offset = _offset, \
+ .mask = _mask, \
+ }, \
+}
+
+static const struct pinctrl_pin_desc pef2256_v12_pins[] = {
+ PEF2256_PINCTRL_PIN(0, "RPA", PEF2256_PC1, PEF2256_12_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(1, "RPB", PEF2256_PC2, PEF2256_12_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(2, "RPC", PEF2256_PC3, PEF2256_12_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(3, "RPD", PEF2256_PC4, PEF2256_12_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(4, "XPA", PEF2256_PC1, PEF2256_12_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(5, "XPB", PEF2256_PC2, PEF2256_12_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(6, "XPC", PEF2256_PC3, PEF2256_12_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(7, "XPD", PEF2256_PC4, PEF2256_12_PC_XPC_MASK),
+};
+
+static const struct pinctrl_pin_desc pef2256_v2x_pins[] = {
+ PEF2256_PINCTRL_PIN(0, "RPA", PEF2256_PC1, PEF2256_2X_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(1, "RPB", PEF2256_PC2, PEF2256_2X_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(2, "RPC", PEF2256_PC3, PEF2256_2X_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(3, "RPD", PEF2256_PC4, PEF2256_2X_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(4, "XPA", PEF2256_PC1, PEF2256_2X_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(5, "XPB", PEF2256_PC2, PEF2256_2X_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(6, "XPC", PEF2256_PC3, PEF2256_2X_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(7, "XPD", PEF2256_PC4, PEF2256_2X_PC_XPC_MASK),
+};
+
+static const char *const pef2256_rp_groups[] = { "RPA", "RPB", "RPC", "RPD" };
+static const char *const pef2256_xp_groups[] = { "XPA", "XPB", "XPC", "XPD" };
+static const char *const pef2256_all_groups[] = { "RPA", "RPB", "RPC", "RPD",
+ "XPA", "XPB", "XPC", "XPD" };
+
+#define PEF2256_FUNCTION(_name, _func_val, _groups) { \
+ .name = _name, \
+ .groups = _groups, \
+ .ngroups = ARRAY_SIZE(_groups), \
+ .func_val = _func_val, \
+}
+
+static const struct pef2256_function_desc pef2256_v2x_functions[] = {
+ PEF2256_FUNCTION("SYPR", PEF2256_2X_PC_RPC_SYPR, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFM", PEF2256_2X_PC_RPC_RFM, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFMB", PEF2256_2X_PC_RPC_RFMB, pef2256_rp_groups),
+ PEF2256_FUNCTION("RSIGM", PEF2256_2X_PC_RPC_RSIGM, pef2256_rp_groups),
+ PEF2256_FUNCTION("RSIG", PEF2256_2X_PC_RPC_RSIG, pef2256_rp_groups),
+ PEF2256_FUNCTION("DLR", PEF2256_2X_PC_RPC_DLR, pef2256_rp_groups),
+ PEF2256_FUNCTION("FREEZE", PEF2256_2X_PC_RPC_FREEZE, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFSP", PEF2256_2X_PC_RPC_RFSP, pef2256_rp_groups),
+ PEF2256_FUNCTION("LOS", PEF2256_2X_PC_RPC_LOS, pef2256_rp_groups),
+
+ PEF2256_FUNCTION("SYPX", PEF2256_2X_PC_XPC_SYPX, pef2256_xp_groups),
+ PEF2256_FUNCTION("XFMS", PEF2256_2X_PC_XPC_XFMS, pef2256_xp_groups),
+ PEF2256_FUNCTION("XSIG", PEF2256_2X_PC_XPC_XSIG, pef2256_xp_groups),
+ PEF2256_FUNCTION("TCLK", PEF2256_2X_PC_XPC_TCLK, pef2256_xp_groups),
+ PEF2256_FUNCTION("XMFB", PEF2256_2X_PC_XPC_XMFB, pef2256_xp_groups),
+ PEF2256_FUNCTION("XSIGM", PEF2256_2X_PC_XPC_XSIGM, pef2256_xp_groups),
+ PEF2256_FUNCTION("DLX", PEF2256_2X_PC_XPC_DLX, pef2256_xp_groups),
+ PEF2256_FUNCTION("XCLK", PEF2256_2X_PC_XPC_XCLK, pef2256_xp_groups),
+ PEF2256_FUNCTION("XLT", PEF2256_2X_PC_XPC_XLT, pef2256_xp_groups),
+
+ PEF2256_FUNCTION("GPI", PEF2256_2X_PC_RPC_GPI | PEF2256_2X_PC_XPC_GPI,
+ pef2256_all_groups),
+ PEF2256_FUNCTION("GPOH", PEF2256_2X_PC_RPC_GPOH | PEF2256_2X_PC_XPC_GPOH,
+ pef2256_all_groups),
+ PEF2256_FUNCTION("GPOL", PEF2256_2X_PC_RPC_GPOL | PEF2256_2X_PC_XPC_GPOL,
+ pef2256_all_groups),
+};
+
+static const struct pef2256_function_desc pef2256_v12_functions[] = {
+ PEF2256_FUNCTION("SYPR", PEF2256_12_PC_RPC_SYPR, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFM", PEF2256_12_PC_RPC_RFM, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFMB", PEF2256_12_PC_RPC_RFMB, pef2256_rp_groups),
+ PEF2256_FUNCTION("RSIGM", PEF2256_12_PC_RPC_RSIGM, pef2256_rp_groups),
+ PEF2256_FUNCTION("RSIG", PEF2256_12_PC_RPC_RSIG, pef2256_rp_groups),
+ PEF2256_FUNCTION("DLR", PEF2256_12_PC_RPC_DLR, pef2256_rp_groups),
+ PEF2256_FUNCTION("FREEZE", PEF2256_12_PC_RPC_FREEZE, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFSP", PEF2256_12_PC_RPC_RFSP, pef2256_rp_groups),
+
+ PEF2256_FUNCTION("SYPX", PEF2256_12_PC_XPC_SYPX, pef2256_xp_groups),
+ PEF2256_FUNCTION("XFMS", PEF2256_12_PC_XPC_XFMS, pef2256_xp_groups),
+ PEF2256_FUNCTION("XSIG", PEF2256_12_PC_XPC_XSIG, pef2256_xp_groups),
+ PEF2256_FUNCTION("TCLK", PEF2256_12_PC_XPC_TCLK, pef2256_xp_groups),
+ PEF2256_FUNCTION("XMFB", PEF2256_12_PC_XPC_XMFB, pef2256_xp_groups),
+ PEF2256_FUNCTION("XSIGM", PEF2256_12_PC_XPC_XSIGM, pef2256_xp_groups),
+ PEF2256_FUNCTION("DLX", PEF2256_12_PC_XPC_DLX, pef2256_xp_groups),
+ PEF2256_FUNCTION("XCLK", PEF2256_12_PC_XPC_XCLK, pef2256_xp_groups),
+ PEF2256_FUNCTION("XLT", PEF2256_12_PC_XPC_XLT, pef2256_xp_groups),
+};
+
+
+static int pef2256_register_pinctrl(struct pef2256 *pef2256)
+{
+ struct pinctrl_dev *pctrl;
+
+ pef2256->pinctrl.pctrl_desc.name = dev_name(pef2256->dev);
+ pef2256->pinctrl.pctrl_desc.owner = THIS_MODULE;
+ pef2256->pinctrl.pctrl_desc.pctlops = &pef2256_pctlops;
+ pef2256->pinctrl.pctrl_desc.pmxops = &pef2256_pmxops;
+ if (pef2256->version == PEF2256_VERSION_1_2) {
+ pef2256->pinctrl.pctrl_desc.pins = pef2256_v12_pins;
+ pef2256->pinctrl.pctrl_desc.npins = ARRAY_SIZE(pef2256_v12_pins);
+ pef2256->pinctrl.functions = pef2256_v12_functions;
+ pef2256->pinctrl.nfunctions = ARRAY_SIZE(pef2256_v12_functions);
+ } else {
+ pef2256->pinctrl.pctrl_desc.pins = pef2256_v2x_pins;
+ pef2256->pinctrl.pctrl_desc.npins = ARRAY_SIZE(pef2256_v2x_pins);
+ pef2256->pinctrl.functions = pef2256_v2x_functions;
+ pef2256->pinctrl.nfunctions = ARRAY_SIZE(pef2256_v2x_functions);
+ }
+
+ pctrl = devm_pinctrl_register(pef2256->dev, &pef2256->pinctrl.pctrl_desc, pef2256);
+ if (IS_ERR(pctrl)) {
+ dev_err(pef2256->dev, "pinctrl driver registration failed\n");
+ return PTR_ERR(pctrl);
+ }
+
+ return 0;
+}
+
+static void pef2256_reset_pinmux(struct pef2256 *pef2256)
+{
+ u8 val;
+ /*
+ * Reset values cannot be used.
+ * They define the SYPR/SYPX pin mux for all the RPx and XPx pins and
+ * Only one pin can be muxed to SYPR and one pin can be muxed to SYPX.
+ * Choose here an other reset value.
+ */
+ if (pef2256->version == PEF2256_VERSION_1_2)
+ val = PEF2256_12_PC_XPC_XCLK | PEF2256_12_PC_RPC_RFSP;
+ else
+ val = PEF2256_2X_PC_XPC_GPI | PEF2256_2X_PC_RPC_GPI;
+
+ pef2256_write8(pef2256, PEF2256_PC1, val);
+ pef2256_write8(pef2256, PEF2256_PC2, val);
+ pef2256_write8(pef2256, PEF2256_PC3, val);
+ pef2256_write8(pef2256, PEF2256_PC4, val);
+}
+
+static ssize_t subordinate_show(struct device *dev, struct device_attribute *attr,
+ char *buf)
+{
+ struct pef2256 *pef2256 = dev_get_drvdata(dev);
+
+ return sysfs_emit(buf, "%d\n", pef2256->is_subordinate);
+}
+
+static ssize_t subordinate_store(struct device *dev, struct device_attribute *attr,
+ const char *buf, size_t count)
+{
+ struct pef2256 *pef2256 = dev_get_drvdata(dev);
+ int ret;
+
+ if (strtobool(buf, &pef2256->is_subordinate) < 0)
+ return -EINVAL;
+
+ ret = pef2256_setup(pef2256);
+ if (ret)
+ return ret;
+
+ return count;
+}
+
+static DEVICE_ATTR_RW(subordinate);
+
+static const struct attribute_group pef2256_attribute_group = {
+ .attrs = (struct attribute *[]) {
+ &dev_attr_subordinate.attr,
+ NULL,
+ },
+};
+
+static int pef2256_probe(struct platform_device *pdev)
+{
+ struct device_node *np = pdev->dev.of_node;
+ unsigned long sclkr_rate, sclkx_rate;
+ struct pef2256 *pef2256;
+ int ret;
+ int irq;
+
+ pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
+ if (!pef2256)
+ return -ENOMEM;
+
+ pef2256->dev = &pdev->dev;
+ ATOMIC_INIT_NOTIFIER_HEAD(&pef2256->event_notifier_list);
+
+ pef2256->regs = devm_platform_ioremap_resource(pdev, 0);
+ if (IS_ERR(pef2256->regs))
+ return PTR_ERR(pef2256->regs);
+
+ pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
+ if (IS_ERR(pef2256->mclk))
+ return PTR_ERR(pef2256->mclk);
+ dev_dbg(pef2256->dev, "mclk %lu Hz\n", clk_get_rate(pef2256->mclk));
+
+ pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
+ if (IS_ERR(pef2256->sclkr))
+ return PTR_ERR(pef2256->sclkr);
+
+ pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
+ if (IS_ERR(pef2256->sclkx))
+ return PTR_ERR(pef2256->sclkx);
+
+ /*
+ * Both SCLKR (receive) and SCLKX (transmit) must have the same rate,
+ * stored as sysclk_rate.
+ * The exact value will be checked at pef2256_check_rates()
+ */
+ sclkr_rate = clk_get_rate(pef2256->sclkr);
+ sclkx_rate = clk_get_rate(pef2256->sclkx);
+ dev_dbg(pef2256->dev, "sclkr %lu Hz\n", sclkr_rate);
+ dev_dbg(pef2256->dev, "sclkx %lu Hz\n", sclkx_rate);
+ if (sclkr_rate != sclkx_rate) {
+ dev_err(pef2256->dev, "clk rate mismatch. sclkr %lu Hz, sclkx %lu Hz\n",
+ sclkr_rate, sclkx_rate);
+ return -EINVAL;
+ }
+ pef2256->sysclk_rate = sclkr_rate;
+
+ /* Reset the component. The MCLK clock must be active during reset */
+ pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
+ if (IS_ERR(pef2256->reset_gpio))
+ return PTR_ERR(pef2256->reset_gpio);
+ if (pef2256->reset_gpio) {
+ gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
+ udelay(10);
+ gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
+ udelay(10);
+ }
+
+ pef2256->version = pef2256_get_version(pef2256);
+ if (pef2256->version == PEF2256_VERSION_UNKNOWN)
+ return -ENODEV;
+
+ ret = pef2556_of_parse(pef2256, np);
+ if (ret)
+ return ret;
+
+ /* Disable interrupts */
+ pef2256_write8(pef2256, PEF2256_IMR0, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR1, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR2, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR3, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR4, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR5, 0xff);
+
+ /* Clear any pending interrupts */
+ pef2256_read8(pef2256, PEF2256_ISR0);
+ pef2256_read8(pef2256, PEF2256_ISR1);
+ pef2256_read8(pef2256, PEF2256_ISR2);
+ pef2256_read8(pef2256, PEF2256_ISR3);
+ pef2256_read8(pef2256, PEF2256_ISR4);
+ pef2256_read8(pef2256, PEF2256_ISR5);
+
+ irq = platform_get_irq(pdev, 0);
+ if (irq < 0)
+ return irq;
+ ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
+ if (ret < 0)
+ return ret;
+
+ pef2256_reset_pinmux(pef2256);
+ ret = pef2256_register_pinctrl(pef2256);
+ if (ret)
+ return ret;
+
+ /*
+ * We are going to reset the E1 lines during setup() call and the ISR2
+ * interrupt used to detect the carrier state changed is masked.
+ * It is time to initialize our internal carrier state flag.
+ */
+ atomic_set(&pef2256->carrier, 0);
+
+ ret = pef2256_setup(pef2256);
+ if (ret)
+ return ret;
+
+ platform_set_drvdata(pdev, pef2256);
+
+ ret = sysfs_create_group(&pef2256->dev->kobj, &pef2256_attribute_group);
+ if (ret < 0) {
+ dev_err(pef2256->dev, "sysfs registration failed (%d)\n", ret);
+ platform_set_drvdata(pdev, NULL);
+ return ret;
+ }
+
+ ret = devm_of_platform_populate(pef2256->dev);
+ if (ret < 0) {
+ dev_err(pef2256->dev, "platform populate failed (%d)\n", ret);
+ platform_set_drvdata(pdev, NULL);
+ return ret;
+ }
+
+ return 0;
+}
+
+static int pef2256_remove(struct platform_device *pdev)
+{
+ struct pef2256 *pef2256 = platform_get_drvdata(pdev);
+
+ /* Disable interrupts */
+ pef2256_write8(pef2256, PEF2256_IMR0, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR1, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR2, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR3, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR4, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR5, 0xff);
+
+ sysfs_remove_group(&pef2256->dev->kobj, &pef2256_attribute_group);
+
+ return 0;
+}
+
+static const struct of_device_id pef2256_id_table[] = {
+ { .compatible = "lantiq,pef2256" },
+ {} /* sentinel */
+};
+MODULE_DEVICE_TABLE(of, pef2256_id_table);
+
+static struct platform_driver pef2256_driver = {
+ .driver = {
+ .name = "lantiq-pef2256",
+ .of_match_table = pef2256_id_table,
+ },
+ .probe = pef2256_probe,
+ .remove = pef2256_remove,
+};
+module_platform_driver(pef2256_driver);
+
+int pef2256_register_event_notifier(struct pef2256 *pef2256, struct notifier_block *nb)
+{
+ return atomic_notifier_chain_register(&pef2256->event_notifier_list, nb);
+}
+EXPORT_SYMBOL_GPL(pef2256_register_event_notifier);
+
+int pef2256_unregister_event_notifier(struct pef2256 *pef2256, struct notifier_block *nb)
+{
+ return atomic_notifier_chain_unregister(&pef2256->event_notifier_list, nb);
+}
+EXPORT_SYMBOL_GPL(pef2256_unregister_event_notifier);
+
+bool pef2256_get_carrier(struct pef2256 *pef2256)
+{
+ return !!atomic_read(&pef2256->carrier);
+}
+EXPORT_SYMBOL_GPL(pef2256_get_carrier);
+
+MODULE_AUTHOR("Herve Codina <herve.codina@bootlin.com>");
+MODULE_DESCRIPTION("PEF2256 driver");
+MODULE_LICENSE("GPL");
diff --git a/include/linux/mfd/pef2256.h b/include/linux/mfd/pef2256.h
new file mode 100644
index 000000000000..0c0afcefa3ef
--- /dev/null
+++ b/include/linux/mfd/pef2256.h
@@ -0,0 +1,28 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+/*
+ * PEF2256 management
+ *
+ * Copyright 2023 CS GROUP France
+ *
+ * Author: Herve Codina <herve.codina@bootlin.com>
+ */
+#ifndef __PEF2256_H__
+#define __PEF2256_H__
+
+#include <linux/types.h>
+
+struct pef2256;
+struct notifier_block;
+
+enum pef2256_event {
+ PEF2256_EVENT_CARRIER, /* Carrier state changed */
+};
+
+/* The nb.notifier_call function registered must not sleep */
+int pef2256_register_event_notifier(struct pef2256 *pef2256, struct notifier_block *nb);
+int pef2256_unregister_event_notifier(struct pef2256 *pef2256, struct notifier_block *nb);
+
+/* Retrieve carrier state. true: carrier on, false: carrier off */
+bool pef2256_get_carrier(struct pef2256 *pef2256);
+
+#endif /* __PEF2256_H__ */
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-28 9:26 ` [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer Herve Codina
@ 2023-03-30 16:05 ` Lee Jones
0 siblings, 0 replies; 45+ messages in thread
From: Lee Jones @ 2023-03-30 16:05 UTC (permalink / raw)
To: Herve Codina
Cc: Rob Herring, Krzysztof Kozlowski, Liam Girdwood, Mark Brown,
Takashi Iwai, linux-kernel, devicetree, alsa-devel,
Christophe Leroy, Thomas Petazzoni
On Tue, 28 Mar 2023, 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.
My goodness!
It's been a long time since I've seen anything quite like this.
My suggestion to you:
* Split this up into components that fit functional subsystems
* Run checkpatch.pl
* Remove all of the debug prints
* Move all of the defines out to a header file
* Be more verbose in your documentation / comments
* Consider using simple-mfd to probe child devices.
> Signed-off-by: Herve Codina <herve.codina@bootlin.com>
> ---
> drivers/mfd/Kconfig | 17 +
> drivers/mfd/Makefile | 1 +
> drivers/mfd/pef2256.c | 1355 +++++++++++++++++++++++++++++++++++
> include/linux/mfd/pef2256.h | 28 +
> 4 files changed, 1401 insertions(+)
> create mode 100644 drivers/mfd/pef2256.c
> create mode 100644 include/linux/mfd/pef2256.h
--
Lee Jones [李琼斯]
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
@ 2023-03-30 16:05 ` Lee Jones
0 siblings, 0 replies; 45+ messages in thread
From: Lee Jones @ 2023-03-30 16:05 UTC (permalink / raw)
To: Herve Codina
Cc: Rob Herring, Krzysztof Kozlowski, Liam Girdwood, Mark Brown,
Jaroslav Kysela, Takashi Iwai, linux-kernel, devicetree,
alsa-devel, Christophe Leroy, Thomas Petazzoni
On Tue, 28 Mar 2023, 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.
My goodness!
It's been a long time since I've seen anything quite like this.
My suggestion to you:
* Split this up into components that fit functional subsystems
* Run checkpatch.pl
* Remove all of the debug prints
* Move all of the defines out to a header file
* Be more verbose in your documentation / comments
* Consider using simple-mfd to probe child devices.
> Signed-off-by: Herve Codina <herve.codina@bootlin.com>
> ---
> drivers/mfd/Kconfig | 17 +
> drivers/mfd/Makefile | 1 +
> drivers/mfd/pef2256.c | 1355 +++++++++++++++++++++++++++++++++++
> include/linux/mfd/pef2256.h | 28 +
> 4 files changed, 1401 insertions(+)
> create mode 100644 drivers/mfd/pef2256.c
> create mode 100644 include/linux/mfd/pef2256.h
--
Lee Jones [李琼斯]
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-30 16:05 ` Lee Jones
(?)
@ 2023-03-31 7:42 ` Herve Codina
2023-03-31 9:13 ` Krzysztof Kozlowski
-1 siblings, 1 reply; 45+ messages in thread
From: Herve Codina @ 2023-03-31 7:42 UTC (permalink / raw)
To: Lee Jones
Cc: Rob Herring, Krzysztof Kozlowski, Liam Girdwood, Mark Brown,
Jaroslav Kysela, Takashi Iwai, linux-kernel, devicetree,
alsa-devel, Christophe Leroy, Thomas Petazzoni
Hi Lee,
On Thu, 30 Mar 2023 17:05:10 +0100
Lee Jones <lee@kernel.org> wrote:
> On Tue, 28 Mar 2023, 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.
>
> My goodness!
>
> It's been a long time since I've seen anything quite like this.
Yes, old things but working on recent kernel.
>
> My suggestion to you:
>
> * Split this up into components that fit functional subsystems
It is done. The audio part is present in ASoC subsystem (path 5 in this
series). pinctrl function is implemented in this driver and, as I don't
want to share registers, I would prefer to keep this function inside this
driver.
Also, I sent a RFC related to HDLC and PHY. In this RFC, the pef2256 is
considered as a PHY and handled in the PHY subsystem.
https://lore.kernel.org/linux-kernel/20230323103154.264546-1-herve.codina@bootlin.com/
> * Run checkpatch.pl
I did.
> * Remove all of the debug prints
I can do that in the next iteration if really needed.
> * Move all of the defines out to a header file
These defines are related to registers. As I don't want to share these
registers, is it really necessary to use a header file for them ?
> * Be more verbose in your documentation / comments
I can improve the API documentation present in include/mfd/pef2256.h.
Do you thing that is necessary ? Only a few devices will use this API.
> * Consider using simple-mfd to probe child devices.
I did.
The driver has (and needs to have) a compatible string.
Having this compatible string, sub-nodes are not automatically populated
in the device tree. In order to have them populated and probed, the pef2256
probe function ends calling devm_of_platform_populate().
Best regards,
Hervé
>
> > Signed-off-by: Herve Codina <herve.codina@bootlin.com>
> > ---
> > drivers/mfd/Kconfig | 17 +
> > drivers/mfd/Makefile | 1 +
> > drivers/mfd/pef2256.c | 1355 +++++++++++++++++++++++++++++++++++
> > include/linux/mfd/pef2256.h | 28 +
> > 4 files changed, 1401 insertions(+)
> > create mode 100644 drivers/mfd/pef2256.c
> > create mode 100644 include/linux/mfd/pef2256.h
>
> --
> Lee Jones [李琼斯]
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-31 7:42 ` Herve Codina
@ 2023-03-31 9:13 ` Krzysztof Kozlowski
0 siblings, 0 replies; 45+ messages in thread
From: Krzysztof Kozlowski @ 2023-03-31 9:13 UTC (permalink / raw)
To: Herve Codina, Lee Jones
Cc: Rob Herring, Krzysztof Kozlowski, Liam Girdwood, Mark Brown,
Takashi Iwai, linux-kernel, devicetree, alsa-devel,
Christophe Leroy, Thomas Petazzoni
On 31/03/2023 09:42, Herve Codina wrote:
> Hi Lee,
>
> On Thu, 30 Mar 2023 17:05:10 +0100
> Lee Jones <lee@kernel.org> wrote:
>
>> On Tue, 28 Mar 2023, 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.
>>
>> My goodness!
>>
>> It's been a long time since I've seen anything quite like this.
>
> Yes, old things but working on recent kernel.
>
>>
>> My suggestion to you:
>>
>> * Split this up into components that fit functional subsystems
>
> It is done. The audio part is present in ASoC subsystem (path 5 in this
> series). pinctrl function is implemented in this driver and, as I don't
> want to share registers, I would prefer to keep this function inside this
> driver.
The amount of defines and huge functions like pef2256_setup_e1()
contradict it.
Even the pef2256_setup_e1() really does not follow Linux coding style -
you know the size requirement, right?
pef2256_get_groups_count, struct pinmux_ops and others - this is
pinctrl, not MFD! They cannot be in MFD driver.
>
> Also, I sent a RFC related to HDLC and PHY. In this RFC, the pef2256 is
> considered as a PHY and handled in the PHY subsystem.
> https://lore.kernel.org/linux-kernel/20230323103154.264546-1-herve.codina@bootlin.com/
>
>> * Run checkpatch.pl
>
> I did.
There are tons of weird indentation,e.g.:
+#define PEF2256_2X_PC_XPC_XLT (0x8 << 0)
^^^^ there is only one space after #define
... and other style issues:
CHECK: Please don't use multiple blank lines
CHECK: spaces preferred around that '+' (ctx:VxV)
CHECK: Alignment should match open parenthesis
CHECK: Macro argument reuse '_groups' - possible side-effects?
CHECK: usleep_range is preferred over udelay; see
Documentation/timers/timers-howto.rst
CHECK: spaces preferred around that '/' (ctx:VxV)
>
>> * Remove all of the debug prints
>
> I can do that in the next iteration if really needed.
>
>> * Move all of the defines out to a header file
>
> These defines are related to registers. As I don't want to share these
> registers, is it really necessary to use a header file for them ?
>
>> * Be more verbose in your documentation / comments
>
> I can improve the API documentation present in include/mfd/pef2256.h.
> Do you thing that is necessary ? Only a few devices will use this API.
>
Krzysztof
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
@ 2023-03-31 9:13 ` Krzysztof Kozlowski
0 siblings, 0 replies; 45+ messages in thread
From: Krzysztof Kozlowski @ 2023-03-31 9:13 UTC (permalink / raw)
To: Herve Codina, Lee Jones
Cc: Rob Herring, Krzysztof Kozlowski, Liam Girdwood, Mark Brown,
Jaroslav Kysela, Takashi Iwai, linux-kernel, devicetree,
alsa-devel, Christophe Leroy, Thomas Petazzoni
On 31/03/2023 09:42, Herve Codina wrote:
> Hi Lee,
>
> On Thu, 30 Mar 2023 17:05:10 +0100
> Lee Jones <lee@kernel.org> wrote:
>
>> On Tue, 28 Mar 2023, 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.
>>
>> My goodness!
>>
>> It's been a long time since I've seen anything quite like this.
>
> Yes, old things but working on recent kernel.
>
>>
>> My suggestion to you:
>>
>> * Split this up into components that fit functional subsystems
>
> It is done. The audio part is present in ASoC subsystem (path 5 in this
> series). pinctrl function is implemented in this driver and, as I don't
> want to share registers, I would prefer to keep this function inside this
> driver.
The amount of defines and huge functions like pef2256_setup_e1()
contradict it.
Even the pef2256_setup_e1() really does not follow Linux coding style -
you know the size requirement, right?
pef2256_get_groups_count, struct pinmux_ops and others - this is
pinctrl, not MFD! They cannot be in MFD driver.
>
> Also, I sent a RFC related to HDLC and PHY. In this RFC, the pef2256 is
> considered as a PHY and handled in the PHY subsystem.
> https://lore.kernel.org/linux-kernel/20230323103154.264546-1-herve.codina@bootlin.com/
>
>> * Run checkpatch.pl
>
> I did.
There are tons of weird indentation,e.g.:
+#define PEF2256_2X_PC_XPC_XLT (0x8 << 0)
^^^^ there is only one space after #define
... and other style issues:
CHECK: Please don't use multiple blank lines
CHECK: spaces preferred around that '+' (ctx:VxV)
CHECK: Alignment should match open parenthesis
CHECK: Macro argument reuse '_groups' - possible side-effects?
CHECK: usleep_range is preferred over udelay; see
Documentation/timers/timers-howto.rst
CHECK: spaces preferred around that '/' (ctx:VxV)
>
>> * Remove all of the debug prints
>
> I can do that in the next iteration if really needed.
>
>> * Move all of the defines out to a header file
>
> These defines are related to registers. As I don't want to share these
> registers, is it really necessary to use a header file for them ?
>
>> * Be more verbose in your documentation / comments
>
> I can improve the API documentation present in include/mfd/pef2256.h.
> Do you thing that is necessary ? Only a few devices will use this API.
>
Krzysztof
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-31 9:13 ` Krzysztof Kozlowski
(?)
@ 2023-03-31 12:11 ` Herve Codina via Alsa-devel
-1 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-03-31 12:11 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: Lee Jones, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Takashi Iwai, linux-kernel, devicetree, alsa-devel,
Christophe Leroy, Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 8399 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Cc: Lee Jones <lee@kernel.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Takashi Iwai <tiwai@suse.com>, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
Date: Fri, 31 Mar 2023 14:11:04 +0200
Message-ID: <20230331141104.42445da9@bootlin.com>
Hi Krzysztof, Lee
On Fri, 31 Mar 2023 11:13:30 +0200
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> On 31/03/2023 09:42, Herve Codina wrote:
> > Hi Lee,
> >
> > On Thu, 30 Mar 2023 17:05:10 +0100
> > Lee Jones <lee@kernel.org> wrote:
> >
> >> On Tue, 28 Mar 2023, 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.
> >>
> >> My goodness!
> >>
> >> It's been a long time since I've seen anything quite like this.
> >
> > Yes, old things but working on recent kernel.
> >
> >>
> >> My suggestion to you:
> >>
> >> * Split this up into components that fit functional subsystems
> >
> > It is done. The audio part is present in ASoC subsystem (path 5 in this
> > series). pinctrl function is implemented in this driver and, as I don't
> > want to share registers, I would prefer to keep this function inside this
> > driver.
>
> The amount of defines and huge functions like pef2256_setup_e1()
> contradict it.
>
> Even the pef2256_setup_e1() really does not follow Linux coding style -
> you know the size requirement, right?
I know that pef2256_setup_e1() is quite big and I will look at a way
to split it in a consistent way.
>
> pef2256_get_groups_count, struct pinmux_ops and others - this is
> pinctrl, not MFD! They cannot be in MFD driver.
Maybe the issue is that MFD was not a good choice.
The "function" provided are not independent of each other.
The "main" driver (pef2256.c) needs to do the setup and handle the interrupt.
The "function" provided are some glues in order to be used in some sub-systems
such as audio. Indeed, ASoC needs a codec DAI to be connected to a CPU DAI.
These "functions" need to be started (ie probe()) after the pef2256 setup was
done. So a start (probe()) order relationship is needed.
If a MFD driver needs independent children to handle independent functions,
the pef2256 does not fit well as a MFD driver.
I switched from misc to MFD just to handle child DT nodes instead of having
phandles. Using child DT nodes instead of phandles is really a good thing and
need to be kept.
The switch to MFD was probably not the best thing to do.
What do you think if I switched back the pef2256 "main" driver (pef2256.c) to
misc ?
>
> >
> > Also, I sent a RFC related to HDLC and PHY. In this RFC, the pef2256 is
> > considered as a PHY and handled in the PHY subsystem.
> > https://lore.kernel.org/linux-kernel/20230323103154.264546-1-herve.codina@bootlin.com/
> >
> >> * Run checkpatch.pl
> >
> > I did.
>
> There are tons of weird indentation,e.g.:
> +#define PEF2256_2X_PC_XPC_XLT (0x8 << 0)
> ^^^^ there is only one space after #define
I ran checkpatch.pl, not checkpatch.pl --strict.
The spaces related the #define can be seen on many other drivers.
#define FOO_REG_BAR 0x10
#define FOO_REG_BAR_BIT0 BIT(0)
#define FOO_REG_BAR_BIT4 BIT(4)
The first line is the register offset and the other lines (indented) are
the bits description related to this register.
>
> ... and other style issues:
>
> CHECK: Please don't use multiple blank lines
> CHECK: spaces preferred around that '+' (ctx:VxV)
> CHECK: Alignment should match open parenthesis
> CHECK: Macro argument reuse '_groups' - possible side-effects?
> CHECK: usleep_range is preferred over udelay; see
> Documentation/timers/timers-howto.rst
> CHECK: spaces preferred around that '/' (ctx:VxV)
I will have a look and fix them in the next iteration.
>
>
> >
> >> * Remove all of the debug prints
> >
> > I can do that in the next iteration if really needed.
> >
> >> * Move all of the defines out to a header file
> >
> > These defines are related to registers. As I don't want to share these
> > registers, is it really necessary to use a header file for them ?
> >
> >> * Be more verbose in your documentation / comments
> >
> > I can improve the API documentation present in include/mfd/pef2256.h.
> > Do you thing that is necessary ? Only a few devices will use this API.
> >
> Krzysztof
>
Best regards,
Hervé
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-31 9:13 ` Krzysztof Kozlowski
(?)
(?)
@ 2023-03-31 12:11 ` Herve Codina
2023-03-31 13:44 ` Krzysztof Kozlowski
-1 siblings, 1 reply; 45+ messages in thread
From: Herve Codina @ 2023-03-31 12:11 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: Lee Jones, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Jaroslav Kysela, Takashi Iwai, linux-kernel,
devicetree, alsa-devel, Christophe Leroy, Thomas Petazzoni
Hi Krzysztof, Lee
On Fri, 31 Mar 2023 11:13:30 +0200
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> On 31/03/2023 09:42, Herve Codina wrote:
> > Hi Lee,
> >
> > On Thu, 30 Mar 2023 17:05:10 +0100
> > Lee Jones <lee@kernel.org> wrote:
> >
> >> On Tue, 28 Mar 2023, 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.
> >>
> >> My goodness!
> >>
> >> It's been a long time since I've seen anything quite like this.
> >
> > Yes, old things but working on recent kernel.
> >
> >>
> >> My suggestion to you:
> >>
> >> * Split this up into components that fit functional subsystems
> >
> > It is done. The audio part is present in ASoC subsystem (path 5 in this
> > series). pinctrl function is implemented in this driver and, as I don't
> > want to share registers, I would prefer to keep this function inside this
> > driver.
>
> The amount of defines and huge functions like pef2256_setup_e1()
> contradict it.
>
> Even the pef2256_setup_e1() really does not follow Linux coding style -
> you know the size requirement, right?
I know that pef2256_setup_e1() is quite big and I will look at a way
to split it in a consistent way.
>
> pef2256_get_groups_count, struct pinmux_ops and others - this is
> pinctrl, not MFD! They cannot be in MFD driver.
Maybe the issue is that MFD was not a good choice.
The "function" provided are not independent of each other.
The "main" driver (pef2256.c) needs to do the setup and handle the interrupt.
The "function" provided are some glues in order to be used in some sub-systems
such as audio. Indeed, ASoC needs a codec DAI to be connected to a CPU DAI.
These "functions" need to be started (ie probe()) after the pef2256 setup was
done. So a start (probe()) order relationship is needed.
If a MFD driver needs independent children to handle independent functions,
the pef2256 does not fit well as a MFD driver.
I switched from misc to MFD just to handle child DT nodes instead of having
phandles. Using child DT nodes instead of phandles is really a good thing and
need to be kept.
The switch to MFD was probably not the best thing to do.
What do you think if I switched back the pef2256 "main" driver (pef2256.c) to
misc ?
>
> >
> > Also, I sent a RFC related to HDLC and PHY. In this RFC, the pef2256 is
> > considered as a PHY and handled in the PHY subsystem.
> > https://lore.kernel.org/linux-kernel/20230323103154.264546-1-herve.codina@bootlin.com/
> >
> >> * Run checkpatch.pl
> >
> > I did.
>
> There are tons of weird indentation,e.g.:
> +#define PEF2256_2X_PC_XPC_XLT (0x8 << 0)
> ^^^^ there is only one space after #define
I ran checkpatch.pl, not checkpatch.pl --strict.
The spaces related the #define can be seen on many other drivers.
#define FOO_REG_BAR 0x10
#define FOO_REG_BAR_BIT0 BIT(0)
#define FOO_REG_BAR_BIT4 BIT(4)
The first line is the register offset and the other lines (indented) are
the bits description related to this register.
>
> ... and other style issues:
>
> CHECK: Please don't use multiple blank lines
> CHECK: spaces preferred around that '+' (ctx:VxV)
> CHECK: Alignment should match open parenthesis
> CHECK: Macro argument reuse '_groups' - possible side-effects?
> CHECK: usleep_range is preferred over udelay; see
> Documentation/timers/timers-howto.rst
> CHECK: spaces preferred around that '/' (ctx:VxV)
I will have a look and fix them in the next iteration.
>
>
> >
> >> * Remove all of the debug prints
> >
> > I can do that in the next iteration if really needed.
> >
> >> * Move all of the defines out to a header file
> >
> > These defines are related to registers. As I don't want to share these
> > registers, is it really necessary to use a header file for them ?
> >
> >> * Be more verbose in your documentation / comments
> >
> > I can improve the API documentation present in include/mfd/pef2256.h.
> > Do you thing that is necessary ? Only a few devices will use this API.
> >
> Krzysztof
>
Best regards,
Hervé
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-31 12:11 ` Herve Codina
@ 2023-03-31 13:44 ` Krzysztof Kozlowski
0 siblings, 0 replies; 45+ messages in thread
From: Krzysztof Kozlowski @ 2023-03-31 13:44 UTC (permalink / raw)
To: Herve Codina
Cc: Lee Jones, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Takashi Iwai, linux-kernel, devicetree, alsa-devel,
Christophe Leroy, Thomas Petazzoni
On 31/03/2023 14:11, Herve Codina wrote:
> Hi Krzysztof, Lee
>
> On Fri, 31 Mar 2023 11:13:30 +0200
> Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
>
>> On 31/03/2023 09:42, Herve Codina wrote:
>>> Hi Lee,
>>>
>>> On Thu, 30 Mar 2023 17:05:10 +0100
>>> Lee Jones <lee@kernel.org> wrote:
>>>
>>>> On Tue, 28 Mar 2023, 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.
>>>>
>>>> My goodness!
>>>>
>>>> It's been a long time since I've seen anything quite like this.
>>>
>>> Yes, old things but working on recent kernel.
>>>
>>>>
>>>> My suggestion to you:
>>>>
>>>> * Split this up into components that fit functional subsystems
>>>
>>> It is done. The audio part is present in ASoC subsystem (path 5 in this
>>> series). pinctrl function is implemented in this driver and, as I don't
>>> want to share registers, I would prefer to keep this function inside this
>>> driver.
>>
>> The amount of defines and huge functions like pef2256_setup_e1()
>> contradict it.
>>
>> Even the pef2256_setup_e1() really does not follow Linux coding style -
>> you know the size requirement, right?
>
> I know that pef2256_setup_e1() is quite big and I will look at a way
> to split it in a consistent way.
>
>>
>> pef2256_get_groups_count, struct pinmux_ops and others - this is
>> pinctrl, not MFD! They cannot be in MFD driver.
>
> Maybe the issue is that MFD was not a good choice.
> The "function" provided are not independent of each other.
> The "main" driver (pef2256.c) needs to do the setup and handle the interrupt.
Just like all PMICs...
> The "function" provided are some glues in order to be used in some sub-systems
> such as audio. Indeed, ASoC needs a codec DAI to be connected to a CPU DAI.
Just like in all other cases...
> These "functions" need to be started (ie probe()) after the pef2256 setup was
> done. So a start (probe()) order relationship is needed.
Just like in all other cases, so I really do not see here anything special.
>
> If a MFD driver needs independent children to handle independent functions,
> the pef2256 does not fit well as a MFD driver.
Why? So far everything is exactly the same.
>
> I switched from misc to MFD just to handle child DT nodes instead of having
> phandles. Using child DT nodes instead of phandles is really a good thing and
> need to be kept.
Your DT bindings and nodes are not related to driver design. It does not
matter for Devicetree if you put it to misc or MFD.
It does not matter for driver whether you call it in Devicetree foo or bar.
> The switch to MFD was probably not the best thing to do.
Maybe, but your existing arguments are not really related...
>
> What do you think if I switched back the pef2256 "main" driver (pef2256.c) to
> misc ?
Why? What would it solve? You want to stuff pinctrl driver to misc, to
avoid Lee's review? No. Pinctrl goes to pinctrl. Not to misc. Not to MFD.
>
>
>>
>>>
>>> Also, I sent a RFC related to HDLC and PHY. In this RFC, the pef2256 is
>>> considered as a PHY and handled in the PHY subsystem.
>>> https://lore.kernel.org/linux-kernel/20230323103154.264546-1-herve.codina@bootlin.com/
>>>
>>>> * Run checkpatch.pl
>>>
>>> I did.
>>
>> There are tons of weird indentation,e.g.:
>> +#define PEF2256_2X_PC_XPC_XLT (0x8 << 0)
>> ^^^^ there is only one space after #define
>
> I ran checkpatch.pl, not checkpatch.pl --strict.
>
> The spaces related the #define can be seen on many other drivers.
>
> #define FOO_REG_BAR 0x10
> #define FOO_REG_BAR_BIT0 BIT(0)
> #define FOO_REG_BAR_BIT4 BIT(4)
>
> The first line is the register offset and the other lines (indented) are
> the bits description related to this register.
I don't think we have such convention in general and argument that some
drivers do it in some subsystems is never a good argument. If they also
misspell things or use Hungarian notation, shall we do the same?
Although maybe it is fine for Lee. I find it unreadable.
git grep '#define \+[A-Z]' | wc -l
73889
git grep '#define [A-Z]' | wc -l
3996054
In MFD there is only one driver doing this.
Most of other cases are net and gpu.
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
@ 2023-03-31 13:44 ` Krzysztof Kozlowski
0 siblings, 0 replies; 45+ messages in thread
From: Krzysztof Kozlowski @ 2023-03-31 13:44 UTC (permalink / raw)
To: Herve Codina
Cc: Lee Jones, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Jaroslav Kysela, Takashi Iwai, linux-kernel,
devicetree, alsa-devel, Christophe Leroy, Thomas Petazzoni
On 31/03/2023 14:11, Herve Codina wrote:
> Hi Krzysztof, Lee
>
> On Fri, 31 Mar 2023 11:13:30 +0200
> Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
>
>> On 31/03/2023 09:42, Herve Codina wrote:
>>> Hi Lee,
>>>
>>> On Thu, 30 Mar 2023 17:05:10 +0100
>>> Lee Jones <lee@kernel.org> wrote:
>>>
>>>> On Tue, 28 Mar 2023, 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.
>>>>
>>>> My goodness!
>>>>
>>>> It's been a long time since I've seen anything quite like this.
>>>
>>> Yes, old things but working on recent kernel.
>>>
>>>>
>>>> My suggestion to you:
>>>>
>>>> * Split this up into components that fit functional subsystems
>>>
>>> It is done. The audio part is present in ASoC subsystem (path 5 in this
>>> series). pinctrl function is implemented in this driver and, as I don't
>>> want to share registers, I would prefer to keep this function inside this
>>> driver.
>>
>> The amount of defines and huge functions like pef2256_setup_e1()
>> contradict it.
>>
>> Even the pef2256_setup_e1() really does not follow Linux coding style -
>> you know the size requirement, right?
>
> I know that pef2256_setup_e1() is quite big and I will look at a way
> to split it in a consistent way.
>
>>
>> pef2256_get_groups_count, struct pinmux_ops and others - this is
>> pinctrl, not MFD! They cannot be in MFD driver.
>
> Maybe the issue is that MFD was not a good choice.
> The "function" provided are not independent of each other.
> The "main" driver (pef2256.c) needs to do the setup and handle the interrupt.
Just like all PMICs...
> The "function" provided are some glues in order to be used in some sub-systems
> such as audio. Indeed, ASoC needs a codec DAI to be connected to a CPU DAI.
Just like in all other cases...
> These "functions" need to be started (ie probe()) after the pef2256 setup was
> done. So a start (probe()) order relationship is needed.
Just like in all other cases, so I really do not see here anything special.
>
> If a MFD driver needs independent children to handle independent functions,
> the pef2256 does not fit well as a MFD driver.
Why? So far everything is exactly the same.
>
> I switched from misc to MFD just to handle child DT nodes instead of having
> phandles. Using child DT nodes instead of phandles is really a good thing and
> need to be kept.
Your DT bindings and nodes are not related to driver design. It does not
matter for Devicetree if you put it to misc or MFD.
It does not matter for driver whether you call it in Devicetree foo or bar.
> The switch to MFD was probably not the best thing to do.
Maybe, but your existing arguments are not really related...
>
> What do you think if I switched back the pef2256 "main" driver (pef2256.c) to
> misc ?
Why? What would it solve? You want to stuff pinctrl driver to misc, to
avoid Lee's review? No. Pinctrl goes to pinctrl. Not to misc. Not to MFD.
>
>
>>
>>>
>>> Also, I sent a RFC related to HDLC and PHY. In this RFC, the pef2256 is
>>> considered as a PHY and handled in the PHY subsystem.
>>> https://lore.kernel.org/linux-kernel/20230323103154.264546-1-herve.codina@bootlin.com/
>>>
>>>> * Run checkpatch.pl
>>>
>>> I did.
>>
>> There are tons of weird indentation,e.g.:
>> +#define PEF2256_2X_PC_XPC_XLT (0x8 << 0)
>> ^^^^ there is only one space after #define
>
> I ran checkpatch.pl, not checkpatch.pl --strict.
>
> The spaces related the #define can be seen on many other drivers.
>
> #define FOO_REG_BAR 0x10
> #define FOO_REG_BAR_BIT0 BIT(0)
> #define FOO_REG_BAR_BIT4 BIT(4)
>
> The first line is the register offset and the other lines (indented) are
> the bits description related to this register.
I don't think we have such convention in general and argument that some
drivers do it in some subsystems is never a good argument. If they also
misspell things or use Hungarian notation, shall we do the same?
Although maybe it is fine for Lee. I find it unreadable.
git grep '#define \+[A-Z]' | wc -l
73889
git grep '#define [A-Z]' | wc -l
3996054
In MFD there is only one driver doing this.
Most of other cases are net and gpu.
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-31 13:44 ` Krzysztof Kozlowski
(?)
@ 2023-03-31 14:59 ` Herve Codina via Alsa-devel
-1 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-03-31 14:59 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: Lee Jones, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Takashi Iwai, linux-kernel, devicetree, alsa-devel,
Christophe Leroy, Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 9871 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Cc: Lee Jones <lee@kernel.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Takashi Iwai <tiwai@suse.com>, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
Date: Fri, 31 Mar 2023 16:59:04 +0200
Message-ID: <20230331165904.4e7f46a1@bootlin.com>
On Fri, 31 Mar 2023 15:44:19 +0200
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> On 31/03/2023 14:11, Herve Codina wrote:
> > Hi Krzysztof, Lee
> >
> > On Fri, 31 Mar 2023 11:13:30 +0200
> > Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> >
> >> On 31/03/2023 09:42, Herve Codina wrote:
> >>> Hi Lee,
> >>>
> >>> On Thu, 30 Mar 2023 17:05:10 +0100
> >>> Lee Jones <lee@kernel.org> wrote:
> >>>
> >>>> On Tue, 28 Mar 2023, 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.
> >>>>
> >>>> My goodness!
> >>>>
> >>>> It's been a long time since I've seen anything quite like this.
> >>>
> >>> Yes, old things but working on recent kernel.
> >>>
> >>>>
> >>>> My suggestion to you:
> >>>>
> >>>> * Split this up into components that fit functional subsystems
> >>>
> >>> It is done. The audio part is present in ASoC subsystem (path 5 in this
> >>> series). pinctrl function is implemented in this driver and, as I don't
> >>> want to share registers, I would prefer to keep this function inside this
> >>> driver.
> >>
> >> The amount of defines and huge functions like pef2256_setup_e1()
> >> contradict it.
> >>
> >> Even the pef2256_setup_e1() really does not follow Linux coding style -
> >> you know the size requirement, right?
> >
> > I know that pef2256_setup_e1() is quite big and I will look at a way
> > to split it in a consistent way.
> >
> >>
> >> pef2256_get_groups_count, struct pinmux_ops and others - this is
> >> pinctrl, not MFD! They cannot be in MFD driver.
> >
> > Maybe the issue is that MFD was not a good choice.
> > The "function" provided are not independent of each other.
> > The "main" driver (pef2256.c) needs to do the setup and handle the interrupt.
>
> Just like all PMICs...
>
> > The "function" provided are some glues in order to be used in some sub-systems
> > such as audio. Indeed, ASoC needs a codec DAI to be connected to a CPU DAI.
>
> Just like in all other cases...
>
> > These "functions" need to be started (ie probe()) after the pef2256 setup was
> > done. So a start (probe()) order relationship is needed.
>
> Just like in all other cases, so I really do not see here anything special.
>
> >
> > If a MFD driver needs independent children to handle independent functions,
> > the pef2256 does not fit well as a MFD driver.
>
> Why? So far everything is exactly the same.
>
> >
> > I switched from misc to MFD just to handle child DT nodes instead of having
> > phandles. Using child DT nodes instead of phandles is really a good thing and
> > need to be kept.
>
> Your DT bindings and nodes are not related to driver design. It does not
> matter for Devicetree if you put it to misc or MFD.
>
> It does not matter for driver whether you call it in Devicetree foo or bar.
>
> > The switch to MFD was probably not the best thing to do.
>
> Maybe, but your existing arguments are not really related...
>
> >
> > What do you think if I switched back the pef2256 "main" driver (pef2256.c) to
> > misc ?
>
> Why? What would it solve? You want to stuff pinctrl driver to misc, to
> avoid Lee's review? No. Pinctrl goes to pinctrl. Not to misc. Not to MFD.
Just to be clear on that point, I do not want to avoid any reviews and Lee's
reviews are fully welcome.
I just misunderstood. I thought the issue was that the pef2256 MFD driver has an
internal setup() and that the 'function' provided were not independent (they share
the pef2256 API).
My first feeling was that it was expected a kind of 'empty' driver for the pef2256
MFD driver. The pef2256 driver cannot be empty. That's why I talk about misc.
Related to pinctrl, the probe() orders need to be controlled but that would not be
an issue if I move the pinctrl part to pinctrl. I would like also to avoid
exporting all registers. Only the pinctrl part needs to access registers and
it needs to access a few of them.
Is there a way to restrict the registers available from a child ?
Best regards,
Hervé
>
> >
> >
> >>
> >>>
> >>> Also, I sent a RFC related to HDLC and PHY. In this RFC, the pef2256 is
> >>> considered as a PHY and handled in the PHY subsystem.
> >>> https://lore.kernel.org/linux-kernel/20230323103154.264546-1-herve.codina@bootlin.com/
> >>>
> >>>> * Run checkpatch.pl
> >>>
> >>> I did.
> >>
> >> There are tons of weird indentation,e.g.:
> >> +#define PEF2256_2X_PC_XPC_XLT (0x8 << 0)
> >> ^^^^ there is only one space after #define
> >
> > I ran checkpatch.pl, not checkpatch.pl --strict.
> >
> > The spaces related the #define can be seen on many other drivers.
> >
> > #define FOO_REG_BAR 0x10
> > #define FOO_REG_BAR_BIT0 BIT(0)
> > #define FOO_REG_BAR_BIT4 BIT(4)
> >
> > The first line is the register offset and the other lines (indented) are
> > the bits description related to this register.
>
> I don't think we have such convention in general and argument that some
> drivers do it in some subsystems is never a good argument. If they also
> misspell things or use Hungarian notation, shall we do the same?
>
> Although maybe it is fine for Lee. I find it unreadable.
>
> git grep '#define \+[A-Z]' | wc -l
> 73889
> git grep '#define [A-Z]' | wc -l
> 3996054
>
> In MFD there is only one driver doing this.
>
> Most of other cases are net and gpu.
>
>
> Best regards,
> Krzysztof
>
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-31 13:44 ` Krzysztof Kozlowski
(?)
(?)
@ 2023-03-31 14:59 ` Herve Codina
2023-04-03 14:28 ` Lee Jones
-1 siblings, 1 reply; 45+ messages in thread
From: Herve Codina @ 2023-03-31 14:59 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: Lee Jones, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Jaroslav Kysela, Takashi Iwai, linux-kernel,
devicetree, alsa-devel, Christophe Leroy, Thomas Petazzoni
On Fri, 31 Mar 2023 15:44:19 +0200
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> On 31/03/2023 14:11, Herve Codina wrote:
> > Hi Krzysztof, Lee
> >
> > On Fri, 31 Mar 2023 11:13:30 +0200
> > Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> >
> >> On 31/03/2023 09:42, Herve Codina wrote:
> >>> Hi Lee,
> >>>
> >>> On Thu, 30 Mar 2023 17:05:10 +0100
> >>> Lee Jones <lee@kernel.org> wrote:
> >>>
> >>>> On Tue, 28 Mar 2023, 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.
> >>>>
> >>>> My goodness!
> >>>>
> >>>> It's been a long time since I've seen anything quite like this.
> >>>
> >>> Yes, old things but working on recent kernel.
> >>>
> >>>>
> >>>> My suggestion to you:
> >>>>
> >>>> * Split this up into components that fit functional subsystems
> >>>
> >>> It is done. The audio part is present in ASoC subsystem (path 5 in this
> >>> series). pinctrl function is implemented in this driver and, as I don't
> >>> want to share registers, I would prefer to keep this function inside this
> >>> driver.
> >>
> >> The amount of defines and huge functions like pef2256_setup_e1()
> >> contradict it.
> >>
> >> Even the pef2256_setup_e1() really does not follow Linux coding style -
> >> you know the size requirement, right?
> >
> > I know that pef2256_setup_e1() is quite big and I will look at a way
> > to split it in a consistent way.
> >
> >>
> >> pef2256_get_groups_count, struct pinmux_ops and others - this is
> >> pinctrl, not MFD! They cannot be in MFD driver.
> >
> > Maybe the issue is that MFD was not a good choice.
> > The "function" provided are not independent of each other.
> > The "main" driver (pef2256.c) needs to do the setup and handle the interrupt.
>
> Just like all PMICs...
>
> > The "function" provided are some glues in order to be used in some sub-systems
> > such as audio. Indeed, ASoC needs a codec DAI to be connected to a CPU DAI.
>
> Just like in all other cases...
>
> > These "functions" need to be started (ie probe()) after the pef2256 setup was
> > done. So a start (probe()) order relationship is needed.
>
> Just like in all other cases, so I really do not see here anything special.
>
> >
> > If a MFD driver needs independent children to handle independent functions,
> > the pef2256 does not fit well as a MFD driver.
>
> Why? So far everything is exactly the same.
>
> >
> > I switched from misc to MFD just to handle child DT nodes instead of having
> > phandles. Using child DT nodes instead of phandles is really a good thing and
> > need to be kept.
>
> Your DT bindings and nodes are not related to driver design. It does not
> matter for Devicetree if you put it to misc or MFD.
>
> It does not matter for driver whether you call it in Devicetree foo or bar.
>
> > The switch to MFD was probably not the best thing to do.
>
> Maybe, but your existing arguments are not really related...
>
> >
> > What do you think if I switched back the pef2256 "main" driver (pef2256.c) to
> > misc ?
>
> Why? What would it solve? You want to stuff pinctrl driver to misc, to
> avoid Lee's review? No. Pinctrl goes to pinctrl. Not to misc. Not to MFD.
Just to be clear on that point, I do not want to avoid any reviews and Lee's
reviews are fully welcome.
I just misunderstood. I thought the issue was that the pef2256 MFD driver has an
internal setup() and that the 'function' provided were not independent (they share
the pef2256 API).
My first feeling was that it was expected a kind of 'empty' driver for the pef2256
MFD driver. The pef2256 driver cannot be empty. That's why I talk about misc.
Related to pinctrl, the probe() orders need to be controlled but that would not be
an issue if I move the pinctrl part to pinctrl. I would like also to avoid
exporting all registers. Only the pinctrl part needs to access registers and
it needs to access a few of them.
Is there a way to restrict the registers available from a child ?
Best regards,
Hervé
>
> >
> >
> >>
> >>>
> >>> Also, I sent a RFC related to HDLC and PHY. In this RFC, the pef2256 is
> >>> considered as a PHY and handled in the PHY subsystem.
> >>> https://lore.kernel.org/linux-kernel/20230323103154.264546-1-herve.codina@bootlin.com/
> >>>
> >>>> * Run checkpatch.pl
> >>>
> >>> I did.
> >>
> >> There are tons of weird indentation,e.g.:
> >> +#define PEF2256_2X_PC_XPC_XLT (0x8 << 0)
> >> ^^^^ there is only one space after #define
> >
> > I ran checkpatch.pl, not checkpatch.pl --strict.
> >
> > The spaces related the #define can be seen on many other drivers.
> >
> > #define FOO_REG_BAR 0x10
> > #define FOO_REG_BAR_BIT0 BIT(0)
> > #define FOO_REG_BAR_BIT4 BIT(4)
> >
> > The first line is the register offset and the other lines (indented) are
> > the bits description related to this register.
>
> I don't think we have such convention in general and argument that some
> drivers do it in some subsystems is never a good argument. If they also
> misspell things or use Hungarian notation, shall we do the same?
>
> Although maybe it is fine for Lee. I find it unreadable.
>
> git grep '#define \+[A-Z]' | wc -l
> 73889
> git grep '#define [A-Z]' | wc -l
> 3996054
>
> In MFD there is only one driver doing this.
>
> Most of other cases are net and gpu.
>
>
> Best regards,
> Krzysztof
>
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-31 14:59 ` Herve Codina
@ 2023-04-03 14:28 ` Lee Jones
0 siblings, 0 replies; 45+ messages in thread
From: Lee Jones @ 2023-04-03 14:28 UTC (permalink / raw)
To: Herve Codina
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Takashi Iwai, linux-kernel, devicetree,
alsa-devel, Christophe Leroy, Thomas Petazzoni
On Fri, 31 Mar 2023, Herve Codina wrote:
> On Fri, 31 Mar 2023 15:44:19 +0200
> Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
>
> > On 31/03/2023 14:11, Herve Codina wrote:
> > > Hi Krzysztof, Lee
> > >
> > > On Fri, 31 Mar 2023 11:13:30 +0200
> > > Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> > >
> > >> On 31/03/2023 09:42, Herve Codina wrote:
> > >>> Hi Lee,
> > >>>
> > >>> On Thu, 30 Mar 2023 17:05:10 +0100
> > >>> Lee Jones <lee@kernel.org> wrote:
> > >>>
> > >>>> On Tue, 28 Mar 2023, 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.
> > >>>>
> > >>>> My goodness!
> > >>>>
> > >>>> It's been a long time since I've seen anything quite like this.
> > >>>
> > >>> Yes, old things but working on recent kernel.
> > >>>
> > >>>>
> > >>>> My suggestion to you:
> > >>>>
> > >>>> * Split this up into components that fit functional subsystems
> > >>>
> > >>> It is done. The audio part is present in ASoC subsystem (path 5 in this
> > >>> series). pinctrl function is implemented in this driver and, as I don't
> > >>> want to share registers, I would prefer to keep this function inside this
> > >>> driver.
> > >>
> > >> The amount of defines and huge functions like pef2256_setup_e1()
> > >> contradict it.
> > >>
> > >> Even the pef2256_setup_e1() really does not follow Linux coding style -
> > >> you know the size requirement, right?
> > >
> > > I know that pef2256_setup_e1() is quite big and I will look at a way
> > > to split it in a consistent way.
> > >
> > >>
> > >> pef2256_get_groups_count, struct pinmux_ops and others - this is
> > >> pinctrl, not MFD! They cannot be in MFD driver.
> > >
> > > Maybe the issue is that MFD was not a good choice.
> > > The "function" provided are not independent of each other.
> > > The "main" driver (pef2256.c) needs to do the setup and handle the interrupt.
> >
> > Just like all PMICs...
> >
> > > The "function" provided are some glues in order to be used in some sub-systems
> > > such as audio. Indeed, ASoC needs a codec DAI to be connected to a CPU DAI.
> >
> > Just like in all other cases...
> >
> > > These "functions" need to be started (ie probe()) after the pef2256 setup was
> > > done. So a start (probe()) order relationship is needed.
> >
> > Just like in all other cases, so I really do not see here anything special.
> >
> > >
> > > If a MFD driver needs independent children to handle independent functions,
> > > the pef2256 does not fit well as a MFD driver.
> >
> > Why? So far everything is exactly the same.
> >
> > >
> > > I switched from misc to MFD just to handle child DT nodes instead of having
> > > phandles. Using child DT nodes instead of phandles is really a good thing and
> > > need to be kept.
> >
> > Your DT bindings and nodes are not related to driver design. It does not
> > matter for Devicetree if you put it to misc or MFD.
> >
> > It does not matter for driver whether you call it in Devicetree foo or bar.
> >
> > > The switch to MFD was probably not the best thing to do.
> >
> > Maybe, but your existing arguments are not really related...
> >
> > >
> > > What do you think if I switched back the pef2256 "main" driver (pef2256.c) to
> > > misc ?
> >
> > Why? What would it solve? You want to stuff pinctrl driver to misc, to
> > avoid Lee's review? No. Pinctrl goes to pinctrl. Not to misc. Not to MFD.
>
> Just to be clear on that point, I do not want to avoid any reviews and Lee's
> reviews are fully welcome.
>
> I just misunderstood. I thought the issue was that the pef2256 MFD driver has an
> internal setup() and that the 'function' provided were not independent (they share
> the pef2256 API).
> My first feeling was that it was expected a kind of 'empty' driver for the pef2256
> MFD driver. The pef2256 driver cannot be empty. That's why I talk about misc.
It can be empty. That's what simple-mfd is for. :)
I suggest that none of this (besides the child registration, which is
achieved by a simple OF API call in this case) has anything to do with
MFD. We are not requesting and initialising shared resources and we are
not using the MFD API to register children. The pin control
functionality clearly needs moving to Pinctrl and the rest, if you
cannot find a suitable home for it *may be* suitable for Misc.
--
Lee Jones [李琼斯]
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
@ 2023-04-03 14:28 ` Lee Jones
0 siblings, 0 replies; 45+ messages in thread
From: Lee Jones @ 2023-04-03 14:28 UTC (permalink / raw)
To: Herve Codina
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai,
linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
On Fri, 31 Mar 2023, Herve Codina wrote:
> On Fri, 31 Mar 2023 15:44:19 +0200
> Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
>
> > On 31/03/2023 14:11, Herve Codina wrote:
> > > Hi Krzysztof, Lee
> > >
> > > On Fri, 31 Mar 2023 11:13:30 +0200
> > > Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> > >
> > >> On 31/03/2023 09:42, Herve Codina wrote:
> > >>> Hi Lee,
> > >>>
> > >>> On Thu, 30 Mar 2023 17:05:10 +0100
> > >>> Lee Jones <lee@kernel.org> wrote:
> > >>>
> > >>>> On Tue, 28 Mar 2023, 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.
> > >>>>
> > >>>> My goodness!
> > >>>>
> > >>>> It's been a long time since I've seen anything quite like this.
> > >>>
> > >>> Yes, old things but working on recent kernel.
> > >>>
> > >>>>
> > >>>> My suggestion to you:
> > >>>>
> > >>>> * Split this up into components that fit functional subsystems
> > >>>
> > >>> It is done. The audio part is present in ASoC subsystem (path 5 in this
> > >>> series). pinctrl function is implemented in this driver and, as I don't
> > >>> want to share registers, I would prefer to keep this function inside this
> > >>> driver.
> > >>
> > >> The amount of defines and huge functions like pef2256_setup_e1()
> > >> contradict it.
> > >>
> > >> Even the pef2256_setup_e1() really does not follow Linux coding style -
> > >> you know the size requirement, right?
> > >
> > > I know that pef2256_setup_e1() is quite big and I will look at a way
> > > to split it in a consistent way.
> > >
> > >>
> > >> pef2256_get_groups_count, struct pinmux_ops and others - this is
> > >> pinctrl, not MFD! They cannot be in MFD driver.
> > >
> > > Maybe the issue is that MFD was not a good choice.
> > > The "function" provided are not independent of each other.
> > > The "main" driver (pef2256.c) needs to do the setup and handle the interrupt.
> >
> > Just like all PMICs...
> >
> > > The "function" provided are some glues in order to be used in some sub-systems
> > > such as audio. Indeed, ASoC needs a codec DAI to be connected to a CPU DAI.
> >
> > Just like in all other cases...
> >
> > > These "functions" need to be started (ie probe()) after the pef2256 setup was
> > > done. So a start (probe()) order relationship is needed.
> >
> > Just like in all other cases, so I really do not see here anything special.
> >
> > >
> > > If a MFD driver needs independent children to handle independent functions,
> > > the pef2256 does not fit well as a MFD driver.
> >
> > Why? So far everything is exactly the same.
> >
> > >
> > > I switched from misc to MFD just to handle child DT nodes instead of having
> > > phandles. Using child DT nodes instead of phandles is really a good thing and
> > > need to be kept.
> >
> > Your DT bindings and nodes are not related to driver design. It does not
> > matter for Devicetree if you put it to misc or MFD.
> >
> > It does not matter for driver whether you call it in Devicetree foo or bar.
> >
> > > The switch to MFD was probably not the best thing to do.
> >
> > Maybe, but your existing arguments are not really related...
> >
> > >
> > > What do you think if I switched back the pef2256 "main" driver (pef2256.c) to
> > > misc ?
> >
> > Why? What would it solve? You want to stuff pinctrl driver to misc, to
> > avoid Lee's review? No. Pinctrl goes to pinctrl. Not to misc. Not to MFD.
>
> Just to be clear on that point, I do not want to avoid any reviews and Lee's
> reviews are fully welcome.
>
> I just misunderstood. I thought the issue was that the pef2256 MFD driver has an
> internal setup() and that the 'function' provided were not independent (they share
> the pef2256 API).
> My first feeling was that it was expected a kind of 'empty' driver for the pef2256
> MFD driver. The pef2256 driver cannot be empty. That's why I talk about misc.
It can be empty. That's what simple-mfd is for. :)
I suggest that none of this (besides the child registration, which is
achieved by a simple OF API call in this case) has anything to do with
MFD. We are not requesting and initialising shared resources and we are
not using the MFD API to register children. The pin control
functionality clearly needs moving to Pinctrl and the rest, if you
cannot find a suitable home for it *may be* suitable for Misc.
--
Lee Jones [李琼斯]
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-03 14:28 ` Lee Jones
(?)
@ 2023-04-04 7:20 ` Herve Codina
2023-04-04 7:23 ` Krzysztof Kozlowski
-1 siblings, 1 reply; 45+ messages in thread
From: Herve Codina @ 2023-04-04 7:20 UTC (permalink / raw)
To: Lee Jones
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai,
linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
Hi Lee,
On Mon, 3 Apr 2023 15:28:22 +0100
Lee Jones <lee@kernel.org> wrote:
> On Fri, 31 Mar 2023, Herve Codina wrote:
>
> > On Fri, 31 Mar 2023 15:44:19 +0200
> > Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> >
> > > On 31/03/2023 14:11, Herve Codina wrote:
> > > > Hi Krzysztof, Lee
> > > >
> > > > On Fri, 31 Mar 2023 11:13:30 +0200
> > > > Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> > > >
> > > >> On 31/03/2023 09:42, Herve Codina wrote:
> > > >>> Hi Lee,
> > > >>>
> > > >>> On Thu, 30 Mar 2023 17:05:10 +0100
> > > >>> Lee Jones <lee@kernel.org> wrote:
> > > >>>
> > > >>>> On Tue, 28 Mar 2023, 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.
> > > >>>>
> > > >>>> My goodness!
> > > >>>>
> > > >>>> It's been a long time since I've seen anything quite like this.
> > > >>>
> > > >>> Yes, old things but working on recent kernel.
> > > >>>
> > > >>>>
> > > >>>> My suggestion to you:
> > > >>>>
> > > >>>> * Split this up into components that fit functional subsystems
> > > >>>
> > > >>> It is done. The audio part is present in ASoC subsystem (path 5 in this
> > > >>> series). pinctrl function is implemented in this driver and, as I don't
> > > >>> want to share registers, I would prefer to keep this function inside this
> > > >>> driver.
> > > >>
> > > >> The amount of defines and huge functions like pef2256_setup_e1()
> > > >> contradict it.
> > > >>
> > > >> Even the pef2256_setup_e1() really does not follow Linux coding style -
> > > >> you know the size requirement, right?
> > > >
> > > > I know that pef2256_setup_e1() is quite big and I will look at a way
> > > > to split it in a consistent way.
> > > >
> > > >>
> > > >> pef2256_get_groups_count, struct pinmux_ops and others - this is
> > > >> pinctrl, not MFD! They cannot be in MFD driver.
> > > >
> > > > Maybe the issue is that MFD was not a good choice.
> > > > The "function" provided are not independent of each other.
> > > > The "main" driver (pef2256.c) needs to do the setup and handle the interrupt.
> > >
> > > Just like all PMICs...
> > >
> > > > The "function" provided are some glues in order to be used in some sub-systems
> > > > such as audio. Indeed, ASoC needs a codec DAI to be connected to a CPU DAI.
> > >
> > > Just like in all other cases...
> > >
> > > > These "functions" need to be started (ie probe()) after the pef2256 setup was
> > > > done. So a start (probe()) order relationship is needed.
> > >
> > > Just like in all other cases, so I really do not see here anything special.
> > >
> > > >
> > > > If a MFD driver needs independent children to handle independent functions,
> > > > the pef2256 does not fit well as a MFD driver.
> > >
> > > Why? So far everything is exactly the same.
> > >
> > > >
> > > > I switched from misc to MFD just to handle child DT nodes instead of having
> > > > phandles. Using child DT nodes instead of phandles is really a good thing and
> > > > need to be kept.
> > >
> > > Your DT bindings and nodes are not related to driver design. It does not
> > > matter for Devicetree if you put it to misc or MFD.
> > >
> > > It does not matter for driver whether you call it in Devicetree foo or bar.
> > >
> > > > The switch to MFD was probably not the best thing to do.
> > >
> > > Maybe, but your existing arguments are not really related...
> > >
> > > >
> > > > What do you think if I switched back the pef2256 "main" driver (pef2256.c) to
> > > > misc ?
> > >
> > > Why? What would it solve? You want to stuff pinctrl driver to misc, to
> > > avoid Lee's review? No. Pinctrl goes to pinctrl. Not to misc. Not to MFD.
> >
> > Just to be clear on that point, I do not want to avoid any reviews and Lee's
> > reviews are fully welcome.
> >
> > I just misunderstood. I thought the issue was that the pef2256 MFD driver has an
> > internal setup() and that the 'function' provided were not independent (they share
> > the pef2256 API).
> > My first feeling was that it was expected a kind of 'empty' driver for the pef2256
> > MFD driver. The pef2256 driver cannot be empty. That's why I talk about misc.
>
> It can be empty. That's what simple-mfd is for. :)
>
> I suggest that none of this (besides the child registration, which is
> achieved by a simple OF API call in this case) has anything to do with
> MFD. We are not requesting and initialising shared resources and we are
> not using the MFD API to register children. The pin control
> functionality clearly needs moving to Pinctrl and the rest, if you
> cannot find a suitable home for it *may be* suitable for Misc.
>
I am confused and I am not really sure to understand where to put my driver.
The core pef2256.c needs to:
1) setup the pef2256
2) add the children
To add the children it calls devm_of_platform_populate() to add the audio
parts as several audio children can be available with the same compatible
string.
I plan to move the pinctrl part to the pinctrl subsystem. With this done,
the core pef2256.c will probably add the children using:
- a mfd_cell for the pinctrl part
- devm_of_platform_populate() for the audio children
The setup (E1 lines and TDM configuration) still needs to be done by the
core pef2256.c. Moving this part only to Misc will break the hierarchy.
The audio children depends on the core pef2256.c as this one do the setup.
Having in the audio children and the part that do the setup in same hierarchy
level is not correct. Audio children should be children of the part that do
the setup.
So, the structure I have in mind:
- pef2256.c (MFD)
implement and do the setup at probe()
Add the children at probe():
- pef2256-pinctrl (pinctrl) added using mfd_add_devices()
- pef2256-codec (ASoC codec) added using devm_of_platform_populate()
Lee, with this in mind, can the core pef2256.c be a MFD driver ?
Best regards,
Hervé
--
Hervé Codina, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-04 7:20 ` Herve Codina
@ 2023-04-04 7:23 ` Krzysztof Kozlowski
0 siblings, 0 replies; 45+ messages in thread
From: Krzysztof Kozlowski @ 2023-04-04 7:23 UTC (permalink / raw)
To: Herve Codina, Lee Jones
Cc: Rob Herring, Krzysztof Kozlowski, Liam Girdwood, Mark Brown,
Takashi Iwai, linux-kernel, devicetree, alsa-devel,
Christophe Leroy, Thomas Petazzoni
On 04/04/2023 09:20, Herve Codina wrote:
>> I suggest that none of this (besides the child registration, which is
>> achieved by a simple OF API call in this case) has anything to do with
>> MFD. We are not requesting and initialising shared resources and we are
>> not using the MFD API to register children. The pin control
>> functionality clearly needs moving to Pinctrl and the rest, if you
>> cannot find a suitable home for it *may be* suitable for Misc.
>>
>
> I am confused and I am not really sure to understand where to put my driver.
>
> The core pef2256.c needs to:
> 1) setup the pef2256
> 2) add the children
>
> To add the children it calls devm_of_platform_populate() to add the audio
> parts as several audio children can be available with the same compatible
> string.
>
> I plan to move the pinctrl part to the pinctrl subsystem. With this done,
> the core pef2256.c will probably add the children using:
> - a mfd_cell for the pinctrl part
> - devm_of_platform_populate() for the audio children
>
> The setup (E1 lines and TDM configuration) still needs to be done by the
> core pef2256.c. Moving this part only to Misc will break the hierarchy.
> The audio children depends on the core pef2256.c as this one do the setup.
> Having in the audio children and the part that do the setup in same hierarchy
> level is not correct. Audio children should be children of the part that do
> the setup.
>
> So, the structure I have in mind:
> - pef2256.c (MFD)
> implement and do the setup at probe()
> Add the children at probe():
> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
>
> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
You do not use MFD here, so why do you want to keep it in MFD? If you
disagree, please tell me where is the MFD code in your patch?
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
@ 2023-04-04 7:23 ` Krzysztof Kozlowski
0 siblings, 0 replies; 45+ messages in thread
From: Krzysztof Kozlowski @ 2023-04-04 7:23 UTC (permalink / raw)
To: Herve Codina, Lee Jones
Cc: Rob Herring, Krzysztof Kozlowski, Liam Girdwood, Mark Brown,
Jaroslav Kysela, Takashi Iwai, linux-kernel, devicetree,
alsa-devel, Christophe Leroy, Thomas Petazzoni
On 04/04/2023 09:20, Herve Codina wrote:
>> I suggest that none of this (besides the child registration, which is
>> achieved by a simple OF API call in this case) has anything to do with
>> MFD. We are not requesting and initialising shared resources and we are
>> not using the MFD API to register children. The pin control
>> functionality clearly needs moving to Pinctrl and the rest, if you
>> cannot find a suitable home for it *may be* suitable for Misc.
>>
>
> I am confused and I am not really sure to understand where to put my driver.
>
> The core pef2256.c needs to:
> 1) setup the pef2256
> 2) add the children
>
> To add the children it calls devm_of_platform_populate() to add the audio
> parts as several audio children can be available with the same compatible
> string.
>
> I plan to move the pinctrl part to the pinctrl subsystem. With this done,
> the core pef2256.c will probably add the children using:
> - a mfd_cell for the pinctrl part
> - devm_of_platform_populate() for the audio children
>
> The setup (E1 lines and TDM configuration) still needs to be done by the
> core pef2256.c. Moving this part only to Misc will break the hierarchy.
> The audio children depends on the core pef2256.c as this one do the setup.
> Having in the audio children and the part that do the setup in same hierarchy
> level is not correct. Audio children should be children of the part that do
> the setup.
>
> So, the structure I have in mind:
> - pef2256.c (MFD)
> implement and do the setup at probe()
> Add the children at probe():
> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
>
> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
You do not use MFD here, so why do you want to keep it in MFD? If you
disagree, please tell me where is the MFD code in your patch?
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-04 7:23 ` Krzysztof Kozlowski
(?)
@ 2023-04-04 8:07 ` Herve Codina
2023-04-04 8:15 ` Krzysztof Kozlowski
-1 siblings, 1 reply; 45+ messages in thread
From: Herve Codina @ 2023-04-04 8:07 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: Lee Jones, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Jaroslav Kysela, Takashi Iwai, linux-kernel,
devicetree, alsa-devel, Christophe Leroy, Thomas Petazzoni
On Tue, 4 Apr 2023 09:23:36 +0200
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> On 04/04/2023 09:20, Herve Codina wrote:
> >> I suggest that none of this (besides the child registration, which is
> >> achieved by a simple OF API call in this case) has anything to do with
> >> MFD. We are not requesting and initialising shared resources and we are
> >> not using the MFD API to register children. The pin control
> >> functionality clearly needs moving to Pinctrl and the rest, if you
> >> cannot find a suitable home for it *may be* suitable for Misc.
> >>
> >
> > I am confused and I am not really sure to understand where to put my driver.
> >
> > The core pef2256.c needs to:
> > 1) setup the pef2256
> > 2) add the children
> >
> > To add the children it calls devm_of_platform_populate() to add the audio
> > parts as several audio children can be available with the same compatible
> > string.
> >
> > I plan to move the pinctrl part to the pinctrl subsystem. With this done,
> > the core pef2256.c will probably add the children using:
> > - a mfd_cell for the pinctrl part
> > - devm_of_platform_populate() for the audio children
> >
> > The setup (E1 lines and TDM configuration) still needs to be done by the
> > core pef2256.c. Moving this part only to Misc will break the hierarchy.
> > The audio children depends on the core pef2256.c as this one do the setup.
> > Having in the audio children and the part that do the setup in same hierarchy
> > level is not correct. Audio children should be children of the part that do
> > the setup.
> >
> > So, the structure I have in mind:
> > - pef2256.c (MFD)
> > implement and do the setup at probe()
> > Add the children at probe():
> > - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> > - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> >
> > Lee, with this in mind, can the core pef2256.c be a MFD driver ?
>
> You do not use MFD here, so why do you want to keep it in MFD? If you
> disagree, please tell me where is the MFD code in your patch?
I don't want to absolutely use MFD.
I just want to put my driver somewhere and I don't know the right location
between MFD and Misc.
Basically, the driver needs to do (little simplified and error path removed):
static const struct mfd_cell pef2256_devs[] = {
{ .name = "lantiq-pef2256-pinctrl", },
};
static int pef2256_probe(struct platform_device *pdev)
{
struct pef2256 *pef2256;
void __iomem *iomem;
int ret;
int irq;
pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
if (!pef2256)
return -ENOMEM;
pef2256->dev = &pdev->dev;
iomem = devm_platform_ioremap_resource(pdev, 0);
pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
&pef2256_regmap_config);
pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
if (pef2256->reset_gpio) {
gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
udelay(10);
gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
udelay(10);
}
pef2556_of_parse(pef2256, np);
irq = platform_get_irq(pdev, 0);
ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
platform_set_drvdata(pdev, pef2256);
mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
pef2256_setup(pef2256);
devm_of_platform_populate(pef2256->dev);
return 0;
}
>
> Best regards,
> Krzysztof
>
--
Hervé Codina, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-04 8:07 ` Herve Codina
@ 2023-04-04 8:15 ` Krzysztof Kozlowski
0 siblings, 0 replies; 45+ messages in thread
From: Krzysztof Kozlowski @ 2023-04-04 8:15 UTC (permalink / raw)
To: Herve Codina
Cc: Lee Jones, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Takashi Iwai, linux-kernel, devicetree, alsa-devel,
Christophe Leroy, Thomas Petazzoni
On 04/04/2023 10:07, Herve Codina wrote:
>>> So, the structure I have in mind:
>>> - pef2256.c (MFD)
>>> implement and do the setup at probe()
>>> Add the children at probe():
>>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
>>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
>>>
>>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
>>
>> You do not use MFD here, so why do you want to keep it in MFD? If you
>> disagree, please tell me where is the MFD code in your patch?
>
> I don't want to absolutely use MFD.
> I just want to put my driver somewhere and I don't know the right location
> between MFD and Misc.
>
> Basically, the driver needs to do (little simplified and error path removed):
>
> static const struct mfd_cell pef2256_devs[] = {
> { .name = "lantiq-pef2256-pinctrl", },
> };
>
> static int pef2256_probe(struct platform_device *pdev)
> {
> struct pef2256 *pef2256;
> void __iomem *iomem;
> int ret;
> int irq;
>
> pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> if (!pef2256)
> return -ENOMEM;
>
> pef2256->dev = &pdev->dev;
>
> iomem = devm_platform_ioremap_resource(pdev, 0);
>
> pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> &pef2256_regmap_config);
>
> pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
>
> pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> if (pef2256->reset_gpio) {
> gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> udelay(10);
> gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> udelay(10);
> }
>
> pef2556_of_parse(pef2256, np);
>
> irq = platform_get_irq(pdev, 0);
> ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
>
> platform_set_drvdata(pdev, pef2256);
>
> mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
Wait, now you use MFD framework, so the driver is suitable for MFD.
Before there was nothing like that in your code.
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
@ 2023-04-04 8:15 ` Krzysztof Kozlowski
0 siblings, 0 replies; 45+ messages in thread
From: Krzysztof Kozlowski @ 2023-04-04 8:15 UTC (permalink / raw)
To: Herve Codina
Cc: Lee Jones, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Jaroslav Kysela, Takashi Iwai, linux-kernel,
devicetree, alsa-devel, Christophe Leroy, Thomas Petazzoni
On 04/04/2023 10:07, Herve Codina wrote:
>>> So, the structure I have in mind:
>>> - pef2256.c (MFD)
>>> implement and do the setup at probe()
>>> Add the children at probe():
>>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
>>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
>>>
>>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
>>
>> You do not use MFD here, so why do you want to keep it in MFD? If you
>> disagree, please tell me where is the MFD code in your patch?
>
> I don't want to absolutely use MFD.
> I just want to put my driver somewhere and I don't know the right location
> between MFD and Misc.
>
> Basically, the driver needs to do (little simplified and error path removed):
>
> static const struct mfd_cell pef2256_devs[] = {
> { .name = "lantiq-pef2256-pinctrl", },
> };
>
> static int pef2256_probe(struct platform_device *pdev)
> {
> struct pef2256 *pef2256;
> void __iomem *iomem;
> int ret;
> int irq;
>
> pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> if (!pef2256)
> return -ENOMEM;
>
> pef2256->dev = &pdev->dev;
>
> iomem = devm_platform_ioremap_resource(pdev, 0);
>
> pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> &pef2256_regmap_config);
>
> pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
>
> pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> if (pef2256->reset_gpio) {
> gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> udelay(10);
> gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> udelay(10);
> }
>
> pef2556_of_parse(pef2256, np);
>
> irq = platform_get_irq(pdev, 0);
> ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
>
> platform_set_drvdata(pdev, pef2256);
>
> mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
Wait, now you use MFD framework, so the driver is suitable for MFD.
Before there was nothing like that in your code.
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-04 8:15 ` Krzysztof Kozlowski
@ 2023-04-05 13:54 ` Lee Jones
-1 siblings, 0 replies; 45+ messages in thread
From: Lee Jones @ 2023-04-05 13:54 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: Herve Codina, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Takashi Iwai, linux-kernel, devicetree, alsa-devel,
Christophe Leroy, Thomas Petazzoni
On Tue, 04 Apr 2023, Krzysztof Kozlowski wrote:
> On 04/04/2023 10:07, Herve Codina wrote:
>
> >>> So, the structure I have in mind:
> >>> - pef2256.c (MFD)
> >>> implement and do the setup at probe()
> >>> Add the children at probe():
> >>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> >>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> >>>
> >>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
> >>
> >> You do not use MFD here, so why do you want to keep it in MFD? If you
> >> disagree, please tell me where is the MFD code in your patch?
> >
> > I don't want to absolutely use MFD.
> > I just want to put my driver somewhere and I don't know the right location
> > between MFD and Misc.
> >
> > Basically, the driver needs to do (little simplified and error path removed):
> >
> > static const struct mfd_cell pef2256_devs[] = {
> > { .name = "lantiq-pef2256-pinctrl", },
> > };
> >
> > static int pef2256_probe(struct platform_device *pdev)
> > {
> > struct pef2256 *pef2256;
> > void __iomem *iomem;
> > int ret;
> > int irq;
> >
> > pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> > if (!pef2256)
> > return -ENOMEM;
> >
> > pef2256->dev = &pdev->dev;
> >
> > iomem = devm_platform_ioremap_resource(pdev, 0);
> >
> > pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> > &pef2256_regmap_config);
> >
> > pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> > pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> > pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
> >
> > pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> > if (pef2256->reset_gpio) {
> > gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> > udelay(10);
> > gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> > udelay(10);
> > }
> >
> > pef2556_of_parse(pef2256, np);
> >
> > irq = platform_get_irq(pdev, 0);
> > ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
> >
> > platform_set_drvdata(pdev, pef2256);
> >
> > mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> > ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
>
> Wait, now you use MFD framework, so the driver is suitable for MFD.
> Before there was nothing like that in your code.
Agree, the above is suitable for MFD, since it does all the things I
said your last one did not. You *can* also use of_platform_populate()
here, since you are *also* requesting and initialising shared resources.
You cannot do *both* however.
--
Lee Jones [李琼斯]
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
@ 2023-04-05 13:54 ` Lee Jones
0 siblings, 0 replies; 45+ messages in thread
From: Lee Jones @ 2023-04-05 13:54 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: Herve Codina, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Jaroslav Kysela, Takashi Iwai, linux-kernel,
devicetree, alsa-devel, Christophe Leroy, Thomas Petazzoni
On Tue, 04 Apr 2023, Krzysztof Kozlowski wrote:
> On 04/04/2023 10:07, Herve Codina wrote:
>
> >>> So, the structure I have in mind:
> >>> - pef2256.c (MFD)
> >>> implement and do the setup at probe()
> >>> Add the children at probe():
> >>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> >>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> >>>
> >>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
> >>
> >> You do not use MFD here, so why do you want to keep it in MFD? If you
> >> disagree, please tell me where is the MFD code in your patch?
> >
> > I don't want to absolutely use MFD.
> > I just want to put my driver somewhere and I don't know the right location
> > between MFD and Misc.
> >
> > Basically, the driver needs to do (little simplified and error path removed):
> >
> > static const struct mfd_cell pef2256_devs[] = {
> > { .name = "lantiq-pef2256-pinctrl", },
> > };
> >
> > static int pef2256_probe(struct platform_device *pdev)
> > {
> > struct pef2256 *pef2256;
> > void __iomem *iomem;
> > int ret;
> > int irq;
> >
> > pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> > if (!pef2256)
> > return -ENOMEM;
> >
> > pef2256->dev = &pdev->dev;
> >
> > iomem = devm_platform_ioremap_resource(pdev, 0);
> >
> > pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> > &pef2256_regmap_config);
> >
> > pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> > pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> > pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
> >
> > pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> > if (pef2256->reset_gpio) {
> > gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> > udelay(10);
> > gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> > udelay(10);
> > }
> >
> > pef2556_of_parse(pef2256, np);
> >
> > irq = platform_get_irq(pdev, 0);
> > ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
> >
> > platform_set_drvdata(pdev, pef2256);
> >
> > mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> > ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
>
> Wait, now you use MFD framework, so the driver is suitable for MFD.
> Before there was nothing like that in your code.
Agree, the above is suitable for MFD, since it does all the things I
said your last one did not. You *can* also use of_platform_populate()
here, since you are *also* requesting and initialising shared resources.
You cannot do *both* however.
--
Lee Jones [李琼斯]
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-05 13:54 ` Lee Jones
(?)
@ 2023-04-05 16:00 ` Herve Codina via Alsa-devel
-1 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-04-05 16:00 UTC (permalink / raw)
To: Lee Jones
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Takashi Iwai, linux-kernel, devicetree,
alsa-devel, Christophe Leroy, Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 8089 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Lee Jones <lee@kernel.org>
Cc: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Takashi Iwai <tiwai@suse.com>, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
Date: Wed, 5 Apr 2023 18:00:23 +0200
Message-ID: <20230405180023.4aebaa08@bootlin.com>
Hi Lee,
On Wed, 5 Apr 2023 14:54:50 +0100
Lee Jones <lee@kernel.org> wrote:
> On Tue, 04 Apr 2023, Krzysztof Kozlowski wrote:
>
> > On 04/04/2023 10:07, Herve Codina wrote:
> >
> > >>> So, the structure I have in mind:
> > >>> - pef2256.c (MFD)
> > >>> implement and do the setup at probe()
> > >>> Add the children at probe():
> > >>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> > >>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> > >>>
> > >>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
> > >>
> > >> You do not use MFD here, so why do you want to keep it in MFD? If you
> > >> disagree, please tell me where is the MFD code in your patch?
> > >
> > > I don't want to absolutely use MFD.
> > > I just want to put my driver somewhere and I don't know the right location
> > > between MFD and Misc.
> > >
> > > Basically, the driver needs to do (little simplified and error path removed):
> > >
> > > static const struct mfd_cell pef2256_devs[] = {
> > > { .name = "lantiq-pef2256-pinctrl", },
> > > };
> > >
> > > static int pef2256_probe(struct platform_device *pdev)
> > > {
> > > struct pef2256 *pef2256;
> > > void __iomem *iomem;
> > > int ret;
> > > int irq;
> > >
> > > pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> > > if (!pef2256)
> > > return -ENOMEM;
> > >
> > > pef2256->dev = &pdev->dev;
> > >
> > > iomem = devm_platform_ioremap_resource(pdev, 0);
> > >
> > > pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> > > &pef2256_regmap_config);
> > >
> > > pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> > > pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> > > pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
> > >
> > > pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> > > if (pef2256->reset_gpio) {
> > > gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> > > udelay(10);
> > > gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> > > udelay(10);
> > > }
> > >
> > > pef2556_of_parse(pef2256, np);
> > >
> > > irq = platform_get_irq(pdev, 0);
> > > ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
> > >
> > > platform_set_drvdata(pdev, pef2256);
> > >
> > > mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> > > ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
> >
> > Wait, now you use MFD framework, so the driver is suitable for MFD.
> > Before there was nothing like that in your code.
>
> Agree, the above is suitable for MFD, since it does all the things I
> said your last one did not. You *can* also use of_platform_populate()
> here, since you are *also* requesting and initialising shared resources.
> You cannot do *both* however.
>
Thanks for having confirmed that this driver can be a MFD driver.
Related to of_platform_populate() / mfd_add_devices(), I wanted to use both
because:
- the pinctrl part does not have (and does not need to have) a specific node
with a specific compatible property. In order to instantiate the related
driver mfd_add_devices() is the only way I know.
- the audio component nodes have a compatible string and several components
(ie several nodes) can be present. of_platform_populate() call seems the
simple way to instantiate them.
Is there a way to use mfd_add_devices() in this case without the need to
count the audio component nodes in order to allocate as much mfd_cell as
nodes having a matching compatible property ? Is there an other API to do
it ?
Best regards,
Hervé
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-05 13:54 ` Lee Jones
(?)
(?)
@ 2023-04-05 16:00 ` Herve Codina
2023-04-11 16:16 ` Herve Codina via Alsa-devel
2023-04-11 16:16 ` Herve Codina
-1 siblings, 2 replies; 45+ messages in thread
From: Herve Codina @ 2023-04-05 16:00 UTC (permalink / raw)
To: Lee Jones
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai,
linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
Hi Lee,
On Wed, 5 Apr 2023 14:54:50 +0100
Lee Jones <lee@kernel.org> wrote:
> On Tue, 04 Apr 2023, Krzysztof Kozlowski wrote:
>
> > On 04/04/2023 10:07, Herve Codina wrote:
> >
> > >>> So, the structure I have in mind:
> > >>> - pef2256.c (MFD)
> > >>> implement and do the setup at probe()
> > >>> Add the children at probe():
> > >>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> > >>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> > >>>
> > >>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
> > >>
> > >> You do not use MFD here, so why do you want to keep it in MFD? If you
> > >> disagree, please tell me where is the MFD code in your patch?
> > >
> > > I don't want to absolutely use MFD.
> > > I just want to put my driver somewhere and I don't know the right location
> > > between MFD and Misc.
> > >
> > > Basically, the driver needs to do (little simplified and error path removed):
> > >
> > > static const struct mfd_cell pef2256_devs[] = {
> > > { .name = "lantiq-pef2256-pinctrl", },
> > > };
> > >
> > > static int pef2256_probe(struct platform_device *pdev)
> > > {
> > > struct pef2256 *pef2256;
> > > void __iomem *iomem;
> > > int ret;
> > > int irq;
> > >
> > > pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> > > if (!pef2256)
> > > return -ENOMEM;
> > >
> > > pef2256->dev = &pdev->dev;
> > >
> > > iomem = devm_platform_ioremap_resource(pdev, 0);
> > >
> > > pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> > > &pef2256_regmap_config);
> > >
> > > pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> > > pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> > > pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
> > >
> > > pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> > > if (pef2256->reset_gpio) {
> > > gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> > > udelay(10);
> > > gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> > > udelay(10);
> > > }
> > >
> > > pef2556_of_parse(pef2256, np);
> > >
> > > irq = platform_get_irq(pdev, 0);
> > > ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
> > >
> > > platform_set_drvdata(pdev, pef2256);
> > >
> > > mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> > > ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
> >
> > Wait, now you use MFD framework, so the driver is suitable for MFD.
> > Before there was nothing like that in your code.
>
> Agree, the above is suitable for MFD, since it does all the things I
> said your last one did not. You *can* also use of_platform_populate()
> here, since you are *also* requesting and initialising shared resources.
> You cannot do *both* however.
>
Thanks for having confirmed that this driver can be a MFD driver.
Related to of_platform_populate() / mfd_add_devices(), I wanted to use both
because:
- the pinctrl part does not have (and does not need to have) a specific node
with a specific compatible property. In order to instantiate the related
driver mfd_add_devices() is the only way I know.
- the audio component nodes have a compatible string and several components
(ie several nodes) can be present. of_platform_populate() call seems the
simple way to instantiate them.
Is there a way to use mfd_add_devices() in this case without the need to
count the audio component nodes in order to allocate as much mfd_cell as
nodes having a matching compatible property ? Is there an other API to do
it ?
Best regards,
Hervé
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-05 16:00 ` Herve Codina
@ 2023-04-11 16:16 ` Herve Codina via Alsa-devel
2023-04-11 16:16 ` Herve Codina
1 sibling, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-04-11 16:16 UTC (permalink / raw)
To: Lee Jones
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Takashi Iwai, linux-kernel, devicetree,
alsa-devel, Christophe Leroy, Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 9931 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Lee Jones <lee@kernel.org>
Cc: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Takashi Iwai <tiwai@suse.com>, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
Date: Tue, 11 Apr 2023 18:16:40 +0200
Message-ID: <20230411181640.50c19d4e@bootlin.com>
Hi Lee,
On Wed, 5 Apr 2023 18:00:23 +0200
Herve Codina <herve.codina@bootlin.com> wrote:
> Hi Lee,
> On Wed, 5 Apr 2023 14:54:50 +0100
> Lee Jones <lee@kernel.org> wrote:
>
> > On Tue, 04 Apr 2023, Krzysztof Kozlowski wrote:
> >
> > > On 04/04/2023 10:07, Herve Codina wrote:
> > >
> > > >>> So, the structure I have in mind:
> > > >>> - pef2256.c (MFD)
> > > >>> implement and do the setup at probe()
> > > >>> Add the children at probe():
> > > >>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> > > >>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> > > >>>
> > > >>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
> > > >>
> > > >> You do not use MFD here, so why do you want to keep it in MFD? If you
> > > >> disagree, please tell me where is the MFD code in your patch?
> > > >
> > > > I don't want to absolutely use MFD.
> > > > I just want to put my driver somewhere and I don't know the right location
> > > > between MFD and Misc.
> > > >
> > > > Basically, the driver needs to do (little simplified and error path removed):
> > > >
> > > > static const struct mfd_cell pef2256_devs[] = {
> > > > { .name = "lantiq-pef2256-pinctrl", },
> > > > };
> > > >
> > > > static int pef2256_probe(struct platform_device *pdev)
> > > > {
> > > > struct pef2256 *pef2256;
> > > > void __iomem *iomem;
> > > > int ret;
> > > > int irq;
> > > >
> > > > pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> > > > if (!pef2256)
> > > > return -ENOMEM;
> > > >
> > > > pef2256->dev = &pdev->dev;
> > > >
> > > > iomem = devm_platform_ioremap_resource(pdev, 0);
> > > >
> > > > pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> > > > &pef2256_regmap_config);
> > > >
> > > > pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> > > > pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> > > > pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
> > > >
> > > > pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> > > > if (pef2256->reset_gpio) {
> > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> > > > udelay(10);
> > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> > > > udelay(10);
> > > > }
> > > >
> > > > pef2556_of_parse(pef2256, np);
> > > >
> > > > irq = platform_get_irq(pdev, 0);
> > > > ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
> > > >
> > > > platform_set_drvdata(pdev, pef2256);
> > > >
> > > > mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> > > > ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
> > >
> > > Wait, now you use MFD framework, so the driver is suitable for MFD.
> > > Before there was nothing like that in your code.
> >
> > Agree, the above is suitable for MFD, since it does all the things I
> > said your last one did not. You *can* also use of_platform_populate()
> > here, since you are *also* requesting and initialising shared resources.
> > You cannot do *both* however.
> >
>
> Thanks for having confirmed that this driver can be a MFD driver.
>
> Related to of_platform_populate() / mfd_add_devices(), I wanted to use both
> because:
> - the pinctrl part does not have (and does not need to have) a specific node
> with a specific compatible property. In order to instantiate the related
> driver mfd_add_devices() is the only way I know.
> - the audio component nodes have a compatible string and several components
> (ie several nodes) can be present. of_platform_populate() call seems the
> simple way to instantiate them.
>
> Is there a way to use mfd_add_devices() in this case without the need to
> count the audio component nodes in order to allocate as much mfd_cell as
> nodes having a matching compatible property ? Is there an other API to do
> it ?
>
I looked deeper for using mfd_add_devices() only and found an issue (related
to my use-case).
mfd_add_devices() calls mfd_add_device() and in this function we have:
---- 8< ----
if (IS_ENABLED(CONFIG_OF) && parent->of_node && cell->of_compatible) {
for_each_child_of_node(parent->of_node, np) {
if (of_device_is_compatible(np, cell->of_compatible)) {
/* Ignore 'disabled' devices error free */
if (!of_device_is_available(np)) {
of_node_put(np);
ret = 0;
goto fail_alias;
}
ret = mfd_match_of_node_to_dev(pdev, np, cell);
if (ret == -EAGAIN)
continue;
of_node_put(np);
if (ret)
goto fail_alias;
break;
}
}
if (!pdev->dev.of_node)
pr_warn("%s: Failed to locate of_node [id: %d]\n",
cell->name, platform_id);
}
---- 8< ----
My issue is related to the loop.
The loop is aborted if the device is not available (typically 'Disabled' in the
DT node).
My full pef2256 node can have several pef2256 audio subnodes with compatible
set to "lantiq,pef2256-codec" and some of them can have 'status = "Disabled";'
As soon as one device (with my expected compatible) is found 'Disabled', there
is no way to look at other children.
Having 'continue' in case of device not available in the loop to look at the
next child will change the behavior of mfd_add_device().
Do you think that looking at next child if we find a 'not available' child
can be correct for mfd_add_device() ?
This probably will have impacts on other MFD drivers.
Best regards,
Hervé
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-05 16:00 ` Herve Codina
2023-04-11 16:16 ` Herve Codina via Alsa-devel
@ 2023-04-11 16:16 ` Herve Codina
2023-04-12 9:59 ` Lee Jones
1 sibling, 1 reply; 45+ messages in thread
From: Herve Codina @ 2023-04-11 16:16 UTC (permalink / raw)
To: Lee Jones
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai,
linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
Hi Lee,
On Wed, 5 Apr 2023 18:00:23 +0200
Herve Codina <herve.codina@bootlin.com> wrote:
> Hi Lee,
> On Wed, 5 Apr 2023 14:54:50 +0100
> Lee Jones <lee@kernel.org> wrote:
>
> > On Tue, 04 Apr 2023, Krzysztof Kozlowski wrote:
> >
> > > On 04/04/2023 10:07, Herve Codina wrote:
> > >
> > > >>> So, the structure I have in mind:
> > > >>> - pef2256.c (MFD)
> > > >>> implement and do the setup at probe()
> > > >>> Add the children at probe():
> > > >>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> > > >>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> > > >>>
> > > >>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
> > > >>
> > > >> You do not use MFD here, so why do you want to keep it in MFD? If you
> > > >> disagree, please tell me where is the MFD code in your patch?
> > > >
> > > > I don't want to absolutely use MFD.
> > > > I just want to put my driver somewhere and I don't know the right location
> > > > between MFD and Misc.
> > > >
> > > > Basically, the driver needs to do (little simplified and error path removed):
> > > >
> > > > static const struct mfd_cell pef2256_devs[] = {
> > > > { .name = "lantiq-pef2256-pinctrl", },
> > > > };
> > > >
> > > > static int pef2256_probe(struct platform_device *pdev)
> > > > {
> > > > struct pef2256 *pef2256;
> > > > void __iomem *iomem;
> > > > int ret;
> > > > int irq;
> > > >
> > > > pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> > > > if (!pef2256)
> > > > return -ENOMEM;
> > > >
> > > > pef2256->dev = &pdev->dev;
> > > >
> > > > iomem = devm_platform_ioremap_resource(pdev, 0);
> > > >
> > > > pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> > > > &pef2256_regmap_config);
> > > >
> > > > pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> > > > pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> > > > pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
> > > >
> > > > pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> > > > if (pef2256->reset_gpio) {
> > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> > > > udelay(10);
> > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> > > > udelay(10);
> > > > }
> > > >
> > > > pef2556_of_parse(pef2256, np);
> > > >
> > > > irq = platform_get_irq(pdev, 0);
> > > > ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
> > > >
> > > > platform_set_drvdata(pdev, pef2256);
> > > >
> > > > mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> > > > ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
> > >
> > > Wait, now you use MFD framework, so the driver is suitable for MFD.
> > > Before there was nothing like that in your code.
> >
> > Agree, the above is suitable for MFD, since it does all the things I
> > said your last one did not. You *can* also use of_platform_populate()
> > here, since you are *also* requesting and initialising shared resources.
> > You cannot do *both* however.
> >
>
> Thanks for having confirmed that this driver can be a MFD driver.
>
> Related to of_platform_populate() / mfd_add_devices(), I wanted to use both
> because:
> - the pinctrl part does not have (and does not need to have) a specific node
> with a specific compatible property. In order to instantiate the related
> driver mfd_add_devices() is the only way I know.
> - the audio component nodes have a compatible string and several components
> (ie several nodes) can be present. of_platform_populate() call seems the
> simple way to instantiate them.
>
> Is there a way to use mfd_add_devices() in this case without the need to
> count the audio component nodes in order to allocate as much mfd_cell as
> nodes having a matching compatible property ? Is there an other API to do
> it ?
>
I looked deeper for using mfd_add_devices() only and found an issue (related
to my use-case).
mfd_add_devices() calls mfd_add_device() and in this function we have:
---- 8< ----
if (IS_ENABLED(CONFIG_OF) && parent->of_node && cell->of_compatible) {
for_each_child_of_node(parent->of_node, np) {
if (of_device_is_compatible(np, cell->of_compatible)) {
/* Ignore 'disabled' devices error free */
if (!of_device_is_available(np)) {
of_node_put(np);
ret = 0;
goto fail_alias;
}
ret = mfd_match_of_node_to_dev(pdev, np, cell);
if (ret == -EAGAIN)
continue;
of_node_put(np);
if (ret)
goto fail_alias;
break;
}
}
if (!pdev->dev.of_node)
pr_warn("%s: Failed to locate of_node [id: %d]\n",
cell->name, platform_id);
}
---- 8< ----
My issue is related to the loop.
The loop is aborted if the device is not available (typically 'Disabled' in the
DT node).
My full pef2256 node can have several pef2256 audio subnodes with compatible
set to "lantiq,pef2256-codec" and some of them can have 'status = "Disabled";'
As soon as one device (with my expected compatible) is found 'Disabled', there
is no way to look at other children.
Having 'continue' in case of device not available in the loop to look at the
next child will change the behavior of mfd_add_device().
Do you think that looking at next child if we find a 'not available' child
can be correct for mfd_add_device() ?
This probably will have impacts on other MFD drivers.
Best regards,
Hervé
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-11 16:16 ` Herve Codina
@ 2023-04-12 9:59 ` Lee Jones
0 siblings, 0 replies; 45+ messages in thread
From: Lee Jones @ 2023-04-12 9:59 UTC (permalink / raw)
To: Herve Codina
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Takashi Iwai, linux-kernel, devicetree,
alsa-devel, Christophe Leroy, Thomas Petazzoni
On Tue, 11 Apr 2023, Herve Codina wrote:
> Hi Lee,
>
> On Wed, 5 Apr 2023 18:00:23 +0200
> Herve Codina <herve.codina@bootlin.com> wrote:
>
> > Hi Lee,
> > On Wed, 5 Apr 2023 14:54:50 +0100
> > Lee Jones <lee@kernel.org> wrote:
> >
> > > On Tue, 04 Apr 2023, Krzysztof Kozlowski wrote:
> > >
> > > > On 04/04/2023 10:07, Herve Codina wrote:
> > > >
> > > > >>> So, the structure I have in mind:
> > > > >>> - pef2256.c (MFD)
> > > > >>> implement and do the setup at probe()
> > > > >>> Add the children at probe():
> > > > >>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> > > > >>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> > > > >>>
> > > > >>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
> > > > >>
> > > > >> You do not use MFD here, so why do you want to keep it in MFD? If you
> > > > >> disagree, please tell me where is the MFD code in your patch?
> > > > >
> > > > > I don't want to absolutely use MFD.
> > > > > I just want to put my driver somewhere and I don't know the right location
> > > > > between MFD and Misc.
> > > > >
> > > > > Basically, the driver needs to do (little simplified and error path removed):
> > > > >
> > > > > static const struct mfd_cell pef2256_devs[] = {
> > > > > { .name = "lantiq-pef2256-pinctrl", },
> > > > > };
> > > > >
> > > > > static int pef2256_probe(struct platform_device *pdev)
> > > > > {
> > > > > struct pef2256 *pef2256;
> > > > > void __iomem *iomem;
> > > > > int ret;
> > > > > int irq;
> > > > >
> > > > > pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> > > > > if (!pef2256)
> > > > > return -ENOMEM;
> > > > >
> > > > > pef2256->dev = &pdev->dev;
> > > > >
> > > > > iomem = devm_platform_ioremap_resource(pdev, 0);
> > > > >
> > > > > pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> > > > > &pef2256_regmap_config);
> > > > >
> > > > > pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> > > > > pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> > > > > pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
> > > > >
> > > > > pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> > > > > if (pef2256->reset_gpio) {
> > > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> > > > > udelay(10);
> > > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> > > > > udelay(10);
> > > > > }
> > > > >
> > > > > pef2556_of_parse(pef2256, np);
> > > > >
> > > > > irq = platform_get_irq(pdev, 0);
> > > > > ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
> > > > >
> > > > > platform_set_drvdata(pdev, pef2256);
> > > > >
> > > > > mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> > > > > ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
> > > >
> > > > Wait, now you use MFD framework, so the driver is suitable for MFD.
> > > > Before there was nothing like that in your code.
> > >
> > > Agree, the above is suitable for MFD, since it does all the things I
> > > said your last one did not. You *can* also use of_platform_populate()
> > > here, since you are *also* requesting and initialising shared resources.
> > > You cannot do *both* however.
> > >
> >
> > Thanks for having confirmed that this driver can be a MFD driver.
> >
> > Related to of_platform_populate() / mfd_add_devices(), I wanted to use both
> > because:
> > - the pinctrl part does not have (and does not need to have) a specific node
> > with a specific compatible property. In order to instantiate the related
> > driver mfd_add_devices() is the only way I know.
> > - the audio component nodes have a compatible string and several components
> > (ie several nodes) can be present. of_platform_populate() call seems the
> > simple way to instantiate them.
> >
> > Is there a way to use mfd_add_devices() in this case without the need to
> > count the audio component nodes in order to allocate as much mfd_cell as
> > nodes having a matching compatible property ? Is there an other API to do
> > it ?
> >
>
> I looked deeper for using mfd_add_devices() only and found an issue (related
> to my use-case).
>
> mfd_add_devices() calls mfd_add_device() and in this function we have:
> ---- 8< ----
> if (IS_ENABLED(CONFIG_OF) && parent->of_node && cell->of_compatible) {
> for_each_child_of_node(parent->of_node, np) {
> if (of_device_is_compatible(np, cell->of_compatible)) {
> /* Ignore 'disabled' devices error free */
> if (!of_device_is_available(np)) {
> of_node_put(np);
> ret = 0;
> goto fail_alias;
> }
>
> ret = mfd_match_of_node_to_dev(pdev, np, cell);
> if (ret == -EAGAIN)
> continue;
> of_node_put(np);
> if (ret)
> goto fail_alias;
>
> break;
> }
> }
>
> if (!pdev->dev.of_node)
> pr_warn("%s: Failed to locate of_node [id: %d]\n",
> cell->name, platform_id);
> }
> ---- 8< ----
>
> My issue is related to the loop.
> The loop is aborted if the device is not available (typically 'Disabled' in the
> DT node).
>
> My full pef2256 node can have several pef2256 audio subnodes with compatible
> set to "lantiq,pef2256-codec" and some of them can have 'status = "Disabled";'
> As soon as one device (with my expected compatible) is found 'Disabled', there
> is no way to look at other children.
>
> Having 'continue' in case of device not available in the loop to look at the
> next child will change the behavior of mfd_add_device().
> Do you think that looking at next child if we find a 'not available' child
> can be correct for mfd_add_device() ?
> This probably will have impacts on other MFD drivers.
Looks like a bug. Encountering one disabled cell should not prevent the
others from registering IMHO.
--
Lee Jones [李琼斯]
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
@ 2023-04-12 9:59 ` Lee Jones
0 siblings, 0 replies; 45+ messages in thread
From: Lee Jones @ 2023-04-12 9:59 UTC (permalink / raw)
To: Herve Codina
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai,
linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
On Tue, 11 Apr 2023, Herve Codina wrote:
> Hi Lee,
>
> On Wed, 5 Apr 2023 18:00:23 +0200
> Herve Codina <herve.codina@bootlin.com> wrote:
>
> > Hi Lee,
> > On Wed, 5 Apr 2023 14:54:50 +0100
> > Lee Jones <lee@kernel.org> wrote:
> >
> > > On Tue, 04 Apr 2023, Krzysztof Kozlowski wrote:
> > >
> > > > On 04/04/2023 10:07, Herve Codina wrote:
> > > >
> > > > >>> So, the structure I have in mind:
> > > > >>> - pef2256.c (MFD)
> > > > >>> implement and do the setup at probe()
> > > > >>> Add the children at probe():
> > > > >>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> > > > >>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> > > > >>>
> > > > >>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
> > > > >>
> > > > >> You do not use MFD here, so why do you want to keep it in MFD? If you
> > > > >> disagree, please tell me where is the MFD code in your patch?
> > > > >
> > > > > I don't want to absolutely use MFD.
> > > > > I just want to put my driver somewhere and I don't know the right location
> > > > > between MFD and Misc.
> > > > >
> > > > > Basically, the driver needs to do (little simplified and error path removed):
> > > > >
> > > > > static const struct mfd_cell pef2256_devs[] = {
> > > > > { .name = "lantiq-pef2256-pinctrl", },
> > > > > };
> > > > >
> > > > > static int pef2256_probe(struct platform_device *pdev)
> > > > > {
> > > > > struct pef2256 *pef2256;
> > > > > void __iomem *iomem;
> > > > > int ret;
> > > > > int irq;
> > > > >
> > > > > pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> > > > > if (!pef2256)
> > > > > return -ENOMEM;
> > > > >
> > > > > pef2256->dev = &pdev->dev;
> > > > >
> > > > > iomem = devm_platform_ioremap_resource(pdev, 0);
> > > > >
> > > > > pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> > > > > &pef2256_regmap_config);
> > > > >
> > > > > pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> > > > > pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> > > > > pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
> > > > >
> > > > > pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> > > > > if (pef2256->reset_gpio) {
> > > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> > > > > udelay(10);
> > > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> > > > > udelay(10);
> > > > > }
> > > > >
> > > > > pef2556_of_parse(pef2256, np);
> > > > >
> > > > > irq = platform_get_irq(pdev, 0);
> > > > > ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
> > > > >
> > > > > platform_set_drvdata(pdev, pef2256);
> > > > >
> > > > > mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> > > > > ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
> > > >
> > > > Wait, now you use MFD framework, so the driver is suitable for MFD.
> > > > Before there was nothing like that in your code.
> > >
> > > Agree, the above is suitable for MFD, since it does all the things I
> > > said your last one did not. You *can* also use of_platform_populate()
> > > here, since you are *also* requesting and initialising shared resources.
> > > You cannot do *both* however.
> > >
> >
> > Thanks for having confirmed that this driver can be a MFD driver.
> >
> > Related to of_platform_populate() / mfd_add_devices(), I wanted to use both
> > because:
> > - the pinctrl part does not have (and does not need to have) a specific node
> > with a specific compatible property. In order to instantiate the related
> > driver mfd_add_devices() is the only way I know.
> > - the audio component nodes have a compatible string and several components
> > (ie several nodes) can be present. of_platform_populate() call seems the
> > simple way to instantiate them.
> >
> > Is there a way to use mfd_add_devices() in this case without the need to
> > count the audio component nodes in order to allocate as much mfd_cell as
> > nodes having a matching compatible property ? Is there an other API to do
> > it ?
> >
>
> I looked deeper for using mfd_add_devices() only and found an issue (related
> to my use-case).
>
> mfd_add_devices() calls mfd_add_device() and in this function we have:
> ---- 8< ----
> if (IS_ENABLED(CONFIG_OF) && parent->of_node && cell->of_compatible) {
> for_each_child_of_node(parent->of_node, np) {
> if (of_device_is_compatible(np, cell->of_compatible)) {
> /* Ignore 'disabled' devices error free */
> if (!of_device_is_available(np)) {
> of_node_put(np);
> ret = 0;
> goto fail_alias;
> }
>
> ret = mfd_match_of_node_to_dev(pdev, np, cell);
> if (ret == -EAGAIN)
> continue;
> of_node_put(np);
> if (ret)
> goto fail_alias;
>
> break;
> }
> }
>
> if (!pdev->dev.of_node)
> pr_warn("%s: Failed to locate of_node [id: %d]\n",
> cell->name, platform_id);
> }
> ---- 8< ----
>
> My issue is related to the loop.
> The loop is aborted if the device is not available (typically 'Disabled' in the
> DT node).
>
> My full pef2256 node can have several pef2256 audio subnodes with compatible
> set to "lantiq,pef2256-codec" and some of them can have 'status = "Disabled";'
> As soon as one device (with my expected compatible) is found 'Disabled', there
> is no way to look at other children.
>
> Having 'continue' in case of device not available in the loop to look at the
> next child will change the behavior of mfd_add_device().
> Do you think that looking at next child if we find a 'not available' child
> can be correct for mfd_add_device() ?
> This probably will have impacts on other MFD drivers.
Looks like a bug. Encountering one disabled cell should not prevent the
others from registering IMHO.
--
Lee Jones [李琼斯]
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-12 9:59 ` Lee Jones
(?)
@ 2023-04-13 6:31 ` Herve Codina
-1 siblings, 0 replies; 45+ messages in thread
From: Herve Codina @ 2023-04-13 6:31 UTC (permalink / raw)
To: Lee Jones
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai,
linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
On Wed, 12 Apr 2023 10:59:18 +0100
Lee Jones <lee@kernel.org> wrote:
> On Tue, 11 Apr 2023, Herve Codina wrote:
>
> > Hi Lee,
> >
> > On Wed, 5 Apr 2023 18:00:23 +0200
> > Herve Codina <herve.codina@bootlin.com> wrote:
> >
> > > Hi Lee,
> > > On Wed, 5 Apr 2023 14:54:50 +0100
> > > Lee Jones <lee@kernel.org> wrote:
> > >
> > > > On Tue, 04 Apr 2023, Krzysztof Kozlowski wrote:
> > > >
> > > > > On 04/04/2023 10:07, Herve Codina wrote:
> > > > >
> > > > > >>> So, the structure I have in mind:
> > > > > >>> - pef2256.c (MFD)
> > > > > >>> implement and do the setup at probe()
> > > > > >>> Add the children at probe():
> > > > > >>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> > > > > >>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> > > > > >>>
> > > > > >>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
> > > > > >>
> > > > > >> You do not use MFD here, so why do you want to keep it in MFD? If you
> > > > > >> disagree, please tell me where is the MFD code in your patch?
> > > > > >
> > > > > > I don't want to absolutely use MFD.
> > > > > > I just want to put my driver somewhere and I don't know the right location
> > > > > > between MFD and Misc.
> > > > > >
> > > > > > Basically, the driver needs to do (little simplified and error path removed):
> > > > > >
> > > > > > static const struct mfd_cell pef2256_devs[] = {
> > > > > > { .name = "lantiq-pef2256-pinctrl", },
> > > > > > };
> > > > > >
> > > > > > static int pef2256_probe(struct platform_device *pdev)
> > > > > > {
> > > > > > struct pef2256 *pef2256;
> > > > > > void __iomem *iomem;
> > > > > > int ret;
> > > > > > int irq;
> > > > > >
> > > > > > pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> > > > > > if (!pef2256)
> > > > > > return -ENOMEM;
> > > > > >
> > > > > > pef2256->dev = &pdev->dev;
> > > > > >
> > > > > > iomem = devm_platform_ioremap_resource(pdev, 0);
> > > > > >
> > > > > > pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> > > > > > &pef2256_regmap_config);
> > > > > >
> > > > > > pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> > > > > > pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> > > > > > pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
> > > > > >
> > > > > > pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> > > > > > if (pef2256->reset_gpio) {
> > > > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> > > > > > udelay(10);
> > > > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> > > > > > udelay(10);
> > > > > > }
> > > > > >
> > > > > > pef2556_of_parse(pef2256, np);
> > > > > >
> > > > > > irq = platform_get_irq(pdev, 0);
> > > > > > ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
> > > > > >
> > > > > > platform_set_drvdata(pdev, pef2256);
> > > > > >
> > > > > > mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> > > > > > ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
> > > > >
> > > > > Wait, now you use MFD framework, so the driver is suitable for MFD.
> > > > > Before there was nothing like that in your code.
> > > >
> > > > Agree, the above is suitable for MFD, since it does all the things I
> > > > said your last one did not. You *can* also use of_platform_populate()
> > > > here, since you are *also* requesting and initialising shared resources.
> > > > You cannot do *both* however.
> > > >
> > >
> > > Thanks for having confirmed that this driver can be a MFD driver.
> > >
> > > Related to of_platform_populate() / mfd_add_devices(), I wanted to use both
> > > because:
> > > - the pinctrl part does not have (and does not need to have) a specific node
> > > with a specific compatible property. In order to instantiate the related
> > > driver mfd_add_devices() is the only way I know.
> > > - the audio component nodes have a compatible string and several components
> > > (ie several nodes) can be present. of_platform_populate() call seems the
> > > simple way to instantiate them.
> > >
> > > Is there a way to use mfd_add_devices() in this case without the need to
> > > count the audio component nodes in order to allocate as much mfd_cell as
> > > nodes having a matching compatible property ? Is there an other API to do
> > > it ?
> > >
> >
> > I looked deeper for using mfd_add_devices() only and found an issue (related
> > to my use-case).
> >
> > mfd_add_devices() calls mfd_add_device() and in this function we have:
> > ---- 8< ----
> > if (IS_ENABLED(CONFIG_OF) && parent->of_node && cell->of_compatible) {
> > for_each_child_of_node(parent->of_node, np) {
> > if (of_device_is_compatible(np, cell->of_compatible)) {
> > /* Ignore 'disabled' devices error free */
> > if (!of_device_is_available(np)) {
> > of_node_put(np);
> > ret = 0;
> > goto fail_alias;
> > }
> >
> > ret = mfd_match_of_node_to_dev(pdev, np, cell);
> > if (ret == -EAGAIN)
> > continue;
> > of_node_put(np);
> > if (ret)
> > goto fail_alias;
> >
> > break;
> > }
> > }
> >
> > if (!pdev->dev.of_node)
> > pr_warn("%s: Failed to locate of_node [id: %d]\n",
> > cell->name, platform_id);
> > }
> > ---- 8< ----
> >
> > My issue is related to the loop.
> > The loop is aborted if the device is not available (typically 'Disabled' in the
> > DT node).
> >
> > My full pef2256 node can have several pef2256 audio subnodes with compatible
> > set to "lantiq,pef2256-codec" and some of them can have 'status = "Disabled";'
> > As soon as one device (with my expected compatible) is found 'Disabled', there
> > is no way to look at other children.
> >
> > Having 'continue' in case of device not available in the loop to look at the
> > next child will change the behavior of mfd_add_device().
> > Do you think that looking at next child if we find a 'not available' child
> > can be correct for mfd_add_device() ?
> > This probably will have impacts on other MFD drivers.
>
> Looks like a bug. Encountering one disabled cell should not prevent the
> others from registering IMHO.
>
Thanks for your confirmation.
I will propose a fix in the next iteration of this series.
Regards,
Hervé
^ permalink raw reply [flat|nested] 45+ messages in thread* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-12 9:59 ` Lee Jones
(?)
(?)
@ 2023-04-13 6:31 ` Herve Codina via Alsa-devel
-1 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-04-13 6:31 UTC (permalink / raw)
To: Lee Jones
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Takashi Iwai, linux-kernel, devicetree,
alsa-devel, Christophe Leroy, Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 10755 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Lee Jones <lee@kernel.org>
Cc: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Takashi Iwai <tiwai@suse.com>, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
Date: Thu, 13 Apr 2023 08:31:09 +0200
Message-ID: <20230413083109.5ad09d2a@bootlin.com>
On Wed, 12 Apr 2023 10:59:18 +0100
Lee Jones <lee@kernel.org> wrote:
> On Tue, 11 Apr 2023, Herve Codina wrote:
>
> > Hi Lee,
> >
> > On Wed, 5 Apr 2023 18:00:23 +0200
> > Herve Codina <herve.codina@bootlin.com> wrote:
> >
> > > Hi Lee,
> > > On Wed, 5 Apr 2023 14:54:50 +0100
> > > Lee Jones <lee@kernel.org> wrote:
> > >
> > > > On Tue, 04 Apr 2023, Krzysztof Kozlowski wrote:
> > > >
> > > > > On 04/04/2023 10:07, Herve Codina wrote:
> > > > >
> > > > > >>> So, the structure I have in mind:
> > > > > >>> - pef2256.c (MFD)
> > > > > >>> implement and do the setup at probe()
> > > > > >>> Add the children at probe():
> > > > > >>> - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> > > > > >>> - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> > > > > >>>
> > > > > >>> Lee, with this in mind, can the core pef2256.c be a MFD driver ?
> > > > > >>
> > > > > >> You do not use MFD here, so why do you want to keep it in MFD? If you
> > > > > >> disagree, please tell me where is the MFD code in your patch?
> > > > > >
> > > > > > I don't want to absolutely use MFD.
> > > > > > I just want to put my driver somewhere and I don't know the right location
> > > > > > between MFD and Misc.
> > > > > >
> > > > > > Basically, the driver needs to do (little simplified and error path removed):
> > > > > >
> > > > > > static const struct mfd_cell pef2256_devs[] = {
> > > > > > { .name = "lantiq-pef2256-pinctrl", },
> > > > > > };
> > > > > >
> > > > > > static int pef2256_probe(struct platform_device *pdev)
> > > > > > {
> > > > > > struct pef2256 *pef2256;
> > > > > > void __iomem *iomem;
> > > > > > int ret;
> > > > > > int irq;
> > > > > >
> > > > > > pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
> > > > > > if (!pef2256)
> > > > > > return -ENOMEM;
> > > > > >
> > > > > > pef2256->dev = &pdev->dev;
> > > > > >
> > > > > > iomem = devm_platform_ioremap_resource(pdev, 0);
> > > > > >
> > > > > > pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
> > > > > > &pef2256_regmap_config);
> > > > > >
> > > > > > pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
> > > > > > pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
> > > > > > pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
> > > > > >
> > > > > > pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
> > > > > > if (pef2256->reset_gpio) {
> > > > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
> > > > > > udelay(10);
> > > > > > gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
> > > > > > udelay(10);
> > > > > > }
> > > > > >
> > > > > > pef2556_of_parse(pef2256, np);
> > > > > >
> > > > > > irq = platform_get_irq(pdev, 0);
> > > > > > ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
> > > > > >
> > > > > > platform_set_drvdata(pdev, pef2256);
> > > > > >
> > > > > > mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
> > > > > > ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
> > > > >
> > > > > Wait, now you use MFD framework, so the driver is suitable for MFD.
> > > > > Before there was nothing like that in your code.
> > > >
> > > > Agree, the above is suitable for MFD, since it does all the things I
> > > > said your last one did not. You *can* also use of_platform_populate()
> > > > here, since you are *also* requesting and initialising shared resources.
> > > > You cannot do *both* however.
> > > >
> > >
> > > Thanks for having confirmed that this driver can be a MFD driver.
> > >
> > > Related to of_platform_populate() / mfd_add_devices(), I wanted to use both
> > > because:
> > > - the pinctrl part does not have (and does not need to have) a specific node
> > > with a specific compatible property. In order to instantiate the related
> > > driver mfd_add_devices() is the only way I know.
> > > - the audio component nodes have a compatible string and several components
> > > (ie several nodes) can be present. of_platform_populate() call seems the
> > > simple way to instantiate them.
> > >
> > > Is there a way to use mfd_add_devices() in this case without the need to
> > > count the audio component nodes in order to allocate as much mfd_cell as
> > > nodes having a matching compatible property ? Is there an other API to do
> > > it ?
> > >
> >
> > I looked deeper for using mfd_add_devices() only and found an issue (related
> > to my use-case).
> >
> > mfd_add_devices() calls mfd_add_device() and in this function we have:
> > ---- 8< ----
> > if (IS_ENABLED(CONFIG_OF) && parent->of_node && cell->of_compatible) {
> > for_each_child_of_node(parent->of_node, np) {
> > if (of_device_is_compatible(np, cell->of_compatible)) {
> > /* Ignore 'disabled' devices error free */
> > if (!of_device_is_available(np)) {
> > of_node_put(np);
> > ret = 0;
> > goto fail_alias;
> > }
> >
> > ret = mfd_match_of_node_to_dev(pdev, np, cell);
> > if (ret == -EAGAIN)
> > continue;
> > of_node_put(np);
> > if (ret)
> > goto fail_alias;
> >
> > break;
> > }
> > }
> >
> > if (!pdev->dev.of_node)
> > pr_warn("%s: Failed to locate of_node [id: %d]\n",
> > cell->name, platform_id);
> > }
> > ---- 8< ----
> >
> > My issue is related to the loop.
> > The loop is aborted if the device is not available (typically 'Disabled' in the
> > DT node).
> >
> > My full pef2256 node can have several pef2256 audio subnodes with compatible
> > set to "lantiq,pef2256-codec" and some of them can have 'status = "Disabled";'
> > As soon as one device (with my expected compatible) is found 'Disabled', there
> > is no way to look at other children.
> >
> > Having 'continue' in case of device not available in the loop to look at the
> > next child will change the behavior of mfd_add_device().
> > Do you think that looking at next child if we find a 'not available' child
> > can be correct for mfd_add_device() ?
> > This probably will have impacts on other MFD drivers.
>
> Looks like a bug. Encountering one disabled cell should not prevent the
> others from registering IMHO.
>
Thanks for your confirmation.
I will propose a fix in the next iteration of this series.
Regards,
Hervé
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-04 7:23 ` Krzysztof Kozlowski
(?)
(?)
@ 2023-04-04 8:07 ` Herve Codina via Alsa-devel
-1 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-04-04 8:07 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: Lee Jones, Rob Herring, Krzysztof Kozlowski, Liam Girdwood,
Mark Brown, Takashi Iwai, linux-kernel, devicetree, alsa-devel,
Christophe Leroy, Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 8211 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Cc: Lee Jones <lee@kernel.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Takashi Iwai <tiwai@suse.com>, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
Date: Tue, 4 Apr 2023 10:07:59 +0200
Message-ID: <20230404100759.5bc9cd20@bootlin.com>
On Tue, 4 Apr 2023 09:23:36 +0200
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> On 04/04/2023 09:20, Herve Codina wrote:
> >> I suggest that none of this (besides the child registration, which is
> >> achieved by a simple OF API call in this case) has anything to do with
> >> MFD. We are not requesting and initialising shared resources and we are
> >> not using the MFD API to register children. The pin control
> >> functionality clearly needs moving to Pinctrl and the rest, if you
> >> cannot find a suitable home for it *may be* suitable for Misc.
> >>
> >
> > I am confused and I am not really sure to understand where to put my driver.
> >
> > The core pef2256.c needs to:
> > 1) setup the pef2256
> > 2) add the children
> >
> > To add the children it calls devm_of_platform_populate() to add the audio
> > parts as several audio children can be available with the same compatible
> > string.
> >
> > I plan to move the pinctrl part to the pinctrl subsystem. With this done,
> > the core pef2256.c will probably add the children using:
> > - a mfd_cell for the pinctrl part
> > - devm_of_platform_populate() for the audio children
> >
> > The setup (E1 lines and TDM configuration) still needs to be done by the
> > core pef2256.c. Moving this part only to Misc will break the hierarchy.
> > The audio children depends on the core pef2256.c as this one do the setup.
> > Having in the audio children and the part that do the setup in same hierarchy
> > level is not correct. Audio children should be children of the part that do
> > the setup.
> >
> > So, the structure I have in mind:
> > - pef2256.c (MFD)
> > implement and do the setup at probe()
> > Add the children at probe():
> > - pef2256-pinctrl (pinctrl) added using mfd_add_devices()
> > - pef2256-codec (ASoC codec) added using devm_of_platform_populate()
> >
> > Lee, with this in mind, can the core pef2256.c be a MFD driver ?
>
> You do not use MFD here, so why do you want to keep it in MFD? If you
> disagree, please tell me where is the MFD code in your patch?
I don't want to absolutely use MFD.
I just want to put my driver somewhere and I don't know the right location
between MFD and Misc.
Basically, the driver needs to do (little simplified and error path removed):
static const struct mfd_cell pef2256_devs[] = {
{ .name = "lantiq-pef2256-pinctrl", },
};
static int pef2256_probe(struct platform_device *pdev)
{
struct pef2256 *pef2256;
void __iomem *iomem;
int ret;
int irq;
pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
if (!pef2256)
return -ENOMEM;
pef2256->dev = &pdev->dev;
iomem = devm_platform_ioremap_resource(pdev, 0);
pef2256->regmap = devm_regmap_init_mmio(&pdev->dev, iomem,
&pef2256_regmap_config);
pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
if (pef2256->reset_gpio) {
gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
udelay(10);
gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
udelay(10);
}
pef2556_of_parse(pef2256, np);
irq = platform_get_irq(pdev, 0);
ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
platform_set_drvdata(pdev, pef2256);
mfd_add_devices(pef2256->dev, PLATFORM_DEVID_NONE, pef2256_devs,
ARRAY_SIZE(pef2256_devs), NULL, 0, NULL);
pef2256_setup(pef2256);
devm_of_platform_populate(pef2256->dev);
return 0;
}
>
> Best regards,
> Krzysztof
>
--
Hervé Codina, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-04-03 14:28 ` Lee Jones
(?)
(?)
@ 2023-04-04 7:20 ` Herve Codina via Alsa-devel
-1 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-04-04 7:20 UTC (permalink / raw)
To: Lee Jones
Cc: Krzysztof Kozlowski, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Takashi Iwai, linux-kernel, devicetree,
alsa-devel, Christophe Leroy, Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 10527 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Lee Jones <lee@kernel.org>
Cc: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Takashi Iwai <tiwai@suse.com>, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
Date: Tue, 4 Apr 2023 09:20:36 +0200
Message-ID: <20230404092036.2d1cd5d9@bootlin.com>
Hi Lee,
On Mon, 3 Apr 2023 15:28:22 +0100
Lee Jones <lee@kernel.org> wrote:
> On Fri, 31 Mar 2023, Herve Codina wrote:
>
> > On Fri, 31 Mar 2023 15:44:19 +0200
> > Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> >
> > > On 31/03/2023 14:11, Herve Codina wrote:
> > > > Hi Krzysztof, Lee
> > > >
> > > > On Fri, 31 Mar 2023 11:13:30 +0200
> > > > Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> > > >
> > > >> On 31/03/2023 09:42, Herve Codina wrote:
> > > >>> Hi Lee,
> > > >>>
> > > >>> On Thu, 30 Mar 2023 17:05:10 +0100
> > > >>> Lee Jones <lee@kernel.org> wrote:
> > > >>>
> > > >>>> On Tue, 28 Mar 2023, 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.
> > > >>>>
> > > >>>> My goodness!
> > > >>>>
> > > >>>> It's been a long time since I've seen anything quite like this.
> > > >>>
> > > >>> Yes, old things but working on recent kernel.
> > > >>>
> > > >>>>
> > > >>>> My suggestion to you:
> > > >>>>
> > > >>>> * Split this up into components that fit functional subsystems
> > > >>>
> > > >>> It is done. The audio part is present in ASoC subsystem (path 5 in this
> > > >>> series). pinctrl function is implemented in this driver and, as I don't
> > > >>> want to share registers, I would prefer to keep this function inside this
> > > >>> driver.
> > > >>
> > > >> The amount of defines and huge functions like pef2256_setup_e1()
> > > >> contradict it.
> > > >>
> > > >> Even the pef2256_setup_e1() really does not follow Linux coding style -
> > > >> you know the size requirement, right?
> > > >
> > > > I know that pef2256_setup_e1() is quite big and I will look at a way
> > > > to split it in a consistent way.
> > > >
> > > >>
> > > >> pef2256_get_groups_count, struct pinmux_ops and others - this is
> > > >> pinctrl, not MFD! They cannot be in MFD driver.
> > > >
> > > > Maybe the issue is that MFD was not a good choice.
> > > > The "function" provided are not independent of each other.
> > > > The "main" driver (pef2256.c) needs to do the setup and handle the interrupt.
> > >
> > > Just like all PMICs...
> > >
> > > > The "function" provided are some glues in order to be used in some sub-systems
> > > > such as audio. Indeed, ASoC needs a codec DAI to be connected to a CPU DAI.
> > >
> > > Just like in all other cases...
> > >
> > > > These "functions" need to be started (ie probe()) after the pef2256 setup was
> > > > done. So a start (probe()) order relationship is needed.
> > >
> > > Just like in all other cases, so I really do not see here anything special.
> > >
> > > >
> > > > If a MFD driver needs independent children to handle independent functions,
> > > > the pef2256 does not fit well as a MFD driver.
> > >
> > > Why? So far everything is exactly the same.
> > >
> > > >
> > > > I switched from misc to MFD just to handle child DT nodes instead of having
> > > > phandles. Using child DT nodes instead of phandles is really a good thing and
> > > > need to be kept.
> > >
> > > Your DT bindings and nodes are not related to driver design. It does not
> > > matter for Devicetree if you put it to misc or MFD.
> > >
> > > It does not matter for driver whether you call it in Devicetree foo or bar.
> > >
> > > > The switch to MFD was probably not the best thing to do.
> > >
> > > Maybe, but your existing arguments are not really related...
> > >
> > > >
> > > > What do you think if I switched back the pef2256 "main" driver (pef2256.c) to
> > > > misc ?
> > >
> > > Why? What would it solve? You want to stuff pinctrl driver to misc, to
> > > avoid Lee's review? No. Pinctrl goes to pinctrl. Not to misc. Not to MFD.
> >
> > Just to be clear on that point, I do not want to avoid any reviews and Lee's
> > reviews are fully welcome.
> >
> > I just misunderstood. I thought the issue was that the pef2256 MFD driver has an
> > internal setup() and that the 'function' provided were not independent (they share
> > the pef2256 API).
> > My first feeling was that it was expected a kind of 'empty' driver for the pef2256
> > MFD driver. The pef2256 driver cannot be empty. That's why I talk about misc.
>
> It can be empty. That's what simple-mfd is for. :)
>
> I suggest that none of this (besides the child registration, which is
> achieved by a simple OF API call in this case) has anything to do with
> MFD. We are not requesting and initialising shared resources and we are
> not using the MFD API to register children. The pin control
> functionality clearly needs moving to Pinctrl and the rest, if you
> cannot find a suitable home for it *may be* suitable for Misc.
>
I am confused and I am not really sure to understand where to put my driver.
The core pef2256.c needs to:
1) setup the pef2256
2) add the children
To add the children it calls devm_of_platform_populate() to add the audio
parts as several audio children can be available with the same compatible
string.
I plan to move the pinctrl part to the pinctrl subsystem. With this done,
the core pef2256.c will probably add the children using:
- a mfd_cell for the pinctrl part
- devm_of_platform_populate() for the audio children
The setup (E1 lines and TDM configuration) still needs to be done by the
core pef2256.c. Moving this part only to Misc will break the hierarchy.
The audio children depends on the core pef2256.c as this one do the setup.
Having in the audio children and the part that do the setup in same hierarchy
level is not correct. Audio children should be children of the part that do
the setup.
So, the structure I have in mind:
- pef2256.c (MFD)
implement and do the setup at probe()
Add the children at probe():
- pef2256-pinctrl (pinctrl) added using mfd_add_devices()
- pef2256-codec (ASoC codec) added using devm_of_platform_populate()
Lee, with this in mind, can the core pef2256.c be a MFD driver ?
Best regards,
Hervé
--
Hervé Codina, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 45+ messages in thread
* Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-30 16:05 ` Lee Jones
(?)
(?)
@ 2023-03-31 7:42 ` Herve Codina via Alsa-devel
-1 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-03-31 7:42 UTC (permalink / raw)
To: Lee Jones
Cc: Rob Herring, Krzysztof Kozlowski, Liam Girdwood, Mark Brown,
Takashi Iwai, linux-kernel, devicetree, alsa-devel,
Christophe Leroy, Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 6347 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Lee Jones <lee@kernel.org>
Cc: Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Takashi Iwai <tiwai@suse.com>, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
Date: Fri, 31 Mar 2023 09:42:08 +0200
Message-ID: <20230331094208.41ab4420@bootlin.com>
Hi Lee,
On Thu, 30 Mar 2023 17:05:10 +0100
Lee Jones <lee@kernel.org> wrote:
> On Tue, 28 Mar 2023, 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.
>
> My goodness!
>
> It's been a long time since I've seen anything quite like this.
Yes, old things but working on recent kernel.
>
> My suggestion to you:
>
> * Split this up into components that fit functional subsystems
It is done. The audio part is present in ASoC subsystem (path 5 in this
series). pinctrl function is implemented in this driver and, as I don't
want to share registers, I would prefer to keep this function inside this
driver.
Also, I sent a RFC related to HDLC and PHY. In this RFC, the pef2256 is
considered as a PHY and handled in the PHY subsystem.
https://lore.kernel.org/linux-kernel/20230323103154.264546-1-herve.codina@bootlin.com/
> * Run checkpatch.pl
I did.
> * Remove all of the debug prints
I can do that in the next iteration if really needed.
> * Move all of the defines out to a header file
These defines are related to registers. As I don't want to share these
registers, is it really necessary to use a header file for them ?
> * Be more verbose in your documentation / comments
I can improve the API documentation present in include/mfd/pef2256.h.
Do you thing that is necessary ? Only a few devices will use this API.
> * Consider using simple-mfd to probe child devices.
I did.
The driver has (and needs to have) a compatible string.
Having this compatible string, sub-nodes are not automatically populated
in the device tree. In order to have them populated and probed, the pef2256
probe function ends calling devm_of_platform_populate().
Best regards,
Hervé
>
> > Signed-off-by: Herve Codina <herve.codina@bootlin.com>
> > ---
> > drivers/mfd/Kconfig | 17 +
> > drivers/mfd/Makefile | 1 +
> > drivers/mfd/pef2256.c | 1355 +++++++++++++++++++++++++++++++++++
> > include/linux/mfd/pef2256.h | 28 +
> > 4 files changed, 1401 insertions(+)
> > create mode 100644 drivers/mfd/pef2256.c
> > create mode 100644 include/linux/mfd/pef2256.h
>
> --
> Lee Jones [李琼斯]
^ permalink raw reply [flat|nested] 45+ messages in thread
* [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
2023-03-28 9:26 [PATCH v5 0/5] Add the Lantiq PEF2256 audio support Herve Codina
` (2 preceding siblings ...)
2023-03-28 9:26 ` [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer Herve Codina
@ 2023-03-28 9:26 ` Herve Codina via Alsa-devel
2023-03-28 9:26 ` [PATCH v5 3/5] Documentation: sysfs: Document the Lantiq PEF2256 sysfs entry Herve Codina via Alsa-devel
` (5 subsequent siblings)
9 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-03-28 9:26 UTC (permalink / raw)
To: Herve Codina, Lee Jones, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai
Cc: linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 54466 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Herve Codina <herve.codina@bootlin.com>, Lee Jones <lee@kernel.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Jaroslav Kysela <perex@perex.cz>, Takashi Iwai <tiwai@suse.com>
Cc: linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: [PATCH v5 2/5] mfd: Add support for the Lantiq PEF2256 framer
Date: Tue, 28 Mar 2023 11:26:42 +0200
Message-ID: <20230328092645.634375-3-herve.codina@bootlin.com>
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 <herve.codina@bootlin.com>
---
drivers/mfd/Kconfig | 17 +
drivers/mfd/Makefile | 1 +
drivers/mfd/pef2256.c | 1355 +++++++++++++++++++++++++++++++++++
include/linux/mfd/pef2256.h | 28 +
4 files changed, 1401 insertions(+)
create mode 100644 drivers/mfd/pef2256.c
create mode 100644 include/linux/mfd/pef2256.h
diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
index fcc141e067b9..74c3750d21e4 100644
--- a/drivers/mfd/Kconfig
+++ b/drivers/mfd/Kconfig
@@ -1063,6 +1063,23 @@ config PCF50633_GPIO
Say yes here if you want to include support GPIO for pins on
the PCF50633 chip.
+config MFD_PEF2256
+ tristate "Lantiq PEF2256 (FALC56) framer"
+ depends on OF
+ select PINCTRL
+ select PINMUX
+ select GENERIC_PINCONF
+ help
+ This option enables support for the Lantiq PEF2256 framer, also known
+ as FALC56. This framer and its line interface component is designed
+ to fulfill all required interfacing between analog E1/T1/J1 lines and
+ the digital PCM system highway.
+
+ If unsure, say N.
+
+ To compile this driver as a module, choose M here: the
+ module will be called pef2256.
+
config MFD_PM8XXX
tristate "Qualcomm PM8xxx PMIC chips driver"
depends on (ARM || HEXAGON || COMPILE_TEST)
diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
index 2f6c89d1e277..b2bb6e6a141c 100644
--- a/drivers/mfd/Makefile
+++ b/drivers/mfd/Makefile
@@ -195,6 +195,7 @@ obj-$(CONFIG_MFD_SI476X_CORE) += si476x-core.o
obj-$(CONFIG_MFD_CS5535) += cs5535-mfd.o
obj-$(CONFIG_MFD_OMAP_USB_HOST) += omap-usb-host.o omap-usb-tll.o
+obj-$(CONFIG_MFD_PEF2256) += pef2256.o
obj-$(CONFIG_MFD_PM8XXX) += qcom-pm8xxx.o ssbi.o
obj-$(CONFIG_MFD_QCOM_RPM) += qcom_rpm.o
obj-$(CONFIG_MFD_SPMI_PMIC) += qcom-spmi-pmic.o
diff --git a/drivers/mfd/pef2256.c b/drivers/mfd/pef2256.c
new file mode 100644
index 000000000000..1a3896c2edcf
--- /dev/null
+++ b/drivers/mfd/pef2256.c
@@ -0,0 +1,1355 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * PEF2256 also known as FALC56 driver
+ *
+ * Copyright 2023 CS GROUP France
+ *
+ * Author: Herve Codina <herve.codina@bootlin.com>
+ */
+
+#include <linux/mfd/pef2256.h>
+#include <linux/clk.h>
+#include <linux/gpio/consumer.h>
+#include <linux/interrupt.h>
+#include <linux/io.h>
+#include <linux/iopoll.h>
+#include <linux/module.h>
+#include <linux/notifier.h>
+#include <linux/of.h>
+#include <linux/of_platform.h>
+#include <linux/pinctrl/pinctrl.h>
+#include <linux/pinctrl/pinconf-generic.h>
+#include <linux/pinctrl/pinmux.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+
+#define PEF2256_CMDR 0x02 /* Command Register */
+#define PEF2256_CMDR_RRES BIT(6)
+#define PEF2256_CMDR_XRES BIT(4)
+#define PEF2256_CMDR_SRES BIT(0)
+#define PEF2256_IMR0 0x14 /* Interrupt Mask Register 0 */
+#define PEF2256_IMR1 0x15 /* Interrupt Mask Register 1 */
+#define PEF2256_IMR2 0x16 /* Interrupt Mask Register 2 */
+#define PEF2256_IMR3 0x17 /* Interrupt Mask Register 3 */
+#define PEF2256_IMR4 0x18 /* Interrupt Mask Register 4 */
+#define PEF2256_IMR5 0x19 /* Interrupt Mask Register 5 */
+#define PEF2256_FMR0 0x1C /* Framer Mode Register 0 */
+#define PEF2256_FMR0_XC_MASK (0x3 << 6)
+#define PEF2256_FMR0_XC_NRZ (0x0 << 6)
+#define PEF2256_FMR0_XC_CMI (0x1 << 6)
+#define PEF2256_FMR0_XC_AMI (0x2 << 6)
+#define PEF2256_FMR0_XC_HDB3 (0x3 << 6)
+#define PEF2256_FMR0_RC_MASK (0x3 << 4)
+#define PEF2256_FMR0_RC_NRZ (0x0 << 4)
+#define PEF2256_FMR0_RC_CMI (0x1 << 4)
+#define PEF2256_FMR0_RC_AMI (0x2 << 4)
+#define PEF2256_FMR0_RC_HDB3 (0x3 << 4)
+#define PEF2256_FMR1 0x1D /* Framer Mode Register 1 */
+#define PEF2256_FMR1_XFS BIT(3)
+#define PEF2256_FMR1_ECM BIT(2)
+/* SSD is defined on 2 bits. The other bit is on SIC1 register */
+#define PEF2256_FMR1_SSD_MASK BIT(1)
+#define PEF2256_FMR1_SSD_2048 0
+#define PEF2256_FMR1_SSD_4096 BIT(1)
+#define PEF2256_FMR1_SSD_8192 0
+#define PEF2256_FMR1_SSD_16384 BIT(1)
+#define PEF2256_FMR2 0x1E /* Framer Mode Register 2 */
+#define PEF2256_FMR2_RFS_MASK (0x3 << 6)
+#define PEF2256_FMR2_RFS_DOUBLEFRAME (0x0 << 6)
+#define PEF2256_FMR2_RFS_CRC4_MULTIFRAME (0x2 << 6)
+#define PEF2256_FMR2_RFS_AUTO_MULTIFRAME (0x3 << 6)
+#define PEF2256_FMR2_AXRA BIT(1)
+#define PEF2256_LOOP 0x1F /* Channel Loop-Back */
+#define PEF2256_XSW 0x20 /* Transmit Service Word */
+#define PEF2256_XSW_XSIS BIT(7)
+#define PEF2256_XSW_XTM BIT(6)
+#define PEF2256_XSW_XY_MASK (0x1f << 0)
+#define PEF2256_XSW_XY(_v) ((_v) & 0x1f)
+#define PEF2256_XSP 0x21 /* Transmit Spare Bits */
+#define PEF2256_XSP_XSIF BIT(2)
+#define PEF2256_XC0 0x22 /* Transmit Control 0 */
+#define PEF2256_XC1 0x23 /* Transmit Control 1 */
+#define PEF2256_RC0 0x24 /* Receive Control 0 */
+#define PEF2256_RC0_SWD BIT(7)
+#define PEF2256_RC0_ASY4 BIT(6)
+#define PEF2256_RC1 0x25 /* Receive Control 1 */
+#define PEF2256_XPM0 0x26 /* Transmit Pulse Mask 0 */
+#define PEF2256_XPM1 0x27 /* Transmit Pulse Mask 1 */
+#define PEF2256_XPM2 0x28 /* Transmit Pulse Mask 2 */
+#define PEF2256_XPM2_XLT BIT(6)
+#define PEF2256_TSWM 0x29 /* Transparent Service Word Mask */
+#define PEF2256_LIM0 0x36 /* Line Interface Mode 0 */
+#define PEF2256_2X_LIM0_BIT3 BIT(3) /* v2.x, described as a forced '1' bit */
+#define PEF2256_LIM0_MAS BIT(0)
+#define PEF2256_LIM1 0x37 /* Line Interface Mode 1 */
+#define PEF2256_12_LIM1_RIL_MASK (0x7 << 4)
+#define PEF2256_12_LIM1_RIL_910 (0x0 << 4)
+#define PEF2256_12_LIM1_RIL_740 (0x1 << 4)
+#define PEF2256_12_LIM1_RIL_590 (0x2 << 4)
+#define PEF2256_12_LIM1_RIL_420 (0x3 << 4)
+#define PEF2256_12_LIM1_RIL_320 (0x4 << 4)
+#define PEF2256_12_LIM1_RIL_210 (0x5 << 4)
+#define PEF2256_12_LIM1_RIL_160 (0x6 << 4)
+#define PEF2256_12_LIM1_RIL_100 (0x7 << 4)
+#define PEF2256_2X_LIM1_RIL_MASK (0x7 << 4)
+#define PEF2256_2X_LIM1_RIL_2250 (0x0 << 4)
+#define PEF2256_2X_LIM1_RIL_1100 (0x1 << 4)
+#define PEF2256_2X_LIM1_RIL_600 (0x2 << 4)
+#define PEF2256_2X_LIM1_RIL_350 (0x3 << 4)
+#define PEF2256_2X_LIM1_RIL_210 (0x4 << 4)
+#define PEF2256_2X_LIM1_RIL_140 (0x5 << 4)
+#define PEF2256_2X_LIM1_RIL_100 (0x6 << 4)
+#define PEF2256_2X_LIM1_RIL_50 (0x7 << 4)
+#define PEF2256_PCD 0x38 /* Pulse Count Detection */
+#define PEF2256_PCR 0x39 /* Pulse Count Recovery */
+#define PEF2256_LIM2 0x3A /* Line Interface Mode 2 */
+#define PEF2256_LIM2_SLT_MASK (0x3 << 4)
+#define PEF2256_LIM2_SLT_THR55 (0x0 << 4)
+#define PEF2256_LIM2_SLT_THR67 (0x1 << 4)
+#define PEF2256_LIM2_SLT_THR50 (0x2 << 4)
+#define PEF2256_LIM2_SLT_THR45 (0x3 << 4)
+#define PEF2256_LIM2_ELT BIT(2)
+#define PEF2256_SIC1 0x3E /* System Interface Control 1 */
+#define PEF2256_SIC1_SSC_MASK (BIT(7) | BIT(3))
+#define PEF2256_SIC1_SSC_2048 (0)
+#define PEF2256_SIC1_SSC_4096 BIT(3)
+#define PEF2256_SIC1_SSC_8192 BIT(7)
+#define PEF2256_SIC1_SSC_16384 (BIT(7) | BIT(3))
+/* SSD is defined on 2 bits. The other bit is on FMR1 register */
+#define PEF2256_SIC1_SSD_MASK BIT(6)
+#define PEF2256_SIC1_SSD_2048 0
+#define PEF2256_SIC1_SSD_4096 0
+#define PEF2256_SIC1_SSD_8192 BIT(6)
+#define PEF2256_SIC1_SSD_16384 BIT(6)
+#define PEF2256_SIC1_RBS_MASK (0x3 << 4)
+#define PEF2256_SIC1_RBS_2FRAMES (0x0 << 4)
+#define PEF2256_SIC1_RBS_1FRAME (0x1 << 4)
+#define PEF2256_SIC1_RBS_96BITS (0x2 << 4)
+#define PEF2256_SIC1_RBS_BYPASS (0x3 << 4)
+#define PEF2256_SIC1_XBS_MASK (0x3 << 0)
+#define PEF2256_SIC1_XBS_BYPASS (0x0 << 0)
+#define PEF2256_SIC1_XBS_1FRAME (0x1 << 0)
+#define PEF2256_SIC1_XBS_2FRAMES (0x2 << 0)
+#define PEF2256_SIC1_XBS_96BITS (0x3 << 0)
+#define PEF2256_SIC2 0x3F /* System Interface Control 2 */
+#define PEF2256_SIC2_SICS_MASK (0x7 << 1)
+#define PEF2256_SIC2_SICS(_v) ((_v) << 1)
+#define PEF2256_SIC3 0x40 /* System Interface Control 3 */
+#define PEF2256_SIC3_RTRI BIT(5)
+#define PEF2256_SIC3_RESX BIT(3)
+#define PEF2256_SIC3_RESR BIT(2)
+#define PEF2256_CMR1 0x44 /* Clock Mode Register 1 */
+#define PEF2256_CMR1_RS_MASK (0x3 << 4)
+#define PEF2256_CMR1_RS_DPLL (0x0 << 4)
+#define PEF2256_CMR1_RS_DPLL_LOS_HIGH (0x1 << 4)
+#define PEF2256_CMR1_RS_DCOR_2048 (0x2 << 4)
+#define PEF2256_CMR1_RS_DCOR_8192 (0x3 << 4)
+#define PEF2256_CMR1_DCS BIT(3)
+#define PEF2256_CMR2 0x45 /* Clock Mode Register 2 */
+#define PEF2256_CMR2_DCOXC BIT(5)
+#define PEF2256_GCR 0x46 /* Global Configuration Register */
+#define PEF2256_GCR_SCI BIT(6)
+#define PEF2256_GCR_ECMC BIT(4)
+#define PEF2256_PC1 0x80 /* Port Configuration 1 */
+#define PEF2256_PC2 0x81 /* Port Configuration 2 */
+#define PEF2256_PC3 0x82 /* Port Configuration 3 */
+#define PEF2256_PC4 0x83 /* Port Configuration 4 */
+#define PEF2256_12_PC_RPC_MASK (0x7 << 4)
+#define PEF2256_12_PC_RPC_SYPR (0x0 << 4)
+#define PEF2256_12_PC_RPC_RFM (0x1 << 4)
+#define PEF2256_12_PC_RPC_RFMB (0x2 << 4)
+#define PEF2256_12_PC_RPC_RSIGM (0x3 << 4)
+#define PEF2256_12_PC_RPC_RSIG (0x4 << 4)
+#define PEF2256_12_PC_RPC_DLR (0x5 << 4)
+#define PEF2256_12_PC_RPC_FREEZE (0x6 << 4)
+#define PEF2256_12_PC_RPC_RFSP (0x7 << 4)
+#define PEF2256_12_PC_XPC_MASK (0xf << 0)
+#define PEF2256_12_PC_XPC_SYPX (0x0 << 0)
+#define PEF2256_12_PC_XPC_XFMS (0x1 << 0)
+#define PEF2256_12_PC_XPC_XSIG (0x2 << 0)
+#define PEF2256_12_PC_XPC_TCLK (0x3 << 0)
+#define PEF2256_12_PC_XPC_XMFB (0x4 << 0)
+#define PEF2256_12_PC_XPC_XSIGM (0x5 << 0)
+#define PEF2256_12_PC_XPC_DLX (0x6 << 0)
+#define PEF2256_12_PC_XPC_XCLK (0x7 << 0)
+#define PEF2256_12_PC_XPC_XLT (0x8 << 0)
+#define PEF2256_2X_PC_RPC_MASK (0xf << 4)
+#define PEF2256_2X_PC_RPC_SYPR (0x0 << 4)
+#define PEF2256_2X_PC_RPC_RFM (0x1 << 4)
+#define PEF2256_2X_PC_RPC_RFMB (0x2 << 4)
+#define PEF2256_2X_PC_RPC_RSIGM (0x3 << 4)
+#define PEF2256_2X_PC_RPC_RSIG (0x4 << 4)
+#define PEF2256_2X_PC_RPC_DLR (0x5 << 4)
+#define PEF2256_2X_PC_RPC_FREEZE (0x6 << 4)
+#define PEF2256_2X_PC_RPC_RFSP (0x7 << 4)
+#define PEF2256_2X_PC_RPC_GPI (0x9 << 4)
+#define PEF2256_2X_PC_RPC_GPOH (0xa << 4)
+#define PEF2256_2X_PC_RPC_GPOL (0xb << 4)
+#define PEF2256_2X_PC_RPC_LOS (0xc << 4)
+#define PEF2256_2X_PC_XPC_MASK (0xf << 0)
+#define PEF2256_2X_PC_XPC_SYPX (0x0 << 0)
+#define PEF2256_2X_PC_XPC_XFMS (0x1 << 0)
+#define PEF2256_2X_PC_XPC_XSIG (0x2 << 0)
+#define PEF2256_2X_PC_XPC_TCLK (0x3 << 0)
+#define PEF2256_2X_PC_XPC_XMFB (0x4 << 0)
+#define PEF2256_2X_PC_XPC_XSIGM (0x5 << 0)
+#define PEF2256_2X_PC_XPC_DLX (0x6 << 0)
+#define PEF2256_2X_PC_XPC_XCLK (0x7 << 0)
+#define PEF2256_2X_PC_XPC_XLT (0x8 << 0)
+#define PEF2256_2X_PC_XPC_GPI (0x9 << 0)
+#define PEF2256_2X_PC_XPC_GPOH (0xa << 0)
+#define PEF2256_2X_PC_XPC_GPOL (0xb << 0)
+#define PEF2256_PC5 0x84 /* Port Configuration 5 */
+#define PEF2256_PC5_CRP BIT(0)
+#define PEF2256_GPC1 0x85 /* Global Port Configuration 1 */
+#define PEF2256_GPC1_CSFP_MASK (0x3 << 5)
+#define PEF2256_GPC1_CSFP_SEC_IN_HIGH (0x0 << 5)
+#define PEF2256_GPC1_CSFP_SEC_OUT_HIGH (0x1 << 5)
+#define PEF2256_GPC1_CSFP_FSC_OUT_HIGH (0x2 << 5)
+#define PEF2256_GPC1_CSFP_FSC_OUT_LOW (0x3 << 5)
+#define PEF2256_PC6 0x86 /* Port Configuration 6 */
+#define PEF2256_GCM(_n) (0x92 + (_n) - 1) /* Global Counter Mode n=1..8 */
+#define PEF2256_GCM1 0x92 /* Global Counter Mode 1 */
+#define PEF2256_GCM2 0x93 /* Global Counter Mode 2 */
+#define PEF2256_GCM3 0x94 /* Global Counter Mode 3 */
+#define PEF2256_GCM4 0x95 /* Global Counter Mode 4 */
+#define PEF2256_GCM5 0x96 /* Global Counter Mode 5 */
+#define PEF2256_GCM6 0x97 /* Global Counter Mode 6 */
+#define PEF2256_GCM7 0x98 /* Global Counter Mode 7 */
+#define PEF2256_GCM8 0x99 /* Global Counter Mode 8 */
+
+#define PEF2256_VSTR 0x4A /* Version Status Register */
+#define PEF2256_VSTR_VERSION_12 0x00
+#define PEF2256_VSTR_VERSION_21 0x10
+#define PEF2256_VSTR_VERSION_2x 0x05
+#define PEF2256_FRS0 0x4C /* Framer Receive Status 0 */
+#define PEF2256_FRS0_LOS BIT(7)
+#define PEF2256_FRS0_AIS BIT(6)
+#define PEF2256_ISR(_n) (0x68 + (_n)) /* Interrupt Status Register (n=0..5) */
+#define PEF2256_ISR0 0x68 /* Interrupt Status Register 0 */
+#define PEF2256_ISR1 0x69 /* Interrupt Status Register 1 */
+#define PEF2256_ISR2 0x6A /* Interrupt Status Register 2 */
+#define PEF2256_ISR3 0x6B /* Interrupt Status Register 3 */
+#define PEF2256_ISR4 0x6C /* Interrupt Status Register 4 */
+#define PEF2256_ISR5 0x6D /* Interrupt Status Register 5 */
+#define PEF2256_GIS 0x6E /* Global Interrupt Status */
+#define PEF2256_GIS_ISR(_n) (1 << (_n))
+#define PEF2256_WID 0xEC /* Wafer Identification Register */
+#define PEF2256_12_WID_MASK 0x03
+#define PEF2256_12_WID_VERSION_12 0x03
+#define PEF2256_2X_WID_MASK 0xc0
+#define PEF2256_2X_WID_VERSION_21 0x00
+#define PEF2256_2X_WID_VERSION_22 0x40
+
+/* IMR2/ISR2 Interrupts */
+#define PEF2256_INT2_AIS BIT(3)
+#define PEF2256_INT2_LOS BIT(2)
+
+enum pef2256_version {
+ PEF2256_VERSION_UNKNOWN,
+ PEF2256_VERSION_1_2,
+ PEF2256_VERSION_2_1,
+ PEF2256_VERSION_2_2,
+};
+
+enum pef2256_frame_type {
+ PEF2256_FRAME_E1_DOUBLEFRAME,
+ PEF2256_FRAME_E1_CRC4_MULTIFRAME,
+ PEF2256_FRAME_E1_AUTO_MULTIFRAME,
+ PEF2256_FRAME_T1J1_4FRAME,
+ PEF2256_FRAME_T1J1_12FRAME,
+ PEF2256_FRAME_T1J1_24FRAME,
+ PEF2256_FRAME_T1J1_72FRAME,
+};
+
+struct pef2256_pinreg_desc {
+ int offset;
+ u8 mask;
+};
+
+struct pef2256_function_desc {
+ const char *name;
+ const char * const*groups;
+ unsigned int ngroups;
+ u8 func_val;
+};
+
+struct pef2256 {
+ struct device *dev;
+ void *__iomem regs;
+ enum pef2256_version version;
+ struct clk *mclk;
+ struct clk *sclkr;
+ struct clk *sclkx;
+ struct gpio_desc *reset_gpio;
+ struct {
+ struct pinctrl_desc pctrl_desc;
+ const struct pef2256_function_desc *functions;
+ unsigned int nfunctions;
+ } pinctrl;
+ bool is_e1;
+ unsigned long sysclk_rate;
+ u32 data_rate;
+ bool is_tx_falling_edge;
+ bool is_subordinate;
+ enum pef2256_frame_type frame_type;
+ u8 channel_phase;
+ atomic_t carrier;
+ struct atomic_notifier_head event_notifier_list;
+};
+
+static inline u8 pef2256_read8(struct pef2256 *pef2256, int offset)
+{
+ return ioread8(pef2256->regs + offset);
+}
+
+static inline void pef2256_write8(struct pef2256 *pef2256, int offset, u8 val)
+{
+ iowrite8(val, pef2256->regs + offset);
+}
+
+static inline void pef2256_clrbits8(struct pef2256 *pef2256, int offset, u8 clr)
+{
+ pef2256_write8(pef2256, offset, pef2256_read8(pef2256, offset) & ~clr);
+}
+
+static inline void pef2256_setbits8(struct pef2256 *pef2256, int offset, u8 set)
+{
+ pef2256_write8(pef2256, offset, pef2256_read8(pef2256, offset) | set);
+}
+
+
+static inline void pef2256_clrsetbits8(struct pef2256 *pef2256, int offset, u8 clr, u8 set)
+{
+ u8 v;
+
+ v = pef2256_read8(pef2256, offset);
+ v &= ~clr;
+ v |= set;
+ pef2256_write8(pef2256, offset, v);
+}
+
+static enum pef2256_version pef2256_get_version(struct pef2256 *pef2256)
+{
+ enum pef2256_version version = PEF2256_VERSION_UNKNOWN;
+ const char *version_txt;
+ u8 vstr, wid;
+
+ vstr = pef2256_read8(pef2256, PEF2256_VSTR);
+ wid = pef2256_read8(pef2256, PEF2256_WID);
+
+ switch (vstr) {
+ case PEF2256_VSTR_VERSION_12:
+ if ((wid & PEF2256_12_WID_MASK) == PEF2256_12_WID_VERSION_12) {
+ version_txt = "1.2";
+ version = PEF2256_VERSION_1_2;
+ }
+ break;
+ case PEF2256_VSTR_VERSION_2x:
+ switch (wid & PEF2256_2X_WID_MASK) {
+ case PEF2256_2X_WID_VERSION_21:
+ version_txt = "2.1 (2.x)";
+ version = PEF2256_VERSION_2_1;
+ break;
+ case PEF2256_2X_WID_VERSION_22:
+ version_txt = "2.2 (2.x)";
+ version = PEF2256_VERSION_2_2;
+ break;
+ }
+ break;
+ case PEF2256_VSTR_VERSION_21:
+ version_txt = "2.1";
+ version = PEF2256_VERSION_2_1;
+ break;
+ }
+
+ if (version == PEF2256_VERSION_UNKNOWN)
+ dev_err(pef2256->dev, "Unknown version (0x%02x, 0x%02x)\n", vstr, wid);
+ else
+ dev_info(pef2256->dev, "Version %s detected\n", version_txt);
+
+ return version;
+}
+
+enum pef2256_gcm_config_item {
+ PEF2256_GCM_CONFIG_1544000 = 0,
+ PEF2256_GCM_CONFIG_2048000,
+ PEF2256_GCM_CONFIG_8192000,
+ PEF2256_GCM_CONFIG_10000000,
+ PEF2256_GCM_CONFIG_12352000,
+ PEF2256_GCM_CONFIG_16384000,
+};
+
+struct pef2256_gcm_config {
+ u8 gcm_12[6];
+ u8 gcm_2x[8];
+};
+
+static const struct pef2256_gcm_config pef2256_gcm_configs[] = {
+ [PEF2256_GCM_CONFIG_1544000] = {
+ .gcm_12 = {0xF0, 0x51, 0x00, 0x80, 0x00, 0x15},
+ .gcm_2x = {0x00, 0x15, 0x00, 0x08, 0x00, 0x3F, 0x9C, 0xDF},
+ },
+ [PEF2256_GCM_CONFIG_2048000] = {
+ .gcm_12 = {0x00, 0x58, 0xD2, 0xC2, 0x00, 0x10},
+ .gcm_2x = {0x00, 0x18, 0xFB, 0x0B, 0x00, 0x2F, 0xDB, 0xDF},
+ },
+ [PEF2256_GCM_CONFIG_8192000] = {
+ .gcm_12 = {0x00, 0x58, 0xD2, 0xC2, 0x03, 0x10},
+ .gcm_2x = {0x00, 0x18, 0xFB, 0x0B, 0x00, 0x0B, 0xDB, 0xDF},
+ },
+ [PEF2256_GCM_CONFIG_10000000] = {
+ .gcm_12 = {0x90, 0x51, 0x81, 0x8F, 0x04, 0x10},
+ .gcm_2x = {0x40, 0x1B, 0x3D, 0x0A, 0x00, 0x07, 0xC9, 0xDC},
+ },
+ [PEF2256_GCM_CONFIG_12352000] = {
+ .gcm_12 = {0xF0, 0x51, 0x00, 0x80, 0x07, 0x15},
+ .gcm_2x = {0x00, 0x19, 0x00, 0x08, 0x01, 0x0A, 0x98, 0xDA},
+ },
+ [PEF2256_GCM_CONFIG_16384000] = {
+ .gcm_12 = {0x00, 0x58, 0xD2, 0xC2, 0x07, 0x10},
+ .gcm_2x = {0x00, 0x18, 0xFB, 0x0B, 0x01, 0x0B, 0xDB, 0xDF},
+ },
+};
+
+static int pef2256_setup_gcm(struct pef2256 *pef2256)
+{
+ enum pef2256_gcm_config_item item;
+ unsigned long mclk_rate;
+ const u8 *gcm;
+ int i, count;
+
+ mclk_rate = clk_get_rate(pef2256->mclk);
+ switch (mclk_rate) {
+ case 1544000:
+ item = PEF2256_GCM_CONFIG_1544000;
+ break;
+ case 2048000:
+ item = PEF2256_GCM_CONFIG_2048000;
+ break;
+ case 8192000:
+ item = PEF2256_GCM_CONFIG_8192000;
+ break;
+ case 10000000:
+ item = PEF2256_GCM_CONFIG_10000000;
+ break;
+ case 12352000:
+ item = PEF2256_GCM_CONFIG_12352000;
+ break;
+ case 16384000:
+ item = PEF2256_GCM_CONFIG_16384000;
+ break;
+ default:
+ dev_err(pef2256->dev, "Unsupported v2.x MCLK rate %lu\n", mclk_rate);
+ return -EINVAL;
+ }
+
+ BUILD_BUG_ON(item >= ARRAY_SIZE(pef2256_gcm_configs));
+
+ if (pef2256->version == PEF2256_VERSION_1_2) {
+ gcm = pef2256_gcm_configs[item].gcm_12;
+ count = ARRAY_SIZE(pef2256_gcm_configs[item].gcm_12);
+ } else {
+ gcm = pef2256_gcm_configs[item].gcm_2x;
+ count = ARRAY_SIZE(pef2256_gcm_configs[item].gcm_2x);
+ }
+
+ for (i = 0; i < count; i++)
+ pef2256_write8(pef2256, PEF2256_GCM(i+1), *(gcm + i));
+
+ return 0;
+}
+
+static int pef2256_setup_e1(struct pef2256 *pef2256)
+{
+ u8 fmr1, fmr2, sic1;
+ int ret;
+
+ /* Basic setup, Master clocking mode (GCM8..1) */
+ ret = pef2256_setup_gcm(pef2256);
+ if (ret)
+ return ret;
+
+ /* RCLK output : DPLL clock, DCO-X enabled, DCO-X internal ref clock */
+ pef2256_write8(pef2256, PEF2256_CMR1, 0x00);
+
+ /*
+ * SCLKR selected, SCLKX selected,
+ * receive synchro pulse sourced by SYPR,
+ * transmit synchro pulse sourced by SYPX
+ */
+ pef2256_write8(pef2256, PEF2256_CMR2, 0x00);
+
+ /* NRZ coding, no alarm simulation */
+ pef2256_write8(pef2256, PEF2256_FMR0, 0x00);
+
+ /*
+ * E1, frame format, 2 Mbit/s system data rate, no AIS
+ * transmission to remote end or system interface, payload loop
+ * off, transmit remote alarm on
+ */
+ fmr1 = 0x00;
+ fmr2 = PEF2256_FMR2_AXRA;
+ switch (pef2256->frame_type) {
+ case PEF2256_FRAME_E1_DOUBLEFRAME:
+ fmr2 |= PEF2256_FMR2_RFS_DOUBLEFRAME;
+ break;
+ case PEF2256_FRAME_E1_CRC4_MULTIFRAME:
+ fmr1 |= PEF2256_FMR1_XFS;
+ fmr2 |= PEF2256_FMR2_RFS_CRC4_MULTIFRAME;
+ break;
+ case PEF2256_FRAME_E1_AUTO_MULTIFRAME:
+ fmr1 |= PEF2256_FMR1_XFS;
+ fmr2 |= PEF2256_FMR2_RFS_AUTO_MULTIFRAME;
+ break;
+ default:
+ dev_err(pef2256->dev, "Unsupported frame type %d\n", pef2256->frame_type);
+ return -EINVAL;
+ }
+ pef2256_write8(pef2256, PEF2256_FMR1, fmr1);
+ pef2256_write8(pef2256, PEF2256_FMR2, fmr2);
+
+ /* E1 default for the receive slicer threshold */
+ pef2256_write8(pef2256, PEF2256_LIM2, PEF2256_LIM2_SLT_THR50);
+ if (!pef2256->is_subordinate) {
+ /* SEC input, active high */
+ pef2256_write8(pef2256, PEF2256_GPC1, PEF2256_GPC1_CSFP_SEC_IN_HIGH);
+ } else {
+ /* Loop-timed */
+ pef2256_setbits8(pef2256, PEF2256_LIM2, PEF2256_LIM2_ELT);
+ /* FSC output, active high */
+ pef2256_write8(pef2256, PEF2256_GPC1, PEF2256_GPC1_CSFP_FSC_OUT_HIGH);
+ }
+
+ /* internal second timer, power on */
+ pef2256_write8(pef2256, PEF2256_GCR, 0x00);
+
+ /*
+ * slave mode, local loop off, mode short-haul
+ * In v2.x, bit3 is a forced 1 bit in the datasheet -> Need to be set.
+ */
+ if (pef2256->version == PEF2256_VERSION_1_2)
+ pef2256_write8(pef2256, PEF2256_LIM0, 0x00);
+ else
+ pef2256_write8(pef2256, PEF2256_LIM0, PEF2256_2X_LIM0_BIT3);
+
+ /* analog interface selected, remote loop off */
+ pef2256_write8(pef2256, PEF2256_LIM1, 0x00);
+
+ /*
+ * SCLKR, SCLKX, RCLK configured to inputs,
+ * XFMS active low, CLK1 and CLK2 pin configuration
+ */
+ pef2256_write8(pef2256, PEF2256_PC5, 0x00);
+ pef2256_write8(pef2256, PEF2256_PC6, 0x00);
+
+ /*
+ * 2.048 MHz system clocking rate, receive buffer 2 frames, transmit
+ * buffer bypass, data sampled and transmitted on the falling edge of
+ * SCLKR/X, automatic freeze signaling, data is active in the first
+ * channel phase
+ */
+ pef2256_write8(pef2256, PEF2256_SIC1, 0x00);
+ pef2256_write8(pef2256, PEF2256_SIC2, 0x00);
+ pef2256_write8(pef2256, PEF2256_SIC3, 0x00);
+
+ /* channel loop-back and single frame mode are disabled */
+ pef2256_write8(pef2256, PEF2256_LOOP, 0x00);
+
+ /* all bits of the transmitted service word are cleared */
+ pef2256_write8(pef2256, PEF2256_XSW, PEF2256_XSW_XY(0x1F));
+ /* CAS disabled and clear spare bit values */
+ pef2256_write8(pef2256, PEF2256_XSP, 0x00);
+
+ /* no transparent mode active */
+ pef2256_write8(pef2256, PEF2256_TSWM, 0x00);
+
+ /*
+ * the transmit clock offset is cleared
+ * the transmit time slot offset is cleared
+ */
+ pef2256_write8(pef2256, PEF2256_XC0, 0x00);
+
+ /* Keep default value for the transmit offset */
+ pef2256_write8(pef2256, PEF2256_XC1, 0x9C);
+
+ /*
+ * transmit pulse mask, default value from datasheet
+ * transmitter in tristate mode
+ */
+ if (pef2256->version == PEF2256_VERSION_1_2)
+ pef2256_write8(pef2256, PEF2256_XPM0, 0x7B);
+ else
+ pef2256_write8(pef2256, PEF2256_XPM0, 0x9C);
+ pef2256_write8(pef2256, PEF2256_XPM1, 0x03);
+ pef2256_write8(pef2256, PEF2256_XPM2, PEF2256_XPM2_XLT | 0x00);
+
+ /* "master" mode */
+ if (!pef2256->is_subordinate)
+ pef2256_setbits8(pef2256, PEF2256_LIM0, PEF2256_LIM0_MAS);
+
+ /* transmit line in normal operation */
+ pef2256_clrbits8(pef2256, PEF2256_XPM2, PEF2256_XPM2_XLT);
+
+ /* receive input threshold = 0,21V */
+ if (pef2256->version == PEF2256_VERSION_1_2)
+ pef2256_clrsetbits8(pef2256, PEF2256_LIM1, PEF2256_12_LIM1_RIL_MASK,
+ PEF2256_12_LIM1_RIL_210);
+ else
+ pef2256_clrsetbits8(pef2256, PEF2256_LIM1, PEF2256_2X_LIM1_RIL_MASK,
+ PEF2256_2X_LIM1_RIL_210);
+
+ /* transmit line coding = HDB3 */
+ pef2256_clrsetbits8(pef2256, PEF2256_FMR0, PEF2256_FMR0_XC_MASK, PEF2256_FMR0_XC_HDB3);
+
+ /* receive line coding = HDB3 */
+ pef2256_clrsetbits8(pef2256, PEF2256_FMR0, PEF2256_FMR0_RC_MASK, PEF2256_FMR0_RC_HDB3);
+
+ /* detection of LOS alarm = 176 pulses (ie (10 + 1) * 16) */
+ pef2256_write8(pef2256, PEF2256_PCD, 10);
+
+ /* recovery of LOS alarm = 22 pulses (ie 21 + 1) */
+ pef2256_write8(pef2256, PEF2256_PCR, 21);
+
+ /* DCO-X center frequency enabled */
+ pef2256_setbits8(pef2256, PEF2256_CMR2, PEF2256_CMR2_DCOXC);
+
+ if (pef2256->is_subordinate) {
+ /* select RCLK source = 2M, disable switching from RCLK to SYNC */
+ pef2256_clrsetbits8(pef2256, PEF2256_CMR1, PEF2256_CMR1_RS_MASK,
+ PEF2256_CMR1_RS_DCOR_2048);
+ pef2256_setbits8(pef2256, PEF2256_CMR1, PEF2256_CMR1_DCS);
+
+ /* transmit buffer size = 2 frames, transparent mode */
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC1, PEF2256_SIC1_XBS_MASK,
+ PEF2256_SIC1_XBS_2FRAMES);
+ pef2256_setbits8(pef2256, PEF2256_XSW, PEF2256_XSW_XTM);
+ }
+
+ if (pef2256->version != PEF2256_VERSION_1_2) {
+ /* during inactive channel phase switch RDO/RSIG into tri-state */
+ pef2256_setbits8(pef2256, PEF2256_SIC3, PEF2256_SIC3_RTRI);
+ }
+
+ if (pef2256->is_tx_falling_edge) {
+ /* falling edge sync pulse transmit, rising edge sync pulse receive */
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC3, PEF2256_SIC3_RESX, PEF2256_SIC3_RESR);
+ } else {
+ /* rising edge sync pulse transmit, falling edge sync pulse receive */
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC3, PEF2256_SIC3_RESR, PEF2256_SIC3_RESX);
+ }
+
+ /* transmit offset counter (XCO10..0) = 4 */
+ pef2256_write8(pef2256, PEF2256_XC0, 0);
+ pef2256_write8(pef2256, PEF2256_XC1, 4);
+ /* receive offset counter (RCO10..0) = 4 */
+ pef2256_write8(pef2256, PEF2256_RC0, 0);
+ pef2256_write8(pef2256, PEF2256_RC1, 4);
+
+ /* system clock rate */
+ switch (pef2256->sysclk_rate) {
+ case 2048000:
+ sic1 = PEF2256_SIC1_SSC_2048;
+ break;
+ case 4096000:
+ sic1 = PEF2256_SIC1_SSC_4096;
+ break;
+ case 8192000:
+ sic1 = PEF2256_SIC1_SSC_8192;
+ break;
+ case 16384000:
+ sic1 = PEF2256_SIC1_SSC_16384;
+ break;
+ default:
+ dev_err(pef2256->dev, "Unsupported sysclk rate %lu\n", pef2256->sysclk_rate);
+ return -EINVAL;
+ }
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC1, PEF2256_SIC1_SSC_MASK, sic1);
+
+ /* data clock rate */
+ switch (pef2256->data_rate) {
+ case 2048000:
+ fmr1 = PEF2256_FMR1_SSD_2048;
+ sic1 = PEF2256_SIC1_SSD_2048;
+ break;
+ case 4096000:
+ fmr1 = PEF2256_FMR1_SSD_4096;
+ sic1 = PEF2256_SIC1_SSD_4096;
+ break;
+ case 8192000:
+ fmr1 = PEF2256_FMR1_SSD_8192;
+ sic1 = PEF2256_SIC1_SSD_8192;
+ break;
+ case 16384000:
+ fmr1 = PEF2256_FMR1_SSD_16384;
+ sic1 = PEF2256_SIC1_SSD_16384;
+ break;
+ default:
+ dev_err(pef2256->dev, "Unsupported data rate %u\n", pef2256->data_rate);
+ return -EINVAL;
+ }
+ pef2256_clrsetbits8(pef2256, PEF2256_FMR1, PEF2256_FMR1_SSD_MASK, fmr1);
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC1, PEF2256_SIC1_SSD_MASK, sic1);
+
+ /* channel phase */
+ pef2256_clrsetbits8(pef2256, PEF2256_SIC2, PEF2256_SIC2_SICS_MASK,
+ PEF2256_SIC2_SICS(pef2256->channel_phase));
+
+ /* error counter latched every 1s */
+ pef2256_setbits8(pef2256, PEF2256_FMR1, PEF2256_FMR1_ECM);
+ /* error counter mode COFA */
+ pef2256_setbits8(pef2256, PEF2256_GCR, PEF2256_GCR_ECMC);
+ /* errors in service words have no influence */
+ pef2256_setbits8(pef2256, PEF2256_RC0, PEF2256_RC0_SWD);
+ /* 4 consecutive incorrect FAS causes loss of sync */
+ pef2256_setbits8(pef2256, PEF2256_RC0, PEF2256_RC0_ASY4);
+ /* Si-Bit, Spare bit For International, FAS word */
+ pef2256_setbits8(pef2256, PEF2256_XSW, PEF2256_XSW_XSIS);
+ pef2256_setbits8(pef2256, PEF2256_XSP, PEF2256_XSP_XSIF);
+
+ /* port RCLK is output */
+ pef2256_setbits8(pef2256, PEF2256_PC5, PEF2256_PC5_CRP);
+ /* status changed interrupt at both up and down */
+ pef2256_setbits8(pef2256, PEF2256_GCR, PEF2256_GCR_SCI);
+
+ /* Clear any ISR2 pending interrupts and unmask needed interrupts */
+ pef2256_read8(pef2256, PEF2256_ISR2);
+ pef2256_clrbits8(pef2256, PEF2256_IMR2, PEF2256_INT2_LOS | PEF2256_INT2_AIS);
+
+ /* reset lines */
+ pef2256_write8(pef2256, PEF2256_CMDR, PEF2256_CMDR_RRES | PEF2256_CMDR_XRES);
+ return 0;
+}
+
+static int pef2256_setup(struct pef2256 *pef2256)
+{
+ if (pef2256->is_e1)
+ return pef2256_setup_e1(pef2256);
+
+ dev_err(pef2256->dev, "Only E1 line is currently supported\n");
+ return -EOPNOTSUPP;
+}
+
+
+
+static void pef2256_isr_default_handler(struct pef2256 *pef2256, u8 nbr, u8 isr)
+{
+ dev_warn(pef2256->dev, "ISR%u: 0x%02x not handled\n", nbr, isr);
+}
+
+static bool pef2256_is_carrier_on(struct pef2256 *pef2256)
+{
+ u8 frs0;
+
+ frs0 = pef2256_read8(pef2256, PEF2256_FRS0);
+ return !(frs0 & (PEF2256_FRS0_LOS | PEF2256_FRS0_AIS));
+}
+
+static void pef2256_isr2_handler(struct pef2256 *pef2256, u8 nbr, u8 isr)
+{
+ bool carrier;
+
+ if (isr & (PEF2256_INT2_LOS | PEF2256_INT2_AIS)) {
+ carrier = pef2256_is_carrier_on(pef2256);
+ if (atomic_xchg(&pef2256->carrier, carrier) != carrier)
+ atomic_notifier_call_chain(&pef2256->event_notifier_list,
+ PEF2256_EVENT_CARRIER, NULL);
+ }
+}
+
+static irqreturn_t pef2256_irq_handler(int irq, void *priv)
+{
+ void (*pef2256_isr_handler[])(struct pef2256 *, u8, u8) = {
+ [0] = pef2256_isr_default_handler,
+ [1] = pef2256_isr_default_handler,
+ [2] = pef2256_isr2_handler,
+ [3] = pef2256_isr_default_handler,
+ [4] = pef2256_isr_default_handler,
+ [5] = pef2256_isr_default_handler
+ };
+ struct pef2256 *pef2256 = (struct pef2256 *)priv;
+ u8 gis;
+ u8 isr;
+ u8 n;
+
+ gis = pef2256_read8(pef2256, PEF2256_GIS);
+
+ for (n = 0; n < ARRAY_SIZE(pef2256_isr_handler) ; n++) {
+ if (gis & PEF2256_GIS_ISR(n)) {
+ isr = pef2256_read8(pef2256, PEF2256_ISR(n));
+ pef2256_isr_handler[n](pef2256, n, isr);
+ }
+ }
+
+ return IRQ_HANDLED;
+}
+
+static int pef2256_check_rates(struct pef2256 *pef2256, unsigned long sysclk_rate,
+ unsigned long data_rate)
+{
+ unsigned long rate;
+
+ switch (sysclk_rate) {
+ case 2048000:
+ case 4096000:
+ case 8192000:
+ case 16384000:
+ break;
+ default:
+ dev_err(pef2256->dev, "Unsupported system clock rate %lu\n", sysclk_rate);
+ return -EINVAL;
+ }
+
+ for (rate = data_rate; rate <= data_rate * 4; rate *= 2) {
+ if (rate == sysclk_rate)
+ return 0;
+ }
+ dev_err(pef2256->dev, "Unsupported data rate %lu with system clock rate %lu\n",
+ data_rate, sysclk_rate);
+ return -EINVAL;
+}
+
+static int pef2556_of_parse(struct pef2256 *pef2256, struct device_node *np)
+{
+ const char *str;
+ int ret;
+
+ str = "e1";
+ ret = of_property_read_string(np, "lantiq,line-interface", &str);
+ if (ret && ret != -EINVAL) {
+ dev_err(pef2256->dev, "%pOF: failed to read lantiq,line-interface\n",
+ np);
+ return ret;
+ }
+ if (!strcmp(str, "e1")) {
+ pef2256->is_e1 = true;
+ } else if (!strcmp(str, "t1j1")) {
+ pef2256->is_e1 = false;
+ } else {
+ dev_err(pef2256->dev, "%pOF: Invalid lantiq,line-interface (%s)\n",
+ np, str);
+ return -EINVAL;
+ }
+ dev_dbg(pef2256->dev, "config: %s line\n", pef2256->is_e1 ? "E1" : "T1/J1");
+
+ pef2256->data_rate = 2048000;
+ ret = of_property_read_u32(np, "lantiq,data-rate-bps", &pef2256->data_rate);
+ if (ret && ret != -EINVAL) {
+ dev_err(pef2256->dev, "%pOF: failed to read lantiq,data-rate-bps\n", np);
+ return ret;
+ }
+ dev_dbg(pef2256->dev, "config: data rate %u bps\n", pef2256->data_rate);
+
+ ret = pef2256_check_rates(pef2256, pef2256->sysclk_rate, pef2256->data_rate);
+ if (ret)
+ return ret;
+
+ pef2256->is_tx_falling_edge = of_property_read_bool(np, "lantiq,clock-falling-edge");
+ dev_dbg(pef2256->dev, "config: tx on %s edge\n",
+ pef2256->is_tx_falling_edge ? "falling" : "rising");
+
+ pef2256->is_subordinate = of_property_read_bool(np, "lantiq,subordinate");
+ dev_dbg(pef2256->dev, "config: subordinate %s\n",
+ pef2256->is_subordinate ? "on" : "off");
+
+ str = pef2256->is_e1 ? "doubleframe" : "12frame";
+ ret = of_property_read_string(np, "lantiq,frame-format", &str);
+ if (ret && ret != -EINVAL) {
+ dev_err(pef2256->dev, "%pOF: failed to read lantiq,frame-format\n",
+ np);
+ return ret;
+ }
+ if (pef2256->is_e1) {
+ if (!strcmp(str, "doubleframe")) {
+ pef2256->frame_type = PEF2256_FRAME_E1_DOUBLEFRAME;
+ } else if (!strcmp(str, "crc4-multiframe")) {
+ pef2256->frame_type = PEF2256_FRAME_E1_CRC4_MULTIFRAME;
+ } else if (!strcmp(str, "auto-multiframe")) {
+ pef2256->frame_type = PEF2256_FRAME_E1_AUTO_MULTIFRAME;
+ } else {
+ dev_err(pef2256->dev, "%pOF: Invalid lantiq,frame-format (%s)\n",
+ np, str);
+ return -EINVAL;
+ }
+ } else {
+ if (!strcmp(str, "4frame")) {
+ pef2256->frame_type = PEF2256_FRAME_T1J1_4FRAME;
+ } else if (!strcmp(str, "12frame")) {
+ pef2256->frame_type = PEF2256_FRAME_T1J1_12FRAME;
+ } else if (!strcmp(str, "24frame")) {
+ pef2256->frame_type = PEF2256_FRAME_T1J1_24FRAME;
+ } else if (!strcmp(str, "72frame")) {
+ pef2256->frame_type = PEF2256_FRAME_T1J1_72FRAME;
+ } else {
+ dev_err(pef2256->dev, "%pOF: Invalid lantiq,frame-format (%s)\n",
+ np, str);
+ return -EINVAL;
+ }
+ }
+ dev_dbg(pef2256->dev, "config: frame type %d\n", pef2256->frame_type);
+
+ pef2256->channel_phase = 0;
+ ret = of_property_read_u8(np, "lantiq,channel-phase", &pef2256->channel_phase);
+ if (ret && ret != -EINVAL) {
+ dev_err(pef2256->dev, "%pOF: failed to read lantiq,channel-phase\n",
+ np);
+ return ret;
+ }
+ if (pef2256->channel_phase >= pef2256->sysclk_rate / pef2256->data_rate) {
+ dev_err(pef2256->dev, "%pOF: Invalid lantiq,channel-phase %u\n",
+ np, pef2256->channel_phase);
+ return -EINVAL;
+ }
+ dev_dbg(pef2256->dev, "config: channel phase %u\n", pef2256->channel_phase);
+
+ return 0;
+}
+
+static int pef2256_get_groups_count(struct pinctrl_dev *pctldev)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ /* We map 1 group <-> 1 pin */
+ return pef2256->pinctrl.pctrl_desc.npins;
+}
+
+static const char *pef2256_get_group_name(struct pinctrl_dev *pctldev,
+ unsigned int selector)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ /* We map 1 group <-> 1 pin */
+ return pef2256->pinctrl.pctrl_desc.pins[selector].name;
+}
+
+static int pef2256_get_group_pins(struct pinctrl_dev *pctldev, unsigned int selector,
+ const unsigned int **pins,
+ unsigned int *num_pins)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ /* We map 1 group <-> 1 pin */
+ *pins = &pef2256->pinctrl.pctrl_desc.pins[selector].number;
+ *num_pins = 1;
+
+ return 0;
+}
+
+static const struct pinctrl_ops pef2256_pctlops = {
+ .get_groups_count = pef2256_get_groups_count,
+ .get_group_name = pef2256_get_group_name,
+ .get_group_pins = pef2256_get_group_pins,
+ .dt_node_to_map = pinconf_generic_dt_node_to_map_pin,
+ .dt_free_map = pinconf_generic_dt_free_map,
+};
+
+static int pef2256_get_functions_count(struct pinctrl_dev *pctldev)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ return pef2256->pinctrl.nfunctions;
+}
+
+static const char *pef2256_get_function_name(struct pinctrl_dev *pctldev,
+ unsigned int selector)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ return pef2256->pinctrl.functions[selector].name;
+}
+
+
+static int pef2256_get_function_groups(struct pinctrl_dev *pctldev, unsigned int selector,
+ const char * const **groups,
+ unsigned * const num_groups)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+
+ *groups = pef2256->pinctrl.functions[selector].groups;
+ *num_groups = pef2256->pinctrl.functions[selector].ngroups;
+ return 0;
+}
+
+static int pef2256_set_mux(struct pinctrl_dev *pctldev, unsigned int func_selector,
+ unsigned int group_selector)
+{
+ struct pef2256 *pef2256 = pinctrl_dev_get_drvdata(pctldev);
+ const struct pef2256_pinreg_desc *pinreg_desc;
+ u8 func_val;
+
+ dev_dbg(pef2256->dev, "set %s to %s function\n",
+ pef2256->pinctrl.pctrl_desc.pins[group_selector].name,
+ pef2256->pinctrl.functions[func_selector].name);
+
+ /* We map 1 group <-> 1 pin */
+ pinreg_desc = pef2256->pinctrl.pctrl_desc.pins[group_selector].drv_data;
+ func_val = pef2256->pinctrl.functions[func_selector].func_val;
+
+ pef2256_clrsetbits8(pef2256, pinreg_desc->offset, pinreg_desc->mask,
+ func_val & pinreg_desc->mask);
+
+ return 0;
+}
+
+static const struct pinmux_ops pef2256_pmxops = {
+ .get_functions_count = pef2256_get_functions_count,
+ .get_function_name = pef2256_get_function_name,
+ .get_function_groups = pef2256_get_function_groups,
+ .set_mux = pef2256_set_mux,
+};
+
+#define PEF2256_PINCTRL_PIN(_number, _name, _offset, _mask) { \
+ .number = _number, \
+ .name = _name, \
+ .drv_data = &(struct pef2256_pinreg_desc) { \
+ .offset = _offset, \
+ .mask = _mask, \
+ }, \
+}
+
+static const struct pinctrl_pin_desc pef2256_v12_pins[] = {
+ PEF2256_PINCTRL_PIN(0, "RPA", PEF2256_PC1, PEF2256_12_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(1, "RPB", PEF2256_PC2, PEF2256_12_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(2, "RPC", PEF2256_PC3, PEF2256_12_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(3, "RPD", PEF2256_PC4, PEF2256_12_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(4, "XPA", PEF2256_PC1, PEF2256_12_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(5, "XPB", PEF2256_PC2, PEF2256_12_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(6, "XPC", PEF2256_PC3, PEF2256_12_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(7, "XPD", PEF2256_PC4, PEF2256_12_PC_XPC_MASK),
+};
+
+static const struct pinctrl_pin_desc pef2256_v2x_pins[] = {
+ PEF2256_PINCTRL_PIN(0, "RPA", PEF2256_PC1, PEF2256_2X_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(1, "RPB", PEF2256_PC2, PEF2256_2X_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(2, "RPC", PEF2256_PC3, PEF2256_2X_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(3, "RPD", PEF2256_PC4, PEF2256_2X_PC_RPC_MASK),
+ PEF2256_PINCTRL_PIN(4, "XPA", PEF2256_PC1, PEF2256_2X_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(5, "XPB", PEF2256_PC2, PEF2256_2X_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(6, "XPC", PEF2256_PC3, PEF2256_2X_PC_XPC_MASK),
+ PEF2256_PINCTRL_PIN(7, "XPD", PEF2256_PC4, PEF2256_2X_PC_XPC_MASK),
+};
+
+static const char *const pef2256_rp_groups[] = { "RPA", "RPB", "RPC", "RPD" };
+static const char *const pef2256_xp_groups[] = { "XPA", "XPB", "XPC", "XPD" };
+static const char *const pef2256_all_groups[] = { "RPA", "RPB", "RPC", "RPD",
+ "XPA", "XPB", "XPC", "XPD" };
+
+#define PEF2256_FUNCTION(_name, _func_val, _groups) { \
+ .name = _name, \
+ .groups = _groups, \
+ .ngroups = ARRAY_SIZE(_groups), \
+ .func_val = _func_val, \
+}
+
+static const struct pef2256_function_desc pef2256_v2x_functions[] = {
+ PEF2256_FUNCTION("SYPR", PEF2256_2X_PC_RPC_SYPR, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFM", PEF2256_2X_PC_RPC_RFM, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFMB", PEF2256_2X_PC_RPC_RFMB, pef2256_rp_groups),
+ PEF2256_FUNCTION("RSIGM", PEF2256_2X_PC_RPC_RSIGM, pef2256_rp_groups),
+ PEF2256_FUNCTION("RSIG", PEF2256_2X_PC_RPC_RSIG, pef2256_rp_groups),
+ PEF2256_FUNCTION("DLR", PEF2256_2X_PC_RPC_DLR, pef2256_rp_groups),
+ PEF2256_FUNCTION("FREEZE", PEF2256_2X_PC_RPC_FREEZE, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFSP", PEF2256_2X_PC_RPC_RFSP, pef2256_rp_groups),
+ PEF2256_FUNCTION("LOS", PEF2256_2X_PC_RPC_LOS, pef2256_rp_groups),
+
+ PEF2256_FUNCTION("SYPX", PEF2256_2X_PC_XPC_SYPX, pef2256_xp_groups),
+ PEF2256_FUNCTION("XFMS", PEF2256_2X_PC_XPC_XFMS, pef2256_xp_groups),
+ PEF2256_FUNCTION("XSIG", PEF2256_2X_PC_XPC_XSIG, pef2256_xp_groups),
+ PEF2256_FUNCTION("TCLK", PEF2256_2X_PC_XPC_TCLK, pef2256_xp_groups),
+ PEF2256_FUNCTION("XMFB", PEF2256_2X_PC_XPC_XMFB, pef2256_xp_groups),
+ PEF2256_FUNCTION("XSIGM", PEF2256_2X_PC_XPC_XSIGM, pef2256_xp_groups),
+ PEF2256_FUNCTION("DLX", PEF2256_2X_PC_XPC_DLX, pef2256_xp_groups),
+ PEF2256_FUNCTION("XCLK", PEF2256_2X_PC_XPC_XCLK, pef2256_xp_groups),
+ PEF2256_FUNCTION("XLT", PEF2256_2X_PC_XPC_XLT, pef2256_xp_groups),
+
+ PEF2256_FUNCTION("GPI", PEF2256_2X_PC_RPC_GPI | PEF2256_2X_PC_XPC_GPI,
+ pef2256_all_groups),
+ PEF2256_FUNCTION("GPOH", PEF2256_2X_PC_RPC_GPOH | PEF2256_2X_PC_XPC_GPOH,
+ pef2256_all_groups),
+ PEF2256_FUNCTION("GPOL", PEF2256_2X_PC_RPC_GPOL | PEF2256_2X_PC_XPC_GPOL,
+ pef2256_all_groups),
+};
+
+static const struct pef2256_function_desc pef2256_v12_functions[] = {
+ PEF2256_FUNCTION("SYPR", PEF2256_12_PC_RPC_SYPR, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFM", PEF2256_12_PC_RPC_RFM, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFMB", PEF2256_12_PC_RPC_RFMB, pef2256_rp_groups),
+ PEF2256_FUNCTION("RSIGM", PEF2256_12_PC_RPC_RSIGM, pef2256_rp_groups),
+ PEF2256_FUNCTION("RSIG", PEF2256_12_PC_RPC_RSIG, pef2256_rp_groups),
+ PEF2256_FUNCTION("DLR", PEF2256_12_PC_RPC_DLR, pef2256_rp_groups),
+ PEF2256_FUNCTION("FREEZE", PEF2256_12_PC_RPC_FREEZE, pef2256_rp_groups),
+ PEF2256_FUNCTION("RFSP", PEF2256_12_PC_RPC_RFSP, pef2256_rp_groups),
+
+ PEF2256_FUNCTION("SYPX", PEF2256_12_PC_XPC_SYPX, pef2256_xp_groups),
+ PEF2256_FUNCTION("XFMS", PEF2256_12_PC_XPC_XFMS, pef2256_xp_groups),
+ PEF2256_FUNCTION("XSIG", PEF2256_12_PC_XPC_XSIG, pef2256_xp_groups),
+ PEF2256_FUNCTION("TCLK", PEF2256_12_PC_XPC_TCLK, pef2256_xp_groups),
+ PEF2256_FUNCTION("XMFB", PEF2256_12_PC_XPC_XMFB, pef2256_xp_groups),
+ PEF2256_FUNCTION("XSIGM", PEF2256_12_PC_XPC_XSIGM, pef2256_xp_groups),
+ PEF2256_FUNCTION("DLX", PEF2256_12_PC_XPC_DLX, pef2256_xp_groups),
+ PEF2256_FUNCTION("XCLK", PEF2256_12_PC_XPC_XCLK, pef2256_xp_groups),
+ PEF2256_FUNCTION("XLT", PEF2256_12_PC_XPC_XLT, pef2256_xp_groups),
+};
+
+
+static int pef2256_register_pinctrl(struct pef2256 *pef2256)
+{
+ struct pinctrl_dev *pctrl;
+
+ pef2256->pinctrl.pctrl_desc.name = dev_name(pef2256->dev);
+ pef2256->pinctrl.pctrl_desc.owner = THIS_MODULE;
+ pef2256->pinctrl.pctrl_desc.pctlops = &pef2256_pctlops;
+ pef2256->pinctrl.pctrl_desc.pmxops = &pef2256_pmxops;
+ if (pef2256->version == PEF2256_VERSION_1_2) {
+ pef2256->pinctrl.pctrl_desc.pins = pef2256_v12_pins;
+ pef2256->pinctrl.pctrl_desc.npins = ARRAY_SIZE(pef2256_v12_pins);
+ pef2256->pinctrl.functions = pef2256_v12_functions;
+ pef2256->pinctrl.nfunctions = ARRAY_SIZE(pef2256_v12_functions);
+ } else {
+ pef2256->pinctrl.pctrl_desc.pins = pef2256_v2x_pins;
+ pef2256->pinctrl.pctrl_desc.npins = ARRAY_SIZE(pef2256_v2x_pins);
+ pef2256->pinctrl.functions = pef2256_v2x_functions;
+ pef2256->pinctrl.nfunctions = ARRAY_SIZE(pef2256_v2x_functions);
+ }
+
+ pctrl = devm_pinctrl_register(pef2256->dev, &pef2256->pinctrl.pctrl_desc, pef2256);
+ if (IS_ERR(pctrl)) {
+ dev_err(pef2256->dev, "pinctrl driver registration failed\n");
+ return PTR_ERR(pctrl);
+ }
+
+ return 0;
+}
+
+static void pef2256_reset_pinmux(struct pef2256 *pef2256)
+{
+ u8 val;
+ /*
+ * Reset values cannot be used.
+ * They define the SYPR/SYPX pin mux for all the RPx and XPx pins and
+ * Only one pin can be muxed to SYPR and one pin can be muxed to SYPX.
+ * Choose here an other reset value.
+ */
+ if (pef2256->version == PEF2256_VERSION_1_2)
+ val = PEF2256_12_PC_XPC_XCLK | PEF2256_12_PC_RPC_RFSP;
+ else
+ val = PEF2256_2X_PC_XPC_GPI | PEF2256_2X_PC_RPC_GPI;
+
+ pef2256_write8(pef2256, PEF2256_PC1, val);
+ pef2256_write8(pef2256, PEF2256_PC2, val);
+ pef2256_write8(pef2256, PEF2256_PC3, val);
+ pef2256_write8(pef2256, PEF2256_PC4, val);
+}
+
+static ssize_t subordinate_show(struct device *dev, struct device_attribute *attr,
+ char *buf)
+{
+ struct pef2256 *pef2256 = dev_get_drvdata(dev);
+
+ return sysfs_emit(buf, "%d\n", pef2256->is_subordinate);
+}
+
+static ssize_t subordinate_store(struct device *dev, struct device_attribute *attr,
+ const char *buf, size_t count)
+{
+ struct pef2256 *pef2256 = dev_get_drvdata(dev);
+ int ret;
+
+ if (strtobool(buf, &pef2256->is_subordinate) < 0)
+ return -EINVAL;
+
+ ret = pef2256_setup(pef2256);
+ if (ret)
+ return ret;
+
+ return count;
+}
+
+static DEVICE_ATTR_RW(subordinate);
+
+static const struct attribute_group pef2256_attribute_group = {
+ .attrs = (struct attribute *[]) {
+ &dev_attr_subordinate.attr,
+ NULL,
+ },
+};
+
+static int pef2256_probe(struct platform_device *pdev)
+{
+ struct device_node *np = pdev->dev.of_node;
+ unsigned long sclkr_rate, sclkx_rate;
+ struct pef2256 *pef2256;
+ int ret;
+ int irq;
+
+ pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
+ if (!pef2256)
+ return -ENOMEM;
+
+ pef2256->dev = &pdev->dev;
+ ATOMIC_INIT_NOTIFIER_HEAD(&pef2256->event_notifier_list);
+
+ pef2256->regs = devm_platform_ioremap_resource(pdev, 0);
+ if (IS_ERR(pef2256->regs))
+ return PTR_ERR(pef2256->regs);
+
+ pef2256->mclk = devm_clk_get_enabled(&pdev->dev, "mclk");
+ if (IS_ERR(pef2256->mclk))
+ return PTR_ERR(pef2256->mclk);
+ dev_dbg(pef2256->dev, "mclk %lu Hz\n", clk_get_rate(pef2256->mclk));
+
+ pef2256->sclkr = devm_clk_get_enabled(&pdev->dev, "sclkr");
+ if (IS_ERR(pef2256->sclkr))
+ return PTR_ERR(pef2256->sclkr);
+
+ pef2256->sclkx = devm_clk_get_enabled(&pdev->dev, "sclkx");
+ if (IS_ERR(pef2256->sclkx))
+ return PTR_ERR(pef2256->sclkx);
+
+ /*
+ * Both SCLKR (receive) and SCLKX (transmit) must have the same rate,
+ * stored as sysclk_rate.
+ * The exact value will be checked at pef2256_check_rates()
+ */
+ sclkr_rate = clk_get_rate(pef2256->sclkr);
+ sclkx_rate = clk_get_rate(pef2256->sclkx);
+ dev_dbg(pef2256->dev, "sclkr %lu Hz\n", sclkr_rate);
+ dev_dbg(pef2256->dev, "sclkx %lu Hz\n", sclkx_rate);
+ if (sclkr_rate != sclkx_rate) {
+ dev_err(pef2256->dev, "clk rate mismatch. sclkr %lu Hz, sclkx %lu Hz\n",
+ sclkr_rate, sclkx_rate);
+ return -EINVAL;
+ }
+ pef2256->sysclk_rate = sclkr_rate;
+
+ /* Reset the component. The MCLK clock must be active during reset */
+ pef2256->reset_gpio = devm_gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
+ if (IS_ERR(pef2256->reset_gpio))
+ return PTR_ERR(pef2256->reset_gpio);
+ if (pef2256->reset_gpio) {
+ gpiod_set_value_cansleep(pef2256->reset_gpio, 1);
+ udelay(10);
+ gpiod_set_value_cansleep(pef2256->reset_gpio, 0);
+ udelay(10);
+ }
+
+ pef2256->version = pef2256_get_version(pef2256);
+ if (pef2256->version == PEF2256_VERSION_UNKNOWN)
+ return -ENODEV;
+
+ ret = pef2556_of_parse(pef2256, np);
+ if (ret)
+ return ret;
+
+ /* Disable interrupts */
+ pef2256_write8(pef2256, PEF2256_IMR0, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR1, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR2, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR3, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR4, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR5, 0xff);
+
+ /* Clear any pending interrupts */
+ pef2256_read8(pef2256, PEF2256_ISR0);
+ pef2256_read8(pef2256, PEF2256_ISR1);
+ pef2256_read8(pef2256, PEF2256_ISR2);
+ pef2256_read8(pef2256, PEF2256_ISR3);
+ pef2256_read8(pef2256, PEF2256_ISR4);
+ pef2256_read8(pef2256, PEF2256_ISR5);
+
+ irq = platform_get_irq(pdev, 0);
+ if (irq < 0)
+ return irq;
+ ret = devm_request_irq(pef2256->dev, irq, pef2256_irq_handler, 0, "pef2256", pef2256);
+ if (ret < 0)
+ return ret;
+
+ pef2256_reset_pinmux(pef2256);
+ ret = pef2256_register_pinctrl(pef2256);
+ if (ret)
+ return ret;
+
+ /*
+ * We are going to reset the E1 lines during setup() call and the ISR2
+ * interrupt used to detect the carrier state changed is masked.
+ * It is time to initialize our internal carrier state flag.
+ */
+ atomic_set(&pef2256->carrier, 0);
+
+ ret = pef2256_setup(pef2256);
+ if (ret)
+ return ret;
+
+ platform_set_drvdata(pdev, pef2256);
+
+ ret = sysfs_create_group(&pef2256->dev->kobj, &pef2256_attribute_group);
+ if (ret < 0) {
+ dev_err(pef2256->dev, "sysfs registration failed (%d)\n", ret);
+ platform_set_drvdata(pdev, NULL);
+ return ret;
+ }
+
+ ret = devm_of_platform_populate(pef2256->dev);
+ if (ret < 0) {
+ dev_err(pef2256->dev, "platform populate failed (%d)\n", ret);
+ platform_set_drvdata(pdev, NULL);
+ return ret;
+ }
+
+ return 0;
+}
+
+static int pef2256_remove(struct platform_device *pdev)
+{
+ struct pef2256 *pef2256 = platform_get_drvdata(pdev);
+
+ /* Disable interrupts */
+ pef2256_write8(pef2256, PEF2256_IMR0, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR1, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR2, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR3, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR4, 0xff);
+ pef2256_write8(pef2256, PEF2256_IMR5, 0xff);
+
+ sysfs_remove_group(&pef2256->dev->kobj, &pef2256_attribute_group);
+
+ return 0;
+}
+
+static const struct of_device_id pef2256_id_table[] = {
+ { .compatible = "lantiq,pef2256" },
+ {} /* sentinel */
+};
+MODULE_DEVICE_TABLE(of, pef2256_id_table);
+
+static struct platform_driver pef2256_driver = {
+ .driver = {
+ .name = "lantiq-pef2256",
+ .of_match_table = pef2256_id_table,
+ },
+ .probe = pef2256_probe,
+ .remove = pef2256_remove,
+};
+module_platform_driver(pef2256_driver);
+
+int pef2256_register_event_notifier(struct pef2256 *pef2256, struct notifier_block *nb)
+{
+ return atomic_notifier_chain_register(&pef2256->event_notifier_list, nb);
+}
+EXPORT_SYMBOL_GPL(pef2256_register_event_notifier);
+
+int pef2256_unregister_event_notifier(struct pef2256 *pef2256, struct notifier_block *nb)
+{
+ return atomic_notifier_chain_unregister(&pef2256->event_notifier_list, nb);
+}
+EXPORT_SYMBOL_GPL(pef2256_unregister_event_notifier);
+
+bool pef2256_get_carrier(struct pef2256 *pef2256)
+{
+ return !!atomic_read(&pef2256->carrier);
+}
+EXPORT_SYMBOL_GPL(pef2256_get_carrier);
+
+MODULE_AUTHOR("Herve Codina <herve.codina@bootlin.com>");
+MODULE_DESCRIPTION("PEF2256 driver");
+MODULE_LICENSE("GPL");
diff --git a/include/linux/mfd/pef2256.h b/include/linux/mfd/pef2256.h
new file mode 100644
index 000000000000..0c0afcefa3ef
--- /dev/null
+++ b/include/linux/mfd/pef2256.h
@@ -0,0 +1,28 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+/*
+ * PEF2256 management
+ *
+ * Copyright 2023 CS GROUP France
+ *
+ * Author: Herve Codina <herve.codina@bootlin.com>
+ */
+#ifndef __PEF2256_H__
+#define __PEF2256_H__
+
+#include <linux/types.h>
+
+struct pef2256;
+struct notifier_block;
+
+enum pef2256_event {
+ PEF2256_EVENT_CARRIER, /* Carrier state changed */
+};
+
+/* The nb.notifier_call function registered must not sleep */
+int pef2256_register_event_notifier(struct pef2256 *pef2256, struct notifier_block *nb);
+int pef2256_unregister_event_notifier(struct pef2256 *pef2256, struct notifier_block *nb);
+
+/* Retrieve carrier state. true: carrier on, false: carrier off */
+bool pef2256_get_carrier(struct pef2256 *pef2256);
+
+#endif /* __PEF2256_H__ */
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread* [PATCH v5 3/5] Documentation: sysfs: Document the Lantiq PEF2256 sysfs entry
2023-03-28 9:26 [PATCH v5 0/5] Add the Lantiq PEF2256 audio support Herve Codina
` (3 preceding siblings ...)
2023-03-28 9:26 ` Herve Codina via Alsa-devel
@ 2023-03-28 9:26 ` Herve Codina via Alsa-devel
2023-03-28 9:26 ` Herve Codina
` (4 subsequent siblings)
9 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-03-28 9:26 UTC (permalink / raw)
To: Herve Codina, Lee Jones, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai
Cc: linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 4992 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Herve Codina <herve.codina@bootlin.com>, Lee Jones <lee@kernel.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Jaroslav Kysela <perex@perex.cz>, Takashi Iwai <tiwai@suse.com>
Cc: linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: [PATCH v5 3/5] Documentation: sysfs: Document the Lantiq PEF2256 sysfs entry
Date: Tue, 28 Mar 2023 11:26:43 +0200
Message-ID: <20230328092645.634375-4-herve.codina@bootlin.com>
Document the "subordinate" sysfs attribute exposed by the PEF2256
driver.
Signed-off-by: Herve Codina <herve.codina@bootlin.com>
---
.../ABI/testing/sysfs-bus-platform-devices-pef2256 | 12 ++++++++++++
1 file changed, 12 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-platform-devices-pef2256
diff --git a/Documentation/ABI/testing/sysfs-bus-platform-devices-pef2256 b/Documentation/ABI/testing/sysfs-bus-platform-devices-pef2256
new file mode 100644
index 000000000000..95ba1ae55daf
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-platform-devices-pef2256
@@ -0,0 +1,12 @@
+What: /sys/bus/platform/devices/*.pef2256/subordinate
+KernelVersion: 6.4
+Contact: Herve Codina <herve.codina@bootlin.com>
+Description:
+ (RW) Controls whether the PEF2256 works as subordinate or main
+ device mode.
+
+ - 0: main device mode
+ - 1: subordinate mode
+
+ In subordinate device mode it synchronizes on line interface
+ clock signals. Otherwise, it synchronizes on internal clocks.
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread* [PATCH v5 3/5] Documentation: sysfs: Document the Lantiq PEF2256 sysfs entry
2023-03-28 9:26 [PATCH v5 0/5] Add the Lantiq PEF2256 audio support Herve Codina
` (4 preceding siblings ...)
2023-03-28 9:26 ` [PATCH v5 3/5] Documentation: sysfs: Document the Lantiq PEF2256 sysfs entry Herve Codina via Alsa-devel
@ 2023-03-28 9:26 ` Herve Codina
2023-03-28 9:26 ` [PATCH v5 4/5] ASoC: codecs: Add support for the Lantiq PEF2256 codec Herve Codina via Alsa-devel
` (3 subsequent siblings)
9 siblings, 0 replies; 45+ messages in thread
From: Herve Codina @ 2023-03-28 9:26 UTC (permalink / raw)
To: Herve Codina, Lee Jones, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai
Cc: linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
Document the "subordinate" sysfs attribute exposed by the PEF2256
driver.
Signed-off-by: Herve Codina <herve.codina@bootlin.com>
---
.../ABI/testing/sysfs-bus-platform-devices-pef2256 | 12 ++++++++++++
1 file changed, 12 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-platform-devices-pef2256
diff --git a/Documentation/ABI/testing/sysfs-bus-platform-devices-pef2256 b/Documentation/ABI/testing/sysfs-bus-platform-devices-pef2256
new file mode 100644
index 000000000000..95ba1ae55daf
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-platform-devices-pef2256
@@ -0,0 +1,12 @@
+What: /sys/bus/platform/devices/*.pef2256/subordinate
+KernelVersion: 6.4
+Contact: Herve Codina <herve.codina@bootlin.com>
+Description:
+ (RW) Controls whether the PEF2256 works as subordinate or main
+ device mode.
+
+ - 0: main device mode
+ - 1: subordinate mode
+
+ In subordinate device mode it synchronizes on line interface
+ clock signals. Otherwise, it synchronizes on internal clocks.
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread* [PATCH v5 4/5] ASoC: codecs: Add support for the Lantiq PEF2256 codec
2023-03-28 9:26 [PATCH v5 0/5] Add the Lantiq PEF2256 audio support Herve Codina
` (5 preceding siblings ...)
2023-03-28 9:26 ` Herve Codina
@ 2023-03-28 9:26 ` Herve Codina via Alsa-devel
2023-03-28 9:26 ` Herve Codina
` (2 subsequent siblings)
9 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-03-28 9:26 UTC (permalink / raw)
To: Herve Codina, Lee Jones, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai
Cc: linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 18285 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Herve Codina <herve.codina@bootlin.com>, Lee Jones <lee@kernel.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Jaroslav Kysela <perex@perex.cz>, Takashi Iwai <tiwai@suse.com>
Cc: linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: [PATCH v5 4/5] ASoC: codecs: Add support for the Lantiq PEF2256 codec
Date: Tue, 28 Mar 2023 11:26:44 +0200
Message-ID: <20230328092645.634375-5-herve.codina@bootlin.com>
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.
The codec support allows to use some of the PCM system highway
time-slots as audio channels to transport audio data over the E1/T1/J1
lines. It provides also line carrier detection events reported through
the ALSA jack detection feature.
Signed-off-by: Herve Codina <herve.codina@bootlin.com>
---
sound/soc/codecs/Kconfig | 14 ++
sound/soc/codecs/Makefile | 2 +
sound/soc/codecs/pef2256-codec.c | 390 +++++++++++++++++++++++++++++++
3 files changed, 406 insertions(+)
create mode 100644 sound/soc/codecs/pef2256-codec.c
diff --git a/sound/soc/codecs/Kconfig b/sound/soc/codecs/Kconfig
index 0be061953e9a..4f78da914fc7 100644
--- a/sound/soc/codecs/Kconfig
+++ b/sound/soc/codecs/Kconfig
@@ -168,6 +168,7 @@ config SND_SOC_ALL_CODECS
imply SND_SOC_PCM512x_I2C
imply SND_SOC_PCM512x_SPI
imply SND_SOC_PEB2466
+ imply SND_SOC_PEF2256
imply SND_SOC_RK3328
imply SND_SOC_RK817
imply SND_SOC_RT274
@@ -1252,6 +1253,19 @@ config SND_SOC_PEB2466
To compile this driver as a module, choose M here: the module
will be called snd-soc-peb2466.
+config SND_SOC_PEF2256
+ tristate "Lantiq PEF2256 codec"
+ depends on MFD_PEF2256
+ help
+ Enable support for the Lantiq PEF2256 (FALC56) codec.
+ The PEF2256 is a framer and line interface between analog E1/T1/J1
+ line and a digital PCM bus.
+ This codec allows to use some of the time slots available on the
+ PEF2256 PCM bus to transport some audio data.
+
+ To compile this driver as a module, choose M here: the module
+ will be called snd-soc-pef2256.
+
config SND_SOC_RK3328
tristate "Rockchip RK3328 audio CODEC"
select REGMAP_MMIO
diff --git a/sound/soc/codecs/Makefile b/sound/soc/codecs/Makefile
index 20b388b77f1f..11bd66d46f7b 100644
--- a/sound/soc/codecs/Makefile
+++ b/sound/soc/codecs/Makefile
@@ -188,6 +188,7 @@ snd-soc-pcm512x-objs := pcm512x.o
snd-soc-pcm512x-i2c-objs := pcm512x-i2c.o
snd-soc-pcm512x-spi-objs := pcm512x-spi.o
snd-soc-peb2466-objs := peb2466.o
+snd-soc-pef2256-objs := pef2256-codec.o
snd-soc-rk3328-objs := rk3328_codec.o
snd-soc-rk817-objs := rk817_codec.o
snd-soc-rl6231-objs := rl6231.o
@@ -551,6 +552,7 @@ obj-$(CONFIG_SND_SOC_PCM512x) += snd-soc-pcm512x.o
obj-$(CONFIG_SND_SOC_PCM512x_I2C) += snd-soc-pcm512x-i2c.o
obj-$(CONFIG_SND_SOC_PCM512x_SPI) += snd-soc-pcm512x-spi.o
obj-$(CONFIG_SND_SOC_PEB2466) += snd-soc-peb2466.o
+obj-$(CONFIG_SND_SOC_PEF2256) += snd-soc-pef2256.o
obj-$(CONFIG_SND_SOC_RK3328) += snd-soc-rk3328.o
obj-$(CONFIG_SND_SOC_RK817) += snd-soc-rk817.o
obj-$(CONFIG_SND_SOC_RL6231) += snd-soc-rl6231.o
diff --git a/sound/soc/codecs/pef2256-codec.c b/sound/soc/codecs/pef2256-codec.c
new file mode 100644
index 000000000000..d87fdc771a30
--- /dev/null
+++ b/sound/soc/codecs/pef2256-codec.c
@@ -0,0 +1,390 @@
+// SPDX-License-Identifier: GPL-2.0
+//
+// pef2256.c -- Lantiq PEF2256 ALSA SoC driver
+//
+// Copyright 2023 CS GROUP France
+//
+// Author: Herve Codina <herve.codina@bootlin.com>
+
+#include <linux/clk.h>
+#include <linux/mfd/pef2256.h>
+#include <linux/module.h>
+#include <linux/notifier.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+#include <sound/jack.h>
+#include <sound/pcm_params.h>
+#include <sound/soc.h>
+#include <sound/tlv.h>
+
+#define PEF2256_NB_CHANNEL 32
+#define PEF2256_JACK_MASK (SND_JACK_LINEIN | SND_JACK_LINEOUT)
+
+struct pef2256_codec {
+ struct pef2256 *pef2256;
+ struct device *dev;
+ struct snd_soc_jack jack;
+ struct notifier_block nb;
+ struct work_struct carrier_work;
+ int max_chan_playback;
+ int max_chan_capture;
+};
+
+static int pef2256_dai_set_tdm_slot(struct snd_soc_dai *dai, unsigned int tx_mask,
+ unsigned int rx_mask, int slots, int width)
+{
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+
+ switch (width) {
+ case 0:
+ /* Not set -> default 8 */
+ case 8:
+ break;
+ default:
+ dev_err(dai->dev, "tdm slot width %d not supported\n", width);
+ return -EINVAL;
+ }
+
+ pef2256->max_chan_playback = hweight32(tx_mask);
+ if (pef2256->max_chan_playback > PEF2256_NB_CHANNEL) {
+ dev_err(dai->dev, "too much tx slots defined (mask = 0x%x) support max %d\n",
+ tx_mask, PEF2256_NB_CHANNEL);
+ return -EINVAL;
+ }
+
+ pef2256->max_chan_capture = hweight32(rx_mask);
+ if (pef2256->max_chan_capture > PEF2256_NB_CHANNEL) {
+ dev_err(dai->dev, "too much rx slots defined (mask = 0x%x) support max %d\n",
+ rx_mask, PEF2256_NB_CHANNEL);
+ return -EINVAL;
+ }
+
+ return 0;
+}
+
+/*
+ * The constraints for format/channel is to match with the number of 8bit
+ * time-slots available.
+ */
+static int pef2256_dai_hw_rule_channels_by_format(struct snd_soc_dai *dai,
+ struct snd_pcm_hw_params *params,
+ unsigned int nb_ts)
+{
+ struct snd_interval *c = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
+ snd_pcm_format_t format = params_format(params);
+ struct snd_interval ch = {0};
+
+ switch (snd_pcm_format_physical_width(format)) {
+ case 8:
+ ch.max = nb_ts;
+ break;
+ case 16:
+ ch.max = nb_ts/2;
+ break;
+ case 32:
+ ch.max = nb_ts/4;
+ break;
+ case 64:
+ ch.max = nb_ts/8;
+ break;
+ default:
+ dev_err(dai->dev, "format physical width %u not supported\n",
+ snd_pcm_format_physical_width(format));
+ return -EINVAL;
+ }
+
+ ch.min = ch.max ? 1 : 0;
+
+ return snd_interval_refine(c, &ch);
+}
+
+static int pef2256_dai_hw_rule_playback_channels_by_format(struct snd_pcm_hw_params *params,
+ struct snd_pcm_hw_rule *rule)
+{
+ struct snd_soc_dai *dai = rule->private;
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+
+ return pef2256_dai_hw_rule_channels_by_format(dai, params, pef2256->max_chan_playback);
+}
+
+static int pef2256_dai_hw_rule_capture_channels_by_format(struct snd_pcm_hw_params *params,
+ struct snd_pcm_hw_rule *rule)
+{
+ struct snd_soc_dai *dai = rule->private;
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+
+ return pef2256_dai_hw_rule_channels_by_format(dai, params, pef2256->max_chan_capture);
+}
+
+static int pef2256_dai_hw_rule_format_by_channels(struct snd_soc_dai *dai,
+ struct snd_pcm_hw_params *params,
+ unsigned int nb_ts)
+{
+ struct snd_mask *f_old = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
+ unsigned int channels = params_channels(params);
+ unsigned int slot_width;
+ struct snd_mask f_new;
+ unsigned int i;
+
+ if (!channels || channels > nb_ts) {
+ dev_err(dai->dev, "channels %u not supported\n", nb_ts);
+ return -EINVAL;
+ }
+
+ slot_width = (nb_ts / channels) * 8;
+
+ snd_mask_none(&f_new);
+ for (i = 0; i <= SNDRV_PCM_FORMAT_LAST; i++) {
+ if (snd_mask_test(f_old, i)) {
+ if (snd_pcm_format_physical_width(i) <= slot_width)
+ snd_mask_set(&f_new, i);
+ }
+ }
+
+ return snd_mask_refine(f_old, &f_new);
+}
+
+static int pef2256_dai_hw_rule_playback_format_by_channels(struct snd_pcm_hw_params *params,
+ struct snd_pcm_hw_rule *rule)
+{
+ struct snd_soc_dai *dai = rule->private;
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+
+ return pef2256_dai_hw_rule_format_by_channels(dai, params, pef2256->max_chan_playback);
+}
+
+static int pef2256_dai_hw_rule_capture_format_by_channels(struct snd_pcm_hw_params *params,
+ struct snd_pcm_hw_rule *rule)
+{
+ struct snd_soc_dai *dai = rule->private;
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+
+ return pef2256_dai_hw_rule_format_by_channels(dai, params, pef2256->max_chan_capture);
+}
+
+static u64 pef2256_formats(u8 nb_ts)
+{
+ u64 formats;
+ unsigned int chan_width;
+ unsigned int format_width;
+ int i;
+
+ if (!nb_ts)
+ return 0;
+
+ formats = 0;
+ chan_width = nb_ts * 8;
+ for (i = 0; i <= SNDRV_PCM_FORMAT_LAST; i++) {
+ /* Support physical width multiple of 8bit */
+ format_width = snd_pcm_format_physical_width(i);
+ if (format_width == 0 || format_width % 8)
+ continue;
+
+ /*
+ * And support physical width that can fit N times in the
+ * channel
+ */
+ if (format_width > chan_width || chan_width % format_width)
+ continue;
+
+ formats |= (1ULL << i);
+ }
+ return formats;
+}
+
+static int pef2256_dai_startup(struct snd_pcm_substream *substream,
+ struct snd_soc_dai *dai)
+{
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+ snd_pcm_hw_rule_func_t hw_rule_channels_by_format;
+ snd_pcm_hw_rule_func_t hw_rule_format_by_channels;
+ unsigned int frame_bits;
+ u64 format;
+ int ret;
+
+ if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
+ format = pef2256_formats(pef2256->max_chan_capture);
+ hw_rule_channels_by_format = pef2256_dai_hw_rule_capture_channels_by_format;
+ hw_rule_format_by_channels = pef2256_dai_hw_rule_capture_format_by_channels;
+ frame_bits = pef2256->max_chan_capture * 8;
+ } else {
+ format = pef2256_formats(pef2256->max_chan_playback);
+ hw_rule_channels_by_format = pef2256_dai_hw_rule_playback_channels_by_format;
+ hw_rule_format_by_channels = pef2256_dai_hw_rule_playback_format_by_channels;
+ frame_bits = pef2256->max_chan_playback * 8;
+ }
+
+ ret = snd_pcm_hw_constraint_mask64(substream->runtime,
+ SNDRV_PCM_HW_PARAM_FORMAT, format);
+ if (ret) {
+ dev_err(dai->dev, "Failed to add format constraint (%d)\n", ret);
+ return ret;
+ }
+
+ ret = snd_pcm_hw_rule_add(substream->runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
+ hw_rule_channels_by_format, dai,
+ SNDRV_PCM_HW_PARAM_FORMAT, -1);
+ if (ret) {
+ dev_err(dai->dev, "Failed to add channels rule (%d)\n", ret);
+ return ret;
+ }
+
+ ret = snd_pcm_hw_rule_add(substream->runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
+ hw_rule_format_by_channels, dai,
+ SNDRV_PCM_HW_PARAM_CHANNELS, -1);
+ if (ret) {
+ dev_err(dai->dev, "Failed to add format rule (%d)\n", ret);
+ return ret;
+ }
+
+ ret = snd_pcm_hw_constraint_single(substream->runtime,
+ SNDRV_PCM_HW_PARAM_FRAME_BITS,
+ frame_bits);
+ if (ret < 0) {
+ dev_err(dai->dev, "Failed to add frame_bits constraint (%d)\n", ret);
+ return ret;
+ }
+
+ return 0;
+}
+
+static u64 pef2256_dai_formats[] = {
+ SND_SOC_POSSIBLE_DAIFMT_DSP_B,
+};
+
+static const struct snd_soc_dai_ops pef2256_dai_ops = {
+ .startup = pef2256_dai_startup,
+ .set_tdm_slot = pef2256_dai_set_tdm_slot,
+ .auto_selectable_formats = pef2256_dai_formats,
+ .num_auto_selectable_formats = ARRAY_SIZE(pef2256_dai_formats),
+};
+
+static struct snd_soc_dai_driver pef2256_dai_driver = {
+ .name = "pef2256",
+ .playback = {
+ .stream_name = "Playback",
+ .channels_min = 1,
+ .channels_max = PEF2256_NB_CHANNEL,
+ .rates = SNDRV_PCM_RATE_8000,
+ .formats = U64_MAX, /* Will be refined on DAI .startup() */
+ },
+ .capture = {
+ .stream_name = "Capture",
+ .channels_min = 1,
+ .channels_max = PEF2256_NB_CHANNEL,
+ .rates = SNDRV_PCM_RATE_8000,
+ .formats = U64_MAX, /* Will be refined on DAI .startup() */
+ },
+ .ops = &pef2256_dai_ops,
+};
+
+static void pef2256_carrier_work(struct work_struct *work)
+{
+ struct pef2256_codec *pef2256 = container_of(work, struct pef2256_codec, carrier_work);
+ int status;
+
+ status = pef2256_get_carrier(pef2256->pef2256) ? PEF2256_JACK_MASK : 0;
+ snd_soc_jack_report(&pef2256->jack, status, PEF2256_JACK_MASK);
+}
+
+static int pef2256_carrier_notifier(struct notifier_block *nb, unsigned long action,
+ void *data)
+{
+ struct pef2256_codec *pef2256 = container_of(nb, struct pef2256_codec, nb);
+
+ switch (action) {
+ case PEF2256_EVENT_CARRIER:
+ queue_work(system_power_efficient_wq, &pef2256->carrier_work);
+ break;
+ default:
+ return NOTIFY_DONE;
+ }
+
+ return NOTIFY_OK;
+}
+
+static int pef2256_component_probe(struct snd_soc_component *component)
+{
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(component);
+ char *name;
+ int ret;
+
+ INIT_WORK(&pef2256->carrier_work, pef2256_carrier_work);
+
+ name = "carrier";
+ if (component->name_prefix) {
+ name = kasprintf(GFP_KERNEL, "%s carrier", component->name_prefix);
+ if (!name)
+ return -ENOMEM;
+ }
+
+ ret = snd_soc_card_jack_new(component->card, name, PEF2256_JACK_MASK, &pef2256->jack);
+ if (component->name_prefix)
+ kfree(name); /* A copy is done by snd_soc_card_jack_new */
+ if (ret) {
+ dev_err(component->dev, "Cannot create jack\n");
+ return ret;
+ }
+
+ pef2256->nb.notifier_call = pef2256_carrier_notifier;
+ ret = pef2256_register_event_notifier(pef2256->pef2256, &pef2256->nb);
+ if (ret) {
+ dev_err(component->dev, "Cannot register event notifier\n");
+ return ret;
+ }
+
+ /* Queue work to set the initial value */
+ queue_work(system_power_efficient_wq, &pef2256->carrier_work);
+
+ return 0;
+}
+
+static void pef2256_component_remove(struct snd_soc_component *component)
+{
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(component);
+
+ pef2256_unregister_event_notifier(pef2256->pef2256, &pef2256->nb);
+ cancel_work_sync(&pef2256->carrier_work);
+}
+
+static const struct snd_soc_component_driver pef2256_component_driver = {
+ .probe = pef2256_component_probe,
+ .remove = pef2256_component_remove,
+ .endianness = 1,
+};
+
+static int pef2256_codec_probe(struct platform_device *pdev)
+{
+ struct pef2256_codec *pef2256;
+
+ pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
+ if (!pef2256)
+ return -ENOMEM;
+
+ pef2256->dev = &pdev->dev;
+ pef2256->pef2256 = dev_get_drvdata(pef2256->dev->parent);
+
+ platform_set_drvdata(pdev, pef2256);
+
+ return devm_snd_soc_register_component(&pdev->dev, &pef2256_component_driver,
+ &pef2256_dai_driver, 1);
+}
+
+static const struct of_device_id pef2256_codec_of_match[] = {
+ { .compatible = "lantiq,pef2256-codec" },
+ {} /* sentinel */
+};
+MODULE_DEVICE_TABLE(of, pef2256_codec_of_match);
+
+static struct platform_driver pef2256_codec_driver = {
+ .driver = {
+ .name = "lantiq-pef2256-codec",
+ .of_match_table = pef2256_codec_of_match,
+ },
+ .probe = pef2256_codec_probe,
+};
+module_platform_driver(pef2256_codec_driver);
+
+MODULE_AUTHOR("Herve Codina <herve.codina@bootlin.com>");
+MODULE_DESCRIPTION("PEF2256 ALSA SoC driver");
+MODULE_LICENSE("GPL");
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread* [PATCH v5 4/5] ASoC: codecs: Add support for the Lantiq PEF2256 codec
2023-03-28 9:26 [PATCH v5 0/5] Add the Lantiq PEF2256 audio support Herve Codina
` (6 preceding siblings ...)
2023-03-28 9:26 ` [PATCH v5 4/5] ASoC: codecs: Add support for the Lantiq PEF2256 codec Herve Codina via Alsa-devel
@ 2023-03-28 9:26 ` Herve Codina
2023-03-28 9:26 ` [PATCH v5 5/5] MAINTAINERS: Add the Lantiq PEF2256 driver entry Herve Codina
2023-03-28 9:26 ` Herve Codina via Alsa-devel
9 siblings, 0 replies; 45+ messages in thread
From: Herve Codina @ 2023-03-28 9:26 UTC (permalink / raw)
To: Herve Codina, Lee Jones, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai
Cc: linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
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.
The codec support allows to use some of the PCM system highway
time-slots as audio channels to transport audio data over the E1/T1/J1
lines. It provides also line carrier detection events reported through
the ALSA jack detection feature.
Signed-off-by: Herve Codina <herve.codina@bootlin.com>
---
sound/soc/codecs/Kconfig | 14 ++
sound/soc/codecs/Makefile | 2 +
sound/soc/codecs/pef2256-codec.c | 390 +++++++++++++++++++++++++++++++
3 files changed, 406 insertions(+)
create mode 100644 sound/soc/codecs/pef2256-codec.c
diff --git a/sound/soc/codecs/Kconfig b/sound/soc/codecs/Kconfig
index 0be061953e9a..4f78da914fc7 100644
--- a/sound/soc/codecs/Kconfig
+++ b/sound/soc/codecs/Kconfig
@@ -168,6 +168,7 @@ config SND_SOC_ALL_CODECS
imply SND_SOC_PCM512x_I2C
imply SND_SOC_PCM512x_SPI
imply SND_SOC_PEB2466
+ imply SND_SOC_PEF2256
imply SND_SOC_RK3328
imply SND_SOC_RK817
imply SND_SOC_RT274
@@ -1252,6 +1253,19 @@ config SND_SOC_PEB2466
To compile this driver as a module, choose M here: the module
will be called snd-soc-peb2466.
+config SND_SOC_PEF2256
+ tristate "Lantiq PEF2256 codec"
+ depends on MFD_PEF2256
+ help
+ Enable support for the Lantiq PEF2256 (FALC56) codec.
+ The PEF2256 is a framer and line interface between analog E1/T1/J1
+ line and a digital PCM bus.
+ This codec allows to use some of the time slots available on the
+ PEF2256 PCM bus to transport some audio data.
+
+ To compile this driver as a module, choose M here: the module
+ will be called snd-soc-pef2256.
+
config SND_SOC_RK3328
tristate "Rockchip RK3328 audio CODEC"
select REGMAP_MMIO
diff --git a/sound/soc/codecs/Makefile b/sound/soc/codecs/Makefile
index 20b388b77f1f..11bd66d46f7b 100644
--- a/sound/soc/codecs/Makefile
+++ b/sound/soc/codecs/Makefile
@@ -188,6 +188,7 @@ snd-soc-pcm512x-objs := pcm512x.o
snd-soc-pcm512x-i2c-objs := pcm512x-i2c.o
snd-soc-pcm512x-spi-objs := pcm512x-spi.o
snd-soc-peb2466-objs := peb2466.o
+snd-soc-pef2256-objs := pef2256-codec.o
snd-soc-rk3328-objs := rk3328_codec.o
snd-soc-rk817-objs := rk817_codec.o
snd-soc-rl6231-objs := rl6231.o
@@ -551,6 +552,7 @@ obj-$(CONFIG_SND_SOC_PCM512x) += snd-soc-pcm512x.o
obj-$(CONFIG_SND_SOC_PCM512x_I2C) += snd-soc-pcm512x-i2c.o
obj-$(CONFIG_SND_SOC_PCM512x_SPI) += snd-soc-pcm512x-spi.o
obj-$(CONFIG_SND_SOC_PEB2466) += snd-soc-peb2466.o
+obj-$(CONFIG_SND_SOC_PEF2256) += snd-soc-pef2256.o
obj-$(CONFIG_SND_SOC_RK3328) += snd-soc-rk3328.o
obj-$(CONFIG_SND_SOC_RK817) += snd-soc-rk817.o
obj-$(CONFIG_SND_SOC_RL6231) += snd-soc-rl6231.o
diff --git a/sound/soc/codecs/pef2256-codec.c b/sound/soc/codecs/pef2256-codec.c
new file mode 100644
index 000000000000..d87fdc771a30
--- /dev/null
+++ b/sound/soc/codecs/pef2256-codec.c
@@ -0,0 +1,390 @@
+// SPDX-License-Identifier: GPL-2.0
+//
+// pef2256.c -- Lantiq PEF2256 ALSA SoC driver
+//
+// Copyright 2023 CS GROUP France
+//
+// Author: Herve Codina <herve.codina@bootlin.com>
+
+#include <linux/clk.h>
+#include <linux/mfd/pef2256.h>
+#include <linux/module.h>
+#include <linux/notifier.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+#include <sound/jack.h>
+#include <sound/pcm_params.h>
+#include <sound/soc.h>
+#include <sound/tlv.h>
+
+#define PEF2256_NB_CHANNEL 32
+#define PEF2256_JACK_MASK (SND_JACK_LINEIN | SND_JACK_LINEOUT)
+
+struct pef2256_codec {
+ struct pef2256 *pef2256;
+ struct device *dev;
+ struct snd_soc_jack jack;
+ struct notifier_block nb;
+ struct work_struct carrier_work;
+ int max_chan_playback;
+ int max_chan_capture;
+};
+
+static int pef2256_dai_set_tdm_slot(struct snd_soc_dai *dai, unsigned int tx_mask,
+ unsigned int rx_mask, int slots, int width)
+{
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+
+ switch (width) {
+ case 0:
+ /* Not set -> default 8 */
+ case 8:
+ break;
+ default:
+ dev_err(dai->dev, "tdm slot width %d not supported\n", width);
+ return -EINVAL;
+ }
+
+ pef2256->max_chan_playback = hweight32(tx_mask);
+ if (pef2256->max_chan_playback > PEF2256_NB_CHANNEL) {
+ dev_err(dai->dev, "too much tx slots defined (mask = 0x%x) support max %d\n",
+ tx_mask, PEF2256_NB_CHANNEL);
+ return -EINVAL;
+ }
+
+ pef2256->max_chan_capture = hweight32(rx_mask);
+ if (pef2256->max_chan_capture > PEF2256_NB_CHANNEL) {
+ dev_err(dai->dev, "too much rx slots defined (mask = 0x%x) support max %d\n",
+ rx_mask, PEF2256_NB_CHANNEL);
+ return -EINVAL;
+ }
+
+ return 0;
+}
+
+/*
+ * The constraints for format/channel is to match with the number of 8bit
+ * time-slots available.
+ */
+static int pef2256_dai_hw_rule_channels_by_format(struct snd_soc_dai *dai,
+ struct snd_pcm_hw_params *params,
+ unsigned int nb_ts)
+{
+ struct snd_interval *c = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
+ snd_pcm_format_t format = params_format(params);
+ struct snd_interval ch = {0};
+
+ switch (snd_pcm_format_physical_width(format)) {
+ case 8:
+ ch.max = nb_ts;
+ break;
+ case 16:
+ ch.max = nb_ts/2;
+ break;
+ case 32:
+ ch.max = nb_ts/4;
+ break;
+ case 64:
+ ch.max = nb_ts/8;
+ break;
+ default:
+ dev_err(dai->dev, "format physical width %u not supported\n",
+ snd_pcm_format_physical_width(format));
+ return -EINVAL;
+ }
+
+ ch.min = ch.max ? 1 : 0;
+
+ return snd_interval_refine(c, &ch);
+}
+
+static int pef2256_dai_hw_rule_playback_channels_by_format(struct snd_pcm_hw_params *params,
+ struct snd_pcm_hw_rule *rule)
+{
+ struct snd_soc_dai *dai = rule->private;
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+
+ return pef2256_dai_hw_rule_channels_by_format(dai, params, pef2256->max_chan_playback);
+}
+
+static int pef2256_dai_hw_rule_capture_channels_by_format(struct snd_pcm_hw_params *params,
+ struct snd_pcm_hw_rule *rule)
+{
+ struct snd_soc_dai *dai = rule->private;
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+
+ return pef2256_dai_hw_rule_channels_by_format(dai, params, pef2256->max_chan_capture);
+}
+
+static int pef2256_dai_hw_rule_format_by_channels(struct snd_soc_dai *dai,
+ struct snd_pcm_hw_params *params,
+ unsigned int nb_ts)
+{
+ struct snd_mask *f_old = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
+ unsigned int channels = params_channels(params);
+ unsigned int slot_width;
+ struct snd_mask f_new;
+ unsigned int i;
+
+ if (!channels || channels > nb_ts) {
+ dev_err(dai->dev, "channels %u not supported\n", nb_ts);
+ return -EINVAL;
+ }
+
+ slot_width = (nb_ts / channels) * 8;
+
+ snd_mask_none(&f_new);
+ for (i = 0; i <= SNDRV_PCM_FORMAT_LAST; i++) {
+ if (snd_mask_test(f_old, i)) {
+ if (snd_pcm_format_physical_width(i) <= slot_width)
+ snd_mask_set(&f_new, i);
+ }
+ }
+
+ return snd_mask_refine(f_old, &f_new);
+}
+
+static int pef2256_dai_hw_rule_playback_format_by_channels(struct snd_pcm_hw_params *params,
+ struct snd_pcm_hw_rule *rule)
+{
+ struct snd_soc_dai *dai = rule->private;
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+
+ return pef2256_dai_hw_rule_format_by_channels(dai, params, pef2256->max_chan_playback);
+}
+
+static int pef2256_dai_hw_rule_capture_format_by_channels(struct snd_pcm_hw_params *params,
+ struct snd_pcm_hw_rule *rule)
+{
+ struct snd_soc_dai *dai = rule->private;
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+
+ return pef2256_dai_hw_rule_format_by_channels(dai, params, pef2256->max_chan_capture);
+}
+
+static u64 pef2256_formats(u8 nb_ts)
+{
+ u64 formats;
+ unsigned int chan_width;
+ unsigned int format_width;
+ int i;
+
+ if (!nb_ts)
+ return 0;
+
+ formats = 0;
+ chan_width = nb_ts * 8;
+ for (i = 0; i <= SNDRV_PCM_FORMAT_LAST; i++) {
+ /* Support physical width multiple of 8bit */
+ format_width = snd_pcm_format_physical_width(i);
+ if (format_width == 0 || format_width % 8)
+ continue;
+
+ /*
+ * And support physical width that can fit N times in the
+ * channel
+ */
+ if (format_width > chan_width || chan_width % format_width)
+ continue;
+
+ formats |= (1ULL << i);
+ }
+ return formats;
+}
+
+static int pef2256_dai_startup(struct snd_pcm_substream *substream,
+ struct snd_soc_dai *dai)
+{
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(dai->component);
+ snd_pcm_hw_rule_func_t hw_rule_channels_by_format;
+ snd_pcm_hw_rule_func_t hw_rule_format_by_channels;
+ unsigned int frame_bits;
+ u64 format;
+ int ret;
+
+ if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
+ format = pef2256_formats(pef2256->max_chan_capture);
+ hw_rule_channels_by_format = pef2256_dai_hw_rule_capture_channels_by_format;
+ hw_rule_format_by_channels = pef2256_dai_hw_rule_capture_format_by_channels;
+ frame_bits = pef2256->max_chan_capture * 8;
+ } else {
+ format = pef2256_formats(pef2256->max_chan_playback);
+ hw_rule_channels_by_format = pef2256_dai_hw_rule_playback_channels_by_format;
+ hw_rule_format_by_channels = pef2256_dai_hw_rule_playback_format_by_channels;
+ frame_bits = pef2256->max_chan_playback * 8;
+ }
+
+ ret = snd_pcm_hw_constraint_mask64(substream->runtime,
+ SNDRV_PCM_HW_PARAM_FORMAT, format);
+ if (ret) {
+ dev_err(dai->dev, "Failed to add format constraint (%d)\n", ret);
+ return ret;
+ }
+
+ ret = snd_pcm_hw_rule_add(substream->runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
+ hw_rule_channels_by_format, dai,
+ SNDRV_PCM_HW_PARAM_FORMAT, -1);
+ if (ret) {
+ dev_err(dai->dev, "Failed to add channels rule (%d)\n", ret);
+ return ret;
+ }
+
+ ret = snd_pcm_hw_rule_add(substream->runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
+ hw_rule_format_by_channels, dai,
+ SNDRV_PCM_HW_PARAM_CHANNELS, -1);
+ if (ret) {
+ dev_err(dai->dev, "Failed to add format rule (%d)\n", ret);
+ return ret;
+ }
+
+ ret = snd_pcm_hw_constraint_single(substream->runtime,
+ SNDRV_PCM_HW_PARAM_FRAME_BITS,
+ frame_bits);
+ if (ret < 0) {
+ dev_err(dai->dev, "Failed to add frame_bits constraint (%d)\n", ret);
+ return ret;
+ }
+
+ return 0;
+}
+
+static u64 pef2256_dai_formats[] = {
+ SND_SOC_POSSIBLE_DAIFMT_DSP_B,
+};
+
+static const struct snd_soc_dai_ops pef2256_dai_ops = {
+ .startup = pef2256_dai_startup,
+ .set_tdm_slot = pef2256_dai_set_tdm_slot,
+ .auto_selectable_formats = pef2256_dai_formats,
+ .num_auto_selectable_formats = ARRAY_SIZE(pef2256_dai_formats),
+};
+
+static struct snd_soc_dai_driver pef2256_dai_driver = {
+ .name = "pef2256",
+ .playback = {
+ .stream_name = "Playback",
+ .channels_min = 1,
+ .channels_max = PEF2256_NB_CHANNEL,
+ .rates = SNDRV_PCM_RATE_8000,
+ .formats = U64_MAX, /* Will be refined on DAI .startup() */
+ },
+ .capture = {
+ .stream_name = "Capture",
+ .channels_min = 1,
+ .channels_max = PEF2256_NB_CHANNEL,
+ .rates = SNDRV_PCM_RATE_8000,
+ .formats = U64_MAX, /* Will be refined on DAI .startup() */
+ },
+ .ops = &pef2256_dai_ops,
+};
+
+static void pef2256_carrier_work(struct work_struct *work)
+{
+ struct pef2256_codec *pef2256 = container_of(work, struct pef2256_codec, carrier_work);
+ int status;
+
+ status = pef2256_get_carrier(pef2256->pef2256) ? PEF2256_JACK_MASK : 0;
+ snd_soc_jack_report(&pef2256->jack, status, PEF2256_JACK_MASK);
+}
+
+static int pef2256_carrier_notifier(struct notifier_block *nb, unsigned long action,
+ void *data)
+{
+ struct pef2256_codec *pef2256 = container_of(nb, struct pef2256_codec, nb);
+
+ switch (action) {
+ case PEF2256_EVENT_CARRIER:
+ queue_work(system_power_efficient_wq, &pef2256->carrier_work);
+ break;
+ default:
+ return NOTIFY_DONE;
+ }
+
+ return NOTIFY_OK;
+}
+
+static int pef2256_component_probe(struct snd_soc_component *component)
+{
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(component);
+ char *name;
+ int ret;
+
+ INIT_WORK(&pef2256->carrier_work, pef2256_carrier_work);
+
+ name = "carrier";
+ if (component->name_prefix) {
+ name = kasprintf(GFP_KERNEL, "%s carrier", component->name_prefix);
+ if (!name)
+ return -ENOMEM;
+ }
+
+ ret = snd_soc_card_jack_new(component->card, name, PEF2256_JACK_MASK, &pef2256->jack);
+ if (component->name_prefix)
+ kfree(name); /* A copy is done by snd_soc_card_jack_new */
+ if (ret) {
+ dev_err(component->dev, "Cannot create jack\n");
+ return ret;
+ }
+
+ pef2256->nb.notifier_call = pef2256_carrier_notifier;
+ ret = pef2256_register_event_notifier(pef2256->pef2256, &pef2256->nb);
+ if (ret) {
+ dev_err(component->dev, "Cannot register event notifier\n");
+ return ret;
+ }
+
+ /* Queue work to set the initial value */
+ queue_work(system_power_efficient_wq, &pef2256->carrier_work);
+
+ return 0;
+}
+
+static void pef2256_component_remove(struct snd_soc_component *component)
+{
+ struct pef2256_codec *pef2256 = snd_soc_component_get_drvdata(component);
+
+ pef2256_unregister_event_notifier(pef2256->pef2256, &pef2256->nb);
+ cancel_work_sync(&pef2256->carrier_work);
+}
+
+static const struct snd_soc_component_driver pef2256_component_driver = {
+ .probe = pef2256_component_probe,
+ .remove = pef2256_component_remove,
+ .endianness = 1,
+};
+
+static int pef2256_codec_probe(struct platform_device *pdev)
+{
+ struct pef2256_codec *pef2256;
+
+ pef2256 = devm_kzalloc(&pdev->dev, sizeof(*pef2256), GFP_KERNEL);
+ if (!pef2256)
+ return -ENOMEM;
+
+ pef2256->dev = &pdev->dev;
+ pef2256->pef2256 = dev_get_drvdata(pef2256->dev->parent);
+
+ platform_set_drvdata(pdev, pef2256);
+
+ return devm_snd_soc_register_component(&pdev->dev, &pef2256_component_driver,
+ &pef2256_dai_driver, 1);
+}
+
+static const struct of_device_id pef2256_codec_of_match[] = {
+ { .compatible = "lantiq,pef2256-codec" },
+ {} /* sentinel */
+};
+MODULE_DEVICE_TABLE(of, pef2256_codec_of_match);
+
+static struct platform_driver pef2256_codec_driver = {
+ .driver = {
+ .name = "lantiq-pef2256-codec",
+ .of_match_table = pef2256_codec_of_match,
+ },
+ .probe = pef2256_codec_probe,
+};
+module_platform_driver(pef2256_codec_driver);
+
+MODULE_AUTHOR("Herve Codina <herve.codina@bootlin.com>");
+MODULE_DESCRIPTION("PEF2256 ALSA SoC driver");
+MODULE_LICENSE("GPL");
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread* [PATCH v5 5/5] MAINTAINERS: Add the Lantiq PEF2256 driver entry
2023-03-28 9:26 [PATCH v5 0/5] Add the Lantiq PEF2256 audio support Herve Codina
` (7 preceding siblings ...)
2023-03-28 9:26 ` Herve Codina
@ 2023-03-28 9:26 ` Herve Codina
2023-03-28 9:26 ` Herve Codina via Alsa-devel
9 siblings, 0 replies; 45+ messages in thread
From: Herve Codina @ 2023-03-28 9:26 UTC (permalink / raw)
To: Herve Codina, Lee Jones, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai
Cc: linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
After contributing the driver, add myself as the maintainer for the
Lantiq PEF2256 driver.
Signed-off-by: Herve Codina <herve.codina@bootlin.com>
---
MAINTAINERS | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/MAINTAINERS b/MAINTAINERS
index fcb69242cd19..a17c85648f6f 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -11651,6 +11651,15 @@ S: Maintained
F: arch/mips/lantiq
F: drivers/soc/lantiq
+LANTIQ PEF2256 DRIVER
+M: Herve Codina <herve.codina@bootlin.com>
+S: Maintained
+F: Documentation/ABI/testing/sysfs-bus-platform-devices-pef2256
+F: Documentation/devicetree/bindings/mfd/lantiq,pef2256.yaml
+F: drivers/mfd/pef2256.c
+F: include/linux/mfd/pef2256.h
+F: sound/soc/codecs/pef2256-codec.c
+
LASI 53c700 driver for PARISC
M: "James E.J. Bottomley" <James.Bottomley@HansenPartnership.com>
L: linux-scsi@vger.kernel.org
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread* [PATCH v5 5/5] MAINTAINERS: Add the Lantiq PEF2256 driver entry
2023-03-28 9:26 [PATCH v5 0/5] Add the Lantiq PEF2256 audio support Herve Codina
` (8 preceding siblings ...)
2023-03-28 9:26 ` [PATCH v5 5/5] MAINTAINERS: Add the Lantiq PEF2256 driver entry Herve Codina
@ 2023-03-28 9:26 ` Herve Codina via Alsa-devel
9 siblings, 0 replies; 45+ messages in thread
From: Herve Codina via Alsa-devel @ 2023-03-28 9:26 UTC (permalink / raw)
To: Herve Codina, Lee Jones, Rob Herring, Krzysztof Kozlowski,
Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai
Cc: linux-kernel, devicetree, alsa-devel, Christophe Leroy,
Thomas Petazzoni
[-- Attachment #0: Type: message/rfc822, Size: 4802 bytes --]
From: Herve Codina <herve.codina@bootlin.com>
To: Herve Codina <herve.codina@bootlin.com>, Lee Jones <lee@kernel.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Jaroslav Kysela <perex@perex.cz>, Takashi Iwai <tiwai@suse.com>
Cc: linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, alsa-devel@alsa-project.org, Christophe Leroy <christophe.leroy@csgroup.eu>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: [PATCH v5 5/5] MAINTAINERS: Add the Lantiq PEF2256 driver entry
Date: Tue, 28 Mar 2023 11:26:45 +0200
Message-ID: <20230328092645.634375-6-herve.codina@bootlin.com>
After contributing the driver, add myself as the maintainer for the
Lantiq PEF2256 driver.
Signed-off-by: Herve Codina <herve.codina@bootlin.com>
---
MAINTAINERS | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/MAINTAINERS b/MAINTAINERS
index fcb69242cd19..a17c85648f6f 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -11651,6 +11651,15 @@ S: Maintained
F: arch/mips/lantiq
F: drivers/soc/lantiq
+LANTIQ PEF2256 DRIVER
+M: Herve Codina <herve.codina@bootlin.com>
+S: Maintained
+F: Documentation/ABI/testing/sysfs-bus-platform-devices-pef2256
+F: Documentation/devicetree/bindings/mfd/lantiq,pef2256.yaml
+F: drivers/mfd/pef2256.c
+F: include/linux/mfd/pef2256.h
+F: sound/soc/codecs/pef2256-codec.c
+
LASI 53c700 driver for PARISC
M: "James E.J. Bottomley" <James.Bottomley@HansenPartnership.com>
L: linux-scsi@vger.kernel.org
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread