sd-card: Only add header to the results file if it’s empty
[brewing-logger:firmware.git] / flash-rom.h
1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
2 /*
3  * Brewing Logger.
4  * Copyright (C) Philip Withnall 2012 <philip@tecnocode.co.uk>
5  *
6  * Brewing Logger is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * Brewing Logger is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Brewing Logger.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef _FLASH_ROM_H
21 #define _FLASH_ROM_H
22
23 #include "log.h"
24
25 /**
26  * \file
27  * \brief Flash memory control declarations.
28  *
29  * Declarations for symbols in flash-rom.c.
30  */
31
32 void flash_rom_init (void);
33 void flash_rom_append_entry (LogEntry *entry) NONNULL (1);
34
35 /**
36  * \brief Flash ROM read entry response.
37  *
38  * Whether the LogEntry returned by flash_rom_read_head_entry() is valid. It is only valid if flash_rom_read_head_entry() returns
39  * FLASH_ROM_READ_ENTRY_SUCCESS. In all other cases, the entry will be written out as received from the Flash ROM, but its contents may be invalid.
40  */
41 typedef enum {
42         FLASH_ROM_READ_ENTRY_SUCCESS = 0,       /**< Success. */
43         FLASH_ROM_READ_ENTRY_CHECKSUM_FAILURE,  /**< Checksum did not match entry contents. */
44 } FlashRomReadEntryResponse;
45
46 FlashRomReadEntryResponse flash_rom_read_head_entry (LogEntry *entry) NONNULL (1);
47 void flash_rom_overwrite_head_entry_checksum (void);
48 void flash_rom_erase (void);
49
50 /**
51  * \brief Flash ROM flush response.
52  *
53  * Whether flushing log entries from the Flash ROM to the SD card was successful. FLASH_ROM_FLUSH_SUCCESS is returned if and only if at least the
54  * current sector's worth of log entries were successfully flushed from the Flash ROM to the SD card, and marked as flushed on the Flash ROM.
55  * Otherwise, a failure code is returned. In case of failure, one or more log entries may still have been successfully flushed from the Flash ROM to
56  * the SD card. If so, they will have been marked as flushed on the Flash ROM.
57  */
58 typedef enum {
59         FLASH_ROM_FLUSH_SUCCESS = 0,    /**< Success. */
60         FLASH_ROM_FLUSH_SD_CARD_ERROR,  /**< Error received from the SD card part-way through the flush operation. */
61 } FlashRomFlushResponse;
62
63 FlashRomFlushResponse flash_rom_flush_to_sd_card (void);
64
65 void flash_rom_power_down (void);
66 void flash_rom_power_up (void);
67
68 #endif /* !_FLASH_ROM_H */