sdk-ameba-v4.0c_180328/component/common/mbed/hal_ext/sys_api.h
2019-04-02 16:34:25 +08:00

133 lines
3.2 KiB
C
Executable file

/** mbed Microcontroller Library
******************************************************************************
* @file sys_api.h
* @author
* @version V1.0.0
* @brief This file provides following mbed system API:
* -JTAG OFF
* -LOGUART ON/OFF
* -OTA image switch
* -System Reset
******************************************************************************
* @attention
*
* Copyright (c) 2006-2013 ARM Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
******************************************************************************
*/
#ifndef MBED_SYS_API_H
#define MBED_SYS_API_H
#include "device.h"
#ifdef __cplusplus
extern "C" {
#endif
/** @addtogroup sys SYSTEM
* @ingroup hal
* @brief system functions
* @{
*/
///@name Ameba Common
///@{
/**
* @brief Turn off the JTAG function
* @retval none
*/
void sys_jtag_off(void);
/**
* @brief switch OTA image if the othe OTA image is valid
* @retval none
* @note for AmebaZ, sys_clear_ota_signature is the same with sys_recover_ota_signature
*/
void sys_clear_ota_signature(void);
/**
* @brief switch OTA image if the othe OTA image is valid
* @retval none
* @note for AmebaZ, sys_clear_ota_signature is the same with sys_recover_ota_signature
*/
void sys_recover_ota_signature(void);
/**
* @brief open log uart
* @retval none
*/
void sys_log_uart_on(void);
/**
* @brief close log uart
* @retval none
*/
void sys_log_uart_off(void);
/**
* @brief store or load adc calibration parameter
* @param write: this parameter can be one of the following values:
* @arg 0: load adc calibration parameter offset & gain from flash system data region
* @arg 1: store adc calibration parameter offset & gain to flash system data region
* @param offset: pointer to adc parameter offset
* @param gain: pointer to adc parameter gain
* @retval none
*/
void sys_adc_calibration(u8 write, u16 *offset, u16 *gain);
/**
* @brief system software reset
* @retval none
*/
void sys_reset(void);
///@}
#if CONFIG_PLATFORM_8195A
///@name Ameba1 Only
///@{
/**
* @brief check whether is sdram power on
* @retval 1: power on
* 0: power off
*/
u8 sys_is_sdram_power_on(void);
/**
* @brief sdram power off
* @retval none
*/
void sys_sdram_off(void);
///@}
#endif //CONFIG_PLATFORM_8195A
#if CONFIG_PLATFORM_8711B
///@name AmebaZ Only
///@{
/**
* @brief vector reset
* @retval none
*/
void sys_cpu_reset(void);
///@}
#endif //CONFIG_PLATFORM_8711B
/*\@}*/
#ifdef __cplusplus
}
#endif
#endif