StreamUpdate.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
/*
 * The code module also contains functions to read and write the User Parameter
 * section of onboard flash memory as a stream. They are here for compatibility
 * with proir tools releases, but the recommended 3.x tools method is to use
 * the application storage of the Configuration System, since it can be accessed
 * through the Configuration Server and JSON objects.
 */
 
#ifndef _NB_STREAM_UP_H
#define _NB_STREAM_UP_H
 
#include <basictypes.h>
 
#define STREAM_UP_FAIL (0)   
#define STREAM_UP_OK (1)     
int ReadBinaryApplicationCodeFromStream(int fd);
 
int ReadS19ApplicationCodeFromStream(int fd);
 
// Send an application image as to an output stream in s-record S19 format
int SendApplicationCodeAsS19(int fd);
 
// Exposed to allow custom updates to be used
int ProcessS3(const char *cp, uint32_t base_Addr, puint8_t CopyTo, uint32_t &cur_pos, uint32_t maxlen);
 
//=================================== USER FLASH FUNCTIONS =========================================
 
/*
 * Send User Parameter Flash data as a binary output stream to the specified file
 * descriptor.
 *
 * Parameters:
 *   int fd     The socket file descriptor to send the data to
 *
 * Returns:
 *   STREAM_UP_OK   The system was able to send the data
 *   STREAM_UP_FAIL The system failed to send the data
 *
 * See Also:
 *   int SendUserFlashToStreamAsS19(int fd);
 *   int ReadBinaryUserFlashFromStream(int fd);
 *   int ReadS19UserFlashFromStream(int fd);
 */
int SendUserFlashToStreamAsBinary(int fd);
 
/*
 * Send User Parameter Flash data as an ASCII s-record S19 output stream to the
 * specified file descriptor.
 *
 * Parameters:
 *   int fd  The socket file descriptor to send the data to
 *
 * Returns:
 *    STREAM_UP_OK      The system was able to send the data
 *    STREAM_UP_FAIL    The system failed to send the data
 *
 * See Also:
 *   int SendUserFlashToStreamAsBinary(int fd);
 *   int ReadBinaryUserFlashFromStream(int fd);
 *   int ReadS19UserFlashFromStream(int fd);
 */
int SendUserFlashToStreamAsS19(int fd);
 
/*
 * Read data from an ASCII s-record S19 input stream and store it in
 * User Parameter Flash.
 *
 * Parameters:
 *   int fd The socket file descriptor to read data from
 *
 * Returns:
 *  STREAM_UP_OK    The system was able to read the data and update flash
 *  STREAM_UP_FAIL  The system failed to read or update
 *
 * See Also:
 *   int SendUserFlashToStreamAsS19(int fd);
 *   int SendUserFlashToStreamAsBinary(int fd);
 *   int ReadBinaryUserFlashFromStream(int fd);
 */
int ReadS19UserFlashFromStream(int fd);
 
/*
 * Read data from an binary input stream and store it in User Parameter Flash.
 *
 * Parameters:
 *  int fd  The socket file descriptor to read data from
 *
 * Returns:
 *   STREAM_UP_OK   The system was able to read the data and update flash
 *   STREAM_UP_FAIL The system failed to read or update
 *
 * See Also:
 *   int SendUserFlashToStreamAsS19(int fd);
 *   int SendUserFlashToStreamAsBinary(int fd);
 *   int ReadS19UserFlashFromStream(int fd);
 */
int ReadBinaryUserFlashFromStream(int fd);
 
//=================================== UTILITY STRUCURES AND FUNCTIONS =========================================
 
// Structure to hold the data from a update before actually programming it in flash
struct TwoPartUpdateStruct
{
    uint8_t S0Record[24];
    puint8_t pBlob;
    uint32_t address;
    uint32_t pgm_size;
    int Result;
 
    TwoPartUpdateStruct()
    {
        pBlob = 0;
        Result = STREAM_UP_FAIL;
    };
};
 
/*
 * Populates the structure with an allocated binary buffer to program into flash.
 * Returns STREAM_UP_OK, and sets structure result to STREAM_UP_OK if successful.
 */
int ReadTwoPartAppUdate(int fd, TwoPartUpdateStruct &us);
 
/*
 * Take a successfully read stream update and programs the flash memory.
 * Returns STREAM_UP_FAIL if update fails.
 * Forces a device reboot on success.
 * Frees any dynamically allocated memory.
 */
int DoTwoPartAppUpdate(TwoPartUpdateStruct &us);
 
/*
 * Called to abort an update and free any dynamically allocated memory
 */
void AbortTwoPartAppUpdate(TwoPartUpdateStruct &us);
 
#endif