fwupdate.h

Go to the documentation of this file.

 
//  Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
//  All rights reserved.
//  
//  Redistribution and use in source and binary forms, with or without modification,
//  are permitted provided that the following conditions are met:
//  
//  1.  Redistributions of source code must retain the above copyright notice,
//      this list of conditions, and the following disclaimer.
//  
//  2.  Redistributions in binary form must reproduce the above copyright notice,
//      this list of conditions, and the following disclaimer in the documentation
//      and/or other materials provided with the distribution.
//  
//  3.  Neither the names of the copyright holders nor the names of their contributors
//      may be used to endorse or promote products derived from this software without
//      specific prior written permission.
//  
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
//  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
//  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
//  THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
//  OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
//  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
//  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS 
//  SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES 
//  OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE 
//  ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
//  
 
 
//  Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
//  All rights reserved.
//  
//  Redistribution and use in source and binary forms, with or without modification,
//  are permitted provided that the following conditions are met:
//  
//  1.  Redistributions of source code must retain the above copyright notice,
//      this list of conditions, and the following disclaimer.
//  
//  2.  Redistributions in binary form must reproduce the above copyright notice,
//      this list of conditions, and the following disclaimer in the documentation
//      and/or other materials provided with the distribution.
//  
//  3.  Neither the names of the copyright holders nor the names of their contributors
//      may be used to endorse or promote products derived from this software without
//      specific prior written permission.
//  
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
//  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
//  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
//  THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
//  OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
//  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
//  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS 
//  SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES 
//  OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE 
//  ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
//  
 
#ifndef FWUPDATE_H
#define FWUPDATE_H
 
#include "xbus.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define FWU_REQUIRED_TXBUFFER_SIZE 300
 
typedef enum
{
        FWU_Success,
        FWU_Failed
} FWU_Result;
 
 
typedef struct
{
        uint32_t m_globalId;                    
        uint32_t m_sectionSize;                 
        uint8_t m_firmwareRevision[3];  
        uint8_t m_xffVersion[2];                
        uint8_t m_chipId;                               
        uint8_t m_numberOfSections;             
        uint8_t m_addressLength;                
        uint16_t m_pageSize;                    
        uint16_t m_sliceSize;                   
        uint8_t m_hardwareVersion[2];   
        char m_productCode[20];                 
        uint32_t m_productVariant;              
} XffHeader;
 
 
typedef enum
{
        STATE_Idle,
        STATE_Start,
        STATE_WaitReady,
        STATE_WaitHeaderResult,
        STATE_WaitSliceReady,
        STATE_WaitPageOk,
        STATE_WaitPageReady
} FWU_State;
 
 
 
typedef struct
{
        /*      External dependencies. Host should fill in these members */
 
        uint32_t (*m_readXffData)(uint8_t* buffer, uint32_t offset, uint32_t length);
 
        void (*m_sendXbusMessage)(uint8_t const* xbusMessage);
 
        void (*m_readyHandler)(FWU_Result result);
 
        uint8_t* m_txBuffer;
 
        /*      State variables for internal use (the user must not touch these) */
        FWU_State m_state;                              
        XffHeader m_xffHeader;                  
        uint32_t m_nofPages;                    
        uint32_t m_nofSlicesPerPage;    
        uint32_t m_pageCounter;                 
        uint32_t m_sliceCounter;                
        uint32_t m_readIndex;                   
        uint8_t m_endOfFile;                    
} FwUpdate;
 
 
void FwUpdate_init(FwUpdate* thisPtr);
 
void FwUpdate_start(FwUpdate* thisPtr);
 
void FwUpdate_handleXbus(FwUpdate* thisPtr, uint8_t const* xbusMessage);
 
 
#ifdef __cplusplus
}
#endif /* extern "C" */
 
 
#endif