diff mbox series

[v2,1/3] dt-bindings: net: bluetooth: Add rtl8723bs-bluetooth

Message ID 20200407055837.3508017-1-alistair@alistair23.me
State Changes Requested, archived
Headers show
Series [v2,1/3] dt-bindings: net: bluetooth: Add rtl8723bs-bluetooth | expand

Checks

Context Check Description
robh/checkpatch success
robh/dt-meta-schema fail build log

Commit Message

Alistair Francis April 7, 2020, 5:58 a.m. UTC
From: Vasily Khoruzhick <anarsoul@gmail.com>

Add binding document for bluetooth part of RTL8723BS/RTL8723CS

Signed-off-by: Vasily Khoruzhick <anarsoul@gmail.com>
Signed-off-by: Alistair Francis <alistair@alistair23.me>
---
v2:
 - Update bindings based on upstream feedback
 - Add RTL8822CS
 - Remove unused/unsupported fields
 - Remove firmware-postfix field
 - Small formatting changes

 .../bindings/net/realtek,rtl8723bs-bt.yaml    | 55 +++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml

Comments

Vasily Khoruzhick April 7, 2020, 6:50 a.m. UTC | #1
On Mon, Apr 6, 2020 at 10:58 PM Alistair Francis <alistair@alistair23.me> wrote:
>
> From: Vasily Khoruzhick <anarsoul@gmail.com>
>
> RTL8723BS is often used in ARM boards, so add ability to bind it
> using device tree.
>
> Signed-off-by: Vasily Khoruzhick <anarsoul@gmail.com>
> Signed-off-by: Alistair Francis <alistair@alistair23.me>
> ---
>  drivers/bluetooth/hci_h5.c | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/drivers/bluetooth/hci_h5.c b/drivers/bluetooth/hci_h5.c
> index 106c110efe56..b0e25a7ca850 100644
> --- a/drivers/bluetooth/hci_h5.c
> +++ b/drivers/bluetooth/hci_h5.c
> @@ -1019,6 +1019,8 @@ static const struct of_device_id rtl_bluetooth_of_match[] = {
>         { .compatible = "realtek,rtl8822cs-bt",
>           .data = (const void *)&rtl_vnd },
>  #endif
> +       { .compatible = "realtek,rtl8822bs-bt",

Wrong compatible? Also you probably want to keep it over #endif.

> +         .data = (const void *)&rtl_vnd },
>         { },
>  };
>  MODULE_DEVICE_TABLE(of, rtl_bluetooth_of_match);
> --
> 2.25.1
>
Vasily Khoruzhick April 7, 2020, 6:52 a.m. UTC | #2
On Mon, Apr 6, 2020 at 10:58 PM Alistair Francis <alistair@alistair23.me> wrote:
>
> The sopine board has an optional RTL8723BS WiFi + BT module that can be
> connected to UART1. Add this to the device tree so that it will work
> for users if connected.

It's optional, so patch should have 'DO-NOT-MERGE' tag and appropriate
change should go into dt overlay.

