[PATCH] bluetooth: document config options

[PATCH] bluetooth: document config options

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 1199 bytes --]


Kernel config options should include useful help text; I had to look
up the terms on wikipedia.

Signed-off-by: Pavel Machek <pavel@ucw.cz>

diff --git a/net/bluetooth/Kconfig b/net/bluetooth/Kconfig
index 68f951b..133c8a6 100644
--- a/net/bluetooth/Kconfig
+++ b/net/bluetooth/Kconfig
@@ -45,6 +45,8 @@ config BT_BREDR
 	bool "Bluetooth Classic (BR/EDR) features"
 	depends on BT
 	default y
+	help
+	  Support Bluetooth version 1 and 2 connections.
 
 source "net/bluetooth/rfcomm/Kconfig"
 
@@ -58,11 +60,17 @@ config BT_HS
 	bool "Bluetooth High Speed (HS) features"
 	depends on BT_BREDR
 	default y
+	help
+	  Bluetooth 3 introduces high-speed mode where bluetooth endpoints
+	  negotiate fast connection over WIFI. This controls its support.
 
 config BT_LE
 	bool "Bluetooth Low Energy (LE) features"
 	depends on BT
 	default y
+	help
+	  Bluetooth 4 introduces special low-energy protocol, designed
+	  for simple devices. This controls its support.
 
 config BT_6LOWPAN
 	tristate "Bluetooth 6LoWPAN support"

-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]

Re: [PATCH] bluetooth: document config options

[Marcel Holtmann]

Hi Pavel,

> Kernel config options should include useful help text; I had to look
> up the terms on wikipedia.
> 
> Signed-off-by: Pavel Machek <pavel@ucw.cz>
> 
> diff --git a/net/bluetooth/Kconfig b/net/bluetooth/Kconfig
> index 68f951b..133c8a6 100644
> --- a/net/bluetooth/Kconfig
> +++ b/net/bluetooth/Kconfig
> @@ -45,6 +45,8 @@ config BT_BREDR
> 	bool "Bluetooth Classic (BR/EDR) features"
> 	depends on BT
> 	default y
> +	help
> +	  Support Bluetooth version 1 and 2 connections.

so this is actually not correct. Version 5.0 is also Bluetooth BR/EDR.

I am fine if use the terms "Basic Rate" and "Enhanced Data Rate" in the description, but the version numbers are kinda not how this works. So some alternative wording needs to be used:

"Bluetooth Classic includes support for Basic Rate (BR) available with Bluetooth version 1.0b or later and support for Enhanced Data Rate (EDR) available with Bluetooth version 2.0 or later."

> source "net/bluetooth/rfcomm/Kconfig"
> 
> @@ -58,11 +60,17 @@ config BT_HS
> 	bool "Bluetooth High Speed (HS) features"
> 	depends on BT_BREDR
> 	default y
> +	help
> +	  Bluetooth 3 introduces high-speed mode where bluetooth endpoints
> +	  negotiate fast connection over WIFI. This controls its support.

Again, while Bluetooth version 3.0 introduces HS support, it is not what is selecting this.

I think here we can write something like this:

"Bluetooth High Speed includes support for off-loading Bluetooth connections via 802.11 physical layer available with Bluetooth version 3.0 or later."

> 
> config BT_LE
> 	bool "Bluetooth Low Energy (LE) features"
> 	depends on BT
> 	default y
> +	help
> +	  Bluetooth 4 introduces special low-energy protocol, designed
> +	  for simple devices. This controls its support.

I think here it is also better to have an alternative text:

"Bluetooth Low Energy includes support low-energy physical layer available with Bluetooth version 4.0 or later."

Regards

Marcel

Re: [PATCH] bluetooth: document config options

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 2295 bytes --]

Hi!

> > Kernel config options should include useful help text; I had to look
> > up the terms on wikipedia.
> > 
> > Signed-off-by: Pavel Machek <pavel@ucw.cz>
> > 
> > diff --git a/net/bluetooth/Kconfig b/net/bluetooth/Kconfig
> > index 68f951b..133c8a6 100644
> > --- a/net/bluetooth/Kconfig
> > +++ b/net/bluetooth/Kconfig
> > @@ -45,6 +45,8 @@ config BT_BREDR
> > 	bool "Bluetooth Classic (BR/EDR) features"
> > 	depends on BT
> > 	default y
> > +	help
> > +	  Support Bluetooth version 1 and 2 connections.
> 
> so this is actually not correct. Version 5.0 is also Bluetooth BR/EDR.
> 
> I am fine if use the terms "Basic Rate" and "Enhanced Data Rate" in the description, but the version numbers are kinda not how this works. So some alternative wording needs to be used:
> 
> "Bluetooth Classic includes support for Basic Rate (BR) available with Bluetooth version 1.0b or later and support for Enhanced Data Rate (EDR) available with Bluetooth version 2.0 or later."
> 

