[riot-notifications] [RIOT-OS/RIOT] boards/doc: Add a guide to find physical board pins (#11793)

Sebastian Meiling notifications at github.com
Mon Jul 8 22:28:34 CEST 2019


smlng requested changes on this pull request.

some final remarks and suggestions.

> @@ -15,4 +15,56 @@
  * configuration of a controller and some external devices such as sensors or
  * radios. All aspects concerning configuration of GPIO pins, MCU clock and
  * device drivers should go into this module.
+ *
+
+Guide to board pinouts {#pinout_guide}
+=====================================
+
+The following are the steps to take to locate specific pinouts on boards.
+This is useful when connecting external hardware to RIOT supported boards.
+
+1. Check the board documentation to see if the pinout is available
+2. If the pinout is not available or up to date check the following:
+    - `boards/<BOARD>/include/periph_conf.h` for board specific
+peripherals such as uart  or spi pins

I'm always unsure: capitalise abbreviations? i.e. UART and SPI?

Also there are 2 spaces after uart, one should be enough

> @@ -15,4 +15,56 @@
  * configuration of a controller and some external devices such as sensors or
  * radios. All aspects concerning configuration of GPIO pins, MCU clock and
  * device drivers should go into this module.
+ *
+
+Guide to board pinouts {#pinout_guide}
+=====================================
+
+The following are the steps to take to locate specific pinouts on boards.
+This is useful when connecting external hardware to RIOT supported boards.
+
+1. Check the board documentation to see if the pinout is available

where to find that (as a newbie)? I.e. add a link to http://doc.riot-os.org/group__boards.html

> +2. If the pinout is not available or up to date check the following:
+    - `boards/<BOARD>/include/periph_conf.h` for board specific
+peripherals such as uart  or spi pins
+    - `boards/<BOARD>/include/board.h` for GPIO specific pins such
+as `LED0` or `BTN0`
+    - `boards/common/<COMMON_BOARD_OR_CPU>/include/periph_conf_common.h`
+for shared pins that are the same for many different boards (board_common.h
+or others will be available too)
+    - `boards/common/<COMMON_BOARD_OR_CPU>/include/<PERIPH_DECLARATION>`
+also may contain specific periphirals such as
+`PERIPH_DECLARATION = cfg_i2c1_pb8_pb9.h` which indicates i2c pins are on
+pb8 and pb9
+3. Once the needed pins are determined with either a port where
+`PORTA = PORT_A = PA = 0` or `PORTB = PORT_B = PB = 1` and pin
+number, such as `PA, 1`, correlate that to the board (the board
+may either have the designators or search online to find which gpio

/gpio/GPIO/ ?

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/11793#pullrequestreview-259136973
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190708/da60e9e0/attachment-0001.html>


More information about the notifications mailing list