Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Bluetooth qualification #9705

Merged
merged 1 commit into from
Sep 26, 2023
Merged

Conversation

annakielar
Copy link
Contributor

Added a new article about the Bluetooth qualification process. Added a few links to links.txt.

Signed-off-by: Anna Kielar anna.kielar@nordicsemi.no

@github-actions github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Dec 15, 2022
@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

@annakielar annakielar marked this pull request as ready for review January 4, 2023 14:53
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jan 4, 2023

Test specification

CI/Jenkins/NRF

  • Skipped

CI/Jenkins/integration

  • Skipped

Note: This message is automatically posted and updated by the CI

@annakielar annakielar force-pushed the bt_qualification branch 2 times, most recently from f488c8b to 089920d Compare January 16, 2023 10:12
@github-actions github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 16, 2023
doc/nrf/protocols.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@grochu grochu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding a few minor comments to clarify.

doc/nrf/protocols.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@grochu grochu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The update looks good.

@annakielar annakielar requested review from mileslouissmith and greg-fer and removed request for mileslouissmith January 23, 2023 10:46
Copy link

@mileslouissmith mileslouissmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks OK.

doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_matter_device_certification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
doc/nrf/ug_bt_qualification.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@greg-fer greg-fer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comments about text cohesion.

As a side note, I would like to see some figures that present the whole process visually. Bluetooth SIG's resources are text-heavy and I couldn't find any overview diagram under the links used on the page. It's really hard to go through wall of texts with different naming conventions for people new to the process, and the more we can do to save tech support some time, the better.

doc/nrf/protocols/bt/bt_qualification/index.rst Outdated Show resolved Hide resolved
doc/nrf/protocols/bt/bt_qualification/index.rst Outdated Show resolved Hide resolved
doc/nrf/protocols/bt/bt_qualification/index.rst Outdated Show resolved Hide resolved
doc/nrf/protocols/bt/bt_qualification/index.rst Outdated Show resolved Hide resolved
doc/nrf/protocols/bt/bt_qualification/index.rst Outdated Show resolved Hide resolved
doc/nrf/protocols/bt/bt_qualification/index.rst Outdated Show resolved Hide resolved
doc/nrf/protocols/bt/bt_qualification/index.rst Outdated Show resolved Hide resolved
doc/nrf/protocols/bt/bt_qualification/index.rst Outdated Show resolved Hide resolved
doc/nrf/protocols/bt/bt_qualification/index.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@omkar3141 omkar3141 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me.

@annakielar annakielar force-pushed the bt_qualification branch 2 times, most recently from 0f899c8 to f61f1d4 Compare August 25, 2023 10:17
@annakielar annakielar force-pushed the bt_qualification branch 2 times, most recently from 73ebc2f to a19f96f Compare September 13, 2023 10:28
@annakielar
Copy link
Contributor Author

Hi All, the PR is ready for your final review.

Copy link
Contributor

@grochu grochu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewed from the Bluetooth stack user perspective, I don't know much about the qualification process itself so I leave this aspect to other reviewers.
The chapter looks very good, it's well-organized and informative.
It may require a certain level of maintenance in case links, terminology or BT SIG policy changes in future.


Any qualified design offered by Nordic Semiconductor (for example, :ref:`ug_bt_mesh` versions) can be qualified independently by the customers.
However, this process may be complex and time-consuming, thus it is recommended to inherit Nordic Semiconductor's design qualifications in your End Product's listing.
If you want to create a Profile Subsystem that is not on the `Bluetooth Qualification Listing`_ yet, run the relevant tests through the `Profile Tuning Suite (PTS)`_ tool and qualify the product.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you want to create a Profile Subsystem that is not on the `Bluetooth Qualification Listing`_ yet, run the relevant tests through the `Profile Tuning Suite (PTS)`_ tool and qualify the product.
If you want to create a Profile Subsystem that is not on the `Bluetooth Qualification Listing`_, run the relevant tests through the `Profile Tuning Suite (PTS)`_ tool and qualify the product.


Before you start the `Bluetooth SIG's Qualification Process`_, ensure the following:

1. You have access to your member company's account.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. You have access to your member company's account.
#. You have access to your company's member account.

1. You have access to your member company's account.
To check if your company is already a SIG member, go to `Join Bluetooth SIG`_ page and search the Member Directory list.

