arch/m68k-amiga/battclock/resetbattclock.c

   1 /*
   2     Copyright © 1995-2010, The AROS Development Team. All rights reserved.
   3
   4     Desc: ResetBattClock()
   5     Lang: english
   6 */
   7 #include "battclock_intern.h"
   8
   9 /*****************************************************************************
  10
  11     NAME */
  12 #include <proto/battclock.h>
  13
  14         AROS_LH0(void, ResetBattClock,
  15
  16 /*  SYNOPSIS */
  17         /* void */
  18
  19 /*  LOCATION */
  20         struct BattClockBase*, BattClockBase, 1, Battclock)
  21
  22 /*  FUNCTION
  23         Reset the system battery-backed-up clock. This will reset the clock
  24         back to 0 seconds (or midnight, 1st Jan 1978).
  25
  26     INPUTS
  27         None.
  28
  29     RESULT
  30         The clock will be reset.
  31
  32     NOTES
  33         This function may do nothing when the battery backed up clock either
  34         doesn't exist, or may not be writable by the operating system.
  35
  36     EXAMPLE
  37
  38     BUGS
  39
  40     SEE ALSO
  41         ReadBattClock(), WriteBattClock()
  42
  43     INTERNALS
  44
  45 *****************************************************************************/
  46 {
  47     AROS_LIBFUNC_INIT
  48
  49     resetbattclock(BattClockBase);
  50     WriteBattClock(0);
  51
  52     AROS_LIBFUNC_EXIT
  53 } /* ResetBattClock */