1 /*
2  * Copyright 2020 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 "MIMXRT1024-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  (1U)
49 #define LOGIC_LED_OFF (0U)
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 (24U)
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_OFF() \
61     GPIO_PortClear(BOARD_USER_LED_GPIO, 1U << BOARD_USER_LED_GPIO_PIN)                 /*!< Turn off target USER_LED */
62 #define USER_LED_ON() 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 board flash size */
79 #define BOARD_FLASH_SIZE (0x400000U)
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 
93 /* Display. */
94 #define BOARD_LCD_DC_GPIO     GPIO1 /*! LCD data/command port */
95 #define BOARD_LCD_DC_GPIO_PIN 15U   /*! LCD data/command pin */
96 
97 /* @Brief Board Bluetooth HCI UART configuration */
98 #define BOARD_BT_UART_BASEADDR    LPUART3
99 #define BOARD_BT_UART_CLK_FREQ    BOARD_DebugConsoleSrcFreq()
100 #define BOARD_BT_UART_IRQ         LPUART3_IRQn
101 #define BOARD_BT_UART_IRQ_HANDLER LPUART3_IRQHandler
102 
103 /*! @brief board has sdcard */
104 #define BOARD_HAS_SDCARD (1U)
105 
106 #if defined(__cplusplus)
107 extern "C" {
108 #endif /* __cplusplus */
109 
110 /*******************************************************************************
111  * API
112  ******************************************************************************/
113 uint32_t BOARD_DebugConsoleSrcFreq(void);
114 
115 void BOARD_InitDebugConsole(void);
116 void BOARD_ConfigMPU(void);
117 #if defined(SDK_I2C_BASED_COMPONENT_USED) && SDK_I2C_BASED_COMPONENT_USED
118 void BOARD_InitDebugConsole(void);
119 void BOARD_LPI2C_Init(LPI2C_Type *base, uint32_t clkSrc_Hz);
120 status_t BOARD_LPI2C_Send(LPI2C_Type *base,
121                           uint8_t deviceAddress,
122                           uint32_t subAddress,
123                           uint8_t subaddressSize,
124                           uint8_t *txBuff,
125                           uint8_t txBuffSize);
126 status_t BOARD_LPI2C_Receive(LPI2C_Type *base,
127                              uint8_t deviceAddress,
128                              uint32_t subAddress,
129                              uint8_t subaddressSize,
130                              uint8_t *rxBuff,
131                              uint8_t rxBuffSize);
132 void BOARD_Accel_I2C_Init(void);
133 status_t BOARD_Accel_I2C_Send(uint8_t deviceAddress, uint32_t subAddress, uint8_t subaddressSize, uint32_t txBuff);
134 status_t BOARD_Accel_I2C_Receive(
135     uint8_t deviceAddress, uint32_t subAddress, uint8_t subaddressSize, uint8_t *rxBuff, uint8_t rxBuffSize);
136 void BOARD_Codec_I2C_Init(void);
137 status_t BOARD_Codec_I2C_Send(
138     uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, const uint8_t *txBuff, uint8_t txBuffSize);
139 status_t BOARD_Codec_I2C_Receive(
140     uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, uint8_t *rxBuff, uint8_t rxBuffSize);
141 #endif /* SDK_I2C_BASED_COMPONENT_USED */
142 void BOARD_SD_Pin_Config(uint32_t speed, uint32_t strength);
143 void BOARD_MMC_Pin_Config(uint32_t speed, uint32_t strength);
144 #if defined(__cplusplus)
145 }
146 #endif /* __cplusplus */
147 
148 #endif /* _BOARD_H_ */
149