2015-05-20 21:04:09

by An, Tedd

[permalink] [raw]
Subject: [PATCH v3] Bluetooth: btusb: Add routine for applying Intel DDC parameters

From: Tedd Ho-Jeong An <[email protected]>

This patch adds the routine to apply the DDC parameter from device
specific ddc file.

Once the device is rest to operational mode, optionally, it can
download the device specific configration (DDC) parameters before
the BlueZ starts the stack initialization.

It opens the DDC file based on HW_VARIANT and send ID/Value with
HCI_Intel_Write_DDC command.

Format of DDC file
DDC file consists of one or more number of DDC structure that has a
'Length' field of one octet, DDC 'ID' field of two octets followed by
the array of DDC 'Value' that gives the value of parameters itself.
'Length' contains the length of DDC 'ID' and DDC 'Value'.

+------------+----------+
| Size(byte) | Name |
+------------+----------+
| 1 | Length |
+------------+----------+
| 2 | ID |
+------------+----------+
| Length - 2 | Value |
+------------+----------+

In case of command failure, it returns the command complete with
parameter that contains the ID that failed to apply.

Signed-off-by: Tedd Ho-Jeong An <[email protected]>
---
drivers/bluetooth/btintel.h | 5 +++
drivers/bluetooth/btusb.c | 75 +++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 80 insertions(+)

diff --git a/drivers/bluetooth/btintel.h b/drivers/bluetooth/btintel.h
index 4bda6ab..affb216 100644
--- a/drivers/bluetooth/btintel.h
+++ b/drivers/bluetooth/btintel.h
@@ -69,6 +69,11 @@ struct intel_secure_send_result {
__u8 status;
} __packed;

+struct intel_write_ddc {
+ __u8 status;
+ __le16 failed_id;
+} __packed;
+
#if IS_ENABLED(CONFIG_BT_INTEL)

int btintel_check_bdaddr(struct hci_dev *hdev);
diff --git a/drivers/bluetooth/btusb.c b/drivers/bluetooth/btusb.c
index 13b9969..bc3697f 100644
--- a/drivers/bluetooth/btusb.c
+++ b/drivers/bluetooth/btusb.c
@@ -2318,6 +2318,66 @@ static void btusb_intel_version_info(struct hci_dev *hdev,
ver->fw_build_num, ver->fw_build_ww, 2000 + ver->fw_build_yy);
}

