PBL Configuration Tool - User Guidecache.freescale.com/files/soft_dev_tools/doc/user_guide/QCSPBLUG.… · PBL is a configuration tool that helps create and modify an existing pre-boot

PBL Configuration Tool User Guide

Document Number: QCSPBLUGRev 4.0, 07/2014

PBL Configuration Tool User Guide, Rev. 4.0, 07/2014

2 Freescale Semiconductor, Inc.

Contents

Section number Title Page

Chapter 1QorIQ Configuration and Validation Suite PBL Configuration Tool

1.1 Introduction.......................................................................................................................................................................5

1.2 Using PBL Configuration Tool.........................................................................................................................................6

1.2.1 Creating QorIQ Configuration Project...................................................................................................................6

1.2.2 Configuring PBL....................................................................................................................................................10

1.2.2.1 Configuring RCW Field by User-defined Custom Value........................................................................14

1.2.2.2 Suppression of Non-critical Errors in PBL Settings................................................................................ 15

1.3 Generating Code from PBL Component...........................................................................................................................17

1.4 Importing PBL Configuration...........................................................................................................................................20

1.4.1 Importing Configuration During Project Creation.................................................................................................21

1.4.2 Importing Configuration for Existing PBL Project................................................................................................23

Chapter 2Appendices

2.1 Appendix A: PBL Component Input File Types.............................................................................................................. 27

2.2 Appendix B: PBL Component Output File Types............................................................................................................31

2.3 Appendix C: PBI Commands Data Supported Format Types.......................................................................................... 35


Freescale Semiconductor, Inc. 3



Chapter 1QorIQ Configuration and Validation Suite PBLConfiguration Tool

This document introduces the Pre-Boot Loader (PBL) configuration tool, represented bya PBL embedded component of QorIQ Configuration and Validation Suite (QCVS).

The document describes how to create a new QorIQ configuration project and configurethe PBL component. The document also describes the basic operations that can beperformed using the PBL configuration tool.

1.1 Introduction

PBL or Pre-Boot Loader is an internal hardware IP block which loads initialization datafrom a specified memory device interface and performs pre-boot initialization of QorIQdevice registers and local memory space.

PBL is a configuration tool that helps create and modify an existing pre-bootinitialization data used for configuring the QorIQ device.

The PBL tool is used for basic configuration and generation of pre-boot initializationdata. The pre-boot initialization data has two parts,

• a Reset Configuration Word (RCW) which is a 512-bits of information• a pre-boot initialization (PBI) commands block

These two parts are provided with CRC tail calculated during generation process and areencapsulated into a PBL image file. This PBL image serves as a basis for PBL blockduring power-on and pre-boot configuration of QorIQ device. So the PBL tool is requiredwhen you want to generate the pre-boot initialization data.



The PBL component of QCVS Processor Expert project allows changing RCWconfiguration for a selected QorIQ device using a set of properties available in theComponent Inspector view for current PBL component. Each RCW bit field has its ownPBL component property for setting the desired value(s). In case of PBI commands, thereis a special UI property in the PBL tool that allows you to edit PBI data which shall be apart of pre-boot initialization.

The PBL tool can generate pre-boot initialization data in various formats that can beprocessed later using other tools, for example, flash programmer that will program PBLimage data into a non-volatile memory. The PBL tool also allows importing an existingpre-boot initialization data (in supported formats) and use this data with slightmodification for different cases, such as modifying PLL ratios to tweak clockingfrequencies, changing SerDes setting, setting up different boot location, or adding newPBI commands.

1.2 Using PBL Configuration Tool

The PBL configuration tool allows you to create and modify an existing pre-bootinitialization data used for configuring the QorIQ device.

You can configure the PBL image content within the component properties. Thecomponent properties are available for configuration in the embedded component itemsdisplayed inside the Component Inspector view after adding the PBL component to theQorIQ configuration project.

To configure PBL, you need to first create a QorIQ configuration project.

This section describes the following topics:

• Creating QorIQ Project• Configuring PBL

1.2.1 Creating QorIQ Configuration Project

To create a new QorIQ project for PBL configuration, follow these steps:

1. Select File > New > QorIQ Configuration Project, and follow the steps in the NewQorIQ Configuration Project Wizard.

2. Enter project name.

Using PBL Configuration Tool



3. Select the required target SoC including the silicon revision in the Devices screen.For example, P4080, rev 3.0.

4. In the Toolset Selection screen, select the PBL - Preboot Loader RCWConfiguration checkbox.

