/*
 * Copyright (c) Hisilicon Technologies Co., Ltd. 2012-2020. All rights reserved.
 * Description: The iapi interfaces of spread
 */

#ifndef __UAPI_SPREAD_H__
#define __UAPI_SPREAD_H__

#include "td_type.h"

#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif
#endif /* __cplusplus */

/* ******************************Structure declaration **************************** */
/* * \addtogroup      SPREAD */
/* * @{ */ /* * <!-- [SPREAD] */
/* * @} */ /* * <!-- ==== Structure Definition end ==== */

/* ****************************** API declaration **************************** */
/* * \addtogroup      SPREAD */
/* * @{ */ /* * <!-- [SPREAD] */

/* *
\brief Open/close the ddr spread.
CNcomment:\brief 打开/关闭DDR展频。CNend
\attention \n
N/A
\param[in] enable       ddr spread enable control   CNcomment: DDR展频使能控制 CNend
\retval ::TD_FAILURE    set failure.                CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS    set success.                CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ss_ddr_set_spread(td_bool enable);

/* *
\brief Set the ddr spreadratio.
CNcomment:\brief 设置DDR展频幅度。CNend
\attention \n
The ddr spreadratio range[0-31] 0; 0.1%; 0.2%; 0.3%; 0.4%; 0.5%; 0.6%; 0.7%...3.1%; \n
CNcomment: DDR展频幅度范围[0-31] 0; 0.1%; 0.2%; 0.3%; 0.4%; 0.5%; 0.6%; 0.7%...3.1%;  CNend
\param[in] ratio           ddr spreadratio value      CNcomment: 需设置的展频幅度的值 CNend
\retval ::TD_FAILURE       set failure.               CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS       set success.               CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ss_ddr_set_spread_ratio(td_u32 ratio);
/* *
\brief Set the ddr spreadfrequency.
CNcomment:\brief 设置DDR展频频率。CNend
\attention \n
The ddr spreadfrequency range[2-5] 93KHZ; 62KHZ; 46KHZ; 37KHZ; 31KHZ; \n
CNcomment: DDR展频频率范围[2-5] 93KHZ; 62KHZ; 46KHZ; 37KHZ; 31KHZ; CNend
\param[in] freq           ddr spreadfrequency value  CNcomment: 需设置的展频频率的值 CNend
\retval ::TD_FAILURE      set failure.               CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS      set success.               CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ss_ddr_set_spread_freq(td_u32 freq);

/* *
\briefa Open/close the emmc clock, Undo reset/reset.
CNcomment:\brief 打开/关闭EMMC时钟，撤销复位/复位。CNend
\attention \n
N/A
\param[in] enable       emmc clock/reset enable control   CNcomment: EMMC时钟/复位使能控制 CNend
\retval ::TD_FAILURE    set failure.                      CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS    set success.                      CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ss_emmc_set_clock(td_bool enable);

/* *
\brief Open/close the emmc spread.
CNcomment:\brief 打开/关闭EMMC展频。CNend
\attention \n
N/A
\param[in] enable       emmc spread enable control  CNcomment: EMMC展频使能控制 CNend
\retval ::TD_FAILURE    set failure.                CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS    set success.                CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ss_emmc_set_spread(td_bool enable);

/* *
\brief Set the emmc spreadratio.
CNcomment:\brief 设置EMMC展频幅度。CNend
\attention \n
The emmc spreadratio range[0-31] 0; 0.1%; 0.2%; 0.3%; 0.4%; 0.5%; 0.6%; 0.7%...3.1%; \n
CNcomment: EMMC展频幅度范围[0-31] 0; 0.1%; 0.2%; 0.3%; 0.4%; 0.5%; 0.6%; 0.7%...3.1%; CNend
\param[in] ratio           emmc spreadratio value  CNcomment: 需设置的展频幅度的值 CNend
\retval ::TD_FAILURE       set failure.            CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS       set success.            CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ss_emmc_set_spread_ratio(td_u32 ratio);

/* *
\brief Set the emmc spreadfrequency.
CNcomment:\brief 设置EMMC展频频率。CNend
\attention \n
The emmc spreadfrequency range[2-5] 93KHZ; 62KHZ; 46KHZ; 37KHZ; 31KHZ; \n
CNcomment:EMMC展频频率范围[2-5] 93KHZ; 62KHZ; 46KHZ; 37KHZ; 31KHZ; CNend
\param[in] freq            emmc spreadfrequency value  CNcomment: 需设置的展频频率的值 CNend
\retval ::TD_FAILURE       set failure.                CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS       set success.                CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ss_emmc_set_spread_freq(td_u32 freq);

/* *
\briefa Open/close the gmac clock, Undo reset/reset.
CNcomment:\brief 打开/关闭GMAC时钟，撤销复位/复位。CNend
\attention \n
N/A
\param[in] enable       gmac clock/reset enable control   CNcomment: GMAC时钟/复位使能控制 CNend
\retval ::TD_FAILURE    set failure.                      CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS    set success.                      CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ss_gmac_set_clock(td_bool enable);

/* *
\brief Open/close the gmac spread.
CNcomment:\brief 打开/关闭GMAC展频。CNend
\attention \n
N/A
\param[in] enable       gmac spread enable control  CNcomment: GMAC展频使能控制 CNend
\retval ::TD_FAILURE    set failure.                CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS    set success.                CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ss_gmac_set_spread(td_bool enable);

/* *
\brief Set the gmac spreadratio.
CNcomment:\brief 设置GMAC展频幅度。CNend
\attention \n
The gmac spreadratio range[0-31] 0; 0.1%; 0.2%; 0.3%; 0.4%; 0.5%; 0.6%; 0.7%...3.1%; \n
CNcomment: GMAC展频幅度范围[0-31] 0; 0.1%; 0.2%; 0.3%; 0.4%; 0.5%; 0.6%; 0.7%...3.1%; CNend
\param[in] ratio           gmac spreadratio value  CNcomment: 需设置的展频幅度的值 CNend
\retval ::TD_FAILURE       set failure.            CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS       set success.            CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ss_gmac_set_spread_ratio(td_u32 ratio);

/* *
\brief Set the gmac spreadfrequency.
CNcomment:\brief 设置GMAC展频频率。CNend
\attention \n
The gmac spreadfrequency range[2-5] 93KHZ; 62KHZ; 46KHZ; 37KHZ; 31KHZ; \n
CNcomment: GMAC展频频率范围[2-5] 93KHZ; 62KHZ; 46KHZ; 37KHZ; 31KHZ; CNend
\param[in] freq           gmac spreadfrequency value  CNcomment: 需设置的展频频率的值 CNend
\retval ::TD_FAILURE      set failure.                CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS      set success.                CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ss_gmac_set_spread_freq(td_u32 freq);

/* *
\briefa Open/close the ci clock, Undo reset/reset.
CNcomment:\brief 打开/关闭CI时钟，撤销复位/复位。CNend
\attention \n
N/A
\param[in] enable       ci clock/reset enable control   CNcomment: CI时钟/复位使能控制 CNend
\retval ::TD_FAILURE    set failure.                    CNcomment: 设置失败 CNend
\retval ::TD_SUCCESS    set success.                    CNcomment: 设置成功 CNend
\see \n
N/A
*/
td_s32 uapi_ci_set_clock(td_bool enable);

/* * @} */ /* * <!-- ==== API declaration end ==== */

#ifdef __cplusplus
#if __cplusplus
}
#endif
#endif /* __cplusplus */

#endif /* __UAPI_SPREAD_H__ */