Update more comments and README.txt files to reflect new organization of the boards/ sub-directory.

This commit is contained in:
Gregory Nutt 2019-08-08 09:16:30 -06:00
parent 66565a69a7
commit 2730714774
5 changed files with 62 additions and 63 deletions

View File

@ -50,6 +50,6 @@ config ARCH_HAVEHEAD
default n default n
---help--- ---help---
Use a board-specific version of the "head" file in the Use a board-specific version of the "head" file in the
boards/<board-name>/src directory boards/z80/z80/<board-name>/src directory
endif endif

View File

@ -103,7 +103,7 @@ Re-usable LCD drivers reside in the drivers/lcd directory:
ssd12989.c. Generic LCD driver for LCDs based on the Solomon Systech ssd12989.c. Generic LCD driver for LCDs based on the Solomon Systech
SSD1289 LCD controller. Think of this as a template for an LCD driver SSD1289 LCD controller. Think of this as a template for an LCD driver
that you will probably have to customize for any particular LCD that you will probably have to customize for any particular LCD
hardware. (see also boards/hymini-stm32v/src/ssd1289.c below). hardware. (see also boards/arm/stm32/hymini-stm32v/src/ssd1289.c below).
st7567.c. LCD Display Module, ST7567, Univision Technology Inc. Used st7567.c. LCD Display Module, ST7567, Univision Technology Inc. Used
with the LPCXpresso and Embedded Artists base board. with the LPCXpresso and Embedded Artists base board.
@ -122,28 +122,28 @@ Re-usable LCD drivers reside in the drivers/lcd directory:
older versions of the TI/Luminary LM3S8962 Evaluation Kit. Example older versions of the TI/Luminary LM3S8962 Evaluation Kit. Example
usage usage
boards/lm3s6965-ek/src boards/arm/tiva/lm3s6965-ek/src
boards/lm3s8962-ek/src boards/arm/tiva/lm3s8962-ek/src
ug-2864ambag01.c. OLED Display Module, UUG-2864AMBAG01, Univision ug-2864ambag01.c. OLED Display Module, UUG-2864AMBAG01, Univision
Technology Inc. Based on the SH1101A controller. Example usage: Technology Inc. Based on the SH1101A controller. Example usage:
boards/stm32f4discovery boards/arm/stm32/stm32f4discovery
boards/zp214xp boards/arm/lpc214x/zp214xpa
ug-9664hswag01.c. OLED Display Module, UG-9664HSWAG01, Univision ug-9664hswag01.c. OLED Display Module, UG-9664HSWAG01, Univision
Technology Inc. Based on the SSD1305 controller. Used with the Technology Inc. Based on the SSD1305 controller. Used with the
LPC Xpresso and Embedded Artists base board. Example usage: LPC Xpresso and Embedded Artists base board. Example usage:
boards/lpcxpresso-lpc1768 boards/arm/lpc71xx_40xx/lpcxpresso-lpc1768
ssd1306.c. OLED Display Modules based on the SSD1306 controllers. ssd1306.c. OLED Display Modules based on the SSD1306 controllers.
This includes the UG-2864HSWEG01 and UG2832HSWEG04, Both from Univision This includes the UG-2864HSWEG01 and UG2832HSWEG04, Both from Univision
Technology Inc. The latter is used with the OLED1 module that comes Technology Inc. The latter is used with the OLED1 module that comes
with the Atmel SAM4l Xplained Pro board. Example usage: with the Atmel SAM4l Xplained Pro board. Example usage:
boards/stm32f4discovery boards/arm/stm32/stm32f4discovery
boards/sam4l-xplained boards/arm/sam34/sam4l-xplained
Segment LCDS (SLCDs): Segment LCDS (SLCDs):
--------------------- ---------------------
@ -153,102 +153,101 @@ Re-usable LCD drivers reside in the drivers/lcd directory:
Examples: boards/ Examples: boards/
================== ==================
There are additional LCD drivers in the boards/<board>/src directory There are additional LCD drivers in the boards/<arch>/<chip>/<board>/src
that support additional LCDs. LCD drivers in the configuration directory directory that support additional LCDs. LCD drivers in the configuration
if they support some differ LCD interface (such as a parallel interface) directory if they support some differ LCD interface (such as a parallel
that makes then less re-usable: interface) that makes then less re-usable:
SSD1289 Drivers: SSD1289 Drivers:
boards/hymini-stm32v/src/ssd1289.c. See also drivers/lcd/ssd1298.c boards/arm/stm32/hymini-stm32v/src/ssd1289.c. See also
above. drivers/lcd/ssd1298.c above.
boards/stm32f4discovery/src/stm32_ssd1289.c. This examples is the boards/arm/stm32/stm32f4discovery/src/stm32_ssd1289.c. This examples
bottom half for the SSD1289 driver at drivers/lcd/ssd1289.c is the bottom half for the SSD1289 driver at drivers/lcd/ssd1289.c
boards/hymini-stm32v/src/ssd1289.c. See also drivers/lcd/ssd1298.c boards/arm/stm32/hymini-stm32v/src/ssd1289.c. See also
above. drivers/lcd/ssd1298.c above.
boards/shenzhou/src/stm32_ssd1289.c boards/arm/stm32/shenzhou/src/stm32_ssd1289.c
kwikstik-k40: kwikstik-k40:
boards/kwikstik-k40/src/k40_lcd.c. Don't waste your time. This is boards/arm/kinetis/kwikstik-k40/src/k40_lcd.c. Don't waste your time.
just a stub. This is just a stub.
HX8346: HX8346:
boards/sam3u-ek/src/sam_lcd.c. The SAM3U-EK development board features boards/arm/sam34/sam3u-ek/src/sam_lcd.c. The SAM3U-EK development board
a TFT/Transmissive color LCD module with touch-screen, FTM280C12D, features a TFT/Transmissive color LCD module with touch-screen,
with integrated driver IC HX8346. FTM280C12D, with integrated driver IC HX8346.
HX8347: HX8347:
boards/pic32mx7mmb/src/pic32_mio283qt2.c. This driver is for the MI0283QT-2 boards/mips/pic32mx/pic32mx7mmb/src/pic32_mio283qt2.c. This driver is
LCD from Multi-Inno Technology Co., Ltd. This LCD is based on the Himax for the MI0283QT-2 LCD from Multi-Inno Technology Co., Ltd. This LCD
HX8347-D LCD controller. is based on the Himax HX8347-D LCD controller.
ILI93xx and Similar: ILI93xx and Similar:
boards/stm3210e-eval/src/stm32_lcd.c. This driver supports the following boards/arm/stm32/stm3210e-eval/src/stm32_lcd.c. This driver supports the
LCDs: following LCDs:
1. Ampire AM-240320LTNQW00H 1. Ampire AM-240320LTNQW00H
2. Orise Tech SPFD5408B 2. Orise Tech SPFD5408B
3. RenesasSP R61580 3. RenesasSP R61580
boards/stm3220g-eval/src/stm32_lcd.c and boards/stm3240g-eval/src/smt32_lcd.c. boards/arm/stm32/stm3220g-eval/src/stm32_lcd.c and
boards/stm3240g-eval/src/smt32_lcd.c.
AM-240320L8TNQW00H (LCD_ILI9320 or LCD_ILI9321) and AM-240320L8TNQW00H (LCD_ILI9320 or LCD_ILI9321) and
AM-240320D5TOQW01H (LCD_ILI9325) AM-240320D5TOQW01H (LCD_ILI9325)
boards/shenzhou/src/stm32_ili93xx.c. Another ILI93xx driver. boards/arm/stm32/shenzhou/src/stm32_ili93xx.c. Another ILI93xx driver.
config/sam4e-ek/src/sam_ili9325.c. ILI9325 driver config/arm/sam34/sam4e-ek/src/sam_ili9325.c. ILI9325 driver
config/sam4e-ek/src/sam_ili9341.c. ILI9341 driver config/arm/sam34/sam4e-ek/src/sam_ili9341.c. ILI9341 driver
ILI9488 ILI9488
boards/samv71-xult/src/sam_ili9488.c boards/arm/samv7/samv71-xult/src/sam_ili9488.c
include/nuttx/lcd/ili9488.h include/nuttx/lcd/ili9488.h
R61505U R61505U
boards/hymini-stm32v/src/stm32_r61505u.c boards/arm/stm32/hymini-stm32v/src/stm32_r61505u.c
Sharp Memory LCD: Sharp Memory LCD:
boards/maple/src/stm32_lcd.c boards/arm/stm32/maple/src/stm32_lcd.c
OLEDs: OLEDs:
boards/stm32f4discovery/src/stm32_ug2864ambag01.c boards/arm/stm32/stm32f4discovery/src/stm32_ug2864ambag01.c
boards/stm32f4discovery/src/stm32_ug2864hsweg01.c boards/arm/stm32/stm32f4discovery/src/stm32_ug2864hsweg01.c
boards/sam4l-xplained/src/sa,_ug2832hsweg04.c boards/arm/sam34/sam4l-xplained/src/sa,_ug2832hsweg04.c
boards/zp214xpa/src/lpc2148_ug2864ambag01.c boards/arm/lpc214x/zp214xpa/src/lpc2148_ug2864ambag01.c
LCD controllers built-into the MCU: LCD controllers built-into the MCU:
arch/arm/src/lpc17xx_40xx/lpc17_40_lcd.c and boards/open1788/src/lpc17_40_lcd.c. arch/arm/src/lpc17xx_40xx/lpc17_40_lcd.c and
boards/arm/lpc17xx_40xx/open1788/src/lpc17_40_lcd.c.
RGB LCD display panel. RGB LCD display panel.
boards/stm32ldiscovery/src/stm32_lcd.c. 1x6 segment LCD with bars boards/arm/stm32/stm32ldiscovery/src/stm32_lcd.c. 1x6 segment LCD with
using the segment LCD controller built-into the STM32L15X. bars using the segment LCD controller built-into the STM32L15X.
Alphnumeric/segment LCD Displays: Alphnumeric/segment LCD Displays:
boards/skp16c26/src/m16c_lcd.c. Untested alphanumeric LCD driver. boards/renesas/m32262f8/skp16c26/src/m16c_lcd.c. Untested alphanumeric
boards/pcblogic-pic32mx/src/pic32mx_lcd1602.c. LCD1602 is based on the LCD driver.
Hitachi HD44780U LCD controller. This version of the driver boards/mips/pic32mx/sure-pic32mx/src/pic32_lcd1602.c. An LCD1602 segment
uses the PIC32MX PMP interface to control the LCD. As of this
writing, has *NOT* been verified (mostly because I get bewildered
by all of the jumper wires). See include/nuttx/lcd/hd4478ou.h
for more information about LCD1602.
boards/sure-pic32mx/src/pic32_lcd1602.c. Another LCD1602 segment
LCD. This is a bit-bang version of the driver and appears to LCD. This is a bit-bang version of the driver and appears to
be fully functional. This version of the LCD1602 driver has be fully functional. This version of the LCD1602 driver has
been verified and is working fine. been verified and is working fine.
boards/stm32ldiscovery/src/stm32_lcd.c. 1x6 segment LCD with bars boards/arm/stm32/stm32ldiscovery/src/stm32_lcd.c. 1x6 segment LCD with
using the segment LCD controller built-into the STM32L15X. bars using the segment LCD controller built-into the STM32L15X.
TFT Panel Drivers: TFT Panel Drivers:
boards/open1788/src/lpc17_40_lcd.c and arch/arm/src/lpc17xx_40xx/lpc17_40_lcd.c boards/arm/lpc17xx_40xx/open1788/src/lpc17_40_lcd.c and
boards/sama5d3x-ek/src and boards/sama5d4-ek/src: Use arch/arm/src/lpc17xx_40xx/lpc17_40_lcd.c
boards/arm/sama5/sama5d3x-ek/src and boards/arm/sama5/sama5d4-ek/src:
Use
arch/arm/src/sama5/sam_lcd.c arch/arm/src/sama5/sam_lcd.c
graphics/ graphics/

