Mistake on this page?
Report an issue in GitHub or email us
Macros | Functions
os_tick.h File Reference

CMSIS OS Tick header file. More...

#include <stdint.h>

Go to the source code of this file.

Macros

#define IRQHANDLER_T
 IRQ Handler. More...
 

Functions

int32_t OS_Tick_Setup (uint32_t freq, IRQHandler_t handler)
 Setup OS Tick timer to generate periodic RTOS Kernel Ticks. More...
 
void OS_Tick_Enable (void)
 Enable OS Tick timer interrupt. More...
 
void OS_Tick_Disable (void)
 Disable OS Tick timer interrupt. More...
 
void OS_Tick_AcknowledgeIRQ (void)
 Acknowledge execution of OS Tick timer interrupt. More...
 
int32_t OS_Tick_GetIRQn (void)
 Get OS Tick timer IRQ number. More...
 
uint32_t OS_Tick_GetClock (void)
 Get OS Tick timer clock frequency. More...
 
uint32_t OS_Tick_GetInterval (void)
 Get OS Tick timer interval reload value. More...
 
uint32_t OS_Tick_GetCount (void)
 Get OS Tick timer counter value. More...
 
uint32_t OS_Tick_GetOverflow (void)
 Get OS Tick timer overflow status. More...
 

Detailed Description

CMSIS OS Tick header file.

Version
V1.0.1
Date
24. November 2017

Definition in file os_tick.h.

Macro Definition Documentation

#define IRQHANDLER_T

IRQ Handler.

Definition at line 32 of file os_tick.h.

Function Documentation

void OS_Tick_AcknowledgeIRQ ( void  )

Acknowledge execution of OS Tick timer interrupt.

void OS_Tick_Disable ( void  )

Disable OS Tick timer interrupt.

void OS_Tick_Enable ( void  )

Enable OS Tick timer interrupt.

uint32_t OS_Tick_GetClock ( void  )

Get OS Tick timer clock frequency.

Returns
OS Tick timer clock frequency in Hz
uint32_t OS_Tick_GetCount ( void  )

Get OS Tick timer counter value.

Returns
OS Tick timer counter value
uint32_t OS_Tick_GetInterval ( void  )

Get OS Tick timer interval reload value.

Returns
OS Tick timer interval reload value
int32_t OS_Tick_GetIRQn ( void  )

Get OS Tick timer IRQ number.

Returns
OS Tick IRQ number
uint32_t OS_Tick_GetOverflow ( void  )

Get OS Tick timer overflow status.

Returns
OS Tick overflow status (1 - overflow, 0 - no overflow).
int32_t OS_Tick_Setup ( uint32_t  freq,
IRQHandler_t  handler 
)

Setup OS Tick timer to generate periodic RTOS Kernel Ticks.

Parameters
[in]freqtick frequency in Hz
[in]handlertick IRQ handler
Returns
0 on success, -1 on error.
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.