Kontron AM4140 User Manual
» User Guide «
AM4140
U-Boot Bootloader
Doc. ID: 1052-0281, Rev. 1.0
June 5, 2012
If it’s embedded, it’s Kontron.
P R E L I M I N A R Y
Preface AM4140 U-Boot Bootloader
Revision History
Publication Title:
Doc. ID: 1052-0281
Rev. Brief Description of Changes Date of Issue
1.0 Initial issue based on the following U-Boot version:
U-Boot 2011.06-00127-gea741f2 (Apr 20 2012 - 13:05:24)
U-Boot Bootloader User Guide for AMC modules
5-Jun-2012
Imprint
Kontron Modular Computers GmbH may be contacted via the following:
MAILING ADDRESS TELEPHONE AND E-MAIL
Kontron Modular Computers GmbH +49 (0) 800-SALESKONTRON
Sudetenstraße 7 sales@kontron.com
D - 87600 Kaufbeuren Germany
P R E L I M I N A R Y
For further information about other Kontron products, please visit our Internet web site:
www.kontron.com.
Disclaimer
Copyright © 2012 Kontron AG. All right s reserved. All dat a is for information purposes only and
not guaranteed for legal purposes. Information has been carefully checked and is believed to
be accurate; however, no responsibility is assumed for inaccuracies. Kontron and the Kontron
logo and all other trademarks or registered trademarks are the property of their respective owners and are recognized. Specifications are subject to change without notice.
Page 2 ID 1052-0281, Rev. 1.0
AM4140 U-Boot Bootloader Preface
Table of Contents
Revision History ........................................................................................................2
Imprint ....................................................................................................................... 2
Disclaimer .................................................................................................................2
Table of Contents ...................................................................................................... 3
Copyrights and Licensing .......................................................................................... 5
Obtaining Source Code ........................................................................................... 10
1. Introduction to U-Boot ................................................................11
2. Standard U-Boot Commands .....................................................11
3. Kontron-Specific Commands .....................................................14
3.1 flsw Command ..........................................................................................15
3.2 fru Command ............................................................................................16
3.3 fwum Command ........................................................................................18
3.4 kboardinfo Command ................................................................................ 20
3.5 kcs Command ............................................................................................ 21
3.6 md5sum Command ................................................................................... 24
3.7 sconf Command .........................................................................................26
3.8 tlbdbg Command ........................................................................................ 31
3.9 vpd Command ............................................................................................32
4. U-Boot Access and Startup ........................................................33
5. Environment ................................................................................34
P R E L I M I N A R Y
6. Working with U-Boot ...................................................................34
6.1 General Operation ...................................................................................... 34
6.2 Using the sconf Command ......................................................................... 34
ID 1052-0281, Rev. 1.0 Page 3
Preface AM4140 U-Boot Bootloader
6.2.1 Overview of Board Configuration Options .........................................35
6.2.2 Example of sconf Command Usage ...................................................36
6.2.2.1 sconf info ...................................................................................36
6.2.2.2 sconf select ................................................................................37
6.2.2.3 sconf set ....................................................................................37
6.2.2.4 sconf save reset .........................................................................38
6.2.2.5 sconf status ................................................................................38
6.3 Using the Network ......................................................................................39
6.3.1 Interface Selection .............................................................................39
6.3.1.1 ethprime .....................................................................................40
6.3.1.2 ethact .........................................................................................40
6.3.1.3 ethrotate .....................................................................................40
6.3.2 Contacting the Server .........................................................................41
6.4 Using SD Cards ..........................................................................................41
6.5 Using the Onboard NAND Flash .................................................................42
6.6 Using the SPI Flash for OS .........................................................................43
6.7 Booting an OS ............................................................................................43
6.7.1 Booting Linux .....................................................................................43
6.7.2 Booting VxWorks ................................................................................44
6.8 Getting Help ................................................................................................45
6.9 Update ........................................................................................................46
6.10 Recovery Mechanism .................................................................................46
P R E L I M I N A R Y
Page 4 ID 1052-0281, Rev. 1.0
AM4140 U-Boot Bootloader Preface
Copyrights and Licensing
U-Boot is Free Software. It is copyrighted by Wolfgang Denk and many others who contributed
code (see the actual source code for details). You can redistribute U-Boot and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. Most of it can also be distributed, at your option, under any later version of
the GNU General Public License -- see individual files for exceptions.
NOTE! This license does *not* cover the so-called "standalone" applications that use U-Boot
services by means of the jump table provided by U-Boot exactly for this purpose - this is merely
considered normal use of U-Boot, and does *not* fall under the heading of "derived work".
The header files "include/image.h" and "include/asm-*/u-boot.h" define interfaces to U-Boot. Including these (unmodified) header files in another file is considered normal use of U-Boot, and
does *not* fall under the heading of "derived work".
Also note that the GPL below is copyrighted by the Free Software Foundation, but the instance
of code that it refers to (the U-Boot source code) is copyrighted by me and others who actually
wrote it.
-- Wolfgang Denk
======================================================================
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but
changing it is not allowed.
Preamble
The licenses for most software are designed to take away your freedom to share and change
it. By contrast, the GNU General Public License is intended to guarantee your freedom to share
and change free software -- to make sure the software is fre e for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is
covered by the GNU Library General Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public
Licenses are designed to make sure that you have the freedom to distribute copies of free sof tware (and charge for this service if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new free programs; and that you
know you can do these things.
P R E L I M I N A R Y
To protect your rights, we need to make restrictions that forbid anyone to deny you these rights
or to ask you to surrender the rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the software, or if you modify it.
ID 1052-0281, Rev. 1.0 Page 5
Preface AM4140 U-Boot Bootloader
For example, if you distribute copies of such a program, whether gratis or for a fee, you must
give the recipients all the rights that you have. You must make sure that they, too, receive or
can get the source code. And you must show them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this license
which gives you legal permission to copy, distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain that everyone underst ands
that there is no warranty for this free software. If the software is modified by someon e else and
passed on, we want its recipients to know that what they have is not the original, so that any
problems introduced by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We wish to avoid the
danger that redistributors of a free program will individually obtain patent licenses, in effect
making the program proprietary. To prevent this, we have made it clear that any p atent must be
licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains a notice placed by the
copyright holder saying it may be distributed under the terms of this General Public
License. The "Program", below , refers to any such program or work, and a "work based on
the Program" means either the Program or any derivative work under copyright law: that is
to say , a work containing the Program or a portion of it, either verbatim or with modifications
and/or translated into another language. (Hereinafter, translation is included without
limitation in the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not covered by this License;
they are outside its scope. The act of running the Program is not restricted, and the output
from the Program is covered only if its contents constitute a work based on the Program
(independent of having been made by running the Program). Whethe r that is true depends
on what the Program does.
1. You may copy and distribute verbatim copies of the Program's source code as you receive
P R E L I M I N A R Y
it, in any medium, provided that you conspicuously and appropriately publish on each copy
an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that
refer to this License and to the absence of any warranty; and give any other recipients of
the Program a copy of this License along with the Program.
Y ou may charge a fee for the physical act of transferring a copy , and you may at your option
offer warranty protection in exchange for a fee.
Page 6 ID 1052-0281, Rev. 1.0
AM4140 U-Boot Bootloader Preface
2. You may modify your copy o r copies of the Program or any portion of it, thus forming a work
based on the Program, and copy and distribute such modifications or work under the terms
of Section 1 above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that you changed
the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in part
contains or is derived from the Program or any part thereof, t o be licensed as a whole
at no charge to all third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you must
cause it, when started running for such interactive use in the most ordinary way, to
print or display an announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide a warranty) and that
users may redistribute the program under these conditions, and telling the user how
to view a copy of this License. (Exception: if the Program itself is interactive but does
not normally print such an announcement, your work based on the Program is not
required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that
work are not derived from the Program, and can be reasonably considered independent
and separate works in themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you distribute the same
sections as part of a whole which is a work based on the Program, the distribution of the
whole must be on the terms of this License, whose permissions for other licensees extend
to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your right s to work written
entirely by you; rather, the intent is to exercise the right to control the distribution of
derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program
(or with a work based on the Program) on a volume of a storage or distribution medium
does not bring the other work under the scope of this License.
3. You may copy and distribute the Program (or a work based on it, under Section 2) in object
code or executable form under the terms of Sections 1 and 2 above provided that you also
do one of the following:
a) Accomp any it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
b) Accomp any it with a written of fer, valid for at least three years, to give any third party,
for a charge no more than your cost of physically performing source distribution, a
complete machine-readable copy of the corresponding source code, to be distributed
under the terms of Sections 1 and 2 above on a medium customarily used for software
interchange; or,
P R E L I M I N A R Y
c) Accompany it with the information you received as to the offer to distribute
corresponding source code. (This alternative is allowed only for noncommercial
distribution and only if you received the program in object code or executable form
with such an offer, in accord with Subsection b above.)
ID 1052-0281, Rev. 1.0 Page 7
Preface AM4140 U-Boot Bootloader
The source code for a work means the preferred form of the work for making modifications
to it. For an executable work, complete source code means all the source code for all
modules it contains, plus any associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However , as a special exception, the
source code distributed need not include anything that is normally distributed (in either
source or binary form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component itself accomp anies
the executable.
If distribution of executable or object code is made by offering access to copy from a
designated place, then offering equivalent access to copy th e source code from the same
place counts as distribution of the source code, even though third parties are no t compelled
to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program except as expressly
provided under this License. Any attempt otherwise to copy, modify, sublicense or
distribute the Program is void, and will automatically terminate your rights under this
License. However , parties who have received copies, or right s, from you under this License
will not have their licenses terminated so long as such parties remain in full compliance.
5. You are not required to accept this L icense, since you have not signed it. However , nothing
else grants you permission to modify or distribute the Program or its derivative works.
These actions are prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the Program), you indicate
your acceptance of this License to do so, and all its terms and conditions for copying,
distributing or modifying the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the Program), the recipient
automatically receives a license from the original licensor to copy, distribute or modify the
Program subject to these terms and conditions. Y ou may not impose any further restrictions
on the recipients' exercise of the rights granted herein. You are not responsible for
enforcing compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent infringement or for any
other reason (not limited to patent issues), conditions are imposed on you (whether by
court order , agreement or otherwise) that contradict the con ditions of this License, they do
not excuse you from the conditions of this License. If you cannot distribute so as to satisfy
P R E L I M I N A R Y
simultaneously your obligations under this License and any other pertinent obligations,
then as a consequence you may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by all those who receive
copies directly or indirectly through you, then the only way you could satisfy both it and this
License would be to refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular
circumstance, the balance of the section is intended to apply and the section as a who le is
intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property
right claims or to contest validity of any such claims; this section has the sole purpose of
protecting the integrity of the free software distribution system, which is implemented by
public license practices. Many people have made generous contributions to the wide range
of software distributed through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing to distribute software
through any other system and a licensee cannot impose that choice.
Page 8 ID 1052-0281, Rev. 1.0
AM4140 U-Boot Bootloader Preface
This section is intended to make thoroughly clear what is believed to be a con sequence of
the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain countries either by
patents or by copyrighted interfaces, the original copyright holder who place s the Program
under this License may add an explicit geographical distribution limitation excluding those
countries, so that distribution is permitted only in or among countries not thus excluded. In
such case, this License incorporates the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions of the General
Public License from time to time. Such new versions will be similar in spirit to the present
version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a version
number of this License which applies to it and "any later version", you have the option of
following the terms and conditions either of that version or of any later version published
by the Free Software Foundation. If the Program does not specify a version number of this
License, you may choose any version ever published by the Free Software Foundation.
10. If you wish to incorporate part s of the Program into other f ree programs whose distribution
conditions are different, write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free Software Foundation; we
sometimes make exceptions for this. Our decision will be guided by the two goals of
preserving the free status of all derivatives of our free software and of promoting the
sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
LAW . EXCEPT WHEN OTHERWISE ST ATED IN WRITING THE COPYRIGHT HOLDERS
AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING , BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING , REP AIR OR
CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENT AL
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURA TE OR LOSSES SUST AINED BY YOU OR THIRD P AR TIES OR
A FAILURE OF THE PROGRAM T O OPERA TE WITH ANY OTHER PROGRAMS), EVEN
IF SUCH HOLDER OR OTHER P AR TY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
P R E L I M I N A R Y
END OF TERMS AND CONDITIONS
ID 1052-0281, Rev. 1.0 Page 9
Preface AM4140 U-Boot Bootloader
Obtaining Source Code
The software included in this product contains copyrighted software that is licensed under the
GPL. A copy of that license is included in this document beginning on page 5. You may obtain
the complete corresponding source code from Kontron for a period of three years af ter our last
shipment of this product. Please contact Kontron for further assist ance in obt a ining the source
code.
P R E L I M I N A R Y
Page 10 ID 1052-0281, Rev. 1.0
AM4140 U-Boot Bootloader U-Boot Usage
1. Introduction to U-Boot
U-Boot is an open source bootloader software developed and maintained by DENX Software
Engineering GmbH (http://www.denx.de). Kontron provides U-Boot with all its standard features as well as Kontron-specific features for usage with Kontron’s AM4140 AMC module.
This user guide provides specific information on Kontron’s implementation of U-Boot and its usage. Please refer to the DENX web site for up-to-date on-line documentation of all of U-Boot’s
standard features.
2. Standard U-Boot Commands
U-Boot is provided with a set of standard commands for which documentation is available on
the DENX web site. Some of the standard commands have sub -groups which can be displayed
when help for the main group command is requested. Where relevant, further information concerning the usage of standard commands is provided in this guide to assist users in performing
specific functions.
The following table indicates the standard U-boot commands configured for the AM4140. The
blue-shaded table cells indicate st andar d U-Boot commands te sted by Ko ntron. Only the st andard U-Boot commands relevant for the normal operation of the AM4140 U-Boot bootloader
have been tested by Kontron.
Table 1: Standard U- Boot Commands Configured for the AM4140
COMMAND DESCRIPTION
? Alias for 'help'
base Print or set address offset
bdinfo Print Board Info structure
boot Boot default, i.e., run 'bootcmd'
bootd Boot default, i.e., run 'bootcmd'
bootelf Boot from an ELF image in memory
bootm Boot application image from memory
bootp Boot image via network using BOOTP/TFTP protocol
bootvx Boot vxWorks from an ELF image
chpart Change active partition
cmp Memory compare
P R E L I M I N A R Y
coninfo Print console devices and information
cp Memory copy
cpu Multiprocessor CPU boot manipulation and release
crc32 Checksum calculation
dhcp Boot image via network using DHCP/TFTP protocol
echo Echo args to console
ID 1052-0281, Rev. 1.0 Page 11
U-Boot Usage AM4140 U-Boot Bootloader
Table 1: Standard U- Boot Commands Configured for the AM4140 (continued)
COMMAND DESCRIPTION
editenv Edit environment variable
env Environment handling commands
errata Report errata workarounds
exit Exit script
ext2load Load binary file from an Ext2 filesystem
ext2ls List files in a directory (default /)
false Do nothing, unsuccessfully
fatinfo Print information about filesystem
fatload Load binary file from a dos filesystem
fatls List files in a directory (default /)
fdt Flattened device tree utility commands
fsinfo Print information about filesystems
fsload Load binary file from a filesystem image
go Start application at address 'addr'
grepenv Search environment variables
help Print command description/usage
i2c I2C subsystem
iminfo Print header information for application image
imxtract Extract a part of a multi-image
interrupts Enable or disable interrupts
irqinfo Print information about IRQs
itest Return true/false on integer compare
P R E L I M I N A R Y
loadb Load binary file over serial line (kermit mode)
loads Load S-Record file over serial line
loady Load binary file over serial line (ymodem mode)
loop Infinite loop on address range
ls List files in a directory (default /)
md Memory display
mdio MDIO utility commands
mii MII utility commands
mm Memory modify (auto-incrementing address)
mmc MMC sub sy stem
Page 12 ID 1052-0281, Rev. 1.0
AM4140 U-Boot Bootloader U-Boot Usage
Table 1: Standard U- Boot Commands Configured for the AM4140 (continued)
COMMAND DESCRIPTION
mmcinfo Display MMC info
mtdparts Define flash/nand partitions
mtest Simple RAM read/write test
mw Memory write (fill)
nand NAND subsystem
nboot Boot from NAND device
nfs Boot image via network using NFS protocol
nm Memory modify (constant address)
pci List and access PCI Configuration Space
ping Send ICMP ECHO_REQUEST to network host
printenv Print environment variables
reginfo Print register information
reset Perform RESET of the CPU
run Run commands in an environment variable
saveenv Save environment variables to persistent storage
saves Save S-Record file over serial line
setenv Set environment variables
setexpr Set environment variable as the result of eval expression
sf SPI flash subsystem
showvar Print local hushshell variables
sleep Delay execution for some time
source Run script from memory
test Minimal test like /bin/sh
tftpboot Boot image via network using TFTP protocol
true Do nothing, successfully
ubi ubi commands
P R E L I M I N A R Y
ubifsload Load file from an UBIFS filesystem
ubifsls List files in a directory
ubifsmount Mount UBIFS volume
ubifsumount Unmount UBIFS volume
version Print monitor, compiler and linker version
ID 1052-0281, Rev. 1.0 Page 13
U-Boot Usage AM4140 U-Boot Bootloader
3. Kontron-Specific Commands
Kontron’s implementation of U-Boot includes certain enhancements to provide specific functions not incorporated in the standard U-Boot. The following table provides a complete listing
of all Kontron-specific U-Boot commands implemented on the AM4140.
Table 2: Kontron-Specific Commands
COMMAND DESCRIPTION
flsw FLash SWitch
Indicates or selects the currently active SPI boot flash
fru Field Replaceable Unit
Provides read/write access to the board’s FRU repository as well as displaying FRU data
fwum FirmWare Update Manager
Provides functions for managing and updating the module’s MMC firmware
kboardinfo Kontron Board Information
Displays a summary of board and configuration information
kcs Access to the Keyboard Controller-Style Interface
Sends raw IPMI commands via the KCS interface
md5sum Message digest 5 checksum
Creates or checks the md5 message digest over a memory area
sconf Kontron Board Configuration
Provides functions for software-based configuration of external interfaces available on the
AMC Card-edge connector and on the front panel connectors J2 (GbE B) and J3 (GbE A)
tlbdbg Translation Look-aside Buffer DeBuG
Displays current configuration of TLB0 and TLB1
vpd Vital Product Data
Provides display and importing functions for vital product data entities
The following chapters provides command syntax reference information, a short description,
and, in some cases, usage examples. Where an ellipsis (…) appears in the command syntax,
it means that the command is continued on the next line. Observe spaces before the ellipsis.
P R E L I M I N A R Y
Page 14 ID 1052-0281, Rev. 1.0
Loading...