img2srec.c 9.73 KB
Newer Older
wdenk's avatar
wdenk committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
/*************************************************************************
|  COPYRIGHT (c) 2000 BY ABATRON AG
|*************************************************************************
|
|  PROJECT NAME: Linux Image to S-record Conversion Utility
|  FILENAME    : img2srec.c
|
|  COMPILER    : GCC
|
|  TARGET OS   : LINUX / UNIX
|  TARGET HW   : -
|
|  PROGRAMMER  : Abatron / RD
|  CREATION    : 07.07.00
|
|*************************************************************************
|
|  DESCRIPTION :
|
|  Utility to convert a Linux Boot Image to S-record:
|  ==================================================
|
|  This command line utility can be used to convert a Linux boot image
|  (zimage.initrd) to S-Record format used for flash programming.
|  This conversion takes care of the special sections "IMAGE" and INITRD".
|
|  img2srec [-o offset] image > image.srec
|
|
|  Build the utility:
|  ==================
|
|  To build the utility use GCC as follows:
|
|  gcc img2srec.c -o img2srec
|
|
|*************************************************************************
|
|
|  UPDATES     :
|
|  DATE      NAME  CHANGES
|  -----------------------------------------------------------
|  Latest update
|
|  07.07.00  aba   Initial release
|
|*************************************************************************/

/*************************************************************************
|  INCLUDES
|*************************************************************************/

55
#include "os_support.h"
56
#include <stdbool.h>
wdenk's avatar
wdenk committed
57 58 59 60 61 62 63 64 65 66 67 68 69
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <ctype.h>
#include <string.h>
#include <elf.h>
#include <unistd.h>
#include <errno.h>

/*************************************************************************
|  FUNCTIONS
|*************************************************************************/

70
static char* ExtractHex (uint32_t* value,  char* getPtr)
wdenk's avatar
wdenk committed
71
{
72 73 74
  uint32_t num;
  uint32_t digit;
  uint8_t  c;
wdenk's avatar
wdenk committed
75 76 77 78 79

  while (*getPtr == ' ') getPtr++;
  num = 0;
  for (;;) {
    c = *getPtr;
80 81 82
    if      ((c >= '0') && (c <= '9')) digit = (uint32_t)(c - '0');
    else if ((c >= 'A') && (c <= 'F')) digit = (uint32_t)(c - 'A' + 10);
    else if ((c >= 'a') && (c <= 'f')) digit = (uint32_t)(c - 'a' + 10);
wdenk's avatar
wdenk committed
83 84 85 86 87 88 89 90 91
    else break;
    num <<= 4;
    num += digit;
    getPtr++;
  } /* for */
  *value = num;
  return getPtr;
} /* ExtractHex */

92
static char* ExtractDecimal (uint32_t* value,  char* getPtr)
wdenk's avatar
wdenk committed
93
{
94 95 96
  uint32_t num;
  uint32_t digit;
  uint8_t  c;
wdenk's avatar
wdenk committed
97 98 99 100 101

  while (*getPtr == ' ') getPtr++;
  num = 0;
  for (;;) {
    c = *getPtr;
102
    if      ((c >= '0') && (c <= '9')) digit = (uint32_t)(c - '0');
wdenk's avatar
wdenk committed
103 104 105 106 107 108 109 110 111 112
    else break;
    num *= 10;
    num += digit;
    getPtr++;
  } /* for */
  *value = num;
  return getPtr;
} /* ExtractDecimal */


113
static void ExtractNumber (uint32_t* value,  char* getPtr)
wdenk's avatar
wdenk committed
114
{
115
  bool  neg = false;;
wdenk's avatar
wdenk committed
116 117 118

  while (*getPtr == ' ') getPtr++;
  if (*getPtr == '-') {
119
    neg = true;
wdenk's avatar
wdenk committed
120 121 122 123 124 125 126 127 128 129 130 131 132
    getPtr++;
  } /* if */
  if ((*getPtr == '0') && ((*(getPtr+1) == 'x') || (*(getPtr+1) == 'X'))) {
    getPtr +=2;
    (void)ExtractHex(value, getPtr);
  } /* if */
  else {
    (void)ExtractDecimal(value, getPtr);
  } /* else */
  if (neg) *value = -(*value);
} /* ExtractNumber */


133
static uint8_t* ExtractWord(uint16_t* value, uint8_t* buffer)
wdenk's avatar
wdenk committed
134
{
135 136 137
  uint16_t x;
  x = (uint16_t)*buffer++;
  x = (x<<8) + (uint16_t)*buffer++;
wdenk's avatar
wdenk committed
138 139 140 141 142
  *value = x;
  return buffer;
} /* ExtractWord */


143
static uint8_t* ExtractLong(uint32_t* value, uint8_t* buffer)
wdenk's avatar
wdenk committed
144
{
145 146 147 148 149
  uint32_t x;
  x = (uint32_t)*buffer++;
  x = (x<<8) + (uint32_t)*buffer++;
  x = (x<<8) + (uint32_t)*buffer++;
  x = (x<<8) + (uint32_t)*buffer++;
wdenk's avatar
wdenk committed
150 151 152 153 154
  *value = x;
  return buffer;
} /* ExtractLong */


