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 #if HAS_ADXL375
  66 #include <ao_adxl375.h>
  67 #define AO_DATA_ADXL375 (1 << 4)
  68 #else
  69 #define AO_DATA_ADXL375 0
  70 #endif
  71
  72 #ifdef AO_DATA_RING
  73
  74 #define AO_DATA_ALL     (AO_DATA_ADC|AO_DATA_MS5607|AO_DATA_MPU6000|AO_DATA_HMC5883|AO_DATA_MMA655X|AO_DATA_MPU9250|AO_DATA_ADXL375)
  75
  76 struct ao_data {
  77         uint16_t                        tick;
  78 #if HAS_ADC
  79         struct ao_adc                   adc;
  80 #endif
  81 #if HAS_MS5607
  82         struct ao_ms5607_sample         ms5607_raw;
  83         struct ao_ms5607_value          ms5607_cooked;
  84 #endif
  85 #if HAS_MPU6000
  86         struct ao_mpu6000_sample        mpu6000;
  87 #if !HAS_MMA655X
  88         int16_t                         z_accel;
  89 #endif
  90 #endif
  91 #if HAS_MPU9250
  92         struct ao_mpu9250_sample        mpu9250;
  93 #endif
  94 #if HAS_HMC5883
  95         struct ao_hmc5883_sample        hmc5883;
  96 #endif
  97 #if HAS_MMA655X
  98         uint16_t                        mma655x;
  99 #endif
 100 #if HAS_ADXL375
 101         struct ao_adxl375_sample        adxl375;
 102 #endif
 103 };
 104
 105 #define ao_data_ring_next(n)    (((n) + 1) & (AO_DATA_RING - 1))
 106 #define ao_data_ring_prev(n)    (((n) - 1) & (AO_DATA_RING - 1))
 107
 108 /* Get a copy of the last complete sample set */
 109 void
 110 ao_data_get(struct ao_data *packet);
 111
 112 extern volatile struct ao_data  ao_data_ring[AO_DATA_RING];
 113 extern volatile uint8_t         ao_data_head;
 114 extern volatile uint8_t         ao_data_present;
 115 extern volatile uint8_t         ao_data_count;
 116
 117 /*
 118  * Mark a section of data as ready, check for data complete
 119  */
 120 #define AO_DATA_PRESENT(bit)    (ao_data_present |= (bit))
 121
 122 /*
 123  * Wait until it is time to write a sensor sample; this is
 124  * signaled by the timer tick
 125  */
 126 #define AO_DATA_WAIT()          ao_sleep((void *) &ao_data_count)
 127
 128 #endif /* AO_DATA_RING */
 129
 130 #if !HAS_BARO && HAS_MS5607
 131
 132 /* Either an MS5607 or an MS5611 hooked to a SPI port
 133  */
 134
 135 #define HAS_BARO        1
 136
 137 typedef int32_t pres_t;
 138
 139 #define AO_ALT_TYPE     int32_t
 140
 141 typedef AO_ALT_TYPE     alt_t;
 142
 143 #define ao_data_pres_cook(packet)       ao_ms5607_convert(&packet->ms5607_raw, &packet->ms5607_cooked)
 144
 145 #define ao_data_pres(packet)    ((packet)->ms5607_cooked.pres)
 146 #define ao_data_temp(packet)    ((packet)->ms5607_cooked.temp)
 147
 148 #define pres_to_altitude(p)     ao_pa_to_altitude(p)
 149
 150 #endif
 151
 152 #if !HAS_BARO && HAS_ADC
 153
 154 #define HAS_BARO        1
 155
 156 typedef int16_t pres_t;
 157 typedef int16_t alt_t;
 158
 159 #define ao_data_pres(packet)    ((packet)->adc.pres)
 160 #define ao_data_temp(packet)    ((packet)->adc.temp)
 161 #define pres_to_altitude(p)     ao_pres_to_altitude(p)
 162 #define ao_data_pres_cook(p)
 163
 164 #endif
 165
 166 /*
 167  * Need a few macros to pull data from the sensors:
 168  *
 169  * ao_data_accel_sample - pull raw sensor and convert to normalized values
 170  * ao_data_accel        - pull normalized value (lives in the same memory)
 171  * ao_data_set_accel    - store normalized value back in the sensor location
 172  * ao_data_accel_invert - flip rocket ends for positive acceleration
 173  */
 174
 175 #if HAS_ACCEL
 176
 177 /* This section is for an analog accelerometer hooked to one of the ADC pins. As
 178  * those are 5V parts, this also requires that the 5V supply be hooked to to anothe ADC
 179  * pin so that the both can be measured to correct for changes between the 3.3V and 5V rails
 180  */
 181
 182 typedef int16_t accel_t;
 183 #define ao_data_accel(packet)                   ((packet)->adc.accel)
 184 #define ao_data_set_accel(packet, a)            ((packet)->adc.accel = (a))
 185 #define ao_data_accel_invert(a)                 (0x7fff -(a))
 186
 187 /*
 188  * Ok, the math here is a bit tricky.
 189  *
 190  * ao_sample_accel:  ADC output for acceleration
 191  * ao_accel_ref:  ADC output for the 5V reference.
 192  * ao_cook_accel: Corrected acceleration value
 193  * Vcc:           3.3V supply to the CC1111
 194  * Vac:           5V supply to the accelerometer
 195  * accel:         input voltage to accelerometer ADC pin
 196  * ref:           input voltage to 5V reference ADC pin
 197  *
 198  *
 199  * Measured acceleration is ratiometric to Vcc:
 200  *
 201  *     ao_sample_accel   accel
 202  *     ------------ = -----
 203  *        32767        Vcc
 204  *
 205  * Measured 5v reference is also ratiometric to Vcc:
 206  *
 207  *     ao_accel_ref    ref
 208  *     ------------ = -----
 209  *        32767        Vcc
 210  *
 211  *
 212  *      ao_accel_ref = 32767 * (ref / Vcc)
 213  *
 214  * Acceleration is measured ratiometric to the 5V supply,
 215  * so what we want is:
 216  *
 217  *      ao_cook_accel    accel
 218  *      ------------- =  -----
 219  *          32767         ref
 220  *
 221  *
 222  *                      accel    Vcc
 223  *                    = ----- *  ---
 224  *                       Vcc     ref
 225  *
 226  *                      ao_sample_accel       32767
 227  *                    = ------------ *  ------------
 228  *                         32767        ao_accel_ref
 229  *
 230  * Multiply through by 32767:
 231  *
 232  *                      ao_sample_accel * 32767
 233  *      ao_cook_accel = --------------------
 234  *                          ao_accel_ref
 235  *
 236  * Now, the tricky part. Getting this to compile efficiently
 237  * and keeping all of the values in-range.
 238  *
 239  * First off, we need to use a shift of 16 instead of * 32767 as SDCC
 240  * does the obvious optimizations for byte-granularity shifts:
 241  *
 242  *      ao_cook_accel = (ao_sample_accel << 16) / ao_accel_ref
 243  *
 244  * Next, lets check our input ranges:
 245  *
 246  *      0 <= ao_sample_accel <= 0x7fff          (singled ended ADC conversion)
 247  *      0x7000 <= ao_accel_ref <= 0x7fff        (the 5V ref value is close to 0x7fff)
 248  *
 249  * Plugging in our input ranges, we get an output range of 0 - 0x12490,
 250  * which is 17 bits. That won't work. If we take the accel ref and shift
 251  * by a bit, we'll change its range:
 252  *
 253  *      0xe000 <= ao_accel_ref<<1 <= 0xfffe
 254  *
 255  *      ao_cook_accel = (ao_sample_accel << 16) / (ao_accel_ref << 1)
 256  *
 257  * Now the output range is 0 - 0x9248, which nicely fits in 16 bits. It
 258  * is, however, one bit too large for our signed computations. So, we
 259  * take the result and shift that by a bit:
 260  *
 261  *      ao_cook_accel = ((ao_sample_accel << 16) / (ao_accel_ref << 1)) >> 1
 262  *
 263  * This finally creates an output range of 0 - 0x4924. As the ADC only
 264  * provides 11 bits of data, we haven't actually lost any precision,
 265  * just dropped a bit of noise off the low end.
 266  */
 267
 268 #if HAS_ACCEL_REF
 269
 270 #define ao_data_accel_cook(packet) \
 271         ((uint16_t) ((((uint32_t) (packet)->adc.accel << 16) / ((packet)->adc.accel_ref << 1))) >> 1)
 272
 273 #else
 274
 275 #define ao_data_accel_cook(packet) ((packet)->adc.accel)
 276
 277 #endif /* HAS_ACCEL_REF */
 278
 279 #endif  /* HAS_ACCEL */
 280
 281 #if !HAS_ACCEL && HAS_MMA655X
 282
 283 #define HAS_ACCEL       1
 284
 285 typedef int16_t accel_t;
 286
 287 /* MMA655X is hooked up so that positive values represent negative acceleration */
 288
 289 #define AO_ACCEL_INVERT         4095
 290
 291 #ifndef AO_MMA655X_INVERT
 292 #error AO_MMA655X_INVERT not defined
 293 #endif
 294
 295 #define ao_data_accel(packet)                   ((packet)->mma655x)
 296 #if AO_MMA655X_INVERT
 297 #define ao_data_accel_cook(packet)              (AO_ACCEL_INVERT - (packet)->mma655x)
 298 #else
 299 #define ao_data_accel_cook(packet)              ((packet)->mma655x)
 300 #endif
 301 #define ao_data_set_accel(packet, accel)        ((packet)->mma655x = (accel))
 302 #define ao_data_accel_invert(accel)             (AO_ACCEL_INVERT - (accel))
 303
 304 #endif
 305
 306 #if !HAS_ACCEL && HAS_ADXL375
 307
 308 #define HAS_ACCEL       1
 309
 310 typedef int16_t accel_t;
 311
 312 #ifndef AO_ADXL375_INVERT
 313 #error AO_ADXL375_INVERT not defined
 314 #endif
 315
 316 #define ao_data_accel(packet)                   ((packet)->adxl375.AO_ADXL375_AXIS)
 317 #if AO_ADXL375_INVERT
 318 #define ao_data_accel_cook(packet)              (-ao_data_accel(packet))
 319 #else
 320 #define ao_data_accel_cook(packet)              ao_data_accel(packet)
 321 #endif
 322 #define ao_data_set_accel(packet, accel)        (ao_data_accel(packet) = (accel))
 323 #define ao_data_accel_invert(accel)             (-(accel))
 324
 325 #endif /* HAS_ADXL375 */
 326
 327 #if !HAS_ACCEL && HAS_MPU6000
 328
 329 #define HAS_ACCEL       1
 330
 331 #define AO_ACCEL_INVERT         0
 332
 333 typedef int16_t accel_t;
 334
 335 /* MPU6000 is hooked up so that positive y is positive acceleration */
 336 #define ao_data_accel(packet)                   ((packet)->z_accel)
 337 #define ao_data_accel_cook(packet)              (-(packet)->mpu6000.accel_y)
 338 #define ao_data_set_accel(packet, accel)        ((packet)->z_accel = (accel))
 339 #define ao_data_accel_invert(a)                 (-(a))
 340
 341 #endif
 342
 343 #if !HAS_GYRO && HAS_MPU6000
 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)->mpu6000.accel_y)
 355 #define ao_data_across(packet)  ((packet)->mpu6000.accel_x)
 356 #define ao_data_through(packet) ((packet)->mpu6000.accel_z)
 357
 358 #define ao_data_roll(packet)    ((packet)->mpu6000.gyro_y)
 359 #define ao_data_pitch(packet)   ((packet)->mpu6000.gyro_x)
 360 #define ao_data_yaw(packet)     ((packet)->mpu6000.gyro_z)
 361
 362 static inline float ao_convert_gyro(float sensor)
 363 {
 364         return ao_mpu6000_gyro(sensor);
 365 }
 366
 367 static inline float ao_convert_accel(int16_t sensor)
 368 {
 369         return ao_mpu6000_accel(sensor);
 370 }
 371
 372 #endif
 373
 374 #if !HAS_GYRO && HAS_MPU9250
 375
 376 #define HAS_GYRO        1
 377
 378 typedef int16_t gyro_t;         /* in raw sample units */
 379 typedef int16_t angle_t;        /* in degrees */
 380
 381 /* Y axis is aligned with the direction of motion (along) */
 382 /* X axis is aligned in the other board axis (across) */
 383 /* Z axis is aligned perpendicular to the board (through) */
 384
 385 #define ao_data_along(packet)   ((packet)->mpu9250.accel_y)
 386 #define ao_data_across(packet)  ((packet)->mpu9250.accel_x)
 387 #define ao_data_through(packet) ((packet)->mpu9250.accel_z)
 388
 389 #define ao_data_roll(packet)    ((packet)->mpu9250.gyro_y)
 390 #define ao_data_pitch(packet)   ((packet)->mpu9250.gyro_x)
 391 #define ao_data_yaw(packet)     ((packet)->mpu9250.gyro_z)
 392
 393 static inline float ao_convert_gyro(float sensor)
 394 {
 395         return ao_mpu9250_gyro(sensor);
 396 }
 397
 398 static inline float ao_convert_accel(int16_t sensor)
 399 {
 400         return ao_mpu9250_accel(sensor);
 401 }
 402
 403 #endif
 404
 405 #if !HAS_MAG && HAS_HMC5883
 406
 407 #define HAS_MAG         1
 408
 409 typedef int16_t ao_mag_t;               /* in raw sample units */
 410
 411 #define ao_data_mag_along(packet)       ((packet)->hmc5883.x)
 412 #define ao_data_mag_across(packet)      ((packet)->hmc5883.y)
 413 #define ao_data_mag_through(packet)     ((packet)->hmc5883.z)
 414
 415 #endif
 416
 417 #if !HAS_MAG && HAS_MPU9250
 418
 419 #define HAS_MAG         1
 420
 421 typedef int16_t ao_mag_t;               /* in raw sample units */
 422
 423 /* Note that this order is different from the accel and gyro. For some
 424  * reason, the mag sensor axes aren't the same as the other two
 425  * sensors. Also, the Z axis is flipped in sign.
 426  */
 427
 428 #define ao_data_mag_along(packet)       ((packet)->mpu9250.mag_x)
 429 #define ao_data_mag_across(packet)      ((packet)->mpu9250.mag_y)
 430 #define ao_data_mag_through(packet)     ((packet)->mpu9250.mag_z)
 431
 432 #endif
 433
 434 #ifdef AO_DATA_RING
 435
 436 static inline void
 437 ao_data_fill(int head) {
 438         if (ao_data_present == AO_DATA_ALL) {
 439 #if HAS_MS5607
 440                 ao_data_ring[head].ms5607_raw = ao_ms5607_current;
 441 #endif
 442 #if HAS_MMA655X
 443                 ao_data_ring[head].mma655x = ao_mma655x_current;
 444 #endif
 445 #if HAS_HMC5883
 446                 ao_data_ring[head].hmc5883 = ao_hmc5883_current;
 447 #endif
 448 #if HAS_MPU6000
 449                 ao_data_ring[head].mpu6000 = ao_mpu6000_current;
 450 #endif
 451 #if HAS_MPU9250
 452                 ao_data_ring[head].mpu9250 = ao_mpu9250_current;
 453 #endif
 454 #if HAS_ADXL375
 455                 ao_data_ring[head].adxl375 = ao_adxl375_current;
 456 #endif
 457                 ao_data_ring[head].tick = ao_tick_count;
 458                 ao_data_head = ao_data_ring_next(head);
 459                 ao_wakeup((void *) &ao_data_head);
 460         }
 461 }
 462
 463 #endif
 464
 465 #endif /* _AO_DATA_H_ */