los_tickless.h

浏览该文件的文档。
00001 /*----------------------------------------------------------------------------
00002  * Copyright (c) <2013-2015>, <Huawei Technologies Co., Ltd>
00003  * All rights reserved.
00004  * Redistribution and use in source and binary forms, with or without modification,
00005  * are permitted provided that the following conditions are met:
00006  * 1. Redistributions of source code must retain the above copyright notice, this list of
00007  * conditions and the following disclaimer.
00008  * 2. Redistributions in binary form must reproduce the above copyright notice, this list
00009  * of conditions and the following disclaimer in the documentation and/or other materials
00010  * provided with the distribution.
00011  * 3. Neither the name of the copyright holder nor the names of its contributors may be used
00012  * to endorse or promote products derived from this software without specific prior written
00013  * permission.
00014  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00015  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
00016  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00017  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
00018  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00019  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00020  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
00021  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
00022  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
00023  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
00024  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00025  *---------------------------------------------------------------------------*/
00026 /*----------------------------------------------------------------------------
00027  * Notice of Export Control Law
00028  * ===============================================
00029  * Huawei LiteOS may be subject to applicable export control laws and regulations, which might
00030  * include those applicable to Huawei LiteOS of U.S. and the country in which you are located.
00031  * Import, export and usage of Huawei LiteOS in any manner by you shall be in compliance with such
00032  * applicable export control laws and regulations.
00033  *---------------------------------------------------------------------------*/
00034 
00035  /**@defgroup los_tickless Tickless
00036  * @ingroup kernel
00037  */
00038 
00039 #ifndef _LOS_TICKLESS_H
00040 #define _LOS_TICKLESS_H
00041 
00042 #ifdef __cplusplus
00043 #if __cplusplus
00044 extern "C" {
00045 #endif /* __cplusplus */
00046 #endif /* __cplusplus */
00047 
00048 /**
00049  * @ingroup  los_tickless
00050  * @brief enable the tickless mode.
00051  *
00052  * @par Description:
00053  * This API is used to enable the tickless mode. System can change from periodic clock mode to dynamic clock mode.
00054  *
00055  * @attention
00056  * <ul>
00057  * </ul>
00058  *
00059  * @param  None.
00060  *
00061  * @retval None.
00062  * @par Dependency:
00063  * <ul><li>los_tickless.h: the header file that contains the API declaration.</li></ul>
00064  * @see LOS_TicklessDisable
00065  * @since Huawei LiteOS V200R001C00
00066  */
00067 extern VOID LOS_TicklessEnable(VOID);
00068 /**
00069  * @ingroup  los_tickless
00070  * @brief disable the tickless mode.
00071  *
00072  * @par Description:
00073  * This API is used to diable the tickless mode. System will not change from periodic clock mode to dynamic clock mode.
00074  *
00075  * @attention
00076  * <ul>
00077  * </ul>
00078  *
00079  * @param  None.
00080  *
00081  * @retval None.
00082  * @par Dependency:
00083  * <ul><li>los_tickless.h: the header file that contains the API declaration.</li></ul>
00084  * @see LOS_TicklessEnable
00085  * @since Huawei LiteOS V200R001C00
00086  */
00087 extern VOID LOS_TicklessDisable(VOID);
00088 
00089 #ifdef __cplusplus
00090 #if __cplusplus
00091 }
00092 #endif /* __cplusplus */
00093 #endif /* __cplusplus */
00094 
00095 #endif