View File

@ -314,13 +314,13 @@ include/arch: .config
@echo "LN: include/arch to $(ARCH_DIR)/include" @echo "LN: include/arch to $(ARCH_DIR)/include"
$(Q) $(DIRLINK) $(TOPDIR)/$(ARCH_DIR)/include include/arch $(Q) $(DIRLINK) $(TOPDIR)/$(ARCH_DIR)/include include/arch
# Link the boards/<board-name>/include directory to include/arch/board # Link the boards/<arch>/<chip><board>/include directory to include/arch/board
include/arch/board: include/arch include/arch/board: include/arch
@echo "LN: include/arch/board to $(BOARD_DIR)/include" @echo "LN: include/arch/board to $(BOARD_DIR)/include"
$(Q) $(DIRLINK) $(BOARD_DIR)/include include/arch/board $(Q) $(DIRLINK) $(BOARD_DIR)/include include/arch/board
# Link the boards/<board-name>/src dir to arch/<arch-name>/src/board # Link the boards/<arch>/<chip><board>/src dir to arch/<arch-name>/src/board
$(ARCH_SRC)/board: .config $(ARCH_SRC)/board: .config
@echo "LN: $(ARCH_SRC)/board to $(BOARD_DIR)/src" @echo "LN: $(ARCH_SRC)/board to $(BOARD_DIR)/src"