Figure 1-1. Toolset Selection Screen5. Click Next.

The PBL Configuration screen appears.

Chapter 1 QorIQ Configuration and Validation Suite PBL Configuration Tool



Figure 1-2. PBL Configuration Screen1

NOTEUse RCW Hard-Coded configuration option is notavailable for all targets.




Figure 1-3. PBL Configuration Screen26. Specify the settings according to requirements.

NOTEYou can pre-configure the PBL component while creatingQorIQ Configuration project. In the PBL Configurationpage (Figure 1-2), select the Import configuration froman existing PBL file or Use RCW Hard-Codedconfiguration option, and provide the necessary detailscorresponding to the selected option. For details, seeImporting PBL Configuration.

7. Click Finish to complete project creation.

This creates a QorIQ project for PBL configuration.




1.2.2 Configuring PBL

To configure PBL component:

1. After creating the QorIQ project with the PBL tool, select the PBL component underthe Components folder in the Components view, as shown in figure below. Theproperties of the PBL component opens in the Component Inspector view.

Figure 1-4. PBL Component Selected in Components View

NOTEIf the Component Inspector view is closed, you can openit by right-clicking on the PBL component in theComponents view and then selecting the Inspector optionfrom the pop-up menu.

2. Adjust RCW bit field values or edit PBI commands according to your requirements.All the settings and properties of the PBL component are sorted by RCW position.




Figure 1-5. Component Inspector - PBL Properties

NOTEMost of the items of the PBL component are Basic level.Only some special or reserved RCW fields are Expert level.Almost all RCW bit fields values can be changedindependently, except the SRDS_EN [178] property of thedetailed SerDes PLL and Protocol Configuration.




Figure 1-6. SerDes Protocol Selection Table3. You can edit PBI commands independently using the PBI Data input property.

Switch to the Graphical Mode of the Component Inspector view to display theproperties of the PBL component.

4. Select the PBI Data Input property, as shown in the following figure, to display thePBI Data Input dialog on the right.




Figure 1-7. Editing PBI Data Input Property

NOTEYou can also open the PBI Data Input dialog by clicking the

button in the PBI Data Input property as shown in thefollowing figure. The button is available only in Basic/Advanced/Expert modes.

Figure 1-8. Opening PBI Data Input dialog

NOTEYou can find more details about supported PBI commands datatypes for PBI Data Input in Appendix C: PBI Commands DataSupported Format Types.

NOTEYou can also configure the PBL component while creating theQorIQ project. In the PBL Configuration screen, select theappropriate option, Import configuration from an existingPBL file or Use RCW Hard-coded configuration, andprovide the necessary details corresponding to the selected




option. For more information, see Importing ConfigurationDuring Project Creation.

1.2.2.1 Configuring RCW Field by User-defined Custom Value

PBL configuration tool lets you specify user-defined value for the RCW field.

You can specify user-defined value for the RCW field if the required bit field value ismissing, for example, when the range of allowed values exceeds. You can also specifyuser-defined value when not all values from the binary expressed bit value range areoffered. For example, in case of 2-bit field, all four possible values are not available.

To specify user-defined value for the RCW field:

1. From the View menu in the Component Inspector, select the Ignore Constraintsand non-Critical Errors option.

Figure 1-9. Enabling Ignore Constraints and Non-Critical Errors Option2. Select the required property. For example, SYS_PLL_RAT [2-6].3. Enter the prefixed custom value in the Custom Bitfield Value text box. Prefix with

0b for binary and 0x for hex.




Figure 1-10. Setting Property in Graphical Mode4. Click Apply.5. View the SYS_PLL_RAT [2-6] property updated with the custom value. This custom

value will be propagated into the PBL output.

Figure 1-11. SYS_PLL_RAT [2-6] Property Updated

NOTEYou need to be careful when changing RCW data using user-defined custom value(s). Setting RCW to an unsupported bitvalue(s) may lead to unpredictable behavior or may break theboot process completely and hang the device.

1.2.2.2 Suppression of Non-critical Errors in PBL Settings




You can suppress all errors except critical errors in the PBL tool settings.

Critical errors signify contradictory requests for the generated output that prevent thePBL tool from generating code.

To suppress non-critical errors in tool settings, click View menu in the ComponentInspector and select the Ignore Constraints and non-Critical Errors option (Figure1-9).

