Skip to content

Commit 6124847

Browse files
Marcelo Salazargpsimenos
authored andcommitted
Clarify impact on changes
1 parent 2ca4f81 commit 6124847

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/design-documents/hal/0004-pin-names-general-guidelines.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ Only add LEDs that are available on the board. This is an example on how to defi
5050
.
5151
#define LEDN = Px_xx // LEDN
5252

53+
Note this document is proposing changing LEDs from `enums` to `define`, which causes a minor change in the compile preprocessor. From application point of view, there are no implications.
54+
5355
**Using LEDs at application**
5456

5557
The detection of available LEDs at application level can be done as follow:
@@ -87,6 +89,8 @@ Only add buttons that are available on the board. This is an example on how to d
8789
.
8890
#define BUTTONN = Px_xx // BUTTONN
8991

92+
Note this document is proposing changing buttons from `enums` to `define`, which causes a minor change in the compile preprocessor. From application point of view, there are no implications.
93+
9094
**Using Buttons at application**
9195

9296
The detection of available buttons at application level can be done as follow:
@@ -116,9 +120,15 @@ The UART pins must be defined to be able to run automated tests using Greentea,
116120

117121
This is an example on how to define UART names in PinNames.h:
118122

123+
typedef enum {
124+
...
119125
// Px_xx relates to the processor pin connected to the UART
120126
USBTX = Px_xx,
121127
USBRX = Px_xx,
128+
...
129+
} PinName;
130+
131+
Note this document is proposing unifying the pin names used for UART communication between the MCU and the host PC.
122132

123133
Note Mbed OS expects to use these names internally (a fix might be needed during the implementation), for example:
124134

183 Bytes
Loading

0 commit comments

Comments
 (0)