summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtc.h
diff options
context:
space:
mode:
authorJoel Sherrill <joel@rtems.org>2016-03-30 08:14:56 -0500
committerJoel Sherrill <joel@rtems.org>2016-03-30 09:32:33 -0500
commit92b6f6e9c9ced4edcb132e517314a6f4e772a7e9 (patch)
tree6fa7a70f510af1586b95769f98fe9ac7ec3d426e /cpukit/include/rtems/rtc.h
parentscore: Objects_Thread_queue_Extract_callout (diff)
downloadrtems-92b6f6e9c9ced4edcb132e517314a6f4e772a7e9.tar.bz2
Move various driver interface definition headers file libcsupport/ to include/
These were in libcsupport for historical reasons and the placement no longer made sense. As part of this move, some of the files were placed under subdirectories which reflect their installed location. Thank you git for allowing us to move files. Years of CVS resulted in files being somewhere they no longer belonged.
Diffstat (limited to 'cpukit/include/rtems/rtc.h')
-rw-r--r--cpukit/include/rtems/rtc.h115
1 files changed, 115 insertions, 0 deletions
diff --git a/cpukit/include/rtems/rtc.h b/cpukit/include/rtems/rtc.h
new file mode 100644
index 0000000000..27b9e453c5
--- /dev/null
+++ b/cpukit/include/rtems/rtc.h
@@ -0,0 +1,115 @@
+/**
+ * @file
+ *
+ * @brief Real-Time Clock Driver Interface
+ *
+ * Real-time clock driver interface.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2001.
+ * On-Line Applications Research Corporation (OAR).
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.org/license/LICENSE.
+ */
+
+#ifndef _RTEMS_RTC_H
+#define _RTEMS_RTC_H
+
+#include <rtems.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @defgroup rtems_rtc Real-Time Clock Driver Interface
+ *
+ * This driver interface provides support to read and set the real-time clock
+ * and to initialize the time of day for the system.
+ */
+/**@{**/
+
+/**
+ * Device file name path.
+ */
+#define RTC_DEVICE_NAME "/dev/rtc"
+
+/**
+ * Device driver table entry.
+ */
+#define RTC_DRIVER_TABLE_ENTRY \
+ { rtc_initialize, rtc_open, rtc_close, \
+ rtc_read, rtc_write, rtc_control }
+
+/**
+ * Initializes the real-time clock device and sets the time of day for the
+ * system.
+ *
+ * If the real-time clock provides an invalid time of day value the system time
+ * of day must remain untouched.
+ */
+rtems_device_driver rtc_initialize(
+ rtems_device_major_number,
+ rtems_device_minor_number,
+ void *
+);
+
+/**
+ * Opens the real-time clock device.
+ */
+rtems_device_driver rtc_open(
+ rtems_device_major_number,
+ rtems_device_minor_number,
+ void *
+);
+
+/**
+ * Closes the real-time clock device.
+ */
+rtems_device_driver rtc_close(
+ rtems_device_major_number,
+ rtems_device_minor_number,
+ void *
+);
+
+/**
+ * Reads the real-time clock value.
+ *
+ * The value will be returned in a @ref rtems_time_of_day structure.
+ */
+rtems_device_driver rtc_read(
+ rtems_device_major_number,
+ rtems_device_minor_number,
+ void *
+);
+
+/**
+ * Sets the real-time clock value.
+ *
+ * The value will be set from a @ref rtems_time_of_day structure.
+ */
+rtems_device_driver rtc_write(
+ rtems_device_major_number,
+ rtems_device_minor_number,
+ void *
+);
+
+/**
+ * Controls the real-time clock.
+ */
+rtems_device_driver rtc_control(
+ rtems_device_major_number,
+ rtems_device_minor_number,
+ void *
+);
+
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif