README 109 KB

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