inertialSenseBootLoader.h

Go to the documentation of this file.

/*
MIT LICENSE

Copyright (c) 2014-2021 Inertial Sense, Inc. - http://inertialsense.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef __INERTIALSENSEBOOTLOADER_H
#define __INERTIALSENSEBOOTLOADER_H

#ifdef __cplusplus
extern "C" {
#endif

#include "serialPort.h"

#define IS_BAUD_RATE_BOOTLOADER 921600

#define IS_BAUD_RATE_BOOTLOADER_RS232 230400

#define IS_BAUD_RATE_BOOTLOADER_SLOW 115200

#define IS_BAUD_RATE_BOOTLOADER_LEGACY 2000000

#define ENABLE_BOOTLOADER_BAUD_DETECTION 1
#define BOOTLOADER_REFRESH_DELAY   500
#define BOOTLOADER_RESPONSE_DELAY  10
#if ENABLE_BOOTLOADER_BAUD_DETECTION
#define BOOTLOADER_RETRIES         30
#else
#define BOOTLOADER_RETRIES         1
#endif

#ifndef BOOTLOADER_ERROR_LENGTH
#define BOOTLOADER_ERROR_LENGTH 512             // Set to zero to disable
#endif

typedef int(*pfnBootloadProgress)(const void* obj, float percent);

typedef void(*pfnBootloadStatus)(const void* obj, const char* infoString);

typedef struct
{
        const char* fileName; // read from this file
    const char* bootName; // optional bootloader file
    int forceBootloaderUpdate;
        serial_port_t* port; // connect with this serial port
        char error[BOOTLOADER_ERROR_LENGTH];
        const void* obj; // user defined pointer
        pfnBootloadProgress uploadProgress; // upload progress
        pfnBootloadProgress verifyProgress; // verify progress
    pfnBootloadStatus statusText;       // receives status text for progress
        const char* verifyFileName; // optional, writes verify file to the path if not 0
        int numberOfDevices; // number of devices if bootloading in parallel
        int baudRate; // baud rate to connect to
    union
    {
        unsigned int bits;
        struct
        {
            unsigned int enableVerify : 1; // whether to enable the verify phase
        } bitFields;
    } flags;
    char bootloadEnableCmd[16];

} bootload_params_t;

int bootloadFile(serial_port_t* port, const char* fileName, const char* bootName,
    const void* obj, pfnBootloadProgress uploadProgress, pfnBootloadProgress verifyProgress);
int bootloadFileEx(bootload_params_t* params);

int bootloadUpdateBootloader(serial_port_t* port, const char* fileName, 
    const void* obj, pfnBootloadProgress uploadProgress, pfnBootloadProgress verifyProgress);
int bootloadUpdateBootloaderEx(bootload_params_t* p);

int bootloadGetBootloaderVersionFromFile(const char* bootName, int* verMajor, char* verMinor);

int enableBootloader(serial_port_t* port, int baudRate, char* error, int errorLength, const char* bootloadEnableCmd);

int disableBootloader(serial_port_t* port, char* error, int errorLength);


int bootloaderCycleBaudRate(int baudRate);
int bootloaderClosestBaudRate(int baudRate);


#ifdef __cplusplus
}
#endif

#endif  // __INERTIALSENSEBOOTLOADER_H