Skip to content

Commit 24fcfd4

Browse files
author
Amanda Butler
authored
Merge pull request #545 from bulislaw/hal_rtc_sleep_ticker_master
Sleep, tickers, RTC APIs are now on master
2 parents 7d93f15 + 4023058 commit 24fcfd4

File tree

4 files changed

+14
-38
lines changed

4 files changed

+14
-38
lines changed

docs/reference/contributing/target/lp_ticker.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Implementing the low power ticker enables Mbed OS to perform power efficient timing operations that only request millisecond accuracy. You can use this API to schedule events, record elapsed time and drive the tickless OS scheduler.
44

5-
<span class="warnings">**Warning:** We are changing the low power 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 low power ticker API](#implementing-the-low-power-ticker-api) section.
6-
75
### Assumptions
86

97
#### Defined behavior
@@ -48,13 +46,9 @@ Hardware low power ticker capabilities.
4846

4947
### Implementing the low power ticker API
5048

51-
We are working on the new HAL low power ticker API, which will replace the current version in an upcoming release of Mbed OS. You need to implement the low power ticker API in both variants. First, you need to implement the current API. You can find it on master branch:
52-
53-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/lp__ticker__api_8h_source.html)
54-
55-
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 low power ticker API in the following header file:
49+
You can find the API and specification for the low power ticker API in the following header file:
5650

57-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-ticker-doxy/group__hal__lp__ticker.html)
51+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__hal__lp__ticker.html)
5852

5953
To enable low power ticker support in Mbed OS, add the `LPTICKER` label in the `device_has` option of the target's section in the `targets.json` file.
6054

@@ -68,8 +62,8 @@ mbed test -t <toolchain> -m <target> -n tests-mbed_hal-common_ticker*,tests-mbed
6862

6963
You can read more about the test cases:
7064

71-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-ticker-doxy/group__hal__lp__ticker.html)
65+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__hal__lp__ticker.html)
7266

73-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-ticker-doxy/group__hal__ticker__tests.html)
67+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__hal__ticker__tests.html)
7468

75-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-ticker-doxy/group__hal__lp__ticker__tests.html)
69+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__hal__lp__ticker__tests.html)

docs/reference/contributing/target/rtc.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Implementing RTC enables Mbed OS to keep track of the current time. The standard library time keeping functions, such as `time`, use it.
44

5-
<span class="warnings">**Warning:** We are changing the RTC 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 RTC API](#implementing-the-rtc-api) section.
6-
75
### Assumptions
86

97
#### Defined behavior
@@ -32,11 +30,7 @@ Hardware RTC capabilities.
3230

3331
### Implementing the RTC API
3432

35-
We are working on the new HAL RTC API, which will replace the current version in an upcoming release of Mbed OS. You need to implement the RTC API in both variants. First, you need to implement the current API. You can find it on the master branch:
36-
37-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/rtc__api_8h_source.html)
38-
39-
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-rtc` branch. You can find the API and specification for the new RTC API in the following header file:
33+
You can find the API and specification for the RTC API in the following header file:
4034

4135
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-rtc-doxy/group__hal__rtc.html)
4236

docs/reference/contributing/target/sleep.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
## Sleep
22

3-
<span class="warnings">**Warning:** We are changing the Sleep 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 Sleep API](#implementing-the-sleep-api) section.
4-
53
Implement the Sleep HAL API to enable your device to go into a low power state when you are not actively using it.
64

75
### Assumptions
@@ -26,13 +24,9 @@ The core system clock is disabled. You can only enable the low-frequency clocks
2624

2725
### Implementing the Sleep API
2826

29-
We are working on the new HAL Sleep API, which will replace the current version in an upcoming release of Mbed OS. You need to implement the Sleep API in both variants. First, you need to implement the current API. You can find it on the master branch:
30-
31-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/sleep__api_8h_source.html)
32-
33-
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-sleep` branch. You can find the API and specification for the new Sleep API in the following header file:
27+
You can find the API and specification for the sleep API in the following header file:
3428

35-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-sleep-doxy/group__hal__sleep.html)
29+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__hal__sleep.html)
3630

3731
To enable sleep support in Mbed OS, you need to add the `SLEEP` label in the `device_has` option of the target's section in the `targets.json` file.
3832

@@ -46,4 +40,4 @@ mbed test -t <toolchain> -m <target> -n "tests-mbed_hal-sleep*"
4640

4741
You can read more about the test cases:
4842

49-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-sleep-doxy/group__hal__sleep__tests.html)
43+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__hal__sleep__tests.html)

docs/reference/contributing/target/us_ticker.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
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.
44

5-
<span class="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.
6-
75
### Assumptions
86

97
#### Defined behavior
@@ -42,13 +40,9 @@ To implement this API, the device must have a hardware counter that has a count
4240

4341
### Implementing the microsecond ticker API
4442

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:
46-
47-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/us__ticker__api_8h_source.html)
48-
49-
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:
43+
You can find the API and specification for the microsecond ticker API in the following header file:
5044

51-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-ticker-doxy/group__hal__us__ticker.html)
45+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__hal__us__ticker.html)
5246

5347
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.
5448

@@ -62,8 +56,8 @@ mbed test -t <toolchain> -m <target> -n tests-mbed_hal-common_ticker*,tests-mbed
6256

6357
You can read more about the test cases:
6458

65-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-ticker-doxy/group__hal__us__ticker.html)
59+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__hal__us__ticker.html)
6660

67-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-ticker-doxy/group__hal__ticker__tests.html)
61+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__hal__ticker__tests.html)
6862

69-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-ticker-doxy/group__hal__us__ticker__tests.html)
63+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__hal__us__ticker__tests.html)

0 commit comments

Comments
 (0)