+static int btusb_apply_ddc_intel(struct hci_dev *hdev, u8 hw_variant)
+{
+ const struct firmware *fw;
+ const u8 *fw_ptr;
+ char fwname[64];
+ struct sk_buff *skb;
+ int err;
+
+ snprintf(fwname, sizeof(fwname), "intel/ibt-%d.ddc", hw_variant);
+
+ /* Device can work without DDC parameters so even if it fails to load
+ * the file, no need to fail the device setup.
+ */
+ err = request_firmware_direct(&fw, fwname, &hdev->dev);
+ if (err < 0) {
+ BT_INFO("%s: WARNING: unable to load Intel DDC file: %s (%d)",
+ hdev->name, fwname, err);
+ return 0;
+ }
+
+ BT_INFO("%s: Intel DDC file opened: %s", hdev->name, fwname);
+
+ fw_ptr = fw->data;
+ while (fw->size > fw_ptr - fw->data) {
+ struct intel_write_ddc *wr_ddc;
+ u8 cmd_len = fw_ptr[0] + sizeof(u8);
+
+ skb = __hci_cmd_sync(hdev, 0xfc8b, cmd_len, fw_ptr,
+ HCI_INIT_TIMEOUT);
+ if (IS_ERR(skb)) {
+ BT_ERR("%s: Failed to send Intel_Write_DDC (%ld)",
+ hdev->name, PTR_ERR(skb));
+ release_firmware(fw);
+ return PTR_ERR(skb);
+ }
+
+ wr_ddc = (struct intel_write_ddc *)skb->data;
+ if (wr_ddc->status) {
+ BT_ERR("%s: Intel write ddc command failure (%02x)",
+ hdev->name, wr_ddc->status);
+ BT_ERR("%s: Last failed DDC ID: %04x",
+ hdev->name, wr_ddc->failed_id);
+ err = -bt_to_errno(wr_ddc->status);
+ release_firmware(fw);
+ kfree_skb(skb);
+ return err;
+ }
+
+ fw_ptr += cmd_len;
+
+ kfree_skb(skb);
+ }
+
+ release_firmware(fw);
+
+ BT_INFO("%s: Completed to apply Intel DDC parameters", hdev->name);
+
+ return 0;
+}
+
static int btusb_setup_intel_new(struct hci_dev *hdev)
{
static const u8 reset_param[] = { 0x00, 0x01, 0x00, 0x01,
@@ -2331,6 +2391,7 @@ static int btusb_setup_intel_new(struct hci_dev *hdev)
char fwname[64];
ktime_t calltime, delta, rettime;
unsigned long long duration;
+ u8 hw_variant;
int err;

BT_DBG("%s", hdev->name);
@@ -2385,6 +2446,10 @@ static int btusb_setup_intel_new(struct hci_dev *hdev)
return -EINVAL;
}

+ /* Keep this variable for later use with DDC
+ */
+ hw_variant = ver->hw_variant;
+
btusb_intel_version_info(hdev, ver);

/* The firmware variant determines if the device is in bootloader
@@ -2660,6 +2725,16 @@ done:

clear_bit(BTUSB_BOOTLOADER, &data->flags);

+ /* Once the device is running in operational mode, it needs to apply
+ * the device configuration(DDC) parameters to the device.
+ */
+ err = btusb_apply_ddc_intel(hdev, hw_variant);
+ if (err < 0) {
+ BT_ERR("%s: Failed to apply DDC parameters (%d)",
+ hdev->name, err);
+ return err;
+ }
+
return 0;
}

--
2.1.0


2015-05-26 16:43:22

by An, Tedd

[permalink] [raw]
Subject: Re: [PATCH v3] Bluetooth: btusb: Add routine for applying Intel DDC parameters

Hi Marcel,

On Mon, 25 May 2015 21:31:47 +0200
Marcel Holtmann <[email protected]> wrote:

> Hi Tedd,
>
> > This patch adds the routine to apply the DDC parameter from device
> > specific ddc file.
> >
> > Once the device is rest to operational mode, optionally, it can
> > download the device specific configration (DDC) parameters before
> > the BlueZ starts the stack initialization.
> >
> > It opens the DDC file based on HW_VARIANT and send ID/Value with
> > HCI_Intel_Write_DDC command.
> >
> > Format of DDC file
> > DDC file consists of one or more number of DDC structure that has a
> > 'Length' field of one octet, DDC 'ID' field of two octets followed by
> > the array of DDC 'Value' that gives the value of parameters itself.
> > 'Length' contains the length of DDC 'ID' and DDC 'Value'.
> >
> > +------------+----------+
> > | Size(byte) | Name |
> > +------------+----------+
> > | 1 | Length |
> > +------------+----------+
> > | 2 | ID |
> > +------------+----------+
> > | Length - 2 | Value |
> > +------------+----------+
>
> I wonder if we should add some sort of header to this file structure.
>

Could you explain more about the "header"? DDC header is Length and ID.
The DDC file can have more than one DDC. Do you mean the header for all DDC
contents? Then it will be same as HCI plen.

Also, how do you think about saving this file in ASCII format instead of binary?
then I can add some comments that start with # and ignore the line like bash script.


Regards,
Tedd

2015-05-25 19:31:47

by Marcel Holtmann

[permalink] [raw]
Subject: Re: [PATCH v3] Bluetooth: btusb: Add routine for applying Intel DDC parameters

Hi Tedd,

