/*
 * Copyright (c) 2019-2023 Beijing Hanwei Innovation Technology Ltd. Co. and
 * its subsidiaries and affiliates (collectly called MKSEMI).
 *
 * 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, except as embedded into an MKSEMI
 *    integrated circuit in a product or a software update for such product,
 *    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 MKSEMI nor the names of its contributors may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 *    MKSEMI integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be
 *    reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY MKSEMI "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL MKSEMI 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 MK_SBL_H_
#define MK_SBL_H_

#include "mk_common.h"

#define SBL_SIZE (0x3000)
#define IMAGE_FLAG_ADDR (FLASH_BASE + SBL_SIZE)

#define IMAGE_FLAG_SIZE (0x1000)
#define IMAGE1_LOAD_ADDR (IMAGE_FLAG_ADDR + IMAGE_FLAG_SIZE)

#define IMAGE1_MAX_SIZE (0x20000)
#define IMAGE2_LOAD_ADDR (IMAGE1_LOAD_ADDR + IMAGE1_MAX_SIZE)

typedef void reset_handler_t(void);

#ifdef __cplusplus
extern "C" {
#endif

/*
 * @brief  Check whether there is a valid image at the specified address
 * @param[in] img_addr      Image address
 * @param[inout] img_cp_len Pointer to length of image, input NULL if unused
 * @param[inout] sp         Pointer to MSP of image, input NULL if unused
 * @param[inout] entry      Pointer to entry of image, input NULL if unused
 * @return 0: successful
 */
int sbl_check_image(uint32_t img_addr, uint32_t *img_cp_len, uint32_t *sp, uint32_t *entry);

/*
 * @brief  Get the address where the activated image is located
 * @return address of actived image
 */
uint32_t sbl_get_active_image(void);

/*
 * @brief  Set the address of the activated image
 * @param[in] img           Image address
 * @return none
 */
void sbl_set_active_image(uint32_t img);

/*
 * @brief  Get the address where the OTA image is stored
 * @return Address for OTA image
 */
uint32_t sbl_get_addr_for_ota(void);

/*
 * @brief  Main process of the second boot loader
 * @return none
 */
void sbl_main(void);

#ifdef __cplusplus
}
#endif

/**
 * @}
 */

#endif /* MK_GPIO_H_ */