README 203 KB

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