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 Toolchain
  27 =========
  28
  29 While ARM Cortex-A8 support ARM v7 instruction set (-march=armv7a) we compile
  30 with -march=armv5 to allow more compilers to work. For U-Boot code this has
  31 no performance impact.
  32
  33 Build
  34 =====
  35
  36 * BeagleBoard:
  37
  38 make omap3_beagle_config
  39 make
  40
  41 * Gumstix Overo:
  42
  43 make omap3_overo_config
  44 make
  45
  46 * TI EVM:
  47
  48 make omap3_evm_config
  49 make
  50
  51 * Pandora:
  52
  53 make omap3_pandora_config
  54 make
  55
  56 * Zoom MDK:
  57
  58 make omap3_zoom1_config
  59 make
  60
  61 * Zoom 2:
  62
  63 make omap3_zoom2_config
  64 make
  65
  66 * CM-T35:
  67
  68 make cm_t35_config
  69 make
  70
  71 Custom commands
  72 ===============
  73
  74 To make U-Boot for OMAP3 support NAND device SW or HW ECC calculation, U-Boot
  75 for OMAP3 supports custom user command
  76
  77 nandecc hw/sw
  78
  79 To be compatible with NAND drivers using SW ECC (e.g. kernel code)
  80
  81 nandecc sw
  82
  83 enables SW ECC calculation. HW ECC enabled with
  84
  85 nandecc hw
  86
  87 is typically used to write 2nd stage bootloader (known as 'x-loader') which is
  88 executed by OMAP3's boot rom and therefore has to be written with HW ECC.
  89
  90 For all other commands see
  91
  92 help
  93
  94 Interfaces
  95 ==========
  96
  97 gpio
  98 ----
  99
 100 To set a bit :
 101
 102         if (!gpio_request(N, "")) {
 103                 gpio_direction_output(N, 0);
 104                 gpio_set_value(N, 1);
 105         }
 106
 107 To clear a bit :
 108
 109         if (!gpio_request(N, "")) {
 110                 gpio_direction_output(N, 0);
 111                 gpio_set_value(N, 0);
 112         }
 113
 114 To read a bit :
 115
 116         if (!gpio_request(N, "")) {
 117                 gpio_direction_input(N);
 118                 val = gpio_get_value(N);
 119                 gpio_free(N);
 120         }
 121         if (val)
 122                 printf("GPIO N is set\n");
 123         else
 124                 printf("GPIO N is clear\n");
 125
 126 dma
 127 ---
 128 void omap3_dma_init(void)
 129         Init the DMA module
 130 int omap3_dma_get_conf_chan(uint32_t chan, struct dma4_chan *config);
 131         Read config of the channel
 132 int omap3_dma_conf_chan(uint32_t chan, struct dma4_chan *config);
 133         Write config to the channel
 134 int omap3_dma_conf_transfer(uint32_t chan, uint32_t *src, uint32_t *dst,
 135                 uint32_t sze)
 136         Config source, destination and size of a transfer
 137 int omap3_dma_wait_for_transfer(uint32_t chan)
 138         Wait for a transfer to end - this hast to be called before a channel
 139         or the data the channel transferd are used.
 140 int omap3_dma_get_revision(uint32_t *minor, uint32_t *major)
 141         Read silicon Revision of the DMA module
 142
 143
 144 Acknowledgements
 145 ================
 146
 147 OMAP3 U-Boot is based on U-Boot tar ball [9] for BeagleBoard and EVM done by
 148 several TI employees.
 149
 150 Links
 151 =====
 152
 153 [1] OMAP3:
 154
 155 http://www.ti.com/omap3 (high volume) and
 156 http://www.ti.com/omap35x (broad market)
 157
 158 [2] OMAP3530 BeagleBoard:
 159
 160 http://beagleboard.org/
 161
 162 [3] Gumstix Overo:
 163
 164 http://www.gumstix.net/Overo/
 165
 166 [4] TI EVM:
 167
 168 http://focus.ti.com/docs/toolsw/folders/print/tmdxevm3503.html
 169
 170 [5] OpenPandora Ltd. Pandora:
 171
 172 http://openpandora.org/
 173
 174 [6] TI/Logic PD Zoom MDK:
 175
 176 http://www.logicpd.com/products/devkit/ti/zoom_mobile_development_kit
 177
 178 [7] TI/Logic PD Zoom 2
 179
 180 http://www.logicpd.com/sites/default/files/1012659A_Zoom_OMAP34x-II_MDP_Brief.pdf
 181
 182 [8] CompuLab Ltd. CM-T35:
 183
 184 http://www.compulab.co.il/t3530/html/t3530-cm-datasheet.htm
 185
 186 [9] TI OMAP3 U-Boot:
 187
 188 http://beagleboard.googlecode.com/files/u-boot_beagle_revb.tar.gz