Ok, works for me.

> > +	help
> > +	  Bluetooth 3 introduces high-speed mode where bluetooth endpoints
> > +	  negotiate fast connection over WIFI. This controls its support.
> 
> Again, while Bluetooth version 3.0 introduces HS support, it is not what is selecting this.
> 
> I think here we can write something like this:
> 
> "Bluetooth High Speed includes support for off-loading Bluetooth connections via 802.11 physical layer available with Bluetooth version 3.0 or later."
>

Ok.

> > config BT_LE
> > 	bool "Bluetooth Low Energy (LE) features"
> > 	depends on BT
> > 	default y
> > +	help
> > +	  Bluetooth 4 introduces special low-energy protocol, designed
> > +	  for simple devices. This controls its support.
> 
> I think here it is also better to have an alternative text:
> 
> "Bluetooth Low Energy includes support low-energy physical layer available with Bluetooth version 4.0 or later."
> 

Ok. Do I understand it correctly that Bluetooth LE basically has
nothing to do with bluetooth, and that Bluetooth 2 hardware will not
be able to detect / communicate with Bluetooth LE hardware?

									Pavel
-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]

Re: [PATCH] bluetooth: document config options

[Marcel Holtmann]

Hi Pavel,

>>> Kernel config options should include useful help text; I had to look
>>> up the terms on wikipedia.
>>> 
>>> Signed-off-by: Pavel Machek <pavel@ucw.cz>
>>> 
>>> diff --git a/net/bluetooth/Kconfig b/net/bluetooth/Kconfig
>>> index 68f951b..133c8a6 100644
>>> --- a/net/bluetooth/Kconfig
>>> +++ b/net/bluetooth/Kconfig
>>> @@ -45,6 +45,8 @@ config BT_BREDR
>>> 	bool "Bluetooth Classic (BR/EDR) features"
>>> 	depends on BT
>>> 	default y
>>> +	help
>>> +	  Support Bluetooth version 1 and 2 connections.
>> 
>> so this is actually not correct. Version 5.0 is also Bluetooth BR/EDR.
>> 
>> I am fine if use the terms "Basic Rate" and "Enhanced Data Rate" in the description, but the version numbers are kinda not how this works. So some alternative wording needs to be used:
>> 
>> "Bluetooth Classic includes support for Basic Rate (BR) available with Bluetooth version 1.0b or later and support for Enhanced Data Rate (EDR) available with Bluetooth version 2.0 or later."
>> 
> 
> Ok, works for me.
> 
>>> +	help
>>> +	  Bluetooth 3 introduces high-speed mode where bluetooth endpoints
>>> +	  negotiate fast connection over WIFI. This controls its support.
>> 
>> Again, while Bluetooth version 3.0 introduces HS support, it is not what is selecting this.
>> 
>> I think here we can write something like this:
>> 
>> "Bluetooth High Speed includes support for off-loading Bluetooth connections via 802.11 physical layer available with Bluetooth version 3.0 or later."
>> 
> 
> Ok.
> 
>>> config BT_LE
>>> 	bool "Bluetooth Low Energy (LE) features"
>>> 	depends on BT
>>> 	default y
>>> +	help
>>> +	  Bluetooth 4 introduces special low-energy protocol, designed
>>> +	  for simple devices. This controls its support.
>> 
>> I think here it is also better to have an alternative text:
>> 
>> "Bluetooth Low Energy includes support low-energy physical layer available with Bluetooth version 4.0 or later."
>> 
> 
> Ok. Do I understand it correctly that Bluetooth LE basically has
> nothing to do with bluetooth, and that Bluetooth 2 hardware will not
> be able to detect / communicate with Bluetooth LE hardware?

if you have LE only on one side and BR/EDR only on the other side, then they can not communicate with each other. You need at least one side with dual-mode BR/EDR/LE support.

Regards