155
static uint8_t* ExtractBlock(uint16_t count, uint8_t* data, uint8_t* buffer)
wdenk's avatar
wdenk committed
156 157 158 159 160 161
{
  while (count--) *data++ = *buffer++;
  return buffer;
} /* ExtractBlock */


162
static char* WriteHex(char* pa, uint8_t value, uint16_t* pCheckSum)
wdenk's avatar
wdenk committed
163
{
164
  uint16_t  temp;
wdenk's avatar
wdenk committed
165 166 167 168 169 170 171 172 173 174 175 176

  static  char ByteToHex[] = "0123456789ABCDEF";

  *pCheckSum += value;
  temp  = value / 16;
  *pa++ = ByteToHex[temp];
  temp  = value % 16;
  *pa++ = ByteToHex[temp];
  return pa;
}


177 178
static char* BuildSRecord(char* pa, uint16_t sType, uint32_t addr,
			  const uint8_t* data, int nCount)
wdenk's avatar
wdenk committed
179
{
180 181 182 183
  uint16_t  addrLen;
  uint16_t  sRLen;
  uint16_t  checkSum;
  uint16_t  i;
wdenk's avatar
wdenk committed
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206

  switch (sType) {
  case 0:
  case 1:
  case 9:
    addrLen = 2;
    break;
  case 2:
  case 8:
    addrLen = 3;
    break;
  case 3:
  case 7:
    addrLen = 4;
    break;
  default:
    return pa;
  } /* switch */

  *pa++ = 'S';
  *pa++ = (char)(sType + '0');
  sRLen = addrLen + nCount + 1;
  checkSum = 0;
207
  pa = WriteHex(pa, (uint8_t)sRLen, &checkSum);
wdenk's avatar
wdenk committed
208 209 210

  /* Write address field */
  for (i = 1; i <= addrLen; i++) {
211
    pa = WriteHex(pa, (uint8_t)(addr >> (8 * (addrLen - i))), &checkSum);
wdenk's avatar
wdenk committed
212 213 214 215 216 217 218 219 220
  } /* for */

  /* Write code/data fields */
  for (i = 0; i < nCount; i++) {
    pa = WriteHex(pa, *data++, &checkSum);
  } /* for */

  /* Write checksum field */
  checkSum = ~checkSum;
221
  pa = WriteHex(pa, (uint8_t)checkSum, &checkSum);
wdenk's avatar
wdenk committed
222 223 224 225 226
  *pa++ = '\0';
  return pa;
}


