/*
 * Copyright (c) 2016, Freescale Semiconductor, Inc.
 * Copyright 2016-2018 NXP
 * All rights reserved.
 *
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef _BOARD_H_
#define _BOARD_H_

#include "clock_config.h"
#include "fsl_common.h"
#include "fsl_gpio.h"

/*******************************************************************************
 * Definitions
 ******************************************************************************/
/*! @brief The board name */
#define BOARD_NAME "LPC54616_for_Sulfur"

#define BOARD_EXTCLKINRATE (0)

/*! @brief The UART to use for debug messages. */
/* TODO: rename UART to USART */
#define BOARD_DEBUG_UART_TYPE       kSerialPort_Uart
#define BOARD_DEBUG_UART_BASEADDR   (uint32_t) USART0
#define BOARD_DEBUG_UART_INSTANCE   0U
#define BOARD_DEBUG_UART_CLK_FREQ   CLOCK_GetFlexCommClkFreq(0)
#define BOARD_DEBUG_UART_CLK_ATTACH kFRO12M_to_FLEXCOMM0
#define BOARD_DEBUG_UART_RST        kFC0_RST_SHIFT_RSTn
#define BOARD_DEBUG_UART_CLKSRC     kCLOCK_Flexcomm0
#define BOARD_UART_IRQ_HANDLER      FLEXCOMM0_IRQHandler
#define BOARD_UART_IRQ              FLEXCOMM0_IRQn
/* TODO: obsolete */
#define BOARD_DEBUG_SPI_CLK_FREQ 12000000

#ifndef BOARD_DEBUG_UART_BAUDRATE
#define BOARD_DEBUG_UART_BAUDRATE 115200
#endif /* BOARD_DEBUG_UART_BAUDRATE */

/*! @brief The ENET PHY address. */
#define BOARD_ENET0_PHY_ADDRESS (0x00U) /* Phy address of enet port 0. */

/*! @brief Memory ranges not usable by the ENET DMA. */
#ifndef BOARD_ENET_NON_DMA_MEMORY_ARRAY
#define BOARD_ENET_NON_DMA_MEMORY_ARRAY                                                     \
    {                                                                                       \
        {0x00000000U, 0x0007FFFFU}, {0x10000000U, 0x17FFFFFFU}, {0x80000000U, 0xDFFFFFFFU}, \
            {0x00000000U, 0x00000000U},                                                     \
    }
#endif /* BOARD_ENET_NON_DMA_MEMORY_ARRAY */

/* LPI2C */
#define BOARD_ACCEL_I2C_BASEADDR   I2C2
#define BOARD_ACCEL_I2C_CLOCK_FREQ 12000000

#define BOARD_CODEC_I2C_BASEADDR   I2C2
#define BOARD_CODEC_I2C_INSTANCE   2U
#define BOARD_CODEC_I2C_CLOCK_FREQ 12000000

#ifndef BOARD_LED0_GPIO
#define BOARD_LED0_GPIO GPIO
#endif
#define BOARD_LED0_GPIO_PORT 0U
#ifndef BOARD_LED0_GPIO_PIN
#define BOARD_LED0_GPIO_PIN 7U
#endif
#ifndef BOARD_LED1_GPIO
#define BOARD_LED1_GPIO GPIO
#endif
#define BOARD_LED1_GPIO_PORT 1U
#ifndef BOARD_LED1_GPIO_PIN
#define BOARD_LED1_GPIO_PIN 16U
#endif
#ifndef BOARD_LED2_GPIO
#define BOARD_LED2_GPIO GPIO
#endif
#define BOARD_LED2_GPIO_PORT 0U
#ifndef BOARD_LED2_GPIO_PIN
#define BOARD_LED2_GPIO_PIN 8U
#endif

#ifndef BOARD_NSTATUS_GPIO
#define BOARD_NSTATUS_GPIO GPIO
#endif
#define BOARD_NSTATUS_GPIO_PORT 0U
#ifndef BOARD_NSTATUS_GPIO_PIN
#define BOARD_NSTATUS_GPIO_PIN 2U
#endif
#define BOARD_NSTATUS_NAME        "NSTATUS"
#define BOARD_NSTATUS_IRQ         PIN_INT0_IRQn
#define BOARD_NSTATUS_IRQ_HANDLER PIN_INT0_IRQHandler
#define BOARD_NSTATUS_GPIO_PININT_INDEX 0

