Skip to content

Commit eb26764

Browse files
author
Amanda Butler
authored
Edit PinMap addition to target.md
Edit new content about PinMap, mostly for active voice and consistent spelling.
1 parent cb67f72 commit eb26764

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/porting/target/target.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ QSPI | qspi_api.h
5858
TRNG | trng_api.h
5959
FLASH | flash_api.h
6060

61-
### Pinmap
61+
### PinMap
6262

63-
All HAL APIs which use pins have functions to get the corresponding pin maps. These functions return a `PinMap` array with each entry containing a pin name, a peripheral and a function. The end of the pin map array is indicated by the presence of a NC pin. Below is an example implementation of the function to get the serial tx pinmap:
63+
All HAL APIs that use pins have functions to get the corresponding pin maps. These functions return a `PinMap` array with each entry containing a pin name, a peripheral and a function. The presence of an NC pin indicates the end of the pin map array. Below is an example implementation of the function to get the serial transmit pin map:
6464

6565
```C NOCI
6666
const PinMap PinMap_UART_TX[] = {
@@ -76,7 +76,7 @@ const PinMap *serial_tx_pinmap()
7676
}
7777
```
7878

79-
Targets which don't make use of a pinmap, such as ones with peripherals that can be connected to any pin, must still define pinmaps as these are needed for testing. For these devices the pinmap does not need to be comprehensive. Instead it should list a representative sample of pins and peripherals so they can be tested appropriately.
79+
Targets that don't use a pinmap, such as ones with peripherals that can connect to any pin, must still define pin maps because testing requires them. For these devices, the pin map does not need to be comprehensive. Instead, it should list a representative sample of pins and peripherals, so they can be tested appropriately.
8080

8181
### Testing
8282

0 commit comments

Comments
 (0)