227
static void ConvertELF(char* fileName, uint32_t loadOffset)
wdenk's avatar
wdenk committed
228 229 230 231
{
  FILE*         file;
  int           i;
  int           rxCount;
232 233 234 235 236
  uint8_t          rxBlock[1024];
  uint32_t         loadSize;
  uint32_t         firstAddr;
  uint32_t         loadAddr;
  uint32_t         loadDiff = 0;
wdenk's avatar
wdenk committed
237 238
  Elf32_Ehdr    elfHeader;
  Elf32_Shdr    sectHeader[32];
239
  uint8_t*         getPtr;
wdenk's avatar
wdenk committed
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
  char          srecLine[128];
  char		*hdr_name;


  /* open file */
  if ((file = fopen(fileName,"rb")) == NULL) {
    fprintf (stderr, "Can't open %s: %s\n", fileName, strerror(errno));
    return;
  } /* if */

  /* read ELF header */
  rxCount = fread(rxBlock, 1, sizeof elfHeader, file);
  getPtr = ExtractBlock(sizeof elfHeader.e_ident, elfHeader.e_ident, rxBlock);
  getPtr = ExtractWord(&elfHeader.e_type, getPtr);
  getPtr = ExtractWord(&elfHeader.e_machine, getPtr);
255 256 257 258 259
  getPtr = ExtractLong((uint32_t *)&elfHeader.e_version, getPtr);
  getPtr = ExtractLong((uint32_t *)&elfHeader.e_entry, getPtr);
  getPtr = ExtractLong((uint32_t *)&elfHeader.e_phoff, getPtr);
  getPtr = ExtractLong((uint32_t *)&elfHeader.e_shoff, getPtr);
  getPtr = ExtractLong((uint32_t *)&elfHeader.e_flags, getPtr);
wdenk's avatar
wdenk committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
  getPtr = ExtractWord(&elfHeader.e_ehsize, getPtr);
  getPtr = ExtractWord(&elfHeader.e_phentsize, getPtr);
  getPtr = ExtractWord(&elfHeader.e_phnum, getPtr);
  getPtr = ExtractWord(&elfHeader.e_shentsize, getPtr);
  getPtr = ExtractWord(&elfHeader.e_shnum, getPtr);
  getPtr = ExtractWord(&elfHeader.e_shstrndx, getPtr);
  if (    (rxCount              != sizeof elfHeader)
       || (elfHeader.e_ident[0] != ELFMAG0)
       || (elfHeader.e_ident[1] != ELFMAG1)
       || (elfHeader.e_ident[2] != ELFMAG2)
       || (elfHeader.e_ident[3] != ELFMAG3)
       || (elfHeader.e_type     != ET_EXEC)
     ) {
    fclose(file);
    fprintf (stderr, "*** illegal file format\n");
    return;
  } /* if */

  /* read all section headers */
  fseek(file, elfHeader.e_shoff, SEEK_SET);
  for (i = 0; i < elfHeader.e_shnum; i++) {
    rxCount = fread(rxBlock, 1, sizeof sectHeader[0], file);
282 283 284 285 286 287 288 289 290 291
    getPtr = ExtractLong((uint32_t *)&sectHeader[i].sh_name, rxBlock);
    getPtr = ExtractLong((uint32_t *)&sectHeader[i].sh_type, getPtr);
    getPtr = ExtractLong((uint32_t *)&sectHeader[i].sh_flags, getPtr);
    getPtr = ExtractLong((uint32_t *)&sectHeader[i].sh_addr, getPtr);
    getPtr = ExtractLong((uint32_t *)&sectHeader[i].sh_offset, getPtr);
    getPtr = ExtractLong((uint32_t *)&sectHeader[i].sh_size, getPtr);
    getPtr = ExtractLong((uint32_t *)&sectHeader[i].sh_link, getPtr);
    getPtr = ExtractLong((uint32_t *)&sectHeader[i].sh_info, getPtr);
    getPtr = ExtractLong((uint32_t *)&sectHeader[i].sh_addralign, getPtr);
    getPtr = ExtractLong((uint32_t *)&sectHeader[i].sh_entsize, getPtr);
wdenk's avatar
wdenk committed
292 293 294 295 296 297 298 299 300 301 302 303 304
    if (rxCount != sizeof sectHeader[0]) {
      fclose(file);
      fprintf (stderr, "*** illegal file format\n");
      return;
    } /* if */
  } /* for */

  if ((hdr_name = strrchr(fileName, '/')) == NULL) {
    hdr_name = fileName;
  } else {
    ++hdr_name;
  }
  /* write start record */
305
  (void)BuildSRecord(srecLine, 0, 0, (uint8_t *)hdr_name, strlen(hdr_name));
wdenk's avatar
wdenk committed
306 307 308 309 310 311 312
  printf("%s\r\n",srecLine);

  /* write data records */
  firstAddr = ~0;
  loadAddr  =  0;
  for (i = 0; i < elfHeader.e_shnum; i++) {
    if (    (sectHeader[i].sh_type == SHT_PROGBITS)
wdenk's avatar
wdenk committed
313 314
	 && (sectHeader[i].sh_size != 0)
	 ) {
wdenk's avatar
wdenk committed
315 316
      loadSize = sectHeader[i].sh_size;
      if (sectHeader[i].sh_flags != 0) {
wdenk's avatar
wdenk committed
317 318
	loadAddr = sectHeader[i].sh_addr;
	loadDiff = loadAddr - sectHeader[i].sh_offset;
wdenk's avatar
wdenk committed
319 320
      } /* if */
      else {
wdenk's avatar
wdenk committed
321
	loadAddr = sectHeader[i].sh_offset + loadDiff;
wdenk's avatar
wdenk committed
322 323 324
      } /* else */

      if (loadAddr < firstAddr)
wdenk's avatar
wdenk committed
325
	firstAddr = loadAddr;
wdenk's avatar
wdenk committed
326 327 328 329 330

      /* build s-records */
      loadSize = sectHeader[i].sh_size;
      fseek(file, sectHeader[i].sh_offset, SEEK_SET);
      while (loadSize) {
wdenk's avatar
wdenk committed
331 332 333 334 335 336 337 338 339 340
	rxCount = fread(rxBlock, 1, (loadSize > 32) ? 32 : loadSize, file);
	if (rxCount < 0) {
	  fclose(file);
	  fprintf (stderr, "*** illegal file format\n");
	return;
	} /* if */
	(void)BuildSRecord(srecLine, 3, loadAddr + loadOffset, rxBlock, rxCount);
	loadSize -= rxCount;
	loadAddr += rxCount;
	printf("%s\r\n",srecLine);
wdenk's avatar
wdenk committed
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
      } /* while */
    } /* if */
  } /* for */

  /* add end record */
  (void)BuildSRecord(srecLine, 7, firstAddr + loadOffset, 0, 0);
  printf("%s\r\n",srecLine);
  fclose(file);
} /* ConvertELF */


/*************************************************************************
|  MAIN
|*************************************************************************/

int main( int argc, char *argv[ ])
{
358
  uint32_t offset;
wdenk's avatar
wdenk committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372

  if (argc == 2) {
    ConvertELF(argv[1], 0);
  } /* if */
  else if ((argc == 4) && (strcmp(argv[1], "-o") == 0)) {
    ExtractNumber(&offset, argv[2]);
    ConvertELF(argv[3], offset);
  } /* if */
  else {
    fprintf (stderr, "Usage: img2srec [-o offset] <image>\n");
  } /* if */

  return 0;
} /* main */