# SFBProvenance.h File Reference

Support for tracking sketch origins data. More...

`#include "SFBTypes.h"`
`#include "SFBChecksum.h"`

Include dependency graph for SFBProvenance.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Data Structures
struct | SFBProvenance
| An SFBProvenance provides information that describes a sketch as a physical artifact. More...
## Defines
#define | SFB_PROVENANCE_MAGIC 0xC300A5FB
| The magic value indicating the start of the checksummed region of a sketch.
#define | SFB_PROVENANCE_CIGAM 0xBF5A003C
| The "backwards" magic value indicating the end of an SFBProvenance block (although not the end of the checksummed region of a sketch).
#define | SFB_PROVENANCE_NZTRX (~SFB_PROVENANCE_MAGIC)
| The "inverted" magic value indicating the end of the checksummed region of a sketch.
## Enumerations
enum | BootProgrammingFlags { PROGRAMMING_FLAG_VERBOSE = 0x01, PROGRAMMING_FLAG_QUIET = 0x02, PROGRAMMING_FLAG_CHECKOFF = 0x04, PROGRAMMING_FLAG_RSRVD4 = 0x08, PROGRAMMING_FLAG_RSRVD5 = 0x10, PROGRAMMING_FLAG_RSRVD6 = 0x20, PROGRAMMING_FLAG_RSRVD7 = 0x40, PROGRAMMING_FLAG_RSRVD8 = 0x80 }

## Detailed Description

Support for tracking sketch origins data.

Author:
  David H. Ackley.

Date:
  (C) 2008 All rights reserved.

Code License:
  The GNU Lesser General Public License

License Note:
  All code samples shown in documentation are placed into the public domain.

## Define Documentation

#define SFB_PROVENANCE_NZTRX (~SFB_PROVENANCE_MAGIC)

The "inverted" magic value indicating the end of the checksummed region of a sketch.

Placed in flash memory after all sketch code by the build system.

## Enumeration Type Documentation

enum BootProgrammingFlags

Enumerator:

  PROGRAMMING_FLAG_VERBOSE | Report extra status messages during burns.
  PROGRAMMING_FLAG_QUIET | Report minimal status messages during burns.
  PROGRAMMING_FLAG_CHECKOFF | Don't trust existing sector checksums during a burn.
  PROGRAMMING_FLAG_RSRVD4 | Reserved for future use; value should be zero and ignored.
  PROGRAMMING_FLAG_RSRVD5 | Reserved for future use; value should be zero and ignored.
  PROGRAMMING_FLAG_RSRVD6 | Reserved for future use; value should be zero and ignored.
  PROGRAMMING_FLAG_RSRVD7 | Reserved for future use; value should be zero and ignored.
  PROGRAMMING_FLAG_RSRVD8 | Reserved for future use; value should be zero and ignored.