Received-SPF: pass (google.com: domain of linux-kernel+bounces-192550-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Date: Tue, 28 May 2024 10:39:07 -0400
From: Frank Li <Frank.li@nxp.com>
To: Richard Zhu <hongxing.zhu@nxp.com>
Cc: conor@kernel.org, vkoul@kernel.org, kishon@kernel.org,
	robh+dt@kernel.org, krzysztof.kozlowski+dt@linaro.org,
	conor+dt@kernel.org, linux-phy@lists.infradead.org,
	devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, kernel@pengutronix.de,
	imx@lists.linux.dev
Subject: Re: [PATCH v6 1/2] dt-bindings: phy: Add i.MX8Q HSIO SerDes PHY
 binding
Message-ID: <ZlXsi8IFMyDjSJnk@lizhi-Precision-Tower-5810>
References: <1716865154-25044-1-git-send-email-hongxing.zhu@nxp.com>
 <1716865154-25044-2-git-send-email-hongxing.zhu@nxp.com>
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <1716865154-25044-2-git-send-email-hongxing.zhu@nxp.com>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?17DmoyAv+XbeZyto2fgne2dDeVCJD7YNB/hhvp0e02ntZgESZfy09Mj53egn?=
 =?us-ascii?Q?64dafCEF/81Me+ncKZDR58fkDAd7ADZ9sjMUfULaYlCwXXxKvn7+NbqnyGgO?=
 =?us-ascii?Q?xoYR7Qivs9yAdv7dR8c1PTWAinWM3UFbeXGEMkhhUsCA+hVJ5oFwJmn9GFIg?=
 =?us-ascii?Q?hqFT34l00RyxwppGUfYfT1xLppyLEoAqID3XfyzGDATZnOEILe8/wMooxHvf?=
 =?us-ascii?Q?DjaJpLGsudiDx5nnGNI+QTzo5AP3O+LseX7q+LebO5rw2vd9cKnkDGMoa4va?=
 =?us-ascii?Q?gY8uX+OkW4VxPTJzPEi9tO7Mr0NFS6myM+e+lb7ipQZ578iuhTviGqye8lAQ?=
 =?us-ascii?Q?SMUPhQuTnUijhxGxDfNfIpPU75jp9a6V6ZjnAgHPuCQJ/9/OIn8TavtW4q8M?=
 =?us-ascii?Q?2tbjARVeR6B/yxzblWdGpIPKoEHQoBfmjAiA/nnDibEbbS+bC8TTKuv99OWj?=
 =?us-ascii?Q?2PtGph3bf8ynvE5/YAt5XoAMnK95zDmbA9zbv8JMJQYM0bVRgB/Rfm0q/cJL?=
 =?us-ascii?Q?6j+DZoW6p41nRQPgu/yohYJLe+8ivNFg4h641efmb2PJfnvtUfAzrPBdHPey?=
 =?us-ascii?Q?OFR2fLczA1wf1mxnwvVAkzWsW5OE9aOO9YMF0PAj1APR9TwRm97uOCkYzioK?=
 =?us-ascii?Q?O4UQsO7tvWkMYvK5PsaVTt61feXBAY80HXioWLJHb0hmmojKufAbAC8TtoSV?=
 =?us-ascii?Q?pCvWbSfHqmJbDjYM/lHLhLFqqeRakux3bHChsx8+ufXUo6jQqtOge+++9now?=
 =?us-ascii?Q?jmUJrlQQRs+sOy8RLikPmjnJp/AuE7Cwahwu9CthpCJ9n6XWk7oBL8gpAu7h?=
 =?us-ascii?Q?X0O59XC8m+McxCkKmlb2VZuNtjL49LDV53zY902WW5NT2ue2oy1QlTVEWpQE?=
 =?us-ascii?Q?JgwZG/RtunvRHH8/wafCyQJHzNi1Rri3j7wAay4zk2oMu+h4vlFUWchjt4fI?=
 =?us-ascii?Q?iy02DgcyZDWAg9R2FY4UQyn3S75nHKTunMhf4bHFe984z/npfbXonjIK4Jrm?=
 =?us-ascii?Q?PoeoU509Bipyi7UxLHk19cEnK5YLBXsd/TokhE4xW7fR4epq8egfIbPNg2uj?=
 =?us-ascii?Q?NhTXCrjxLz8ApvQvyit6HzsT5xiGFgr0CpPt3LQL/2KbmA5eqEKaO3XYjmoa?=
 =?us-ascii?Q?vPnZ6r2gofywHga1QBnSTm0YPnBWx6sdKk8wpmANb+MRsVbmEVBcy6PMhVU3?=
 =?us-ascii?Q?tt+bcrr5MxSkRbQOkp1x2Ud9NWA6LgMrJGOnoMmyJNp2aQHlBaKaBV8sPVDh?=
 =?us-ascii?Q?2kCfHZucFsjdq9mfKyFESTiMVAmVp0N3/r5Ee+pYBt0IGfxMdXds1aaOvgW2?=
 =?us-ascii?Q?bUVXtBUJ68vEkQpk+MJU+bjfItg72EX+PpfP+uNCBPkwLuSdYI4VfHA3VK67?=
 =?us-ascii?Q?H56z9aOLjKZP+Evi6vtK02SImx0XAb/0b+bRgd9IQiogc5kL2avBz/AVLuOt?=
 =?us-ascii?Q?xB3nvDeY0S9x8fnLg06tyQF4QeMCYTs3VW5jYiMKFmbUSWl8bfdxYQM+aZ20?=
 =?us-ascii?Q?jdU0hkKd4ekwjWwmZsXy2rkNv9PBDn4/krDNfmg+ZEHTBhXciHROA81KItFX?=
 =?us-ascii?Q?KAxPtjpaPrAq/ceVhyICGjG9d8YmGpfNY9jicTLb?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 4556e5cd-db86-4ecf-ff14-08dc7f23f33e
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 May 2024 14:39:16.2455
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: Ae+vPYEpV7DPxaZsj9MYqZ53M3vqpmD28zL9BDp4Yi0X47OyepkWLm7VRIeDUXq94VWIPUFSfRgYmMvwdtlB1w==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: GVXPR04MB10405

On Tue, May 28, 2024 at 10:59:13AM +0800, Richard Zhu wrote:
> Add i.MX8QM and i.MX8QXP HSIO SerDes PHY binding.
> Introduce one HSIO configuration 'fsl,hsio-cfg', which need be set at
> initialization according to board design.
> 
> Signed-off-by: Richard Zhu <hongxing.zhu@nxp.com>
> ---
>  .../bindings/phy/fsl,imx8qm-hsio.yaml         | 164 ++++++++++++++++++
>  1 file changed, 164 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/phy/fsl,imx8qm-hsio.yaml
> 
> diff --git a/Documentation/devicetree/bindings/phy/fsl,imx8qm-hsio.yaml b/Documentation/devicetree/bindings/phy/fsl,imx8qm-hsio.yaml
> new file mode 100644
> index 000000000000..8af342ef3be3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/fsl,imx8qm-hsio.yaml
> @@ -0,0 +1,164 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/phy/fsl,imx8qm-hsio.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Freescale i.MX8QM SoC series High Speed IO(HSIO) SERDES PHY
> +
> +maintainers:
> +  - Richard Zhu <hongxing.zhu@nxp.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - fsl,imx8qm-hsio
> +      - fsl,imx8qxp-hsio
> +  reg:
> +    items:
> +      - description: Base address and length of the PHY block
> +      - description: HSIO control and status registers(CSR) of the PHY
> +      - description: HSIO CSR of the controller bound to the PHY
> +      - description: HSIO CSR for MISC
> +
> +  reg-names:
> +    items:
> +      - const: reg
> +      - const: phy
> +      - const: ctrl
> +      - const: misc
> +
> +  "#phy-cells":
> +    const: 3
> +    description:
> +      The first defines lane index.
> +      The second defines the type of the PHY refer to the include phy.h.
> +      The third defines the controller index, indicated which controller
> +      is bound to the lane.
> +
> +  clocks:
> +    minItems: 5
> +    maxItems: 14
> +
> +  clock-names:
> +    minItems: 5
> +    maxItems: 14
> +
> +  fsl,hsio-cfg:
> +    description:

Here need "|" because you want keep format for below table.


> +      Specifies the use case of the HSIO module in the hardware design.
> +      Regarding the design of i.MX8QM HSIO subsystem, HSIO module can be
> +      confiured as following three use cases.
> +      +-------------------------------------+
> +      |                | i.MX8QM            |
> +      |----------------|--------------------|
> +      |                | Lane0| Lane1| Lane2|
> +      |----------------|------|------|------|
> +      | pcieax2sata    | PCIEA| PCIEA| SATA |
> +      |----------------|------|------|------|
> +      | pcieax2pcieb   | PCIEA| PCIEA| PCIEB|
> +      |----------------|------|------|------|
> +      | pcieapciebsata | PCIEA| PCIEB| SATA |
> +      +-------------------------------------+
> +    $ref: /schemas/types.yaml#/definitions/string
> +    enum: [ pcieax2sata, pcieax2pcieb, pcieapciebsata]

how about:
	pciea-x2-sata, pciea-x2-pcieb, pciea-pcieb-sata

> +    default: pcieapciebsata
> +
> +  fsl,refclk-pad-mode:
> +    description:
> +      Specifies the mode of the refclk pad used. INPUT(PHY refclock is
> +      provided externally via the refclk pad) or OUTPUT(PHY refclock is
> +      derived from SoC internal source and provided on the refclk pad).
> +      This property not exists means unused(PHY refclock is derived from
> +      SoC internal source).
> +    $ref: /schemas/types.yaml#/definitions/string
> +    enum: [ input, output, unused ]
> +    default: unused
> +
> +  power-domains:
> +    minItems: 1
> +    maxItems: 2
> +
> +required:
> +  - compatible
> +  - reg
> +  - reg-names
> +  - "#phy-cells"
> +  - clocks
> +  - clock-names
> +  - fsl,hsio-cfg
> +
> +allOf:
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - fsl,imx8qxp-hsio
> +    then:
> +      properties:
> +        clock-names:
> +          items:
> +            - const: pclk0
> +            - const: apb_pclk0
> +            - const: phy0_crr
> +            - const: ctl0_crr
> +            - const: misc_crr
> +        power-domains:
> +          maxItems: 1
> +
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - fsl,imx8qm-hsio
> +    then:
> +      properties:
> +        clock-names:
> +          items:
> +            - const: pclk0
> +            - const: pclk1
> +            - const: apb_pclk0
> +            - const: apb_pclk1
> +            - const: pclk2
> +            - const: epcs_tx
> +            - const: epcs_rx
> +            - const: apb_pclk2
> +            - const: phy0_crr
> +            - const: phy1_crr
> +            - const: ctl0_crr
> +            - const: ctl1_crr
> +            - const: ctl2_crr
> +            - const: misc_crr
> +        power-domains:
> +          minItems: 2
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/imx8-clock.h>
> +    #include <dt-bindings/clock/imx8-lpcg.h>
> +    #include <dt-bindings/firmware/imx/rsrc.h>
> +    #include <dt-bindings/phy/phy-imx8-pcie.h>
> +
> +    phy@5f1a0000 {
> +        compatible = "fsl,imx8qxp-hsio";
> +        reg = <0x5f1a0000 0x10000>,
> +              <0x5f120000 0x10000>,
> +              <0x5f140000 0x10000>,
> +              <0x5f160000 0x10000>;
> +        reg-names = "reg", "phy", "ctrl", "misc";
> +        clocks = <&phyx1_lpcg IMX_LPCG_CLK_0>,
> +                 <&phyx1_lpcg IMX_LPCG_CLK_4>,
> +                 <&phyx1_crr1_lpcg IMX_LPCG_CLK_4>,
> +                 <&pcieb_crr3_lpcg IMX_LPCG_CLK_4>,
> +                 <&misc_crr5_lpcg IMX_LPCG_CLK_4>;
> +        clock-names = "pclk0", "apb_pclk0", "phy0_crr", "ctl0_crr", "misc_crr";
> +        power-domains = <&pd IMX_SC_R_SERDES_1>;
> +        #phy-cells = <3>;
> +        fsl,hsio-cfg = "pcieapciebsata";
> +        fsl,refclk-pad-mode = "input";
> +    };
> +...
> -- 
> 2.37.1
>