For example, to suppress the SerDes lanes power-down setting errors, as shown in thefollowing figure, select View > Ignore Constraints and non-Critical Errors option inthe Component Inspector view.

Figure 1-12. Suppressing SerDes Lanes Power-down Settings Errors

The error messages change to warnings as shown in the figure below.

Figure 1-13. SerDes Lanes Power-down Warning Message




1.3 Generating Code from PBL Component

The PBL configuration tool generates pre-boot initialization data that encapsulates into aPBL image file.

When you finish configuration settings of the components, or at any time duringconfiguration changes, it is necessary to generate code to get updated output of thecomponents.

For Layerscape devices, two more parameters are available for code generation that areEndianness and Access Size. The generated code will change depending on the selectedoutput format. For some output formats, the Endianness and Access Size are disabledbecause they are not used.

Figure 1-14. Configuration page - For Layerscape devices

The code generation from the PBL component is based on the properties set in theComponent Inspector. The output from the PBL component is generated on userrequest.

Perform any of the following steps to generate code:

• Click the Generate Processor Expert Code icon in the Components view asshown in the following figure.




Figure 1-15. Generate Processor Expert Code Icon• Right-click the ProcessorExpert.pe node in the Project Explorer view, and select the

Generate Processor Expert Code option from the context menu, as shown in thefollowing figure.

Generating Code from PBL Component



Figure 1-16. Generate Processor Expert Code• Select the Project > Generate Processor Expert Code option from the Eclipse IDE

menu.

The Generating Code dialog appears.




Figure 1-17. Code Generation

The output file is generated and added to the Project Explorer in the Generated_Codefolder. The name of the output file use the same name of the PBL component used in theQorIQ Configuration project as shown in figure below.

Figure 1-18. PBL Generated Code File in Project Explorer

Importing PBL Configuration



1.4 Importing PBL Configuration

You can also use the PBL component to configure PBL data by importing configurationfrom an existing PBL image file that may have content in one of the several supportedformats. For details, refer Appendix A: PBL Component Input File Types.

You can import a PBL configuration using the New QorIQ Configuration ProjectWizard during project creation or later for any component already existing in project.

• Importing Configuration During Project Creation• Importing Configuration for Existing PBL Project

1.4.1 Importing Configuration During Project Creation

To import a PBL configuration, a QorIQ Configuration project must be created. Performthe following steps:

1. In the PBL Configuration page of the New QorIQ Configuration Project Wizard,select the Import configuration from an existing PBL file option.

2. Specify the file to be imported in the Input file text box. Use the Browse button tolocate the file.

3. Select the appropriate file format in which you want to import the specified inputfile, from the File format drop-down box.




Figure 1-19. Selecting Input File - PBL Configuration4. For Layerscape devices:

a. Select the appropriate endianness. Default endianness for all QorIQ devicesexcept Layerscape is Big endian. Default endianness for Layerscape devices isLittle Endian.




b. Select the appropriate Access Size. Access size refers to how the data isdisplayed (for example, for XXD format access size is 2 means the bytes aregrouped 2 by 2) and also how the endianness conversion is done.

NOTEFor some formats, the Access Size parameter isdisabled, because it is not used. Access size isautomatically detected using the imported file bytesgrouping. The formats for which the access size isautomatically detected are: XXD Object Dump, U-Boot Memory Dump, eDINK Memory Dump,RCW[0:511] U-Boot CCSR Dump, RCW[0:511]eDINK CCSR Dump.

5. Click Finish.

The PBL project is created using imported configuration.

1.4.2 Importing Configuration for Existing PBL Project

You can also configure the PBL component by importing an existing pre-bootinitialization data in the selected PBL image input format. You can import PBL imageusing clipboard as well as from a file. Following are the steps to import a PBL image:

1. Open the Component Inspector view for PBL component in the existing project.2. Select the Import tab in the Component Inspector view. The following fields are

available:• Input File – specifies the input configuration file for import• Input Format – specifies the input configuration file format• Input Data – displays the content of the selected input file

For Layerscape devices, two more parameters are available for code generation:Endianness and Access Size.

• Endianness – specifies the endianness of the generated file. Default endiannessfor Layerscape devices is Little Endian.

• Access size – specifies the access size of the endianness conversion. For someformats, access size refers to how the data is displayed (for example, for XXDformat access size 2 means the bytes are grouped 2 by 2).




The generated code will change based on selected output format, Endianness andAccess Size. For some output formats, the Endianness and Access Size are disabledbecause they are not used (for example, Text Table RCW Format).

