/*
 * Copyright 2018-2021 NXP
 * All rights reserved.
 *
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef _FLEXSPI_FLASH_CONFIG_H_
#define _FLEXSPI_FLASH_CONFIG_H_

#include <flash_partitioning.h>
#include "fsl_flexspi.h"

/*******************************************************************************
 * Definitions
 ******************************************************************************/
/*${macro:start}*/
#define EXAMPLE_FLEXSPI                         FLEXSPI
#define FLASH_SIZE_KB                           ( COMPONENT_FLASHIAP_SIZE / 1024 ) /* 0x2000= 64Mb/KByte */
#define EXAMPLE_FLEXSPI_AMBA_BASE               FlexSPI_AMBA_BASE
#define FLASH_PAGE_SIZE                         ( 256 )
#define SECTOR_SIZE                             ( 0x1000 ) /* 4K */
#define FLEXSPI_BASE_ADDRESS_MASK               ( FLASH_SIZE_KB * 0x400 - 1 )

#define NOR_CMD_LUT_SEQ_IDX_READ_FAST_QUAD      0 /* set it to index0 to align with xip settings */
#define NOR_CMD_LUT_SEQ_IDX_WRITEENABLE         2
#define NOR_CMD_LUT_SEQ_IDX_ERASESECTOR         3
#define NOR_CMD_LUT_SEQ_IDX_PAGEPROGRAM_QUAD    4
#define NOR_CMD_LUT_SEQ_IDX_ERASECHIP           5
#define NOR_CMD_LUT_SEQ_IDX_WRITESTATUSREG      9
#define NOR_CMD_LUT_SEQ_IDX_READSTATUSREG       12

#define CUSTOM_LUT_LENGTH                       60
#define FLASH_BUSY_STATUS_POL                   1
#define FLASH_BUSY_STATUS_OFFSET                0

/*${macro:end}*/

/*******************************************************************************
 * Prototypes
 ******************************************************************************/
/*${prototype:start}*/
void BOARD_InitHardware( void );
static inline void flexspi_clock_init( void )
{
#if defined( XIP_EXTERNAL_FLASH ) && ( XIP_EXTERNAL_FLASH == 1 )
    CLOCK_SetMux( kCLOCK_FlexspiMux, 0x2 ); /* Choose PLL2 PFD2 clock as flexspi source clock. 396M */
    CLOCK_SetDiv( kCLOCK_FlexspiDiv, 2 );   /* flexspi clock 133M. */
#else
    const clock_usb_pll_config_t g_ccmConfigUsbPll = { .loopDivider = 0U };
    CLOCK_InitUsb1Pll( &g_ccmConfigUsbPll );
    CLOCK_InitUsb1Pfd( kCLOCK_Pfd0, 24 );   /* Set PLL3 PFD0 clock 360MHZ. */
    CLOCK_SetMux( kCLOCK_FlexspiMux, 0x3 ); /* Choose PLL3 PFD0 clock as flexspi source clock. */
    CLOCK_SetDiv( kCLOCK_FlexspiDiv, 2 );   /* flexspi clock 120M. */
#endif
}

status_t sfw_flash_erase( uint32_t address,
                          size_t len );
status_t sfw_flash_write( uint32_t dstAddr,
                          const void * src,
                          size_t len );
status_t sfw_flash_read( uint32_t dstAddr,
                         void * buf,
                         size_t len );
status_t sfw_flash_init( void );
status_t sfw_flash_read_ipc( uint32_t address,
                             uint8_t * buffer,
                             uint32_t length );
status_t flexspi_nor_flash_erase_sector( FLEXSPI_Type * base,
                                         uint32_t address );
status_t flexspi_nor_flash_page_program( FLEXSPI_Type * base,
                                         uint32_t dstAddr,
                                         const uint32_t * src,
                                         size_t len );

/*${prototype:end}*/

#endif /* _FLEXSPI_FLASH_H_ */