Eric Lee / smarc-uboot

Download as
Browse Code ยป

Commit 218ca724c08ca8a649f0917cf201cf23d4b33f39

Authored by Wolfgang Denk
1 parent f6b44e0e4d
Exists in master and in 54 other branches 8qm-imx_v2020.04_5.4.70_2.3.0, emb_lf_v2022.04, imx_v2015.04_4.1.15_1.0.0_ga, pitx_8mp_lf_v2020.04, smarc-8m-android-10.0.0_2.6.0, smarc-8m-android-11.0.0_2.0.0, smarc-8mp-android-11.0.0_2.0.0, smarc-emmc-imx_v2014.04_3.10.53_1.1.0_ga, smarc-emmc-imx_v2014.04_3.14.28_1.0.0_ga, smarc-imx-l5.0.0_1.0.0-ga, smarc-imx6_v2018.03_4.14.98_2.0.0_ga, smarc-imx7_v2017.03_4.9.11_1.0.0_ga, smarc-imx7_v2018.03_4.14.98_2.0.0_ga, smarc-imx_v2014.04_3.14.28_1.0.0_ga, smarc-imx_v2015.04_4.1.15_1.0.0_ga, smarc-imx_v2017.03_4.9.11_1.0.0_ga, smarc-imx_v2017.03_4.9.88_2.0.0_ga, smarc-imx_v2017.03_o8.1.0_1.3.0_8m, smarc-imx_v2018.03_4.14.78_1.0.0_ga, smarc-m6.0.1_2.1.0-ga, smarc-n7.1.2_2.0.0-ga, smarc-rel_imx_4.1.15_2.0.0_ga, smarc_8m-imx_v2018.03_4.14.98_2.0.0_ga, smarc_8m-imx_v2019.04_4.19.35_1.1.0, smarc_8m_00d0-imx_v2018.03_4.14.98_2.0.0_ga, smarc_8mm-imx_v2018.03_4.14.98_2.0.0_ga, smarc_8mm-imx_v2019.04_4.19.35_1.1.0, smarc_8mm-imx_v2020.04_5.4.24_2.1.0, smarc_8mp_lf_v2020.04, smarc_8mq-imx_v2020.04_5.4.24_2.1.0, smarc_8mq_lf_v2020.04, ti-u-boot-2015.07, u-boot-2013.01.y, v2013.10, v2013.10-smarct33, v2013.10-smartmen, v2014.01, v2014.04, v2014.04-smarct33, v2014.04-smarct33-emmc, v2014.04-smartmen, v2014.07, v2014.07-smarct33, v2014.07-smartmen, v2015.07-smarct33, v2015.07-smarct33-emmc, v2015.07-smarct4x, v2016.05-dlt, v2016.05-smarct3x, v2016.05-smarct3x-emmc, v2016.05-smarct4x, v2017.01-smarct3x, v2017.01-smarct3x-emmc, v2017.01-smarct4x

README: update documentation (availability, links, etc.) 

Signed-off-by: Wolfgang Denk <wd@denx.de>

Showing 1 changed file with 94 additions and 63 deletions Side-by-side Diff

1 1 #
2   -# (C) Copyright 2000 - 2005
  2 +# (C) Copyright 2000 - 2008
3 3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 4 #
5 5 # See file CREDITS for list of people who contributed to this
... ... @@ -51,7 +51,8 @@
51 51 "working". In fact, many of them are used in production systems.
52 52  
53 53 In case of problems see the CHANGELOG and CREDITS files to find out
54   -who contributed the specific port.
  54 +who contributed the specific port. The MAINTAINERS file lists board
  55 +maintainers.
55 56  
56 57  
57 58 Where to get help:
... ... @@ -65,6 +66,22 @@
65 66 http://lists.sourceforge.net/lists/listinfo/u-boot-users/
66 67  
67 68  
  69 +Where to get source code:
  70 +=========================
  71 +
  72 +The U-Boot source code is maintained in the git repository at
  73 +git://www.denx.de/git/u-boot.git ; you can browse it online at
  74 +http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
  75 +
  76 +The "snapshot" links on this page allow you to download tarballs of
  77 +any version you might be interested in. Ofifcial releases are also
  78 +available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
  79 +directory.
  80 +
  81 +Pre-build (and tested) images are available from
  82 +ftp://ftp.denx.de/pub/u-boot/images/
  83 +
  84 +
