Mistake on this page?
Report an issue in GitHub or email us
rtos_idle.h
1 /* mbed Microcontroller Library
2  * Copyright (c) 2006-2012 ARM Limited
3  * SPDX-License-Identifier: MIT
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy
6  * of this software and associated documentation files (the "Software"), to deal
7  * in the Software without restriction, including without limitation the rights
8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9  * copies of the Software, and to permit persons to whom the Software is
10  * furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23 #ifndef RTOS_IDLE_H
24 #define RTOS_IDLE_H
25 
26 #include "mbed_toolchain.h"
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 /** \addtogroup rtos-internal-api */
33 /** @{*/
34 
35 /**
36  * \defgroup rtos_Idle Idle hook function
37  * @{
38  */
39 /**
40  @note
41  Sets the hook function called by idle task
42  @param fptr Hook function pointer.
43  */
44 void rtos_attach_idle_hook(void (*fptr)(void));
45 
46 /** @private */
47 MBED_NORETURN void rtos_idle_loop(void);
48 
49 /** @}*/
50 /** @}*/
51 
52 #ifdef __cplusplus
53 }
54 #endif
55 
56 #endif
#define MBED_NORETURN
MBED_NORETURN Declare a function that will never return.
void rtos_attach_idle_hook(void(*fptr)(void))
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.