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/lp_ticker.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Implementing the low power ticker enables Mbed OS to perform power efficient tim
16
16
- The ticker rolls over at (1 << bits) and continues counting starting from 0.
17
17
- The ticker counts at the specified frequency plus or minus 10%.
18
18
- The ticker increments by 1 each tick.
19
-
- The ticker interrupt fires only when the ticker times increments to or past the value that `ticker_set_interrupt` sets.
19
+
- The ticker interrupt fires only when the ticker time increments to or past the value that `ticker_set_interrupt` sets.
20
20
- It is safe to call `ticker_set_interrupt` repeatedly before the handler is called.
21
21
- The function `ticker_fire_interrupt` causes `ticker_irq_handler` to be called immediately from interrupt context.
22
22
- The ticker operations `ticker_read`, `ticker_clear_interrupt`, `ticker_set_interrupt` and `ticker_fire_interrupt` take less than 20us to complete.
@@ -34,19 +34,19 @@ Be careful around these common trouble areas when implementing this API:
34
34
35
35
- The ticker cannot drift when rescheduled repeatedly
36
36
- The ticker keeps counting when it rolls over
37
-
- The ticker interrupts fires when the compare value is set to 0 and and overflow occurs
37
+
- The ticker interrupt fires when the compare value is set to 0 and and overflow occurs
38
38
39
39
#### Dependencies
40
40
41
41
Hardware low power ticker capabilities.
42
42
43
43
#### Implementing the low power ticker API
44
44
45
-
We are working on the new HAL low power ticker API, which will replace 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:
45
+
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:
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 `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
+
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:
Copy file name to clipboardExpand all lines: docs/reference/contributing/target/rtc.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -32,11 +32,11 @@ Hardware RTC capabilities.
32
32
33
33
#### Implementing the RTC API
34
34
35
-
We are working on the new HAL RTC API, which will replace 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:
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:
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 `feature-hal-spec-rtc` branch. You can find the API and specification for the new RTC API in the following header file:
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:
Copy file name to clipboardExpand all lines: docs/reference/contributing/target/sleep.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Implement the Sleep HAL API to enable your device to go into a low power state w
8
8
9
9
##### Defined behavior
10
10
11
-
There are two powersaving modes available in Mbed OS:
11
+
There are two power-saving modes available in Mbed OS:
12
12
13
13
###### Sleep
14
14
@@ -26,11 +26,11 @@ The core system clock is disabled. You can only enable the low-frequency clocks
26
26
27
27
#### Implementing the Sleep API
28
28
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 master branch:
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:
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 `feature-hal-spec-sleep` branch. You can find the API and specification for the new Sleep API in the following header file:
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:
Copy file name to clipboardExpand all lines: docs/reference/contributing/target/us_ticker.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
### Microsecond ticker
2
2
3
-
Implementing the microsecond ticker enables Mbed OS to perform operations that require precise timing. You can use this API to shedule events, record elapsed time and perform submillisecond delays.
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
5
<spanclass="warnings">**Warning:** We are changing the microsecond ticker HAL API in an upcoming release 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
6
@@ -16,7 +16,7 @@ Implementing the microsecond ticker enables Mbed OS to perform operations that r
16
16
- The ticker rolls over at (1 << bits) and continues counting starting from 0.
17
17
- The ticker counts at the specified frequency plus or minus 10%.
18
18
- The ticker increments by 1 each tick.
19
-
- The ticker interrupt fires only when the ticker times increments to or past the value set by `ticker_set_interrupt`.
19
+
- The ticker interrupt fires only when the ticker time increments to or past the value set by `ticker_set_interrupt`.
20
20
- It is safe to call `ticker_set_interrupt` repeatedly before the handler is called.
21
21
- The function `ticker_fire_interrupt` causes `ticker_irq_handler` to be called immediately from interrupt context.
22
22
- The ticker operations `ticker_read`, `ticker_clear_interrupt`, `ticker_set_interrupt` and `ticker_fire_interrupt` take less than 20us to complete.
@@ -34,19 +34,19 @@ Be careful around these common trouble areas when implementing this API:
34
34
35
35
- The ticker cannot drift when rescheduled repeatedly
36
36
- The ticker keeps counting when it rolls over
37
-
- The ticker interrupts fires when the compare value is set to 0 and and overflow occurs
37
+
- The ticker interrupt fires when the compare value is set to 0 and overflow occurs
38
38
39
39
#### Dependencies
40
40
41
41
To implement this API, the device must have a hardware counter that has a count value at least 16 bits wide and can operate between 250KHz and 8MHz.
42
42
43
43
#### Implementing the microsecond ticker API
44
44
45
-
We are working on the new HAL microsecond ticker API, which will replace 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 master branch:
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:
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 `feature-hal-spec-ticker` branch. You can find the API and specification for the new microsecond ticker API in the following header file:
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:
0 commit comments