README 158 KB

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