doc/README.omap3

   1
   2 Summary
   3 =======
   4
   5 This README is about U-Boot support for TI's ARM Cortex-A8 based OMAP3 [1]
   6 family of SoCs. TI's OMAP3 SoC family contains an ARM Cortex-A8. Additionally,
   7 some family members contain a TMS320C64x+ DSP and/or an Imagination SGX 2D/3D
   8 graphics processor and various other standard peripherals.
   9
  10 Currently the following boards are supported:
  11
  12 * OMAP3530 BeagleBoard [2]
  13
  14 * Gumstix Overo [3]
  15
  16 * TI EVM [4]
  17
  18 * OpenPandora Ltd. Pandora [5]
  19
  20 * TI/Logic PD Zoom MDK [6]
  21
  22 * TI/Logic PD Zoom 2 [7]
  23
  24 * CompuLab Ltd. CM-T35 [8]
  25
  26 Build
  27 =====
  28
  29 * BeagleBoard:
  30
  31 make omap3_beagle_config
  32 make
  33
  34 * Gumstix Overo:
  35
  36 make omap3_overo_config
  37 make
  38
  39 * TI EVM:
  40
  41 make omap3_evm_config
  42 make
  43
  44 * Zoom MDK:
  45
  46 make omap3_zoom1_config
  47 make
  48
  49 * Zoom 2:
  50
  51 make omap3_zoom2_config
  52 make
  53
  54 * CM-T35:
  55
  56 make cm_t35_config
  57 make
  58
  59
  60 Custom commands
  61 ===============
  62
  63 To make U-Boot for OMAP3 support NAND device SW or HW ECC calculation, U-Boot
  64 for OMAP3 supports custom user command
  65
  66 nandecc hw/sw
  67
  68 To be compatible with NAND drivers using SW ECC (e.g. kernel code)
  69
  70 nandecc sw
  71
  72 enables SW ECC calculation. HW ECC enabled with
  73
  74 nandecc hw
  75
  76 is typically used to write 2nd stage bootloader (known as 'x-loader') which is
  77 executed by OMAP3's boot rom and therefore has to be written with HW ECC.
  78
  79 For all other commands see
  80
  81 help
  82
  83 Interfaces
  84 ==========
  85
  86 gpio
  87 ----
  88
  89 To set a bit :
  90
  91         if (!gpio_request(N, "")) {
  92                 gpio_direction_output(N, 0);
  93                 gpio_set_value(N, 1);
  94         }
  95
  96 To clear a bit :
  97
  98         if (!gpio_request(N, "")) {
  99                 gpio_direction_output(N, 0);
 100                 gpio_set_value(N, 0);
 101         }
 102
 103 To read a bit :
 104
 105         if (!gpio_request(N, "")) {
 106                 gpio_direction_input(N);
 107                 val = gpio_get_value(N);
 108                 gpio_free(N);
 109         }
 110         if (val)
 111                 printf("GPIO N is set\n");
 112         else
 113                 printf("GPIO N is clear\n");
 114
 115 dma
 116 ---
 117 void omap3_dma_init(void)
 118         Init the DMA module
 119 int omap3_dma_get_conf_chan(uint32_t chan, struct dma4_chan *config);
 120         Read config of the channel
 121 int omap3_dma_conf_chan(uint32_t chan, struct dma4_chan *config);
 122         Write config to the channel
 123 int omap3_dma_conf_transfer(uint32_t chan, uint32_t *src, uint32_t *dst,
 124                 uint32_t sze)
 125         Config source, destination and size of a transfer
 126 int omap3_dma_wait_for_transfer(uint32_t chan)
 127         Wait for a transfer to end - this hast to be called before a channel
 128         or the data the channel transferd are used.
 129 int omap3_dma_get_revision(uint32_t *minor, uint32_t *major)
 130         Read silicon Revision of the DMA module
 131
 132 NAND
 133 ====
 134
 135 There are some OMAP3 devices out there with NAND attached. Due to the fact that
 136 OMAP3 ROM code can only handle 1-bit hamming ECC for accessing first page
 137 (place where SPL lives) we require this setup for u-boot at least when reading
 138 the second progam within SPL.  A lot of newer NAND chips however require more
 139 than 1-bit ECC for the pages, some can live with 1-bit for the first page. To
 140 handle this we can switch to another ECC algorithm after reading the payload
 141 within SPL.
 142
 143 BCH8
 144 ----
 145
 146 To enable hardware assisted BCH8 (8-bit BCH [Bose, Chaudhuri, Hocquenghem]) on
 147 OMAP3 devices we can use the BCH library in lib/bch.c. To do so add CONFIG_BCH
 148 and set CONFIG_NAND_OMAP_ECCSCHEME=5 (refer README.nand) for selecting BCH8_SW.
 149 The NAND OOB layout is the same as in linux kernel, if the linux kernel BCH8
 150 implementation for OMAP3 works for you so the u-boot version should also.
 151 When you require the SPL to read with BCH8 there are two more configs to
 152 change:
 153
 154  * CONFIG_SYS_NAND_ECCPOS (must be the same as .eccpos in
 155    GPMC_NAND_HW_BCH8_ECC_LAYOUT defined in
 156    arch/arm/include/asm/arch-omap3/omap_gpmc.h)
 157  * CONFIG_SYS_NAND_ECCSIZE must be 512
 158  * CONFIG_SYS_NAND_ECCBYTES must be 13 for this BCH8 setup
 159
 160 Acknowledgements
 161 ================
 162
 163 OMAP3 U-Boot is based on U-Boot tar ball [9] for BeagleBoard and EVM done by
 164 several TI employees.
 165
 166 Links
 167 =====
 168
 169 [1] OMAP3:
 170
 171 http://www.ti.com/omap3 (high volume) and
 172 http://www.ti.com/omap35x (broad market)
 173
 174 [2] OMAP3530 BeagleBoard:
 175
 176 http://beagleboard.org/
 177
 178 [3] Gumstix Overo:
 179
 180 http://www.gumstix.net/Overo/
 181
 182 [4] TI EVM:
 183
 184 http://focus.ti.com/docs/toolsw/folders/print/tmdxevm3503.html
 185
 186 [5] OpenPandora Ltd. Pandora:
 187
 188 http://openpandora.org/
 189
 190 [6] TI/Logic PD Zoom MDK:
 191
 192 http://www.logicpd.com/products/devkit/ti/zoom_mobile_development_kit
 193
 194 [7] TI/Logic PD Zoom 2
 195
 196 http://www.logicpd.com/sites/default/files/1012659A_Zoom_OMAP34x-II_MDP_Brief.pdf
 197
 198 [8] CompuLab Ltd. CM-T35:
 199
 200 http://www.compulab.co.il/t3530/html/t3530-cm-datasheet.htm
 201
 202 [9] TI OMAP3 U-Boot:
 203
 204 http://beagleboard.googlecode.com/files/u-boot_beagle_revb.tar.gz