src/main/config/config_streamer.h

   1 /*
   2  * This file is part of Cleanflight.
   3  *
   4  * Cleanflight 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 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * Cleanflight is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with Cleanflight.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #pragma once
  19
  20 #include <stdint.h>
  21 #include <stdbool.h>
  22
  23 #include "drivers/flash_m25p16.h"
  24
  25 // Streams data out to the EEPROM, padding to the write size as
  26 // needed, and updating the checksum as it goes.
  27
  28 #ifdef CONFIG_IN_EXTERNAL_FLASH
  29 #define CONFIG_STREAMER_BUFFER_SIZE M25P16_PAGESIZE // Must match flash device page size
  30 typedef uint32_t config_streamer_buffer_align_type_t;
  31 #elif defined(STM32H7)
  32 #define CONFIG_STREAMER_BUFFER_SIZE 32  // Flash word = 256-bits
  33 typedef uint64_t config_streamer_buffer_align_type_t;
  34 #else
  35 #define CONFIG_STREAMER_BUFFER_SIZE 4
  36 typedef uint32_t config_streamer_buffer_align_type_t;
  37 #endif
  38
  39 typedef struct config_streamer_s {
  40     uintptr_t address;
  41     uintptr_t end;
  42     int size;
  43     union {
  44         uint8_t b[CONFIG_STREAMER_BUFFER_SIZE];
  45         config_streamer_buffer_align_type_t w;
  46     } buffer;
  47     int at;
  48     int err;
  49     bool unlocked;
  50 } config_streamer_t;
  51
  52 void config_streamer_init(config_streamer_t *c);
  53
  54 void config_streamer_start(config_streamer_t *c, uintptr_t base, int size);
  55 int config_streamer_write(config_streamer_t *c, const uint8_t *p, uint32_t size);
  56 int config_streamer_flush(config_streamer_t *c);
  57
  58 int config_streamer_finish(config_streamer_t *c);
  59 int config_streamer_status(config_streamer_t *c);