README 91 KB

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