1 /*
2  * Copyright 2021-2022 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 #include "fsl_clock.h"
15 
16 /*******************************************************************************
17  * Definitions
18  ******************************************************************************/
19 /*! @brief The board name */
20 #define BOARD_NAME "MIMXRT1040-EVK"
21 
22 /* The UART to use for debug messages. */
23 #define BOARD_DEBUG_UART_TYPE     kSerialPort_Uart
24 #define BOARD_DEBUG_UART_BASEADDR (uint32_t) LPUART1
25 #define BOARD_DEBUG_UART_INSTANCE 1U
26 
27 #define BOARD_DEBUG_UART_CLK_FREQ BOARD_DebugConsoleSrcFreq()
28 
29 #define BOARD_UART_IRQ         LPUART1_IRQn
30 #define BOARD_UART_IRQ_HANDLER LPUART1_IRQHandler
31 
32 #ifndef BOARD_DEBUG_UART_BAUDRATE
33 #define BOARD_DEBUG_UART_BAUDRATE (115200U)
34 #endif /* BOARD_DEBUG_UART_BAUDRATE */
35 
36 /*! @brief The USER_LED used for board */
37 #define LOGIC_LED_ON  (0U)
38 #define LOGIC_LED_OFF (1U)
39 #ifndef BOARD_USER_LED_GPIO
40 #define BOARD_USER_LED_GPIO GPIO1
41 #endif
42 #ifndef BOARD_USER_LED_GPIO_PIN
43 #define BOARD_USER_LED_GPIO_PIN (8U)
44 #endif
45 
46 #define USER_LED_INIT(output)                                            \
47     GPIO_PinWrite(BOARD_USER_LED_GPIO, BOARD_USER_LED_GPIO_PIN, output); \
48     BOARD_USER_LED_GPIO->GDIR |= (1U << BOARD_USER_LED_GPIO_PIN) /*!< Enable target USER_LED */
49 #define USER_LED_OFF() \
50     GPIO_PortClear(BOARD_USER_LED_GPIO, 1U << BOARD_USER_LED_GPIO_PIN)                  /*!< Turn off target USER_LED */
51 #define USER_LED_ON() GPIO_PortSet(BOARD_USER_LED_GPIO, 1U << BOARD_USER_LED_GPIO_PIN) /*!<Turn on target USER_LED*/
52 #define USER_LED_TOGGLE()                                       \
53     GPIO_PinWrite(BOARD_USER_LED_GPIO, BOARD_USER_LED_GPIO_PIN, \
54                   0x1 ^ GPIO_PinRead(BOARD_USER_LED_GPIO, BOARD_USER_LED_GPIO_PIN)) /*!< Toggle target USER_LED */
55 
56 /*! @brief Define the port interrupt number for the board switches */
57 #ifndef BOARD_USER_BUTTON_GPIO
58 #define BOARD_USER_BUTTON_GPIO GPIO5
59 #endif
60 #ifndef BOARD_USER_BUTTON_GPIO_PIN
61 #define BOARD_USER_BUTTON_GPIO_PIN (0U)
62 #endif
63 #define BOARD_USER_BUTTON_IRQ         GPIO5_Combined_0_15_IRQn
64 #define BOARD_USER_BUTTON_IRQ_HANDLER GPIO5_Combined_0_15_IRQHandler
65 #define BOARD_USER_BUTTON_NAME        "SW5"
66 
67 /*! @brief The board flash size */
68 #define BOARD_FLASH_SIZE (0x800000U)
69 
70 /*! @brief The ENET PHY address. */
71 #define BOARD_ENET0_PHY_ADDRESS (0x02U) /* Phy address of enet port 0. */
72 
73 /* USB PHY condfiguration */
74 #define BOARD_USB_PHY_D_CAL     (0x0CU)
75 #define BOARD_USB_PHY_TXCAL45DP (0x06U)
76 #define BOARD_USB_PHY_TXCAL45DM (0x06U)
77 
78 #define BOARD_ARDUINO_INT_IRQ   (GPIO1_INT3_IRQn)
79 #define BOARD_ARDUINO_I2C_IRQ   (LPI2C1_IRQn)
80 #define BOARD_ARDUINO_I2C_INDEX (1)
81 
82 /* @Brief Board accelerator sensor configuration */
83 #define BOARD_ACCEL_I2C_BASEADDR LPI2C1
84 /* Select USB1 PLL (480 MHz) as LPI2C's clock source */
85 #define BOARD_ACCEL_I2C_CLOCK_SOURCE_SELECT (0U)
86 /* Clock divider for LPI2C clock source */
87 #define BOARD_ACCEL_I2C_CLOCK_SOURCE_DIVIDER (5U)
88 #define BOARD_ACCEL_I2C_CLOCK_FREQ           (CLOCK_GetFreq(kCLOCK_Usb1PllClk) / 8 / (BOARD_ACCEL_I2C_CLOCK_SOURCE_DIVIDER + 1U))
89 
90 #define BOARD_CODEC_I2C_BASEADDR             LPI2C1
91 #define BOARD_CODEC_I2C_INSTANCE             1U
92 #define BOARD_CODEC_I2C_CLOCK_SOURCE_SELECT  (0U)
93 #define BOARD_CODEC_I2C_CLOCK_SOURCE_DIVIDER (5U)
94 #define BOARD_CODEC_I2C_CLOCK_FREQ           (10000000U)
95 
96 /* @Brief Board CAMERA configuration */
97 #define BOARD_CAMERA_I2C_BASEADDR             LPI2C1
98 #define BOARD_CAMERA_I2C_CLOCK_SOURCE_DIVIDER (5U)
99 #define BOARD_CAMERA_I2C_CLOCK_SOURCE_SELECT  (0U) /* Select USB1 PLL (480 MHz) as LPI2C's clock source */
100 #define BOARD_CAMERA_I2C_CLOCK_FREQ \
101     (CLOCK_GetFreq(kCLOCK_Usb1PllClk) / 8 / (BOARD_CAMERA_I2C_CLOCK_SOURCE_DIVIDER + 1U))
102 
103 #define BOARD_CAMERA_I2C_SCL_GPIO GPIO1
104 #define BOARD_CAMERA_I2C_SCL_PIN  16
105 #define BOARD_CAMERA_I2C_SDA_GPIO GPIO1
106 #define BOARD_CAMERA_I2C_SDA_PIN  17
107 #define BOARD_CAMERA_PWDN_GPIO    GPIO1
108 #define BOARD_CAMERA_PWDN_PIN     4
109 
110 /* @Brief Board Bluetooth HCI UART configuration */
111 #define BOARD_BT_UART_BASEADDR    LPUART3
112 #define BOARD_BT_UART_INSTANCE    3
113 #define BOARD_BT_UART_BAUDRATE    3000000
114 #define BOARD_BT_UART_CLK_FREQ    BOARD_DebugConsoleSrcFreq()
115 #define BOARD_BT_UART_IRQ         LPUART3_IRQn
116 #define BOARD_BT_UART_IRQ_HANDLER LPUART3_IRQHandler
117 
118 /*! @brief board has sdcard */
119 #define BOARD_HAS_SDCARD (1U)
120 
121 #if defined(__cplusplus)
122 extern "C" {
123 #endif /* __cplusplus */
124 
125 /*******************************************************************************
126  * API
127  ******************************************************************************/
128 uint32_t BOARD_DebugConsoleSrcFreq(void);
129 
130 void BOARD_InitDebugConsole(void);
131 
132 void BOARD_ConfigMPU(void);
133 #if defined(SDK_I2C_BASED_COMPONENT_USED) && SDK_I2C_BASED_COMPONENT_USED
134 void BOARD_LPI2C_Init(LPI2C_Type *base, uint32_t clkSrc_Hz);
135 status_t BOARD_LPI2C_Send(LPI2C_Type *base,
136                           uint8_t deviceAddress,
137                           uint32_t subAddress,
138                           uint8_t subaddressSize,
139                           uint8_t *txBuff,
140                           uint8_t txBuffSize);
141 status_t BOARD_LPI2C_Receive(LPI2C_Type *base,
142                              uint8_t deviceAddress,
143                              uint32_t subAddress,
144                              uint8_t subaddressSize,
145                              uint8_t *rxBuff,
146                              uint8_t rxBuffSize);
147 status_t BOARD_LPI2C_SendSCCB(LPI2C_Type *base,
148                               uint8_t deviceAddress,
149                               uint32_t subAddress,
150                               uint8_t subaddressSize,
151                               uint8_t *txBuff,
152                               uint8_t txBuffSize);
153 status_t BOARD_LPI2C_ReceiveSCCB(LPI2C_Type *base,
154                                  uint8_t deviceAddress,
155                                  uint32_t subAddress,
156                                  uint8_t subaddressSize,
157                                  uint8_t *rxBuff,
158                                  uint8_t rxBuffSize);
159 void BOARD_Accel_I2C_Init(void);
160 status_t BOARD_Accel_I2C_Send(uint8_t deviceAddress, uint32_t subAddress, uint8_t subaddressSize, uint32_t txBuff);
161 status_t BOARD_Accel_I2C_Receive(
162     uint8_t deviceAddress, uint32_t subAddress, uint8_t subaddressSize, uint8_t *rxBuff, uint8_t rxBuffSize);
163 void BOARD_Codec_I2C_Init(void);
164 status_t BOARD_Codec_I2C_Send(
165     uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, const uint8_t *txBuff, uint8_t txBuffSize);
166 status_t BOARD_Codec_I2C_Receive(
167     uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, uint8_t *rxBuff, uint8_t rxBuffSize);
168 void BOARD_Camera_I2C_Init(void);
169 status_t BOARD_Camera_I2C_Send(
170     uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, const uint8_t *txBuff, uint8_t txBuffSize);
171 status_t BOARD_Camera_I2C_Receive(
172     uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, uint8_t *rxBuff, uint8_t rxBuffSize);
173 
174 status_t BOARD_Camera_I2C_SendSCCB(
175     uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, const uint8_t *txBuff, uint8_t txBuffSize);
176 status_t BOARD_Camera_I2C_ReceiveSCCB(
177     uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, uint8_t *rxBuff, uint8_t rxBuffSize);
178 #endif /* SDK_I2C_BASED_COMPONENT_USED */
179 
180 void BOARD_SD_Pin_Config(uint32_t speed, uint32_t strength);
181 void BOARD_MMC_Pin_Config(uint32_t speed, uint32_t strength);
182 
183 #if defined(__cplusplus)
184 }
185 #endif /* __cplusplus */
186 
187 #endif /* _BOARD_H_ */
188