From ff676aee33d4061e9d8186a15ad72c78fa1466a0 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Mon, 28 Mar 2011 15:32:56 +0000
Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2848
 35acf78f-673a-0410-8e92-d51de3d6d3f4

---
 os/hal/include/icu.h | 131 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 131 insertions(+)
 create mode 100644 os/hal/include/icu.h

(limited to 'os/hal/include/icu.h')

diff --git a/os/hal/include/icu.h b/os/hal/include/icu.h
new file mode 100644
index 000000000..1f4e58ece
--- /dev/null
+++ b/os/hal/include/icu.h
@@ -0,0 +1,131 @@
+/*
+    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
+                 2011 Giovanni Di Sirio.
+
+    This file is part of ChibiOS/RT.
+
+    ChibiOS/RT is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    ChibiOS/RT is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @file    icu.h
+ * @brief   ICU Driver macros and structures.
+ *
+ * @addtogroup ICU
+ * @{
+ */
+
+#ifndef _ICU_H_
+#define _ICU_H_
+
+#if HAL_USE_ICU || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Driver constants.                                                         */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver pre-compile time settings.                                         */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Derived constants and error checks.                                       */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver data structures and types.                                         */
+/*===========================================================================*/
+
+/**
+ * @brief   Driver state machine possible states.
+ */
+typedef enum {
+  ICU_UNINIT = 0,                   /**< Not initialized.                   */
+  ICU_STOP = 1,                     /**< Stopped.                           */
+  ICU_READY = 2,                    /**< Ready.                             */
+  ICU_WAITING = 3,                  /**< Waiting first edge.                */
+  ICU_ACTIVE = 4,                   /**< Active cycle phase.                */
+  ICU_IDLE = 5,                     /**< Idle cycle phase.                  */
+} icustate_t;
+
+#include "icu_lld.h"
+
+/*===========================================================================*/
+/* Driver macros.                                                            */
+/*===========================================================================*/
+
+/**
+ * @brief   Enables the input capture.
+ *
+ * @param[in] icup      pointer to the @p ICUDriver object
+ *
+ * @iclass
+ */
+void icuEnableI(icup) icu_lld_enable(icup)
+
+/**
+ * @brief   Disables the input capture.
+ *
+ * @param[in] icup      pointer to the @p ICUDriver object
+ *
+ * @iclass
+ */
+void icuDisableI(ICUDriver *icup) icu_lld_disable(icup)
+
+/**
+ * @brief   Returns the width of the latest pulse.
+ * @details The pulse width is defined as number of ticks between the start
+ *          edge and the stop edge.
+ *
+ * @param[in] icup      pointer to the @p ICUDriver object
+ * @return              The number of ticks.
+ *
+ * @iclass
+ */
+#define icuGetWidthI(icup) icu_lld_get_width(icup)
+
+/**
+ * @brief   Returns the width of the latest cycle.
+ * @details The cycle width is defined as number of ticks between a start
+ *          edge and the next start edge.
+ *
+ * @param[in] icup      pointer to the @p ICUDriver object
+ * @return              The number of ticks.
+ *
+ * @iclass
+ */
+#define icuGetPeriodI(icup) icu_lld_get_period(icup)
+
+/*===========================================================================*/
+/* External declarations.                                                    */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+  void icuInit(void);
+  void icuObjectInit(ICUDriver *icup);
+  void icuStart(ICUDriver *icup, const ICUConfig *config);
+  void icuStop(ICUDriver *icup);
+  void icuEnableI(ICUDriver *icup);
+  void icuDisableI(ICUDriver *icup);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* HAL_USE_ICU */
+
+#endif /* _ICU_H_ */
+
+/** @} */
-- 
cgit v1.2.3