> Signed-off-by: Alistair Francis <alistair@alistair23.me>
> ---
>  .../allwinner/sun50i-a64-sopine-baseboard.dts | 23 +++++++++++++++++++
>  1 file changed, 23 insertions(+)
>
> diff --git a/arch/arm64/boot/dts/allwinner/sun50i-a64-sopine-baseboard.dts b/arch/arm64/boot/dts/allwinner/sun50i-a64-sopine-baseboard.dts
> index 2f6ea9f3f6a2..f4be1bc56b07 100644
> --- a/arch/arm64/boot/dts/allwinner/sun50i-a64-sopine-baseboard.dts
> +++ b/arch/arm64/boot/dts/allwinner/sun50i-a64-sopine-baseboard.dts
> @@ -103,6 +103,16 @@ ext_rgmii_phy: ethernet-phy@1 {
>         };
>  };
>
> +&mmc1 {
> +       pinctrl-names = "default";
> +       pinctrl-0 = <&mmc1_pins>;
> +       vmmc-supply = <&reg_dldo4>;
> +       vqmmc-supply = <&reg_eldo1>;
> +       non-removable;
> +       bus-width = <4>;
> +       status = "okay";
> +};
> +
>  &mmc2 {
>         pinctrl-names = "default";
>         pinctrl-0 = <&mmc2_pins>;
> @@ -174,6 +184,19 @@ &uart0 {
>         status = "okay";
>  };
>
> +&uart1 {
> +       pinctrl-names = "default";
> +       pinctrl-0 = <&uart1_pins>, <&uart1_rts_cts_pins>;
> +       uart-has-rtscts = <1>;
> +       status = "okay";
> +
> +       bluetooth {
> +               compatible = "realtek,rtl8723bs-bt";
> +               device-wake-gpios = <&r_pio 0 5 GPIO_ACTIVE_HIGH>; /* PL5 */
> +               host-wake-gpios = <&r_pio 0 6 GPIO_ACTIVE_HIGH>; /* PL6 */
> +       };
> +};
> +
>  /* On Pi-2 connector */
>  &uart2 {
>         pinctrl-names = "default";
> --
> 2.25.1
>
Alistair Francis April 8, 2020, 2:40 a.m. UTC | #3
On Mon, Apr 6, 2020 at 11:51 PM Vasily Khoruzhick <anarsoul@gmail.com> wrote:
>
> On Mon, Apr 6, 2020 at 10:58 PM Alistair Francis <alistair@alistair23.me> wrote:
> >
> > From: Vasily Khoruzhick <anarsoul@gmail.com>
> >
> > RTL8723BS is often used in ARM boards, so add ability to bind it
> > using device tree.
> >
> > Signed-off-by: Vasily Khoruzhick <anarsoul@gmail.com>
> > Signed-off-by: Alistair Francis <alistair@alistair23.me>
> > ---
> >  drivers/bluetooth/hci_h5.c | 2 ++
> >  1 file changed, 2 insertions(+)
> >
> > diff --git a/drivers/bluetooth/hci_h5.c b/drivers/bluetooth/hci_h5.c
> > index 106c110efe56..b0e25a7ca850 100644
> > --- a/drivers/bluetooth/hci_h5.c
> > +++ b/drivers/bluetooth/hci_h5.c
> > @@ -1019,6 +1019,8 @@ static const struct of_device_id rtl_bluetooth_of_match[] = {
> >         { .compatible = "realtek,rtl8822cs-bt",
> >           .data = (const void *)&rtl_vnd },
> >  #endif
> > +       { .compatible = "realtek,rtl8822bs-bt",
>
> Wrong compatible? Also you probably want to keep it over #endif.

Fixed.

Alistair

>
> > +         .data = (const void *)&rtl_vnd },
> >         { },
> >  };
> >  MODULE_DEVICE_TABLE(of, rtl_bluetooth_of_match);
> > --
> > 2.25.1
> >
Alistair Francis April 8, 2020, 2:42 a.m. UTC | #4
On Mon, Apr 6, 2020 at 11:53 PM Vasily Khoruzhick <anarsoul@gmail.com> wrote:
>
> On Mon, Apr 6, 2020 at 10:58 PM Alistair Francis <alistair@alistair23.me> wrote:
> >
> > The sopine board has an optional RTL8723BS WiFi + BT module that can be
> > connected to UART1. Add this to the device tree so that it will work
> > for users if connected.
>
> It's optional, so patch should have 'DO-NOT-MERGE' tag and appropriate
> change should go into dt overlay.

I was hoping to enable WiFi/Bluetooth by default, even though it's an
optional add-on for the board.

Alistair

>
> > Signed-off-by: Alistair Francis <alistair@alistair23.me>
> > ---
> >  .../allwinner/sun50i-a64-sopine-baseboard.dts | 23 +++++++++++++++++++
> >  1 file changed, 23 insertions(+)
> >
> > diff --git a/arch/arm64/boot/dts/allwinner/sun50i-a64-sopine-baseboard.dts b/arch/arm64/boot/dts/allwinner/sun50i-a64-sopine-baseboard.dts
> > index 2f6ea9f3f6a2..f4be1bc56b07 100644
> > --- a/arch/arm64/boot/dts/allwinner/sun50i-a64-sopine-baseboard.dts
> > +++ b/arch/arm64/boot/dts/allwinner/sun50i-a64-sopine-baseboard.dts
> > @@ -103,6 +103,16 @@ ext_rgmii_phy: ethernet-phy@1 {
> >         };
> >  };
> >
> > +&mmc1 {
> > +       pinctrl-names = "default";
> > +       pinctrl-0 = <&mmc1_pins>;
> > +       vmmc-supply = <&reg_dldo4>;
> > +       vqmmc-supply = <&reg_eldo1>;
> > +       non-removable;
> > +       bus-width = <4>;
> > +       status = "okay";
> > +};
> > +
> >  &mmc2 {
> >         pinctrl-names = "default";
> >         pinctrl-0 = <&mmc2_pins>;
> > @@ -174,6 +184,19 @@ &uart0 {
> >         status = "okay";
> >  };
> >
> > +&uart1 {
> > +       pinctrl-names = "default";
> > +       pinctrl-0 = <&uart1_pins>, <&uart1_rts_cts_pins>;
> > +       uart-has-rtscts = <1>;
> > +       status = "okay";
> > +
> > +       bluetooth {
> > +               compatible = "realtek,rtl8723bs-bt";
> > +               device-wake-gpios = <&r_pio 0 5 GPIO_ACTIVE_HIGH>; /* PL5 */
> > +               host-wake-gpios = <&r_pio 0 6 GPIO_ACTIVE_HIGH>; /* PL6 */
> > +       };
> > +};
> > +
> >  /* On Pi-2 connector */
> >  &uart2 {
> >         pinctrl-names = "default";
> > --
> > 2.25.1
> >
Rob Herring (Arm) April 9, 2020, 11:10 p.m. UTC | #5
On Mon,  6 Apr 2020 22:58:35 -0700, Alistair Francis wrote:
> From: Vasily Khoruzhick <anarsoul@gmail.com>
> 
> Add binding document for bluetooth part of RTL8723BS/RTL8723CS
> 
> Signed-off-by: Vasily Khoruzhick <anarsoul@gmail.com>
> Signed-off-by: Alistair Francis <alistair@alistair23.me>
> ---
> v2:
>  - Update bindings based on upstream feedback
>  - Add RTL8822CS
>  - Remove unused/unsupported fields
>  - Remove firmware-postfix field
>  - Small formatting changes
> 
>  .../bindings/net/realtek,rtl8723bs-bt.yaml    | 55 +++++++++++++++++++
>  1 file changed, 55 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml
> 

My bot found errors running 'make dt_binding_check' on your patch:

/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml: properties:compatible:oneOf:0: 'realtek,rtl8723bs-bt' is not of type 'object', 'boolean'
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml: properties:compatible:oneOf:1: 'realtek,rtl8723cs-bt' is not of type 'object', 'boolean'
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml: properties:compatible:oneOf:2: 'realtek,rtl8822cs-bt' is not of type 'object', 'boolean'
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml: properties:host-wake-gpios: Additional properties are not allowed ('desciption' was unexpected)
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml: properties:host-wake-gpios: 'desciption' is not one of ['$ref', 'additionalItems', 'additionalProperties', 'allOf', 'anyOf', 'const', 'contains', 'default', 'dependencies', 'deprecated', 'description', 'else', 'enum', 'exclusiveMaximum', 'exclusiveMinimum', 'items', 'if', 'minItems', 'minimum', 'maxItems', 'maximum', 'multipleOf', 'not', 'oneOf', 'pattern', 'patternProperties', 'properties', 'required', 'then', 'type', 'typeSize', 'unevaluatedProperties', 'uniqueItems']
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml: properties:host-wake-gpios: {'maxItems': 1, 'desciption': 'GPIO specifier, used to wakeup the host processor'} is not valid under any of the given schemas (Possible causes of the failure):
	/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml: properties:host-wake-gpios: Additional properties are not allowed ('desciption' was unexpected)
	/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml: properties:host-wake-gpios:maxItems: 1 is less than the minimum of 2

Documentation/devicetree/bindings/Makefile:12: recipe for target 'Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.example.dts' failed
make[1]: *** [Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.example.dts] Error 1
make[1]: *** Waiting for unfinished jobs....
Makefile:1262: recipe for target 'dt_binding_check' failed
make: *** [dt_binding_check] Error 2

See https://patchwork.ozlabs.org/patch/1267219

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure dt-schema is up to date:

pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade

Please check and re-submit.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml b/Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml
new file mode 100644
index 000000000000..a03ce1bbc56f
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/realtek,rtl8723bs-bt.yaml
@@ -0,0 +1,55 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/realtek,rtl8723bs-bt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RTL8723BS/RTL8723CS/RTL8822CS Bluetooth Device Tree Bindings
+
+maintainers:
+  - Vasily Khoruzhick <anarsoul@gmail.com>
+  - Alistair Francis <alistair@alistair23.me>
+
+description:
+  RTL8723CS/RTL8723CS/RTL8822CS is WiFi + BT chip. WiFi part is connected over
+  SDIO, while BT is connected over serial. It speaks H5 protocol with few
+  extra commands to upload firmware and change module speed.
+
+properties:
+  compatible:
+    oneOf:
+      - "realtek,rtl8723bs-bt"
+      - "realtek,rtl8723cs-bt"
+      - "realtek,rtl8822cs-bt"
+
+  device-wake-gpios:
+    maxItems: 1
+    description:
+      GPIO specifier, used to wakeup the BT module
+
+  enable-gpios:
+    maxItems: 1
+    description:
+      GPIO specifier, used to enable the BT module
+
+  host-wake-gpios:
+    maxItems: 1
+    desciption:
+      GPIO specifier, used to wakeup the host processor
+
+required:
+  - compatible
+
+examples:
+  - |
+    &uart1 {
+        pinctrl-names = "default";
+        pinctrl-0 = <&uart1_pins>, <&uart1_rts_cts_pins>;
+        uart-has-rtscts = <1>;
+
+        bluetooth {
+            compatible = "realtek,rtl8723bs-bt";
+            device-wake-gpios = <&r_pio 0 5 GPIO_ACTIVE_HIGH>; /* PL5 */
+            host-wakeup-gpios = <&r_pio 0 6 GPIO_ACTIVE_HIGH>; /* PL6 */
+        };
+    };