README 180 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289
  1. #
  2. # (C) Copyright 2000 - 2012
  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. Note: There is no CHANGELOG file in the actual U-Boot source tree;
  49. it can be created dynamically from the Git log using:
  50. make CHANGELOG
  51. Where to get help:
  52. ==================
  53. In case you have questions about, problems with or contributions for
  54. U-Boot you should send a message to the U-Boot mailing list at
  55. <u-boot@lists.denx.de>. There is also an archive of previous traffic
  56. on the mailing list - please search the archive before asking FAQ's.
  57. Please see http://lists.denx.de/pipermail/u-boot and
  58. http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
  59. Where to get source code:
  60. =========================
  61. The U-Boot source code is maintained in the git repository at
  62. git://www.denx.de/git/u-boot.git ; you can browse it online at
  63. http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
  64. The "snapshot" links on this page allow you to download tarballs of
  65. any version you might be interested in. Official releases are also
  66. available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
  67. directory.
  68. Pre-built (and tested) images are available from
  69. ftp://ftp.denx.de/pub/u-boot/images/
  70. Where we come from:
  71. ===================
  72. - start from 8xxrom sources
  73. - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
  74. - clean up code
  75. - make it easier to add custom boards
  76. - make it possible to add other [PowerPC] CPUs
  77. - extend functions, especially:
  78. * Provide extended interface to Linux boot loader
  79. * S-Record download
  80. * network boot
  81. * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
  82. - create ARMBoot project (http://sourceforge.net/projects/armboot)
  83. - add other CPU families (starting with ARM)
  84. - create U-Boot project (http://sourceforge.net/projects/u-boot)
  85. - current project page: see http://www.denx.de/wiki/U-Boot
  86. Names and Spelling:
  87. ===================
  88. The "official" name of this project is "Das U-Boot". The spelling
  89. "U-Boot" shall be used in all written text (documentation, comments
  90. in source files etc.). Example:
  91. This is the README file for the U-Boot project.
  92. File names etc. shall be based on the string "u-boot". Examples:
  93. include/asm-ppc/u-boot.h
  94. #include <asm/u-boot.h>
  95. Variable names, preprocessor constants etc. shall be either based on
  96. the string "u_boot" or on "U_BOOT". Example:
  97. U_BOOT_VERSION u_boot_logo
  98. IH_OS_U_BOOT u_boot_hush_start
  99. Versioning:
  100. ===========
  101. Starting with the release in October 2008, the names of the releases
  102. were changed from numerical release numbers without deeper meaning
  103. into a time stamp based numbering. Regular releases are identified by
  104. names consisting of the calendar year and month of the release date.
  105. Additional fields (if present) indicate release candidates or bug fix
  106. releases in "stable" maintenance trees.
  107. Examples:
  108. U-Boot v2009.11 - Release November 2009
  109. U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
  110. U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
  111. Directory Hierarchy:
  112. ====================
  113. /arch Architecture specific files
  114. /arm Files generic to ARM architecture
  115. /cpu CPU specific files
  116. /arm720t Files specific to ARM 720 CPUs
  117. /arm920t Files specific to ARM 920 CPUs
  118. /at91 Files specific to Atmel AT91RM9200 CPU
  119. /imx Files specific to Freescale MC9328 i.MX CPUs
  120. /s3c24x0 Files specific to Samsung S3C24X0 CPUs
  121. /arm925t Files specific to ARM 925 CPUs
  122. /arm926ejs Files specific to ARM 926 CPUs
  123. /arm1136 Files specific to ARM 1136 CPUs
  124. /ixp Files specific to Intel XScale IXP CPUs
  125. /pxa Files specific to Intel XScale PXA CPUs
  126. /s3c44b0 Files specific to Samsung S3C44B0 CPUs
  127. /sa1100 Files specific to Intel StrongARM SA1100 CPUs
  128. /lib Architecture specific library files
  129. /avr32 Files generic to AVR32 architecture
  130. /cpu CPU specific files
  131. /lib Architecture specific library files
  132. /blackfin Files generic to Analog Devices Blackfin architecture
  133. /cpu CPU specific files
  134. /lib Architecture specific library files
  135. /x86 Files generic to x86 architecture
  136. /cpu CPU specific files
  137. /lib Architecture specific library files
  138. /m68k Files generic to m68k architecture
  139. /cpu CPU specific files
  140. /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
  141. /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
  142. /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
  143. /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
  144. /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
  145. /lib Architecture specific library files
  146. /microblaze Files generic to microblaze architecture
  147. /cpu CPU specific files
  148. /lib Architecture specific library files
  149. /mips Files generic to MIPS architecture
  150. /cpu CPU specific files
  151. /mips32 Files specific to MIPS32 CPUs
  152. /xburst Files specific to Ingenic XBurst CPUs
  153. /lib Architecture specific library files
  154. /nds32 Files generic to NDS32 architecture
  155. /cpu CPU specific files
  156. /n1213 Files specific to Andes Technology N1213 CPUs
  157. /lib Architecture specific library files
  158. /nios2 Files generic to Altera NIOS2 architecture
  159. /cpu CPU specific files
  160. /lib Architecture specific library files
  161. /powerpc Files generic to PowerPC architecture
  162. /cpu CPU specific files
  163. /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
  164. /mpc5xx Files specific to Freescale MPC5xx CPUs
  165. /mpc5xxx Files specific to Freescale MPC5xxx CPUs
  166. /mpc8xx Files specific to Freescale MPC8xx CPUs
  167. /mpc8220 Files specific to Freescale MPC8220 CPUs
  168. /mpc824x Files specific to Freescale MPC824x CPUs
  169. /mpc8260 Files specific to Freescale MPC8260 CPUs
  170. /mpc85xx Files specific to Freescale MPC85xx CPUs
  171. /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
  172. /lib Architecture specific library files
  173. /sh Files generic to SH architecture
  174. /cpu CPU specific files
  175. /sh2 Files specific to sh2 CPUs
  176. /sh3 Files specific to sh3 CPUs
  177. /sh4 Files specific to sh4 CPUs
  178. /lib Architecture specific library files
  179. /sparc Files generic to SPARC architecture
  180. /cpu CPU specific files
  181. /leon2 Files specific to Gaisler LEON2 SPARC CPU
  182. /leon3 Files specific to Gaisler LEON3 SPARC CPU
  183. /lib Architecture specific library files
  184. /api Machine/arch independent API for external apps
  185. /board Board dependent files
  186. /common Misc architecture independent functions
  187. /disk Code for disk drive partition handling
  188. /doc Documentation (don't expect too much)
  189. /drivers Commonly used device drivers
  190. /examples Example code for standalone applications, etc.
  191. /fs Filesystem code (cramfs, ext2, jffs2, etc.)
  192. /include Header Files
  193. /lib Files generic to all architectures
  194. /libfdt Library files to support flattened device trees
  195. /lzma Library files to support LZMA decompression
  196. /lzo Library files to support LZO decompression
  197. /net Networking code
  198. /post Power On Self Test
  199. /rtc Real Time Clock drivers
  200. /tools Tools to build S-Record or U-Boot images, etc.
  201. Software Configuration:
  202. =======================
  203. Configuration is usually done using C preprocessor defines; the
  204. rationale behind that is to avoid dead code whenever possible.
  205. There are two classes of configuration variables:
  206. * Configuration _OPTIONS_:
  207. These are selectable by the user and have names beginning with
  208. "CONFIG_".
  209. * Configuration _SETTINGS_:
  210. These depend on the hardware etc. and should not be meddled with if
  211. you don't know what you're doing; they have names beginning with
  212. "CONFIG_SYS_".
  213. Later we will add a configuration tool - probably similar to or even
  214. identical to what's used for the Linux kernel. Right now, we have to
  215. do the configuration by hand, which means creating some symbolic
  216. links and editing some configuration files. We use the TQM8xxL boards
  217. as an example here.
  218. Selection of Processor Architecture and Board Type:
  219. ---------------------------------------------------
  220. For all supported boards there are ready-to-use default
  221. configurations available; just type "make <board_name>_config".
  222. Example: For a TQM823L module type:
  223. cd u-boot
  224. make TQM823L_config
  225. For the Cogent platform, you need to specify the CPU type as well;
  226. e.g. "make cogent_mpc8xx_config". And also configure the cogent
  227. directory according to the instructions in cogent/README.
  228. Configuration Options:
  229. ----------------------
  230. Configuration depends on the combination of board and CPU type; all
  231. such information is kept in a configuration file
  232. "include/configs/<board_name>.h".
  233. Example: For a TQM823L module, all configuration settings are in
  234. "include/configs/TQM823L.h".
  235. Many of the options are named exactly as the corresponding Linux
  236. kernel configuration options. The intention is to make it easier to
  237. build a config tool - later.
  238. The following options need to be configured:
  239. - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
  240. - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
  241. - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
  242. Define exactly one, e.g. CONFIG_ATSTK1002
  243. - CPU Module Type: (if CONFIG_COGENT is defined)
  244. Define exactly one of
  245. CONFIG_CMA286_60_OLD
  246. --- FIXME --- not tested yet:
  247. CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
  248. CONFIG_CMA287_23, CONFIG_CMA287_50
  249. - Motherboard Type: (if CONFIG_COGENT is defined)
  250. Define exactly one of
  251. CONFIG_CMA101, CONFIG_CMA102
  252. - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
  253. Define one or more of
  254. CONFIG_CMA302
  255. - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
  256. Define one or more of
  257. CONFIG_LCD_HEARTBEAT - update a character position on
  258. the LCD display every second with
  259. a "rotator" |\-/|\-/
  260. - Board flavour: (if CONFIG_MPC8260ADS is defined)
  261. CONFIG_ADSTYPE
  262. Possible values are:
  263. CONFIG_SYS_8260ADS - original MPC8260ADS
  264. CONFIG_SYS_8266ADS - MPC8266ADS
  265. CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
  266. CONFIG_SYS_8272ADS - MPC8272ADS
  267. - Marvell Family Member
  268. CONFIG_SYS_MVFS - define it if you want to enable
  269. multiple fs option at one time
  270. for marvell soc family
  271. - MPC824X Family Member (if CONFIG_MPC824X is defined)
  272. Define exactly one of
  273. CONFIG_MPC8240, CONFIG_MPC8245
  274. - 8xx CPU Options: (if using an MPC8xx CPU)
  275. CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
  276. get_gclk_freq() cannot work
  277. e.g. if there is no 32KHz
  278. reference PIT/RTC clock
  279. CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
  280. or XTAL/EXTAL)
  281. - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
  282. CONFIG_SYS_8xx_CPUCLK_MIN
  283. CONFIG_SYS_8xx_CPUCLK_MAX
  284. CONFIG_8xx_CPUCLK_DEFAULT
  285. See doc/README.MPC866
  286. CONFIG_SYS_MEASURE_CPUCLK
  287. Define this to measure the actual CPU clock instead
  288. of relying on the correctness of the configured
  289. values. Mostly useful for board bringup to make sure
  290. the PLL is locked at the intended frequency. Note
  291. that this requires a (stable) reference clock (32 kHz
  292. RTC clock or CONFIG_SYS_8XX_XIN)
  293. CONFIG_SYS_DELAYED_ICACHE
  294. Define this option if you want to enable the
  295. ICache only when Code runs from RAM.
  296. - 85xx CPU Options:
  297. CONFIG_SYS_PPC64
  298. Specifies that the core is a 64-bit PowerPC implementation (implements
  299. the "64" category of the Power ISA). This is necessary for ePAPR
  300. compliance, among other possible reasons.
  301. CONFIG_SYS_FSL_TBCLK_DIV
  302. Defines the core time base clock divider ratio compared to the
  303. system clock. On most PQ3 devices this is 8, on newer QorIQ
  304. devices it can be 16 or 32. The ratio varies from SoC to Soc.
  305. CONFIG_SYS_FSL_PCIE_COMPAT
  306. Defines the string to utilize when trying to match PCIe device
  307. tree nodes for the given platform.
  308. CONFIG_SYS_PPC_E500_DEBUG_TLB
  309. Enables a temporary TLB entry to be used during boot to work
  310. around limitations in e500v1 and e500v2 external debugger
  311. support. This reduces the portions of the boot code where
  312. breakpoints and single stepping do not work. The value of this
  313. symbol should be set to the TLB1 entry to be used for this
  314. purpose.
  315. CONFIG_SYS_FSL_ERRATUM_A004510
  316. Enables a workaround for erratum A004510. If set,
  317. then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
  318. CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
  319. CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
  320. CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
  321. Defines one or two SoC revisions (low 8 bits of SVR)
  322. for which the A004510 workaround should be applied.
  323. The rest of SVR is either not relevant to the decision
  324. of whether the erratum is present (e.g. p2040 versus
  325. p2041) or is implied by the build target, which controls
  326. whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
  327. See Freescale App Note 4493 for more information about
  328. this erratum.
  329. CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
  330. This is the value to write into CCSR offset 0x18600
  331. according to the A004510 workaround.
  332. - Generic CPU options:
  333. CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
  334. Defines the endianess of the CPU. Implementation of those
  335. values is arch specific.
  336. - Intel Monahans options:
  337. CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
  338. Defines the Monahans run mode to oscillator
  339. ratio. Valid values are 8, 16, 24, 31. The core
  340. frequency is this value multiplied by 13 MHz.
  341. CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
  342. Defines the Monahans turbo mode to oscillator
  343. ratio. Valid values are 1 (default if undefined) and
  344. 2. The core frequency as calculated above is multiplied
  345. by this value.
  346. - MIPS CPU options:
  347. CONFIG_SYS_INIT_SP_OFFSET
  348. Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
  349. pointer. This is needed for the temporary stack before
  350. relocation.
  351. CONFIG_SYS_MIPS_CACHE_MODE
  352. Cache operation mode for the MIPS CPU.
  353. See also arch/mips/include/asm/mipsregs.h.
  354. Possible values are:
  355. CONF_CM_CACHABLE_NO_WA
  356. CONF_CM_CACHABLE_WA
  357. CONF_CM_UNCACHED
  358. CONF_CM_CACHABLE_NONCOHERENT
  359. CONF_CM_CACHABLE_CE
  360. CONF_CM_CACHABLE_COW
  361. CONF_CM_CACHABLE_CUW
  362. CONF_CM_CACHABLE_ACCELERATED
  363. CONFIG_SYS_XWAY_EBU_BOOTCFG
  364. Special option for Lantiq XWAY SoCs for booting from NOR flash.
  365. See also arch/mips/cpu/mips32/start.S.
  366. CONFIG_XWAY_SWAP_BYTES
  367. Enable compilation of tools/xway-swap-bytes needed for Lantiq
  368. XWAY SoCs for booting from NOR flash. The U-Boot image needs to
  369. be swapped if a flash programmer is used.
  370. - ARM options:
  371. CONFIG_SYS_EXCEPTION_VECTORS_HIGH
  372. Select high exception vectors of the ARM core, e.g., do not
  373. clear the V bit of the c1 register of CP15.
  374. CONFIG_SYS_THUMB_BUILD
  375. Use this flag to build U-Boot using the Thumb instruction
  376. set for ARM architectures. Thumb instruction set provides
  377. better code density. For ARM architectures that support
  378. Thumb2 this flag will result in Thumb2 code generated by
  379. GCC.
  380. - Linux Kernel Interface:
  381. CONFIG_CLOCKS_IN_MHZ
  382. U-Boot stores all clock information in Hz
  383. internally. For binary compatibility with older Linux
  384. kernels (which expect the clocks passed in the
  385. bd_info data to be in MHz) the environment variable
  386. "clocks_in_mhz" can be defined so that U-Boot
  387. converts clock data to MHZ before passing it to the
  388. Linux kernel.
  389. When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
  390. "clocks_in_mhz=1" is automatically included in the
  391. default environment.
  392. CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
  393. When transferring memsize parameter to linux, some versions
  394. expect it to be in bytes, others in MB.
  395. Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
  396. CONFIG_OF_LIBFDT
  397. New kernel versions are expecting firmware settings to be
  398. passed using flattened device trees (based on open firmware
  399. concepts).
  400. CONFIG_OF_LIBFDT
  401. * New libfdt-based support
  402. * Adds the "fdt" command
  403. * The bootm command automatically updates the fdt
  404. OF_CPU - The proper name of the cpus node (only required for
  405. MPC512X and MPC5xxx based boards).
  406. OF_SOC - The proper name of the soc node (only required for
  407. MPC512X and MPC5xxx based boards).
  408. OF_TBCLK - The timebase frequency.
  409. OF_STDOUT_PATH - The path to the console device
  410. boards with QUICC Engines require OF_QE to set UCC MAC
  411. addresses
  412. CONFIG_OF_BOARD_SETUP
  413. Board code has addition modification that it wants to make
  414. to the flat device tree before handing it off to the kernel
  415. CONFIG_OF_BOOT_CPU
  416. This define fills in the correct boot CPU in the boot
  417. param header, the default value is zero if undefined.
  418. CONFIG_OF_IDE_FIXUP
  419. U-Boot can detect if an IDE device is present or not.
  420. If not, and this new config option is activated, U-Boot
  421. removes the ATA node from the DTS before booting Linux,
  422. so the Linux IDE driver does not probe the device and
  423. crash. This is needed for buggy hardware (uc101) where
  424. no pull down resistor is connected to the signal IDE5V_DD7.
  425. CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
  426. This setting is mandatory for all boards that have only one
  427. machine type and must be used to specify the machine type
  428. number as it appears in the ARM machine registry
  429. (see http://www.arm.linux.org.uk/developer/machines/).
  430. Only boards that have multiple machine types supported
  431. in a single configuration file and the machine type is
  432. runtime discoverable, do not have to use this setting.
  433. - vxWorks boot parameters:
  434. bootvx constructs a valid bootline using the following
  435. environments variables: bootfile, ipaddr, serverip, hostname.
  436. It loads the vxWorks image pointed bootfile.
  437. CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
  438. CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
  439. CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
  440. CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
  441. CONFIG_SYS_VXWORKS_ADD_PARAMS
  442. Add it at the end of the bootline. E.g "u=username pw=secret"
  443. Note: If a "bootargs" environment is defined, it will overwride
  444. the defaults discussed just above.
  445. - Cache Configuration:
  446. CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
  447. CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
  448. CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
  449. - Cache Configuration for ARM:
  450. CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
  451. controller
  452. CONFIG_SYS_PL310_BASE - Physical base address of PL310
  453. controller register space
  454. - Serial Ports:
  455. CONFIG_PL010_SERIAL
  456. Define this if you want support for Amba PrimeCell PL010 UARTs.
  457. CONFIG_PL011_SERIAL
  458. Define this if you want support for Amba PrimeCell PL011 UARTs.
  459. CONFIG_PL011_CLOCK
  460. If you have Amba PrimeCell PL011 UARTs, set this variable to
  461. the clock speed of the UARTs.
  462. CONFIG_PL01x_PORTS
  463. If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
  464. define this to a list of base addresses for each (supported)
  465. port. See e.g. include/configs/versatile.h
  466. CONFIG_PL011_SERIAL_RLCR
  467. Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
  468. have separate receive and transmit line control registers. Set
  469. this variable to initialize the extra register.
  470. CONFIG_PL011_SERIAL_FLUSH_ON_INIT
  471. On some platforms (e.g. U8500) U-Boot is loaded by a second stage
  472. boot loader that has already initialized the UART. Define this
  473. variable to flush the UART at init time.
  474. - Console Interface:
  475. Depending on board, define exactly one serial port
  476. (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
  477. CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
  478. console by defining CONFIG_8xx_CONS_NONE
  479. Note: if CONFIG_8xx_CONS_NONE is defined, the serial
  480. port routines must be defined elsewhere
  481. (i.e. serial_init(), serial_getc(), ...)
  482. CONFIG_CFB_CONSOLE
  483. Enables console device for a color framebuffer. Needs following
  484. defines (cf. smiLynxEM, i8042)
  485. VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
  486. (default big endian)
  487. VIDEO_HW_RECTFILL graphic chip supports
  488. rectangle fill
  489. (cf. smiLynxEM)
  490. VIDEO_HW_BITBLT graphic chip supports
  491. bit-blit (cf. smiLynxEM)
  492. VIDEO_VISIBLE_COLS visible pixel columns
  493. (cols=pitch)
  494. VIDEO_VISIBLE_ROWS visible pixel rows
  495. VIDEO_PIXEL_SIZE bytes per pixel
  496. VIDEO_DATA_FORMAT graphic data format
  497. (0-5, cf. cfb_console.c)
  498. VIDEO_FB_ADRS framebuffer address
  499. VIDEO_KBD_INIT_FCT keyboard int fct
  500. (i.e. i8042_kbd_init())
  501. VIDEO_TSTC_FCT test char fct
  502. (i.e. i8042_tstc)
  503. VIDEO_GETC_FCT get char fct
  504. (i.e. i8042_getc)
  505. CONFIG_CONSOLE_CURSOR cursor drawing on/off
  506. (requires blink timer
  507. cf. i8042.c)
  508. CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
  509. CONFIG_CONSOLE_TIME display time/date info in
  510. upper right corner
  511. (requires CONFIG_CMD_DATE)
  512. CONFIG_VIDEO_LOGO display Linux logo in
  513. upper left corner
  514. CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
  515. linux_logo.h for logo.
  516. Requires CONFIG_VIDEO_LOGO
  517. CONFIG_CONSOLE_EXTRA_INFO
  518. additional board info beside
  519. the logo
  520. When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
  521. a limited number of ANSI escape sequences (cursor control,
  522. erase functions and limited graphics rendition control).
  523. When CONFIG_CFB_CONSOLE is defined, video console is
  524. default i/o. Serial console can be forced with
  525. environment 'console=serial'.
  526. When CONFIG_SILENT_CONSOLE is defined, all console
  527. messages (by U-Boot and Linux!) can be silenced with
  528. the "silent" environment variable. See
  529. doc/README.silent for more information.
  530. - Console Baudrate:
  531. CONFIG_BAUDRATE - in bps
  532. Select one of the baudrates listed in
  533. CONFIG_SYS_BAUDRATE_TABLE, see below.
  534. CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
  535. - Console Rx buffer length
  536. With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
  537. the maximum receive buffer length for the SMC.
  538. This option is actual only for 82xx and 8xx possible.
  539. If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
  540. must be defined, to setup the maximum idle timeout for
  541. the SMC.
  542. - Pre-Console Buffer:
  543. Prior to the console being initialised (i.e. serial UART
  544. initialised etc) all console output is silently discarded.
  545. Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
  546. buffer any console messages prior to the console being
  547. initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
  548. bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
  549. a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
  550. bytes are output before the console is initialised, the
  551. earlier bytes are discarded.
  552. 'Sane' compilers will generate smaller code if
  553. CONFIG_PRE_CON_BUF_SZ is a power of 2
  554. - Safe printf() functions
  555. Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
  556. the printf() functions. These are defined in
  557. include/vsprintf.h and include snprintf(), vsnprintf() and
  558. so on. Code size increase is approximately 300-500 bytes.
  559. If this option is not given then these functions will
  560. silently discard their buffer size argument - this means
  561. you are not getting any overflow checking in this case.
  562. - Boot Delay: CONFIG_BOOTDELAY - in seconds
  563. Delay before automatically booting the default image;
  564. set to -1 to disable autoboot.
  565. set to -2 to autoboot with no delay and not check for abort
  566. (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
  567. See doc/README.autoboot for these options that
  568. work with CONFIG_BOOTDELAY. None are required.
  569. CONFIG_BOOT_RETRY_TIME
  570. CONFIG_BOOT_RETRY_MIN
  571. CONFIG_AUTOBOOT_KEYED
  572. CONFIG_AUTOBOOT_PROMPT
  573. CONFIG_AUTOBOOT_DELAY_STR
  574. CONFIG_AUTOBOOT_STOP_STR
  575. CONFIG_AUTOBOOT_DELAY_STR2
  576. CONFIG_AUTOBOOT_STOP_STR2
  577. CONFIG_ZERO_BOOTDELAY_CHECK
  578. CONFIG_RESET_TO_RETRY
  579. - Autoboot Command:
  580. CONFIG_BOOTCOMMAND
  581. Only needed when CONFIG_BOOTDELAY is enabled;
  582. define a command string that is automatically executed
  583. when no character is read on the console interface
  584. within "Boot Delay" after reset.
  585. CONFIG_BOOTARGS
  586. This can be used to pass arguments to the bootm
  587. command. The value of CONFIG_BOOTARGS goes into the
  588. environment value "bootargs".
  589. CONFIG_RAMBOOT and CONFIG_NFSBOOT
  590. The value of these goes into the environment as
  591. "ramboot" and "nfsboot" respectively, and can be used
  592. as a convenience, when switching between booting from
  593. RAM and NFS.
  594. - Pre-Boot Commands:
  595. CONFIG_PREBOOT
  596. When this option is #defined, the existence of the
  597. environment variable "preboot" will be checked
  598. immediately before starting the CONFIG_BOOTDELAY
  599. countdown and/or running the auto-boot command resp.
  600. entering interactive mode.
  601. This feature is especially useful when "preboot" is
  602. automatically generated or modified. For an example
  603. see the LWMON board specific code: here "preboot" is
  604. modified when the user holds down a certain
  605. combination of keys on the (special) keyboard when
  606. booting the systems
  607. - Serial Download Echo Mode:
  608. CONFIG_LOADS_ECHO
  609. If defined to 1, all characters received during a
  610. serial download (using the "loads" command) are
  611. echoed back. This might be needed by some terminal
  612. emulations (like "cu"), but may as well just take
  613. time on others. This setting #define's the initial
  614. value of the "loads_echo" environment variable.
  615. - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
  616. CONFIG_KGDB_BAUDRATE
  617. Select one of the baudrates listed in
  618. CONFIG_SYS_BAUDRATE_TABLE, see below.
  619. - Monitor Functions:
  620. Monitor commands can be included or excluded
  621. from the build by using the #include files
  622. <config_cmd_all.h> and #undef'ing unwanted
  623. commands, or using <config_cmd_default.h>
  624. and augmenting with additional #define's
  625. for wanted commands.
  626. The default command configuration includes all commands
  627. except those marked below with a "*".
  628. CONFIG_CMD_ASKENV * ask for env variable
  629. CONFIG_CMD_BDI bdinfo
  630. CONFIG_CMD_BEDBUG * Include BedBug Debugger
  631. CONFIG_CMD_BMP * BMP support
  632. CONFIG_CMD_BSP * Board specific commands
  633. CONFIG_CMD_BOOTD bootd
  634. CONFIG_CMD_CACHE * icache, dcache
  635. CONFIG_CMD_CONSOLE coninfo
  636. CONFIG_CMD_CRC32 * crc32
  637. CONFIG_CMD_DATE * support for RTC, date/time...
  638. CONFIG_CMD_DHCP * DHCP support
  639. CONFIG_CMD_DIAG * Diagnostics
  640. CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
  641. CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
  642. CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
  643. CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
  644. CONFIG_CMD_DTT * Digital Therm and Thermostat
  645. CONFIG_CMD_ECHO echo arguments
  646. CONFIG_CMD_EDITENV edit env variable
  647. CONFIG_CMD_EEPROM * EEPROM read/write support
  648. CONFIG_CMD_ELF * bootelf, bootvx
  649. CONFIG_CMD_EXPORTENV * export the environment
  650. CONFIG_CMD_EXT2 * ext2 command support
  651. CONFIG_CMD_EXT4 * ext4 command support
  652. CONFIG_CMD_SAVEENV saveenv
  653. CONFIG_CMD_FDC * Floppy Disk Support
  654. CONFIG_CMD_FAT * FAT command support
  655. CONFIG_CMD_FDOS * Dos diskette Support
  656. CONFIG_CMD_FLASH flinfo, erase, protect
  657. CONFIG_CMD_FPGA FPGA device initialization support
  658. CONFIG_CMD_GETTIME * Get time since boot
  659. CONFIG_CMD_GO * the 'go' command (exec code)
  660. CONFIG_CMD_GREPENV * search environment
  661. CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
  662. CONFIG_CMD_I2C * I2C serial bus support
  663. CONFIG_CMD_IDE * IDE harddisk support
  664. CONFIG_CMD_IMI iminfo
  665. CONFIG_CMD_IMLS List all found images
  666. CONFIG_CMD_IMMAP * IMMR dump support
  667. CONFIG_CMD_IMPORTENV * import an environment
  668. CONFIG_CMD_INI * import data from an ini file into the env
  669. CONFIG_CMD_IRQ * irqinfo
  670. CONFIG_CMD_ITEST Integer/string test of 2 values
  671. CONFIG_CMD_JFFS2 * JFFS2 Support
  672. CONFIG_CMD_KGDB * kgdb
  673. CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
  674. CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
  675. (169.254.*.*)
  676. CONFIG_CMD_LOADB loadb
  677. CONFIG_CMD_LOADS loads
  678. CONFIG_CMD_MD5SUM print md5 message digest
  679. (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
  680. CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
  681. loop, loopw, mtest
  682. CONFIG_CMD_MISC Misc functions like sleep etc
  683. CONFIG_CMD_MMC * MMC memory mapped support
  684. CONFIG_CMD_MII * MII utility commands
  685. CONFIG_CMD_MTDPARTS * MTD partition support
  686. CONFIG_CMD_NAND * NAND support
  687. CONFIG_CMD_NET bootp, tftpboot, rarpboot
  688. CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
  689. CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
  690. CONFIG_CMD_PCI * pciinfo
  691. CONFIG_CMD_PCMCIA * PCMCIA support
  692. CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
  693. host
  694. CONFIG_CMD_PORTIO * Port I/O
  695. CONFIG_CMD_READ * Read raw data from partition
  696. CONFIG_CMD_REGINFO * Register dump
  697. CONFIG_CMD_RUN run command in env variable
  698. CONFIG_CMD_SAVES * save S record dump
  699. CONFIG_CMD_SCSI * SCSI Support
  700. CONFIG_CMD_SDRAM * print SDRAM configuration information
  701. (requires CONFIG_CMD_I2C)
  702. CONFIG_CMD_SETGETDCR Support for DCR Register access
  703. (4xx only)
  704. CONFIG_CMD_SF * Read/write/erase SPI NOR flash
  705. CONFIG_CMD_SHA1SUM print sha1 memory digest
  706. (requires CONFIG_CMD_MEMORY)
  707. CONFIG_CMD_SOURCE "source" command Support
  708. CONFIG_CMD_SPI * SPI serial bus support
  709. CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
  710. CONFIG_CMD_TFTPPUT * TFTP put command (upload)
  711. CONFIG_CMD_TIME * run command and report execution time (ARM specific)
  712. CONFIG_CMD_TIMER * access to the system tick timer
  713. CONFIG_CMD_USB * USB support
  714. CONFIG_CMD_CDP * Cisco Discover Protocol support
  715. CONFIG_CMD_MFSL * Microblaze FSL support
  716. EXAMPLE: If you want all functions except of network
  717. support you can write:
  718. #include "config_cmd_all.h"
  719. #undef CONFIG_CMD_NET
  720. Other Commands:
  721. fdt (flattened device tree) command: CONFIG_OF_LIBFDT
  722. Note: Don't enable the "icache" and "dcache" commands
  723. (configuration option CONFIG_CMD_CACHE) unless you know
  724. what you (and your U-Boot users) are doing. Data
  725. cache cannot be enabled on systems like the 8xx or
  726. 8260 (where accesses to the IMMR region must be
  727. uncached), and it cannot be disabled on all other
  728. systems where we (mis-) use the data cache to hold an
  729. initial stack and some data.
  730. XXX - this list needs to get updated!
  731. - Device tree:
  732. CONFIG_OF_CONTROL
  733. If this variable is defined, U-Boot will use a device tree
  734. to configure its devices, instead of relying on statically
  735. compiled #defines in the board file. This option is
  736. experimental and only available on a few boards. The device
  737. tree is available in the global data as gd->fdt_blob.
  738. U-Boot needs to get its device tree from somewhere. This can
  739. be done using one of the two options below:
  740. CONFIG_OF_EMBED
  741. If this variable is defined, U-Boot will embed a device tree
  742. binary in its image. This device tree file should be in the
  743. board directory and called <soc>-<board>.dts. The binary file
  744. is then picked up in board_init_f() and made available through
  745. the global data structure as gd->blob.
  746. CONFIG_OF_SEPARATE
  747. If this variable is defined, U-Boot will build a device tree
  748. binary. It will be called u-boot.dtb. Architecture-specific
  749. code will locate it at run-time. Generally this works by:
  750. cat u-boot.bin u-boot.dtb >image.bin
  751. and in fact, U-Boot does this for you, creating a file called
  752. u-boot-dtb.bin which is useful in the common case. You can
  753. still use the individual files if you need something more
  754. exotic.
  755. - Watchdog:
  756. CONFIG_WATCHDOG
  757. If this variable is defined, it enables watchdog
  758. support for the SoC. There must be support in the SoC
  759. specific code for a watchdog. For the 8xx and 8260
  760. CPUs, the SIU Watchdog feature is enabled in the SYPCR
  761. register. When supported for a specific SoC is
  762. available, then no further board specific code should
  763. be needed to use it.
  764. CONFIG_HW_WATCHDOG
  765. When using a watchdog circuitry external to the used
  766. SoC, then define this variable and provide board
  767. specific code for the "hw_watchdog_reset" function.
  768. - U-Boot Version:
  769. CONFIG_VERSION_VARIABLE
  770. If this variable is defined, an environment variable
  771. named "ver" is created by U-Boot showing the U-Boot
  772. version as printed by the "version" command.
  773. Any change to this variable will be reverted at the
  774. next reset.
  775. - Real-Time Clock:
  776. When CONFIG_CMD_DATE is selected, the type of the RTC
  777. has to be selected, too. Define exactly one of the
  778. following options:
  779. CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
  780. CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
  781. CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
  782. CONFIG_RTC_MC146818 - use MC146818 RTC
  783. CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
  784. CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
  785. CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
  786. CONFIG_RTC_DS164x - use Dallas DS164x RTC
  787. CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
  788. CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
  789. CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
  790. CONFIG_SYS_RV3029_TCR - enable trickle charger on
  791. RV3029 RTC.
  792. Note that if the RTC uses I2C, then the I2C interface
  793. must also be configured. See I2C Support, below.
  794. - GPIO Support:
  795. CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
  796. CONFIG_PCA953X_INFO - enable pca953x info command
  797. The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
  798. chip-ngpio pairs that tell the PCA953X driver the number of
  799. pins supported by a particular chip.
  800. Note that if the GPIO device uses I2C, then the I2C interface
  801. must also be configured. See I2C Support, below.
  802. - Timestamp Support:
  803. When CONFIG_TIMESTAMP is selected, the timestamp
  804. (date and time) of an image is printed by image
  805. commands like bootm or iminfo. This option is
  806. automatically enabled when you select CONFIG_CMD_DATE .
  807. - Partition Labels (disklabels) Supported:
  808. Zero or more of the following:
  809. CONFIG_MAC_PARTITION Apple's MacOS partition table.
  810. CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
  811. Intel architecture, USB sticks, etc.
  812. CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
  813. CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
  814. bootloader. Note 2TB partition limit; see
  815. disk/part_efi.c
  816. CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
  817. If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
  818. CONFIG_CMD_SCSI) you must configure support for at
  819. least one non-MTD partition type as well.
  820. - IDE Reset method:
  821. CONFIG_IDE_RESET_ROUTINE - this is defined in several
  822. board configurations files but used nowhere!
  823. CONFIG_IDE_RESET - is this is defined, IDE Reset will
  824. be performed by calling the function
  825. ide_set_reset(int reset)
  826. which has to be defined in a board specific file
  827. - ATAPI Support:
  828. CONFIG_ATAPI
  829. Set this to enable ATAPI support.
  830. - LBA48 Support
  831. CONFIG_LBA48
  832. Set this to enable support for disks larger than 137GB
  833. Also look at CONFIG_SYS_64BIT_LBA.
  834. Whithout these , LBA48 support uses 32bit variables and will 'only'
  835. support disks up to 2.1TB.
  836. CONFIG_SYS_64BIT_LBA:
  837. When enabled, makes the IDE subsystem use 64bit sector addresses.
  838. Default is 32bit.
  839. - SCSI Support:
  840. At the moment only there is only support for the
  841. SYM53C8XX SCSI controller; define
  842. CONFIG_SCSI_SYM53C8XX to enable it.
  843. CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
  844. CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
  845. CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
  846. maximum numbers of LUNs, SCSI ID's and target
  847. devices.
  848. CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
  849. The environment variable 'scsidevs' is set to the number of
  850. SCSI devices found during the last scan.
  851. - NETWORK Support (PCI):
  852. CONFIG_E1000
  853. Support for Intel 8254x/8257x gigabit chips.
  854. CONFIG_E1000_SPI
  855. Utility code for direct access to the SPI bus on Intel 8257x.
  856. This does not do anything useful unless you set at least one
  857. of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
  858. CONFIG_E1000_SPI_GENERIC
  859. Allow generic access to the SPI bus on the Intel 8257x, for
  860. example with the "sspi" command.
  861. CONFIG_CMD_E1000
  862. Management command for E1000 devices. When used on devices
  863. with SPI support you can reprogram the EEPROM from U-Boot.
  864. CONFIG_E1000_FALLBACK_MAC
  865. default MAC for empty EEPROM after production.
  866. CONFIG_EEPRO100
  867. Support for Intel 82557/82559/82559ER chips.
  868. Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
  869. write routine for first time initialisation.
  870. CONFIG_TULIP
  871. Support for Digital 2114x chips.
  872. Optional CONFIG_TULIP_SELECT_MEDIA for board specific
  873. modem chip initialisation (KS8761/QS6611).
  874. CONFIG_NATSEMI
  875. Support for National dp83815 chips.
  876. CONFIG_NS8382X
  877. Support for National dp8382[01] gigabit chips.
  878. - NETWORK Support (other):
  879. CONFIG_DRIVER_AT91EMAC
  880. Support for AT91RM9200 EMAC.
  881. CONFIG_RMII
  882. Define this to use reduced MII inteface
  883. CONFIG_DRIVER_AT91EMAC_QUIET
  884. If this defined, the driver is quiet.
  885. The driver doen't show link status messages.
  886. CONFIG_CALXEDA_XGMAC
  887. Support for the Calxeda XGMAC device
  888. CONFIG_LAN91C96
  889. Support for SMSC's LAN91C96 chips.
  890. CONFIG_LAN91C96_BASE
  891. Define this to hold the physical address
  892. of the LAN91C96's I/O space
  893. CONFIG_LAN91C96_USE_32_BIT
  894. Define this to enable 32 bit addressing
  895. CONFIG_SMC91111
  896. Support for SMSC's LAN91C111 chip
  897. CONFIG_SMC91111_BASE
  898. Define this to hold the physical address
  899. of the device (I/O space)
  900. CONFIG_SMC_USE_32_BIT
  901. Define this if data bus is 32 bits
  902. CONFIG_SMC_USE_IOFUNCS
  903. Define this to use i/o functions instead of macros
  904. (some hardware wont work with macros)
  905. CONFIG_DRIVER_TI_EMAC
  906. Support for davinci emac
  907. CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
  908. Define this if you have more then 3 PHYs.
  909. CONFIG_FTGMAC100
  910. Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
  911. CONFIG_FTGMAC100_EGIGA
  912. Define this to use GE link update with gigabit PHY.
  913. Define this if FTGMAC100 is connected to gigabit PHY.
  914. If your system has 10/100 PHY only, it might not occur
  915. wrong behavior. Because PHY usually return timeout or
  916. useless data when polling gigabit status and gigabit
  917. control registers. This behavior won't affect the
  918. correctnessof 10/100 link speed update.
  919. CONFIG_SMC911X
  920. Support for SMSC's LAN911x and LAN921x chips
  921. CONFIG_SMC911X_BASE
  922. Define this to hold the physical address
  923. of the device (I/O space)
  924. CONFIG_SMC911X_32_BIT
  925. Define this if data bus is 32 bits
  926. CONFIG_SMC911X_16_BIT
  927. Define this if data bus is 16 bits. If your processor
  928. automatically converts one 32 bit word to two 16 bit
  929. words you may also try CONFIG_SMC911X_32_BIT.
  930. CONFIG_SH_ETHER
  931. Support for Renesas on-chip Ethernet controller
  932. CONFIG_SH_ETHER_USE_PORT
  933. Define the number of ports to be used
  934. CONFIG_SH_ETHER_PHY_ADDR
  935. Define the ETH PHY's address
  936. CONFIG_SH_ETHER_CACHE_WRITEBACK
  937. If this option is set, the driver enables cache flush.
  938. - TPM Support:
  939. CONFIG_GENERIC_LPC_TPM
  940. Support for generic parallel port TPM devices. Only one device
  941. per system is supported at this time.
  942. CONFIG_TPM_TIS_BASE_ADDRESS
  943. Base address where the generic TPM device is mapped
  944. to. Contemporary x86 systems usually map it at
  945. 0xfed40000.
  946. - USB Support:
  947. At the moment only the UHCI host controller is
  948. supported (PIP405, MIP405, MPC5200); define
  949. CONFIG_USB_UHCI to enable it.
  950. define CONFIG_USB_KEYBOARD to enable the USB Keyboard
  951. and define CONFIG_USB_STORAGE to enable the USB
  952. storage devices.
  953. Note:
  954. Supported are USB Keyboards and USB Floppy drives
  955. (TEAC FD-05PUB).
  956. MPC5200 USB requires additional defines:
  957. CONFIG_USB_CLOCK
  958. for 528 MHz Clock: 0x0001bbbb
  959. CONFIG_PSC3_USB
  960. for USB on PSC3
  961. CONFIG_USB_CONFIG
  962. for differential drivers: 0x00001000
  963. for single ended drivers: 0x00005000
  964. for differential drivers on PSC3: 0x00000100
  965. for single ended drivers on PSC3: 0x00004100
  966. CONFIG_SYS_USB_EVENT_POLL
  967. May be defined to allow interrupt polling
  968. instead of using asynchronous interrupts
  969. CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
  970. txfilltuning field in the EHCI controller on reset.
  971. - USB Device:
  972. Define the below if you wish to use the USB console.
  973. Once firmware is rebuilt from a serial console issue the
  974. command "setenv stdin usbtty; setenv stdout usbtty" and
  975. attach your USB cable. The Unix command "dmesg" should print
  976. it has found a new device. The environment variable usbtty
  977. can be set to gserial or cdc_acm to enable your device to
  978. appear to a USB host as a Linux gserial device or a
  979. Common Device Class Abstract Control Model serial device.
  980. If you select usbtty = gserial you should be able to enumerate
  981. a Linux host by
  982. # modprobe usbserial vendor=0xVendorID product=0xProductID
  983. else if using cdc_acm, simply setting the environment
  984. variable usbtty to be cdc_acm should suffice. The following
  985. might be defined in YourBoardName.h
  986. CONFIG_USB_DEVICE
  987. Define this to build a UDC device
  988. CONFIG_USB_TTY
  989. Define this to have a tty type of device available to
  990. talk to the UDC device
  991. CONFIG_USBD_HS
  992. Define this to enable the high speed support for usb
  993. device and usbtty. If this feature is enabled, a routine
  994. int is_usbd_high_speed(void)
  995. also needs to be defined by the driver to dynamically poll
  996. whether the enumeration has succeded at high speed or full
  997. speed.
  998. CONFIG_SYS_CONSOLE_IS_IN_ENV
  999. Define this if you want stdin, stdout &/or stderr to
  1000. be set to usbtty.
  1001. mpc8xx:
  1002. CONFIG_SYS_USB_EXTC_CLK 0xBLAH
  1003. Derive USB clock from external clock "blah"
  1004. - CONFIG_SYS_USB_EXTC_CLK 0x02
  1005. CONFIG_SYS_USB_BRG_CLK 0xBLAH
  1006. Derive USB clock from brgclk
  1007. - CONFIG_SYS_USB_BRG_CLK 0x04
  1008. If you have a USB-IF assigned VendorID then you may wish to
  1009. define your own vendor specific values either in BoardName.h
  1010. or directly in usbd_vendor_info.h. If you don't define
  1011. CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
  1012. CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
  1013. should pretend to be a Linux device to it's target host.
  1014. CONFIG_USBD_MANUFACTURER
  1015. Define this string as the name of your company for
  1016. - CONFIG_USBD_MANUFACTURER "my company"
  1017. CONFIG_USBD_PRODUCT_NAME
  1018. Define this string as the name of your product
  1019. - CONFIG_USBD_PRODUCT_NAME "acme usb device"
  1020. CONFIG_USBD_VENDORID
  1021. Define this as your assigned Vendor ID from the USB
  1022. Implementors Forum. This *must* be a genuine Vendor ID
  1023. to avoid polluting the USB namespace.
  1024. - CONFIG_USBD_VENDORID 0xFFFF
  1025. CONFIG_USBD_PRODUCTID
  1026. Define this as the unique Product ID
  1027. for your device
  1028. - CONFIG_USBD_PRODUCTID 0xFFFF
  1029. - ULPI Layer Support:
  1030. The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
  1031. the generic ULPI layer. The generic layer accesses the ULPI PHY
  1032. via the platform viewport, so you need both the genric layer and
  1033. the viewport enabled. Currently only Chipidea/ARC based
  1034. viewport is supported.
  1035. To enable the ULPI layer support, define CONFIG_USB_ULPI and
  1036. CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
  1037. If your ULPI phy needs a different reference clock than the
  1038. standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
  1039. the appropriate value in Hz.
  1040. - MMC Support:
  1041. The MMC controller on the Intel PXA is supported. To
  1042. enable this define CONFIG_MMC. The MMC can be
  1043. accessed from the boot prompt by mapping the device
  1044. to physical memory similar to flash. Command line is
  1045. enabled with CONFIG_CMD_MMC. The MMC driver also works with
  1046. the FAT fs. This is enabled with CONFIG_CMD_FAT.
  1047. CONFIG_SH_MMCIF
  1048. Support for Renesas on-chip MMCIF controller
  1049. CONFIG_SH_MMCIF_ADDR
  1050. Define the base address of MMCIF registers
  1051. CONFIG_SH_MMCIF_CLK
  1052. Define the clock frequency for MMCIF
  1053. - Journaling Flash filesystem support:
  1054. CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
  1055. CONFIG_JFFS2_NAND_DEV
  1056. Define these for a default partition on a NAND device
  1057. CONFIG_SYS_JFFS2_FIRST_SECTOR,
  1058. CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
  1059. Define these for a default partition on a NOR device
  1060. CONFIG_SYS_JFFS_CUSTOM_PART
  1061. Define this to create an own partition. You have to provide a
  1062. function struct part_info* jffs2_part_info(int part_num)
  1063. If you define only one JFFS2 partition you may also want to
  1064. #define CONFIG_SYS_JFFS_SINGLE_PART 1
  1065. to disable the command chpart. This is the default when you
  1066. have not defined a custom partition
  1067. - FAT(File Allocation Table) filesystem write function support:
  1068. CONFIG_FAT_WRITE
  1069. Define this to enable support for saving memory data as a
  1070. file in FAT formatted partition.
  1071. This will also enable the command "fatwrite" enabling the
  1072. user to write files to FAT.
  1073. CBFS (Coreboot Filesystem) support
  1074. CONFIG_CMD_CBFS
  1075. Define this to enable support for reading from a Coreboot
  1076. filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
  1077. and cbfsload.
  1078. - Keyboard Support:
  1079. CONFIG_ISA_KEYBOARD
  1080. Define this to enable standard (PC-Style) keyboard
  1081. support
  1082. CONFIG_I8042_KBD
  1083. Standard PC keyboard driver with US (is default) and
  1084. GERMAN key layout (switch via environment 'keymap=de') support.
  1085. Export function i8042_kbd_init, i8042_tstc and i8042_getc
  1086. for cfb_console. Supports cursor blinking.
  1087. - Video support:
  1088. CONFIG_VIDEO
  1089. Define this to enable video support (for output to
  1090. video).
  1091. CONFIG_VIDEO_CT69000
  1092. Enable Chips & Technologies 69000 Video chip
  1093. CONFIG_VIDEO_SMI_LYNXEM
  1094. Enable Silicon Motion SMI 712/710/810 Video chip. The
  1095. video output is selected via environment 'videoout'
  1096. (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
  1097. assumed.
  1098. For the CT69000 and SMI_LYNXEM drivers, videomode is
  1099. selected via environment 'videomode'. Two different ways
  1100. are possible:
  1101. - "videomode=num" 'num' is a standard LiLo mode numbers.
  1102. Following standard modes are supported (* is default):
  1103. Colors 640x480 800x600 1024x768 1152x864 1280x1024
  1104. -------------+---------------------------------------------
  1105. 8 bits | 0x301* 0x303 0x305 0x161 0x307
  1106. 15 bits | 0x310 0x313 0x316 0x162 0x319
  1107. 16 bits | 0x311 0x314 0x317 0x163 0x31A
  1108. 24 bits | 0x312 0x315 0x318 ? 0x31B
  1109. -------------+---------------------------------------------
  1110. (i.e. setenv videomode 317; saveenv; reset;)
  1111. - "videomode=bootargs" all the video parameters are parsed
  1112. from the bootargs. (See drivers/video/videomodes.c)
  1113. CONFIG_VIDEO_SED13806
  1114. Enable Epson SED13806 driver. This driver supports 8bpp
  1115. and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
  1116. or CONFIG_VIDEO_SED13806_16BPP
  1117. CONFIG_FSL_DIU_FB
  1118. Enable the Freescale DIU video driver. Reference boards for
  1119. SOCs that have a DIU should define this macro to enable DIU
  1120. support, and should also define these other macros:
  1121. CONFIG_SYS_DIU_ADDR
  1122. CONFIG_VIDEO
  1123. CONFIG_CMD_BMP
  1124. CONFIG_CFB_CONSOLE
  1125. CONFIG_VIDEO_SW_CURSOR
  1126. CONFIG_VGA_AS_SINGLE_DEVICE
  1127. CONFIG_VIDEO_LOGO
  1128. CONFIG_VIDEO_BMP_LOGO
  1129. The DIU driver will look for the 'video-mode' environment
  1130. variable, and if defined, enable the DIU as a console during
  1131. boot. See the documentation file README.video for a
  1132. description of this variable.
  1133. CONFIG_VIDEO_VGA
  1134. Enable the VGA video / BIOS for x86. The alternative if you
  1135. are using coreboot is to use the coreboot frame buffer
  1136. driver.
  1137. - Keyboard Support:
  1138. CONFIG_KEYBOARD
  1139. Define this to enable a custom keyboard support.
  1140. This simply calls drv_keyboard_init() which must be
  1141. defined in your board-specific files.
  1142. The only board using this so far is RBC823.
  1143. - LCD Support: CONFIG_LCD
  1144. Define this to enable LCD support (for output to LCD
  1145. display); also select one of the supported displays
  1146. by defining one of these:
  1147. CONFIG_ATMEL_LCD:
  1148. HITACHI TX09D70VM1CCA, 3.5", 240x320.
  1149. CONFIG_NEC_NL6448AC33:
  1150. NEC NL6448AC33-18. Active, color, single scan.
  1151. CONFIG_NEC_NL6448BC20
  1152. NEC NL6448BC20-08. 6.5", 640x480.
  1153. Active, color, single scan.
  1154. CONFIG_NEC_NL6448BC33_54
  1155. NEC NL6448BC33-54. 10.4", 640x480.
  1156. Active, color, single scan.
  1157. CONFIG_SHARP_16x9
  1158. Sharp 320x240. Active, color, single scan.
  1159. It isn't 16x9, and I am not sure what it is.
  1160. CONFIG_SHARP_LQ64D341
  1161. Sharp LQ64D341 display, 640x480.
  1162. Active, color, single scan.
  1163. CONFIG_HLD1045
  1164. HLD1045 display, 640x480.
  1165. Active, color, single scan.
  1166. CONFIG_OPTREX_BW
  1167. Optrex CBL50840-2 NF-FW 99 22 M5
  1168. or
  1169. Hitachi LMG6912RPFC-00T
  1170. or
  1171. Hitachi SP14Q002
  1172. 320x240. Black & white.
  1173. Normally display is black on white background; define
  1174. CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
  1175. CONFIG_LCD_BMP_RLE8
  1176. Support drawing of RLE8-compressed bitmaps on the LCD.
  1177. - Splash Screen Support: CONFIG_SPLASH_SCREEN
  1178. If this option is set, the environment is checked for
  1179. a variable "splashimage". If found, the usual display
  1180. of logo, copyright and system information on the LCD
  1181. is suppressed and the BMP image at the address
  1182. specified in "splashimage" is loaded instead. The
  1183. console is redirected to the "nulldev", too. This
  1184. allows for a "silent" boot where a splash screen is
  1185. loaded very quickly after power-on.
  1186. CONFIG_SPLASH_SCREEN_ALIGN
  1187. If this option is set the splash image can be freely positioned
  1188. on the screen. Environment variable "splashpos" specifies the
  1189. position as "x,y". If a positive number is given it is used as
  1190. number of pixel from left/top. If a negative number is given it
  1191. is used as number of pixel from right/bottom. You can also
  1192. specify 'm' for centering the image.
  1193. Example:
  1194. setenv splashpos m,m
  1195. => image at center of screen
  1196. setenv splashpos 30,20
  1197. => image at x = 30 and y = 20
  1198. setenv splashpos -10,m
  1199. => vertically centered image
  1200. at x = dspWidth - bmpWidth - 9
  1201. - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
  1202. If this option is set, additionally to standard BMP
  1203. images, gzipped BMP images can be displayed via the
  1204. splashscreen support or the bmp command.
  1205. - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
  1206. If this option is set, 8-bit RLE compressed BMP images
  1207. can be displayed via the splashscreen support or the
  1208. bmp command.
  1209. - Do compresssing for memory range:
  1210. CONFIG_CMD_ZIP
  1211. If this option is set, it would use zlib deflate method
  1212. to compress the specified memory at its best effort.
  1213. - Compression support:
  1214. CONFIG_BZIP2
  1215. If this option is set, support for bzip2 compressed
  1216. images is included. If not, only uncompressed and gzip
  1217. compressed images are supported.
  1218. NOTE: the bzip2 algorithm requires a lot of RAM, so
  1219. the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
  1220. be at least 4MB.
  1221. CONFIG_LZMA
  1222. If this option is set, support for lzma compressed
  1223. images is included.
  1224. Note: The LZMA algorithm adds between 2 and 4KB of code and it
  1225. requires an amount of dynamic memory that is given by the
  1226. formula:
  1227. (1846 + 768 << (lc + lp)) * sizeof(uint16)
  1228. Where lc and lp stand for, respectively, Literal context bits
  1229. and Literal pos bits.
  1230. This value is upper-bounded by 14MB in the worst case. Anyway,
  1231. for a ~4MB large kernel image, we have lc=3 and lp=0 for a
  1232. total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
  1233. a very small buffer.
  1234. Use the lzmainfo tool to determinate the lc and lp values and
  1235. then calculate the amount of needed dynamic memory (ensuring
  1236. the appropriate CONFIG_SYS_MALLOC_LEN value).
  1237. - MII/PHY support:
  1238. CONFIG_PHY_ADDR
  1239. The address of PHY on MII bus.
  1240. CONFIG_PHY_CLOCK_FREQ (ppc4xx)
  1241. The clock frequency of the MII bus
  1242. CONFIG_PHY_GIGE
  1243. If this option is set, support for speed/duplex
  1244. detection of gigabit PHY is included.
  1245. CONFIG_PHY_RESET_DELAY
  1246. Some PHY like Intel LXT971A need extra delay after
  1247. reset before any MII register access is possible.
  1248. For such PHY, set this option to the usec delay
  1249. required. (minimum 300usec for LXT971A)
  1250. CONFIG_PHY_CMD_DELAY (ppc4xx)
  1251. Some PHY like Intel LXT971A need extra delay after
  1252. command issued before MII status register can be read
  1253. - Ethernet address:
  1254. CONFIG_ETHADDR
  1255. CONFIG_ETH1ADDR
  1256. CONFIG_ETH2ADDR
  1257. CONFIG_ETH3ADDR
  1258. CONFIG_ETH4ADDR
  1259. CONFIG_ETH5ADDR
  1260. Define a default value for Ethernet address to use
  1261. for the respective Ethernet interface, in case this
  1262. is not determined automatically.
  1263. - IP address:
  1264. CONFIG_IPADDR
  1265. Define a default value for the IP address to use for
  1266. the default Ethernet interface, in case this is not
  1267. determined through e.g. bootp.
  1268. (Environment variable "ipaddr")
  1269. - Server IP address:
  1270. CONFIG_SERVERIP
  1271. Defines a default value for the IP address of a TFTP
  1272. server to contact when using the "tftboot" command.
  1273. (Environment variable "serverip")
  1274. CONFIG_KEEP_SERVERADDR
  1275. Keeps the server's MAC address, in the env 'serveraddr'
  1276. for passing to bootargs (like Linux's netconsole option)
  1277. - Gateway IP address:
  1278. CONFIG_GATEWAYIP
  1279. Defines a default value for the IP address of the
  1280. default router where packets to other networks are
  1281. sent to.
  1282. (Environment variable "gatewayip")
  1283. - Subnet mask:
  1284. CONFIG_NETMASK
  1285. Defines a default value for the subnet mask (or
  1286. routing prefix) which is used to determine if an IP
  1287. address belongs to the local subnet or needs to be
  1288. forwarded through a router.
  1289. (Environment variable "netmask")
  1290. - Multicast TFTP Mode:
  1291. CONFIG_MCAST_TFTP
  1292. Defines whether you want to support multicast TFTP as per
  1293. rfc-2090; for example to work with atftp. Lets lots of targets
  1294. tftp down the same boot image concurrently. Note: the Ethernet
  1295. driver in use must provide a function: mcast() to join/leave a
  1296. multicast group.
  1297. - BOOTP Recovery Mode:
  1298. CONFIG_BOOTP_RANDOM_DELAY
  1299. If you have many targets in a network that try to
  1300. boot using BOOTP, you may want to avoid that all
  1301. systems send out BOOTP requests at precisely the same
  1302. moment (which would happen for instance at recovery
  1303. from a power failure, when all systems will try to
  1304. boot, thus flooding the BOOTP server. Defining
  1305. CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
  1306. inserted before sending out BOOTP requests. The
  1307. following delays are inserted then:
  1308. 1st BOOTP request: delay 0 ... 1 sec
  1309. 2nd BOOTP request: delay 0 ... 2 sec
  1310. 3rd BOOTP request: delay 0 ... 4 sec
  1311. 4th and following
  1312. BOOTP requests: delay 0 ... 8 sec
  1313. - DHCP Advanced Options:
  1314. You can fine tune the DHCP functionality by defining
  1315. CONFIG_BOOTP_* symbols:
  1316. CONFIG_BOOTP_SUBNETMASK
  1317. CONFIG_BOOTP_GATEWAY
  1318. CONFIG_BOOTP_HOSTNAME
  1319. CONFIG_BOOTP_NISDOMAIN
  1320. CONFIG_BOOTP_BOOTPATH
  1321. CONFIG_BOOTP_BOOTFILESIZE
  1322. CONFIG_BOOTP_DNS
  1323. CONFIG_BOOTP_DNS2
  1324. CONFIG_BOOTP_SEND_HOSTNAME
  1325. CONFIG_BOOTP_NTPSERVER
  1326. CONFIG_BOOTP_TIMEOFFSET
  1327. CONFIG_BOOTP_VENDOREX
  1328. CONFIG_BOOTP_MAY_FAIL
  1329. CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
  1330. environment variable, not the BOOTP server.
  1331. CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
  1332. after the configured retry count, the call will fail
  1333. instead of starting over. This can be used to fail over
  1334. to Link-local IP address configuration if the DHCP server
  1335. is not available.
  1336. CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
  1337. serverip from a DHCP server, it is possible that more
  1338. than one DNS serverip is offered to the client.
  1339. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
  1340. serverip will be stored in the additional environment
  1341. variable "dnsip2". The first DNS serverip is always
  1342. stored in the variable "dnsip", when CONFIG_BOOTP_DNS
  1343. is defined.
  1344. CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
  1345. to do a dynamic update of a DNS server. To do this, they
  1346. need the hostname of the DHCP requester.
  1347. If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
  1348. of the "hostname" environment variable is passed as
  1349. option 12 to the DHCP server.
  1350. CONFIG_BOOTP_DHCP_REQUEST_DELAY
  1351. A 32bit value in microseconds for a delay between
  1352. receiving a "DHCP Offer" and sending the "DHCP Request".
  1353. This fixes a problem with certain DHCP servers that don't
  1354. respond 100% of the time to a "DHCP request". E.g. On an
  1355. AT91RM9200 processor running at 180MHz, this delay needed
  1356. to be *at least* 15,000 usec before a Windows Server 2003
  1357. DHCP server would reply 100% of the time. I recommend at
  1358. least 50,000 usec to be safe. The alternative is to hope
  1359. that one of the retries will be successful but note that
  1360. the DHCP timeout and retry process takes a longer than
  1361. this delay.
  1362. - Link-local IP address negotiation:
  1363. Negotiate with other link-local clients on the local network
  1364. for an address that doesn't require explicit configuration.
  1365. This is especially useful if a DHCP server cannot be guaranteed
  1366. to exist in all environments that the device must operate.
  1367. See doc/README.link-local for more information.
  1368. - CDP Options:
  1369. CONFIG_CDP_DEVICE_ID
  1370. The device id used in CDP trigger frames.
  1371. CONFIG_CDP_DEVICE_ID_PREFIX
  1372. A two character string which is prefixed to the MAC address
  1373. of the device.
  1374. CONFIG_CDP_PORT_ID
  1375. A printf format string which contains the ascii name of
  1376. the port. Normally is set to "eth%d" which sets
  1377. eth0 for the first Ethernet, eth1 for the second etc.
  1378. CONFIG_CDP_CAPABILITIES
  1379. A 32bit integer which indicates the device capabilities;
  1380. 0x00000010 for a normal host which does not forwards.
  1381. CONFIG_CDP_VERSION
  1382. An ascii string containing the version of the software.
  1383. CONFIG_CDP_PLATFORM
  1384. An ascii string containing the name of the platform.
  1385. CONFIG_CDP_TRIGGER
  1386. A 32bit integer sent on the trigger.
  1387. CONFIG_CDP_POWER_CONSUMPTION
  1388. A 16bit integer containing the power consumption of the
  1389. device in .1 of milliwatts.
  1390. CONFIG_CDP_APPLIANCE_VLAN_TYPE
  1391. A byte containing the id of the VLAN.
  1392. - Status LED: CONFIG_STATUS_LED
  1393. Several configurations allow to display the current
  1394. status using a LED. For instance, the LED will blink
  1395. fast while running U-Boot code, stop blinking as
  1396. soon as a reply to a BOOTP request was received, and
  1397. start blinking slow once the Linux kernel is running
  1398. (supported by a status LED driver in the Linux
  1399. kernel). Defining CONFIG_STATUS_LED enables this
  1400. feature in U-Boot.
  1401. - CAN Support: CONFIG_CAN_DRIVER
  1402. Defining CONFIG_CAN_DRIVER enables CAN driver support
  1403. on those systems that support this (optional)
  1404. feature, like the TQM8xxL modules.
  1405. - I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
  1406. These enable I2C serial bus commands. Defining either of
  1407. (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
  1408. include the appropriate I2C driver for the selected CPU.
  1409. This will allow you to use i2c commands at the u-boot
  1410. command line (as long as you set CONFIG_CMD_I2C in
  1411. CONFIG_COMMANDS) and communicate with i2c based realtime
  1412. clock chips. See common/cmd_i2c.c for a description of the
  1413. command line interface.
  1414. CONFIG_HARD_I2C selects a hardware I2C controller.
  1415. CONFIG_SOFT_I2C configures u-boot to use a software (aka
  1416. bit-banging) driver instead of CPM or similar hardware
  1417. support for I2C.
  1418. There are several other quantities that must also be
  1419. defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
  1420. In both cases you will need to define CONFIG_SYS_I2C_SPEED
  1421. to be the frequency (in Hz) at which you wish your i2c bus
  1422. to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
  1423. the CPU's i2c node address).
  1424. Now, the u-boot i2c code for the mpc8xx
  1425. (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
  1426. and so its address should therefore be cleared to 0 (See,
  1427. eg, MPC823e User's Manual p.16-473). So, set
  1428. CONFIG_SYS_I2C_SLAVE to 0.
  1429. CONFIG_SYS_I2C_INIT_MPC5XXX
  1430. When a board is reset during an i2c bus transfer
  1431. chips might think that the current transfer is still
  1432. in progress. Reset the slave devices by sending start
  1433. commands until the slave device responds.
  1434. That's all that's required for CONFIG_HARD_I2C.
  1435. If you use the software i2c interface (CONFIG_SOFT_I2C)
  1436. then the following macros need to be defined (examples are
  1437. from include/configs/lwmon.h):
  1438. I2C_INIT
  1439. (Optional). Any commands necessary to enable the I2C
  1440. controller or configure ports.
  1441. eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
  1442. I2C_PORT
  1443. (Only for MPC8260 CPU). The I/O port to use (the code
  1444. assumes both bits are on the same port). Valid values
  1445. are 0..3 for ports A..D.
  1446. I2C_ACTIVE
  1447. The code necessary to make the I2C data line active
  1448. (driven). If the data line is open collector, this
  1449. define can be null.
  1450. eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
  1451. I2C_TRISTATE
  1452. The code necessary to make the I2C data line tri-stated
  1453. (inactive). If the data line is open collector, this
  1454. define can be null.
  1455. eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
  1456. I2C_READ
  1457. Code that returns TRUE if the I2C data line is high,
  1458. FALSE if it is low.
  1459. eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
  1460. I2C_SDA(bit)
  1461. If <bit> is TRUE, sets the I2C data line high. If it
  1462. is FALSE, it clears it (low).
  1463. eg: #define I2C_SDA(bit) \
  1464. if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
  1465. else immr->im_cpm.cp_pbdat &= ~PB_SDA
  1466. I2C_SCL(bit)
  1467. If <bit> is TRUE, sets the I2C clock line high. If it
  1468. is FALSE, it clears it (low).
  1469. eg: #define I2C_SCL(bit) \
  1470. if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
  1471. else immr->im_cpm.cp_pbdat &= ~PB_SCL
  1472. I2C_DELAY
  1473. This delay is invoked four times per clock cycle so this
  1474. controls the rate of data transfer. The data rate thus
  1475. is 1 / (I2C_DELAY * 4). Often defined to be something
  1476. like:
  1477. #define I2C_DELAY udelay(2)
  1478. CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
  1479. If your arch supports the generic GPIO framework (asm/gpio.h),
  1480. then you may alternatively define the two GPIOs that are to be
  1481. used as SCL / SDA. Any of the previous I2C_xxx macros will
  1482. have GPIO-based defaults assigned to them as appropriate.
  1483. You should define these to the GPIO value as given directly to
  1484. the generic GPIO functions.
  1485. CONFIG_SYS_I2C_INIT_BOARD
  1486. When a board is reset during an i2c bus transfer
  1487. chips might think that the current transfer is still
  1488. in progress. On some boards it is possible to access
  1489. the i2c SCLK line directly, either by using the
  1490. processor pin as a GPIO or by having a second pin
  1491. connected to the bus. If this option is defined a
  1492. custom i2c_init_board() routine in boards/xxx/board.c
  1493. is run early in the boot sequence.
  1494. CONFIG_SYS_I2C_BOARD_LATE_INIT
  1495. An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
  1496. defined a custom i2c_board_late_init() routine in
  1497. boards/xxx/board.c is run AFTER the operations in i2c_init()
  1498. is completed. This callpoint can be used to unreset i2c bus
  1499. using CPU i2c controller register accesses for CPUs whose i2c
  1500. controller provide such a method. It is called at the end of
  1501. i2c_init() to allow i2c_init operations to setup the i2c bus
  1502. controller on the CPU (e.g. setting bus speed & slave address).
  1503. CONFIG_I2CFAST (PPC405GP|PPC405EP only)
  1504. This option enables configuration of bi_iic_fast[] flags
  1505. in u-boot bd_info structure based on u-boot environment
  1506. variable "i2cfast". (see also i2cfast)
  1507. CONFIG_I2C_MULTI_BUS
  1508. This option allows the use of multiple I2C buses, each of which
  1509. must have a controller. At any point in time, only one bus is
  1510. active. To switch to a different bus, use the 'i2c dev' command.
  1511. Note that bus numbering is zero-based.
  1512. CONFIG_SYS_I2C_NOPROBES
  1513. This option specifies a list of I2C devices that will be skipped
  1514. when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
  1515. is set, specify a list of bus-device pairs. Otherwise, specify
  1516. a 1D array of device addresses
  1517. e.g.
  1518. #undef CONFIG_I2C_MULTI_BUS
  1519. #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
  1520. will skip addresses 0x50 and 0x68 on a board with one I2C bus
  1521. #define CONFIG_I2C_MULTI_BUS
  1522. #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
  1523. will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
  1524. CONFIG_SYS_SPD_BUS_NUM
  1525. If defined, then this indicates the I2C bus number for DDR SPD.
  1526. If not defined, then U-Boot assumes that SPD is on I2C bus 0.
  1527. CONFIG_SYS_RTC_BUS_NUM
  1528. If defined, then this indicates the I2C bus number for the RTC.
  1529. If not defined, then U-Boot assumes that RTC is on I2C bus 0.
  1530. CONFIG_SYS_DTT_BUS_NUM
  1531. If defined, then this indicates the I2C bus number for the DTT.
  1532. If not defined, then U-Boot assumes that DTT is on I2C bus 0.
  1533. CONFIG_SYS_I2C_DTT_ADDR:
  1534. If defined, specifies the I2C address of the DTT device.
  1535. If not defined, then U-Boot uses predefined value for
  1536. specified DTT device.
  1537. CONFIG_FSL_I2C
  1538. Define this option if you want to use Freescale's I2C driver in
  1539. drivers/i2c/fsl_i2c.c.
  1540. CONFIG_I2C_MUX
  1541. Define this option if you have I2C devices reached over 1 .. n
  1542. I2C Muxes like the pca9544a. This option addes a new I2C
  1543. Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
  1544. new I2C Bus to the existing I2C Busses. If you select the
  1545. new Bus with "i2c dev", u-bbot sends first the commandos for
  1546. the muxes to activate this new "bus".
  1547. CONFIG_I2C_MULTI_BUS must be also defined, to use this
  1548. feature!
  1549. Example:
  1550. Adding a new I2C Bus reached over 2 pca9544a muxes
  1551. The First mux with address 70 and channel 6
  1552. The Second mux with address 71 and channel 4
  1553. => i2c bus pca9544a:70:6:pca9544a:71:4
  1554. Use the "i2c bus" command without parameter, to get a list
  1555. of I2C Busses with muxes:
  1556. => i2c bus
  1557. Busses reached over muxes:
  1558. Bus ID: 2
  1559. reached over Mux(es):
  1560. pca9544a@70 ch: 4
  1561. Bus ID: 3
  1562. reached over Mux(es):
  1563. pca9544a@70 ch: 6
  1564. pca9544a@71 ch: 4
  1565. =>
  1566. If you now switch to the new I2C Bus 3 with "i2c dev 3"
  1567. u-boot first sends the command to the mux@70 to enable
  1568. channel 6, and then the command to the mux@71 to enable
  1569. the channel 4.
  1570. After that, you can use the "normal" i2c commands as
  1571. usual to communicate with your I2C devices behind
  1572. the 2 muxes.
  1573. This option is actually implemented for the bitbanging
  1574. algorithm in common/soft_i2c.c and for the Hardware I2C
  1575. Bus on the MPC8260. But it should be not so difficult
  1576. to add this option to other architectures.
  1577. CONFIG_SOFT_I2C_READ_REPEATED_START
  1578. defining this will force the i2c_read() function in
  1579. the soft_i2c driver to perform an I2C repeated start
  1580. between writing the address pointer and reading the
  1581. data. If this define is omitted the default behaviour
  1582. of doing a stop-start sequence will be used. Most I2C
  1583. devices can use either method, but some require one or
  1584. the other.
  1585. - SPI Support: CONFIG_SPI
  1586. Enables SPI driver (so far only tested with
  1587. SPI EEPROM, also an instance works with Crystal A/D and
  1588. D/As on the SACSng board)
  1589. CONFIG_SH_SPI
  1590. Enables the driver for SPI controller on SuperH. Currently
  1591. only SH7757 is supported.
  1592. CONFIG_SPI_X
  1593. Enables extended (16-bit) SPI EEPROM addressing.
  1594. (symmetrical to CONFIG_I2C_X)
  1595. CONFIG_SOFT_SPI
  1596. Enables a software (bit-bang) SPI driver rather than
  1597. using hardware support. This is a general purpose
  1598. driver that only requires three general I/O port pins
  1599. (two outputs, one input) to function. If this is
  1600. defined, the board configuration must define several
  1601. SPI configuration items (port pins to use, etc). For
  1602. an example, see include/configs/sacsng.h.
  1603. CONFIG_HARD_SPI
  1604. Enables a hardware SPI driver for general-purpose reads
  1605. and writes. As with CONFIG_SOFT_SPI, the board configuration
  1606. must define a list of chip-select function pointers.
  1607. Currently supported on some MPC8xxx processors. For an
  1608. example, see include/configs/mpc8349emds.h.
  1609. CONFIG_MXC_SPI
  1610. Enables the driver for the SPI controllers on i.MX and MXC
  1611. SoCs. Currently i.MX31/35/51 are supported.
  1612. - FPGA Support: CONFIG_FPGA
  1613. Enables FPGA subsystem.
  1614. CONFIG_FPGA_<vendor>
  1615. Enables support for specific chip vendors.
  1616. (ALTERA, XILINX)
  1617. CONFIG_FPGA_<family>
  1618. Enables support for FPGA family.
  1619. (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
  1620. CONFIG_FPGA_COUNT
  1621. Specify the number of FPGA devices to support.
  1622. CONFIG_SYS_FPGA_PROG_FEEDBACK
  1623. Enable printing of hash marks during FPGA configuration.
  1624. CONFIG_SYS_FPGA_CHECK_BUSY
  1625. Enable checks on FPGA configuration interface busy
  1626. status by the configuration function. This option
  1627. will require a board or device specific function to
  1628. be written.
  1629. CONFIG_FPGA_DELAY
  1630. If defined, a function that provides delays in the FPGA
  1631. configuration driver.
  1632. CONFIG_SYS_FPGA_CHECK_CTRLC
  1633. Allow Control-C to interrupt FPGA configuration
  1634. CONFIG_SYS_FPGA_CHECK_ERROR
  1635. Check for configuration errors during FPGA bitfile
  1636. loading. For example, abort during Virtex II
  1637. configuration if the INIT_B line goes low (which
  1638. indicated a CRC error).
  1639. CONFIG_SYS_FPGA_WAIT_INIT
  1640. Maximum time to wait for the INIT_B line to deassert
  1641. after PROB_B has been deasserted during a Virtex II
  1642. FPGA configuration sequence. The default time is 500
  1643. ms.
  1644. CONFIG_SYS_FPGA_WAIT_BUSY
  1645. Maximum time to wait for BUSY to deassert during
  1646. Virtex II FPGA configuration. The default is 5 ms.
  1647. CONFIG_SYS_FPGA_WAIT_CONFIG
  1648. Time to wait after FPGA configuration. The default is
  1649. 200 ms.
  1650. - Configuration Management:
  1651. CONFIG_IDENT_STRING
  1652. If defined, this string will be added to the U-Boot
  1653. version information (U_BOOT_VERSION)
  1654. - Vendor Parameter Protection:
  1655. U-Boot considers the values of the environment
  1656. variables "serial#" (Board Serial Number) and
  1657. "ethaddr" (Ethernet Address) to be parameters that
  1658. are set once by the board vendor / manufacturer, and
  1659. protects these variables from casual modification by
  1660. the user. Once set, these variables are read-only,
  1661. and write or delete attempts are rejected. You can
  1662. change this behaviour:
  1663. If CONFIG_ENV_OVERWRITE is #defined in your config
  1664. file, the write protection for vendor parameters is
  1665. completely disabled. Anybody can change or delete
  1666. these parameters.
  1667. Alternatively, if you #define _both_ CONFIG_ETHADDR
  1668. _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
  1669. Ethernet address is installed in the environment,
  1670. which can be changed exactly ONCE by the user. [The
  1671. serial# is unaffected by this, i. e. it remains
  1672. read-only.]
  1673. - Protected RAM:
  1674. CONFIG_PRAM
  1675. Define this variable to enable the reservation of
  1676. "protected RAM", i. e. RAM which is not overwritten
  1677. by U-Boot. Define CONFIG_PRAM to hold the number of
  1678. kB you want to reserve for pRAM. You can overwrite
  1679. this default value by defining an environment
  1680. variable "pram" to the number of kB you want to
  1681. reserve. Note that the board info structure will
  1682. still show the full amount of RAM. If pRAM is
  1683. reserved, a new environment variable "mem" will
  1684. automatically be defined to hold the amount of
  1685. remaining RAM in a form that can be passed as boot
  1686. argument to Linux, for instance like that:
  1687. setenv bootargs ... mem=\${mem}
  1688. saveenv
  1689. This way you can tell Linux not to use this memory,
  1690. either, which results in a memory region that will
  1691. not be affected by reboots.
  1692. *WARNING* If your board configuration uses automatic
  1693. detection of the RAM size, you must make sure that
  1694. this memory test is non-destructive. So far, the
  1695. following board configurations are known to be
  1696. "pRAM-clean":
  1697. IVMS8, IVML24, SPD8xx, TQM8xxL,
  1698. HERMES, IP860, RPXlite, LWMON,
  1699. FLAGADM, TQM8260
  1700. - Access to physical memory region (> 4GB)
  1701. Some basic support is provided for operations on memory not
  1702. normally accessible to U-Boot - e.g. some architectures
  1703. support access to more than 4GB of memory on 32-bit
  1704. machines using physical address extension or similar.
  1705. Define CONFIG_PHYSMEM to access this basic support, which
  1706. currently only supports clearing the memory.
  1707. - Error Recovery:
  1708. CONFIG_PANIC_HANG
  1709. Define this variable to stop the system in case of a
  1710. fatal error, so that you have to reset it manually.
  1711. This is probably NOT a good idea for an embedded
  1712. system where you want the system to reboot
  1713. automatically as fast as possible, but it may be
  1714. useful during development since you can try to debug
  1715. the conditions that lead to the situation.
  1716. CONFIG_NET_RETRY_COUNT
  1717. This variable defines the number of retries for
  1718. network operations like ARP, RARP, TFTP, or BOOTP
  1719. before giving up the operation. If not defined, a
  1720. default value of 5 is used.
  1721. CONFIG_ARP_TIMEOUT
  1722. Timeout waiting for an ARP reply in milliseconds.
  1723. CONFIG_NFS_TIMEOUT
  1724. Timeout in milliseconds used in NFS protocol.
  1725. If you encounter "ERROR: Cannot umount" in nfs command,
  1726. try longer timeout such as
  1727. #define CONFIG_NFS_TIMEOUT 10000UL
  1728. - Command Interpreter:
  1729. CONFIG_AUTO_COMPLETE
  1730. Enable auto completion of commands using TAB.
  1731. Note that this feature has NOT been implemented yet
  1732. for the "hush" shell.
  1733. CONFIG_SYS_HUSH_PARSER
  1734. Define this variable to enable the "hush" shell (from
  1735. Busybox) as command line interpreter, thus enabling
  1736. powerful command line syntax like
  1737. if...then...else...fi conditionals or `&&' and '||'
  1738. constructs ("shell scripts").
  1739. If undefined, you get the old, much simpler behaviour
  1740. with a somewhat smaller memory footprint.
  1741. CONFIG_SYS_PROMPT_HUSH_PS2
  1742. This defines the secondary prompt string, which is
  1743. printed when the command interpreter needs more input
  1744. to complete a command. Usually "> ".
  1745. Note:
  1746. In the current implementation, the local variables
  1747. space and global environment variables space are
  1748. separated. Local variables are those you define by
  1749. simply typing `name=value'. To access a local
  1750. variable later on, you have write `$name' or
  1751. `${name}'; to execute the contents of a variable
  1752. directly type `$name' at the command prompt.
  1753. Global environment variables are those you use
  1754. setenv/printenv to work with. To run a command stored
  1755. in such a variable, you need to use the run command,
  1756. and you must not use the '$' sign to access them.
  1757. To store commands and special characters in a
  1758. variable, please use double quotation marks
  1759. surrounding the whole text of the variable, instead
  1760. of the backslashes before semicolons and special
  1761. symbols.
  1762. - Commandline Editing and History:
  1763. CONFIG_CMDLINE_EDITING
  1764. Enable editing and History functions for interactive
  1765. commandline input operations
  1766. - Default Environment:
  1767. CONFIG_EXTRA_ENV_SETTINGS
  1768. Define this to contain any number of null terminated
  1769. strings (variable = value pairs) that will be part of
  1770. the default environment compiled into the boot image.
  1771. For example, place something like this in your
  1772. board's config file:
  1773. #define CONFIG_EXTRA_ENV_SETTINGS \
  1774. "myvar1=value1\0" \
  1775. "myvar2=value2\0"
  1776. Warning: This method is based on knowledge about the
  1777. internal format how the environment is stored by the
  1778. U-Boot code. This is NOT an official, exported
  1779. interface! Although it is unlikely that this format
  1780. will change soon, there is no guarantee either.
  1781. You better know what you are doing here.
  1782. Note: overly (ab)use of the default environment is
  1783. discouraged. Make sure to check other ways to preset
  1784. the environment like the "source" command or the
  1785. boot command first.
  1786. CONFIG_ENV_VARS_UBOOT_CONFIG
  1787. Define this in order to add variables describing the
  1788. U-Boot build configuration to the default environment.
  1789. These will be named arch, cpu, board, vendor, and soc.
  1790. Enabling this option will cause the following to be defined:
  1791. - CONFIG_SYS_ARCH
  1792. - CONFIG_SYS_CPU
  1793. - CONFIG_SYS_BOARD
  1794. - CONFIG_SYS_VENDOR
  1795. - CONFIG_SYS_SOC
  1796. CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
  1797. Define this in order to add variables describing certain
  1798. run-time determined information about the hardware to the
  1799. environment. These will be named board_name, board_rev.
  1800. - DataFlash Support:
  1801. CONFIG_HAS_DATAFLASH
  1802. Defining this option enables DataFlash features and
  1803. allows to read/write in Dataflash via the standard
  1804. commands cp, md...
  1805. - Serial Flash support
  1806. CONFIG_CMD_SF
  1807. Defining this option enables SPI flash commands
  1808. 'sf probe/read/write/erase/update'.
  1809. Usage requires an initial 'probe' to define the serial
  1810. flash parameters, followed by read/write/erase/update
  1811. commands.
  1812. The following defaults may be provided by the platform
  1813. to handle the common case when only a single serial
  1814. flash is present on the system.
  1815. CONFIG_SF_DEFAULT_BUS Bus identifier
  1816. CONFIG_SF_DEFAULT_CS Chip-select
  1817. CONFIG_SF_DEFAULT_MODE (see include/spi.h)
  1818. CONFIG_SF_DEFAULT_SPEED in Hz
  1819. - SystemACE Support:
  1820. CONFIG_SYSTEMACE
  1821. Adding this option adds support for Xilinx SystemACE
  1822. chips attached via some sort of local bus. The address
  1823. of the chip must also be defined in the
  1824. CONFIG_SYS_SYSTEMACE_BASE macro. For example:
  1825. #define CONFIG_SYSTEMACE
  1826. #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
  1827. When SystemACE support is added, the "ace" device type
  1828. becomes available to the fat commands, i.e. fatls.
  1829. - TFTP Fixed UDP Port:
  1830. CONFIG_TFTP_PORT
  1831. If this is defined, the environment variable tftpsrcp
  1832. is used to supply the TFTP UDP source port value.
  1833. If tftpsrcp isn't defined, the normal pseudo-random port
  1834. number generator is used.
  1835. Also, the environment variable tftpdstp is used to supply
  1836. the TFTP UDP destination port value. If tftpdstp isn't
  1837. defined, the normal port 69 is used.
  1838. The purpose for tftpsrcp is to allow a TFTP server to
  1839. blindly start the TFTP transfer using the pre-configured
  1840. target IP address and UDP port. This has the effect of
  1841. "punching through" the (Windows XP) firewall, allowing
  1842. the remainder of the TFTP transfer to proceed normally.
  1843. A better solution is to properly configure the firewall,
  1844. but sometimes that is not allowed.
  1845. - Show boot progress:
  1846. CONFIG_SHOW_BOOT_PROGRESS
  1847. Defining this option allows to add some board-
  1848. specific code (calling a user-provided function
  1849. "show_boot_progress(int)") that enables you to show
  1850. the system's boot progress on some display (for
  1851. example, some LED's) on your board. At the moment,
  1852. the following checkpoints are implemented:
  1853. - Detailed boot stage timing
  1854. CONFIG_BOOTSTAGE
  1855. Define this option to get detailed timing of each stage
  1856. of the boot process.
  1857. CONFIG_BOOTSTAGE_USER_COUNT
  1858. This is the number of available user bootstage records.
  1859. Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
  1860. a new ID will be allocated from this stash. If you exceed
  1861. the limit, recording will stop.
  1862. CONFIG_BOOTSTAGE_REPORT
  1863. Define this to print a report before boot, similar to this:
  1864. Timer summary in microseconds:
  1865. Mark Elapsed Stage
  1866. 0 0 reset
  1867. 3,575,678 3,575,678 board_init_f start
  1868. 3,575,695 17 arch_cpu_init A9
  1869. 3,575,777 82 arch_cpu_init done
  1870. 3,659,598 83,821 board_init_r start
  1871. 3,910,375 250,777 main_loop
  1872. 29,916,167 26,005,792 bootm_start
  1873. 30,361,327 445,160 start_kernel
  1874. CONFIG_CMD_BOOTSTAGE
  1875. Add a 'bootstage' command which supports printing a report
  1876. and un/stashing of bootstage data.
  1877. CONFIG_BOOTSTAGE_FDT
  1878. Stash the bootstage information in the FDT. A root 'bootstage'
  1879. node is created with each bootstage id as a child. Each child
  1880. has a 'name' property and either 'mark' containing the
  1881. mark time in microsecond, or 'accum' containing the
  1882. accumulated time for that bootstage id in microseconds.
  1883. For example:
  1884. bootstage {
  1885. 154 {
  1886. name = "board_init_f";
  1887. mark = <3575678>;
  1888. };
  1889. 170 {
  1890. name = "lcd";
  1891. accum = <33482>;
  1892. };
  1893. };
  1894. Code in the Linux kernel can find this in /proc/devicetree.
  1895. Legacy uImage format:
  1896. Arg Where When
  1897. 1 common/cmd_bootm.c before attempting to boot an image
  1898. -1 common/cmd_bootm.c Image header has bad magic number
  1899. 2 common/cmd_bootm.c Image header has correct magic number
  1900. -2 common/cmd_bootm.c Image header has bad checksum
  1901. 3 common/cmd_bootm.c Image header has correct checksum
  1902. -3 common/cmd_bootm.c Image data has bad checksum
  1903. 4 common/cmd_bootm.c Image data has correct checksum
  1904. -4 common/cmd_bootm.c Image is for unsupported architecture
  1905. 5 common/cmd_bootm.c Architecture check OK
  1906. -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
  1907. 6 common/cmd_bootm.c Image Type check OK
  1908. -6 common/cmd_bootm.c gunzip uncompression error
  1909. -7 common/cmd_bootm.c Unimplemented compression type
  1910. 7 common/cmd_bootm.c Uncompression OK
  1911. 8 common/cmd_bootm.c No uncompress/copy overwrite error
  1912. -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
  1913. 9 common/image.c Start initial ramdisk verification
  1914. -10 common/image.c Ramdisk header has bad magic number
  1915. -11 common/image.c Ramdisk header has bad checksum
  1916. 10 common/image.c Ramdisk header is OK
  1917. -12 common/image.c Ramdisk data has bad checksum
  1918. 11 common/image.c Ramdisk data has correct checksum
  1919. 12 common/image.c Ramdisk verification complete, start loading
  1920. -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
  1921. 13 common/image.c Start multifile image verification
  1922. 14 common/image.c No initial ramdisk, no multifile, continue.
  1923. 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
  1924. -30 arch/powerpc/lib/board.c Fatal error, hang the system
  1925. -31 post/post.c POST test failed, detected by post_output_backlog()
  1926. -32 post/post.c POST test failed, detected by post_run_single()
  1927. 34 common/cmd_doc.c before loading a Image from a DOC device
  1928. -35 common/cmd_doc.c Bad usage of "doc" command
  1929. 35 common/cmd_doc.c correct usage of "doc" command
  1930. -36 common/cmd_doc.c No boot device
  1931. 36 common/cmd_doc.c correct boot device
  1932. -37 common/cmd_doc.c Unknown Chip ID on boot device
  1933. 37 common/cmd_doc.c correct chip ID found, device available
  1934. -38 common/cmd_doc.c Read Error on boot device
  1935. 38 common/cmd_doc.c reading Image header from DOC device OK
  1936. -39 common/cmd_doc.c Image header has bad magic number
  1937. 39 common/cmd_doc.c Image header has correct magic number
  1938. -40 common/cmd_doc.c Error reading Image from DOC device
  1939. 40 common/cmd_doc.c Image header has correct magic number
  1940. 41 common/cmd_ide.c before loading a Image from a IDE device
  1941. -42 common/cmd_ide.c Bad usage of "ide" command
  1942. 42 common/cmd_ide.c correct usage of "ide" command
  1943. -43 common/cmd_ide.c No boot device
  1944. 43 common/cmd_ide.c boot device found
  1945. -44 common/cmd_ide.c Device not available
  1946. 44 common/cmd_ide.c Device available
  1947. -45 common/cmd_ide.c wrong partition selected
  1948. 45 common/cmd_ide.c partition selected
  1949. -46 common/cmd_ide.c Unknown partition table
  1950. 46 common/cmd_ide.c valid partition table found
  1951. -47 common/cmd_ide.c Invalid partition type
  1952. 47 common/cmd_ide.c correct partition type
  1953. -48 common/cmd_ide.c Error reading Image Header on boot device
  1954. 48 common/cmd_ide.c reading Image Header from IDE device OK
  1955. -49 common/cmd_ide.c Image header has bad magic number
  1956. 49 common/cmd_ide.c Image header has correct magic number
  1957. -50 common/cmd_ide.c Image header has bad checksum
  1958. 50 common/cmd_ide.c Image header has correct checksum
  1959. -51 common/cmd_ide.c Error reading Image from IDE device
  1960. 51 common/cmd_ide.c reading Image from IDE device OK
  1961. 52 common/cmd_nand.c before loading a Image from a NAND device
  1962. -53 common/cmd_nand.c Bad usage of "nand" command
  1963. 53 common/cmd_nand.c correct usage of "nand" command
  1964. -54 common/cmd_nand.c No boot device
  1965. 54 common/cmd_nand.c boot device found
  1966. -55 common/cmd_nand.c Unknown Chip ID on boot device
  1967. 55 common/cmd_nand.c correct chip ID found, device available
  1968. -56 common/cmd_nand.c Error reading Image Header on boot device
  1969. 56 common/cmd_nand.c reading Image Header from NAND device OK
  1970. -57 common/cmd_nand.c Image header has bad magic number
  1971. 57 common/cmd_nand.c Image header has correct magic number
  1972. -58 common/cmd_nand.c Error reading Image from NAND device
  1973. 58 common/cmd_nand.c reading Image from NAND device OK
  1974. -60 common/env_common.c Environment has a bad CRC, using default
  1975. 64 net/eth.c starting with Ethernet configuration.
  1976. -64 net/eth.c no Ethernet found.
  1977. 65 net/eth.c Ethernet found.
  1978. -80 common/cmd_net.c usage wrong
  1979. 80 common/cmd_net.c before calling NetLoop()
  1980. -81 common/cmd_net.c some error in NetLoop() occurred
  1981. 81 common/cmd_net.c NetLoop() back without error
  1982. -82 common/cmd_net.c size == 0 (File with size 0 loaded)
  1983. 82 common/cmd_net.c trying automatic boot
  1984. 83 common/cmd_net.c running "source" command
  1985. -83 common/cmd_net.c some error in automatic boot or "source" command
  1986. 84 common/cmd_net.c end without errors
  1987. FIT uImage format:
  1988. Arg Where When
  1989. 100 common/cmd_bootm.c Kernel FIT Image has correct format
  1990. -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
  1991. 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
  1992. -101 common/cmd_bootm.c Can't get configuration for kernel subimage
  1993. 102 common/cmd_bootm.c Kernel unit name specified
  1994. -103 common/cmd_bootm.c Can't get kernel subimage node offset
  1995. 103 common/cmd_bootm.c Found configuration node
  1996. 104 common/cmd_bootm.c Got kernel subimage node offset
  1997. -104 common/cmd_bootm.c Kernel subimage hash verification failed
  1998. 105 common/cmd_bootm.c Kernel subimage hash verification OK
  1999. -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
  2000. 106 common/cmd_bootm.c Architecture check OK
  2001. -106 common/cmd_bootm.c Kernel subimage has wrong type
  2002. 107 common/cmd_bootm.c Kernel subimage type OK
  2003. -107 common/cmd_bootm.c Can't get kernel subimage data/size
  2004. 108 common/cmd_bootm.c Got kernel subimage data/size
  2005. -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
  2006. -109 common/cmd_bootm.c Can't get kernel subimage type
  2007. -110 common/cmd_bootm.c Can't get kernel subimage comp
  2008. -111 common/cmd_bootm.c Can't get kernel subimage os
  2009. -112 common/cmd_bootm.c Can't get kernel subimage load address
  2010. -113 common/cmd_bootm.c Image uncompress/copy overwrite error
  2011. 120 common/image.c Start initial ramdisk verification
  2012. -120 common/image.c Ramdisk FIT image has incorrect format
  2013. 121 common/image.c Ramdisk FIT image has correct format
  2014. 122 common/image.c No ramdisk subimage unit name, using configuration
  2015. -122 common/image.c Can't get configuration for ramdisk subimage
  2016. 123 common/image.c Ramdisk unit name specified
  2017. -124 common/image.c Can't get ramdisk subimage node offset
  2018. 125 common/image.c Got ramdisk subimage node offset
  2019. -125 common/image.c Ramdisk subimage hash verification failed
  2020. 126 common/image.c Ramdisk subimage hash verification OK
  2021. -126 common/image.c Ramdisk subimage for unsupported architecture
  2022. 127 common/image.c Architecture check OK
  2023. -127 common/image.c Can't get ramdisk subimage data/size
  2024. 128 common/image.c Got ramdisk subimage data/size
  2025. 129 common/image.c Can't get ramdisk load address
  2026. -129 common/image.c Got ramdisk load address
  2027. -130 common/cmd_doc.c Incorrect FIT image format
  2028. 131 common/cmd_doc.c FIT image format OK
  2029. -140 common/cmd_ide.c Incorrect FIT image format
  2030. 141 common/cmd_ide.c FIT image format OK
  2031. -150 common/cmd_nand.c Incorrect FIT image format
  2032. 151 common/cmd_nand.c FIT image format OK
  2033. - FIT image support:
  2034. CONFIG_FIT
  2035. Enable support for the FIT uImage format.
  2036. CONFIG_FIT_BEST_MATCH
  2037. When no configuration is explicitly selected, default to the
  2038. one whose fdt's compatibility field best matches that of
  2039. U-Boot itself. A match is considered "best" if it matches the
  2040. most specific compatibility entry of U-Boot's fdt's root node.
  2041. The order of entries in the configuration's fdt is ignored.
  2042. - Standalone program support:
  2043. CONFIG_STANDALONE_LOAD_ADDR
  2044. This option defines a board specific value for the
  2045. address where standalone program gets loaded, thus
  2046. overwriting the architecture dependent default
  2047. settings.
  2048. - Frame Buffer Address:
  2049. CONFIG_FB_ADDR
  2050. Define CONFIG_FB_ADDR if you want to use specific
  2051. address for frame buffer.
  2052. Then system will reserve the frame buffer address to
  2053. defined address instead of lcd_setmem (this function
  2054. grabs the memory for frame buffer by panel's size).
  2055. Please see board_init_f function.
  2056. - Automatic software updates via TFTP server
  2057. CONFIG_UPDATE_TFTP
  2058. CONFIG_UPDATE_TFTP_CNT_MAX
  2059. CONFIG_UPDATE_TFTP_MSEC_MAX
  2060. These options enable and control the auto-update feature;
  2061. for a more detailed description refer to doc/README.update.
  2062. - MTD Support (mtdparts command, UBI support)
  2063. CONFIG_MTD_DEVICE
  2064. Adds the MTD device infrastructure from the Linux kernel.
  2065. Needed for mtdparts command support.
  2066. CONFIG_MTD_PARTITIONS
  2067. Adds the MTD partitioning infrastructure from the Linux
  2068. kernel. Needed for UBI support.
  2069. - SPL framework
  2070. CONFIG_SPL
  2071. Enable building of SPL globally.
  2072. CONFIG_SPL_LDSCRIPT
  2073. LDSCRIPT for linking the SPL binary.
  2074. CONFIG_SPL_MAX_SIZE
  2075. Maximum binary size (text, data and rodata) of the SPL binary.
  2076. CONFIG_SPL_TEXT_BASE
  2077. TEXT_BASE for linking the SPL binary.
  2078. CONFIG_SPL_RELOC_TEXT_BASE
  2079. Address to relocate to. If unspecified, this is equal to
  2080. CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
  2081. CONFIG_SPL_BSS_START_ADDR
  2082. Link address for the BSS within the SPL binary.
  2083. CONFIG_SPL_BSS_MAX_SIZE
  2084. Maximum binary size of the BSS section of the SPL binary.
  2085. CONFIG_SPL_STACK
  2086. Adress of the start of the stack SPL will use
  2087. CONFIG_SPL_RELOC_STACK
  2088. Adress of the start of the stack SPL will use after
  2089. relocation. If unspecified, this is equal to
  2090. CONFIG_SPL_STACK.
  2091. CONFIG_SYS_SPL_MALLOC_START
  2092. Starting address of the malloc pool used in SPL.
  2093. CONFIG_SYS_SPL_MALLOC_SIZE
  2094. The size of the malloc pool used in SPL.
  2095. CONFIG_SPL_FRAMEWORK
  2096. Enable the SPL framework under common/. This framework
  2097. supports MMC, NAND and YMODEM loading of U-Boot and NAND
  2098. NAND loading of the Linux Kernel.
  2099. CONFIG_SPL_DISPLAY_PRINT
  2100. For ARM, enable an optional function to print more information
  2101. about the running system.
  2102. CONFIG_SPL_INIT_MINIMAL
  2103. Arch init code should be built for a very small image
  2104. CONFIG_SPL_LIBCOMMON_SUPPORT
  2105. Support for common/libcommon.o in SPL binary
  2106. CONFIG_SPL_LIBDISK_SUPPORT
  2107. Support for disk/libdisk.o in SPL binary
  2108. CONFIG_SPL_I2C_SUPPORT
  2109. Support for drivers/i2c/libi2c.o in SPL binary
  2110. CONFIG_SPL_GPIO_SUPPORT
  2111. Support for drivers/gpio/libgpio.o in SPL binary
  2112. CONFIG_SPL_MMC_SUPPORT
  2113. Support for drivers/mmc/libmmc.o in SPL binary
  2114. CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
  2115. CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
  2116. CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
  2117. Address, size and partition on the MMC to load U-Boot from
  2118. when the MMC is being used in raw mode.
  2119. CONFIG_SPL_FAT_SUPPORT
  2120. Support for fs/fat/libfat.o in SPL binary
  2121. CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
  2122. Filename to read to load U-Boot when reading from FAT
  2123. CONFIG_SPL_NAND_BASE
  2124. Include nand_base.c in the SPL. Requires
  2125. CONFIG_SPL_NAND_DRIVERS.
  2126. CONFIG_SPL_NAND_DRIVERS
  2127. SPL uses normal NAND drivers, not minimal drivers.
  2128. CONFIG_SPL_NAND_ECC
  2129. Include standard software ECC in the SPL
  2130. CONFIG_SPL_NAND_SIMPLE
  2131. Support for NAND boot using simple NAND drivers that
  2132. expose the cmd_ctrl() interface.
  2133. CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
  2134. CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
  2135. CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
  2136. CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
  2137. CONFIG_SYS_NAND_ECCBYTES
  2138. Defines the size and behavior of the NAND that SPL uses
  2139. to read U-Boot
  2140. CONFIG_SYS_NAND_U_BOOT_OFFS
  2141. Location in NAND to read U-Boot from
  2142. CONFIG_SYS_NAND_U_BOOT_DST
  2143. Location in memory to load U-Boot to
  2144. CONFIG_SYS_NAND_U_BOOT_SIZE
  2145. Size of image to load
  2146. CONFIG_SYS_NAND_U_BOOT_START
  2147. Entry point in loaded image to jump to
  2148. CONFIG_SYS_NAND_HW_ECC_OOBFIRST
  2149. Define this if you need to first read the OOB and then the
  2150. data. This is used for example on davinci plattforms.
  2151. CONFIG_SPL_OMAP3_ID_NAND
  2152. Support for an OMAP3-specific set of functions to return the
  2153. ID and MFR of the first attached NAND chip, if present.
  2154. CONFIG_SPL_SERIAL_SUPPORT
  2155. Support for drivers/serial/libserial.o in SPL binary
  2156. CONFIG_SPL_SPI_FLASH_SUPPORT
  2157. Support for drivers/mtd/spi/libspi_flash.o in SPL binary
  2158. CONFIG_SPL_SPI_SUPPORT
  2159. Support for drivers/spi/libspi.o in SPL binary
  2160. CONFIG_SPL_RAM_DEVICE
  2161. Support for running image already present in ram, in SPL binary
  2162. CONFIG_SPL_LIBGENERIC_SUPPORT
  2163. Support for lib/libgeneric.o in SPL binary
  2164. CONFIG_SPL_TARGET
  2165. Final target image containing SPL and payload. Some SPLs
  2166. use an arch-specific makefile fragment instead, for
  2167. example if more than one image needs to be produced.
  2168. Modem Support:
  2169. --------------
  2170. [so far only for SMDK2400 boards]
  2171. - Modem support enable:
  2172. CONFIG_MODEM_SUPPORT
  2173. - RTS/CTS Flow control enable:
  2174. CONFIG_HWFLOW
  2175. - Modem debug support:
  2176. CONFIG_MODEM_SUPPORT_DEBUG
  2177. Enables debugging stuff (char screen[1024], dbg())
  2178. for modem support. Useful only with BDI2000.
  2179. - Interrupt support (PPC):
  2180. There are common interrupt_init() and timer_interrupt()
  2181. for all PPC archs. interrupt_init() calls interrupt_init_cpu()
  2182. for CPU specific initialization. interrupt_init_cpu()
  2183. should set decrementer_count to appropriate value. If
  2184. CPU resets decrementer automatically after interrupt
  2185. (ppc4xx) it should set decrementer_count to zero.
  2186. timer_interrupt() calls timer_interrupt_cpu() for CPU
  2187. specific handling. If board has watchdog / status_led
  2188. / other_activity_monitor it works automatically from
  2189. general timer_interrupt().
  2190. - General:
  2191. In the target system modem support is enabled when a
  2192. specific key (key combination) is pressed during
  2193. power-on. Otherwise U-Boot will boot normally
  2194. (autoboot). The key_pressed() function is called from
  2195. board_init(). Currently key_pressed() is a dummy
  2196. function, returning 1 and thus enabling modem
  2197. initialization.
  2198. If there are no modem init strings in the
  2199. environment, U-Boot proceed to autoboot; the
  2200. previous output (banner, info printfs) will be
  2201. suppressed, though.
  2202. See also: doc/README.Modem
  2203. Board initialization settings:
  2204. ------------------------------
  2205. During Initialization u-boot calls a number of board specific functions
  2206. to allow the preparation of board specific prerequisites, e.g. pin setup
  2207. before drivers are initialized. To enable these callbacks the
  2208. following configuration macros have to be defined. Currently this is
  2209. architecture specific, so please check arch/your_architecture/lib/board.c
  2210. typically in board_init_f() and board_init_r().
  2211. - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
  2212. - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
  2213. - CONFIG_BOARD_LATE_INIT: Call board_late_init()
  2214. - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
  2215. Configuration Settings:
  2216. -----------------------
  2217. - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
  2218. undefine this when you're short of memory.
  2219. - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
  2220. width of the commands listed in the 'help' command output.
  2221. - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
  2222. prompt for user input.
  2223. - CONFIG_SYS_CBSIZE: Buffer size for input from the Console
  2224. - CONFIG_SYS_PBSIZE: Buffer size for Console output
  2225. - CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
  2226. - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
  2227. the application (usually a Linux kernel) when it is
  2228. booted
  2229. - CONFIG_SYS_BAUDRATE_TABLE:
  2230. List of legal baudrate settings for this board.
  2231. - CONFIG_SYS_CONSOLE_INFO_QUIET
  2232. Suppress display of console information at boot.
  2233. - CONFIG_SYS_CONSOLE_IS_IN_ENV
  2234. If the board specific function
  2235. extern int overwrite_console (void);
  2236. returns 1, the stdin, stderr and stdout are switched to the
  2237. serial port, else the settings in the environment are used.
  2238. - CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
  2239. Enable the call to overwrite_console().
  2240. - CONFIG_SYS_CONSOLE_ENV_OVERWRITE
  2241. Enable overwrite of previous console environment settings.
  2242. - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
  2243. Begin and End addresses of the area used by the
  2244. simple memory test.
  2245. - CONFIG_SYS_ALT_MEMTEST:
  2246. Enable an alternate, more extensive memory test.
  2247. - CONFIG_SYS_MEMTEST_SCRATCH:
  2248. Scratch address used by the alternate memory test
  2249. You only need to set this if address zero isn't writeable
  2250. - CONFIG_SYS_MEM_TOP_HIDE (PPC only):
  2251. If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
  2252. this specified memory area will get subtracted from the top
  2253. (end) of RAM and won't get "touched" at all by U-Boot. By
  2254. fixing up gd->ram_size the Linux kernel should gets passed
  2255. the now "corrected" memory size and won't touch it either.
  2256. This should work for arch/ppc and arch/powerpc. Only Linux
  2257. board ports in arch/powerpc with bootwrapper support that
  2258. recalculate the memory size from the SDRAM controller setup
  2259. will have to get fixed in Linux additionally.
  2260. This option can be used as a workaround for the 440EPx/GRx
  2261. CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
  2262. be touched.
  2263. WARNING: Please make sure that this value is a multiple of
  2264. the Linux page size (normally 4k). If this is not the case,
  2265. then the end address of the Linux memory will be located at a
  2266. non page size aligned address and this could cause major
  2267. problems.
  2268. - CONFIG_SYS_TFTP_LOADADDR:
  2269. Default load address for network file downloads
  2270. - CONFIG_SYS_LOADS_BAUD_CHANGE:
  2271. Enable temporary baudrate change while serial download
  2272. - CONFIG_SYS_SDRAM_BASE:
  2273. Physical start address of SDRAM. _Must_ be 0 here.
  2274. - CONFIG_SYS_MBIO_BASE:
  2275. Physical start address of Motherboard I/O (if using a
  2276. Cogent motherboard)
  2277. - CONFIG_SYS_FLASH_BASE:
  2278. Physical start address of Flash memory.
  2279. - CONFIG_SYS_MONITOR_BASE:
  2280. Physical start address of boot monitor code (set by
  2281. make config files to be same as the text base address
  2282. (CONFIG_SYS_TEXT_BASE) used when linking) - same as
  2283. CONFIG_SYS_FLASH_BASE when booting from flash.
  2284. - CONFIG_SYS_MONITOR_LEN:
  2285. Size of memory reserved for monitor code, used to
  2286. determine _at_compile_time_ (!) if the environment is
  2287. embedded within the U-Boot image, or in a separate
  2288. flash sector.
  2289. - CONFIG_SYS_MALLOC_LEN:
  2290. Size of DRAM reserved for malloc() use.
  2291. - CONFIG_SYS_BOOTM_LEN:
  2292. Normally compressed uImages are limited to an
  2293. uncompressed size of 8 MBytes. If this is not enough,
  2294. you can define CONFIG_SYS_BOOTM_LEN in your board config file
  2295. to adjust this setting to your needs.
  2296. - CONFIG_SYS_BOOTMAPSZ:
  2297. Maximum size of memory mapped by the startup code of
  2298. the Linux kernel; all data that must be processed by
  2299. the Linux kernel (bd_info, boot arguments, FDT blob if
  2300. used) must be put below this limit, unless "bootm_low"
  2301. enviroment variable is defined and non-zero. In such case
  2302. all data for the Linux kernel must be between "bootm_low"
  2303. and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
  2304. variable "bootm_mapsize" will override the value of
  2305. CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
  2306. then the value in "bootm_size" will be used instead.
  2307. - CONFIG_SYS_BOOT_RAMDISK_HIGH:
  2308. Enable initrd_high functionality. If defined then the
  2309. initrd_high feature is enabled and the bootm ramdisk subcommand
  2310. is enabled.
  2311. - CONFIG_SYS_BOOT_GET_CMDLINE:
  2312. Enables allocating and saving kernel cmdline in space between
  2313. "bootm_low" and "bootm_low" + BOOTMAPSZ.
  2314. - CONFIG_SYS_BOOT_GET_KBD:
  2315. Enables allocating and saving a kernel copy of the bd_info in
  2316. space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
  2317. - CONFIG_SYS_MAX_FLASH_BANKS:
  2318. Max number of Flash memory banks
  2319. - CONFIG_SYS_MAX_FLASH_SECT:
  2320. Max number of sectors on a Flash chip
  2321. - CONFIG_SYS_FLASH_ERASE_TOUT:
  2322. Timeout for Flash erase operations (in ms)
  2323. - CONFIG_SYS_FLASH_WRITE_TOUT:
  2324. Timeout for Flash write operations (in ms)
  2325. - CONFIG_SYS_FLASH_LOCK_TOUT
  2326. Timeout for Flash set sector lock bit operation (in ms)
  2327. - CONFIG_SYS_FLASH_UNLOCK_TOUT
  2328. Timeout for Flash clear lock bits operation (in ms)
  2329. - CONFIG_SYS_FLASH_PROTECTION
  2330. If defined, hardware flash sectors protection is used
  2331. instead of U-Boot software protection.
  2332. - CONFIG_SYS_DIRECT_FLASH_TFTP:
  2333. Enable TFTP transfers directly to flash memory;
  2334. without this option such a download has to be
  2335. performed in two steps: (1) download to RAM, and (2)
  2336. copy from RAM to flash.
  2337. The two-step approach is usually more reliable, since
  2338. you can check if the download worked before you erase
  2339. the flash, but in some situations (when system RAM is
  2340. too limited to allow for a temporary copy of the
  2341. downloaded image) this option may be very useful.
  2342. - CONFIG_SYS_FLASH_CFI:
  2343. Define if the flash driver uses extra elements in the
  2344. common flash structure for storing flash geometry.
  2345. - CONFIG_FLASH_CFI_DRIVER
  2346. This option also enables the building of the cfi_flash driver
  2347. in the drivers directory
  2348. - CONFIG_FLASH_CFI_MTD
  2349. This option enables the building of the cfi_mtd driver
  2350. in the drivers directory. The driver exports CFI flash
  2351. to the MTD layer.
  2352. - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
  2353. Use buffered writes to flash.
  2354. - CONFIG_FLASH_SPANSION_S29WS_N
  2355. s29ws-n MirrorBit flash has non-standard addresses for buffered
  2356. write commands.
  2357. - CONFIG_SYS_FLASH_QUIET_TEST
  2358. If this option is defined, the common CFI flash doesn't
  2359. print it's warning upon not recognized FLASH banks. This
  2360. is useful, if some of the configured banks are only
  2361. optionally available.
  2362. - CONFIG_FLASH_SHOW_PROGRESS
  2363. If defined (must be an integer), print out countdown
  2364. digits and dots. Recommended value: 45 (9..1) for 80
  2365. column displays, 15 (3..1) for 40 column displays.
  2366. - CONFIG_SYS_RX_ETH_BUFFER:
  2367. Defines the number of Ethernet receive buffers. On some
  2368. Ethernet controllers it is recommended to set this value
  2369. to 8 or even higher (EEPRO100 or 405 EMAC), since all
  2370. buffers can be full shortly after enabling the interface
  2371. on high Ethernet traffic.
  2372. Defaults to 4 if not defined.
  2373. - CONFIG_ENV_MAX_ENTRIES
  2374. Maximum number of entries in the hash table that is used
  2375. internally to store the environment settings. The default
  2376. setting is supposed to be generous and should work in most
  2377. cases. This setting can be used to tune behaviour; see
  2378. lib/hashtable.c for details.
  2379. The following definitions that deal with the placement and management
  2380. of environment data (variable area); in general, we support the
  2381. following configurations:
  2382. - CONFIG_BUILD_ENVCRC:
  2383. Builds up envcrc with the target environment so that external utils
  2384. may easily extract it and embed it in final U-Boot images.
  2385. - CONFIG_ENV_IS_IN_FLASH:
  2386. Define this if the environment is in flash memory.
  2387. a) The environment occupies one whole flash sector, which is
  2388. "embedded" in the text segment with the U-Boot code. This
  2389. happens usually with "bottom boot sector" or "top boot
  2390. sector" type flash chips, which have several smaller
  2391. sectors at the start or the end. For instance, such a
  2392. layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
  2393. such a case you would place the environment in one of the
  2394. 4 kB sectors - with U-Boot code before and after it. With
  2395. "top boot sector" type flash chips, you would put the
  2396. environment in one of the last sectors, leaving a gap
  2397. between U-Boot and the environment.
  2398. - CONFIG_ENV_OFFSET:
  2399. Offset of environment data (variable area) to the
  2400. beginning of flash memory; for instance, with bottom boot
  2401. type flash chips the second sector can be used: the offset
  2402. for this sector is given here.
  2403. CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
  2404. - CONFIG_ENV_ADDR:
  2405. This is just another way to specify the start address of
  2406. the flash sector containing the environment (instead of
  2407. CONFIG_ENV_OFFSET).
  2408. - CONFIG_ENV_SECT_SIZE:
  2409. Size of the sector containing the environment.
  2410. b) Sometimes flash chips have few, equal sized, BIG sectors.
  2411. In such a case you don't want to spend a whole sector for
  2412. the environment.
  2413. - CONFIG_ENV_SIZE:
  2414. If you use this in combination with CONFIG_ENV_IS_IN_FLASH
  2415. and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
  2416. of this flash sector for the environment. This saves
  2417. memory for the RAM copy of the environment.
  2418. It may also save flash memory if you decide to use this
  2419. when your environment is "embedded" within U-Boot code,
  2420. since then the remainder of the flash sector could be used
  2421. for U-Boot code. It should be pointed out that this is
  2422. STRONGLY DISCOURAGED from a robustness point of view:
  2423. updating the environment in flash makes it always
  2424. necessary to erase the WHOLE sector. If something goes
  2425. wrong before the contents has been restored from a copy in
  2426. RAM, your target system will be dead.
  2427. - CONFIG_ENV_ADDR_REDUND
  2428. CONFIG_ENV_SIZE_REDUND
  2429. These settings describe a second storage area used to hold
  2430. a redundant copy of the environment data, so that there is
  2431. a valid backup copy in case there is a power failure during
  2432. a "saveenv" operation.
  2433. BE CAREFUL! Any changes to the flash layout, and some changes to the
  2434. source code will make it necessary to adapt <board>/u-boot.lds*
  2435. accordingly!
  2436. - CONFIG_ENV_IS_IN_NVRAM:
  2437. Define this if you have some non-volatile memory device
  2438. (NVRAM, battery buffered SRAM) which you want to use for the
  2439. environment.
  2440. - CONFIG_ENV_ADDR:
  2441. - CONFIG_ENV_SIZE:
  2442. These two #defines are used to determine the memory area you
  2443. want to use for environment. It is assumed that this memory
  2444. can just be read and written to, without any special
  2445. provision.
  2446. BE CAREFUL! The first access to the environment happens quite early
  2447. in U-Boot initalization (when we try to get the setting of for the
  2448. console baudrate). You *MUST* have mapped your NVRAM area then, or
  2449. U-Boot will hang.
  2450. Please note that even with NVRAM we still use a copy of the
  2451. environment in RAM: we could work on NVRAM directly, but we want to
  2452. keep settings there always unmodified except somebody uses "saveenv"
  2453. to save the current settings.
  2454. - CONFIG_ENV_IS_IN_EEPROM:
  2455. Use this if you have an EEPROM or similar serial access
  2456. device and a driver for it.
  2457. - CONFIG_ENV_OFFSET:
  2458. - CONFIG_ENV_SIZE:
  2459. These two #defines specify the offset and size of the
  2460. environment area within the total memory of your EEPROM.
  2461. - CONFIG_SYS_I2C_EEPROM_ADDR:
  2462. If defined, specified the chip address of the EEPROM device.
  2463. The default address is zero.
  2464. - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
  2465. If defined, the number of bits used to address bytes in a
  2466. single page in the EEPROM device. A 64 byte page, for example
  2467. would require six bits.
  2468. - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
  2469. If defined, the number of milliseconds to delay between
  2470. page writes. The default is zero milliseconds.
  2471. - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
  2472. The length in bytes of the EEPROM memory array address. Note
  2473. that this is NOT the chip address length!
  2474. - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
  2475. EEPROM chips that implement "address overflow" are ones
  2476. like Catalyst 24WC04/08/16 which has 9/10/11 bits of
  2477. address and the extra bits end up in the "chip address" bit
  2478. slots. This makes a 24WC08 (1Kbyte) chip look like four 256
  2479. byte chips.
  2480. Note that we consider the length of the address field to
  2481. still be one byte because the extra address bits are hidden
  2482. in the chip address.
  2483. - CONFIG_SYS_EEPROM_SIZE:
  2484. The size in bytes of the EEPROM device.
  2485. - CONFIG_ENV_EEPROM_IS_ON_I2C
  2486. define this, if you have I2C and SPI activated, and your
  2487. EEPROM, which holds the environment, is on the I2C bus.
  2488. - CONFIG_I2C_ENV_EEPROM_BUS
  2489. if you have an Environment on an EEPROM reached over
  2490. I2C muxes, you can define here, how to reach this
  2491. EEPROM. For example:
  2492. #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
  2493. EEPROM which holds the environment, is reached over
  2494. a pca9547 i2c mux with address 0x70, channel 3.
  2495. - CONFIG_ENV_IS_IN_DATAFLASH:
  2496. Define this if you have a DataFlash memory device which you
  2497. want to use for the environment.
  2498. - CONFIG_ENV_OFFSET:
  2499. - CONFIG_ENV_ADDR:
  2500. - CONFIG_ENV_SIZE:
  2501. These three #defines specify the offset and size of the
  2502. environment area within the total memory of your DataFlash placed
  2503. at the specified address.
  2504. - CONFIG_ENV_IS_IN_REMOTE:
  2505. Define this if you have a remote memory space which you
  2506. want to use for the local device's environment.
  2507. - CONFIG_ENV_ADDR:
  2508. - CONFIG_ENV_SIZE:
  2509. These two #defines specify the address and size of the
  2510. environment area within the remote memory space. The
  2511. local device can get the environment from remote memory
  2512. space by SRIO or PCIE links.
  2513. BE CAREFUL! For some special cases, the local device can not use
  2514. "saveenv" command. For example, the local device will get the
  2515. environment stored in a remote NOR flash by SRIO or PCIE link,
  2516. but it can not erase, write this NOR flash by SRIO or PCIE interface.
  2517. - CONFIG_ENV_IS_IN_NAND:
  2518. Define this if you have a NAND device which you want to use
  2519. for the environment.
  2520. - CONFIG_ENV_OFFSET:
  2521. - CONFIG_ENV_SIZE:
  2522. These two #defines specify the offset and size of the environment
  2523. area within the first NAND device. CONFIG_ENV_OFFSET must be
  2524. aligned to an erase block boundary.
  2525. - CONFIG_ENV_OFFSET_REDUND (optional):
  2526. This setting describes a second storage area of CONFIG_ENV_SIZE
  2527. size used to hold a redundant copy of the environment data, so
  2528. that there is a valid backup copy in case there is a power failure
  2529. during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
  2530. aligned to an erase block boundary.
  2531. - CONFIG_ENV_RANGE (optional):
  2532. Specifies the length of the region in which the environment
  2533. can be written. This should be a multiple of the NAND device's
  2534. block size. Specifying a range with more erase blocks than
  2535. are needed to hold CONFIG_ENV_SIZE allows bad blocks within
  2536. the range to be avoided.
  2537. - CONFIG_ENV_OFFSET_OOB (optional):
  2538. Enables support for dynamically retrieving the offset of the
  2539. environment from block zero's out-of-band data. The
  2540. "nand env.oob" command can be used to record this offset.
  2541. Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
  2542. using CONFIG_ENV_OFFSET_OOB.
  2543. - CONFIG_NAND_ENV_DST
  2544. Defines address in RAM to which the nand_spl code should copy the
  2545. environment. If redundant environment is used, it will be copied to
  2546. CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
  2547. - CONFIG_SYS_SPI_INIT_OFFSET
  2548. Defines offset to the initial SPI buffer area in DPRAM. The
  2549. area is used at an early stage (ROM part) if the environment
  2550. is configured to reside in the SPI EEPROM: We need a 520 byte
  2551. scratch DPRAM area. It is used between the two initialization
  2552. calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
  2553. to be a good choice since it makes it far enough from the
  2554. start of the data area as well as from the stack pointer.
  2555. Please note that the environment is read-only until the monitor
  2556. has been relocated to RAM and a RAM copy of the environment has been
  2557. created; also, when using EEPROM you will have to use getenv_f()
  2558. until then to read environment variables.
  2559. The environment is protected by a CRC32 checksum. Before the monitor
  2560. is relocated into RAM, as a result of a bad CRC you will be working
  2561. with the compiled-in default environment - *silently*!!! [This is
  2562. necessary, because the first environment variable we need is the
  2563. "baudrate" setting for the console - if we have a bad CRC, we don't
  2564. have any device yet where we could complain.]
  2565. Note: once the monitor has been relocated, then it will complain if
  2566. the default environment is used; a new CRC is computed as soon as you
  2567. use the "saveenv" command to store a valid environment.
  2568. - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
  2569. Echo the inverted Ethernet link state to the fault LED.
  2570. Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
  2571. also needs to be defined.
  2572. - CONFIG_SYS_FAULT_MII_ADDR:
  2573. MII address of the PHY to check for the Ethernet link state.
  2574. - CONFIG_NS16550_MIN_FUNCTIONS:
  2575. Define this if you desire to only have use of the NS16550_init
  2576. and NS16550_putc functions for the serial driver located at
  2577. drivers/serial/ns16550.c. This option is useful for saving
  2578. space for already greatly restricted images, including but not
  2579. limited to NAND_SPL configurations.
  2580. Low Level (hardware related) configuration options:
  2581. ---------------------------------------------------
  2582. - CONFIG_SYS_CACHELINE_SIZE:
  2583. Cache Line Size of the CPU.
  2584. - CONFIG_SYS_DEFAULT_IMMR:
  2585. Default address of the IMMR after system reset.
  2586. Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
  2587. and RPXsuper) to be able to adjust the position of
  2588. the IMMR register after a reset.
  2589. - CONFIG_SYS_CCSRBAR_DEFAULT:
  2590. Default (power-on reset) physical address of CCSR on Freescale
  2591. PowerPC SOCs.
  2592. - CONFIG_SYS_CCSRBAR:
  2593. Virtual address of CCSR. On a 32-bit build, this is typically
  2594. the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
  2595. CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
  2596. for cross-platform code that uses that macro instead.
  2597. - CONFIG_SYS_CCSRBAR_PHYS:
  2598. Physical address of CCSR. CCSR can be relocated to a new
  2599. physical address, if desired. In this case, this macro should
  2600. be set to that address. Otherwise, it should be set to the
  2601. same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
  2602. is typically relocated on 36-bit builds. It is recommended
  2603. that this macro be defined via the _HIGH and _LOW macros:
  2604. #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
  2605. * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
  2606. - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
  2607. Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
  2608. either 0 (32-bit build) or 0xF (36-bit build). This macro is
  2609. used in assembly code, so it must not contain typecasts or
  2610. integer size suffixes (e.g. "ULL").
  2611. - CONFIG_SYS_CCSRBAR_PHYS_LOW:
  2612. Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
  2613. used in assembly code, so it must not contain typecasts or
  2614. integer size suffixes (e.g. "ULL").
  2615. - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
  2616. If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
  2617. forced to a value that ensures that CCSR is not relocated.
  2618. - Floppy Disk Support:
  2619. CONFIG_SYS_FDC_DRIVE_NUMBER
  2620. the default drive number (default value 0)
  2621. CONFIG_SYS_ISA_IO_STRIDE
  2622. defines the spacing between FDC chipset registers
  2623. (default value 1)
  2624. CONFIG_SYS_ISA_IO_OFFSET
  2625. defines the offset of register from address. It
  2626. depends on which part of the data bus is connected to
  2627. the FDC chipset. (default value 0)
  2628. If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
  2629. CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
  2630. default value.
  2631. if CONFIG_SYS_FDC_HW_INIT is defined, then the function
  2632. fdc_hw_init() is called at the beginning of the FDC
  2633. setup. fdc_hw_init() must be provided by the board
  2634. source code. It is used to make hardware dependant
  2635. initializations.
  2636. - CONFIG_IDE_AHB:
  2637. Most IDE controllers were designed to be connected with PCI
  2638. interface. Only few of them were designed for AHB interface.
  2639. When software is doing ATA command and data transfer to
  2640. IDE devices through IDE-AHB controller, some additional
  2641. registers accessing to these kind of IDE-AHB controller
  2642. is requierd.
  2643. - CONFIG_SYS_IMMR: Physical address of the Internal Memory.
  2644. DO NOT CHANGE unless you know exactly what you're
  2645. doing! (11-4) [MPC8xx/82xx systems only]
  2646. - CONFIG_SYS_INIT_RAM_ADDR:
  2647. Start address of memory area that can be used for
  2648. initial data and stack; please note that this must be
  2649. writable memory that is working WITHOUT special
  2650. initialization, i. e. you CANNOT use normal RAM which
  2651. will become available only after programming the
  2652. memory controller and running certain initialization
  2653. sequences.
  2654. U-Boot uses the following memory types:
  2655. - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
  2656. - MPC824X: data cache
  2657. - PPC4xx: data cache
  2658. - CONFIG_SYS_GBL_DATA_OFFSET:
  2659. Offset of the initial data structure in the memory
  2660. area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
  2661. CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
  2662. data is located at the end of the available space
  2663. (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
  2664. CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
  2665. below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
  2666. CONFIG_SYS_GBL_DATA_OFFSET) downward.
  2667. Note:
  2668. On the MPC824X (or other systems that use the data
  2669. cache for initial memory) the address chosen for
  2670. CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
  2671. point to an otherwise UNUSED address space between
  2672. the top of RAM and the start of the PCI space.
  2673. - CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
  2674. - CONFIG_SYS_SYPCR: System Protection Control (11-9)
  2675. - CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
  2676. - CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
  2677. - CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
  2678. - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
  2679. - CONFIG_SYS_OR_TIMING_SDRAM:
  2680. SDRAM timing
  2681. - CONFIG_SYS_MAMR_PTA:
  2682. periodic timer for refresh
  2683. - CONFIG_SYS_DER: Debug Event Register (37-47)
  2684. - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
  2685. CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
  2686. CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
  2687. CONFIG_SYS_BR1_PRELIM:
  2688. Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
  2689. - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
  2690. CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
  2691. CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
  2692. Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
  2693. - CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
  2694. CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
  2695. Machine Mode Register and Memory Periodic Timer
  2696. Prescaler definitions (SDRAM timing)
  2697. - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
  2698. enable I2C microcode relocation patch (MPC8xx);
  2699. define relocation offset in DPRAM [DSP2]
  2700. - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
  2701. enable SMC microcode relocation patch (MPC8xx);
  2702. define relocation offset in DPRAM [SMC1]
  2703. - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
  2704. enable SPI microcode relocation patch (MPC8xx);
  2705. define relocation offset in DPRAM [SCC4]
  2706. - CONFIG_SYS_USE_OSCCLK:
  2707. Use OSCM clock mode on MBX8xx board. Be careful,
  2708. wrong setting might damage your board. Read
  2709. doc/README.MBX before setting this variable!
  2710. - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
  2711. Offset of the bootmode word in DPRAM used by post
  2712. (Power On Self Tests). This definition overrides
  2713. #define'd default value in commproc.h resp.
  2714. cpm_8260.h.
  2715. - CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
  2716. CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
  2717. CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
  2718. CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
  2719. CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
  2720. CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
  2721. CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
  2722. CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
  2723. Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
  2724. - CONFIG_PCI_DISABLE_PCIE:
  2725. Disable PCI-Express on systems where it is supported but not
  2726. required.
  2727. - CONFIG_PCI_ENUM_ONLY
  2728. Only scan through and get the devices on the busses.
  2729. Don't do any setup work, presumably because someone or
  2730. something has already done it, and we don't need to do it
  2731. a second time. Useful for platforms that are pre-booted
  2732. by coreboot or similar.
  2733. - CONFIG_SYS_SRIO:
  2734. Chip has SRIO or not
  2735. - CONFIG_SRIO1:
  2736. Board has SRIO 1 port available
  2737. - CONFIG_SRIO2:
  2738. Board has SRIO 2 port available
  2739. - CONFIG_SYS_SRIOn_MEM_VIRT:
  2740. Virtual Address of SRIO port 'n' memory region
  2741. - CONFIG_SYS_SRIOn_MEM_PHYS:
  2742. Physical Address of SRIO port 'n' memory region
  2743. - CONFIG_SYS_SRIOn_MEM_SIZE:
  2744. Size of SRIO port 'n' memory region
  2745. - CONFIG_SYS_NDFC_16
  2746. Defined to tell the NDFC that the NAND chip is using a
  2747. 16 bit bus.
  2748. - CONFIG_SYS_NDFC_EBC0_CFG
  2749. Sets the EBC0_CFG register for the NDFC. If not defined
  2750. a default value will be used.
  2751. - CONFIG_SPD_EEPROM
  2752. Get DDR timing information from an I2C EEPROM. Common
  2753. with pluggable memory modules such as SODIMMs
  2754. SPD_EEPROM_ADDRESS
  2755. I2C address of the SPD EEPROM
  2756. - CONFIG_SYS_SPD_BUS_NUM
  2757. If SPD EEPROM is on an I2C bus other than the first
  2758. one, specify here. Note that the value must resolve
  2759. to something your driver can deal with.
  2760. - CONFIG_SYS_DDR_RAW_TIMING
  2761. Get DDR timing information from other than SPD. Common with
  2762. soldered DDR chips onboard without SPD. DDR raw timing
  2763. parameters are extracted from datasheet and hard-coded into
  2764. header files or board specific files.
  2765. - CONFIG_FSL_DDR_INTERACTIVE
  2766. Enable interactive DDR debugging. See doc/README.fsl-ddr.
  2767. - CONFIG_SYS_83XX_DDR_USES_CS0
  2768. Only for 83xx systems. If specified, then DDR should
  2769. be configured using CS0 and CS1 instead of CS2 and CS3.
  2770. - CONFIG_ETHER_ON_FEC[12]
  2771. Define to enable FEC[12] on a 8xx series processor.
  2772. - CONFIG_FEC[12]_PHY
  2773. Define to the hardcoded PHY address which corresponds
  2774. to the given FEC; i. e.
  2775. #define CONFIG_FEC1_PHY 4
  2776. means that the PHY with address 4 is connected to FEC1
  2777. When set to -1, means to probe for first available.
  2778. - CONFIG_FEC[12]_PHY_NORXERR
  2779. The PHY does not have a RXERR line (RMII only).
  2780. (so program the FEC to ignore it).
  2781. - CONFIG_RMII
  2782. Enable RMII mode for all FECs.
  2783. Note that this is a global option, we can't
  2784. have one FEC in standard MII mode and another in RMII mode.
  2785. - CONFIG_CRC32_VERIFY
  2786. Add a verify option to the crc32 command.
  2787. The syntax is:
  2788. => crc32 -v <address> <count> <crc32>
  2789. Where address/count indicate a memory area
  2790. and crc32 is the correct crc32 which the
  2791. area should have.
  2792. - CONFIG_LOOPW
  2793. Add the "loopw" memory command. This only takes effect if
  2794. the memory commands are activated globally (CONFIG_CMD_MEM).
  2795. - CONFIG_MX_CYCLIC
  2796. Add the "mdc" and "mwc" memory commands. These are cyclic
  2797. "md/mw" commands.
  2798. Examples:
  2799. => mdc.b 10 4 500
  2800. This command will print 4 bytes (10,11,12,13) each 500 ms.
  2801. => mwc.l 100 12345678 10
  2802. This command will write 12345678 to address 100 all 10 ms.
  2803. This only takes effect if the memory commands are activated
  2804. globally (CONFIG_CMD_MEM).
  2805. - CONFIG_SKIP_LOWLEVEL_INIT
  2806. [ARM, NDS32, MIPS only] If this variable is defined, then certain
  2807. low level initializations (like setting up the memory
  2808. controller) are omitted and/or U-Boot does not
  2809. relocate itself into RAM.
  2810. Normally this variable MUST NOT be defined. The only
  2811. exception is when U-Boot is loaded (to RAM) by some
  2812. other boot loader or by a debugger which performs
  2813. these initializations itself.
  2814. - CONFIG_SPL_BUILD
  2815. Modifies the behaviour of start.S when compiling a loader
  2816. that is executed before the actual U-Boot. E.g. when
  2817. compiling a NAND SPL.
  2818. - CONFIG_USE_ARCH_MEMCPY
  2819. CONFIG_USE_ARCH_MEMSET
  2820. If these options are used a optimized version of memcpy/memset will
  2821. be used if available. These functions may be faster under some
  2822. conditions but may increase the binary size.
  2823. - CONFIG_X86_NO_RESET_VECTOR
  2824. If defined, the x86 reset vector code is excluded. You will need
  2825. to do this when U-Boot is running from Coreboot.
  2826. - CONFIG_X86_NO_REAL_MODE
  2827. If defined, x86 real mode code is omitted. This assumes a
  2828. 32-bit environment where such code is not needed. You will
  2829. need to do this when U-Boot is running from Coreboot.
  2830. Freescale QE/FMAN Firmware Support:
  2831. -----------------------------------
  2832. The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
  2833. loading of "firmware", which is encoded in the QE firmware binary format.
  2834. This firmware often needs to be loaded during U-Boot booting, so macros
  2835. are used to identify the storage device (NOR flash, SPI, etc) and the address
  2836. within that device.
  2837. - CONFIG_SYS_QE_FMAN_FW_ADDR
  2838. The address in the storage device where the firmware is located. The
  2839. meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
  2840. is also specified.
  2841. - CONFIG_SYS_QE_FMAN_FW_LENGTH
  2842. The maximum possible size of the firmware. The firmware binary format
  2843. has a field that specifies the actual size of the firmware, but it
  2844. might not be possible to read any part of the firmware unless some
  2845. local storage is allocated to hold the entire firmware first.
  2846. - CONFIG_SYS_QE_FMAN_FW_IN_NOR
  2847. Specifies that QE/FMAN firmware is located in NOR flash, mapped as
  2848. normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
  2849. virtual address in NOR flash.
  2850. - CONFIG_SYS_QE_FMAN_FW_IN_NAND
  2851. Specifies that QE/FMAN firmware is located in NAND flash.
  2852. CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
  2853. - CONFIG_SYS_QE_FMAN_FW_IN_MMC
  2854. Specifies that QE/FMAN firmware is located on the primary SD/MMC
  2855. device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
  2856. - CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
  2857. Specifies that QE/FMAN firmware is located on the primary SPI
  2858. device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
  2859. - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
  2860. Specifies that QE/FMAN firmware is located in the remote (master)
  2861. memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
  2862. can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
  2863. window->master inbound window->master LAW->the ucode address in
  2864. master's memory space.
  2865. Building the Software:
  2866. ======================
  2867. Building U-Boot has been tested in several native build environments
  2868. and in many different cross environments. Of course we cannot support
  2869. all possibly existing versions of cross development tools in all
  2870. (potentially obsolete) versions. In case of tool chain problems we
  2871. recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
  2872. which is extensively used to build and test U-Boot.
  2873. If you are not using a native environment, it is assumed that you
  2874. have GNU cross compiling tools available in your path. In this case,
  2875. you must set the environment variable CROSS_COMPILE in your shell.
  2876. Note that no changes to the Makefile or any other source files are
  2877. necessary. For example using the ELDK on a 4xx CPU, please enter:
  2878. $ CROSS_COMPILE=ppc_4xx-
  2879. $ export CROSS_COMPILE
  2880. Note: If you wish to generate Windows versions of the utilities in
  2881. the tools directory you can use the MinGW toolchain
  2882. (http://www.mingw.org). Set your HOST tools to the MinGW
  2883. toolchain and execute 'make tools'. For example:
  2884. $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
  2885. Binaries such as tools/mkimage.exe will be created which can
  2886. be executed on computers running Windows.
  2887. U-Boot is intended to be simple to build. After installing the
  2888. sources you must configure U-Boot for one specific board type. This
  2889. is done by typing:
  2890. make NAME_config
  2891. where "NAME_config" is the name of one of the existing configu-
  2892. rations; see boards.cfg for supported names.
  2893. Note: for some board special configuration names may exist; check if
  2894. additional information is available from the board vendor; for
  2895. instance, the TQM823L systems are available without (standard)
  2896. or with LCD support. You can select such additional "features"
  2897. when choosing the configuration, i. e.
  2898. make TQM823L_config
  2899. - will configure for a plain TQM823L, i. e. no LCD support
  2900. make TQM823L_LCD_config
  2901. - will configure for a TQM823L with U-Boot console on LCD
  2902. etc.
  2903. Finally, type "make all", and you should get some working U-Boot
  2904. images ready for download to / installation on your system:
  2905. - "u-boot.bin" is a raw binary image
  2906. - "u-boot" is an image in ELF binary format
  2907. - "u-boot.srec" is in Motorola S-Record format
  2908. By default the build is performed locally and the objects are saved
  2909. in the source directory. One of the two methods can be used to change
  2910. this behavior and build U-Boot to some external directory:
  2911. 1. Add O= to the make command line invocations:
  2912. make O=/tmp/build distclean
  2913. make O=/tmp/build NAME_config
  2914. make O=/tmp/build all
  2915. 2. Set environment variable BUILD_DIR to point to the desired location:
  2916. export BUILD_DIR=/tmp/build
  2917. make distclean
  2918. make NAME_config
  2919. make all
  2920. Note that the command line "O=" setting overrides the BUILD_DIR environment
  2921. variable.
  2922. Please be aware that the Makefiles assume you are using GNU make, so
  2923. for instance on NetBSD you might need to use "gmake" instead of
  2924. native "make".
  2925. If the system board that you have is not listed, then you will need
  2926. to port U-Boot to your hardware platform. To do this, follow these
  2927. steps:
  2928. 1. Add a new configuration option for your board to the toplevel
  2929. "boards.cfg" file, using the existing entries as examples.
  2930. Follow the instructions there to keep the boards in order.
  2931. 2. Create a new directory to hold your board specific code. Add any
  2932. files you need. In your board directory, you will need at least
  2933. the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
  2934. 3. Create a new configuration file "include/configs/<board>.h" for
  2935. your board
  2936. 3. If you're porting U-Boot to a new CPU, then also create a new
  2937. directory to hold your CPU specific code. Add any files you need.
  2938. 4. Run "make <board>_config" with your new name.
  2939. 5. Type "make", and you should get a working "u-boot.srec" file
  2940. to be installed on your target system.
  2941. 6. Debug and solve any problems that might arise.
  2942. [Of course, this last step is much harder than it sounds.]
  2943. Testing of U-Boot Modifications, Ports to New Hardware, etc.:
  2944. ==============================================================
  2945. If you have modified U-Boot sources (for instance added a new board
  2946. or support for new devices, a new CPU, etc.) you are expected to
  2947. provide feedback to the other developers. The feedback normally takes
  2948. the form of a "patch", i. e. a context diff against a certain (latest
  2949. official or latest in the git repository) version of U-Boot sources.
  2950. But before you submit such a patch, please verify that your modifi-
  2951. cation did not break existing code. At least make sure that *ALL* of
  2952. the supported boards compile WITHOUT ANY compiler warnings. To do so,
  2953. just run the "MAKEALL" script, which will configure and build U-Boot
  2954. for ALL supported system. Be warned, this will take a while. You can
  2955. select which (cross) compiler to use by passing a `CROSS_COMPILE'
  2956. environment variable to the script, i. e. to use the ELDK cross tools
  2957. you can type
  2958. CROSS_COMPILE=ppc_8xx- MAKEALL
  2959. or to build on a native PowerPC system you can type
  2960. CROSS_COMPILE=' ' MAKEALL
  2961. When using the MAKEALL script, the default behaviour is to build
  2962. U-Boot in the source directory. This location can be changed by
  2963. setting the BUILD_DIR environment variable. Also, for each target
  2964. built, the MAKEALL script saves two log files (<target>.ERR and
  2965. <target>.MAKEALL) in the <source dir>/LOG directory. This default
  2966. location can be changed by setting the MAKEALL_LOGDIR environment
  2967. variable. For example:
  2968. export BUILD_DIR=/tmp/build
  2969. export MAKEALL_LOGDIR=/tmp/log
  2970. CROSS_COMPILE=ppc_8xx- MAKEALL
  2971. With the above settings build objects are saved in the /tmp/build,
  2972. log files are saved in the /tmp/log and the source tree remains clean
  2973. during the whole build process.
  2974. See also "U-Boot Porting Guide" below.
  2975. Monitor Commands - Overview:
  2976. ============================
  2977. go - start application at address 'addr'
  2978. run - run commands in an environment variable
  2979. bootm - boot application image from memory
  2980. bootp - boot image via network using BootP/TFTP protocol
  2981. bootz - boot zImage from memory
  2982. tftpboot- boot image via network using TFTP protocol
  2983. and env variables "ipaddr" and "serverip"
  2984. (and eventually "gatewayip")
  2985. tftpput - upload a file via network using TFTP protocol
  2986. rarpboot- boot image via network using RARP/TFTP protocol
  2987. diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
  2988. loads - load S-Record file over serial line
  2989. loadb - load binary file over serial line (kermit mode)
  2990. md - memory display
  2991. mm - memory modify (auto-incrementing)
  2992. nm - memory modify (constant address)
  2993. mw - memory write (fill)
  2994. cp - memory copy
  2995. cmp - memory compare
  2996. crc32 - checksum calculation
  2997. i2c - I2C sub-system
  2998. sspi - SPI utility commands
  2999. base - print or set address offset
  3000. printenv- print environment variables
  3001. setenv - set environment variables
  3002. saveenv - save environment variables to persistent storage
  3003. protect - enable or disable FLASH write protection
  3004. erase - erase FLASH memory
  3005. flinfo - print FLASH memory information
  3006. nand - NAND memory operations (see doc/README.nand)
  3007. bdinfo - print Board Info structure
  3008. iminfo - print header information for application image
  3009. coninfo - print console devices and informations
  3010. ide - IDE sub-system
  3011. loop - infinite loop on address range
  3012. loopw - infinite write loop on address range
  3013. mtest - simple RAM test
  3014. icache - enable or disable instruction cache
  3015. dcache - enable or disable data cache
  3016. reset - Perform RESET of the CPU
  3017. echo - echo args to console
  3018. version - print monitor version
  3019. help - print online help
  3020. ? - alias for 'help'
  3021. Monitor Commands - Detailed Description:
  3022. ========================================
  3023. TODO.
  3024. For now: just type "help <command>".
  3025. Environment Variables:
  3026. ======================
  3027. U-Boot supports user configuration using Environment Variables which
  3028. can be made persistent by saving to Flash memory.
  3029. Environment Variables are set using "setenv", printed using
  3030. "printenv", and saved to Flash using "saveenv". Using "setenv"
  3031. without a value can be used to delete a variable from the
  3032. environment. As long as you don't save the environment you are
  3033. working with an in-memory copy. In case the Flash area containing the
  3034. environment is erased by accident, a default environment is provided.
  3035. Some configuration options can be set using Environment Variables.
  3036. List of environment variables (most likely not complete):
  3037. baudrate - see CONFIG_BAUDRATE
  3038. bootdelay - see CONFIG_BOOTDELAY
  3039. bootcmd - see CONFIG_BOOTCOMMAND
  3040. bootargs - Boot arguments when booting an RTOS image
  3041. bootfile - Name of the image to load with TFTP
  3042. bootm_low - Memory range available for image processing in the bootm
  3043. command can be restricted. This variable is given as
  3044. a hexadecimal number and defines lowest address allowed
  3045. for use by the bootm command. See also "bootm_size"
  3046. environment variable. Address defined by "bootm_low" is
  3047. also the base of the initial memory mapping for the Linux
  3048. kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
  3049. bootm_mapsize.
  3050. bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
  3051. This variable is given as a hexadecimal number and it
  3052. defines the size of the memory region starting at base
  3053. address bootm_low that is accessible by the Linux kernel
  3054. during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
  3055. as the default value if it is defined, and bootm_size is
  3056. used otherwise.
  3057. bootm_size - Memory range available for image processing in the bootm
  3058. command can be restricted. This variable is given as
  3059. a hexadecimal number and defines the size of the region
  3060. allowed for use by the bootm command. See also "bootm_low"
  3061. environment variable.
  3062. updatefile - Location of the software update file on a TFTP server, used
  3063. by the automatic software update feature. Please refer to
  3064. documentation in doc/README.update for more details.
  3065. autoload - if set to "no" (any string beginning with 'n'),
  3066. "bootp" will just load perform a lookup of the
  3067. configuration from the BOOTP server, but not try to
  3068. load any image using TFTP
  3069. autostart - if set to "yes", an image loaded using the "bootp",
  3070. "rarpboot", "tftpboot" or "diskboot" commands will
  3071. be automatically started (by internally calling
  3072. "bootm")
  3073. If set to "no", a standalone image passed to the
  3074. "bootm" command will be copied to the load address
  3075. (and eventually uncompressed), but NOT be started.
  3076. This can be used to load and uncompress arbitrary
  3077. data.
  3078. fdt_high - if set this restricts the maximum address that the
  3079. flattened device tree will be copied into upon boot.
  3080. For example, if you have a system with 1 GB memory
  3081. at physical address 0x10000000, while Linux kernel
  3082. only recognizes the first 704 MB as low memory, you
  3083. may need to set fdt_high as 0x3C000000 to have the
  3084. device tree blob be copied to the maximum address
  3085. of the 704 MB low memory, so that Linux kernel can
  3086. access it during the boot procedure.
  3087. If this is set to the special value 0xFFFFFFFF then
  3088. the fdt will not be copied at all on boot. For this
  3089. to work it must reside in writable memory, have
  3090. sufficient padding on the end of it for u-boot to
  3091. add the information it needs into it, and the memory
  3092. must be accessible by the kernel.
  3093. fdtcontroladdr- if set this is the address of the control flattened
  3094. device tree used by U-Boot when CONFIG_OF_CONTROL is
  3095. defined.
  3096. i2cfast - (PPC405GP|PPC405EP only)
  3097. if set to 'y' configures Linux I2C driver for fast
  3098. mode (400kHZ). This environment variable is used in
  3099. initialization code. So, for changes to be effective
  3100. it must be saved and board must be reset.
  3101. initrd_high - restrict positioning of initrd images:
  3102. If this variable is not set, initrd images will be
  3103. copied to the highest possible address in RAM; this
  3104. is usually what you want since it allows for
  3105. maximum initrd size. If for some reason you want to
  3106. make sure that the initrd image is loaded below the
  3107. CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
  3108. variable to a value of "no" or "off" or "0".
  3109. Alternatively, you can set it to a maximum upper
  3110. address to use (U-Boot will still check that it
  3111. does not overwrite the U-Boot stack and data).
  3112. For instance, when you have a system with 16 MB
  3113. RAM, and want to reserve 4 MB from use by Linux,
  3114. you can do this by adding "mem=12M" to the value of
  3115. the "bootargs" variable. However, now you must make
  3116. sure that the initrd image is placed in the first
  3117. 12 MB as well - this can be done with
  3118. setenv initrd_high 00c00000
  3119. If you set initrd_high to 0xFFFFFFFF, this is an
  3120. indication to U-Boot that all addresses are legal
  3121. for the Linux kernel, including addresses in flash
  3122. memory. In this case U-Boot will NOT COPY the
  3123. ramdisk at all. This may be useful to reduce the
  3124. boot time on your system, but requires that this
  3125. feature is supported by your Linux kernel.
  3126. ipaddr - IP address; needed for tftpboot command
  3127. loadaddr - Default load address for commands like "bootp",
  3128. "rarpboot", "tftpboot", "loadb" or "diskboot"
  3129. loads_echo - see CONFIG_LOADS_ECHO
  3130. serverip - TFTP server IP address; needed for tftpboot command
  3131. bootretry - see CONFIG_BOOT_RETRY_TIME
  3132. bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
  3133. bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
  3134. ethprime - controls which interface is used first.
  3135. ethact - controls which interface is currently active.
  3136. For example you can do the following
  3137. => setenv ethact FEC
  3138. => ping 192.168.0.1 # traffic sent on FEC
  3139. => setenv ethact SCC
  3140. => ping 10.0.0.1 # traffic sent on SCC
  3141. ethrotate - When set to "no" U-Boot does not go through all
  3142. available network interfaces.
  3143. It just stays at the currently selected interface.
  3144. netretry - When set to "no" each network operation will
  3145. either succeed or fail without retrying.
  3146. When set to "once" the network operation will
  3147. fail when all the available network interfaces
  3148. are tried once without success.
  3149. Useful on scripts which control the retry operation
  3150. themselves.
  3151. npe_ucode - set load address for the NPE microcode
  3152. tftpsrcport - If this is set, the value is used for TFTP's
  3153. UDP source port.
  3154. tftpdstport - If this is set, the value is used for TFTP's UDP
  3155. destination port instead of the Well Know Port 69.
  3156. tftpblocksize - Block size to use for TFTP transfers; if not set,
  3157. we use the TFTP server's default block size
  3158. tftptimeout - Retransmission timeout for TFTP packets (in milli-
  3159. seconds, minimum value is 1000 = 1 second). Defines
  3160. when a packet is considered to be lost so it has to
  3161. be retransmitted. The default is 5000 = 5 seconds.
  3162. Lowering this value may make downloads succeed
  3163. faster in networks with high packet loss rates or
  3164. with unreliable TFTP servers.
  3165. vlan - When set to a value < 4095 the traffic over
  3166. Ethernet is encapsulated/received over 802.1q
  3167. VLAN tagged frames.
  3168. The following image location variables contain the location of images
  3169. used in booting. The "Image" column gives the role of the image and is
  3170. not an environment variable name. The other columns are environment
  3171. variable names. "File Name" gives the name of the file on a TFTP
  3172. server, "RAM Address" gives the location in RAM the image will be
  3173. loaded to, and "Flash Location" gives the image's address in NOR
  3174. flash or offset in NAND flash.
  3175. *Note* - these variables don't have to be defined for all boards, some
  3176. boards currenlty use other variables for these purposes, and some
  3177. boards use these variables for other purposes.
  3178. Image File Name RAM Address Flash Location
  3179. ----- --------- ----------- --------------
  3180. u-boot u-boot u-boot_addr_r u-boot_addr
  3181. Linux kernel bootfile kernel_addr_r kernel_addr
  3182. device tree blob fdtfile fdt_addr_r fdt_addr
  3183. ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
  3184. The following environment variables may be used and automatically
  3185. updated by the network boot commands ("bootp" and "rarpboot"),
  3186. depending the information provided by your boot server:
  3187. bootfile - see above
  3188. dnsip - IP address of your Domain Name Server
  3189. dnsip2 - IP address of your secondary Domain Name Server
  3190. gatewayip - IP address of the Gateway (Router) to use
  3191. hostname - Target hostname
  3192. ipaddr - see above
  3193. netmask - Subnet Mask
  3194. rootpath - Pathname of the root filesystem on the NFS server
  3195. serverip - see above
  3196. There are two special Environment Variables:
  3197. serial# - contains hardware identification information such
  3198. as type string and/or serial number
  3199. ethaddr - Ethernet address
  3200. These variables can be set only once (usually during manufacturing of
  3201. the board). U-Boot refuses to delete or overwrite these variables
  3202. once they have been set once.
  3203. Further special Environment Variables:
  3204. ver - Contains the U-Boot version string as printed
  3205. with the "version" command. This variable is
  3206. readonly (see CONFIG_VERSION_VARIABLE).
  3207. Please note that changes to some configuration parameters may take
  3208. only effect after the next boot (yes, that's just like Windoze :-).
  3209. Command Line Parsing:
  3210. =====================
  3211. There are two different command line parsers available with U-Boot:
  3212. the old "simple" one, and the much more powerful "hush" shell:
  3213. Old, simple command line parser:
  3214. --------------------------------
  3215. - supports environment variables (through setenv / saveenv commands)
  3216. - several commands on one line, separated by ';'
  3217. - variable substitution using "... ${name} ..." syntax
  3218. - special characters ('$', ';') can be escaped by prefixing with '\',
  3219. for example:
  3220. setenv bootcmd bootm \${address}
  3221. - You can also escape text by enclosing in single apostrophes, for example:
  3222. setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
  3223. Hush shell:
  3224. -----------
  3225. - similar to Bourne shell, with control structures like
  3226. if...then...else...fi, for...do...done; while...do...done,
  3227. until...do...done, ...
  3228. - supports environment ("global") variables (through setenv / saveenv
  3229. commands) and local shell variables (through standard shell syntax
  3230. "name=value"); only environment variables can be used with "run"
  3231. command
  3232. General rules:
  3233. --------------
  3234. (1) If a command line (or an environment variable executed by a "run"
  3235. command) contains several commands separated by semicolon, and
  3236. one of these commands fails, then the remaining commands will be
  3237. executed anyway.
  3238. (2) If you execute several variables with one call to run (i. e.
  3239. calling run with a list of variables as arguments), any failing
  3240. command will cause "run" to terminate, i. e. the remaining
  3241. variables are not executed.
  3242. Note for Redundant Ethernet Interfaces:
  3243. =======================================
  3244. Some boards come with redundant Ethernet interfaces; U-Boot supports
  3245. such configurations and is capable of automatic selection of a
  3246. "working" interface when needed. MAC assignment works as follows:
  3247. Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
  3248. MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
  3249. "eth1addr" (=>eth1), "eth2addr", ...
  3250. If the network interface stores some valid MAC address (for instance
  3251. in SROM), this is used as default address if there is NO correspon-
  3252. ding setting in the environment; if the corresponding environment
  3253. variable is set, this overrides the settings in the card; that means:
  3254. o If the SROM has a valid MAC address, and there is no address in the
  3255. environment, the SROM's address is used.
  3256. o If there is no valid address in the SROM, and a definition in the
  3257. environment exists, then the value from the environment variable is
  3258. used.
  3259. o If both the SROM and the environment contain a MAC address, and
  3260. both addresses are the same, this MAC address is used.
  3261. o If both the SROM and the environment contain a MAC address, and the
  3262. addresses differ, the value from the environment is used and a
  3263. warning is printed.
  3264. o If neither SROM nor the environment contain a MAC address, an error
  3265. is raised.
  3266. If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
  3267. will be programmed into hardware as part of the initialization process. This
  3268. may be skipped by setting the appropriate 'ethmacskip' environment variable.
  3269. The naming convention is as follows:
  3270. "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
  3271. Image Formats:
  3272. ==============
  3273. U-Boot is capable of booting (and performing other auxiliary operations on)
  3274. images in two formats:
  3275. New uImage format (FIT)
  3276. -----------------------
  3277. Flexible and powerful format based on Flattened Image Tree -- FIT (similar
  3278. to Flattened Device Tree). It allows the use of images with multiple
  3279. components (several kernels, ramdisks, etc.), with contents protected by
  3280. SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
  3281. Old uImage format
  3282. -----------------
  3283. Old image format is based on binary files which can be basically anything,
  3284. preceded by a special header; see the definitions in include/image.h for
  3285. details; basically, the header defines the following image properties:
  3286. * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
  3287. 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
  3288. LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
  3289. Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
  3290. INTEGRITY).
  3291. * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
  3292. IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
  3293. Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
  3294. * Compression Type (uncompressed, gzip, bzip2)
  3295. * Load Address
  3296. * Entry Point
  3297. * Image Name
  3298. * Image Timestamp
  3299. The header is marked by a special Magic Number, and both the header
  3300. and the data portions of the image are secured against corruption by
  3301. CRC32 checksums.
  3302. Linux Support:
  3303. ==============
  3304. Although U-Boot should support any OS or standalone application
  3305. easily, the main focus has always been on Linux during the design of
  3306. U-Boot.
  3307. U-Boot includes many features that so far have been part of some
  3308. special "boot loader" code within the Linux kernel. Also, any
  3309. "initrd" images to be used are no longer part of one big Linux image;
  3310. instead, kernel and "initrd" are separate images. This implementation
  3311. serves several purposes:
  3312. - the same features can be used for other OS or standalone
  3313. applications (for instance: using compressed images to reduce the
  3314. Flash memory footprint)
  3315. - it becomes much easier to port new Linux kernel versions because
  3316. lots of low-level, hardware dependent stuff are done by U-Boot
  3317. - the same Linux kernel image can now be used with different "initrd"
  3318. images; of course this also means that different kernel images can
  3319. be run with the same "initrd". This makes testing easier (you don't
  3320. have to build a new "zImage.initrd" Linux image when you just
  3321. change a file in your "initrd"). Also, a field-upgrade of the
  3322. software is easier now.
  3323. Linux HOWTO:
  3324. ============
  3325. Porting Linux to U-Boot based systems:
  3326. ---------------------------------------
  3327. U-Boot cannot save you from doing all the necessary modifications to
  3328. configure the Linux device drivers for use with your target hardware
  3329. (no, we don't intend to provide a full virtual machine interface to
  3330. Linux :-).
  3331. But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
  3332. Just make sure your machine specific header file (for instance
  3333. include/asm-ppc/tqm8xx.h) includes the same definition of the Board
  3334. Information structure as we define in include/asm-<arch>/u-boot.h,
  3335. and make sure that your definition of IMAP_ADDR uses the same value
  3336. as your U-Boot configuration in CONFIG_SYS_IMMR.
  3337. Configuring the Linux kernel:
  3338. -----------------------------
  3339. No specific requirements for U-Boot. Make sure you have some root
  3340. device (initial ramdisk, NFS) for your target system.
  3341. Building a Linux Image:
  3342. -----------------------
  3343. With U-Boot, "normal" build targets like "zImage" or "bzImage" are
  3344. not used. If you use recent kernel source, a new build target
  3345. "uImage" will exist which automatically builds an image usable by
  3346. U-Boot. Most older kernels also have support for a "pImage" target,
  3347. which was introduced for our predecessor project PPCBoot and uses a
  3348. 100% compatible format.
  3349. Example:
  3350. make TQM850L_config
  3351. make oldconfig
  3352. make dep
  3353. make uImage
  3354. The "uImage" build target uses a special tool (in 'tools/mkimage') to
  3355. encapsulate a compressed Linux kernel image with header information,
  3356. CRC32 checksum etc. for use with U-Boot. This is what we are doing:
  3357. * build a standard "vmlinux" kernel image (in ELF binary format):
  3358. * convert the kernel into a raw binary image:
  3359. ${CROSS_COMPILE}-objcopy -O binary \
  3360. -R .note -R .comment \
  3361. -S vmlinux linux.bin
  3362. * compress the binary image:
  3363. gzip -9 linux.bin
  3364. * package compressed binary image for U-Boot:
  3365. mkimage -A ppc -O linux -T kernel -C gzip \
  3366. -a 0 -e 0 -n "Linux Kernel Image" \
  3367. -d linux.bin.gz uImage
  3368. The "mkimage" tool can also be used to create ramdisk images for use
  3369. with U-Boot, either separated from the Linux kernel image, or
  3370. combined into one file. "mkimage" encapsulates the images with a 64
  3371. byte header containing information about target architecture,
  3372. operating system, image type, compression method, entry points, time
  3373. stamp, CRC32 checksums, etc.
  3374. "mkimage" can be called in two ways: to verify existing images and
  3375. print the header information, or to build new images.
  3376. In the first form (with "-l" option) mkimage lists the information
  3377. contained in the header of an existing U-Boot image; this includes
  3378. checksum verification:
  3379. tools/mkimage -l image
  3380. -l ==> list image header information
  3381. The second form (with "-d" option) is used to build a U-Boot image
  3382. from a "data file" which is used as image payload:
  3383. tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
  3384. -n name -d data_file image
  3385. -A ==> set architecture to 'arch'
  3386. -O ==> set operating system to 'os'
  3387. -T ==> set image type to 'type'
  3388. -C ==> set compression type 'comp'
  3389. -a ==> set load address to 'addr' (hex)
  3390. -e ==> set entry point to 'ep' (hex)
  3391. -n ==> set image name to 'name'
  3392. -d ==> use image data from 'datafile'
  3393. Right now, all Linux kernels for PowerPC systems use the same load
  3394. address (0x00000000), but the entry point address depends on the
  3395. kernel version:
  3396. - 2.2.x kernels have the entry point at 0x0000000C,
  3397. - 2.3.x and later kernels have the entry point at 0x00000000.
  3398. So a typical call to build a U-Boot image would read:
  3399. -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
  3400. > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
  3401. > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
  3402. > examples/uImage.TQM850L
  3403. Image Name: 2.4.4 kernel for TQM850L
  3404. Created: Wed Jul 19 02:34:59 2000
  3405. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  3406. Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
  3407. Load Address: 0x00000000
  3408. Entry Point: 0x00000000
  3409. To verify the contents of the image (or check for corruption):
  3410. -> tools/mkimage -l examples/uImage.TQM850L
  3411. Image Name: 2.4.4 kernel for TQM850L
  3412. Created: Wed Jul 19 02:34:59 2000
  3413. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  3414. Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
  3415. Load Address: 0x00000000
  3416. Entry Point: 0x00000000
  3417. NOTE: for embedded systems where boot time is critical you can trade
  3418. speed for memory and install an UNCOMPRESSED image instead: this
  3419. needs more space in Flash, but boots much faster since it does not
  3420. need to be uncompressed:
  3421. -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
  3422. -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
  3423. > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
  3424. > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
  3425. > examples/uImage.TQM850L-uncompressed
  3426. Image Name: 2.4.4 kernel for TQM850L
  3427. Created: Wed Jul 19 02:34:59 2000
  3428. Image Type: PowerPC Linux Kernel Image (uncompressed)
  3429. Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
  3430. Load Address: 0x00000000
  3431. Entry Point: 0x00000000
  3432. Similar you can build U-Boot images from a 'ramdisk.image.gz' file
  3433. when your kernel is intended to use an initial ramdisk:
  3434. -> tools/mkimage -n 'Simple Ramdisk Image' \
  3435. > -A ppc -O linux -T ramdisk -C gzip \
  3436. > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
  3437. Image Name: Simple Ramdisk Image
  3438. Created: Wed Jan 12 14:01:50 2000
  3439. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  3440. Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
  3441. Load Address: 0x00000000
  3442. Entry Point: 0x00000000
  3443. Installing a Linux Image:
  3444. -------------------------
  3445. To downloading a U-Boot image over the serial (console) interface,
  3446. you must convert the image to S-Record format:
  3447. objcopy -I binary -O srec examples/image examples/image.srec
  3448. The 'objcopy' does not understand the information in the U-Boot
  3449. image header, so the resulting S-Record file will be relative to
  3450. address 0x00000000. To load it to a given address, you need to
  3451. specify the target address as 'offset' parameter with the 'loads'
  3452. command.
  3453. Example: install the image to address 0x40100000 (which on the
  3454. TQM8xxL is in the first Flash bank):
  3455. => erase 40100000 401FFFFF
  3456. .......... done
  3457. Erased 8 sectors
  3458. => loads 40100000
  3459. ## Ready for S-Record download ...
  3460. ~>examples/image.srec
  3461. 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
  3462. ...
  3463. 15989 15990 15991 15992
  3464. [file transfer complete]
  3465. [connected]
  3466. ## Start Addr = 0x00000000
  3467. You can check the success of the download using the 'iminfo' command;
  3468. this includes a checksum verification so you can be sure no data
  3469. corruption happened:
  3470. => imi 40100000
  3471. ## Checking Image at 40100000 ...
  3472. Image Name: 2.2.13 for initrd on TQM850L
  3473. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  3474. Data Size: 335725 Bytes = 327 kB = 0 MB
  3475. Load Address: 00000000
  3476. Entry Point: 0000000c
  3477. Verifying Checksum ... OK
  3478. Boot Linux:
  3479. -----------
  3480. The "bootm" command is used to boot an application that is stored in
  3481. memory (RAM or Flash). In case of a Linux kernel image, the contents
  3482. of the "bootargs" environment variable is passed to the kernel as
  3483. parameters. You can check and modify this variable using the
  3484. "printenv" and "setenv" commands:
  3485. => printenv bootargs
  3486. bootargs=root=/dev/ram
  3487. => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  3488. => printenv bootargs
  3489. bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  3490. => bootm 40020000
  3491. ## Booting Linux kernel at 40020000 ...
  3492. Image Name: 2.2.13 for NFS on TQM850L
  3493. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  3494. Data Size: 381681 Bytes = 372 kB = 0 MB
  3495. Load Address: 00000000
  3496. Entry Point: 0000000c
  3497. Verifying Checksum ... OK
  3498. Uncompressing Kernel Image ... OK
  3499. 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
  3500. Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  3501. time_init: decrementer frequency = 187500000/60
  3502. Calibrating delay loop... 49.77 BogoMIPS
  3503. Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
  3504. ...
  3505. If you want to boot a Linux kernel with initial RAM disk, you pass
  3506. the memory addresses of both the kernel and the initrd image (PPBCOOT
  3507. format!) to the "bootm" command:
  3508. => imi 40100000 40200000
  3509. ## Checking Image at 40100000 ...
  3510. Image Name: 2.2.13 for initrd on TQM850L
  3511. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  3512. Data Size: 335725 Bytes = 327 kB = 0 MB
  3513. Load Address: 00000000
  3514. Entry Point: 0000000c
  3515. Verifying Checksum ... OK
  3516. ## Checking Image at 40200000 ...
  3517. Image Name: Simple Ramdisk Image
  3518. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  3519. Data Size: 566530 Bytes = 553 kB = 0 MB
  3520. Load Address: 00000000
  3521. Entry Point: 00000000
  3522. Verifying Checksum ... OK
  3523. => bootm 40100000 40200000
  3524. ## Booting Linux kernel at 40100000 ...
  3525. Image Name: 2.2.13 for initrd on TQM850L
  3526. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  3527. Data Size: 335725 Bytes = 327 kB = 0 MB
  3528. Load Address: 00000000
  3529. Entry Point: 0000000c
  3530. Verifying Checksum ... OK
  3531. Uncompressing Kernel Image ... OK
  3532. ## Loading RAMDisk Image at 40200000 ...
  3533. Image Name: Simple Ramdisk Image
  3534. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  3535. Data Size: 566530 Bytes = 553 kB = 0 MB
  3536. Load Address: 00000000
  3537. Entry Point: 00000000
  3538. Verifying Checksum ... OK
  3539. Loading Ramdisk ... OK
  3540. 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
  3541. Boot arguments: root=/dev/ram
  3542. time_init: decrementer frequency = 187500000/60
  3543. Calibrating delay loop... 49.77 BogoMIPS
  3544. ...
  3545. RAMDISK: Compressed image found at block 0
  3546. VFS: Mounted root (ext2 filesystem).
  3547. bash#
  3548. Boot Linux and pass a flat device tree:
  3549. -----------
  3550. First, U-Boot must be compiled with the appropriate defines. See the section
  3551. titled "Linux Kernel Interface" above for a more in depth explanation. The
  3552. following is an example of how to start a kernel and pass an updated
  3553. flat device tree:
  3554. => print oftaddr
  3555. oftaddr=0x300000
  3556. => print oft
  3557. oft=oftrees/mpc8540ads.dtb
  3558. => tftp $oftaddr $oft
  3559. Speed: 1000, full duplex
  3560. Using TSEC0 device
  3561. TFTP from server 192.168.1.1; our IP address is 192.168.1.101
  3562. Filename 'oftrees/mpc8540ads.dtb'.
  3563. Load address: 0x300000
  3564. Loading: #
  3565. done
  3566. Bytes transferred = 4106 (100a hex)
  3567. => tftp $loadaddr $bootfile
  3568. Speed: 1000, full duplex
  3569. Using TSEC0 device
  3570. TFTP from server 192.168.1.1; our IP address is 192.168.1.2
  3571. Filename 'uImage'.
  3572. Load address: 0x200000
  3573. Loading:############
  3574. done
  3575. Bytes transferred = 1029407 (fb51f hex)
  3576. => print loadaddr
  3577. loadaddr=200000
  3578. => print oftaddr
  3579. oftaddr=0x300000
  3580. => bootm $loadaddr - $oftaddr
  3581. ## Booting image at 00200000 ...
  3582. Image Name: Linux-2.6.17-dirty
  3583. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  3584. Data Size: 1029343 Bytes = 1005.2 kB
  3585. Load Address: 00000000
  3586. Entry Point: 00000000
  3587. Verifying Checksum ... OK
  3588. Uncompressing Kernel Image ... OK
  3589. Booting using flat device tree at 0x300000
  3590. Using MPC85xx ADS machine description
  3591. Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
  3592. [snip]
  3593. More About U-Boot Image Types:
  3594. ------------------------------
  3595. U-Boot supports the following image types:
  3596. "Standalone Programs" are directly runnable in the environment
  3597. provided by U-Boot; it is expected that (if they behave
  3598. well) you can continue to work in U-Boot after return from
  3599. the Standalone Program.
  3600. "OS Kernel Images" are usually images of some Embedded OS which
  3601. will take over control completely. Usually these programs
  3602. will install their own set of exception handlers, device
  3603. drivers, set up the MMU, etc. - this means, that you cannot
  3604. expect to re-enter U-Boot except by resetting the CPU.
  3605. "RAMDisk Images" are more or less just data blocks, and their
  3606. parameters (address, size) are passed to an OS kernel that is
  3607. being started.
  3608. "Multi-File Images" contain several images, typically an OS
  3609. (Linux) kernel image and one or more data images like
  3610. RAMDisks. This construct is useful for instance when you want
  3611. to boot over the network using BOOTP etc., where the boot
  3612. server provides just a single image file, but you want to get
  3613. for instance an OS kernel and a RAMDisk image.
  3614. "Multi-File Images" start with a list of image sizes, each
  3615. image size (in bytes) specified by an "uint32_t" in network
  3616. byte order. This list is terminated by an "(uint32_t)0".
  3617. Immediately after the terminating 0 follow the images, one by
  3618. one, all aligned on "uint32_t" boundaries (size rounded up to
  3619. a multiple of 4 bytes).
  3620. "Firmware Images" are binary images containing firmware (like
  3621. U-Boot or FPGA images) which usually will be programmed to
  3622. flash memory.
  3623. "Script files" are command sequences that will be executed by
  3624. U-Boot's command interpreter; this feature is especially
  3625. useful when you configure U-Boot to use a real shell (hush)
  3626. as command interpreter.
  3627. Booting the Linux zImage:
  3628. -------------------------
  3629. On some platforms, it's possible to boot Linux zImage. This is done
  3630. using the "bootz" command. The syntax of "bootz" command is the same
  3631. as the syntax of "bootm" command.
  3632. Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
  3633. kernel with raw initrd images. The syntax is slightly different, the
  3634. address of the initrd must be augmented by it's size, in the following
  3635. format: "<initrd addres>:<initrd size>".
  3636. Standalone HOWTO:
  3637. =================
  3638. One of the features of U-Boot is that you can dynamically load and
  3639. run "standalone" applications, which can use some resources of
  3640. U-Boot like console I/O functions or interrupt services.
  3641. Two simple examples are included with the sources:
  3642. "Hello World" Demo:
  3643. -------------------
  3644. 'examples/hello_world.c' contains a small "Hello World" Demo
  3645. application; it is automatically compiled when you build U-Boot.
  3646. It's configured to run at address 0x00040004, so you can play with it
  3647. like that:
  3648. => loads
  3649. ## Ready for S-Record download ...
  3650. ~>examples/hello_world.srec
  3651. 1 2 3 4 5 6 7 8 9 10 11 ...
  3652. [file transfer complete]
  3653. [connected]
  3654. ## Start Addr = 0x00040004
  3655. => go 40004 Hello World! This is a test.
  3656. ## Starting application at 0x00040004 ...
  3657. Hello World
  3658. argc = 7
  3659. argv[0] = "40004"
  3660. argv[1] = "Hello"
  3661. argv[2] = "World!"
  3662. argv[3] = "This"
  3663. argv[4] = "is"
  3664. argv[5] = "a"
  3665. argv[6] = "test."
  3666. argv[7] = "<NULL>"
  3667. Hit any key to exit ...
  3668. ## Application terminated, rc = 0x0
  3669. Another example, which demonstrates how to register a CPM interrupt
  3670. handler with the U-Boot code, can be found in 'examples/timer.c'.
  3671. Here, a CPM timer is set up to generate an interrupt every second.
  3672. The interrupt service routine is trivial, just printing a '.'
  3673. character, but this is just a demo program. The application can be
  3674. controlled by the following keys:
  3675. ? - print current values og the CPM Timer registers
  3676. b - enable interrupts and start timer
  3677. e - stop timer and disable interrupts
  3678. q - quit application
  3679. => loads
  3680. ## Ready for S-Record download ...
  3681. ~>examples/timer.srec
  3682. 1 2 3 4 5 6 7 8 9 10 11 ...
  3683. [file transfer complete]
  3684. [connected]
  3685. ## Start Addr = 0x00040004
  3686. => go 40004
  3687. ## Starting application at 0x00040004 ...
  3688. TIMERS=0xfff00980
  3689. Using timer 1
  3690. tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
  3691. Hit 'b':
  3692. [q, b, e, ?] Set interval 1000000 us
  3693. Enabling timer
  3694. Hit '?':
  3695. [q, b, e, ?] ........
  3696. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
  3697. Hit '?':
  3698. [q, b, e, ?] .
  3699. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
  3700. Hit '?':
  3701. [q, b, e, ?] .
  3702. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
  3703. Hit '?':
  3704. [q, b, e, ?] .
  3705. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
  3706. Hit 'e':
  3707. [q, b, e, ?] ...Stopping timer
  3708. Hit 'q':
  3709. [q, b, e, ?] ## Application terminated, rc = 0x0
  3710. Minicom warning:
  3711. ================
  3712. Over time, many people have reported problems when trying to use the
  3713. "minicom" terminal emulation program for serial download. I (wd)
  3714. consider minicom to be broken, and recommend not to use it. Under
  3715. Unix, I recommend to use C-Kermit for general purpose use (and
  3716. especially for kermit binary protocol download ("loadb" command), and
  3717. use "cu" for S-Record download ("loads" command). See
  3718. http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
  3719. for help with kermit.
  3720. Nevertheless, if you absolutely want to use it try adding this
  3721. configuration to your "File transfer protocols" section:
  3722. Name Program Name U/D FullScr IO-Red. Multi
  3723. X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
  3724. Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
  3725. NetBSD Notes:
  3726. =============
  3727. Starting at version 0.9.2, U-Boot supports NetBSD both as host
  3728. (build U-Boot) and target system (boots NetBSD/mpc8xx).
  3729. Building requires a cross environment; it is known to work on
  3730. NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
  3731. need gmake since the Makefiles are not compatible with BSD make).
  3732. Note that the cross-powerpc package does not install include files;
  3733. attempting to build U-Boot will fail because <machine/ansi.h> is
  3734. missing. This file has to be installed and patched manually:
  3735. # cd /usr/pkg/cross/powerpc-netbsd/include
  3736. # mkdir powerpc
  3737. # ln -s powerpc machine
  3738. # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
  3739. # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
  3740. Native builds *don't* work due to incompatibilities between native
  3741. and U-Boot include files.
  3742. Booting assumes that (the first part of) the image booted is a
  3743. stage-2 loader which in turn loads and then invokes the kernel
  3744. proper. Loader sources will eventually appear in the NetBSD source
  3745. tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
  3746. meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
  3747. Implementation Internals:
  3748. =========================
  3749. The following is not intended to be a complete description of every
  3750. implementation detail. However, it should help to understand the
  3751. inner workings of U-Boot and make it easier to port it to custom
  3752. hardware.
  3753. Initial Stack, Global Data:
  3754. ---------------------------
  3755. The implementation of U-Boot is complicated by the fact that U-Boot
  3756. starts running out of ROM (flash memory), usually without access to
  3757. system RAM (because the memory controller is not initialized yet).
  3758. This means that we don't have writable Data or BSS segments, and BSS
  3759. is not initialized as zero. To be able to get a C environment working
  3760. at all, we have to allocate at least a minimal stack. Implementation
  3761. options for this are defined and restricted by the CPU used: Some CPU
  3762. models provide on-chip memory (like the IMMR area on MPC8xx and
  3763. MPC826x processors), on others (parts of) the data cache can be
  3764. locked as (mis-) used as memory, etc.
  3765. Chris Hallinan posted a good summary of these issues to the
  3766. U-Boot mailing list:
  3767. Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
  3768. From: "Chris Hallinan" <clh@net1plus.com>
  3769. Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
  3770. ...
  3771. Correct me if I'm wrong, folks, but the way I understand it
  3772. is this: Using DCACHE as initial RAM for Stack, etc, does not
  3773. require any physical RAM backing up the cache. The cleverness
  3774. is that the cache is being used as a temporary supply of
  3775. necessary storage before the SDRAM controller is setup. It's
  3776. beyond the scope of this list to explain the details, but you
  3777. can see how this works by studying the cache architecture and
  3778. operation in the architecture and processor-specific manuals.
  3779. OCM is On Chip Memory, which I believe the 405GP has 4K. It
  3780. is another option for the system designer to use as an
  3781. initial stack/RAM area prior to SDRAM being available. Either
  3782. option should work for you. Using CS 4 should be fine if your
  3783. board designers haven't used it for something that would
  3784. cause you grief during the initial boot! It is frequently not
  3785. used.
  3786. CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
  3787. with your processor/board/system design. The default value
  3788. you will find in any recent u-boot distribution in
  3789. walnut.h should work for you. I'd set it to a value larger
  3790. than your SDRAM module. If you have a 64MB SDRAM module, set
  3791. it above 400_0000. Just make sure your board has no resources
  3792. that are supposed to respond to that address! That code in
  3793. start.S has been around a while and should work as is when
  3794. you get the config right.
  3795. -Chris Hallinan
  3796. DS4.COM, Inc.
  3797. It is essential to remember this, since it has some impact on the C
  3798. code for the initialization procedures:
  3799. * Initialized global data (data segment) is read-only. Do not attempt
  3800. to write it.
  3801. * Do not use any uninitialized global data (or implicitely initialized
  3802. as zero data - BSS segment) at all - this is undefined, initiali-
  3803. zation is performed later (when relocating to RAM).
  3804. * Stack space is very limited. Avoid big data buffers or things like
  3805. that.
  3806. Having only the stack as writable memory limits means we cannot use
  3807. normal global data to share information beween the code. But it
  3808. turned out that the implementation of U-Boot can be greatly
  3809. simplified by making a global data structure (gd_t) available to all
  3810. functions. We could pass a pointer to this data as argument to _all_
  3811. functions, but this would bloat the code. Instead we use a feature of
  3812. the GCC compiler (Global Register Variables) to share the data: we
  3813. place a pointer (gd) to the global data into a register which we
  3814. reserve for this purpose.
  3815. When choosing a register for such a purpose we are restricted by the
  3816. relevant (E)ABI specifications for the current architecture, and by
  3817. GCC's implementation.
  3818. For PowerPC, the following registers have specific use:
  3819. R1: stack pointer
  3820. R2: reserved for system use
  3821. R3-R4: parameter passing and return values
  3822. R5-R10: parameter passing
  3823. R13: small data area pointer
  3824. R30: GOT pointer
  3825. R31: frame pointer
  3826. (U-Boot also uses R12 as internal GOT pointer. r12
  3827. is a volatile register so r12 needs to be reset when
  3828. going back and forth between asm and C)
  3829. ==> U-Boot will use R2 to hold a pointer to the global data
  3830. Note: on PPC, we could use a static initializer (since the
  3831. address of the global data structure is known at compile time),
  3832. but it turned out that reserving a register results in somewhat
  3833. smaller code - although the code savings are not that big (on
  3834. average for all boards 752 bytes for the whole U-Boot image,
  3835. 624 text + 127 data).
  3836. On Blackfin, the normal C ABI (except for P3) is followed as documented here:
  3837. http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
  3838. ==> U-Boot will use P3 to hold a pointer to the global data
  3839. On ARM, the following registers are used:
  3840. R0: function argument word/integer result
  3841. R1-R3: function argument word
  3842. R9: GOT pointer
  3843. R10: stack limit (used only if stack checking if enabled)
  3844. R11: argument (frame) pointer
  3845. R12: temporary workspace
  3846. R13: stack pointer
  3847. R14: link register
  3848. R15: program counter
  3849. ==> U-Boot will use R8 to hold a pointer to the global data
  3850. On Nios II, the ABI is documented here:
  3851. http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
  3852. ==> U-Boot will use gp to hold a pointer to the global data
  3853. Note: on Nios II, we give "-G0" option to gcc and don't use gp
  3854. to access small data sections, so gp is free.
  3855. On NDS32, the following registers are used:
  3856. R0-R1: argument/return
  3857. R2-R5: argument
  3858. R15: temporary register for assembler
  3859. R16: trampoline register
  3860. R28: frame pointer (FP)
  3861. R29: global pointer (GP)
  3862. R30: link register (LP)
  3863. R31: stack pointer (SP)
  3864. PC: program counter (PC)
  3865. ==> U-Boot will use R10 to hold a pointer to the global data
  3866. NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
  3867. or current versions of GCC may "optimize" the code too much.
  3868. Memory Management:
  3869. ------------------
  3870. U-Boot runs in system state and uses physical addresses, i.e. the
  3871. MMU is not used either for address mapping nor for memory protection.
  3872. The available memory is mapped to fixed addresses using the memory
  3873. controller. In this process, a contiguous block is formed for each
  3874. memory type (Flash, SDRAM, SRAM), even when it consists of several
  3875. physical memory banks.
  3876. U-Boot is installed in the first 128 kB of the first Flash bank (on
  3877. TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
  3878. booting and sizing and initializing DRAM, the code relocates itself
  3879. to the upper end of DRAM. Immediately below the U-Boot code some
  3880. memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
  3881. configuration setting]. Below that, a structure with global Board
  3882. Info data is placed, followed by the stack (growing downward).
  3883. Additionally, some exception handler code is copied to the low 8 kB
  3884. of DRAM (0x00000000 ... 0x00001FFF).
  3885. So a typical memory configuration with 16 MB of DRAM could look like
  3886. this:
  3887. 0x0000 0000 Exception Vector code
  3888. :
  3889. 0x0000 1FFF
  3890. 0x0000 2000 Free for Application Use
  3891. :
  3892. :
  3893. :
  3894. :
  3895. 0x00FB FF20 Monitor Stack (Growing downward)
  3896. 0x00FB FFAC Board Info Data and permanent copy of global data
  3897. 0x00FC 0000 Malloc Arena
  3898. :
  3899. 0x00FD FFFF
  3900. 0x00FE 0000 RAM Copy of Monitor Code
  3901. ... eventually: LCD or video framebuffer
  3902. ... eventually: pRAM (Protected RAM - unchanged by reset)
  3903. 0x00FF FFFF [End of RAM]
  3904. System Initialization:
  3905. ----------------------
  3906. In the reset configuration, U-Boot starts at the reset entry point
  3907. (on most PowerPC systems at address 0x00000100). Because of the reset
  3908. configuration for CS0# this is a mirror of the onboard Flash memory.
  3909. To be able to re-map memory U-Boot then jumps to its link address.
  3910. To be able to implement the initialization code in C, a (small!)
  3911. initial stack is set up in the internal Dual Ported RAM (in case CPUs
  3912. which provide such a feature like MPC8xx or MPC8260), or in a locked
  3913. part of the data cache. After that, U-Boot initializes the CPU core,
  3914. the caches and the SIU.
  3915. Next, all (potentially) available memory banks are mapped using a
  3916. preliminary mapping. For example, we put them on 512 MB boundaries
  3917. (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
  3918. on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
  3919. programmed for SDRAM access. Using the temporary configuration, a
  3920. simple memory test is run that determines the size of the SDRAM
  3921. banks.
  3922. When there is more than one SDRAM bank, and the banks are of
  3923. different size, the largest is mapped first. For equal size, the first
  3924. bank (CS2#) is mapped first. The first mapping is always for address
  3925. 0x00000000, with any additional banks following immediately to create
  3926. contiguous memory starting from 0.
  3927. Then, the monitor installs itself at the upper end of the SDRAM area
  3928. and allocates memory for use by malloc() and for the global Board
  3929. Info data; also, the exception vector code is copied to the low RAM
  3930. pages, and the final stack is set up.
  3931. Only after this relocation will you have a "normal" C environment;
  3932. until that you are restricted in several ways, mostly because you are
  3933. running from ROM, and because the code will have to be relocated to a
  3934. new address in RAM.
  3935. U-Boot Porting Guide:
  3936. ----------------------
  3937. [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
  3938. list, October 2002]
  3939. int main(int argc, char *argv[])
  3940. {
  3941. sighandler_t no_more_time;
  3942. signal(SIGALRM, no_more_time);
  3943. alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
  3944. if (available_money > available_manpower) {
  3945. Pay consultant to port U-Boot;
  3946. return 0;
  3947. }
  3948. Download latest U-Boot source;
  3949. Subscribe to u-boot mailing list;
  3950. if (clueless)
  3951. email("Hi, I am new to U-Boot, how do I get started?");
  3952. while (learning) {
  3953. Read the README file in the top level directory;
  3954. Read http://www.denx.de/twiki/bin/view/DULG/Manual;
  3955. Read applicable doc/*.README;
  3956. Read the source, Luke;
  3957. /* find . -name "*.[chS]" | xargs grep -i <keyword> */
  3958. }
  3959. if (available_money > toLocalCurrency ($2500))
  3960. Buy a BDI3000;
  3961. else
  3962. Add a lot of aggravation and time;
  3963. if (a similar board exists) { /* hopefully... */
  3964. cp -a board/<similar> board/<myboard>
  3965. cp include/configs/<similar>.h include/configs/<myboard>.h
  3966. } else {
  3967. Create your own board support subdirectory;
  3968. Create your own board include/configs/<myboard>.h file;
  3969. }
  3970. Edit new board/<myboard> files
  3971. Edit new include/configs/<myboard>.h
  3972. while (!accepted) {
  3973. while (!running) {
  3974. do {
  3975. Add / modify source code;
  3976. } until (compiles);
  3977. Debug;
  3978. if (clueless)
  3979. email("Hi, I am having problems...");
  3980. }
  3981. Send patch file to the U-Boot email list;
  3982. if (reasonable critiques)
  3983. Incorporate improvements from email list code review;
  3984. else
  3985. Defend code as written;
  3986. }
  3987. return 0;
  3988. }
  3989. void no_more_time (int sig)
  3990. {
  3991. hire_a_guru();
  3992. }
  3993. Coding Standards:
  3994. -----------------
  3995. All contributions to U-Boot should conform to the Linux kernel
  3996. coding style; see the file "Documentation/CodingStyle" and the script
  3997. "scripts/Lindent" in your Linux kernel source directory.
  3998. Source files originating from a different project (for example the
  3999. MTD subsystem) are generally exempt from these guidelines and are not
  4000. reformated to ease subsequent migration to newer versions of those
  4001. sources.
  4002. Please note that U-Boot is implemented in C (and to some small parts in
  4003. Assembler); no C++ is used, so please do not use C++ style comments (//)
  4004. in your code.
  4005. Please also stick to the following formatting rules:
  4006. - remove any trailing white space
  4007. - use TAB characters for indentation and vertical alignment, not spaces
  4008. - make sure NOT to use DOS '\r\n' line feeds
  4009. - do not add more than 2 consecutive empty lines to source files
  4010. - do not add trailing empty lines to source files
  4011. Submissions which do not conform to the standards may be returned
  4012. with a request to reformat the changes.
  4013. Submitting Patches:
  4014. -------------------
  4015. Since the number of patches for U-Boot is growing, we need to
  4016. establish some rules. Submissions which do not conform to these rules
  4017. may be rejected, even when they contain important and valuable stuff.
  4018. Please see http://www.denx.de/wiki/U-Boot/Patches for details.
  4019. Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
  4020. see http://lists.denx.de/mailman/listinfo/u-boot
  4021. When you send a patch, please include the following information with
  4022. it:
  4023. * For bug fixes: a description of the bug and how your patch fixes
  4024. this bug. Please try to include a way of demonstrating that the
  4025. patch actually fixes something.
  4026. * For new features: a description of the feature and your
  4027. implementation.
  4028. * A CHANGELOG entry as plaintext (separate from the patch)
  4029. * For major contributions, your entry to the CREDITS file
  4030. * When you add support for a new board, don't forget to add this
  4031. board to the MAINTAINERS file, too.
  4032. * If your patch adds new configuration options, don't forget to
  4033. document these in the README file.
  4034. * The patch itself. If you are using git (which is *strongly*
  4035. recommended) you can easily generate the patch using the
  4036. "git format-patch". If you then use "git send-email" to send it to
  4037. the U-Boot mailing list, you will avoid most of the common problems
  4038. with some other mail clients.
  4039. If you cannot use git, use "diff -purN OLD NEW". If your version of
  4040. diff does not support these options, then get the latest version of
  4041. GNU diff.
  4042. The current directory when running this command shall be the parent
  4043. directory of the U-Boot source tree (i. e. please make sure that
  4044. your patch includes sufficient directory information for the
  4045. affected files).
  4046. We prefer patches as plain text. MIME attachments are discouraged,
  4047. and compressed attachments must not be used.
  4048. * If one logical set of modifications affects or creates several
  4049. files, all these changes shall be submitted in a SINGLE patch file.
  4050. * Changesets that contain different, unrelated modifications shall be
  4051. submitted as SEPARATE patches, one patch per changeset.
  4052. Notes:
  4053. * Before sending the patch, run the MAKEALL script on your patched
  4054. source tree and make sure that no errors or warnings are reported
  4055. for any of the boards.
  4056. * Keep your modifications to the necessary minimum: A patch
  4057. containing several unrelated changes or arbitrary reformats will be
  4058. returned with a request to re-formatting / split it.
  4059. * If you modify existing code, make sure that your new code does not
  4060. add to the memory footprint of the code ;-) Small is beautiful!
  4061. When adding new features, these should compile conditionally only
  4062. (using #ifdef), and the resulting code with the new feature
  4063. disabled must not need more memory than the old code without your
  4064. modification.
  4065. * Remember that there is a size limit of 100 kB per message on the
  4066. u-boot mailing list. Bigger patches will be moderated. If they are
  4067. reasonable and not too big, they will be acknowledged. But patches
  4068. bigger than the size limit should be avoided.