README 142 KB

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