Nut/OS  4.10.3
API Reference
rtc.c
Go to the documentation of this file.
00001 /*
00002  * Copyright (C) 2006 by egnite Software GmbH. All rights reserved.
00003  *
00004  * Redistribution and use in source and binary forms, with or without
00005  * modification, are permitted provided that the following conditions
00006  * are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the copyright holders nor the names of
00014  *    contributors may be used to endorse or promote products derived
00015  *    from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00018  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00019  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00020  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00021  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00022  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00023  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00024  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00025  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00026  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00027  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00028  * SUCH DAMAGE.
00029  *
00030  * For additional information see http://www.ethernut.de/
00031  *
00032  */
00033 
00054 #include <dev/rtc.h>
00055 
00056 static NUTRTC *reg_rtc;
00057 
00058 
00069 int NutRegisterRtc(NUTRTC * rtc)
00070 {
00071     reg_rtc = rtc;
00072     if (rtc && reg_rtc->rtc_init) {
00073         if ((*reg_rtc->rtc_init) ()) {
00074             reg_rtc = NULL;
00075             return -1;
00076         }
00077     }
00078     return 0;
00079 }
00080 
00091 int NutRtcGetTime(struct _tm *tm)
00092 {
00093     if (reg_rtc && reg_rtc->rtc_gettime && tm) {
00094         return (*reg_rtc->rtc_gettime) (tm);
00095     }
00096     return -1;
00097 }
00098 
00109 int NutRtcSetTime(CONST struct _tm *tm)
00110 {
00111     if (reg_rtc && reg_rtc->rtc_settime && tm) {
00112         return (*reg_rtc->rtc_settime) (tm);
00113     }
00114     return -1;
00115 }
00116 
00128 int NutRtcGetAlarm(int idx, struct _tm *tm, int *aflags)
00129 {
00130     if (reg_rtc && reg_rtc->rtc_getalarm) {
00131         return (*reg_rtc->rtc_getalarm) (idx, tm, aflags);
00132     }
00133     return -1;
00134 }
00135 
00152 int NutRtcSetAlarm(int idx, CONST struct _tm *tm, int aflags)
00153 {
00154     if (reg_rtc && reg_rtc->rtc_setalarm) {
00155         return (*reg_rtc->rtc_setalarm) (idx, tm, aflags);
00156     }
00157     return -1;
00158 }
00159 
00170 int NutRtcGetStatus(uint32_t * sflags)
00171 {
00172     if (reg_rtc && reg_rtc->rtc_getstatus) {
00173         return (*reg_rtc->rtc_getstatus) (sflags);
00174     }
00175     return -1;
00176 }
00177 
00185 int NutRtcClearStatus(uint32_t sflags)
00186 {
00187     if (reg_rtc && reg_rtc->rtc_clrstatus) {
00188         return (*reg_rtc->rtc_clrstatus) (sflags);
00189     }
00190     return -1;
00191 }