Skip to content

Commit adab5a4

Browse files
author
Amanda Butler
authored
Complete initial copy edit of itm.md
Copy edit file for active voice, American English and precise language.
1 parent c78bcd7 commit adab5a4

File tree

1 file changed

+10
-10
lines changed
  • docs/reference/contributing/target

1 file changed

+10
-10
lines changed
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
### Instrumented Trace Macrocell
22

3-
For targets with Arm CoreSight (e.g. Cortex-M3 and Cortex-M4) the Instrumented Trace Macrocell provides a lightweight, non-intrusive way for collecting debug trace output.
3+
For targets with Arm CoreSight (for example, Cortex-M3 and Cortex-M4), the Instrumented Trace Macrocell provides a lightweight, nonintrusive way to collect debug trace output.
44

55
#### Assumptions
66

7-
* The target supports Arm CoreSight.
8-
* The target has SWO connected either to a compatible interface chip or exposed as a debug pin.
7+
- The target supports Arm CoreSight.
8+
- The target has SWO connected either to a compatible interface chip or exposed as a debug pin.
99

1010
##### Defined behavior
1111

12-
* Targets must implement the function `void itm_init(void)` and add `ITM` to the `device_has` section in `target.json`.
13-
* When `void itm_init(void)` is called, the debug clock for the ITM must be initialized and the SWO pin configured for debug output.
14-
* `void itm_init(void)` should only have to modify the clock pre-scaler in the generic register `TPI->ACPR`. The generic ITM registers will be initialized by the helper function `mbed_itm_init`.
15-
* `void itm_init(void)` will only be called once during startup and doesn't have to be protected for multiple calls.
12+
- Targets must implement the function `void itm_init(void)` and add `ITM` to the `device_has` section in `target.json`.
13+
- When `void itm_init(void)` is called, the debug clock for the ITM must be initialized and the SWO pin configured for debug output.
14+
- `void itm_init(void)` only has to modify the clock prescaler in the generic register `TPI->ACPR`. The helper function `mbed_itm_init` initializes the generic ITM registers.
15+
- `void itm_init(void)` is only called once during startup and doesn't have to be protected for multiple calls.
1616

1717
##### Undefined behavior
1818

19-
* The debug clock frequency is left undefined since the most optimal frequency will vary from target to target. It is up to each target's owner to pick a frequency that (a) doesn't interfere with normal operation and (b) is supported by the owner's preferred debug monitor.
19+
- The debug clock frequency is left undefined because the most optimal frequency varies from target to target. It is up to each target's owner to choose a frequency that doesn't interfere with normal operation and that the owner's preferred debug monitor supports.
2020

2121
#### Testing
2222

23-
The `SerialWireOutput` class can be used for sending `stdout` to the SWO stimulus port on the ITM by including this override function:
23+
You can use the `SerialWireOutput` to send `stdout` to the SWO stimulus port on the ITM by including this override function:
2424

2525
```
2626
#include "SerialWireOutput.h"
@@ -31,4 +31,4 @@ FileHandle* mbed::mbed_override_console(int fd) {
3131
}
3232
```
3333

34-
The function can be placed in any C++ compilation unit, including `main.cpp`.
34+
You can place the function in any C++ compilation unit, including `main.cpp`.

0 commit comments

Comments
 (0)