diff options
| -rw-r--r-- | mkubootenv/.gitignore | 4 | ||||
| -rw-r--r-- | mkubootenv/Makefile | 35 | ||||
| -rw-r--r-- | mkubootenv/README | 45 | ||||
| -rw-r--r-- | mkubootenv/crc32.c | 71 | ||||
| -rw-r--r-- | mkubootenv/crc32.h | 8 | ||||
| -rw-r--r-- | mkubootenv/example/uboot_env.bin | bin | 0 -> 247 bytes | |||
| -rw-r--r-- | mkubootenv/example/uboot_env.env | 10 | ||||
| -rw-r--r-- | mkubootenv/mkubootenv.c | 330 |
8 files changed, 503 insertions, 0 deletions
diff --git a/mkubootenv/.gitignore b/mkubootenv/.gitignore new file mode 100644 index 0000000..c3f689a --- /dev/null +++ b/mkubootenv/.gitignore @@ -0,0 +1,4 @@ +mkubootenv +*.o +*.bin +*.env diff --git a/mkubootenv/Makefile b/mkubootenv/Makefile new file mode 100644 index 0000000..a0cbf46 --- /dev/null +++ b/mkubootenv/Makefile @@ -0,0 +1,35 @@ +prefix = $(HOME) + +P = mkubootenv +OBJS = mkubootenv.o crc32.o +WHERE = $(prefix)/bin/$(P) + +CFLAGS += -W -Wall -Wextra -Wstrict-prototypes -Wsign-compare -Wshadow \ + -Wchar-subscripts -Wmissing-declarations -Wmissing-prototypes \ + -Wpointer-arith -Wcast-align + +all: $(P) + +$(P): $(OBJS) + @echo " LD $@" + @$(CC) $(LDFLAGS) -o $@ $^ + +%.o: %.c %.h + @echo " CC $@" + @$(CC) $(CFLAGS) -c $< -o $@ + +%.o: %.c + @echo " CC $@" + @$(CC) $(CFLAGS) -c $< -o $@ + +install: + @echo " INSTALL $(WHERE)" + @install -m755 -D $(P) $(WHERE) + +uninstall: + @echo " UNINSTALL $(WHERE)" + @rm -f $(WHERE) + +clean: + @echo " CLEAN" + @rm -f $(OBJS) $(P) diff --git a/mkubootenv/README b/mkubootenv/README new file mode 100644 index 0000000..e63eba3 --- /dev/null +++ b/mkubootenv/README @@ -0,0 +1,45 @@ +mkubootenv +========== + +Create an U-Boot environmet image suitable for flashing. The input is a text +file containing environment variable definitions in the format “name=value”, +separeated by newlines. + +Usage +----- + +usage: mkubootenv [-s <size>] <source file> <target file> + +Options: + -s <size> set size of the target image file to <size> bytes. If <size> is + bigger than the source file, the target image gets padded with + null bytes. If <size> is smaller than the source file, an error is + emitted. + -r reverse operation: get plaintext env file (target) from binary + image file (source) + +File formats +------------ + +The U-Boot environment is stored in a simple file format, described in +include/environment.h of the U-Boot source tree as follows: + +/************************************************************************** + * + * The "environment" is stored as a list of '\0' terminated + * "name=value" strings. The end of the list is marked by a double + * '\0'. New entries are always added at the end. Deleting an entry + * shifts the remaining entries to the front. Replacing an entry is a + * combination of deleting the old value and adding the new one. + * + * The environment is preceeded by a 32 bit CRC over the data part. + * + ************************************************************************** + */ + +The input file format for mkubootenv is a simple text file containing +'name=value' pairs, separated by newlines ('\n'). This means, there are _no +newlines allowed_ inside the variable names or values. + +See the example/ directory for an example input file (uboot_env.env) and its +corresponding output file (uboot_env.bin). diff --git a/mkubootenv/crc32.c b/mkubootenv/crc32.c new file mode 100644 index 0000000..6e0c87d --- /dev/null +++ b/mkubootenv/crc32.c @@ -0,0 +1,71 @@ +#include <stdlib.h> +#include <stdint.h> + +#include "crc32.h" + +/* Table computed with Mark Adler's makecrc.c utility. */ +static const uint32_t crc32_table[256] = { + 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, + 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, + 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, + 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de, + 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856, + 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9, + 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, + 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, + 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, + 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a, + 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599, + 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924, + 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, + 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, + 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e, + 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01, + 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed, + 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950, + 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, + 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, + 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, + 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5, + 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010, + 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f, + 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, + 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, + 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615, + 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8, + 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344, + 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb, + 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, + 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, + 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, + 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c, + 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef, + 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236, + 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, + 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, + 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c, + 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713, + 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b, + 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242, + 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, + 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, + 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278, + 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7, + 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66, + 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9, + 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, + 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, + 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, + 0x2d02ef8d +}; + +uint32_t crc32(uint32_t crc, const uint8_t *buf, size_t len) +{ + const uint8_t *end; + + crc = ~crc; + for (end = buf + len; buf < end; buf++) + crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8); + + return ~crc; +} diff --git a/mkubootenv/crc32.h b/mkubootenv/crc32.h new file mode 100644 index 0000000..6ea89b0 --- /dev/null +++ b/mkubootenv/crc32.h @@ -0,0 +1,8 @@ +#ifndef _CRC32_H_ +#define _CRC32_H_ + +#include <stdint.h> + +extern uint32_t crc32(uint32_t crc, const uint8_t *buf, size_t len); + +#endif /* _CRC32_H_ */ diff --git a/mkubootenv/example/uboot_env.bin b/mkubootenv/example/uboot_env.bin Binary files differnew file mode 100644 index 0000000..9c4138c --- /dev/null +++ b/mkubootenv/example/uboot_env.bin diff --git a/mkubootenv/example/uboot_env.env b/mkubootenv/example/uboot_env.env new file mode 100644 index 0000000..35330e8 --- /dev/null +++ b/mkubootenv/example/uboot_env.env @@ -0,0 +1,10 @@ +baudrate=115200 +kernel_addr=4050000 +bootcmd=run flash_ram +ramargs=setenv bootargs root=/dev/ram rw panic=1 +bootdelay=3 +flash_ram=run set_mac;run ramargs;bootm ${kernel_addr} +stdin=serial +stdout=serial +stderr=serial +ethaddr=00:15:12:00:20:01 diff --git a/mkubootenv/mkubootenv.c b/mkubootenv/mkubootenv.c new file mode 100644 index 0000000..8e49cbb --- /dev/null +++ b/mkubootenv/mkubootenv.c @@ -0,0 +1,330 @@ +/* + * mkubootenv.c + * + * Create a U-Boot environment image suitable for flashing. + * + * The input is a text file containing environment variable + * definitions in the format "name=value", separeated by newlines. + * + * The "environment" (output) is stored as a list of '\0' terminated + * "name=value" strings. The end of the list is marked by a double '\0'. + * + * The environment is preceeded by a 32 bit CRC over the data part. + * + * Copyright (c) 2009, Zurich University of Applied Sciences + * Copyright (c) 2009, Tobias Klauser <klto@zhaw.ch> + * + * 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., 51 Franklin St, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include <stdlib.h> +#include <stdio.h> +#include <stdint.h> +#include <stdbool.h> +#include <string.h> +#include <unistd.h> +#include <errno.h> + +#include <fcntl.h> +#include <sys/types.h> +#include <sys/stat.h> +#include <sys/mman.h> + +#include "crc32.h" + +#undef DEBUG + +#define CMD_NAME "mkubootenv" + +#define CRC32_SIZE sizeof(uint32_t) +/* minimum trailing null bytes */ +#define TRAILER_SIZE 2 + +#define err(fmt, args...) fprintf(stderr, "%s: Error: " fmt, CMD_NAME, ##args) +#define warn(fmt, args...) fprintf(stderr, "%s: Warning: " fmt, CMD_NAME, ##args) +#ifdef DEBUG +# define dbg(fmt, args...) fprintf(stdout, fmt, ##args) +#else +# define dbg(fmt, args...) +#endif + +/* file "object" */ +struct file { + const char *name; + int fd; + uint8_t *ptr; + size_t size; +}; + +static void usage_and_exit(int status) __attribute__((noreturn)); + +static inline void uboot_env_init_file(struct file *f) +{ + memset(f, 0, sizeof(struct file)); + f->ptr = MAP_FAILED; +} + +static int uboot_env_prepare_source(struct file *s) +{ + struct stat sbuf; + + s->fd = open(s->name, O_RDONLY); + if (s->fd < 0) { + err("Can't open source file '%s': %s\n", s->name, + strerror(errno)); + return EXIT_FAILURE; + } + + if (fstat(s->fd, &sbuf) < 0) { + err("Can't stat source file '%s': %s\n", s->name, + strerror(errno)); + close(s->fd); + return -1; + } + + s->ptr = mmap(NULL, sbuf.st_size, PROT_READ, MAP_SHARED, s->fd, 0); + if (s->ptr == MAP_FAILED) { + err("Can't mmap source image file '%s': %s\n", s->name, + strerror(errno)); + close(s->fd); + return -1; + } + + s->size = sbuf.st_size; + + return 0; +} + +static int uboot_env_prepare_target(struct file *t) +{ + t->fd = open(t->name, O_RDWR|O_CREAT|O_TRUNC, 0666); + if (t->fd < 0) { + err("Can't open target image file '%s': %s\n", t->name, + strerror(errno)); + return -1; + } + + /* + * seek to the end of the target file to write a byte, so we have the + * whole target image size mapped for writing + */ + if (lseek(t->fd, t->size - 1, SEEK_SET) < 0) { + err("Can't seek in target image file '%s': %s\n", t->name, + strerror(errno)); + close(t->fd); + return -1; + } + + if (write(t->fd, "", 1) < 0) { + err("Can't write to target image file '%s': %s\n", t->name, + strerror(errno)); + close(t->fd); + return -1; + } + + t->ptr = mmap(NULL, t->size, PROT_READ|PROT_WRITE, MAP_SHARED, t->fd, 0); + if (t->ptr == MAP_FAILED) { + err("Can't mmap target image file '%s': %s\n", t->name, + strerror(errno)); + close(t->fd); + return -1; + } + + return 0; +} + +static void uboot_env_cleanup_file(struct file *f) +{ + if (f->ptr != MAP_FAILED) + munmap(f->ptr, f->size); + if (f->fd > 0) + close(f->fd); +} + +static void uboot_env_to_img(struct file *s, struct file *t) +{ + uint8_t *p, *q, *end; + uint32_t *crc; + + dbg("source file (env): %s\n", s->name); + dbg("target image file (bin): %s\n", t->name); + dbg("target size: %zd\n", t->size); + + /* CRC32 placeholder, will be filled later */ + end = t->ptr + CRC32_SIZE; + for (p = t->ptr; p < end; p++) + *p = 0; + + /* copy the source file, replacing \n by \0 */ + end = s->ptr + s->size; + for (q = s->ptr; q < end; q++, p++) + *p = (*q == '\n') ? '\0' : *q; + + /* trailer */ + end = s->ptr + t->size; + for (q = s->ptr + s->size; q < end; q++) + *p = 0; + + /* now for the real CRC32 */ + crc = (uint32_t *) t->ptr; + *crc = crc32(0, t->ptr + CRC32_SIZE, t->size - CRC32_SIZE); +} + +static void uboot_img_to_env(struct file *s, struct file *t) +{ + uint8_t *p, *q, *end; + uint32_t *crc; + + dbg("source file (bin): %s\n", s->name); + dbg("target image file (env): %s\n", t->name); + dbg("target size: %zd\n", t->size); + + /* check CRC */ + crc = (uint32_t *) s->ptr; + if (*crc != crc32(0, s->ptr + CRC32_SIZE, s->size - CRC32_SIZE)) + warn("source image with bad CRC\n"); + + p = t->ptr; + end = s->ptr + CRC32_SIZE + t->size; + for (q = s->ptr + CRC32_SIZE; q < end; p++, q++) + *p = (*q == '\0') ? '\n' : *q; +} + +static void usage_and_exit(int status) +{ + printf("usage: mkubootenv [-s <size>] <source file> <target file>\n" + " -s <size> set size of the target image file to <size> bytes. If <size> is\n" + " bigger than the source file, the target image gets padded with null\n" + " bytes. If <size> is smaller than the source file, an error is emitted.\n" + " -r reverse operation: get plaintext env file (target) from binary image\n" + " file (source)\n"); + exit(status); +} + +int main(int argc, char **argv) +{ + int i; + int status = EXIT_FAILURE; + ssize_t img_size = -1; + bool reverse = false; + struct file s, t; /* source and target file */ + + if (argc < 2) + usage_and_exit(EXIT_FAILURE); + + /* parse commandline options */ + for (i = 1; (i + 1 < argc) && (argv[i][0] == '-'); i++) { + switch (argv[i][1]) { + case 's': { + char *opt = argv[++i]; + + if (strlen(opt) > 2 && opt[0] == '0' && + (opt[1] == 'x' || opt[1] == 'X')) { + img_size = strtol(opt, NULL, 16); + } else { + img_size = strtol(opt, NULL, 10); + + if (img_size <= 0) { + err("Invalid target image size: %zd. Must be greater than 0.\n", img_size); + exit(EXIT_FAILURE); + } + } + break; + } + case 'r': + reverse = true; + break; + case 'h': + status = EXIT_SUCCESS; + /* fall through */ + default: + usage_and_exit(status); + break; + } + } + + /* we expect two filenames */ + if (i + 2 > argc) + usage_and_exit(EXIT_FAILURE); + + if (reverse && img_size >= 0) + warn("Image size specified in reverse mode will be ignored\n"); + + uboot_env_init_file(&s); + uboot_env_init_file(&t); + s.name = argv[i]; + t.name = argv[i+1]; + + if (uboot_env_prepare_source(&s)) + exit(EXIT_FAILURE); + + if (!reverse) { + ssize_t min_img_size = CRC32_SIZE + s.size + TRAILER_SIZE; + + /* TODO: Check source file format: + * var=value\n + */ + + /* + * check whether the size hasn't been set or whether the source file + + * CRC + trailer fits into the specified size. + */ + if (img_size < 0) + img_size = min_img_size; + else if (img_size < min_img_size) { + err("Specified size (%zd) is too small for the source file to " + "fit into. Must be at least %zd bytes.\n", + img_size, min_img_size); + goto cleanup_source; + } + + t.size = img_size; + if (uboot_env_prepare_target(&t)) + goto cleanup_source; + + uboot_env_to_img(&s, &t); + } else { + uint8_t *p; + uint8_t *end; + bool found_data_end = false; + + /* get the length of the data part */ + end = s.ptr + CRC32_SIZE + s.size; + for (p = s.ptr + CRC32_SIZE; (p < end - 1) && (!found_data_end); p++) { + /* two null bytes mark the end of the data section */ + if (*p == '\0' && *(p + 1) == '\0') + found_data_end = true; + } + + if (!found_data_end) + warn("No end of list delimiter found in source file\n"); + + /* calculate the plain text file size */ + t.size = p - (s.ptr + CRC32_SIZE); + if (uboot_env_prepare_target(&t)) + goto cleanup_source; + + uboot_img_to_env(&s, &t); + } + + status = EXIT_SUCCESS; + + uboot_env_cleanup_file(&t); +cleanup_source: + uboot_env_cleanup_file(&s); + + exit(status); +} |