Dallas Semiconductor DS80C400 C Libraries Home Page

Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

tini_rtc.h File Reference


Detailed Description

RTC function library.

This library contains RTC functions for the DS1672U, the real time clock included in the TINIm400 reference module.

For detailed information on the DS1672U, please see the Low-Voltage Serial Timekeeping Chip.

Warning:
The functions in this library are NOT multi-process safe--that is, if you call the same method from two different processes at the same time, the parameters to the function may be destroyed, yielding unpredictable results.

Go to the source code of this file.

Defines

#define DEVICE_ADDRESS   0xD0
#define COUNTER_ADDRESS   0x00
#define CONTROL_ADDRESS   0x04
#define TRICKLECHARGER_ADDRESS   0x05
#define TRICKLECHARGER_DISABLE   0xF0
#define START_CLOCK   0x7F
#define STOP_CLOCK   0x80
#define NODIODE_250OHM   0xA5
#define ONEDIODE_250OHM   0xA9
#define NODIODE_2KOHM   0xA6
#define ONEDIODE_2KOHM   0xAA
#define NODIODE_4KOHM   0xA7
#define ONEDIODE_4KOHM   0xAB
#define TINI_RTC_VERSION   1

Functions

int rtc_version ()
 Return the library version.
int rtc_startclock ()
 Start oscillator to count clock by setting MSB of control register to 0.
int rtc_stopclock ()
 Stop oscillator to pause clock by setting MSB of control register to 1.
int rtc_setcontrolregister (unsigned char newvalue)
 Write value to 8 bit control register.
int rtc_getcontrolregister (unsigned char *)
 Fetch value of 8 bit control register.
int rtc_disabletricklecharger ()
 Disable trickle charger register by setting 4 LSB's to 0.
int rtc_enabletricklecharger0diode250ohm ()
 Set trickle charger register to work no diode and with 250ohm.
int rtc_enabletricklecharger1diode250ohm ()
 Set trickle charger register to work 1 diode and with 250ohm.
int rtc_enabletricklecharger0diode2kohm ()
 Set trickle charger register to work no diode and with 2Kohm.
int rtc_enabletricklecharger1diode2kohm ()
 Set trickle charger register to work 1 diode and with 2Kohm.
int rtc_enabletricklecharger0diode4kohm ()
 Set trickle charger register to work no diode and with 4Kohm.
int rtc_enabletricklecharger1diode4kohm ()
 Set trickle charger register to work 1 diode and with 4Kohm.
int rtc_settricklechargerregister (unsigned char newvalue)
 Set trickle charger register new value.
int rtc_gettricklechargerregister (unsigned char *)
 Fetch 8 bit trickle charger register content.
int rtc_getclock (long *)
 Convert char array to long integer after fetch from 32 bit counter of RTC.
int rtc_setclock (long newvalue)
 Convert long integer to char array and write to 32 bit counter of RTC.


Define Documentation

#define CONTROL_ADDRESS   0x04
 

Address of Control register.

See also:
rtc_setcontrolregister

rtc_getcontrolregister

#define COUNTER_ADDRESS   0x00
 

Starting address of 32 bits RTC counter.

See also:
rtc_getclock

rtc_setclock

#define DEVICE_ADDRESS   0xD0
 

Device address.

#define NODIODE_250OHM   0xA5
 

Value of Trickle Charger register that connects Vcc & Vbackup via no diode and 250 ohm resistor when Trickle Charger is enabled .

See also:
rtc_enabletricklecharger0diode250ohm

#define NODIODE_2KOHM   0xA6
 

Value of Trickle Charger register that connects Vcc & Vbackup via no diode and 2K ohm resistor when Trickle Charger is enabled .

See also:
rtc_enabletricklecharger0diode2kohm

#define NODIODE_4KOHM   0xA7
 

Value of Trickle Charger register that connects Vcc & Vbackup via no diode and 4K ohm resistor when Trickle Charger is enabled .

See also:
rtc_enabletricklecharger0diode4kohm

#define ONEDIODE_250OHM   0xA9
 

Value of Trickle Charger register that connects Vcc & Vbackup via one diode and 250 ohm resistor when Trickle Charger is enabled .

See also:
rtc_enabletricklecharger1diode250ohm

#define ONEDIODE_2KOHM   0xAA
 

Value of Trickle Charger register that connects Vcc & Vbackup via one diode and 2K ohm resistor when Trickle Charger is enabled .

See also:
rtc_enabletricklecharger1diode2kohm

#define ONEDIODE_4KOHM   0xAB
 