#ifndef BOARD_INITDONE_GPIO
#define BOARD_INITDONE_GPIO GPIO
#endif
#define BOARD_INITDONE_GPIO_PORT 0U
#ifndef BOARD_INITDONE_GPIO_PIN
#define BOARD_INITDONE_GPIO_PIN 3U
#endif
#define BOARD_INITDONE_NAME        "INITDONE"
#define BOARD_INITDONE_IRQ         PIN_INT0_IRQn
#define BOARD_INITDONE_IRQ_HANDLER PIN_INT0_IRQHandler
#define BOARD_INITDONE_GPIO_PININT_INDEX 0

#ifndef BOARD_CONFDONE_GPIO
#define BOARD_CONFDONE_GPIO GPIO
#endif
#define BOARD_CONFDONE_GPIO_PORT 1U
#ifndef BOARD_CONFDONE_GPIO_PIN
#define BOARD_CONFDONE_GPIO_PIN 15U
#endif
#define BOARD_CONFDONE_NAME              "CONFDONE"
#define BOARD_CONFDONE_IRQ               PIN_INT0_IRQn
#define BOARD_CONFDONE_IRQ_HANDLER       PIN_INT0_IRQHandler
#define BOARD_CONFDONE_GPIO_PININT_INDEX 0

#ifndef BOARD_SOMRESET_GPIO
#define BOARD_SOMRESET_GPIO GPIO
#endif
#define BOARD_SOMRESET_GPIO_PORT 0U
#ifndef BOARD_SOMRESET_GPIO_PIN
#define BOARD_SOMRESET_GPIO_PIN 9U
#endif

#ifndef BOARD_SW4_2_GPIO
#define BOARD_SW4_2_GPIO GPIO
#endif
#define BOARD_SW4_2_GPIO_PORT 0U
#ifndef BOARD_SW4_2_GPIO_PIN
#define BOARD_SW4_2_GPIO_PIN 17U
#endif

#define BOARD_ARDUINO_INT_IRQ   (GINT0_IRQn)
#define BOARD_ARDUINO_I2C_IRQ   (FLEXCOMM2_IRQn)
#define BOARD_ARDUINO_I2C_INDEX (2)

/* Board led color mapping */
#define LOGIC_LED_ON  1U
#define LOGIC_LED_OFF 0U

#define LED0_INIT(output)                                                    \
    GPIO_PinInit(BOARD_LED0_GPIO, BOARD_LED0_GPIO_PORT, BOARD_LED0_GPIO_PIN, \
                 &(gpio_pin_config_t){kGPIO_DigitalOutput, (output)}) /*!< Enable target LED0 */
#define LED0_OFF() \
    GPIO_PortClear(BOARD_LED0_GPIO, BOARD_LED0_GPIO_PORT, 1U << BOARD_LED0_GPIO_PIN) /*!< Turn on target LED0 */
#define LED0_ON() \
    GPIO_PortSet(BOARD_LED0_GPIO, BOARD_LED0_GPIO_PORT, 1U << BOARD_LED0_GPIO_PIN) /*!< Turn off target LED0 */
#define LED0_TOGGLE() \
    GPIO_PortToggle(BOARD_LED0_GPIO, BOARD_LED0_GPIO_PORT, 1U << BOARD_LED0_GPIO_PIN) /*!< Toggle on target LED0 */
#define LED1_INIT(output)                                                    \
    GPIO_PinInit(BOARD_LED1_GPIO, BOARD_LED1_GPIO_PORT, BOARD_LED1_GPIO_PIN, \
                 &(gpio_pin_config_t){kGPIO_DigitalOutput, (output)}) /*!< Enable target LED1 */
#define LED1_OFF() \
    GPIO_PortClear(BOARD_LED1_GPIO, BOARD_LED1_GPIO_PORT, 1U << BOARD_LED1_GPIO_PIN) /*!< Turn on target LED1 */
#define LED1_ON() \
    GPIO_PortSet(BOARD_LED1_GPIO, BOARD_LED1_GPIO_PORT, 1U << BOARD_LED1_GPIO_PIN) /*!< Turn off target LED1 */