Figure 1-20. Import Tab - Specifying Import Parameters




Figure 1-21. Import Tab - Specifying Import Parameters3. Either specify the file to be imported, in the Input File text box, or put the input data

directly into the Input data text box (that is copying the content of the file in theInput Data text box).

4. Specify the format of the file in the Input Format field.5. Click Import.

The data is imported and the Import Complete dialog appears.

Figure 1-22. Import Complete Dialog6. Click OK.

The changed properties are highlighted as shown in the figure below.




Figure 1-23. Changed Properties

This is how you import a PBL image.




Chapter 2Appendices

2.1 Appendix A: PBL Component Input File Types

This appendix contains description of the PBL input file formats supported by the PBLtool import functionality. The various PBL formats available for the import configurationare shown in the following figures.

• XXD Object Dump - This file format is directly generated from the PBL tool andsupports user comments within PBL data content.

Figure 2-1. XXD Object Dump Format• S-Record - You can find detailed information about the Motorola S-record format in

MC68000 Family Programmer's Reference Manual at http://www.freescale.com/files/archives/doc/ref_manual/M68000PRM.pdf. This file format is directlygenerated from the PBL tool.



http://www.freescale.com/files/archives/doc/ref_manual/M68000PRM.pdf


Figure 2-2. S-Record Format• Source Code - This file format is directly generated from the PBL tool.

Figure 2-3. Source Code Format• Text Table RCW Format - This file format is directly generated from the PBL tool

and supports user comments within PBL data content.

Figure 2-4. Text Table RCW Format• U-Boot Memory Dump - This file format supports user comments within PBL data

content.

Appendix A: PBL Component Input File Types



Figure 2-5. U-Boot Memory Dump Format• eDINK Memory Dump - This file format supports user comments within PBL data

content.

Figure 2-6. eDINK Memory Dump Format• Hex String - This file format is directly generated from the PBL tool.

Figure 2-7. Hex String Format• RCW[0:511] U-Boot CCSR Dump - This file format supports user comments within

PBL data content.

Chapter 2 Appendices



Figure 2-8. RCW[0:511] U-Boot CCSR Dump Format• RCW[0:511] eDINK CCSR Dump - This file format supports user comments within

PBL data content.

Figure 2-9. RCW[0:511] eDINK CCSR Dump Format• RCW[0:511] CW JTAG Config - This file format is directly generated from the PBL

tool.

Figure 2-10. RCW[0:511] CW JTAG Config Format• RCW[0:511] Hex String - This file format is directly generated from the PBL tool.

Appendix A: PBL Component Input File Types



Figure 2-11. RCW[0:511] Hex String Format• Binary - This is the binary form of the PBL data from XXD Object Dump. This file

format is directly generated from the PBL tool.

Figure 2-12. Binary File Format

NOTEPBL supports different set of input and output file formatsalthough some of the file formats are supported for both.

2.2 Appendix B: PBL Component Output File Types

This appendix contains description of the PBL output file formats supported by the PBLtool code generation.

NOTEPBL supports different set of input and output file formatsalthough some of the file formats are supported for both.

• XXD Object Dump - This file format is directly supported for PBL input also.




Figure 2-13. XXD Object Dump Format• S-Record - You can find detailed information about the Motorola S-record format in

MC68000 Family Programmer's Reference Manual at http://www.freescale.com/files/archives/doc/ref_manual/M68000PRM.pdf. This file format is directlysupported for PBL input also.

Figure 2-14. S-Record Format• Source Code - This file format is directly supported for PBL input also.

Figure 2-15. Source Code Format• Text Table RCW Format - This file format is directly supported for PBL input also.

Appendix B: PBL Component Output File Types





Figure 2-16. Text Table RCW Format• U-Boot Commands

Figure 2-17. U-Boot Commands File Format• eDINK32 Commands




Figure 2-18. eDINK32 Commands File Format• Hex String - This file format is directly supported for PBL input also.

Figure 2-19. Hex String Format• RCW[0:511] CW JTAG Config - This file format is directly supported for PBL input

also.

Figure 2-20. RCW[0:511] CW JTAG Config Format

Appendix B: PBL Component Output File Types



• RCW[0:511] Hex String - This file format is directly supported for PBL input also.

Figure 2-21. RCW[0:511] Hex String Format• Binary - This is the binary form of the PBL data from XXD Object Dump. This file

format is directly supported for PBL input also.

Figure 2-22. Binary File Format

