README 132 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880
  1. # SPDX-License-Identifier: GPL-2.0+
  2. #
  3. # (C) Copyright 2000 - 2013
  4. # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  5. Summary:
  6. ========
  7. This directory contains the source code for U-Boot, a boot loader for
  8. Embedded boards based on PowerPC, ARM, MIPS and several other
  9. processors, which can be installed in a boot ROM and used to
  10. initialize and test the hardware or to download and run application
  11. code.
  12. The development of U-Boot is closely related to Linux: some parts of
  13. the source code originate in the Linux source tree, we have some
  14. header files in common, and special provision has been made to
  15. support booting of Linux images.
  16. Some attention has been paid to make this software easily
  17. configurable and extendable. For instance, all monitor commands are
  18. implemented with the same call interface, so that it's very easy to
  19. add new commands. Also, instead of permanently adding rarely used
  20. code (for instance hardware test utilities) to the monitor, you can
  21. load and run it dynamically.
  22. Status:
  23. =======
  24. In general, all boards for which a configuration option exists in the
  25. Makefile have been tested to some extent and can be considered
  26. "working". In fact, many of them are used in production systems.
  27. In case of problems see the CHANGELOG file to find out who contributed
  28. the specific port. In addition, there are various MAINTAINERS files
  29. scattered throughout the U-Boot source identifying the people or
  30. companies responsible for various boards and subsystems.
  31. Note: As of August, 2010, there is no longer a CHANGELOG file in the
  32. actual U-Boot source tree; however, it can be created dynamically
  33. from the Git log using:
  34. make CHANGELOG
  35. Where to get help:
  36. ==================
  37. In case you have questions about, problems with or contributions for
  38. U-Boot, you should send a message to the U-Boot mailing list at
  39. <u-boot@lists.denx.de>. There is also an archive of previous traffic
  40. on the mailing list - please search the archive before asking FAQ's.
  41. Please see https://lists.denx.de/pipermail/u-boot and
  42. https://marc.info/?l=u-boot
  43. Where to get source code:
  44. =========================
  45. The U-Boot source code is maintained in the Git repository at
  46. https://source.denx.de/u-boot/u-boot.git ; you can browse it online at
  47. https://source.denx.de/u-boot/u-boot
  48. The "Tags" links on this page allow you to download tarballs of
  49. any version you might be interested in. Official releases are also
  50. available from the DENX file server through HTTPS or FTP.
  51. https://ftp.denx.de/pub/u-boot/
  52. ftp://ftp.denx.de/pub/u-boot/
  53. Where we come from:
  54. ===================
  55. - start from 8xxrom sources
  56. - create PPCBoot project (https://sourceforge.net/projects/ppcboot)
  57. - clean up code
  58. - make it easier to add custom boards
  59. - make it possible to add other [PowerPC] CPUs
  60. - extend functions, especially:
  61. * Provide extended interface to Linux boot loader
  62. * S-Record download
  63. * network boot
  64. * ATA disk / SCSI ... boot
  65. - create ARMBoot project (https://sourceforge.net/projects/armboot)
  66. - add other CPU families (starting with ARM)
  67. - create U-Boot project (https://sourceforge.net/projects/u-boot)
  68. - current project page: see https://www.denx.de/wiki/U-Boot
  69. Names and Spelling:
  70. ===================
  71. The "official" name of this project is "Das U-Boot". The spelling
  72. "U-Boot" shall be used in all written text (documentation, comments
  73. in source files etc.). Example:
  74. This is the README file for the U-Boot project.
  75. File names etc. shall be based on the string "u-boot". Examples:
  76. include/asm-ppc/u-boot.h
  77. #include <asm/u-boot.h>
  78. Variable names, preprocessor constants etc. shall be either based on
  79. the string "u_boot" or on "U_BOOT". Example:
  80. U_BOOT_VERSION u_boot_logo
  81. IH_OS_U_BOOT u_boot_hush_start
  82. Versioning:
  83. ===========
  84. Starting with the release in October 2008, the names of the releases
  85. were changed from numerical release numbers without deeper meaning
  86. into a time stamp based numbering. Regular releases are identified by
  87. names consisting of the calendar year and month of the release date.
  88. Additional fields (if present) indicate release candidates or bug fix
  89. releases in "stable" maintenance trees.
  90. Examples:
  91. U-Boot v2009.11 - Release November 2009
  92. U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
  93. U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
  94. Directory Hierarchy:
  95. ====================
  96. /arch Architecture-specific files
  97. /arc Files generic to ARC architecture
  98. /arm Files generic to ARM architecture
  99. /m68k Files generic to m68k architecture
  100. /microblaze Files generic to microblaze architecture
  101. /mips Files generic to MIPS architecture
  102. /nds32 Files generic to NDS32 architecture
  103. /nios2 Files generic to Altera NIOS2 architecture
  104. /powerpc Files generic to PowerPC architecture
  105. /riscv Files generic to RISC-V architecture
  106. /sandbox Files generic to HW-independent "sandbox"
  107. /sh Files generic to SH architecture
  108. /x86 Files generic to x86 architecture
  109. /xtensa Files generic to Xtensa architecture
  110. /api Machine/arch-independent API for external apps
  111. /board Board-dependent files
  112. /boot Support for images and booting
  113. /cmd U-Boot commands functions
  114. /common Misc architecture-independent functions
  115. /configs Board default configuration files
  116. /disk Code for disk drive partition handling
  117. /doc Documentation (a mix of ReST and READMEs)
  118. /drivers Device drivers
  119. /dts Makefile for building internal U-Boot fdt.
  120. /env Environment support
  121. /examples Example code for standalone applications, etc.
  122. /fs Filesystem code (cramfs, ext2, jffs2, etc.)
  123. /include Header Files
  124. /lib Library routines generic to all architectures
  125. /Licenses Various license files
  126. /net Networking code
  127. /post Power On Self Test
  128. /scripts Various build scripts and Makefiles
  129. /test Various unit test files
  130. /tools Tools to build and sign FIT images, etc.
  131. Software Configuration:
  132. =======================
  133. Configuration is usually done using C preprocessor defines; the
  134. rationale behind that is to avoid dead code whenever possible.
  135. There are two classes of configuration variables:
  136. * Configuration _OPTIONS_:
  137. These are selectable by the user and have names beginning with
  138. "CONFIG_".
  139. * Configuration _SETTINGS_:
  140. These depend on the hardware etc. and should not be meddled with if
  141. you don't know what you're doing; they have names beginning with
  142. "CONFIG_SYS_".
  143. Previously, all configuration was done by hand, which involved creating
  144. symbolic links and editing configuration files manually. More recently,
  145. U-Boot has added the Kbuild infrastructure used by the Linux kernel,
  146. allowing you to use the "make menuconfig" command to configure your
  147. build.
  148. Selection of Processor Architecture and Board Type:
  149. ---------------------------------------------------
  150. For all supported boards there are ready-to-use default
  151. configurations available; just type "make <board_name>_defconfig".
  152. Example: For a TQM823L module type:
  153. cd u-boot
  154. make TQM823L_defconfig
  155. Note: If you're looking for the default configuration file for a board
  156. you're sure used to be there but is now missing, check the file
  157. doc/README.scrapyard for a list of no longer supported boards.
  158. Sandbox Environment:
  159. --------------------
  160. U-Boot can be built natively to run on a Linux host using the 'sandbox'
  161. board. This allows feature development which is not board- or architecture-
  162. specific to be undertaken on a native platform. The sandbox is also used to
  163. run some of U-Boot's tests.
  164. See doc/arch/sandbox.rst for more details.
  165. Board Initialisation Flow:
  166. --------------------------
  167. This is the intended start-up flow for boards. This should apply for both
  168. SPL and U-Boot proper (i.e. they both follow the same rules).
  169. Note: "SPL" stands for "Secondary Program Loader," which is explained in
  170. more detail later in this file.
  171. At present, SPL mostly uses a separate code path, but the function names
  172. and roles of each function are the same. Some boards or architectures
  173. may not conform to this. At least most ARM boards which use
  174. CONFIG_SPL_FRAMEWORK conform to this.
  175. Execution typically starts with an architecture-specific (and possibly
  176. CPU-specific) start.S file, such as:
  177. - arch/arm/cpu/armv7/start.S
  178. - arch/powerpc/cpu/mpc83xx/start.S
  179. - arch/mips/cpu/start.S
  180. and so on. From there, three functions are called; the purpose and
  181. limitations of each of these functions are described below.
  182. lowlevel_init():
  183. - purpose: essential init to permit execution to reach board_init_f()
  184. - no global_data or BSS
  185. - there is no stack (ARMv7 may have one but it will soon be removed)
  186. - must not set up SDRAM or use console
  187. - must only do the bare minimum to allow execution to continue to
  188. board_init_f()
  189. - this is almost never needed
  190. - return normally from this function
  191. board_init_f():
  192. - purpose: set up the machine ready for running board_init_r():
  193. i.e. SDRAM and serial UART
  194. - global_data is available
  195. - stack is in SRAM
  196. - BSS is not available, so you cannot use global/static variables,
  197. only stack variables and global_data
  198. Non-SPL-specific notes:
  199. - dram_init() is called to set up DRAM. If already done in SPL this
  200. can do nothing
  201. SPL-specific notes:
  202. - you can override the entire board_init_f() function with your own
  203. version as needed.
  204. - preloader_console_init() can be called here in extremis
  205. - should set up SDRAM, and anything needed to make the UART work
  206. - there is no need to clear BSS, it will be done by crt0.S
  207. - for specific scenarios on certain architectures an early BSS *can*
  208. be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
  209. of BSS prior to entering board_init_f()) but doing so is discouraged.
  210. Instead it is strongly recommended to architect any code changes
  211. or additions such to not depend on the availability of BSS during
  212. board_init_f() as indicated in other sections of this README to
  213. maintain compatibility and consistency across the entire code base.
  214. - must return normally from this function (don't call board_init_r()
  215. directly)
  216. Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
  217. this point the stack and global_data are relocated to below
  218. CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
  219. memory.
  220. board_init_r():
  221. - purpose: main execution, common code
  222. - global_data is available
  223. - SDRAM is available
  224. - BSS is available, all static/global variables can be used
  225. - execution eventually continues to main_loop()
  226. Non-SPL-specific notes:
  227. - U-Boot is relocated to the top of memory and is now running from
  228. there.
  229. SPL-specific notes:
  230. - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
  231. CONFIG_SPL_STACK_R_ADDR points into SDRAM
  232. - preloader_console_init() can be called here - typically this is
  233. done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
  234. spl_board_init() function containing this call
  235. - loads U-Boot or (in falcon mode) Linux
  236. Configuration Options:
  237. ----------------------
  238. Configuration depends on the combination of board and CPU type; all
  239. such information is kept in a configuration file
  240. "include/configs/<board_name>.h".
  241. Example: For a TQM823L module, all configuration settings are in
  242. "include/configs/TQM823L.h".
  243. Many of the options are named exactly as the corresponding Linux
  244. kernel configuration options. The intention is to make it easier to
  245. build a config tool - later.
  246. - ARM Platform Bus Type(CCI):
  247. CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
  248. provides full cache coherency between two clusters of multi-core
  249. CPUs and I/O coherency for devices and I/O masters
  250. CONFIG_SYS_FSL_HAS_CCI400
  251. Defined For SoC that has cache coherent interconnect
  252. CCN-400
  253. CONFIG_SYS_FSL_HAS_CCN504
  254. Defined for SoC that has cache coherent interconnect CCN-504
  255. The following options need to be configured:
  256. - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
  257. - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
  258. - 85xx CPU Options:
  259. CONFIG_SYS_PPC64
  260. Specifies that the core is a 64-bit PowerPC implementation (implements
  261. the "64" category of the Power ISA). This is necessary for ePAPR
  262. compliance, among other possible reasons.
  263. CONFIG_SYS_FSL_TBCLK_DIV
  264. Defines the core time base clock divider ratio compared to the
  265. system clock. On most PQ3 devices this is 8, on newer QorIQ
  266. devices it can be 16 or 32. The ratio varies from SoC to Soc.
  267. CONFIG_SYS_FSL_PCIE_COMPAT
  268. Defines the string to utilize when trying to match PCIe device
  269. tree nodes for the given platform.
  270. CONFIG_SYS_FSL_ERRATUM_A004510
  271. Enables a workaround for erratum A004510. If set,
  272. then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
  273. CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
  274. CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
  275. CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
  276. Defines one or two SoC revisions (low 8 bits of SVR)
  277. for which the A004510 workaround should be applied.
  278. The rest of SVR is either not relevant to the decision
  279. of whether the erratum is present (e.g. p2040 versus
  280. p2041) or is implied by the build target, which controls
  281. whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
  282. See Freescale App Note 4493 for more information about
  283. this erratum.
  284. CONFIG_A003399_NOR_WORKAROUND
  285. Enables a workaround for IFC erratum A003399. It is only
  286. required during NOR boot.
  287. CONFIG_A008044_WORKAROUND
  288. Enables a workaround for T1040/T1042 erratum A008044. It is only
  289. required during NAND boot and valid for Rev 1.0 SoC revision
  290. CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
  291. This is the value to write into CCSR offset 0x18600
  292. according to the A004510 workaround.
  293. CONFIG_SYS_FSL_DSP_DDR_ADDR
  294. This value denotes start offset of DDR memory which is
  295. connected exclusively to the DSP cores.
  296. CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
  297. This value denotes start offset of M2 memory
  298. which is directly connected to the DSP core.
  299. CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
  300. This value denotes start offset of M3 memory which is directly
  301. connected to the DSP core.
  302. CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
  303. This value denotes start offset of DSP CCSR space.
  304. CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
  305. Single Source Clock is clocking mode present in some of FSL SoC's.
  306. In this mode, a single differential clock is used to supply
  307. clocks to the sysclock, ddrclock and usbclock.
  308. CONFIG_SYS_CPC_REINIT_F
  309. This CONFIG is defined when the CPC is configured as SRAM at the
  310. time of U-Boot entry and is required to be re-initialized.
  311. CONFIG_DEEP_SLEEP
  312. Indicates this SoC supports deep sleep feature. If deep sleep is
  313. supported, core will start to execute uboot when wakes up.
  314. - Generic CPU options:
  315. CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
  316. Defines the endianess of the CPU. Implementation of those
  317. values is arch specific.
  318. CONFIG_SYS_FSL_DDR
  319. Freescale DDR driver in use. This type of DDR controller is
  320. found in mpc83xx, mpc85xx as well as some ARM core SoCs.
  321. CONFIG_SYS_FSL_DDR_ADDR
  322. Freescale DDR memory-mapped register base.
  323. CONFIG_SYS_FSL_DDR_EMU
  324. Specify emulator support for DDR. Some DDR features such as
  325. deskew training are not available.
  326. CONFIG_SYS_FSL_DDRC_GEN1
  327. Freescale DDR1 controller.
  328. CONFIG_SYS_FSL_DDRC_GEN2
  329. Freescale DDR2 controller.
  330. CONFIG_SYS_FSL_DDRC_GEN3
  331. Freescale DDR3 controller.
  332. CONFIG_SYS_FSL_DDRC_GEN4
  333. Freescale DDR4 controller.
  334. CONFIG_SYS_FSL_DDRC_ARM_GEN3
  335. Freescale DDR3 controller for ARM-based SoCs.
  336. CONFIG_SYS_FSL_DDR1
  337. Board config to use DDR1. It can be enabled for SoCs with
  338. Freescale DDR1 or DDR2 controllers, depending on the board
  339. implemetation.
  340. CONFIG_SYS_FSL_DDR2
  341. Board config to use DDR2. It can be enabled for SoCs with
  342. Freescale DDR2 or DDR3 controllers, depending on the board
  343. implementation.
  344. CONFIG_SYS_FSL_DDR3
  345. Board config to use DDR3. It can be enabled for SoCs with
  346. Freescale DDR3 or DDR3L controllers.
  347. CONFIG_SYS_FSL_DDR3L
  348. Board config to use DDR3L. It can be enabled for SoCs with
  349. DDR3L controllers.
  350. CONFIG_SYS_FSL_IFC_BE
  351. Defines the IFC controller register space as Big Endian
  352. CONFIG_SYS_FSL_IFC_LE
  353. Defines the IFC controller register space as Little Endian
  354. CONFIG_SYS_FSL_IFC_CLK_DIV
  355. Defines divider of platform clock(clock input to IFC controller).
  356. CONFIG_SYS_FSL_LBC_CLK_DIV
  357. Defines divider of platform clock(clock input to eLBC controller).
  358. CONFIG_SYS_FSL_DDR_BE
  359. Defines the DDR controller register space as Big Endian
  360. CONFIG_SYS_FSL_DDR_LE
  361. Defines the DDR controller register space as Little Endian
  362. CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
  363. Physical address from the view of DDR controllers. It is the
  364. same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
  365. it could be different for ARM SoCs.
  366. CONFIG_SYS_FSL_DDR_INTLV_256B
  367. DDR controller interleaving on 256-byte. This is a special
  368. interleaving mode, handled by Dickens for Freescale layerscape
  369. SoCs with ARM core.
  370. CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
  371. Number of controllers used as main memory.
  372. CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
  373. Number of controllers used for other than main memory.
  374. CONFIG_SYS_FSL_HAS_DP_DDR
  375. Defines the SoC has DP-DDR used for DPAA.
  376. CONFIG_SYS_FSL_SEC_BE
  377. Defines the SEC controller register space as Big Endian
  378. CONFIG_SYS_FSL_SEC_LE
  379. Defines the SEC controller register space as Little Endian
  380. - MIPS CPU options:
  381. CONFIG_SYS_INIT_SP_OFFSET
  382. Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
  383. pointer. This is needed for the temporary stack before
  384. relocation.
  385. CONFIG_XWAY_SWAP_BYTES
  386. Enable compilation of tools/xway-swap-bytes needed for Lantiq
  387. XWAY SoCs for booting from NOR flash. The U-Boot image needs to
  388. be swapped if a flash programmer is used.
  389. - ARM options:
  390. CONFIG_SYS_EXCEPTION_VECTORS_HIGH
  391. Select high exception vectors of the ARM core, e.g., do not
  392. clear the V bit of the c1 register of CP15.
  393. COUNTER_FREQUENCY
  394. Generic timer clock source frequency.
  395. COUNTER_FREQUENCY_REAL
  396. Generic timer clock source frequency if the real clock is
  397. different from COUNTER_FREQUENCY, and can only be determined
  398. at run time.
  399. - Tegra SoC options:
  400. CONFIG_TEGRA_SUPPORT_NON_SECURE
  401. Support executing U-Boot in non-secure (NS) mode. Certain
  402. impossible actions will be skipped if the CPU is in NS mode,
  403. such as ARM architectural timer initialization.
  404. - Linux Kernel Interface:
  405. CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
  406. When transferring memsize parameter to Linux, some versions
  407. expect it to be in bytes, others in MB.
  408. Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
  409. CONFIG_OF_LIBFDT
  410. New kernel versions are expecting firmware settings to be
  411. passed using flattened device trees (based on open firmware
  412. concepts).
  413. CONFIG_OF_LIBFDT
  414. * New libfdt-based support
  415. * Adds the "fdt" command
  416. * The bootm command automatically updates the fdt
  417. OF_TBCLK - The timebase frequency.
  418. boards with QUICC Engines require OF_QE to set UCC MAC
  419. addresses
  420. CONFIG_OF_SYSTEM_SETUP
  421. Other code has addition modification that it wants to make
  422. to the flat device tree before handing it off to the kernel.
  423. This causes ft_system_setup() to be called before booting
  424. the kernel.
  425. CONFIG_OF_IDE_FIXUP
  426. U-Boot can detect if an IDE device is present or not.
  427. If not, and this new config option is activated, U-Boot
  428. removes the ATA node from the DTS before booting Linux,
  429. so the Linux IDE driver does not probe the device and
  430. crash. This is needed for buggy hardware (uc101) where
  431. no pull down resistor is connected to the signal IDE5V_DD7.
  432. - vxWorks boot parameters:
  433. bootvx constructs a valid bootline using the following
  434. environments variables: bootdev, bootfile, ipaddr, netmask,
  435. serverip, gatewayip, hostname, othbootargs.
  436. It loads the vxWorks image pointed bootfile.
  437. Note: If a "bootargs" environment is defined, it will override
  438. the defaults discussed just above.
  439. - Cache Configuration for ARM:
  440. CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
  441. controller
  442. CONFIG_SYS_PL310_BASE - Physical base address of PL310
  443. controller register space
  444. - Serial Ports:
  445. CONFIG_PL011_CLOCK
  446. If you have Amba PrimeCell PL011 UARTs, set this variable to
  447. the clock speed of the UARTs.
  448. CONFIG_PL01x_PORTS
  449. If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
  450. define this to a list of base addresses for each (supported)
  451. port. See e.g. include/configs/versatile.h
  452. CONFIG_SERIAL_HW_FLOW_CONTROL
  453. Define this variable to enable hw flow control in serial driver.
  454. Current user of this option is drivers/serial/nsl16550.c driver
  455. - Serial Download Echo Mode:
  456. CONFIG_LOADS_ECHO
  457. If defined to 1, all characters received during a
  458. serial download (using the "loads" command) are
  459. echoed back. This might be needed by some terminal
  460. emulations (like "cu"), but may as well just take
  461. time on others. This setting #define's the initial
  462. value of the "loads_echo" environment variable.
  463. - Removal of commands
  464. If no commands are needed to boot, you can disable
  465. CONFIG_CMDLINE to remove them. In this case, the command line
  466. will not be available, and when U-Boot wants to execute the
  467. boot command (on start-up) it will call board_run_command()
  468. instead. This can reduce image size significantly for very
  469. simple boot procedures.
  470. - Regular expression support:
  471. CONFIG_REGEX
  472. If this variable is defined, U-Boot is linked against
  473. the SLRE (Super Light Regular Expression) library,
  474. which adds regex support to some commands, as for
  475. example "env grep" and "setexpr".
  476. - Watchdog:
  477. CONFIG_SYS_WATCHDOG_FREQ
  478. Some platforms automatically call WATCHDOG_RESET()
  479. from the timer interrupt handler every
  480. CONFIG_SYS_WATCHDOG_FREQ interrupts. If not set by the
  481. board configuration file, a default of CONFIG_SYS_HZ/2
  482. (i.e. 500) is used. Setting CONFIG_SYS_WATCHDOG_FREQ
  483. to 0 disables calling WATCHDOG_RESET() from the timer
  484. interrupt.
  485. - Real-Time Clock:
  486. When CONFIG_CMD_DATE is selected, the type of the RTC
  487. has to be selected, too. Define exactly one of the
  488. following options:
  489. CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
  490. CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
  491. CONFIG_RTC_MC146818 - use MC146818 RTC
  492. CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
  493. CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
  494. CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
  495. CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
  496. CONFIG_RTC_DS164x - use Dallas DS164x RTC
  497. CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
  498. CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
  499. CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
  500. CONFIG_SYS_RV3029_TCR - enable trickle charger on
  501. RV3029 RTC.
  502. Note that if the RTC uses I2C, then the I2C interface
  503. must also be configured. See I2C Support, below.
  504. - GPIO Support:
  505. CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
  506. The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
  507. chip-ngpio pairs that tell the PCA953X driver the number of
  508. pins supported by a particular chip.
  509. Note that if the GPIO device uses I2C, then the I2C interface
  510. must also be configured. See I2C Support, below.
  511. - I/O tracing:
  512. When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
  513. accesses and can checksum them or write a list of them out
  514. to memory. See the 'iotrace' command for details. This is
  515. useful for testing device drivers since it can confirm that
  516. the driver behaves the same way before and after a code
  517. change. Currently this is supported on sandbox and arm. To
  518. add support for your architecture, add '#include <iotrace.h>'
  519. to the bottom of arch/<arch>/include/asm/io.h and test.
  520. Example output from the 'iotrace stats' command is below.
  521. Note that if the trace buffer is exhausted, the checksum will
  522. still continue to operate.
  523. iotrace is enabled
  524. Start: 10000000 (buffer start address)
  525. Size: 00010000 (buffer size)
  526. Offset: 00000120 (current buffer offset)
  527. Output: 10000120 (start + offset)
  528. Count: 00000018 (number of trace records)
  529. CRC32: 9526fb66 (CRC32 of all trace records)
  530. - Timestamp Support:
  531. When CONFIG_TIMESTAMP is selected, the timestamp
  532. (date and time) of an image is printed by image
  533. commands like bootm or iminfo. This option is
  534. automatically enabled when you select CONFIG_CMD_DATE .
  535. - Partition Labels (disklabels) Supported:
  536. Zero or more of the following:
  537. CONFIG_MAC_PARTITION Apple's MacOS partition table.
  538. CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
  539. CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
  540. bootloader. Note 2TB partition limit; see
  541. disk/part_efi.c
  542. CONFIG_SCSI) you must configure support for at
  543. least one non-MTD partition type as well.
  544. - LBA48 Support
  545. CONFIG_LBA48
  546. Set this to enable support for disks larger than 137GB
  547. Also look at CONFIG_SYS_64BIT_LBA.
  548. Whithout these , LBA48 support uses 32bit variables and will 'only'
  549. support disks up to 2.1TB.
  550. CONFIG_SYS_64BIT_LBA:
  551. When enabled, makes the IDE subsystem use 64bit sector addresses.
  552. Default is 32bit.
  553. - NETWORK Support (PCI):
  554. CONFIG_E1000_SPI
  555. Utility code for direct access to the SPI bus on Intel 8257x.
  556. This does not do anything useful unless you set at least one
  557. of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
  558. CONFIG_NATSEMI
  559. Support for National dp83815 chips.
  560. CONFIG_NS8382X
  561. Support for National dp8382[01] gigabit chips.
  562. - NETWORK Support (other):
  563. CONFIG_CALXEDA_XGMAC
  564. Support for the Calxeda XGMAC device
  565. CONFIG_LAN91C96
  566. Support for SMSC's LAN91C96 chips.
  567. CONFIG_LAN91C96_USE_32_BIT
  568. Define this to enable 32 bit addressing
  569. CONFIG_SMC91111
  570. Support for SMSC's LAN91C111 chip
  571. CONFIG_SMC91111_BASE
  572. Define this to hold the physical address
  573. of the device (I/O space)
  574. CONFIG_SMC_USE_32_BIT
  575. Define this if data bus is 32 bits
  576. CONFIG_SMC_USE_IOFUNCS
  577. Define this to use i/o functions instead of macros
  578. (some hardware wont work with macros)
  579. CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
  580. Define this if you have more then 3 PHYs.
  581. CONFIG_FTGMAC100
  582. Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
  583. CONFIG_FTGMAC100_EGIGA
  584. Define this to use GE link update with gigabit PHY.
  585. Define this if FTGMAC100 is connected to gigabit PHY.
  586. If your system has 10/100 PHY only, it might not occur
  587. wrong behavior. Because PHY usually return timeout or
  588. useless data when polling gigabit status and gigabit
  589. control registers. This behavior won't affect the
  590. correctnessof 10/100 link speed update.
  591. CONFIG_SH_ETHER
  592. Support for Renesas on-chip Ethernet controller
  593. CONFIG_SH_ETHER_USE_PORT
  594. Define the number of ports to be used
  595. CONFIG_SH_ETHER_PHY_ADDR
  596. Define the ETH PHY's address
  597. CONFIG_SH_ETHER_CACHE_WRITEBACK
  598. If this option is set, the driver enables cache flush.
  599. - TPM Support:
  600. CONFIG_TPM
  601. Support TPM devices.
  602. CONFIG_TPM_TIS_INFINEON
  603. Support for Infineon i2c bus TPM devices. Only one device
  604. per system is supported at this time.
  605. CONFIG_TPM_TIS_I2C_BURST_LIMITATION
  606. Define the burst count bytes upper limit
  607. CONFIG_TPM_ST33ZP24
  608. Support for STMicroelectronics TPM devices. Requires DM_TPM support.
  609. CONFIG_TPM_ST33ZP24_I2C
  610. Support for STMicroelectronics ST33ZP24 I2C devices.
  611. Requires TPM_ST33ZP24 and I2C.
  612. CONFIG_TPM_ST33ZP24_SPI
  613. Support for STMicroelectronics ST33ZP24 SPI devices.
  614. Requires TPM_ST33ZP24 and SPI.
  615. CONFIG_TPM_ATMEL_TWI
  616. Support for Atmel TWI TPM device. Requires I2C support.
  617. CONFIG_TPM_TIS_LPC
  618. Support for generic parallel port TPM devices. Only one device
  619. per system is supported at this time.
  620. CONFIG_TPM_TIS_BASE_ADDRESS
  621. Base address where the generic TPM device is mapped
  622. to. Contemporary x86 systems usually map it at
  623. 0xfed40000.
  624. CONFIG_TPM
  625. Define this to enable the TPM support library which provides
  626. functional interfaces to some TPM commands.
  627. Requires support for a TPM device.
  628. CONFIG_TPM_AUTH_SESSIONS
  629. Define this to enable authorized functions in the TPM library.
  630. Requires CONFIG_TPM and CONFIG_SHA1.
  631. - USB Support:
  632. At the moment only the UHCI host controller is
  633. supported (PIP405, MIP405); define
  634. CONFIG_USB_UHCI to enable it.
  635. define CONFIG_USB_KEYBOARD to enable the USB Keyboard
  636. and define CONFIG_USB_STORAGE to enable the USB
  637. storage devices.
  638. Note:
  639. Supported are USB Keyboards and USB Floppy drives
  640. (TEAC FD-05PUB).
  641. CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
  642. txfilltuning field in the EHCI controller on reset.
  643. CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
  644. HW module registers.
  645. - USB Device:
  646. Define the below if you wish to use the USB console.
  647. Once firmware is rebuilt from a serial console issue the
  648. command "setenv stdin usbtty; setenv stdout usbtty" and
  649. attach your USB cable. The Unix command "dmesg" should print
  650. it has found a new device. The environment variable usbtty
  651. can be set to gserial or cdc_acm to enable your device to
  652. appear to a USB host as a Linux gserial device or a
  653. Common Device Class Abstract Control Model serial device.
  654. If you select usbtty = gserial you should be able to enumerate
  655. a Linux host by
  656. # modprobe usbserial vendor=0xVendorID product=0xProductID
  657. else if using cdc_acm, simply setting the environment
  658. variable usbtty to be cdc_acm should suffice. The following
  659. might be defined in YourBoardName.h
  660. CONFIG_USB_DEVICE
  661. Define this to build a UDC device
  662. CONFIG_USB_TTY
  663. Define this to have a tty type of device available to
  664. talk to the UDC device
  665. CONFIG_USBD_HS
  666. Define this to enable the high speed support for usb
  667. device and usbtty. If this feature is enabled, a routine
  668. int is_usbd_high_speed(void)
  669. also needs to be defined by the driver to dynamically poll
  670. whether the enumeration has succeded at high speed or full
  671. speed.
  672. If you have a USB-IF assigned VendorID then you may wish to
  673. define your own vendor specific values either in BoardName.h
  674. or directly in usbd_vendor_info.h. If you don't define
  675. CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
  676. CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
  677. should pretend to be a Linux device to it's target host.
  678. CONFIG_USBD_MANUFACTURER
  679. Define this string as the name of your company for
  680. - CONFIG_USBD_MANUFACTURER "my company"
  681. CONFIG_USBD_PRODUCT_NAME
  682. Define this string as the name of your product
  683. - CONFIG_USBD_PRODUCT_NAME "acme usb device"
  684. CONFIG_USBD_VENDORID
  685. Define this as your assigned Vendor ID from the USB
  686. Implementors Forum. This *must* be a genuine Vendor ID
  687. to avoid polluting the USB namespace.
  688. - CONFIG_USBD_VENDORID 0xFFFF
  689. CONFIG_USBD_PRODUCTID
  690. Define this as the unique Product ID
  691. for your device
  692. - CONFIG_USBD_PRODUCTID 0xFFFF
  693. - ULPI Layer Support:
  694. The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
  695. the generic ULPI layer. The generic layer accesses the ULPI PHY
  696. via the platform viewport, so you need both the genric layer and
  697. the viewport enabled. Currently only Chipidea/ARC based
  698. viewport is supported.
  699. To enable the ULPI layer support, define CONFIG_USB_ULPI and
  700. CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
  701. If your ULPI phy needs a different reference clock than the
  702. standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
  703. the appropriate value in Hz.
  704. - MMC Support:
  705. The MMC controller on the Intel PXA is supported. To
  706. enable this define CONFIG_MMC. The MMC can be
  707. accessed from the boot prompt by mapping the device
  708. to physical memory similar to flash. Command line is
  709. enabled with CONFIG_CMD_MMC. The MMC driver also works with
  710. the FAT fs. This is enabled with CONFIG_CMD_FAT.
  711. CONFIG_SH_MMCIF
  712. Support for Renesas on-chip MMCIF controller
  713. CONFIG_SH_MMCIF_ADDR
  714. Define the base address of MMCIF registers
  715. CONFIG_SH_MMCIF_CLK
  716. Define the clock frequency for MMCIF
  717. - USB Device Firmware Update (DFU) class support:
  718. CONFIG_DFU_OVER_USB
  719. This enables the USB portion of the DFU USB class
  720. CONFIG_DFU_NAND
  721. This enables support for exposing NAND devices via DFU.
  722. CONFIG_DFU_RAM
  723. This enables support for exposing RAM via DFU.
  724. Note: DFU spec refer to non-volatile memory usage, but
  725. allow usages beyond the scope of spec - here RAM usage,
  726. one that would help mostly the developer.
  727. CONFIG_SYS_DFU_DATA_BUF_SIZE
  728. Dfu transfer uses a buffer before writing data to the
  729. raw storage device. Make the size (in bytes) of this buffer
  730. configurable. The size of this buffer is also configurable
  731. through the "dfu_bufsiz" environment variable.
  732. CONFIG_SYS_DFU_MAX_FILE_SIZE
  733. When updating files rather than the raw storage device,
  734. we use a static buffer to copy the file into and then write
  735. the buffer once we've been given the whole file. Define
  736. this to the maximum filesize (in bytes) for the buffer.
  737. Default is 4 MiB if undefined.
  738. DFU_DEFAULT_POLL_TIMEOUT
  739. Poll timeout [ms], is the timeout a device can send to the
  740. host. The host must wait for this timeout before sending
  741. a subsequent DFU_GET_STATUS request to the device.
  742. DFU_MANIFEST_POLL_TIMEOUT
  743. Poll timeout [ms], which the device sends to the host when
  744. entering dfuMANIFEST state. Host waits this timeout, before
  745. sending again an USB request to the device.
  746. - Journaling Flash filesystem support:
  747. CONFIG_SYS_JFFS2_FIRST_SECTOR,
  748. CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
  749. Define these for a default partition on a NOR device
  750. - Keyboard Support:
  751. See Kconfig help for available keyboard drivers.
  752. - Video support:
  753. CONFIG_FSL_DIU_FB
  754. Enable the Freescale DIU video driver. Reference boards for
  755. SOCs that have a DIU should define this macro to enable DIU
  756. support, and should also define these other macros:
  757. CONFIG_SYS_DIU_ADDR
  758. CONFIG_VIDEO
  759. CONFIG_CFB_CONSOLE
  760. CONFIG_VIDEO_SW_CURSOR
  761. CONFIG_VGA_AS_SINGLE_DEVICE
  762. CONFIG_VIDEO_BMP_LOGO
  763. The DIU driver will look for the 'video-mode' environment
  764. variable, and if defined, enable the DIU as a console during
  765. boot. See the documentation file doc/README.video for a
  766. description of this variable.
  767. - LCD Support: CONFIG_LCD
  768. Define this to enable LCD support (for output to LCD
  769. display); also select one of the supported displays
  770. by defining one of these:
  771. CONFIG_ATMEL_LCD:
  772. HITACHI TX09D70VM1CCA, 3.5", 240x320.
  773. CONFIG_NEC_NL6448AC33:
  774. NEC NL6448AC33-18. Active, color, single scan.
  775. CONFIG_NEC_NL6448BC20
  776. NEC NL6448BC20-08. 6.5", 640x480.
  777. Active, color, single scan.
  778. CONFIG_NEC_NL6448BC33_54
  779. NEC NL6448BC33-54. 10.4", 640x480.
  780. Active, color, single scan.
  781. CONFIG_SHARP_16x9
  782. Sharp 320x240. Active, color, single scan.
  783. It isn't 16x9, and I am not sure what it is.
  784. CONFIG_SHARP_LQ64D341
  785. Sharp LQ64D341 display, 640x480.
  786. Active, color, single scan.
  787. CONFIG_HLD1045
  788. HLD1045 display, 640x480.
  789. Active, color, single scan.
  790. CONFIG_OPTREX_BW
  791. Optrex CBL50840-2 NF-FW 99 22 M5
  792. or
  793. Hitachi LMG6912RPFC-00T
  794. or
  795. Hitachi SP14Q002
  796. 320x240. Black & white.
  797. CONFIG_LCD_ALIGNMENT
  798. Normally the LCD is page-aligned (typically 4KB). If this is
  799. defined then the LCD will be aligned to this value instead.
  800. For ARM it is sometimes useful to use MMU_SECTION_SIZE
  801. here, since it is cheaper to change data cache settings on
  802. a per-section basis.
  803. CONFIG_LCD_ROTATION
  804. Sometimes, for example if the display is mounted in portrait
  805. mode or even if it's mounted landscape but rotated by 180degree,
  806. we need to rotate our content of the display relative to the
  807. framebuffer, so that user can read the messages which are
  808. printed out.
  809. Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
  810. initialized with a given rotation from "vl_rot" out of
  811. "vidinfo_t" which is provided by the board specific code.
  812. The value for vl_rot is coded as following (matching to
  813. fbcon=rotate:<n> linux-kernel commandline):
  814. 0 = no rotation respectively 0 degree
  815. 1 = 90 degree rotation
  816. 2 = 180 degree rotation
  817. 3 = 270 degree rotation
  818. If CONFIG_LCD_ROTATION is not defined, the console will be
  819. initialized with 0degree rotation.
  820. CONFIG_LCD_BMP_RLE8
  821. Support drawing of RLE8-compressed bitmaps on the LCD.
  822. - MII/PHY support:
  823. CONFIG_PHY_CLOCK_FREQ (ppc4xx)
  824. The clock frequency of the MII bus
  825. CONFIG_PHY_RESET_DELAY
  826. Some PHY like Intel LXT971A need extra delay after
  827. reset before any MII register access is possible.
  828. For such PHY, set this option to the usec delay
  829. required. (minimum 300usec for LXT971A)
  830. CONFIG_PHY_CMD_DELAY (ppc4xx)
  831. Some PHY like Intel LXT971A need extra delay after
  832. command issued before MII status register can be read
  833. - IP address:
  834. CONFIG_IPADDR
  835. Define a default value for the IP address to use for
  836. the default Ethernet interface, in case this is not
  837. determined through e.g. bootp.
  838. (Environment variable "ipaddr")
  839. - Server IP address:
  840. CONFIG_SERVERIP
  841. Defines a default value for the IP address of a TFTP
  842. server to contact when using the "tftboot" command.
  843. (Environment variable "serverip")
  844. - Gateway IP address:
  845. CONFIG_GATEWAYIP
  846. Defines a default value for the IP address of the
  847. default router where packets to other networks are
  848. sent to.
  849. (Environment variable "gatewayip")
  850. - Subnet mask:
  851. CONFIG_NETMASK
  852. Defines a default value for the subnet mask (or
  853. routing prefix) which is used to determine if an IP
  854. address belongs to the local subnet or needs to be
  855. forwarded through a router.
  856. (Environment variable "netmask")
  857. - BOOTP Recovery Mode:
  858. CONFIG_BOOTP_RANDOM_DELAY
  859. If you have many targets in a network that try to
  860. boot using BOOTP, you may want to avoid that all
  861. systems send out BOOTP requests at precisely the same
  862. moment (which would happen for instance at recovery
  863. from a power failure, when all systems will try to
  864. boot, thus flooding the BOOTP server. Defining
  865. CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
  866. inserted before sending out BOOTP requests. The
  867. following delays are inserted then:
  868. 1st BOOTP request: delay 0 ... 1 sec
  869. 2nd BOOTP request: delay 0 ... 2 sec
  870. 3rd BOOTP request: delay 0 ... 4 sec
  871. 4th and following
  872. BOOTP requests: delay 0 ... 8 sec
  873. CONFIG_BOOTP_ID_CACHE_SIZE
  874. BOOTP packets are uniquely identified using a 32-bit ID. The
  875. server will copy the ID from client requests to responses and
  876. U-Boot will use this to determine if it is the destination of
  877. an incoming response. Some servers will check that addresses
  878. aren't in use before handing them out (usually using an ARP
  879. ping) and therefore take up to a few hundred milliseconds to
  880. respond. Network congestion may also influence the time it
  881. takes for a response to make it back to the client. If that
  882. time is too long, U-Boot will retransmit requests. In order
  883. to allow earlier responses to still be accepted after these
  884. retransmissions, U-Boot's BOOTP client keeps a small cache of
  885. IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
  886. cache. The default is to keep IDs for up to four outstanding
  887. requests. Increasing this will allow U-Boot to accept offers
  888. from a BOOTP client in networks with unusually high latency.
  889. - DHCP Advanced Options:
  890. You can fine tune the DHCP functionality by defining
  891. CONFIG_BOOTP_* symbols:
  892. CONFIG_BOOTP_NISDOMAIN
  893. CONFIG_BOOTP_BOOTFILESIZE
  894. CONFIG_BOOTP_NTPSERVER
  895. CONFIG_BOOTP_TIMEOFFSET
  896. CONFIG_BOOTP_VENDOREX
  897. CONFIG_BOOTP_MAY_FAIL
  898. CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
  899. after the configured retry count, the call will fail
  900. instead of starting over. This can be used to fail over
  901. to Link-local IP address configuration if the DHCP server
  902. is not available.
  903. CONFIG_BOOTP_DHCP_REQUEST_DELAY
  904. A 32bit value in microseconds for a delay between
  905. receiving a "DHCP Offer" and sending the "DHCP Request".
  906. This fixes a problem with certain DHCP servers that don't
  907. respond 100% of the time to a "DHCP request". E.g. On an
  908. AT91RM9200 processor running at 180MHz, this delay needed
  909. to be *at least* 15,000 usec before a Windows Server 2003
  910. DHCP server would reply 100% of the time. I recommend at
  911. least 50,000 usec to be safe. The alternative is to hope
  912. that one of the retries will be successful but note that
  913. the DHCP timeout and retry process takes a longer than
  914. this delay.
  915. - Link-local IP address negotiation:
  916. Negotiate with other link-local clients on the local network
  917. for an address that doesn't require explicit configuration.
  918. This is especially useful if a DHCP server cannot be guaranteed
  919. to exist in all environments that the device must operate.
  920. See doc/README.link-local for more information.
  921. - MAC address from environment variables
  922. FDT_SEQ_MACADDR_FROM_ENV
  923. Fix-up device tree with MAC addresses fetched sequentially from
  924. environment variables. This config work on assumption that
  925. non-usable ethernet node of device-tree are either not present
  926. or their status has been marked as "disabled".
  927. - CDP Options:
  928. CONFIG_CDP_DEVICE_ID
  929. The device id used in CDP trigger frames.
  930. CONFIG_CDP_DEVICE_ID_PREFIX
  931. A two character string which is prefixed to the MAC address
  932. of the device.
  933. CONFIG_CDP_PORT_ID
  934. A printf format string which contains the ascii name of
  935. the port. Normally is set to "eth%d" which sets
  936. eth0 for the first Ethernet, eth1 for the second etc.
  937. CONFIG_CDP_CAPABILITIES
  938. A 32bit integer which indicates the device capabilities;
  939. 0x00000010 for a normal host which does not forwards.
  940. CONFIG_CDP_VERSION
  941. An ascii string containing the version of the software.
  942. CONFIG_CDP_PLATFORM
  943. An ascii string containing the name of the platform.
  944. CONFIG_CDP_TRIGGER
  945. A 32bit integer sent on the trigger.
  946. CONFIG_CDP_POWER_CONSUMPTION
  947. A 16bit integer containing the power consumption of the
  948. device in .1 of milliwatts.
  949. CONFIG_CDP_APPLIANCE_VLAN_TYPE
  950. A byte containing the id of the VLAN.
  951. - Status LED: CONFIG_LED_STATUS
  952. Several configurations allow to display the current
  953. status using a LED. For instance, the LED will blink
  954. fast while running U-Boot code, stop blinking as
  955. soon as a reply to a BOOTP request was received, and
  956. start blinking slow once the Linux kernel is running
  957. (supported by a status LED driver in the Linux
  958. kernel). Defining CONFIG_LED_STATUS enables this
  959. feature in U-Boot.
  960. Additional options:
  961. CONFIG_LED_STATUS_GPIO
  962. The status LED can be connected to a GPIO pin.
  963. In such cases, the gpio_led driver can be used as a
  964. status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
  965. to include the gpio_led driver in the U-Boot binary.
  966. CONFIG_GPIO_LED_INVERTED_TABLE
  967. Some GPIO connected LEDs may have inverted polarity in which
  968. case the GPIO high value corresponds to LED off state and
  969. GPIO low value corresponds to LED on state.
  970. In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
  971. with a list of GPIO LEDs that have inverted polarity.
  972. - I2C Support:
  973. CONFIG_SYS_NUM_I2C_BUSES
  974. Hold the number of i2c buses you want to use.
  975. CONFIG_SYS_I2C_DIRECT_BUS
  976. define this, if you don't use i2c muxes on your hardware.
  977. if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
  978. omit this define.
  979. CONFIG_SYS_I2C_MAX_HOPS
  980. define how many muxes are maximal consecutively connected
  981. on one i2c bus. If you not use i2c muxes, omit this
  982. define.
  983. CONFIG_SYS_I2C_BUSES
  984. hold a list of buses you want to use, only used if
  985. CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
  986. a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
  987. CONFIG_SYS_NUM_I2C_BUSES = 9:
  988. CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
  989. {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
  990. {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
  991. {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
  992. {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
  993. {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
  994. {1, {I2C_NULL_HOP}}, \
  995. {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
  996. {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
  997. }
  998. which defines
  999. bus 0 on adapter 0 without a mux
  1000. bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
  1001. bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
  1002. bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
  1003. bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
  1004. bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
  1005. bus 6 on adapter 1 without a mux
  1006. bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
  1007. bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
  1008. If you do not have i2c muxes on your board, omit this define.
  1009. - Legacy I2C Support:
  1010. If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
  1011. then the following macros need to be defined (examples are
  1012. from include/configs/lwmon.h):
  1013. I2C_INIT
  1014. (Optional). Any commands necessary to enable the I2C
  1015. controller or configure ports.
  1016. eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
  1017. I2C_ACTIVE
  1018. The code necessary to make the I2C data line active
  1019. (driven). If the data line is open collector, this
  1020. define can be null.
  1021. eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
  1022. I2C_TRISTATE
  1023. The code necessary to make the I2C data line tri-stated
  1024. (inactive). If the data line is open collector, this
  1025. define can be null.
  1026. eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
  1027. I2C_READ
  1028. Code that returns true if the I2C data line is high,
  1029. false if it is low.
  1030. eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
  1031. I2C_SDA(bit)
  1032. If <bit> is true, sets the I2C data line high. If it
  1033. is false, it clears it (low).
  1034. eg: #define I2C_SDA(bit) \
  1035. if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
  1036. else immr->im_cpm.cp_pbdat &= ~PB_SDA
  1037. I2C_SCL(bit)
  1038. If <bit> is true, sets the I2C clock line high. If it
  1039. is false, it clears it (low).
  1040. eg: #define I2C_SCL(bit) \
  1041. if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
  1042. else immr->im_cpm.cp_pbdat &= ~PB_SCL
  1043. I2C_DELAY
  1044. This delay is invoked four times per clock cycle so this
  1045. controls the rate of data transfer. The data rate thus
  1046. is 1 / (I2C_DELAY * 4). Often defined to be something
  1047. like:
  1048. #define I2C_DELAY udelay(2)
  1049. CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
  1050. If your arch supports the generic GPIO framework (asm/gpio.h),
  1051. then you may alternatively define the two GPIOs that are to be
  1052. used as SCL / SDA. Any of the previous I2C_xxx macros will
  1053. have GPIO-based defaults assigned to them as appropriate.
  1054. You should define these to the GPIO value as given directly to
  1055. the generic GPIO functions.
  1056. CONFIG_SYS_I2C_INIT_BOARD
  1057. When a board is reset during an i2c bus transfer
  1058. chips might think that the current transfer is still
  1059. in progress. On some boards it is possible to access
  1060. the i2c SCLK line directly, either by using the
  1061. processor pin as a GPIO or by having a second pin
  1062. connected to the bus. If this option is defined a
  1063. custom i2c_init_board() routine in boards/xxx/board.c
  1064. is run early in the boot sequence.
  1065. CONFIG_I2C_MULTI_BUS
  1066. This option allows the use of multiple I2C buses, each of which
  1067. must have a controller. At any point in time, only one bus is
  1068. active. To switch to a different bus, use the 'i2c dev' command.
  1069. Note that bus numbering is zero-based.
  1070. CONFIG_SYS_I2C_NOPROBES
  1071. This option specifies a list of I2C devices that will be skipped
  1072. when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
  1073. is set, specify a list of bus-device pairs. Otherwise, specify
  1074. a 1D array of device addresses
  1075. e.g.
  1076. #undef CONFIG_I2C_MULTI_BUS
  1077. #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
  1078. will skip addresses 0x50 and 0x68 on a board with one I2C bus
  1079. #define CONFIG_I2C_MULTI_BUS
  1080. #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
  1081. will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
  1082. CONFIG_SYS_SPD_BUS_NUM
  1083. If defined, then this indicates the I2C bus number for DDR SPD.
  1084. If not defined, then U-Boot assumes that SPD is on I2C bus 0.
  1085. CONFIG_SYS_RTC_BUS_NUM
  1086. If defined, then this indicates the I2C bus number for the RTC.
  1087. If not defined, then U-Boot assumes that RTC is on I2C bus 0.
  1088. CONFIG_SOFT_I2C_READ_REPEATED_START
  1089. defining this will force the i2c_read() function in
  1090. the soft_i2c driver to perform an I2C repeated start
  1091. between writing the address pointer and reading the
  1092. data. If this define is omitted the default behaviour
  1093. of doing a stop-start sequence will be used. Most I2C
  1094. devices can use either method, but some require one or
  1095. the other.
  1096. - SPI Support: CONFIG_SPI
  1097. Enables SPI driver (so far only tested with
  1098. SPI EEPROM, also an instance works with Crystal A/D and
  1099. D/As on the SACSng board)
  1100. CONFIG_SYS_SPI_MXC_WAIT
  1101. Timeout for waiting until spi transfer completed.
  1102. default: (CONFIG_SYS_HZ/100) /* 10 ms */
  1103. - FPGA Support: CONFIG_FPGA
  1104. Enables FPGA subsystem.
  1105. CONFIG_FPGA_<vendor>
  1106. Enables support for specific chip vendors.
  1107. (ALTERA, XILINX)
  1108. CONFIG_FPGA_<family>
  1109. Enables support for FPGA family.
  1110. (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
  1111. CONFIG_FPGA_COUNT
  1112. Specify the number of FPGA devices to support.
  1113. CONFIG_SYS_FPGA_PROG_FEEDBACK
  1114. Enable printing of hash marks during FPGA configuration.
  1115. CONFIG_SYS_FPGA_CHECK_BUSY
  1116. Enable checks on FPGA configuration interface busy
  1117. status by the configuration function. This option
  1118. will require a board or device specific function to
  1119. be written.
  1120. CONFIG_FPGA_DELAY
  1121. If defined, a function that provides delays in the FPGA
  1122. configuration driver.
  1123. CONFIG_SYS_FPGA_CHECK_CTRLC
  1124. Allow Control-C to interrupt FPGA configuration
  1125. CONFIG_SYS_FPGA_CHECK_ERROR
  1126. Check for configuration errors during FPGA bitfile
  1127. loading. For example, abort during Virtex II
  1128. configuration if the INIT_B line goes low (which
  1129. indicated a CRC error).
  1130. CONFIG_SYS_FPGA_WAIT_INIT
  1131. Maximum time to wait for the INIT_B line to de-assert
  1132. after PROB_B has been de-asserted during a Virtex II
  1133. FPGA configuration sequence. The default time is 500
  1134. ms.
  1135. CONFIG_SYS_FPGA_WAIT_BUSY
  1136. Maximum time to wait for BUSY to de-assert during
  1137. Virtex II FPGA configuration. The default is 5 ms.
  1138. CONFIG_SYS_FPGA_WAIT_CONFIG
  1139. Time to wait after FPGA configuration. The default is
  1140. 200 ms.
  1141. - Vendor Parameter Protection:
  1142. U-Boot considers the values of the environment
  1143. variables "serial#" (Board Serial Number) and
  1144. "ethaddr" (Ethernet Address) to be parameters that
  1145. are set once by the board vendor / manufacturer, and
  1146. protects these variables from casual modification by
  1147. the user. Once set, these variables are read-only,
  1148. and write or delete attempts are rejected. You can
  1149. change this behaviour:
  1150. If CONFIG_ENV_OVERWRITE is #defined in your config
  1151. file, the write protection for vendor parameters is
  1152. completely disabled. Anybody can change or delete
  1153. these parameters.
  1154. Alternatively, if you define _both_ an ethaddr in the
  1155. default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
  1156. Ethernet address is installed in the environment,
  1157. which can be changed exactly ONCE by the user. [The
  1158. serial# is unaffected by this, i. e. it remains
  1159. read-only.]
  1160. The same can be accomplished in a more flexible way
  1161. for any variable by configuring the type of access
  1162. to allow for those variables in the ".flags" variable
  1163. or define CONFIG_ENV_FLAGS_LIST_STATIC.
  1164. - Protected RAM:
  1165. CONFIG_PRAM
  1166. Define this variable to enable the reservation of
  1167. "protected RAM", i. e. RAM which is not overwritten
  1168. by U-Boot. Define CONFIG_PRAM to hold the number of
  1169. kB you want to reserve for pRAM. You can overwrite
  1170. this default value by defining an environment
  1171. variable "pram" to the number of kB you want to
  1172. reserve. Note that the board info structure will
  1173. still show the full amount of RAM. If pRAM is
  1174. reserved, a new environment variable "mem" will
  1175. automatically be defined to hold the amount of
  1176. remaining RAM in a form that can be passed as boot
  1177. argument to Linux, for instance like that:
  1178. setenv bootargs ... mem=\${mem}
  1179. saveenv
  1180. This way you can tell Linux not to use this memory,
  1181. either, which results in a memory region that will
  1182. not be affected by reboots.
  1183. *WARNING* If your board configuration uses automatic
  1184. detection of the RAM size, you must make sure that
  1185. this memory test is non-destructive. So far, the
  1186. following board configurations are known to be
  1187. "pRAM-clean":
  1188. IVMS8, IVML24, SPD8xx,
  1189. HERMES, IP860, RPXlite, LWMON,
  1190. FLAGADM
  1191. - Error Recovery:
  1192. CONFIG_NET_RETRY_COUNT
  1193. This variable defines the number of retries for
  1194. network operations like ARP, RARP, TFTP, or BOOTP
  1195. before giving up the operation. If not defined, a
  1196. default value of 5 is used.
  1197. CONFIG_ARP_TIMEOUT
  1198. Timeout waiting for an ARP reply in milliseconds.
  1199. CONFIG_NFS_TIMEOUT
  1200. Timeout in milliseconds used in NFS protocol.
  1201. If you encounter "ERROR: Cannot umount" in nfs command,
  1202. try longer timeout such as
  1203. #define CONFIG_NFS_TIMEOUT 10000UL
  1204. Note:
  1205. In the current implementation, the local variables
  1206. space and global environment variables space are
  1207. separated. Local variables are those you define by
  1208. simply typing `name=value'. To access a local
  1209. variable later on, you have write `$name' or
  1210. `${name}'; to execute the contents of a variable
  1211. directly type `$name' at the command prompt.
  1212. Global environment variables are those you use
  1213. setenv/printenv to work with. To run a command stored
  1214. in such a variable, you need to use the run command,
  1215. and you must not use the '$' sign to access them.
  1216. To store commands and special characters in a
  1217. variable, please use double quotation marks
  1218. surrounding the whole text of the variable, instead
  1219. of the backslashes before semicolons and special
  1220. symbols.
  1221. - Command Line Editing and History:
  1222. CONFIG_CMDLINE_PS_SUPPORT
  1223. Enable support for changing the command prompt string
  1224. at run-time. Only static string is supported so far.
  1225. The string is obtained from environment variables PS1
  1226. and PS2.
  1227. - Default Environment:
  1228. CONFIG_EXTRA_ENV_SETTINGS
  1229. Define this to contain any number of null terminated
  1230. strings (variable = value pairs) that will be part of
  1231. the default environment compiled into the boot image.
  1232. For example, place something like this in your
  1233. board's config file:
  1234. #define CONFIG_EXTRA_ENV_SETTINGS \
  1235. "myvar1=value1\0" \
  1236. "myvar2=value2\0"
  1237. Warning: This method is based on knowledge about the
  1238. internal format how the environment is stored by the
  1239. U-Boot code. This is NOT an official, exported
  1240. interface! Although it is unlikely that this format
  1241. will change soon, there is no guarantee either.
  1242. You better know what you are doing here.
  1243. Note: overly (ab)use of the default environment is
  1244. discouraged. Make sure to check other ways to preset
  1245. the environment like the "source" command or the
  1246. boot command first.
  1247. CONFIG_DELAY_ENVIRONMENT
  1248. Normally the environment is loaded when the board is
  1249. initialised so that it is available to U-Boot. This inhibits
  1250. that so that the environment is not available until
  1251. explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
  1252. this is instead controlled by the value of
  1253. /config/load-environment.
  1254. - TFTP Fixed UDP Port:
  1255. CONFIG_TFTP_PORT
  1256. If this is defined, the environment variable tftpsrcp
  1257. is used to supply the TFTP UDP source port value.
  1258. If tftpsrcp isn't defined, the normal pseudo-random port
  1259. number generator is used.
  1260. Also, the environment variable tftpdstp is used to supply
  1261. the TFTP UDP destination port value. If tftpdstp isn't
  1262. defined, the normal port 69 is used.
  1263. The purpose for tftpsrcp is to allow a TFTP server to
  1264. blindly start the TFTP transfer using the pre-configured
  1265. target IP address and UDP port. This has the effect of
  1266. "punching through" the (Windows XP) firewall, allowing
  1267. the remainder of the TFTP transfer to proceed normally.
  1268. A better solution is to properly configure the firewall,
  1269. but sometimes that is not allowed.
  1270. CONFIG_STANDALONE_LOAD_ADDR
  1271. This option defines a board specific value for the
  1272. address where standalone program gets loaded, thus
  1273. overwriting the architecture dependent default
  1274. settings.
  1275. - Frame Buffer Address:
  1276. CONFIG_FB_ADDR
  1277. Define CONFIG_FB_ADDR if you want to use specific
  1278. address for frame buffer. This is typically the case
  1279. when using a graphics controller has separate video
  1280. memory. U-Boot will then place the frame buffer at
  1281. the given address instead of dynamically reserving it
  1282. in system RAM by calling lcd_setmem(), which grabs
  1283. the memory for the frame buffer depending on the
  1284. configured panel size.
  1285. Please see board_init_f function.
  1286. - Automatic software updates via TFTP server
  1287. CONFIG_UPDATE_TFTP
  1288. CONFIG_UPDATE_TFTP_CNT_MAX
  1289. CONFIG_UPDATE_TFTP_MSEC_MAX
  1290. These options enable and control the auto-update feature;
  1291. for a more detailed description refer to doc/README.update.
  1292. - MTD Support (mtdparts command, UBI support)
  1293. CONFIG_MTD_UBI_WL_THRESHOLD
  1294. This parameter defines the maximum difference between the highest
  1295. erase counter value and the lowest erase counter value of eraseblocks
  1296. of UBI devices. When this threshold is exceeded, UBI starts performing
  1297. wear leveling by means of moving data from eraseblock with low erase
  1298. counter to eraseblocks with high erase counter.
  1299. The default value should be OK for SLC NAND flashes, NOR flashes and
  1300. other flashes which have eraseblock life-cycle 100000 or more.
  1301. However, in case of MLC NAND flashes which typically have eraseblock
  1302. life-cycle less than 10000, the threshold should be lessened (e.g.,
  1303. to 128 or 256, although it does not have to be power of 2).
  1304. default: 4096
  1305. CONFIG_MTD_UBI_BEB_LIMIT
  1306. This option specifies the maximum bad physical eraseblocks UBI
  1307. expects on the MTD device (per 1024 eraseblocks). If the
  1308. underlying flash does not admit of bad eraseblocks (e.g. NOR
  1309. flash), this value is ignored.
  1310. NAND datasheets often specify the minimum and maximum NVM
  1311. (Number of Valid Blocks) for the flashes' endurance lifetime.
  1312. The maximum expected bad eraseblocks per 1024 eraseblocks
  1313. then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
  1314. which gives 20 for most NANDs (MaxNVB is basically the total
  1315. count of eraseblocks on the chip).
  1316. To put it differently, if this value is 20, UBI will try to
  1317. reserve about 1.9% of physical eraseblocks for bad blocks
  1318. handling. And that will be 1.9% of eraseblocks on the entire
  1319. NAND chip, not just the MTD partition UBI attaches. This means
  1320. that if you have, say, a NAND flash chip admits maximum 40 bad
  1321. eraseblocks, and it is split on two MTD partitions of the same
  1322. size, UBI will reserve 40 eraseblocks when attaching a
  1323. partition.
  1324. default: 20
  1325. CONFIG_MTD_UBI_FASTMAP
  1326. Fastmap is a mechanism which allows attaching an UBI device
  1327. in nearly constant time. Instead of scanning the whole MTD device it
  1328. only has to locate a checkpoint (called fastmap) on the device.
  1329. The on-flash fastmap contains all information needed to attach
  1330. the device. Using fastmap makes only sense on large devices where
  1331. attaching by scanning takes long. UBI will not automatically install
  1332. a fastmap on old images, but you can set the UBI parameter
  1333. CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
  1334. that fastmap-enabled images are still usable with UBI implementations
  1335. without fastmap support. On typical flash devices the whole fastmap
  1336. fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
  1337. CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
  1338. Set this parameter to enable fastmap automatically on images
  1339. without a fastmap.
  1340. default: 0
  1341. CONFIG_MTD_UBI_FM_DEBUG
  1342. Enable UBI fastmap debug
  1343. default: 0
  1344. - SPL framework
  1345. CONFIG_SPL
  1346. Enable building of SPL globally.
  1347. CONFIG_SPL_MAX_FOOTPRINT
  1348. Maximum size in memory allocated to the SPL, BSS included.
  1349. When defined, the linker checks that the actual memory
  1350. used by SPL from _start to __bss_end does not exceed it.
  1351. CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
  1352. must not be both defined at the same time.
  1353. CONFIG_SPL_MAX_SIZE
  1354. Maximum size of the SPL image (text, data, rodata, and
  1355. linker lists sections), BSS excluded.
  1356. When defined, the linker checks that the actual size does
  1357. not exceed it.
  1358. CONFIG_SPL_RELOC_TEXT_BASE
  1359. Address to relocate to. If unspecified, this is equal to
  1360. CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
  1361. CONFIG_SPL_BSS_START_ADDR
  1362. Link address for the BSS within the SPL binary.
  1363. CONFIG_SPL_BSS_MAX_SIZE
  1364. Maximum size in memory allocated to the SPL BSS.
  1365. When defined, the linker checks that the actual memory used
  1366. by SPL from __bss_start to __bss_end does not exceed it.
  1367. CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
  1368. must not be both defined at the same time.
  1369. CONFIG_SPL_STACK
  1370. Adress of the start of the stack SPL will use
  1371. CONFIG_SPL_PANIC_ON_RAW_IMAGE
  1372. When defined, SPL will panic() if the image it has
  1373. loaded does not have a signature.
  1374. Defining this is useful when code which loads images
  1375. in SPL cannot guarantee that absolutely all read errors
  1376. will be caught.
  1377. An example is the LPC32XX MLC NAND driver, which will
  1378. consider that a completely unreadable NAND block is bad,
  1379. and thus should be skipped silently.
  1380. CONFIG_SPL_RELOC_STACK
  1381. Adress of the start of the stack SPL will use after
  1382. relocation. If unspecified, this is equal to
  1383. CONFIG_SPL_STACK.
  1384. CONFIG_SYS_SPL_MALLOC_START
  1385. Starting address of the malloc pool used in SPL.
  1386. When this option is set the full malloc is used in SPL and
  1387. it is set up by spl_init() and before that, the simple malloc()
  1388. can be used if CONFIG_SYS_MALLOC_F is defined.
  1389. CONFIG_SYS_SPL_MALLOC_SIZE
  1390. The size of the malloc pool used in SPL.
  1391. CONFIG_SPL_DISPLAY_PRINT
  1392. For ARM, enable an optional function to print more information
  1393. about the running system.
  1394. CONFIG_SPL_INIT_MINIMAL
  1395. Arch init code should be built for a very small image
  1396. CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
  1397. CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
  1398. Sector and number of sectors to load kernel argument
  1399. parameters from when MMC is being used in raw mode
  1400. (for falcon mode)
  1401. CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
  1402. Filename to read to load U-Boot when reading from filesystem
  1403. CONFIG_SPL_FS_LOAD_KERNEL_NAME
  1404. Filename to read to load kernel uImage when reading
  1405. from filesystem (for Falcon mode)
  1406. CONFIG_SPL_FS_LOAD_ARGS_NAME
  1407. Filename to read to load kernel argument parameters
  1408. when reading from filesystem (for Falcon mode)
  1409. CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
  1410. Set this for NAND SPL on PPC mpc83xx targets, so that
  1411. start.S waits for the rest of the SPL to load before
  1412. continuing (the hardware starts execution after just
  1413. loading the first page rather than the full 4K).
  1414. CONFIG_SPL_SKIP_RELOCATE
  1415. Avoid SPL relocation
  1416. CONFIG_SPL_NAND_IDENT
  1417. SPL uses the chip ID list to identify the NAND flash.
  1418. Requires CONFIG_SPL_NAND_BASE.
  1419. CONFIG_SPL_UBI
  1420. Support for a lightweight UBI (fastmap) scanner and
  1421. loader
  1422. CONFIG_SPL_NAND_RAW_ONLY
  1423. Support to boot only raw u-boot.bin images. Use this only
  1424. if you need to save space.
  1425. CONFIG_SPL_COMMON_INIT_DDR
  1426. Set for common ddr init with serial presence detect in
  1427. SPL binary.
  1428. CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
  1429. CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
  1430. CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
  1431. CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
  1432. CONFIG_SYS_NAND_ECCBYTES
  1433. Defines the size and behavior of the NAND that SPL uses
  1434. to read U-Boot
  1435. CONFIG_SYS_NAND_U_BOOT_DST
  1436. Location in memory to load U-Boot to
  1437. CONFIG_SYS_NAND_U_BOOT_SIZE
  1438. Size of image to load
  1439. CONFIG_SYS_NAND_U_BOOT_START
  1440. Entry point in loaded image to jump to
  1441. CONFIG_SYS_NAND_HW_ECC_OOBFIRST
  1442. Define this if you need to first read the OOB and then the
  1443. data. This is used, for example, on davinci platforms.
  1444. CONFIG_SPL_RAM_DEVICE
  1445. Support for running image already present in ram, in SPL binary
  1446. CONFIG_SPL_PAD_TO
  1447. Image offset to which the SPL should be padded before appending
  1448. the SPL payload. By default, this is defined as
  1449. CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
  1450. CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
  1451. payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
  1452. CONFIG_SPL_TARGET
  1453. Final target image containing SPL and payload. Some SPLs
  1454. use an arch-specific makefile fragment instead, for
  1455. example if more than one image needs to be produced.
  1456. CONFIG_SPL_FIT_PRINT
  1457. Printing information about a FIT image adds quite a bit of
  1458. code to SPL. So this is normally disabled in SPL. Use this
  1459. option to re-enable it. This will affect the output of the
  1460. bootm command when booting a FIT image.
  1461. - TPL framework
  1462. CONFIG_TPL
  1463. Enable building of TPL globally.
  1464. CONFIG_TPL_PAD_TO
  1465. Image offset to which the TPL should be padded before appending
  1466. the TPL payload. By default, this is defined as
  1467. CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
  1468. CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
  1469. payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
  1470. - Interrupt support (PPC):
  1471. There are common interrupt_init() and timer_interrupt()
  1472. for all PPC archs. interrupt_init() calls interrupt_init_cpu()
  1473. for CPU specific initialization. interrupt_init_cpu()
  1474. should set decrementer_count to appropriate value. If
  1475. CPU resets decrementer automatically after interrupt
  1476. (ppc4xx) it should set decrementer_count to zero.
  1477. timer_interrupt() calls timer_interrupt_cpu() for CPU
  1478. specific handling. If board has watchdog / status_led
  1479. / other_activity_monitor it works automatically from
  1480. general timer_interrupt().
  1481. Board initialization settings:
  1482. ------------------------------
  1483. During Initialization u-boot calls a number of board specific functions
  1484. to allow the preparation of board specific prerequisites, e.g. pin setup
  1485. before drivers are initialized. To enable these callbacks the
  1486. following configuration macros have to be defined. Currently this is
  1487. architecture specific, so please check arch/your_architecture/lib/board.c
  1488. typically in board_init_f() and board_init_r().
  1489. - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
  1490. - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
  1491. - CONFIG_BOARD_LATE_INIT: Call board_late_init()
  1492. - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
  1493. Configuration Settings:
  1494. -----------------------
  1495. - MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
  1496. Optionally it can be defined to support 64-bit memory commands.
  1497. - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
  1498. undefine this when you're short of memory.
  1499. - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
  1500. width of the commands listed in the 'help' command output.
  1501. - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
  1502. prompt for user input.
  1503. - CONFIG_SYS_CBSIZE: Buffer size for input from the Console
  1504. - CONFIG_SYS_PBSIZE: Buffer size for Console output
  1505. - CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
  1506. - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
  1507. the application (usually a Linux kernel) when it is
  1508. booted
  1509. - CONFIG_SYS_BAUDRATE_TABLE:
  1510. List of legal baudrate settings for this board.
  1511. - CONFIG_SYS_MEM_RESERVE_SECURE
  1512. Only implemented for ARMv8 for now.
  1513. If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
  1514. is substracted from total RAM and won't be reported to OS.
  1515. This memory can be used as secure memory. A variable
  1516. gd->arch.secure_ram is used to track the location. In systems
  1517. the RAM base is not zero, or RAM is divided into banks,
  1518. this variable needs to be recalcuated to get the address.
  1519. - CONFIG_SYS_MEM_TOP_HIDE:
  1520. If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
  1521. this specified memory area will get subtracted from the top
  1522. (end) of RAM and won't get "touched" at all by U-Boot. By
  1523. fixing up gd->ram_size the Linux kernel should gets passed
  1524. the now "corrected" memory size and won't touch it either.
  1525. This should work for arch/ppc and arch/powerpc. Only Linux
  1526. board ports in arch/powerpc with bootwrapper support that
  1527. recalculate the memory size from the SDRAM controller setup
  1528. will have to get fixed in Linux additionally.
  1529. This option can be used as a workaround for the 440EPx/GRx
  1530. CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
  1531. be touched.
  1532. WARNING: Please make sure that this value is a multiple of
  1533. the Linux page size (normally 4k). If this is not the case,
  1534. then the end address of the Linux memory will be located at a
  1535. non page size aligned address and this could cause major
  1536. problems.
  1537. - CONFIG_SYS_LOADS_BAUD_CHANGE:
  1538. Enable temporary baudrate change while serial download
  1539. - CONFIG_SYS_SDRAM_BASE:
  1540. Physical start address of SDRAM. _Must_ be 0 here.
  1541. - CONFIG_SYS_FLASH_BASE:
  1542. Physical start address of Flash memory.
  1543. - CONFIG_SYS_MONITOR_BASE:
  1544. Physical start address of boot monitor code (set by
  1545. make config files to be same as the text base address
  1546. (CONFIG_SYS_TEXT_BASE) used when linking) - same as
  1547. CONFIG_SYS_FLASH_BASE when booting from flash.
  1548. - CONFIG_SYS_MONITOR_LEN:
  1549. Size of memory reserved for monitor code, used to
  1550. determine _at_compile_time_ (!) if the environment is
  1551. embedded within the U-Boot image, or in a separate
  1552. flash sector.
  1553. - CONFIG_SYS_MALLOC_LEN:
  1554. Size of DRAM reserved for malloc() use.
  1555. - CONFIG_SYS_MALLOC_F_LEN
  1556. Size of the malloc() pool for use before relocation. If
  1557. this is defined, then a very simple malloc() implementation
  1558. will become available before relocation. The address is just
  1559. below the global data, and the stack is moved down to make
  1560. space.
  1561. This feature allocates regions with increasing addresses
  1562. within the region. calloc() is supported, but realloc()
  1563. is not available. free() is supported but does nothing.
  1564. The memory will be freed (or in fact just forgotten) when
  1565. U-Boot relocates itself.
  1566. - CONFIG_SYS_MALLOC_SIMPLE
  1567. Provides a simple and small malloc() and calloc() for those
  1568. boards which do not use the full malloc in SPL (which is
  1569. enabled with CONFIG_SYS_SPL_MALLOC_START).
  1570. - CONFIG_SYS_NONCACHED_MEMORY:
  1571. Size of non-cached memory area. This area of memory will be
  1572. typically located right below the malloc() area and mapped
  1573. uncached in the MMU. This is useful for drivers that would
  1574. otherwise require a lot of explicit cache maintenance. For
  1575. some drivers it's also impossible to properly maintain the
  1576. cache. For example if the regions that need to be flushed
  1577. are not a multiple of the cache-line size, *and* padding
  1578. cannot be allocated between the regions to align them (i.e.
  1579. if the HW requires a contiguous array of regions, and the
  1580. size of each region is not cache-aligned), then a flush of
  1581. one region may result in overwriting data that hardware has
  1582. written to another region in the same cache-line. This can
  1583. happen for example in network drivers where descriptors for
  1584. buffers are typically smaller than the CPU cache-line (e.g.
  1585. 16 bytes vs. 32 or 64 bytes).
  1586. Non-cached memory is only supported on 32-bit ARM at present.
  1587. - CONFIG_SYS_BOOTM_LEN:
  1588. Normally compressed uImages are limited to an
  1589. uncompressed size of 8 MBytes. If this is not enough,
  1590. you can define CONFIG_SYS_BOOTM_LEN in your board config file
  1591. to adjust this setting to your needs.
  1592. - CONFIG_SYS_BOOTMAPSZ:
  1593. Maximum size of memory mapped by the startup code of
  1594. the Linux kernel; all data that must be processed by
  1595. the Linux kernel (bd_info, boot arguments, FDT blob if
  1596. used) must be put below this limit, unless "bootm_low"
  1597. environment variable is defined and non-zero. In such case
  1598. all data for the Linux kernel must be between "bootm_low"
  1599. and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
  1600. variable "bootm_mapsize" will override the value of
  1601. CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
  1602. then the value in "bootm_size" will be used instead.
  1603. - CONFIG_SYS_BOOT_RAMDISK_HIGH:
  1604. Enable initrd_high functionality. If defined then the
  1605. initrd_high feature is enabled and the bootm ramdisk subcommand
  1606. is enabled.
  1607. - CONFIG_SYS_BOOT_GET_CMDLINE:
  1608. Enables allocating and saving kernel cmdline in space between
  1609. "bootm_low" and "bootm_low" + BOOTMAPSZ.
  1610. - CONFIG_SYS_BOOT_GET_KBD:
  1611. Enables allocating and saving a kernel copy of the bd_info in
  1612. space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
  1613. - CONFIG_SYS_MAX_FLASH_SECT:
  1614. Max number of sectors on a Flash chip
  1615. - CONFIG_SYS_FLASH_ERASE_TOUT:
  1616. Timeout for Flash erase operations (in ms)
  1617. - CONFIG_SYS_FLASH_WRITE_TOUT:
  1618. Timeout for Flash write operations (in ms)
  1619. - CONFIG_SYS_FLASH_LOCK_TOUT
  1620. Timeout for Flash set sector lock bit operation (in ms)
  1621. - CONFIG_SYS_FLASH_UNLOCK_TOUT
  1622. Timeout for Flash clear lock bits operation (in ms)
  1623. - CONFIG_SYS_FLASH_PROTECTION
  1624. If defined, hardware flash sectors protection is used
  1625. instead of U-Boot software protection.
  1626. - CONFIG_SYS_DIRECT_FLASH_TFTP:
  1627. Enable TFTP transfers directly to flash memory;
  1628. without this option such a download has to be
  1629. performed in two steps: (1) download to RAM, and (2)
  1630. copy from RAM to flash.
  1631. The two-step approach is usually more reliable, since
  1632. you can check if the download worked before you erase
  1633. the flash, but in some situations (when system RAM is
  1634. too limited to allow for a temporary copy of the
  1635. downloaded image) this option may be very useful.
  1636. - CONFIG_SYS_FLASH_CFI:
  1637. Define if the flash driver uses extra elements in the
  1638. common flash structure for storing flash geometry.
  1639. - CONFIG_FLASH_CFI_DRIVER
  1640. This option also enables the building of the cfi_flash driver
  1641. in the drivers directory
  1642. - CONFIG_FLASH_CFI_MTD
  1643. This option enables the building of the cfi_mtd driver
  1644. in the drivers directory. The driver exports CFI flash
  1645. to the MTD layer.
  1646. - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
  1647. Use buffered writes to flash.
  1648. - CONFIG_FLASH_SPANSION_S29WS_N
  1649. s29ws-n MirrorBit flash has non-standard addresses for buffered
  1650. write commands.
  1651. - CONFIG_SYS_FLASH_QUIET_TEST
  1652. If this option is defined, the common CFI flash doesn't
  1653. print it's warning upon not recognized FLASH banks. This
  1654. is useful, if some of the configured banks are only
  1655. optionally available.
  1656. - CONFIG_FLASH_SHOW_PROGRESS
  1657. If defined (must be an integer), print out countdown
  1658. digits and dots. Recommended value: 45 (9..1) for 80
  1659. column displays, 15 (3..1) for 40 column displays.
  1660. - CONFIG_FLASH_VERIFY
  1661. If defined, the content of the flash (destination) is compared
  1662. against the source after the write operation. An error message
  1663. will be printed when the contents are not identical.
  1664. Please note that this option is useless in nearly all cases,
  1665. since such flash programming errors usually are detected earlier
  1666. while unprotecting/erasing/programming. Please only enable
  1667. this option if you really know what you are doing.
  1668. - CONFIG_SYS_RX_ETH_BUFFER:
  1669. Defines the number of Ethernet receive buffers. On some
  1670. Ethernet controllers it is recommended to set this value
  1671. to 8 or even higher (EEPRO100 or 405 EMAC), since all
  1672. buffers can be full shortly after enabling the interface
  1673. on high Ethernet traffic.
  1674. Defaults to 4 if not defined.
  1675. - CONFIG_ENV_MAX_ENTRIES
  1676. Maximum number of entries in the hash table that is used
  1677. internally to store the environment settings. The default
  1678. setting is supposed to be generous and should work in most
  1679. cases. This setting can be used to tune behaviour; see
  1680. lib/hashtable.c for details.
  1681. - CONFIG_ENV_FLAGS_LIST_DEFAULT
  1682. - CONFIG_ENV_FLAGS_LIST_STATIC
  1683. Enable validation of the values given to environment variables when
  1684. calling env set. Variables can be restricted to only decimal,
  1685. hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
  1686. the variables can also be restricted to IP address or MAC address.
  1687. The format of the list is:
  1688. type_attribute = [s|d|x|b|i|m]
  1689. access_attribute = [a|r|o|c]
  1690. attributes = type_attribute[access_attribute]
  1691. entry = variable_name[:attributes]
  1692. list = entry[,list]
  1693. The type attributes are:
  1694. s - String (default)
  1695. d - Decimal
  1696. x - Hexadecimal
  1697. b - Boolean ([1yYtT|0nNfF])
  1698. i - IP address
  1699. m - MAC address
  1700. The access attributes are:
  1701. a - Any (default)
  1702. r - Read-only
  1703. o - Write-once
  1704. c - Change-default
  1705. - CONFIG_ENV_FLAGS_LIST_DEFAULT
  1706. Define this to a list (string) to define the ".flags"
  1707. environment variable in the default or embedded environment.
  1708. - CONFIG_ENV_FLAGS_LIST_STATIC
  1709. Define this to a list (string) to define validation that
  1710. should be done if an entry is not found in the ".flags"
  1711. environment variable. To override a setting in the static
  1712. list, simply add an entry for the same variable name to the
  1713. ".flags" variable.
  1714. If CONFIG_REGEX is defined, the variable_name above is evaluated as a
  1715. regular expression. This allows multiple variables to define the same
  1716. flags without explicitly listing them for each variable.
  1717. The following definitions that deal with the placement and management
  1718. of environment data (variable area); in general, we support the
  1719. following configurations:
  1720. - CONFIG_BUILD_ENVCRC:
  1721. Builds up envcrc with the target environment so that external utils
  1722. may easily extract it and embed it in final U-Boot images.
  1723. BE CAREFUL! The first access to the environment happens quite early
  1724. in U-Boot initialization (when we try to get the setting of for the
  1725. console baudrate). You *MUST* have mapped your NVRAM area then, or
  1726. U-Boot will hang.
  1727. Please note that even with NVRAM we still use a copy of the
  1728. environment in RAM: we could work on NVRAM directly, but we want to
  1729. keep settings there always unmodified except somebody uses "saveenv"
  1730. to save the current settings.
  1731. BE CAREFUL! For some special cases, the local device can not use
  1732. "saveenv" command. For example, the local device will get the
  1733. environment stored in a remote NOR flash by SRIO or PCIE link,
  1734. but it can not erase, write this NOR flash by SRIO or PCIE interface.
  1735. - CONFIG_NAND_ENV_DST
  1736. Defines address in RAM to which the nand_spl code should copy the
  1737. environment. If redundant environment is used, it will be copied to
  1738. CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
  1739. Please note that the environment is read-only until the monitor
  1740. has been relocated to RAM and a RAM copy of the environment has been
  1741. created; also, when using EEPROM you will have to use env_get_f()
  1742. until then to read environment variables.
  1743. The environment is protected by a CRC32 checksum. Before the monitor
  1744. is relocated into RAM, as a result of a bad CRC you will be working
  1745. with the compiled-in default environment - *silently*!!! [This is
  1746. necessary, because the first environment variable we need is the
  1747. "baudrate" setting for the console - if we have a bad CRC, we don't
  1748. have any device yet where we could complain.]
  1749. Note: once the monitor has been relocated, then it will complain if
  1750. the default environment is used; a new CRC is computed as soon as you
  1751. use the "saveenv" command to store a valid environment.
  1752. - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
  1753. Echo the inverted Ethernet link state to the fault LED.
  1754. Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
  1755. also needs to be defined.
  1756. - CONFIG_SYS_FAULT_MII_ADDR:
  1757. MII address of the PHY to check for the Ethernet link state.
  1758. - CONFIG_NS16550_MIN_FUNCTIONS:
  1759. Define this if you desire to only have use of the NS16550_init
  1760. and NS16550_putc functions for the serial driver located at
  1761. drivers/serial/ns16550.c. This option is useful for saving
  1762. space for already greatly restricted images, including but not
  1763. limited to NAND_SPL configurations.
  1764. - CONFIG_DISPLAY_BOARDINFO
  1765. Display information about the board that U-Boot is running on
  1766. when U-Boot starts up. The board function checkboard() is called
  1767. to do this.
  1768. - CONFIG_DISPLAY_BOARDINFO_LATE
  1769. Similar to the previous option, but display this information
  1770. later, once stdio is running and output goes to the LCD, if
  1771. present.
  1772. - CONFIG_BOARD_SIZE_LIMIT:
  1773. Maximum size of the U-Boot image. When defined, the
  1774. build system checks that the actual size does not
  1775. exceed it.
  1776. Low Level (hardware related) configuration options:
  1777. ---------------------------------------------------
  1778. - CONFIG_SYS_CACHELINE_SIZE:
  1779. Cache Line Size of the CPU.
  1780. - CONFIG_SYS_CCSRBAR_DEFAULT:
  1781. Default (power-on reset) physical address of CCSR on Freescale
  1782. PowerPC SOCs.
  1783. - CONFIG_SYS_CCSRBAR:
  1784. Virtual address of CCSR. On a 32-bit build, this is typically
  1785. the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
  1786. - CONFIG_SYS_CCSRBAR_PHYS:
  1787. Physical address of CCSR. CCSR can be relocated to a new
  1788. physical address, if desired. In this case, this macro should
  1789. be set to that address. Otherwise, it should be set to the
  1790. same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
  1791. is typically relocated on 36-bit builds. It is recommended
  1792. that this macro be defined via the _HIGH and _LOW macros:
  1793. #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
  1794. * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
  1795. - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
  1796. Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
  1797. either 0 (32-bit build) or 0xF (36-bit build). This macro is
  1798. used in assembly code, so it must not contain typecasts or
  1799. integer size suffixes (e.g. "ULL").
  1800. - CONFIG_SYS_CCSRBAR_PHYS_LOW:
  1801. Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
  1802. used in assembly code, so it must not contain typecasts or
  1803. integer size suffixes (e.g. "ULL").
  1804. - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
  1805. If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
  1806. forced to a value that ensures that CCSR is not relocated.
  1807. - CONFIG_SYS_IMMR: Physical address of the Internal Memory.
  1808. DO NOT CHANGE unless you know exactly what you're
  1809. doing! (11-4) [MPC8xx systems only]
  1810. - CONFIG_SYS_INIT_RAM_ADDR:
  1811. Start address of memory area that can be used for
  1812. initial data and stack; please note that this must be
  1813. writable memory that is working WITHOUT special
  1814. initialization, i. e. you CANNOT use normal RAM which
  1815. will become available only after programming the
  1816. memory controller and running certain initialization
  1817. sequences.
  1818. U-Boot uses the following memory types:
  1819. - MPC8xx: IMMR (internal memory of the CPU)
  1820. - CONFIG_SYS_GBL_DATA_OFFSET:
  1821. Offset of the initial data structure in the memory
  1822. area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
  1823. CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
  1824. data is located at the end of the available space
  1825. (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
  1826. GENERATED_GBL_DATA_SIZE), and the initial stack is just
  1827. below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
  1828. CONFIG_SYS_GBL_DATA_OFFSET) downward.
  1829. Note:
  1830. On the MPC824X (or other systems that use the data
  1831. cache for initial memory) the address chosen for
  1832. CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
  1833. point to an otherwise UNUSED address space between
  1834. the top of RAM and the start of the PCI space.
  1835. - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
  1836. - CONFIG_SYS_OR_TIMING_SDRAM:
  1837. SDRAM timing
  1838. - CONFIG_SYS_MAMR_PTA:
  1839. periodic timer for refresh
  1840. - CONFIG_SYS_SRIO:
  1841. Chip has SRIO or not
  1842. - CONFIG_SRIO1:
  1843. Board has SRIO 1 port available
  1844. - CONFIG_SRIO2:
  1845. Board has SRIO 2 port available
  1846. - CONFIG_SRIO_PCIE_BOOT_MASTER
  1847. Board can support master function for Boot from SRIO and PCIE
  1848. - CONFIG_SYS_SRIOn_MEM_VIRT:
  1849. Virtual Address of SRIO port 'n' memory region
  1850. - CONFIG_SYS_SRIOn_MEM_PHYxS:
  1851. Physical Address of SRIO port 'n' memory region
  1852. - CONFIG_SYS_SRIOn_MEM_SIZE:
  1853. Size of SRIO port 'n' memory region
  1854. - CONFIG_SYS_NAND_BUSWIDTH_16BIT
  1855. Defined to tell the NAND controller that the NAND chip is using
  1856. a 16 bit bus.
  1857. Not all NAND drivers use this symbol.
  1858. Example of drivers that use it:
  1859. - drivers/mtd/nand/raw/ndfc.c
  1860. - drivers/mtd/nand/raw/mxc_nand.c
  1861. - CONFIG_SYS_NDFC_EBC0_CFG
  1862. Sets the EBC0_CFG register for the NDFC. If not defined
  1863. a default value will be used.
  1864. - CONFIG_SPD_EEPROM
  1865. Get DDR timing information from an I2C EEPROM. Common
  1866. with pluggable memory modules such as SODIMMs
  1867. SPD_EEPROM_ADDRESS
  1868. I2C address of the SPD EEPROM
  1869. - CONFIG_SYS_SPD_BUS_NUM
  1870. If SPD EEPROM is on an I2C bus other than the first
  1871. one, specify here. Note that the value must resolve
  1872. to something your driver can deal with.
  1873. - CONFIG_SYS_DDR_RAW_TIMING
  1874. Get DDR timing information from other than SPD. Common with
  1875. soldered DDR chips onboard without SPD. DDR raw timing
  1876. parameters are extracted from datasheet and hard-coded into
  1877. header files or board specific files.
  1878. - CONFIG_FSL_DDR_INTERACTIVE
  1879. Enable interactive DDR debugging. See doc/README.fsl-ddr.
  1880. - CONFIG_FSL_DDR_SYNC_REFRESH
  1881. Enable sync of refresh for multiple controllers.
  1882. - CONFIG_FSL_DDR_BIST
  1883. Enable built-in memory test for Freescale DDR controllers.
  1884. - CONFIG_SYS_83XX_DDR_USES_CS0
  1885. Only for 83xx systems. If specified, then DDR should
  1886. be configured using CS0 and CS1 instead of CS2 and CS3.
  1887. - CONFIG_RMII
  1888. Enable RMII mode for all FECs.
  1889. Note that this is a global option, we can't
  1890. have one FEC in standard MII mode and another in RMII mode.
  1891. - CONFIG_CRC32_VERIFY
  1892. Add a verify option to the crc32 command.
  1893. The syntax is:
  1894. => crc32 -v <address> <count> <crc32>
  1895. Where address/count indicate a memory area
  1896. and crc32 is the correct crc32 which the
  1897. area should have.
  1898. - CONFIG_LOOPW
  1899. Add the "loopw" memory command. This only takes effect if
  1900. the memory commands are activated globally (CONFIG_CMD_MEMORY).
  1901. - CONFIG_CMD_MX_CYCLIC
  1902. Add the "mdc" and "mwc" memory commands. These are cyclic
  1903. "md/mw" commands.
  1904. Examples:
  1905. => mdc.b 10 4 500
  1906. This command will print 4 bytes (10,11,12,13) each 500 ms.
  1907. => mwc.l 100 12345678 10
  1908. This command will write 12345678 to address 100 all 10 ms.
  1909. This only takes effect if the memory commands are activated
  1910. globally (CONFIG_CMD_MEMORY).
  1911. - CONFIG_SPL_BUILD
  1912. Set when the currently-running compilation is for an artifact
  1913. that will end up in the SPL (as opposed to the TPL or U-Boot
  1914. proper). Code that needs stage-specific behavior should check
  1915. this.
  1916. - CONFIG_TPL_BUILD
  1917. Set when the currently-running compilation is for an artifact
  1918. that will end up in the TPL (as opposed to the SPL or U-Boot
  1919. proper). Code that needs stage-specific behavior should check
  1920. this.
  1921. - CONFIG_SYS_MPC85XX_NO_RESETVEC
  1922. Only for 85xx systems. If this variable is specified, the section
  1923. .resetvec is not kept and the section .bootpg is placed in the
  1924. previous 4k of the .text section.
  1925. - CONFIG_ARCH_MAP_SYSMEM
  1926. Generally U-Boot (and in particular the md command) uses
  1927. effective address. It is therefore not necessary to regard
  1928. U-Boot address as virtual addresses that need to be translated
  1929. to physical addresses. However, sandbox requires this, since
  1930. it maintains its own little RAM buffer which contains all
  1931. addressable memory. This option causes some memory accesses
  1932. to be mapped through map_sysmem() / unmap_sysmem().
  1933. - CONFIG_X86_RESET_VECTOR
  1934. If defined, the x86 reset vector code is included. This is not
  1935. needed when U-Boot is running from Coreboot.
  1936. - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
  1937. Option to disable subpage write in NAND driver
  1938. driver that uses this:
  1939. drivers/mtd/nand/raw/davinci_nand.c
  1940. Freescale QE/FMAN Firmware Support:
  1941. -----------------------------------
  1942. The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
  1943. loading of "firmware", which is encoded in the QE firmware binary format.
  1944. This firmware often needs to be loaded during U-Boot booting, so macros
  1945. are used to identify the storage device (NOR flash, SPI, etc) and the address
  1946. within that device.
  1947. - CONFIG_SYS_FMAN_FW_ADDR
  1948. The address in the storage device where the FMAN microcode is located. The
  1949. meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
  1950. is also specified.
  1951. - CONFIG_SYS_QE_FW_ADDR
  1952. The address in the storage device where the QE microcode is located. The
  1953. meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
  1954. is also specified.
  1955. - CONFIG_SYS_QE_FMAN_FW_LENGTH
  1956. The maximum possible size of the firmware. The firmware binary format
  1957. has a field that specifies the actual size of the firmware, but it
  1958. might not be possible to read any part of the firmware unless some
  1959. local storage is allocated to hold the entire firmware first.
  1960. - CONFIG_SYS_QE_FMAN_FW_IN_NOR
  1961. Specifies that QE/FMAN firmware is located in NOR flash, mapped as
  1962. normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
  1963. virtual address in NOR flash.
  1964. - CONFIG_SYS_QE_FMAN_FW_IN_NAND
  1965. Specifies that QE/FMAN firmware is located in NAND flash.
  1966. CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
  1967. - CONFIG_SYS_QE_FMAN_FW_IN_MMC
  1968. Specifies that QE/FMAN firmware is located on the primary SD/MMC
  1969. device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
  1970. - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
  1971. Specifies that QE/FMAN firmware is located in the remote (master)
  1972. memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
  1973. can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
  1974. window->master inbound window->master LAW->the ucode address in
  1975. master's memory space.
  1976. Freescale Layerscape Management Complex Firmware Support:
  1977. ---------------------------------------------------------
  1978. The Freescale Layerscape Management Complex (MC) supports the loading of
  1979. "firmware".
  1980. This firmware often needs to be loaded during U-Boot booting, so macros
  1981. are used to identify the storage device (NOR flash, SPI, etc) and the address
  1982. within that device.
  1983. - CONFIG_FSL_MC_ENET
  1984. Enable the MC driver for Layerscape SoCs.
  1985. Freescale Layerscape Debug Server Support:
  1986. -------------------------------------------
  1987. The Freescale Layerscape Debug Server Support supports the loading of
  1988. "Debug Server firmware" and triggering SP boot-rom.
  1989. This firmware often needs to be loaded during U-Boot booting.
  1990. - CONFIG_SYS_MC_RSV_MEM_ALIGN
  1991. Define alignment of reserved memory MC requires
  1992. Reproducible builds
  1993. -------------------
  1994. In order to achieve reproducible builds, timestamps used in the U-Boot build
  1995. process have to be set to a fixed value.
  1996. This is done using the SOURCE_DATE_EPOCH environment variable.
  1997. SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
  1998. option for U-Boot or an environment variable in U-Boot.
  1999. SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
  2000. Building the Software:
  2001. ======================
  2002. Building U-Boot has been tested in several native build environments
  2003. and in many different cross environments. Of course we cannot support
  2004. all possibly existing versions of cross development tools in all
  2005. (potentially obsolete) versions. In case of tool chain problems we
  2006. recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
  2007. which is extensively used to build and test U-Boot.
  2008. If you are not using a native environment, it is assumed that you
  2009. have GNU cross compiling tools available in your path. In this case,
  2010. you must set the environment variable CROSS_COMPILE in your shell.
  2011. Note that no changes to the Makefile or any other source files are
  2012. necessary. For example using the ELDK on a 4xx CPU, please enter:
  2013. $ CROSS_COMPILE=ppc_4xx-
  2014. $ export CROSS_COMPILE
  2015. U-Boot is intended to be simple to build. After installing the
  2016. sources you must configure U-Boot for one specific board type. This
  2017. is done by typing:
  2018. make NAME_defconfig
  2019. where "NAME_defconfig" is the name of one of the existing configu-
  2020. rations; see configs/*_defconfig for supported names.
  2021. Note: for some boards special configuration names may exist; check if
  2022. additional information is available from the board vendor; for
  2023. instance, the TQM823L systems are available without (standard)
  2024. or with LCD support. You can select such additional "features"
  2025. when choosing the configuration, i. e.
  2026. make TQM823L_defconfig
  2027. - will configure for a plain TQM823L, i. e. no LCD support
  2028. make TQM823L_LCD_defconfig
  2029. - will configure for a TQM823L with U-Boot console on LCD
  2030. etc.
  2031. Finally, type "make all", and you should get some working U-Boot
  2032. images ready for download to / installation on your system:
  2033. - "u-boot.bin" is a raw binary image
  2034. - "u-boot" is an image in ELF binary format
  2035. - "u-boot.srec" is in Motorola S-Record format
  2036. By default the build is performed locally and the objects are saved
  2037. in the source directory. One of the two methods can be used to change
  2038. this behavior and build U-Boot to some external directory:
  2039. 1. Add O= to the make command line invocations:
  2040. make O=/tmp/build distclean
  2041. make O=/tmp/build NAME_defconfig
  2042. make O=/tmp/build all
  2043. 2. Set environment variable KBUILD_OUTPUT to point to the desired location:
  2044. export KBUILD_OUTPUT=/tmp/build
  2045. make distclean
  2046. make NAME_defconfig
  2047. make all
  2048. Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
  2049. variable.
  2050. User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
  2051. setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
  2052. For example to treat all compiler warnings as errors:
  2053. make KCFLAGS=-Werror
  2054. Please be aware that the Makefiles assume you are using GNU make, so
  2055. for instance on NetBSD you might need to use "gmake" instead of
  2056. native "make".
  2057. If the system board that you have is not listed, then you will need
  2058. to port U-Boot to your hardware platform. To do this, follow these
  2059. steps:
  2060. 1. Create a new directory to hold your board specific code. Add any
  2061. files you need. In your board directory, you will need at least
  2062. the "Makefile" and a "<board>.c".
  2063. 2. Create a new configuration file "include/configs/<board>.h" for
  2064. your board.
  2065. 3. If you're porting U-Boot to a new CPU, then also create a new
  2066. directory to hold your CPU specific code. Add any files you need.
  2067. 4. Run "make <board>_defconfig" with your new name.
  2068. 5. Type "make", and you should get a working "u-boot.srec" file
  2069. to be installed on your target system.
  2070. 6. Debug and solve any problems that might arise.
  2071. [Of course, this last step is much harder than it sounds.]
  2072. Testing of U-Boot Modifications, Ports to New Hardware, etc.:
  2073. ==============================================================
  2074. If you have modified U-Boot sources (for instance added a new board
  2075. or support for new devices, a new CPU, etc.) you are expected to
  2076. provide feedback to the other developers. The feedback normally takes
  2077. the form of a "patch", i.e. a context diff against a certain (latest
  2078. official or latest in the git repository) version of U-Boot sources.
  2079. But before you submit such a patch, please verify that your modifi-
  2080. cation did not break existing code. At least make sure that *ALL* of
  2081. the supported boards compile WITHOUT ANY compiler warnings. To do so,
  2082. just run the buildman script (tools/buildman/buildman), which will
  2083. configure and build U-Boot for ALL supported system. Be warned, this
  2084. will take a while. Please see the buildman README, or run 'buildman -H'
  2085. for documentation.
  2086. See also "U-Boot Porting Guide" below.
  2087. Monitor Commands - Overview:
  2088. ============================
  2089. go - start application at address 'addr'
  2090. run - run commands in an environment variable
  2091. bootm - boot application image from memory
  2092. bootp - boot image via network using BootP/TFTP protocol
  2093. bootz - boot zImage from memory
  2094. tftpboot- boot image via network using TFTP protocol
  2095. and env variables "ipaddr" and "serverip"
  2096. (and eventually "gatewayip")
  2097. tftpput - upload a file via network using TFTP protocol
  2098. rarpboot- boot image via network using RARP/TFTP protocol
  2099. diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
  2100. loads - load S-Record file over serial line
  2101. loadb - load binary file over serial line (kermit mode)
  2102. md - memory display
  2103. mm - memory modify (auto-incrementing)
  2104. nm - memory modify (constant address)
  2105. mw - memory write (fill)
  2106. ms - memory search
  2107. cp - memory copy
  2108. cmp - memory compare
  2109. crc32 - checksum calculation
  2110. i2c - I2C sub-system
  2111. sspi - SPI utility commands
  2112. base - print or set address offset
  2113. printenv- print environment variables
  2114. pwm - control pwm channels
  2115. setenv - set environment variables
  2116. saveenv - save environment variables to persistent storage
  2117. protect - enable or disable FLASH write protection
  2118. erase - erase FLASH memory
  2119. flinfo - print FLASH memory information
  2120. nand - NAND memory operations (see doc/README.nand)
  2121. bdinfo - print Board Info structure
  2122. iminfo - print header information for application image
  2123. coninfo - print console devices and informations
  2124. ide - IDE sub-system
  2125. loop - infinite loop on address range
  2126. loopw - infinite write loop on address range
  2127. mtest - simple RAM test
  2128. icache - enable or disable instruction cache
  2129. dcache - enable or disable data cache
  2130. reset - Perform RESET of the CPU
  2131. echo - echo args to console
  2132. version - print monitor version
  2133. help - print online help
  2134. ? - alias for 'help'
  2135. Monitor Commands - Detailed Description:
  2136. ========================================
  2137. TODO.
  2138. For now: just type "help <command>".
  2139. Note for Redundant Ethernet Interfaces:
  2140. =======================================
  2141. Some boards come with redundant Ethernet interfaces; U-Boot supports
  2142. such configurations and is capable of automatic selection of a
  2143. "working" interface when needed. MAC assignment works as follows:
  2144. Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
  2145. MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
  2146. "eth1addr" (=>eth1), "eth2addr", ...
  2147. If the network interface stores some valid MAC address (for instance
  2148. in SROM), this is used as default address if there is NO correspon-
  2149. ding setting in the environment; if the corresponding environment
  2150. variable is set, this overrides the settings in the card; that means:
  2151. o If the SROM has a valid MAC address, and there is no address in the
  2152. environment, the SROM's address is used.
  2153. o If there is no valid address in the SROM, and a definition in the
  2154. environment exists, then the value from the environment variable is
  2155. used.
  2156. o If both the SROM and the environment contain a MAC address, and
  2157. both addresses are the same, this MAC address is used.
  2158. o If both the SROM and the environment contain a MAC address, and the
  2159. addresses differ, the value from the environment is used and a
  2160. warning is printed.
  2161. o If neither SROM nor the environment contain a MAC address, an error
  2162. is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
  2163. a random, locally-assigned MAC is used.
  2164. If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
  2165. will be programmed into hardware as part of the initialization process. This
  2166. may be skipped by setting the appropriate 'ethmacskip' environment variable.
  2167. The naming convention is as follows:
  2168. "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
  2169. Image Formats:
  2170. ==============
  2171. U-Boot is capable of booting (and performing other auxiliary operations on)
  2172. images in two formats:
  2173. New uImage format (FIT)
  2174. -----------------------
  2175. Flexible and powerful format based on Flattened Image Tree -- FIT (similar
  2176. to Flattened Device Tree). It allows the use of images with multiple
  2177. components (several kernels, ramdisks, etc.), with contents protected by
  2178. SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
  2179. Old uImage format
  2180. -----------------
  2181. Old image format is based on binary files which can be basically anything,
  2182. preceded by a special header; see the definitions in include/image.h for
  2183. details; basically, the header defines the following image properties:
  2184. * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
  2185. 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
  2186. LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
  2187. Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, INTEGRITY).
  2188. * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
  2189. IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
  2190. Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
  2191. * Compression Type (uncompressed, gzip, bzip2)
  2192. * Load Address
  2193. * Entry Point
  2194. * Image Name
  2195. * Image Timestamp
  2196. The header is marked by a special Magic Number, and both the header
  2197. and the data portions of the image are secured against corruption by
  2198. CRC32 checksums.
  2199. Linux Support:
  2200. ==============
  2201. Although U-Boot should support any OS or standalone application
  2202. easily, the main focus has always been on Linux during the design of
  2203. U-Boot.
  2204. U-Boot includes many features that so far have been part of some
  2205. special "boot loader" code within the Linux kernel. Also, any
  2206. "initrd" images to be used are no longer part of one big Linux image;
  2207. instead, kernel and "initrd" are separate images. This implementation
  2208. serves several purposes:
  2209. - the same features can be used for other OS or standalone
  2210. applications (for instance: using compressed images to reduce the
  2211. Flash memory footprint)
  2212. - it becomes much easier to port new Linux kernel versions because
  2213. lots of low-level, hardware dependent stuff are done by U-Boot
  2214. - the same Linux kernel image can now be used with different "initrd"
  2215. images; of course this also means that different kernel images can
  2216. be run with the same "initrd". This makes testing easier (you don't
  2217. have to build a new "zImage.initrd" Linux image when you just
  2218. change a file in your "initrd"). Also, a field-upgrade of the
  2219. software is easier now.
  2220. Linux HOWTO:
  2221. ============
  2222. Porting Linux to U-Boot based systems:
  2223. ---------------------------------------
  2224. U-Boot cannot save you from doing all the necessary modifications to
  2225. configure the Linux device drivers for use with your target hardware
  2226. (no, we don't intend to provide a full virtual machine interface to
  2227. Linux :-).
  2228. But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
  2229. Just make sure your machine specific header file (for instance
  2230. include/asm-ppc/tqm8xx.h) includes the same definition of the Board
  2231. Information structure as we define in include/asm-<arch>/u-boot.h,
  2232. and make sure that your definition of IMAP_ADDR uses the same value
  2233. as your U-Boot configuration in CONFIG_SYS_IMMR.
  2234. Note that U-Boot now has a driver model, a unified model for drivers.
  2235. If you are adding a new driver, plumb it into driver model. If there
  2236. is no uclass available, you are encouraged to create one. See
  2237. doc/driver-model.
  2238. Configuring the Linux kernel:
  2239. -----------------------------
  2240. No specific requirements for U-Boot. Make sure you have some root
  2241. device (initial ramdisk, NFS) for your target system.
  2242. Building a Linux Image:
  2243. -----------------------
  2244. With U-Boot, "normal" build targets like "zImage" or "bzImage" are
  2245. not used. If you use recent kernel source, a new build target
  2246. "uImage" will exist which automatically builds an image usable by
  2247. U-Boot. Most older kernels also have support for a "pImage" target,
  2248. which was introduced for our predecessor project PPCBoot and uses a
  2249. 100% compatible format.
  2250. Example:
  2251. make TQM850L_defconfig
  2252. make oldconfig
  2253. make dep
  2254. make uImage
  2255. The "uImage" build target uses a special tool (in 'tools/mkimage') to
  2256. encapsulate a compressed Linux kernel image with header information,
  2257. CRC32 checksum etc. for use with U-Boot. This is what we are doing:
  2258. * build a standard "vmlinux" kernel image (in ELF binary format):
  2259. * convert the kernel into a raw binary image:
  2260. ${CROSS_COMPILE}-objcopy -O binary \
  2261. -R .note -R .comment \
  2262. -S vmlinux linux.bin
  2263. * compress the binary image:
  2264. gzip -9 linux.bin
  2265. * package compressed binary image for U-Boot:
  2266. mkimage -A ppc -O linux -T kernel -C gzip \
  2267. -a 0 -e 0 -n "Linux Kernel Image" \
  2268. -d linux.bin.gz uImage
  2269. The "mkimage" tool can also be used to create ramdisk images for use
  2270. with U-Boot, either separated from the Linux kernel image, or
  2271. combined into one file. "mkimage" encapsulates the images with a 64
  2272. byte header containing information about target architecture,
  2273. operating system, image type, compression method, entry points, time
  2274. stamp, CRC32 checksums, etc.
  2275. "mkimage" can be called in two ways: to verify existing images and
  2276. print the header information, or to build new images.
  2277. In the first form (with "-l" option) mkimage lists the information
  2278. contained in the header of an existing U-Boot image; this includes
  2279. checksum verification:
  2280. tools/mkimage -l image
  2281. -l ==> list image header information
  2282. The second form (with "-d" option) is used to build a U-Boot image
  2283. from a "data file" which is used as image payload:
  2284. tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
  2285. -n name -d data_file image
  2286. -A ==> set architecture to 'arch'
  2287. -O ==> set operating system to 'os'
  2288. -T ==> set image type to 'type'
  2289. -C ==> set compression type 'comp'
  2290. -a ==> set load address to 'addr' (hex)
  2291. -e ==> set entry point to 'ep' (hex)
  2292. -n ==> set image name to 'name'
  2293. -d ==> use image data from 'datafile'
  2294. Right now, all Linux kernels for PowerPC systems use the same load
  2295. address (0x00000000), but the entry point address depends on the
  2296. kernel version:
  2297. - 2.2.x kernels have the entry point at 0x0000000C,
  2298. - 2.3.x and later kernels have the entry point at 0x00000000.
  2299. So a typical call to build a U-Boot image would read:
  2300. -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
  2301. > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
  2302. > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
  2303. > examples/uImage.TQM850L
  2304. Image Name: 2.4.4 kernel for TQM850L
  2305. Created: Wed Jul 19 02:34:59 2000
  2306. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2307. Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
  2308. Load Address: 0x00000000
  2309. Entry Point: 0x00000000
  2310. To verify the contents of the image (or check for corruption):
  2311. -> tools/mkimage -l examples/uImage.TQM850L
  2312. Image Name: 2.4.4 kernel for TQM850L
  2313. Created: Wed Jul 19 02:34:59 2000
  2314. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2315. Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
  2316. Load Address: 0x00000000
  2317. Entry Point: 0x00000000
  2318. NOTE: for embedded systems where boot time is critical you can trade
  2319. speed for memory and install an UNCOMPRESSED image instead: this
  2320. needs more space in Flash, but boots much faster since it does not
  2321. need to be uncompressed:
  2322. -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
  2323. -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
  2324. > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
  2325. > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
  2326. > examples/uImage.TQM850L-uncompressed
  2327. Image Name: 2.4.4 kernel for TQM850L
  2328. Created: Wed Jul 19 02:34:59 2000
  2329. Image Type: PowerPC Linux Kernel Image (uncompressed)
  2330. Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
  2331. Load Address: 0x00000000
  2332. Entry Point: 0x00000000
  2333. Similar you can build U-Boot images from a 'ramdisk.image.gz' file
  2334. when your kernel is intended to use an initial ramdisk:
  2335. -> tools/mkimage -n 'Simple Ramdisk Image' \
  2336. > -A ppc -O linux -T ramdisk -C gzip \
  2337. > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
  2338. Image Name: Simple Ramdisk Image
  2339. Created: Wed Jan 12 14:01:50 2000
  2340. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  2341. Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
  2342. Load Address: 0x00000000
  2343. Entry Point: 0x00000000
  2344. The "dumpimage" tool can be used to disassemble or list the contents of images
  2345. built by mkimage. See dumpimage's help output (-h) for details.
  2346. Installing a Linux Image:
  2347. -------------------------
  2348. To downloading a U-Boot image over the serial (console) interface,
  2349. you must convert the image to S-Record format:
  2350. objcopy -I binary -O srec examples/image examples/image.srec
  2351. The 'objcopy' does not understand the information in the U-Boot
  2352. image header, so the resulting S-Record file will be relative to
  2353. address 0x00000000. To load it to a given address, you need to
  2354. specify the target address as 'offset' parameter with the 'loads'
  2355. command.
  2356. Example: install the image to address 0x40100000 (which on the
  2357. TQM8xxL is in the first Flash bank):
  2358. => erase 40100000 401FFFFF
  2359. .......... done
  2360. Erased 8 sectors
  2361. => loads 40100000
  2362. ## Ready for S-Record download ...
  2363. ~>examples/image.srec
  2364. 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
  2365. ...
  2366. 15989 15990 15991 15992
  2367. [file transfer complete]
  2368. [connected]
  2369. ## Start Addr = 0x00000000
  2370. You can check the success of the download using the 'iminfo' command;
  2371. this includes a checksum verification so you can be sure no data
  2372. corruption happened:
  2373. => imi 40100000
  2374. ## Checking Image at 40100000 ...
  2375. Image Name: 2.2.13 for initrd on TQM850L
  2376. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2377. Data Size: 335725 Bytes = 327 kB = 0 MB
  2378. Load Address: 00000000
  2379. Entry Point: 0000000c
  2380. Verifying Checksum ... OK
  2381. Boot Linux:
  2382. -----------
  2383. The "bootm" command is used to boot an application that is stored in
  2384. memory (RAM or Flash). In case of a Linux kernel image, the contents
  2385. of the "bootargs" environment variable is passed to the kernel as
  2386. parameters. You can check and modify this variable using the
  2387. "printenv" and "setenv" commands:
  2388. => printenv bootargs
  2389. bootargs=root=/dev/ram
  2390. => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  2391. => printenv bootargs
  2392. bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  2393. => bootm 40020000
  2394. ## Booting Linux kernel at 40020000 ...
  2395. Image Name: 2.2.13 for NFS on TQM850L
  2396. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2397. Data Size: 381681 Bytes = 372 kB = 0 MB
  2398. Load Address: 00000000
  2399. Entry Point: 0000000c
  2400. Verifying Checksum ... OK
  2401. Uncompressing Kernel Image ... OK
  2402. Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000
  2403. Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  2404. time_init: decrementer frequency = 187500000/60
  2405. Calibrating delay loop... 49.77 BogoMIPS
  2406. Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
  2407. ...
  2408. If you want to boot a Linux kernel with initial RAM disk, you pass
  2409. the memory addresses of both the kernel and the initrd image (PPBCOOT
  2410. format!) to the "bootm" command:
  2411. => imi 40100000 40200000
  2412. ## Checking Image at 40100000 ...
  2413. Image Name: 2.2.13 for initrd on TQM850L
  2414. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2415. Data Size: 335725 Bytes = 327 kB = 0 MB
  2416. Load Address: 00000000
  2417. Entry Point: 0000000c
  2418. Verifying Checksum ... OK
  2419. ## Checking Image at 40200000 ...
  2420. Image Name: Simple Ramdisk Image
  2421. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  2422. Data Size: 566530 Bytes = 553 kB = 0 MB
  2423. Load Address: 00000000
  2424. Entry Point: 00000000
  2425. Verifying Checksum ... OK
  2426. => bootm 40100000 40200000
  2427. ## Booting Linux kernel at 40100000 ...
  2428. Image Name: 2.2.13 for initrd on TQM850L
  2429. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2430. Data Size: 335725 Bytes = 327 kB = 0 MB
  2431. Load Address: 00000000
  2432. Entry Point: 0000000c
  2433. Verifying Checksum ... OK
  2434. Uncompressing Kernel Image ... OK
  2435. ## Loading RAMDisk Image at 40200000 ...
  2436. Image Name: Simple Ramdisk Image
  2437. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  2438. Data Size: 566530 Bytes = 553 kB = 0 MB
  2439. Load Address: 00000000
  2440. Entry Point: 00000000
  2441. Verifying Checksum ... OK
  2442. Loading Ramdisk ... OK
  2443. Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000
  2444. Boot arguments: root=/dev/ram
  2445. time_init: decrementer frequency = 187500000/60
  2446. Calibrating delay loop... 49.77 BogoMIPS
  2447. ...
  2448. RAMDISK: Compressed image found at block 0
  2449. VFS: Mounted root (ext2 filesystem).
  2450. bash#
  2451. Boot Linux and pass a flat device tree:
  2452. -----------
  2453. First, U-Boot must be compiled with the appropriate defines. See the section
  2454. titled "Linux Kernel Interface" above for a more in depth explanation. The
  2455. following is an example of how to start a kernel and pass an updated
  2456. flat device tree:
  2457. => print oftaddr
  2458. oftaddr=0x300000
  2459. => print oft
  2460. oft=oftrees/mpc8540ads.dtb
  2461. => tftp $oftaddr $oft
  2462. Speed: 1000, full duplex
  2463. Using TSEC0 device
  2464. TFTP from server 192.168.1.1; our IP address is 192.168.1.101
  2465. Filename 'oftrees/mpc8540ads.dtb'.
  2466. Load address: 0x300000
  2467. Loading: #
  2468. done
  2469. Bytes transferred = 4106 (100a hex)
  2470. => tftp $loadaddr $bootfile
  2471. Speed: 1000, full duplex
  2472. Using TSEC0 device
  2473. TFTP from server 192.168.1.1; our IP address is 192.168.1.2
  2474. Filename 'uImage'.
  2475. Load address: 0x200000
  2476. Loading:############
  2477. done
  2478. Bytes transferred = 1029407 (fb51f hex)
  2479. => print loadaddr
  2480. loadaddr=200000
  2481. => print oftaddr
  2482. oftaddr=0x300000
  2483. => bootm $loadaddr - $oftaddr
  2484. ## Booting image at 00200000 ...
  2485. Image Name: Linux-2.6.17-dirty
  2486. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2487. Data Size: 1029343 Bytes = 1005.2 kB
  2488. Load Address: 00000000
  2489. Entry Point: 00000000
  2490. Verifying Checksum ... OK
  2491. Uncompressing Kernel Image ... OK
  2492. Booting using flat device tree at 0x300000
  2493. Using MPC85xx ADS machine description
  2494. Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
  2495. [snip]
  2496. More About U-Boot Image Types:
  2497. ------------------------------
  2498. U-Boot supports the following image types:
  2499. "Standalone Programs" are directly runnable in the environment
  2500. provided by U-Boot; it is expected that (if they behave
  2501. well) you can continue to work in U-Boot after return from
  2502. the Standalone Program.
  2503. "OS Kernel Images" are usually images of some Embedded OS which
  2504. will take over control completely. Usually these programs
  2505. will install their own set of exception handlers, device
  2506. drivers, set up the MMU, etc. - this means, that you cannot
  2507. expect to re-enter U-Boot except by resetting the CPU.
  2508. "RAMDisk Images" are more or less just data blocks, and their
  2509. parameters (address, size) are passed to an OS kernel that is
  2510. being started.
  2511. "Multi-File Images" contain several images, typically an OS
  2512. (Linux) kernel image and one or more data images like
  2513. RAMDisks. This construct is useful for instance when you want
  2514. to boot over the network using BOOTP etc., where the boot
  2515. server provides just a single image file, but you want to get
  2516. for instance an OS kernel and a RAMDisk image.
  2517. "Multi-File Images" start with a list of image sizes, each
  2518. image size (in bytes) specified by an "uint32_t" in network
  2519. byte order. This list is terminated by an "(uint32_t)0".
  2520. Immediately after the terminating 0 follow the images, one by
  2521. one, all aligned on "uint32_t" boundaries (size rounded up to
  2522. a multiple of 4 bytes).
  2523. "Firmware Images" are binary images containing firmware (like
  2524. U-Boot or FPGA images) which usually will be programmed to
  2525. flash memory.
  2526. "Script files" are command sequences that will be executed by
  2527. U-Boot's command interpreter; this feature is especially
  2528. useful when you configure U-Boot to use a real shell (hush)
  2529. as command interpreter.
  2530. Booting the Linux zImage:
  2531. -------------------------
  2532. On some platforms, it's possible to boot Linux zImage. This is done
  2533. using the "bootz" command. The syntax of "bootz" command is the same
  2534. as the syntax of "bootm" command.
  2535. Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
  2536. kernel with raw initrd images. The syntax is slightly different, the
  2537. address of the initrd must be augmented by it's size, in the following
  2538. format: "<initrd addres>:<initrd size>".
  2539. Standalone HOWTO:
  2540. =================
  2541. One of the features of U-Boot is that you can dynamically load and
  2542. run "standalone" applications, which can use some resources of
  2543. U-Boot like console I/O functions or interrupt services.
  2544. Two simple examples are included with the sources:
  2545. "Hello World" Demo:
  2546. -------------------
  2547. 'examples/hello_world.c' contains a small "Hello World" Demo
  2548. application; it is automatically compiled when you build U-Boot.
  2549. It's configured to run at address 0x00040004, so you can play with it
  2550. like that:
  2551. => loads
  2552. ## Ready for S-Record download ...
  2553. ~>examples/hello_world.srec
  2554. 1 2 3 4 5 6 7 8 9 10 11 ...
  2555. [file transfer complete]
  2556. [connected]
  2557. ## Start Addr = 0x00040004
  2558. => go 40004 Hello World! This is a test.
  2559. ## Starting application at 0x00040004 ...
  2560. Hello World
  2561. argc = 7
  2562. argv[0] = "40004"
  2563. argv[1] = "Hello"
  2564. argv[2] = "World!"
  2565. argv[3] = "This"
  2566. argv[4] = "is"
  2567. argv[5] = "a"
  2568. argv[6] = "test."
  2569. argv[7] = "<NULL>"
  2570. Hit any key to exit ...
  2571. ## Application terminated, rc = 0x0
  2572. Another example, which demonstrates how to register a CPM interrupt
  2573. handler with the U-Boot code, can be found in 'examples/timer.c'.
  2574. Here, a CPM timer is set up to generate an interrupt every second.
  2575. The interrupt service routine is trivial, just printing a '.'
  2576. character, but this is just a demo program. The application can be
  2577. controlled by the following keys:
  2578. ? - print current values og the CPM Timer registers
  2579. b - enable interrupts and start timer
  2580. e - stop timer and disable interrupts
  2581. q - quit application
  2582. => loads
  2583. ## Ready for S-Record download ...
  2584. ~>examples/timer.srec
  2585. 1 2 3 4 5 6 7 8 9 10 11 ...
  2586. [file transfer complete]
  2587. [connected]
  2588. ## Start Addr = 0x00040004
  2589. => go 40004
  2590. ## Starting application at 0x00040004 ...
  2591. TIMERS=0xfff00980
  2592. Using timer 1
  2593. tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
  2594. Hit 'b':
  2595. [q, b, e, ?] Set interval 1000000 us
  2596. Enabling timer
  2597. Hit '?':
  2598. [q, b, e, ?] ........
  2599. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
  2600. Hit '?':
  2601. [q, b, e, ?] .
  2602. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
  2603. Hit '?':
  2604. [q, b, e, ?] .
  2605. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
  2606. Hit '?':
  2607. [q, b, e, ?] .
  2608. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
  2609. Hit 'e':
  2610. [q, b, e, ?] ...Stopping timer
  2611. Hit 'q':
  2612. [q, b, e, ?] ## Application terminated, rc = 0x0
  2613. Minicom warning:
  2614. ================
  2615. Over time, many people have reported problems when trying to use the
  2616. "minicom" terminal emulation program for serial download. I (wd)
  2617. consider minicom to be broken, and recommend not to use it. Under
  2618. Unix, I recommend to use C-Kermit for general purpose use (and
  2619. especially for kermit binary protocol download ("loadb" command), and
  2620. use "cu" for S-Record download ("loads" command). See
  2621. https://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
  2622. for help with kermit.
  2623. Nevertheless, if you absolutely want to use it try adding this
  2624. configuration to your "File transfer protocols" section:
  2625. Name Program Name U/D FullScr IO-Red. Multi
  2626. X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
  2627. Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
  2628. NetBSD Notes:
  2629. =============
  2630. Starting at version 0.9.2, U-Boot supports NetBSD both as host
  2631. (build U-Boot) and target system (boots NetBSD/mpc8xx).
  2632. Building requires a cross environment; it is known to work on
  2633. NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
  2634. need gmake since the Makefiles are not compatible with BSD make).
  2635. Note that the cross-powerpc package does not install include files;
  2636. attempting to build U-Boot will fail because <machine/ansi.h> is
  2637. missing. This file has to be installed and patched manually:
  2638. # cd /usr/pkg/cross/powerpc-netbsd/include
  2639. # mkdir powerpc
  2640. # ln -s powerpc machine
  2641. # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
  2642. # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
  2643. Native builds *don't* work due to incompatibilities between native
  2644. and U-Boot include files.
  2645. Booting assumes that (the first part of) the image booted is a
  2646. stage-2 loader which in turn loads and then invokes the kernel
  2647. proper. Loader sources will eventually appear in the NetBSD source
  2648. tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
  2649. meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
  2650. Implementation Internals:
  2651. =========================
  2652. The following is not intended to be a complete description of every
  2653. implementation detail. However, it should help to understand the
  2654. inner workings of U-Boot and make it easier to port it to custom
  2655. hardware.
  2656. Initial Stack, Global Data:
  2657. ---------------------------
  2658. The implementation of U-Boot is complicated by the fact that U-Boot
  2659. starts running out of ROM (flash memory), usually without access to
  2660. system RAM (because the memory controller is not initialized yet).
  2661. This means that we don't have writable Data or BSS segments, and BSS
  2662. is not initialized as zero. To be able to get a C environment working
  2663. at all, we have to allocate at least a minimal stack. Implementation
  2664. options for this are defined and restricted by the CPU used: Some CPU
  2665. models provide on-chip memory (like the IMMR area on MPC8xx and
  2666. MPC826x processors), on others (parts of) the data cache can be
  2667. locked as (mis-) used as memory, etc.
  2668. Chris Hallinan posted a good summary of these issues to the
  2669. U-Boot mailing list:
  2670. Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
  2671. From: "Chris Hallinan" <clh@net1plus.com>
  2672. Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
  2673. ...
  2674. Correct me if I'm wrong, folks, but the way I understand it
  2675. is this: Using DCACHE as initial RAM for Stack, etc, does not
  2676. require any physical RAM backing up the cache. The cleverness
  2677. is that the cache is being used as a temporary supply of
  2678. necessary storage before the SDRAM controller is setup. It's
  2679. beyond the scope of this list to explain the details, but you
  2680. can see how this works by studying the cache architecture and
  2681. operation in the architecture and processor-specific manuals.
  2682. OCM is On Chip Memory, which I believe the 405GP has 4K. It
  2683. is another option for the system designer to use as an
  2684. initial stack/RAM area prior to SDRAM being available. Either
  2685. option should work for you. Using CS 4 should be fine if your
  2686. board designers haven't used it for something that would
  2687. cause you grief during the initial boot! It is frequently not
  2688. used.
  2689. CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
  2690. with your processor/board/system design. The default value
  2691. you will find in any recent u-boot distribution in
  2692. walnut.h should work for you. I'd set it to a value larger
  2693. than your SDRAM module. If you have a 64MB SDRAM module, set
  2694. it above 400_0000. Just make sure your board has no resources
  2695. that are supposed to respond to that address! That code in
  2696. start.S has been around a while and should work as is when
  2697. you get the config right.
  2698. -Chris Hallinan
  2699. DS4.COM, Inc.
  2700. It is essential to remember this, since it has some impact on the C
  2701. code for the initialization procedures:
  2702. * Initialized global data (data segment) is read-only. Do not attempt
  2703. to write it.
  2704. * Do not use any uninitialized global data (or implicitly initialized
  2705. as zero data - BSS segment) at all - this is undefined, initiali-
  2706. zation is performed later (when relocating to RAM).
  2707. * Stack space is very limited. Avoid big data buffers or things like
  2708. that.
  2709. Having only the stack as writable memory limits means we cannot use
  2710. normal global data to share information between the code. But it
  2711. turned out that the implementation of U-Boot can be greatly
  2712. simplified by making a global data structure (gd_t) available to all
  2713. functions. We could pass a pointer to this data as argument to _all_
  2714. functions, but this would bloat the code. Instead we use a feature of
  2715. the GCC compiler (Global Register Variables) to share the data: we
  2716. place a pointer (gd) to the global data into a register which we
  2717. reserve for this purpose.
  2718. When choosing a register for such a purpose we are restricted by the
  2719. relevant (E)ABI specifications for the current architecture, and by
  2720. GCC's implementation.
  2721. For PowerPC, the following registers have specific use:
  2722. R1: stack pointer
  2723. R2: reserved for system use
  2724. R3-R4: parameter passing and return values
  2725. R5-R10: parameter passing
  2726. R13: small data area pointer
  2727. R30: GOT pointer
  2728. R31: frame pointer
  2729. (U-Boot also uses R12 as internal GOT pointer. r12
  2730. is a volatile register so r12 needs to be reset when
  2731. going back and forth between asm and C)
  2732. ==> U-Boot will use R2 to hold a pointer to the global data
  2733. Note: on PPC, we could use a static initializer (since the
  2734. address of the global data structure is known at compile time),
  2735. but it turned out that reserving a register results in somewhat
  2736. smaller code - although the code savings are not that big (on
  2737. average for all boards 752 bytes for the whole U-Boot image,
  2738. 624 text + 127 data).
  2739. On ARM, the following registers are used:
  2740. R0: function argument word/integer result
  2741. R1-R3: function argument word
  2742. R9: platform specific
  2743. R10: stack limit (used only if stack checking is enabled)
  2744. R11: argument (frame) pointer
  2745. R12: temporary workspace
  2746. R13: stack pointer
  2747. R14: link register
  2748. R15: program counter
  2749. ==> U-Boot will use R9 to hold a pointer to the global data
  2750. Note: on ARM, only R_ARM_RELATIVE relocations are supported.
  2751. On Nios II, the ABI is documented here:
  2752. https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
  2753. ==> U-Boot will use gp to hold a pointer to the global data
  2754. Note: on Nios II, we give "-G0" option to gcc and don't use gp
  2755. to access small data sections, so gp is free.
  2756. On NDS32, the following registers are used:
  2757. R0-R1: argument/return
  2758. R2-R5: argument
  2759. R15: temporary register for assembler
  2760. R16: trampoline register
  2761. R28: frame pointer (FP)
  2762. R29: global pointer (GP)
  2763. R30: link register (LP)
  2764. R31: stack pointer (SP)
  2765. PC: program counter (PC)
  2766. ==> U-Boot will use R10 to hold a pointer to the global data
  2767. NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
  2768. or current versions of GCC may "optimize" the code too much.
  2769. On RISC-V, the following registers are used:
  2770. x0: hard-wired zero (zero)
  2771. x1: return address (ra)
  2772. x2: stack pointer (sp)
  2773. x3: global pointer (gp)
  2774. x4: thread pointer (tp)
  2775. x5: link register (t0)
  2776. x8: frame pointer (fp)
  2777. x10-x11: arguments/return values (a0-1)
  2778. x12-x17: arguments (a2-7)
  2779. x28-31: temporaries (t3-6)
  2780. pc: program counter (pc)
  2781. ==> U-Boot will use gp to hold a pointer to the global data
  2782. Memory Management:
  2783. ------------------
  2784. U-Boot runs in system state and uses physical addresses, i.e. the
  2785. MMU is not used either for address mapping nor for memory protection.
  2786. The available memory is mapped to fixed addresses using the memory
  2787. controller. In this process, a contiguous block is formed for each
  2788. memory type (Flash, SDRAM, SRAM), even when it consists of several
  2789. physical memory banks.
  2790. U-Boot is installed in the first 128 kB of the first Flash bank (on
  2791. TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
  2792. booting and sizing and initializing DRAM, the code relocates itself
  2793. to the upper end of DRAM. Immediately below the U-Boot code some
  2794. memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
  2795. configuration setting]. Below that, a structure with global Board
  2796. Info data is placed, followed by the stack (growing downward).
  2797. Additionally, some exception handler code is copied to the low 8 kB
  2798. of DRAM (0x00000000 ... 0x00001FFF).
  2799. So a typical memory configuration with 16 MB of DRAM could look like
  2800. this:
  2801. 0x0000 0000 Exception Vector code
  2802. :
  2803. 0x0000 1FFF
  2804. 0x0000 2000 Free for Application Use
  2805. :
  2806. :
  2807. :
  2808. :
  2809. 0x00FB FF20 Monitor Stack (Growing downward)
  2810. 0x00FB FFAC Board Info Data and permanent copy of global data
  2811. 0x00FC 0000 Malloc Arena
  2812. :
  2813. 0x00FD FFFF
  2814. 0x00FE 0000 RAM Copy of Monitor Code
  2815. ... eventually: LCD or video framebuffer
  2816. ... eventually: pRAM (Protected RAM - unchanged by reset)
  2817. 0x00FF FFFF [End of RAM]
  2818. System Initialization:
  2819. ----------------------
  2820. In the reset configuration, U-Boot starts at the reset entry point
  2821. (on most PowerPC systems at address 0x00000100). Because of the reset
  2822. configuration for CS0# this is a mirror of the on board Flash memory.
  2823. To be able to re-map memory U-Boot then jumps to its link address.
  2824. To be able to implement the initialization code in C, a (small!)
  2825. initial stack is set up in the internal Dual Ported RAM (in case CPUs
  2826. which provide such a feature like), or in a locked part of the data
  2827. cache. After that, U-Boot initializes the CPU core, the caches and
  2828. the SIU.
  2829. Next, all (potentially) available memory banks are mapped using a
  2830. preliminary mapping. For example, we put them on 512 MB boundaries
  2831. (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
  2832. on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
  2833. programmed for SDRAM access. Using the temporary configuration, a
  2834. simple memory test is run that determines the size of the SDRAM
  2835. banks.
  2836. When there is more than one SDRAM bank, and the banks are of
  2837. different size, the largest is mapped first. For equal size, the first
  2838. bank (CS2#) is mapped first. The first mapping is always for address
  2839. 0x00000000, with any additional banks following immediately to create
  2840. contiguous memory starting from 0.
  2841. Then, the monitor installs itself at the upper end of the SDRAM area
  2842. and allocates memory for use by malloc() and for the global Board
  2843. Info data; also, the exception vector code is copied to the low RAM
  2844. pages, and the final stack is set up.
  2845. Only after this relocation will you have a "normal" C environment;
  2846. until that you are restricted in several ways, mostly because you are
  2847. running from ROM, and because the code will have to be relocated to a
  2848. new address in RAM.
  2849. U-Boot Porting Guide:
  2850. ----------------------
  2851. [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
  2852. list, October 2002]
  2853. int main(int argc, char *argv[])
  2854. {
  2855. sighandler_t no_more_time;
  2856. signal(SIGALRM, no_more_time);
  2857. alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
  2858. if (available_money > available_manpower) {
  2859. Pay consultant to port U-Boot;
  2860. return 0;
  2861. }
  2862. Download latest U-Boot source;
  2863. Subscribe to u-boot mailing list;
  2864. if (clueless)
  2865. email("Hi, I am new to U-Boot, how do I get started?");
  2866. while (learning) {
  2867. Read the README file in the top level directory;
  2868. Read https://www.denx.de/wiki/bin/view/DULG/Manual;
  2869. Read applicable doc/README.*;
  2870. Read the source, Luke;
  2871. /* find . -name "*.[chS]" | xargs grep -i <keyword> */
  2872. }
  2873. if (available_money > toLocalCurrency ($2500))
  2874. Buy a BDI3000;
  2875. else
  2876. Add a lot of aggravation and time;
  2877. if (a similar board exists) { /* hopefully... */
  2878. cp -a board/<similar> board/<myboard>
  2879. cp include/configs/<similar>.h include/configs/<myboard>.h
  2880. } else {
  2881. Create your own board support subdirectory;
  2882. Create your own board include/configs/<myboard>.h file;
  2883. }
  2884. Edit new board/<myboard> files
  2885. Edit new include/configs/<myboard>.h
  2886. while (!accepted) {
  2887. while (!running) {
  2888. do {
  2889. Add / modify source code;
  2890. } until (compiles);
  2891. Debug;
  2892. if (clueless)
  2893. email("Hi, I am having problems...");
  2894. }
  2895. Send patch file to the U-Boot email list;
  2896. if (reasonable critiques)
  2897. Incorporate improvements from email list code review;
  2898. else
  2899. Defend code as written;
  2900. }
  2901. return 0;
  2902. }
  2903. void no_more_time (int sig)
  2904. {
  2905. hire_a_guru();
  2906. }
  2907. Coding Standards:
  2908. -----------------
  2909. All contributions to U-Boot should conform to the Linux kernel
  2910. coding style; see the kernel coding style guide at
  2911. https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
  2912. script "scripts/Lindent" in your Linux kernel source directory.
  2913. Source files originating from a different project (for example the
  2914. MTD subsystem) are generally exempt from these guidelines and are not
  2915. reformatted to ease subsequent migration to newer versions of those
  2916. sources.
  2917. Please note that U-Boot is implemented in C (and to some small parts in
  2918. Assembler); no C++ is used, so please do not use C++ style comments (//)
  2919. in your code.
  2920. Please also stick to the following formatting rules:
  2921. - remove any trailing white space
  2922. - use TAB characters for indentation and vertical alignment, not spaces
  2923. - make sure NOT to use DOS '\r\n' line feeds
  2924. - do not add more than 2 consecutive empty lines to source files
  2925. - do not add trailing empty lines to source files
  2926. Submissions which do not conform to the standards may be returned
  2927. with a request to reformat the changes.
  2928. Submitting Patches:
  2929. -------------------
  2930. Since the number of patches for U-Boot is growing, we need to
  2931. establish some rules. Submissions which do not conform to these rules
  2932. may be rejected, even when they contain important and valuable stuff.
  2933. Please see https://www.denx.de/wiki/U-Boot/Patches for details.
  2934. Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
  2935. see https://lists.denx.de/listinfo/u-boot
  2936. When you send a patch, please include the following information with
  2937. it:
  2938. * For bug fixes: a description of the bug and how your patch fixes
  2939. this bug. Please try to include a way of demonstrating that the
  2940. patch actually fixes something.
  2941. * For new features: a description of the feature and your
  2942. implementation.
  2943. * For major contributions, add a MAINTAINERS file with your
  2944. information and associated file and directory references.
  2945. * When you add support for a new board, don't forget to add a
  2946. maintainer e-mail address to the boards.cfg file, too.
  2947. * If your patch adds new configuration options, don't forget to
  2948. document these in the README file.
  2949. * The patch itself. If you are using git (which is *strongly*
  2950. recommended) you can easily generate the patch using the
  2951. "git format-patch". If you then use "git send-email" to send it to
  2952. the U-Boot mailing list, you will avoid most of the common problems
  2953. with some other mail clients.
  2954. If you cannot use git, use "diff -purN OLD NEW". If your version of
  2955. diff does not support these options, then get the latest version of
  2956. GNU diff.
  2957. The current directory when running this command shall be the parent
  2958. directory of the U-Boot source tree (i. e. please make sure that
  2959. your patch includes sufficient directory information for the
  2960. affected files).
  2961. We prefer patches as plain text. MIME attachments are discouraged,
  2962. and compressed attachments must not be used.
  2963. * If one logical set of modifications affects or creates several
  2964. files, all these changes shall be submitted in a SINGLE patch file.
  2965. * Changesets that contain different, unrelated modifications shall be
  2966. submitted as SEPARATE patches, one patch per changeset.
  2967. Notes:
  2968. * Before sending the patch, run the buildman script on your patched
  2969. source tree and make sure that no errors or warnings are reported
  2970. for any of the boards.
  2971. * Keep your modifications to the necessary minimum: A patch
  2972. containing several unrelated changes or arbitrary reformats will be
  2973. returned with a request to re-formatting / split it.
  2974. * If you modify existing code, make sure that your new code does not
  2975. add to the memory footprint of the code ;-) Small is beautiful!
  2976. When adding new features, these should compile conditionally only
  2977. (using #ifdef), and the resulting code with the new feature
  2978. disabled must not need more memory than the old code without your
  2979. modification.
  2980. * Remember that there is a size limit of 100 kB per message on the
  2981. u-boot mailing list. Bigger patches will be moderated. If they are
  2982. reasonable and not too big, they will be acknowledged. But patches
  2983. bigger than the size limit should be avoided.