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 
00027 namespace rtos {
00028 /** \addtogroup rtos */
00029 /** @{*/
00030 
00031 /** Functions in the Kernel namespace control RTOS kernel information. */
00032 namespace Kernel {
00033 
00034 /** Read the current RTOS kernel millisecond tick count.
00035      The tick count corresponds to the tick count used by the RTOS for timing
00036      purposes. It increments monotonically from 0 at boot, hence effectively
00037      never wraps. If the underlying RTOS only provides a 32-bit tick count,
00038      this method expands it to 64 bits.
00039      @return  RTOS kernel current tick count
00040      @note mbed OS always uses millisecond RTOS ticks, and this could only wrap
00041            after half a billion years
00042      @note You cannot call this function from ISR context.
00043  */
00044 uint64_t get_ms_count();
00045 
00046 } // namespace Kernel
00047 
00048 } // namespace rtos
00049 #endif
00050 
00051 /** @}*/