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