aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/templates/meta
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-11-29 08:50:13 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-11-29 08:50:13 +0000
commitd4c616e6eeb0587ca450c75b1086efa77ac690e5 (patch)
tree956be5c79924929b0c79c6aa792ad5b8bff31ede /os/hal/templates/meta
parent87417b01023059aa833f376d9bd7aea5174a5f1b (diff)
downloadChibiOS-d4c616e6eeb0587ca450c75b1086efa77ac690e5.tar.gz
ChibiOS-d4c616e6eeb0587ca450c75b1086efa77ac690e5.tar.bz2
ChibiOS-d4c616e6eeb0587ca450c75b1086efa77ac690e5.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1351 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/templates/meta')
-rw-r--r--os/hal/templates/meta/driver.c87
-rw-r--r--os/hal/templates/meta/driver.h54
-rw-r--r--os/hal/templates/meta/driver_lld.c79
-rw-r--r--os/hal/templates/meta/driver_lld.h81
4 files changed, 301 insertions, 0 deletions
diff --git a/os/hal/templates/meta/driver.c b/os/hal/templates/meta/driver.c
new file mode 100644
index 000000000..9bf785ed2
--- /dev/null
+++ b/os/hal/templates/meta/driver.c
@@ -0,0 +1,87 @@
+/*
+ ChibiOS/RT - Copyright (C) 2006-2007 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 XXX.c
+ * @brief XXX Driver code.
+ * @addtogroup XXX
+ * @{
+ */
+
+#include <ch.h>
+#include <xxx.h>
+
+/**
+ * @brief XXX Driver initialization.
+ */
+void xxxInit(void) {
+
+ xxx_lld_init();
+}
+
+/**
+ * @brief Initializes the standard part of a @p XXXDriver structure.
+ *
+ * @param[in] xxxp pointer to the @p XXXDriver object
+ */
+void xxxObjectInit(XXXDriver *xxxp) {
+
+ xxxp->xxx_state = XXX_STOP;
+ xxxp->xxx_config = NULL;
+}
+
+/**
+ * @brief Configures and activates the XXX peripheral.
+ *
+ * @param[in] xxxp pointer to the @p XXXDriver object
+ * @param[in] config pointer to the @p XXXConfig object
+ */
+void xxxStart(XXXDriver *xxxp, const XXXConfig *config) {
+
+ chDbgCheck((xxxp != NULL) && (config != NULL), "xxxStart");
+
+ chSysLock();
+ chDbgAssert((xxxp->xxx_state == XXX_STOP) || (xxxp->xxx_state == XXX_READY),
+ "xxxStart(), #1",
+ "invalid state");
+ xxxp->xxx_config = config;
+ xxx_lld_start(xxxp);
+ xxxp->xxx_state = XXX_READY;
+ chSysUnlock();
+}
+
+/**
+ * @brief Deactivates the XXX peripheral.
+ *
+ * @param[in] xxxp pointer to the @p XXXDriver object
+ */
+void xxxStop(XXXDriver *xxxp) {
+
+ chDbgCheck(xxxp != NULL, "xxxStop");
+
+ chSysLock();
+ chDbgAssert((xxxp->xxx_state == XXX_STOP) || (xxxp->xxx_state == XXX_READY),
+ "xxxStop(), #1",
+ "invalid state");
+ xxx_lld_stop(xxxp);
+ xxxp->xxx_state = XXX_STOP;
+ chSysUnlock();
+}
+
+/** @} */
diff --git a/os/hal/templates/meta/driver.h b/os/hal/templates/meta/driver.h
new file mode 100644
index 000000000..675bc6689
--- /dev/null
+++ b/os/hal/templates/meta/driver.h
@@ -0,0 +1,54 @@
+/*
+ ChibiOS/RT - Copyright (C) 2006-2007 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 xxx.h
+ * @brief XXX Driver macros and structures.
+ * @addtogroup XXX
+ * @{
+ */
+
+#ifndef _XXX_H_
+#define _XXX_H_
+
+/**
+ * @brief Driver state machine possible states.
+ */
+typedef enum {
+ XXX_UNINIT = 0, /**< @brief Not initialized. */
+ XXX_STOP = 1, /**< @brief Stopped. */
+ XXX_READY = 2, /**< @brief Ready. */
+} xxxstate_t;
+
+#include "xxx_lld.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void xxxInit(void);
+ void xxxObjectInit(XXXDriver *xxxp);
+ void xxxStart(XXXDriver *xxxp, const XXXConfig *config);
+ void xxxStop(XXXDriver *xxxp);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _XXX_H_ */
+
+/** @} */
diff --git a/os/hal/templates/meta/driver_lld.c b/os/hal/templates/meta/driver_lld.c
new file mode 100644
index 000000000..df91ed21b
--- /dev/null
+++ b/os/hal/templates/meta/driver_lld.c
@@ -0,0 +1,79 @@
+/*
+ ChibiOS/RT - Copyright (C) 2006-2007 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/xxx_lld.c
+ * @brief XXX Driver subsystem low level driver source template
+ * @addtogroup XXX_LLD
+ * @{
+ */
+
+#include <ch.h>
+#include <xxx.h>
+
+/*===========================================================================*/
+/* Low Level Driver exported variables. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Low Level Driver local variables. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Low Level Driver local functions. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Low Level Driver interrupt handlers. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Low Level Driver exported functions. */
+/*===========================================================================*/
+
+/**
+ * @brief Low level XXX driver initialization.
+ */
+void xxx_lld_init(void) {
+
+}
+
+/**
+ * @brief Configures and activates the XXX peripheral.
+ *
+ * @param[in] xxxp pointer to the @p XXXDriver object
+ */
+void xxx_lld_start(XXXDriver *xxxp) {
+
+ if (xxxp->xxx_state == XXX_STOP) {
+ /* Clock activation.*/
+ }
+ /* Configuration.*/
+}
+
+/**
+ * @brief Deactivates the XXX peripheral.
+ *
+ * @param[in] xxxp pointer to the @p XXXDriver object
+ */
+void xxx_lld_stop(XXXDriver *xxxp) {
+
+}
+
+/** @} */
diff --git a/os/hal/templates/meta/driver_lld.h b/os/hal/templates/meta/driver_lld.h
new file mode 100644
index 000000000..92194664e
--- /dev/null
+++ b/os/hal/templates/meta/driver_lld.h
@@ -0,0 +1,81 @@
+/*
+ ChibiOS/RT - Copyright (C) 2006-2007 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/xxx_lld.h
+ * @brief XXX Driver subsystem low level driver header template
+ * @addtogroup XXX_LLD
+ * @{
+ */
+
+#ifndef _XXX_LLD_H_
+#define _XXX_LLD_H_
+
+/*===========================================================================*/
+/* Driver pre-compile time settings. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver constants. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief Driver configuration structure.
+ * @note It could be empty on some architectures.
+ */
+typedef struct {
+
+} XXXConfig;
+
+/**
+ * @brief Structure representing an XXX driver.
+ */
+typedef struct {
+ /**
+ * @brief Driver state.
+ */
+ xxxstate_t xxx_state;
+ /**
+ * @brief Current configuration data.
+ */
+ const XXXConfig *xxx_config;
+ /* End of the mandatory fields.*/
+} XXXDriver;
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void xxx_lld_init(void);
+ void xxx_lld_start(XXXDriver *xxxp);
+ void xxx_lld_stop(XXXDriver *xxxp);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _XXX_LLD_H_ */
+
+/** @} */