View File

@ -316,7 +316,7 @@ else
$(Q) echo FAKELNK > include\arch\.fakelnk $(Q) echo FAKELNK > include\arch\.fakelnk
endif endif
# Link the boards\<board-name>\include directory to include\arch\board # Link the boards\<arch>\<chip><board>\include directory to include\arch\board
include\arch\board: include\arch include\arch\board: include\arch
@echo LN: include\arch\board to $(BOARD_DIR)\include @echo LN: include\arch\board to $(BOARD_DIR)\include
@ -327,7 +327,7 @@ else
$(Q) echo FAKELNK > include\arch\board\.fakelnk $(Q) echo FAKELNK > include\arch\board\.fakelnk
endif endif
# Link the boards\<board-name>\src dir to arch\<arch-name>\src\board # Link the boards\<arch>\<chip><board>\src dir to arch\<arch-name>\src\board
$(ARCH_SRC)\board: .config $(ARCH_SRC)\board: .config
@echo LN: $(ARCH_SRC)\board to $(BOARD_DIR)\src @echo LN: $(ARCH_SRC)\board to $(BOARD_DIR)\src

View File

@ -556,11 +556,11 @@ ide_exporter.py
cd nuttx cd nuttx
make V=1 |& tee build_log make V=1 |& tee build_log
./tools/ide_exporter.py makelog_f2nsh_c iar ./boards/<board>/ide/template/iar -o ./boards/<board>/ide/nsh/iar ./tools/ide_exporter.py makelog_f2nsh_c iar ./boards/<arch>/<chip>/<board>/ide/template/iar -o ./boards/<arch>/<chip>/<board>/ide/nsh/iar
or or
./tools/ide_exporter.py makelog_f2nsh_c uvision_gcc ./boards/<board>/ide/template/uvision_gcc/ -o ./boards/<board>/ide/nsh/uvision ./tools/ide_exporter.py makelog_f2nsh_c uvision_gcc ./boards/<arch>/<chip>/<board>/ide/template/uvision_gcc/ -o ./boards/<arch>/<chip>/<board>/ide/nsh/uvision
3) Limitations: 3) Limitations:
- IAR supports C only. Iar C++ does not compatible with g++ so disable - IAR supports C only. Iar C++ does not compatible with g++ so disable
@ -807,7 +807,7 @@ refresh.sh
<board> <board>
The board directory under nuttx/boards The board directory under nuttx/boards
<config> <config>
The board configuration directory under nuttx/boards/<board> The board configuration directory under nuttx/boards/<arch>/<chip>/<board>
The steps to refresh the file taken by refresh.sh are: The steps to refresh the file taken by refresh.sh are: