diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2013-06-16 12:21:30 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2013-06-16 12:21:30 +0000 |
| commit | 0d96f5c78e54d267ef1ca230fe20af1ca090e1d6 (patch) | |
| tree | 7090525820ed5cc9127e6d72aff8dc3dd37f563b /os/kernel | |
| parent | 9c9c52f753a9caf51189ad9e1293476f2384676b (diff) | |
| download | ChibiOS-0d96f5c78e54d267ef1ca230fe20af1ca090e1d6.tar.gz ChibiOS-0d96f5c78e54d267ef1ca230fe20af1ca090e1d6.tar.bz2 ChibiOS-0d96f5c78e54d267ef1ca230fe20af1ca090e1d6.zip | |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/branches/kernel_3_dev@5859 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/kernel')
| -rw-r--r-- | os/kernel/include/ch.h | 2 | ||||
| -rw-r--r-- | os/kernel/include/chvt.h | 294 | ||||
| -rw-r--r-- | os/kernel/src/chschd.c | 2 | ||||
| -rw-r--r-- | os/kernel/src/chthreads.c | 2 | ||||
| -rw-r--r-- | os/kernel/src/chvt.c | 124 | ||||
| -rw-r--r-- | os/kernel/templates/module.c | 81 | ||||
| -rw-r--r-- | os/kernel/templates/module.h | 77 |
7 files changed, 432 insertions, 150 deletions
diff --git a/os/kernel/include/ch.h b/os/kernel/include/ch.h index db7c45501..677aa58b7 100644 --- a/os/kernel/include/ch.h +++ b/os/kernel/include/ch.h @@ -102,6 +102,7 @@ #include "chconf.h"
#include "chtypes.h"
+#include "chdebug.h"
#include "chlists.h"
#include "chcore.h"
#include "chsys.h"
@@ -124,7 +125,6 @@ #include "chqueues.h"
#include "chstreams.h"
#include "chfiles.h"
-#include "chdebug.h"
#if !defined(__DOXYGEN__)
extern WORKING_AREA(_idle_thread_wa, PORT_IDLE_THREAD_STACK_SIZE);
diff --git a/os/kernel/include/chvt.h b/os/kernel/include/chvt.h index 97a04d81e..8aa8c5840 100644 --- a/os/kernel/include/chvt.h +++ b/os/kernel/include/chvt.h @@ -20,7 +20,7 @@ /**
* @file chvt.h
- * @brief Time macros and structures.
+ * @brief Time and Virtual Timers module macros and structures.
*
* @addtogroup time
* @{
@@ -29,6 +29,63 @@ #ifndef _CHVT_H_
#define _CHVT_H_
+/*===========================================================================*/
+/* Module constants. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module pre-compile time settings. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Derived constants and error checks. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief Virtual Timer callback function.
+ */
+typedef void (*vtfunc_t)(void *);
+
+/**
+ * @brief Virtual Timer structure type.
+ */
+typedef struct VirtualTimer VirtualTimer;
+
+/**
+ * @extends VTList
+ *
+ * @brief Virtual Timer descriptor structure.
+ */
+struct VirtualTimer {
+ VirtualTimer *vt_next; /**< @brief Next timer in the list. */
+ VirtualTimer *vt_prev; /**< @brief Previous timer in the list. */
+ systime_t vt_time; /**< @brief Absolute time. */
+ vtfunc_t vt_func; /**< @brief Timer callback function
+ pointer. */
+ void *vt_par; /**< @brief Timer callback function
+ parameter. */
+};
+
+/**
+ * @brief Virtual timers list header.
+ * @note The timers list is implemented as a double link bidirectional list
+ * in order to make the unlink time constant, the reset of a virtual
+ * timer is often used in the code.
+ */
+typedef struct {
+ VirtualTimer *vt_next; /**< @brief Next timer in the list. */
+ VirtualTimer *vt_prev; /**< @brief Last timer in the list. */
+ volatile systime_t vt_time; /**< @brief Current system time. */
+} VTList;
+
+/*===========================================================================*/
+/* Module macros. */
+/*===========================================================================*/
+
/**
* @name Time conversion utilities
* @{
@@ -73,97 +130,124 @@ ((systime_t)((((usec) * CH_FREQUENCY - 1L) / 1000000L) + 1L))
/** @} */
-/**
- * @brief Virtual Timer callback function.
- */
-typedef void (*vtfunc_t)(void *);
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
-/**
- * @brief Virtual Timer structure type.
+extern VTList vtlist;
+
+/*
+ * Virtual Timers APIs.
*/
-typedef struct VirtualTimer VirtualTimer;
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void _vt_init(void);
+ bool_t chVTIsSystemTimeWithin(systime_t start, systime_t end);
+ void chVTSetAbsoluteI(VirtualTimer *vtp, systime_t time,
+ vtfunc_t vtfunc, void *par);
+ void chVTResetI(VirtualTimer *vtp);
+#ifdef __cplusplus
+}
+#endif
+
+/*===========================================================================*/
+/* Module inline functions. */
+/*===========================================================================*/
/**
- * @extends VTList
+ * @brief Current system time.
+ * @details Returns the number of system ticks since the @p chSysInit()
+ * invocation.
+ * @note The counter can reach its maximum and then restart from zero.
*
- * @brief Virtual Timer descriptor structure.
+ * @return The system time in ticks.
+ *
+ * @iclass
*/
-struct VirtualTimer {
- VirtualTimer *vt_next; /**< @brief Next timer in the delta
- list. */
- VirtualTimer *vt_prev; /**< @brief Previous timer in the delta
- list. */
- systime_t vt_time; /**< @brief Time delta before timeout. */
- vtfunc_t vt_func; /**< @brief Timer callback function
- pointer. */
- void *vt_par; /**< @brief Timer callback function
- parameter. */
-};
+static inline systime_t chVTGetSystemTimeI(void) {
+
+ chDbgCheckClassI();
+
+ return vtlist.vt_time;
+}
/**
- * @brief Virtual timers list header.
- * @note The delta list is implemented as a double link bidirectional list
- * in order to make the unlink time constant, the reset of a virtual
- * timer is often used in the code.
+ * @brief Current system time.
+ * @details Returns the number of system ticks since the @p chSysInit()
+ * invocation.
+ * @note The counter can reach its maximum and then restart from zero.
+ *
+ * @return The system time in ticks.
+ *
+ * @api
*/
-typedef struct {
- VirtualTimer *vt_next; /**< @brief Next timer in the delta
- list. */
- VirtualTimer *vt_prev; /**< @brief Last timer in the delta
- list. */
- systime_t vt_time; /**< @brief Must be initialized to -1. */
- volatile systime_t vt_systime; /**< @brief System Time counter. */
-} VTList;
+static inline systime_t chVTGetSystemTime(void) {
+ systime_t systime;
+
+ chSysLock()
+ systime = chVTGetSystemTimeI();
+ chSysUnlock();
+ return systime;
+}
/**
- * @name Macro Functions
- * @{
+ * @brief Initializes a @p VirtualTimer object.
+ * @note Initializing a timer object is not strictly required because
+ * the function @p chVTSetI() initializes the object too. This
+ * function is only useful if you need to perform a @p chVTIsArmed()
+ * check before calling @p chVTSetI().
+ *
+ * @param[out] vtp the @p VirtualTimer structure pointer
+ *
+ * @init
*/
+static inline void chVTObjectInit(VirtualTimer *vtp) {
+
+ vtp->vt_func = NULL;
+}
+
/**
- * @brief Virtual timers ticker.
- * @note The system lock is released before entering the callback and
- * re-acquired immediately after. It is callback's responsibility
- * to acquire the lock if needed. This is done in order to reduce
- * interrupts jitter when many timers are in use.
+ * @brief Returns @p TRUE if the specified timer is armed.
+ * @pre The timer must have been initialized using @p chVTObjectInit()
+ * or @p chVTSetI() (or @p chVTSetI() variants).
+ *
+ * @param[in] vtp the @p VirtualTimer structure pointer
+ * @return true if the timer is armed.
*
* @iclass
*/
-#define chVTDoTickI() { \
- vtlist.vt_systime++; \
- if (&vtlist != (VTList *)vtlist.vt_next) { \
- VirtualTimer *vtp; \
- \
- --vtlist.vt_next->vt_time; \
- while (!(vtp = vtlist.vt_next)->vt_time) { \
- vtfunc_t fn = vtp->vt_func; \
- vtp->vt_func = (vtfunc_t)NULL; \
- vtp->vt_next->vt_prev = (void *)&vtlist; \
- (&vtlist)->vt_next = vtp->vt_next; \
- chSysUnlockFromIsr(); \
- fn(vtp->vt_par); \
- chSysLockFromIsr(); \
- } \
- } \
+static inline bool_t chVTIsArmedI(VirtualTimer *vtp) {
+
+ chDbgCheckClassI();
+
+ return (bool_t)(vtp->vt_func != NULL);
}
/**
- * @brief Returns @p TRUE if the specified timer is armed.
+ * @brief Enables a virtual timer.
+ *
+ * @param[out] vtp the @p VirtualTimer structure pointer
+ * @param[in] delay the number of ticks before the operation timeouts.
+ * @param[in] vtfunc the timer callback function. After invoking the
+ * callback the timer is disabled and the structure can
+ * be disposed or reused.
+ * @param[in] par a parameter that will be passed to the callback
+ * function
*
* @iclass
*/
-#define chVTIsArmedI(vtp) ((vtp)->vt_func != NULL)
+static inline void chVTSetI(VirtualTimer *vtp, systime_t delay,
+ vtfunc_t vtfunc, void *par) {
+
+ chVTSetAbsoluteI(vtp, chVTGetSystemTimeI() + delay, vtfunc, par);
+}
/**
* @brief Enables a virtual timer.
- * @note The associated function is invoked from interrupt context.
*
* @param[out] vtp the @p VirtualTimer structure pointer
- * @param[in] time the number of ticks before the operation timeouts, the
- * special values are handled as follow:
- * - @a TIME_INFINITE is allowed but interpreted as a
- * normal time specification.
- * - @a TIME_IMMEDIATE this value is not allowed.
- * .
+ * @param[in] delay the number of ticks before the operation timeouts.
* @param[in] vtfunc the timer callback function. After invoking the
* callback the timer is disabled and the structure can
* be disposed or reused.
@@ -172,56 +256,74 @@ typedef struct { *
* @api
*/
-#define chVTSet(vtp, time, vtfunc, par) { \
- chSysLock(); \
- chVTSetI(vtp, time, vtfunc, par); \
- chSysUnlock(); \
+static inline void chVTSet(VirtualTimer *vtp, systime_t delay,
+ vtfunc_t vtfunc, void *par) {
+
+ chSysLock();
+ chVTSetI(vtp, delay, vtfunc, par);
+ chSysUnlock();
}
/**
* @brief Disables a Virtual Timer.
- * @note The timer is first checked and disabled only if armed.
+ * @pre The timer must be in armed state before calling this function.
*
* @param[in] vtp the @p VirtualTimer structure pointer
*
- * @api
+ * @iclass
*/
-#define chVTReset(vtp) { \
- chSysLock(); \
- if (chVTIsArmedI(vtp)) \
- chVTResetI(vtp); \
- chSysUnlock(); \
+static inline void chVTDoResetI(VirtualTimer *vtp) {
+
+ chDbgCheckClassI();
+ chDbgCheck(vtp != NULL, "chVTDoResetI");
+
+ vtp->vt_prev->vt_next = vtp->vt_next;
+ vtp->vt_next->vt_prev = vtp->vt_prev;
+ vtp->vt_func = (vtfunc_t)NULL;
}
/**
- * @brief Current system time.
- * @details Returns the number of system ticks since the @p chSysInit()
- * invocation.
- * @note The counter can reach its maximum and then restart from zero.
- * @note This function is designed to work with the @p chThdSleepUntil().
+ * @brief Disables a Virtual Timer.
+ * @note The timer is first checked and disabled only if armed.
*
- * @return The system time in ticks.
+ * @param[in] vtp the @p VirtualTimer structure pointer
*
* @api
*/
-#define chTimeNow() (vtlist.vt_systime)
-/** @} */
+static inline void chVTReset(VirtualTimer *vtp) {
-extern VTList vtlist;
+ chSysLock();
+ chVTResetI(vtp);
+ chSysUnlock();
+}
-/*
- * Virtual Timers APIs.
+/**
+ * @brief Virtual timers ticker.
+ * @note The system lock is released before entering the callback and
+ * re-acquired immediately after. It is callback's responsibility
+ * to acquire the lock if needed. This is done in order to reduce
+ * interrupts jitter when many timers are in use.
+ *
+ * @iclass
*/
-#ifdef __cplusplus
-extern "C" {
-#endif
- void _vt_init(void);
- void chVTSetI(VirtualTimer *vtp, systime_t time, vtfunc_t vtfunc, void *par);
- void chVTResetI(VirtualTimer *vtp);
- bool_t chTimeIsWithin(systime_t start, systime_t end);
-#ifdef __cplusplus
+static inline void chVTDoTickI(void) {
+ systime_t systime = ++vtlist.vt_time;
+
+ chDbgCheckClassI();
+
+ if (&vtlist != (VTList *)vtlist.vt_next) {
+ VirtualTimer *vtp;
+
+ while (((VirtualTimer *)&vtlist != (vtp = vtlist.vt_next)) &&
+ (vtp->vt_time == systime)) {
+ vtfunc_t fn = vtp->vt_func;
+ chVTDoResetI(vtp);
+ chSysUnlockFromIsr();
+ fn(vtp->vt_par);
+ chSysLockFromIsr();
+ }
+ }
}
-#endif
#endif /* _CHVT_H_ */
diff --git a/os/kernel/src/chschd.c b/os/kernel/src/chschd.c index 1106cf03f..285c36ba3 100644 --- a/os/kernel/src/chschd.c +++ b/os/kernel/src/chschd.c @@ -189,7 +189,7 @@ msg_t chSchGoSleepTimeoutS(tstate_t newstate, systime_t time) { chVTSetI(&vt, time, wakeup, currp);
chSchGoSleepS(newstate);
if (chVTIsArmedI(&vt))
- chVTResetI(&vt);
+ chVTDoResetI(&vt);
}
else
chSchGoSleepS(newstate);
diff --git a/os/kernel/src/chthreads.c b/os/kernel/src/chthreads.c index 9f6973c90..7652cbfb1 100644 --- a/os/kernel/src/chthreads.c +++ b/os/kernel/src/chthreads.c @@ -302,7 +302,7 @@ void chThdSleep(systime_t time) { void chThdSleepUntil(systime_t time) {
chSysLock();
- if ((time -= chTimeNow()) > 0)
+ if ((time -= chVTGetSystemTimeI()) > 0)
chThdSleepS(time);
chSysUnlock();
}
diff --git a/os/kernel/src/chvt.c b/os/kernel/src/chvt.c index a8e3ce499..d27f3170c 100644 --- a/os/kernel/src/chvt.c +++ b/os/kernel/src/chvt.c @@ -20,7 +20,7 @@ /**
* @file chvt.c
- * @brief Time and Virtual Timers related code.
+ * @brief Time and Virtual Timers module code.
*
* @addtogroup time
* @details Time and Virtual Timers related APIs and services.
@@ -29,11 +29,35 @@ #include "ch.h"
+/*===========================================================================*/
+/* Module local definitions. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module exported variables. */
+/*===========================================================================*/
+
/**
* @brief Virtual timers delta list header.
*/
VTList vtlist;
+/*===========================================================================*/
+/* Module local types. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module local variables. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module local functions. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module exported functions. */
+/*===========================================================================*/
+
/**
* @brief Virtual Timers initialization.
* @note Internal use only.
@@ -43,21 +67,37 @@ VTList vtlist; void _vt_init(void) {
vtlist.vt_next = vtlist.vt_prev = (void *)&vtlist;
- vtlist.vt_time = (systime_t)-1;
- vtlist.vt_systime = 0;
+ vtlist.vt_time = 0;
+}
+
+/**
+ * @brief Checks if the current system time is within the specified time
+ * window.
+ * @note When start==end then the function returns always true because the
+ * whole time range is specified.
+ *
+ * @param[in] start the start of the time window (inclusive)
+ * @param[in] end the end of the time window (non inclusive)
+ * @retval TRUE current time within the specified time window.
+ * @retval FALSE current time not within the specified time window.
+ *
+ * @api
+ */
+bool_t chVTIsSystemTimeWithin(systime_t start, systime_t end) {
+
+ systime_t time = chVTGetSystemTime();
+ return end > start ? (time >= start) && (time < end) :
+ (time >= start) || (time < end);
}
/**
* @brief Enables a virtual timer.
+ * @details The timer is enabled and programmed to trigger at the absolute
+ * system time specified as parameter.
* @note The associated function is invoked from interrupt context.
*
* @param[out] vtp the @p VirtualTimer structure pointer
- * @param[in] time the number of ticks before the operation timeouts, the
- * special values are handled as follow:
- * - @a TIME_INFINITE is allowed but interpreted as a
- * normal time specification.
- * - @a TIME_IMMEDIATE this value is not allowed.
- * .
+ * @param[in] time absolute system time
* @param[in] vtfunc the timer callback function. After invoking the
* callback the timer is disabled and the structure can
* be disposed or reused.
@@ -66,31 +106,36 @@ void _vt_init(void) { *
* @iclass
*/
-void chVTSetI(VirtualTimer *vtp, systime_t time, vtfunc_t vtfunc, void *par) {
+void chVTSetAbsoluteI(VirtualTimer *vtp, systime_t time,
+ vtfunc_t vtfunc, void *par) {
VirtualTimer *p;
+ systime_t systime = vtlist.vt_time;
chDbgCheckClassI();
- chDbgCheck((vtp != NULL) && (vtfunc != NULL) && (time != TIME_IMMEDIATE),
- "chVTSetI");
+ chDbgCheck((vtp != NULL) && (vtfunc != NULL), "chVTSetI");
vtp->vt_par = par;
vtp->vt_func = vtfunc;
- p = vtlist.vt_next;
- while (p->vt_time < time) {
- time -= p->vt_time;
- p = p->vt_next;
- }
-
- vtp->vt_prev = (vtp->vt_next = p)->vt_prev;
- vtp->vt_prev->vt_next = p->vt_prev = vtp;
vtp->vt_time = time;
- if (p != (void *)&vtlist)
- p->vt_time -= time;
+ if (time <= systime) {
+ p = vtlist.vt_prev;
+ while ((p->vt_time <= systime) && (p->vt_time > time))
+ p = p->vt_prev;
+ vtp->vt_next = (vtp->vt_prev = p)->vt_next;
+ vtp->vt_next->vt_prev = p->vt_next = vtp;
+ }
+ else {
+ p = vtlist.vt_next;
+ while ((p->vt_time > systime) && (p->vt_time < time))
+ p = p->vt_next;
+ vtp->vt_prev = (vtp->vt_next = p)->vt_prev;
+ vtp->vt_prev->vt_next = p->vt_prev = vtp;
+ }
}
/**
* @brief Disables a Virtual Timer.
- * @note The timer MUST be active when this function is invoked.
+ * @note The timer is first checked and disabled only if armed.
*
* @param[in] vtp the @p VirtualTimer structure pointer
*
@@ -100,35 +145,12 @@ void chVTResetI(VirtualTimer *vtp) { chDbgCheckClassI();
chDbgCheck(vtp != NULL, "chVTResetI");
- chDbgAssert(vtp->vt_func != NULL,
- "chVTResetI(), #1",
- "timer not set or already triggered");
-
- if (vtp->vt_next != (void *)&vtlist)
- vtp->vt_next->vt_time += vtp->vt_time;
- vtp->vt_prev->vt_next = vtp->vt_next;
- vtp->vt_next->vt_prev = vtp->vt_prev;
- vtp->vt_func = (vtfunc_t)NULL;
-}
-/**
- * @brief Checks if the current system time is within the specified time
- * window.
- * @note When start==end then the function returns always true because the
- * whole time range is specified.
- *
- * @param[in] start the start of the time window (inclusive)
- * @param[in] end the end of the time window (non inclusive)
- * @retval TRUE current time within the specified time window.
- * @retval FALSE current time not within the specified time window.
- *
- * @api
- */
-bool_t chTimeIsWithin(systime_t start, systime_t end) {
-
- systime_t time = chTimeNow();
- return end > start ? (time >= start) && (time < end) :
- (time >= start) || (time < end);
+ if (chVTIsArmedI(vtp)) {
+ vtp->vt_prev->vt_next = vtp->vt_next;
+ vtp->vt_next->vt_prev = vtp->vt_prev;
+ vtp->vt_func = (vtfunc_t)NULL;
+ }
}
/** @} */
diff --git a/os/kernel/templates/module.c b/os/kernel/templates/module.c new file mode 100644 index 000000000..a079437a2 --- /dev/null +++ b/os/kernel/templates/module.c @@ -0,0 +1,81 @@ +/*
+ ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
+ 2011,2012,2013 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 chXxx.c
+ * @brief XXX module code.
+ *
+ * @addtogroup XXX
+ * @{
+ */
+
+#include "ch.h"
+
+#if CH_USE_XXX || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Module local definitions. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module exported variables. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module local types. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module local variables. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module local functions. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module exported functions. */
+/*===========================================================================*/
+
+/**
+ * @brief XXX Module initialization.
+ * @note This function is implicitly invoked on system initialization,
+ * there is no need to explicitly initialize the module.
+ *
+ * @notapi
+ */
+void _xxx_init(void) {
+
+}
+
+/**
+ * @brief Initializes a @p xxx_t object.
+ *
+ * @param[out] xxxp pointer to the @p xxx_t object
+ *
+ * @init
+ */
+void chXxxObjectInit(xxx_t *xxxp) {
+
+}
+
+#endif /* CH_USE_XXX */
+
+/** @} */
diff --git a/os/kernel/templates/module.h b/os/kernel/templates/module.h new file mode 100644 index 000000000..4761a947c --- /dev/null +++ b/os/kernel/templates/module.h @@ -0,0 +1,77 @@ +/*
+ ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
+ 2011,2012,2013 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 chXxx.h
+ * @brief XXX Module macros and structures.
+ *
+ * @addtogroup XXX
+ * @{
+ */
+
+#ifndef _CHXXX_H_
+#define _CHXXX_H_
+
+#include "ch.h"
+
+#if CH_USE_XXX || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Module constants. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module pre-compile time settings. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Derived constants and error checks. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module data structures and types. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Module macros. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void chXxxInit(void);
+ void chXxxObjectInit(xxx_t *xxxp);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* CH_USE_XXX */
+
+#endif /* _CHXXX_H_ */
+
+/*===========================================================================*/
+/* Module inline functions. */
+/*===========================================================================*/
+
+/** @} */
|