Skip to content

Cordio Documentation: Explain how to tests and what tools are available. #7417

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.

Sign up for GitHub

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

Merged
merged 9 commits into from
Aug 24, 2018
Merged

Cordio Documentation: Explain how to tests and what tools are available. #7417

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7a8cc02
Cordio Documentation: Explain how to tests and what tools are available.
pan- Jul 4, 2018
bae4c89
Remove shall, whole lotta other changes. Not done yet.
Jul 9, 2018
f2c6d59
Further stylistic changes. Passive -> active
Aug 10, 2018
739bd66
grammatical and stylistic fixes, more passive -> active
Aug 10, 2018
db8f369
Fixing colons and formatting
Aug 10, 2018
1082724
formatting changes
Aug 10, 2018
3b95202
Final review and grammatical changes
Aug 14, 2018
c1e154b
removing \
Aug 14, 2018
4a9570b
function signature line
Aug 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions features/FEATURE_BLE/targets/TARGET_CORDIO/doc/PortingGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,26 @@ ble::vendor::cordio::CordioHCIDriver& ble_cordio_get_hci_driver() {
}
```

### Tests

Greentea tests are bundled with the cordio port of BLE API to ensure that the transport driver works as expected as well as validate the cordio stack initialization. You can run them with the following command:
Copy link
Contributor

Choose a reason for hiding this comment

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

Greentea tests are bundled with the Cordio port of the BLE API to make sure the transport driver works as expected, as well as to validate Cordio stack initialization. You can run them with the following command:

We don't typically use language that implies things might not work (as per the style guide). I'm not crazy about "works as expected."

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, if the bundling is something Arm does, Arm should be the active subject of the sentence. Or "we."

Copy link
Contributor

Choose a reason for hiding this comment

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

Cordio capitalized throughout.


```
mbed test -t <toolchain> -m <target> -n mbed-os-features-feature_ble-targets-target_cordio-tests-cordio_hci-driver,mbed-os-features-feature_ble-targets-target_cordio-tests-cordio_hci-transport
```

* mbed-os-features-feature_ble-targets-target_cordio-tests-cordio_hci-transport: Ensure that the transport is able to send an HCI reset command and receive the corresponding HCI status event.
Copy link
Contributor

Choose a reason for hiding this comment

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

Rather than ensure, I'd suggest check. Or make sure.

Copy link
Contributor

Choose a reason for hiding this comment

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

Rather than is able to, can. Reduces wordiness.

Copy link
Contributor

Choose a reason for hiding this comment

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

Query: Why don't you like "ensure"? I usually prefer it to "make sure" because it's shorter.

* mbed-os-features-feature_ble-targets-target_cordio-tests-cordio_hci-driver: Runs the whole initialization process then ensure the cordio stack has been properly initialized by the HCI driver.


### Tools

The application [mbed-os-cordio-hci-passthrough](https://github.com/ARMmbed/mbed-os-cordio-hci-passthrough) can be used to _proxify_ a Bluetooth controller connected to an mbed board.

Bytes sent by the host over the board serial are forwarded to the controller with the help of the `HCITransportDriver` while bytes sent by the controller are sent back to the host through the board serial.
Copy link
Contributor

Choose a reason for hiding this comment

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

Subject-verb disagreement in Runs the whole initialization process then ensure the cordio stack has been properly initialized by the HCI driver.

Is this a statement about what the driver does, or a command that the user must follow?

Passive -> active. Every sentence here could be streamlined by changing from passive to active.


This application can be used to validate the transport driver and debug the initialization process on a PC host.




Expand Down