Flasher.hpp

Go to the documentation of this file.

/*
 *  Copyright (c) 2020, Cascoda Ltd.
 *  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 name of the copyright holder nor the
 *     names of its 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 HOLDER 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.
 */
 
#ifndef POSIX_APP_CHILICTL_FLASH_FLASHER_HPP_
#define POSIX_APP_CHILICTL_FLASH_FLASHER_HPP_
 
#include <fstream>
#include <mutex>
 
#include "common/DeviceInfo.hpp"
 
namespace ca {
 
class Flasher
{
public:
    enum FlashType
    {
        APROM_CLEAR             = 0, 
        APROM_PROGRAM           = 1, 
        APROM_CLEAR_AND_PROGRAM = 2, 
        DFU                     = 3, 
        MANUFACTURER            = 4, 
    };
 
    enum State
    {
        INIT,      
        OTA_ERASE, 
        REBOOT,    
        ERASE,     
        FLASH,     
        VERIFY,    
        VALIDATE,  
        COMPLETE,  
        FAIL,      
        INVALID,   
    };
 
    Flasher(const char       *aAppFilePath,
            const char       *aOtaBootFilePath,
            const char       *aManufacturerDataFilePath,
            const DeviceInfo &aDeviceInfo,
            FlashType         aFlashType);
 
    ~Flasher();
 
    ca_error Process();
 
    bool IsComplete();
 
    State GetState() { return mState; }
 
    void SetIgnoreVersion(bool aIgnoreVersion) { mIgnoreVersion = aIgnoreVersion; }
 
    void SetEnumerateUartDevices(bool aEnumerateUartDevices) { mEnumerateUartDevices = aEnumerateUartDevices; }
 
private:
    enum
    {
        kMaxRebootDiscoverAttempts = 10,
        kMsgSendTimeout            = 5,
        kWriteLen                  = 244,
    };
 
    std::mutex    mMutex;
    std::ifstream mAppFile;
    std::ifstream mOtaBootFile;
    std::ifstream mManuDataFile;
    size_t        mAppFileSize;
    size_t        mOtaBootFileSize;
    size_t        mManuDataFileSize;
    size_t        mAppMaxFileSize;
    size_t        mOtaBootMaxFileSize;
    size_t        mManuDataMaxFileSize;
    uint32_t      mAppStartAddr;
    uint32_t      mOtaBootStartAddr;
    uint32_t      mManuDataStartAddr;
    size_t        mCombinedFileSize;
    size_t        mPageSize;
    ca821x_dev    mDeviceRef;
    DeviceInfo    mDeviceInfo;
    uint32_t      mCounter;
    State         mState;
    FlashType     mFlashType;
    bool          mIgnoreVersion;
    bool          mEnumerateUartDevices;
    bool          mOtaBootFilePresent;
 
    void     set_state(State aNextState);
    ca_error init();
    ca_error ota_erase();
    ca_error reboot();
    ca_error erase();
    ca_error flash();
    ca_error verify();
    ca_error validate();
 
    ca_error ota_erase_done(ca_error status);
    ca_error reboot_done(ca_error status);
    ca_error erase_done(ca_error status);
    ca_error flash_done(ca_error status);
    ca_error verify_done(ca_error status);
    ca_error validate_done(ca_error status);
 
    ca_error        dfu_callback(EVBME_Message *params);
    static ca_error dfu_callback(EVBME_Message *params, ca821x_dev *pDeviceRef);
 
    ca_error        handle_evbme_message(EVBME_Message *params);
    static ca_error handle_evbme_message(EVBME_Message *params, ca821x_dev *pDeviceRef);
 
    ca_error send_reboot_request();
    void     configure_size_and_addresses();
    size_t   get_page_count_for_erase();
    uint32_t get_start_address();
 
    static const char *state_string(State aState);
};
 
} /* namespace ca */
 
#endif /* POSIX_APP_CHILICTL_FLASH_FLASHER_HPP_ */