> This patch adds the routine to apply the DDC parameter from device
> specific ddc file.
>
> Once the device is rest to operational mode, optionally, it can
> download the device specific configration (DDC) parameters before
> the BlueZ starts the stack initialization.
>
> It opens the DDC file based on HW_VARIANT and send ID/Value with
> HCI_Intel_Write_DDC command.
>
> Format of DDC file
> DDC file consists of one or more number of DDC structure that has a
> 'Length' field of one octet, DDC 'ID' field of two octets followed by
> the array of DDC 'Value' that gives the value of parameters itself.
> 'Length' contains the length of DDC 'ID' and DDC 'Value'.
>
> +------------+----------+
> | Size(byte) | Name |
> +------------+----------+
> | 1 | Length |
> +------------+----------+
> | 2 | ID |
> +------------+----------+
> | Length - 2 | Value |
> +------------+----------+

I wonder if we should add some sort of header to this file structure.

> In case of command failure, it returns the command complete with
> parameter that contains the ID that failed to apply.
>
> Signed-off-by: Tedd Ho-Jeong An <[email protected]>
> ---
> drivers/bluetooth/btintel.h | 5 +++
> drivers/bluetooth/btusb.c | 75 +++++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 80 insertions(+)
>
> diff --git a/drivers/bluetooth/btintel.h b/drivers/bluetooth/btintel.h
> index 4bda6ab..affb216 100644
> --- a/drivers/bluetooth/btintel.h
> +++ b/drivers/bluetooth/btintel.h
> @@ -69,6 +69,11 @@ struct intel_secure_send_result {
> __u8 status;
> } __packed;
>
> +struct intel_write_ddc {
> + __u8 status;
> + __le16 failed_id;
> +} __packed;
> +
> #if IS_ENABLED(CONFIG_BT_INTEL)
>
> int btintel_check_bdaddr(struct hci_dev *hdev);
> diff --git a/drivers/bluetooth/btusb.c b/drivers/bluetooth/btusb.c
> index 13b9969..bc3697f 100644
> --- a/drivers/bluetooth/btusb.c
> +++ b/drivers/bluetooth/btusb.c
> @@ -2318,6 +2318,66 @@ static void btusb_intel_version_info(struct hci_dev *hdev,
> ver->fw_build_num, ver->fw_build_ww, 2000 + ver->fw_build_yy);
> }
>
> +static int btusb_apply_ddc_intel(struct hci_dev *hdev, u8 hw_variant)
> +{
> + const struct firmware *fw;
> + const u8 *fw_ptr;
> + char fwname[64];
> + struct sk_buff *skb;
> + int err;
> +
> + snprintf(fwname, sizeof(fwname), "intel/ibt-%d.ddc", hw_variant);

Lets use intel/ibt-11-%u.ddc here.

> +
> + /* Device can work without DDC parameters so even if it fails to load
> + * the file, no need to fail the device setup.
> + */
> + err = request_firmware_direct(&fw, fwname, &hdev->dev);
> + if (err < 0) {
> + BT_INFO("%s: WARNING: unable to load Intel DDC file: %s (%d)",
> + hdev->name, fwname, err);

I think the warning notion is a bit too much. Honestly I think that not printing anything here is just fine.

> + return 0;
> + }
> +
> + BT_INFO("%s: Intel DDC file opened: %s", hdev->name, fwname);
> +
> + fw_ptr = fw->data;
> + while (fw->size > fw_ptr - fw->data) {
> + struct intel_write_ddc *wr_ddc;
> + u8 cmd_len = fw_ptr[0] + sizeof(u8);
> +
> + skb = __hci_cmd_sync(hdev, 0xfc8b, cmd_len, fw_ptr,
> + HCI_INIT_TIMEOUT);
> + if (IS_ERR(skb)) {
> + BT_ERR("%s: Failed to send Intel_Write_DDC (%ld)",
> + hdev->name, PTR_ERR(skb));
> + release_firmware(fw);
> + return PTR_ERR(skb);

I would assign err variable and then just use a done label at the end of the function.

> + }
> +
> + wr_ddc = (struct intel_write_ddc *)skb->data;
> + if (wr_ddc->status) {

The status check is no longer needed. __hci_cmd_sync will have done that for you.

> + BT_ERR("%s: Intel write ddc command failure (%02x)",
> + hdev->name, wr_ddc->status);
> + BT_ERR("%s: Last failed DDC ID: %04x",
> + hdev->name, wr_ddc->failed_id);
> + err = -bt_to_errno(wr_ddc->status);
> + release_firmware(fw);
> + kfree_skb(skb);
> + return err;

Same as above. Assign err, free the skb and jump to the done label.

> + }
> +
> + fw_ptr += cmd_len;
> +
> + kfree_skb(skb);
> + }
> +
> + release_firmware(fw);
> +
> + BT_INFO("%s: Completed to apply Intel DDC parameters", hdev->name);
> +
> + return 0;
> +}
> +
> static int btusb_setup_intel_new(struct hci_dev *hdev)
> {
> static const u8 reset_param[] = { 0x00, 0x01, 0x00, 0x01,
> @@ -2331,6 +2391,7 @@ static int btusb_setup_intel_new(struct hci_dev *hdev)
> char fwname[64];
> ktime_t calltime, delta, rettime;
> unsigned long long duration;
> + u8 hw_variant;
> int err;
>
> BT_DBG("%s", hdev->name);
> @@ -2385,6 +2446,10 @@ static int btusb_setup_intel_new(struct hci_dev *hdev)
> return -EINVAL;
> }
>
> + /* Keep this variable for later use with DDC
> + */
> + hw_variant = ver->hw_variant;
> +
> btusb_intel_version_info(hdev, ver);
>
> /* The firmware variant determines if the device is in bootloader
> @@ -2660,6 +2725,16 @@ done:
>
> clear_bit(BTUSB_BOOTLOADER, &data->flags);
>
> + /* Once the device is running in operational mode, it needs to apply
> + * the device configuration(DDC) parameters to the device.
> + */
> + err = btusb_apply_ddc_intel(hdev, hw_variant);
> + if (err < 0) {
> + BT_ERR("%s: Failed to apply DDC parameters (%d)",
> + hdev->name, err);
> + return err;
> + }
> +

Do you want to keep this in a separate function or just put it inline here. Inline might be a bit easier.

> return 0;
> }

