source: rtems/cpukit/include/rtems/tod.h @ 2a56a1cf

5
Last change on this file since 2a56a1cf was 2a56a1cf, checked in by Andreas Dachsberger <andreas.dachsberger@…>, on 04/02/19 at 12:14:30

doxygen: Real Time Clock Time of Day API Definition in BSP->Shared

Update #3706.
  • Property mode set to 100644
File size: 1.1 KB
Line 
1/**
2 *  @file
3 *
4 *  @ingroup shared_tod
5 *
6 *  @brief Real Time Clock Time of Day API Definition
7 */
8
9/*
10 *
11 *  Based on MVME162 TOD by:
12 *    COPYRIGHT (C) 1997
13 *    by Katsutoshi Shibuya - BU Denken Co.,Ltd. - Sapporo - JAPAN
14 *    ALL RIGHTS RESERVED
15 *
16 *  The license and distribution terms for this file may be
17 *  found in the file LICENSE in this distribution or at
18 *  http://www.rtems.org/license/LICENSE.
19 */
20
21#ifndef TOD_H
22#define TOD_H
23
24#ifdef __cplusplus
25extern "C" {
26#endif
27
28/**
29 *  @defgroup shared_tod RTC
30 *
31 *  @ingroup RTEMSBSPsShared
32 *
33 *  @brief Set the RTC
34 */
35int setRealTime(
36  const rtems_time_of_day *tod
37);
38
39/*
40 *  Get the time from the RTC.
41 */
42
43void getRealTime(
44  rtems_time_of_day *tod
45);
46
47/*
48 *  Read real time from RTC and set it to RTEMS' clock manager
49 */
50
51void setRealTimeToRTEMS(void);
52
53/*
54 *  Read time from RTEMS' clock manager and set it to RTC
55 */
56
57void setRealTimeFromRTEMS(void);
58
59/*
60 *  Return the difference between RTC and RTEMS' clock manager time in minutes.
61 *  If the difference is greater than 1 day, this returns 9999.
62 */
63
64int checkRealTime(void);
65
66#ifdef __cplusplus
67}
68#endif
69
70#endif
Note: See TracBrowser for help on using the repository browser.