wdt_get_interval(2K)

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | ERRORS

NAME

wdt_get_interval, wdt_get_maxinterval, wdt_get_mininterval, wdt_set_interval- timeout intervals of a watchdog timer

SYNOPSIS

#include <cx/wdt.h>

int wdt_get_interval(wdt_handle_t handle, timespec_t * interval);
int wdt_get_maxinterval(wdt_handle_t handle, timespec_t * maxinterval);
int wdt_get_mininterval(wdt_handle_t handle, timespec_t * mininterval);
int wdt_set_interval(wdt_handle_t handle, timespec_t * interval);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

DESCRIPTION

The wdt_get_interval() call returns the timeout interval previously set using wdt_set_interval() , at the memory location pointed to by interval , for the watchdog timer represented by * handle . If no timeout interval is set, then both fields of * interval are filled with zeros.

The wdt_get_maxinterval() call returns the maximum timeout interval allowed for the watchdog timer represented by * handle , at the memory location pointed to by maxinterval .

wdt_get_mininterval() sets the interval after which, if the timer associated with handle has been armed and has not been patted, the action for the timer will be initiated. If both components of *interval are 0, the timer is disabled.

The wdt_set_interval() call sets the timeout interval pointed to by interval to the watchdog timer represented by * handle . If the timer is armed and is later not "patted" within the specified interval, then the action for the timer is initiated.

If the period is lower than than the period returned by wdt_get_mininterval() then this period is set to the min interval permitted.

RETURN VALUES

On successful completion, wdt_get_interval() , wdt_get_maxinterval() , wdt_get_mininterval() , and wdt_set_interval() return 0. Otherwise, these calls return -1 and set errno to indicate one of the following error conditions.

ERRORS

ENXIO

No watchdog timer has been configured.

ENOSYS

The watchdog timer module has not been configured.

EPERM

The caller is not the owner of the watchdog timer.

EBUSY

All watchdog timers are already allocated.

EFAULT

The handle points outside the allocated address space of the actor.

EINVAL

The specified interval is invalid or not supported by the timer.

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | ERRORS