diff mbox series

[BlueZ,v6,1/8] doc: Introduce the quality report command and event

Message ID 20220526112456.2488536-1-josephsih@chromium.org (mailing list archive)
State Accepted
Commit 93850c827d549115f0396da42c4a0529feeed1a3
Headers show
Series [BlueZ,v6,1/8] doc: Introduce the quality report command and event | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
tedd_an/checkpatch success Checkpatch PASS
tedd_an/gitlint success Gitlint PASS
tedd_an/setupell success Setup ELL PASS
tedd_an/buildprep success Build Prep PASS
tedd_an/build success Build Configuration PASS
tedd_an/makecheck success Make Check PASS
tedd_an/makecheckvalgrind success Make Check PASS
tedd_an/makedistcheck success Make Distcheck PASS
tedd_an/build_extell success Build External ELL PASS
tedd_an/build_extell_make success Build Make with External ELL PASS
tedd_an/incremental_build success Pass

Commit Message

Joseph Hwang May 26, 2022, 11:24 a.m. UTC 
Add the MGMT quality report command and event in doc/mgmt-api.txt.

---

Changes in v6:
- No update in this patch. The patch 3/8 is updated to resolve a
  patch conflict.

Changes in v5:
- Use Quality_Report instead of Action in mgmt-api.txt.
- Modify the description of Set Quality Report Command.

Changes in v4:
- Use "Quality Report Event" without the prefix "Bluetooth" word.
- Combine both MGMT quality report command and event changes in a
  single patch.

Changes in v3:
- Swap AOSP Bluetooth Quality Report Event and Intel Telemetry Event.
- Add 5 new patches (5/9 - 9/9) to enable the quality report
  feature via MGMT_OP_SET_QUALITY_REPORT instead of through the
  experimental features.

Changes in v2:
- This is a new patch for adding the event in doc/mgmt-api.txt

 doc/mgmt-api.txt | 60 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)

Comments

bluez.test.bot@gmail.com May 26, 2022, 3:39 p.m. UTC | #1 
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=645249

---Test result---

Test Summary:
CheckPatch                    PASS      8.83 seconds
GitLint                       FAIL      5.88 seconds
Prep - Setup ELL              PASS      43.76 seconds
Build - Prep                  PASS      0.56 seconds
Build - Configure             PASS      8.53 seconds
Build - Make                  PASS      1334.80 seconds
Make Check                    PASS      11.63 seconds
Make Check w/Valgrind         PASS      458.89 seconds
Make Distcheck                PASS      239.06 seconds
Build w/ext ELL - Configure   PASS      8.89 seconds
Build w/ext ELL - Make        PASS      1320.90 seconds
Incremental Build with patchesPASS      10678.68 seconds

Details
##############################
Test: GitLint - FAIL
Desc: Run gitlint with rule in .gitlint
Output:
[BlueZ,v6,2/8] lib: Add structures and constants for quality report command and event
1: T1 Title exceeds max length (85>80): "[BlueZ,v6,2/8] lib: Add structures and constants for quality report command and event"




---
Regards,
Linux Bluetooth
patchwork-bot+bluetooth@kernel.org June 2, 2022, 4 p.m. UTC | #2 
Hello:

This series was applied to bluetooth/bluez.git (master)
by Marcel Holtmann <marcel@holtmann.org>:

On Thu, 26 May 2022 19:24:49 +0800 you wrote:
> Add the MGMT quality report command and event in doc/mgmt-api.txt.
> 
> ---
> 
> Changes in v6:
> - No update in this patch. The patch 3/8 is updated to resolve a
>   patch conflict.
> 
> [...]

Here is the summary with links:
  - [BlueZ,v6,1/8] doc: Introduce the quality report command and event
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=93850c827d54
  - [BlueZ,v6,2/8] lib: Add structures and constants for quality report command and event
    (no matching commit)
  - [BlueZ,v6,3/8] adapter: remove quality report from experimental features
    (no matching commit)
  - [BlueZ,v6,4/8] adapter: support AOSP MGMT_EV_QUALITY_REPORT
    (no matching commit)
  - [BlueZ,v6,5/8] adapter: support Intel MGMT_EV_QUALITY_REPORT
    (no matching commit)
  - [BlueZ,v6,6/8] tools/btmgmt: fix quality report command
    (no matching commit)
  - [BlueZ,v6,7/8] monitor: print quality report cmd
    (no matching commit)
  - [BlueZ,v6,8/8] monitor: packet: add missing decodings of MGMT commands to todo
    (no matching commit)

You are awesome, thank you!
Joseph Hwang June 7, 2022, 6:40 a.m. UTC | #3 
Hi Marcel:

  Do you mean to apply the first patch in the series or to apply the 8
patches in the whole series?

  It seems that only the first patch was applied in
