diff mbox series

[BlueZ,v3] doc:Adding Roles property

Message ID 20200423142305.66778-1-alainm@chromium.org (mailing list archive)
State Accepted
Headers show
Series [BlueZ,v3] doc:Adding Roles property | expand

Commit Message

Alain Michaud April 23, 2020, 2:23 p.m. UTC
This change adds a new property to indicate the support for concurrent
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

Szymon Janc April 23, 2020, 2:42 p.m. UTC | #1
Hi,

On Thursday, 23 April 2020 16:23:05 CEST Alain Michaud wrote:
> This change adds a new property to indicate the support for concurrent
> 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..1a7255750 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} Roles [readonly]
> +
> +			List of supported roles. Possible values:
> +				"central": Supports the central role.
> +				"peripheral": Supports the peripheral 
role.
> +				"central-peripheral": Supports both 
roles
> +						      
concurrently.

If this is an array os strings why central-peripheral is needed?
Alain Michaud April 23, 2020, 2:51 p.m. UTC | #2
On Thu, Apr 23, 2020 at 10:42 AM Szymon Janc <szymon.janc@codecoup.pl> wrote:
>
> Hi,
>
> On Thursday, 23 April 2020 16:23:05 CEST Alain Michaud wrote:
> > This change adds a new property to indicate the support for concurrent
> > 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..1a7255750 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} Roles [readonly]
> > +
> > +                     List of supported roles. Possible values:
> > +                             "central": Supports the central role.
> > +                             "peripheral": Supports the peripheral
> role.
> > +                             "central-peripheral": Supports both
> roles
> > +
> concurrently.
>
> If this is an array os strings why central-peripheral is needed?
The keyword in the description is "concurrently".  Not all adapters
support being peripheral and central concurrently.

>
>
> --
> pozdrawiam
> Szymon Janc
>
>
Alain Michaud April 27, 2020, 2:57 p.m. UTC | #3
Any more feedback on this Api design?

On Thu, Apr 23, 2020 at 10:51 AM Alain Michaud <alainmichaud@google.com> wrote:
>
> On Thu, Apr 23, 2020 at 10:42 AM Szymon Janc <szymon.janc@codecoup.pl> wrote:
> >
> > Hi,
> >
> > On Thursday, 23 April 2020 16:23:05 CEST Alain Michaud wrote:
> > > This change adds a new property to indicate the support for concurrent
> > > 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..1a7255750 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} Roles [readonly]
> > > +
> > > +                     List of supported roles. Possible values:
> > > +                             "central": Supports the central role.
> > > +                             "peripheral": Supports the peripheral
> > role.
> > > +                             "central-peripheral": Supports both
> > roles
> > > +
> > concurrently.
> >
> > If this is an array os strings why central-peripheral is needed?
> The keyword in the description is "concurrently".  Not all adapters
> support being peripheral and central concurrently.
>
> >
> >
> > --
> > pozdrawiam
> > Szymon Janc
> >
> >
Luiz Augusto von Dentz April 27, 2020, 4:47 p.m. UTC | #4
Hi Alain,

On Mon, Apr 27, 2020 at 8:02 AM Alain Michaud <alainmichaud@google.com> wrote:
>
> Any more feedback on this Api design?
>
> On Thu, Apr 23, 2020 at 10:51 AM Alain Michaud <alainmichaud@google.com> wrote:
> >
> > On Thu, Apr 23, 2020 at 10:42 AM Szymon Janc <szymon.janc@codecoup.pl> wrote:
> > >
> > > Hi,
> > >
> > > On Thursday, 23 April 2020 16:23:05 CEST Alain Michaud wrote:
> > > > This change adds a new property to indicate the support for concurrent
> > > > 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..1a7255750 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} Roles [readonly]
> > > > +
> > > > +                     List of supported roles. Possible values:
> > > > +                             "central": Supports the central role.
> > > > +                             "peripheral": Supports the peripheral
> > > role.
> > > > +                             "central-peripheral": Supports both
> > > roles
> > > > +
> > > concurrently.
> > >
> > > If this is an array os strings why central-peripheral is needed?
> > The keyword in the description is "concurrently".  Not all adapters
> > support being peripheral and central concurrently.

Applied, thanks.
diff mbox series

Patch

diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index acae032d9..1a7255750 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} Roles [readonly]
+
+			List of supported roles. Possible values:
+				"central": Supports the central role.
+				"peripheral": Supports the peripheral role.
+				"central-peripheral": Supports both roles
+						      concurrently.