Regards

Marcel


2015-06-06 05:51:39

by Marcel Holtmann

[permalink] [raw]
Subject: Re: [PATCH v3] Bluetooth: btusb: Add routine for applying Intel DDC parameters

Hi Tedd,

>>> This patch adds the routine to apply the DDC parameter from device
>>> specific ddc file.
>>>
>>> Once the device is rest to operational mode, optionally, it can
>>> download the device specific configration (DDC) parameters before
>>> the BlueZ starts the stack initialization.
>>>
>>> It opens the DDC file based on HW_VARIANT and send ID/Value with
>>> HCI_Intel_Write_DDC command.
>>>
>>> Format of DDC file
>>> DDC file consists of one or more number of DDC structure that has a
>>> 'Length' field of one octet, DDC 'ID' field of two octets followed by
>>> the array of DDC 'Value' that gives the value of parameters itself.
>>> 'Length' contains the length of DDC 'ID' and DDC 'Value'.
>>>
>>> +------------+----------+
>>> | Size(byte) | Name |
>>> +------------+----------+
>>> | 1 | Length |
>>> +------------+----------+
>>> | 2 | ID |
>>> +------------+----------+
>>> | Length - 2 | Value |
>>> +------------+----------+
>>
>> I wonder if we should add some sort of header to this file structure.
>>
>
> Could you explain more about the "header"? DDC header is Length and ID.
> The DDC file can have more than one DDC. Do you mean the header for all DDC
> contents? Then it will be same as HCI plen.

I meant a general file header. Some magic bytes that identity this as DDC file. Not sure if this is needed or not. Otherwise for each DDC entry, I am totally fine in using the format of the HCI command itself as base for the data. That will make it really simple.

> Also, how do you think about saving this file in ASCII format instead of binary?
> then I can add some comments that start with # and ignore the line like bash script.

We can easily extend bluemoon utility to convert this from some kind of key value pair ASCII format. However in general the binary format is a bit more efficient from the kernel point of view.

Regards

Marcel