osal_timer.h

Overview

Related Modules:

OSAL

Description:

Declares timer types and interfaces.

Since:

1.0

Version:

1.0

Summary

Data Structures

Data Structure Name

Description

OsalTimer

Describes a timer.

Macros

Macro Name and Value

Description

OSAL_DECLARE_TIMER(timer)   OsalTimer timer

Defines a timer macro.

Typedefs

Typedef Name

Description

OsalTimerFunc) (uintptr_t arg)

typedef void(* 

Describes a timer execution function type.

Functions

Function Name

Description

OsalTimerCreate (OsalTimer timer, uint32_t interval, OsalTimerFunc func, uintptr_t arg)

int32_t 

Creates a timer.

OsalTimerDelete (OsalTimer timer)

int32_t 

Deletes a timer.

OsalTimerStartOnce (OsalTimer timer)

int32_t 

Starts a timer.

OsalTimerStartLoop (OsalTimer timer)

int32_t 

Starts a periodic timer.

OsalTimerSetTimeout (OsalTimer *timer, uint32_t interval)

int32_t 

Sets the interval of a timer.