README 97 KB

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