README 176 KB

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