osd-contiki/regression-tests
Robert Quattlebaum 28a1e40ebd core/lib/settings: Generalized Settings Manager to work on any platform
This commit moves the Settings Manager from the AVR codebase
into the Contiki core library. Any platform that implements
the Contiki EEPROM API can now use the Settings Manager's
key-value store for storing their persistent configuration info.

The Settings Manager is a EEPROM-based key-value store. Keys
are 16-bit integers and values may be up to 16,383 bytes long.
It is intended to be used to store configuration-related information,
like network settings, radio channels, etc.

 * Robust data format which requires no initialization.
 * Supports multiple values with the same key.
 * Data can be appended without erasing EEPROM.
 * Max size of settings data can be easily increased in the future,
   as long as it doesn't overlap with application data.

The format was inspired by the [OLPC manufacturing data format][].

Since the beginning of EEPROM often contains application-specific
information, the best place to store settings is at the end of EEPROM
(the "top"). Because we are starting at the end of EEPROM, it makes
sense to grow the list of key-value pairs downward, toward the start of
EEPROM.

Each key-value pair is stored in memory in the following format:

Order    | Size     | Name         | Description
--------:|---------:|--------------|-------------------------------
       0 |        2 | `key`        | 16-bit key
      -2 |        1 | `size_check` | One's-complement of next byte
      -3 |   1 or 2 | `size`       | The size of `value`, in bytes
-4 or -5 | variable | `value`      | Value associated with `key`

The end of the key-value pairs is denoted by the first invalid entry.
An invalid entry has any of the following attributes:

 * The `size_check` byte doesn't match the one's compliment of the
   `size` byte (or `size_low` byte).
 * The key has a value of 0x0000.

[OLPC manufacturing data format]: http://wiki.laptop.org/go/Manufacturing_data
2013-03-20 11:57:13 -07:00
..
01-compile core/lib/settings: Generalized Settings Manager to work on any platform 2013-03-20 11:57:13 -07:00
02-hello-world Moved the Contiki tests from the tools/cooja directory into the regression-tests/ directory 2012-12-10 01:50:01 +01:00
03-base Moved the Contiki tests from the tools/cooja directory into the regression-tests/ directory 2012-12-10 01:50:01 +01:00
04-rime Updated paths to relative paths to make it easier to move tests to new directories 2013-03-18 09:07:33 +01:00
05-netperf Moved the Contiki tests from the tools/cooja directory into the regression-tests/ directory 2012-12-10 01:50:01 +01:00
06-shell Make regression tests deterministic by having a constant random seed 2012-12-10 01:50:06 +01:00
07-elfloader Moved the Contiki tests from the tools/cooja directory into the regression-tests/ directory 2012-12-10 01:50:01 +01:00
08-collect Split the collect test into collect and collect-lossy to make each individual 2013-03-18 09:07:33 +01:00
09-collect-lossy Split the collect test into collect and collect-lossy to make each individual 2013-03-18 09:07:33 +01:00
10-ipv4 Split the collect test into collect and collect-lossy to make each individual 2013-03-18 09:07:33 +01:00
11-ipv6 Split the collect test into collect and collect-lossy to make each individual 2013-03-18 09:07:33 +01:00
12-rpl Updated paths to relative paths to make it easier to move tests to new directories 2013-03-18 09:07:33 +01:00
13-ip6-apps Split the collect test into collect and collect-lossy to make each individual 2013-03-18 09:07:33 +01:00
Makefile The Thingsquare Mist regression test scripts 2012-12-10 01:49:48 +01:00
Makefile.compile-test Fix up compile test so that you can do nested subdirectories 2012-12-11 12:58:11 -05:00
Makefile.simulation-test The Thingsquare Mist regression test scripts 2012-12-10 01:49:48 +01:00