README 196 KB

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