68 85 Where we come from:
69 86 ===================
70 87  
... ... @@ -81,6 +98,7 @@
81 98 - create ARMBoot project (http://sourceforge.net/projects/armboot)
82 99 - add other CPU families (starting with ARM)
83 100 - create U-Boot project (http://sourceforge.net/projects/u-boot)
  101 +- current project page: see http://www.denx.de/wiki/UBoot
84 102  
85 103  
86 104 Names and Spelling:
... ... @@ -168,7 +186,7 @@
168 186 - lib_mips Files generic to MIPS architecture
169 187 - lib_nios Files generic to NIOS architecture
170 188 - lib_ppc Files generic to PowerPC architecture
171   -- libfdt Library files to support flattened device trees
  189 +- libfdt Library files to support flattened device trees
172 190 - net Networking code
173 191 - post Power On Self Test
174 192 - rtc Real Time Clock drivers
... ... @@ -320,7 +338,7 @@
320 338 converts clock data to MHZ before passing it to the
321 339 Linux kernel.
322 340 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
323   - "clocks_in_mhz=1" is automatically included in the
  341 + "clocks_in_mhz=1" is automatically included in the
324 342 default environment.
325 343  
326 344 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
... ... @@ -686,9 +704,9 @@
686 704 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
687 705 and/or CONFIG_ISO_PARTITION
688 706  
689   - If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
690   - CONFIG_CMD_SCSI) you must configure support for at least
691   - one partition type as well.
  707 + If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
  708 + CONFIG_CMD_SCSI) you must configure support for at
  709 + least one partition type as well.
692 710  
693 711 - IDE Reset method:
694 712 CONFIG_IDE_RESET_ROUTINE - this is defined in several
... ... @@ -1325,7 +1343,7 @@
1325 1343 This option specifies a list of I2C devices that will be skipped
1326 1344 when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1327 1345 command). If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
1328   - pairs. Otherwise, specify a 1D array of device addresses
  1346 + pairs. Otherwise, specify a 1D array of device addresses
1329 1347  
1330 1348 e.g.
1331 1349 #undef CONFIG_I2C_MULTI_BUS
1332 1350  
1333 1351  
1334 1352  
... ... @@ -2324,22 +2342,24 @@
2324 2342 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2325 2343  
2326 2344 - CONFIG_SPD_EEPROM
2327   - Get DDR timing information from an I2C EEPROM. Common with pluggable
2328   - memory modules such as SODIMMs
  2345 + Get DDR timing information from an I2C EEPROM. Common
  2346 + with pluggable memory modules such as SODIMMs
  2347 +
2329 2348 SPD_EEPROM_ADDRESS
2330 2349 I2C address of the SPD EEPROM
2331 2350  
2332 2351 - CFG_SPD_BUS_NUM
2333   - If SPD EEPROM is on an I2C bus other than the first one, specify here.
2334   - Note that the value must resolve to something your driver can deal with.
  2352 + If SPD EEPROM is on an I2C bus other than the first
  2353 + one, specify here. Note that the value must resolve
  2354 + to something your driver can deal with.
2335 2355  
2336 2356 - CFG_83XX_DDR_USES_CS0
2337   - Only for 83xx systems. If specified, then DDR should be configured
2338   - using CS0 and CS1 instead of CS2 and CS3.
  2357 + Only for 83xx systems. If specified, then DDR should
  2358 + be configured using CS0 and CS1 instead of CS2 and CS3.
2339 2359  
2340 2360 - CFG_83XX_DDR_USES_CS0
2341   - Only for 83xx systems. If specified, then DDR should be configured
2342   - using CS0 and CS1 instead of CS2 and CS3.
  2361 + Only for 83xx systems. If specified, then DDR should
  2362 + be configured using CS0 and CS1 instead of CS2 and CS3.
2343 2363  
2344 2364 - CONFIG_ETHER_ON_FEC[12]
2345 2365 Define to enable FEC[12] on a 8xx series processor.
2346 2366  
2347 2367  
2348 2368  
2349 2369  
... ... @@ -2405,29 +2425,30 @@
2405 2425 Building the Software:
2406 2426 ======================
2407 2427  
2408   -Building U-Boot has been tested in native PPC environments (on a
2409   -PowerBook G3 running LinuxPPC 2000) and in cross environments
2410   -(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2411   -NetBSD 1.5 on x86).
  2428 +Building U-Boot has been tested in several native build environments
  2429 +and in many different cross environments. Of course we cannot support
  2430 +all possibly existing versions of cross development tools in all
  2431 +(potentially obsolete) versions. In case of tool chain problems we
  2432 +recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
  2433 +which is extensively used to build and test U-Boot.
