| Message ID | 20211221182826.2141789-1-jaschultzMS@gmail.com |
|---|---|
| Headers | show |
| Series | platform: surface: Introduce Surface XBL Driver | expand |
On Tue, 21 Dec 2021 10:28:23 -0800, Jarrett Schultz wrote: > From: Jarrett Schultz <jaschultz@microsoft.com> > > Introduce yaml for surface xbl driver. > > Signed-off-by: Jarrett Schultz <jaschultz@microsoft.com> > > --- > > Changes in v4: > - Addressed small formatting changes > - Removed unnecessary lines > > --- > > Changes in v3: > - Updated description to only pertain to the hardware > - Updated the required field to properly reflect the binding > - Removed the first example > - Fixed the size of the reg field in the second example > > --- > > Changes in v2: > - Removed json-schema dependence > - Elaborated on description of driver > - Updated example > --- > .../platform/microsoft/surface-xbl.yaml | 64 +++++++++++++++++++ > MAINTAINERS | 7 ++ > 2 files changed, 71 insertions(+) > create mode 100644 Documentation/devicetree/bindings/platform/microsoft/surface-xbl.yaml > My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' on your patch (DT_CHECKER_FLAGS is new in v5.13): yamllint warnings/errors: dtschema/dtc warnings/errors: Documentation/devicetree/bindings/platform/microsoft/surface-xbl.example.dt.yaml:0:0: /imem@146bf000/xbl@a94: failed to match any schema with compatible: ['microsoft,sm8150-surface-duo-xbl'] doc reference errors (make refcheckdocs): See https://patchwork.ozlabs.org/patch/1571914 This check can fail if there are any dependencies. The base for a patch series is generally the most recent rc1. If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date: pip3 install dtschema --upgrade Please check and re-submit.
On Tue, Dec 21, 2021 at 10:28:23AM -0800, Jarrett Schultz wrote: > From: Jarrett Schultz <jaschultz@microsoft.com> > > Introduce yaml for surface xbl driver. > > Signed-off-by: Jarrett Schultz <jaschultz@microsoft.com> > > --- > > Changes in v4: > - Addressed small formatting changes > - Removed unnecessary lines > > --- > > Changes in v3: > - Updated description to only pertain to the hardware > - Updated the required field to properly reflect the binding > - Removed the first example > - Fixed the size of the reg field in the second example > > --- > > Changes in v2: > - Removed json-schema dependence > - Elaborated on description of driver > - Updated example > --- > .../platform/microsoft/surface-xbl.yaml | 64 +++++++++++++++++++ > MAINTAINERS | 7 ++ > 2 files changed, 71 insertions(+) > create mode 100644 Documentation/devicetree/bindings/platform/microsoft/surface-xbl.yaml > > diff --git a/Documentation/devicetree/bindings/platform/microsoft/surface-xbl.yaml b/Documentation/devicetree/bindings/platform/microsoft/surface-xbl.yaml > new file mode 100644 > index 000000000000..df5a87a016f4 > --- /dev/null > +++ b/Documentation/devicetree/bindings/platform/microsoft/surface-xbl.yaml > @@ -0,0 +1,64 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/platform/microsoft/surface-xbl.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Surface Extensible Bootloader for Microsoft Surface Duo > + > +maintainers: > + - Jarrett Schultz <jaschultz@microsoft.com> > + > +description: | > + Defined to expose information that is used during production when > + device is in manufacturing mode. Some of the information included > + in this imem section is - If this is onchip sram, we have a binding for that. That's not an MFD. > + * board_id > + * battery_present > + * hw_init_retries > + * is_customer_mode > + * is_act_mode > + * pmic_reset_reason > + * touch_fw_version > + * ocp_error_location nvmem binding doesn't work for describing these fields? > + See sysfs documentation for more information. sysfs? Not relevant to the binding. > + > +properties: > + compatible: > + const: simple-mfd > + > + reg: > + maxItems: 1 > + > +additionalProperties: false > + > +required: > + - compatible > + - reg > + - ranges > + - address-cells > + - size-cells > + > +examples: > + - | > + / { > + compatible = "foo"; > + model = "foo"; No need to make this the root node with a fake compatible. > + #address-cells = <2>; > + #size-cells = <2>; > + > + imem@146bf000 { > + compatible = "simple-mfd"; > + reg = <0x0 0x146bf000 0x0 0x1000>; > + ranges = <0x0 0x0 0x146bf000 0x1000>; > + #address-cells = <1>; > + #size-cells = <1>; > + status = "okay"; Don't show status in examples. > + > + xbl@a94 { > + compatible = "microsoft,sm8150-surface-duo-xbl"; > + reg = <0xa94 0x100>; > + status = "okay"; > + }; > + }; > + }; > diff --git a/MAINTAINERS b/MAINTAINERS > index 13f9a84a617e..5d0ca2a98b57 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -12649,6 +12649,13 @@ F: Documentation/driver-api/surface_aggregator/clients/dtx.rst > F: drivers/platform/surface/surface_dtx.c > F: include/uapi/linux/surface_aggregator/dtx.h > > +MICROSOFT SURFACE DUO XBL DRIVER > +M: Jarrett Schultz <jaschultz@microsoft.com> > +L: linux-arm-msm@vger.kernel.org > +L: platform-driver-x86@vger.kernel.org > +S: Supported > +F: Documentation/devicetree/bindings/platform/microsoft/surface-xbl.yaml > + > MICROSOFT SURFACE GPE LID SUPPORT DRIVER > M: Maximilian Luz <luzmaximilian@gmail.com> > L: platform-driver-x86@vger.kernel.org > -- > 2.25.1 > >
> -----Original Message----- > From: Rob Herring <robh@kernel.org> > Sent: Tuesday, December 21, 2021 5:24 PM > To: Jarrett Schultz <jaschultzms@gmail.com> > Cc: Andy Gross <agross@kernel.org>; bjorn.andersson@linaro.org; Hans de > Goede <hdegoede@redhat.com>; Mark Gross <markgross@kernel.org>; > Maximilian Luz <luzmaximilian@gmail.com>; Felipe Balbi > <balbi@kernel.org>; linux-arm-msm@vger.kernel.org; platform-driver- > x86@vger.kernel.org; linux-kernel@vger.kernel.org; > devicetree@vger.kernel.org; Jarrett Schultz <jaschultz@microsoft.com> > Subject: [EXTERNAL] Re: [PATCH RESEND v4 1/4] dt-bindings: platform: > microsoft: Document surface xbl > > On Tue, Dec 21, 2021 at 10:28:23AM -0800, Jarrett Schultz wrote: > > From: Jarrett Schultz <jaschultz@microsoft.com> > > > > Introduce yaml for surface xbl driver. > > > > Signed-off-by: Jarrett Schultz <jaschultz@microsoft.com> > > > > --- > > > > Changes in v4: > > - Addressed small formatting changes > > - Removed unnecessary lines > > > > --- > > > > Changes in v3: > > - Updated description to only pertain to the hardware > > - Updated the required field to properly reflect the binding > > - Removed the first example > > - Fixed the size of the reg field in the second example > > > > --- > > > > Changes in v2: > > - Removed json-schema dependence > > - Elaborated on description of driver > > - Updated example > > --- > > .../platform/microsoft/surface-xbl.yaml | 64 +++++++++++++++++++ > > MAINTAINERS | 7 ++ > > 2 files changed, 71 insertions(+) > > create mode 100644 > > Documentation/devicetree/bindings/platform/microsoft/surface-xbl.yaml > > > > diff --git > > a/Documentation/devicetree/bindings/platform/microsoft/surface- > xbl.yam > > l > > b/Documentation/devicetree/bindings/platform/microsoft/surface- > xbl.yam > > l > > new file mode 100644 > > index 000000000000..df5a87a016f4 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/platform/microsoft/surface-xbl > > +++ .yaml > > @@ -0,0 +1,64 @@ > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2 > > +--- > > +$id: > > > +https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi > > +cetree.org%2Fschemas%2Fplatform%2Fmicrosoft%2Fsurface- > xbl.yaml%23& > > > +;data=04%7C01%7Cjaschultz%40microsoft.com%7C77abe729b69a40624472 > 08d9c > > > +4d8f44e%7C72f988bf86f141af91ab2d7cd011db47%7C0%7C0%7C637757258 > 3887312 > > > +05%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luM > zIiLCJBTi > > > +I6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=jG0qubz122GG2s8%2B > 1ZuMCcPIa > > +33KWwPoO2VNlDySmvs%3D&reserved=0 > > +$schema: > > > +https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi > > +cetree.org%2Fmeta- > schemas%2Fcore.yaml%23&data=04%7C01%7Cjaschultz > > > +%40microsoft.com%7C77abe729b69a4062447208d9c4d8f44e%7C72f988bf8 > 6f141a > > > +f91ab2d7cd011db47%7C0%7C0%7C637757258388731205%7CUnknown%7C > TWFpbGZsb3 > > > +d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0 > %3D% > > > +7C3000&sdata=FxKNLPok9eW%2FBPmuGzU6x7dPwpnev0Ngr8epO4NA > UzA%3D& > > +;reserved=0 > > + > > +title: Surface Extensible Bootloader for Microsoft Surface Duo > > + > > +maintainers: > > + - Jarrett Schultz <jaschultz@microsoft.com> > > + > > +description: | > > + Defined to expose information that is used during production when > > + device is in manufacturing mode. Some of the information included > > + in this imem section is - > > If this is onchip sram, we have a binding for that. That's not an MFD. > > > + * board_id > > + * battery_present > > + * hw_init_retries > > + * is_customer_mode > > + * is_act_mode > > + * pmic_reset_reason > > + * touch_fw_version > > + * ocp_error_location > > nvmem binding doesn't work for describing these fields? > > > + See sysfs documentation for more information. > > sysfs? Not relevant to the binding. > > > + > > +properties: > > + compatible: > > + const: simple-mfd > > + > > + reg: > > + maxItems: 1 > > + > > +additionalProperties: false > > + > > +required: > > + - compatible > > + - reg > > + - ranges > > + - address-cells > > + - size-cells > > + > > +examples: > > + - | > > + / { > > + compatible = "foo"; > > + model = "foo"; > > No need to make this the root node with a fake compatible. I included this root node in order to make #address-cells = #size-cells = 2, since this example raises errors otherwise. > > > + #address-cells = <2>; > > + #size-cells = <2>; > > + > > + imem@146bf000 { > > + compatible = "simple-mfd"; > > + reg = <0x0 0x146bf000 0x0 0x1000>; > > + ranges = <0x0 0x0 0x146bf000 0x1000>; > > + #address-cells = <1>; > > + #size-cells = <1>; > > + status = "okay"; > > Don't show status in examples. > > > + > > + xbl@a94 { > > + compatible = "microsoft,sm8150-surface-duo-xbl"; > > + reg = <0xa94 0x100>; > > + status = "okay"; > > + }; > > + }; > > + }; > > diff --git a/MAINTAINERS b/MAINTAINERS index > > 13f9a84a617e..5d0ca2a98b57 100644 > > --- a/MAINTAINERS > > +++ b/MAINTAINERS > > @@ -12649,6 +12649,13 @@ F: Documentation/driver- > api/surface_aggregator/clients/dtx.rst > > F: drivers/platform/surface/surface_dtx.c > > F: include/uapi/linux/surface_aggregator/dtx.h > > > > +MICROSOFT SURFACE DUO XBL DRIVER > > +M: Jarrett Schultz <jaschultz@microsoft.com> > > +L: linux-arm-msm@vger.kernel.org > > +L: platform-driver-x86@vger.kernel.org > > +S: Supported > > +F: Documentation/devicetree/bindings/platform/microsoft/surface- > xbl.yaml > > + > > MICROSOFT SURFACE GPE LID SUPPORT DRIVER > > M: Maximilian Luz <luzmaximilian@gmail.com> > > L: platform-driver-x86@vger.kernel.org > > -- > > 2.25.1 > > > >
On Mon, Dec 27, 2021 at 10:54 AM Jarrett Schultz <jaschultz@microsoft.com> wrote: > > > > > -----Original Message----- > > From: Rob Herring <robh@kernel.org> > > Sent: Tuesday, December 21, 2021 5:24 PM > > To: Jarrett Schultz <jaschultzms@gmail.com> > > Cc: Andy Gross <agross@kernel.org>; bjorn.andersson@linaro.org; Hans de > > Goede <hdegoede@redhat.com>; Mark Gross <markgross@kernel.org>; > > Maximilian Luz <luzmaximilian@gmail.com>; Felipe Balbi > > <balbi@kernel.org>; linux-arm-msm@vger.kernel.org; platform-driver- > > x86@vger.kernel.org; linux-kernel@vger.kernel.org; > > devicetree@vger.kernel.org; Jarrett Schultz <jaschultz@microsoft.com> > > Subject: [EXTERNAL] Re: [PATCH RESEND v4 1/4] dt-bindings: platform: > > microsoft: Document surface xbl > > > > On Tue, Dec 21, 2021 at 10:28:23AM -0800, Jarrett Schultz wrote: > > > From: Jarrett Schultz <jaschultz@microsoft.com> > > > > > > Introduce yaml for surface xbl driver. > > > > > > Signed-off-by: Jarrett Schultz <jaschultz@microsoft.com> > > > > > > --- > > > > > > Changes in v4: > > > - Addressed small formatting changes > > > - Removed unnecessary lines > > > > > > --- > > > > > > Changes in v3: > > > - Updated description to only pertain to the hardware > > > - Updated the required field to properly reflect the binding > > > - Removed the first example > > > - Fixed the size of the reg field in the second example > > > > > > --- > > > > > > Changes in v2: > > > - Removed json-schema dependence > > > - Elaborated on description of driver > > > - Updated example > > > --- > > > .../platform/microsoft/surface-xbl.yaml | 64 +++++++++++++++++++ > > > MAINTAINERS | 7 ++ > > > 2 files changed, 71 insertions(+) > > > create mode 100644 > > > Documentation/devicetree/bindings/platform/microsoft/surface-xbl.yaml > > > > > > diff --git > > > a/Documentation/devicetree/bindings/platform/microsoft/surface- > > xbl.yam > > > l > > > b/Documentation/devicetree/bindings/platform/microsoft/surface- > > xbl.yam > > > l > > > new file mode 100644 > > > index 000000000000..df5a87a016f4 > > > --- /dev/null > > > +++ b/Documentation/devicetree/bindings/platform/microsoft/surface-xbl > > > +++ .yaml > > > @@ -0,0 +1,64 @@ > > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2 > > > +--- > > > +$id: > > > > > +https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi > > > +cetree.org%2Fschemas%2Fplatform%2Fmicrosoft%2Fsurface- > > xbl.yaml%23& > > > > > +;data=04%7C01%7Cjaschultz%40microsoft.com%7C77abe729b69a40624472 > > 08d9c > > > > > +4d8f44e%7C72f988bf86f141af91ab2d7cd011db47%7C0%7C0%7C637757258 > > 3887312 > > > > > +05%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luM > > zIiLCJBTi > > > > > +I6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=jG0qubz122GG2s8%2B > > 1ZuMCcPIa > > > +33KWwPoO2VNlDySmvs%3D&reserved=0 > > > +$schema: > > > > > +https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi > > > +cetree.org%2Fmeta- > > schemas%2Fcore.yaml%23&data=04%7C01%7Cjaschultz > > > > > +%40microsoft.com%7C77abe729b69a4062447208d9c4d8f44e%7C72f988bf8 > > 6f141a > > > > > +f91ab2d7cd011db47%7C0%7C0%7C637757258388731205%7CUnknown%7C > > TWFpbGZsb3 > > > > > +d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0 > > %3D% > > > > > +7C3000&sdata=FxKNLPok9eW%2FBPmuGzU6x7dPwpnev0Ngr8epO4NA > > UzA%3D& > > > +;reserved=0 > > > + > > > +title: Surface Extensible Bootloader for Microsoft Surface Duo > > > + > > > +maintainers: > > > + - Jarrett Schultz <jaschultz@microsoft.com> > > > + > > > +description: | > > > + Defined to expose information that is used during production when > > > + device is in manufacturing mode. Some of the information included > > > + in this imem section is - > > > > If this is onchip sram, we have a binding for that. That's not an MFD. > > > > > + * board_id > > > + * battery_present > > > + * hw_init_retries > > > + * is_customer_mode > > > + * is_act_mode > > > + * pmic_reset_reason > > > + * touch_fw_version > > > + * ocp_error_location > > > > nvmem binding doesn't work for describing these fields? > > > > > + See sysfs documentation for more information. > > > > sysfs? Not relevant to the binding. > > > > > + > > > +properties: > > > + compatible: > > > + const: simple-mfd > > > + > > > + reg: > > > + maxItems: 1 > > > + > > > +additionalProperties: false > > > + > > > +required: > > > + - compatible > > > + - reg > > > + - ranges > > > + - address-cells > > > + - size-cells > > > + > > > +examples: > > > + - | > > > + / { > > > + compatible = "foo"; > > > + model = "foo"; > > > > No need to make this the root node with a fake compatible. > > I included this root node in order to make #address-cells = #size-cells = 2, > since this example raises errors otherwise. Why does your example require 2 cells? You only have 4KB of address space. Though you can do: bus { #address-cells = <2>; #size-cells = <2>; ... }; Rob
> -----Original Message----- > From: Rob Herring <robh@kernel.org> > Sent: Monday, December 27, 2021 9:46 AM > To: Jarrett Schultz <jaschultz@microsoft.com> > Cc: Jarrett Schultz <jaschultzms@gmail.com>; Andy Gross > <agross@kernel.org>; bjorn.andersson@linaro.org; Hans de Goede > <hdegoede@redhat.com>; Mark Gross <markgross@kernel.org>; Maximilian > Luz <luzmaximilian@gmail.com>; Felipe Balbi <balbi@kernel.org>; linux-arm- > msm@vger.kernel.org; platform-driver-x86@vger.kernel.org; linux- > kernel@vger.kernel.org; devicetree@vger.kernel.org > Subject: Re: [EXTERNAL] Re: [PATCH RESEND v4 1/4] dt-bindings: platform: > microsoft: Document surface xbl > > On Mon, Dec 27, 2021 at 10:54 AM Jarrett Schultz > <jaschultz@microsoft.com> wrote: > > > > > > > > > -----Original Message----- > > > From: Rob Herring <robh@kernel.org> > > > Sent: Tuesday, December 21, 2021 5:24 PM > > > To: Jarrett Schultz <jaschultzms@gmail.com> > > > Cc: Andy Gross <agross@kernel.org>; bjorn.andersson@linaro.org; Hans > > > de Goede <hdegoede@redhat.com>; Mark Gross > <markgross@kernel.org>; > > > Maximilian Luz <luzmaximilian@gmail.com>; Felipe Balbi > > > <balbi@kernel.org>; linux-arm-msm@vger.kernel.org; platform-driver- > > > x86@vger.kernel.org; linux-kernel@vger.kernel.org; > > > devicetree@vger.kernel.org; Jarrett Schultz > > > <jaschultz@microsoft.com> > > > Subject: [EXTERNAL] Re: [PATCH RESEND v4 1/4] dt-bindings: platform: > > > microsoft: Document surface xbl > > > > > > On Tue, Dec 21, 2021 at 10:28:23AM -0800, Jarrett Schultz wrote: > > > > From: Jarrett Schultz <jaschultz@microsoft.com> > > > > > > > > Introduce yaml for surface xbl driver. > > > > > > > > Signed-off-by: Jarrett Schultz <jaschultz@microsoft.com> > > > > > > > > --- > > > > > > > > Changes in v4: > > > > - Addressed small formatting changes > > > > - Removed unnecessary lines > > > > > > > > --- > > > > > > > > Changes in v3: > > > > - Updated description to only pertain to the hardware > > > > - Updated the required field to properly reflect the binding > > > > - Removed the first example > > > > - Fixed the size of the reg field in the second example > > > > > > > > --- > > > > > > > > Changes in v2: > > > > - Removed json-schema dependence > > > > - Elaborated on description of driver > > > > - Updated example > > > > --- > > > > .../platform/microsoft/surface-xbl.yaml | 64 +++++++++++++++++++ > > > > MAINTAINERS | 7 ++ > > > > 2 files changed, 71 insertions(+) create mode 100644 > > > > Documentation/devicetree/bindings/platform/microsoft/surface-xbl.y > > > > aml > > > > > > > > diff --git > > > > a/Documentation/devicetree/bindings/platform/microsoft/surface- > > > xbl.yam > > > > l > > > > b/Documentation/devicetree/bindings/platform/microsoft/surface- > > > xbl.yam > > > > l > > > > new file mode 100644 > > > > index 000000000000..df5a87a016f4 > > > > --- /dev/null > > > > +++ b/Documentation/devicetree/bindings/platform/microsoft/surface > > > > +++ -xbl > > > > +++ .yaml > > > > @@ -0,0 +1,64 @@ > > > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML > > > > +1.2 > > > > +--- > > > > +$id: > > > > > > > > +https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Fde > > > +vi > > > > +cetree.org%2Fschemas%2Fplatform%2Fmicrosoft%2Fsurface- > > > xbl.yaml%23& > > > > > > > > +;data=04%7C01%7Cjaschultz%40microsoft.com%7C77abe729b69a40624472 > > > 08d9c > > > > > > > > +4d8f44e%7C72f988bf86f141af91ab2d7cd011db47%7C0%7C0%7C637757258 > > > 3887312 > > > > > > > > +05%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luM > > > zIiLCJBTi > > > > > > > > +I6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=jG0qubz122GG2s8%2B > > > 1ZuMCcPIa > > > > +33KWwPoO2VNlDySmvs%3D&reserved=0 > > > > +$schema: > > > > > > > > +https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Fde > > > +vi > > > > +cetree.org%2Fmeta- > > > schemas%2Fcore.yaml%23&data=04%7C01%7Cjaschultz > > > > > > > > +%40microsoft.com%7C77abe729b69a4062447208d9c4d8f44e%7C72f988bf8 > > > 6f141a > > > > > > > > +f91ab2d7cd011db47%7C0%7C0%7C637757258388731205%7CUnknown%7C > > > TWFpbGZsb3 > > > > > > > > +d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0 > > > %3D% > > > > > > > > +7C3000&sdata=FxKNLPok9eW%2FBPmuGzU6x7dPwpnev0Ngr8epO4NA > > > UzA%3D& > > > > +;reserved=0 > > > > + > > > > +title: Surface Extensible Bootloader for Microsoft Surface Duo > > > > + > > > > +maintainers: > > > > + - Jarrett Schultz <jaschultz@microsoft.com> > > > > + > > > > +description: | > > > > + Defined to expose information that is used during production > > > > +when > > > > + device is in manufacturing mode. Some of the information > > > > +included > > > > + in this imem section is - > > > > > > If this is onchip sram, we have a binding for that. That's not an MFD. > > > > > > > + * board_id > > > > + * battery_present > > > > + * hw_init_retries > > > > + * is_customer_mode > > > > + * is_act_mode > > > > + * pmic_reset_reason > > > > + * touch_fw_version > > > > + * ocp_error_location > > > > > > nvmem binding doesn't work for describing these fields? > > > > > > > + See sysfs documentation for more information. > > > > > > sysfs? Not relevant to the binding. > > > > > > > + > > > > +properties: > > > > + compatible: > > > > + const: simple-mfd > > > > + > > > > + reg: > > > > + maxItems: 1 > > > > + > > > > +additionalProperties: false > > > > + > > > > +required: > > > > + - compatible > > > > + - reg > > > > + - ranges > > > > + - address-cells > > > > + - size-cells > > > > + > > > > +examples: > > > > + - | > > > > + / { > > > > + compatible = "foo"; > > > > + model = "foo"; > > > > > > No need to make this the root node with a fake compatible. > > > > I included this root node in order to make #address-cells = > > #size-cells = 2, since this example raises errors otherwise. > > Why does your example require 2 cells? You only have 4KB of address space. The soc node that imem sits under in sm8150.dtsi defines it that way so for continuity I figured that it would make sense for the example to mirror that. Also, should imem and xbl be documented in separate files? > > Though you can do: > > bus { > #address-cells = <2>; > #size-cells = <2>; > ... > }; > > Rob
On Mon, Dec 27, 2021 at 10:17 AM Jarrett Schultz <jaschultz@microsoft.com> wrote: > > > > > -----Original Message----- > > From: Rob Herring <robh@kernel.org> > > Sent: Monday, December 27, 2021 9:46 AM > > To: Jarrett Schultz <jaschultz@microsoft.com> > > Cc: Jarrett Schultz <jaschultzms@gmail.com>; Andy Gross > > <agross@kernel.org>; bjorn.andersson@linaro.org; Hans de Goede > > <hdegoede@redhat.com>; Mark Gross <markgross@kernel.org>; Maximilian > > Luz <luzmaximilian@gmail.com>; Felipe Balbi <balbi@kernel.org>; linux-arm- > > msm@vger.kernel.org; platform-driver-x86@vger.kernel.org; linux- > > kernel@vger.kernel.org; devicetree@vger.kernel.org > > Subject: Re: [EXTERNAL] Re: [PATCH RESEND v4 1/4] dt-bindings: platform: > > microsoft: Document surface xbl Please fix your mail client reply style. > > > > On Mon, Dec 27, 2021 at 10:54 AM Jarrett Schultz > > <jaschultz@microsoft.com> wrote: > > > > > > > > > > > > > -----Original Message----- > > > > From: Rob Herring <robh@kernel.org> > > > > Sent: Tuesday, December 21, 2021 5:24 PM > > > > To: Jarrett Schultz <jaschultzms@gmail.com> > > > > Cc: Andy Gross <agross@kernel.org>; bjorn.andersson@linaro.org; Hans > > > > de Goede <hdegoede@redhat.com>; Mark Gross > > <markgross@kernel.org>; > > > > Maximilian Luz <luzmaximilian@gmail.com>; Felipe Balbi > > > > <balbi@kernel.org>; linux-arm-msm@vger.kernel.org; platform-driver- > > > > x86@vger.kernel.org; linux-kernel@vger.kernel.org; > > > > devicetree@vger.kernel.org; Jarrett Schultz > > > > <jaschultz@microsoft.com> > > > > Subject: [EXTERNAL] Re: [PATCH RESEND v4 1/4] dt-bindings: platform: > > > > microsoft: Document surface xbl > > > > > > > > On Tue, Dec 21, 2021 at 10:28:23AM -0800, Jarrett Schultz wrote: > > > > > From: Jarrett Schultz <jaschultz@microsoft.com> > > > > > > > > > > Introduce yaml for surface xbl driver. > > > > > > > > > > Signed-off-by: Jarrett Schultz <jaschultz@microsoft.com> > > > > > > > > > > --- > > > > > > > > > > Changes in v4: > > > > > - Addressed small formatting changes > > > > > - Removed unnecessary lines > > > > > > > > > > --- > > > > > > > > > > Changes in v3: > > > > > - Updated description to only pertain to the hardware > > > > > - Updated the required field to properly reflect the binding > > > > > - Removed the first example > > > > > - Fixed the size of the reg field in the second example > > > > > > > > > > --- > > > > > > > > > > Changes in v2: > > > > > - Removed json-schema dependence > > > > > - Elaborated on description of driver > > > > > - Updated example > > > > > --- > > > > > .../platform/microsoft/surface-xbl.yaml | 64 +++++++++++++++++++ > > > > > MAINTAINERS | 7 ++ > > > > > 2 files changed, 71 insertions(+) create mode 100644 > > > > > Documentation/devicetree/bindings/platform/microsoft/surface-xbl.y > > > > > aml > > > > > > > > > > diff --git > > > > > a/Documentation/devicetree/bindings/platform/microsoft/surface- > > > > xbl.yam > > > > > l > > > > > b/Documentation/devicetree/bindings/platform/microsoft/surface- > > > > xbl.yam > > > > > l > > > > > new file mode 100644 > > > > > index 000000000000..df5a87a016f4 > > > > > --- /dev/null > > > > > +++ b/Documentation/devicetree/bindings/platform/microsoft/surface > > > > > +++ -xbl > > > > > +++ .yaml > > > > > @@ -0,0 +1,64 @@ > > > > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML > > > > > +1.2 > > > > > +--- > > > > > +$id: > > > > > > > > > > > +https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Fde > > > > +vi > > > > > +cetree.org%2Fschemas%2Fplatform%2Fmicrosoft%2Fsurface- > > > > xbl.yaml%23& And this... Or trim the context if not relevant to the discussion. [...] > > > > > +examples: > > > > > + - | > > > > > + / { > > > > > + compatible = "foo"; > > > > > + model = "foo"; > > > > > > > > No need to make this the root node with a fake compatible. > > > > > > I included this root node in order to make #address-cells = > > > #size-cells = 2, since this example raises errors otherwise. > > > > Why does your example require 2 cells? You only have 4KB of address space. > > The soc node that imem sits under in sm8150.dtsi defines it that way so for > continuity I figured that it would make sense for the example to mirror that. It's just an example. If you are just duplicating dts files, why have examples? > > Also, should imem and xbl be documented in separate files? No. That depends more on the size of the schema. So it's a judgment call typically. Rob
Rob Herring wrote: > From: Rob Herring <robh@kernel.org> > > On Tue, Dec 21, 2021 at 10:28:23AM -0800, Jarrett Schultz wrote: > > From: Jarrett Schultz <jaschultz@microsoft.com> > > > > +title: Surface Extensible Bootloader for Microsoft Surface Duo > > + > > +maintainers: > > + - Jarrett Schultz <jaschultz@microsoft.com> > > + > > +description: | > > + Defined to expose information that is used during production when > > + device is in manufacturing mode. Some of the information included > > + in this imem section is - > > If this is onchip sram, we have a binding for that. That's not an MFD. I now have this driver working with nvmem, but I could not find the binding that you are talking about here. Could you point me to the binding? Thanks, Jarrett > > > + * board_id > > + * battery_present > > + * hw_init_retries > > + * is_customer_mode > > + * is_act_mode > > + * pmic_reset_reason > > + * touch_fw_version > > + * ocp_error_location > > nvmem binding doesn't work for describing these fields? > > > + See sysfs documentation for more information. > > sysfs? Not relevant to the binding. > > > + > > +properties: > > + compatible: > > + const: simple-mfd > > + > > + reg: > > + maxItems: 1 > > + > > +additionalProperties: false > > + > > +required: > > + - compatible > > + - reg > > + - ranges > > + - address-cells > > + - size-cells > > + > > +examples: > > + - | > > + / { > > + compatible = "foo"; > > + model = "foo"; > > No need to make this the root node with a fake compatible. > > > + #address-cells = <2>; > > + #size-cells = <2>; > > + > > + imem@146bf000 { > > + compatible = "simple-mfd"; > > + reg = <0x0 0x146bf000 0x0 0x1000>; > > + ranges = <0x0 0x0 0x146bf000 0x1000>; > > + #address-cells = <1>; > > + #size-cells = <1>; > > + status = "okay"; > > Don't show status in examples. > > > + > > + xbl@a94 { > > + compatible = "microsoft,sm8150-surface-duo-xbl"; > > + reg = <0xa94 0x100>; > > + status = "okay"; > > + }; > > + }; > > + }; > > diff --git a/MAINTAINERS b/MAINTAINERS index > > 13f9a84a617e..5d0ca2a98b57 100644 > > --- a/MAINTAINERS > > +++ b/MAINTAINERS > > @@ -12649,6 +12649,13 @@ F: Documentation/driver- > api/surface_aggregator/clients/dtx.rst > > F: drivers/platform/surface/surface_dtx.c > > F: include/uapi/linux/surface_aggregator/dtx.h > > > > +MICROSOFT SURFACE DUO XBL DRIVER > > +M: Jarrett Schultz <jaschultz@microsoft.com> > > +L: linux-arm-msm@vger.kernel.org > > +L: platform-driver-x86@vger.kernel.org > > +S: Supported > > +F: Documentation/devicetree/bindings/platform/microsoft/surface- > xbl.yaml > > + > > MICROSOFT SURFACE GPE LID SUPPORT DRIVER > > M: Maximilian Luz <luzmaximilian@gmail.com> > > L: platform-driver-x86@vger.kernel.org > > -- > > 2.25.1 > > > >
On Mon 14 Feb 19:04 CST 2022, Jarrett Schultz wrote: > Jarrett Schultz wrote: > > From: Jarrett Schultz > > > > Rob Herring wrote: > > > From: Rob Herring <robh@kernel.org> > > > > > > On Tue, Dec 21, 2021 at 10:28:23AM -0800, Jarrett Schultz wrote: > > > > From: Jarrett Schultz <jaschultz@microsoft.com> > > > > > > > > +title: Surface Extensible Bootloader for Microsoft Surface Duo > > > > + > > > > +maintainers: > > > > + - Jarrett Schultz <jaschultz@microsoft.com> > > > > + > > > > +description: | > > > > + Defined to expose information that is used during production when > > > > + device is in manufacturing mode. Some of the information included > > > > + in this imem section is - > > > > > > If this is onchip sram, we have a binding for that. That's not an MFD. > > > > I now have this driver working with nvmem, but I could not find the binding > > that you are talking about here. Could you point me to the binding? > > > > Thanks, > > Jarrett > > > > Rob, > > I followed up with my team members who have let me know that this lies > in DDR rather than SRAM. Could you please point me to the correct > binding to use? > It might be DDR, but it's on-chip and the memory region that you describe is a region within "imem" - something used for various purposes by Qualcomm, presumably also in your device. Unfortunately we haven't specified a binding for "imem", only some of its regions. Perhaps it would be appropriate to express the entire imem as nvmem, in addition to the region-specific logic, if that suits you. Regards, Bjorn > Thanks, > Jarrett > > > > > > > > + * board_id > > > > + * battery_present > > > > + * hw_init_retries > > > > + * is_customer_mode > > > > + * is_act_mode > > > > + * pmic_reset_reason > > > > + * touch_fw_version > > > > + * ocp_error_location > > > > > > nvmem binding doesn't work for describing these fields? > > > > > > > + See sysfs documentation for more information. > > > > > > sysfs? Not relevant to the binding. > > > > > > > + > > > > +properties: > > > > + compatible: > > > > + const: simple-mfd > > > > + > > > > + reg: > > > > + maxItems: 1 > > > > + > > > > +additionalProperties: false > > > > + > > > > +required: > > > > + - compatible > > > > + - reg > > > > + - ranges > > > > + - address-cells > > > > + - size-cells > > > > + > > > > +examples: > > > > + - | > > > > + / { > > > > + compatible = "foo"; > > > > + model = "foo"; > > > > > > No need to make this the root node with a fake compatible. > > > > > > > + #address-cells = <2>; > > > > + #size-cells = <2>; > > > > + > > > > + imem@146bf000 { > > > > + compatible = "simple-mfd"; > > > > + reg = <0x0 0x146bf000 0x0 0x1000>; > > > > + ranges = <0x0 0x0 0x146bf000 0x1000>; > > > > + #address-cells = <1>; > > > > + #size-cells = <1>; > > > > + status = "okay"; > > > > > > Don't show status in examples. > > > > > > > + > > > > + xbl@a94 { > > > > + compatible = "microsoft,sm8150-surface-duo-xbl"; > > > > + reg = <0xa94 0x100>; > > > > + status = "okay"; > > > > + }; > > > > + }; > > > > + }; > > > > diff --git a/MAINTAINERS b/MAINTAINERS index > > > > 13f9a84a617e..5d0ca2a98b57 100644 > > > > --- a/MAINTAINERS > > > > +++ b/MAINTAINERS > > > > @@ -12649,6 +12649,13 @@ F: Documentation/driver- > > > api/surface_aggregator/clients/dtx.rst > > > > F: drivers/platform/surface/surface_dtx.c > > > > F: include/uapi/linux/surface_aggregator/dtx.h > > > > > > > > +MICROSOFT SURFACE DUO XBL DRIVER > > > > +M: Jarrett Schultz <jaschultz@microsoft.com> > > > > +L: linux-arm-msm@vger.kernel.org > > > > +L: platform-driver-x86@vger.kernel.org > > > > +S: Supported > > > > +F: Documentation/devicetree/bindings/platform/microsoft/surface- > > > xbl.yaml > > > > + > > > > MICROSOFT SURFACE GPE LID SUPPORT DRIVER > > > > M: Maximilian Luz <luzmaximilian@gmail.com> > > > > L: platform-driver-x86@vger.kernel.org > > > > -- > > > > 2.25.1 > > > > > > > >