2. Get acquainted with the Program Reference Document (PRD) and Declaration Process Document (DPD), that will help you to understand the basics.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Get acquainted with the Program Reference Document (PRD) and Declaration Process Document (DPD), that will help you to understand the basics.
#. Get acquainted with the Program Reference Document (PRD) and Declaration Process Document (DPD) to understand the basics of the qualification process.

To check if your company is already a SIG member, go to `Join Bluetooth SIG`_ page and search the Member Directory list.

2. Get acquainted with the Program Reference Document (PRD) and Declaration Process Document (DPD), that will help you to understand the basics.
Log into your member company's account to review both `PRD and DPD`_ documents.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Log into your member company's account to review both `PRD and DPD`_ documents.
Log into your company's member account to review both `PRD and DPD`_ documents.

Qualification process
*********************

Although you can use pre-qualified designs, any Bluetooth Product qualification cannot be simply inherited with no action required from your end.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Although you can use pre-qualified designs, any Bluetooth Product qualification cannot be simply inherited with no action required from your end.
Although you can use pre-qualified designs, Bluetooth Product qualification can only be inherited through action on your end.

* You want to switch to another major |NCS| version for an existing product.
* In some cases, if you want to switch to another minor |NCS| version for an existing product.

It may happen that you would need to alter the configuration of the qualified design or slightly modify small parts of the existing design to better fit your application needs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It may happen that you would need to alter the configuration of the qualified design or slightly modify small parts of the existing design to better fit your application needs.
You might need to alter the configuration of the qualified design or slightly modify parts of the existing design to better fit your application needs.

* Ensure that the resulting design does not change the Implementation Conformance Statement (ICS) that has already been declared for a relevant Nordic Semiconductor's qualified design.
* Ensure that the resulting design does not break the qualification of the existing design.

You can do so by running relevant qualification tests using test tools indicated in the 'Launch Studio'_ tool.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can do so by running relevant qualification tests using test tools indicated in the 'Launch Studio'_ tool.
You can complete the checks by running relevant qualification tests using test tools indicated in the 'Launch Studio'_ tool.


#. Open the Bluetooth QDIDs article and, based on the table, confirm the following information:

* That the version you want to use is compatible with versions of other Subsystems you want to keep for your product.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* That the version you want to use is compatible with versions of other Subsystems you want to keep for your product.
* The version you want to use must be compatible with versions of other Subsystems you want to keep for your product.


#. Navigate to the relevant Compatibility Matrix directory.

#. Open the Bluetooth QDIDs article and, based on the table, confirm the following information:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#. Open the Bluetooth QDIDs article and, based on the table, confirm the following information:
#. Open the Bluetooth QDIDs article and, based on the table, confirm the following:

#. Open the Bluetooth QDIDs article and, based on the table, confirm the following information:

* That the version you want to use is compatible with versions of other Subsystems you want to keep for your product.
* That relevant Host and SoftDevice Controller Subsystems implemented in the |NCS| version you want to use are pre-qualified.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* That relevant Host and SoftDevice Controller Subsystems implemented in the |NCS| version you want to use are pre-qualified.
* Relevant Host and SoftDevice Controller Subsystems implemented in the |NCS| version you want to use must be pre-qualified.

@annakielar annakielar force-pushed the bt_qualification branch 2 times, most recently from 776fb36 to 0889264 Compare September 22, 2023 09:23
@omkar3141
Copy link
Contributor

Hello, I think the PR is good enough, and it will be nice to merge it as soon as possible.

@greg-fer greg-fer self-requested a review September 25, 2023 07:04
@umapraseeda
Copy link
Contributor

@annakielar, please rebase as it is having conflict.

@annakielar annakielar force-pushed the bt_qualification branch 2 times, most recently from b8a0d6a to d40e24a Compare September 25, 2023 12:31
Added a new article about the Bluetooth qualification process.
Added a page gathering all Bluetooth-related topics in Protocols.
Added a few links to links.txt.

Signed-off-by: Anna Kielar <anna.kielar@nordicsemi.no>
@nordicjm nordicjm merged commit 54c13f8 into nrfconnect:main Sep 26, 2023
11 checks passed
@omkar3141
Copy link
Contributor

omkar3141 commented Sep 26, 2023 via email

@omkar3141
Copy link
Contributor

omkar3141 commented Sep 26, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.