2412 2434  
2413   -If you are not using a native PPC environment, it is assumed that you
2414   -have the GNU cross compiling tools available in your path and named
2415   -with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2416   -you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2417   -the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2418   -change it to:
  2435 +If you are not using a native environment, it is assumed that you
  2436 +have GNU cross compiling tools available in your path. In this case,
  2437 +you must set the environment variable CROSS_COMPILE in your shell.
  2438 +Note that no changes to the Makefile or any other source files are
  2439 +necessary. For example using the ELDK on a 4xx CPU, please enter:
2419 2440  
2420   - CROSS_COMPILE = ppc_4xx-
  2441 + $ CROSS_COMPILE=ppc_4xx-
  2442 + $ export CROSS_COMPILE
2421 2443  
2422   -
2423   -U-Boot is intended to be simple to build. After installing the
2424   -sources you must configure U-Boot for one specific board type. This
  2444 +U-Boot is intended to be simple to build. After installing the
  2445 +sources you must configure U-Boot for one specific board type. This
2425 2446 is done by typing:
2426 2447  
2427 2448 make NAME_config
2428 2449  
2429   -where "NAME_config" is the name of one of the existing
2430   -configurations; see the main Makefile for supported names.
  2450 +where "NAME_config" is the name of one of the existing configu-
  2451 +rations; see the main Makefile for supported names.
2431 2452  
2432 2453 Note: for some board special configuration names may exist; check if
2433 2454 additional information is available from the board vendor; for
2434 2455  
2435 2456  
2436 2457  
... ... @@ -2503,20 +2524,20 @@
2503 2524 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2504 2525 ==============================================================
2505 2526  
2506   -If you have modified U-Boot sources (for instance added a new board
2507   -or support for new devices, a new CPU, etc.) you are expected to
  2527 +If you have modified U-Boot sources (for instance added a new board
  2528 +or support for new devices, a new CPU, etc.) you are expected to
2508 2529 provide feedback to the other developers. The feedback normally takes
2509 2530 the form of a "patch", i. e. a context diff against a certain (latest
2510   -official or latest in CVS) version of U-Boot sources.
  2531 +official or latest in the git repository) version of U-Boot sources.
2511 2532  
2512   -But before you submit such a patch, please verify that your modifi-
2513   -cation did not break existing code. At least make sure that *ALL* of
  2533 +But before you submit such a patch, please verify that your modifi-
  2534 +cation did not break existing code. At least make sure that *ALL* of
2514 2535 the supported boards compile WITHOUT ANY compiler warnings. To do so,
2515 2536 just run the "MAKEALL" script, which will configure and build U-Boot
2516   -for ALL supported system. Be warned, this will take a while. You can
2517   -select which (cross) compiler to use by passing a `CROSS_COMPILE'
2518   -environment variable to the script, i. e. to use the cross tools from
2519   -MontaVista's Hard Hat Linux you can type
  2537 +for ALL supported system. Be warned, this will take a while. You can
  2538 +select which (cross) compiler to use by passing a `CROSS_COMPILE'
  2539 +environment variable to the script, i. e. to use the ELDK cross tools
  2540 +you can type
2520 2541  
2521 2542 CROSS_COMPILE=ppc_8xx- MAKEALL
2522 2543  
2523 2544  
... ... @@ -2524,20 +2545,21 @@
2524 2545  
2525 2546 CROSS_COMPILE=' ' MAKEALL
2526 2547  
2527   -When using the MAKEALL script, the default behaviour is to build U-Boot
2528   -in the source directory. This location can be changed by setting the
2529   -BUILD_DIR environment variable. Also, for each target built, the MAKEALL
2530   -script saves two log files (<target>.ERR and <target>.MAKEALL) in the
2531   -<source dir>/LOG directory. This default location can be changed by
2532   -setting the MAKEALL_LOGDIR environment variable. For example:
  2548 +When using the MAKEALL script, the default behaviour is to build
  2549 +U-Boot in the source directory. This location can be changed by
  2550 +setting the BUILD_DIR environment variable. Also, for each target
  2551 +built, the MAKEALL script saves two log files (<target>.ERR and
  2552 +<target>.MAKEALL) in the <source dir>/LOG directory. This default
  2553 +location can be changed by setting the MAKEALL_LOGDIR environment
  2554 +variable. For example:
