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

/*
 * Copyright (C) 20222 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_FLASH_ARBIT_H_
#define _DRIVER_CHIP_HAL_FLASH_ARBIT_H_

#include "stdint.h"
typedef enum {
	FLASH_ARBIT_YES = 0,       /* flash allow to option */
	FLASH_ARBIT_NO = -1,       /* flash forbit to option */
	FLASH_ARBIT_WAIT = -2,     /* flash wait for option */
	FLASH_ARBIT_TIMEOUT = -3,  /* flash wait timeout */
} Flash_Arbit_Res;
/**
  * @brief Register flash arbit funcion which will be called before flash option.
  *
  * @param *func: callback function.
  *
  * @retval HAL_Status: The status of driver
  */
int HAL_Flash_RgstArbitFunc(Flash_Arbit_Res(*func)(uint32_t));
/**
  * @brief UnRegister flash arbit funcion which will be called before flash option.
  *
  */
void HAL_Flash_UnRgstArbitFunc(Flash_Arbit_Res(*func)(uint32_t));
/**
  * @brief Notify flash arbit again if flash is waitting for option.
  *
  */
void HAL_Flash_ArbitNotify(void);

#endif