bl_gen3.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc., 9350 Excelsior Blvd., Suite 700, Hopkins, MN 55343
 * ===========================================================================
 */

#ifndef XBEE_BL_GEN3_H
#define XBEE_BL_GEN3_H

#include "xbee/device.h"
#include "wpan/types.h"

XBEE_BEGIN_DECLS

typedef enum xbee_gen3_state {
    XBEE_GEN3_STATE_INIT,               // hold TX in break
    XBEE_GEN3_STATE_ENTER_BOOTLOADER,   // wait for bootloader (drops CTS)
    XBEE_GEN3_STATE_GET_BL_VERSION,     // wait until bootloader ready, send 'B'
    XBEE_GEN3_STATE_BL_VERSION,         // parse 'B' response, send 'L'
    XBEE_GEN3_STATE_BL_PROTOCOL,        // parse 'L' response, send 'R'/'X'
    XBEE_GEN3_STATE_BAUD_RATE,          // parse 'R'/'X', change baud, send 'V'
    XBEE_GEN3_STATE_EXT_VERSION,        // parse 'V' response, send 'I'
    XBEE_GEN3_STATE_START_TRANSFER,     // parse 'I' response, start transfer
    XBEE_GEN3_STATE_SEND_PAGE,          // send the current page
    XBEE_GEN3_STATE_LOAD_PAGE,          // on success, load next page or verify
    XBEE_GEN3_STATE_VERIFY,             // wait for response to 'C'

    XBEE_GEN3_STATE_SUCCESS,
    XBEE_GEN3_STATE_FAILURE
} xbee_gen3_state_t;

#define XBEE_GEN3_UPLOAD_PAGE_SIZE      512

// Response to a XBEE_GEN3_CMD_EXTENDED_VER command.
typedef XBEE_PACKED(xbee_gen3_extended_ver_t, {
    uint16_t            hw_version_le;          // ATHV
    uint16_t            hw_revision_le;         // AT%R
    uint8_t             hw_compatibility;       // AT%C
    uint8_t             unused;
    uint16_t            hw_series_le;           // ATHS
    addr64              mac_address_be;
    uint8_t             end_of_response;        // always 'U'
}) xbee_gen3_extended_ver_t;

void xbee_gen3_dump_extended_ver(const xbee_gen3_extended_ver_t *ver);

typedef struct xbee_gen3_update_t {
    uint32_t                    timer;
    xbee_gen3_state_t           state;
    xbee_gen3_state_t           next_state;
    uint16_t                    flags;
#define XBEE_GEN3_BL_FLAG_RETRY_MASK    (0xFF)  
#define XBEE_GEN3_BL_FLAG_QUERY_ONLY    (1<<8)  
#define XBEE_GEN3_BL_FLAG_PROTO1        (1<<9)  
#define XBEE_GEN3_BL_FLAG_EOF           (1<<10) 

    uint16_t                    bl_version;     
    uint16_t                    page_num;       

    int16_t                     page_offset;

    xbee_gen3_extended_ver_t    ext_ver;        

    xbee_dev_t                  *xbee;

    char                        buffer[XBEE_GEN3_UPLOAD_PAGE_SIZE];

    int (*read)(void *context, void *buffer, int16_t bytes);

    void *context;
} xbee_gen3_update_t;

#define XBEE_GEN3_FW_LOAD_TIMEOUT_MS    10000

int xbee_bl_gen3_install_init(xbee_dev_t *xbee, xbee_gen3_update_t *source);

uint16_t xbee_bl_gen3_install_state(xbee_gen3_update_t *source);

int xbee_bl_gen3_install_tick(xbee_gen3_update_t *source);

#define XBEE_GEN3_STATUS_BUF_SIZE       60

const char *xbee_bl_gen3_install_status(xbee_gen3_update_t *source,
                                        char buffer[XBEE_GEN3_STATUS_BUF_SIZE]);

XBEE_END_DECLS

#endif // XBEE_BL_GEN3_H