git.gag.com Git - fw/altos/blob - src/core/ao_data.h

   1 /*
   2  * Copyright © 2012 Keith Packard <keithp@keithp.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; version 2 of the License.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  16  */
  17
  18 #ifndef _AO_DATA_H_
  19 #define _AO_DATA_H_
  20
  21 #if HAS_ADC
  22 #define AO_DATA_ADC     (1 << 0)
  23 #else
  24 #define AO_DATA_ADC     0
  25 #endif
  26
  27 #if HAS_MS5607
  28 #include <ao_ms5607.h>
  29 #define AO_DATA_MS5607  (1 << 1)
  30 #else
  31 #define AO_DATA_MS5607  0
  32 #endif
  33
  34 #if HAS_MPU6000
  35 #include <ao_mpu6000.h>
  36 #define AO_DATA_MPU6000 (1 << 2)
  37 #else
  38 #define AO_DATA_MPU6000 0
  39 #endif
  40
  41 #if HAS_HMC5883
  42 #include <ao_hmc5883.h>
  43 #define AO_DATA_HMC5883 (1 << 3)
  44 #else
  45 #define AO_DATA_HMC5883 0
  46 #endif
  47
  48 #if HAS_MMA655X
  49 #include <ao_mma655x.h>
  50 #define AO_DATA_MMA655X (1 << 4)
  51 #else
  52 #define AO_DATA_MMA655X 0
  53 #endif
  54
  55 #ifdef AO_DATA_RING
  56
  57 #define AO_DATA_ALL     (AO_DATA_ADC|AO_DATA_MS5607|AO_DATA_MPU6000|AO_DATA_HMC5883|AO_DATA_MMA655X)
  58
  59 struct ao_data {
  60         uint16_t                        tick;
  61 #if HAS_ADC
  62         struct ao_adc                   adc;
  63 #endif
  64 #if HAS_MS5607
  65         struct ao_ms5607_sample         ms5607_raw;
  66         struct ao_ms5607_value          ms5607_cooked;
  67 #endif
  68 #if HAS_MPU6000
  69         struct ao_mpu6000_sample        mpu6000;
  70 #if !HAS_MMA655X
  71         int16_t                         z_accel;
  72 #endif
  73 #endif
  74 #if HAS_HMC5883
  75         struct ao_hmc5883_sample        hmc5883;
  76 #endif
  77 #if HAS_MMA655X
  78         uint16_t                        mma655x;
  79 #endif
  80 };
  81
  82 #define ao_data_ring_next(n)    (((n) + 1) & (AO_DATA_RING - 1))
  83 #define ao_data_ring_prev(n)    (((n) - 1) & (AO_DATA_RING - 1))
  84
  85 /* Get a copy of the last complete sample set */
  86 void
  87 ao_data_get(__xdata struct ao_data *packet);
  88
  89 extern volatile __xdata struct ao_data  ao_data_ring[AO_DATA_RING];
  90 extern volatile __data uint8_t          ao_data_head;
  91 extern volatile __data uint8_t          ao_data_present;
  92 extern volatile __data uint8_t          ao_data_count;
  93
  94 /*
  95  * Mark a section of data as ready, check for data complete
  96  */
  97 #define AO_DATA_PRESENT(bit)    (ao_data_present |= (bit))
  98
  99 /*
 100  * Wait until it is time to write a sensor sample; this is
 101  * signaled by the timer tick
 102  */
 103 #define AO_DATA_WAIT() do {                             \
 104                 ao_sleep(DATA_TO_XDATA ((void *) &ao_data_count));      \
 105         } while (0)
 106
 107 #endif /* AO_DATA_RING */
 108
 109 #if !HAS_BARO && HAS_MS5607
 110
 111 /* Either an MS5607 or an MS5611 hooked to a SPI port
 112  */
 113
 114 #define HAS_BARO        1
 115
 116 typedef int32_t pres_t;
 117
 118 #ifndef AO_ALT_TYPE
 119 #define AO_ALT_TYPE     int32_t
 120 #endif
 121
 122 typedef AO_ALT_TYPE     alt_t;
 123
 124 #define ao_data_pres_cook(packet)       ao_ms5607_convert(&packet->ms5607_raw, &packet->ms5607_cooked)
 125
 126 #define ao_data_pres(packet)    ((packet)->ms5607_cooked.pres)
 127 #define ao_data_temp(packet)    ((packet)->ms5607_cooked.temp)
 128
 129 #define pres_to_altitude(p)     ao_pa_to_altitude(p)
 130
 131 #endif
 132
 133 #if !HAS_BARO && HAS_ADC
 134
 135 #define HAS_BARO        1
 136
 137 typedef int16_t pres_t;
 138 typedef int16_t alt_t;
 139
 140 #define ao_data_pres(packet)    ((packet)->adc.pres)
 141 #define ao_data_temp(packet)    ((packet)->adc.temp)
 142 #define pres_to_altitude(p)     ao_pres_to_altitude(p)
 143 #define ao_data_pres_cook(p)
 144
 145 #endif
 146
 147 #if !HAS_BARO
 148 typedef int16_t alt_t;
 149 #endif
 150
 151 /*
 152  * Need a few macros to pull data from the sensors:
 153  *
 154  * ao_data_accel_sample - pull raw sensor and convert to normalized values
 155  * ao_data_accel        - pull normalized value (lives in the same memory)
 156  * ao_data_set_accel    - store normalized value back in the sensor location
 157  * ao_data_accel_invert - flip rocket ends for positive acceleration
 158  */
 159
 160 #if HAS_ACCEL
 161
 162 /* This section is for an analog accelerometer hooked to one of the ADC pins. As
 163  * those are 5V parts, this also requires that the 5V supply be hooked to to anothe ADC
 164  * pin so that the both can be measured to correct for changes between the 3.3V and 5V rails
 165  */
 166
 167 typedef int16_t accel_t;
 168 #define ao_data_accel(packet)                   ((packet)->adc.accel)
 169 #define ao_data_set_accel(packet, a)            ((packet)->adc.accel = (a))
 170 #define ao_data_accel_invert(a)                 (0x7fff -(a))
 171
 172 /*
 173  * Ok, the math here is a bit tricky.
 174  *
 175  * ao_sample_accel:  ADC output for acceleration
 176  * ao_accel_ref:  ADC output for the 5V reference.
 177  * ao_cook_accel: Corrected acceleration value
 178  * Vcc:           3.3V supply to the CC1111
 179  * Vac:           5V supply to the accelerometer
 180  * accel:         input voltage to accelerometer ADC pin
 181  * ref:           input voltage to 5V reference ADC pin
 182  *
 183  *
 184  * Measured acceleration is ratiometric to Vcc:
 185  *
 186  *     ao_sample_accel   accel
 187  *     ------------ = -----
 188  *        32767        Vcc
 189  *
 190  * Measured 5v reference is also ratiometric to Vcc:
 191  *
 192  *     ao_accel_ref    ref
 193  *     ------------ = -----
 194  *        32767        Vcc
 195  *
 196  *
 197  *      ao_accel_ref = 32767 * (ref / Vcc)
 198  *
 199  * Acceleration is measured ratiometric to the 5V supply,
 200  * so what we want is:
 201  *
 202  *      ao_cook_accel    accel
 203  *      ------------- =  -----
 204  *          32767         ref
 205  *
 206  *
 207  *                      accel    Vcc
 208  *                    = ----- *  ---
 209  *                       Vcc     ref
 210  *
 211  *                      ao_sample_accel       32767
 212  *                    = ------------ *  ------------
 213  *                         32767        ao_accel_ref
 214  *
 215  * Multiply through by 32767:
 216  *
 217  *                      ao_sample_accel * 32767
 218  *      ao_cook_accel = --------------------
 219  *                          ao_accel_ref
 220  *
 221  * Now, the tricky part. Getting this to compile efficiently
 222  * and keeping all of the values in-range.
 223  *
 224  * First off, we need to use a shift of 16 instead of * 32767 as SDCC
 225  * does the obvious optimizations for byte-granularity shifts:
 226  *
 227  *      ao_cook_accel = (ao_sample_accel << 16) / ao_accel_ref
 228  *
 229  * Next, lets check our input ranges:
 230  *
 231  *      0 <= ao_sample_accel <= 0x7fff          (singled ended ADC conversion)
 232  *      0x7000 <= ao_accel_ref <= 0x7fff        (the 5V ref value is close to 0x7fff)
 233  *
 234  * Plugging in our input ranges, we get an output range of 0 - 0x12490,
 235  * which is 17 bits. That won't work. If we take the accel ref and shift
 236  * by a bit, we'll change its range:
 237  *
 238  *      0xe000 <= ao_accel_ref<<1 <= 0xfffe
 239  *
 240  *      ao_cook_accel = (ao_sample_accel << 16) / (ao_accel_ref << 1)
 241  *
 242  * Now the output range is 0 - 0x9248, which nicely fits in 16 bits. It
 243  * is, however, one bit too large for our signed computations. So, we
 244  * take the result and shift that by a bit:
 245  *
 246  *      ao_cook_accel = ((ao_sample_accel << 16) / (ao_accel_ref << 1)) >> 1
 247  *
 248  * This finally creates an output range of 0 - 0x4924. As the ADC only
 249  * provides 11 bits of data, we haven't actually lost any precision,
 250  * just dropped a bit of noise off the low end.
 251  */
 252
 253 #if HAS_ACCEL_REF
 254
 255 #define ao_data_accel_cook(packet) \
 256         ((uint16_t) ((((uint32_t) (packet)->adc.accel << 16) / ((packet)->adc.accel_ref << 1))) >> 1)
 257
 258 #else
 259
 260 #define ao_data_accel_cook(packet) ((packet)->adc.accel)
 261
 262 #endif /* HAS_ACCEL_REF */
 263
 264 #endif  /* HAS_ACCEL */
 265
 266 #if !HAS_ACCEL && HAS_MMA655X
 267
 268 #define HAS_ACCEL       1
 269
 270 typedef int16_t accel_t;
 271
 272 /* MMA655X is hooked up so that positive values represent negative acceleration */
 273
 274 #define ao_data_accel(packet)                   ((packet)->mma655x)
 275 #if AO_MMA655X_INVERT
 276 #define ao_data_accel_cook(packet)              (4095 - (packet)->mma655x)
 277 #else
 278 #define ao_data_accel_cook(packet)              ((packet)->mma655x)
 279 #endif
 280 #define ao_data_set_accel(packet, accel)        ((packet)->mma655x = (accel))
 281 #define ao_data_accel_invert(accel)             (4095 - (accel))
 282
 283 #endif
 284
 285 #if !HAS_ACCEL && HAS_MPU6000
 286
 287 #define HAS_ACCEL       1
 288
 289 typedef int16_t accel_t;
 290
 291 /* MPU6000 is hooked up so that positive y is positive acceleration */
 292 #define ao_data_accel(packet)                   ((packet)->z_accel)
 293 #define ao_data_accel_cook(packet)              (-(packet)->mpu6000.accel_y)
 294 #define ao_data_set_accel(packet, accel)        ((packet)->z_accel = (accel))
 295 #define ao_data_accel_invert(a)                 (-(a))
 296
 297 #endif
 298
 299 #if !HAS_GYRO && HAS_MPU6000
 300
 301 #define HAS_GYRO        1
 302
 303 typedef int16_t gyro_t;
 304 typedef int32_t angle_t;
 305
 306 /* Y axis is aligned with the direction of motion (along) */
 307 /* X axis is aligned in the other board axis (across) */
 308 /* Z axis is aligned perpendicular to the board (through) */
 309
 310 #define ao_data_along(packet)   ((packet)->mpu6000.accel_y)
 311 #define ao_data_across(packet)  ((packet)->mpu6000.accel_x)
 312 #define ao_data_through(packet) ((packet)->mpu6000.accel_z)
 313
 314 #define ao_data_roll(packet)    ((packet)->mpu6000.gyro_y)
 315 #define ao_data_pitch(packet)   ((packet)->mpu6000.gyro_x)
 316 #define ao_data_yaw(packet)     ((packet)->mpu6000.gyro_z)
 317
 318 #endif
 319
 320 #endif /* _AO_DATA_H_ */