Contiki 3.x
rtc.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014, Eistec AB.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holder nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  *
29  * This file is part of the Mulle platform port of the Contiki operating system.
30  *
31  */
32 
33 /**
34  * \file
35  * Implementation of K60 RTC driver.
36  *
37  * \author
38  * Joakim Gebart <joakim.gebart@eistec.se>
39  */
40 
41 #ifndef K60_RTC_H_
42 #define K60_RTC_H_
43 
44 #include <stdint.h>
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 /**
51  * Initialize the RTC hardware
52  */
53 void rtc_init(void);
54 
55 /**
56  * Enable the RTC seconds counter
57  */
58 void rtc_start(void);
59 
60 /**
61  * Stop the RTC seconds counter
62  */
63 void rtc_stop(void);
64 
65 /**
66  * Set the time.
67  */
68 void rtc_time_set(uint32_t seconds);
69 
70 /**
71  * Get the current time.
72  */
73 uint32_t rtc_time_get(void);
74 
75 /**
76  * Set alarm time
77  */
78 void rtc_alarm_set(uint32_t alarm_time);
79 
80 #ifdef __cplusplus
81 } /* extern "C" */
82 #endif
83 
84 #endif /* !defined(K60_RTC_H_) */
void rtc_stop(void)
Stop the RTC seconds counter.
Definition: rtc.c:69
void rtc_init(void)
Initialize the RTC hardware.
Definition: rtc.c:47
uint32_t rtc_time_get(void)
Get the current time.
Definition: rtc.c:81
void rtc_start(void)
Enable the RTC seconds counter.
Definition: rtc.c:63
void rtc_time_set(uint32_t seconds)
Set the time.
Definition: rtc.c:75
void rtc_alarm_set(uint32_t alarm_time)
Set alarm time.
Definition: rtc.c:86