firmware/export/rtc.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by Linus Nielsen Feltzing, Uwe Freese
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21 #ifndef _RTC_H_
  22 #define _RTC_H_
  23
  24 #include <stdbool.h>
  25 #include "system.h"
  26 #include "config.h"
  27 #include "time.h"
  28
  29 /* Macros used to convert to and from BCD, used in various rtc drivers
  30    this is the wrong place but misc.h is in apps... */
  31 #define BCD2DEC(X) (((((X)>>4) & 0x0f) * 10) + ((X) & 0xf))
  32 #define DEC2BCD(X) ((((X)/10)<<4) | ((X)%10))
  33
  34 #if CONFIG_RTC
  35
  36 /* Common functions for all targets */
  37 void rtc_init(void);
  38 int rtc_read_datetime(struct tm *tm);
  39 int rtc_write_datetime(const struct tm *tm);
  40
  41 #if CONFIG_RTC == RTC_M41ST84W
  42
  43 /* The RTC in the Archos devices is used for much more than just the clock
  44    data */
  45 int rtc_read(unsigned char address);
  46 int rtc_read_multiple(unsigned char address, unsigned char *buf, int numbytes);
  47 int rtc_write(unsigned char address, unsigned char value);
  48
  49 #endif /* RTC_M41ST84W */
  50
  51 #ifdef HAVE_RTC_ALARM
  52 void rtc_set_alarm(int h, int m);
  53 void rtc_get_alarm(int *h, int *m);
  54 void rtc_enable_alarm(bool enable);
  55 bool rtc_check_alarm_started(bool release_alarm);
  56 bool rtc_check_alarm_flag(void);
  57 #endif /* HAVE_RTC_ALARM */
  58
  59 #endif /* CONFIG_RTC */
  60
  61 #endif
  62