]> oss.titaniummirror.com Git - tinyos-2.x.git/blobdiff - tos/chips/msp430/adc12/Msp430Adc12.h
GCC 4.4.3 seems to have proper bitfield support.
[tinyos-2.x.git] / tos / chips / msp430 / adc12 / Msp430Adc12.h
index a8f9aa6712f9bb08c7b17ed7ed33a3b5d278bfb5..6cbce0175d4ca765e5d182e682a62070178f6b06 100644 (file)
@@ -1,5 +1,5 @@
 /* 
- * Copyright (c) 2004, Technische Universitaet Berlin
+ * Copyright (c) 2006, Technische Universitaet Berlin
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
 #define MSP430ADC12_H
 #include "Msp430RefVoltGenerator.h"
 
-#define P6PIN_AUTO_CONFIGURE
+#define ADC12_TIMERA_ENABLED
+#define ADC12_P6PIN_AUTO_CONFIGURE
+#define ADC12_CHECK_ARGS
+//#define ADC12_ONLY_WITH_DMA
+
+// for HIL clients 
 #define REF_VOLT_AUTO_CONFIGURE
-#define CHECK_ARGS
-
-/*
- * The msp430adc12_channel_config_t encapsulates all relevant flags for
- * sampling a single ADC12 channel on a per-client basis.  They are taken from
- * the following MSP430 registers: ADC12CTL0, ADC12CTL1, ADC12MCTLx and TACTL
- * of TimerA (if applicable) and named according to section "17.3 ADC12
- * Registers" of the "MSP430x1xx Family User's Guide",
- * http://focus.ti.com/lit/ug/slau049e/slau049e.pdf).
- *
- * .inch: ADC12 input channel (ADC12MCTLx register). An (external) input channel 
- *        maps to one of msp430's A0-A7 pins (see device specific data sheet).
- *
- * .sref: reference voltage (ADC12MCTLx register). If
- *        REFERENCE_VREFplus_AVss or REFERENCE_VREFplus_VREFnegterm is chosen
- *        AND the client wires to Msp430Adc12RefVoltAutoClientC (or
- *        REF_VOLT_AUTO_CONFIGURE is defined and the client wires to
- *        AdcReadClientC, AdcReadNowClientC or AdcReadStreamClientC) then the
- *        reference voltage generator is automatically switched on to the
- *        voltage level defined by the "ref2_5v" flag (see below) whenever the
- *        client accesses the ADC12. Otherwise both flags are ignored.
- * 
- * .ref2_5v: Reference generator voltage level (ADC12CTL0 register). See
- *        explanation to "sref" flag.
- * 
- * .adc12ssel: ADC12 clock source select for the sample-hold-time
- *        (ADC12CTL1 register). In combination the "adc12ssel", "adc12div" and
- *        "sht" define the sample-hold-time: "adc12ssel" defines the clock
- *        source, "adc12div" defines the ADC12 clock divider and "sht" define
- *        the time expressed in jiffies.
- *
- * .adc12div: ADC12 clock divider (ADC12CTL1 register). See "adc12ssel".
- *
- * .sht: Sample-and-hold time (ADC12CTL1 register). See "adc12ssel".
- * 
- * .sampcon_ssel: In combination with "sampcon_id" and the "jiffies"
- *        parameter in the Msp430Adc12SingleChannel interface commands the
- *        "sampcon_ssel" defines the sampling rate (TASSEL in TACTL register,
- *        TimerA). It is the clock source for the SAMPCON signal, which
- *        triggers the actual sampling. It is ignored when
- *        Msp430Adc12SingleChannel.getSingleData() is used or the "jiffies"
- *        parameter is zero; otherwise the SAMPCON signal is sourced from
- *        TimerA, so that the multiple conversion mode can be made with the
- *        user defined sampling rate.
- * 
- * .sampcon_id: Input divider for "sampcon_ssel"  (IDx in TACTL
- *        register, TimerA). See "sampcon_ssel".
- *
- * 
- *                   **********************************
- *                    
- * EXAMPLE: Assuming that SMCLK runs at 1 MHz the following command fills the
- * user buffer with 2000 conversion results sampled on channel A2 with a
- * sampling rate of 4000 Hz, i.e. the multipleDataReady() event is signalled
- * after 500 ms. Note that the sampling rate is defined by the combination of
- * SAMPCON_SOURCE_SMCLK, SAMPCON_CLOCK_DIV_1 and the "jiffies" parameter of
- * 250.  
- *
- * 
- * uint16_t buffer[2000];
- * msp430adc12_channel_config_t config = {
- *   INPUT_CHANNEL_A2, REFERENCE_VREFplus_AVss, REFVOLT_LEVEL_1_5,
- *   SHT_SOURCE_SMCLK, SHT_CLOCK_DIV_1, SAMPLE_HOLD_64_CYCLES,
- *   SAMPCON_SOURCE_SMCLK, SAMPCON_CLOCK_DIV_1 
- * };
- * 
- * event void Resource.granted() 
- * { 
- *  if (call SingleChannel.getMultipleData(&config, buffer, 2000, 250)
- *       == SUCCESS)
- *   {
- *     // .. multipleDataReady() event will be signalled in 500ms
- *   } else {
- *     // check error
- *   } 
- * }
- */
 
 typedef struct { 
+  // see README.txt
   unsigned int inch: 4;            // input channel 
   unsigned int sref: 3;            // reference voltage 
   unsigned int ref2_5v: 1;         // reference voltage level 
@@ -130,6 +58,15 @@ typedef struct {
   unsigned int : 0;                // align to a word boundary 
 } msp430adc12_channel_config_t;
 
+typedef struct 
+{
+  // see README.txt
+  volatile unsigned
+  inch: 4,                                     // input channel
+  sref: 3,                                     // reference voltage
+  eos: 1;                                      // end of sequence flag
+} __attribute__ ((packed)) adc12memctl_t;
+
 enum inch_enum
 {  
    // see device specific data sheet which pin Ax is mapped to
@@ -227,24 +164,23 @@ enum sampcon_id_enum
 // The unique string for accessing HAL2 via ReadStream
 #define ADCC_READ_STREAM_SERVICE "AdcC.ReadStream.Client"
 
-
-typedef struct 
-{
-  volatile unsigned
-  inch: 4,                                     // input channel
-  sref: 3,                                     // reference voltage
-  eos: 1;                                      // end of sequence flag
-} __attribute__ ((packed)) adc12memctl_t;
-
-/* Test for GCC bug (bitfield access) - only version 3.2.3 is known to be stable */
-// check: is this relevant anymore ?
+/* Test for GCC bug (bitfield access) - versions 3.2.3 and 4.4.3 are known to
+ * be stable
+ */
+// TODO: check whether this is still relevant...
 #define GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__ * 10 + __GNUC_PATCHLEVEL__)
 #if GCC_VERSION == 332
 #error "The msp430-gcc version (3.3.2) contains a bug which results in false accessing \
 of bitfields in structs and makes MSP430ADC12M.nc fail ! Use version 3.2.3 instead."
 #elif GCC_VERSION != 323
+#if GCC_VERSION < 443
 #warning "This version of msp430-gcc might contain a bug which results in false accessing \
 of bitfields in structs (MSP430ADC12M.nc would fail). Use version 3.2.3 instead."
+#endif
 #endif  
 
+#ifndef __msp430_have_adc12
+#error MSP430ADC12C: Target msp430 device does not have ADC12 module
+#endif
+
 #endif