[U-Boot] [PATCH 2/3] tools: mkimage (type=kwbimage) kirkwood boot image support
Prafulla Wadaskar
prafulla at marvell.com
Sun Jul 19 03:45:57 CEST 2009
For more details refer docs/README.kwbimage
Signed-off-by: Prafulla Wadaskar <prafulla at marvell.com>
---
Makefile | 5 ++
common/image.c | 1 +
doc/README.kwbimage | 77 ++++++++++++++++++++++
include/image.h | 1 +
tools/Makefile | 1 +
tools/kwbimage.c | 181 +++++++++++++++++++++++++++++++++++++++++++++++++++
tools/kwbimage.h | 105 +++++++++++++++++++++++++++++
tools/mkimage.c | 23 ++++++-
8 files changed, 393 insertions(+), 1 deletions(-)
create mode 100644 doc/README.kwbimage
create mode 100644 tools/kwbimage.c
create mode 100644 tools/kwbimage.h
diff --git a/Makefile b/Makefile
index 55fc2a3..b9e45ed 100644
--- a/Makefile
+++ b/Makefile
@@ -339,6 +339,10 @@ $(obj)u-boot.img: $(obj)u-boot.bin
sed -e 's/"[ ]*$$/ for $(BOARD) board"/') \
-d $< $@
+$(obj)u-boot.kwb: $(obj)u-boot.bin
+ ./tools/mkimage -n ./board/$(BOARDDIR)/kwbimage.cfg \
+ -T kwbimage -a $(TEXT_BASE) -e $(TEXT_BASE) -d $< $@
+
$(obj)u-boot.sha1: $(obj)u-boot.bin
$(obj)tools/ubsha1 $(obj)u-boot.bin
@@ -3638,6 +3642,7 @@ clobber: clean
@rm -f $(OBJS) $(obj)*.bak $(obj)ctags $(obj)etags $(obj)TAGS \
$(obj)cscope.* $(obj)*.*~
@rm -f $(obj)u-boot $(obj)u-boot.map $(obj)u-boot.hex $(ALL)
+ @rm -f $(obj)u-boot.kwb
@rm -f $(obj)tools/{env/crc32.c,inca-swap-bytes}
@rm -f $(obj)cpu/mpc824x/bedbug_603e.c
@rm -f $(obj)include/asm/proc $(obj)include/asm/arch $(obj)include/asm
diff --git a/common/image.c b/common/image.c
index e22c974..845006f 100644
--- a/common/image.c
+++ b/common/image.c
@@ -145,6 +145,7 @@ static table_entry_t uimage_type[] = {
{ IH_TYPE_SCRIPT, "script", "Script", },
{ IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
{ IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
+ { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
{ -1, "", "", },
};
diff --git a/doc/README.kwbimage b/doc/README.kwbimage
new file mode 100644
index 0000000..b00a053
--- /dev/null
+++ b/doc/README.kwbimage
@@ -0,0 +1,77 @@
+---------------------------------------------
+Kirkwood Boot Image generation using mkimage
+---------------------------------------------
+
+This document describes the U-Boot feature as it
+is implemented for the Kirkwood family of SoCs.
+
+The Kirkwood SoC's can boot directly from NAND FLASH,
+SPI FLASH, SATA etc. using its internal bootRom support.
+
+for more details refer section 24.2 of Kirkwood functional specifications.
+ref: www.marvell.com/products/embedded.../kirkwood/index.jsp
+
+Commad syntax:
+./tools/mkimage -n <board specific configuration file> \
+ -T kwbimage -a <start address> -e <execution address> -d <input_raw_binary> <output_kwboot_file>
+
+for ex.
+./tools/mkimage -n ./board/Marvell/openrd_base/kwbimage.cfg \
+ -T kwbimage -a 0x00600000 -e 0x00600000 -d u-boot.bin u-boot.kwb
+
+kwimage support available with mkimage utility will generate kirkwood boot image that can be flashed on the board nand/spi flash
+
+Board specific configuration file specifications:-
+1. This file must present in the $(BOARDDIR) and the name should be kwbimage.cfg (since this is used in Makefile)
+2. This file can have empty lines and lines starting with "#" as first character to put comments
+3. This file can have configuration command lines as mentioned below, any other information in this file is treated as invalid.
+
+Configuration command line syntax:
+1. Each command line is must have two strings, first one command or address and second one data string
+2. Following are the valid command strings and data strings associated combinations
+ Command string data string
+ BOOT_FROM nand/spi/sata
+ NAND_ECC_MODE default/rs/hamming/disabled
+ NAND_PAGE_SIZE any u16 hex value
+ SATA_PIO_MODE any u32 hex value
+ DDR_INIT_DELAY any u32 hex value
+ <u32 register address> <u32 vlaue for it>, you can have maximum 55 such commands
+3. all commands are optional to program
+
+Typical example of kwimage.cfg file:-
+
+# Boot Media configurations
+BOOT_FROM nand
+NAND_ECC_MODE default
+NAND_PAGE_SIZE 0x0800
+
+# Configure RGMII-0 interface pad voltage to 1.8V
+0xFFD100e0 0x1b1b1b9b
+# DRAM Configuration
+0xFFD01400 0x43000c30
+0xFFD01404 0x37543000
+0xFFD01408 0x22125451
+0xFFD0140C 0x00000a33
+0xFFD01410 0x000000cc
+0xFFD01414 0x00000000
+0xFFD01418 0x00000000
+0xFFD0141C 0x00000C52
+0xFFD01420 0x00000040
+0xFFD01424 0x0000F17F
+0xFFD01428 0x00085520
+0xFFD0147C 0x00008552
+0xFFD01504 0x0FFFFFF1
+0xFFD01508 0x10000000
+0xFFD0150C 0x0FFFFFF5
+0xFFD01514 0x00000000
+0xFFD0151C 0x00000000
+0xFFD01494 0x00030000
+0xFFD01498 0x00000000
+0xFFD0149C 0x0000E803
+0xFFD01480 0x00000001
+# End of Header extension
+0x0 0x0
+
+Author: Prafulla Wadaskar <prafulla at marvell.com>
+------------------------------------------------------
+
diff --git a/include/image.h b/include/image.h
index f183757..ed94dda 100644
--- a/include/image.h
+++ b/include/image.h
@@ -158,6 +158,7 @@
#define IH_TYPE_SCRIPT 6 /* Script file */
#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
+#define IH_TYPE_KWBIMAGE 9 /* Boot Rom Image */
/*
* Compression Types
diff --git a/tools/Makefile b/tools/Makefile
index 43c284c..5ead74c 100644
--- a/tools/Makefile
+++ b/tools/Makefile
@@ -167,6 +167,7 @@ $(obj)img2srec$(SFX): $(obj)img2srec.o
$(STRIP) $@
$(obj)mkimage$(SFX): $(obj)mkimage.o $(obj)crc32.o $(obj)image.o $(obj)md5.o \
+ $(obj)kwbimage.o \
$(obj)sha1.o $(LIBFDT_OBJS) $(obj)os_support.o
$(CC) $(CFLAGS) $(HOST_LDFLAGS) -o $@ $^
$(STRIP) $@
diff --git a/tools/kwbimage.c b/tools/kwbimage.c
new file mode 100644
index 0000000..06f256e
--- /dev/null
+++ b/tools/kwbimage.c
@@ -0,0 +1,181 @@
+/*
+ * (C) Copyright 2008
+ * Marvell Semiconductor <www.marvell.com>
+ * Written-by: Prafulla Wadaskar <prafulla at marvell.com>
+ *
+ * See file CREDITS for list of people who contributed to this
+ * project.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ */
+
+#include <errno.h>
+#include <fcntl.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/mman.h>
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <unistd.h>
+#include "kwbimage.h"
+
+struct kwb_header kwbimage_header;
+/*
+ * Generates 8 bit checksum
+ */
+u8 kwbimage_checksum8(void *start, u32 len, u8 csum)
+{
+ register u8 sum = csum;
+ volatile u8 *startp = (volatile u8 *)start;
+
+ do {
+ sum += *startp;
+ startp++;
+ } while (--len);
+ return (sum);
+}
+
+/*
+ * Generates 32 bit checksum
+ */
+u32 kwbimage_checksum32(void *start, u32 len, u32 csum)
+{
+ register u32 sum = csum;
+ volatile u32 *startp = (volatile u32 *)start;
+
+ do {
+ sum += *startp;
+ startp++;
+ len -= sizeof(u32);
+ } while (len > 0);
+ return (sum);
+}
+
+void *kwbimage_get_header_ptr (void)
+{
+ return ((void *)&kwbimage_header);
+}
+
+int kwbimage_get_header_size (void)
+{
+ return (sizeof (struct kwb_header));
+}
+
+void kwdimage_set_ext_header(struct kwb_header *kwbhdr, char* fname) {
+ bhr_t *mhdr = &kwbhdr->kwb_hdr;
+ extbhr_t *exthdr = &kwbhdr->kwb_exthdr;
+ int fd = -1;
+ int lineno, i;
+ char *line = NULL;
+ char cmdstr[MAX_KWBCMD_LEN], datastr[MAX_KWBDATA_LEN];
+ size_t len = 0;
+
+ exthdr->dramregsoffs = (u32)&exthdr->rcfg - (u32)mhdr;
+
+ if ((fd = fopen(fname, "r")) == 0) {
+ fprintf (stderr, "Err: Can't open %s: %s\n",
+ fname, strerror(errno));
+ exit (EXIT_FAILURE);
+ }
+
+ i = lineno = 0;
+ while ((getline(&line, &len, fd)) != -1) {
+ /* skip empty lines and lines staring with # */
+ lineno++;
+ if (!(line[0] != '#' && strlen(line) != 1))
+ continue;
+
+ if (strlen(line) > (MAX_KWBCMD_LEN + MAX_KWBDATA_LEN)) {
+ printf("Err.. %s(line no %d) too long\n",
+ fname, lineno);
+ exit (EXIT_FAILURE);
+ }
+
+ sscanf(line, "%s %s\n", cmdstr, datastr);
+ if (strcmp(cmdstr, "BOOT_FROM") == 0) {
+ if (strcmp(datastr, "spi") == 0) {
+ mhdr->blockid = IBR_HDR_SPI_ID;
+ } else if (strcmp(datastr, "nand") == 0) {
+ mhdr->blockid = IBR_HDR_NAND_ID;
+ } else if (strcmp(datastr, "sata") == 0) {
+ mhdr->blockid = IBR_HDR_SATA_ID;
+ } else {
+ printf("Err.. Invalid kwimage data\n");
+ exit (EXIT_FAILURE);
+ }
+ printf("Preparing kirkwood boot image to boot from %s\n", datastr);
+ } else if (strcmp(cmdstr, "NAND_ECC_MODE") == 0) {
+ if (strcmp(datastr, "default") == 0) {
+ mhdr->nandeccmode = IBR_HDR_ECC_DEFAULT;
+ } else if (strcmp(datastr, "hamming") == 0) {
+ mhdr->nandeccmode = IBR_HDR_ECC_FORCED_HAMMING;
+ } else if (strcmp(datastr, "rs") == 0) {
+ mhdr->nandeccmode = IBR_HDR_ECC_FORCED_RS;
+ } else if (strcmp(datastr, "disabled") == 0) {
+ mhdr->nandeccmode = IBR_HDR_ECC_DISABLED;
+ } else {
+ printf("Err.. Invalid kwimage data\n");
+ exit (EXIT_FAILURE);
+ }
+ printf("Nand ECC mode = %s\n", datastr);
+ } else if (strcmp(cmdstr, "NAND_PAGE_SIZE") == 0) {
+ mhdr->nandpagesize = strtoul (datastr, line, 16);
+ printf("Nand page size = %x\n", mhdr->nandpagesize);
+ } else if (strcmp(cmdstr, "SATA_PIO_MODE") == 0) {
+ mhdr->satapiomode = strtoul (datastr, line, 16);
+ printf("Sata PIO mode = %x\n", mhdr->satapiomode);
+ } else if (strcmp(cmdstr, "DDR_INIT_DELAY") == 0) {
+ mhdr->ddrinitdelay = strtoul (datastr, line, 16);
+ printf("DDR init delay = %d msec\n",
+ mhdr->ddrinitdelay);
+ } else {
+ exthdr->rcfg[i].raddr = strtoul (cmdstr, line, 16);
+ exthdr->rcfg[i].rdata = strtoul (datastr, line, 16);
+ if (i > KWBIMAGE_MAX_CONFIG ) {
+ printf("Err.. found more than max "
+ "allowed(%d) configurations\n",
+ KWBIMAGE_MAX_CONFIG);
+ exit (EXIT_FAILURE);
+ } else
+ i++;
+ }
+ }
+ if (line)
+ free(line);
+
+ fclose(fd);
+}
+
+void kwbimage_set_header (struct kwb_header *hdr, struct stat *sbuf,
+ u32 dadr, u32 eadr, char *fname)
+{
+ bhr_t *mhdr = &hdr->kwb_hdr;
+ extbhr_t *exthdr = &hdr->kwb_exthdr;
+
+ mhdr->blocksize = sbuf->st_size - kwbimage_get_header_size();
+ mhdr->srcaddr = kwbimage_get_header_size();
+ mhdr->destaddr= dadr;
+ mhdr->execaddr =eadr;
+ mhdr->ext = 0x1; /* header extension appended */
+
+ kwdimage_set_ext_header(hdr, fname);
+ /* calculate checksums */
+ mhdr->checkSum = kwbimage_checksum8((void *)mhdr, sizeof(bhr_t), 0);
+ exthdr->checkSum = kwbimage_checksum8((void *)exthdr,
+ sizeof(extbhr_t),0);
+}
+
diff --git a/tools/kwbimage.h b/tools/kwbimage.h
new file mode 100644
index 0000000..c54b701
--- /dev/null
+++ b/tools/kwbimage.h
@@ -0,0 +1,105 @@
+/*
+ * (C) Copyright 2008
+ * Marvell Semiconductor <www.marvell.com>
+ * iWritten-by: Prafulla Wadaskar <prafulla at marvell.com>
+ *
+ * See file CREDITS for list of people who contributed to this
+ * project.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ */
+
+#ifndef _KWBIMAGE_H_
+#define _KWBIMAGE_H_
+
+#define KWBIMAGE_MAX_CONFIG ((0x1dc - 0x20)/sizeof(struct reg_config))
+#define MAX_KWBCMD_LEN 32
+#define MAX_KWBDATA_LEN 32
+
+/* NAND ECC Mode */
+#define IBR_HDR_ECC_DEFAULT 0x00
+#define IBR_HDR_ECC_FORCED_HAMMING 0x01
+#define IBR_HDR_ECC_FORCED_RS 0x02
+#define IBR_HDR_ECC_DISABLED 0x03
+
+/* Boot Type - block ID */
+#define IBR_HDR_I2C_ID 0x4D
+#define IBR_HDR_SPI_ID 0x5A
+#define IBR_HDR_NAND_ID 0x8B
+#define IBR_HDR_SATA_ID 0x78
+#define IBR_HDR_PEX_ID 0x9C
+#define IBR_HDR_UART_ID 0x69
+#define IBR_DEF_ATTRIB 0x00
+
+/* typedefs */
+typedef char s8;
+typedef unsigned char u8;
+
+typedef int s32;
+typedef unsigned int u32;
+
+typedef short s16;
+typedef unsigned short u16;
+
+typedef long s64;
+typedef unsigned long u64;
+
+typedef struct bhr_t {
+ u8 blockid; /*0 */
+ u8 nandeccmode; /*1 */
+ u16 nandpagesize; /*2-3 */
+ u32 blocksize; /*4-7 */
+ u32 rsvd1; /*8-11 */
+ u32 srcaddr; /*12-15 */
+ u32 destaddr; /*16-19 */
+ u32 execaddr; /*20-23 */
+ u8 satapiomode; /*24 */
+ u8 rsvd3; /*25 */
+ u16 ddrinitdelay; /*26-27 */
+ u16 rsvd2; /*28-29 */
+ u8 ext; /*30 */
+ u8 checkSum; /*31 */
+} bhr_t, *pbhr_t;
+
+struct reg_config {
+ u32 raddr;
+ u32 rdata;
+};
+
+typedef struct extbhr_t {
+ u32 dramregsoffs;
+ u8 rsrvd1[0x20 - sizeof(u32)];
+ struct reg_config rcfg[KWBIMAGE_MAX_CONFIG];
+ u8 rsrvd2[7];
+ u8 checkSum;
+} extbhr_t, *pextbhr_t;
+
+struct kwb_header {
+ bhr_t kwb_hdr;
+ extbhr_t kwb_exthdr;
+};
+
+/*
+ * functions
+ */
+u8 kwbimage_checksum8(void *start, u32 len, u8 csum);
+u32 kwbimage_checksum32(void *start, u32 len, u32 csum);
+void *kwbimage_get_header_ptr(void);
+int kwbimage_get_header_size (void);
+void kwbimage_set_header (struct kwb_header *hdr, struct stat *sbuf,
+ u32 dadr, u32 eadr, char *fname);
+
+#endif /* _KWBIMAGE_H_ */
diff --git a/tools/mkimage.c b/tools/mkimage.c
index c5b593c..9a11071 100644
--- a/tools/mkimage.c
+++ b/tools/mkimage.c
@@ -24,6 +24,7 @@
#include "mkimage.h"
#include <image.h>
+#include "kwbimage.h"
extern int errno;
@@ -251,7 +252,13 @@ NXTARG: ;
* write dummy header, to be fixed later
*/
int hdr_size;
- hdr_size = image_get_header_size ();
+
+ if (opt_type == IH_TYPE_KWBIMAGE) {
+ hdr = kwbimage_get_header_ptr();
+ hdr_size = kwbimage_get_header_size ();
+ } else
+ hdr_size = image_get_header_size ();
+
memset (hdr, 0, hdr_size);
if (write(ifd, hdr, hdr_size) != hdr_size) {
fprintf (stderr, "%s: Write error on %s: %s\n",
@@ -339,6 +346,19 @@ NXTARG: ;
hdr = (image_header_t *)ptr;
+ /* Build new header */
+ if (opt_type == IH_TYPE_KWBIMAGE) {
+ checksum = kwbimage_checksum32((void *)ptr, sbuf.st_size, 0);
+
+ if (write(ifd, &checksum, sizeof(uint32_t))
+ != sizeof(uint32_t)) {
+ fprintf (stderr, "%s: Checksum wr err on %s: %s\n",
+ cmdname, imagefile, strerror(errno));
+ exit (EXIT_FAILURE);
+ }
+ sbuf.st_size += sizeof(uint32_t);
+ kwbimage_set_header (hdr, &sbuf, addr, ep, name);
+ } else {
checksum = crc32 (0,
(const char *)(ptr + hdr_size),
sbuf.st_size - hdr_size);
@@ -361,6 +381,7 @@ NXTARG: ;
image_print_contents (hdr);
+ }
(void) munmap((void *)ptr, sbuf.st_size);
/* We're a bit of paranoid */
--
1.5.3.4
More information about the U-Boot
mailing list