diff mbox series

[BlueZ,v2] doc:Adding LESupportedRoles property

Message ID 20200421204722.195637-1-alainm@chromium.org (mailing list archive)
State Superseded
Headers show
Series [BlueZ,v2] doc:Adding LESupportedRoles property | expand

Commit Message

Alain Michaud April 21, 2020, 8:47 p.m. UTC
This change adds a new property to indicate the support for concurrent
LE roles which means that the controller has reported the appropriate
LE_Supported_States (hdev->le_states) and that the controller's driver
has reported correctly handling the various reported states.
---

 doc/adapter-api.txt | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Marcel Holtmann April 22, 2020, 5:34 p.m. UTC | #1
Hi Alain,

> This change adds a new property to indicate the support for concurrent
> LE roles which means that the controller has reported the appropriate
> LE_Supported_States (hdev->le_states) and that the controller's driver
> has reported correctly handling the various reported states.
> ---
> 
> doc/adapter-api.txt | 8 ++++++++
> 1 file changed, 8 insertions(+)
> 
> diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
> index acae032d9..f76e1e910 100644
> --- a/doc/adapter-api.txt
> +++ b/doc/adapter-api.txt
> @@ -326,3 +326,11 @@ Properties	string Address [readonly]
> 
> 			Local Device ID information in modalias format
> 			used by the kernel and udev.
> +
> +		array{string} LERoles [readonly]

I would just call it Roles. Then we can extend it without having to be LE specific.

> +
> +			List of supported LE roles.  Possible values:
> +				"central" - Supports the central role.
> +				"peripheral" - Supports the peripheral role.
> +				"central-peripheral" - Supports both roles
> +						       concurrently.

Otherwise I am good with this.

Regards

Marcel
diff mbox series

Patch

diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index acae032d9..f76e1e910 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -326,3 +326,11 @@  Properties	string Address [readonly]
 
 			Local Device ID information in modalias format
 			used by the kernel and udev.
+
+		array{string} LERoles [readonly]
+
+			List of supported LE roles.  Possible values:
+				"central" - Supports the central role.
+				"peripheral" - Supports the peripheral role.
+				"central-peripheral" - Supports both roles
+						       concurrently.