README 95 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867
  1. #
  2. # (C) Copyright 2000 - 2002
  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 and ARM processors, which can be
  27. installed in a boot ROM and used to initialize and test the hardware
  28. or to download and run application code.
  29. The development of U-Boot is closely related to Linux: some parts of
  30. the source code originate in the Linux source tree, we have some
  31. header files in common, and special provision has been made to
  32. support booting of Linux images.
  33. Some attention has been paid to make this software easily
  34. configurable and extendable. For instance, all monitor commands are
  35. implemented with the same call interface, so that it's very easy to
  36. add new commands. Also, instead of permanently adding rarely used
  37. code (for instance hardware test utilities) to the monitor, you can
  38. load and run it dynamically.
  39. Status:
  40. =======
  41. In general, all boards for which a configuration option exists in the
  42. Makefile have been tested to some extent and can be considered
  43. "working". In fact, many of them are used in production systems.
  44. In case of problems see the CHANGELOG and CREDITS files to find out
  45. who contributed the specific port.
  46. Where to get help:
  47. ==================
  48. In case you have questions about, problems with or contributions for
  49. U-Boot you should send a message to the U-Boot mailing list at
  50. <u-boot-users@lists.sourceforge.net>. There is also an archive of
  51. previous traffic on the mailing list - please search the archive
  52. before asking FAQ's. Please see
  53. http://lists.sourceforge.net/lists/listinfo/u-boot-users/
  54. Where we come from:
  55. ===================
  56. - start from 8xxrom sources
  57. - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
  58. - clean up code
  59. - make it easier to add custom boards
  60. - make it possible to add other [PowerPC] CPUs
  61. - extend functions, especially:
  62. * Provide extended interface to Linux boot loader
  63. * S-Record download
  64. * network boot
  65. * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
  66. - create ARMBoot project (http://sourceforge.net/projects/armboot)
  67. - add other CPU families (starting with ARM)
  68. - create U-Boot project (http://sourceforge.net/projects/u-boot)
  69. Names and Spelling:
  70. ===================
  71. The "official" name of this project is "Das U-Boot". The spelling
  72. "U-Boot" shall be used in all written text (documentation, comments
  73. in source files etc.). Example:
  74. This is the README file for the U-Boot project.
  75. File names etc. shall be based on the string "u-boot". Examples:
  76. include/asm-ppc/u-boot.h
  77. #include <asm/u-boot.h>
  78. Variable names, preprocessor constants etc. shall be either based on
  79. the string "u_boot" or on "U_BOOT". Example:
  80. U_BOOT_VERSION u_boot_logo
  81. IH_OS_U_BOOT u_boot_hush_start
  82. Versioning:
  83. ===========
  84. U-Boot uses a 3 level version number containing a version, a
  85. sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
  86. sub-version "34", and patchlevel "4".
  87. The patchlevel is used to indicate certain stages of development
  88. between released versions, i. e. officially released versions of
  89. U-Boot will always have a patchlevel of "0".
  90. Directory Hierarchy:
  91. ====================
  92. - board Board dependend files
  93. - common Misc architecture independend functions
  94. - cpu CPU specific files
  95. - disk Code for disk drive partition handling
  96. - doc Documentation (don't expect too much)
  97. - drivers Common used device drivers
  98. - dtt Digital Thermometer and Thermostat drivers
  99. - examples Example code for standalone applications, etc.
  100. - include Header Files
  101. - disk Harddisk interface code
  102. - net Networking code
  103. - ppc Files generic to PowerPC architecture
  104. - post Power On Self Test
  105. - post/arch Symlink to architecture specific Power On Self Test
  106. - post/arch-ppc PowerPC architecture specific Power On Self Test
  107. - post/cpu/mpc8260 MPC8260 CPU specific Power On Self Test
  108. - post/cpu/mpc8xx MPC8xx CPU specific Power On Self Test
  109. - rtc Real Time Clock drivers
  110. - tools Tools to build S-Record or U-Boot images, etc.
  111. - cpu/74xx_7xx Files specific to Motorola MPC74xx and 7xx CPUs
  112. - cpu/mpc5xx Files specific to Motorola MPC5xx CPUs
  113. - cpu/mpc8xx Files specific to Motorola MPC8xx CPUs
  114. - cpu/mpc824x Files specific to Motorola MPC824x CPUs
  115. - cpu/mpc8260 Files specific to Motorola MPC8260 CPU
  116. - cpu/ppc4xx Files specific to IBM 4xx CPUs
  117. - board/LEOX/ Files specific to boards manufactured by The LEOX team
  118. - board/LEOX/elpt860 Files specific to ELPT860 boards
  119. - board/RPXClassic
  120. Files specific to RPXClassic boards
  121. - board/RPXlite Files specific to RPXlite boards
  122. - board/c2mon Files specific to c2mon boards
  123. - board/cmi Files specific to cmi boards
  124. - board/cogent Files specific to Cogent boards
  125. (need further configuration)
  126. Files specific to CPCIISER4 boards
  127. - board/cpu86 Files specific to CPU86 boards
  128. - board/cray/ Files specific to boards manufactured by Cray
  129. - board/cray/L1 Files specific to L1 boards
  130. - board/cu824 Files specific to CU824 boards
  131. - board/ebony Files specific to IBM Ebony board
  132. - board/eric Files specific to ERIC boards
  133. - board/esd/ Files specific to boards manufactured by ESD
  134. - board/esd/adciop Files specific to ADCIOP boards
  135. - board/esd/ar405 Files specific to AR405 boards
  136. - board/esd/canbt Files specific to CANBT boards
  137. - board/esd/cpci405 Files specific to CPCI405 boards
  138. - board/esd/cpciiser4 Files specific to CPCIISER4 boards
  139. - board/esd/common Common files for ESD boards
  140. - board/esd/dasa_sim Files specific to DASA_SIM boards
  141. - board/esd/du405 Files specific to DU405 boards
  142. - board/esd/ocrtc Files specific to OCRTC boards
  143. - board/esd/pci405 Files specific to PCI405 boards
  144. - board/esteem192e
  145. Files specific to ESTEEM192E boards
  146. - board/etx094 Files specific to ETX_094 boards
  147. - board/evb64260
  148. Files specific to EVB64260 boards
  149. - board/fads Files specific to FADS boards
  150. - board/flagadm Files specific to FLAGADM boards
  151. - board/gen860t Files specific to GEN860T boards
  152. - board/genietv Files specific to GENIETV boards
  153. - board/gth Files specific to GTH boards
  154. - board/hermes Files specific to HERMES boards
  155. - board/hymod Files specific to HYMOD boards
  156. - board/icu862 Files specific to ICU862 boards
  157. - board/ip860 Files specific to IP860 boards
  158. - board/iphase4539
  159. Files specific to Interphase4539 boards
  160. - board/ivm Files specific to IVMS8/IVML24 boards
  161. - board/lantec Files specific to LANTEC boards
  162. - board/lwmon Files specific to LWMON boards
  163. - board/mbx8xx Files specific to MBX boards
  164. - board/mpc8260ads
  165. Files specific to MMPC8260ADS boards
  166. - board/mpl/ Files specific to boards manufactured by MPL
  167. - board/mpl/common Common files for MPL boards
  168. - board/mpl/pip405 Files specific to PIP405 boards
  169. - board/mpl/mip405 Files specific to MIP405 boards
  170. - board/musenki Files specific to MUSEKNI boards
  171. - board/mvs1 Files specific to MVS1 boards
  172. - board/nx823 Files specific to NX823 boards
  173. - board/oxc Files specific to OXC boards
  174. - board/pcippc2 Files specific to PCIPPC2/PCIPPC6 boards
  175. - board/pm826 Files specific to PM826 boards
  176. - board/ppmc8260
  177. Files specific to PPMC8260 boards
  178. - board/rpxsuper
  179. Files specific to RPXsuper boards
  180. - board/rsdproto
  181. Files specific to RSDproto boards
  182. - board/sandpoint
  183. Files specific to Sandpoint boards
  184. - board/sbc8260 Files specific to SBC8260 boards
  185. - board/sacsng Files specific to SACSng boards
  186. - board/siemens Files specific to boards manufactured by Siemens AG
  187. - board/siemens/CCM Files specific to CCM boards
  188. - board/siemens/IAD210 Files specific to IAD210 boards
  189. - board/siemens/SCM Files specific to SCM boards
  190. - board/siemens/pcu_e Files specific to PCU_E boards
  191. - board/sixnet Files specific to SIXNET boards
  192. - board/spd8xx Files specific to SPD8xxTS boards
  193. - board/tqm8260 Files specific to TQM8260 boards
  194. - board/tqm8xx Files specific to TQM8xxL boards
  195. - board/w7o Files specific to W7O boards
  196. - board/walnut405
  197. Files specific to Walnut405 boards
  198. - board/westel/ Files specific to boards manufactured by Westel Wireless
  199. - board/westel/amx860 Files specific to AMX860 boards
  200. - board/utx8245 Files specific to UTX8245 boards
  201. Software Configuration:
  202. =======================
  203. Configuration is usually done using C preprocessor defines; the
  204. rationale behind that is to avoid dead code whenever possible.
  205. There are two classes of configuration variables:
  206. * Configuration _OPTIONS_:
  207. These are selectable by the user and have names beginning with
  208. "CONFIG_".
  209. * Configuration _SETTINGS_:
  210. These depend on the hardware etc. and should not be meddled with if
  211. you don't know what you're doing; they have names beginning with
  212. "CFG_".
  213. Later we will add a configuration tool - probably similar to or even
  214. identical to what's used for the Linux kernel. Right now, we have to
  215. do the configuration by hand, which means creating some symbolic
  216. links and editing some configuration files. We use the TQM8xxL boards
  217. as an example here.
  218. Selection of Processor Architecture and Board Type:
  219. ---------------------------------------------------
  220. For all supported boards there are ready-to-use default
  221. configurations available; just type "make <board_name>_config".
  222. Example: For a TQM823L module type:
  223. cd u-boot
  224. make TQM823L_config
  225. For the Cogent platform, you need to specify the cpu type as well;
  226. e.g. "make cogent_mpc8xx_config". And also configure the cogent
  227. directory according to the instructions in cogent/README.
  228. Configuration Options:
  229. ----------------------
  230. Configuration depends on the combination of board and CPU type; all
  231. such information is kept in a configuration file
  232. "include/configs/<board_name>.h".
  233. Example: For a TQM823L module, all configuration settings are in
  234. "include/configs/TQM823L.h".
  235. Many of the options are named exactly as the corresponding Linux
  236. kernel configuration options. The intention is to make it easier to
  237. build a config tool - later.
  238. The following options need to be configured:
  239. - CPU Type: Define exactly one of
  240. PowerPC based CPUs:
  241. -------------------
  242. CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860
  243. or CONFIG_MPC5xx
  244. or CONFIG_MPC824X, CONFIG_MPC8260
  245. or CONFIG_IOP480
  246. or CONFIG_405GP
  247. or CONFIG_440
  248. or CONFIG_MPC74xx
  249. ARM based CPUs:
  250. ---------------
  251. CONFIG_SA1110
  252. CONFIG_ARM7
  253. CONFIG_PXA250
  254. - Board Type: Define exactly one of
  255. PowerPC based boards:
  256. ---------------------
  257. CONFIG_ADCIOP, CONFIG_ICU862 CONFIG_RPXsuper,
  258. CONFIG_ADS860, CONFIG_IP860, CONFIG_SM850,
  259. CONFIG_AMX860, CONFIG_IPHASE4539, CONFIG_SPD823TS,
  260. CONFIG_AR405, CONFIG_IVML24, CONFIG_SXNI855T,
  261. CONFIG_BAB7xx, CONFIG_IVML24_128, CONFIG_Sandpoint8240,
  262. CONFIG_CANBT, CONFIG_IVML24_256, CONFIG_Sandpoint8245,
  263. CONFIG_CCM, CONFIG_IVMS8, CONFIG_TQM823L,
  264. CONFIG_CPCI405, CONFIG_IVMS8_128, CONFIG_TQM850L,
  265. CONFIG_CPCI4052, CONFIG_IVMS8_256, CONFIG_TQM855L,
  266. CONFIG_CPCIISER4, CONFIG_LANTEC, CONFIG_TQM860L,
  267. CONFIG_CPU86, CONFIG_MBX, CONFIG_TQM8260,
  268. CONFIG_CRAYL1, CONFIG_MBX860T, CONFIG_TTTech,
  269. CONFIG_CU824, CONFIG_MHPC, CONFIG_UTX8245,
  270. CONFIG_DASA_SIM, CONFIG_MIP405, CONFIG_W7OLMC,
  271. CONFIG_DU405, CONFIG_MOUSSE, CONFIG_W7OLMG,
  272. CONFIG_ELPPC, CONFIG_MPC8260ADS, CONFIG_WALNUT405,
  273. CONFIG_ERIC, CONFIG_MUSENKI, CONFIG_ZUMA,
  274. CONFIG_ESTEEM192E, CONFIG_MVS1, CONFIG_c2mon,
  275. CONFIG_ETX094, CONFIG_NX823, CONFIG_cogent_mpc8260,
  276. CONFIG_EVB64260, CONFIG_OCRTC, CONFIG_cogent_mpc8xx,
  277. CONFIG_FADS823, CONFIG_ORSG, CONFIG_ep8260,
  278. CONFIG_FADS850SAR, CONFIG_OXC, CONFIG_gw8260,
  279. CONFIG_FADS860T, CONFIG_PCI405, CONFIG_hermes,
  280. CONFIG_FLAGADM, CONFIG_PCIPPC2, CONFIG_hymod,
  281. CONFIG_FPS850L, CONFIG_PCIPPC6, CONFIG_lwmon,
  282. CONFIG_GEN860T, CONFIG_PIP405, CONFIG_pcu_e,
  283. CONFIG_GENIETV, CONFIG_PM826, CONFIG_ppmc8260,
  284. CONFIG_GTH, CONFIG_RPXClassic, CONFIG_rsdproto,
  285. CONFIG_IAD210, CONFIG_RPXlite, CONFIG_sbc8260,
  286. CONFIG_EBONY, CONFIG_sacsng, CONFIG_FPS860L,
  287. CONFIG_V37, CONFIG_ELPT860, CONFIG_CMI
  288. ARM based boards:
  289. -----------------
  290. CONFIG_HHP_CRADLE, CONFIG_DNP1110, CONFIG_EP7312,
  291. CONFIG_IMPA7, CONFIG_LART, CONFIG_LUBBOCK,
  292. CONFIG_SHANNON, CONFIG_SMDK2400, CONFIG_SMDK2410,
  293. CONFIG_TRAB
  294. - CPU Module Type: (if CONFIG_COGENT is defined)
  295. Define exactly one of
  296. CONFIG_CMA286_60_OLD
  297. --- FIXME --- not tested yet:
  298. CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
  299. CONFIG_CMA287_23, CONFIG_CMA287_50
  300. - Motherboard Type: (if CONFIG_COGENT is defined)
  301. Define exactly one of
  302. CONFIG_CMA101, CONFIG_CMA102
  303. - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
  304. Define one or more of
  305. CONFIG_CMA302
  306. - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
  307. Define one or more of
  308. CONFIG_LCD_HEARTBEAT - update a character position on
  309. the lcd display every second with
  310. a "rotator" |\-/|\-/
  311. - MPC824X Family Member (if CONFIG_MPC824X is defined)
  312. Define exactly one of
  313. CONFIG_MPC8240, CONFIG_MPC8245
  314. - 8xx CPU Options: (if using an 8xx cpu)
  315. Define one or more of
  316. CONFIG_8xx_GCLK_FREQ - if get_gclk_freq() can not work e.g.
  317. no 32KHz reference PIT/RTC clock
  318. - Clock Interface:
  319. CONFIG_CLOCKS_IN_MHZ
  320. U-Boot stores all clock information in Hz
  321. internally. For binary compatibility with older Linux
  322. kernels (which expect the clocks passed in the
  323. bd_info data to be in MHz) the environment variable
  324. "clocks_in_mhz" can be defined so that U-Boot
  325. converts clock data to MHZ before passing it to the
  326. Linux kernel.
  327. When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
  328. "clocks_in_mhz=1" is automatically included in the
  329. default environment.
  330. - Console Interface:
  331. Depending on board, define exactly one serial port
  332. (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
  333. CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
  334. console by defining CONFIG_8xx_CONS_NONE
  335. Note: if CONFIG_8xx_CONS_NONE is defined, the serial
  336. port routines must be defined elsewhere
  337. (i.e. serial_init(), serial_getc(), ...)
  338. CONFIG_CFB_CONSOLE
  339. Enables console device for a color framebuffer. Needs following
  340. defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
  341. VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
  342. (default big endian)
  343. VIDEO_HW_RECTFILL graphic chip supports
  344. rectangle fill
  345. (cf. smiLynxEM)
  346. VIDEO_HW_BITBLT graphic chip supports
  347. bit-blit (cf. smiLynxEM)
  348. VIDEO_VISIBLE_COLS visible pixel columns
  349. (cols=pitch)
  350. VIDEO_VISIBLE_ROWS visible pixel rows
  351. VIDEO_PIXEL_SIZE bytes per pixel
  352. VIDEO_DATA_FORMAT graphic data format
  353. (0-5, cf. cfb_console.c)
  354. VIDEO_FB_ADRS framebuffer address
  355. VIDEO_KBD_INIT_FCT keyboard int fct
  356. (i.e. i8042_kbd_init())
  357. VIDEO_TSTC_FCT test char fct
  358. (i.e. i8042_tstc)
  359. VIDEO_GETC_FCT get char fct
  360. (i.e. i8042_getc)
  361. CONFIG_CONSOLE_CURSOR cursor drawing on/off
  362. (requires blink timer
  363. cf. i8042.c)
  364. CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
  365. CONFIG_CONSOLE_TIME display time/date info in
  366. upper right corner
  367. (requires CFG_CMD_DATE)
  368. CONFIG_VIDEO_LOGO display Linux logo in
  369. upper left corner
  370. CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
  371. linux_logo.h for logo.
  372. Requires CONFIG_VIDEO_LOGO
  373. CONFIG_CONSOLE_EXTRA_INFO
  374. addional board info beside
  375. the logo
  376. When CONFIG_CFB_CONSOLE is defined, video console is
  377. default i/o. Serial console can be forced with
  378. environment 'console=serial'.
  379. - Console Baudrate:
  380. CONFIG_BAUDRATE - in bps
  381. Select one of the baudrates listed in
  382. CFG_BAUDRATE_TABLE, see below.
  383. - Interrupt driven serial port input:
  384. CONFIG_SERIAL_SOFTWARE_FIFO
  385. PPC405GP only.
  386. Use an interrupt handler for receiving data on the
  387. serial port. It also enables using hardware handshake
  388. (RTS/CTS) and UART's built-in FIFO. Set the number of
  389. bytes the interrupt driven input buffer should have.
  390. Set to 0 to disable this feature (this is the default).
  391. This will also disable hardware handshake.
  392. - Boot Delay: CONFIG_BOOTDELAY - in seconds
  393. Delay before automatically booting the default image;
  394. set to -1 to disable autoboot.
  395. See doc/README.autoboot for these options that
  396. work with CONFIG_BOOTDELAY. None are required.
  397. CONFIG_BOOT_RETRY_TIME
  398. CONFIG_BOOT_RETRY_MIN
  399. CONFIG_AUTOBOOT_KEYED
  400. CONFIG_AUTOBOOT_PROMPT
  401. CONFIG_AUTOBOOT_DELAY_STR
  402. CONFIG_AUTOBOOT_STOP_STR
  403. CONFIG_AUTOBOOT_DELAY_STR2
  404. CONFIG_AUTOBOOT_STOP_STR2
  405. CONFIG_ZERO_BOOTDELAY_CHECK
  406. CONFIG_RESET_TO_RETRY
  407. - Autoboot Command:
  408. CONFIG_BOOTCOMMAND
  409. Only needed when CONFIG_BOOTDELAY is enabled;
  410. define a command string that is automatically executed
  411. when no character is read on the console interface
  412. within "Boot Delay" after reset.
  413. CONFIG_BOOTARGS
  414. This can be used to pass arguments to the bootm
  415. command. The value of CONFIG_BOOTARGS goes into the
  416. environment value "bootargs".
  417. CONFIG_RAMBOOT and CONFIG_NFSBOOT
  418. The value of these goes into the environment as
  419. "ramboot" and "nfsboot" respectively, and can be used
  420. as a convenience, when switching between booting from
  421. ram and nfs.
  422. - Pre-Boot Commands:
  423. CONFIG_PREBOOT
  424. When this option is #defined, the existence of the
  425. environment variable "preboot" will be checked
  426. immediately before starting the CONFIG_BOOTDELAY
  427. countdown and/or running the auto-boot command resp.
  428. entering interactive mode.
  429. This feature is especially useful when "preboot" is
  430. automatically generated or modified. For an example
  431. see the LWMON board specific code: here "preboot" is
  432. modified when the user holds down a certain
  433. combination of keys on the (special) keyboard when
  434. booting the systems
  435. - Serial Download Echo Mode:
  436. CONFIG_LOADS_ECHO
  437. If defined to 1, all characters received during a
  438. serial download (using the "loads" command) are
  439. echoed back. This might be needed by some terminal
  440. emulations (like "cu"), but may as well just take
  441. time on others. This setting #define's the initial
  442. value of the "loads_echo" environment variable.
  443. - Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
  444. CONFIG_KGDB_BAUDRATE
  445. Select one of the baudrates listed in
  446. CFG_BAUDRATE_TABLE, see below.
  447. - Monitor Functions:
  448. CONFIG_COMMANDS
  449. Most monitor functions can be selected (or
  450. de-selected) by adjusting the definition of
  451. CONFIG_COMMANDS; to select individual functions,
  452. #define CONFIG_COMMANDS by "OR"ing any of the
  453. following values:
  454. #define enables commands:
  455. -------------------------
  456. CFG_CMD_ASKENV * ask for env variable
  457. CFG_CMD_BDI bdinfo
  458. CFG_CMD_BEDBUG Include BedBug Debugger
  459. CFG_CMD_BOOTD bootd
  460. CFG_CMD_CACHE icache, dcache
  461. CFG_CMD_CONSOLE coninfo
  462. CFG_CMD_DATE * support for RTC, date/time...
  463. CFG_CMD_DHCP DHCP support
  464. CFG_CMD_ECHO * echo arguments
  465. CFG_CMD_EEPROM * EEPROM read/write support
  466. CFG_CMD_ELF bootelf, bootvx
  467. CFG_CMD_ENV saveenv
  468. CFG_CMD_FDC * Floppy Disk Support
  469. CFG_CMD_FDOS * Dos diskette Support
  470. CFG_CMD_FLASH flinfo, erase, protect
  471. CFG_CMD_FPGA FPGA device initialization support
  472. CFG_CMD_I2C * I2C serial bus support
  473. CFG_CMD_IDE * IDE harddisk support
  474. CFG_CMD_IMI iminfo
  475. CFG_CMD_IMMAP * IMMR dump support
  476. CFG_CMD_IRQ * irqinfo
  477. CFG_CMD_KGDB * kgdb
  478. CFG_CMD_LOADB loadb
  479. CFG_CMD_LOADS loads
  480. CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
  481. loop, mtest
  482. CFG_CMD_MII MII utility commands
  483. CFG_CMD_NET bootp, tftpboot, rarpboot
  484. CFG_CMD_PCI * pciinfo
  485. CFG_CMD_PCMCIA * PCMCIA support
  486. CFG_CMD_REGINFO * Register dump
  487. CFG_CMD_RUN run command in env variable
  488. CFG_CMD_SCSI * SCSI Support
  489. CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
  490. CFG_CMD_SPI * SPI serial bus support
  491. CFG_CMD_USB * USB support
  492. CFG_CMD_BSP * Board SPecific functions
  493. -----------------------------------------------
  494. CFG_CMD_ALL all
  495. CFG_CMD_DFL Default configuration; at the moment
  496. this is includes all commands, except
  497. the ones marked with "*" in the list
  498. above.
  499. If you don't define CONFIG_COMMANDS it defaults to
  500. CFG_CMD_DFL in include/cmd_confdefs.h. A board can
  501. override the default settings in the respective
  502. include file.
  503. EXAMPLE: If you want all functions except of network
  504. support you can write:
  505. #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
  506. Note: Don't enable the "icache" and "dcache" commands
  507. (configuration option CFG_CMD_CACHE) unless you know
  508. what you (and your U-Boot users) are doing. Data
  509. cache cannot be enabled on systems like the 8xx or
  510. 8260 (where accesses to the IMMR region must be
  511. uncached), and it cannot be disabled on all other
  512. systems where we (mis-) use the data cache to hold an
  513. initial stack and some data.
  514. XXX - this list needs to get updated!
  515. - Watchdog:
  516. CONFIG_WATCHDOG
  517. If this variable is defined, it enables watchdog
  518. support. There must support in the platform specific
  519. code for a watchdog. For the 8xx and 8260 CPUs, the
  520. SIU Watchdog feature is enabled in the SYPCR
  521. register.
  522. - Real-Time Clock:
  523. When CFG_CMD_DATE is selected, the type of the RTC
  524. has to be selected, too. Define exactly one of the
  525. following options:
  526. CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
  527. CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
  528. CONFIG_RTC_MC146818 - use MC146818 RTC
  529. CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
  530. CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
  531. CONFIG_RTC_DS164x - use Dallas DS164x RTC
  532. - Timestamp Support:
  533. When CONFIG_TIMESTAMP is selected, the timestamp
  534. (date and time) of an image is printed by image
  535. commands like bootm or iminfo. This option is
  536. automatically enabled when you select CFG_CMD_DATE .
  537. - Partition Support:
  538. CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
  539. and/or CONFIG_ISO_PARTITION
  540. If IDE or SCSI support is enabled (CFG_CMD_IDE or
  541. CFG_CMD_SCSI) you must configure support for at least
  542. one partition type as well.
  543. - IDE Reset method:
  544. CONFIG_IDE_RESET_ROUTINE
  545. Set this to define that instead of a reset Pin, the
  546. routine ide_set_reset(int idereset) will be used.
  547. - ATAPI Support:
  548. CONFIG_ATAPI
  549. Set this to enable ATAPI support.
  550. - SCSI Support:
  551. At the moment only there is only support for the
  552. SYM53C8XX SCSI controller; define
  553. CONFIG_SCSI_SYM53C8XX to enable it.
  554. CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
  555. CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
  556. CFG_SCSI_MAX_LUN] can be adjusted to define the
  557. maximum numbers of LUNs, SCSI ID's and target
  558. devices.
  559. CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
  560. - NETWORK Support (PCI):
  561. CONFIG_EEPRO100
  562. Support for Intel 82557/82559/82559ER chips.
  563. Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
  564. write routine for first time initialisation.
  565. CONFIG_TULIP
  566. Support for Digital 2114x chips.
  567. Optional CONFIG_TULIP_SELECT_MEDIA for board specific
  568. modem chip initialisation (KS8761/QS6611).
  569. CONFIG_NATSEMI
  570. Support for National dp83815 chips.
  571. CONFIG_NS8382X
  572. Support for National dp8382[01] gigabit chips.
  573. - USB Support:
  574. At the moment only the UHCI host controller is
  575. supported (PIP405, MIP405); define
  576. CONFIG_USB_UHCI to enable it.
  577. define CONFIG_USB_KEYBOARD to enable the USB Keyboard
  578. end define CONFIG_USB_STORAGE to enable the USB
  579. storage devices.
  580. Note:
  581. Supported are USB Keyboards and USB Floppy drives
  582. (TEAC FD-05PUB).
  583. - Keyboard Support:
  584. CONFIG_ISA_KEYBOARD
  585. Define this to enable standard (PC-Style) keyboard
  586. support
  587. CONFIG_I8042_KBD
  588. Standard PC keyboard driver with US (is default) and
  589. GERMAN key layout (switch via environment 'keymap=de') support.
  590. Export function i8042_kbd_init, i8042_tstc and i8042_getc
  591. for cfb_console. Supports cursor blinking.
  592. - Video support:
  593. CONFIG_VIDEO
  594. Define this to enable video support (for output to
  595. video).
  596. CONFIG_VIDEO_CT69000
  597. Enable Chips & Technologies 69000 Video chip
  598. CONFIG_VIDEO_SMI_LYNXEM
  599. Enable Silicon Motion SMI 712/710/810 Video chip
  600. Videomode are selected via environment 'videomode' with
  601. standard LiLo mode numbers.
  602. Following modes are supported (* is default):
  603. 800x600 1024x768 1280x1024
  604. 256 (8bit) 303* 305 307
  605. 65536 (16bit) 314 317 31a
  606. 16,7 Mill (24bit) 315 318 31b
  607. (i.e. setenv videomode 317; saveenv; reset;)
  608. CONFIG_VIDEO_SED13806
  609. Enable Epson SED13806 driver. This driver supports 8bpp
  610. and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
  611. or CONFIG_VIDEO_SED13806_16BPP
  612. - LCD Support: CONFIG_LCD
  613. Define this to enable LCD support (for output to LCD
  614. display); also select one of the supported displays
  615. by defining one of these:
  616. CONFIG_NEC_NL6648AC33:
  617. NEC NL6648AC33-18. Active, color, single scan.
  618. CONFIG_NEC_NL6648BC20
  619. NEC NL6648BC20-08. 6.5", 640x480.
  620. Active, color, single scan.
  621. CONFIG_SHARP_16x9
  622. Sharp 320x240. Active, color, single scan.
  623. It isn't 16x9, and I am not sure what it is.
  624. CONFIG_SHARP_LQ64D341
  625. Sharp LQ64D341 display, 640x480.
  626. Active, color, single scan.
  627. CONFIG_HLD1045
  628. HLD1045 display, 640x480.
  629. Active, color, single scan.
  630. CONFIG_OPTREX_BW
  631. Optrex CBL50840-2 NF-FW 99 22 M5
  632. or
  633. Hitachi LMG6912RPFC-00T
  634. or
  635. Hitachi SP14Q002
  636. 320x240. Black & white.
  637. Normally display is black on white background; define
  638. CFG_WHITE_ON_BLACK to get it inverted.
  639. - Ethernet address:
  640. CONFIG_ETHADDR
  641. CONFIG_ETH2ADDR
  642. CONFIG_ETH3ADDR
  643. Define a default value for ethernet address to use
  644. for the respective ethernet interface, in case this
  645. is not determined automatically.
  646. - IP address:
  647. CONFIG_IPADDR
  648. Define a default value for the IP address to use for
  649. the default ethernet interface, in case this is not
  650. determined through e.g. bootp.
  651. - Server IP address:
  652. CONFIG_SERVERIP
  653. Defines a default value for theIP address of a TFTP
  654. server to contact when using the "tftboot" command.
  655. - BOOTP Recovery Mode:
  656. CONFIG_BOOTP_RANDOM_DELAY
  657. If you have many targets in a network that try to
  658. boot using BOOTP, you may want to avoid that all
  659. systems send out BOOTP requests at precisely the same
  660. moment (which would happen for instance at recovery
  661. from a power failure, when all systems will try to
  662. boot, thus flooding the BOOTP server. Defining
  663. CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
  664. inserted before sending out BOOTP requests. The
  665. following delays are insterted then:
  666. 1st BOOTP request: delay 0 ... 1 sec
  667. 2nd BOOTP request: delay 0 ... 2 sec
  668. 3rd BOOTP request: delay 0 ... 4 sec
  669. 4th and following
  670. BOOTP requests: delay 0 ... 8 sec
  671. - Status LED: CONFIG_STATUS_LED
  672. Several configurations allow to display the current
  673. status using a LED. For instance, the LED will blink
  674. fast while running U-Boot code, stop blinking as
  675. soon as a reply to a BOOTP request was received, and
  676. start blinking slow once the Linux kernel is running
  677. (supported by a status LED driver in the Linux
  678. kernel). Defining CONFIG_STATUS_LED enables this
  679. feature in U-Boot.
  680. - CAN Support: CONFIG_CAN_DRIVER
  681. Defining CONFIG_CAN_DRIVER enables CAN driver support
  682. on those systems that support this (optional)
  683. feature, like the TQM8xxL modules.
  684. - I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
  685. Enables I2C serial bus commands. If this is selected,
  686. either CONFIG_HARD_I2C or CONFIG_SOFT_I2C must be defined
  687. to include the appropriate I2C driver.
  688. See also: common/cmd_i2c.c for a description of the
  689. command line interface.
  690. CONFIG_HARD_I2C
  691. Selects the CPM hardware driver for I2C.
  692. CONFIG_SOFT_I2C
  693. Use software (aka bit-banging) driver instead of CPM
  694. or similar hardware support for I2C. This is configured
  695. via the following defines.
  696. I2C_INIT
  697. (Optional). Any commands necessary to enable I2C
  698. controller or configure ports.
  699. I2C_PORT
  700. (Only for MPC8260 CPU). The I/O port to use (the code
  701. assumes both bits are on the same port). Valid values
  702. are 0..3 for ports A..D.
  703. I2C_ACTIVE
  704. The code necessary to make the I2C data line active
  705. (driven). If the data line is open collector, this
  706. define can be null.
  707. I2C_TRISTATE
  708. The code necessary to make the I2C data line tri-stated
  709. (inactive). If the data line is open collector, this
  710. define can be null.
  711. I2C_READ
  712. Code that returns TRUE if the I2C data line is high,
  713. FALSE if it is low.
  714. I2C_SDA(bit)
  715. If <bit> is TRUE, sets the I2C data line high. If it
  716. is FALSE, it clears it (low).
  717. I2C_SCL(bit)
  718. If <bit> is TRUE, sets the I2C clock line high. If it
  719. is FALSE, it clears it (low).
  720. I2C_DELAY
  721. This delay is invoked four times per clock cycle so this
  722. controls the rate of data transfer. The data rate thus
  723. is 1 / (I2C_DELAY * 4).
  724. CFG_I2C_INIT_BOARD
  725. When a board is reset during an i2c bus transfer
  726. chips might think that the current transfer is still
  727. in progress. On some boards it is possible to access
  728. the i2c SCLK line directly, either by using the
  729. processor pin as a GPIO or by having a second pin
  730. connected to the bus. If this option is defined a
  731. custom i2c_init_board() routine in boards/xxx/board.c
  732. is run early in the boot sequence.
  733. - SPI Support: CONFIG_SPI
  734. Enables SPI driver (so far only tested with
  735. SPI EEPROM, also an instance works with Crystal A/D and
  736. D/As on the SACSng board)
  737. CONFIG_SPI_X
  738. Enables extended (16-bit) SPI EEPROM addressing.
  739. (symmetrical to CONFIG_I2C_X)
  740. CONFIG_SOFT_SPI
  741. Enables a software (bit-bang) SPI driver rather than
  742. using hardware support. This is a general purpose
  743. driver that only requires three general I/O port pins
  744. (two outputs, one input) to function. If this is
  745. defined, the board configuration must define several
  746. SPI configuration items (port pins to use, etc). For
  747. an example, see include/configs/sacsng.h.
  748. - FPGA Support: CONFIG_FPGA_COUNT
  749. Specify the number of FPGA devices to support.
  750. CONFIG_FPGA
  751. Used to specify the types of FPGA devices. For
  752. example,
  753. #define CONFIG_FPGA CFG_XILINX_VIRTEX2
  754. CFG_FPGA_PROG_FEEDBACK
  755. Enable printing of hash marks during FPGA
  756. configuration.
  757. CFG_FPGA_CHECK_BUSY
  758. Enable checks on FPGA configuration interface busy
  759. status by the configuration function. This option
  760. will require a board or device specific function to
  761. be written.
  762. CONFIG_FPGA_DELAY
  763. If defined, a function that provides delays in the
  764. FPGA configuration driver.
  765. CFG_FPGA_CHECK_CTRLC
  766. Allow Control-C to interrupt FPGA configuration
  767. CFG_FPGA_CHECK_ERROR
  768. Check for configuration errors during FPGA bitfile
  769. loading. For example, abort during Virtex II
  770. configuration if the INIT_B line goes low (which
  771. indicated a CRC error).
  772. CFG_FPGA_WAIT_INIT
  773. Maximum time to wait for the INIT_B line to deassert
  774. after PROB_B has been deasserted during a Virtex II
  775. FPGA configuration sequence. The default time is 500 mS.
  776. CFG_FPGA_WAIT_BUSY
  777. Maximum time to wait for BUSY to deassert during
  778. Virtex II FPGA configuration. The default is 5 mS.
  779. CFG_FPGA_WAIT_CONFIG
  780. Time to wait after FPGA configuration. The default is
  781. 200 mS.
  782. - FPGA Support: CONFIG_FPGA_COUNT
  783. Specify the number of FPGA devices to support.
  784. CONFIG_FPGA
  785. Used to specify the types of FPGA devices. For example,
  786. #define CONFIG_FPGA CFG_XILINX_VIRTEX2
  787. CFG_FPGA_PROG_FEEDBACK
  788. Enable printing of hash marks during FPGA configuration.
  789. CFG_FPGA_CHECK_BUSY
  790. Enable checks on FPGA configuration interface busy
  791. status by the configuration function. This option
  792. will require a board or device specific function to
  793. be written.
  794. CONFIG_FPGA_DELAY
  795. If defined, a function that provides delays in the FPGA
  796. configuration driver.
  797. CFG_FPGA_CHECK_CTRLC
  798. Allow Control-C to interrupt FPGA configuration
  799. CFG_FPGA_CHECK_ERROR
  800. Check for configuration errors during FPGA bitfile
  801. loading. For example, abort during Virtex II
  802. configuration if the INIT_B line goes low (which
  803. indicated a CRC error).
  804. CFG_FPGA_WAIT_INIT
  805. Maximum time to wait for the INIT_B line to deassert
  806. after PROB_B has been deasserted during a Virtex II
  807. FPGA configuration sequence. The default time is 500
  808. mS.
  809. CFG_FPGA_WAIT_BUSY
  810. Maximum time to wait for BUSY to deassert during
  811. Virtex II FPGA configuration. The default is 5 mS.
  812. CFG_FPGA_WAIT_CONFIG
  813. Time to wait after FPGA configuration. The default is
  814. 200 mS.
  815. - Configuration Management:
  816. CONFIG_IDENT_STRING
  817. If defined, this string will be added to the U-Boot
  818. version information (U_BOOT_VERSION)
  819. - Vendor Parameter Protection:
  820. U-Boot considers the values of the environment
  821. variables "serial#" (Board Serial Number) and
  822. "ethaddr" (Ethernet Address) to bb parameters that
  823. are set once by the board vendor / manufacturer, and
  824. protects these variables from casual modification by
  825. the user. Once set, these variables are read-only,
  826. and write or delete attempts are rejected. You can
  827. change this behviour:
  828. If CONFIG_ENV_OVERWRITE is #defined in your config
  829. file, the write protection for vendor parameters is
  830. completely disabled. Anybody can change or delete
  831. these parameters.
  832. Alternatively, if you #define _both_ CONFIG_ETHADDR
  833. _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
  834. ethernet address is installed in the environment,
  835. which can be changed exactly ONCE by the user. [The
  836. serial# is unaffected by this, i. e. it remains
  837. read-only.]
  838. - Protected RAM:
  839. CONFIG_PRAM
  840. Define this variable to enable the reservation of
  841. "protected RAM", i. e. RAM which is not overwritten
  842. by U-Boot. Define CONFIG_PRAM to hold the number of
  843. kB you want to reserve for pRAM. You can overwrite
  844. this default value by defining an environment
  845. variable "pram" to the number of kB you want to
  846. reserve. Note that the board info structure will
  847. still show the full amount of RAM. If pRAM is
  848. reserved, a new environment variable "mem" will
  849. automatically be defined to hold the amount of
  850. remaining RAM in a form that can be passed as boot
  851. argument to Linux, for instance like that:
  852. setenv bootargs ... mem=\$(mem)
  853. saveenv
  854. This way you can tell Linux not to use this memory,
  855. either, which results in a memory region that will
  856. not be affected by reboots.
  857. *WARNING* If your board configuration uses automatic
  858. detection of the RAM size, you must make sure that
  859. this memory test is non-destructive. So far, the
  860. following board configurations are known to be
  861. "pRAM-clean":
  862. ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
  863. HERMES, IP860, RPXlite, LWMON, LANTEC,
  864. PCU_E, FLAGADM, TQM8260
  865. - Error Recovery:
  866. CONFIG_PANIC_HANG
  867. Define this variable to stop the system in case of a
  868. fatal error, so that you have to reset it manually.
  869. This is probably NOT a good idea for an embedded
  870. system where you want to system to reboot
  871. automatically as fast as possible, but it may be
  872. useful during development since you can try to debug
  873. the conditions that lead to the situation.
  874. CONFIG_NET_RETRY_COUNT
  875. This variable defines the number of retries for
  876. network operations like ARP, RARP, TFTP, or BOOTP
  877. before giving up the operation. If not defined, a
  878. default value of 5 is used.
  879. - Command Interpreter:
  880. CFG_HUSH_PARSER
  881. Define this variable to enable the "hush" shell (from
  882. Busybox) as command line interpreter, thus enabling
  883. powerful command line syntax like
  884. if...then...else...fi conditionals or `&&' and '||'
  885. constructs ("shell scripts").
  886. If undefined, you get the old, much simpler behaviour
  887. with a somewhat smaller memory footprint.
  888. CFG_PROMPT_HUSH_PS2
  889. This defines the secondary prompt string, which is
  890. printed when the command interpreter needs more input
  891. to complete a command. Usually "> ".
  892. Note:
  893. In the current implementation, the local variables
  894. space and global environment variables space are
  895. separated. Local variables are those you define by
  896. simply typing like `name=value'. To access a local
  897. variable later on, you have write `$name' or
  898. `${name}'; variable directly by typing say `$name' at
  899. the command prompt.
  900. Global environment variables are those you use
  901. setenv/printenv to work with. To run a command stored
  902. in such a variable, you need to use the run command,
  903. and you must not use the '$' sign to access them.
  904. To store commands and special characters in a
  905. variable, please use double quotation marks
  906. surrounding the whole text of the variable, instead
  907. of the backslashes before semicolons and special
  908. symbols.
  909. - Default Environment
  910. CONFIG_EXTRA_ENV_SETTINGS
  911. Define this to contain any number of null terminated
  912. strings (variable = value pairs) that will be part of
  913. the default enviroment compiled into the boot image.
  914. For example, place something like this in your
  915. board's config file:
  916. #define CONFIG_EXTRA_ENV_SETTINGS \
  917. "myvar1=value1\0" \
  918. "myvar2=value2\0"
  919. Warning: This method is based on knowledge about the
  920. internal format how the environment is stored by the
  921. U-Boot code. This is NOT an official, exported
  922. interface! Although it is unlikely that this format
  923. will change soon, but there is no guarantee either.
  924. You better know what you are doing here.
  925. Note: overly (ab)use of the default environment is
  926. discouraged. Make sure to check other ways to preset
  927. the environment like the autoscript function or the
  928. boot command first.
  929. - Show boot progress
  930. CONFIG_SHOW_BOOT_PROGRESS
  931. Defining this option allows to add some board-
  932. specific code (calling a user-provided function
  933. "show_boot_progress(int)") that enables you to show
  934. the system's boot progress on some display (for
  935. example, some LED's) on your board. At the moment,
  936. the following checkpoints are implemented:
  937. Arg Where When
  938. 1 common/cmd_bootm.c before attempting to boot an image
  939. -1 common/cmd_bootm.c Image header has bad magic number
  940. 2 common/cmd_bootm.c Image header has correct magic number
  941. -2 common/cmd_bootm.c Image header has bad checksum
  942. 3 common/cmd_bootm.c Image header has correct checksum
  943. -3 common/cmd_bootm.c Image data has bad checksum
  944. 4 common/cmd_bootm.c Image data has correct checksum
  945. -4 common/cmd_bootm.c Image is for unsupported architecture
  946. 5 common/cmd_bootm.c Architecture check OK
  947. -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
  948. 6 common/cmd_bootm.c Image Type check OK
  949. -6 common/cmd_bootm.c gunzip uncompression error
  950. -7 common/cmd_bootm.c Unimplemented compression type
  951. 7 common/cmd_bootm.c Uncompression OK
  952. -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
  953. 8 common/cmd_bootm.c Image Type check OK
  954. -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
  955. 9 common/cmd_bootm.c Start initial ramdisk verification
  956. -10 common/cmd_bootm.c Ramdisk header has bad magic number
  957. -11 common/cmd_bootm.c Ramdisk header has bad checksum
  958. 10 common/cmd_bootm.c Ramdisk header is OK
  959. -12 common/cmd_bootm.c Ramdisk data has bad checksum
  960. 11 common/cmd_bootm.c Ramdisk data has correct checksum
  961. 12 common/cmd_bootm.c Ramdisk verification complete, start loading
  962. -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk)
  963. 13 common/cmd_bootm.c Start multifile image verification
  964. 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue.
  965. 15 common/cmd_bootm.c All preparation done, transferring control to OS
  966. -1 common/cmd_doc.c Bad usage of "doc" command
  967. -1 common/cmd_doc.c No boot device
  968. -1 common/cmd_doc.c Unknown Chip ID on boot device
  969. -1 common/cmd_doc.c Read Error on boot device
  970. -1 common/cmd_doc.c Image header has bad magic number
  971. -1 common/cmd_ide.c Bad usage of "ide" command
  972. -1 common/cmd_ide.c No boot device
  973. -1 common/cmd_ide.c Unknown boot device
  974. -1 common/cmd_ide.c Unknown partition table
  975. -1 common/cmd_ide.c Invalid partition type
  976. -1 common/cmd_ide.c Read Error on boot device
  977. -1 common/cmd_ide.c Image header has bad magic number
  978. -1 common/cmd_nvedit.c Environment not changable, but has bad CRC
  979. Modem Support:
  980. --------------
  981. [so far only for SMDK2400 and TRAB boards]
  982. - Modem support endable:
  983. CONFIG_MODEM_SUPPORT
  984. - RTS/CTS Flow control enable:
  985. CONFIG_HWFLOW
  986. - Modem debug support:
  987. CONFIG_MODEM_SUPPORT_DEBUG
  988. Enables debugging stuff (char screen[1024], dbg())
  989. for modem support. Useful only with BDI2000.
  990. - General:
  991. In the target system modem support is enabled when a
  992. specific key (key combination) is pressed during
  993. power-on. Otherwise U-Boot will boot normally
  994. (autoboot). The key_pressed() fuction is called from
  995. board_init(). Currently key_pressed() is a dummy
  996. function, returning 1 and thus enabling modem
  997. initialization.
  998. If there are no modem init strings in the
  999. environment, U-Boot proceed to autoboot; the
  1000. previous output (banner, info printfs) will be
  1001. supressed, though.
  1002. See also: doc/README.Modem
  1003. Configuration Settings:
  1004. -----------------------
  1005. - CFG_LONGHELP: Defined when you want long help messages included;
  1006. undefine this when you're short of memory.
  1007. - CFG_PROMPT: This is what U-Boot prints on the console to
  1008. prompt for user input.
  1009. - CFG_CBSIZE: Buffer size for input from the Console
  1010. - CFG_PBSIZE: Buffer size for Console output
  1011. - CFG_MAXARGS: max. Number of arguments accepted for monitor commands
  1012. - CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
  1013. the application (usually a Linux kernel) when it is
  1014. booted
  1015. - CFG_BAUDRATE_TABLE:
  1016. List of legal baudrate settings for this board.
  1017. - CFG_CONSOLE_INFO_QUIET
  1018. Suppress display of console information at boot.
  1019. - CFG_CONSOLE_IS_IN_ENV
  1020. If the board specific function
  1021. extern int overwrite_console (void);
  1022. returns 1, the stdin, stderr and stdout are switched to the
  1023. serial port, else the settings in the environment are used.
  1024. - CFG_CONSOLE_OVERWRITE_ROUTINE
  1025. Enable the call to overwrite_console().
  1026. - CFG_CONSOLE_ENV_OVERWRITE
  1027. Enable overwrite of previous console environment settings.
  1028. - CFG_MEMTEST_START, CFG_MEMTEST_END:
  1029. Begin and End addresses of the area used by the
  1030. simple memory test.
  1031. - CFG_ALT_MEMTEST:
  1032. Enable an alternate, more extensive memory test.
  1033. - CFG_TFTP_LOADADDR:
  1034. Default load address for network file downloads
  1035. - CFG_LOADS_BAUD_CHANGE:
  1036. Enable temporary baudrate change while serial download
  1037. - CFG_SDRAM_BASE:
  1038. Physical start address of SDRAM. _Must_ be 0 here.
  1039. - CFG_MBIO_BASE:
  1040. Physical start address of Motherboard I/O (if using a
  1041. Cogent motherboard)
  1042. - CFG_FLASH_BASE:
  1043. Physical start address of Flash memory.
  1044. - CFG_MONITOR_BASE:
  1045. Physical start address of boot monitor code (set by
  1046. make config files to be same as the text base address
  1047. (TEXT_BASE) used when linking) - same as
  1048. CFG_FLASH_BASE when booting from flash.
  1049. - CFG_MONITOR_LEN:
  1050. Size of memory reserved for monitor code
  1051. - CFG_MALLOC_LEN:
  1052. Size of DRAM reserved for malloc() use.
  1053. - CFG_BOOTMAPSZ:
  1054. Maximum size of memory mapped by the startup code of
  1055. the Linux kernel; all data that must be processed by
  1056. the Linux kernel (bd_info, boot arguments, eventually
  1057. initrd image) must be put below this limit.
  1058. - CFG_MAX_FLASH_BANKS:
  1059. Max number of Flash memory banks
  1060. - CFG_MAX_FLASH_SECT:
  1061. Max number of sectors on a Flash chip
  1062. - CFG_FLASH_ERASE_TOUT:
  1063. Timeout for Flash erase operations (in ms)
  1064. - CFG_FLASH_WRITE_TOUT:
  1065. Timeout for Flash write operations (in ms)
  1066. - CFG_DIRECT_FLASH_TFTP:
  1067. Enable TFTP transfers directly to flash memory;
  1068. without this option such a download has to be
  1069. performed in two steps: (1) download to RAM, and (2)
  1070. copy from RAM to flash.
  1071. The two-step approach is usually more reliable, since
  1072. you can check if the download worked before you erase
  1073. the flash, but in some situations (when sytem RAM is
  1074. too limited to allow for a tempory copy of the
  1075. downloaded image) this option may be very useful.
  1076. - CFG_FLASH_CFI:
  1077. Define if the flash driver uses extra elements in the
  1078. common flash structure for storing flash geometry
  1079. The following definitions that deal with the placement and management
  1080. of environment data (variable area); in general, we support the
  1081. following configurations:
  1082. - CFG_ENV_IS_IN_FLASH:
  1083. Define this if the environment is in flash memory.
  1084. a) The environment occupies one whole flash sector, which is
  1085. "embedded" in the text segment with the U-Boot code. This
  1086. happens usually with "bottom boot sector" or "top boot
  1087. sector" type flash chips, which have several smaller
  1088. sectors at the start or the end. For instance, such a
  1089. layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
  1090. such a case you would place the environment in one of the
  1091. 4 kB sectors - with U-Boot code before and after it. With
  1092. "top boot sector" type flash chips, you would put the
  1093. environment in one of the last sectors, leaving a gap
  1094. between U-Boot and the environment.
  1095. - CFG_ENV_OFFSET:
  1096. Offset of environment data (variable area) to the
  1097. beginning of flash memory; for instance, with bottom boot
  1098. type flash chips the second sector can be used: the offset
  1099. for this sector is given here.
  1100. CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
  1101. - CFG_ENV_ADDR:
  1102. This is just another way to specify the start address of
  1103. the flash sector containing the environment (instead of
  1104. CFG_ENV_OFFSET).
  1105. - CFG_ENV_SECT_SIZE:
  1106. Size of the sector containing the environment.
  1107. b) Sometimes flash chips have few, equal sized, BIG sectors.
  1108. In such a case you don't want to spend a whole sector for
  1109. the environment.
  1110. - CFG_ENV_SIZE:
  1111. If you use this in combination with CFG_ENV_IS_IN_FLASH
  1112. and CFG_ENV_SECT_SIZE, you can specify to use only a part
  1113. of this flash sector for the environment. This saves
  1114. memory for the RAM copy of the environment.
  1115. It may also save flash memory if you decide to use this
  1116. when your environment is "embedded" within U-Boot code,
  1117. since then the remainder of the flash sector could be used
  1118. for U-Boot code. It should be pointed out that this is
  1119. STRONGLY DISCOURAGED from a robustness point of view:
  1120. updating the environment in flash makes it always
  1121. necessary to erase the WHOLE sector. If something goes
  1122. wrong before the contents has been restored from a copy in
  1123. RAM, your target system will be dead.
  1124. - CFG_ENV_ADDR_REDUND
  1125. CFG_ENV_SIZE_REDUND
  1126. These settings describe a second storage area used to hold
  1127. a redundand copy of the environment data, so that there is
  1128. a valid backup copy in case there is a power failur during
  1129. a "saveenv" operation.
  1130. BE CAREFUL! Any changes to the flash layout, and some changes to the
  1131. source code will make it necessary to adapt <board>/u-boot.lds*
  1132. accordingly!
  1133. - CFG_ENV_IS_IN_NVRAM:
  1134. Define this if you have some non-volatile memory device
  1135. (NVRAM, battery buffered SRAM) which you want to use for the
  1136. environment.
  1137. - CFG_ENV_ADDR:
  1138. - CFG_ENV_SIZE:
  1139. These two #defines are used to determin the memory area you
  1140. want to use for environment. It is assumed that this memory
  1141. can just be read and written to, without any special
  1142. provision.
  1143. BE CAREFUL! The first access to the environment happens quite early
  1144. in U-Boot initalization (when we try to get the setting of for the
  1145. console baudrate). You *MUST* have mappend your NVRAM area then, or
  1146. U-Boot will hang.
  1147. Please note that even with NVRAM we still use a copy of the
  1148. environment in RAM: we could work on NVRAM directly, but we want to
  1149. keep settings there always unmodified except somebody uses "saveenv"
  1150. to save the current settings.
  1151. - CFG_ENV_IS_IN_EEPROM:
  1152. Use this if you have an EEPROM or similar serial access
  1153. device and a driver for it.
  1154. - CFG_ENV_OFFSET:
  1155. - CFG_ENV_SIZE:
  1156. These two #defines specify the offset and size of the
  1157. environment area within the total memory of your EEPROM.
  1158. - CFG_I2C_EEPROM_ADDR:
  1159. If defined, specified the chip address of the EEPROM device.
  1160. The default address is zero.
  1161. - CFG_EEPROM_PAGE_WRITE_BITS:
  1162. If defined, the number of bits used to address bytes in a
  1163. single page in the EEPROM device. A 64 byte page, for example
  1164. would require six bits.
  1165. - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
  1166. If defined, the number of milliseconds to delay between
  1167. page writes. The default is zero milliseconds.
  1168. - CFG_I2C_EEPROM_ADDR_LEN:
  1169. The length in bytes of the EEPROM memory array address. Note
  1170. that this is NOT the chip address length!
  1171. - CFG_EEPROM_SIZE:
  1172. The size in bytes of the EEPROM device.
  1173. - CFG_SPI_INIT_OFFSET
  1174. Defines offset to the initial SPI buffer area in DPRAM. The
  1175. area is used at an early stage (ROM part) if the environment
  1176. is configured to reside in the SPI EEPROM: We need a 520 byte
  1177. scratch DPRAM area. It is used between the two initialization
  1178. calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
  1179. to be a good choice since it makes it far enough from the
  1180. start of the data area as well as from the stack pointer.
  1181. Please note that the environment is read-only as long as the monitor
  1182. has been relocated to RAM and a RAM copy of the environment has been
  1183. created; also, when using EEPROM you will have to use getenv_r()
  1184. until then to read environment variables.
  1185. The environment is protected by a CRC32 checksum. Before the monitor
  1186. is relocated into RAM, as a result of a bad CRC you will be working
  1187. with the compiled-in default environment - *silently*!!! [This is
  1188. necessary, because the first environment variable we need is the
  1189. "baudrate" setting for the console - if we have a bad CRC, we don't
  1190. have any device yet where we could complain.]
  1191. Note: once the monitor has been relocated, then it will complain if
  1192. the default environment is used; a new CRC is computed as soon as you
  1193. use the "saveenv" command to store a valid environment.
  1194. Low Level (hardware related) configuration options:
  1195. ---------------------------------------------------
  1196. - CFG_CACHELINE_SIZE:
  1197. Cache Line Size of the CPU.
  1198. - CFG_DEFAULT_IMMR:
  1199. Default address of the IMMR after system reset.
  1200. Needed on some 8260 systems (MPC8260ADS and RPXsuper)
  1201. to be able to adjust the position of the IMMR
  1202. register after a reset.
  1203. - Floppy Disk Support:
  1204. CFG_FDC_DRIVE_NUMBER
  1205. the default drive number (default value 0)
  1206. CFG_ISA_IO_STRIDE
  1207. defines the spacing between fdc chipset registers
  1208. (default value 1)
  1209. CFG_ISA_IO_OFFSET
  1210. defines the offset of register from address. It
  1211. depends on which part of the data bus is connected to
  1212. the fdc chipset. (default value 0)
  1213. If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
  1214. CFG_FDC_DRIVE_NUMBER are undefined, they take their
  1215. default value.
  1216. if CFG_FDC_HW_INIT is defined, then the function
  1217. fdc_hw_init() is called at the beginning of the FDC
  1218. setup. fdc_hw_init() must be provided by the board
  1219. source code. It is used to make hardware dependant
  1220. initializations.
  1221. - CFG_IMMR: Physical address of the Internal Memory Mapped
  1222. Register; DO NOT CHANGE! (11-4)
  1223. [MPC8xx systems only]
  1224. - CFG_INIT_RAM_ADDR:
  1225. Start address of memory area tha can be used for
  1226. initial data and stack; please note that this must be
  1227. writable memory that is working WITHOUT special
  1228. initialization, i. e. you CANNOT use normal RAM which
  1229. will become available only after programming the
  1230. memory controller and running certain initialization
  1231. sequences.
  1232. U-Boot uses the following memory types:
  1233. - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
  1234. - MPC824X: data cache
  1235. - PPC4xx: data cache
  1236. - CFG_GBL_DATA_OFFSET:
  1237. Offset of the initial data structure in the memory
  1238. area defined by CFG_INIT_RAM_ADDR. Usually
  1239. CFG_GBL_DATA_OFFSET is chosen such that the initial
  1240. data is located at the end of the available space
  1241. (sometimes written as (CFG_INIT_RAM_END -
  1242. CFG_INIT_DATA_SIZE), and the initial stack is just
  1243. below that area (growing from (CFG_INIT_RAM_ADDR +
  1244. CFG_GBL_DATA_OFFSET) downward.
  1245. Note:
  1246. On the MPC824X (or other systems that use the data
  1247. cache for initial memory) the address chosen for
  1248. CFG_INIT_RAM_ADDR is basically arbitrary - it must
  1249. point to an otherwise UNUSED address space between
  1250. the top of RAM and the start of the PCI space.
  1251. - CFG_SIUMCR: SIU Module Configuration (11-6)
  1252. - CFG_SYPCR: System Protection Control (11-9)
  1253. - CFG_TBSCR: Time Base Status and Control (11-26)
  1254. - CFG_PISCR: Periodic Interrupt Status and Control (11-31)
  1255. - CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
  1256. - CFG_SCCR: System Clock and reset Control Register (15-27)
  1257. - CFG_OR_TIMING_SDRAM:
  1258. SDRAM timing
  1259. - CFG_MAMR_PTA:
  1260. periodic timer for refresh
  1261. - CFG_DER: Debug Event Register (37-47)
  1262. - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
  1263. CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
  1264. CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
  1265. CFG_BR1_PRELIM:
  1266. Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
  1267. - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
  1268. CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
  1269. CFG_OR3_PRELIM, CFG_BR3_PRELIM:
  1270. Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
  1271. - CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
  1272. CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
  1273. Machine Mode Register and Memory Periodic Timer
  1274. Prescaler definitions (SDRAM timing)
  1275. - CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
  1276. enable I2C microcode relocation patch (MPC8xx);
  1277. define relocation offset in DPRAM [DSP2]
  1278. - CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
  1279. enable SPI microcode relocation patch (MPC8xx);
  1280. define relocation offset in DPRAM [SCC4]
  1281. - CFG_USE_OSCCLK:
  1282. Use OSCM clock mode on MBX8xx board. Be careful,
  1283. wrong setting might damage your board. Read
  1284. doc/README.MBX before setting this variable!
  1285. - CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
  1286. Offset of the bootmode word in DPRAM used by post
  1287. (Power On Self Tests). This definition overrides
  1288. #define'd default value in commproc.h resp.
  1289. cpm_8260.h.
  1290. Building the Software:
  1291. ======================
  1292. Building U-Boot has been tested in native PPC environments (on a
  1293. PowerBook G3 running LinuxPPC 2000) and in cross environments
  1294. (running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
  1295. NetBSD 1.5 on x86).
  1296. If you are not using a native PPC environment, it is assumed that you
  1297. have the GNU cross compiling tools available in your path and named
  1298. with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
  1299. you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
  1300. the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
  1301. change it to:
  1302. CROSS_COMPILE = ppc_4xx-
  1303. U-Boot is intended to be simple to build. After installing the
  1304. sources you must configure U-Boot for one specific board type. This
  1305. is done by typing:
  1306. make NAME_config
  1307. where "NAME_config" is the name of one of the existing
  1308. configurations; the following names are supported:
  1309. ADCIOP_config GTH_config TQM850L_config
  1310. ADS860_config IP860_config TQM855L_config
  1311. AR405_config IVML24_config TQM860L_config
  1312. CANBT_config IVMS8_config WALNUT405_config
  1313. CPCI405_config LANTEC_config cogent_common_config
  1314. CPCIISER4_config MBX_config cogent_mpc8260_config
  1315. CU824_config MBX860T_config cogent_mpc8xx_config
  1316. ESTEEM192E_config RPXlite_config hermes_config
  1317. ETX094_config RPXsuper_config hymod_config
  1318. FADS823_config SM850_config lwmon_config
  1319. FADS850SAR_config SPD823TS_config pcu_e_config
  1320. FADS860T_config SXNI855T_config rsdproto_config
  1321. FPS850L_config Sandpoint8240_config sbc8260_config
  1322. GENIETV_config TQM823L_config PIP405_config
  1323. GEN860T_config EBONY_config FPS860L_config
  1324. ELPT860_config cmi_mpc5xx_config
  1325. Note: for some board special configuration names may exist; check if
  1326. additional information is available from the board vendor; for
  1327. instance, the TQM8xxL systems run normally at 50 MHz and use a
  1328. SCC for 10baseT ethernet; there are also systems with 80 MHz
  1329. CPU clock, and an optional Fast Ethernet module is available
  1330. for CPU's with FEC. You can select such additional "features"
  1331. when chosing the configuration, i. e.
  1332. make TQM860L_config
  1333. - will configure for a plain TQM860L, i. e. 50MHz, no FEC
  1334. make TQM860L_FEC_config
  1335. - will configure for a TQM860L at 50MHz with FEC for ethernet
  1336. make TQM860L_80MHz_config
  1337. - will configure for a TQM860L at 80 MHz, with normal 10baseT
  1338. interface
  1339. make TQM860L_FEC_80MHz_config
  1340. - will configure for a TQM860L at 80 MHz with FEC for ethernet
  1341. make TQM823L_LCD_config
  1342. - will configure for a TQM823L with U-Boot console on LCD
  1343. make TQM823L_LCD_80MHz_config
  1344. - will configure for a TQM823L at 80 MHz with U-Boot console on LCD
  1345. etc.
  1346. Finally, type "make all", and you should get some working U-Boot
  1347. images ready for downlod to / installation on your system:
  1348. - "u-boot.bin" is a raw binary image
  1349. - "u-boot" is an image in ELF binary format
  1350. - "u-boot.srec" is in Motorola S-Record format
  1351. Please be aware that the Makefiles assume you are using GNU make, so
  1352. for instance on NetBSD you might need to use "gmake" instead of
  1353. native "make".
  1354. If the system board that you have is not listed, then you will need
  1355. to port U-Boot to your hardware platform. To do this, follow these
  1356. steps:
  1357. 1. Add a new configuration option for your board to the toplevel
  1358. "Makefile" and to the "MAKEALL" script, using the existing
  1359. entries as examples. Note that here and at many other places
  1360. boards and other names are listed alphabetically sorted. Please
  1361. keep this order.
  1362. 2. Create a new directory to hold your board specific code. Add any
  1363. files you need. In your board directory, you will need at least
  1364. the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
  1365. 3. Create a new configuration file "include/configs/<board>.h" for
  1366. your board
  1367. 3. If you're porting U-Boot to a new CPU, then also create a new
  1368. directory to hold your CPU specific code. Add any files you need.
  1369. 4. Run "make <board>_config" with your new name.
  1370. 5. Type "make", and you should get a working "u-boot.srec" file
  1371. to be installed on your target system.
  1372. 6. Debug and solve any problems that might arise.
  1373. [Of course, this last step is much harder than it sounds.]
  1374. Testing of U-Boot Modifications, Ports to New Hardware, etc.:
  1375. ==============================================================
  1376. If you have modified U-Boot sources (for instance added a new board
  1377. or support for new devices, a new CPU, etc.) you are expected to
  1378. provide feedback to the other developers. The feedback normally takes
  1379. the form of a "patch", i. e. a context diff against a certain (latest
  1380. official or latest in CVS) version of U-Boot sources.
  1381. But before you submit such a patch, please verify that your modifi-
  1382. cation did not break existing code. At least make sure that *ALL* of
  1383. the supported boards compile WITHOUT ANY compiler warnings. To do so,
  1384. just run the "MAKEALL" script, which will configure and build U-Boot
  1385. for ALL supported system. Be warned, this will take a while. You can
  1386. select which (cross) compiler to use py passing a `CROSS_COMPILE'
  1387. environment variable to the script, i. e. to use the cross tools from
  1388. MontaVista's Hard Hat Linux you can type
  1389. CROSS_COMPILE=ppc_8xx- MAKEALL
  1390. or to build on a native PowerPC system you can type
  1391. CROSS_COMPILE=' ' MAKEALL
  1392. See also "U-Boot Porting Guide" below.
  1393. Monitor Commands - Overview:
  1394. ============================
  1395. go - start application at address 'addr'
  1396. run - run commands in an environment variable
  1397. bootm - boot application image from memory
  1398. bootp - boot image via network using BootP/TFTP protocol
  1399. tftpboot- boot image via network using TFTP protocol
  1400. and env variables "ipaddr" and "serverip"
  1401. (and eventually "gatewayip")
  1402. rarpboot- boot image via network using RARP/TFTP protocol
  1403. diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
  1404. loads - load S-Record file over serial line
  1405. loadb - load binary file over serial line (kermit mode)
  1406. md - memory display
  1407. mm - memory modify (auto-incrementing)
  1408. nm - memory modify (constant address)
  1409. mw - memory write (fill)
  1410. cp - memory copy
  1411. cmp - memory compare
  1412. crc32 - checksum calculation
  1413. imd - i2c memory display
  1414. imm - i2c memory modify (auto-incrementing)
  1415. inm - i2c memory modify (constant address)
  1416. imw - i2c memory write (fill)
  1417. icrc32 - i2c checksum calculation
  1418. iprobe - probe to discover valid I2C chip addresses
  1419. iloop - infinite loop on address range
  1420. isdram - print SDRAM configuration information
  1421. sspi - SPI utility commands
  1422. base - print or set address offset
  1423. printenv- print environment variables
  1424. setenv - set environment variables
  1425. saveenv - save environment variables to persistent storage
  1426. protect - enable or disable FLASH write protection
  1427. erase - erase FLASH memory
  1428. flinfo - print FLASH memory information
  1429. bdinfo - print Board Info structure
  1430. iminfo - print header information for application image
  1431. coninfo - print console devices and informations
  1432. ide - IDE sub-system
  1433. loop - infinite loop on address range
  1434. mtest - simple RAM test
  1435. icache - enable or disable instruction cache
  1436. dcache - enable or disable data cache
  1437. reset - Perform RESET of the CPU
  1438. echo - echo args to console
  1439. version - print monitor version
  1440. help - print online help
  1441. ? - alias for 'help'
  1442. Monitor Commands - Detailed Description:
  1443. ========================================
  1444. TODO.
  1445. For now: just type "help <command>".
  1446. Environment Variables:
  1447. ======================
  1448. U-Boot supports user configuration using Environment Variables which
  1449. can be made persistent by saving to Flash memory.
  1450. Environment Variables are set using "setenv", printed using
  1451. "printenv", and saved to Flash using "saveenv". Using "setenv"
  1452. without a value can be used to delete a variable from the
  1453. environment. As long as you don't save the environment you are
  1454. working with an in-memory copy. In case the Flash area containing the
  1455. environment is erased by accident, a default environment is provided.
  1456. Some configuration options can be set using Environment Variables:
  1457. baudrate - see CONFIG_BAUDRATE
  1458. bootdelay - see CONFIG_BOOTDELAY
  1459. bootcmd - see CONFIG_BOOTCOMMAND
  1460. bootargs - Boot arguments when booting an RTOS image
  1461. bootfile - Name of the image to load with TFTP
  1462. autoload - if set to "no" (any string beginning with 'n'),
  1463. "bootp" will just load perform a lookup of the
  1464. configuration from the BOOTP server, but not try to
  1465. load any image using TFTP
  1466. autostart - if set to "yes", an image loaded using the "bootp",
  1467. "rarpboot", "tftpboot" or "diskboot" commands will
  1468. be automatically started (by internally calling
  1469. "bootm")
  1470. initrd_high - restrict positioning of initrd images:
  1471. If this variable is not set, initrd images will be
  1472. copied to the highest possible address in RAM; this
  1473. is usually what you want since it allows for
  1474. maximum initrd size. If for some reason you want to
  1475. make sure that the initrd image is loaded below the
  1476. CFG_BOOTMAPSZ limit, you can set this environment
  1477. variable to a value of "no" or "off" or "0".
  1478. Alternatively, you can set it to a maximum upper
  1479. address to use (U-Boot will still check that it
  1480. does not overwrite the U-Boot stack and data).
  1481. For instance, when you have a system with 16 MB
  1482. RAM, and want to reseve 4 MB from use by Linux,
  1483. you can do this by adding "mem=12M" to the value of
  1484. the "bootargs" variable. However, now you must make
  1485. sure, that the initrd image is placed in the first
  1486. 12 MB as well - this can be done with
  1487. setenv initrd_high 00c00000
  1488. ipaddr - IP address; needed for tftpboot command
  1489. loadaddr - Default load address for commands like "bootp",
  1490. "rarpboot", "tftpboot", "loadb" or "diskboot"
  1491. loads_echo - see CONFIG_LOADS_ECHO
  1492. serverip - TFTP server IP address; needed for tftpboot command
  1493. bootretry - see CONFIG_BOOT_RETRY_TIME
  1494. bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
  1495. bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
  1496. The following environment variables may be used and automatically
  1497. updated by the network boot commands ("bootp" and "rarpboot"),
  1498. depending the information provided by your boot server:
  1499. bootfile - see above
  1500. dnsip - IP address of your Domain Name Server
  1501. gatewayip - IP address of the Gateway (Router) to use
  1502. hostname - Target hostname
  1503. ipaddr - see above
  1504. netmask - Subnet Mask
  1505. rootpath - Pathname of the root filesystem on the NFS server
  1506. serverip - see above
  1507. There are two special Environment Variables:
  1508. serial# - contains hardware identification information such
  1509. as type string and/or serial number
  1510. ethaddr - Ethernet address
  1511. These variables can be set only once (usually during manufacturing of
  1512. the board). U-Boot refuses to delete or overwrite these variables
  1513. once they have been set once.
  1514. Please note that changes to some configuration parameters may take
  1515. only effect after the next boot (yes, that's just like Windoze :-).
  1516. Note for Redundant Ethernet Interfaces:
  1517. =======================================
  1518. Some boards come with redundand ethernet interfaces; U-Boot supports
  1519. such configurations and is capable of automatic selection of a
  1520. "working" interface when needed. MAC assignemnt works as follows:
  1521. Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
  1522. MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
  1523. "eth1addr" (=>eth1), "eth2addr", ...
  1524. If the network interface stores some valid MAC address (for instance
  1525. in SROM), this is used as default address if there is NO correspon-
  1526. ding setting in the environment; if the corresponding environment
  1527. variable is set, this overrides the settings in the card; that means:
  1528. o If the SROM has a valid MAC address, and there is no address in the
  1529. environment, the SROM's address is used.
  1530. o If there is no valid address in the SROM, and a definition in the
  1531. environment exists, then the value from the environment variable is
  1532. used.
  1533. o If both the SROM and the environment contain a MAC address, and
  1534. both addresses are the same, this MAC address is used.
  1535. o If both the SROM and the environment contain a MAC address, and the
  1536. addresses differ, the value from the environment is used and a
  1537. warning is printed.
  1538. o If neither SROM nor the environment contain a MAC address, an error
  1539. is raised.
  1540. Image Formats:
  1541. ==============
  1542. The "boot" commands of this monitor operate on "image" files which
  1543. can be basicly anything, preceeded by a special header; see the
  1544. definitions in include/image.h for details; basicly, the header
  1545. defines the following image properties:
  1546. * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
  1547. 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
  1548. LynxOS, pSOS, QNX;
  1549. Currently supported: Linux, NetBSD, VxWorks, QNX).
  1550. * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
  1551. IA64, MIPS, MIPS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
  1552. Currently supported: PowerPC).
  1553. * Compression Type (Provisions for uncompressed, gzip, bzip2;
  1554. Currently supported: uncompressed, gzip).
  1555. * Load Address
  1556. * Entry Point
  1557. * Image Name
  1558. * Image Timestamp
  1559. The header is marked by a special Magic Number, and both the header
  1560. and the data portions of the image are secured against corruption by
  1561. CRC32 checksums.
  1562. Linux Support:
  1563. ==============
  1564. Although U-Boot should support any OS or standalone application
  1565. easily, Linux has always been in the focus during the design of
  1566. U-Boot.
  1567. U-Boot includes many features that so far have been part of some
  1568. special "boot loader" code within the Linux kernel. Also, any
  1569. "initrd" images to be used are no longer part of one big Linux image;
  1570. instead, kernel and "initrd" are separate images. This implementation
  1571. serves serveral purposes:
  1572. - the same features can be used for other OS or standalone
  1573. applications (for instance: using compressed images to reduce the
  1574. Flash memory footprint)
  1575. - it becomes much easier to port new Linux kernel versions because
  1576. lots of low-level, hardware dependend stuff are done by U-Boot
  1577. - the same Linux kernel image can now be used with different "initrd"
  1578. images; of course this also means that different kernel images can
  1579. be run with the same "initrd". This makes testing easier (you don't
  1580. have to build a new "zImage.initrd" Linux image when you just
  1581. change a file in your "initrd"). Also, a field-upgrade of the
  1582. software is easier now.
  1583. Linux HOWTO:
  1584. ============
  1585. Porting Linux to U-Boot based systems:
  1586. ---------------------------------------
  1587. U-Boot cannot save you from doing all the necessary modifications to
  1588. configure the Linux device drivers for use with your target hardware
  1589. (no, we don't intend to provide a full virtual machine interface to
  1590. Linux :-).
  1591. But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
  1592. Just make sure your machine specific header file (for instance
  1593. include/asm-ppc/tqm8xx.h) includes the same definition of the Board
  1594. Information structure as we define in include/u-boot.h, and make
  1595. sure that your definition of IMAP_ADDR uses the same value as your
  1596. U-Boot configuration in CFG_IMMR.
  1597. Configuring the Linux kernel:
  1598. -----------------------------
  1599. No specific requirements for U-Boot. Make sure you have some root
  1600. device (initial ramdisk, NFS) for your target system.
  1601. Building a Linux Image:
  1602. -----------------------
  1603. With U-Boot, "normal" build targets like "zImage" or "bzImage" are
  1604. not used. If you use recent kernel source, a new build target
  1605. "uImage" will exist which automatically builds an image usable by
  1606. U-Boot. Most older kernels also have support for a "pImage" target,
  1607. which was introduced for our predecessor project PPCBoot and uses a
  1608. 100% compatible format.
  1609. Example:
  1610. make TQM850L_config
  1611. make oldconfig
  1612. make dep
  1613. make uImage
  1614. The "uImage" build target uses a special tool (in 'tools/mkimage') to
  1615. encapsulate a compressed Linux kernel image with header information,
  1616. CRC32 checksum etc. for use with U-Boot. This is what we are doing:
  1617. * build a standard "vmlinux" kernel image (in ELF binary format):
  1618. * convert the kernel into a raw binary image:
  1619. ${CROSS_COMPILE}-objcopy -O binary \
  1620. -R .note -R .comment \
  1621. -S vmlinux linux.bin
  1622. * compress the binary image:
  1623. gzip -9 linux.bin
  1624. * package compressed binary image for U-Boot:
  1625. mkimage -A ppc -O linux -T kernel -C gzip \
  1626. -a 0 -e 0 -n "Linux Kernel Image" \
  1627. -d linux.bin.gz uImage
  1628. The "mkimage" tool can also be used to create ramdisk images for use
  1629. with U-Boot, either separated from the Linux kernel image, or
  1630. combined into one file. "mkimage" encapsulates the images with a 64
  1631. byte header containing information about target architecture,
  1632. operating system, image type, compression method, entry points, time
  1633. stamp, CRC32 checksums, etc.
  1634. "mkimage" can be called in two ways: to verify existing images and
  1635. print the header information, or to build new images.
  1636. In the first form (with "-l" option) mkimage lists the information
  1637. contained in the header of an existing U-Boot image; this includes
  1638. checksum verification:
  1639. tools/mkimage -l image
  1640. -l ==> list image header information
  1641. The second form (with "-d" option) is used to build a U-Boot image
  1642. from a "data file" which is used as image payload:
  1643. tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
  1644. -n name -d data_file image
  1645. -A ==> set architecture to 'arch'
  1646. -O ==> set operating system to 'os'
  1647. -T ==> set image type to 'type'
  1648. -C ==> set compression type 'comp'
  1649. -a ==> set load address to 'addr' (hex)
  1650. -e ==> set entry point to 'ep' (hex)
  1651. -n ==> set image name to 'name'
  1652. -d ==> use image data from 'datafile'
  1653. Right now, all Linux kernels use the same load address (0x00000000),
  1654. but the entry point address depends on the kernel version:
  1655. - 2.2.x kernels have the entry point at 0x0000000C,
  1656. - 2.3.x and later kernels have the entry point at 0x00000000.
  1657. So a typical call to build a U-Boot image would read:
  1658. -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
  1659. > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
  1660. > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
  1661. > examples/uImage.TQM850L
  1662. Image Name: 2.4.4 kernel for TQM850L
  1663. Created: Wed Jul 19 02:34:59 2000
  1664. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  1665. Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
  1666. Load Address: 0x00000000
  1667. Entry Point: 0x00000000
  1668. To verify the contents of the image (or check for corruption):
  1669. -> tools/mkimage -l examples/uImage.TQM850L
  1670. Image Name: 2.4.4 kernel for TQM850L
  1671. Created: Wed Jul 19 02:34:59 2000
  1672. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  1673. Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
  1674. Load Address: 0x00000000
  1675. Entry Point: 0x00000000
  1676. NOTE: for embedded systems where boot time is critical you can trade
  1677. speed for memory and install an UNCOMPRESSED image instead: this
  1678. needs more space in Flash, but boots much faster since it does not
  1679. need to be uncompressed:
  1680. -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
  1681. -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
  1682. > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
  1683. > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
  1684. > examples/uImage.TQM850L-uncompressed
  1685. Image Name: 2.4.4 kernel for TQM850L
  1686. Created: Wed Jul 19 02:34:59 2000
  1687. Image Type: PowerPC Linux Kernel Image (uncompressed)
  1688. Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
  1689. Load Address: 0x00000000
  1690. Entry Point: 0x00000000
  1691. Similar you can build U-Boot images from a 'ramdisk.image.gz' file
  1692. when your kernel is intended to use an initial ramdisk:
  1693. -> tools/mkimage -n 'Simple Ramdisk Image' \
  1694. > -A ppc -O linux -T ramdisk -C gzip \
  1695. > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
  1696. Image Name: Simple Ramdisk Image
  1697. Created: Wed Jan 12 14:01:50 2000
  1698. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  1699. Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
  1700. Load Address: 0x00000000
  1701. Entry Point: 0x00000000
  1702. Installing a Linux Image:
  1703. -------------------------
  1704. To downloading a U-Boot image over the serial (console) interface,
  1705. you must convert the image to S-Record format:
  1706. objcopy -I binary -O srec examples/image examples/image.srec
  1707. The 'objcopy' does not understand the information in the U-Boot
  1708. image header, so the resulting S-Record file will be relative to
  1709. address 0x00000000. To load it to a given address, you need to
  1710. specify the target address as 'offset' parameter with the 'loads'
  1711. command.
  1712. Example: install the image to address 0x40100000 (which on the
  1713. TQM8xxL is in the first Flash bank):
  1714. => erase 40100000 401FFFFF
  1715. .......... done
  1716. Erased 8 sectors
  1717. => loads 40100000
  1718. ## Ready for S-Record download ...
  1719. ~>examples/image.srec
  1720. 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
  1721. ...
  1722. 15989 15990 15991 15992
  1723. [file transfer complete]
  1724. [connected]
  1725. ## Start Addr = 0x00000000
  1726. You can check the success of the download using the 'iminfo' command;
  1727. this includes a checksum verification so you can be sure no data
  1728. corruption happened:
  1729. => imi 40100000
  1730. ## Checking Image at 40100000 ...
  1731. Image Name: 2.2.13 for initrd on TQM850L
  1732. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  1733. Data Size: 335725 Bytes = 327 kB = 0 MB
  1734. Load Address: 00000000
  1735. Entry Point: 0000000c
  1736. Verifying Checksum ... OK
  1737. Boot Linux:
  1738. -----------
  1739. The "bootm" command is used to boot an application that is stored in
  1740. memory (RAM or Flash). In case of a Linux kernel image, the contents
  1741. of the "bootargs" environment variable is passed to the kernel as
  1742. parameters. You can check and modify this variable using the
  1743. "printenv" and "setenv" commands:
  1744. => printenv bootargs
  1745. bootargs=root=/dev/ram
  1746. => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  1747. => printenv bootargs
  1748. bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  1749. => bootm 40020000
  1750. ## Booting Linux kernel at 40020000 ...
  1751. Image Name: 2.2.13 for NFS on TQM850L
  1752. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  1753. Data Size: 381681 Bytes = 372 kB = 0 MB
  1754. Load Address: 00000000
  1755. Entry Point: 0000000c
  1756. Verifying Checksum ... OK
  1757. Uncompressing Kernel Image ... OK
  1758. 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
  1759. Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
  1760. time_init: decrementer frequency = 187500000/60
  1761. Calibrating delay loop... 49.77 BogoMIPS
  1762. Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
  1763. ...
  1764. If you want to boot a Linux kernel with initial ram disk, you pass
  1765. the memory addreses of both the kernel and the initrd image (PPBCOOT
  1766. format!) to the "bootm" command:
  1767. => imi 40100000 40200000
  1768. ## Checking Image at 40100000 ...
  1769. Image Name: 2.2.13 for initrd on TQM850L
  1770. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  1771. Data Size: 335725 Bytes = 327 kB = 0 MB
  1772. Load Address: 00000000
  1773. Entry Point: 0000000c
  1774. Verifying Checksum ... OK
  1775. ## Checking Image at 40200000 ...
  1776. Image Name: Simple Ramdisk Image
  1777. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  1778. Data Size: 566530 Bytes = 553 kB = 0 MB
  1779. Load Address: 00000000
  1780. Entry Point: 00000000
  1781. Verifying Checksum ... OK
  1782. => bootm 40100000 40200000
  1783. ## Booting Linux kernel at 40100000 ...
  1784. Image Name: 2.2.13 for initrd on TQM850L
  1785. Image Type: PowerPC Linux Kernel Image (gzip compressed)
  1786. Data Size: 335725 Bytes = 327 kB = 0 MB
  1787. Load Address: 00000000
  1788. Entry Point: 0000000c
  1789. Verifying Checksum ... OK
  1790. Uncompressing Kernel Image ... OK
  1791. ## Loading RAMDisk Image at 40200000 ...
  1792. Image Name: Simple Ramdisk Image
  1793. Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
  1794. Data Size: 566530 Bytes = 553 kB = 0 MB
  1795. Load Address: 00000000
  1796. Entry Point: 00000000
  1797. Verifying Checksum ... OK
  1798. Loading Ramdisk ... OK
  1799. 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
  1800. Boot arguments: root=/dev/ram
  1801. time_init: decrementer frequency = 187500000/60
  1802. Calibrating delay loop... 49.77 BogoMIPS
  1803. ...
  1804. RAMDISK: Compressed image found at block 0
  1805. VFS: Mounted root (ext2 filesystem).
  1806. bash#
  1807. More About U-Boot Image Types:
  1808. ------------------------------
  1809. U-Boot supports the following image types:
  1810. "Standalone Programs" are directly runnable in the environment
  1811. provided by U-Boot; it is expected that (if they behave
  1812. well) you can continue to work in U-Boot after return from
  1813. the Standalone Program.
  1814. "OS Kernel Images" are usually images of some Embedded OS which
  1815. will take over control completely. Usually these programs
  1816. will install their own set of exception handlers, device
  1817. drivers, set up the MMU, etc. - this means, that you cannot
  1818. expect to re-enter U-Boot except by resetting the CPU.
  1819. "RAMDisk Images" are more or less just data blocks, and their
  1820. parameters (address, size) are passed to an OS kernel that is
  1821. being started.
  1822. "Multi-File Images" contain several images, typically an OS
  1823. (Linux) kernel image and one or more data images like
  1824. RAMDisks. This construct is useful for instance when you want
  1825. to boot over the network using BOOTP etc., where the boot
  1826. server provides just a single image file, but you want to get
  1827. for instance an OS kernel and a RAMDisk image.
  1828. "Multi-File Images" start with a list of image sizes, each
  1829. image size (in bytes) specified by an "uint32_t" in network
  1830. byte order. This list is terminated by an "(uint32_t)0".
  1831. Immediately after the terminating 0 follow the images, one by
  1832. one, all aligned on "uint32_t" boundaries (size rounded up to
  1833. a multiple of 4 bytes).
  1834. "Firmware Images" are binary images containing firmware (like
  1835. U-Boot or FPGA images) which usually will be programmed to
  1836. flash memory.
  1837. "Script files" are command sequences that will be executed by
  1838. U-Boot's command interpreter; this feature is especially
  1839. useful when you configure U-Boot to use a real shell (hush)
  1840. as command interpreter.
  1841. Standalone HOWTO:
  1842. =================
  1843. One of the features of U-Boot is that you can dynamically load and
  1844. run "standalone" applications, which can use some resources of
  1845. U-Boot like console I/O functions or interrupt services.
  1846. Two simple examples are included with the sources:
  1847. "Hello World" Demo:
  1848. -------------------
  1849. 'examples/hello_world.c' contains a small "Hello World" Demo
  1850. application; it is automatically compiled when you build U-Boot.
  1851. It's configured to run at address 0x00040004, so you can play with it
  1852. like that:
  1853. => loads
  1854. ## Ready for S-Record download ...
  1855. ~>examples/hello_world.srec
  1856. 1 2 3 4 5 6 7 8 9 10 11 ...
  1857. [file transfer complete]
  1858. [connected]
  1859. ## Start Addr = 0x00040004
  1860. => go 40004 Hello World! This is a test.
  1861. ## Starting application at 0x00040004 ...
  1862. Hello World
  1863. argc = 7
  1864. argv[0] = "40004"
  1865. argv[1] = "Hello"
  1866. argv[2] = "World!"
  1867. argv[3] = "This"
  1868. argv[4] = "is"
  1869. argv[5] = "a"
  1870. argv[6] = "test."
  1871. argv[7] = "<NULL>"
  1872. Hit any key to exit ...
  1873. ## Application terminated, rc = 0x0
  1874. Another example, which demonstrates how to register a CPM interrupt
  1875. handler with the U-Boot code, can be found in 'examples/timer.c'.
  1876. Here, a CPM timer is set up to generate an interrupt every second.
  1877. The interrupt service routine is trivial, just printing a '.'
  1878. character, but this is just a demo program. The application can be
  1879. controlled by the following keys:
  1880. ? - print current values og the CPM Timer registers
  1881. b - enable interrupts and start timer
  1882. e - stop timer and disable interrupts
  1883. q - quit application
  1884. => loads
  1885. ## Ready for S-Record download ...
  1886. ~>examples/timer.srec
  1887. 1 2 3 4 5 6 7 8 9 10 11 ...
  1888. [file transfer complete]
  1889. [connected]
  1890. ## Start Addr = 0x00040004
  1891. => go 40004
  1892. ## Starting application at 0x00040004 ...
  1893. TIMERS=0xfff00980
  1894. Using timer 1
  1895. tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
  1896. Hit 'b':
  1897. [q, b, e, ?] Set interval 1000000 us
  1898. Enabling timer
  1899. Hit '?':
  1900. [q, b, e, ?] ........
  1901. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
  1902. Hit '?':
  1903. [q, b, e, ?] .
  1904. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
  1905. Hit '?':
  1906. [q, b, e, ?] .
  1907. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
  1908. Hit '?':
  1909. [q, b, e, ?] .
  1910. tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
  1911. Hit 'e':
  1912. [q, b, e, ?] ...Stopping timer
  1913. Hit 'q':
  1914. [q, b, e, ?] ## Application terminated, rc = 0x0
  1915. Minicom warning:
  1916. ================
  1917. Over time, many people have reported problems when trying to used the
  1918. "minicom" terminal emulation program for serial download. I (wd)
  1919. consider minicom to be broken, and recommend not to use it. Under
  1920. Unix, I recommend to use CKermit for general purpose use (and
  1921. especially for kermit binary protocol download ("loadb" command), and
  1922. use "cu" for S-Record download ("loads" command).
  1923. NetBSD Notes:
  1924. =============
  1925. Starting at version 0.9.2, U-Boot supports NetBSD both as host
  1926. (build U-Boot) and target system (boots NetBSD/mpc8xx).
  1927. Building requires a cross environment; it is known to work on
  1928. NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
  1929. need gmake since the Makefiles are not compatible with BSD make).
  1930. Note that the cross-powerpc package does not install include files;
  1931. attempting to build U-Boot will fail because <machine/ansi.h> is
  1932. missing. This file has to be installed and patched manually:
  1933. # cd /usr/pkg/cross/powerpc-netbsd/include
  1934. # mkdir powerpc
  1935. # ln -s powerpc machine
  1936. # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
  1937. # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
  1938. Native builds *don't* work due to incompatibilities between native
  1939. and U-Boot include files.
  1940. Booting assumes that (the first part of) the image booted is a
  1941. stage-2 loader which in turn loads and then invokes the kernel
  1942. proper. Loader sources will eventually appear in the NetBSD source
  1943. tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
  1944. meantime, send mail to bruno@exet-ag.de and/or wd@denx.de for
  1945. details.
  1946. Implementation Internals:
  1947. =========================
  1948. The following is not intended to be a complete description of every
  1949. implementation detail. However, it should help to understand the
  1950. inner workings of U-Boot and make it easier to port it to custom
  1951. hardware.
  1952. Initial Stack, Global Data:
  1953. ---------------------------
  1954. The implementation of U-Boot is complicated by the fact that U-Boot
  1955. starts running out of ROM (flash memory), usually without access to
  1956. system RAM (because the memory controller is not initialized yet).
  1957. This means that we don't have writable Data or BSS segments, and BSS
  1958. is not initialized as zero. To be able to get a C environment working
  1959. at all, we have to allocate at least a minimal stack. Implementation
  1960. options for this are defined and restricted by the CPU used: Some CPU
  1961. models provide on-chip memory (like the IMMR area on MPC8xx and
  1962. MPC826x processors), on others (parts of) the data cache can be
  1963. locked as (mis-) used as memory, etc.
  1964. Chris Hallinan posted a good summy of these issues to the
  1965. u-boot-users mailing list:
  1966. Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
  1967. From: "Chris Hallinan" <clh@net1plus.com>
  1968. Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
  1969. ...
  1970. Correct me if I'm wrong, folks, but the way I understand it
  1971. is this: Using DCACHE as initial RAM for Stack, etc, does not
  1972. require any physical RAM backing up the cache. The cleverness
  1973. is that the cache is being used as a temporary supply of
  1974. necessary storage before the SDRAM controller is setup. It's
  1975. beyond the scope of this list to expain the details, but you
  1976. can see how this works by studying the cache architecture and
  1977. operation in the architecture and processor-specific manuals.
  1978. OCM is On Chip Memory, which I believe the 405GP has 4K. It
  1979. is another option for the system designer to use as an
  1980. initial stack/ram area prior to SDRAM being available. Either
  1981. option should work for you. Using CS 4 should be fine if your
  1982. board designers haven't used it for something that would
  1983. cause you grief during the initial boot! It is frequently not
  1984. used.
  1985. CFG_INIT_RAM_ADDR should be somewhere that won't interfere
  1986. with your processor/board/system design. The default value
  1987. you will find in any recent u-boot distribution in
  1988. Walnut405.h should work for you. I'd set it to a value larger
  1989. than your SDRAM module. If you have a 64MB SDRAM module, set
  1990. it above 400_0000. Just make sure your board has no resources
  1991. that are supposed to respond to that address! That code in
  1992. start.S has been around a while and should work as is when
  1993. you get the config right.
  1994. -Chris Hallinan
  1995. DS4.COM, Inc.
  1996. It is essential to remember this, since it has some impact on the C
  1997. code for the initialization procedures:
  1998. * Initialized global data (data segment) is read-only. Do not attempt
  1999. to write it.
  2000. * Do not use any unitialized global data (or implicitely initialized
  2001. as zero data - BSS segment) at all - this is undefined, initiali-
  2002. zation is performed later (when relocationg to RAM).
  2003. * Stack space is very limited. Avoid big data buffers or things like
  2004. that.
  2005. Having only the stack as writable memory limits means we cannot use
  2006. normal global data to share information beween the code. But it
  2007. turned out that the implementation of U-Boot can be greatly
  2008. simplified by making a global data structure (gd_t) available to all
  2009. functions. We could pass a pointer to this data as argument to _all_
  2010. functions, but this would bloat the code. Instead we use a feature of
  2011. the GCC compiler (Global Register Variables) to share the data: we
  2012. place a pointer (gd) to the global data into a register which we
  2013. reserve for this purpose.
  2014. When chosing a register for such a purpose we are restricted by the
  2015. relevant (E)ABI specifications for the current architecture, and by
  2016. GCC's implementation.
  2017. For PowerPC, the following registers have specific use:
  2018. R1: stack pointer
  2019. R2: TOC pointer
  2020. R3-R4: parameter passing and return values
  2021. R5-R10: parameter passing
  2022. R13: small data area pointer
  2023. R30: GOT pointer
  2024. R31: frame pointer
  2025. (U-Boot also uses R14 as internal GOT pointer.)
  2026. ==> U-Boot will use R29 to hold a pointer to the global data
  2027. Note: on PPC, we could use a static initializer (since the
  2028. address of the global data structure is known at compile time),
  2029. but it turned out that reserving a register results in somewhat
  2030. smaller code - although the code savings are not that big (on
  2031. average for all boards 752 bytes for the whole U-Boot image,
  2032. 624 text + 127 data).
  2033. On ARM, the following registers are used:
  2034. R0: function argument word/integer result
  2035. R1-R3: function argument word
  2036. R9: GOT pointer
  2037. R10: stack limit (used only if stack checking if enabled)
  2038. R11: argument (frame) pointer
  2039. R12: temporary workspace
  2040. R13: stack pointer
  2041. R14: link register
  2042. R15: program counter
  2043. ==> U-Boot will use R8 to hold a pointer to the global data
  2044. Memory Management:
  2045. ------------------
  2046. U-Boot runs in system state and uses physical addresses, i.e. the
  2047. MMU is not used either for address mapping nor for memory protection.
  2048. The available memory is mapped to fixed addresses using the memory
  2049. controller. In this process, a contiguous block is formed for each
  2050. memory type (Flash, SDRAM, SRAM), even when it consists of several
  2051. physical memory banks.
  2052. U-Boot is installed in the first 128 kB of the first Flash bank (on
  2053. TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
  2054. booting and sizing and initializing DRAM, the code relocates itself
  2055. to the upper end of DRAM. Immediately below the U-Boot code some
  2056. memory is reserved for use by malloc() [see CFG_MALLOC_LEN
  2057. configuration setting]. Below that, a structure with global Board
  2058. Info data is placed, followed by the stack (growing downward).
  2059. Additionally, some exception handler code is copied to the low 8 kB
  2060. of DRAM (0x00000000 ... 0x00001FFF).
  2061. So a typical memory configuration with 16 MB of DRAM could look like
  2062. this:
  2063. 0x0000 0000 Exception Vector code
  2064. :
  2065. 0x0000 1FFF
  2066. 0x0000 2000 Free for Application Use
  2067. :
  2068. :
  2069. :
  2070. :
  2071. 0x00FB FF20 Monitor Stack (Growing downward)
  2072. 0x00FB FFAC Board Info Data and permanent copy of global data
  2073. 0x00FC 0000 Malloc Arena
  2074. :
  2075. 0x00FD FFFF
  2076. 0x00FE 0000 RAM Copy of Monitor Code
  2077. ... eventually: LCD or video framebuffer
  2078. ... eventually: pRAM (Protected RAM - unchanged by reset)
  2079. 0x00FF FFFF [End of RAM]
  2080. System Initialization:
  2081. ----------------------
  2082. In the reset configuration, U-Boot starts at the reset entry point
  2083. (on most PowerPC systens at address 0x00000100). Because of the reset
  2084. configuration for CS0# this is a mirror of the onboard Flash memory.
  2085. To be able to re-map memory U-Boot then jumps to it's link address.
  2086. To be able to implement the initialization code in C, a (small!)
  2087. initial stack is set up in the internal Dual Ported RAM (in case CPUs
  2088. which provide such a feature like MPC8xx or MPC8260), or in a locked
  2089. part of the data cache. After that, U-Boot initializes the CPU core,
  2090. the caches and the SIU.
  2091. Next, all (potentially) available memory banks are mapped using a
  2092. preliminary mapping. For example, we put them on 512 MB boundaries
  2093. (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
  2094. on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
  2095. programmed for SDRAM access. Using the temporary configuration, a
  2096. simple memory test is run that determines the size of the SDRAM
  2097. banks.
  2098. When there is more than one SDRAM bank, and the banks are of
  2099. different size, the larger is mapped first. For equal size, the first
  2100. bank (CS2#) is mapped first. The first mapping is always for address
  2101. 0x00000000, with any additional banks following immediately to create
  2102. contiguous memory starting from 0.
  2103. Then, the monitor installs itself at the upper end of the SDRAM area
  2104. and allocates memory for use by malloc() and for the global Board
  2105. Info data; also, the exception vector code is copied to the low RAM
  2106. pages, and the final stack is set up.
  2107. Only after this relocation will you have a "normal" C environment;
  2108. until that you are restricted in several ways, mostly because you are
  2109. running from ROM, and because the code will have to be relocated to a
  2110. new address in RAM.
  2111. U-Boot Porting Guide:
  2112. ----------------------
  2113. [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
  2114. list, October 2002]
  2115. int main (int argc, char *argv[])
  2116. {
  2117. sighandler_t no_more_time;
  2118. signal (SIGALRM, no_more_time);
  2119. alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
  2120. if (available_money > available_manpower) {
  2121. pay consultant to port U-Boot;
  2122. return 0;
  2123. }
  2124. Download latest U-Boot source;
  2125. Subscribe to u-boot-users mailing list;
  2126. if (clueless) {
  2127. email ("Hi, I am new to U-Boot, how do I get started?");
  2128. }
  2129. while (learning) {
  2130. Read the README file in the top level directory;
  2131. Read http://www.denx.de/re/DPLG.html
  2132. Read the source, Luke;
  2133. }
  2134. if (available_money > toLocalCurrency ($2500)) {
  2135. Buy a BDI2000;
  2136. } else {
  2137. Add a lot of aggravation and time;
  2138. }
  2139. Create your own board support subdirectory;
  2140. Create your own board config file;
  2141. while (!running) {
  2142. do {
  2143. Add / modify source code;
  2144. } until (compiles);
  2145. Debug;
  2146. if (clueless)
  2147. email ("Hi, I am having problems...");
  2148. }
  2149. Send patch file to Wolfgang;
  2150. return 0;
  2151. }
  2152. void no_more_time (int sig)
  2153. {
  2154. hire_a_guru();
  2155. }
  2156. Coding Standards:
  2157. -----------------
  2158. All contributions to U-Boot should conform to the Linux kernel
  2159. coding style; see the file "Documentation/CodingStyle" in your Linux
  2160. kernel source directory.
  2161. Please note that U-Boot is implemented in C (and to some small parts
  2162. in Assembler); no C++ is used, so please do not use C++ style
  2163. comments (//) in your code.
  2164. Submissions which do not conform to the standards may be returned
  2165. with a request to reformat the changes.
  2166. Submitting Patches:
  2167. -------------------
  2168. Since the number of patches for U-Boot is growing, we need to
  2169. establish some rules. Submissions which do not conform to these rules
  2170. may be rejected, even when they contain important and valuable stuff.
  2171. When you send a patch, please include the following information with
  2172. it:
  2173. * For bug fixes: a description of the bug and how your patch fixes
  2174. this bug. Please try to include a way of demonstrating that the
  2175. patch actually fixes something.
  2176. * For new features: a description of the feature and your
  2177. implementation.
  2178. * A CHANGELOG entry as plaintext (separate from the patch)
  2179. * For major contributions, your entry to the CREDITS file
  2180. * When you add support for a new board, don't forget to add this
  2181. board to the MAKEALL script, too.
  2182. * If your patch adds new configuration options, don't forget to
  2183. document these in the README file.
  2184. * The patch itself. If you are accessing the CVS repository use "cvs
  2185. update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
  2186. version of diff does not support these options, then get the latest
  2187. version of GNU diff.
  2188. We accept patches as plain text, MIME attachments or as uuencoded
  2189. gzipped text.
  2190. Notes:
  2191. * Before sending the patch, run the MAKEALL script on your patched
  2192. source tree and make sure that no errors or warnings are reported
  2193. for any of the boards.
  2194. * Keep your modifications to the necessary minimum: A patch
  2195. containing several unrelated changes or arbitrary reformats will be
  2196. returned with a request to re-formatting / split it.
  2197. * If you modify existing code, make sure that your new code does not
  2198. add to the memory footprint of the code ;-) Small is beautiful!
  2199. When adding new features, these should compile conditionally only
  2200. (using #ifdef), and the resulting code with the new feature
  2201. disabled must not need more memory than the old code without your
  2202. modification.