README 153 KB

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