2 * Freescale i.MX28 image generator
5 * on behalf of DENX Software Engineering GmbH
7 * SPDX-License-Identifier: GPL-2.0+
13 #include <sys/types.h>
18 /* Taken from <linux/kernel.h> */
19 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
20 #define round_down(x, y) ((x) & ~__round_mask(x, y))
25 * TWEAK this if you have blown any OCOTP fuses.
27 #define STRIDE_PAGES 64
28 #define STRIDE_COUNT 4
31 * Layout for 256Mb big NAND with 2048b page size, 64b OOB size and
34 * TWEAK this if you have different kind of NAND chip.
36 static uint32_t nand_writesize = 2048;
37 static uint32_t nand_oobsize = 64;
38 static uint32_t nand_erasesize = 128 * 1024;
41 * Sector on which the SigmaTel boot partition (0x53) starts.
43 static uint32_t sd_sector = 2048;
46 * Each of the U-Boot bootstreams is at maximum 1MB big.
48 * TWEAK this if, for some wild reason, you need to boot bigger image.
50 #define MAX_BOOTSTREAM_SIZE (1 * 1024 * 1024)
52 /* i.MX28 NAND controller-specific constants. DO NOT TWEAK! */
53 #define MXS_NAND_DMA_DESCRIPTOR_COUNT 4
54 #define MXS_NAND_CHUNK_DATA_CHUNK_SIZE 512
55 #define MXS_NAND_METADATA_SIZE 10
56 #define MXS_NAND_BITS_PER_ECC_LEVEL 13
57 #define MXS_NAND_COMMAND_BUFFER_SIZE 32
59 struct mx28_nand_fcb {
66 uint8_t address_setup;
68 uint8_t nand_timing_state;
73 uint32_t page_data_size;
74 uint32_t total_page_size;
75 uint32_t sectors_per_block;
76 uint32_t number_of_nands; /* Ignored */
77 uint32_t total_internal_die; /* Ignored */
78 uint32_t cell_type; /* Ignored */
79 uint32_t ecc_block_n_ecc_type;
80 uint32_t ecc_block_0_size;
81 uint32_t ecc_block_n_size;
82 uint32_t ecc_block_0_ecc_type;
83 uint32_t metadata_bytes;
84 uint32_t num_ecc_blocks_per_page;
85 uint32_t ecc_block_n_ecc_level_sdk; /* Ignored */
86 uint32_t ecc_block_0_size_sdk; /* Ignored */
87 uint32_t ecc_block_n_size_sdk; /* Ignored */
88 uint32_t ecc_block_0_ecc_level_sdk; /* Ignored */
89 uint32_t num_ecc_blocks_per_page_sdk; /* Ignored */
90 uint32_t metadata_bytes_sdk; /* Ignored */
91 uint32_t erase_threshold;
93 uint32_t patch_sectors;
94 uint32_t firmware1_starting_sector;
95 uint32_t firmware2_starting_sector;
96 uint32_t sectors_in_firmware1;
97 uint32_t sectors_in_firmware2;
98 uint32_t dbbt_search_area_start_address;
99 uint32_t badblock_marker_byte;
100 uint32_t badblock_marker_start_bit;
101 uint32_t bb_marker_physical_offset;
104 struct mx28_nand_dbbt {
106 uint32_t fingerprint;
109 uint32_t number_2k_pages_bb;
112 struct mx28_nand_bbt {
115 uint32_t badblock[510];
118 struct mx28_sd_drive_info {
122 uint32_t first_sector_number;
123 uint32_t sector_count;
126 struct mx28_sd_config_block {
128 uint32_t primary_boot_tag;
129 uint32_t secondary_boot_tag;
131 struct mx28_sd_drive_info drv_info[1];
134 static inline uint32_t mx28_nand_ecc_chunk_cnt(uint32_t page_data_size)
136 return page_data_size / MXS_NAND_CHUNK_DATA_CHUNK_SIZE;
139 static inline uint32_t mx28_nand_ecc_size_in_bits(uint32_t ecc_strength)
141 return ecc_strength * MXS_NAND_BITS_PER_ECC_LEVEL;
144 static inline uint32_t mx28_nand_get_ecc_strength(uint32_t page_data_size,
145 uint32_t page_oob_size)
150 * Determine the ECC layout with the formula:
151 * ECC bits per chunk = (total page spare data bits) /
152 * (bits per ECC level) / (chunks per page)
154 * total page spare data bits =
155 * (page oob size - meta data size) * (bits per byte)
157 ecc_strength = ((page_oob_size - MXS_NAND_METADATA_SIZE) * 8)
158 / (MXS_NAND_BITS_PER_ECC_LEVEL *
159 mx28_nand_ecc_chunk_cnt(page_data_size));
161 return round_down(ecc_strength, 2);
164 static inline uint32_t mx28_nand_get_mark_offset(uint32_t page_data_size,
165 uint32_t ecc_strength)
167 uint32_t chunk_data_size_in_bits;
168 uint32_t chunk_ecc_size_in_bits;
169 uint32_t chunk_total_size_in_bits;
170 uint32_t block_mark_chunk_number;
171 uint32_t block_mark_chunk_bit_offset;
172 uint32_t block_mark_bit_offset;
174 chunk_data_size_in_bits = MXS_NAND_CHUNK_DATA_CHUNK_SIZE * 8;
175 chunk_ecc_size_in_bits = mx28_nand_ecc_size_in_bits(ecc_strength);
177 chunk_total_size_in_bits =
178 chunk_data_size_in_bits + chunk_ecc_size_in_bits;
180 /* Compute the bit offset of the block mark within the physical page. */
181 block_mark_bit_offset = page_data_size * 8;
183 /* Subtract the metadata bits. */
184 block_mark_bit_offset -= MXS_NAND_METADATA_SIZE * 8;
187 * Compute the chunk number (starting at zero) in which the block mark
190 block_mark_chunk_number =
191 block_mark_bit_offset / chunk_total_size_in_bits;
194 * Compute the bit offset of the block mark within its chunk, and
197 block_mark_chunk_bit_offset = block_mark_bit_offset -
198 (block_mark_chunk_number * chunk_total_size_in_bits);
200 if (block_mark_chunk_bit_offset > chunk_data_size_in_bits)
204 * Now that we know the chunk number in which the block mark appears,
205 * we can subtract all the ECC bits that appear before it.
207 block_mark_bit_offset -=
208 block_mark_chunk_number * chunk_ecc_size_in_bits;
210 return block_mark_bit_offset;
213 static inline uint32_t mx28_nand_mark_byte_offset(void)
215 uint32_t ecc_strength;
216 ecc_strength = mx28_nand_get_ecc_strength(nand_writesize, nand_oobsize);
217 return mx28_nand_get_mark_offset(nand_writesize, ecc_strength) >> 3;
220 static inline uint32_t mx28_nand_mark_bit_offset(void)
222 uint32_t ecc_strength;
223 ecc_strength = mx28_nand_get_ecc_strength(nand_writesize, nand_oobsize);
224 return mx28_nand_get_mark_offset(nand_writesize, ecc_strength) & 0x7;
227 static uint32_t mx28_nand_block_csum(uint8_t *block, uint32_t size)
232 for (i = 0; i < size; i++)
235 return csum ^ 0xffffffff;
238 static struct mx28_nand_fcb *mx28_nand_get_fcb(uint32_t size)
240 struct mx28_nand_fcb *fcb;
241 uint32_t bcb_size_bytes;
242 uint32_t stride_size_bytes;
243 uint32_t bootstream_size_pages;
244 uint32_t fw1_start_page;
245 uint32_t fw2_start_page;
247 fcb = malloc(nand_writesize);
249 printf("MX28 NAND: Unable to allocate FCB\n");
253 memset(fcb, 0, nand_writesize);
255 fcb->fingerprint = 0x20424346;
256 fcb->version = 0x01000000;
259 * FIXME: These here are default values as found in kobs-ng. We should
260 * probably retrieve the data from NAND or something.
262 fcb->timing.data_setup = 80;
263 fcb->timing.data_hold = 60;
264 fcb->timing.address_setup = 25;
265 fcb->timing.dsample_time = 6;
267 fcb->page_data_size = nand_writesize;
268 fcb->total_page_size = nand_writesize + nand_oobsize;
269 fcb->sectors_per_block = nand_erasesize / nand_writesize;
271 fcb->num_ecc_blocks_per_page = (nand_writesize / 512) - 1;
272 fcb->ecc_block_0_size = 512;
273 fcb->ecc_block_n_size = 512;
274 fcb->metadata_bytes = 10;
275 fcb->ecc_block_n_ecc_type = mx28_nand_get_ecc_strength(
276 nand_writesize, nand_oobsize) >> 1;
277 fcb->ecc_block_0_ecc_type = mx28_nand_get_ecc_strength(
278 nand_writesize, nand_oobsize) >> 1;
279 if (fcb->ecc_block_n_ecc_type == 0) {
280 printf("MX28 NAND: Unsupported NAND geometry\n");
285 fcb->patch_sectors = 0;
287 fcb->badblock_marker_byte = mx28_nand_mark_byte_offset();
288 fcb->badblock_marker_start_bit = mx28_nand_mark_bit_offset();
289 fcb->bb_marker_physical_offset = nand_writesize;
291 stride_size_bytes = STRIDE_PAGES * nand_writesize;
292 bcb_size_bytes = stride_size_bytes * STRIDE_COUNT;
294 bootstream_size_pages = (size + (nand_writesize - 1)) /
297 fw1_start_page = 2 * bcb_size_bytes / nand_writesize;
298 fw2_start_page = (2 * bcb_size_bytes + MAX_BOOTSTREAM_SIZE) /
301 fcb->firmware1_starting_sector = fw1_start_page;
302 fcb->firmware2_starting_sector = fw2_start_page;
303 fcb->sectors_in_firmware1 = bootstream_size_pages;
304 fcb->sectors_in_firmware2 = bootstream_size_pages;
306 fcb->dbbt_search_area_start_address = STRIDE_PAGES * STRIDE_COUNT;
315 static struct mx28_nand_dbbt *mx28_nand_get_dbbt(void)
317 struct mx28_nand_dbbt *dbbt;
319 dbbt = malloc(nand_writesize);
321 printf("MX28 NAND: Unable to allocate DBBT\n");
325 memset(dbbt, 0, nand_writesize);
327 dbbt->fingerprint = 0x54424244;
333 static inline uint8_t mx28_nand_parity_13_8(const uint8_t b)
335 uint32_t parity = 0, tmp;
337 tmp = ((b >> 6) ^ (b >> 5) ^ (b >> 3) ^ (b >> 2)) & 1;
340 tmp = ((b >> 7) ^ (b >> 5) ^ (b >> 4) ^ (b >> 2) ^ (b >> 1)) & 1;
343 tmp = ((b >> 7) ^ (b >> 6) ^ (b >> 5) ^ (b >> 1) ^ (b >> 0)) & 1;
346 tmp = ((b >> 7) ^ (b >> 4) ^ (b >> 3) ^ (b >> 0)) & 1;
349 tmp = ((b >> 6) ^ (b >> 4) ^ (b >> 3) ^
350 (b >> 2) ^ (b >> 1) ^ (b >> 0)) & 1;
356 static uint8_t *mx28_nand_fcb_block(struct mx28_nand_fcb *fcb)
362 block = malloc(nand_writesize + nand_oobsize);
364 printf("MX28 NAND: Unable to allocate FCB block\n");
368 memset(block, 0, nand_writesize + nand_oobsize);
370 /* Update the FCB checksum */
371 fcb->checksum = mx28_nand_block_csum(((uint8_t *)fcb) + 4, 508);
373 /* Figure 12-11. in iMX28RM, rev. 1, says FCB is at offset 12 */
374 memcpy(block + 12, fcb, sizeof(struct mx28_nand_fcb));
376 /* ECC is at offset 12 + 512 */
377 ecc = block + 12 + 512;
379 /* Compute the ECC parity */
380 for (i = 0; i < sizeof(struct mx28_nand_fcb); i++)
381 ecc[i] = mx28_nand_parity_13_8(block[i + 12]);
386 static int mx28_nand_write_fcb(struct mx28_nand_fcb *fcb, uint8_t *buf)
393 fcbblock = mx28_nand_fcb_block(fcb);
397 for (i = 0; i < STRIDE_PAGES * STRIDE_COUNT; i += STRIDE_PAGES) {
398 offset = i * nand_writesize;
399 memcpy(buf + offset, fcbblock, nand_writesize + nand_oobsize);
400 /* Mark the NAND page is OK. */
401 buf[offset + nand_writesize] = 0xff;
408 static int mx28_nand_write_dbbt(struct mx28_nand_dbbt *dbbt, uint8_t *buf)
411 int i = STRIDE_PAGES * STRIDE_COUNT;
413 for (; i < 2 * STRIDE_PAGES * STRIDE_COUNT; i += STRIDE_PAGES) {
414 offset = i * nand_writesize;
415 memcpy(buf + offset, dbbt, sizeof(struct mx28_nand_dbbt));
421 static int mx28_nand_write_firmware(struct mx28_nand_fcb *fcb, int infd,
426 uint32_t offset1, offset2;
428 size = lseek(infd, 0, SEEK_END);
429 lseek(infd, 0, SEEK_SET);
431 offset1 = fcb->firmware1_starting_sector * nand_writesize;
432 offset2 = fcb->firmware2_starting_sector * nand_writesize;
434 ret = read(infd, buf + offset1, size);
438 memcpy(buf + offset2, buf + offset1, size);
443 static void usage(void)
446 "Usage: mxsboot [ops] <type> <infile> <outfile>\n"
447 "Augment BootStream file with a proper header for i.MX28 boot\n"
449 " <type> type of image:\n"
450 " \"nand\" for NAND image\n"
451 " \"sd\" for SD image\n"
452 " <infile> input file, the u-boot.sb bootstream\n"
453 " <outfile> output file, the bootable image\n"
456 "For NAND boot, these options are accepted:\n"
457 " -w <size> NAND page size\n"
458 " -o <size> NAND OOB size\n"
459 " -e <size> NAND erase size\n"
461 "For SD boot, these options are accepted:\n"
462 " -p <sector> Sector where the SGTL partition starts\n"
466 static int mx28_create_nand_image(int infd, int outfd)
468 struct mx28_nand_fcb *fcb;
469 struct mx28_nand_dbbt *dbbt;
475 size = nand_writesize * 512 + 2 * MAX_BOOTSTREAM_SIZE;
479 printf("Can not allocate output buffer of %d bytes\n", size);
483 memset(buf, 0, size);
485 fcb = mx28_nand_get_fcb(MAX_BOOTSTREAM_SIZE);
487 printf("Unable to compile FCB\n");
491 dbbt = mx28_nand_get_dbbt();
493 printf("Unable to compile DBBT\n");
497 ret = mx28_nand_write_fcb(fcb, buf);
499 printf("Unable to write FCB to buffer\n");
503 ret = mx28_nand_write_dbbt(dbbt, buf);
505 printf("Unable to write DBBT to buffer\n");
509 ret = mx28_nand_write_firmware(fcb, infd, buf);
511 printf("Unable to write firmware to buffer\n");
515 wr_size = write(outfd, buf, size);
516 if (wr_size != size) {
533 static int mx28_create_sd_image(int infd, int outfd)
540 struct mx28_sd_config_block *cb;
542 fsize = lseek(infd, 0, SEEK_END);
543 lseek(infd, 0, SEEK_SET);
544 size = fsize + 4 * 512;
548 printf("Can not allocate output buffer of %d bytes\n", size);
552 ret = read(infd, (uint8_t *)buf + 4 * 512, fsize);
558 cb = (struct mx28_sd_config_block *)buf;
560 cb->signature = htole32(0x00112233);
561 cb->primary_boot_tag = htole32(0x1);
562 cb->secondary_boot_tag = htole32(0x1);
563 cb->num_copies = htole32(1);
564 cb->drv_info[0].chip_num = htole32(0x0);
565 cb->drv_info[0].drive_type = htole32(0x0);
566 cb->drv_info[0].tag = htole32(0x1);
567 cb->drv_info[0].first_sector_number = htole32(sd_sector + 4);
568 cb->drv_info[0].sector_count = htole32((size - 4) / 512);
570 wr_size = write(outfd, buf, size);
571 if (wr_size != size) {
584 static int parse_ops(int argc, char **argv)
602 for (i = 1; i < argc; i++) {
603 if (!strncmp(argv[i], "-w", 2))
605 else if (!strncmp(argv[i], "-o", 2))
607 else if (!strncmp(argv[i], "-e", 2))
609 else if (!strncmp(argv[i], "-p", 2))
614 tmp = strtol(argv[++i], &end, 10);
620 if (type == PARAM_WRITE)
621 nand_writesize = tmp;
622 if (type == PARAM_OOB)
624 if (type == PARAM_ERASE)
625 nand_erasesize = tmp;
626 if (type == PARAM_PART)
630 if (strcmp(argv[i], "sd") && strcmp(argv[i], "nand"))
639 int main(int argc, char **argv)
645 offset = parse_ops(argc, argv);
652 infd = open(argv[offset + 1], O_RDONLY);
654 printf("Input BootStream file can not be opened\n");
659 outfd = open(argv[offset + 2], O_CREAT | O_TRUNC | O_WRONLY,
662 printf("Output file can not be created\n");
667 if (!strcmp(argv[offset], "sd"))
668 ret = mx28_create_sd_image(infd, outfd);
669 else if (!strcmp(argv[offset], "nand"))
670 ret = mx28_create_nand_image(infd, outfd);