nbupdate.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef __NBUPDATE_H
#define __NBUPDATE_H
 
#include <predef.h>
#include <constants.h>
#include <basictypes.h>
#include <PlatformHeader.h>
 
#define NBUP_ERR_NO_ERR 0        
#define NBUP_ERR_BAD_SOCK -1     
#define NBUP_ERR_TIMEOUT -2      
#define NBUP_ERR_TOO_LARGE -3    
#define NBUP_ERR_WRONG_PLAT -4   
#define NBUP_ERR_BAD_PROG -5     
#define NBUP_ERR_BAD_AUTH -6     
// States...
// Looking for an S....
// S getting S record type
// Parsing Address up to 8 chars)
// Parsing Data
// Checking csum....
 
// S0MOD5441X
// S315C0040000 40 00 04 00 40 00 05 40 00 05 F6 3C 00 03 AA 5C  1D
// S315C0040010 1B 41 90 65 A7 0A 18 11 00 41 FF FF 01 4C 6C 80  73
// S7054000054075
 
extern const char PlatformName[];
 
const uint16_t FLAG_DOING_S0 = 1;
const uint16_t FLAG_DOING_S3 = 2;
const uint16_t FLAG_DOING_S7 = 4;
const uint16_t FLAG_SUS_VALID = 8;
const uint16_t FLAG_SAW_FINALS7 = 16;
const uint16_t FLAG_SAW_BINARY = 32;
const uint16_t FLAG_DOING_BINARY = 64;
const uint16_t FLAG_NEED_AUTH_CHARS = 128;
const uint16_t FLAG_DONE_S0 = 0x100;
 
class AppUpdateRecord
{
    bool m_bWrittenToFlash;
    uint8_t m_state;
    uint8_t m_csum;
    uint8_t m_cnt;
    uint16_t m_flags;
    uint32_t tempv;
 
    PlatformFlashHeaderStruct bsus;
    PlatformFlashHeaderStruct sus;
 
    uint8_t *pRecord;
#ifdef APP_BUFFER_VERIFY
    uint8_t *pRecord2;
#endif
    uint32_t DataRead;
    uint32_t BaseAddress;
    const char *m_Error;
    int m_ErrorNum;
 
   public:
    AppUpdateRecord();
    ~AppUpdateRecord();
    // Return true when done
    bool ParseChars(char *chars, int nChars);
    void ParseOneChar(char c);
    void PutValue(uint8_t v);
    bool resp;
    bool bUpdateRefused;
 
    enum
    {
        ERR_NO_ERR,
        ERR_NO_REC,
        ERR_BAD_RX,
        ERR_WRITE_FAIL,
        ERR_ALREADY_WRITTEN,
        ERR_BAD_ALLOC,
        ERR_BAD_PLAT,
        ERR_BAD_AUTH,
        ERR_BAD_CSUM
    };
 
    int DoFlashProgram();
    bool CsumValid();
    bool ImageReceived()
    {
        if ((m_Error) || (m_ErrorNum) || (!pRecord) || (DataRead < sus.CompleteRecordSize() - sus.SizeWithoutPad()) ||
            ((m_flags & FLAG_SAW_FINALS7) == 0) || (m_flags & FLAG_NEED_AUTH_CHARS))
            return false;
        return true;
    };
 
    const char *GetError() { return m_Error; };
 
    int GetErrorNum() { return m_ErrorNum; }
 
    void SetBadAuth()
    {
        m_ErrorNum = ERR_BAD_AUTH;
        m_Error = "Bad Authentication";
    }
 
    bool bWaitingOnAuth() { return (((m_flags & FLAG_NEED_AUTH_CHARS) != 0) || (m_ErrorNum == ERR_BAD_AUTH)); }
 
    uint32_t GetbaseAddress() { return BaseAddress; };
 
    uint32_t GetLength() { return sus.CompleteRecordSize() - sus.SizeWithoutPad(); };
 
    uint32_t GetFullLength() { return bsus.CompleteRecordSize(); };
 
    const uint8_t *GetData() { return pRecord; };
 
    bool IsBinary() { return ((m_flags & FLAG_DOING_BINARY) != 0); }
 
    int32_t GetRemainingLen() { return (int32_t)bsus.CompleteRecordSize() - DataRead; }
};
 
enum AppAuthResult
{
    eOKToProgram,
    eBadSignature,
    eMoreData
};
 
// Helper functiosn for signed apps.
typedef AppAuthResult (*AppAuthenticateFunc)(AppUpdateRecord *ar, uint8_t *chars, int n);
extern AppAuthenticateFunc pAppAuthFunc;
 
void RegisterAppSigningPublicKey(const char *pKey);
 
int ProgramApplication(uint32_t where, uint8_t *pAppImage);
 
int UpdateFromStream(int fd, AppUpdateRecord *&pu, uint32_t timeout);
 
#endif /* ----- #ifndef __NBUPDATE_H  ----- */