aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/dac.h
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/include/dac.h')
-rw-r--r--os/hal/include/dac.h594
1 files changed, 297 insertions, 297 deletions
diff --git a/os/hal/include/dac.h b/os/hal/include/dac.h
index 3d1157ae0..9fec43af3 100644
--- a/os/hal/include/dac.h
+++ b/os/hal/include/dac.h
@@ -1,297 +1,297 @@
-/*
- 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 dac.h
- * @brief DAC Driver macros and structures.
- *
- * @addtogroup DAC
- * @{
- */
-
-#ifndef _DAC_H_
-#define _DAC_H_
-
-#if HAL_USE_DAC || defined(__DOXYGEN__)
-
-/*===========================================================================*/
-/* Driver constants. */
-/*===========================================================================*/
-
-/*===========================================================================*/
-/* Driver pre-compile time settings. */
-/*===========================================================================*/
-
-/**
- * @name DAC configuration options
- * @{
- */
-/**
- * @brief Enables synchronous APIs.
- * @note Disabling this option saves both code and data space.
- */
-#if !defined(DAC_USE_WAIT) || defined(__DOXYGEN__)
-#define DAC_USE_WAIT TRUE
-#endif
-
-/**
- * @brief Enables the @p dacAcquireBus() and @p dacReleaseBus() APIs.
- * @note Disabling this option saves both code and data space.
- */
-#if !defined(DAC_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
-#define DAC_USE_MUTUAL_EXCLUSION TRUE
-#endif
-/** @} */
-
-/*===========================================================================*/
-/* Derived constants and error checks. */
-/*===========================================================================*/
-
-/*===========================================================================*/
-/* Driver data structures and types. */
-/*===========================================================================*/
-
-/**
- * @brief Driver state machine possible states.
- */
-typedef enum {
- DAC_UNINIT = 0, /**< Not initialized. */
- DAC_STOP = 1, /**< Stopped. */
- DAC_READY = 2, /**< Ready. */
- DAC_ACTIVE = 3, /**< Exchanging data. */
- DAC_COMPLETE = 4, /**< Asynchronous operation complete. */
- DAC_ERROR = 5 /**< Error. */
-} dacstate_t;
-
-#include "dac_lld.h"
-
-/*===========================================================================*/
-/* Driver macros. */
-/*===========================================================================*/
-
-/**
- * @name Low Level driver helper macros
- * @{
- */
-#if DAC_USE_WAIT || defined(__DOXYGEN__)
-/**
- * @brief Waits for operation completion.
- * @details This function waits for the driver to complete the current
- * operation.
- * @pre An operation must be running while the function is invoked.
- * @note No more than one thread can wait on a DAC driver using
- * this function.
- *
- * @param[in] dacp pointer to the @p DACDriver object
- *
- * @notapi
- */
-#define _dac_wait_s(dacp) osalThreadSuspendS(&(dacp)->thread)
-
-/**
- * @brief Resumes a thread waiting for a conversion completion.
- *
- * @param[in] dacp pointer to the @p DACDriver object
- *
- * @notapi
- */
-#define _dac_reset_i(dacp) osalThreadResumeI(&(dacp)->thread, MSG_RESET)
-
-/**
- * @brief Resumes a thread waiting for a conversion completion.
- *
- * @param[in] dacp pointer to the @p DACDriver object
- *
- * @notapi
- */
-#define _dac_reset_s(dacp) osalThreadResumeS(&(dacp)->thread, MSG_RESET)
-
-/**
- * @brief Wakes up the waiting thread.
- *
- * @param[in] dacp pointer to the @p DACDriver object
- *
- * @notapi
- */
-#define _dac_wakeup_isr(dacp) { \
- osalSysLockFromISR(); \
- osalThreadResumeI(&(dacp)->thread, MSG_OK); \
- osalSysUnlockFromISR(); \
-}
-
-/**
- * @brief Wakes up the waiting thread with a timeout message.
- *
- * @param[in] dacp pointer to the @p DACDriver object
- *
- * @notapi
- */
-#define _dac_timeout_isr(dacp) { \
- osalSysLockFromISR(); \
- osalThreadResumeI(&(dacp)->thread, MSG_TIMEOUT); \
- osalSysUnlockFromISR(); \
-}
-
-#else /* !DAC_USE_WAIT */
-#define _dac_wait_s(dacp)
-#define _dac_reset_i(dacp)
-#define _dac_reset_s(dacp)
-#define _dac_wakeup_isr(dacp)
-#define _dac_timeout_isr(dacp)
-#endif /* !DAC_USE_WAIT */
-
-/**
- * @brief Common ISR code, half buffer event.
- * @details This code handles the portable part of the ISR code:
- * - Callback invocation.
- * .
- * @note This macro is meant to be used in the low level drivers
- * implementation only.
- *
- * @param[in] dacp pointer to the @p DACDriver object
- *
- * @notapi
- */
-#define _dac_isr_half_code(dacp) { \
- if ((dacp)->grpp->end_cb != NULL) { \
- (dacp)->grpp->end_cb(dacp, (dacp)->samples, (dacp)->depth / 2); \
- } \
-}
-
-/**
- * @brief Common ISR code, full buffer event.
- * @details This code handles the portable part of the ISR code:
- * - Callback invocation.
- * - Waiting thread wakeup, if any.
- * - Driver state transitions.
- * .
- * @note This macro is meant to be used in the low level drivers
- * implementation only.
- *
- * @param[in] dacp pointer to the @p DACDriver object
- *
- * @notapi
- */
-#define _dac_isr_full_code(dacp) { \
- if ((dacp)->grpp->circular) { \
- /* Callback handling.*/ \
- if ((dacp)->grpp->end_cb != NULL) { \
- if ((dacp)->depth > 1) { \
- /* Invokes the callback passing the 2nd half of the buffer.*/ \
- size_t half = (dacp)->depth / 2; \
- size_t half_index = half * (dacp)->grpp->num_channels; \
- (dacp)->grpp->end_cb(dacp, (dacp)->samples + half_index, half); \
- } \
- else { \
- /* Invokes the callback passing the whole buffer.*/ \
- (dacp)->grpp->end_cb(dacp, (dacp)->samples, (dacp)->depth); \
- } \
- } \
- } \
- else { \
- /* End conversion.*/ \
- dac_lld_stop_conversion(dacp); \
- if ((dacp)->grpp->end_cb != NULL) { \
- (dacp)->state = DAC_COMPLETE; \
- if ((dacp)->depth > 1) { \
- /* Invokes the callback passing the 2nd half of the buffer.*/ \
- size_t half = (dacp)->depth / 2; \
- size_t half_index = half * (dacp)->grpp->num_channels; \
- (dacp)->grpp->end_cb(dacp, (dacp)->samples + half_index, half); \
- } \
- else { \
- /* Invokes the callback passing the whole buffer.*/ \
- (dacp)->grpp->end_cb(dacp, (dacp)->samples, (dacp)->depth); \
- } \
- if ((dacp)->state == DAC_COMPLETE) { \
- (dacp)->state = DAC_READY; \
- (dacp)->grpp = NULL; \
- } \
- } \
- else { \
- (dacp)->state = DAC_READY; \
- (dacp)->grpp = NULL; \
- } \
- _dac_wakeup_isr(dacp); \
- } \
-}
-
-/**
- * @brief Common ISR code, error event.
- * @details This code handles the portable part of the ISR code:
- * - Callback invocation.
- * - Waiting thread timeout signaling, if any.
- * - Driver state transitions.
- * .
- * @note This macro is meant to be used in the low level drivers
- * implementation only.
- *
- * @param[in] dacp pointer to the @p DACDriver object
- * @param[in] err platform dependent error code
- *
- * @notapi
- */
-#define _dac_isr_error_code(dacp, err) { \
- dac_lld_stop_conversion(dacp); \
- if ((dacp)->grpp->error_cb != NULL) { \
- (dacp)->state = DAC_ERROR; \
- (dacp)->grpp->error_cb(dacp, err); \
- if ((dacp)->state == DAC_ERROR) \
- (dacp)->state = DAC_READY; \
- } \
- (dacp)->grpp = NULL; \
- _dac_timeout_isr(dacp); \
-}
-/** @} */
-
-/*===========================================================================*/
-/* External declarations. */
-/*===========================================================================*/
-
-#ifdef __cplusplus
-extern "C" {
-#endif
- void dacInit(void);
- void dacObjectInit(DACDriver *dacp);
- void dacStart(DACDriver *dacp, const DACConfig *config);
- void dacStop(DACDriver *dacp);
- void dacStartConversion(DACDriver *dacp, const DACConversionGroup *grpp,
- const dacsample_t *samples, size_t depth);
- void dacStartConversionI(DACDriver *dacp, const DACConversionGroup *grpp,
- const dacsample_t *samples, size_t depth);
- void dacStopConversion(DACDriver *dacp);
- void dacStopConversionI(DACDriver *dacp);
-#if DAC_USE_WAIT || defined(__DOXYGEN__)
- msg_t dacConvert(DACDriver *dacp, const DACConversionGroup *grpp,
- const dacsample_t *samples, size_t depth);
-#endif /* DAC_USE_WAIT */
-#if DAC_USE_MUTUAL_EXCLUSION
- void dacAcquireBus(DACDriver *dacp);
- void dacReleaseBus(DACDriver *dacp);
-#endif /* DAC_USE_MUTUAL_EXCLUSION */
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* HAL_USE_DAC */
-
-#endif /* _DAC_H_ */
-
-/** @} */
+/*
+ ChibiOS/HAL - Copyright (C) 2006,2007,2008,2009,2010,
+ 2011,2012,2013,2014 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/HAL
+
+ ChibiOS/HAL 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 dac.h
+ * @brief DAC Driver macros and structures.
+ *
+ * @addtogroup DAC
+ * @{
+ */
+
+#ifndef _DAC_H_
+#define _DAC_H_
+
+#if HAL_USE_DAC || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Driver constants. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver pre-compile time settings. */
+/*===========================================================================*/
+
+/**
+ * @name DAC configuration options
+ * @{
+ */
+/**
+ * @brief Enables synchronous APIs.
+ * @note Disabling this option saves both code and data space.
+ */
+#if !defined(DAC_USE_WAIT) || defined(__DOXYGEN__)
+#define DAC_USE_WAIT TRUE
+#endif
+
+/**
+ * @brief Enables the @p dacAcquireBus() and @p dacReleaseBus() APIs.
+ * @note Disabling this option saves both code and data space.
+ */
+#if !defined(DAC_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
+#define DAC_USE_MUTUAL_EXCLUSION TRUE
+#endif
+/** @} */
+
+/*===========================================================================*/
+/* Derived constants and error checks. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief Driver state machine possible states.
+ */
+typedef enum {
+ DAC_UNINIT = 0, /**< Not initialized. */
+ DAC_STOP = 1, /**< Stopped. */
+ DAC_READY = 2, /**< Ready. */
+ DAC_ACTIVE = 3, /**< Exchanging data. */
+ DAC_COMPLETE = 4, /**< Asynchronous operation complete. */
+ DAC_ERROR = 5 /**< Error. */
+} dacstate_t;
+
+#include "dac_lld.h"
+
+/*===========================================================================*/
+/* Driver macros. */
+/*===========================================================================*/
+
+/**
+ * @name Low Level driver helper macros
+ * @{
+ */
+#if DAC_USE_WAIT || defined(__DOXYGEN__)
+/**
+ * @brief Waits for operation completion.
+ * @details This function waits for the driver to complete the current
+ * operation.
+ * @pre An operation must be running while the function is invoked.
+ * @note No more than one thread can wait on a DAC driver using
+ * this function.
+ *
+ * @param[in] dacp pointer to the @p DACDriver object
+ *
+ * @notapi
+ */
+#define _dac_wait_s(dacp) osalThreadSuspendS(&(dacp)->thread)
+
+/**
+ * @brief Resumes a thread waiting for a conversion completion.
+ *
+ * @param[in] dacp pointer to the @p DACDriver object
+ *
+ * @notapi
+ */
+#define _dac_reset_i(dacp) osalThreadResumeI(&(dacp)->thread, MSG_RESET)
+
+/**
+ * @brief Resumes a thread waiting for a conversion completion.
+ *
+ * @param[in] dacp pointer to the @p DACDriver object
+ *
+ * @notapi
+ */
+#define _dac_reset_s(dacp) osalThreadResumeS(&(dacp)->thread, MSG_RESET)
+
+/**
+ * @brief Wakes up the waiting thread.
+ *
+ * @param[in] dacp pointer to the @p DACDriver object
+ *
+ * @notapi
+ */
+#define _dac_wakeup_isr(dacp) { \
+ osalSysLockFromISR(); \
+ osalThreadResumeI(&(dacp)->thread, MSG_OK); \
+ osalSysUnlockFromISR(); \
+}
+
+/**
+ * @brief Wakes up the waiting thread with a timeout message.
+ *
+ * @param[in] dacp pointer to the @p DACDriver object
+ *
+ * @notapi
+ */
+#define _dac_timeout_isr(dacp) { \
+ osalSysLockFromISR(); \
+ osalThreadResumeI(&(dacp)->thread, MSG_TIMEOUT); \
+ osalSysUnlockFromISR(); \
+}
+
+#else /* !DAC_USE_WAIT */
+#define _dac_wait_s(dacp)
+#define _dac_reset_i(dacp)
+#define _dac_reset_s(dacp)
+#define _dac_wakeup_isr(dacp)
+#define _dac_timeout_isr(dacp)
+#endif /* !DAC_USE_WAIT */
+
+/**
+ * @brief Common ISR code, half buffer event.
+ * @details This code handles the portable part of the ISR code:
+ * - Callback invocation.
+ * .
+ * @note This macro is meant to be used in the low level drivers
+ * implementation only.
+ *
+ * @param[in] dacp pointer to the @p DACDriver object
+ *
+ * @notapi
+ */
+#define _dac_isr_half_code(dacp) { \
+ if ((dacp)->grpp->end_cb != NULL) { \
+ (dacp)->grpp->end_cb(dacp, (dacp)->samples, (dacp)->depth / 2); \
+ } \
+}
+
+/**
+ * @brief Common ISR code, full buffer event.
+ * @details This code handles the portable part of the ISR code:
+ * - Callback invocation.
+ * - Waiting thread wakeup, if any.
+ * - Driver state transitions.
+ * .
+ * @note This macro is meant to be used in the low level drivers
+ * implementation only.
+ *
+ * @param[in] dacp pointer to the @p DACDriver object
+ *
+ * @notapi
+ */
+#define _dac_isr_full_code(dacp) { \
+ if ((dacp)->grpp->circular) { \
+ /* Callback handling.*/ \
+ if ((dacp)->grpp->end_cb != NULL) { \
+ if ((dacp)->depth > 1) { \
+ /* Invokes the callback passing the 2nd half of the buffer.*/ \
+ size_t half = (dacp)->depth / 2; \
+ size_t half_index = half * (dacp)->grpp->num_channels; \
+ (dacp)->grpp->end_cb(dacp, (dacp)->samples + half_index, half); \
+ } \
+ else { \
+ /* Invokes the callback passing the whole buffer.*/ \
+ (dacp)->grpp->end_cb(dacp, (dacp)->samples, (dacp)->depth); \
+ } \
+ } \
+ } \
+ else { \
+ /* End conversion.*/ \
+ dac_lld_stop_conversion(dacp); \
+ if ((dacp)->grpp->end_cb != NULL) { \
+ (dacp)->state = DAC_COMPLETE; \
+ if ((dacp)->depth > 1) { \
+ /* Invokes the callback passing the 2nd half of the buffer.*/ \
+ size_t half = (dacp)->depth / 2; \
+ size_t half_index = half * (dacp)->grpp->num_channels; \
+ (dacp)->grpp->end_cb(dacp, (dacp)->samples + half_index, half); \
+ } \
+ else { \
+ /* Invokes the callback passing the whole buffer.*/ \
+ (dacp)->grpp->end_cb(dacp, (dacp)->samples, (dacp)->depth); \
+ } \
+ if ((dacp)->state == DAC_COMPLETE) { \
+ (dacp)->state = DAC_READY; \
+ (dacp)->grpp = NULL; \
+ } \
+ } \
+ else { \
+ (dacp)->state = DAC_READY; \
+ (dacp)->grpp = NULL; \
+ } \
+ _dac_wakeup_isr(dacp); \
+ } \
+}
+
+/**
+ * @brief Common ISR code, error event.
+ * @details This code handles the portable part of the ISR code:
+ * - Callback invocation.
+ * - Waiting thread timeout signaling, if any.
+ * - Driver state transitions.
+ * .
+ * @note This macro is meant to be used in the low level drivers
+ * implementation only.
+ *
+ * @param[in] dacp pointer to the @p DACDriver object
+ * @param[in] err platform dependent error code
+ *
+ * @notapi
+ */
+#define _dac_isr_error_code(dacp, err) { \
+ dac_lld_stop_conversion(dacp); \
+ if ((dacp)->grpp->error_cb != NULL) { \
+ (dacp)->state = DAC_ERROR; \
+ (dacp)->grpp->error_cb(dacp, err); \
+ if ((dacp)->state == DAC_ERROR) \
+ (dacp)->state = DAC_READY; \
+ } \
+ (dacp)->grpp = NULL; \
+ _dac_timeout_isr(dacp); \
+}
+/** @} */
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void dacInit(void);
+ void dacObjectInit(DACDriver *dacp);
+ void dacStart(DACDriver *dacp, const DACConfig *config);
+ void dacStop(DACDriver *dacp);
+ void dacStartConversion(DACDriver *dacp, const DACConversionGroup *grpp,
+ const dacsample_t *samples, size_t depth);
+ void dacStartConversionI(DACDriver *dacp, const DACConversionGroup *grpp,
+ const dacsample_t *samples, size_t depth);
+ void dacStopConversion(DACDriver *dacp);
+ void dacStopConversionI(DACDriver *dacp);
+#if DAC_USE_WAIT || defined(__DOXYGEN__)
+ msg_t dacConvert(DACDriver *dacp, const DACConversionGroup *grpp,
+ const dacsample_t *samples, size_t depth);
+#endif /* DAC_USE_WAIT */
+#if DAC_USE_MUTUAL_EXCLUSION
+ void dacAcquireBus(DACDriver *dacp);
+ void dacReleaseBus(DACDriver *dacp);
+#endif /* DAC_USE_MUTUAL_EXCLUSION */
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* HAL_USE_DAC */
+
+#endif /* _DAC_H_ */
+
+/** @} */
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-14 01:19:41 +0000