README 167 KB

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