zephyr/kernel/nanokernel/idle.c
Anas Nashif 275ca60b08 Fixed file description and applied doxygen style
Removed old style file description and documnetation and apply
doxygen synatx.

Change-Id: I3ac9f06d4f574bf3c79c6f6044cec3a7e2f6e4c8
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:58 -05:00

50 lines
1.2 KiB
C

/*
* Copyright (c) 2011-2014 Wind River Systems, Inc.
*
* 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.
*/
/**
* @file
* @brief Nanokernel idle support
*
* This module provides routines to set the idle field in the nanokernel
* data structure.
*/
#ifdef CONFIG_ADVANCED_POWER_MANAGEMENT
#include <nanokernel.h>
#include <nano_private.h>
#include <toolchain.h>
#include <sections.h>
/**
*
* @brief Indicate that nanokernel is idling in tickless mode
*
* Sets the nanokernel data structure idle field to a non-zero value.
*
* @param ticks the number of ticks to idle
*
* @return N/A
*/
void nano_cpu_set_idle(int32_t ticks)
{
extern tNANO _nanokernel;
_nanokernel.idle = ticks;
}
#endif /* CONFIG_ADVANCED_POWER_MANAGEMENT */