fix config.mk file header comment

[fnordlicht-mini] / firmware / fnordlicht-firmware / storage.h

/* vim:ts=4 sts=4 et tw=80
 *
 *         fnordlicht firmware
 *
 *    for additional information please
 *    see http://lochraster.org/fnordlichtmini
 *
 * (c) by Alexander Neumann <alexander@bumpern.de>
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __STORAGE_H
#define __STORAGE_H

#include "color.h"
#include "remote-proto.h"
#include <avr/eeprom.h>
#include <stdint.h>
#include <stdbool.h>

/* store a color configuration in EEPROM
 * size: 8 byte
 *
 * use union color_t here, check rgb_marker! */
struct storage_color_t
{
    uint8_t step;
    uint8_t delay;
    uint16_t pause;
    union color_t color;
};

#define EEPROM_MAGIC_BYTE 0x23

/* store the startup configuration in EEPROM
 * size: 14 bytes */
struct storage_config_t
{
    /* magic byte, must match EEPROM_MAGIC_BYTE to mark a valid configuration */
    uint8_t magic;
    /* initial node address to use at startup */
    uint8_t startup_addr;
    /* startup parameters, defined in remote_proto.h, size: 12 bytes */
    struct startup_parameters_t params;
};

/* storage structure for EEPROM
 * size: 496 bytes
 * (means: 16 bytes left) */
struct storage_t
{
    /* startup configuration, size: 14 bytes */
    struct storage_config_t config;

    /* color storage, size: 60*8 == 480 bytes */
    struct storage_color_t color[CONFIG_EEPROM_COLORS];

    /* crc16 checksum over config and color[], size: 2 bytes */
    uint16_t checksum;
};

/* global structures */
extern struct storage_config_t startup_config;
extern EEMEM struct storage_t eeprom_storage;

/* initialize storage */
void storage_init(void);
/* poll storage */
void storage_poll(void);

/* save storage config cfg to eeprom */
void storage_save_config(void);
/* load storage config cfg from eeprom */
void storage_load_config(void);

void storage_save_color(uint8_t position, struct storage_color_t *color);
void storage_load_color(uint8_t position, struct storage_color_t *color);

/* return true if configuration has been loaded and is valid */
bool storage_valid_config(void);

#endif