2.3 Appendix C: PBI Commands Data Supported FormatTypes

This appendix describes PBI commands data types and formats supported by the PBLtool within the UI property PBI Data Input to process PBI data from.

The simple PBI command types that you can select in the PBI Data Input field in theGraphical Mode of the Component Inspector view are:

• PBI command to write CCSR data of 4-bytes or 1-byte• PBI command to write ACS data of 4-bytes• PBI command to Flush, CRC Check, Jump or Wait




Figure 2-23. Simple PBI Command Types

The complex set of PBI data read from user-defined file is shown in the following figure.

Figure 2-24. Complex Set of PBI Command Data

• PBI data to initialize only ACS space read as data from an XXD Object Dump orfrom a binary file processed as chunks of data. For example, to initialize ACSaddress space by a user-defined boot loader or OS kernel that will take care of devicebooting after a PBL hardware. Data read from the selected file are processed by thePBL tool to set the largest possible data chunks, maximum of 64-bytes as supportedby the PBL hardware. The PBL tool properly accepts only XXD Object Dump orbinary formatted data for this kind of ACS space initialization.

• PBI data to initialize memory space (CCSR or ACS) read as PBI data from LinuxSDK RCW text file and processed to a set of separate PBI commands. For example,device errata workaround or single register initialization through additional PBIcommands during boot process.

Appendix C: PBI Commands Data Supported Format Types



You can select the input file which is then processed by the PBL tool with respect toa simple pre-processing and recognition of basic PBI command types as supported bya QorIQ Linux SDK (since version 1.3.1). The following commands are recognizedin .pbi sections within the input RCW text file.

• write <a> <n>... write PBI command that writes to CCSR address <a> value of <n>• awrite <a> <n>... write PBI command that writes to ACS address <a> value of <n>• wait <n>... wait PBI command for defined value of <n>• flush ... flush PBI command

The following pre-processing statements are supported within the input file.• #include <file-name> or #include "file-name"...include specified file content• #define ...define either symbol for conditions or symbol with value• #ifdef-#endif... conditional statement applied to inner content




Appendix C: PBI Commands Data Supported Format Types



How to Reach Us:

Home Page:freescale.com

Web Support:freescale.com/support

Information in this document is provided solely to enable system and

software implementers to use Freescale products. There are no express

or implied copyright licenses granted hereunder to design or fabricate

any integrated circuits based on the information in this document.

Freescale reserves the right to make changes without further notice to

any products herein. Freescale makes no warranty, representation, or

guarantee regarding the suitability of its products for any particular

purpose, nor does Freescale assume any liability arising out of the

application or use of any product or circuit, and specifically disclaims

any and all liability, including without limitation consequential or

incidental damages. “Typical” parameters that may be provided in

Freescale data sheets and/or specifications can and do vary in different

applications, and actual performance may vary over time. All operating

parameters, including “typicals,” must be validated for each customer

application by customer's technical experts. Freescale does not convey

any license under its patent rights nor the rights of others. Freescale

sells products pursuant to standard terms and conditions of sale, which

can be found at the following address: freescale.com/

SalesTermsandConditions.

Freescale, the Freescale logo, AltiVec, C-5, CodeTest, CodeWarrior,

ColdFire, ColdFire+, C-Ware, Energy Efficient Solutions logo, Kinetis,

mobileGT, PowerQUICC, Processor Expert, QorIQ, Qorivva, StarCore,

Symphony, and VortiQa are trademarks of Freescale Semiconductor,

Inc., Reg. U.S. Pat. & Tm. Off. Airfast, BeeKit, BeeStack, CoreNet,

Flexis, Layerscape, MagniV, MXC, Platform in a Package, QorIQ

Qonverge, QUICC Engine, Ready Play, SafeAssure, SafeAssure logo,

SMARTMOS, Tower, TurboLink, Vybrid, and Xtrinsic are trademarks of

Freescale Semiconductor, Inc. All other product or service names are

the property of their respective owners.

© 2011–2014 Freescale Semiconductor, Inc.

Document Number QCSPBLUGRevision 4.0, 07/2014

http://www.freescale.com

http://www.freescale.com/support

http://www.freescale.com/SalesTermsandConditions

http://www.freescale.com/SalesTermsandConditions

Documents

PBL Configuration Tool - User Guidecache.freescale.com/files/soft_dev_tools/doc/user_guide/QCSPBLUG.… · PBL is a configuration tool that helps create and modify an existing pre-boot