2 * Freescale i.MX28 image generator
4 * Copyright (C) 2011 Marek Vasut <marek.vasut@gmail.com>
5 * on behalf of DENX Software Engineering GmbH
7 * See file CREDITS for list of people who contributed to this
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of
13 * the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
28 #include <sys/types.h>
36 * TWEAK this if you have blown any OCOTP fuses.
38 #define STRIDE_PAGES 64
39 #define STRIDE_COUNT 4
42 * Layout for 256Mb big NAND with 2048b page size, 64b OOB size and
45 * TWEAK this if you have different kind of NAND chip.
47 uint32_t nand_writesize = 2048;
48 uint32_t nand_oobsize = 64;
49 uint32_t nand_erasesize = 128 * 1024;
52 * Sector on which the SigmaTel boot partition (0x53) starts.
54 uint32_t sd_sector = 2048;
57 * Each of the U-Boot bootstreams is at maximum 1MB big.
59 * TWEAK this if, for some wild reason, you need to boot bigger image.
61 #define MAX_BOOTSTREAM_SIZE (1 * 1024 * 1024)
63 /* i.MX28 NAND controller-specific constants. DO NOT TWEAK! */
64 #define MXS_NAND_DMA_DESCRIPTOR_COUNT 4
65 #define MXS_NAND_CHUNK_DATA_CHUNK_SIZE 512
66 #define MXS_NAND_METADATA_SIZE 10
67 #define MXS_NAND_COMMAND_BUFFER_SIZE 32
69 struct mx28_nand_fcb {
76 uint8_t address_setup;
78 uint8_t nand_timing_state;
83 uint32_t page_data_size;
84 uint32_t total_page_size;
85 uint32_t sectors_per_block;
86 uint32_t number_of_nands; /* Ignored */
87 uint32_t total_internal_die; /* Ignored */
88 uint32_t cell_type; /* Ignored */
89 uint32_t ecc_block_n_ecc_type;
90 uint32_t ecc_block_0_size;
91 uint32_t ecc_block_n_size;
92 uint32_t ecc_block_0_ecc_type;
93 uint32_t metadata_bytes;
94 uint32_t num_ecc_blocks_per_page;
95 uint32_t ecc_block_n_ecc_level_sdk; /* Ignored */
96 uint32_t ecc_block_0_size_sdk; /* Ignored */
97 uint32_t ecc_block_n_size_sdk; /* Ignored */
98 uint32_t ecc_block_0_ecc_level_sdk; /* Ignored */
99 uint32_t num_ecc_blocks_per_page_sdk; /* Ignored */
100 uint32_t metadata_bytes_sdk; /* Ignored */
101 uint32_t erase_threshold;
103 uint32_t patch_sectors;
104 uint32_t firmware1_starting_sector;
105 uint32_t firmware2_starting_sector;
106 uint32_t sectors_in_firmware1;
107 uint32_t sectors_in_firmware2;
108 uint32_t dbbt_search_area_start_address;
109 uint32_t badblock_marker_byte;
110 uint32_t badblock_marker_start_bit;
111 uint32_t bb_marker_physical_offset;
114 struct mx28_nand_dbbt {
116 uint32_t fingerprint;
119 uint32_t number_2k_pages_bb;
122 struct mx28_nand_bbt {
125 uint32_t badblock[510];
128 struct mx28_sd_drive_info {
132 uint32_t first_sector_number;
133 uint32_t sector_count;
136 struct mx28_sd_config_block {
138 uint32_t primary_boot_tag;
139 uint32_t secondary_boot_tag;
141 struct mx28_sd_drive_info drv_info[1];
144 static inline uint32_t mx28_nand_ecc_size_in_bits(uint32_t ecc_strength)
146 return ecc_strength * 13;
149 static inline uint32_t mx28_nand_get_ecc_strength(uint32_t page_data_size,
150 uint32_t page_oob_size)
152 if (page_data_size == 2048)
155 if (page_data_size == 4096) {
156 if (page_oob_size == 128)
159 if (page_oob_size == 218)
166 static inline uint32_t mx28_nand_get_mark_offset(uint32_t page_data_size,
167 uint32_t ecc_strength)
169 uint32_t chunk_data_size_in_bits;
170 uint32_t chunk_ecc_size_in_bits;
171 uint32_t chunk_total_size_in_bits;
172 uint32_t block_mark_chunk_number;
173 uint32_t block_mark_chunk_bit_offset;
174 uint32_t block_mark_bit_offset;
176 chunk_data_size_in_bits = MXS_NAND_CHUNK_DATA_CHUNK_SIZE * 8;
177 chunk_ecc_size_in_bits = mx28_nand_ecc_size_in_bits(ecc_strength);
179 chunk_total_size_in_bits =
180 chunk_data_size_in_bits + chunk_ecc_size_in_bits;
182 /* Compute the bit offset of the block mark within the physical page. */
183 block_mark_bit_offset = page_data_size * 8;
185 /* Subtract the metadata bits. */
186 block_mark_bit_offset -= MXS_NAND_METADATA_SIZE * 8;
189 * Compute the chunk number (starting at zero) in which the block mark
192 block_mark_chunk_number =
193 block_mark_bit_offset / chunk_total_size_in_bits;
196 * Compute the bit offset of the block mark within its chunk, and
199 block_mark_chunk_bit_offset = block_mark_bit_offset -
200 (block_mark_chunk_number * chunk_total_size_in_bits);
202 if (block_mark_chunk_bit_offset > chunk_data_size_in_bits)
206 * Now that we know the chunk number in which the block mark appears,
207 * we can subtract all the ECC bits that appear before it.
209 block_mark_bit_offset -=
210 block_mark_chunk_number * chunk_ecc_size_in_bits;
212 return block_mark_bit_offset;
215 static inline uint32_t mx28_nand_mark_byte_offset(void)
217 uint32_t ecc_strength;
218 ecc_strength = mx28_nand_get_ecc_strength(nand_writesize, nand_oobsize);
219 return mx28_nand_get_mark_offset(nand_writesize, ecc_strength) >> 3;
222 static inline uint32_t mx28_nand_mark_bit_offset(void)
224 uint32_t ecc_strength;
225 ecc_strength = mx28_nand_get_ecc_strength(nand_writesize, nand_oobsize);
226 return mx28_nand_get_mark_offset(nand_writesize, ecc_strength) & 0x7;
229 static uint32_t mx28_nand_block_csum(uint8_t *block, uint32_t size)
234 for (i = 0; i < size; i++)
237 return csum ^ 0xffffffff;
240 static struct mx28_nand_fcb *mx28_nand_get_fcb(uint32_t size)
242 struct mx28_nand_fcb *fcb;
243 uint32_t bcb_size_bytes;
244 uint32_t stride_size_bytes;
245 uint32_t bootstream_size_pages;
246 uint32_t fw1_start_page;
247 uint32_t fw2_start_page;
249 fcb = malloc(nand_writesize);
251 printf("MX28 NAND: Unable to allocate FCB\n");
255 memset(fcb, 0, nand_writesize);
257 fcb->fingerprint = 0x20424346;
258 fcb->version = 0x01000000;
261 * FIXME: These here are default values as found in kobs-ng. We should
262 * probably retrieve the data from NAND or something.
264 fcb->timing.data_setup = 80;
265 fcb->timing.data_hold = 60;
266 fcb->timing.address_setup = 25;
267 fcb->timing.dsample_time = 6;
269 fcb->page_data_size = nand_writesize;
270 fcb->total_page_size = nand_writesize + nand_oobsize;
271 fcb->sectors_per_block = nand_erasesize / nand_writesize;
273 fcb->num_ecc_blocks_per_page = (nand_writesize / 512) - 1;
274 fcb->ecc_block_0_size = 512;
275 fcb->ecc_block_n_size = 512;
276 fcb->metadata_bytes = 10;
278 if (nand_writesize == 2048) {
279 fcb->ecc_block_n_ecc_type = 4;
280 fcb->ecc_block_0_ecc_type = 4;
281 } else if (nand_writesize == 4096) {
282 if (nand_oobsize == 128) {
283 fcb->ecc_block_n_ecc_type = 4;
284 fcb->ecc_block_0_ecc_type = 4;
285 } else if (nand_oobsize == 218) {
286 fcb->ecc_block_n_ecc_type = 8;
287 fcb->ecc_block_0_ecc_type = 8;
291 if (fcb->ecc_block_n_ecc_type == 0) {
292 printf("MX28 NAND: Unsupported NAND geometry\n");
297 fcb->patch_sectors = 0;
299 fcb->badblock_marker_byte = mx28_nand_mark_byte_offset();
300 fcb->badblock_marker_start_bit = mx28_nand_mark_bit_offset();
301 fcb->bb_marker_physical_offset = nand_writesize;
303 stride_size_bytes = STRIDE_PAGES * nand_writesize;
304 bcb_size_bytes = stride_size_bytes * STRIDE_COUNT;
306 bootstream_size_pages = (size + (nand_writesize - 1)) /
309 fw1_start_page = 2 * bcb_size_bytes / nand_writesize;
310 fw2_start_page = (2 * bcb_size_bytes + MAX_BOOTSTREAM_SIZE) /
313 fcb->firmware1_starting_sector = fw1_start_page;
314 fcb->firmware2_starting_sector = fw2_start_page;
315 fcb->sectors_in_firmware1 = bootstream_size_pages;
316 fcb->sectors_in_firmware2 = bootstream_size_pages;
318 fcb->dbbt_search_area_start_address = STRIDE_PAGES * STRIDE_COUNT;
327 static struct mx28_nand_dbbt *mx28_nand_get_dbbt(void)
329 struct mx28_nand_dbbt *dbbt;
331 dbbt = malloc(nand_writesize);
333 printf("MX28 NAND: Unable to allocate DBBT\n");
337 memset(dbbt, 0, nand_writesize);
339 dbbt->fingerprint = 0x54424244;
345 static inline uint8_t mx28_nand_parity_13_8(const uint8_t b)
347 uint32_t parity = 0, tmp;
349 tmp = ((b >> 6) ^ (b >> 5) ^ (b >> 3) ^ (b >> 2)) & 1;
352 tmp = ((b >> 7) ^ (b >> 5) ^ (b >> 4) ^ (b >> 2) ^ (b >> 1)) & 1;
355 tmp = ((b >> 7) ^ (b >> 6) ^ (b >> 5) ^ (b >> 1) ^ (b >> 0)) & 1;
358 tmp = ((b >> 7) ^ (b >> 4) ^ (b >> 3) ^ (b >> 0)) & 1;
361 tmp = ((b >> 6) ^ (b >> 4) ^ (b >> 3) ^
362 (b >> 2) ^ (b >> 1) ^ (b >> 0)) & 1;
368 static uint8_t *mx28_nand_fcb_block(struct mx28_nand_fcb *fcb)
374 block = malloc(nand_writesize + nand_oobsize);
376 printf("MX28 NAND: Unable to allocate FCB block\n");
380 memset(block, 0, nand_writesize + nand_oobsize);
382 /* Update the FCB checksum */
383 fcb->checksum = mx28_nand_block_csum(((uint8_t *)fcb) + 4, 508);
385 /* Figure 12-11. in iMX28RM, rev. 1, says FCB is at offset 12 */
386 memcpy(block + 12, fcb, sizeof(struct mx28_nand_fcb));
388 /* ECC is at offset 12 + 512 */
389 ecc = block + 12 + 512;
391 /* Compute the ECC parity */
392 for (i = 0; i < sizeof(struct mx28_nand_fcb); i++)
393 ecc[i] = mx28_nand_parity_13_8(block[i + 12]);
398 static int mx28_nand_write_fcb(struct mx28_nand_fcb *fcb, char *buf)
405 fcbblock = mx28_nand_fcb_block(fcb);
409 for (i = 0; i < STRIDE_PAGES * STRIDE_COUNT; i += STRIDE_PAGES) {
410 offset = i * nand_writesize;
411 memcpy(buf + offset, fcbblock, nand_writesize + nand_oobsize);
418 static int mx28_nand_write_dbbt(struct mx28_nand_dbbt *dbbt, char *buf)
421 int i = STRIDE_PAGES * STRIDE_COUNT;
423 for (; i < 2 * STRIDE_PAGES * STRIDE_COUNT; i += STRIDE_PAGES) {
424 offset = i * nand_writesize;
425 memcpy(buf + offset, dbbt, sizeof(struct mx28_nand_dbbt));
431 static int mx28_nand_write_firmware(struct mx28_nand_fcb *fcb, int infd,
436 uint32_t offset1, offset2;
438 size = lseek(infd, 0, SEEK_END);
439 lseek(infd, 0, SEEK_SET);
441 offset1 = fcb->firmware1_starting_sector * nand_writesize;
442 offset2 = fcb->firmware2_starting_sector * nand_writesize;
444 ret = read(infd, buf + offset1, size);
448 memcpy(buf + offset2, buf + offset1, size);
456 "Usage: mx28image [ops] <type> <infile> <outfile>\n"
457 "Augment BootStream file with a proper header for i.MX28 boot\n"
459 " <type> type of image:\n"
460 " \"nand\" for NAND image\n"
461 " \"sd\" for SD image\n"
462 " <infile> input file, the u-boot.sb bootstream\n"
463 " <outfile> output file, the bootable image\n"
466 "For NAND boot, these options are accepted:\n"
467 " -w <size> NAND page size\n"
468 " -o <size> NAND OOB size\n"
469 " -e <size> NAND erase size\n"
471 "For SD boot, these options are accepted:\n"
472 " -p <sector> Sector where the SGTL partition starts\n"
476 static int mx28_create_nand_image(int infd, int outfd)
478 struct mx28_nand_fcb *fcb;
479 struct mx28_nand_dbbt *dbbt;
485 size = nand_writesize * 512 + 2 * MAX_BOOTSTREAM_SIZE;
489 printf("Can not allocate output buffer of %d bytes\n", size);
493 memset(buf, 0, size);
495 fcb = mx28_nand_get_fcb(MAX_BOOTSTREAM_SIZE);
497 printf("Unable to compile FCB\n");
501 dbbt = mx28_nand_get_dbbt();
503 printf("Unable to compile DBBT\n");
507 ret = mx28_nand_write_fcb(fcb, buf);
509 printf("Unable to write FCB to buffer\n");
513 ret = mx28_nand_write_dbbt(dbbt, buf);
515 printf("Unable to write DBBT to buffer\n");
519 ret = mx28_nand_write_firmware(fcb, infd, buf);
521 printf("Unable to write firmware to buffer\n");
525 wr_size = write(outfd, buf, size);
526 if (wr_size != size) {
543 static int mx28_create_sd_image(int infd, int outfd)
550 struct mx28_sd_config_block *cb;
552 fsize = lseek(infd, 0, SEEK_END);
553 lseek(infd, 0, SEEK_SET);
558 printf("Can not allocate output buffer of %d bytes\n", size);
562 ret = read(infd, (uint8_t *)buf + 512, fsize);
568 cb = (struct mx28_sd_config_block *)buf;
570 cb->signature = 0x00112233;
571 cb->primary_boot_tag = 0x1;
572 cb->secondary_boot_tag = 0x1;
574 cb->drv_info[0].chip_num = 0x0;
575 cb->drv_info[0].drive_type = 0x0;
576 cb->drv_info[0].tag = 0x1;
577 cb->drv_info[0].first_sector_number = sd_sector + 1;
578 cb->drv_info[0].sector_count = (size - 1) / 512;
580 wr_size = write(outfd, buf, size);
581 if (wr_size != size) {
594 int parse_ops(int argc, char **argv)
609 for (i = 1; i < argc; i++) {
610 if (!strncmp(argv[i], "-w", 2))
612 else if (!strncmp(argv[i], "-o", 2))
614 else if (!strncmp(argv[i], "-e", 2))
616 else if (!strncmp(argv[i], "-p", 2))
621 tmp = strtol(argv[++i], &end, 10);
627 if (type == PARAM_WRITE)
628 nand_writesize = tmp;
629 if (type == PARAM_OOB)
631 if (type == PARAM_ERASE)
632 nand_erasesize = tmp;
633 if (type == PARAM_PART)
637 if (strcmp(argv[i], "sd") && strcmp(argv[i], "nand"))
646 int main(int argc, char **argv)
652 offset = parse_ops(argc, argv);
659 infd = open(argv[offset + 1], O_RDONLY);
661 printf("Input BootStream file can not be opened\n");
666 outfd = open(argv[offset + 2], O_CREAT | O_TRUNC | O_WRONLY,
669 printf("Output file can not be created\n");
674 if (!strcmp(argv[offset], "sd"))
675 ret = mx28_create_sd_image(infd, outfd);
676 else if (!strcmp(argv[offset], "nand"))
677 ret = mx28_create_nand_image(infd, outfd);