userconfig.h

#ifndef USERCONFIG_H
#define USERCONFIG_H
 
typedef struct user_config {
  uint16_t      validbytes;     // how many bytes in user_config are set?
  uint32_t      checksum;       // crc over the bytes
  uint32_t      data_version;   // incremented each time it changes. 0 == invalid
  uint8_t       userdata[2048];
} _user_config;
 
/*
 * \brief receive a (partial) update
 * commands "userapp-control" with parameter "ucr=n" are sent this way.
 * n==1 initializes a new receive section, requires pid=P and max=M, where
 *       M is the maximum number of packets
 *       P is a unique ID for this set of packets
 * n==2 adds data, requires pid=P, pos=X, size=S and data=[bytes], where
 *       X is the index of this data packet [1...n]
 *       S is the size in bytes of data argument
 * packets must be in order and once last packet is received, flash is updated.
 */
int userconfig_receive(struct command *com);
 
/*
 * the userconfig:
 * this is a little unstructured piece of flash set aside for configuration of userapps.
 * note that this is updated at any time. If the userapp reads flash from interrupts the
 * flash might change between invokations. if that is a problem the app should copy the
 * contents into ram from the userloop.
 */
/*
 * return the current size of the userconfig space. 0 means it is invalid, that is "there isn't one"
 */
uint32_t userconfig_size();
/*
 * each time the config is updated, the version is incremented.
 * in other words, unless the version is changed, the data remains the same
 */
uint32_t userconfig_version();
/*
 * this copies the userconfig into a ram buffer, *IF* the version has been updated and *IF* the destination buffer is large enough.
 * actual_size (if NOT NULL) will contain the actual size of bytes once this completes without an error
 * RETURN VALUE: 0==ok, anything else is an error (same version is not an error)
 */
int userconfig_copy(uint8_t *buf, uint16_t bufsize, uint16_t *actual_size);
/*
 * write the userconfig in ram to flash
 * RETURN VALUE: 0==ok, anything else is an error
 */
int  write_user_config_to_flash();
// write but as userconfig
int userconfig_write(uint8_t *buf, uint32_t size);
 
#endif