1 /*
2  * Copyright 2018-2019 NXP
3  * All rights reserved.
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  */
7 
8 #ifndef _BOARD_H_
9 #define _BOARD_H_
10 
11 #include "clock_config.h"
12 #include "fsl_common.h"
13 #include "fsl_gpio.h"
14 
15 /*******************************************************************************
16  * Definitions
17  ******************************************************************************/
18 /*! @brief The board name */
19 #define BOARD_NAME "MIMXRT1020-EVK"
20 
21 /* The UART to use for debug messages. */
22 #define BOARD_DEBUG_UART_TYPE     kSerialPort_Uart
23 #define BOARD_DEBUG_UART_BASEADDR (uint32_t) LPUART1
24 #define BOARD_DEBUG_UART_INSTANCE 1U
25 
26 #define BOARD_DEBUG_UART_CLK_FREQ BOARD_DebugConsoleSrcFreq()
27 
28 #define BOARD_UART_IRQ         LPUART1_IRQn
29 #define BOARD_UART_IRQ_HANDLER LPUART1_IRQHandler
30 
31 #ifndef BOARD_DEBUG_UART_BAUDRATE
32 #define BOARD_DEBUG_UART_BAUDRATE (115200U)
33 #endif /* BOARD_DEBUG_UART_BAUDRATE */
34 
35 /* @Brief Board accelerator sensor configuration */
36 #define BOARD_ACCEL_I2C_BASEADDR             LPI2C4
37 #define BOARD_ACCEL_I2C_CLOCK_SOURCE_SELECT  (0U)
38 #define BOARD_ACCEL_I2C_CLOCK_SOURCE_DIVIDER (5U)
39 #define BOARD_ACCEL_I2C_CLOCK_FREQ           (CLOCK_GetFreq(kCLOCK_Usb1PllClk) / 8 / (BOARD_ACCEL_I2C_CLOCK_SOURCE_DIVIDER + 1U))
40 
41 #define BOARD_CODEC_I2C_BASEADDR             LPI2C1
42 #define BOARD_CODEC_I2C_INSTANCE             1U
43 #define BOARD_CODEC_I2C_CLOCK_SOURCE_SELECT  (0U)
44 #define BOARD_CODEC_I2C_CLOCK_SOURCE_DIVIDER (5U)
45 #define BOARD_CODEC_I2C_CLOCK_FREQ           (10000000U)
46 
47 /*! @brief The USER_LED used for board */
48 #define LOGIC_LED_ON  (0U)
49 #define LOGIC_LED_OFF (1U)
50 #ifndef BOARD_USER_LED_GPIO
51 #define BOARD_USER_LED_GPIO GPIO1
52 #endif
53 #ifndef BOARD_USER_LED_GPIO_PIN
54 #define BOARD_USER_LED_GPIO_PIN (5U)
55 #endif
56 
57 #define USER_LED_INIT(output)                                            \
58     GPIO_PinWrite(BOARD_USER_LED_GPIO, BOARD_USER_LED_GPIO_PIN, output); \
59     BOARD_USER_LED_GPIO->GDIR |= (1U << BOARD_USER_LED_GPIO_PIN) /*!< Enable target USER_LED */
60 #define USER_LED_ON() \
61     GPIO_PortClear(BOARD_USER_LED_GPIO, 1U << BOARD_USER_LED_GPIO_PIN)                  /*!< Turn off target USER_LED */
62 #define USER_LED_OFF() GPIO_PortSet(BOARD_USER_LED_GPIO, 1U << BOARD_USER_LED_GPIO_PIN) /*!<Turn on target USER_LED*/
63 #define USER_LED_TOGGLE()                                       \
64     GPIO_PinWrite(BOARD_USER_LED_GPIO, BOARD_USER_LED_GPIO_PIN, \
65                   0x1 ^ GPIO_PinRead(BOARD_USER_LED_GPIO, BOARD_USER_LED_GPIO_PIN)) /*!< Toggle target USER_LED */
66 
67 /*! @brief Define the port interrupt number for the board switches */
68 #ifndef BOARD_USER_BUTTON_GPIO
69 #define BOARD_USER_BUTTON_GPIO GPIO5
70 #endif
71 #ifndef BOARD_USER_BUTTON_GPIO_PIN
72 #define BOARD_USER_BUTTON_GPIO_PIN (0U)
73 #endif
74 #define BOARD_USER_BUTTON_IRQ         GPIO5_Combined_0_15_IRQn
75 #define BOARD_USER_BUTTON_IRQ_HANDLER GPIO5_Combined_0_15_IRQHandler
76 #define BOARD_USER_BUTTON_NAME        "SW4"
77 
78 /*! @brief The hyper flash size */
79 #define BOARD_FLASH_SIZE (0x800000U)
80 
81 /*! @brief The ENET PHY address. */
82 #define BOARD_ENET0_PHY_ADDRESS (0x02U) /* Phy address of enet port 0. */
83 
84 /* USB PHY condfiguration */
85 #define BOARD_USB_PHY_D_CAL     (0x0CU)
86 #define BOARD_USB_PHY_TXCAL45DP (0x06U)
87 #define BOARD_USB_PHY_TXCAL45DM (0x06U)
88 
89 #define BOARD_ARDUINO_INT_IRQ   (GPIO1_Combined_16_31_IRQn)
90 #define BOARD_ARDUINO_I2C_IRQ   (LPI2C4_IRQn)
91 #define BOARD_ARDUINO_I2C_INDEX (4)
92 /*! @brief The WIFI-QCA shield pin. */
93 #define BOARD_INITGT202SHIELD_PWRON_GPIO      GPIO1               /*!< GPIO device name: GPIO */
94 #define BOARD_INITGT202SHIELD_PWRON_PORT      1U                  /*!< PORT device index: 1 */
95 #define BOARD_INITGT202SHIELD_PWRON_GPIO_PIN  23U                 /*!< PIO4 pin index: 23 */
96 #define BOARD_INITGT202SHIELD_PWRON_PIN_NAME  GPIO1_23            /*!< Pin name */
97 #define BOARD_INITGT202SHIELD_PWRON_LABEL     "PWRON"             /*!< Label */
98 #define BOARD_INITGT202SHIELD_PWRON_NAME      "PWRON"             /*!< Identifier name */
99 #define BOARD_INITGT202SHIELD_PWRON_DIRECTION kGPIO_DigitalOutput /*!< Direction */
100 
101 #define BOARD_INITGT202SHIELD_IRQ_GPIO      GPIO1              /*!< GPIO device name: GPIO */
102 #define BOARD_INITGT202SHIELD_IRQ_PORT      1U                 /*!< PORT device index: 1 */
103 #define BOARD_INITGT202SHIELD_IRQ_GPIO_PIN  22U                /*!< PIO1 pin index: 22 */
104 #define BOARD_INITGT202SHIELD_IRQ_PIN_NAME  GPIO1_22           /*!< Pin name */
105 #define BOARD_INITGT202SHIELD_IRQ_LABEL     "IRQ"              /*!< Label */
106 #define BOARD_INITGT202SHIELD_IRQ_NAME      "IRQ"              /*!< Identifier name */
107 #define BOARD_INITGT202SHIELD_IRQ_DIRECTION kGPIO_DigitalInput /*!< Direction */
108 
109 /* Display. */
110 #define BOARD_LCD_DC_GPIO     GPIO1 /*! LCD data/command port */
111 #define BOARD_LCD_DC_GPIO_PIN 15U   /*! LCD data/command pin */
112 
113 /* @Brief Board Bluetooth HCI UART configuration */
114 #define BOARD_BT_UART_BASEADDR    LPUART3
115 #define BOARD_BT_UART_CLK_FREQ    BOARD_DebugConsoleSrcFreq()
116 #define BOARD_BT_UART_IRQ         LPUART3_IRQn
117 #define BOARD_BT_UART_IRQ_HANDLER LPUART3_IRQHandler
118 
119 /*! @brief board has sdcard */
120 #define BOARD_HAS_SDCARD (1U)
121 
122 #if defined(__cplusplus)
123 extern "C" {
124 #endif /* __cplusplus */
125 
126 /*******************************************************************************
127  * API
128  ******************************************************************************/
129 uint32_t BOARD_DebugConsoleSrcFreq(void);
130 
131 void BOARD_InitDebugConsole(void);
132 void BOARD_ConfigMPU(void);
133 #if defined(SDK_I2C_BASED_COMPONENT_USED) && SDK_I2C_BASED_COMPONENT_USED
134 void BOARD_InitDebugConsole(void);
135 void BOARD_LPI2C_Init(LPI2C_Type *base, uint32_t clkSrc_Hz);
136 status_t BOARD_LPI2C_Send(LPI2C_Type *base,
137                           uint8_t deviceAddress,
138                           uint32_t subAddress,
139                           uint8_t subaddressSize,
140                           uint8_t *txBuff,
141                           uint8_t txBuffSize);
142 status_t BOARD_LPI2C_Receive(LPI2C_Type *base,
143                              uint8_t deviceAddress,
144                              uint32_t subAddress,
145                              uint8_t subaddressSize,
146                              uint8_t *rxBuff,
147                              uint8_t rxBuffSize);
148 void BOARD_Accel_I2C_Init(void);
149 status_t BOARD_Accel_I2C_Send(uint8_t deviceAddress, uint32_t subAddress, uint8_t subaddressSize, uint32_t txBuff);
150 status_t BOARD_Accel_I2C_Receive(
151     uint8_t deviceAddress, uint32_t subAddress, uint8_t subaddressSize, uint8_t *rxBuff, uint8_t rxBuffSize);
152 void BOARD_Codec_I2C_Init(void);
153 status_t BOARD_Codec_I2C_Send(
154     uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, const uint8_t *txBuff, uint8_t txBuffSize);
155 status_t BOARD_Codec_I2C_Receive(
156     uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, uint8_t *rxBuff, uint8_t rxBuffSize);
157 #endif /* SDK_I2C_BASED_COMPONENT_USED */
158 void BOARD_SD_Pin_Config(uint32_t speed, uint32_t strength);
159 void BOARD_MMC_Pin_Config(uint32_t speed, uint32_t strength);
160 #if defined(__cplusplus)
161 }
162 #endif /* __cplusplus */
163 
164 #endif /* _BOARD_H_ */
165