README 148 KB

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