[PATCH 0/3 V4] Bluetooth: Add support for RTL8821CS

[PATCH 0/3 V4] Bluetooth: Add support for RTL8821CS

[Chris Morgan]

From: Chris Morgan <macromorgan@hotmail.com>

This patch series is to add support for the RTL8821CS Bluetooth
controller found on the RTL8821CS WiFi/Bluetooth combo chip.

This has been tested with firmware version 0x75b8f098 which has been
submitted by Realtek for inclusion in linux-firmware.

https://lore.kernel.org/linux-firmware/20230223062453.181239-1-max.chou@realtek.com/

Changes from V3:
 - Corrected bindings so that all but the 8821 use enum, and 8821 uses
   items.

Changes from V2:
 - Corrected devicetree documentation to change compatible from const
   back to enum.
 - Removed "reviewed-by" from Alistair Francis as binding documentation
   updated with changes.

Changes from V1:
 - Switched to use a fallback string for the rtl8822cs so as to not add
   an extra entry to the of_device_id table. The driver is capable of
   selecting the correct firmware blob to load.
 - Updated the messages to note a new version of the firmware was
   tested and that Realtek has submitted this firmware upstream.
 - Updated the devicetree node on the Anbernic RGxx3 series to use the
   fallback string of realtek,rtl8822cs-bt.

Chris Morgan (3):
  dt-bindings: net: realtek-bluetooth: Add RTL8821CS
  Bluetooth: hci_h5: btrtl: Add support for RTL8821CS
  arm64: dts: rockchip: Update compatible for bluetooth

 .../bindings/net/realtek-bluetooth.yaml       | 24 ++++++++++++-------
 .../dts/rockchip/rk3566-anbernic-rgxx3.dtsi   |  2 +-
 drivers/bluetooth/btrtl.c                     |  8 +++++++
 3 files changed, 24 insertions(+), 10 deletions(-)

-- 
2.34.1

[PATCH 1/3 V4] dt-bindings: net: realtek-bluetooth: Add RTL8821CS

[Chris Morgan]

From: Chris Morgan <macromorgan@hotmail.com>

Add compatible string for RTL8821CS for existing Realtek Bluetooth
driver.

Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
---
 .../bindings/net/realtek-bluetooth.yaml       | 24 ++++++++++++-------
 1 file changed, 15 insertions(+), 9 deletions(-)

diff --git a/Documentation/devicetree/bindings/net/realtek-bluetooth.yaml b/Documentation/devicetree/bindings/net/realtek-bluetooth.yaml
index 143b5667abad..8cc2b9924680 100644
--- a/Documentation/devicetree/bindings/net/realtek-bluetooth.yaml
+++ b/Documentation/devicetree/bindings/net/realtek-bluetooth.yaml
@@ -4,24 +4,30 @@
 $id: http://devicetree.org/schemas/net/realtek-bluetooth.yaml#
 $schema: http://devicetree.org/meta-schemas/core.yaml#
 
-title: RTL8723BS/RTL8723CS/RTL8822CS Bluetooth
+title: RTL8723BS/RTL8723CS/RTL8821CS/RTL8822CS Bluetooth
 
 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.
+  RTL8723CS/RTL8723CS/RTL8821CS/RTL8822CS is a 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:
-    enum:
-      - realtek,rtl8723bs-bt
-      - realtek,rtl8723cs-bt
-      - realtek,rtl8723ds-bt
-      - realtek,rtl8822cs-bt
+    oneOf:
+      - enum:
+          - realtek,rtl8723bs-bt
+          - realtek,rtl8723cs-bt
+          - realtek,rtl8723ds-bt
+          - realtek,rtl8822cs-bt
+      - items:
+          - enum:
+              - realtek,rtl8821cs-bt
+          - const: realtek,rtl8822cs-bt
 
   device-wake-gpios:
     maxItems: 1
-- 
2.34.1

[PATCH 2/3 V4] Bluetooth: hci_h5: btrtl: Add support for RTL8821CS

[Chris Morgan]

From: Chris Morgan <macromorgan@hotmail.com>

RTL8821CS is a WiFi + Bluetooth combo chip from Realtek that provides
WiFi A/B/G/N/AC over an SDIO interface and Bluetooth 4.2 over a UART
interface.

Note that the firmware this was tested with was firmware version
0x75b8f098.

Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
---
 drivers/bluetooth/btrtl.c | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/drivers/bluetooth/btrtl.c b/drivers/bluetooth/btrtl.c
