Kinetis Bootloader  2.0.0
Common bootloader for Kinetis devices
executable_image.h
1 /*
2  * Copyright (c) 2013 - 2014, Freescale Semiconductor, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * o Redistributions of source code must retain the above copyright notice, this list
9  * of conditions and the following disclaimer.
10  *
11  * o Redistributions in binary form must reproduce the above copyright notice, this
12  * list of conditions and the following disclaimer in the documentation and/or
13  * other materials provided with the distribution.
14  *
15  * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from this
17  * software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef __executable_image_H__
32 #define __executable_image_H__
33 
34 #include <stdint.h>
35 
36 /*******************************************************************************
37  * Definitions
38  ******************************************************************************/
39 
40 #define IMAGE_BUFFER_SIZE 1024 * 16
41 #define IMAGE_START_ADDRESS 0x00010000
42 
44 enum
45 {
46  kImageType_SB = 0,
47  kImageType_Srecord = 1,
48  kImageType_Intelhex = 2,
49  kImageType_Binary = 3,
50  kImageType_Invalid = 4
51 };
52 
53 enum
54 {
56  SB_SIGN1 = 'S',
57  SB_SIGN2 = 'T',
58  SB_SIGN3 = 'M',
59  SB_SIGN4 = 'P',
61  SB_SIGN_OFFSET1 = 20,
62  SB_SIGN_OFFSET2 = 21,
63  SB_SIGN_OFFSET3 = 22,
64  SB_SIGN_OFFSET4 = 23
65 };
66 
67 enum
68 {
70  SRECORD_SIGN = 'S',
72  SRECORD_SIGN_OFFSET = 0
73 };
74 
75 enum
76 {
78  INTELHEX_SIGN = ':',
80  INTELHEX_SIGN_OFFSET = 0
81 };
82 
83 enum _recordStatus_t
84 {
85  kRecordStatus_Success = 0,
86  kRecordStatus_Fail = 1,
87  kRecordStatus_InvalidLength = 2,
88  kRecordStatus_InvalidStart = 3,
89  kRecordStatus_InvalidType = 4,
90  kRecordStatus_InvalidChecksum = 5,
91  kRecordStatus_FlashOver = 6,
92  kRecordStatus_FlashPartly = 7,
93  kRecordStatus_EraseOver = 8,
94  kRecordStatus_ErasePartly = 9
95 };
96 typedef uint8_t recordStatus_t;
97 
99 typedef void (*flash_image_status_t)(recordStatus_t status);
100 
101 extern uint8_t s_image_buffer[IMAGE_BUFFER_SIZE];
102 extern uint32_t s_image_buffer_index;
103 extern uint32_t s_image_start_address;
104 extern uint32_t s_image_next_address;
105 extern uint32_t s_image_base_address;
106 
107 /*******************************************************************************
108  * API
109  ******************************************************************************/
110 #if defined(__cplusplus)
111 extern "C" {
112 #endif /* __cplusplus */
113 
115 uint8_t read_flash_char(uint32_t address, uint32_t index);
116 
118 uint8_t get_image_type();
119 
121 recordStatus_t flash_image(flash_image_status_t function);
122 
123 #if defined(__cplusplus)
124 }
125 #endif /* __cplusplus */
126 
127 #endif /* __executable_image_H__ */