README 142 KB

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