Re: [PATCH RESEND v4 1/4] dt-bindings: platform: microsoft: Document surface xbl
From: Rob Herring <robh@kernel.org>
Date: 2021-12-21 23:23:56
Also in:
linux-arm-msm, lkml, platform-driver-x86
On Tue, Dec 21, 2021 at 10:28:23AM -0800, Jarrett Schultz wrote:
quoted hunk ↗ jump to hunk
From: Jarrett Schultz <redacted> Introduce yaml for surface xbl driver. Signed-off-by: Jarrett Schultz <redacted> --- 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.yamldiff --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.
quoted hunk ↗ jump to hunk
+ + 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