Value of Trickle Charger register that connects Vcc & Vbackup via one diode and 4K ohm resistor when Trickle Charger is enabled .

See also:
rtc_enabletricklecharger1diode4kohm

#define START_CLOCK   0x7F
 

Value of Control register that will start oscillator.

See also:
rtc_startclock

#define STOP_CLOCK   0x80
 

Value of Control register that will stop oscillator.

See also:
rtc_startclock

#define TINI_RTC_VERSION   1
 

Version number associated with this header file. Should be the same as the version number returned by the rtc_version function.

See also:
rtc_version

#define TRICKLECHARGER_ADDRESS   0x05
 

Address of Trickle Charger register.

See also:
rtc_gettricklechargerregister

rtc_settricklechargerregister

#define TRICKLECHARGER_DISABLE   0xF0
 

Value of Trickle Charger register that will disable it.

See also:
rtc_disabletricklecharger


Function Documentation

int rtc_disabletricklecharger  ) 
 

Disable trickle charger register by setting 4 LSB's to 0.

Returns:
0 if pass, -1 if fail
See also:
rtc_enabletricklecharger0diode250ohm

int rtc_enabletricklecharger0diode250ohm  ) 
 

Set trickle charger register to work no diode and with 250ohm.

Returns:
0 if pass, -1 if fail
See also:
rtc_disabletricklecharger

rtc_enabletricklecharger1diode250ohm

int rtc_enabletricklecharger0diode2kohm  ) 
 

Set trickle charger register to work no diode and with 2Kohm.

Returns:
0 if pass, -1 if fail
See also:
rtc_disabletricklecharger

rtc_enabletricklecharger1diode2kohm

int rtc_enabletricklecharger0diode4kohm  ) 
 

Set trickle charger register to work no diode and with 4Kohm.

Returns:
0 if pass, -1 if fail
See also:
rtc_disabletricklecharger

rtc_enabletricklecharger1diode4kohm

int rtc_enabletricklecharger1diode250ohm  ) 
 

Set trickle charger register to work 1 diode and with 250ohm.

Returns:
0 if pass, -1 if fail
See also:
rtc_disabletricklecharger

rtc_enabletricklecharger0diode2kohm

int rtc_enabletricklecharger1diode2kohm  ) 
 

Set trickle charger register to work 1 diode and with 2Kohm.

Returns:
0 if pass, -1 if fail
See also:
rtc_disabletricklecharger

rtc_enabletricklecharger0diode4kohm

int rtc_enabletricklecharger1diode4kohm  ) 
 

Set trickle charger register to work 1 diode and with 4Kohm.

Returns:
0 if pass, -1 if fail
See also:
rtc_disabletricklecharger

rtc_enabletricklecharger0diode250ohm

int rtc_getclock long *   ) 
 

Convert char array to long integer after fetch from 32 bit counter of RTC.

Returns:
0 if pass, -1 if fail
See also:
rtc_setclock

int rtc_getcontrolregister unsigned char *   ) 
 

Fetch value of 8 bit control register.

Returns:
0 if pass, -1 if fail
See also:
rtc_setcontrolregister

int rtc_gettricklechargerregister unsigned char *   ) 
 

Fetch 8 bit trickle charger register content.

Returns:
0 if pass, -1 if fail
See also:
rtc_settricklechargerregister

int rtc_setclock long  newvalue  ) 
 

Convert long integer to char array and write to 32 bit counter of RTC.

Parameters:
newvalue Value in long integer.
Returns:
0 if pass, -1 if fail
See also:
rtc_getclock

int rtc_setcontrolregister unsigned char  newvalue  ) 
 

Write value to 8 bit control register.

Parameters:
newvalue Value to set.
Returns:
0 if pass, -1 if fail
See also:
rtc_getcontrolregister

int rtc_settricklechargerregister unsigned char  newvalue  ) 
 

Set trickle charger register new value.

Parameters:
newvalue Value to set
Returns:
0 if pass, -1 if fail
See also:
rtc_gettricklechargerregister

int rtc_startclock  ) 
 

Start oscillator to count clock by setting MSB of control register to 0.

Returns:
RTC version.
See also:
rtc_stopclock

int rtc_stopclock  ) 
 

Stop oscillator to pause clock by setting MSB of control register to 1.

Returns:
0 if pass, -1 if fail
See also:
rtc_startclock

int rtc_version  ) 
 

Return the library version.

See also:
rtc_startclock


Copyright 2005 Dallas Semiconductor, Inc.. Documentation generated by Doxygen.