api/pcf8563_8h_source.html

00001 #ifndef _DEV_PCF8563_H_
00002 #define _DEV_PCF8563_H_
00003
00004 /*
00005  * Copyright (C) 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$
00038  * Revision 1.3  2008/08/11 06:59:59  haraldkipp
00039  * BSD types replaced by stdint types (feature request #1282721).
00040  *
00041  * Revision 1.2  2006/10/05 17:18:49  haraldkipp
00042  * Hardware independant RTC layer added.
00043  *
00044  * Revision 1.1  2006/04/07 13:54:17  haraldkipp
00045  * PCF8563 RTC driver added.
00046  *
00047  */
00048
00049 #include <dev/rtc.h>
00050
00051 extern NUTRTC rtcPcf8563;
00052
00053 __BEGIN_DECLS
00054 /* Prototypes */
00055 extern int PcfRtcInit(void);
00056
00057 extern int PcfRtcGetClock(struct _tm *tm);
00058 extern int PcfRtcSetClock(CONST struct _tm *tm);
00059 extern int PcfRtcGetAlarm(int idx, struct _tm *tm, int *aflgs);
00060 extern int PcfRtcSetAlarm(int idx, CONST struct _tm *tm, int aflgs);
00061 extern int PcfRtcGetStatus(uint32_t *sflgs);
00062 extern int PcfRtcClearStatus(uint32_t sflgs);
00063 extern int PcfRtcReadRegs(uint8_t addr, uint8_t *buff, size_t len);
00064 extern int PcfRtcWrite(int nv, CONST uint8_t *buff, size_t len);
00065
00066 __END_DECLS
00067 /* End of prototypes */
00068 #endif