#define LED1_TOGGLE() \
    GPIO_PortToggle(BOARD_LED1_GPIO, BOARD_LED1_GPIO_PORT, 1U << BOARD_LED1_GPIO_PIN) /*!< Toggle on target LED1 */

#define LED2_INIT(output)                                                    \
    GPIO_PinInit(BOARD_LED2_GPIO, BOARD_LED2_GPIO_PORT, BOARD_LED2_GPIO_PIN, \
                 &(gpio_pin_config_t){kGPIO_DigitalOutput, (output)}) /*!< Enable target LED2 */
#define LED2_OFF() \
    GPIO_PortClear(BOARD_LED2_GPIO, BOARD_LED2_GPIO_PORT, 1U << BOARD_LED2_GPIO_PIN) /*!< Turn on target LED2 */
#define LED2_ON() \
    GPIO_PortSet(BOARD_LED2_GPIO, BOARD_LED2_GPIO_PORT, 1U << BOARD_LED2_GPIO_PIN) /*!< Turn off target LED2 */
#define LED2_TOGGLE() \
    GPIO_PortToggle(BOARD_LED2_GPIO, BOARD_LED2_GPIO_PORT, 1U << BOARD_LED2_GPIO_PIN) /*!< Toggle on target LED2 */

#define NSTATUS_INIT() \
    GPIO_PinInit(BOARD_NSTATUS_GPIO, BOARD_NSTATUS_GPIO_PORT, BOARD_NSTATUS_GPIO_PIN, \
                 &(gpio_pin_config_t){kGPIO_DigitalInput, 0}) /*!< Enable Pin input of NSTATUS */
#define NSTATUS_READ() \
    GPIO_PinRead(BOARD_NSTATUS_GPIO, BOARD_NSTATUS_GPIO_PORT, BOARD_NSTATUS_GPIO_PIN) /*!< Read Pin status of NSTATUS */

#define INITDONE_INIT() \
    GPIO_PinInit(BOARD_INITDONE_GPIO, BOARD_INITDONE_GPIO_PORT, BOARD_INITDONE_GPIO_PIN, \
                 &(gpio_pin_config_t){kGPIO_DigitalInput, 0}) /*!< Enable Pin input of INITDONE */
#define INITDONE_READ() \
    GPIO_PinRead(BOARD_INITDONE_GPIO, BOARD_INITDONE_GPIO_PORT, BOARD_INITDONE_GPIO_PIN) /*!< Read Pin status of INITDONE */

#define CONFDONE_INIT() \
    GPIO_PinInit(BOARD_CONFDONE_GPIO, BOARD_CONFDONE_GPIO_PORT, BOARD_CONFDONE_GPIO_PIN, \
                 &(gpio_pin_config_t){kGPIO_DigitalInput, 0}) /*!< Enable Pin input of CONFDONE */
#define CONFDONE_READ() \
    GPIO_PinRead(BOARD_CONFDONE_GPIO, BOARD_CONFDONE_GPIO_PORT, BOARD_CONFDONE_GPIO_PIN) /*!< Read Pin status of CONFDONE */

/* FPGA Reset mapping */
#define LOGIC_SOMRESET_DEASSERT  1U
#define LOGIC_SOMRESET_ASSERT 0U

#define SOMRESET_INIT(output) \
    GPIO_PinInit(BOARD_SOMRESET_GPIO, BOARD_SOMRESET_GPIO_PORT, BOARD_SOMRESET_GPIO_PIN, \
                 &(gpio_pin_config_t){kGPIO_DigitalOutput, (output)}) /*!< Enable target SOMRESET */
#define SOMRESET_ON() \
    GPIO_PortClear(BOARD_SOMRESET_GPIO, BOARD_SOMRESET_GPIO_PORT, 1U << BOARD_SOMRESET_GPIO_PIN) /*!< Turn on target SOMRESET */
#define SOMRESET_OFF() \
    GPIO_PortSet(BOARD_SOMRESET_GPIO, BOARD_SOMRESET_GPIO_PORT, 1U << BOARD_SOMRESET_GPIO_PIN) /*!< Turn off target SOMRESET */

