@database "battclock"
@master "Work:RKM/Includes&Autodocs/doc/battclock.doc"

@Node Main "battclock.doc"
@toc "2.0Includes_Autodocs/Autodocs"

@{" ReadBattClock() " Link "ReadBattClock()"}
@{" ResetBattClock() " Link "ResetBattClock()"}
@{" WriteBattClock() " Link "WriteBattClock()"}

@EndNode

@Node "ReadBattClock()" "battclock.resource/ReadBattClock"

NAME
    ReadBattClock -- Read time from clock chip.  (V36)

SYNOPSIS
    AmigaTime = ReadBattClock( )

    ULONG ReadBattClock( void );
    D0

FUNCTION
    This routine reads the time from the clock chip and returns it
    as the number of seconds from 01-jan-1978.

INPUTS

RESULTS
    AmigaTime       The number of seconds from 01-Jan-1978 that
                        the clock chip thinks it is.

NOTES
    If the clock chip returns an invalid date, the clock chip is
    reset and 0 is returned.

SEE ALSO

BUGS

@EndNode

@Node "ResetBattClock()" "battclock.resource/ResetBattClock"

NAME
    ResetBattClock -- Reset the clock chip.  (V36)

SYNOPSIS
    ResetBattClock( )

    void ResetBattClock( void );

FUNCTION
    This routine does whatever is neeeded to put the clock chip
    into a working and usable state and also sets the date on the
    clock chip to 01-Jan-1978.

INPUTS

RESULTS

NOTES

SEE ALSO

BUGS

@EndNode

@Node "WriteBattClock()" "battclock.resource/WriteBattClock"

NAME
    WriteBattClock -- Set the time on the clock chip.  (V36)

SYNOPSIS
    WriteBattClock( AmigaTime )
                    D0

    void WriteBattClock( ULONG );

FUNCTION
    This routine writes the time given in AmigaTime to the clock
    chip.

INPUTS
    AmigaTime       The number of seconds from 01-Jan-1978 to the
                        time that should be written to the clock
                        chip.

RESULTS

NOTES

SEE ALSO

BUGS

@EndNode

