README 133 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960
  1. #
  2. # (C) Copyright 2000 - 2008
  3. # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  4. #
  5. # See file CREDITS for list of people who contributed to this
  6. # project.
  7. #
  8. # This program is free software; you can redistribute it and/or
  9. # modify it under the terms of the GNU General Public License as
  10. # published by the Free Software Foundation; either version 2 of
  11. # the License, or (at your option) any later version.
  12. #
  13. # This program is distributed in the hope that it will be useful,
  14. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. # GNU General Public License for more details.
  17. #
  18. # You should have received a copy of the GNU General Public License
  19. # along with this program; if not, write to the Free Software
  20. # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21. # MA 02111-1307 USA
  22. #
  23. Summary:
  24. ========
  25. This directory contains the source code for U-Boot, a boot loader for
  26. Embedded boards based on PowerPC, ARM, MIPS and several other
  27. processors, which can be installed in a boot ROM and used to
  28. initialize and test the hardware or to download and run application
  29. code.
  30. The development of U-Boot is closely related to Linux: some parts of
  31. the source code originate in the Linux source tree, we have some
  32. header files in common, and special provision has been made to
  33. support booting of Linux images.
  34. Some attention has been paid to make this software easily
  35. configurable and extendable. For instance, all monitor commands are
  36. implemented with the same call interface, so that it's very easy to
  37. add new commands. Also, instead of permanently adding rarely used
  38. code (for instance hardware test utilities) to the monitor, you can
  39. load and run it dynamically.
  40. Status:
  41. =======
  42. In general, all boards for which a configuration option exists in the
  43. Makefile have been tested to some extent and can be considered
  44. "working". In fact, many of them are used in production systems.
  45. In case of problems see the CHANGELOG and CREDITS files to find out
  46. who contributed the specific port. The MAINTAINERS file lists board
  47. maintainers.
  48. Where to get help:
  49. ==================
  50. In case you have questions about, problems with or contributions for
  51. U-Boot you should send a message to the U-Boot mailing list at
  52. <u-boot-users@lists.sourceforge.net>. There is also an archive of
  53. previous traffic on the mailing list - please search the archive
  54. before asking FAQ's. Please see
  55. http://lists.sourceforge.net/lists/listinfo/u-boot-users/
  56. Where to get source code:
  57. =========================
  58. The U-Boot source code is maintained in the git repository at
  59. git://www.denx.de/git/u-boot.git ; you can browse it online at
  60. http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
  61. The "snapshot" links on this page allow you to download tarballs of
  62. any version you might be interested in. Ofifcial releases are also
  63. available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
  64. directory.
  65. Pre-built (and tested) images are available from
  66. ftp://ftp.denx.de/pub/u-boot/images/
  67. Where we come from:
  68. ===================
  69. - start from 8xxrom sources
  70. - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
  71. - clean up code
  72. - make it easier to add custom boards
  73. - make it possible to add other [PowerPC] CPUs
  74. - extend functions, especially:
  75. * Provide extended interface to Linux boot loader
  76. * S-Record download
  77. * network boot
  78. * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
  79. - create ARMBoot project (http://sourceforge.net/projects/armboot)
  80. - add other CPU families (starting with ARM)
  81. - create U-Boot project (http://sourceforge.net/projects/u-boot)
  82. - current project page: see http://www.denx.de/wiki/UBoot
  83. Names and Spelling:
  84. ===================
  85. The "official" name of this project is "Das U-Boot". The spelling
  86. "U-Boot" shall be used in all written text (documentation, comments
  87. in source files etc.). Example:
  88. This is the README file for the U-Boot project.
  89. File names etc. shall be based on the string "u-boot". Examples:
  90. include/asm-ppc/u-boot.h
  91. #include <asm/u-boot.h>
  92. Variable names, preprocessor constants etc. shall be either based on
  93. the string "u_boot" or on "U_BOOT". Example:
  94. U_BOOT_VERSION u_boot_logo
  95. IH_OS_U_BOOT u_boot_hush_start
  96. Versioning:
  97. ===========
  98. U-Boot uses a 3 level version number containing a version, a
  99. sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
  100. sub-version "34", and patchlevel "4".
  101. The patchlevel is used to indicate certain stages of development
  102. between released versions, i. e. officially released versions of
  103. U-Boot will always have a patchlevel of "0".
  104. Directory Hierarchy:
  105. ====================
  106. - board Board dependent files
  107. - common Misc architecture independent functions
  108. - cpu CPU specific files
  109. - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
  110. - arm720t Files specific to ARM 720 CPUs
  111. - arm920t Files specific to ARM 920 CPUs
  112. - at91rm9200 Files specific to Atmel AT91RM9200 CPU
  113. - imx Files specific to Freescale MC9328 i.MX CPUs
  114. - s3c24x0 Files specific to Samsung S3C24X0 CPUs
  115. - arm925t Files specific to ARM 925 CPUs
  116. - arm926ejs Files specific to ARM 926 CPUs
  117. - arm1136 Files specific to ARM 1136 CPUs
  118. - at32ap Files specific to Atmel AVR32 AP CPUs
  119. - i386 Files specific to i386 CPUs
  120. - ixp Files specific to Intel XScale IXP CPUs
  121. - leon2 Files specific to Gaisler LEON2 SPARC CPU
  122. - leon3 Files specific to Gaisler LEON3 SPARC CPU
  123. - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
  124. - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
  125. - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
  126. - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
  127. - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
  128. - mips Files specific to MIPS CPUs
  129. - mpc5xx Files specific to Freescale MPC5xx CPUs
  130. - mpc5xxx Files specific to Freescale MPC5xxx CPUs
  131. - mpc8xx Files specific to Freescale MPC8xx CPUs
  132. - mpc8220 Files specific to Freescale MPC8220 CPUs
  133. - mpc824x Files specific to Freescale MPC824x CPUs
  134. - mpc8260 Files specific to Freescale MPC8260 CPUs
  135. - mpc85xx Files specific to Freescale MPC85xx CPUs
  136. - nios Files specific to Altera NIOS CPUs
  137. - nios2 Files specific to Altera Nios-II CPUs
  138. - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
  139. - pxa Files specific to Intel XScale PXA CPUs
  140. - s3c44b0 Files specific to Samsung S3C44B0 CPUs
  141. - sa1100 Files specific to Intel StrongARM SA1100 CPUs
  142. - disk Code for disk drive partition handling
  143. - doc Documentation (don't expect too much)
  144. - drivers Commonly used device drivers
  145. - dtt Digital Thermometer and Thermostat drivers
  146. - examples Example code for standalone applications, etc.
  147. - include Header Files
  148. - lib_arm Files generic to ARM architecture
  149. - lib_avr32 Files generic to AVR32 architecture
  150. - lib_generic Files generic to all architectures
  151. - lib_i386 Files generic to i386 architecture
  152. - lib_m68k Files generic to m68k architecture
  153. - lib_mips Files generic to MIPS architecture
  154. - lib_nios Files generic to NIOS architecture
  155. - lib_ppc Files generic to PowerPC architecture
  156. - lib_sparc Files generic to SPARC architecture
  157. - libfdt Library files to support flattened device trees
  158. - net Networking code
  159. - post Power On Self Test
  160. - rtc Real Time Clock drivers
  161. - tools Tools to build S-Record or U-Boot images, etc.
  162. Software Configuration:
  163. =======================
  164. Configuration is usually done using C preprocessor defines; the
  165. rationale behind that is to avoid dead code whenever possible.
  166. There are two classes of configuration variables:
  167. * Configuration _OPTIONS_:
  168. These are selectable by the user and have names beginning with
  169. "CONFIG_".
  170. * Configuration _SETTINGS_:
  171. These depend on the hardware etc. and should not be meddled with if
  172. you don't know what you're doing; they have names beginning with
  173. "CFG_".
  174. Later we will add a configuration tool - probably similar to or even
  175. identical to what's used for the Linux kernel. Right now, we have to
  176. do the configuration by hand, which means creating some symbolic
  177. links and editing some configuration files. We use the TQM8xxL boards
  178. as an example here.
  179. Selection of Processor Architecture and Board Type:
  180. ---------------------------------------------------
  181. For all supported boards there are ready-to-use default
  182. configurations available; just type "make <board_name>_config".
  183. Example: For a TQM823L module type:
  184. cd u-boot
  185. make TQM823L_config
  186. For the Cogent platform, you need to specify the cpu type as well;
  187. e.g. "make cogent_mpc8xx_config". And also configure the cogent
  188. directory according to the instructions in cogent/README.
  189. Configuration Options:
  190. ----------------------
  191. Configuration depends on the combination of board and CPU type; all
  192. such information is kept in a configuration file
  193. "include/configs/<board_name>.h".
  194. Example: For a TQM823L module, all configuration settings are in
  195. "include/configs/TQM823L.h".
  196. Many of the options are named exactly as the corresponding Linux
  197. kernel configuration options. The intention is to make it easier to
  198. build a config tool - later.
  199. The following options need to be configured:
  200. - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
  201. - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
  202. - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
  203. Define exactly one, e.g. CONFIG_ATSTK1002
  204. - CPU Module Type: (if CONFIG_COGENT is defined)
  205. Define exactly one of
  206. CONFIG_CMA286_60_OLD
  207. --- FIXME --- not tested yet:
  208. CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
  209. CONFIG_CMA287_23, CONFIG_CMA287_50
  210. - Motherboard Type: (if CONFIG_COGENT is defined)
  211. Define exactly one of
  212. CONFIG_CMA101, CONFIG_CMA102
  213. - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
  214. Define one or more of
  215. CONFIG_CMA302
  216. - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
  217. Define one or more of
  218. CONFIG_LCD_HEARTBEAT - update a character position on
  219. the lcd display every second with
  220. a "rotator" |\-/|\-/
  221. - Board flavour: (if CONFIG_MPC8260ADS is defined)
  222. CONFIG_ADSTYPE
  223. Possible values are:
  224. CFG_8260ADS - original MPC8260ADS
  225. CFG_8266ADS - MPC8266ADS
  226. CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
  227. CFG_8272ADS - MPC8272ADS
  228. - MPC824X Family Member (if CONFIG_MPC824X is defined)
  229. Define exactly one of
  230. CONFIG_MPC8240, CONFIG_MPC8245
  231. - 8xx CPU Options: (if using an MPC8xx cpu)
  232. CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
  233. get_gclk_freq() cannot work
  234. e.g. if there is no 32KHz
  235. reference PIT/RTC clock
  236. CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
  237. or XTAL/EXTAL)
  238. - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
  239. CFG_8xx_CPUCLK_MIN
  240. CFG_8xx_CPUCLK_MAX
  241. CONFIG_8xx_CPUCLK_DEFAULT
  242. See doc/README.MPC866
  243. CFG_MEASURE_CPUCLK
  244. Define this to measure the actual CPU clock instead
  245. of relying on the correctness of the configured
  246. values. Mostly useful for board bringup to make sure
  247. the PLL is locked at the intended frequency. Note
  248. that this requires a (stable) reference clock (32 kHz
  249. RTC clock or CFG_8XX_XIN)
  250. - Intel Monahans options:
  251. CFG_MONAHANS_RUN_MODE_OSC_RATIO
  252. Defines the Monahans run mode to oscillator
  253. ratio. Valid values are 8, 16, 24, 31. The core
  254. frequency is this value multiplied by 13 MHz.
  255. CFG_MONAHANS_TURBO_RUN_MODE_RATIO
  256. Defines the Monahans turbo mode to oscillator
  257. ratio. Valid values are 1 (default if undefined) and
  258. 2. The core frequency as calculated above is multiplied
  259. by this value.
  260. - Linux Kernel Interface:
  261. CONFIG_CLOCKS_IN_MHZ
  262. U-Boot stores all clock information in Hz
  263. internally. For binary compatibility with older Linux
  264. kernels (which expect the clocks passed in the
  265. bd_info data to be in MHz) the environment variable
  266. "clocks_in_mhz" can be defined so that U-Boot
  267. converts clock data to MHZ before passing it to the
  268. Linux kernel.
  269. When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
  270. "clocks_in_mhz=1" is automatically included in the
  271. default environment.
  272. CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
  273. When transfering memsize parameter to linux, some versions
  274. expect it to be in bytes, others in MB.
  275. Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
  276. CONFIG_OF_LIBFDT / CONFIG_OF_FLAT_TREE
  277. New kernel versions are expecting firmware settings to be
  278. passed using flattened device trees (based on open firmware
  279. concepts).
  280. CONFIG_OF_LIBFDT
  281. * New libfdt-based support
  282. * Adds the "fdt" command
  283. * The bootm command automatically updates the fdt
  284. CONFIG_OF_FLAT_TREE
  285. * Deprecated, see CONFIG_OF_LIBFDT
  286. * Original ft_build.c-based support
  287. * Automatically modifies the dft as part of the bootm command
  288. * The environment variable "disable_of", when set,
  289. disables this functionality.
  290. OF_CPU - The proper name of the cpus node.
  291. OF_SOC - The proper name of the soc node.
  292. OF_TBCLK - The timebase frequency.
  293. OF_STDOUT_PATH - The path to the console device
  294. boards with QUICC Engines require OF_QE to set UCC mac addresses
  295. CONFIG_OF_BOARD_SETUP
  296. Board code has addition modification that it wants to make
  297. to the flat device tree before handing it off to the kernel
  298. CONFIG_OF_BOOT_CPU
  299. This define fills in the correct boot cpu in the boot
  300. param header, the default value is zero if undefined.
  301. - Serial Ports:
  302. CFG_PL010_SERIAL
  303. Define this if you want support for Amba PrimeCell PL010 UARTs.
  304. CFG_PL011_SERIAL
  305. Define this if you want support for Amba PrimeCell PL011 UARTs.
  306. CONFIG_PL011_CLOCK
  307. If you have Amba PrimeCell PL011 UARTs, set this variable to
  308. the clock speed of the UARTs.
  309. CONFIG_PL01x_PORTS
  310. If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
  311. define this to a list of base addresses for each (supported)
  312. port. See e.g. include/configs/versatile.h
  313. - Console Interface:
  314. Depending on board, define exactly one serial port
  315. (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
  316. CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
  317. console by defining CONFIG_8xx_CONS_NONE
  318. Note: if CONFIG_8xx_CONS_NONE is defined, the serial
  319. port routines must be defined elsewhere
  320. (i.e. serial_init(), serial_getc(), ...)
  321. CONFIG_CFB_CONSOLE
  322. Enables console device for a color framebuffer. Needs following
  323. defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
  324. VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
  325. (default big endian)
  326. VIDEO_HW_RECTFILL graphic chip supports
  327. rectangle fill
  328. (cf. smiLynxEM)
  329. VIDEO_HW_BITBLT graphic chip supports
  330. bit-blit (cf. smiLynxEM)
  331. VIDEO_VISIBLE_COLS visible pixel columns
  332. (cols=pitch)
  333. VIDEO_VISIBLE_ROWS visible pixel rows
  334. VIDEO_PIXEL_SIZE bytes per pixel
  335. VIDEO_DATA_FORMAT graphic data format
  336. (0-5, cf. cfb_console.c)
  337. VIDEO_FB_ADRS framebuffer address
  338. VIDEO_KBD_INIT_FCT keyboard int fct
  339. (i.e. i8042_kbd_init())
  340. VIDEO_TSTC_FCT test char fct
  341. (i.e. i8042_tstc)
  342. VIDEO_GETC_FCT get char fct
  343. (i.e. i8042_getc)
  344. CONFIG_CONSOLE_CURSOR cursor drawing on/off
  345. (requires blink timer
  346. cf. i8042.c)
  347. CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
  348. CONFIG_CONSOLE_TIME display time/date info in
  349. upper right corner
  350. (requires CONFIG_CMD_DATE)
  351. CONFIG_VIDEO_LOGO display Linux logo in
  352. upper left corner
  353. CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
  354. linux_logo.h for logo.
  355. Requires CONFIG_VIDEO_LOGO
  356. CONFIG_CONSOLE_EXTRA_INFO
  357. addional board info beside
  358. the logo
  359. When CONFIG_CFB_CONSOLE is defined, video console is
  360. default i/o. Serial console can be forced with
  361. environment 'console=serial'.
  362. When CONFIG_SILENT_CONSOLE is defined, all console
  363. messages (by U-Boot and Linux!) can be silenced with
  364. the "silent" environment variable. See
  365. doc/README.silent for more information.
  366. - Console Baudrate:
  367. CONFIG_BAUDRATE - in bps
  368. Select one of the baudrates listed in
  369. CFG_BAUDRATE_TABLE, see below.
  370. CFG_BRGCLK_PRESCALE, baudrate prescale
  371. - Interrupt driven serial port input:
  372. CONFIG_SERIAL_SOFTWARE_FIFO
  373. PPC405GP only.
  374. Use an interrupt handler for receiving data on the
  375. serial port. It also enables using hardware handshake
  376. (RTS/CTS) and UART's built-in FIFO. Set the number of
  377. bytes the interrupt driven input buffer should have.
  378. Leave undefined to disable this feature, including
  379. disable the buffer and hardware handshake.
  380. - Console UART Number:
  381. CONFIG_UART1_CONSOLE
  382. AMCC PPC4xx only.
  383. If defined internal UART1 (and not UART0) is used
  384. as default U-Boot console.
  385. - Boot Delay: CONFIG_BOOTDELAY - in seconds
  386. Delay before automatically booting the default image;
  387. set to -1 to disable autoboot.
  388. See doc/README.autoboot for these options that
  389. work with CONFIG_BOOTDELAY. None are required.
  390. CONFIG_BOOT_RETRY_TIME
  391. CONFIG_BOOT_RETRY_MIN
  392. CONFIG_AUTOBOOT_KEYED
  393. CONFIG_AUTOBOOT_PROMPT
  394. CONFIG_AUTOBOOT_DELAY_STR
  395. CONFIG_AUTOBOOT_STOP_STR
  396. CONFIG_AUTOBOOT_DELAY_STR2
  397. CONFIG_AUTOBOOT_STOP_STR2
  398. CONFIG_ZERO_BOOTDELAY_CHECK
  399. CONFIG_RESET_TO_RETRY
  400. - Autoboot Command:
  401. CONFIG_BOOTCOMMAND
  402. Only needed when CONFIG_BOOTDELAY is enabled;
  403. define a command string that is automatically executed
  404. when no character is read on the console interface
  405. within "Boot Delay" after reset.
  406. CONFIG_BOOTARGS
  407. This can be used to pass arguments to the bootm
  408. command. The value of CONFIG_BOOTARGS goes into the
  409. environment value "bootargs".
  410. CONFIG_RAMBOOT and CONFIG_NFSBOOT
  411. The value of these goes into the environment as
  412. "ramboot" and "nfsboot" respectively, and can be used
  413. as a convenience, when switching between booting from
  414. ram and nfs.
  415. - Pre-Boot Commands:
  416. CONFIG_PREBOOT
  417. When this option is #defined, the existence of the
  418. environment variable "preboot" will be checked
  419. immediately before starting the CONFIG_BOOTDELAY
  420. countdown and/or running the auto-boot command resp.
  421. entering interactive mode.
  422. This feature is especially useful when "preboot" is
  423. automatically generated or modified. For an example
  424. see the LWMON board specific code: here "preboot" is
  425. modified when the user holds down a certain
  426. combination of keys on the (special) keyboard when
  427. booting the systems
  428. - Serial Download Echo Mode:
  429. CONFIG_LOADS_ECHO
  430. If defined to 1, all characters received during a
  431. serial download (using the "loads" command) are
  432. echoed back. This might be needed by some terminal
  433. emulations (like "cu"), but may as well just take
  434. time on others. This setting #define's the initial
  435. value of the "loads_echo" environment variable.
  436. - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
  437. CONFIG_KGDB_BAUDRATE
  438. Select one of the baudrates listed in
  439. CFG_BAUDRATE_TABLE, see below.
  440. - Monitor Functions:
  441. Monitor commands can be included or excluded
  442. from the build by using the #include files
  443. "config_cmd_all.h" and #undef'ing unwanted
  444. commands, or using "config_cmd_default.h"
  445. and augmenting with additional #define's
  446. for wanted commands.
  447. The default command configuration includes all commands
  448. except those marked below with a "*".
  449. CONFIG_CMD_ASKENV * ask for env variable
  450. CONFIG_CMD_AUTOSCRIPT Autoscript Support
  451. CONFIG_CMD_BDI bdinfo
  452. CONFIG_CMD_BEDBUG * Include BedBug Debugger
  453. CONFIG_CMD_BMP * BMP support
  454. CONFIG_CMD_BSP * Board specific commands
  455. CONFIG_CMD_BOOTD bootd
  456. CONFIG_CMD_CACHE * icache, dcache
  457. CONFIG_CMD_CONSOLE coninfo
  458. CONFIG_CMD_DATE * support for RTC, date/time...
  459. CONFIG_CMD_DHCP * DHCP support
  460. CONFIG_CMD_DIAG * Diagnostics
  461. CONFIG_CMD_DOC * Disk-On-Chip Support
  462. CONFIG_CMD_DTT * Digital Therm and Thermostat
  463. CONFIG_CMD_ECHO echo arguments
  464. CONFIG_CMD_EEPROM * EEPROM read/write support
  465. CONFIG_CMD_ELF * bootelf, bootvx
  466. CONFIG_CMD_ENV saveenv
  467. CONFIG_CMD_FDC * Floppy Disk Support
  468. CONFIG_CMD_FAT * FAT partition support
  469. CONFIG_CMD_FDOS * Dos diskette Support
  470. CONFIG_CMD_FLASH flinfo, erase, protect
  471. CONFIG_CMD_FPGA FPGA device initialization support
  472. CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
  473. CONFIG_CMD_I2C * I2C serial bus support
  474. CONFIG_CMD_IDE * IDE harddisk support
  475. CONFIG_CMD_IMI iminfo
  476. CONFIG_CMD_IMLS List all found images
  477. CONFIG_CMD_IMMAP * IMMR dump support
  478. CONFIG_CMD_IRQ * irqinfo
  479. CONFIG_CMD_ITEST Integer/string test of 2 values
  480. CONFIG_CMD_JFFS2 * JFFS2 Support
  481. CONFIG_CMD_KGDB * kgdb
  482. CONFIG_CMD_LOADB loadb
  483. CONFIG_CMD_LOADS loads
  484. CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
  485. loop, loopw, mtest
  486. CONFIG_CMD_MISC Misc functions like sleep etc
  487. CONFIG_CMD_MMC * MMC memory mapped support
  488. CONFIG_CMD_MII * MII utility commands
  489. CONFIG_CMD_NAND * NAND support
  490. CONFIG_CMD_NET bootp, tftpboot, rarpboot
  491. CONFIG_CMD_PCI * pciinfo
  492. CONFIG_CMD_PCMCIA * PCMCIA support
  493. CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
  494. host
  495. CONFIG_CMD_PORTIO * Port I/O
  496. CONFIG_CMD_REGINFO * Register dump
  497. CONFIG_CMD_RUN run command in env variable
  498. CONFIG_CMD_SAVES * save S record dump
  499. CONFIG_CMD_SCSI * SCSI Support
  500. CONFIG_CMD_SDRAM * print SDRAM configuration information
  501. (requires CONFIG_CMD_I2C)
  502. CONFIG_CMD_SETGETDCR Support for DCR Register access
  503. (4xx only)
  504. CONFIG_CMD_SPI * SPI serial bus support
  505. CONFIG_CMD_USB * USB support
  506. CONFIG_CMD_VFD * VFD support (TRAB)
  507. CONFIG_CMD_CDP * Cisco Discover Protocol support
  508. CONFIG_CMD_FSL * Microblaze FSL support
  509. EXAMPLE: If you want all functions except of network
  510. support you can write:
  511. #include "config_cmd_all.h"
  512. #undef CONFIG_CMD_NET
  513. Other Commands:
  514. fdt (flattened device tree) command: CONFIG_OF_LIBFDT
  515. Note: Don't enable the "icache" and "dcache" commands
  516. (configuration option CONFIG_CMD_CACHE) unless you know
  517. what you (and your U-Boot users) are doing. Data
  518. cache cannot be enabled on systems like the 8xx or
  519. 8260 (where accesses to the IMMR region must be
  520. uncached), and it cannot be disabled on all other
  521. systems where we (mis-) use the data cache to hold an
  522. initial stack and some data.
  523. XXX - this list needs to get updated!
  524. - Watchdog:
  525. CONFIG_WATCHDOG
  526. If this variable is defined, it enables watchdog
  527. support. There must be support in the platform specific
  528. code for a watchdog. For the 8xx and 8260 CPUs, the
  529. SIU Watchdog feature is enabled in the SYPCR
  530. register.
  531. - U-Boot Version:
  532. CONFIG_VERSION_VARIABLE
  533. If this variable is defined, an environment variable
  534. named "ver" is created by U-Boot showing the U-Boot
  535. version as printed by the "version" command.
  536. This variable is readonly.
  537. - Real-Time Clock:
  538. When CONFIG_CMD_DATE is selected, the type of the RTC
  539. has to be selected, too. Define exactly one of the
  540. following options:
  541. CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
  542. CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
  543. CONFIG_RTC_MC13783 - use MC13783 RTC
  544. CONFIG_RTC_MC146818 - use MC146818 RTC
  545. CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
  546. CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
  547. CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
  548. CONFIG_RTC_DS164x - use Dallas DS164x RTC
  549. CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
  550. CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
  551. CFG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
  552. Note that if the RTC uses I2C, then the I2C interface
  553. must also be configured. See I2C Support, below.
  554. - Timestamp Support:
  555. When CONFIG_TIMESTAMP is selected, the timestamp
  556. (date and time) of an image is printed by image
  557. commands like bootm or iminfo. This option is
  558. automatically enabled when you select CONFIG_CMD_DATE .
  559. - Partition Support:
  560. CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
  561. and/or CONFIG_ISO_PARTITION
  562. If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
  563. CONFIG_CMD_SCSI) you must configure support for at
  564. least one partition type as well.
  565. - IDE Reset method:
  566. CONFIG_IDE_RESET_ROUTINE - this is defined in several
  567. board configurations files but used nowhere!
  568. CONFIG_IDE_RESET - is this is defined, IDE Reset will
  569. be performed by calling the function
  570. ide_set_reset(int reset)
  571. which has to be defined in a board specific file
  572. - ATAPI Support:
  573. CONFIG_ATAPI
  574. Set this to enable ATAPI support.
  575. - LBA48 Support
  576. CONFIG_LBA48
  577. Set this to enable support for disks larger than 137GB
  578. Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
  579. Whithout these , LBA48 support uses 32bit variables and will 'only'
  580. support disks up to 2.1TB.
  581. CFG_64BIT_LBA:
  582. When enabled, makes the IDE subsystem use 64bit sector addresses.
  583. Default is 32bit.
  584. - SCSI Support:
  585. At the moment only there is only support for the
  586. SYM53C8XX SCSI controller; define
  587. CONFIG_SCSI_SYM53C8XX to enable it.
  588. CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
  589. CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
  590. CFG_SCSI_MAX_LUN] can be adjusted to define the
  591. maximum numbers of LUNs, SCSI ID's and target
  592. devices.
  593. CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
  594. - NETWORK Support (PCI):
  595. CONFIG_E1000
  596. Support for Intel 8254x gigabit chips.
  597. CONFIG_E1000_FALLBACK_MAC
  598. default MAC for empty eeprom after production.
  599. CONFIG_EEPRO100
  600. Support for Intel 82557/82559/82559ER chips.
  601. Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
  602. write routine for first time initialisation.
  603. CONFIG_TULIP
  604. Support for Digital 2114x chips.
  605. Optional CONFIG_TULIP_SELECT_MEDIA for board specific
  606. modem chip initialisation (KS8761/QS6611).
  607. CONFIG_NATSEMI
  608. Support for National dp83815 chips.
  609. CONFIG_NS8382X
  610. Support for National dp8382[01] gigabit chips.
  611. - NETWORK Support (other):
  612. CONFIG_DRIVER_LAN91C96
  613. Support for SMSC's LAN91C96 chips.
  614. CONFIG_LAN91C96_BASE
  615. Define this to hold the physical address
  616. of the LAN91C96's I/O space
  617. CONFIG_LAN91C96_USE_32_BIT
  618. Define this to enable 32 bit addressing
  619. CONFIG_DRIVER_SMC91111
  620. Support for SMSC's LAN91C111 chip
  621. CONFIG_SMC91111_BASE
  622. Define this to hold the physical address
  623. of the device (I/O space)
  624. CONFIG_SMC_USE_32_BIT
  625. Define this if data bus is 32 bits
  626. CONFIG_SMC_USE_IOFUNCS
  627. Define this to use i/o functions instead of macros
  628. (some hardware wont work with macros)
  629. - USB Support:
  630. At the moment only the UHCI host controller is
  631. supported (PIP405, MIP405, MPC5200); define
  632. CONFIG_USB_UHCI to enable it.
  633. define CONFIG_USB_KEYBOARD to enable the USB Keyboard
  634. and define CONFIG_USB_STORAGE to enable the USB
  635. storage devices.
  636. Note:
  637. Supported are USB Keyboards and USB Floppy drives
  638. (TEAC FD-05PUB).
  639. MPC5200 USB requires additional defines:
  640. CONFIG_USB_CLOCK
  641. for 528 MHz Clock: 0x0001bbbb
  642. CONFIG_USB_CONFIG
  643. for differential drivers: 0x00001000
  644. for single ended drivers: 0x00005000
  645. CFG_USB_EVENT_POLL
  646. May be defined to allow interrupt polling
  647. instead of using asynchronous interrupts
  648. - USB Device:
  649. Define the below if you wish to use the USB console.
  650. Once firmware is rebuilt from a serial console issue the
  651. command "setenv stdin usbtty; setenv stdout usbtty" and
  652. attach your usb cable. The Unix command "dmesg" should print
  653. it has found a new device. The environment variable usbtty
  654. can be set to gserial or cdc_acm to enable your device to
  655. appear to a USB host as a Linux gserial device or a
  656. Common Device Class Abstract Control Model serial device.
  657. If you select usbtty = gserial you should be able to enumerate
  658. a Linux host by
  659. # modprobe usbserial vendor=0xVendorID product=0xProductID
  660. else if using cdc_acm, simply setting the environment
  661. variable usbtty to be cdc_acm should suffice. The following
  662. might be defined in YourBoardName.h
  663. CONFIG_USB_DEVICE
  664. Define this to build a UDC device
  665. CONFIG_USB_TTY
  666. Define this to have a tty type of device available to
  667. talk to the UDC device
  668. CFG_CONSOLE_IS_IN_ENV
  669. Define this if you want stdin, stdout &/or stderr to
  670. be set to usbtty.
  671. mpc8xx:
  672. CFG_USB_EXTC_CLK 0xBLAH
  673. Derive USB clock from external clock "blah"
  674. - CFG_USB_EXTC_CLK 0x02
  675. CFG_USB_BRG_CLK 0xBLAH
  676. Derive USB clock from brgclk
  677. - CFG_USB_BRG_CLK 0x04
  678. If you have a USB-IF assigned VendorID then you may wish to
  679. define your own vendor specific values either in BoardName.h
  680. or directly in usbd_vendor_info.h. If you don't define
  681. CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
  682. CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
  683. should pretend to be a Linux device to it's target host.
  684. CONFIG_USBD_MANUFACTURER
  685. Define this string as the name of your company for
  686. - CONFIG_USBD_MANUFACTURER "my company"
  687. CONFIG_USBD_PRODUCT_NAME
  688. Define this string as the name of your product
  689. - CONFIG_USBD_PRODUCT_NAME "acme usb device"
  690. CONFIG_USBD_VENDORID
  691. Define this as your assigned Vendor ID from the USB
  692. Implementors Forum. This *must* be a genuine Vendor ID
  693. to avoid polluting the USB namespace.
  694. - CONFIG_USBD_VENDORID 0xFFFF
  695. CONFIG_USBD_PRODUCTID
  696. Define this as the unique Product ID
  697. for your device
  698. - CONFIG_USBD_PRODUCTID 0xFFFF
  699. - MMC Support:
  700. The MMC controller on the Intel PXA is supported. To
  701. enable this define CONFIG_MMC. The MMC can be
  702. accessed from the boot prompt by mapping the device
  703. to physical memory similar to flash. Command line is
  704. enabled with CONFIG_CMD_MMC. The MMC driver also works with
  705. the FAT fs. This is enabled with CONFIG_CMD_FAT.
  706. - Journaling Flash filesystem support:
  707. CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
  708. CONFIG_JFFS2_NAND_DEV
  709. Define these for a default partition on a NAND device
  710. CFG_JFFS2_FIRST_SECTOR,
  711. CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
  712. Define these for a default partition on a NOR device
  713. CFG_JFFS_CUSTOM_PART
  714. Define this to create an own partition. You have to provide a
  715. function struct part_info* jffs2_part_info(int part_num)
  716. If you define only one JFFS2 partition you may also want to
  717. #define CFG_JFFS_SINGLE_PART 1
  718. to disable the command chpart. This is the default when you
  719. have not defined a custom partition
  720. - Keyboard Support:
  721. CONFIG_ISA_KEYBOARD
  722. Define this to enable standard (PC-Style) keyboard
  723. support
  724. CONFIG_I8042_KBD
  725. Standard PC keyboard driver with US (is default) and
  726. GERMAN key layout (switch via environment 'keymap=de') support.
  727. Export function i8042_kbd_init, i8042_tstc and i8042_getc
  728. for cfb_console. Supports cursor blinking.
  729. - Video support:
  730. CONFIG_VIDEO
  731. Define this to enable video support (for output to
  732. video).
  733. CONFIG_VIDEO_CT69000
  734. Enable Chips & Technologies 69000 Video chip
  735. CONFIG_VIDEO_SMI_LYNXEM
  736. Enable Silicon Motion SMI 712/710/810 Video chip. The
  737. video output is selected via environment 'videoout'
  738. (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
  739. assumed.
  740. For the CT69000 and SMI_LYNXEM drivers, videomode is
  741. selected via environment 'videomode'. Two diferent ways
  742. are possible:
  743. - "videomode=num" 'num' is a standard LiLo mode numbers.
  744. Following standard modes are supported (* is default):
  745. Colors 640x480 800x600 1024x768 1152x864 1280x1024
  746. -------------+---------------------------------------------
  747. 8 bits | 0x301* 0x303 0x305 0x161 0x307
  748. 15 bits | 0x310 0x313 0x316 0x162 0x319
  749. 16 bits | 0x311 0x314 0x317 0x163 0x31A
  750. 24 bits | 0x312 0x315 0x318 ? 0x31B
  751. -------------+---------------------------------------------
  752. (i.e. setenv videomode 317; saveenv; reset;)
  753. - "videomode=bootargs" all the video parameters are parsed
  754. from the bootargs. (See drivers/video/videomodes.c)
  755. CONFIG_VIDEO_SED13806
  756. Enable Epson SED13806 driver. This driver supports 8bpp
  757. and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
  758. or CONFIG_VIDEO_SED13806_16BPP
  759. - Keyboard Support:
  760. CONFIG_KEYBOARD
  761. Define this to enable a custom keyboard support.
  762. This simply calls drv_keyboard_init() which must be
  763. defined in your board-specific files.
  764. The only board using this so far is RBC823.
  765. - LCD Support: CONFIG_LCD
  766. Define this to enable LCD support (for output to LCD
  767. display); also select one of the supported displays
  768. by defining one of these:
  769. CONFIG_NEC_NL6448AC33:
  770. NEC NL6448AC33-18. Active, color, single scan.
  771. CONFIG_NEC_NL6448BC20
  772. NEC NL6448BC20-08. 6.5", 640x480.
  773. Active, color, single scan.
  774. CONFIG_NEC_NL6448BC33_54
  775. NEC NL6448BC33-54. 10.4", 640x480.
  776. Active, color, single scan.
  777. CONFIG_SHARP_16x9
  778. Sharp 320x240. Active, color, single scan.
  779. It isn't 16x9, and I am not sure what it is.
  780. CONFIG_SHARP_LQ64D341
  781. Sharp LQ64D341 display, 640x480.
  782. Active, color, single scan.
  783. CONFIG_HLD1045
  784. HLD1045 display, 640x480.
  785. Active, color, single scan.
  786. CONFIG_OPTREX_BW
  787. Optrex CBL50840-2 NF-FW 99 22 M5
  788. or
  789. Hitachi LMG6912RPFC-00T
  790. or
  791. Hitachi SP14Q002
  792. 320x240. Black & white.
  793. Normally display is black on white background; define
  794. CFG_WHITE_ON_BLACK to get it inverted.
  795. - Splash Screen Support: CONFIG_SPLASH_SCREEN
  796. If this option is set, the environment is checked for
  797. a variable "splashimage". If found, the usual display
  798. of logo, copyright and system information on the LCD
  799. is suppressed and the BMP image at the address
  800. specified in "splashimage" is loaded instead. The
  801. console is redirected to the "nulldev", too. This
  802. allows for a "silent" boot where a splash screen is
  803. loaded very quickly after power-on.
  804. - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
  805. If this option is set, additionally to standard BMP
  806. images, gzipped BMP images can be displayed via the
  807. splashscreen support or the bmp command.
  808. - Compression support:
  809. CONFIG_BZIP2
  810. If this option is set, support for bzip2 compressed
  811. images is included. If not, only uncompressed and gzip
  812. compressed images are supported.
  813. NOTE: the bzip2 algorithm requires a lot of RAM, so
  814. the malloc area (as defined by CFG_MALLOC_LEN) should
  815. be at least 4MB.
  816. - MII/PHY support:
  817. CONFIG_PHY_ADDR
  818. The address of PHY on MII bus.
  819. CONFIG_PHY_CLOCK_FREQ (ppc4xx)
  820. The clock frequency of the MII bus
  821. CONFIG_PHY_GIGE
  822. If this option is set, support for speed/duplex
  823. detection of Gigabit PHY is included.
  824. CONFIG_PHY_RESET_DELAY
  825. Some PHY like Intel LXT971A need extra delay after
  826. reset before any MII register access is possible.
  827. For such PHY, set this option to the usec delay
  828. required. (minimum 300usec for LXT971A)
  829. CONFIG_PHY_CMD_DELAY (ppc4xx)
  830. Some PHY like Intel LXT971A need extra delay after
  831. command issued before MII status register can be read
  832. - Ethernet address:
  833. CONFIG_ETHADDR
  834. CONFIG_ETH2ADDR
  835. CONFIG_ETH3ADDR
  836. Define a default value for ethernet address to use
  837. for the respective ethernet interface, in case this
  838. is not determined automatically.
  839. - IP address:
  840. CONFIG_IPADDR
  841. Define a default value for the IP address to use for
  842. the default ethernet interface, in case this is not
  843. determined through e.g. bootp.
  844. - Server IP address:
  845. CONFIG_SERVERIP
  846. Defines a default value for theIP address of a TFTP
  847. server to contact when using the "tftboot" command.
  848. - Multicast TFTP Mode:
  849. CONFIG_MCAST_TFTP
  850. Defines whether you want to support multicast TFTP as per
  851. rfc-2090; for example to work with atftp. Lets lots of targets
  852. tftp down the same boot image concurrently. Note: the ethernet
  853. driver in use must provide a function: mcast() to join/leave a
  854. multicast group.
  855. CONFIG_BOOTP_RANDOM_DELAY
  856. - BOOTP Recovery Mode:
  857. CONFIG_BOOTP_RANDOM_DELAY
  858. If you have many targets in a network that try to
  859. boot using BOOTP, you may want to avoid that all
  860. systems send out BOOTP requests at precisely the same
  861. moment (which would happen for instance at recovery
  862. from a power failure, when all systems will try to
  863. boot, thus flooding the BOOTP server. Defining
  864. CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
  865. inserted before sending out BOOTP requests. The
  866. following delays are inserted then:
  867. 1st BOOTP request: delay 0 ... 1 sec
  868. 2nd BOOTP request: delay 0 ... 2 sec
  869. 3rd BOOTP request: delay 0 ... 4 sec
  870. 4th and following
  871. BOOTP requests: delay 0 ... 8 sec
  872. - DHCP Advanced Options:
  873. You can fine tune the DHCP functionality by defining
  874. CONFIG_BOOTP_* symbols:
  875. CONFIG_BOOTP_SUBNETMASK
  876. CONFIG_BOOTP_GATEWAY
  877. CONFIG_BOOTP_HOSTNAME
  878. CONFIG_BOOTP_NISDOMAIN
  879. CONFIG_BOOTP_BOOTPATH
  880. CONFIG_BOOTP_BOOTFILESIZE
  881. CONFIG_BOOTP_DNS
  882. CONFIG_BOOTP_DNS2
  883. CONFIG_BOOTP_SEND_HOSTNAME
  884. CONFIG_BOOTP_NTPSERVER
  885. CONFIG_BOOTP_TIMEOFFSET
  886. CONFIG_BOOTP_VENDOREX
  887. CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
  888. environment variable, not the BOOTP server.
  889. CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
  890. serverip from a DHCP server, it is possible that more
  891. than one DNS serverip is offered to the client.
  892. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
  893. serverip will be stored in the additional environment
  894. variable "dnsip2". The first DNS serverip is always
  895. stored in the variable "dnsip", when CONFIG_BOOTP_DNS
  896. is defined.
  897. CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
  898. to do a dynamic update of a DNS server. To do this, they
  899. need the hostname of the DHCP requester.
  900. If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
  901. of the "hostname" environment variable is passed as
  902. option 12 to the DHCP server.
  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. - CDP Options:
  916. CONFIG_CDP_DEVICE_ID
  917. The device id used in CDP trigger frames.
  918. CONFIG_CDP_DEVICE_ID_PREFIX
  919. A two character string which is prefixed to the MAC address
  920. of the device.
  921. CONFIG_CDP_PORT_ID
  922. A printf format string which contains the ascii name of
  923. the port. Normally is set to "eth%d" which sets
  924. eth0 for the first ethernet, eth1 for the second etc.
  925. CONFIG_CDP_CAPABILITIES
  926. A 32bit integer which indicates the device capabilities;
  927. 0x00000010 for a normal host which does not forwards.
  928. CONFIG_CDP_VERSION
  929. An ascii string containing the version of the software.
  930. CONFIG_CDP_PLATFORM
  931. An ascii string containing the name of the platform.
  932. CONFIG_CDP_TRIGGER
  933. A 32bit integer sent on the trigger.
  934. CONFIG_CDP_POWER_CONSUMPTION
  935. A 16bit integer containing the power consumption of the
  936. device in .1 of milliwatts.
  937. CONFIG_CDP_APPLIANCE_VLAN_TYPE
  938. A byte containing the id of the VLAN.
  939. - Status LED: CONFIG_STATUS_LED
  940. Several configurations allow to display the current
  941. status using a LED. For instance, the LED will blink
  942. fast while running U-Boot code, stop blinking as
  943. soon as a reply to a BOOTP request was received, and
  944. start blinking slow once the Linux kernel is running
  945. (supported by a status LED driver in the Linux
  946. kernel). Defining CONFIG_STATUS_LED enables this
  947. feature in U-Boot.
  948. - CAN Support: CONFIG_CAN_DRIVER
  949. Defining CONFIG_CAN_DRIVER enables CAN driver support
  950. on those systems that support this (optional)
  951. feature, like the TQM8xxL modules.
  952. - I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
  953. These enable I2C serial bus commands. Defining either of
  954. (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
  955. include the appropriate I2C driver for the selected cpu.
  956. This will allow you to use i2c commands at the u-boot
  957. command line (as long as you set CONFIG_CMD_I2C in
  958. CONFIG_COMMANDS) and communicate with i2c based realtime
  959. clock chips. See common/cmd_i2c.c for a description of the
  960. command line interface.
  961. CONFIG_I2C_CMD_TREE is a recommended option that places
  962. all I2C commands under a single 'i2c' root command. The
  963. older 'imm', 'imd', 'iprobe' etc. commands are considered
  964. deprecated and may disappear in the future.
  965. CONFIG_HARD_I2C selects a hardware I2C controller.
  966. CONFIG_SOFT_I2C configures u-boot to use a software (aka
  967. bit-banging) driver instead of CPM or similar hardware
  968. support for I2C.
  969. There are several other quantities that must also be
  970. defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
  971. In both cases you will need to define CFG_I2C_SPEED
  972. to be the frequency (in Hz) at which you wish your i2c bus
  973. to run and CFG_I2C_SLAVE to be the address of this node (ie
  974. the cpu's i2c node address).
  975. Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
  976. sets the cpu up as a master node and so its address should
  977. therefore be cleared to 0 (See, eg, MPC823e User's Manual
  978. p.16-473). So, set CFG_I2C_SLAVE to 0.
  979. That's all that's required for CONFIG_HARD_I2C.
  980. If you use the software i2c interface (CONFIG_SOFT_I2C)
  981. then the following macros need to be defined (examples are
  982. from include/configs/lwmon.h):
  983. I2C_INIT
  984. (Optional). Any commands necessary to enable the I2C
  985. controller or configure ports.
  986. eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
  987. I2C_PORT
  988. (Only for MPC8260 CPU). The I/O port to use (the code
  989. assumes both bits are on the same port). Valid values
  990. are 0..3 for ports A..D.
  991. I2C_ACTIVE
  992. The code necessary to make the I2C data line active
  993. (driven). If the data line is open collector, this
  994. define can be null.
  995. eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
  996. I2C_TRISTATE
  997. The code necessary to make the I2C data line tri-stated
  998. (inactive). If the data line is open collector, this
  999. define can be null.
  1000. eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
  1001. I2C_READ
  1002. Code that returns TRUE if the I2C data line is high,
  1003. FALSE if it is low.
  1004. eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
  1005. I2C_SDA(bit)
  1006. If <bit> is TRUE, sets the I2C data line high. If it
  1007. is FALSE, it clears it (low).
  1008. eg: #define I2C_SDA(bit) \
  1009. if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
  1010. else immr->im_cpm.cp_pbdat &= ~PB_SDA
  1011. I2C_SCL(bit)
  1012. If <bit> is TRUE, sets the I2C clock line high. If it
  1013. is FALSE, it clears it (low).
  1014. eg: #define I2C_SCL(bit) \
  1015. if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
  1016. else immr->im_cpm.cp_pbdat &= ~PB_SCL
  1017. I2C_DELAY
  1018. This delay is invoked four times per clock cycle so this
  1019. controls the rate of data transfer. The data rate thus
  1020. is 1 / (I2C_DELAY * 4). Often defined to be something
  1021. like:
  1022. #define I2C_DELAY udelay(2)
  1023. CFG_I2C_INIT_BOARD
  1024. When a board is reset during an i2c bus transfer
  1025. chips might think that the current transfer is still
  1026. in progress. On some boards it is possible to access
  1027. the i2c SCLK line directly, either by using the
  1028. processor pin as a GPIO or by having a second pin
  1029. connected to the bus. If this option is defined a
  1030. custom i2c_init_board() routine in boards/xxx/board.c
  1031. is run early in the boot sequence.
  1032. CONFIG_I2CFAST (PPC405GP|PPC405EP only)
  1033. This option enables configuration of bi_iic_fast[] flags
  1034. in u-boot bd_info structure based on u-boot environment
  1035. variable "i2cfast". (see also i2cfast)
  1036. CONFIG_I2C_MULTI_BUS
  1037. This option allows the use of multiple I2C buses, each of which
  1038. must have a controller. At any point in time, only one bus is
  1039. active. To switch to a different bus, use the 'i2c dev' command.
  1040. Note that bus numbering is zero-based.
  1041. CFG_I2C_NOPROBES
  1042. This option specifies a list of I2C devices that will be skipped
  1043. when the 'i2c probe' command is issued (or 'iprobe' using the legacy
  1044. command). If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
  1045. pairs. Otherwise, specify a 1D array of device addresses
  1046. e.g.
  1047. #undef CONFIG_I2C_MULTI_BUS
  1048. #define CFG_I2C_NOPROBES {0x50,0x68}
  1049. will skip addresses 0x50 and 0x68 on a board with one I2C bus
  1050. #define CONFIG_I2C_MULTI_BUS
  1051. #define CFG_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
  1052. will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
  1053. CFG_SPD_BUS_NUM
  1054. If defined, then this indicates the I2C bus number for DDR SPD.
  1055. If not defined, then U-Boot assumes that SPD is on I2C bus 0.
  1056. CFG_RTC_BUS_NUM
  1057. If defined, then this indicates the I2C bus number for the RTC.
  1058. If not defined, then U-Boot assumes that RTC is on I2C bus 0.
  1059. CFG_DTT_BUS_NUM
  1060. If defined, then this indicates the I2C bus number for the DTT.
  1061. If not defined, then U-Boot assumes that DTT is on I2C bus 0.
  1062. CONFIG_FSL_I2C
  1063. Define this option if you want to use Freescale's I2C driver in
  1064. drivers/i2c/fsl_i2c.c.
  1065. - SPI Support: CONFIG_SPI
  1066. Enables SPI driver (so far only tested with
  1067. SPI EEPROM, also an instance works with Crystal A/D and
  1068. D/As on the SACSng board)
  1069. CONFIG_SPI_X
  1070. Enables extended (16-bit) SPI EEPROM addressing.
  1071. (symmetrical to CONFIG_I2C_X)
  1072. CONFIG_SOFT_SPI
  1073. Enables a software (bit-bang) SPI driver rather than
  1074. using hardware support. This is a general purpose
  1075. driver that only requires three general I/O port pins
  1076. (two outputs, one input) to function. If this is
  1077. defined, the board configuration must define several
  1078. SPI configuration items (port pins to use, etc). For
  1079. an example, see include/configs/sacsng.h.
  1080. CONFIG_HARD_SPI
  1081. Enables a hardware SPI driver for general-purpose reads
  1082. and writes. As with CONFIG_SOFT_SPI, the board configuration
  1083. must define a list of chip-select function pointers.
  1084. Currently supported on some MPC8xxx processors. For an
  1085. example, see include/configs/mpc8349emds.h.
  1086. CONFIG_MXC_SPI
  1087. Enables the driver for the SPI controllers on i.MX and MXC
  1088. SoCs. Currently only i.MX31 is supported.
  1089. - FPGA Support: CONFIG_FPGA
  1090. Enables FPGA subsystem.
  1091. CONFIG_FPGA_<vendor>
  1092. Enables support for specific chip vendors.
  1093. (ALTERA, XILINX)
  1094. CONFIG_FPGA_<family>
  1095. Enables support for FPGA family.
  1096. (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
  1097. CONFIG_FPGA_COUNT
  1098. Specify the number of FPGA devices to support.
  1099. CFG_FPGA_PROG_FEEDBACK
  1100. Enable printing of hash marks during FPGA configuration.
  1101. CFG_FPGA_CHECK_BUSY
  1102. Enable checks on FPGA configuration interface busy
  1103. status by the configuration function. This option
  1104. will require a board or device specific function to
  1105. be written.
  1106. CONFIG_FPGA_DELAY
  1107. If defined, a function that provides delays in the FPGA
  1108. configuration driver.
  1109. CFG_FPGA_CHECK_CTRLC
  1110. Allow Control-C to interrupt FPGA configuration
  1111. CFG_FPGA_CHECK_ERROR
  1112. Check for configuration errors during FPGA bitfile
  1113. loading. For example, abort during Virtex II
  1114. configuration if the INIT_B line goes low (which
  1115. indicated a CRC error).
  1116. CFG_FPGA_WAIT_INIT
  1117. Maximum time to wait for the INIT_B line to deassert
  1118. after PROB_B has been deasserted during a Virtex II
  1119. FPGA configuration sequence. The default time is 500
  1120. mS.
  1121. CFG_FPGA_WAIT_BUSY
  1122. Maximum time to wait for BUSY to deassert during
  1123. Virtex II FPGA configuration. The default is 5 mS.
  1124. CFG_FPGA_WAIT_CONFIG
  1125. Time to wait after FPGA configuration. The default is
  1126. 200 mS.
  1127. - Configuration Management:
  1128. CONFIG_IDENT_STRING
  1129. If defined, this string will be added to the U-Boot
  1130. version information (U_BOOT_VERSION)
  1131. - Vendor Parameter Protection:
  1132. U-Boot considers the values of the environment
  1133. variables "serial#" (Board Serial Number) and
  1134. "ethaddr" (Ethernet Address) to be parameters that
  1135. are set once by the board vendor / manufacturer, and
  1136. protects these variables from casual modification by
  1137. the user. Once set, these variables are read-only,
  1138. and write or delete attempts are rejected. You can
  1139. change this behviour:
  1140. If CONFIG_ENV_OVERWRITE is #defined in your config
  1141. file, the write protection for vendor parameters is
  1142. completely disabled. Anybody can change or delete
  1143. these parameters.
  1144. Alternatively, if you #define _both_ CONFIG_ETHADDR
  1145. _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
  1146. ethernet address is installed in the environment,
  1147. which can be changed exactly ONCE by the user. [The
  1148. serial# is unaffected by this, i. e. it remains
  1149. read-only.]
  1150. - Protected RAM:
  1151. CONFIG_PRAM
  1152. Define this variable to enable the reservation of
  1153. "protected RAM", i. e. RAM which is not overwritten
  1154. by U-Boot. Define CONFIG_PRAM to hold the number of
  1155. kB you want to reserve for pRAM. You can overwrite
  1156. this default value by defining an environment
  1157. variable "pram" to the number of kB you want to
  1158. reserve. Note that the board info structure will
  1159. still show the full amount of RAM. If pRAM is
  1160. reserved, a new environment variable "mem" will
  1161. automatically be defined to hold the amount of
  1162. remaining RAM in a form that can be passed as boot
  1163. argument to Linux, for instance like that:
  1164. setenv bootargs ... mem=\${mem}
  1165. saveenv
  1166. This way you can tell Linux not to use this memory,
  1167. either, which results in a memory region that will
  1168. not be affected by reboots.
  1169. *WARNING* If your board configuration uses automatic
  1170. detection of the RAM size, you must make sure that
  1171. this memory test is non-destructive. So far, the
  1172. following board configurations are known to be
  1173. "pRAM-clean":
  1174. ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
  1175. HERMES, IP860, RPXlite, LWMON, LANTEC,
  1176. PCU_E, FLAGADM, TQM8260
  1177. - Error Recovery:
  1178. CONFIG_PANIC_HANG
  1179. Define this variable to stop the system in case of a
  1180. fatal error, so that you have to reset it manually.
  1181. This is probably NOT a good idea for an embedded
  1182. system where you want to system to reboot
  1183. automatically as fast as possible, but it may be
  1184. useful during development since you can try to debug
  1185. the conditions that lead to the situation.
  1186. CONFIG_NET_RETRY_COUNT
  1187. This variable defines the number of retries for
  1188. network operations like ARP, RARP, TFTP, or BOOTP
  1189. before giving up the operation. If not defined, a
  1190. default value of 5 is used.
  1191. CONFIG_ARP_TIMEOUT
  1192. Timeout waiting for an ARP reply in milliseconds.
  1193. - Command Interpreter:
  1194. CONFIG_AUTO_COMPLETE
  1195. Enable auto completion of commands using TAB.
  1196. Note that this feature has NOT been implemented yet
  1197. for the "hush" shell.
  1198. CFG_HUSH_PARSER
  1199. Define this variable to enable the "hush" shell (from
  1200. Busybox) as command line interpreter, thus enabling
  1201. powerful command line syntax like
  1202. if...then...else...fi conditionals or `&&' and '||'
  1203. constructs ("shell scripts").
  1204. If undefined, you get the old, much simpler behaviour
  1205. with a somewhat smaller memory footprint.
  1206. CFG_PROMPT_HUSH_PS2
  1207. This defines the secondary prompt string, which is
  1208. printed when the command interpreter needs more input
  1209. to complete a command. Usually "> ".
  1210. Note:
  1211. In the current implementation, the local variables
  1212. space and global environment variables space are
  1213. separated. Local variables are those you define by
  1214. simply typing `name=value'. To access a local
  1215. variable later on, you have write `$name' or
  1216. `${name}'; to execute the contents of a variable
  1217. directly type `$name' at the command prompt.
  1218. Global environment variables are those you use
  1219. setenv/printenv to work with. To run a command stored
  1220. in such a variable, you need to use the run command,
  1221. and you must not use the '$' sign to access them.
  1222. To store commands and special characters in a
  1223. variable, please use double quotation marks
  1224. surrounding the whole text of the variable, instead
  1225. of the backslashes before semicolons and special
  1226. symbols.
  1227. - Commandline Editing and History:
  1228. CONFIG_CMDLINE_EDITING
  1229. Enable editiong and History functions for interactive
  1230. commandline input operations
  1231. - Default Environment:
  1232. CONFIG_EXTRA_ENV_SETTINGS
  1233. Define this to contain any number of null terminated
  1234. strings (variable = value pairs) that will be part of
  1235. the default environment compiled into the boot image.
  1236. For example, place something like this in your
  1237. board's config file:
  1238. #define CONFIG_EXTRA_ENV_SETTINGS \
  1239. "myvar1=value1\0" \
  1240. "myvar2=value2\0"
  1241. Warning: This method is based on knowledge about the
  1242. internal format how the environment is stored by the
  1243. U-Boot code. This is NOT an official, exported
  1244. interface! Although it is unlikely that this format
  1245. will change soon, there is no guarantee either.
  1246. You better know what you are doing here.
  1247. Note: overly (ab)use of the default environment is
  1248. discouraged. Make sure to check other ways to preset
  1249. the environment like the autoscript function or the
  1250. boot command first.
  1251. - DataFlash Support:
  1252. CONFIG_HAS_DATAFLASH
  1253. Defining this option enables DataFlash features and
  1254. allows to read/write in Dataflash via the standard
  1255. commands cp, md...
  1256. - SystemACE Support:
  1257. CONFIG_SYSTEMACE
  1258. Adding this option adds support for Xilinx SystemACE
  1259. chips attached via some sort of local bus. The address
  1260. of the chip must alsh be defined in the
  1261. CFG_SYSTEMACE_BASE macro. For example:
  1262. #define CONFIG_SYSTEMACE
  1263. #define CFG_SYSTEMACE_BASE 0xf0000000
  1264. When SystemACE support is added, the "ace" device type
  1265. becomes available to the fat commands, i.e. fatls.
  1266. - TFTP Fixed UDP Port:
  1267. CONFIG_TFTP_PORT
  1268. If this is defined, the environment variable tftpsrcp
  1269. is used to supply the TFTP UDP source port value.
  1270. If tftpsrcp isn't defined, the normal pseudo-random port
  1271. number generator is used.
  1272. Also, the environment variable tftpdstp is used to supply
  1273. the TFTP UDP destination port value. If tftpdstp isn't
  1274. defined, the normal port 69 is used.
  1275. The purpose for tftpsrcp is to allow a TFTP server to
  1276. blindly start the TFTP transfer using the pre-configured
  1277. target IP address and UDP port. This has the effect of
  1278. "punching through" the (Windows XP) firewall, allowing
  1279. the remainder of the TFTP transfer to proceed normally.
  1280. A better solution is to properly configure the firewall,
  1281. but sometimes that is not allowed.
  1282. - Show boot progress:
  1283. CONFIG_SHOW_BOOT_PROGRESS
  1284. Defining this option allows to add some board-
  1285. specific code (calling a user-provided function
  1286. "show_boot_progress(int)") that enables you to show
  1287. the system's boot progress on some display (for
  1288. example, some LED's) on your board. At the moment,
  1289. the following checkpoints are implemented:
  1290. Legacy uImage format:
  1291. Arg Where When
  1292. 1 common/cmd_bootm.c before attempting to boot an image
  1293. -1 common/cmd_bootm.c Image header has bad magic number
  1294. 2 common/cmd_bootm.c Image header has correct magic number
  1295. -2 common/cmd_bootm.c Image header has bad checksum
  1296. 3 common/cmd_bootm.c Image header has correct checksum
  1297. -3 common/cmd_bootm.c Image data has bad checksum
  1298. 4 common/cmd_bootm.c Image data has correct checksum
  1299. -4 common/cmd_bootm.c Image is for unsupported architecture
  1300. 5 common/cmd_bootm.c Architecture check OK
  1301. -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
  1302. 6 common/cmd_bootm.c Image Type check OK
  1303. -6 common/cmd_bootm.c gunzip uncompression error
  1304. -7 common/cmd_bootm.c Unimplemented compression type
  1305. 7 common/cmd_bootm.c Uncompression OK
  1306. 8 common/cmd_bootm.c No uncompress/copy overwrite error
  1307. -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
  1308. 9 common/image.c Start initial ramdisk verification
  1309. -10 common/image.c Ramdisk header has bad magic number
  1310. -11 common/image.c Ramdisk header has bad checksum
  1311. 10 common/image.c Ramdisk header is OK
  1312. -12 common/image.c Ramdisk data has bad checksum
  1313. 11 common/image.c Ramdisk data has correct checksum
  1314. 12 common/image.c Ramdisk verification complete, start loading
  1315. -13 common/image.c Wrong Image Type (not PPC Linux Ramdisk)
  1316. 13 common/image.c Start multifile image verification
  1317. 14 common/image.c No initial ramdisk, no multifile, continue.
  1318. 15 lib_<arch>/bootm.c All preparation done, transferring control to OS
  1319. -30 lib_ppc/board.c Fatal error, hang the system
  1320. -31 post/post.c POST test failed, detected by post_output_backlog()
  1321. -32 post/post.c POST test failed, detected by post_run_single()
  1322. 34 common/cmd_doc.c before loading a Image from a DOC device
  1323. -35 common/cmd_doc.c Bad usage of "doc" command
  1324. 35 common/cmd_doc.c correct usage of "doc" command
  1325. -36 common/cmd_doc.c No boot device
  1326. 36 common/cmd_doc.c correct boot device
  1327. -37 common/cmd_doc.c Unknown Chip ID on boot device
  1328. 37 common/cmd_doc.c correct chip ID found, device available
  1329. -38 common/cmd_doc.c Read Error on boot device
  1330. 38 common/cmd_doc.c reading Image header from DOC device OK
  1331. -39 common/cmd_doc.c Image header has bad magic number
  1332. 39 common/cmd_doc.c Image header has correct magic number
  1333. -40 common/cmd_doc.c Error reading Image from DOC device
  1334. 40 common/cmd_doc.c Image header has correct magic number
  1335. 41 common/cmd_ide.c before loading a Image from a IDE device
  1336. -42 common/cmd_ide.c Bad usage of "ide" command
  1337. 42 common/cmd_ide.c correct usage of "ide" command
  1338. -43 common/cmd_ide.c No boot device
  1339. 43 common/cmd_ide.c boot device found
  1340. -44 common/cmd_ide.c Device not available
  1341. 44 common/cmd_ide.c Device available
  1342. -45 common/cmd_ide.c wrong partition selected
  1343. 45 common/cmd_ide.c partition selected
  1344. -46 common/cmd_ide.c Unknown partition table
  1345. 46 common/cmd_ide.c valid partition table found
  1346. -47 common/cmd_ide.c Invalid partition type
  1347. 47 common/cmd_ide.c correct partition type
  1348. -48 common/cmd_ide.c Error reading Image Header on boot device
  1349. 48 common/cmd_ide.c reading Image Header from IDE device OK
  1350. -49 common/cmd_ide.c Image header has bad magic number
  1351. 49 common/cmd_ide.c Image header has correct magic number
  1352. -50 common/cmd_ide.c Image header has bad checksum
  1353. 50 common/cmd_ide.c Image header has correct checksum
  1354. -51 common/cmd_ide.c Error reading Image from IDE device
  1355. 51 common/cmd_ide.c reading Image from IDE device OK
  1356. 52 common/cmd_nand.c before loading a Image from a NAND device
  1357. -53 common/cmd_nand.c Bad usage of "nand" command
  1358. 53 common/cmd_nand.c correct usage of "nand" command
  1359. -54 common/cmd_nand.c No boot device
  1360. 54 common/cmd_nand.c boot device found
  1361. -55 common/cmd_nand.c Unknown Chip ID on boot device
  1362. 55 common/cmd_nand.c correct chip ID found, device available
  1363. -56 common/cmd_nand.c Error reading Image Header on boot device
  1364. 56 common/cmd_nand.c reading Image Header from NAND device OK
  1365. -57 common/cmd_nand.c Image header has bad magic number
  1366. 57 common/cmd_nand.c Image header has correct magic number
  1367. -58 common/cmd_nand.c Error reading Image from NAND device
  1368. 58 common/cmd_nand.c reading Image from NAND device OK
  1369. -60 common/env_common.c Environment has a bad CRC, using default
  1370. 64 net/eth.c starting with Ethernetconfiguration.
  1371. -64 net/eth.c no Ethernet found.
  1372. 65 net/eth.c Ethernet found.
  1373. -80 common/cmd_net.c usage wrong
  1374. 80 common/cmd_net.c before calling NetLoop()
  1375. -81 common/cmd_net.c some error in NetLoop() occured
  1376. 81 common/cmd_net.c NetLoop() back without error
  1377. -82 common/cmd_net.c size == 0 (File with size 0 loaded)
  1378. 82 common/cmd_net.c trying automatic boot
  1379. 83 common/cmd_net.c running autoscript
  1380. -83 common/cmd_net.c some error in automatic boot or autoscript
  1381. 84 common/cmd_net.c end without errors
  1382. FIT uImage format:
  1383. Arg Where When
  1384. 100 common/cmd_bootm.c Kernel FIT Image has correct format
  1385. -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
  1386. 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
  1387. -101 common/cmd_bootm.c Can't get configuration for kernel subimage
  1388. 102 common/cmd_bootm.c Kernel unit name specified
  1389. -103 common/cmd_bootm.c Can't get kernel subimage node offset
  1390. 103 common/cmd_bootm.c Found configuration node
  1391. 104 common/cmd_bootm.c Got kernel subimage node offset
  1392. -104 common/cmd_bootm.c Kernel subimage hash verification failed
  1393. 105 common/cmd_bootm.c Kernel subimage hash verification OK
  1394. -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
  1395. 106 common/cmd_bootm.c Architecture check OK
  1396. -106 common/cmd_bootm.c Kernel subimage has wrong typea
  1397. 107 common/cmd_bootm.c Kernel subimge type OK
  1398. -107 common/cmd_bootm.c Can't get kernel subimage data/size
  1399. 108 common/cmd_bootm.c Got kernel subimage data/size
  1400. -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
  1401. -109 common/cmd_bootm.c Can't get kernel subimage type
  1402. -110 common/cmd_bootm.c Can't get kernel subimage comp
  1403. -111 common/cmd_bootm.c Can't get kernel subimage os
  1404. -112 common/cmd_bootm.c Can't get kernel subimage load address
  1405. -113 common/cmd_bootm.c Image uncompress/copy overwrite error
  1406. 120 common/image.c Start initial ramdisk verification
  1407. -120 common/image.c Ramdisk FIT image has incorrect format
  1408. 121 common/image.c Ramdisk FIT image has correct format
  1409. 122 common/image.c No Ramdisk subimage unit name, using configuration
  1410. -122 common/image.c Can't get configuration for ramdisk subimage
  1411. 123 common/image.c Ramdisk unit name specified
  1412. -124 common/image.c Can't get ramdisk subimage node offset
  1413. 125 common/image.c Got ramdisk subimage node offset
  1414. -125 common/image.c Ramdisk subimage hash verification failed
  1415. 126 common/image.c Ramdisk subimage hash verification OK
  1416. -126 common/image.c Ramdisk subimage for unsupported architecture
  1417. 127 common/image.c Architecture check OK
  1418. -127 common/image.c Can't get ramdisk subimage data/size
  1419. 128 common/image.c Got ramdisk subimage data/size
  1420. 129 common/image.c Can't get ramdisk load address
  1421. -129 common/image.c Got ramdisk load address
  1422. -130 common/cmd_doc.c Icorrect FIT image format
  1423. 131 common/cmd_doc.c FIT image format OK
  1424. -140 common/cmd_ide.c Icorrect FIT image format
  1425. 141 common/cmd_ide.c FIT image format OK
  1426. -150 common/cmd_nand.c Icorrect FIT image format
  1427. 151 common/cmd_nand.c FIT image format OK
  1428. Modem Support:
  1429. --------------
  1430. [so far only for SMDK2400 and TRAB boards]
  1431. - Modem support endable:
  1432. CONFIG_MODEM_SUPPORT
  1433. - RTS/CTS Flow control enable:
  1434. CONFIG_HWFLOW
  1435. - Modem debug support:
  1436. CONFIG_MODEM_SUPPORT_DEBUG
  1437. Enables debugging stuff (char screen[1024], dbg())
  1438. for modem support. Useful only with BDI2000.
  1439. - Interrupt support (PPC):
  1440. There are common interrupt_init() and timer_interrupt()
  1441. for all PPC archs. interrupt_init() calls interrupt_init_cpu()
  1442. for cpu specific initialization. interrupt_init_cpu()
  1443. should set decrementer_count to appropriate value. If
  1444. cpu resets decrementer automatically after interrupt
  1445. (ppc4xx) it should set decrementer_count to zero.
  1446. timer_interrupt() calls timer_interrupt_cpu() for cpu
  1447. specific handling. If board has watchdog / status_led
  1448. / other_activity_monitor it works automatically from
  1449. general timer_interrupt().
  1450. - General:
  1451. In the target system modem support is enabled when a
  1452. specific key (key combination) is pressed during
  1453. power-on. Otherwise U-Boot will boot normally
  1454. (autoboot). The key_pressed() fuction is called from
  1455. board_init(). Currently key_pressed() is a dummy
  1456. function, returning 1 and thus enabling modem
  1457. initialization.
  1458. If there are no modem init strings in the
  1459. environment, U-Boot proceed to autoboot; the
  1460. previous output (banner, info printfs) will be
  1461. supressed, though.
  1462. See also: doc/README.Modem
  1463. Configuration Settings:
  1464. -----------------------
  1465. - CFG_LONGHELP: Defined when you want long help messages included;
  1466. undefine this when you're short of memory.
  1467. - CFG_PROMPT: This is what U-Boot prints on the console to
  1468. prompt for user input.
  1469. - CFG_CBSIZE: Buffer size for input from the Console
  1470. - CFG_PBSIZE: Buffer size for Console output
  1471. - CFG_MAXARGS: max. Number of arguments accepted for monitor commands
  1472. - CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
  1473. the application (usually a Linux kernel) when it is
  1474. booted
  1475. - CFG_BAUDRATE_TABLE:
  1476. List of legal baudrate settings for this board.
  1477. - CFG_CONSOLE_INFO_QUIET
  1478. Suppress display of console information at boot.
  1479. - CFG_CONSOLE_IS_IN_ENV
  1480. If the board specific function
  1481. extern int overwrite_console (void);
  1482. returns 1, the stdin, stderr and stdout are switched to the
  1483. serial port, else the settings in the environment are used.
  1484. - CFG_CONSOLE_OVERWRITE_ROUTINE
  1485. Enable the call to overwrite_console().
  1486. - CFG_CONSOLE_ENV_OVERWRITE
  1487. Enable overwrite of previous console environment settings.
  1488. - CFG_MEMTEST_START, CFG_MEMTEST_END:
  1489. Begin and End addresses of the area used by the
  1490. simple memory test.
  1491. - CFG_ALT_MEMTEST:
  1492. Enable an alternate, more extensive memory test.
  1493. - CFG_MEMTEST_SCRATCH:
  1494. Scratch address used by the alternate memory test
  1495. You only need to set this if address zero isn't writeable
  1496. - CFG_MEM_TOP_HIDE (PPC only):
  1497. If CFG_MEM_TOP_HIDE is defined in the board config header,
  1498. this specified memory area will get subtracted from the top
  1499. (end) of ram and won't get "touched" at all by U-Boot. By
  1500. fixing up gd->ram_size the Linux kernel should gets passed
  1501. the now "corrected" memory size and won't touch it either.
  1502. This should work for arch/ppc and arch/powerpc. Only Linux
  1503. board ports in arch/powerpc with bootwrapper support that
  1504. recalculate the memory size from the SDRAM controller setup
  1505. will have to get fixed in Linux additionally.
  1506. This option can be used as a workaround for the 440EPx/GRx
  1507. CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
  1508. be touched.
  1509. WARNING: Please make sure that this value is a multiple of
  1510. the Linux page size (normally 4k). If this is not the case,
  1511. then the end address of the Linux memory will be located at a
  1512. non page size aligned address and this could cause major
  1513. problems.
  1514. - CFG_TFTP_LOADADDR:
  1515. Default load address for network file downloads
  1516. - CFG_LOADS_BAUD_CHANGE:
  1517. Enable temporary baudrate change while serial download
  1518. - CFG_SDRAM_BASE:
  1519. Physical start address of SDRAM. _Must_ be 0 here.
  1520. - CFG_MBIO_BASE:
  1521. Physical start address of Motherboard I/O (if using a
  1522. Cogent motherboard)
  1523. - CFG_FLASH_BASE:
  1524. Physical start address of Flash memory.
  1525. - CFG_MONITOR_BASE:
  1526. Physical start address of boot monitor code (set by
  1527. make config files to be same as the text base address
  1528. (TEXT_BASE) used when linking) - same as
  1529. CFG_FLASH_BASE when booting from flash.
  1530. - CFG_MONITOR_LEN:
  1531. Size of memory reserved for monitor code, used to
  1532. determine _at_compile_time_ (!) if the environment is
  1533. embedded within the U-Boot image, or in a separate
  1534. flash sector.
  1535. - CFG_MALLOC_LEN:
  1536. Size of DRAM reserved for malloc() use.
  1537. - CFG_BOOTM_LEN:
  1538. Normally compressed uImages are limited to an
  1539. uncompressed size of 8 MBytes. If this is not enough,
  1540. you can define CFG_BOOTM_LEN in your board config file
  1541. to adjust this setting to your needs.
  1542. - CFG_BOOTMAPSZ:
  1543. Maximum size of memory mapped by the startup code of
  1544. the Linux kernel; all data that must be processed by
  1545. the Linux kernel (bd_info, boot arguments, FDT blob if
  1546. used) must be put below this limit, unless "bootm_low"
  1547. enviroment variable is defined and non-zero. In such case
  1548. all data for the Linux kernel must be between "bootm_low"
  1549. and "bootm_low" + CFG_BOOTMAPSZ.
  1550. - CFG_MAX_FLASH_BANKS:
  1551. Max number of Flash memory banks
  1552. - CFG_MAX_FLASH_SECT:
  1553. Max number of sectors on a Flash chip
  1554. - CFG_FLASH_ERASE_TOUT:
  1555. Timeout for Flash erase operations (in ms)
  1556. - CFG_FLASH_WRITE_TOUT:
  1557. Timeout for Flash write operations (in ms)
  1558. - CFG_FLASH_LOCK_TOUT
  1559. Timeout for Flash set sector lock bit operation (in ms)
  1560. - CFG_FLASH_UNLOCK_TOUT
  1561. Timeout for Flash clear lock bits operation (in ms)
  1562. - CFG_FLASH_PROTECTION
  1563. If defined, hardware flash sectors protection is used
  1564. instead of U-Boot software protection.
  1565. - CFG_DIRECT_FLASH_TFTP:
  1566. Enable TFTP transfers directly to flash memory;
  1567. without this option such a download has to be
  1568. performed in two steps: (1) download to RAM, and (2)
  1569. copy from RAM to flash.
  1570. The two-step approach is usually more reliable, since
  1571. you can check if the download worked before you erase
  1572. the flash, but in some situations (when sytem RAM is
  1573. too limited to allow for a tempory copy of the
  1574. downloaded image) this option may be very useful.
  1575. - CFG_FLASH_CFI:
  1576. Define if the flash driver uses extra elements in the
  1577. common flash structure for storing flash geometry.
  1578. - CFG_FLASH_CFI_DRIVER
  1579. This option also enables the building of the cfi_flash driver
  1580. in the drivers directory
  1581. - CFG_FLASH_USE_BUFFER_WRITE
  1582. Use buffered writes to flash.
  1583. - CONFIG_FLASH_SPANSION_S29WS_N
  1584. s29ws-n MirrorBit flash has non-standard addresses for buffered
  1585. write commands.
  1586. - CFG_FLASH_QUIET_TEST
  1587. If this option is defined, the common CFI flash doesn't
  1588. print it's warning upon not recognized FLASH banks. This
  1589. is useful, if some of the configured banks are only
  1590. optionally available.
  1591. - CONFIG_FLASH_SHOW_PROGRESS
  1592. If defined (must be an integer), print out countdown
  1593. digits and dots. Recommended value: 45 (9..1) for 80
  1594. column displays, 15 (3..1) for 40 column displays.
  1595. - CFG_RX_ETH_BUFFER:
  1596. Defines the number of ethernet receive buffers. On some
  1597. ethernet controllers it is recommended to set this value
  1598. to 8 or even higher (EEPRO100 or 405 EMAC), since all
  1599. buffers can be full shortly after enabling the interface
  1600. on high ethernet traffic.
  1601. Defaults to 4 if not defined.
  1602. The following definitions that deal with the placement and management
  1603. of environment data (variable area); in general, we support the
  1604. following configurations:
  1605. - CFG_ENV_IS_IN_FLASH:
  1606. Define this if the environment is in flash memory.
  1607. a) The environment occupies one whole flash sector, which is
  1608. "embedded" in the text segment with the U-Boot code. This
  1609. happens usually with "bottom boot sector" or "top boot
  1610. sector" type flash chips, which have several smaller
  1611. sectors at the start or the end. For instance, such a
  1612. layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
  1613. such a case you would place the environment in one of the
  1614. 4 kB sectors - with U-Boot code before and after it. With
  1615. "top boot sector" type flash chips, you would put the
  1616. environment in one of the last sectors, leaving a gap
  1617. between U-Boot and the environment.
  1618. - CFG_ENV_OFFSET:
  1619. Offset of environment data (variable area) to the
  1620. beginning of flash memory; for instance, with bottom boot
  1621. type flash chips the second sector can be used: the offset
  1622. for this sector is given here.
  1623. CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
  1624. - CFG_ENV_ADDR:
  1625. This is just another way to specify the start address of
  1626. the flash sector containing the environment (instead of
  1627. CFG_ENV_OFFSET).
  1628. - CFG_ENV_SECT_SIZE:
  1629. Size of the sector containing the environment.
  1630. b) Sometimes flash chips have few, equal sized, BIG sectors.
  1631. In such a case you don't want to spend a whole sector for
  1632. the environment.
  1633. - CFG_ENV_SIZE:
  1634. If you use this in combination with CFG_ENV_IS_IN_FLASH
  1635. and CFG_ENV_SECT_SIZE, you can specify to use only a part
  1636. of this flash sector for the environment. This saves
  1637. memory for the RAM copy of the environment.
  1638. It may also save flash memory if you decide to use this
  1639. when your environment is "embedded" within U-Boot code,
  1640. since then the remainder of the flash sector could be used
  1641. for U-Boot code. It should be pointed out that this is
  1642. STRONGLY DISCOURAGED from a robustness point of view:
  1643. updating the environment in flash makes it always
  1644. necessary to erase the WHOLE sector. If something goes
  1645. wrong before the contents has been restored from a copy in
  1646. RAM, your target system will be dead.
  1647. - CFG_ENV_ADDR_REDUND
  1648. CFG_ENV_SIZE_REDUND
  1649. These settings describe a second storage area used to hold
  1650. a redundand copy of the environment data, so that there is
  1651. a valid backup copy in case there is a power failure during
  1652. a "saveenv" operation.
  1653. BE CAREFUL! Any changes to the flash layout, and some changes to the
  1654. source code will make it necessary to adapt <board>/u-boot.lds*
  1655. accordingly!
  1656. - CFG_ENV_IS_IN_NVRAM:
  1657. Define this if you have some non-volatile memory device
  1658. (NVRAM, battery buffered SRAM) which you want to use for the
  1659. environment.
  1660. - CFG_ENV_ADDR:
  1661. - CFG_ENV_SIZE:
  1662. These two #defines are used to determin the memory area you
  1663. want to use for environment. It is assumed that this memory
  1664. can just be read and written to, without any special
  1665. provision.
  1666. BE CAREFUL! The first access to the environment happens quite early
  1667. in U-Boot initalization (when we try to get the setting of for the
  1668. console baudrate). You *MUST* have mappend your NVRAM area then, or
  1669. U-Boot will hang.
  1670. Please note that even with NVRAM we still use a copy of the
  1671. environment in RAM: we could work on NVRAM directly, but we want to
  1672. keep settings there always unmodified except somebody uses "saveenv"
  1673. to save the current settings.
  1674. - CFG_ENV_IS_IN_EEPROM:
  1675. Use this if you have an EEPROM or similar serial access
  1676. device and a driver for it.
  1677. - CFG_ENV_OFFSET:
  1678. - CFG_ENV_SIZE:
  1679. These two #defines specify the offset and size of the
  1680. environment area within the total memory of your EEPROM.
  1681. - CFG_I2C_EEPROM_ADDR:
  1682. If defined, specified the chip address of the EEPROM device.
  1683. The default address is zero.
  1684. - CFG_EEPROM_PAGE_WRITE_BITS:
  1685. If defined, the number of bits used to address bytes in a
  1686. single page in the EEPROM device. A 64 byte page, for example
  1687. would require six bits.
  1688. - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
  1689. If defined, the number of milliseconds to delay between
  1690. page writes. The default is zero milliseconds.
  1691. - CFG_I2C_EEPROM_ADDR_LEN:
  1692. The length in bytes of the EEPROM memory array address. Note
  1693. that this is NOT the chip address length!
  1694. - CFG_I2C_EEPROM_ADDR_OVERFLOW:
  1695. EEPROM chips that implement "address overflow" are ones
  1696. like Catalyst 24WC04/08/16 which has 9/10/11 bits of
  1697. address and the extra bits end up in the "chip address" bit
  1698. slots. This makes a 24WC08 (1Kbyte) chip look like four 256
  1699. byte chips.
  1700. Note that we consider the length of the address field to
  1701. still be one byte because the extra address bits are hidden
  1702. in the chip address.
  1703. - CFG_EEPROM_SIZE:
  1704. The size in bytes of the EEPROM device.
  1705. - CFG_ENV_IS_IN_DATAFLASH:
  1706. Define this if you have a DataFlash memory device which you
  1707. want to use for the environment.
  1708. - CFG_ENV_OFFSET:
  1709. - CFG_ENV_ADDR:
  1710. - CFG_ENV_SIZE:
  1711. These three #defines specify the offset and size of the
  1712. environment area within the total memory of your DataFlash placed
  1713. at the specified address.
  1714. - CFG_ENV_IS_IN_NAND:
  1715. Define this if you have a NAND device which you want to use
  1716. for the environment.
  1717. - CFG_ENV_OFFSET:
  1718. - CFG_ENV_SIZE:
  1719. These two #defines specify the offset and size of the environment
  1720. area within the first NAND device.
  1721. - CFG_ENV_OFFSET_REDUND
  1722. This setting describes a second storage area of CFG_ENV_SIZE
  1723. size used to hold a redundant copy of the environment data,
  1724. so that there is a valid backup copy in case there is a
  1725. power failure during a "saveenv" operation.
  1726. Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
  1727. to a block boundary, and CFG_ENV_SIZE must be a multiple of
  1728. the NAND devices block size.
  1729. - CFG_SPI_INIT_OFFSET
  1730. Defines offset to the initial SPI buffer area in DPRAM. The
  1731. area is used at an early stage (ROM part) if the environment
  1732. is configured to reside in the SPI EEPROM: We need a 520 byte
  1733. scratch DPRAM area. It is used between the two initialization
  1734. calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
  1735. to be a good choice since it makes it far enough from the
  1736. start of the data area as well as from the stack pointer.
  1737. Please note that the environment is read-only until the monitor
  1738. has been relocated to RAM and a RAM copy of the environment has been
  1739. created; also, when using EEPROM you will have to use getenv_r()
  1740. until then to read environment variables.
  1741. The environment is protected by a CRC32 checksum. Before the monitor
  1742. is relocated into RAM, as a result of a bad CRC you will be working
  1743. with the compiled-in default environment - *silently*!!! [This is
  1744. necessary, because the first environment variable we need is the
  1745. "baudrate" setting for the console - if we have a bad CRC, we don't
  1746. have any device yet where we could complain.]
  1747. Note: once the monitor has been relocated, then it will complain if
  1748. the default environment is used; a new CRC is computed as soon as you
  1749. use the "saveenv" command to store a valid environment.
  1750. - CFG_FAULT_ECHO_LINK_DOWN:
  1751. Echo the inverted Ethernet link state to the fault LED.
  1752. Note: If this option is active, then CFG_FAULT_MII_ADDR
  1753. also needs to be defined.
  1754. - CFG_FAULT_MII_ADDR:
  1755. MII address of the PHY to check for the Ethernet link state.
  1756. - CFG_64BIT_VSPRINTF:
  1757. Makes vsprintf (and all *printf functions) support printing
  1758. of 64bit values by using the L quantifier
  1759. - CFG_64BIT_STRTOUL:
  1760. Adds simple_strtoull that returns a 64bit value
  1761. Low Level (hardware related) configuration options:
  1762. ---------------------------------------------------
  1763. - CFG_CACHELINE_SIZE:
  1764. Cache Line Size of the CPU.
  1765. - CFG_DEFAULT_IMMR:
  1766. Default address of the IMMR after system reset.
  1767. Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
  1768. and RPXsuper) to be able to adjust the position of
  1769. the IMMR register after a reset.
  1770. - Floppy Disk Support:
  1771. CFG_FDC_DRIVE_NUMBER
  1772. the default drive number (default value 0)
  1773. CFG_ISA_IO_STRIDE
  1774. defines the spacing between fdc chipset registers
  1775. (default value 1)
  1776. CFG_ISA_IO_OFFSET
  1777. defines the offset of register from address. It
  1778. depends on which part of the data bus is connected to
  1779. the fdc chipset. (default value 0)
  1780. If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
  1781. CFG_FDC_DRIVE_NUMBER are undefined, they take their
  1782. default value.
  1783. if CFG_FDC_HW_INIT is defined, then the function
  1784. fdc_hw_init() is called at the beginning of the FDC
  1785. setup. fdc_hw_init() must be provided by the board
  1786. source code. It is used to make hardware dependant
  1787. initializations.
  1788. - CFG_IMMR: Physical address of the Internal Memory.
  1789. DO NOT CHANGE unless you know exactly what you're
  1790. doing! (11-4) [MPC8xx/82xx systems only]
  1791. - CFG_INIT_RAM_ADDR:
  1792. Start address of memory area that can be used for
  1793. initial data and stack; please note that this must be
  1794. writable memory that is working WITHOUT special
  1795. initialization, i. e. you CANNOT use normal RAM which
  1796. will become available only after programming the
  1797. memory controller and running certain initialization
  1798. sequences.
  1799. U-Boot uses the following memory types:
  1800. - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
  1801. - MPC824X: data cache
  1802. - PPC4xx: data cache
  1803. - CFG_GBL_DATA_OFFSET:
  1804. Offset of the initial data structure in the memory
  1805. area defined by CFG_INIT_RAM_ADDR. Usually
  1806. CFG_GBL_DATA_OFFSET is chosen such that the initial
  1807. data is located at the end of the available space
  1808. (sometimes written as (CFG_INIT_RAM_END -
  1809. CFG_INIT_DATA_SIZE), and the initial stack is just
  1810. below that area (growing from (CFG_INIT_RAM_ADDR +
  1811. CFG_GBL_DATA_OFFSET) downward.
  1812. Note:
  1813. On the MPC824X (or other systems that use the data
  1814. cache for initial memory) the address chosen for
  1815. CFG_INIT_RAM_ADDR is basically arbitrary - it must
  1816. point to an otherwise UNUSED address space between
  1817. the top of RAM and the start of the PCI space.
  1818. - CFG_SIUMCR: SIU Module Configuration (11-6)
  1819. - CFG_SYPCR: System Protection Control (11-9)
  1820. - CFG_TBSCR: Time Base Status and Control (11-26)
  1821. - CFG_PISCR: Periodic Interrupt Status and Control (11-31)
  1822. - CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
  1823. - CFG_SCCR: System Clock and reset Control Register (15-27)
  1824. - CFG_OR_TIMING_SDRAM:
  1825. SDRAM timing
  1826. - CFG_MAMR_PTA:
  1827. periodic timer for refresh
  1828. - CFG_DER: Debug Event Register (37-47)
  1829. - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
  1830. CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
  1831. CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
  1832. CFG_BR1_PRELIM:
  1833. Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
  1834. - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
  1835. CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
  1836. CFG_OR3_PRELIM, CFG_BR3_PRELIM:
  1837. Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
  1838. - CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
  1839. CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
  1840. Machine Mode Register and Memory Periodic Timer
  1841. Prescaler definitions (SDRAM timing)
  1842. - CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
  1843. enable I2C microcode relocation patch (MPC8xx);
  1844. define relocation offset in DPRAM [DSP2]
  1845. - CFG_SMC_UCODE_PATCH, CFG_SMC_DPMEM_OFFSET [0x1FC0]:
  1846. enable SMC microcode relocation patch (MPC8xx);
  1847. define relocation offset in DPRAM [SMC1]
  1848. - CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
  1849. enable SPI microcode relocation patch (MPC8xx);
  1850. define relocation offset in DPRAM [SCC4]
  1851. - CFG_USE_OSCCLK:
  1852. Use OSCM clock mode on MBX8xx board. Be careful,
  1853. wrong setting might damage your board. Read
  1854. doc/README.MBX before setting this variable!
  1855. - CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
  1856. Offset of the bootmode word in DPRAM used by post
  1857. (Power On Self Tests). This definition overrides
  1858. #define'd default value in commproc.h resp.
  1859. cpm_8260.h.
  1860. - CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
  1861. CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
  1862. CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
  1863. CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
  1864. CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
  1865. CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
  1866. CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
  1867. CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
  1868. Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
  1869. - CONFIG_SPD_EEPROM
  1870. Get DDR timing information from an I2C EEPROM. Common
  1871. with pluggable memory modules such as SODIMMs
  1872. SPD_EEPROM_ADDRESS
  1873. I2C address of the SPD EEPROM
  1874. - CFG_SPD_BUS_NUM
  1875. If SPD EEPROM is on an I2C bus other than the first
  1876. one, specify here. Note that the value must resolve
  1877. to something your driver can deal with.
  1878. - CFG_83XX_DDR_USES_CS0
  1879. Only for 83xx systems. If specified, then DDR should
  1880. be configured using CS0 and CS1 instead of CS2 and CS3.
  1881. - CFG_83XX_DDR_USES_CS0
  1882. Only for 83xx systems. If specified, then DDR should
  1883. be configured using CS0 and CS1 instead of CS2 and CS3.
  1884. - CONFIG_ETHER_ON_FEC[12]
  1885. Define to enable FEC[12] on a 8xx series processor.
  1886. - CONFIG_FEC[12]_PHY
  1887. Define to the hardcoded PHY address which corresponds
  1888. to the given FEC; i. e.
  1889. #define CONFIG_FEC1_PHY 4
  1890. means that the PHY with address 4 is connected to FEC1
  1891. When set to -1, means to probe for first available.
  1892. - CONFIG_FEC[12]_PHY_NORXERR
  1893. The PHY does not have a RXERR line (RMII only).
  1894. (so program the FEC to ignore it).
  1895. - CONFIG_RMII
  1896. Enable RMII mode for all FECs.
  1897. Note that this is a global option, we can't
  1898. have one FEC in standard MII mode and another in RMII mode.
  1899. - CONFIG_CRC32_VERIFY
  1900. Add a verify option to the crc32 command.
  1901. The syntax is:
  1902. => crc32 -v <address> <count> <crc32>
  1903. Where address/count indicate a memory area
  1904. and crc32 is the correct crc32 which the
  1905. area should have.
  1906. - CONFIG_LOOPW
  1907. Add the "loopw" memory command. This only takes effect if
  1908. the memory commands are activated globally (CONFIG_CMD_MEM).
  1909. - CONFIG_MX_CYCLIC
  1910. Add the "mdc" and "mwc" memory commands. These are cyclic
  1911. "md/mw" commands.
  1912. Examples:
  1913. => mdc.b 10 4 500
  1914. This command will print 4 bytes (10,11,12,13) each 500 ms.
  1915. => mwc.l 100 12345678 10
  1916. This command will write 12345678 to address 100 all 10 ms.
  1917. This only takes effect if the memory commands are activated
  1918. globally (CONFIG_CMD_MEM).
  1919. - CONFIG_SKIP_LOWLEVEL_INIT
  1920. - CONFIG_SKIP_RELOCATE_UBOOT
  1921. [ARM only] If these variables are defined, then
  1922. certain low level initializations (like setting up
  1923. the memory controller) are omitted and/or U-Boot does
  1924. not relocate itself into RAM.
  1925. Normally these variables MUST NOT be defined. The
  1926. only exception is when U-Boot is loaded (to RAM) by
  1927. some other boot loader or by a debugger which
  1928. performs these intializations itself.
  1929. Building the Software:
  1930. ======================
  1931. Building U-Boot has been tested in several native build environments
  1932. and in many different cross environments. Of course we cannot support
  1933. all possibly existing versions of cross development tools in all
  1934. (potentially obsolete) versions. In case of tool chain problems we
  1935. recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
  1936. which is extensively used to build and test U-Boot.
  1937. If you are not using a native environment, it is assumed that you
  1938. have GNU cross compiling tools available in your path. In this case,
  1939. you must set the environment variable CROSS_COMPILE in your shell.
  1940. Note that no changes to the Makefile or any other source files are
  1941. necessary. For example using the ELDK on a 4xx CPU, please enter:
  1942. $ CROSS_COMPILE=ppc_4xx-
  1943. $ export CROSS_COMPILE
  1944. U-Boot is intended to be simple to build. After installing the
  1945. sources you must configure U-Boot for one specific board type. This
  1946. is done by typing:
  1947. make NAME_config
  1948. where "NAME_config" is the name of one of the existing configu-
  1949. rations; see the main Makefile for supported names.
  1950. Note: for some board special configuration names may exist; check if
  1951. additional information is available from the board vendor; for
  1952. instance, the TQM823L systems are available without (standard)
  1953. or with LCD support. You can select such additional "features"
  1954. when chosing the configuration, i. e.
  1955. make TQM823L_config
  1956. - will configure for a plain TQM823L, i. e. no LCD support
  1957. make TQM823L_LCD_config
  1958. - will configure for a TQM823L with U-Boot console on LCD
  1959. etc.
  1960. Finally, type "make all", and you should get some working U-Boot
  1961. images ready for download to / installation on your system:
  1962. - "u-boot.bin" is a raw binary image
  1963. - "u-boot" is an image in ELF binary format
  1964. - "u-boot.srec" is in Motorola S-Record format
  1965. By default the build is performed locally and the objects are saved
  1966. in the source directory. One of the two methods can be used to change
  1967. this behavior and build U-Boot to some external directory:
  1968. 1. Add O= to the make command line invocations:
  1969. make O=/tmp/build distclean
  1970. make O=/tmp/build NAME_config
  1971. make O=/tmp/build all
  1972. 2. Set environment variable BUILD_DIR to point to the desired location:
  1973. export BUILD_DIR=/tmp/build
  1974. make distclean
  1975. make NAME_config
  1976. make all
  1977. Note that the command line "O=" setting overrides the BUILD_DIR environment
  1978. variable.
  1979. Please be aware that the Makefiles assume you are using GNU make, so
  1980. for instance on NetBSD you might need to use "gmake" instead of
  1981. native "make".
  1982. If the system board that you have is not listed, then you will need
  1983. to port U-Boot to your hardware platform. To do this, follow these
  1984. steps:
  1985. 1. Add a new configuration option for your board to the toplevel
  1986. "Makefile" and to the "MAKEALL" script, using the existing
  1987. entries as examples. Note that here and at many other places
  1988. boards and other names are listed in alphabetical sort order. Please
  1989. keep this order.
  1990. 2. Create a new directory to hold your board specific code. Add any
  1991. files you need. In your board directory, you will need at least
  1992. the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
  1993. 3. Create a new configuration file "include/configs/<board>.h" for
  1994. your board
  1995. 3. If you're porting U-Boot to a new CPU, then also create a new
  1996. directory to hold your CPU specific code. Add any files you need.
  1997. 4. Run "make <board>_config" with your new name.
  1998. 5. Type "make", and you should get a working "u-boot.srec" file
  1999. to be installed on your target system.
  2000. 6. Debug and solve any problems that might arise.
  2001. [Of course, this last step is much harder than it sounds.]
  2002. Testing of U-Boot Modifications, Ports to New Hardware, etc.:
  2003. ==============================================================
  2004. If you have modified U-Boot sources (for instance added a new board
  2005. or support for new devices, a new CPU, etc.) you are expected to
  2006. provide feedback to the other developers. The feedback normally takes
  2007. the form of a "patch", i. e. a context diff against a certain (latest
  2008. official or latest in the git repository) version of U-Boot sources.
  2009. But before you submit such a patch, please verify that your modifi-
  2010. cation did not break existing code. At least make sure that *ALL* of
  2011. the supported boards compile WITHOUT ANY compiler warnings. To do so,
  2012. just run the "MAKEALL" script, which will configure and build U-Boot
  2013. for ALL supported system. Be warned, this will take a while. You can
  2014. select which (cross) compiler to use by passing a `CROSS_COMPILE'
  2015. environment variable to the script, i. e. to use the ELDK cross tools
  2016. you can type
  2017. CROSS_COMPILE=ppc_8xx- MAKEALL
  2018. or to build on a native PowerPC system you can type
  2019. CROSS_COMPILE=' ' MAKEALL
  2020. When using the MAKEALL script, the default behaviour is to build
  2021. U-Boot in the source directory. This location can be changed by
  2022. setting the BUILD_DIR environment variable. Also, for each target
  2023. built, the MAKEALL script saves two log files (<target>.ERR and
  2024. <target>.MAKEALL) in the <source dir>/LOG directory. This default
  2025. location can be changed by setting the MAKEALL_LOGDIR environment
  2026. variable. For example:
  2027. export BUILD_DIR=/tmp/build
  2028. export MAKEALL_LOGDIR=/tmp/log
  2029. CROSS_COMPILE=ppc_8xx- MAKEALL
  2030. With the above settings build objects are saved in the /tmp/build,
  2031. log files are saved in the /tmp/log and the source tree remains clean
  2032. during the whole build process.
  2033. See also "U-Boot Porting Guide" below.
  2034. Monitor Commands - Overview:
  2035. ============================
  2036. go - start application at address 'addr'
  2037. run - run commands in an environment variable
  2038. bootm - boot application image from memory
  2039. bootp - boot image via network using BootP/TFTP protocol
  2040. tftpboot- boot image via network using TFTP protocol
  2041. and env variables "ipaddr" and "serverip"
  2042. (and eventually "gatewayip")
  2043. rarpboot- boot image via network using RARP/TFTP protocol
  2044. diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
  2045. loads - load S-Record file over serial line
  2046. loadb - load binary file over serial line (kermit mode)
  2047. md - memory display
  2048. mm - memory modify (auto-incrementing)
  2049. nm - memory modify (constant address)
  2050. mw - memory write (fill)
  2051. cp - memory copy
  2052. cmp - memory compare
  2053. crc32 - checksum calculation
  2054. imd - i2c memory display
  2055. imm - i2c memory modify (auto-incrementing)
  2056. inm - i2c memory modify (constant address)
  2057. imw - i2c memory write (fill)
  2058. icrc32 - i2c checksum calculation
  2059. iprobe - probe to discover valid I2C chip addresses
  2060. iloop - infinite loop on address range
  2061. isdram - print SDRAM configuration information
  2062. sspi - SPI utility commands
  2063. base - print or set address offset
  2064. printenv- print environment variables
  2065. setenv - set environment variables
  2066. saveenv - save environment variables to persistent storage
  2067. protect - enable or disable FLASH write protection
  2068. erase - erase FLASH memory
  2069. flinfo - print FLASH memory information
  2070. bdinfo - print Board Info structure
  2071. iminfo - print header information for application image
  2072. coninfo - print console devices and informations
  2073. ide - IDE sub-system
  2074. loop - infinite loop on address range
  2075. loopw - infinite write loop on address range
  2076. mtest - simple RAM test
  2077. icache - enable or disable instruction cache
  2078. dcache - enable or disable data cache
  2079. reset - Perform RESET of the CPU
  2080. echo - echo args to console
  2081. version - print monitor version
  2082. help - print online help
  2083. ? - alias for 'help'
  2084. Monitor Commands - Detailed Description:
  2085. ========================================
  2086. TODO.
  2087. For now: just type "help <command>".
  2088. Environment Variables:
  2089. ======================
  2090. U-Boot supports user configuration using Environment Variables which
  2091. can be made persistent by saving to Flash memory.
  2092. Environment Variables are set using "setenv", printed using
  2093. "printenv", and saved to Flash using "saveenv". Using "setenv"
  2094. without a value can be used to delete a variable from the
  2095. environment. As long as you don't save the environment you are
  2096. working with an in-memory copy. In case the Flash area containing the
  2097. environment is erased by accident, a default environment is provided.
  2098. Some configuration options can be set using Environment Variables:
  2099. baudrate - see CONFIG_BAUDRATE
  2100. bootdelay - see CONFIG_BOOTDELAY
  2101. bootcmd - see CONFIG_BOOTCOMMAND
  2102. bootargs - Boot arguments when booting an RTOS image
  2103. bootfile - Name of the image to load with TFTP
  2104. bootm_low - Memory range available for image processing in the bootm
  2105. command can be restricted. This variable is given as
  2106. a hexadecimal number and defines lowest address allowed
  2107. for use by the bootm command. See also "bootm_size"
  2108. environment variable. Address defined by "bootm_low" is
  2109. also the base of the initial memory mapping for the Linux
  2110. kernel -- see the descripton of CFG_BOOTMAPSZ.
  2111. bootm_size - Memory range available for image processing in the bootm
  2112. command can be restricted. This variable is given as
  2113. a hexadecimal number and defines the size of the region
  2114. allowed for use by the bootm command. See also "bootm_low"
  2115. environment variable.
  2116. autoload - if set to "no" (any string beginning with 'n'),
  2117. "bootp" will just load perform a lookup of the
  2118. configuration from the BOOTP server, but not try to
  2119. load any image using TFTP
  2120. autoscript - if set to "yes" commands like "loadb", "loady",
  2121. "bootp", "tftpb", "rarpboot" and "nfs" will attempt
  2122. to automatically run script images (by internally
  2123. calling "autoscript").
  2124. autoscript_uname - if script image is in a format (FIT) this
  2125. variable is used to get script subimage unit name.
  2126. autostart - if set to "yes", an image loaded using the "bootp",
  2127. "rarpboot", "tftpboot" or "diskboot" commands will
  2128. be automatically started (by internally calling
  2129. "bootm")
  2130. If set to "no", a standalone image passed to the
  2131. "bootm" command will be copied to the load address
  2132. (and eventually uncompressed), but NOT be started.
  2133. This can be used to load and uncompress arbitrary
  2134. data.
  2135. i2cfast - (PPC405GP|PPC405EP only)
  2136. if set to 'y' configures Linux I2C driver for fast
  2137. mode (400kHZ). This environment variable is used in
  2138. initialization code. So, for changes to be effective
  2139. it must be saved and board must be reset.
  2140. initrd_high - restrict positioning of initrd images:
  2141. If this variable is not set, initrd images will be
  2142. copied to the highest possible address in RAM; this
  2143. is usually what you want since it allows for
  2144. maximum initrd size. If for some reason you want to
  2145. make sure that the initrd image is loaded below the
  2146. CFG_BOOTMAPSZ limit, you can set this environment
  2147. variable to a value of "no" or "off" or "0".
  2148. Alternatively, you can set it to a maximum upper
  2149. address to use (U-Boot will still check that it
  2150. does not overwrite the U-Boot stack and data).
  2151. For instance, when you have a system with 16 MB
  2152. RAM, and want to reserve 4 MB from use by Linux,
  2153. you can do this by adding "mem=12M" to the value of
  2154. the "bootargs" variable. However, now you must make
  2155. sure that the initrd image is placed in the first
  2156. 12 MB as well - this can be done with
  2157. setenv initrd_high 00c00000
  2158. If you set initrd_high to 0xFFFFFFFF, this is an
  2159. indication to U-Boot that all addresses are legal
  2160. for the Linux kernel, including addresses in flash
  2161. memory. In this case U-Boot will NOT COPY the
  2162. ramdisk at all. This may be useful to reduce the
  2163. boot time on your system, but requires that this
  2164. feature is supported by your Linux kernel.
  2165. ipaddr - IP address; needed for tftpboot command
  2166. loadaddr - Default load address for commands like "bootp",
  2167. "rarpboot", "tftpboot", "loadb" or "diskboot"
  2168. loads_echo - see CONFIG_LOADS_ECHO
  2169. serverip - TFTP server IP address; needed for tftpboot command
  2170. bootretry - see CONFIG_BOOT_RETRY_TIME
  2171. bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
  2172. bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
  2173. ethprime - When CONFIG_NET_MULTI is enabled controls which
  2174. interface is used first.
  2175. ethact - When CONFIG_NET_MULTI is enabled controls which
  2176. interface is currently active. For example you
  2177. can do the following
  2178. => setenv ethact FEC ETHERNET
  2179. => ping 192.168.0.1 # traffic sent on FEC ETHERNET
  2180. => setenv ethact SCC ETHERNET
  2181. => ping 10.0.0.1 # traffic sent on SCC ETHERNET
  2182. ethrotate - When set to "no" U-Boot does not go through all
  2183. available network interfaces.
  2184. It just stays at the currently selected interface.
  2185. netretry - When set to "no" each network operation will
  2186. either succeed or fail without retrying.
  2187. When set to "once" the network operation will
  2188. fail when all the available network interfaces
  2189. are tried once without success.
  2190. Useful on scripts which control the retry operation
  2191. themselves.
  2192. npe_ucode - see CONFIG_IXP4XX_NPE_EXT_UCOD
  2193. if set load address for the npe microcode
  2194. tftpsrcport - If this is set, the value is used for TFTP's
  2195. UDP source port.
  2196. tftpdstport - If this is set, the value is used for TFTP's UDP
  2197. destination port instead of the Well Know Port 69.
  2198. vlan - When set to a value < 4095 the traffic over
  2199. ethernet is encapsulated/received over 802.1q
  2200. VLAN tagged frames.
  2201. The following environment variables may be used and automatically
  2202. updated by the network boot commands ("bootp" and "rarpboot"),
  2203. depending the information provided by your boot server:
  2204. bootfile - see above
  2205. dnsip - IP address of your Domain Name Server
  2206. dnsip2 - IP address of your secondary Domain Name Server
  2207. gatewayip - IP address of the Gateway (Router) to use
  2208. hostname - Target hostname
  2209. ipaddr - see above
  2210. netmask - Subnet Mask
  2211. rootpath - Pathname of the root filesystem on the NFS server
  2212. serverip - see above
  2213. There are two special Environment Variables:
  2214. serial# - contains hardware identification information such
  2215. as type string and/or serial number
  2216. ethaddr - Ethernet address
  2217. These variables can be set only once (usually during manufacturing of
  2218. the board). U-Boot refuses to delete or overwrite these variables
  2219. once they have been set once.
  2220. Further special Environment Variables:
  2221. ver - Contains the U-Boot version string as printed
  2222. with the "version" command. This variable is
  2223. readonly (see CONFIG_VERSION_VARIABLE).
  2224. Please note that changes to some configuration parameters may take
  2225. only effect after the next boot (yes, that's just like Windoze :-).
  2226. Command Line Parsing:
  2227. =====================
  2228. There are two different command line parsers available with U-Boot:
  2229. the old "simple" one, and the much more powerful "hush" shell:
  2230. Old, simple command line parser:
  2231. --------------------------------
  2232. - supports environment variables (through setenv / saveenv commands)
  2233. - several commands on one line, separated by ';'
  2234. - variable substitution using "... ${name} ..." syntax
  2235. - special characters ('$', ';') can be escaped by prefixing with '\',
  2236. for example:
  2237. setenv bootcmd bootm \${address}
  2238. - You can also escape text by enclosing in single apostrophes, for example:
  2239. setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
  2240. Hush shell:
  2241. -----------
  2242. - similar to Bourne shell, with control structures like
  2243. if...then...else...fi, for...do...done; while...do...done,
  2244. until...do...done, ...
  2245. - supports environment ("global") variables (through setenv / saveenv
  2246. commands) and local shell variables (through standard shell syntax
  2247. "name=value"); only environment variables can be used with "run"
  2248. command
  2249. General rules:
  2250. --------------
  2251. (1) If a command line (or an environment variable executed by a "run"
  2252. command) contains several commands separated by semicolon, and
  2253. one of these commands fails, then the remaining commands will be
  2254. executed anyway.
  2255. (2) If you execute several variables with one call to run (i. e.
  2256. calling run with a list af variables as arguments), any failing
  2257. command will cause "run" to terminate, i. e. the remaining
  2258. variables are not executed.
  2259. Note for Redundant Ethernet Interfaces:
  2260. =======================================
  2261. Some boards come with redundant ethernet interfaces; U-Boot supports
  2262. such configurations and is capable of automatic selection of a
  2263. "working" interface when needed. MAC assignment works as follows:
  2264. Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
  2265. MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
  2266. "eth1addr" (=>eth1), "eth2addr", ...
  2267. If the network interface stores some valid MAC address (for instance
  2268. in SROM), this is used as default address if there is NO correspon-
  2269. ding setting in the environment; if the corresponding environment
  2270. variable is set, this overrides the settings in the card; that means:
  2271. o If the SROM has a valid MAC address, and there is no address in the
  2272. environment, the SROM's address is used.
  2273. o If there is no valid address in the SROM, and a definition in the
  2274. environment exists, then the value from the environment variable is
  2275. used.
  2276. o If both the SROM and the environment contain a MAC address, and
  2277. both addresses are the same, this MAC address is used.
  2278. o If both the SROM and the environment contain a MAC address, and the
  2279. addresses differ, the value from the environment is used and a
  2280. warning is printed.
  2281. o If neither SROM nor the environment contain a MAC address, an error
  2282. is raised.
  2283. Image Formats:
  2284. ==============
  2285. U-Boot is capable of booting (and performing other auxiliary operations on)
  2286. images in two formats:
  2287. New uImage format (FIT)
  2288. -----------------------
  2289. Flexible and powerful format based on Flattened Image Tree -- FIT (similar
  2290. to Flattened Device Tree). It allows the use of images with multiple
  2291. components (several kernels, ramdisks, etc.), with contents protected by
  2292. SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
  2293. Old uImage format
  2294. -----------------
  2295. Old image format is based on binary files which can be basically anything,
  2296. preceded by a special header; see the definitions in include/image.h for
  2297. details; basically, the header defines the following image properties:
  2298. * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
  2299. 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
  2300. LynxOS, pSOS, QNX, RTEMS, ARTOS;
  2301. Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
  2302. * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
  2303. IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
  2304. Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
  2305. * Compression Type (uncompressed, gzip, bzip2)
  2306. * Load Address
  2307. * Entry Point
  2308. * Image Name
  2309. * Image Timestamp
  2310. The header is marked by a special Magic Number, and both the header
  2311. and the data portions of the image are secured against corruption by
  2312. CRC32 checksums.
  2313. Linux Support:
  2314. ==============
  2315. Although U-Boot should support any OS or standalone application
  2316. easily, the main focus has always been on Linux during the design of
  2317. U-Boot.
  2318. U-Boot includes many features that so far have been part of some
  2319. special "boot loader" code within the Linux kernel. Also, any
  2320. "initrd" images to be used are no longer part of one big Linux image;
  2321. instead, kernel and "initrd" are separate images. This implementation
  2322. serves several purposes:
  2323. - the same features can be used for other OS or standalone
  2324. applications (for instance: using compressed images to reduce the
  2325. Flash memory footprint)
  2326. - it becomes much easier to port new Linux kernel versions because
  2327. lots of low-level, hardware dependent stuff are done by U-Boot
  2328. - the same Linux kernel image can now be used with different "initrd"
  2329. images; of course this also means that different kernel images can
  2330. be run with the same "initrd". This makes testing easier (you don't
  2331. have to build a new "zImage.initrd" Linux image when you just
  2332. change a file in your "initrd"). Also, a field-upgrade of the
  2333. software is easier now.
  2334. Linux HOWTO:
  2335. ============
  2336. Porting Linux to U-Boot based systems:
  2337. ---------------------------------------
  2338. U-Boot cannot save you from doing all the necessary modifications to
  2339. configure the Linux device drivers for use with your target hardware
  2340. (no, we don't intend to provide a full virtual machine interface to
  2341. Linux :-).
  2342. But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
  2343. Just make sure your machine specific header file (for instance
  2344. include/asm-ppc/tqm8xx.h) includes the same definition of the Board
  2345. Information structure as we define in include/u-boot.h, and make
  2346. sure that your definition of IMAP_ADDR uses the same value as your
  2347. U-Boot configuration in CFG_IMMR.
  2348. Configuring the Linux kernel:
  2349. -----------------------------
  2350. No specific requirements for U-Boot. Make sure you have some root
  2351. device (initial ramdisk, NFS) for your target system.
  2352. Building a Linux Image:
  2353. -----------------------
  2354. With U-Boot, "normal" build targets like "zImage" or "bzImage" are
  2355. not used. If you use recent kernel source, a new build target
  2356. "uImage" will exist which automatically builds an image usable by
  2357. U-Boot. Most older kernels also have support for a "pImage" target,
  2358. which was introduced for our predecessor project PPCBoot and uses a
  2359. 100% compatible format.
  2360. Example:
  2361. make TQM850L_config
  2362. make oldconfig
  2363. make dep
  2364. make uImage
  2365. The "uImage" build target uses a special tool (in 'tools/mkimage') to
  2366. encapsulate a compressed Linux kernel image with header information,
  2367. CRC32 checksum etc. for use with U-Boot. This is what we are doing:
  2368. * build a standard "vmlinux" kernel image (in ELF binary format):
  2369. * convert the kernel into a raw binary image:
  2370. ${CROSS_COMPILE}-objcopy -O binary \
  2371. -R .note -R .comment \
  2372. -S vmlinux linux.bin
  2373. * compress the binary image:
  2374. gzip -9 linux.bin
  2375. * package compressed binary image for U-Boot:
  2376. mkimage -A ppc -O linux -T kernel -C gzip \
  2377. -a 0 -e 0 -n "Linux Kernel Image" \
  2378. -d linux.bin.gz uImage
  2379. The "mkimage" tool can also be used to create ramdisk images for use
  2380. with U-Boot, either separated from the Linux kernel image, or
  2381. combined into one file. "mkimage" encapsulates the images with a 64
  2382. byte header containing information about target architecture,
  2383. operating system, image type, compression method, entry points, time
  2384. stamp, CRC32 checksums, etc.
  2385. "mkimage" can be called in two ways: to verify existing images and
  2386. print the header information, or to build new images.
  2387. In the first form (with "-l" option) mkimage lists the information
  2388. contained in the header of an existing U-Boot image; this includes
  2389. checksum verification:
  2390. tools/mkimage -l image
  2391. -l ==> list image header information
  2392. The second form (with "-d" option) is used to build a U-Boot image
  2393. from a "data file" which is used as image payload:
  2394. tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
  2395. -n name -d data_file image
  2396. -A ==> set architecture to 'arch'
  2397. -O ==> set operating system to 'os'
  2398. -T ==> set image type to 'type'
  2399. -C ==> set compression type 'comp'
  2400. -a ==> set load address to 'addr' (hex)
  2401. -e ==> set entry point to 'ep' (hex)
  2402. -n ==> set image name to 'name'
  2403. -d ==> use image data from 'datafile'
  2404. Right now, all Linux kernels for PowerPC systems use the same load
  2405. address (0x00000000), but the entry point address depends on the
  2406. kernel version:
  2407. - 2.2.x kernels have the entry point at 0x0000000C,
  2408. - 2.3.x and later kernels have the entry point at 0x00000000.
  2409. So a typical call to build a U-Boot image would read:
  2410. -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
  2411. > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
  2412. > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
  2413. > examples/uImage.TQM850L
  2414. Image Name: 2.4.4 kernel for TQM850L
  2415. Created: Wed Jul 19 02:34:59 2000
  2416. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2417. Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
  2418. Load Address: 0x00000000
  2419. Entry Point: 0x00000000
  2420. To verify the contents of the image (or check for corruption):
  2421. -> tools/mkimage -l examples/uImage.TQM850L
  2422. Image Name: 2.4.4 kernel for TQM850L
  2423. Created: Wed Jul 19 02:34:59 2000
  2424. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2425. Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
  2426. Load Address: 0x00000000
  2427. Entry Point: 0x00000000
  2428. NOTE: for embedded systems where boot time is critical you can trade
  2429. speed for memory and install an UNCOMPRESSED image instead: this
  2430. needs more space in Flash, but boots much faster since it does not
  2431. need to be uncompressed:
  2432. -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
  2433. -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
  2434. > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
  2435. > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
  2436. > examples/uImage.TQM850L-uncompressed
  2437. Image Name: 2.4.4 kernel for TQM850L
  2438. Created: Wed Jul 19 02:34:59 2000
  2439. Image Type: PowerPC Linux Kernel Image (uncompressed)
  2440. Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
  2441. Load Address: 0x00000000
  2442. Entry Point: 0x00000000
  2443. Similar you can build U-Boot images from a 'ramdisk.image.gz' file
  2444. when your kernel is intended to use an initial ramdisk:
  2445. -> tools/mkimage -n 'Simple Ramdisk Image' \
  2446. > -A ppc -O linux -T ramdisk -C gzip \
  2447. > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
  2448. Image Name: Simple Ramdisk Image
  2449. Created: Wed Jan 12 14:01:50 2000
  2450. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  2451. Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
  2452. Load Address: 0x00000000
  2453. Entry Point: 0x00000000
  2454. Installing a Linux Image:
  2455. -------------------------
  2456. To downloading a U-Boot image over the serial (console) interface,
  2457. you must convert the image to S-Record format:
  2458. objcopy -I binary -O srec examples/image examples/image.srec
  2459. The 'objcopy' does not understand the information in the U-Boot
  2460. image header, so the resulting S-Record file will be relative to
  2461. address 0x00000000. To load it to a given address, you need to
  2462. specify the target address as 'offset' parameter with the 'loads'
  2463. command.
  2464. Example: install the image to address 0x40100000 (which on the
  2465. TQM8xxL is in the first Flash bank):
  2466. => erase 40100000 401FFFFF
  2467. .......... done
  2468. Erased 8 sectors
  2469. => loads 40100000
  2470. ## Ready for S-Record download ...
  2471. ~>examples/image.srec
  2472. 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
  2473. ...
  2474. 15989 15990 15991 15992
  2475. [file transfer complete]
  2476. [connected]
  2477. ## Start Addr = 0x00000000
  2478. You can check the success of the download using the 'iminfo' command;
  2479. this includes a checksum verification so you can be sure no data
  2480. corruption happened:
  2481. => imi 40100000
  2482. ## Checking Image at 40100000 ...
  2483. Image Name: 2.2.13 for initrd on TQM850L
  2484. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2485. Data Size: 335725 Bytes = 327 kB = 0 MB
  2486. Load Address: 00000000
  2487. Entry Point: 0000000c
  2488. Verifying Checksum ... OK
  2489. Boot Linux:
  2490. -----------
  2491. The "bootm" command is used to boot an application that is stored in
  2492. memory (RAM or Flash). In case of a Linux kernel image, the contents
  2493. of the "bootargs" environment variable is passed to the kernel as
  2494. parameters. You can check and modify this variable using the
  2495. "printenv" and "setenv" commands:
  2496. => printenv bootargs
  2497. bootargs=root=/dev/ram
  2498. => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  2499. => printenv bootargs
  2500. bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  2501. => bootm 40020000
  2502. ## Booting Linux kernel at 40020000 ...
  2503. Image Name: 2.2.13 for NFS on TQM850L
  2504. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2505. Data Size: 381681 Bytes = 372 kB = 0 MB
  2506. Load Address: 00000000
  2507. Entry Point: 0000000c
  2508. Verifying Checksum ... OK
  2509. Uncompressing Kernel Image ... OK
  2510. 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
  2511. Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  2512. time_init: decrementer frequency = 187500000/60
  2513. Calibrating delay loop... 49.77 BogoMIPS
  2514. Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
  2515. ...
  2516. If you want to boot a Linux kernel with initial ram disk, you pass
  2517. the memory addresses of both the kernel and the initrd image (PPBCOOT
  2518. format!) to the "bootm" command:
  2519. => imi 40100000 40200000
  2520. ## Checking Image at 40100000 ...
  2521. Image Name: 2.2.13 for initrd on TQM850L
  2522. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2523. Data Size: 335725 Bytes = 327 kB = 0 MB
  2524. Load Address: 00000000
  2525. Entry Point: 0000000c
  2526. Verifying Checksum ... OK
  2527. ## Checking Image at 40200000 ...
  2528. Image Name: Simple Ramdisk Image
  2529. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  2530. Data Size: 566530 Bytes = 553 kB = 0 MB
  2531. Load Address: 00000000
  2532. Entry Point: 00000000
  2533. Verifying Checksum ... OK
  2534. => bootm 40100000 40200000
  2535. ## Booting Linux kernel at 40100000 ...
  2536. Image Name: 2.2.13 for initrd on TQM850L
  2537. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2538. Data Size: 335725 Bytes = 327 kB = 0 MB
  2539. Load Address: 00000000
  2540. Entry Point: 0000000c
  2541. Verifying Checksum ... OK
  2542. Uncompressing Kernel Image ... OK
  2543. ## Loading RAMDisk Image at 40200000 ...
  2544. Image Name: Simple Ramdisk Image
  2545. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  2546. Data Size: 566530 Bytes = 553 kB = 0 MB
  2547. Load Address: 00000000
  2548. Entry Point: 00000000
  2549. Verifying Checksum ... OK
  2550. Loading Ramdisk ... OK
  2551. 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
  2552. Boot arguments: root=/dev/ram
  2553. time_init: decrementer frequency = 187500000/60
  2554. Calibrating delay loop... 49.77 BogoMIPS
  2555. ...
  2556. RAMDISK: Compressed image found at block 0
  2557. VFS: Mounted root (ext2 filesystem).
  2558. bash#
  2559. Boot Linux and pass a flat device tree:
  2560. -----------
  2561. First, U-Boot must be compiled with the appropriate defines. See the section
  2562. titled "Linux Kernel Interface" above for a more in depth explanation. The
  2563. following is an example of how to start a kernel and pass an updated
  2564. flat device tree:
  2565. => print oftaddr
  2566. oftaddr=0x300000
  2567. => print oft
  2568. oft=oftrees/mpc8540ads.dtb
  2569. => tftp $oftaddr $oft
  2570. Speed: 1000, full duplex
  2571. Using TSEC0 device
  2572. TFTP from server 192.168.1.1; our IP address is 192.168.1.101
  2573. Filename 'oftrees/mpc8540ads.dtb'.
  2574. Load address: 0x300000
  2575. Loading: #
  2576. done
  2577. Bytes transferred = 4106 (100a hex)
  2578. => tftp $loadaddr $bootfile
  2579. Speed: 1000, full duplex
  2580. Using TSEC0 device
  2581. TFTP from server 192.168.1.1; our IP address is 192.168.1.2
  2582. Filename 'uImage'.
  2583. Load address: 0x200000
  2584. Loading:############
  2585. done
  2586. Bytes transferred = 1029407 (fb51f hex)
  2587. => print loadaddr
  2588. loadaddr=200000
  2589. => print oftaddr
  2590. oftaddr=0x300000
  2591. => bootm $loadaddr - $oftaddr
  2592. ## Booting image at 00200000 ...
  2593. Image Name: Linux-2.6.17-dirty
  2594. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  2595. Data Size: 1029343 Bytes = 1005.2 kB
  2596. Load Address: 00000000
  2597. Entry Point: 00000000
  2598. Verifying Checksum ... OK
  2599. Uncompressing Kernel Image ... OK
  2600. Booting using flat device tree at 0x300000
  2601. Using MPC85xx ADS machine description
  2602. Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
  2603. [snip]
  2604. More About U-Boot Image Types:
  2605. ------------------------------
  2606. U-Boot supports the following image types:
  2607. "Standalone Programs" are directly runnable in the environment
  2608. provided by U-Boot; it is expected that (if they behave
  2609. well) you can continue to work in U-Boot after return from
  2610. the Standalone Program.
  2611. "OS Kernel Images" are usually images of some Embedded OS which
  2612. will take over control completely. Usually these programs
  2613. will install their own set of exception handlers, device
  2614. drivers, set up the MMU, etc. - this means, that you cannot
  2615. expect to re-enter U-Boot except by resetting the CPU.
  2616. "RAMDisk Images" are more or less just data blocks, and their
  2617. parameters (address, size) are passed to an OS kernel that is
  2618. being started.
  2619. "Multi-File Images" contain several images, typically an OS
  2620. (Linux) kernel image and one or more data images like
  2621. RAMDisks. This construct is useful for instance when you want
  2622. to boot over the network using BOOTP etc., where the boot
  2623. server provides just a single image file, but you want to get
  2624. for instance an OS kernel and a RAMDisk image.
  2625. "Multi-File Images" start with a list of image sizes, each
  2626. image size (in bytes) specified by an "uint32_t" in network
  2627. byte order. This list is terminated by an "(uint32_t)0".
  2628. Immediately after the terminating 0 follow the images, one by
  2629. one, all aligned on "uint32_t" boundaries (size rounded up to
  2630. a multiple of 4 bytes).
  2631. "Firmware Images" are binary images containing firmware (like
  2632. U-Boot or FPGA images) which usually will be programmed to
  2633. flash memory.
  2634. "Script files" are command sequences that will be executed by
  2635. U-Boot's command interpreter; this feature is especially
  2636. useful when you configure U-Boot to use a real shell (hush)
  2637. as command interpreter.
  2638. Standalone HOWTO:
  2639. =================
  2640. One of the features of U-Boot is that you can dynamically load and
  2641. run "standalone" applications, which can use some resources of
  2642. U-Boot like console I/O functions or interrupt services.
  2643. Two simple examples are included with the sources:
  2644. "Hello World" Demo:
  2645. -------------------
  2646. 'examples/hello_world.c' contains a small "Hello World" Demo
  2647. application; it is automatically compiled when you build U-Boot.
  2648. It's configured to run at address 0x00040004, so you can play with it
  2649. like that:
  2650. => loads
  2651. ## Ready for S-Record download ...
  2652. ~>examples/hello_world.srec
  2653. 1 2 3 4 5 6 7 8 9 10 11 ...
  2654. [file transfer complete]
  2655. [connected]
  2656. ## Start Addr = 0x00040004
  2657. => go 40004 Hello World! This is a test.
  2658. ## Starting application at 0x00040004 ...
  2659. Hello World
  2660. argc = 7
  2661. argv[0] = "40004"
  2662. argv[1] = "Hello"
  2663. argv[2] = "World!"
  2664. argv[3] = "This"
  2665. argv[4] = "is"
  2666. argv[5] = "a"
  2667. argv[6] = "test."
  2668. argv[7] = "<NULL>"
  2669. Hit any key to exit ...
  2670. ## Application terminated, rc = 0x0
  2671. Another example, which demonstrates how to register a CPM interrupt
  2672. handler with the U-Boot code, can be found in 'examples/timer.c'.
  2673. Here, a CPM timer is set up to generate an interrupt every second.
  2674. The interrupt service routine is trivial, just printing a '.'
  2675. character, but this is just a demo program. The application can be
  2676. controlled by the following keys:
  2677. ? - print current values og the CPM Timer registers
  2678. b - enable interrupts and start timer
  2679. e - stop timer and disable interrupts
  2680. q - quit application
  2681. => loads
  2682. ## Ready for S-Record download ...
  2683. ~>examples/timer.srec
  2684. 1 2 3 4 5 6 7 8 9 10 11 ...
  2685. [file transfer complete]
  2686. [connected]
  2687. ## Start Addr = 0x00040004
  2688. => go 40004
  2689. ## Starting application at 0x00040004 ...
  2690. TIMERS=0xfff00980
  2691. Using timer 1
  2692. tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
  2693. Hit 'b':
  2694. [q, b, e, ?] Set interval 1000000 us
  2695. Enabling timer
  2696. Hit '?':
  2697. [q, b, e, ?] ........
  2698. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
  2699. Hit '?':
  2700. [q, b, e, ?] .
  2701. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
  2702. Hit '?':
  2703. [q, b, e, ?] .
  2704. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
  2705. Hit '?':
  2706. [q, b, e, ?] .
  2707. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
  2708. Hit 'e':
  2709. [q, b, e, ?] ...Stopping timer
  2710. Hit 'q':
  2711. [q, b, e, ?] ## Application terminated, rc = 0x0
  2712. Minicom warning:
  2713. ================
  2714. Over time, many people have reported problems when trying to use the
  2715. "minicom" terminal emulation program for serial download. I (wd)
  2716. consider minicom to be broken, and recommend not to use it. Under
  2717. Unix, I recommend to use C-Kermit for general purpose use (and
  2718. especially for kermit binary protocol download ("loadb" command), and
  2719. use "cu" for S-Record download ("loads" command).
  2720. Nevertheless, if you absolutely want to use it try adding this
  2721. configuration to your "File transfer protocols" section:
  2722. Name Program Name U/D FullScr IO-Red. Multi
  2723. X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
  2724. Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
  2725. NetBSD Notes:
  2726. =============
  2727. Starting at version 0.9.2, U-Boot supports NetBSD both as host
  2728. (build U-Boot) and target system (boots NetBSD/mpc8xx).
  2729. Building requires a cross environment; it is known to work on
  2730. NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
  2731. need gmake since the Makefiles are not compatible with BSD make).
  2732. Note that the cross-powerpc package does not install include files;
  2733. attempting to build U-Boot will fail because <machine/ansi.h> is
  2734. missing. This file has to be installed and patched manually:
  2735. # cd /usr/pkg/cross/powerpc-netbsd/include
  2736. # mkdir powerpc
  2737. # ln -s powerpc machine
  2738. # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
  2739. # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
  2740. Native builds *don't* work due to incompatibilities between native
  2741. and U-Boot include files.
  2742. Booting assumes that (the first part of) the image booted is a
  2743. stage-2 loader which in turn loads and then invokes the kernel
  2744. proper. Loader sources will eventually appear in the NetBSD source
  2745. tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
  2746. meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
  2747. Implementation Internals:
  2748. =========================
  2749. The following is not intended to be a complete description of every
  2750. implementation detail. However, it should help to understand the
  2751. inner workings of U-Boot and make it easier to port it to custom
  2752. hardware.
  2753. Initial Stack, Global Data:
  2754. ---------------------------
  2755. The implementation of U-Boot is complicated by the fact that U-Boot
  2756. starts running out of ROM (flash memory), usually without access to
  2757. system RAM (because the memory controller is not initialized yet).
  2758. This means that we don't have writable Data or BSS segments, and BSS
  2759. is not initialized as zero. To be able to get a C environment working
  2760. at all, we have to allocate at least a minimal stack. Implementation
  2761. options for this are defined and restricted by the CPU used: Some CPU
  2762. models provide on-chip memory (like the IMMR area on MPC8xx and
  2763. MPC826x processors), on others (parts of) the data cache can be
  2764. locked as (mis-) used as memory, etc.
  2765. Chris Hallinan posted a good summary of these issues to the
  2766. u-boot-users mailing list:
  2767. Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
  2768. From: "Chris Hallinan" <clh@net1plus.com>
  2769. Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
  2770. ...
  2771. Correct me if I'm wrong, folks, but the way I understand it
  2772. is this: Using DCACHE as initial RAM for Stack, etc, does not
  2773. require any physical RAM backing up the cache. The cleverness
  2774. is that the cache is being used as a temporary supply of
  2775. necessary storage before the SDRAM controller is setup. It's
  2776. beyond the scope of this list to expain the details, but you
  2777. can see how this works by studying the cache architecture and
  2778. operation in the architecture and processor-specific manuals.
  2779. OCM is On Chip Memory, which I believe the 405GP has 4K. It
  2780. is another option for the system designer to use as an
  2781. initial stack/ram area prior to SDRAM being available. Either
  2782. option should work for you. Using CS 4 should be fine if your
  2783. board designers haven't used it for something that would
  2784. cause you grief during the initial boot! It is frequently not
  2785. used.
  2786. CFG_INIT_RAM_ADDR should be somewhere that won't interfere
  2787. with your processor/board/system design. The default value
  2788. you will find in any recent u-boot distribution in
  2789. walnut.h should work for you. I'd set it to a value larger
  2790. than your SDRAM module. If you have a 64MB SDRAM module, set
  2791. it above 400_0000. Just make sure your board has no resources
  2792. that are supposed to respond to that address! That code in
  2793. start.S has been around a while and should work as is when
  2794. you get the config right.
  2795. -Chris Hallinan
  2796. DS4.COM, Inc.
  2797. It is essential to remember this, since it has some impact on the C
  2798. code for the initialization procedures:
  2799. * Initialized global data (data segment) is read-only. Do not attempt
  2800. to write it.
  2801. * Do not use any unitialized global data (or implicitely initialized
  2802. as zero data - BSS segment) at all - this is undefined, initiali-
  2803. zation is performed later (when relocating to RAM).
  2804. * Stack space is very limited. Avoid big data buffers or things like
  2805. that.
  2806. Having only the stack as writable memory limits means we cannot use
  2807. normal global data to share information beween the code. But it
  2808. turned out that the implementation of U-Boot can be greatly
  2809. simplified by making a global data structure (gd_t) available to all
  2810. functions. We could pass a pointer to this data as argument to _all_
  2811. functions, but this would bloat the code. Instead we use a feature of
  2812. the GCC compiler (Global Register Variables) to share the data: we
  2813. place a pointer (gd) to the global data into a register which we
  2814. reserve for this purpose.
  2815. When choosing a register for such a purpose we are restricted by the
  2816. relevant (E)ABI specifications for the current architecture, and by
  2817. GCC's implementation.
  2818. For PowerPC, the following registers have specific use:
  2819. R1: stack pointer
  2820. R2: reserved for system use
  2821. R3-R4: parameter passing and return values
  2822. R5-R10: parameter passing
  2823. R13: small data area pointer
  2824. R30: GOT pointer
  2825. R31: frame pointer
  2826. (U-Boot also uses R14 as internal GOT pointer.)
  2827. ==> U-Boot will use R2 to hold a pointer to the global data
  2828. Note: on PPC, we could use a static initializer (since the
  2829. address of the global data structure is known at compile time),
  2830. but it turned out that reserving a register results in somewhat
  2831. smaller code - although the code savings are not that big (on
  2832. average for all boards 752 bytes for the whole U-Boot image,
  2833. 624 text + 127 data).
  2834. On Blackfin, the normal C ABI (except for P5) is followed as documented here:
  2835. http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
  2836. ==> U-Boot will use P5 to hold a pointer to the global data
  2837. On ARM, the following registers are used:
  2838. R0: function argument word/integer result
  2839. R1-R3: function argument word
  2840. R9: GOT pointer
  2841. R10: stack limit (used only if stack checking if enabled)
  2842. R11: argument (frame) pointer
  2843. R12: temporary workspace
  2844. R13: stack pointer
  2845. R14: link register
  2846. R15: program counter
  2847. ==> U-Boot will use R8 to hold a pointer to the global data
  2848. NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
  2849. or current versions of GCC may "optimize" the code too much.
  2850. Memory Management:
  2851. ------------------
  2852. U-Boot runs in system state and uses physical addresses, i.e. the
  2853. MMU is not used either for address mapping nor for memory protection.
  2854. The available memory is mapped to fixed addresses using the memory
  2855. controller. In this process, a contiguous block is formed for each
  2856. memory type (Flash, SDRAM, SRAM), even when it consists of several
  2857. physical memory banks.
  2858. U-Boot is installed in the first 128 kB of the first Flash bank (on
  2859. TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
  2860. booting and sizing and initializing DRAM, the code relocates itself
  2861. to the upper end of DRAM. Immediately below the U-Boot code some
  2862. memory is reserved for use by malloc() [see CFG_MALLOC_LEN
  2863. configuration setting]. Below that, a structure with global Board
  2864. Info data is placed, followed by the stack (growing downward).
  2865. Additionally, some exception handler code is copied to the low 8 kB
  2866. of DRAM (0x00000000 ... 0x00001FFF).
  2867. So a typical memory configuration with 16 MB of DRAM could look like
  2868. this:
  2869. 0x0000 0000 Exception Vector code
  2870. :
  2871. 0x0000 1FFF
  2872. 0x0000 2000 Free for Application Use
  2873. :
  2874. :
  2875. :
  2876. :
  2877. 0x00FB FF20 Monitor Stack (Growing downward)
  2878. 0x00FB FFAC Board Info Data and permanent copy of global data
  2879. 0x00FC 0000 Malloc Arena
  2880. :
  2881. 0x00FD FFFF
  2882. 0x00FE 0000 RAM Copy of Monitor Code
  2883. ... eventually: LCD or video framebuffer
  2884. ... eventually: pRAM (Protected RAM - unchanged by reset)
  2885. 0x00FF FFFF [End of RAM]
  2886. System Initialization:
  2887. ----------------------
  2888. In the reset configuration, U-Boot starts at the reset entry point
  2889. (on most PowerPC systens at address 0x00000100). Because of the reset
  2890. configuration for CS0# this is a mirror of the onboard Flash memory.
  2891. To be able to re-map memory U-Boot then jumps to its link address.
  2892. To be able to implement the initialization code in C, a (small!)
  2893. initial stack is set up in the internal Dual Ported RAM (in case CPUs
  2894. which provide such a feature like MPC8xx or MPC8260), or in a locked
  2895. part of the data cache. After that, U-Boot initializes the CPU core,
  2896. the caches and the SIU.
  2897. Next, all (potentially) available memory banks are mapped using a
  2898. preliminary mapping. For example, we put them on 512 MB boundaries
  2899. (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
  2900. on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
  2901. programmed for SDRAM access. Using the temporary configuration, a
  2902. simple memory test is run that determines the size of the SDRAM
  2903. banks.
  2904. When there is more than one SDRAM bank, and the banks are of
  2905. different size, the largest is mapped first. For equal size, the first
  2906. bank (CS2#) is mapped first. The first mapping is always for address
  2907. 0x00000000, with any additional banks following immediately to create
  2908. contiguous memory starting from 0.
  2909. Then, the monitor installs itself at the upper end of the SDRAM area
  2910. and allocates memory for use by malloc() and for the global Board
  2911. Info data; also, the exception vector code is copied to the low RAM
  2912. pages, and the final stack is set up.
  2913. Only after this relocation will you have a "normal" C environment;
  2914. until that you are restricted in several ways, mostly because you are
  2915. running from ROM, and because the code will have to be relocated to a
  2916. new address in RAM.
  2917. U-Boot Porting Guide:
  2918. ----------------------
  2919. [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
  2920. list, October 2002]
  2921. int main (int argc, char *argv[])
  2922. {
  2923. sighandler_t no_more_time;
  2924. signal (SIGALRM, no_more_time);
  2925. alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
  2926. if (available_money > available_manpower) {
  2927. pay consultant to port U-Boot;
  2928. return 0;
  2929. }
  2930. Download latest U-Boot source;
  2931. Subscribe to u-boot-users mailing list;
  2932. if (clueless) {
  2933. email ("Hi, I am new to U-Boot, how do I get started?");
  2934. }
  2935. while (learning) {
  2936. Read the README file in the top level directory;
  2937. Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
  2938. Read the source, Luke;
  2939. }
  2940. if (available_money > toLocalCurrency ($2500)) {
  2941. Buy a BDI2000;
  2942. } else {
  2943. Add a lot of aggravation and time;
  2944. }
  2945. Create your own board support subdirectory;
  2946. Create your own board config file;
  2947. while (!running) {
  2948. do {
  2949. Add / modify source code;
  2950. } until (compiles);
  2951. Debug;
  2952. if (clueless)
  2953. email ("Hi, I am having problems...");
  2954. }
  2955. Send patch file to Wolfgang;
  2956. return 0;
  2957. }
  2958. void no_more_time (int sig)
  2959. {
  2960. hire_a_guru();
  2961. }
  2962. Coding Standards:
  2963. -----------------
  2964. All contributions to U-Boot should conform to the Linux kernel
  2965. coding style; see the file "Documentation/CodingStyle" and the script
  2966. "scripts/Lindent" in your Linux kernel source directory. In sources
  2967. originating from U-Boot a style corresponding to "Lindent -pcs" (adding
  2968. spaces before parameters to function calls) is actually used.
  2969. Source files originating from a different project (for example the
  2970. MTD subsystem) are generally exempt from these guidelines and are not
  2971. reformated to ease subsequent migration to newer versions of those
  2972. sources.
  2973. Please note that U-Boot is implemented in C (and to some small parts in
  2974. Assembler); no C++ is used, so please do not use C++ style comments (//)
  2975. in your code.
  2976. Please also stick to the following formatting rules:
  2977. - remove any trailing white space
  2978. - use TAB characters for indentation, not spaces
  2979. - make sure NOT to use DOS '\r\n' line feeds
  2980. - do not add more than 2 empty lines to source files
  2981. - do not add trailing empty lines to source files
  2982. Submissions which do not conform to the standards may be returned
  2983. with a request to reformat the changes.
  2984. Submitting Patches:
  2985. -------------------
  2986. Since the number of patches for U-Boot is growing, we need to
  2987. establish some rules. Submissions which do not conform to these rules
  2988. may be rejected, even when they contain important and valuable stuff.
  2989. Patches shall be sent to the u-boot-users mailing list.
  2990. Please see http://www.denx.de/wiki/UBoot/Patches for details.
  2991. When you send a patch, please include the following information with
  2992. it:
  2993. * For bug fixes: a description of the bug and how your patch fixes
  2994. this bug. Please try to include a way of demonstrating that the
  2995. patch actually fixes something.
  2996. * For new features: a description of the feature and your
  2997. implementation.
  2998. * A CHANGELOG entry as plaintext (separate from the patch)
  2999. * For major contributions, your entry to the CREDITS file
  3000. * When you add support for a new board, don't forget to add this
  3001. board to the MAKEALL script, too.
  3002. * If your patch adds new configuration options, don't forget to
  3003. document these in the README file.
  3004. * The patch itself. If you are using git (which is *strongly*
  3005. recommended) you can easily generate the patch using the
  3006. "git-format-patch". If you then use "git-send-email" to send it to
  3007. the U-Boot mailing list, you will avoid most of the common problems
  3008. with some other mail clients.
  3009. If you cannot use git, use "diff -purN OLD NEW". If your version of
  3010. diff does not support these options, then get the latest version of
  3011. GNU diff.
  3012. The current directory when running this command shall be the parent
  3013. directory of the U-Boot source tree (i. e. please make sure that
  3014. your patch includes sufficient directory information for the
  3015. affected files).
  3016. We prefer patches as plain text. MIME attachments are discouraged,
  3017. and compressed attachments must not be used.
  3018. * If one logical set of modifications affects or creates several
  3019. files, all these changes shall be submitted in a SINGLE patch file.
  3020. * Changesets that contain different, unrelated modifications shall be
  3021. submitted as SEPARATE patches, one patch per changeset.
  3022. Notes:
  3023. * Before sending the patch, run the MAKEALL script on your patched
  3024. source tree and make sure that no errors or warnings are reported
  3025. for any of the boards.
  3026. * Keep your modifications to the necessary minimum: A patch
  3027. containing several unrelated changes or arbitrary reformats will be
  3028. returned with a request to re-formatting / split it.
  3029. * If you modify existing code, make sure that your new code does not
  3030. add to the memory footprint of the code ;-) Small is beautiful!
  3031. When adding new features, these should compile conditionally only
  3032. (using #ifdef), and the resulting code with the new feature
  3033. disabled must not need more memory than the old code without your
  3034. modification.
  3035. * Remember that there is a size limit of 40 kB per message on the
  3036. u-boot-users mailing list. Bigger patches will be moderated. If
  3037. they are reasonable and not bigger than 100 kB, they will be
  3038. acknowledged. Even bigger patches should be avoided.