/*
 * 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_EFUSE_H_
#define MK_EFUSE_H_

#include "mk_common.h"

/**
 * @addtogroup MK8000_eFuse
 * @{
 */

#define EFUSE_STATUS_CP_DONE 0x80
#define EFUSE_STATUS_FT_DONE 0x40
#define EFUSE_STATUS_PRGM1_DONE 0x20
#define EFUSE_STATUS_PRGM2_DONE 0x10
#define EFUSE_STATUS_WR_PROTECT 0x01

/** eFuse access mode */
enum EFUSE_ACCESS_MODE_T
{
    EFUSE_LOAD_ALL = 0,
    EFUSE_LOAD_WORD,
    EFUSE_LOAD_BYTE,
    EFUSE_LOAD_BLOCK,
    EFUSE_PROGRAM_BIT,
    EFUSE_PROGRAM_WORD,
    EFUSE_PROGRAM_BYTE,
    EFUSE_PROGRAM_BLOCK,
};

/** Items stored in eFuse */
enum EFUSE_ITEM_T
{
    EFUSE_STATUS = 0x00,
    EFUSE_HS_XTAL_INJ = 0x01,
    EFUSE_RESERVED = 0x44,
};

#define EFUSE_READ_BYTE(x) (*(const volatile uint8_t *)(EFUSE_SHADOW_BASE + x))

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief eFuse open.
 */
int efuse_open(void);

/**
 * @brief eFuse close.
 */
int efuse_close(void);

/**
 * @brief reset eFuse.
 */
void efuse_reset(void);

/**
 * @brief reload eFuse.
 */
void efuse_reload_all(void);

/**
 * @brief read a word from eFuse.
 *
 * @param[in] word_addr             Word address of eFuse
 * @return value read from eFuse
 */
uint32_t efuse_read_word(uint16_t word_addr);

/**
 * @brief read a byte from eFuse.
 *
 * @param[in] byte_addr             Byte address of eFuse
 * @return value read from eFuse
 */
uint8_t efuse_read_byte(uint16_t byte_addr);

/**
 * @brief read a block from eFuse.
 *
 * @param[in] byte_addr_start       Start byte address of a block in eFuse
 * @param[in] len                   Length of block
 * @param[out] buf                  Buffer to store read out data
 */
void efuse_read_block(uint16_t byte_addr_start, uint16_t len, uint8_t *buf);

/**
 * @brief program a word to eFuse.
 *
 * @param[in] word_addr             Word address of eFuse
 * @param[in] data                  Data will be programmed into eFuse
 */
void efuse_program_word(uint16_t word_addr, uint32_t data);

/**
 * @brief program a byte to eFuse.
 *
 * @param[in] byte_addr             Byte address of eFuse
 * @param[in] data                  Data will be programmed into eFuse
 */
void efuse_program_byte(uint16_t byte_addr, uint8_t data);

/**
 * @brief program a bit to eFuse.
 *
 * @param[in] byte_addr             Byte address of eFuse
 * @param[in] bit_offset            Bit offset of a byte to be programmed
 */
void efuse_set_bit(uint16_t byte_addr, uint8_t bit_offset);

#ifdef __cplusplus
}
#endif

/**
 * @}
 */

#endif /* MK_EFUSE_H_ */