README 233 KB

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