1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/*
* Copyright (C) 2016 by Daniel Friesel
*
* License: You may use, redistribute and/or modify this file under the terms
* of either:
* * The GNU LGPL v3 (see COPYING and COPYING.LESSER), or
* * The 3-clause BSD License (see COPYING.BSD)
*
*/
#include <stdlib.h>
#define I2C_EEPROM_ADDR 0x50
class Storage {
private:
uint8_t num_anims;
uint8_t page_offset;
uint8_t header[2];
uint8_t first_free_page;
uint8_t i2c_start_write(void);
uint8_t i2c_start_read(void);
void i2c_stop(void);
uint8_t i2c_send(uint8_t len, uint8_t *data);
uint8_t i2c_receive(uint8_t len, uint8_t *data);
uint8_t i2c_read(uint8_t addrhi, uint8_t addrlo, uint8_t len, uint8_t *data);
uint8_t i2c_write(uint8_t addrhi, uint8_t addrlo, uint8_t len, uint8_t *data);
enum I2CStatus : uint8_t {
I2C_OK,
I2C_START_ERR,
I2C_ADDR_ERR,
I2C_ERR
};
public:
Storage() { num_anims = 0; first_free_page = 0;};
/**
* Enable the storage hardware: Configures the internal I2C
* module and reads the number of stored patterns from the
* EEPROM.
*/
void enable();
/**
* Prepares the storage for a complete overwrite by setting the
* number of stored animations to zero. The next save operation
* will get pattern id 0 and overwrite the first stored pattern.
*
* Note that this function does not write anything to the
* EEPROM. Use Storage::sync() for that.
*/
void reset();
/**
* Writes the current number of animations (as set by reset() or
* save() to the EEPROM. Required to get a consistent storage state
* after a power cycle.
*/
void sync();
/**
* Checks whether the EEPROM contains animathion data.
*
* @return true if the EEPROM contains valid-looking data
*/
bool hasData();
/**
* Accessor for the number of saved patterns on the EEPROM.
* Only returns valid data if hasData() returned true.
*
* @return number of patterns
*/
uint8_t numPatterns() { return num_anims; };
/**
* Load pattern from EEPROM.
*
* @param idx pattern index (starting with 0)
* @param data pointer to data structure for the pattern. Must be
* at least 132 bytes
*/
void load(uint8_t idx, uint8_t *data);
/**
* Load partial pattern chunk (without header) from EEPROM.
*
* @param chunk 128 byte-offset inside pattern (starting with 0)
* @param data pointer to data structure for the pattern. Must be
* at least 128 bytes
*/
void loadChunk(uint8_t chunk, uint8_t *data);
/**
* Save (possibly partial) pattern on the EEPROM. 32 bytes of
* dattern data will be read and stored, regardless of the
* pattern header.
*
* @param data pattern data. Must be at least 32 bytes
*/
void save(uint8_t *data);
/**
* Continue saving a pattern on the EEPROM. Appends 32 bytes of
* pattern data after the most recently written block of data
* (i.e., to the pattern which is currently being saved).
*
* @param data pattern data. Must be at least 32 bytes
*/
void append(uint8_t *data);
};
extern Storage storage;
|
