Kernel.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2017 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 KERNEL_H
00023 #define KERNEL_H
00024 
00025 #include <stdint.h>
00026 #include "cmsis_os2.h"
00027 
00028 namespace rtos {
00029 /** \addtogroup rtos */
00030 /** @{*/
00031 
00032 /** Functions in the Kernel namespace control RTOS kernel information. */
00033 namespace Kernel {
00034 
00035 /** Read the current RTOS kernel millisecond tick count.
00036      The tick count corresponds to the tick count the RTOS uses for timing
00037      purposes. It increments monotonically from 0 at boot, so it effectively
00038      never wraps. If the underlying RTOS only provides a 32-bit tick count,
00039      this method expands it to 64 bits.
00040      @return  RTOS kernel current tick count
00041      @note Mbed OS always uses millisecond RTOS ticks, and this could only wrap
00042            after half a billion years.
00043      @note You cannot call this function from ISR context.
00044  */
00045 uint64_t get_ms_count();
00046 
00047 /** Attach a function to be called by the RTOS idle task.
00048   @param   fptr pointer to the function to be called
00049 
00050   @note You may call this function from ISR context.
00051 */
00052 void attach_idle_hook(void (*fptr)(void));
00053 
00054 /** Attach a function to be called when a thread terminates.
00055   @param   fptr pointer to the function to be called
00056 
00057   @note You may call this function from ISR context.
00058 */
00059 void attach_thread_terminate_hook(void (*fptr)(osThreadId_t id));
00060 
00061 } // namespace Kernel
00062 
00063 } // namespace rtos
00064 #endif
00065 
00066 /** @}*/