ISBootloaderExample.c

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.
*/

#include <stdio.h>

// STEP 1: Add Includes
// Change these include paths to the correct paths for your project
#include "../../src/ISComm.h"
#include "../../src/serialPortPlatform.h"
#include "../../src/inertialSenseBootLoader.h"

// print out upload progress
static int bootloaderUploadProgress(const void* obj, float percent)
{
        printf("Upload: %d percent...         \r", (int)(percent * 100.0f));
        if (percent >= 1.0f)
        {
                printf("\n");
        }
        return 1; // return zero to abort
}

// print out verify progress
static int bootloaderVerifyProgress(const void* obj, float percent)
{
        printf("Verify: %d percent...         \r", (int)(percent * 100.0f));
        if (percent >= 1.0f)
        {
                printf("\n");
        }
        return 1; // return zero to abort
}

static void bootloaderStatusText(const void* obj, const char* info)
{
        printf("%s\n", info);
}

int main(int argc, char* argv[])
{
        if (argc < 3 || argc > 4)
        {
                printf("Please pass the com port, firmware file name to bootload, and optionally bootloader file name as the only arguments\r\n");
                printf("usage: %s {COMx} {Firmware file} {Bootloader file (optional)}\r\n", argv[0]);
                // In Visual Studio IDE, this can be done through "Project Properties -> Debugging -> Command Arguments: COM3 IS_uINS-3.hex" 
                return -1;
        }

        // STEP 2: Initialize and open serial port

        serial_port_t serialPort;

        // initialize the serial port (Windows, MAC or Linux) - if using an embedded system like Arduino,
        //  you will need to either bootload from Windows, MAC or Linux, or implement your own code that
        //  implements all the function pointers on the serial_port_t struct.
        serialPortPlatformInit(&serialPort);

        // set the port - the bootloader uses this to open the port and enable bootload mode, etc.
        serialPortSetPort(&serialPort, argv[1]);

        // STEP 3: Set bootloader parameters

        // bootloader parameters
        bootload_params_t param;

        // very important - initialize the bootloader params to zeros
        memset(&param, 0, sizeof(param));

        // the file to bootload, *.hex
        param.fileName = argv[2];

        // optional - bootloader file, *.bin
        param.forceBootloaderUpdate = 0;        //do not force update of bootloader
        if (argc == 4)
                param.bootName = argv[3];
        else
                param.bootName = 0;

        // the serial port
        param.port = &serialPort;

        // progress indicators
        param.uploadProgress = bootloaderUploadProgress;
        param.verifyProgress = bootloaderVerifyProgress;
        param.statusText = bootloaderStatusText;

        // enable verify to read back the firmware and ensure it is correct
        param.flags.bitFields.enableVerify = 1;

        // optional - define baudrate. If not defined standard baud rates will be attempted.
        // The default bootloader baudrate is 921600.  If using a system with known baud limits it is best to specify a lower baudrate.
//      param.baudRate = IS_BAUD_RATE_BOOTLOADER_RS232;
//      param.baudRate = IS_BAUD_RATE_BOOTLOADER_SLOW;

        // enable auto-baud, in the event that fast serial communications is not available,
        //  the bootloader will attempt to fall back to a slower speed
        //      param.flags.bitFields.enableAutoBaud = 1;

        // STEP 4: Run bootloader

        if (bootloadFileEx(&param))
        {
                printf("Bootloader success on port %s with file %s\n", serialPort.port, param.fileName);
                return 0;
        }
        else
        {
                if(param.error[0] != 0)
                        printf("Bootloader failed! Error: %s\n", param.error);
                else
                        printf("Bootloader failed!\n");
                return -1;
        }
}