Simplify afsk testing harness.

[bertos.git] / bertos / hw / hw_afsk.h

diff --git a/bertos/hw/hw_afsk.h b/bertos/hw/hw_afsk.h
index 74ebfcd595a01a9aadbda10bbcf05e9513ddaace..ec9b8be2e71a8bc62e138c58221050e17a1528b0 100644 (file)
--- a/bertos/hw/hw_afsk.h
+++ b/bertos/hw/hw_afsk.h
@@ -42,46 +42,46 @@
 
 #include "cfg/cfg_arch.h"
 
-#if !(ARCH & ARCH_UNITTEST)
-       #warning TODO:This is an example implementation, you must implement it!
+#warning TODO:This is an example implementation, you must implement it!
 
-       #define AFSK_ADC_INIT(ch, ctx) do { (void)ch, (void)ctx; } while (0)
-
-       #define AFSK_STROBE_INIT() do { /* Implement me */ } while (0)
-       #define AFSK_STROBE_ON()   do { /* Implement me */ } while (0)
-       #define AFSK_STROBE_OFF()  do { /* Implement me */ } while (0)
-
-       #define AFSK_DAC_INIT(ch, ctx)   do { (void)ch, (void)ctx; } while (0)
-       #define AFSK_DAC_IRQ_START(ch)   do { (void)ch; /* Implement me */ } while (0)
-       #define AFSK_DAC_IRQ_STOP(ch)    do { (void)ch; /* Implement me */ } while (0)
-       #define AFSK_DAC_SET(ch, val)    do { (void)ch; (void)val; } while (0)
-#else /* (ARCH & ARCH_UNITTEST) */
-
-       #include <stdio.h>
-       #include <cfg/compiler.h>
-
-       /* For test */
-       extern uint32_t data_written;
-       extern FILE *fp_dac;
-       extern bool afsk_tx_test;
+/**
+ * Initialize the specified channel of the ADC for AFSK needs.
+ * The adc should be configured to have a continuos stream of convertions.
+ * For every convertion there must be an ISR that read the sample
+ * and call afsk_adc_isr(), passing the context and the sample.
+ *
+ * \param ch channel to be used for AFSK demodulation.
+ * \param ctx AFSK context (\see Afsk). This parameter must be saved and
+ *            passed back to afsk_adc_isr() for every convertion.
+ */
+#define AFSK_ADC_INIT(ch, ctx) do { (void)ch, (void)ctx; } while (0)
 
-       #define AFSK_ADC_INIT(ch, ctx)    do { (void)ch, (void)ctx; } while (0)
+#define AFSK_STROBE_INIT() do { /* Implement me */ } while (0)
+#define AFSK_STROBE_ON()   do { /* Implement me */ } while (0)
+#define AFSK_STROBE_OFF()  do { /* Implement me */ } while (0)
 
-       #define AFSK_STROBE_INIT()  /* Implement me */
-       #define AFSK_STROBE_ON()    /* Implement me */
-       #define AFSK_STROBE_OFF()   /* Implement me */
+/**
+ * Initialize the specified channel of the DAC for AFSK needs.
+ * The DAC has to be configured in order to call an ISR for every sample sent.
+ * The DAC doesn't have to start the IRQ immediatly but have to wait
+ * the AFSK driver to call AFSK_DAC_IRQ_START().
+ * The ISR must then call afsk_dac_isr() passing the AFSK context.
+ * \param ch DAC channel to be used for AFSK modulation.
+ * \param ctx AFSK context (\see Afsk).  This parameter must be saved and
+ *             passed back to afsk_dac_isr() for every convertion.
+ */
+#define AFSK_DAC_INIT(ch, ctx)   do { (void)ch, (void)ctx; } while (0)
 
-       #define AFSK_DAC_INIT(ch, ctx)   do { (void)ch, (void)ctx; } while (0)
-       #define AFSK_DAC_IRQ_START(ch)   do { (void)ch; afsk_tx_test = true; } while (0)
-       #define AFSK_DAC_IRQ_STOP(ch)    do { (void)ch; afsk_tx_test = false; } while (0)
-       #define AFSK_DAC_SET(ch, _val)     \
-       do { \
-               (void)ch; \
-               int8_t val = (_val) - 128; \
-               ASSERT(fwrite(&val, 1, sizeof(val), fp_dac) == sizeof(val)); \
-               data_written++; \
-       } while (0)
+/**
+ * Start DAC convertions on channel \a ch.
+ * \param ch DAC channel.
+ */
+#define AFSK_DAC_IRQ_START(ch)   do { (void)ch; /* Implement me */ } while (0)
 
-#endif /* !(ARCH & ARCH_UNITTEST) */
+/**
+ * Stop DAC convertions on channel \a ch.
+ * \param ch DAC channel.
+ */
+#define AFSK_DAC_IRQ_STOP(ch)    do { (void)ch; /* Implement me */ } while (0)
 
 #endif /* HW_AFSK_H */