You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/contributing/target/us_ticker.md
+1-15Lines changed: 1 addition & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,6 @@
2
2
3
3
Implementing the microsecond ticker enables Mbed OS to perform operations that require precise timing. You can use this API to schedule events, record elapsed time and perform submillisecond delays.
4
4
5
-
<spanclass="warnings">**Warning:** We are changing the microsecond ticker HAL API in an upcoming release of Mbed OS. This page documents code that exists on a feature branch of Mbed OS. You can find details on how it may affect you in the [implementing the microsecond ticker API](#implementing-the-microsecond-ticker-api) section.</span>
6
-
7
5
### Assumptions
8
6
9
7
#### Defined behavior
@@ -42,14 +40,10 @@ To implement this API, the device must have a hardware counter that has a count
42
40
43
41
### Implementing the microsecond ticker API
44
42
45
-
We are working on the new HAL microsecond ticker API, which will replace the current version in an upcoming release of Mbed OS. You need to implement the microsecond ticker API in both variants. First, you need to implement the current API. You can find it on the master branch:
43
+
You can find the API and specification for the microsecond ticker API in the following header file:
To make sure your platform is ready for the upcoming changes, you need to implement the future API and submit it in a separate pull request against the `feature-hal-spec-ticker` branch. You can find the API and specification for the new microsecond ticker API in the following header file:
To enable microsecond ticker support in Mbed OS, add the `USTICKER` label in the `device_has` option of the target's section in the `targets.json` file.
54
48
55
49
### Testing
@@ -59,11 +53,3 @@ The Mbed OS HAL provides a set of conformance tests for the microsecond ticker.
59
53
```
60
54
mbed test -t <toolchain> -m <target> -n tests-mbed_hal-common_ticker*,tests-mbed_hal-us_ticker*
0 commit comments