README 92 KB

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