/* Copyright Statement:
 *
 * This software/firmware and related documentation ("AutoChips Software") are
 * protected under relevant copyright laws. The information contained herein is
 * confidential and proprietary to AutoChips Inc. and/or its licensors. Without
 * the prior written permission of AutoChips inc. and/or its licensors, any
 * reproduction, modification, use or disclosure of AutoChips Software, and
 * information contained herein, in whole or in part, shall be strictly
 * prohibited.
 *
 * AutoChips Inc. (C) 2023. All rights reserved.
 *
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("AUTOCHIPS SOFTWARE")
 * RECEIVED FROM AUTOCHIPS AND/OR ITS REPRESENTATIVES ARE PROVIDED TO RECEIVER
 * ON AN "AS-IS" BASIS ONLY. AUTOCHIPS EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
 * NONINFRINGEMENT. NEITHER DOES AUTOCHIPS PROVIDE ANY WARRANTY WHATSOEVER WITH
 * RESPECT TO THE SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY,
 * INCORPORATED IN, OR SUPPLIED WITH THE AUTOCHIPS SOFTWARE, AND RECEIVER AGREES
 * TO LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO.
 * RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO
 * OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN AUTOCHIPS
 * SOFTWARE. AUTOCHIPS SHALL ALSO NOT BE RESPONSIBLE FOR ANY AUTOCHIPS SOFTWARE
 * RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND AUTOCHIPS'S
 * ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO THE AUTOCHIPS SOFTWARE
 * RELEASED HEREUNDER WILL BE, AT AUTOCHIPS'S OPTION, TO REVISE OR REPLACE THE
 * AUTOCHIPS SOFTWARE AT ISSUE, OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE
 * CHARGE PAID BY RECEIVER TO AUTOCHIPS FOR SUCH AUTOCHIPS SOFTWARE AT ISSUE.
 */
/******************************************************************************
* @version: V1.0.0 demo
******************************************************************************/

/*!
 *Routine Description:
 *
 *1.
 *
 */

/*!
 * @file main.c
 *
 * @brief This file is main.c.
 *
 */

/* ===========================================  Includes  =========================================== */
#include "ac7803x_eflash.h"

/* ============================================  Define  ============================================ */

/* ===========================================  Typedef  ============================================ */
typedef struct{
    EFLASH_StatusType   (*eFlash_Unlock) (void);
    EFLASH_StatusType   (*eFlash_ErasePage) (uint32_t addr);
    EFLASH_StatusType   (*eFlash_Program) (uint32_t addr, uint32_t *data, uint32_t size);
    void                (*eFlash_Read) (uint32_t addr, uint32_t size, uint32_t *data);
    void                (*eFlash_Lock) (void);
}FlashOptInfo;
/* ==========================================  Variables  =========================================== */
void eFlash_Lock(void);
EFLASH_StatusType eFlash_Unlock(void);
void eFlash_Read(uint32_t addr, uint32_t size, uint32_t *data);
EFLASH_StatusType eFlash_ErasePage(uint32_t addr);
EFLASH_StatusType eFlash_Program(uint32_t addr, uint32_t *data, uint32_t size);

const FlashOptInfo g_flashOptinfo ={
    &eFlash_Unlock,
    &eFlash_ErasePage,
    &eFlash_Program,
    &eFlash_Read,
    &eFlash_Lock,
};

/* ====================================  Functions declaration  ===================================== */

/* ======================================  Functions define  ======================================== */



/*!
 * @brief eFlash_Unlock
 *        This Function is Unlock the eflash controller.
 *
 * @param[in] none
 * @return operation status
 *        - EFLASH_STATUS_SUCCESS: Operation was successful
 *        - EFLASH_STATUS_ERROR:   Operation was failure
 */
EFLASH_StatusType eFlash_Unlock(void)
{
    EFLASH_StatusType ret = EFLASH_STATUS_ERROR;
    ret = EFLASH_UnlockCtrl();
    return ret;
}

/*!
 * @brief eFlash_ErasePage
 *        This function is used to erase one page of Flash.
 *
 * @param[in] addr: Specified eflash addrees to be erased
 * @return operation status
 *        - EFLASH_STATUS_SUCCESS: Operation was successful
 *        - EFLASH_STATUS_ERROR:   Operation was failure
 */
EFLASH_StatusType eFlash_ErasePage(uint32_t addr)
{
    EFLASH_StatusType ret = EFLASH_STATUS_ERROR;
    ret = EFLASH_PageErase(addr);
    return ret;
}

/*!
 * @brief eFlash_Program
 *        This function is used to erase one page of Flash.
 *
 * @param[in] addr: eflash addrees to be programed (should be 4-aligned)
 * @param[in] buffer: Point to the data to be programed
 * @param[in] len: Data length to be programed (the unit is word)
 *
 * @return operation status
 *        - EFLASH_STATUS_SUCCESS: Operation was successful
 *        - EFLASH_STATUS_ERROR:   Operation was failure
 */
EFLASH_StatusType eFlash_Program(uint32_t addr, uint32_t *data, uint32_t size)
{
    EFLASH_StatusType ret = EFLASH_STATUS_ERROR;
    ret = EFLASH_PageProgram(addr, data, size);
    return ret;
}

/*!
 * @brief eFlash_Read
 *        This function is used to read Flash data
 *
 * @param[in] addr: eflash address
 * @param[in] buffer: Point to the data bufffer for saving the read data
 * @param[in] len: read length(the unit is word)
 *
 * @return none
 */
void eFlash_Read(uint32_t addr, uint32_t size, uint32_t *data)
{
    EFLASH_Read(addr, data, size);
}

/*!
 * @brief eFlash_Lock
 *        This function is Lock the eflash controller.
 *
 * @param[in] none
 *
 * @return none
 */
void eFlash_Lock(void)
{
    EFLASH_LockCtrl();
}

/* =============================================  EOF  ============================================== */
