README 197 KB

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