os_tick.h File Reference

CMSIS OS Tick header file. More...

#include <stdint.h>

Include dependency graph for os_tick.h:

Go to the source code of this file.

Macros
#define	IRQHANDLER_T
	IRQ Handler.

Typedefs
typedef void(*	IRQHandler_t) (void)

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

Detailed Description

CMSIS OS Tick header file.

Version

V1.0.2

Date

19. March 2021

Definition in file os_tick.h.

Macro Definition Documentation

IRQHANDLER_T

#define IRQHANDLER_T

IRQ Handler.

Definition at line 37 of file os_tick.h.

Typedef Documentation

IRQHandler_t

typedef void(* IRQHandler_t) (void)

Definition at line 38 of file os_tick.h.

Function Documentation

OS_Tick_AcknowledgeIRQ()

void OS_Tick_AcknowledgeIRQ

(

void

)

Acknowledge execution of OS Tick timer interrupt.

OS_Tick_Disable()

void OS_Tick_Disable

(

void

)

Disable OS Tick timer interrupt.

OS_Tick_Enable()

void OS_Tick_Enable

(

void

)

Enable OS Tick timer interrupt.

OS_Tick_GetClock()

uint32_t OS_Tick_GetClock

(

void

)

Get OS Tick timer clock frequency.

Returns

OS Tick timer clock frequency in Hz

OS_Tick_GetCount()

uint32_t OS_Tick_GetCount

(

void

)

Get OS Tick timer counter value.

Returns

OS Tick timer counter value

Definition at line 228 of file cmsis_os2.c.

References SysTick.

OS_Tick_GetInterval()

uint32_t OS_Tick_GetInterval

(

void

)

Get OS Tick timer interval reload value.

Returns

OS Tick timer interval reload value

Definition at line 251 of file cmsis_os2.c.

References SysTick.

OS_Tick_GetIRQn()

int32_t OS_Tick_GetIRQn

(

void

)

Get OS Tick timer IRQ number.

Returns

OS Tick IRQ number

OS_Tick_GetOverflow()

uint32_t OS_Tick_GetOverflow

(

void

)

Get OS Tick timer overflow status.

Returns

OS Tick overflow status (1 - overflow, 0 - no overflow).

Definition at line 239 of file cmsis_os2.c.

References SysTick.

OS_Tick_Setup()

int32_t OS_Tick_Setup	(	uint32_t	freq,
		IRQHandler_t	handler )

Setup OS Tick timer to generate periodic RTOS Kernel Ticks.

Parameters

[in]	freq	tick frequency in Hz
[in]	handler	tick IRQ handler

Returns

0 on success, -1 on error.