intelhex_image.h

/*
 * Copyright (c) 2013 - 2014, Freescale Semiconductor, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o 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.
 *
 * o Neither the name of Freescale Semiconductor, Inc. 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 __intelhex_image_H__
#define __intelhex_image_H__

#include "executable_image.h"

/*******************************************************************************
 * Definitions
 ******************************************************************************/
enum
{
    INTELHEX_START_CHAR = ':',

    INTELHEX_MIN_LENGTH = 11,

    INTELHEX_ADDRESS_START_CHAR_INDEX = 3,

    INTELHEX_TYPE_START_CHAR_INDEX = 7,

    INTELHEX_DATA_START_CHAR_INDEX = 9
};

enum
{
    INTELHEX_RECORD_DATA = 0x00,

    INTELHEX_RECORD_END_OF_FILE = 0x01,

    INTELHEX_RECORD_EXTENDED_SEGMENT_ADDRESS = 0x02,

    INTELHEX_RECORD_START_SEGMENT_ADDRESS = 0x03,

    INTELHEX_RECORD_EXTENDED_LINEAR_ADDRESS = 0x04,

    INTELHEX_RECORD_START_LINEAR_ADDRESS = 0x05
};

/*******************************************************************************
 * API
 ******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif /* __cplusplus */

recordStatus_t intelhex_image_program(uint32_t image_address);

#if defined(__cplusplus)
}
#endif /* __cplusplus */

#endif /* __intelhex_image_H__ */