module ti.sysbios.hal.SecondsClock
index URL

Seconds module that uses Clock as its' time base

C synopsis target-domain sourced in ti/sysbios/hal/SecondsClock.xdc
#include <ti/sysbios/hal/SecondsClock.h>
Functions common to all ISeconds modules
UInt32 
SecondsClock_get// Returns number of seconds since 1970 (the Unix epoch)();
UInt32 
SecondsClock_getTime// Fills in a Seconds_Time structure with seconds and nanoseconds elapsed since 1970 (the Unix epoch)(ISeconds_Time *ts);
Void 
SecondsClock_set// Update the real time clock with number of seconds since 1970(UInt32 seconds);
Functions common to all target modules
SecondsClock_Module_getMask// Returns the diagnostics mask for this module, SecondsClock_Module_hasMask// Test whether this module has a diagnostics mask, SecondsClock_Module_heap// The heap from which this module allocates memory, SecondsClock_Module_id// Get this module's unique id, SecondsClock_Module_setMask// Set the diagnostics mask for this module, SecondsClock_Module_startupDone// Test if this module has completed startup
Typedefs
typedef struct
SecondsClock_Time// Structure to hold a time value in seconds plus nanoseconds ...
 
 
struct SecondsClock_Time
index URL

Structure to hold a time value in seconds plus nanoseconds

C synopsis target-domain
typedef struct SecondsClock_Time {
    UInt32 secs;
    // Seconds
    UInt32 nsecs;
    // Nanoseconds
} SecondsClock_Time;
 
 
SecondsClock_get()  // module-wide
index URL

Returns number of seconds since 1970 (the Unix epoch)

C synopsis target-domain
UInt32 SecondsClock_get();
 
DETAILS
The user must call Seconds_set() before making any calls to Seconds_get(), otherwise the value returned by Seconds_get() will be meaningless.
 
SecondsClock_getTime()  // module-wide
index URL

Fills in a Seconds_Time structure with seconds and nanoseconds elapsed since 1970 (the Unix epoch)

C synopsis target-domain
UInt32 SecondsClock_getTime(ISeconds_Time *ts);
 
DETAILS
Seconds_set() must have been called before making any calls to Seconds_getTime(), otherwise the value returned by Seconds_getTime() will be meaningless.
 
SecondsClock_set()  // module-wide
index URL

Update the real time clock with number of seconds since 1970

C synopsis target-domain
Void SecondsClock_set(UInt32 seconds);
 
DETAILS
Note: This function is non-reentrant.
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId SecondsClock_Module_id();
// Get this module's unique id
 
Bool SecondsClock_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle SecondsClock_Module_heap();
// The heap from which this module allocates memory
 
Bool SecondsClock_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 SecondsClock_Module_getMask();
// Returns the diagnostics mask for this module
 
Void SecondsClock_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
Configuration settings sourced in ti/sysbios/hal/SecondsClock.xdc
var SecondsClock = xdc.useModule('ti.sysbios.hal.SecondsClock');
module-wide constants & types
    var obj = new SecondsClock.Time// Structure to hold a time value in seconds plus nanoseconds;
        obj.secs// Seconds = UInt32  ...
        obj.nsecs// Nanoseconds = UInt32  ...
module-wide config parameters
    SecondsClock.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
struct SecondsClock.Time
index URL

Structure to hold a time value in seconds plus nanoseconds

Configuration settings
var obj = new SecondsClock.Time;
 
    obj.secs = UInt32  ...
    // Seconds
    obj.nsecs = UInt32  ...
    // Nanoseconds
 
C SYNOPSIS
SecondsClock_Time
 
metaonly config SecondsClock.common$  // module-wide
index URL

Common module configuration parameters

Configuration settings
SecondsClock.common$ = Types.Common$ undefined;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
generated on Tue, 09 Oct 2018 20:57:27 GMT