You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
LiteOS-Reading/src/kernel/include/los_tickless.h

99 lines
3.7 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

/* ----------------------------------------------------------------------------
* Copyright (c) Huawei Technologies Co., Ltd. 2013-2019. All rights reserved.
* Description: Tickless
* Author: Huawei LiteOS Team
* Create: 2013-01-01
* 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 the copyright holder 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 HOLDER 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.
* --------------------------------------------------------------------------- */
/*这些代码主要用于开启和关闭 Tickless 模式,提供了 Tickless 相关操作接口和功能。*/
/**
* @defgroup los_tickless Tickless
* @ingroup kernel
*/
#ifndef _LOS_TICKLESS_H
#define _LOS_TICKLESS_H
#include "los_typedef.h"
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */
/**
* @ingroup los_tickless
* @brief enable the tickless mode.
*
* @par Description:
* This API is used to enable the tickless mode. In the mode, system changes from
* periodic clock mode to dynamic clock mode.
*
* @attention
* None.
*
* @param None.
*
* @retval None.
* @par Dependency:
* <ul><li>los_tickless.h: the header file that contains the API declaration.</li></ul>
* @see LOS_TicklessDisable
* @since Huawei LiteOS V200R001C00
*/
extern VOID LOS_TicklessEnable(VOID);
/*这段代码声明了一个函数LOS_TicklessEnable用于启用tickless模式。
LOS_TicklessEnable函数的功能是启用tickless模式。在这种模式下系统从周期性时钟模式切换到动态时钟模式能够有效地减少系统的功耗*/
/**
* @ingroup los_tickless
* @brief disable the tickless mode.
*
* @par Description:
* This API is used to disable the tickless mode. System will not change from
* periodic clock mode to dynamic clock mode.
*
* @attention
* None.
*
* @param None.
*
* @retval None.
* @par Dependency:
* <ul><li>los_tickless.h: the header file that contains the API declaration.</li></ul>
* @see LOS_TicklessEnable
* @since Huawei LiteOS V200R001C00
*/
extern VOID LOS_TicklessDisable(VOID);
/*这段代码声明了一个函数LOS_TicklessDisable用于禁用tickless模式。
LOS_TicklessDisable函数的功能是禁用tickless模式。在这种模式下系统从动态时钟模式切换回周期性时钟模式系统将会以固定的时间间隔来产生时钟中断。*/
#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */
#endif