README 124 KB

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