#define SW4_2_INIT() \
    GPIO_PinInit(BOARD_SW4_2_GPIO, BOARD_SW4_2_GPIO_PORT, BOARD_SW4_2_GPIO_PIN, \
                 &(gpio_pin_config_t){kGPIO_DigitalInput, 0}) /*!< Enable Pin input of CONFDONE */
#define SW4_2_READ() \
    GPIO_PinRead(BOARD_SW4_2_GPIO, BOARD_SW4_2_GPIO_PORT, BOARD_SW4_2_GPIO_PIN) /*!< Read Pin status of CONFDONE */


/* LCD panel. */
#define BOARD_LCD_BL_GPIO          3
#define BOARD_LCD_BL_PIN           31
#define BOARD_TOUCH_PANEL_RST_GPIO 2
#define BOARD_TOUCH_PANEL_RST_PIN  27

/* @Brief Board touch panel configuration */
#define BOARD_TOUCH_I2C_BASEADDR I2C2
#define BOARD_TOUCH_RST_GPIO     GPIO
#define BOARD_TOUCH_RST_PORT     2
#define BOARD_TOUCH_RST_PIN      27
#define BOARD_TOUCH_INT_GPIO     GPIO
#define BOARD_TOUCH_INT_PORT     4
#define BOARD_TOUCH_INT_PIN      0

/* Serial MWM WIFI */
#define BOARD_SERIAL_MWM_PORT_CLK_FREQ CLOCK_GetFlexCommClkFreq(4)
#define BOARD_SERIAL_MWM_PORT          USART4
#define BOARD_SERIAL_MWM_PORT_IRQn     FLEXCOMM4_IRQn
#define BOARD_SERIAL_MWM_RST_GPIO      GPIO
#define BOARD_SERIAL_MWM_RST_PORT      1
#define BOARD_SERIAL_MWM_RST_PIN       22
#define BOARD_SERIAL_MWM_RST_WRITE(output) \
    GPIO_PinWrite(BOARD_SERIAL_MWM_RST_GPIO, BOARD_SERIAL_MWM_RST_PORT, BOARD_SERIAL_MWM_RST_PIN, output)

#if defined(__cplusplus)
extern "C" {
#endif /* __cplusplus */

/*******************************************************************************
 * API
 ******************************************************************************/

status_t BOARD_InitDebugConsole(void);
void BOARD_InitSDRAM(void);
#if defined(SDK_I2C_BASED_COMPONENT_USED) && SDK_I2C_BASED_COMPONENT_USED
void BOARD_I2C_Init(I2C_Type *base, uint32_t clkSrc_Hz);
status_t BOARD_I2C_Send(I2C_Type *base,
                        uint8_t deviceAddress,
                        uint32_t subAddress,
                        uint8_t subaddressSize,
                        uint8_t *txBuff,
                        uint8_t txBuffSize);
status_t BOARD_I2C_Receive(I2C_Type *base,
                           uint8_t deviceAddress,
                           uint32_t subAddress,
                           uint8_t subaddressSize,
                           uint8_t *rxBuff,
                           uint8_t rxBuffSize);
void BOARD_Accel_I2C_Init(void);
status_t BOARD_Accel_I2C_Send(uint8_t deviceAddress, uint32_t subAddress, uint8_t subaddressSize, uint32_t txBuff);
status_t BOARD_Accel_I2C_Receive(
    uint8_t deviceAddress, uint32_t subAddress, uint8_t subaddressSize, uint8_t *rxBuff, uint8_t rxBuffSize);
void BOARD_Codec_I2C_Init(void);
status_t BOARD_Codec_I2C_Send(
    uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, const uint8_t *txBuff, uint8_t txBuffSize);
status_t BOARD_Codec_I2C_Receive(
    uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, uint8_t *rxBuff, uint8_t rxBuffSize);
status_t BOARD_Touch_I2C_Send(
    uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, const uint8_t *txBuff, uint8_t txBuffSize);
status_t BOARD_Touch_I2C_Receive(
    uint8_t deviceAddress, uint32_t subAddress, uint8_t subAddressSize, uint8_t *rxBuff, uint8_t rxBuffSize);
#endif /* SDK_I2C_BASED_COMPONENT_USED */

#if defined(__cplusplus)
}
#endif /* __cplusplus */

#endif /* _BOARD_H_ */
