Interface: LogData

This interface is used to provide efficient, byte level logging to a region of memory/flash/etc (the actual region is specified through some other mechanism, e.g., in ByteEEPROM by providing a parameterised LogData interface). Unlike the WriteData interface, the data written via append is only guaranteed to be present in the region once sync has completed. Note: this interface is purposefully restrictive to allow logging to be as fast as possible. Calls to LogData must not be interspersed with calls to WriteData on the same area of memory/flash/etc (ReadData is fine). WriteData can be called after syncDone returns. This interface is currently used by ByteEEPROM

Author:

David Gay

Components providing this interface:

tos.platform.mica.ByteEEPROM
tos.platform.mica.ByteEEPROMC
tos.system.BufferedLog

Components requiring this interface:

apps.HighFrequencySampling.Sample
apps.TestEEPROM.ByteSpeed.ETimingM
tos.system.BufferedLog

Commands

• result_t erase (void) Erase region, reset append pointer to beginning of region

• result_t append (uint8_t *data, uint32_t numBytes) Append bytes to region (erase must be called first)

• uint32_t currentOffset (void) Report current append offset.

• result_t sync (void) Ensure all data written by append is committed to flash.

• result_t eraseDone (result_t success) Report erase completion.

• result_t appendDone (uint8_t *data, uint32_t numBytes, result_t success) Report append completion.

• result_t syncDone (result_t success) Report sync completion.

erase

append

currentOffset

sync

eraseDone

appendDone

syncDone