xref: /aosp_15_r20/external/arm-trusted-firmware/tools/nxp/create_pbl/README (revision 54fd6939e177f8ff529b10183254802c76df6d08)
1*54fd6939SJiyong ParkDescription:
2*54fd6939SJiyong Park------------
3*54fd6939SJiyong ParkTool 'create_pbl' is a standalone tool to create the PBL images.
4*54fd6939SJiyong Park	 where,
5*54fd6939SJiyong Park	     On the basis of Chassis,
6*54fd6939SJiyong Park	     RCW image is placed first followed by the,
7*54fd6939SJiyong Park	     PBI commands to copy the,
8*54fd6939SJiyong Park	     Input BL2 image stored on the,
9*54fd6939SJiyong Park	     Specified boot source (QSPI or SD or NOR) to the,
10*54fd6939SJiyong Park             Specified destination address.
11*54fd6939SJiyong Park
12*54fd6939SJiyong Park
13*54fd6939SJiyong ParkUsage in standalone way:
14*54fd6939SJiyong Park-----------------------
15*54fd6939SJiyong Park
16*54fd6939SJiyong Park./create_pbl [options] (mentioned below):
17*54fd6939SJiyong Park
18*54fd6939SJiyong Park	-r  <RCW file-name>         - name of RCW binary file.
19*54fd6939SJiyong Park	-i  <BL2 Bin file-name>     - file to be added to rcw file.
20*54fd6939SJiyong Park	-c  <SoC Number>            - SoC numeric identifier, may be one of
21*54fd6939SJiyong Park                                  1012,1023,1026.1028,
22*54fd6939SJiyong Park                                  1043,1046,1088,2080,
23*54fd6939SJiyong Park                                  2088,2160
24*54fd6939SJiyong Park	-b  <boot source id>        - Boot source id string, may be one of
25*54fd6939SJiyong Park                                  "qspi", "nor", "nand", "sd", "emmc"
26*54fd6939SJiyong Park	-d  <Address>               - Destination address where BL2
27*54fd6939SJiyong Park	                              image is to be copied
28*54fd6939SJiyong Park	-o  <output filename>	    - Name of PBL image generated
29*54fd6939SJiyong Park	                              as an output of the tool.
30*54fd6939SJiyong Park	-e  <Address>               - [Optional] Entry Point Address
31*54fd6939SJiyong Park	                              of the BL2.bin
32*54fd6939SJiyong Park	-f  <Address>               - BL2 image offset
33*54fd6939SJiyong Park	                              on Boot Source for block copy.
34*54fd6939SJiyong Park	                              command for chassis >=3.)
35*54fd6939SJiyong Park				      (Must for Ch3, Ignored for Ch2)
36*54fd6939SJiyong Park	-h  Help.
37*54fd6939SJiyong Park	-s  Secure boot.
38*54fd6939SJiyong Park
39*54fd6939SJiyong Park		-s 	secure boot
40*54fd6939SJiyong Park		-c	SoC Number (see description above)
41*54fd6939SJiyong Park		-b	Boot source.
42*54fd6939SJiyong Park		-r	RCW binary file.
43*54fd6939SJiyong Park		-i	Input file that is to be added to rcw file.
44*54fd6939SJiyong Park		-o	Name of output file
45*54fd6939SJiyong Park		-f	Source Offset (Block Copy)
46*54fd6939SJiyong Park		-d	Destination address to which file has to be copied
47*54fd6939SJiyong Park		-h	Help.
48*54fd6939SJiyong Park
49*54fd6939SJiyong ParkExample:
50*54fd6939SJiyong Park	./create_pbl -r <RCW file> -i <bl2.bin> -c <chassis_no> -b <boot_source = sd/qspi/nor> -d <Destination_Addr> -o <pbl_image_name>
51*54fd6939SJiyong Park
52*54fd6939SJiyong Park
53*54fd6939SJiyong Park
54*54fd6939SJiyong ParkUsage at compilation time:
55*54fd6939SJiyong Park--------------------------------
56*54fd6939SJiyong Park
57*54fd6939SJiyong Park	make <compilation command......> pbl RCW=<Path_to_RCW_File>/<rcw_file_name.bin>
58*54fd6939SJiyong Park
59*54fd6939SJiyong ParkExample: QSPI Boot For LS1046ARDB-
60*54fd6939SJiyong Park
61*54fd6939SJiyong Park	make PLAT=ls1046rdb all fip BOOT_MODE=qspi SPD=opteed BL32=tee.bin BL33=u-boot-ls1046.bin pbl RCW=/home/pankaj/flexbuild/packages/firmware/dash-rcw/ls1046ardb/RR_FFSSPPPN_1133_5506/rcw_1600_qspiboot.bin
62*54fd6939SJiyong Park
63*54fd6939SJiyong ParkExample: QSPI Boot For LX2160ARDB-
64*54fd6939SJiyong Park
65*54fd6939SJiyong Park	make PLAT=lx2160ardb all fip BOOT_MODE=flexspi_nor SPD=opteed BL32=tee_lx2.bin BL33=u-boot_lx2160.bin pbl RCW=plat/nxp/soc-lx2160/lx2160ardb/rcw_1900_600_1600_19_5_2.bin
66