Skip to content

Std pin names #1447

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 4 commits into from
Apr 23, 2021
Merged

Std pin names #1447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
17da6a9
Rename docs for std pin names
Apr 20, 2021
424fe80
Update title of std pin names porting guide
Apr 20, 2021
e7ad4c8
Update title of std pin name dev guide
Apr 20, 2021
605a6b8
Update title of Arduino Uno pin names dev guide
Apr 20, 2021
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@
]
},
{
"title": "Standard Pin Names Developer Guide",
"title": "Standard Pin Names",
"sources": [{
"path": "docs/porting/standard_pin_names/pin_names_dev_guide.md"
},
Expand Down
8 changes: 2 additions & 6 deletions docs/porting/standard_pin_names/pin_names_dev_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
## Introduction

### Overview and assumptions
## Standard Pin Names

Platform code should be portable across different Mbed supported boards with the same hardware capabilities or interfaces.
In general, platform code should be portable across different Mbed supported boards with the same hardware capabilities or interfaces.

This document provides general developer guidelines on pin names that apply to all boards but it's not specific to any type of connector.

**_NOTE:_** there might be separate documents for pin names that apply to specific connectors.

## Standard Pin Names

### LEDs

Available onboard LEDs are defined as `LEDx` e.g. `LED1`, `LED2`, ...
Expand Down
4 changes: 2 additions & 2 deletions docs/porting/standard_pin_names/pin_names_dev_guide_arduino.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Arduino Uno
## Arduino Uno Pin Names

The Arduino Uno connector is a standardised connector in Mbed, which has a set amount of exposed functionality. To achieve meaningful portability of application code across various Mbed boards that are Arduino Uno compliant, the pin names used for the connector pins are common across these boards.

Expand Down Expand Up @@ -62,4 +62,4 @@ For more details about UART, please check the Mbed API.

**PWM/Timer pins**

In the Arduino Uno standard, there are only 6 PWM and timers available on pins ARDUINO_UNO_D3, ARDUINO_UNO_D5, ARDUINO_UNO_D6, ARDUINO_UNO_D9, ARDUINO_UNO_D10 and ARDUINO_UNO_D11. However, Mbed boards may support the usage of PWM and timers functions on other pins as well.
In the Arduino Uno standard, there are only 6 PWM and timers available on pins ARDUINO_UNO_D3, ARDUINO_UNO_D5, ARDUINO_UNO_D6, ARDUINO_UNO_D9, ARDUINO_UNO_D10 and ARDUINO_UNO_D11. However, Mbed boards may support the usage of PWM and timers functions on other pins as well.
6 changes: 3 additions & 3 deletions docs/porting/standard_pin_names/pin_names_porting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Standard Pin Names Porting Guide
# Standard Pin Names

This guide aims to help vendors to comply with the new pin naming guidelines.
This porting guide aims to help vendors to comply with the new pin naming guidelines.

There is a set of generic guidelines that apply to all boards, and further sets of guidelines that additionally apply to boards that have certain compatible connectors.

Expand Down Expand Up @@ -340,4 +340,4 @@ mbedgt: test case report:
| DISCO_L475VG_IOT01A-GCC_ARM | DISCO_L475VG_IOT01A | hal-tests-tests-pin_names-arduino_uno | UART | 1 | 0 | OK | 0.07 |
mbedgt: test case results: 37 OK
mbedgt: completed in 34.33 sec
```
```