Skip to content

Commit b24ec25

Browse files
author
Donatien Garnier
authored
Merge pull request #1447 from ARMmbed/std-pin-names
Std pin names
2 parents d590b2a + 605a6b8 commit b24ec25

File tree

4 files changed

+8
-12
lines changed

4 files changed

+8
-12
lines changed

docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@
266266
]
267267
},
268268
{
269-
"title": "Standard Pin Names Developer Guide",
269+
"title": "Standard Pin Names",
270270
"sources": [{
271271
"path": "docs/porting/standard_pin_names/pin_names_dev_guide.md"
272272
},

docs/porting/standard_pin_names/pin_names_dev_guide.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
1-
## Introduction
2-
3-
### Overview and assumptions
1+
## Standard Pin Names
42

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

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

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

11-
## Standard Pin Names
12-
139
### LEDs
1410

1511
Available onboard LEDs are defined as `LEDx` e.g. `LED1`, `LED2`, ...

docs/porting/standard_pin_names/pin_names_dev_guide_arduino.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Arduino Uno
1+
## Arduino Uno Pin Names
22

33
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.
44

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

6363
**PWM/Timer pins**
6464

65-
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.
65+
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.

docs/porting/standard_pin_names/pin_names_porting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Standard Pin Names Porting Guide
1+
# Standard Pin Names
22

3-
This guide aims to help vendors to comply with the new pin naming guidelines.
3+
This porting guide aims to help vendors to comply with the new pin naming guidelines.
44

55
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.
66

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

0 commit comments

Comments
 (0)