/**
 * @file  hal_xip.h
 * @author  XRADIO IOT WLAN Team
 */

/*
 * Copyright (C) 2017 XRADIO TECHNOLOGY CO., LTD. All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the
 *       distribution.
 *    3. Neither the name of XRADIO TECHNOLOGY CO., LTD. nor the names of
 *       its contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _DRIVER_CHIP_HAL_XIP_H_
#define _DRIVER_CHIP_HAL_XIP_H_

#include "sys/param.h"
#include "driver/chip/hal_flashctrl.h"
#include "driver/chip/flashchip/flash_chip.h"

#ifdef __cplusplus
extern "C" {
#endif

extern char __XIP_Base[];
extern char __XIP_End[];
#define FLASH_XIP_START_ADDR                    ((uint32_t)(__XIP_Base))
#define FLASH_XIP_END_ADDR                      (roundup2(((uint32_t)(__XIP_End)+1), 64))
#define FLASH_XIP_END_ADDR_FAKE                 ((uint32_t)(__XIP_End))

#define FLASH_XIP_ALIGN_OFFSET                  0x1000
#define FLASH_XIP_USER_START_ADDR               (roundup2(((uint32_t)(__XIP_End)+65), FLASH_XIP_ALIGN_OFFSET))
#define FLASH_XIP_USER_END_ADDR                 FC_GetXipUserEndAddr()
#define FLASH_XIP_USER_ADDR_STEP                (64) /* must big than read cache line */
#define FLASH_XIP_USER_START_ADDR_FAKE          ((uint32_t)(__XIP_End))

extern char __PSRAM_Base[];
extern char __PSRAM_End[];
extern char __PSRAM_Top[];

#ifdef CONFIG_PSRAM
#define PSRAM_MAPPING_ADDR    ((uint32_t)(CONFIG_PSRAM_START))
#define PSRAM_START_ADDR      ((uint32_t)(__PSRAM_Base))
#define PSRAM_END_ADDR        ((uint32_t)(__PSRAM_Top))
#else
#define PSRAM_START_ADDR      ((uint32_t)(CONFIG_PSRAM_START))
#define PSRAM_END_ADDR        (PSRAM_START_ADDR)
#endif

struct XipDrv;

int HAL_Xip_setCmd(struct XipDrv *xip, InstructionField *cmd,
                   InstructionField *addr, InstructionField *dummy, InstructionField *data);
int HAL_Xip_setDelay(struct XipDrv *xip, Flashc_Delay *delay);
int HAL_Xip_setAddr(struct XipDrv *xip, uint32_t addr);
int HAL_Xip_setContinue(struct XipDrv *xip, uint32_t continueMode, void *arg);

/**
 * @brief Initializes XIP module.
 * @note XIP is a module that cpu can run the code in flash but not ram.
 * @param flash: flash number, this flash must have been initialized, and must
 *               be connected to the flash controller pin.
 * @param xaddr: XIP code start address.
 * @retval HAL_Status: The status of driver
 */
HAL_Status HAL_Xip_Init(uint32_t flash, uint32_t xaddr);

/**
 * @brief Deinitializes XIP module.
 * @retval HAL_Status: The status of driver
 */
HAL_Status HAL_Xip_Deinit(uint32_t flash);

void HAL_Xip_SetDbgMask(uint8_t dbg_mask);

#ifdef __cplusplus
}
#endif

#endif /* _DRIVER_CHIP_HAL_XIP_H_ */