README 215 KB

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