git.gag.com Git - fw/altos/blob - src/kernel/ao_log.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; 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 #include "ao.h"
  19 #include <ao_log.h>
  20 #include <ao_config.h>
  21 #if HAS_TRACKER
  22 #include <ao_tracker.h>
  23 #endif
  24
  25 __xdata uint8_t ao_log_mutex;
  26 __pdata uint32_t ao_log_current_pos;
  27 __pdata uint32_t ao_log_end_pos;
  28 __pdata uint32_t ao_log_start_pos;
  29 __xdata uint8_t ao_log_running;
  30 __pdata enum ao_flight_state ao_log_state;
  31 __xdata uint16_t ao_flight_number;
  32
  33 void
  34 ao_log_flush(void)
  35 {
  36         ao_storage_flush();
  37 }
  38
  39 /*
  40  * When erasing a flight log, make sure the config block
  41  * has an up-to-date version of the current flight number
  42  */
  43
  44 struct ao_log_erase {
  45         uint8_t mark;
  46         uint16_t flight;
  47 };
  48
  49 static __xdata struct ao_log_erase erase;
  50
  51 #ifndef LOG_MAX_ERASE
  52 #define LOG_MAX_ERASE   16
  53 #endif
  54
  55 #ifndef LOG_ERASE_MARK
  56 #if USE_EEPROM_CONFIG
  57 #error "Must define LOG_ERASE_MARK with USE_EEPROM_CONFIG"
  58 #endif
  59 #define LOG_ERASE_MARK  0x00
  60 #endif
  61
  62 static uint32_t
  63 ao_log_erase_pos(uint8_t i)
  64 {
  65         return i * sizeof (struct ao_log_erase) + AO_CONFIG_MAX_SIZE;
  66 }
  67
  68 void
  69 ao_log_write_erase(uint8_t pos)
  70 {
  71         erase.mark = LOG_ERASE_MARK;
  72         erase.flight = ao_flight_number;
  73         ao_config_write(ao_log_erase_pos(pos),  &erase, sizeof (erase));
  74
  75 #if USE_EEPROM_CONFIG
  76         if (pos == 0) {
  77                 uint8_t i;
  78                 for (i = 1; i < LOG_MAX_ERASE; i++) {
  79                         erase.mark = ~LOG_ERASE_MARK;
  80                         erase.flight = 0;
  81                         ao_config_write(ao_log_erase_pos(i), &erase, sizeof (erase));
  82                 }
  83         }
  84 #endif
  85
  86         ao_config_flush();
  87 }
  88
  89 static void
  90 ao_log_read_erase(uint8_t pos)
  91 {
  92         ao_config_read(ao_log_erase_pos(pos), &erase, sizeof (erase));
  93 }
  94
  95
  96 static void
  97 ao_log_erase_mark(void)
  98 {
  99         uint8_t                         i;
 100
 101         for (i = 0; i < LOG_MAX_ERASE; i++) {
 102                 ao_log_read_erase(i);
 103                 if (erase.mark == LOG_ERASE_MARK && erase.flight == ao_flight_number)
 104                         return;
 105                 if (erase.mark != LOG_ERASE_MARK) {
 106                         ao_log_write_erase(i);
 107                         return;
 108                 }
 109         }
 110         ao_config_put();
 111 }
 112
 113 static uint8_t
 114 ao_log_slots()
 115 {
 116         return (uint8_t) (ao_storage_log_max / ao_config.flight_log_max);
 117 }
 118
 119 uint32_t
 120 ao_log_pos(uint8_t slot)
 121 {
 122         return ((slot) * ao_config.flight_log_max);
 123 }
 124
 125 static uint16_t
 126 ao_log_max_flight(void)
 127 {
 128         uint8_t         log_slot;
 129         uint8_t         log_slots;
 130         uint16_t        log_flight;
 131         uint16_t        max_flight = 0;
 132
 133         /* Scan the log space looking for the biggest flight number */
 134         log_slots = ao_log_slots();
 135         for (log_slot = 0; log_slot < log_slots; log_slot++) {
 136                 log_flight = ao_log_flight(log_slot);
 137                 if (!log_flight)
 138                         continue;
 139                 if (max_flight == 0 || (int16_t) (log_flight - max_flight) > 0)
 140                         max_flight = log_flight;
 141         }
 142         return max_flight;
 143 }
 144
 145 static void
 146 ao_log_erase(uint8_t slot) __reentrant
 147 {
 148         uint32_t log_current_pos, log_end_pos;
 149
 150         ao_log_erase_mark();
 151         log_current_pos = ao_log_pos(slot);
 152         log_end_pos = log_current_pos + ao_config.flight_log_max;
 153         while (log_current_pos < log_end_pos) {
 154                 uint8_t i;
 155                 static __xdata uint8_t b;
 156
 157                 /*
 158                  * Check to see if we've reached the end of
 159                  * the used memory to avoid re-erasing the same
 160                  * memory over and over again
 161                  */
 162                 for (i = 0; i < 16; i++) {
 163                         if (ao_storage_read(log_current_pos + i, &b, 1))
 164                                 if (b != 0xff)
 165                                         break;
 166                 }
 167                 if (i == 16)
 168                         break;
 169                 ao_storage_erase(log_current_pos);
 170                 log_current_pos += ao_storage_block;
 171         }
 172 }
 173
 174 static void
 175 ao_log_find_max_erase_flight(void) __reentrant
 176 {
 177         uint8_t log_slot;
 178
 179         /* Now look through the log of flight numbers from erase operations and
 180          * see if the last one is bigger than what we found above
 181          */
 182         for (log_slot = LOG_MAX_ERASE; log_slot-- > 0;) {
 183                 ao_log_read_erase(log_slot);
 184                 if (erase.mark == LOG_ERASE_MARK) {
 185                         if (ao_flight_number == 0 ||
 186                             (int16_t) (erase.flight - ao_flight_number) > 0)
 187                                 ao_flight_number = erase.flight;
 188                         break;
 189                 }
 190         }
 191         if (ao_flight_number == 0)
 192                 ao_flight_number = 1;
 193 }
 194
 195 uint8_t
 196 ao_log_scan(void) __reentrant
 197 {
 198         uint8_t         log_slot;
 199         uint8_t         log_slots;
 200 #if FLIGHT_LOG_APPEND
 201         uint8_t         ret;
 202 #else
 203         uint8_t         log_want;
 204 #endif
 205
 206         ao_config_get();
 207
 208         /* Get any existing flight number */
 209         ao_flight_number = ao_log_max_flight();
 210
 211 #if FLIGHT_LOG_APPEND
 212
 213         /* Deal with older OS versions which stored multiple
 214          * flights in rom by erasing everything after the first
 215          * slot
 216          */
 217         if (ao_config.flight_log_max != ao_storage_log_max) {
 218                 log_slots = ao_log_slots();
 219                 for (log_slot = 1; log_slot < log_slots; log_slot++) {
 220                         if (ao_log_flight(log_slot) != 0)
 221                                 ao_log_erase(log_slot);
 222                 }
 223                 ao_config_log_fix_append();
 224         }
 225         ao_log_current_pos = ao_log_pos(0);
 226         ao_log_end_pos = ao_log_current_pos + ao_storage_log_max;
 227
 228         if (ao_flight_number) {
 229                 uint32_t        full = ao_log_current_pos;
 230                 uint32_t        empty = ao_log_end_pos - ao_log_size;
 231
 232                 /* If there's already a flight started, then find the
 233                  * end of it
 234                  */
 235                 for (;;) {
 236                         ao_log_current_pos = (full + empty) >> 1;
 237                         ao_log_current_pos -= ao_log_current_pos % ao_log_size;
 238
 239                         if (ao_log_current_pos == full) {
 240                                 if (ao_log_check(ao_log_current_pos))
 241                                         ao_log_current_pos += ao_log_size;
 242                                 break;
 243                         }
 244                         if (ao_log_current_pos == empty)
 245                                 break;
 246
 247                         if (ao_log_check(ao_log_current_pos)) {
 248                                 full = ao_log_current_pos;
 249                         } else {
 250                                 empty = ao_log_current_pos;
 251                         }
 252                 }
 253                 ret = 1;
 254         } else {
 255                 ao_log_find_max_erase_flight();
 256                 ret = 0;
 257         }
 258         ao_wakeup(&ao_flight_number);
 259         return ret;
 260 #else
 261
 262         if (ao_flight_number)
 263                 if (++ao_flight_number == 0)
 264                         ao_flight_number = 1;
 265
 266         ao_log_find_max_erase_flight();
 267
 268         /* With a flight number in hand, find a place to write a new log,
 269          * use the target flight number to index the available log slots so
 270          * that we write logs to each spot about the same number of times.
 271          */
 272
 273         /* Find a log slot for the next flight, if available */
 274         ao_log_current_pos = ao_log_end_pos = 0;
 275         log_slots = ao_log_slots();
 276         log_want = (ao_flight_number - 1) % log_slots;
 277         log_slot = log_want;
 278         do {
 279                 if (ao_log_flight(log_slot) == 0) {
 280                         ao_log_current_pos = ao_log_pos(log_slot);
 281                         ao_log_end_pos = ao_log_current_pos + ao_config.flight_log_max;
 282                         break;
 283                 }
 284                 if (++log_slot >= log_slots)
 285                         log_slot = 0;
 286         } while (log_slot != log_want);
 287         ao_wakeup(&ao_flight_number);
 288         return 0;
 289 #endif
 290 }
 291
 292 void
 293 ao_log_start(void)
 294 {
 295         /* start logging */
 296         ao_log_running = 1;
 297         ao_wakeup(&ao_log_running);
 298 }
 299
 300 void
 301 ao_log_stop(void)
 302 {
 303         ao_log_running = 0;
 304         ao_log_flush();
 305 }
 306
 307 uint8_t
 308 ao_log_present(void)
 309 {
 310         return ao_log_max_flight() != 0;
 311 }
 312
 313 uint8_t
 314 ao_log_full(void)
 315 {
 316         return ao_log_current_pos == ao_log_end_pos;
 317 }
 318
 319 #ifndef LOG_ADC
 320 #define LOG_ADC HAS_ADC
 321 #endif
 322
 323 #if LOG_ADC
 324 static __xdata struct ao_task ao_log_task;
 325 #endif
 326
 327 void
 328 ao_log_list(void) __reentrant
 329 {
 330         uint8_t slot;
 331         uint8_t slots;
 332         uint16_t flight;
 333
 334         slots = ao_log_slots();
 335         for (slot = 0; slot < slots; slot++)
 336         {
 337                 flight = ao_log_flight(slot);
 338                 if (flight)
 339                         printf ("flight %d start %x end %x\n",
 340                                 flight,
 341                                 (uint16_t) (ao_log_pos(slot) >> 8),
 342                                 (uint16_t) (ao_log_pos(slot+1) >> 8));
 343         }
 344         printf ("done\n");
 345 }
 346
 347 void
 348 ao_log_delete(void) __reentrant
 349 {
 350         uint8_t slot;
 351         uint8_t slots;
 352
 353         ao_cmd_decimal();
 354         if (ao_cmd_status != ao_cmd_success)
 355                 return;
 356
 357         slots = ao_log_slots();
 358         /* Look for the flight log matching the requested flight */
 359         if (ao_cmd_lex_i) {
 360                 for (slot = 0; slot < slots; slot++) {
 361                         if (ao_log_flight(slot) == ao_cmd_lex_i) {
 362 #if HAS_TRACKER
 363                                 ao_tracker_erase_start(ao_cmd_lex_i);
 364 #endif
 365                                 ao_log_erase(slot);
 366 #if HAS_TRACKER
 367                                 ao_tracker_erase_end();
 368 #endif
 369                                 puts("Erased");
 370                                 return;
 371                         }
 372                 }
 373         }
 374         printf("No such flight: %d\n", ao_cmd_lex_i);
 375 }
 376
 377 __code struct ao_cmds ao_log_cmds[] = {
 378         { ao_log_list,  "l\0List logs" },
 379         { ao_log_delete,        "d <flight-number>\0Delete flight" },
 380         { 0,    NULL },
 381 };
 382
 383 void
 384 ao_log_init(void)
 385 {
 386         ao_log_running = 0;
 387
 388         /* For now, just log the flight starting at the begining of eeprom */
 389         ao_log_state = ao_flight_invalid;
 390
 391         ao_cmd_register(&ao_log_cmds[0]);
 392
 393 #ifndef HAS_ADC
 394 #error Define HAS_ADC for ao_log.c
 395 #endif
 396 #if LOG_ADC
 397         /* Create a task to log events to eeprom */
 398         ao_add_task(&ao_log_task, ao_log, "log");
 399 #endif
 400 }