bluetooth: document config options

PATCH Superseded Pavel Machek 2 participants 7 messages Jul 21, 2017 – Aug 8, 2017

Subsystems (4)

Networking Network drivers Bluetooth drivers Bluetooth

lore

Share & tools

lore

Pavel Machek

author

2017-07-21 07:49 UTC #0 lore raw

PATCH 1/1 bluetooth: document config options

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

Signed-off-by Pavel Machek <[email protected]>

net/bluetooth/Kconfig +8 -0

index 68f951b..133c8a6 100644
@@ -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"

Signature · 2 lines

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

Marcel Holtmann

maintainer

2017-07-21 09:55 UTC #1 lore raw

Hi Pavel,

Quoted 10 lines

Kernel config options should include useful help text; I had to look up the terms on wikipedia.
Signed-off-by Pavel Machek <[email protected]>
net/bluetooth/Kconfig +0 -0
index 68f951b..133c8a6 100644

net/bluetooth/Kconfig config BT_BREDR · line 49

Quoted 5 lines

net/bluetooth/Kconfig +2 -0

@@ -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."

net/bluetooth/Kconfig config BT_HS · line 65

Quoted 9 lines

source "net/bluetooth/rfcomm/Kconfig"

net/bluetooth/Kconfig +3 -0

@@ -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."

net/bluetooth/Kconfig config BT_HS · line 73

Quoted 8 lines

config BT_LE
bool "Bluetooth Low Energy (LE) features"
depends on BT
default y
net/bluetooth/Kconfig +3 -0
+	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

Pavel Machek

author

2017-07-21 10:42 UTC #2 lore raw

Hi!

Quoted 18 lines

Quoted 10 lines
Kernel config options should include useful help text; I had to look up the terms on wikipedia.
Signed-off-by Pavel Machek <[email protected]>
net/bluetooth/Kconfig +0 -0
index 68f951b..133c8a6 100644
net/bluetooth/Kconfig config BT_BREDR · line 49
Quoted 5 lines
net/bluetooth/Kconfig +2 -0
@@ -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.

Quoted 4 lines

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.

Quoted 10 lines

net/bluetooth/Kconfig config BT_HS · line 65
Quoted 3 lines
net/bluetooth/Kconfig +3 -0
+	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.

Quoted 10 lines

net/bluetooth/Kconfig config BT_HS · line 73
Quoted 7 lines
config BT_LE
bool "Bluetooth Low Energy (LE) features"
depends on BT
default y
net/bluetooth/Kconfig +3 -0
+	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:

Quoted 2 lines

"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

Signature · 2 lines

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

Marcel Holtmann

maintainer

2017-07-21 10:55 UTC #3 lore raw

Hi Pavel,

Quoted 48 lines

Quoted 18 lines
Quoted 10 lines
Kernel config options should include useful help text; I had to look up the terms on wikipedia.
Signed-off-by Pavel Machek <[email protected]>
net/bluetooth/Kconfig +0 -0
index 68f951b..133c8a6 100644
net/bluetooth/Kconfig config BT_BREDR · line 49
Quoted 5 lines
net/bluetooth/Kconfig +2 -0
@@ -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.
Quoted 4 lines
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.
Quoted 10 lines
net/bluetooth/Kconfig config BT_HS · line 65
Quoted 3 lines
net/bluetooth/Kconfig +3 -0
+	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.
Quoted 10 lines
net/bluetooth/Kconfig config BT_HS · line 73
Quoted 7 lines
config BT_LE
bool "Bluetooth Low Energy (LE) features"
depends on BT
default y
net/bluetooth/Kconfig +3 -0
+	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:

Quoted 6 lines

Quoted 2 lines
"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

Marcel Holtmann

maintainer

2017-08-07 06:34 UTC #4 lore raw

In reply to Pavel Machek

Hi Pavel,

Quoted 31 lines

Quoted 18 lines
Quoted 10 lines
Kernel config options should include useful help text; I had to look up the terms on wikipedia.
Signed-off-by Pavel Machek <[email protected]>
net/bluetooth/Kconfig +0 -0
index 68f951b..133c8a6 100644
net/bluetooth/Kconfig config BT_BREDR · line 49
Quoted 5 lines
net/bluetooth/Kconfig +2 -0
@@ -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.
Quoted 4 lines
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.
Quoted 6 lines
net/bluetooth/Kconfig config BT_HS · line 65
Quoted 3 lines
net/bluetooth/Kconfig +3 -0
+	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.

Quoted 6 lines

Quoted 4 lines
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

Pavel Machek

author

2017-08-08 13:48 UTC #5 lore raw

PATCH v2 1/1 bluetooth: document config options

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

Signed-off-by Pavel Machek <[email protected]>

---

Quoted 1 line

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

net/bluetooth/Kconfig +13 -1

index 68f951b..48add1e 100644
@@ -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

Signature · 2 lines

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

Marcel Holtmann

maintainer

2017-08-08 14:04 UTC #6 lore raw

Hi Pavel,

Quoted 7 lines · Pavel Machek

Kernel config options should include useful help text; I had to look up the terms on wikipedia.
Signed-off-by Pavel Machek <[email protected]>

Quoted 8 lines

---
Quoted 1 line
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