mirror of https://github.com/ARMmbed/mbed-os.git
67 lines
2.4 KiB
C++
67 lines
2.4 KiB
C++
/* mbed Microcontroller Library
|
|
* Copyright (c) 2017 ARM Limited
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*/
|
|
#ifndef KERNEL_H
|
|
#define KERNEL_H
|
|
|
|
#include <stdint.h>
|
|
#include "cmsis_os2.h"
|
|
|
|
namespace rtos {
|
|
/** \addtogroup rtos */
|
|
/** @{*/
|
|
|
|
/** Functions in the Kernel namespace control RTOS kernel information. */
|
|
namespace Kernel {
|
|
|
|
/** Read the current RTOS kernel millisecond tick count.
|
|
The tick count corresponds to the tick count the RTOS uses for timing
|
|
purposes. It increments monotonically from 0 at boot, so it effectively
|
|
never wraps. If the underlying RTOS only provides a 32-bit tick count,
|
|
this method expands it to 64 bits.
|
|
@return RTOS kernel current tick count
|
|
@note Mbed OS always uses millisecond RTOS ticks, and this could only wrap
|
|
after half a billion years.
|
|
@note You cannot call this function from ISR context.
|
|
*/
|
|
uint64_t get_ms_count();
|
|
|
|
/** Attach a function to be called by the RTOS idle task.
|
|
@param fptr pointer to the function to be called
|
|
|
|
@note You may call this function from ISR context.
|
|
*/
|
|
void attach_idle_hook(void (*fptr)(void));
|
|
|
|
/** Attach a function to be called when a thread terminates.
|
|
@param fptr pointer to the function to be called
|
|
|
|
@note You may call this function from ISR context.
|
|
*/
|
|
void attach_thread_terminate_hook(void (*fptr)(osThreadId_t id));
|
|
|
|
} // namespace Kernel
|
|
|
|
} // namespace rtos
|
|
#endif
|
|
|
|
/** @}*/
|