Marcel

Re: [PATCH] bluetooth: document config options

[Marcel Holtmann]

Hi Pavel,

>>> Kernel config options should include useful help text; I had to look
>>> up the terms on wikipedia.
>>> 
>>> Signed-off-by: Pavel Machek <pavel@ucw.cz>
>>> 
>>> diff --git a/net/bluetooth/Kconfig b/net/bluetooth/Kconfig
>>> index 68f951b..133c8a6 100644
>>> --- a/net/bluetooth/Kconfig
>>> +++ b/net/bluetooth/Kconfig
>>> @@ -45,6 +45,8 @@ config BT_BREDR
>>> 	bool "Bluetooth Classic (BR/EDR) features"
>>> 	depends on BT
>>> 	default y
>>> +	help
>>> +	  Support Bluetooth version 1 and 2 connections.
>> 
>> so this is actually not correct. Version 5.0 is also Bluetooth BR/EDR.
>> 
>> I am fine if use the terms "Basic Rate" and "Enhanced Data Rate" in the description, but the version numbers are kinda not how this works. So some alternative wording needs to be used:
>> 
>> "Bluetooth Classic includes support for Basic Rate (BR) available with Bluetooth version 1.0b or later and support for Enhanced Data Rate (EDR) available with Bluetooth version 2.0 or later."
>> 
> 
> Ok, works for me.
> 
>>> +	help
>>> +	  Bluetooth 3 introduces high-speed mode where bluetooth endpoints
>>> +	  negotiate fast connection over WIFI. This controls its support.
>> 
>> Again, while Bluetooth version 3.0 introduces HS support, it is not what is selecting this.
>> 
>> I think here we can write something like this:
>> 
>> "Bluetooth High Speed includes support for off-loading Bluetooth connections via 802.11 physical layer available with Bluetooth version 3.0 or later."
>> 
> 
> Ok.

are you planning to send a patch with updated wording for this?

Regards

Marcel

[PATCHv2] bluetooth: document config options

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 1601 bytes --]

Kernel config options should include useful help text; I had to look
up the terms on wikipedia.

Signed-off-by: Pavel Machek <pavel@ucw.cz>

---

> are you planning to send a patch with updated wording for this?

Sorry for the delay, it is above. I added word "wifi" to 802.11
description.

							Pavel

diff --git a/net/bluetooth/Kconfig b/net/bluetooth/Kconfig
index 68f951b..48add1e 100644
--- a/net/bluetooth/Kconfig
+++ b/net/bluetooth/Kconfig
@@ -45,6 +45,11 @@ config BT_BREDR
 	bool "Bluetooth Classic (BR/EDR) features"
 	depends on BT
 	default y
+	help
+	  Bluetooth Classic includes support for Basic Rate (BR)
+	  available with Bluetooth version 1.0b or later and support
+	  for Enhanced Data Rate (EDR) available with Bluetooth
+	  version 2.0 or later.
 
 source "net/bluetooth/rfcomm/Kconfig"
 
@@ -58,12 +63,19 @@ config BT_HS
 	bool "Bluetooth High Speed (HS) features"
 	depends on BT_BREDR
 	default y
+	help
+	  Bluetooth High Speed includes support for off-loading
+	  Bluetooth connections via 802.11 (wifi) physical layer
+	  available with Bluetooth version 3.0 or later.
 
 config BT_LE
 	bool "Bluetooth Low Energy (LE) features"
 	depends on BT
 	default y
-
+	help
+	  Bluetooth Low Energy includes support low-energy physical
+	  layer available with Bluetooth version 4.0 or later.
+	  
 config BT_6LOWPAN
 	tristate "Bluetooth 6LoWPAN support"
 	depends on BT_LE && 6LOWPAN

-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]

Re: [PATCHv2] bluetooth: document config options

[Marcel Holtmann]

Hi Pavel,

> On Aug 8, 2017, at 15:48, Pavel Machek <pavel@ucw.cz> wrote:
> 
> Kernel config options should include useful help text; I had to look
> up the terms on wikipedia.
> 
> Signed-off-by: Pavel Machek <pavel@ucw.cz>
> 
> ---
> 
>> are you planning to send a patch with updated wording for this?
> 
> Sorry for the delay, it is above. I added word "wifi" to 802.11
> description.
> 
> 							Pavel

patch has been applied to bluetooth-next tree.

Regards

Marcel