README 177 KB

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