> -----Original Message----- > From: Krzysztof Kozlowski <krzysztof.kozlowski@xxxxxxxxxx> > Sent: 2022年8月30日 16:55 > To: Joy Zou <joy.zou@xxxxxxx> > Cc: S.J. Wang <shengjiu.wang@xxxxxxx>; vkoul@xxxxxxxxxx; > robh+dt@xxxxxxxxxx; krzysztof.kozlowski+dt@xxxxxxxxxx; > shawnguo@xxxxxxxxxx; s.hauer@xxxxxxxxxxxxxx; kernel@xxxxxxxxxxxxxx; > festevam@xxxxxxxxx; dl-linux-imx <linux-imx@xxxxxxx>; > dmaengine@xxxxxxxxxxxxxxx; devicetree@xxxxxxxxxxxxxxx; > linux-arm-kernel@xxxxxxxxxxxxxxxxxxx; linux-kernel@xxxxxxxxxxxxxxx > Subject: [EXT] Re: [PATCH V3 1/2] dt-bindings: fsl-imx-sdma: Convert imx sdma > to DT schema > > Caution: EXT Email > > On 30/08/2022 11:18, Joy Zou wrote: > > Convert the i.MX SDMA binding to DT schema format using json-schema. > > In addition, add new peripheral types HDMI Audio. > > Please wrap commit message according to Linux coding style / submission > process: I will modify commit message according to Linux coding style / submission process. > https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Felixir.bo > otlin.com%2Flinux%2Fv5.18-rc4%2Fsource%2FDocumentation%2Fprocess%2F > submitting-patches.rst%23L586&data=05%7C01%7Cjoy.zou%40nxp.com > %7C55890065ef354208787208da8a65421d%7C686ea1d3bc2b4c6fa92cd99c > 5c301635%7C0%7C0%7C637974464755794915%7CUnknown%7CTWFpbGZs > b3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0 > %3D%7C3000%7C%7C%7C&sdata=STvcSCxL25DqsrApiYi4Ma%2FqsQebi > MoXZqNWnjvHl9k%3D&reserved=0 > > > > > when run dtbs_check will occur nodename not match issue because the > > old dts nodename can't match new rule. I have modified thoes old dts, > > and will upstream in the near future. > > Please send it with this series. I will prepare this series patch. > > > > > Signed-off-by: Joy Zou <joy.zou@xxxxxxx> > > --- > > Changes since (implicit) v2: > > modify the commit message in patch v3. > > modify the filename in patch v3. > > modify the maintainer in patch v3. > > delete the unnecessary comment in patch v3. > > modify the compatible and run dt_binding_check and dtbs_check in patch > > v3. > > add clocks and clock-names property in patch v3. > > delete the reg description and add maxItems in patch v3. > > delete the interrupts description and add maxItems in patch v3. > > add ref for gpr property. > > modify the fsl,sdma-event-remap ref type and add items in patch v3. > > delete consumer example in patch v3. > > --- > > .../devicetree/bindings/dma/fsl,imx-sdma.yaml | 142 > > ++++++++++++++++++ .../devicetree/bindings/dma/fsl-imx-sdma.txt | > > 118 --------------- > > 2 files changed, 142 insertions(+), 118 deletions(-) create mode > > 100644 Documentation/devicetree/bindings/dma/fsl,imx-sdma.yaml > > delete mode 100644 > > Documentation/devicetree/bindings/dma/fsl-imx-sdma.txt > > > > diff --git a/Documentation/devicetree/bindings/dma/fsl,imx-sdma.yaml > > b/Documentation/devicetree/bindings/dma/fsl,imx-sdma.yaml > > new file mode 100644 > > index 000000000000..54cd99ae127f > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/dma/fsl,imx-sdma.yaml > > @@ -0,0 +1,142 @@ > > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause %YAML 1.2 > > +--- > > +$id: > > +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi > > > +cetree.org%2Fschemas%2Fdma%2Ffsl%2Cimx-sdma.yaml%23&data=05 > %7C01% > > > +7Cjoy.zou%40nxp.com%7C55890065ef354208787208da8a65421d%7C686ea > 1d3bc2b > > > +4c6fa92cd99c5c301635%7C0%7C0%7C637974464755794915%7CUnknown > %7CTWFpbGZ > > > +sb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6M > n0% > > > +3D%7C3000%7C%7C%7C&sdata=G1H5konCS21TvDIYo9B46tXZTIpT86OV > gO3pfRaT > > +0%2F8%3D&reserved=0 > > +$schema: > > +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi > > > +cetree.org%2Fmeta-schemas%2Fcore.yaml%23&data=05%7C01%7Cjoy.z > ou%4 > > > +0nxp.com%7C55890065ef354208787208da8a65421d%7C686ea1d3bc2b4c6 > fa92cd99 > > > +c5c301635%7C0%7C0%7C637974464755794915%7CUnknown%7CTWFpbG > Zsb3d8eyJWIj > > > +oiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3 > 000%7 > > > +C%7C%7C&sdata=NnDnwpVwextS4ygO9JM3jkLpAk19jHnI%2BJ%2FnW1 > sGzzk%3D& > > +amp;reserved=0 > > + > > +title: Freescale Smart Direct Memory Access (SDMA) Controller for > > +i.MX > > + > > +maintainers: > > + - Joy Zou <joy.zou@xxxxxxx> > > + > > +allOf: > > + - $ref: "dma-controller.yaml#" > > Drop the quotes. I will delete it. > > > + > > +properties: > > + compatible: > > + oneOf: > > + - items: > > + - enum: > > + - fsl,imx50-sdma > > + - fsl,imx51-sdma > > + - fsl,imx53-sdma > > + - fsl,imx6q-sdma > > + - fsl,imx7d-sdma > > + - const: fsl,imx35-sdma > > What happened to fsl,imx35-to1-sdma and others? This does not look like pure > conversion and your commit msg did not explain differences to the binding. > I have checked fsl,imx35-to1-sdma and others that don't are used, so delete item. I am sorry, the difference description was omitted, I will add in patch v4. > > + - items: > > + - enum: > > + - fsl,imx6sx-sdma > > + - fsl,imx6ul-sdma > > + - fsl,imx6sl-sdma > > + - const: fsl,imx6q-sdma > > All this also differ from original binding, so describe the reason behind the > changes. The original binding only list partial compatible name, but not describe the relation between compatible. I list different cases in order to describe the platform relation and difference. I will add in patch v4. > > > + - items: > > + - const: fsl,imx6ul-sdma > > + - const: fsl,imx6q-sdma > > + - const: fsl,imx35-sdma > > You have fsl,imx6ul-sdma above so this is duplicating stuff. I am sorry but this > looks very odd. I will delete it and modify the dts in patch v4. > > > > + - items: > > + - const: fsl,imx6sll-sdma > > + - const: fsl,imx6ul-sdma > > + - items: > > + - const: fsl,imx8mq-sdma > > + - const: fsl,imx7d-sdma > > + - items: > > + - enum: > > + - fsl,imx8mp-sdma > > + - fsl,imx8mn-sdma > > + - fsl,imx8mm-sdma > > + - const: fsl,imx8mq-sdma > > + - items: > > + - const: fsl,imx25-sdma > > + - items: > > + - const: fsl,imx31-sdma > > + - items: > > + - const: fsl,imx35-sdma > > All these three last entries are not "items", but one enum. I will change items into enum in patch v4. > > > + reg: > > + maxItems: 1 > > + > > + interrupts: > > + maxItems: 1 > > + > > + fsl,sdma-ram-script-name: > > + $ref: /schemas/types.yaml#/definitions/string > > + description: Should contain the full path of SDMA RAM scripts > firmware. > > + > > + "#dma-cells": > > + const: 3 > > + description: | > > + The first cell: request/event ID > > + > > + The second cell: peripheral types ID > > + enum: > > + - MCU domain SSI: 0 > > + - Shared SSI: 1 > > + - MMC: 2 > > + - SDHC: 3 > > + - MCU domain UART: 4 > > + - Shared UART: 5 > > + - FIRI: 6 > > + - MCU domain CSPI: 7 > > + - Shared CSPI: 8 > > + - SIM: 9 > > + - ATA: 10 > > + - CCM: 11 > > + - External peripheral: 12 > > + - Memory Stick Host Controller: 13 > > + - Shared Memory Stick Host Controller: 14 > > + - DSP: 15 > > + - Memory: 16 > > + - FIFO type Memory: 17 > > + - SPDIF: 18 > > + - IPU Memory: 19 > > + - ASRC: 20 > > + - ESAI: 21 > > + - SSI Dual FIFO: 22 > > + description: needs firmware more than ver 2 > > + - Shared ASRC: 23 > > + - SAI: 24 > > + - HDMI Audio: 25 > > + > > + The third cell: transfer priority ID > > + enum: > > + - High: 0 > > + - Medium: 1 > > + - Low: 2 > > + > > + gpr: > > + $ref: /schemas/types.yaml#/definitions/phandle > > + description: The phandle to the General Purpose Register (GPR) > > + node > > + > > + fsl,sdma-event-remap: > > + $ref: /schemas/types.yaml#/definitions/uint32-matrix > > + items: > > + - description: The GPR register offset, shift and value for RX > > + - description: The GPR register offset, shift and value for TX > > + description: | > > + Register bits of sdma event remap, the format is <reg shift val>. > > + > > + clocks: > > + maxItems: 2 > > + > > + clock-names: > > + maxItems: 2 > > You need to list the items and if they are non-obvious also describe them in > clocks. I will add items and description in patch v4. Thank you very much for your effort to provide valuable and important comments on my patch. BR Joy Zou > > > diff --git a/Documentation/devicetree/bindings/dma/fsl-imx-sdma.txt > > b/Documentation/devicetree/bindings/dma/fsl-imx-sdma.txt > > deleted file mode 100644 > > index 12c316ff4834..000000000000 > > --- a/Documentation/devicetree/bindings/dma/fsl-imx-sdma.txt > > +++ /dev/null > > @@ -1,118 +0,0 @@ > > -* Freescale Smart Direct Memory Access (SDMA) Controller for i.MX > > - > > -Required properties: > > -- compatible : Should be one of > > - "fsl,imx25-sdma" > > - "fsl,imx31-sdma", "fsl,imx31-to1-sdma", "fsl,imx31-to2-sdma" > > - "fsl,imx35-sdma", "fsl,imx35-to1-sdma", "fsl,imx35-to2-sdma" > > - "fsl,imx51-sdma" > > - "fsl,imx53-sdma" > > - "fsl,imx6q-sdma" > > - "fsl,imx7d-sdma" > > - "fsl,imx6ul-sdma" > > - "fsl,imx8mq-sdma" > > - "fsl,imx8mm-sdma" > > - "fsl,imx8mn-sdma" > > - "fsl,imx8mp-sdma" > > - The -to variants should be preferred since they allow to determine > > the > > - correct ROM script addresses needed for the driver to work without > > additional > > - firmware. > > -- reg : Should contain SDMA registers location and length > > -- interrupts : Should contain SDMA interrupt > > -- #dma-cells : Must be <3>. > > - The first cell specifies the DMA request/event ID. See details > > below > > - about the second and third cell. > > -- fsl,sdma-ram-script-name : Should contain the full path of SDMA RAM > > - scripts firmware > > - > > -The second cell of dma phandle specifies the peripheral type of DMA > transfer. > > -The full ID of peripheral types can be found below. > > - > > - ID transfer type > > - --------------------- > > - 0 MCU domain SSI > > - 1 Shared SSI > > - 2 MMC > > - 3 SDHC > > - 4 MCU domain UART > > - 5 Shared UART > > - 6 FIRI > > - 7 MCU domain CSPI > > - 8 Shared CSPI > > - 9 SIM > > - 10 ATA > > - 11 CCM > > - 12 External peripheral > > - 13 Memory Stick Host Controller > > - 14 Shared Memory Stick Host Controller > > - 15 DSP > > - 16 Memory > > - 17 FIFO type Memory > > - 18 SPDIF > > - 19 IPU Memory > > - 20 ASRC > > - 21 ESAI > > - 22 SSI Dual FIFO (needs firmware ver >= 2) > > - 23 Shared ASRC > > - 24 SAI > > - > > -The third cell specifies the transfer priority as below. > > - > > - ID transfer priority > > - ------------------------- > > - 0 High > > - 1 Medium > > - 2 Low > > - > > -Optional properties: > > - > > -- gpr : The phandle to the General Purpose Register (GPR) node. > > -- fsl,sdma-event-remap : Register bits of sdma event remap, the > > format is > > - <reg shift val>. > > - reg is the GPR register offset. > > - shift is the bit position inside the GPR register. > > - val is the value of the bit (0 or 1). > > - > > -Examples: > > - > > -sdma@83fb0000 { > > - compatible = "fsl,imx51-sdma", "fsl,imx35-sdma"; > > - reg = <0x83fb0000 0x4000>; > > - interrupts = <6>; > > - #dma-cells = <3>; > > - fsl,sdma-ram-script-name = "sdma-imx51.bin"; > > -}; > > - > > -DMA clients connected to the i.MX SDMA controller must use the format > > -described in the dma.txt file. > > - > > -Examples: > > - > > -ssi2: ssi@70014000 { > > - compatible = "fsl,imx51-ssi", "fsl,imx21-ssi"; > > - reg = <0x70014000 0x4000>; > > - interrupts = <30>; > > - clocks = <&clks 49>; > > - dmas = <&sdma 24 1 0>, > > - <&sdma 25 1 0>; > > - dma-names = "rx", "tx"; > > - fsl,fifo-depth = <15>; > > -}; > > - > > -Using the fsl,sdma-event-remap property: > > - > > -If we want to use SDMA on the SAI1 port on a MX6SX: > > - > > -&sdma { > > - gpr = <&gpr>; > > - /* SDMA events remap for SAI1_RX and SAI1_TX */ > > - fsl,sdma-event-remap = <0 15 1>, <0 16 1>; > > -}; > > - > > -The fsl,sdma-event-remap property in this case has two values: > > -- <0 15 1> means that the offset is 0, so GPR0 is the register of the > > -SDMA remap. Bit 15 of GPR0 selects between UART4_RX and SAI1_RX. > > -Setting bit 15 to 1 selects SAI1_RX. > > -- <0 16 1> means that the offset is 0, so GPR0 is the register of the > > -SDMA remap. Bit 16 of GPR0 selects between UART4_TX and SAI1_TX. > > -Setting bit 16 to 1 selects SAI1_TX. > > Include such text in fsl,sdma-event-remap description. > > Best regards, > Krzysztof