index 69c3fe649ca7..72947d319fa6 100644
--- a/drivers/bluetooth/btrtl.c
+++ b/drivers/bluetooth/btrtl.c
@@ -128,6 +128,14 @@ static const struct id_table ic_id_table[] = {
 	  .fw_name  = "rtl_bt/rtl8821c_fw.bin",
 	  .cfg_name = "rtl_bt/rtl8821c_config" },
 
+	/* 8821CS */
+	{ IC_INFO(RTL_ROM_LMP_8821A, 0xc, 0x8, HCI_UART),
+	  .config_needed = true,
+	  .has_rom_version = true,
+	  .has_msft_ext = true,
+	  .fw_name  = "rtl_bt/rtl8821cs_fw.bin",
+	  .cfg_name = "rtl_bt/rtl8821cs_config" },
+
 	/* 8761A */
 	{ IC_INFO(RTL_ROM_LMP_8761A, 0xa, 0x6, HCI_USB),
 	  .config_needed = false,
-- 
2.34.1

[PATCH 3/3 V4] arm64: dts: rockchip: Update compatible for bluetooth

[Chris Morgan]

From: Chris Morgan <macromorgan@hotmail.com>

Update the compatible for the Realtek RTL8821CS bluetooth node.

Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
---
 arch/arm64/boot/dts/rockchip/rk3566-anbernic-rgxx3.dtsi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/arm64/boot/dts/rockchip/rk3566-anbernic-rgxx3.dtsi b/arch/arm64/boot/dts/rockchip/rk3566-anbernic-rgxx3.dtsi
index 41262a69d33e..8fadd8afb190 100644
--- a/arch/arm64/boot/dts/rockchip/rk3566-anbernic-rgxx3.dtsi
+++ b/arch/arm64/boot/dts/rockchip/rk3566-anbernic-rgxx3.dtsi
@@ -716,7 +716,7 @@ &uart1 {
 	status = "okay";
 
 	bluetooth {
-		compatible = "realtek,rtl8821cs-bt";
+		compatible = "realtek,rtl8821cs-bt", "realtek,rtl8822cs-bt";
 		device-wake-gpios = <&gpio4 4 GPIO_ACTIVE_HIGH>;
 		enable-gpios = <&gpio4 3 GPIO_ACTIVE_HIGH>;
 		host-wake-gpios = <&gpio4 5 GPIO_ACTIVE_HIGH>;
-- 
2.34.1

Re: [PATCH 1/3 V4] dt-bindings: net: realtek-bluetooth: Add RTL8821CS

[Krzysztof Kozlowski]

On 28/02/2023 16:22, Chris Morgan wrote:
> From: Chris Morgan <macromorgan@hotmail.com>
> 
> Add compatible string for RTL8821CS for existing Realtek Bluetooth
> driver.
> 
> Signed-off-by: Chris Morgan <macromorgan@hotmail.com>


Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Best regards,
Krzysztof

Re: [PATCH 1/3 V4] dt-bindings: net: realtek-bluetooth: Add RTL8821CS

[Alistair]

On Wed, 1 Mar 2023, at 1:22 AM, Chris Morgan wrote:
> From: Chris Morgan <macromorgan@hotmail.com>
> 
> Add compatible string for RTL8821CS for existing Realtek Bluetooth
> driver.
> 
> Signed-off-by: Chris Morgan <macromorgan@hotmail.com>

Reviewed-by: Alistair Francis <alistair@alistair23.me>

Alistair

> ---
> .../bindings/net/realtek-bluetooth.yaml       | 24 ++++++++++++-------
> 1 file changed, 15 insertions(+), 9 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/net/realtek-bluetooth.yaml b/Documentation/devicetree/bindings/net/realtek-bluetooth.yaml
> index 143b5667abad..8cc2b9924680 100644
> --- a/Documentation/devicetree/bindings/net/realtek-bluetooth.yaml
> +++ b/Documentation/devicetree/bindings/net/realtek-bluetooth.yaml
> @@ -4,24 +4,30 @@
> $id: http://devicetree.org/schemas/net/realtek-bluetooth.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>  
> -title: RTL8723BS/RTL8723CS/RTL8822CS Bluetooth
> +title: RTL8723BS/RTL8723CS/RTL8821CS/RTL8822CS Bluetooth
>  
> 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.
> +  RTL8723CS/RTL8723CS/RTL8821CS/RTL8822CS is a 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:
> -    enum:
> -      - realtek,rtl8723bs-bt
> -      - realtek,rtl8723cs-bt
> -      - realtek,rtl8723ds-bt
> -      - realtek,rtl8822cs-bt
> +    oneOf:
> +      - enum:
> +          - realtek,rtl8723bs-bt
> +          - realtek,rtl8723cs-bt
> +          - realtek,rtl8723ds-bt
> +          - realtek,rtl8822cs-bt
> +      - items:
> +          - enum:
> +              - realtek,rtl8821cs-bt
> +          - const: realtek,rtl8822cs-bt
>  
>    device-wake-gpios:
>      maxItems: 1
> -- 
> 2.34.1
> 
> 

Re: [PATCH 0/3 V4] Bluetooth: Add support for RTL8821CS

[patchwork-bot+bluetooth]

Hello:

This series was applied to bluetooth/bluetooth-next.git (master)
by Luiz Augusto von Dentz <luiz.von.dentz@intel.com>:

On Tue, 28 Feb 2023 09:22:02 -0600 you wrote:
> From: Chris Morgan <macromorgan@hotmail.com>
> 
> This patch series is to add support for the RTL8821CS Bluetooth
> controller found on the RTL8821CS WiFi/Bluetooth combo chip.
> 
> This has been tested with firmware version 0x75b8f098 which has been
> submitted by Realtek for inclusion in linux-firmware.
> 
> [...]

Here is the summary with links:
  - [1/3,V4] dt-bindings: net: realtek-bluetooth: Add RTL8821CS
    https://git.kernel.org/bluetooth/bluetooth-next/c/b564bad5b54d
  - [2/3,V4] Bluetooth: hci_h5: btrtl: Add support for RTL8821CS
    https://git.kernel.org/bluetooth/bluetooth-next/c/8b449db459d9
  - [3/3,V4] arm64: dts: rockchip: Update compatible for bluetooth
    https://git.kernel.org/bluetooth/bluetooth-next/c/d305437d4d2a

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html

Re: [PATCH 2/3 V4] Bluetooth: hci_h5: btrtl: Add support for RTL8821CS

[Chris Morgan]

I shudder to bring this up now, but I'm encountering a new bug and
might have to withdraw this.

I'm receiving errors in dmesg of the following, and I can't seem to
figure out the root cause:
Bluetooth: hci0: Out-of-order packet arrived

Any thoughts on what might cause it?
Thank you.

On Tue, Feb 28, 2023 at 9:22 AM Chris Morgan <macroalpha82@gmail.com> wrote:
>
> From: Chris Morgan <macromorgan@hotmail.com>
>
> RTL8821CS is a WiFi + Bluetooth combo chip from Realtek that provides
> WiFi A/B/G/N/AC over an SDIO interface and Bluetooth 4.2 over a UART
> interface.
>
> Note that the firmware this was tested with was firmware version
> 0x75b8f098.
>
> Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
> ---
>  drivers/bluetooth/btrtl.c | 8 ++++++++
>  1 file changed, 8 insertions(+)
>
> diff --git a/drivers/bluetooth/btrtl.c b/drivers/bluetooth/btrtl.c
> index 69c3fe649ca7..72947d319fa6 100644
> --- a/drivers/bluetooth/btrtl.c
> +++ b/drivers/bluetooth/btrtl.c
> @@ -128,6 +128,14 @@ static const struct id_table ic_id_table[] = {
>           .fw_name  = "rtl_bt/rtl8821c_fw.bin",
>           .cfg_name = "rtl_bt/rtl8821c_config" },
>
> +       /* 8821CS */
> +       { IC_INFO(RTL_ROM_LMP_8821A, 0xc, 0x8, HCI_UART),
> +         .config_needed = true,
> +         .has_rom_version = true,
> +         .has_msft_ext = true,
> +         .fw_name  = "rtl_bt/rtl8821cs_fw.bin",
> +         .cfg_name = "rtl_bt/rtl8821cs_config" },
> +
>         /* 8761A */
>         { IC_INFO(RTL_ROM_LMP_8761A, 0xa, 0x6, HCI_USB),
>           .config_needed = false,
> --
> 2.34.1
>

Re: [PATCH 2/3 V4] Bluetooth: hci_h5: btrtl: Add support for RTL8821CS

[Chris Morgan]

I found the fix, simply put changing the compatible from
realtek,rtl8822cs-bt to realtek,rtl8732bs-bt fixes it (because it sets
the "H5_INFO_WAKEUP_DISABLE" flag). Is it too late for a V5, or should
I submit this as a fix to the devicetree and devicetree documentation?

Thank you.

On Fri, Mar 10, 2023 at 10:25 AM Chris Morgan <macroalpha82@gmail.com> wrote:
>
> I shudder to bring this up now, but I'm encountering a new bug and
> might have to withdraw this.
>
> I'm receiving errors in dmesg of the following, and I can't seem to
> figure out the root cause:
> Bluetooth: hci0: Out-of-order packet arrived
>
> Any thoughts on what might cause it?
> Thank you.
>
> On Tue, Feb 28, 2023 at 9:22 AM Chris Morgan <macroalpha82@gmail.com> wrote:
> >
> > From: Chris Morgan <macromorgan@hotmail.com>
> >
> > RTL8821CS is a WiFi + Bluetooth combo chip from Realtek that provides
> > WiFi A/B/G/N/AC over an SDIO interface and Bluetooth 4.2 over a UART
> > interface.
> >
> > Note that the firmware this was tested with was firmware version
> > 0x75b8f098.
> >
> > Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
> > ---
> >  drivers/bluetooth/btrtl.c | 8 ++++++++
> >  1 file changed, 8 insertions(+)
> >
> > diff --git a/drivers/bluetooth/btrtl.c b/drivers/bluetooth/btrtl.c
> > index 69c3fe649ca7..72947d319fa6 100644
> > --- a/drivers/bluetooth/btrtl.c
> > +++ b/drivers/bluetooth/btrtl.c
> > @@ -128,6 +128,14 @@ static const struct id_table ic_id_table[] = {
> >           .fw_name  = "rtl_bt/rtl8821c_fw.bin",
> >           .cfg_name = "rtl_bt/rtl8821c_config" },
> >
> > +       /* 8821CS */
> > +       { IC_INFO(RTL_ROM_LMP_8821A, 0xc, 0x8, HCI_UART),
> > +         .config_needed = true,
> > +         .has_rom_version = true,
> > +         .has_msft_ext = true,
> > +         .fw_name  = "rtl_bt/rtl8821cs_fw.bin",
> > +         .cfg_name = "rtl_bt/rtl8821cs_config" },
> > +
> >         /* 8761A */
> >         { IC_INFO(RTL_ROM_LMP_8761A, 0xa, 0x6, HCI_USB),
> >           .config_needed = false,
> > --
> > 2.34.1
> >

Re: [PATCH 2/3 V4] Bluetooth: hci_h5: btrtl: Add support for RTL8821CS

[Vasily Khoruzhick]

On Mon, Mar 13, 2023 at 11:12 AM Chris Morgan <macroalpha82@gmail.com> wrote:
>
> I found the fix, simply put changing the compatible from
> realtek,rtl8822cs-bt to realtek,rtl8732bs-bt fixes it (because it sets
> the "H5_INFO_WAKEUP_DISABLE" flag). Is it too late for a V5, or should
> I submit this as a fix to the devicetree and devicetree documentation?

But is it actually compatible with rtl8723bs-bt though? I think you
may need to add an entry for 8821cs to rtl_bluetooth_of_match in
hci_h5.c

> Thank you.
>
> On Fri, Mar 10, 2023 at 10:25 AM Chris Morgan <macroalpha82@gmail.com> wrote:
> >
> > I shudder to bring this up now, but I'm encountering a new bug and
> > might have to withdraw this.
> >
> > I'm receiving errors in dmesg of the following, and I can't seem to
> > figure out the root cause:
> > Bluetooth: hci0: Out-of-order packet arrived
> >
> > Any thoughts on what might cause it?
> > Thank you.
> >
> > On Tue, Feb 28, 2023 at 9:22 AM Chris Morgan <macroalpha82@gmail.com> wrote:
> > >
> > > From: Chris Morgan <macromorgan@hotmail.com>
> > >
> > > RTL8821CS is a WiFi + Bluetooth combo chip from Realtek that provides
> > > WiFi A/B/G/N/AC over an SDIO interface and Bluetooth 4.2 over a UART
> > > interface.
> > >
> > > Note that the firmware this was tested with was firmware version
> > > 0x75b8f098.
> > >
> > > Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
> > > ---
> > >  drivers/bluetooth/btrtl.c | 8 ++++++++
> > >  1 file changed, 8 insertions(+)
> > >
> > > diff --git a/drivers/bluetooth/btrtl.c b/drivers/bluetooth/btrtl.c
> > > index 69c3fe649ca7..72947d319fa6 100644
> > > --- a/drivers/bluetooth/btrtl.c
> > > +++ b/drivers/bluetooth/btrtl.c
> > > @@ -128,6 +128,14 @@ static const struct id_table ic_id_table[] = {
> > >           .fw_name  = "rtl_bt/rtl8821c_fw.bin",
> > >           .cfg_name = "rtl_bt/rtl8821c_config" },
> > >
> > > +       /* 8821CS */
> > > +       { IC_INFO(RTL_ROM_LMP_8821A, 0xc, 0x8, HCI_UART),
> > > +         .config_needed = true,
> > > +         .has_rom_version = true,
> > > +         .has_msft_ext = true,
> > > +         .fw_name  = "rtl_bt/rtl8821cs_fw.bin",
> > > +         .cfg_name = "rtl_bt/rtl8821cs_config" },
> > > +
> > >         /* 8761A */
> > >         { IC_INFO(RTL_ROM_LMP_8761A, 0xa, 0x6, HCI_USB),
> > >           .config_needed = false,
> > > --
> > > 2.34.1
> > >

Re: [PATCH 2/3 V4] Bluetooth: hci_h5: btrtl: Add support for RTL8821CS

[Chris Morgan]

On Mon, Mar 13, 2023 at 11:36:21AM -0700, Vasily Khoruzhick wrote:
> On Mon, Mar 13, 2023 at 11:12 AM Chris Morgan <macroalpha82@gmail.com> wrote:
> >
> > I found the fix, simply put changing the compatible from
> > realtek,rtl8822cs-bt to realtek,rtl8732bs-bt fixes it (because it sets
> > the "H5_INFO_WAKEUP_DISABLE" flag). Is it too late for a V5, or should
> > I submit this as a fix to the devicetree and devicetree documentation?
> 
> But is it actually compatible with rtl8723bs-bt though? I think you
> may need to add an entry for 8821cs to rtl_bluetooth_of_match in
> hci_h5.c

The compatible string would be an exact copy of what is present for
rtl8723bs-bt. Previously I was advised by the devicetree team to just
use a fallback string rather than add a duplicate entry to the driver,
so that's what I did. The driver itself can detect the difference
between the 8821cs and 8723bs and load the appropriate firmware.

Technically the rtl8822cs-bt also works as long as you only want to
"test" the driver and not use it. It's the power management stuff
that causes it to fail roughly 9 out of every 10 times you try to
use it for more than simple pairing (I tested 3 different controllers
with the new compatible string for a total of 7 tests and it works
consistently now).

If you're okay with the compatible string change, I'll update it and
resubmit this as a V5. It shouldn't require a change to the driver,
only the binding.

Thank you.

> 
> > Thank you.
> >
> > On Fri, Mar 10, 2023 at 10:25 AM Chris Morgan <macroalpha82@gmail.com> wrote:
> > >
> > > I shudder to bring this up now, but I'm encountering a new bug and
> > > might have to withdraw this.
> > >
> > > I'm receiving errors in dmesg of the following, and I can't seem to
> > > figure out the root cause:
> > > Bluetooth: hci0: Out-of-order packet arrived
> > >
> > > Any thoughts on what might cause it?
> > > Thank you.
> > >
> > > On Tue, Feb 28, 2023 at 9:22 AM Chris Morgan <macroalpha82@gmail.com> wrote:
> > > >
> > > > From: Chris Morgan <macromorgan@hotmail.com>
> > > >
> > > > RTL8821CS is a WiFi + Bluetooth combo chip from Realtek that provides
> > > > WiFi A/B/G/N/AC over an SDIO interface and Bluetooth 4.2 over a UART
> > > > interface.
> > > >
> > > > Note that the firmware this was tested with was firmware version
> > > > 0x75b8f098.
> > > >
> > > > Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
> > > > ---
> > > >  drivers/bluetooth/btrtl.c | 8 ++++++++
> > > >  1 file changed, 8 insertions(+)
> > > >
> > > > diff --git a/drivers/bluetooth/btrtl.c b/drivers/bluetooth/btrtl.c
> > > > index 69c3fe649ca7..72947d319fa6 100644
> > > > --- a/drivers/bluetooth/btrtl.c
> > > > +++ b/drivers/bluetooth/btrtl.c
> > > > @@ -128,6 +128,14 @@ static const struct id_table ic_id_table[] = {
> > > >           .fw_name  = "rtl_bt/rtl8821c_fw.bin",
> > > >           .cfg_name = "rtl_bt/rtl8821c_config" },
> > > >
> > > > +       /* 8821CS */
> > > > +       { IC_INFO(RTL_ROM_LMP_8821A, 0xc, 0x8, HCI_UART),
> > > > +         .config_needed = true,
> > > > +         .has_rom_version = true,
> > > > +         .has_msft_ext = true,
> > > > +         .fw_name  = "rtl_bt/rtl8821cs_fw.bin",
> > > > +         .cfg_name = "rtl_bt/rtl8821cs_config" },
> > > > +
> > > >         /* 8761A */
> > > >         { IC_INFO(RTL_ROM_LMP_8761A, 0xa, 0x6, HCI_USB),
> > > >           .config_needed = false,
> > > > --
> > > > 2.34.1
> > > >