altos: oops. Fix syntax
[fw/altos] / src / kernel / ao_flight.c
1 /*
2  * Copyright © 2009 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_FLIGHT_TEST
20 #include "ao.h"
21 #include <ao_log.h>
22 #endif
23
24 #include <ao_flight.h>
25
26 #if HAS_MPU6000 || HAS_MPU9250
27 #include <ao_quaternion.h>
28 #endif
29
30 #ifndef HAS_ACCEL
31 #error Please define HAS_ACCEL
32 #endif
33
34 #ifndef HAS_GPS
35 #error Please define HAS_GPS
36 #endif
37
38 #ifndef HAS_USB
39 #error Please define HAS_USB
40 #endif
41
42 #if HAS_FAKE_FLIGHT
43 #include <ao_fake_flight.h>
44 #endif
45
46 #ifndef HAS_TELEMETRY
47 #define HAS_TELEMETRY   HAS_RADIO
48 #endif
49
50 /* Main flight thread. */
51
52 enum ao_flight_state    ao_flight_state;        /* current flight state */
53 uint16_t                ao_boost_tick;          /* time of most recent boost detect */
54 uint16_t                ao_launch_tick;         /* time of first boost detect */
55 uint16_t                ao_motor_number;        /* number of motors burned so far */
56
57 #if HAS_SENSOR_ERRORS
58 /* Any sensor can set this to mark the flight computer as 'broken' */
59 uint8_t                 ao_sensor_errors;
60 #endif
61
62 /*
63  * track min/max data over a long interval to detect
64  * resting
65  */
66 static uint16_t         ao_interval_end;
67 #ifdef HAS_BARO
68 static ao_v_t           ao_interval_min_height;
69 static ao_v_t           ao_interval_max_height;
70 #else
71 static accel_t          ao_interval_min_accel_along, ao_interval_max_accel_along;
72 static accel_t          ao_interval_min_accel_across, ao_interval_max_accel_across;
73 static accel_t          ao_interval_min_accel_through, ao_interval_max_accel_through;
74 #endif
75 #if HAS_ACCEL
76 static ao_v_t           ao_coast_avg_accel;
77 #endif
78
79 #define init_bounds(_cur, _min, _max) do {                              \
80                 _min = _max = _cur;                                     \
81         } while (0)
82
83 #define check_bounds(_cur, _min, _max) do {     \
84                 if (_cur < _min)                \
85                         _min = _cur;            \
86                 if (_cur > _max)                \
87                         _max = _cur;            \
88         } while(0)
89
90 uint8_t                 ao_flight_force_idle;
91
92 /* We also have a clock, which can be used to sanity check things in
93  * case of other failures
94  */
95
96 #define BOOST_TICKS_MAX AO_SEC_TO_TICKS(15)
97
98 /* Landing is detected by getting constant readings from both pressure and accelerometer
99  * for a fairly long time (AO_INTERVAL_TICKS)
100  */
101 #define AO_INTERVAL_TICKS       AO_SEC_TO_TICKS(10)
102
103 #define abs(a)  ((a) < 0 ? -(a) : (a))
104
105 void
106 ao_flight(void)
107 {
108         ao_sample_init();
109         ao_flight_state = ao_flight_startup;
110         for (;;) {
111
112                 /*
113                  * Process ADC samples, just looping
114                  * until the sensors are calibrated.
115                  */
116                 if (!ao_sample())
117                         continue;
118
119                 switch (ao_flight_state) {
120                 case ao_flight_startup:
121
122                         /* Check to see what mode we should go to.
123                          *  - Invalid mode if accel cal appears to be out
124                          *  - pad mode if we're upright,
125                          *  - idle mode otherwise
126                          */
127 #if HAS_ACCEL
128                         if (ao_config.accel_plus_g == 0 ||
129                             ao_config.accel_minus_g == 0 ||
130                             ao_ground_accel < ao_config.accel_plus_g - ACCEL_NOSE_UP ||
131                             ao_ground_accel > ao_config.accel_minus_g + ACCEL_NOSE_UP
132 #if HAS_BARO
133                             || ao_ground_height < -1000 ||
134                             ao_ground_height > 7000
135 #endif
136                                 )
137                         {
138                                 /* Detected an accel value outside -1.5g to 1.5g
139                                  * (or uncalibrated values), so we go into invalid mode
140                                  */
141                                 ao_flight_state = ao_flight_invalid;
142
143 #if HAS_RADIO && PACKET_HAS_SLAVE
144                                 /* Turn on packet system in invalid mode on TeleMetrum */
145                                 ao_packet_slave_start();
146 #endif
147                         } else
148 #endif
149                                 if (!ao_flight_force_idle
150 #if HAS_ACCEL
151                                     && ao_ground_accel < ao_config.accel_plus_g + ACCEL_NOSE_UP
152 #endif
153                                         )
154                         {
155                                 /* Set pad mode - we can fly! */
156                                 ao_flight_state = ao_flight_pad;
157 #if HAS_USB && !HAS_FLIGHT_DEBUG && !HAS_SAMPLE_PROFILE && !DEBUG
158                                 /* Disable the USB controller in flight mode
159                                  * to save power
160                                  */
161 #if HAS_FAKE_FLIGHT
162                                 if (!ao_fake_flight_active)
163 #endif
164                                         ao_usb_disable();
165 #endif
166
167 #if !HAS_ACCEL && PACKET_HAS_SLAVE
168                                 /* Disable packet mode in pad state on TeleMini */
169                                 ao_packet_slave_stop();
170 #endif
171
172 #if HAS_TELEMETRY
173                                 /* Turn on telemetry system */
174                                 ao_rdf_set(1);
175                                 ao_telemetry_set_interval(AO_TELEMETRY_INTERVAL_PAD);
176 #endif
177 #if AO_LED_RED
178                                 /* signal successful initialization by turning off the LED */
179                                 ao_led_off(AO_LED_RED);
180 #endif
181                         } else {
182                                 /* Set idle mode */
183                                 ao_flight_state = ao_flight_idle;
184 #if HAS_SENSOR_ERRORS
185                                 if (ao_sensor_errors)
186                                         ao_flight_state = ao_flight_invalid;
187 #endif
188  
189 #if HAS_ACCEL && HAS_RADIO && PACKET_HAS_SLAVE
190                                 /* Turn on packet system in idle mode on TeleMetrum */
191                                 ao_packet_slave_start();
192 #endif
193
194 #if AO_LED_RED
195                                 /* signal successful initialization by turning off the LED */
196                                 ao_led_off(AO_LED_RED);
197 #endif
198                         }
199                         /* wakeup threads due to state change */
200                         ao_wakeup(&ao_flight_state);
201
202                         break;
203
204 #if 0
205                 case ao_flight_idle:
206                 case ao_flight_invalid:
207                         printf("+g %d ga %d sa %d accel %ld speed %ld\n", ao_config.accel_plus_g, ao_ground_accel, ao_sample_accel, ao_accel, ao_speed);
208                         break;
209 #endif
210
211                 case ao_flight_pad:
212                         /* pad to boost:
213                          *
214                          * barometer: > 20m vertical motion
215                          *             OR
216                          * accelerometer: > 2g AND velocity > 5m/s
217                          *
218                          * The accelerometer should always detect motion before
219                          * the barometer, but we use both to make sure this
220                          * transition is detected. If the device
221                          * doesn't have an accelerometer, then ignore the
222                          * speed and acceleration as they are quite noisy
223                          * on the pad.
224                          */
225                         if (ao_height > AO_M_TO_HEIGHT(20)
226 #if HAS_ACCEL
227                             || (ao_accel > AO_MSS_TO_ACCEL(20)
228 #if HAS_BARO
229                                 && ao_speed > AO_MS_TO_SPEED(5)
230 #endif
231 )
232 #endif
233                                 )
234                         {
235                                 ao_flight_state = ao_flight_boost;
236                                 ao_wakeup(&ao_flight_state);
237
238                                 ao_launch_tick = ao_boost_tick = ao_sample_tick;
239
240                                 /* start logging data */
241 #if HAS_LOG
242                                 ao_log_start();
243 #endif
244
245 #if HAS_TELEMETRY
246                                 /* Increase telemetry rate */
247                                 ao_telemetry_set_interval(AO_TELEMETRY_INTERVAL_FLIGHT);
248
249                                 /* disable RDF beacon */
250                                 ao_rdf_set(0);
251 #endif
252
253 #if HAS_GPS
254                                 /* Record current GPS position by waking up GPS log tasks */
255                                 ao_gps_new = AO_GPS_NEW_DATA | AO_GPS_NEW_TRACKING;
256                                 ao_wakeup(&ao_gps_new);
257 #endif
258                         }
259                         break;
260                 case ao_flight_boost:
261
262                         /* boost to fast:
263                          *
264                          * accelerometer: start to fall at > 1/4 G
265                          *              OR
266                          * time: boost for more than 15 seconds
267                          *
268                          * Detects motor burn out by the switch from acceleration to
269                          * deceleration, or by waiting until the maximum burn duration
270                          * (15 seconds) has past.
271                          */
272                         if ((ao_accel < AO_MSS_TO_ACCEL(-2.5)) ||
273                             (int16_t) (ao_sample_tick - ao_boost_tick) > BOOST_TICKS_MAX)
274                         {
275 #if HAS_ACCEL
276 #if HAS_BARO
277                                 ao_flight_state = ao_flight_fast;
278 #else
279                                 ao_flight_state = ao_flight_coast;
280
281                                 /* Initialize landing detection interval values */
282                                 ao_interval_end = ao_sample_tick + AO_INTERVAL_TICKS;
283
284                                 init_bounds(ao_sample_accel_along, ao_interval_min_accel_along, ao_interval_max_accel_along);
285                                 init_bounds(ao_sample_accel_across, ao_interval_min_accel_across, ao_interval_max_accel_across);
286                                 init_bounds(ao_sample_accel_through, ao_interval_min_accel_through, ao_interval_max_accel_through);
287 #endif
288                                 ao_coast_avg_accel = ao_accel;
289 #else
290                                 ao_flight_state = ao_flight_coast;
291 #endif
292                                 ao_wakeup(&ao_flight_state);
293                                 ++ao_motor_number;
294                         }
295                         break;
296 #if HAS_ACCEL && HAS_BARO
297                 case ao_flight_fast:
298                         /*
299                          * This is essentially the same as coast,
300                          * but the barometer is being ignored as
301                          * it may be unreliable.
302                          */
303                         if (ao_speed < AO_MS_TO_SPEED(AO_MAX_BARO_SPEED))
304                         {
305                                 ao_flight_state = ao_flight_coast;
306                                 ao_wakeup(&ao_flight_state);
307                         } else
308                                 goto check_re_boost;
309                         break;
310 #endif
311                 case ao_flight_coast:
312
313 #if HAS_BARO
314                         /*
315                          * By customer request - allow the user
316                          * to lock out apogee detection for a specified
317                          * number of seconds.
318                          */
319                         if (ao_config.apogee_lockout) {
320                                 if ((int16_t) (ao_sample_tick - ao_launch_tick) <
321                                     AO_SEC_TO_TICKS(ao_config.apogee_lockout))
322                                         break;
323                         }
324
325                         /* apogee detect: coast to drogue deploy:
326                          *
327                          * speed: < 0
328                          *
329                          * Also make sure the model altitude is tracking
330                          * the measured altitude reasonably closely; otherwise
331                          * we're probably transsonic.
332                          */
333 #define AO_ERROR_BOUND  100
334
335                         if (ao_speed < 0
336 #if !HAS_ACCEL
337                             && (ao_sample_alt >= AO_MAX_BARO_HEIGHT || ao_error_h_sq_avg < AO_ERROR_BOUND)
338 #endif
339                                 )
340                         {
341                                 /* enter drogue state */
342                                 ao_flight_state = ao_flight_drogue;
343                                 ao_wakeup(&ao_flight_state);
344 #if HAS_TELEMETRY
345                                 /* slow down the telemetry system */
346                                 ao_telemetry_set_interval(AO_TELEMETRY_INTERVAL_RECOVER);
347
348                                 /* Turn the RDF beacon back on */
349                                 ao_rdf_set(1);
350 #endif
351                         }
352                         else
353 #else /* not HAS_BARO */
354                         /* coast to land:
355                          *
356                          * accel: values stable
357                          */
358                         check_bounds(ao_sample_accel_along, ao_interval_min_accel_along, ao_interval_max_accel_along);
359                         check_bounds(ao_sample_accel_across, ao_interval_min_accel_across, ao_interval_max_accel_across);
360                         check_bounds(ao_sample_accel_through, ao_interval_min_accel_through, ao_interval_max_accel_through);
361
362 #define MAX_QUIET_ACCEL 2
363
364                         if ((int16_t) (ao_sample_tick - ao_interval_end) >= 0) {
365                                 if (ao_interval_max_accel_along - ao_interval_min_accel_along <= ao_data_accel_to_sample(MAX_QUIET_ACCEL) &&
366                                     ao_interval_max_accel_across - ao_interval_min_accel_across <= ao_data_accel_to_sample(MAX_QUIET_ACCEL) &&
367                                     ao_interval_max_accel_through - ao_interval_min_accel_through <= ao_data_accel_to_sample(MAX_QUIET_ACCEL))
368                                 {
369                                         ao_flight_state = ao_flight_landed;
370                                         ao_wakeup(&ao_flight_state);
371 #if HAS_ADC
372                                         /* turn off the ADC capture */
373                                         ao_timer_set_adc_interval(0);
374 #endif
375                                 }
376
377                                 /* Reset interval values */
378                                 ao_interval_end = ao_sample_tick + AO_INTERVAL_TICKS;
379
380                                 init_bounds(ao_sample_accel_along, ao_interval_min_accel_along, ao_interval_max_accel_along);
381                                 init_bounds(ao_sample_accel_across, ao_interval_min_accel_across, ao_interval_max_accel_across);
382                                 init_bounds(ao_sample_accel_through, ao_interval_min_accel_through, ao_interval_max_accel_through);
383                         }
384 #endif
385 #if HAS_ACCEL
386                         {
387 #if HAS_BARO
388                         check_re_boost:
389 #endif
390                                 ao_coast_avg_accel = ao_coast_avg_accel + ((ao_accel - ao_coast_avg_accel) >> 5);
391                                 if (ao_coast_avg_accel > AO_MSS_TO_ACCEL(20)) {
392                                         ao_boost_tick = ao_sample_tick;
393                                         ao_flight_state = ao_flight_boost;
394                                         ao_wakeup(&ao_flight_state);
395                                 }
396                         }
397 #endif
398
399                         break;
400 #if HAS_BARO
401                 case ao_flight_drogue:
402
403                         /* drogue to main deploy:
404                          *
405                          * barometer: reach main deploy altitude
406                          *
407                          * Would like to use the accelerometer for this test, but
408                          * the orientation of the flight computer is unknown after
409                          * drogue deploy, so we ignore it. Could also detect
410                          * high descent rate using the pressure sensor to
411                          * recognize drogue deploy failure and eject the main
412                          * at that point. Perhaps also use the drogue sense lines
413                          * to notice continutity?
414                          */
415                         if (ao_height <= ao_config.main_deploy)
416                         {
417                                 ao_flight_state = ao_flight_main;
418                                 ao_wakeup(&ao_flight_state);
419
420                                 /*
421                                  * Start recording min/max height
422                                  * to figure out when the rocket has landed
423                                  */
424
425                                 /* initialize interval values */
426                                 ao_interval_end = ao_sample_tick + AO_INTERVAL_TICKS;
427
428                                 ao_interval_min_height = ao_interval_max_height = ao_avg_height;
429                         }
430                         break;
431
432                         /* fall through... */
433                 case ao_flight_main:
434
435                         /* main to land:
436                          *
437                          * barometer: altitude stable
438                          */
439                         if (ao_avg_height < ao_interval_min_height)
440                                 ao_interval_min_height = ao_avg_height;
441                         if (ao_avg_height > ao_interval_max_height)
442                                 ao_interval_max_height = ao_avg_height;
443
444                         if ((int16_t) (ao_sample_tick - ao_interval_end) >= 0) {
445                                 if (ao_interval_max_height - ao_interval_min_height <= AO_M_TO_HEIGHT(4))
446                                 {
447                                         ao_flight_state = ao_flight_landed;
448                                         ao_wakeup(&ao_flight_state);
449 #if HAS_ADC
450                                         /* turn off the ADC capture */
451                                         ao_timer_set_adc_interval(0);
452 #endif
453                                 }
454                                 ao_interval_min_height = ao_interval_max_height = ao_avg_height;
455                                 ao_interval_end = ao_sample_tick + AO_INTERVAL_TICKS;
456                         }
457                         break;
458 #endif /* HAS_BARO */
459 #if HAS_FLIGHT_DEBUG
460                 case ao_flight_test:
461 #if HAS_GYRO
462                         printf ("angle %4d pitch %7d yaw %7d roll %7d\n",
463                                 ao_sample_orient,
464                                 ((ao_sample_pitch << 9) - ao_ground_pitch) >> 9,
465                                 ((ao_sample_yaw << 9) - ao_ground_yaw) >> 9,
466                                 ((ao_sample_roll << 9) - ao_ground_roll) >> 9);
467 #endif
468                         flush();
469                         break;
470 #endif /* HAS_FLIGHT_DEBUG */
471                 default:
472                         break;
473                 }
474         }
475 }
476
477 #if HAS_FLIGHT_DEBUG
478 static inline int int_part(ao_v_t i)    { return i >> 4; }
479 static inline int frac_part(ao_v_t i)   { return ((i & 0xf) * 100 + 8) / 16; }
480
481 static void
482 ao_flight_dump(void)
483 {
484 #if HAS_ACCEL
485         ao_v_t  accel;
486
487         accel = ((ao_config.accel_plus_g - ao_sample_accel) * ao_accel_scale) >> 16;
488 #endif
489
490         printf ("sample:\n");
491         printf ("  tick        %d\n", ao_sample_tick);
492 #if HAS_BARO
493         printf ("  raw pres    %d\n", ao_sample_pres);
494 #endif
495 #if HAS_ACCEL
496         printf ("  raw accel   %d\n", ao_sample_accel);
497 #endif
498 #if HAS_BARO
499         printf ("  ground pres %d\n", ao_ground_pres);
500         printf ("  ground alt  %d\n", ao_ground_height);
501 #endif
502 #if HAS_ACCEL
503         printf ("  raw accel   %d\n", ao_sample_accel);
504         printf ("  groundaccel %d\n", ao_ground_accel);
505         printf ("  accel_2g    %d\n", ao_accel_2g);
506 #endif
507
508 #if HAS_BARO
509         printf ("  alt         %d\n", ao_sample_alt);
510         printf ("  height      %d\n", ao_sample_height);
511 #endif
512
513 #if HAS_ACCEL
514         printf ("  accel       %d.%02d\n", int_part(accel), frac_part(accel));
515 #endif
516
517
518         printf ("kalman:\n");
519         printf ("  height      %d\n", ao_height);
520         printf ("  speed       %d.%02d\n", int_part(ao_speed), frac_part(ao_speed));
521         printf ("  accel       %d.%02d\n", int_part(ao_accel), frac_part(ao_accel));
522         printf ("  max_height  %d\n", ao_max_height);
523         printf ("  avg_height  %d\n", ao_avg_height);
524         printf ("  error_h     %d\n", ao_error_h);
525 #if !HAS_ACCEL
526         printf ("  error_avg   %d\n", ao_error_h_sq_avg);
527 #endif
528 }
529
530 static void
531 ao_gyro_test(void)
532 {
533         ao_flight_state = ao_flight_test;
534         ao_getchar();
535         ao_flight_state = ao_flight_idle;
536 }
537
538 uint8_t ao_orient_test;
539
540 static void
541 ao_orient_test_select(void)
542 {
543         ao_orient_test = !ao_orient_test;
544 }
545
546 const struct ao_cmds ao_flight_cmds[] = {
547         { ao_flight_dump,       "F\0Dump flight status" },
548         { ao_gyro_test,         "G\0Test gyro code" },
549         { ao_orient_test_select,"O\0Test orientation code" },
550         { 0, NULL },
551 };
552 #endif
553
554 static struct ao_task   flight_task;
555
556 void
557 ao_flight_init(void)
558 {
559         ao_flight_state = ao_flight_startup;
560 #if HAS_FLIGHT_DEBUG
561         ao_cmd_register(&ao_flight_cmds[0]);
562 #endif
563         ao_add_task(&flight_task, ao_flight, "flight");
564 }