README 108 KB

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