2533 2555  
2534 2556 export BUILD_DIR=/tmp/build
2535 2557 export MAKEALL_LOGDIR=/tmp/log
2536 2558 CROSS_COMPILE=ppc_8xx- MAKEALL
2537 2559  
2538   -With the above settings build objects are saved in the /tmp/build, log
2539   -files are saved in the /tmp/log and the source tree remains clean during
2540   -the whole build process.
  2560 +With the above settings build objects are saved in the /tmp/build,
  2561 +log files are saved in the /tmp/log and the source tree remains clean
  2562 +during the whole build process.
2541 2563  
2542 2564  
2543 2565 See also "U-Boot Porting Guide" below.
... ... @@ -3093,7 +3115,7 @@
3093 3115  
3094 3116  
3095 3117 You can check the success of the download using the 'iminfo' command;
3096   -this includes a checksum verification so you can be sure no data
  3118 +this includes a checksum verification so you can be sure no data
3097 3119 corruption happened:
3098 3120  
3099 3121 => imi 40100000
... ... @@ -3438,7 +3460,7 @@
3438 3460 MPC826x processors), on others (parts of) the data cache can be
3439 3461 locked as (mis-) used as memory, etc.
3440 3462  
3441   - Chris Hallinan posted a good summary of these issues to the
  3463 + Chris Hallinan posted a good summary of these issues to the
3442 3464 u-boot-users mailing list:
3443 3465  
3444 3466 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
... ... @@ -3728,6 +3750,8 @@
3728 3750  
3729 3751 Patches shall be sent to the u-boot-users mailing list.
3730 3752  
  3753 +Please see http://www.denx.de/wiki/UBoot/Patches for details.
  3754 +
3731 3755 When you send a patch, please include the following information with
3732 3756 it:
3733 3757  
3734 3758  
3735 3759  
3736 3760  
... ... @@ -3748,19 +3772,24 @@
3748 3772 * If your patch adds new configuration options, don't forget to
3749 3773 document these in the README file.
3750 3774  
3751   -* The patch itself. If you are accessing the CVS repository use "cvs
3752   - update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3753   - version of diff does not support these options, then get the latest
3754   - version of GNU diff.
  3775 +* The patch itself. If you are using git (which is *strongly*
  3776 + recommended) you can easily generate the patch using the
  3777 + "git-format-patch". If you then use "git-send-email" to send it to
  3778 + the U-Boot mailing list, you will avoid most of the common problems
  3779 + with some other mail clients.
3755 3780  
3756   - The current directory when running this command shall be the top
3757   - level directory of the U-Boot source tree, or it's parent directory
3758   - (i. e. please make sure that your patch includes sufficient
3759   - directory information for the affected files).
  3781 + If you cannot use git, use "diff -purN OLD NEW". If your version of
  3782 + diff does not support these options, then get the latest version of
  3783 + GNU diff.
3760 3784  
3761   - We accept patches as plain text, MIME attachments or as uuencoded
3762   - gzipped text.
  3785 + The current directory when running this command shall be the parent
  3786 + directory of the U-Boot source tree (i. e. please make sure that
  3787 + your patch includes sufficient directory information for the
  3788 + affected files).
3763 3789  
  3790 + We prefer patches as plain text. MIME attachments are discouraged,
  3791 + and compressed attachments must not be used.
  3792 +
3764 3793 * If one logical set of modifications affects or creates several
3765 3794 files, all these changes shall be submitted in a SINGLE patch file.
3766 3795  
... ... @@ -3786,5 +3815,7 @@
3786 3815 modification.
3787 3816  
3788 3817 * Remember that there is a size limit of 40 kB per message on the
3789   - u-boot-users mailing list. Compression may help.
  3818 + u-boot-users mailing list. Bigger patches will be moderated. If
  3819 + they are reasonable and not bigger than 100 kB, they will be
  3820 + acknowledged. Even bigger patches should be avoided.