xref: /OK3568_Linux_fs/u-boot/tools/lpc32xximage.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Image manipulator for LPC32XX SoCs
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * (C) Copyright 2015  DENX Software Engineering GmbH
5*4882a593Smuzhiyun  * Written-by: Albert ARIBAUD <albert.aribaud@3adev.fr>
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Derived from omapimage.c:
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * (C) Copyright 2010
10*4882a593Smuzhiyun  * Linaro LTD, www.linaro.org
11*4882a593Smuzhiyun  * Author: John Rigby <john.rigby@linaro.org>
12*4882a593Smuzhiyun  * Based on TI's signGP.c
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  * (C) Copyright 2009
15*4882a593Smuzhiyun  * Stefano Babic, DENX Software Engineering, sbabic@denx.de.
16*4882a593Smuzhiyun  *
17*4882a593Smuzhiyun  * (C) Copyright 2008
18*4882a593Smuzhiyun  * Marvell Semiconductor <www.marvell.com>
19*4882a593Smuzhiyun  * Written-by: Prafulla Wadaskar <prafulla@marvell.com>
20*4882a593Smuzhiyun  *
21*4882a593Smuzhiyun  * SPDX-License-Identifier:	GPL-2.0+
22*4882a593Smuzhiyun  */
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #include "imagetool.h"
25*4882a593Smuzhiyun #include <compiler.h>
26*4882a593Smuzhiyun #include <image.h>
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun /*
29*4882a593Smuzhiyun  * NAND page 0 boot header
30*4882a593Smuzhiyun  */
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun struct nand_page_0_boot_header {
33*4882a593Smuzhiyun 	uint32_t data[129];
34*4882a593Smuzhiyun 	uint32_t pad[383];
35*4882a593Smuzhiyun };
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun /*
38*4882a593Smuzhiyun  * Default ICC (interface configuration data [sic]) if none specified
39*4882a593Smuzhiyun  * in board config
40*4882a593Smuzhiyun  */
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun #ifndef LPC32XX_BOOT_ICR
43*4882a593Smuzhiyun #define LPC32XX_BOOT_ICR 0x00000096
44*4882a593Smuzhiyun #endif
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun /*
47*4882a593Smuzhiyun  * Default boot NAND page size if none specified in board config
48*4882a593Smuzhiyun  */
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun #ifndef LPC32XX_BOOT_NAND_PAGESIZE
51*4882a593Smuzhiyun #define LPC32XX_BOOT_NAND_PAGESIZE 2048
52*4882a593Smuzhiyun #endif
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun /*
55*4882a593Smuzhiyun  * Default boot NAND pages per sector if none specified in board config
56*4882a593Smuzhiyun  */
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun #ifndef LPC32XX_BOOT_NAND_PAGES_PER_SECTOR
59*4882a593Smuzhiyun #define LPC32XX_BOOT_NAND_PAGES_PER_SECTOR 64
60*4882a593Smuzhiyun #endif
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun /*
63*4882a593Smuzhiyun  * Maximum size for boot code is 56K unless defined in board config
64*4882a593Smuzhiyun  */
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun #ifndef LPC32XX_BOOT_CODESIZE
67*4882a593Smuzhiyun #define LPC32XX_BOOT_CODESIZE (56*1024)
68*4882a593Smuzhiyun #endif
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun /* signature byte for a readable block */
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun #define LPC32XX_BOOT_BLOCK_OK 0xaa
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun static struct nand_page_0_boot_header lpc32xximage_header;
75*4882a593Smuzhiyun 
lpc32xximage_check_image_types(uint8_t type)76*4882a593Smuzhiyun static int lpc32xximage_check_image_types(uint8_t type)
77*4882a593Smuzhiyun {
78*4882a593Smuzhiyun 	if (type == IH_TYPE_LPC32XXIMAGE)
79*4882a593Smuzhiyun 		return EXIT_SUCCESS;
80*4882a593Smuzhiyun 	return EXIT_FAILURE;
81*4882a593Smuzhiyun }
82*4882a593Smuzhiyun 
lpc32xximage_verify_header(unsigned char * ptr,int image_size,struct image_tool_params * params)83*4882a593Smuzhiyun static int lpc32xximage_verify_header(unsigned char *ptr, int image_size,
84*4882a593Smuzhiyun 			struct image_tool_params *params)
85*4882a593Smuzhiyun {
86*4882a593Smuzhiyun 	struct nand_page_0_boot_header *hdr =
87*4882a593Smuzhiyun 		(struct nand_page_0_boot_header *)ptr;
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun 	/* turn image size from bytes to NAND pages, page 0 included */
90*4882a593Smuzhiyun 	int image_size_in_pages = ((image_size - 1)
91*4882a593Smuzhiyun 				  / LPC32XX_BOOT_NAND_PAGESIZE);
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun 	if (hdr->data[0] != (0xff & LPC32XX_BOOT_ICR))
94*4882a593Smuzhiyun 		return -1;
95*4882a593Smuzhiyun 	if (hdr->data[1] != (0xff & ~LPC32XX_BOOT_ICR))
96*4882a593Smuzhiyun 		return -1;
97*4882a593Smuzhiyun 	if (hdr->data[2] != (0xff & LPC32XX_BOOT_ICR))
98*4882a593Smuzhiyun 		return -1;
99*4882a593Smuzhiyun 	if (hdr->data[3] != (0xff & ~LPC32XX_BOOT_ICR))
100*4882a593Smuzhiyun 		return -1;
101*4882a593Smuzhiyun 	if (hdr->data[4] != (0xff & image_size_in_pages))
102*4882a593Smuzhiyun 		return -1;
103*4882a593Smuzhiyun 	if (hdr->data[5] != (0xff & ~image_size_in_pages))
104*4882a593Smuzhiyun 		return -1;
105*4882a593Smuzhiyun 	if (hdr->data[6] != (0xff & image_size_in_pages))
106*4882a593Smuzhiyun 		return -1;
107*4882a593Smuzhiyun 	if (hdr->data[7] != (0xff & ~image_size_in_pages))
108*4882a593Smuzhiyun 		return -1;
109*4882a593Smuzhiyun 	if (hdr->data[8] != (0xff & image_size_in_pages))
110*4882a593Smuzhiyun 		return -1;
111*4882a593Smuzhiyun 	if (hdr->data[9] != (0xff & ~image_size_in_pages))
112*4882a593Smuzhiyun 		return -1;
113*4882a593Smuzhiyun 	if (hdr->data[10] != (0xff & image_size_in_pages))
114*4882a593Smuzhiyun 		return -1;
115*4882a593Smuzhiyun 	if (hdr->data[11] != (0xff & ~image_size_in_pages))
116*4882a593Smuzhiyun 		return -1;
117*4882a593Smuzhiyun 	if (hdr->data[12] != LPC32XX_BOOT_BLOCK_OK)
118*4882a593Smuzhiyun 		return -1;
119*4882a593Smuzhiyun 	if (hdr->data[128] != LPC32XX_BOOT_BLOCK_OK)
120*4882a593Smuzhiyun 		return -1;
121*4882a593Smuzhiyun 	return 0;
122*4882a593Smuzhiyun }
123*4882a593Smuzhiyun 
print_hdr_byte(struct nand_page_0_boot_header * hdr,int ofs)124*4882a593Smuzhiyun static void print_hdr_byte(struct nand_page_0_boot_header *hdr, int ofs)
125*4882a593Smuzhiyun {
126*4882a593Smuzhiyun 	printf("header[%d] = %02x\n", ofs, hdr->data[ofs]);
127*4882a593Smuzhiyun }
128*4882a593Smuzhiyun 
lpc32xximage_print_header(const void * ptr)129*4882a593Smuzhiyun static void lpc32xximage_print_header(const void *ptr)
130*4882a593Smuzhiyun {
131*4882a593Smuzhiyun 	struct nand_page_0_boot_header *hdr =
132*4882a593Smuzhiyun 		(struct nand_page_0_boot_header *)ptr;
133*4882a593Smuzhiyun 	int ofs;
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun 	for (ofs = 0; ofs <= 12; ofs++)
136*4882a593Smuzhiyun 		print_hdr_byte(hdr, ofs);
137*4882a593Smuzhiyun 	print_hdr_byte(hdr, 128);
138*4882a593Smuzhiyun }
139*4882a593Smuzhiyun 
lpc32xximage_set_header(void * ptr,struct stat * sbuf,int ifd,struct image_tool_params * params)140*4882a593Smuzhiyun static void lpc32xximage_set_header(void *ptr, struct stat *sbuf, int ifd,
141*4882a593Smuzhiyun 				struct image_tool_params *params)
142*4882a593Smuzhiyun {
143*4882a593Smuzhiyun 	struct nand_page_0_boot_header *hdr =
144*4882a593Smuzhiyun 		(struct nand_page_0_boot_header *)ptr;
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun 	/* turn image size from bytes to NAND pages, page 0 included */
147*4882a593Smuzhiyun 	int image_size_in_pages = ((sbuf->st_size
148*4882a593Smuzhiyun 				  + LPC32XX_BOOT_NAND_PAGESIZE - 1)
149*4882a593Smuzhiyun 				  / LPC32XX_BOOT_NAND_PAGESIZE);
150*4882a593Smuzhiyun 
151*4882a593Smuzhiyun 	/* fill header -- default byte value is 0x00, not 0xFF */
152*4882a593Smuzhiyun 	memset((void *)hdr, 0, sizeof(*hdr));
153*4882a593Smuzhiyun 	hdr->data[0] = (hdr->data[2] = 0xff & LPC32XX_BOOT_ICR);
154*4882a593Smuzhiyun 	hdr->data[1] = (hdr->data[3] = 0xff & ~LPC32XX_BOOT_ICR);
155*4882a593Smuzhiyun 	hdr->data[4] = (hdr->data[6] = (hdr->data[8]
156*4882a593Smuzhiyun 		       = (hdr->data[10] = 0xff & image_size_in_pages)));
157*4882a593Smuzhiyun 	hdr->data[5] = (hdr->data[7] = (hdr->data[9]
158*4882a593Smuzhiyun 		       = (hdr->data[11] = 0xff & ~image_size_in_pages)));
159*4882a593Smuzhiyun 	hdr->data[12] = (hdr->data[128] = LPC32XX_BOOT_BLOCK_OK);
160*4882a593Smuzhiyun }
161*4882a593Smuzhiyun 
162*4882a593Smuzhiyun /*
163*4882a593Smuzhiyun  * lpc32xximage parameters
164*4882a593Smuzhiyun  */
165*4882a593Smuzhiyun U_BOOT_IMAGE_TYPE(
166*4882a593Smuzhiyun 	lpc32xximage,
167*4882a593Smuzhiyun 	"LPC32XX Boot Image",
168*4882a593Smuzhiyun 	sizeof(lpc32xximage_header),
169*4882a593Smuzhiyun 	(void *)&lpc32xximage_header,
170*4882a593Smuzhiyun 	NULL,
171*4882a593Smuzhiyun 	lpc32xximage_verify_header,
172*4882a593Smuzhiyun 	lpc32xximage_print_header,
173*4882a593Smuzhiyun 	lpc32xximage_set_header,
174*4882a593Smuzhiyun 	NULL,
175*4882a593Smuzhiyun 	lpc32xximage_check_image_types,
176*4882a593Smuzhiyun 	NULL,
177*4882a593Smuzhiyun 	NULL
178*4882a593Smuzhiyun );
179