@database "battclock"
@master "AMIDEV:NDK/Autodocs/battclock.doc"

@Node Main "battclock.doc"
@toc "Autodocs/AG/INDEX/Main"
    @{" ReadBattClock() " Link "ReadBattClock()"}
    @{" ResetBattClock() " Link "ResetBattClock()"}
    @{" WriteBattClock() " Link "WriteBattClock()"}
@EndNode

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

@{b}   NAME@{ub}
	ReadBattClock -- @{"Read" Link "dos/Read()"} time from clock chip.  (V36)

@{b}   SYNOPSIS@{ub}
	AmigaTime = ReadBattClock( )

	ULONG ReadBattClock( void );
	D0

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

@{b}   INPUTS@{ub}

@{b}   RESULTS@{ub}
	AmigaTime       The number of seconds from 01-Jan-1978 that
	                    the clock chip thinks it is.

@{b}   NOTES@{ub}
	If the clock chip returns an invalid date, the clock chip is
	reset and 0 is returned.

@{b}   SEE ALSO@{ub}

@{b}   BUGS@{ub}

@EndNode

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

@{b}   NAME@{ub}
	ResetBattClock -- Reset the clock chip.  (V36)

@{b}   SYNOPSIS@{ub}
	ResetBattClock( )

	void ResetBattClock( void );

@{b}   FUNCTION@{ub}
	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.

@{b}   INPUTS@{ub}

@{b}   RESULTS@{ub}

@{b}   NOTES@{ub}

@{b}   SEE ALSO@{ub}

@{b}   BUGS@{ub}

@EndNode

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

@{b}   NAME@{ub}
	WriteBattClock -- Set the time on the clock chip.  (V36)

@{b}   SYNOPSIS@{ub}
	WriteBattClock( AmigaTime )
	                D0

	void WriteBattClock( ULONG );

@{b}   FUNCTION@{ub}
	This routine writes the time given in AmigaTime to the clock
	chip.

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

@{b}   RESULTS@{ub}

@{b}   NOTES@{ub}

@{b}   SEE ALSO@{ub}

@{b}   BUGS@{ub}

@EndNode