rtc.h

Go to the documentation of this file.
00001 #ifndef _DEV_RTC_H_
00002 #define _DEV_RTC_H_
00003 
00004 /*
00005  * Copyright (C) 2005-2006 by egnite Software GmbH. All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in the
00015  *    documentation and/or other materials provided with the distribution.
00016  * 3. Neither the name of the copyright holders nor the names of
00017  *    contributors may be used to endorse or promote products derived
00018  *    from this software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00024  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * For additional information see http://www.ethernut.de/
00034  */
00035 
00036 /*
00037  * $Log: rtc.h,v $
00038  * Revision 1.1  2006/10/05 17:18:49  haraldkipp
00039  * Hardware independant RTC layer added.
00040  *
00041  */
00042 
00043 #include <sys/types.h>
00044 #include <time.h>
00045 
00046 #define RTC_STATUS_PF       0x00000001
00047 #define RTC_STATUS_AL0      0x00000020
00048 #define RTC_STATUS_AL1      0x00000040
00049 
00050 #define RTC_ALARM_SECOND    0x00000001
00051 #define RTC_ALARM_MINUTE    0x00000002
00052 #define RTC_ALARM_HOUR      0x00000004
00053 #define RTC_ALARM_MDAY      0x00000008
00054 #define RTC_ALARM_MONTH     0x00000010
00055 #define RTC_ALARM_WDAY      0x00000080
00056 
00060 #define BCD2BIN(x) ((((u_char)(x)) >> 4) * 10 + ((x) & 0x0F))
00061 
00065 #define BIN2BCD(x) (((((u_char)(x)) / 10) << 4) + (x) % 10)
00066 
00070 typedef struct _NUTRTC NUTRTC;
00071 
00075 struct _NUTRTC {
00076     int (*rtc_init) (void);
00077     int (*rtc_gettime) (struct _tm *);
00078     int (*rtc_settime) (CONST struct _tm *);
00079     int (*rtc_getalarm) (int idx, struct _tm *, int *);
00080     int (*rtc_setalarm) (int idx, CONST struct _tm *, int);
00081     int (*rtc_getstatus) (u_long *);
00082     int (*rtc_clrstatus) (u_long);
00083 };
00084 
00085 __BEGIN_DECLS
00086 /* Prototypes */
00087 extern int NutRegisterRtc(NUTRTC *rtc);
00088 
00089 extern int NutRtcGetTime(struct _tm *tm);
00090 extern int NutRtcSetTime(CONST struct _tm *tm);
00091 
00092 extern int NutRtcGetAlarm(int idx, struct _tm *tm, int *aflags);
00093 extern int NutRtcSetAlarm(int idx, CONST struct _tm *tm, int aflags);
00094 
00095 extern int NutRtcGetStatus(u_long *sflags);
00096 extern int NutRtcClearStatus(u_long sflags);
00097 
00098 __END_DECLS
00099 /* End of prototypes */
00100 #endif

© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/