nuttx/boards/arm/lpc17xx_40xx/lpc4088-quickstart/include/board.h
Xiang Xiao cde88cabcc Run codespell -w with the latest dictonary again
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-02-23 22:27:46 +01:00

388 lines
14 KiB
C

/****************************************************************************
* boards/arm/lpc17xx_40xx/lpc4088-quickstart/include/board.h
* include/arch/board/board.h
*
* Copyright (C) 2013 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#ifndef __BOARDS_ARM_LPC17XX_40XX_LPC4088_QUICKSTART_INCLUDE_BOARD_H
#define __BOARDS_ARM_LPC17XX_40XX_LPC4088_QUICKSTART_INCLUDE_BOARD_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <stdbool.h>
#if defined(CONFIG_ARCH_IRQBUTTONS) && defined(CONFIG_LPC17_40_GPIOIRQ)
# include <nuttx/irq.h>
#endif
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Clocking *****************************************************************/
/* NOTE: The following definitions require lpc17_40_syscon.h.
* It is not included here because the including C file may not have that
* file in its include path.
*/
#define BOARD_XTAL_FREQUENCY (12000000) /* XTAL oscillator frequency */
#define BOARD_OSCCLK_FREQUENCY BOARD_XTAL_FREQUENCY /* Main oscillator frequency */
#define BOARD_RTCCLK_FREQUENCY (32768) /* RTC oscillator frequency */
#define BOARD_INTRCOSC_FREQUENCY (4000000) /* Internal RC oscillator frequency */
#define BOARD_WDTOSC_FREQUENCY (500000) /* WDT oscillator frequency */
/* This is the clock setup we configure for:
*
* SYSCLK = BOARD_OSCCLK_FREQUENCY = 12MHz -> Select Main oscillator for source
* PLL0CLK = (10 * SYSCLK) / 1 = 120MHz -> PLL0 multipler=10, pre-divider=1
* CCLCK = 120MHz -> CCLK divider = 1
*/
#define LPC17_40_CCLK 120000000 /* 120Mhz */
#define BOARD_PCLKDIV 2 /* Peripheral clock = LPC17_40_CCLK/2 */
#define BOARD_PCLK_FREQUENCY (LPC17_40_CCLK / BOARD_PCLKDIV)
/* Select the main oscillator as the frequency source.
* SYSCLK is then the frequency of the main oscillator.
*
* If BOARD_XTAL_FREQUENCY > 15000000, then the SCS OSCRS bit (bit 4) should
* also be set in the BOARD_SCS_VALUE.
*/
#undef CONFIG_LPC17_40_MAINOSC
#define CONFIG_LPC17_40_MAINOSC 1
#define BOARD_SCS_VALUE SYSCON_SCS_OSCEN
/* Select the main oscillator and CCLK divider.
* The output of the divider is CCLK.
* The input to the divider (PLLCLK) will be determined by the PLL output.
*/
#define BOARD_CCLKSEL_DIVIDER 1
#define BOARD_CCLKSEL_VALUE (BOARD_CCLKSEL_DIVIDER | SYSCON_CCLKSEL_CCLKSEL)
/* PLL0. PLL0 is used to generate the CPU clock (PLLCLK).
*
* Source clock: Main oscillator
* PLL0 Multiplier value (M): 10
* PLL0 Pre-divider value (P): 1
*
* PLL0CLK = (M * SYSCLK) = 120MHz
*/
#undef CONFIG_LPC17_40_PLL0
#define CONFIG_LPC17_40_PLL0 1
#define BOARD_CLKSRCSEL_VALUE SYSCON_CLKSRCSEL_MAIN
#define BOARD_PLL0CFG_MSEL 10
#define BOARD_PLL0CFG_PSEL 1
#define BOARD_PLL0CFG_VALUE \
(((BOARD_PLL0CFG_MSEL-1) << SYSCON_PLLCFG_MSEL_SHIFT) | \
((BOARD_PLL0CFG_PSEL-1) << SYSCON_PLLCFG_PSEL_SHIFT))
/* PLL1 : PLL1 is used to generate clock for the USB */
#undef CONFIG_LPC17_40_PLL1
#define BOARD_PLL1CFG_MSEL 4
#define BOARD_PLL1CFG_PSEL 2
#define BOARD_PLL1CFG_VALUE \
(((BOARD_PLL1CFG_MSEL-1) << SYSCON_PLLCFG_MSEL_SHIFT) | \
((BOARD_PLL1CFG_PSEL-1) << SYSCON_PLLCFG_PSEL_SHIFT))
#ifdef CONFIG_LPC17_40_EMC
/* EMC clock selection.
*
* The EMC clock should not be driven above 80MHz. As a result the EMC
* uses the CPU clock divided by two.
*/
# define BOARD_EMCCLKSEL_DIVIDER 2
# define BOARD_EMCCLKSEL_VALUE SYSCON_EMCCLKSEL_CCLK_DIV2
# define LPC17_40_EMCCLK (LPC17_40_CCLK / BOARD_EMCCLKSEL_DIVIDER)
#endif
#if defined(CONFIG_LPC17_40_USBHOST) || (CONFIG_LPC17_40_USBDEV)
/* USB divider. The output of the PLL is used as the USB clock
*
* USBCLK = PLL1CLK = (SYSCLK * 4) = 48MHz
*/
# define BOARD_USBCLKSEL_DIVIDER 1
# define BOARD_USBCLKSEL_VALUE (SYSCON_USBCLKSEL_USBDIV_DIV1 | \
SYSCON_USBCLKSEL_USBSEL_PLL1)
#endif
/* FLASH Configuration */
#undef CONFIG_LPC17_40_FLASH
#define CONFIG_LPC17_40_FLASH 1
/* Flash access use 6 CPU clocks - Safe for any allowed conditions */
#define BOARD_FLASHCFG_VALUE (SYSCON_FLASHCFG_TIM_5 | 0x03a)
/* Ethernet configuration */
#define ETH_MCFG_CLKSEL_DIV ETH_MCFG_CLKSEL_DIV48
/* Set EMC delay values:
*
* CMDDLY: Programmable delay value for EMC outputs in command delayed
* mode. The delay amount is roughly CMDDLY * 250 picoseconds.
* FBCLKDLY: Programmable delay value for the feedback clock that controls
* input data sampling. The delay amount is roughly (FBCLKDLY+1) * 250
* picoseconds.
* CLKOUT0DLY: Programmable delay value for the CLKOUT0 output. This would
* typically be used in clock delayed mode. The delay amount is roughly
* (CLKOUT0DLY+1) * 250 picoseconds.
* CLKOUT1DLY: Programmable delay value for the CLKOUT1 output. This would
* typically be used in clock delayed mode. The delay amount is roughly
* (CLKOUT1DLY+1) * 250 picoseconds.
*
* Optimal for NOR: {1,1,1,1}
* Needed for NAND and SDRAM: {17,1,2,1}
*/
#ifdef CONFIG_LPC17_40_EMC
#if defined(CONFIG_LPC17_40_EXTNAND) || defined(CONFIG_LPC17_40_EXTDRAM)
# define BOARD_CMDDLY 17
# define BOARD_FBCLKDLY 17
# define BOARD_CLKOUT0DLY 1
# define BOARD_CLKOUT1DLY 1
#else
# define BOARD_CMDDLY 1
# define BOARD_FBCLKDLY 1
# define BOARD_CLKOUT0DLY 1
# define BOARD_CLKOUT1DLY 1
#endif
#endif
/* LED definitions **********************************************************/
/* If CONFIG_ARCH_LEDS is not defined, then the user can control
* the LEDs in any way.
* The following definitions are used to access individual LEDs.
*
* LED1 : Connected to P1[18]
* LED2 : Connected to P0[13]
* LED3 : Connected to P1[13]
* LED4 : Connected to P2[19]
*
* These LEDs are connected to ground so a high output value will illuminate
* them.
*/
/* LED index values for use with board_userled() */
#define BOARD_LED1 0
#define BOARD_LED2 1
#define BOARD_LED3 2
#define BOARD_LED4 3
#define BOARD_NLEDS 4
/* LED bits for use with board_userled_all() */
#define BOARD_LED1_BIT (1 << BOARD_LED1)
#define BOARD_LED2_BIT (1 << BOARD_LED2)
#define BOARD_LED3_BIT (1 << BOARD_LED3)
#define BOARD_LED4_BIT (1 << BOARD_LED4)
/* If CONFIG_ARCH_LEDs is defined, then NuttX will control the four LEDs
* on the LPC4088 QuickStart board.
* The following definitions describe how NuttX controls the LEDs:
*/
/* LED1 LED2 LED3 LED4 */
#define LED_STARTED 0 /* OFF OFF OFF OFF */
#define LED_HEAPALLOCATE 1 /* ON OFF OFF OFF */
#define LED_IRQSENABLED 2 /* OFF ON OFF OFF */
#define LED_STACKCREATED 3 /* ON ON OFF OFF */
#define LED_INIRQ 4 /* LED3 glows, on while in interrupt */
#define LED_SIGNAL 4 /* LED3 glows, on while in signal handler */
#define LED_ASSERTION 4 /* LED3 glows, on while in assertion */
#define LED_PANIC 4 /* LED3 Flashes at 2Hz */
#define LED_IDLE 5 /* LED4 glows: ON while active
* OFF while sleeping
*/
/* Button definitions *******************************************************/
/* The LPC4088 QuickStart supports a single button.
* It must be pulled up by the MCU.
* When closed, the pin will be pulled to ground.
* So the button will read "1" when open and "0" when closed.
* The button is capable of generating an interrupt.
*
* USER1 -- Connected to P2[10]
*
* For the interrupting buttons, interrupts are generated on both edges
* (press and release).
*/
#define BOARD_BUTTON_USER1 0
#define NUM_BUTTONS 1
#define BOARD_BUTTON_USER1_BIT (1 << BOARD_BUTTON_USER1)
/* Alternate pin selections *************************************************/
/* UART0:
*
* TX --- Connected to P0[2]
* RX --- Connected to P0[3]
*/
#define GPIO_UART0_TXD GPIO_UART0_TXD_2
#define GPIO_UART0_RXD GPIO_UART0_RXD_2
/* UART1:
*
* RTS --- Connected to P0[22]
* RI --- Connected to P0[21]
* DSR --- Connected to P0[19]
* DCD --- Connected to P0[18]
* CTS --- Connected to P0[17]
* DTR --- Connected to P0[20]
* TXD --- Connected to P0[15]
* RXD --- Connected to P0[16]
*/
#define GPIO_UART1_RTS GPIO_UART1_RTS_2
#define GPIO_UART1_RI GPIO_UART1_RI_1
#define GPIO_UART1_DSR GPIO_UART1_DSR_1
#define GPIO_UART1_DCD GPIO_UART1_DCD_1
#define GPIO_UART1_CTS GPIO_UART1_CTS_1
#define GPIO_UART1_DTR GPIO_UART1_DTR_1
#define GPIO_UART1_TXD GPIO_UART1_TXD_1
#define GPIO_UART1_RXD GPIO_UART1_RXD_1
/* Ethernet:
* MDC --- Connected to P1[16]
* MDIO --- Connected to P1[17]
*/
#define GPIO_ENET_MDC GPIO_ENET_MDC_1
#define GPIO_ENET_MDIO GPIO_ENET_MDIO_1
/* External LCD is currently untested.
* These pins will probably need to be updated before using the LCD.
*/
#if 0
/* LCD R:
*
* VD0 --- Connected to P0[4]
* VD1 --- Connected to P0[5]
* VD2 --- Connected to P4[28]
* VD3 --- Connected to P4[29]
* VD4 --- Connected to P2[6]
* VD5 --- Connected to P2[7]
* VD6 --- Connected to P2[8]
* VD7 --- Connected to P2[9]
*/
#define GPIO_LCD_VD0 GPIO_LCD_VD0_1
#define GPIO_LCD_VD1 GPIO_LCD_VD1_1
#define GPIO_LCD_VD2 GPIO_LCD_VD2_2
#define GPIO_LCD_VD3 GPIO_LCD_VD3_3
#define GPIO_LCD_VD4 GPIO_LCD_VD4_1
#define GPIO_LCD_VD5 GPIO_LCD_VD5_1
#define GPIO_LCD_VD6 GPIO_LCD_VD6_2
#define GPIO_LCD_VD7 GPIO_LCD_VD7_2
/* LCD G:
*
* VD8 --- Connected to P0[6]
* VD9 --- Connected to P0[7]
* VD10 --- Connected to P1[20]
* VD11 --- Connected to P1[21]
* VD12 --- Connected to P1[22]
* VD13 --- Connected to P1[23]
* VD14 --- Connected to P1[24]
* VD15 --- Connected to P1[25]
*/
#define GPIO_LCD_VD8 GPIO_LCD_VD8_1
#define GPIO_LCD_VD9 GPIO_LCD_VD9_1
#define GPIO_LCD_VD10 GPIO_LCD_VD10_1
#define GPIO_LCD_VD11 GPIO_LCD_VD11_1
#define GPIO_LCD_VD12 GPIO_LCD_VD12_1
#define GPIO_LCD_VD13 GPIO_LCD_VD13_1
#define GPIO_LCD_VD14 GPIO_LCD_VD14_1
#define GPIO_LCD_VD15 GPIO_LCD_VD15_1
/* LCD B:
*
* VD16 --- Connected to P0[8]
* VD17 --- Connected to P0[9]
* VD18 --- Connected to P2[12]
* VD19 --- Connected to P2[13]
* VD20 --- Connected to P1[26]
* VD21 --- Connected to P1[27]
* VD22 --- Connected to P1[28]
* VD23 --- Connected to P1[29]
*
* DCLK --- Connected to P2[2]
* LP --- Connected to P2[5]
* FP --- Connected to P2[3]
* ENAB_M --- Connected to P2[4]
* PWR --- Connected to P2[0]
*/
/* XPT2046 Touchscreen:
*
* -------------- -------------------- ------------ -------------------------
* XTPT2046 Module Module
* Signal Connector Connector
* -------------- -------------------- ------------ -------------------------
* Pin 11 PENIRQ\ PENIRQ (pulled high) PORT3 Pin 1 P2.15 PENIRQ
* Pin 12 DOUT MISO PORT3 Pin 4 P1.18 MISO1 (Also USB HOST UP LED)
* Pin 13 BUSY BUSY (pulled high) PORT3 Pin 9 P2.14 BUSY
* Pin 14 DIN MOSI PORT3 Pin 3 P0.13 MOSI1 (Also USB Device up LED and SD CD pin)
* Pin 15 CS\ SSEL (pulled high) PORT3 Pin 6 P1.8 GPIO (Also RMII_CRS_DV)
* Pin 16 DCLK SCK PORT3 Pin 5 P1.19 SCK1
* -------------- -------------------- ------------ -------------------------
*/
#define GPIO_SSP1_MISO GPIO_SSP1_MISO_3
#define GPIO_SSP1_MOSI GPIO_SSP1_MOSI_2
#define GPIO_SSP1_SCK GPIO_SSP1_SCK_2
#endif
#endif /* __BOARDS_ARM_LPC17XX_40XX_LPC4088_QUICKSTART_INCLUDE_BOARD_H */