[v1] Bluetooth: Add ABI doc for sysfs reset

[PATCH] Bluetooth: Add ABI doc for sysfs reset

Posted by Hsin-chen Chuang 1 year ago

From: Hsin-chen Chuang <chharry@chromium.org>

The functionality was implemented in commit 0f8a00137411 ("Bluetooth:
Allow reset via sysfs")

Signed-off-by: Hsin-chen Chuang <chharry@chromium.org>
---

 Documentation/ABI/stable/sysfs-class-bluetooth | 9 +++++++++
 MAINTAINERS                                    | 1 +
 2 files changed, 10 insertions(+)
 create mode 100644 Documentation/ABI/stable/sysfs-class-bluetooth

diff --git a/Documentation/ABI/stable/sysfs-class-bluetooth b/Documentation/ABI/stable/sysfs-class-bluetooth
new file mode 100644
index 000000000000..e794ce706582
--- /dev/null
+++ b/Documentation/ABI/stable/sysfs-class-bluetooth
@@ -0,0 +1,9 @@
+What: 		/sys/class/bluetooth/hci<index>/reset
+Date:		14-Jan-2025
+KernelVersion:	6.13
+Contact:	linux-bluetooth@vger.kernel.org
+Description: 	This write-only attribute allows users to trigger the vendor reset
+		method on the Bluetooth device when an arbitrary data is written.
+		The reset may or may not be done through the device transport
+		(e.g., UART/USB), and can through an out-of-band approach such as
+		GPIO.
diff --git a/MAINTAINERS b/MAINTAINERS
index 797e94ba74f7..e949c3ac7846 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4058,6 +4058,7 @@ S:	Supported
 W:	http://www.bluez.org/
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/bluetooth/bluetooth.git
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/bluetooth/bluetooth-next.git
+F:	Documentation/ABI/stable/sysfs-class-bluetooth
 F:	include/net/bluetooth/
 F:	net/bluetooth/
 
-- 
2.48.0.rc2.279.g1de40edade-goog

Re: [PATCH] Bluetooth: Add ABI doc for sysfs reset

Posted by Paul Menzel 1 year ago

Dear Hsin-chen,


Thank you for your patch.


Am 20.01.25 um 09:24 schrieb Hsin-chen Chuang:
> From: Hsin-chen Chuang <chharry@chromium.org>
> 
> The functionality was implemented in commit 0f8a00137411 ("Bluetooth:
> Allow reset via sysfs")

Add a Fixes: tag?

> Signed-off-by: Hsin-chen Chuang <chharry@chromium.org>
> ---
> 
>   Documentation/ABI/stable/sysfs-class-bluetooth | 9 +++++++++
>   MAINTAINERS                                    | 1 +
>   2 files changed, 10 insertions(+)
>   create mode 100644 Documentation/ABI/stable/sysfs-class-bluetooth
> 
> diff --git a/Documentation/ABI/stable/sysfs-class-bluetooth b/Documentation/ABI/stable/sysfs-class-bluetooth
> new file mode 100644
> index 000000000000..e794ce706582
> --- /dev/null
> +++ b/Documentation/ABI/stable/sysfs-class-bluetooth
> @@ -0,0 +1,9 @@
> +What: 		/sys/class/bluetooth/hci<index>/reset
> +Date:		14-Jan-2025
> +KernelVersion:	6.13
> +Contact:	linux-bluetooth@vger.kernel.org
> +Description: 	This write-only attribute allows users to trigger the vendor reset
> +		method on the Bluetooth device when an arbitrary data is written.

*data* is plural, so “when arbitrary data is written”?

> +		The reset may or may not be done through the device transport
> +		(e.g., UART/USB), and can through an out-of-band approach such as

…, and can *also be done* through …

> +		GPIO.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 797e94ba74f7..e949c3ac7846 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -4058,6 +4058,7 @@ S:	Supported
>   W:	http://www.bluez.org/
>   T:	git git://git.kernel.org/pub/scm/linux/kernel/git/bluetooth/bluetooth.git
>   T:	git git://git.kernel.org/pub/scm/linux/kernel/git/bluetooth/bluetooth-next.git
> +F:	Documentation/ABI/stable/sysfs-class-bluetooth
>   F:	include/net/bluetooth/
>   F:	net/bluetooth/
>   


Kind regards,

Paul

Re: [PATCH] Bluetooth: Add ABI doc for sysfs reset

Posted by Hsin-chen Chuang 1 year ago

Hi Paul,

Thanks for the quick response. I have uploaded the v2 patch, thanks.


On Mon, Jan 20, 2025 at 4:32 PM Paul Menzel <pmenzel@molgen.mpg.de> wrote:
>
> Dear Hsin-chen,
>
>
> Thank you for your patch.
>
>
> Am 20.01.25 um 09:24 schrieb Hsin-chen Chuang:
> > From: Hsin-chen Chuang <chharry@chromium.org>
> >
> > The functionality was implemented in commit 0f8a00137411 ("Bluetooth:
> > Allow reset via sysfs")
>
> Add a Fixes: tag?
>
> > Signed-off-by: Hsin-chen Chuang <chharry@chromium.org>
> > ---
> >
> >   Documentation/ABI/stable/sysfs-class-bluetooth | 9 +++++++++
> >   MAINTAINERS                                    | 1 +
> >   2 files changed, 10 insertions(+)
> >   create mode 100644 Documentation/ABI/stable/sysfs-class-bluetooth
> >
> > diff --git a/Documentation/ABI/stable/sysfs-class-bluetooth b/Documentation/ABI/stable/sysfs-class-bluetooth
> > new file mode 100644
> > index 000000000000..e794ce706582
> > --- /dev/null
> > +++ b/Documentation/ABI/stable/sysfs-class-bluetooth
> > @@ -0,0 +1,9 @@
> > +What:                /sys/class/bluetooth/hci<index>/reset
> > +Date:                14-Jan-2025
> > +KernelVersion:       6.13
> > +Contact:     linux-bluetooth@vger.kernel.org
> > +Description:         This write-only attribute allows users to trigger the vendor reset
> > +             method on the Bluetooth device when an arbitrary data is written.
>
> *data* is plural, so “when arbitrary data is written”?
>
> > +             The reset may or may not be done through the device transport
> > +             (e.g., UART/USB), and can through an out-of-band approach such as
>
> …, and can *also be done* through …
>
> > +             GPIO.
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index 797e94ba74f7..e949c3ac7846 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -4058,6 +4058,7 @@ S:      Supported
> >   W:  http://www.bluez.org/
> >   T:  git git://git.kernel.org/pub/scm/linux/kernel/git/bluetooth/bluetooth.git
> >   T:  git git://git.kernel.org/pub/scm/linux/kernel/git/bluetooth/bluetooth-next.git
> > +F:   Documentation/ABI/stable/sysfs-class-bluetooth
> >   F:  include/net/bluetooth/
> >   F:  net/bluetooth/
> >
>
>
> Kind regards,
>
> Paul

-- 
Best Regards,
Hsin-chen