https://git.kernel.org/pub/scm/bluetooth/bluez.git

  Just would like to confirm with you. Thanks!

Regards,
Joseph

On Fri, Jun 3, 2022 at 12:00 AM <patchwork-bot+bluetooth@kernel.org> wrote:
>
> Hello:
>
> This series was applied to bluetooth/bluez.git (master)
> by Marcel Holtmann <marcel@holtmann.org>:
>
> On Thu, 26 May 2022 19:24:49 +0800 you wrote:
> > Add the MGMT quality report command and event in doc/mgmt-api.txt.
> >
> > ---
> >
> > Changes in v6:
> > - No update in this patch. The patch 3/8 is updated to resolve a
> >   patch conflict.
> >
> > [...]
>
> Here is the summary with links:
>   - [BlueZ,v6,1/8] doc: Introduce the quality report command and event
>     https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=93850c827d54
>   - [BlueZ,v6,2/8] lib: Add structures and constants for quality report command and event
>     (no matching commit)
>   - [BlueZ,v6,3/8] adapter: remove quality report from experimental features
>     (no matching commit)
>   - [BlueZ,v6,4/8] adapter: support AOSP MGMT_EV_QUALITY_REPORT
>     (no matching commit)
>   - [BlueZ,v6,5/8] adapter: support Intel MGMT_EV_QUALITY_REPORT
>     (no matching commit)
>   - [BlueZ,v6,6/8] tools/btmgmt: fix quality report command
>     (no matching commit)
>   - [BlueZ,v6,7/8] monitor: print quality report cmd
>     (no matching commit)
>   - [BlueZ,v6,8/8] monitor: packet: add missing decodings of MGMT commands to todo
>     (no matching commit)
>
> You are awesome, thank you!
> --
> Deet-doot-dot, I am a bot.
> https://korg.docs.kernel.org/patchwork/pwbot.html
>
>
diff mbox series

Patch

diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt
index ebe56afa4..a429f0ef3 100644
--- a/doc/mgmt-api.txt
+++ b/doc/mgmt-api.txt
@@ -332,6 +332,7 @@  Read Controller Information Command
 		15	Static Address
 		16	PHY Configuration
 		17	Wideband Speech
+		18	Quality Report
 
 	This command generates a Command Complete event on success or
 	a Command Status event on failure.
@@ -2924,6 +2925,7 @@  Read Extended Controller Information Command
 		15	Static Address
 		16	PHY Configuration
 		17	Wideband Speech
+		18	Quality Report
 
 	The EIR_Data field contains information about class of device,
 	local name and other values. Not all of them might be present. For
@@ -3858,6 +3860,45 @@  Add Advertisement Patterns Monitor With RSSI Threshold Command
 				Invalid Parameters
 
 
+Set Quality Report Command
+==========================
+
+	Command Code:		0x0057
+	Controller Index:	<controller id>
+	Command Parameters:	Quality_Report (1 Octet)
+	Return Parameters:	Current_Settings (4 Octets)
+
+	This command is used to enable and disable the controller's quality
+	report feature. The allowed values for the Quality_Report command
+	parameter are 0x00 and 0x01. All other values will return Invalid
+	Parameters.
+
+	The value 0x00 disables the Quality Report, and the value 0x01
+	enables the Quality Report feature.
+
+	This command is only available for the controllers that support
+	either AOSP Bluetooth quality report or Intel telemetry event.
+	It is supported if the supported_settings indicate support for it.
+
+	This command requires to use a valid controller index. Otherwise,
+	an Invalid Index status will be returned.
+
+	The command is sent to the controller to enable/disable the quality
+	report feature, and generates a Command Complete event on success.
+	If the controller failed to execute the action, a Failed status will
+	be returned.
+
+	The quality report state is maintained by the kernel over the adapter
+	power cycle. When the adapter is powered off, the quality report
+	feature is disabled by the kernel. When the adapter is powered on, it
+	is enabled again by the kernel if it was enabled before.
+
+	Possible errors:	Failed
+				Invalid Index
+				Invalid Parameters
+				Not Supported
+
+
 Command Complete Event
 ======================
 
@@ -4978,3 +5019,22 @@  Advertisement Monitor Device Lost Event
 		2	LE Random
 
 	This event will be sent to all management sockets.
+
+
+Quality Report Event
+====================
+
+	Event code:		0x0031
+	Controller Index:	<controller_id>
+	Event Parameters:	Quality_Spec (1 Octet)
+				Report_Len (2 Octets)
+				Report (0-65535 Octets)
+
+	This event carries the Bluetooth quality report sent by the
+	controller.
+
+	Possible values for the Quality_Spec parameter:
+		0	AOSP Bluetooth Quality Report Event
+		1	Intel Telemetry Event
+
+	This event will be sent to all management sockets.