Ultibo API
C/C++ API for Ultibo Core
Loading...
Searching...
No Matches
_CLOCK_DEVICE Struct Reference

#include <devices.h>

Data Fields

DEVICE device
 The Device entry for this Clock device.
uint32_t clockid
 Unique Id of this Clock device in the Clock device table.
uint32_t clockstate
 Clock device state (eg CLOCK_STATE_ENABLED).
clock_device_start_proc devicestart
 A device specific DeviceStart method implementing a standard clock device interface (Or nil if the default method is suitable).
clock_device_stop_proc devicestop
 A device specific DeviceStop method implementing a standard clock device interface (Or nil if the default method is suitable).
clock_device_read_proc deviceread
 A device specific DeviceRead method implementing a standard clock device interface (Or nil if the default method is suitable).
clock_device_read64_proc deviceread64
 A device specific DeviceRead64 method implementing a standard clock device interface (Mandatory).
clock_device_write64_proc devicewrite64
 A device specific DeviceWrite64 method implementing a standard clock device interface (Optional).
clock_device_get_rate_proc devicegetrate
 A device specific DeviceGetRate method implementing a standard clock device interface (Or nil if the default method is suitable).
clock_device_set_rate_proc devicesetrate
 A device specific DeviceSetRate method implementing a standard clock device interface (Optional).
clock_device_get_properties_proc devicegetproperties
 A device specific DeviceGetProperties method implementing a standard clock device interface (Or nil if the default method is suitable).
uint32_t readcount
MUTEX_HANDLE lock
 Device lock.
void * address
 Device register base address.
uint32_t rate
 Device rate (Hz).
uint32_t minrate
 Device minimum rate (Hz).
uint32_t maxrate
 Device maximum rate (Hz).
CLOCK_DEVICEprev
 Previous entry in Clock device table.
CLOCK_DEVICEnext
 Next entry in Clock device table.

Detailed Description

Clock Device

Field Documentation

◆ device

DEVICE device

The Device entry for this Clock device.

◆ clockid

uint32_t clockid

Unique Id of this Clock device in the Clock device table.

◆ clockstate

uint32_t clockstate

Clock device state (eg CLOCK_STATE_ENABLED).

◆ devicestart

A device specific DeviceStart method implementing a standard clock device interface (Or nil if the default method is suitable).

◆ devicestop

A device specific DeviceStop method implementing a standard clock device interface (Or nil if the default method is suitable).

◆ deviceread

A device specific DeviceRead method implementing a standard clock device interface (Or nil if the default method is suitable).

◆ deviceread64

A device specific DeviceRead64 method implementing a standard clock device interface (Mandatory).

◆ devicewrite64

A device specific DeviceWrite64 method implementing a standard clock device interface (Optional).

◆ devicegetrate

A device specific DeviceGetRate method implementing a standard clock device interface (Or nil if the default method is suitable).

◆ devicesetrate

A device specific DeviceSetRate method implementing a standard clock device interface (Optional).

◆ devicegetproperties

clock_device_get_properties_proc devicegetproperties

A device specific DeviceGetProperties method implementing a standard clock device interface (Or nil if the default method is suitable).

◆ readcount

uint32_t readcount

◆ lock

Device lock.

◆ address

void* address

Device register base address.

◆ rate

uint32_t rate

Device rate (Hz).

◆ minrate

uint32_t minrate

Device minimum rate (Hz).

◆ maxrate

uint32_t maxrate

Device maximum rate (Hz).

◆ prev

CLOCK_DEVICE* prev

Previous entry in Clock device table.

◆ next

CLOCK_DEVICE* next

Next entry in Clock device table.


The documentation for this struct was generated from the following file: