rtos_idle.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2012 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef RTOS_IDLE_H
00023 #define RTOS_IDLE_H
00024 
00025 #include "mbed_toolchain.h"
00026 
00027 #ifdef __cplusplus
00028 extern "C" {
00029 #endif
00030 
00031 /** \addtogroup rtos-internal-api */
00032 /** @{*/
00033 
00034 /**
00035  * \defgroup rtos_Idle Idle hook function
00036  * @{
00037  */
00038 /**
00039  @note
00040  Sets the hook function called by idle task
00041  @param fptr Hook function pointer.
00042  */
00043 void rtos_attach_idle_hook (void (*fptr)(void));
00044 
00045 /** @private */
00046 MBED_NORETURN void rtos_idle_loop(void);
00047 
00048 /** @}*/
00049 /** @}*/
00050 
00051 #ifdef __cplusplus
00052 }
00053 #endif
00054 
00055 #endif