diff mbox series

Bluetooth: Add ABI doc for sysfs reset

Message ID 20250120162456.1.I2524c9a7d322be04b38b29bde3d7d1e578229cca@changeid (mailing list archive)
State Superseded
Headers show
Series Bluetooth: Add ABI doc for sysfs reset | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
tedd_an/SubjectPrefix success Gitlint PASS
tedd_an/BuildKernel success BuildKernel PASS
tedd_an/CheckAllWarning success CheckAllWarning PASS
tedd_an/CheckSparse success CheckSparse PASS
tedd_an/BuildKernel32 success BuildKernel32 PASS
tedd_an/TestRunnerSetup success TestRunnerSetup PASS
tedd_an/TestRunner_l2cap-tester success TestRunner PASS
tedd_an/TestRunner_iso-tester success TestRunner PASS
tedd_an/TestRunner_bnep-tester success TestRunner PASS
tedd_an/TestRunner_mgmt-tester fail TestRunner_mgmt-tester: Total: 490, Passed: 485 (99.0%), Failed: 1, Not Run: 4
tedd_an/TestRunner_rfcomm-tester success TestRunner PASS
tedd_an/TestRunner_sco-tester success TestRunner PASS
tedd_an/TestRunner_ioctl-tester success TestRunner PASS
tedd_an/TestRunner_mesh-tester success TestRunner PASS
tedd_an/TestRunner_smp-tester success TestRunner PASS
tedd_an/TestRunner_userchan-tester success TestRunner PASS

Commit Message

Hsin-chen Chuang Jan. 20, 2025, 8:24 a.m. UTC 
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

Comments

Paul Menzel Jan. 20, 2025, 8:32 a.m. UTC | #1 
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
Hsin-chen Chuang Jan. 20, 2025, 8:49 a.m. UTC | #2 
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
bluez.test.bot@gmail.com Jan. 20, 2025, 9 a.m. UTC | #3 
This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=926859

---Test result---

Test Summary:
CheckPatch                    PENDING   0.23 seconds
GitLint                       PENDING   0.23 seconds
SubjectPrefix                 PASS      0.11 seconds
BuildKernel                   PASS      24.39 seconds
CheckAllWarning               PASS      26.45 seconds
CheckSparse                   PASS      30.28 seconds
BuildKernel32                 PASS      23.90 seconds
TestRunnerSetup               PASS      429.76 seconds
TestRunner_l2cap-tester       PASS      22.56 seconds
TestRunner_iso-tester         PASS      30.42 seconds
TestRunner_bnep-tester        PASS      5.16 seconds
TestRunner_mgmt-tester        FAIL      121.67 seconds
TestRunner_rfcomm-tester      PASS      7.59 seconds
TestRunner_sco-tester         PASS      9.36 seconds
TestRunner_ioctl-tester       PASS      8.06 seconds
TestRunner_mesh-tester        PASS      6.12 seconds
TestRunner_smp-tester         PASS      7.02 seconds
TestRunner_userchan-tester    PASS      5.12 seconds
IncrementalBuild              PENDING   0.82 seconds

Details
##############################
Test: CheckPatch - PENDING
Desc: Run checkpatch.pl script
Output:

##############################
Test: GitLint - PENDING
Desc: Run gitlint
Output:

##############################
Test: TestRunner_mgmt-tester - FAIL
Desc: Run mgmt-tester with test-runner
Output:
Total: 490, Passed: 485 (99.0%), Failed: 1, Not Run: 4

Failed Test Cases
LL Privacy - Set Flags 1 (Add to RL)                 Failed       0.161 seconds
##############################
Test: IncrementalBuild - PENDING
Desc: Incremental build with the patches in the series
Output:



---
Regards,
Linux Bluetooth
diff mbox series

Patch

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/