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/templates/icu_lld.h | 136 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 136 insertions(+)
 create mode 100644 os/hal/templates/icu_lld.h

(limited to 'os/hal/templates/icu_lld.h')

diff --git a/os/hal/templates/icu_lld.h b/os/hal/templates/icu_lld.h
new file mode 100644
index 000000000..b0debb2b9
--- /dev/null
+++ b/os/hal/templates/icu_lld.h
@@ -0,0 +1,136 @@
+/*
+    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    templates/icu_lld.h
+ * @brief   ICU Driver subsystem low level driver header template.
+ *
+ * @addtogroup ICU
+ * @{
+ */
+
+#ifndef _ICU_LLD_H_
+#define _ICU_LLD_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 ICU driver mode.
+ */
+typedef enum {
+  ICU_INPUT_ACTIVE_HIGH = 0,        /**< Trigger on rising edge.            */
+  ICU_INPUT_ACTIVE_LOW = 1,         /**< Trigger on falling edge.           */
+} icumode_t;
+
+/**
+ * @brief   ICU counter type.
+ */
+typedef uint16_t icucnt_t;
+
+/**
+ * @brief   Type of a structure representing an ICU driver.
+ */
+typedef struct ICUDriver ICUDriver;
+
+/**
+ * @brief   ICU notification callback type.
+ *
+ * @param[in] icup      pointer to a @p ICUDriver object
+ */
+typedef void (*icucallback_t)(ICUDriver *icup);
+
+/**
+ * @brief   Driver configuration structure.
+ * @note    It could be empty on some architectures.
+ */
+typedef struct {
+  /**
+   * @brief   Driver mode.
+   */
+  icumode_t                 mode;
+  /**
+   * @brief   Callback for pulse width measurement.
+   */
+  icucallback_t             width_cb;
+  /**
+   * @brief   Callback for cycle period measurement.
+   */
+  icucallback_t             period_cb;
+  /* End of the mandatory fields.*/
+} ICUConfig;
+
+/**
+ * @brief   Structure representing an ICU driver.
+ */
+struct ICUDriver {
+  /**
+   * @brief Driver state.
+   */
+  icustate_t                state;
+  /**
+   * @brief Current configuration data.
+   */
+  const ICUConfig           *config;
+  /* End of the mandatory fields.*/
+};
+
+/*===========================================================================*/
+/* Driver macros.                                                            */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* External declarations.                                                    */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+  void icu_lld_init(void);
+  void icu_lld_start(ICUDriver *icup);
+  void icu_lld_stop(ICUDriver *icup);
+  void icu_lld_enable(ICUDriver *icup);
+  void icu_lld_disable(ICUDriver *icup);
+  icucnt_t icu_lld_get_width(ICUDriver *icup);
+  icucnt_t icu_lld_get_period(ICUDriver *icup);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* HAL_USE_ICU */
+
+#endif /* _ICU_LLD_H_ */
+
+/** @} */
-- 
cgit v1.2.3