LKML Archive mirror
 help / color / mirror / Atom feed
From: Rob Herring <robh@kernel.org>
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: Re: [PATCH RESEND v4 1/4] dt-bindings: platform: microsoft: Document surface xbl
Date: Tue, 21 Dec 2021 19:23:50 -0400	[thread overview]
Message-ID: <YcJiBk5f071eJ5+n@robh.at.kernel.org> (raw)
In-Reply-To: <20211221182826.2141789-2-jaschultzMS@gmail.com>

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
> 
> 

  parent reply	other threads:[~2021-12-21 23:23 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-21 18:28 [PATCH RESEND v4 0/4] platform: surface: Introduce Surface XBL Driver Jarrett Schultz
2021-12-21 18:28 ` [PATCH RESEND v4 1/4] dt-bindings: platform: microsoft: Document surface xbl Jarrett Schultz
2021-12-21 22:45   ` Rob Herring
2021-12-21 23:23   ` Rob Herring [this message]
2021-12-27 14:54     ` [EXTERNAL] " Jarrett Schultz
2021-12-27 15:45       ` Rob Herring
2021-12-27 16:16         ` Jarrett Schultz
2022-01-04 22:00           ` Rob Herring
2022-02-03 23:23     ` Jarrett Schultz
2022-02-15  1:04       ` Jarrett Schultz
2022-02-15 14:39         ` Bjorn Andersson
2022-02-24 23:42           ` Jarrett Schultz
2021-12-21 18:28 ` [PATCH RESEND v4 2/4] platform: surface: Add " Jarrett Schultz
2021-12-21 18:28 ` [PATCH RESEND v4 3/4] arm64: dts: qcom: sm8150: Add imem section Jarrett Schultz
2021-12-21 18:28 ` [PATCH RESEND v4 4/4] arm64: dts: qcom: surface-duo: Add surface xbl Jarrett Schultz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=YcJiBk5f071eJ5+n@robh.at.kernel.org \
    --to=robh@kernel.org \
    --cc=agross@kernel.org \
    --cc=balbi@kernel.org \
    --cc=bjorn.andersson@linaro.org \
    --cc=devicetree@vger.kernel.org \
    --cc=hdegoede@redhat.com \
    --cc=jaschultz@microsoft.com \
    --cc=jaschultzms@gmail.com \
    --cc=linux-arm-msm@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=luzmaximilian@gmail.com \
    --cc=markgross@kernel.org \
    --cc=platform-driver-x86@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).