diff options
Diffstat (limited to 'os/io/templates')
| -rw-r--r-- | os/io/templates/adc_lld.c | 93 | ||||
| -rw-r--r-- | os/io/templates/adc_lld.h | 77 | ||||
| -rw-r--r-- | os/io/templates/spi_lld.h | 2 |
3 files changed, 170 insertions, 2 deletions
diff --git a/os/io/templates/adc_lld.c b/os/io/templates/adc_lld.c new file mode 100644 index 000000000..0f3246cf0 --- /dev/null +++ b/os/io/templates/adc_lld.c @@ -0,0 +1,93 @@ +/*
+ 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/adc_lld.c
+ * @brief ADC Driver subsystem low level driver source template
+ * @addtogroup ADC_LLD
+ * @{
+ */
+
+#include <ch.h>
+#include <adc.h>
+
+/*===========================================================================*/
+/* Low Level Driver local functions. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Low Level Driver interrupt handlers. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Low Level Driver exported functions. */
+/*===========================================================================*/
+
+/**
+ * @brief Low level ADC driver initialization.
+ */
+void adc_lld_init(void) {
+
+}
+
+/**
+ * @brief Configures and activates the ADC peripheral.
+ *
+ * @param[in] adcp pointer to the @p ADCDriver object
+ */
+void adc_lld_start(ADCDriver *adcp) {
+
+ if (adcp->spd_state == ADC_STOP) {
+ /* Clock activation.*/
+ }
+ /* Configuration.*/
+}
+
+/**
+ * @brief Deactivates the ADC peripheral.
+ *
+ * @param[in] adcp pointer to the @p ADCDriver object
+ */
+void adc_lld_stop(ADCDriver *adcp) {
+
+}
+
+/**
+ * @brief Starts an ADC conversion.
+ *
+ * @param[in] adcp pointer to the @p ADCDriver object
+ * @param[in] grpp pointer to a @p ADCConversionGroup object
+ * @param[out] samples pointer to the samples buffer
+ */
+void adc_lld_start_conversion(ADCDriver *adcp,
+ ADCConversionGroup *grpp,
+ void *samples) {
+
+}
+
+/**
+ * @brief Stops an ongoing conversion.
+ *
+ * @param[in] adcp pointer to the @p ADCDriver object
+ */
+void adc_lld_stop_conversion(ADCDriver *adcp) {
+
+}
+
+/** @} */
diff --git a/os/io/templates/adc_lld.h b/os/io/templates/adc_lld.h index ab8a48bf9..6fde9c181 100644 --- a/os/io/templates/adc_lld.h +++ b/os/io/templates/adc_lld.h @@ -32,10 +32,85 @@ /*===========================================================================*/
/*===========================================================================*/
+/* Driver constants. */
+/*===========================================================================*/
+
+/**
+ * @brief Linear buffering mode.
+ * @details In the linear buffering mode the buffer is filled one time and
+ * then the operation automatically stops. + */
+#define ADC_GROUP_BUFFER_LINEAR 0
+
+/**
+ * @brief Circular buffering mode.
+ * @details In the circular buffering mode the buffer is filled one time and
+ * then the operation automatically starts again.
+ */
+#define ADC_GROUP_BUFFER_CIRCULAR 1
+
+/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
+ * @brief ADC sample data type. + */
+typedef uint16_t adcsample_t;
+
+/**
+ * @brief Channels number in a conversion group.
+ */
+typedef uint16_t adc_channels_num_t;
+
+/**
+ * @brief Samples buffer depth.
+ */
+typedef uint16_t adc_buffer_depth_t;
+
+/**
+ * @brief ADC notification callback type.
+ * @param[in] buffer pointer to the most recent samples data
+ * @param[in] n number of buffer rows available starting from @p buffer + */
+typedef void (*adccallback_t)(adcsample_t *buffer,
+ adc_buffer_depth_t n);
+
+/**
+ * @brief Conversion group configuration structure.
+ * @details This implementation-dependent structure describes a conversion
+ * operation. + */
+typedef struct {
+ /**
+ * @brief Group mode flags. + */
+ uint_least8_t acg_mode;
+
+ /**
+ * @brief Number of the analog channels belonging to the conversion group. + */
+ adc_channels_num_t acg_num_channels;
+
+ /**
+ * @brief Samples buffer depth.
+ * @note The buffer depth must be an even number or one. The 50% callback
+ * behavior for buffers with odd depth is unspecified. + */
+ adc_buffer_depth_t acg_buffer_depth;
+
+ /**
+ * @brief Data streaming callback.
+ * @details This callback is invoked at 50% and 100% buffer fill level in
+ * order to allow realtime processing of the conversion results
+ * when the circular buffer mode is selected.
+ * @note The 50% callback is only invoked if @p acg_num_samples is greater
+ * than 1.
+ */
+ adccallback_t acg_callback;
+} ADCConversionGroup;
+
+/**
* @brief Driver configuration structure.
*/
typedef struct {
@@ -43,7 +118,7 @@ typedef struct { } ADCConfig;
/**
- * @brief Structure representing a MAC driver.
+ * @brief Structure representing an ADC driver.
*/
typedef struct {
/**
diff --git a/os/io/templates/spi_lld.h b/os/io/templates/spi_lld.h index e25dc86dd..23a1f094b 100644 --- a/os/io/templates/spi_lld.h +++ b/os/io/templates/spi_lld.h @@ -58,7 +58,7 @@ typedef struct { } SPIConfig;
/**
- * @brief Structure representing a MAC driver.
+ * @brief Structure representing a SPI driver.
*/
typedef struct {
/**
|