Skip to content

Add pinmap docs to target porting summary page #930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 13, 2019
Merged

Add pinmap docs to target porting summary page #930

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb67f72
Add pinmap docs to target porting summary page
c1728p9 Jan 23, 2019
eb26764
Edit PinMap addition to target.md
Feb 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/porting/target/target.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,30 @@ PWMOUT | pwmout_api.h
RTC | rtc_api.h
SLEEP | sleep_api.h
SPI SPISLAVE | spi_api.h
QSPI | qspi_api.h
TRNG | trng_api.h
FLASH | flash_api.h

### PinMap

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:

```C NOCI
const PinMap PinMap_UART_TX[] = {
{P0_19, UART_0, 1},
{P1_13, UART_0, 3},
{P1_27, UART_0, 2},
{ NC , NC , 0}
};

const PinMap *serial_tx_pinmap()
{
return PinMap_UART_TX;
}
```

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.

### Testing

The Mbed OS HAL provides a set of conformance tests for the Mbed OS HAL APIs. You can use these tests to validate the correctness of your implementation. To run the all of the Mbed OS HAL API tests, use the following command:
Expand Down