board/w7o/fpga.c: make (mostly) checkpatch clean
[kernel/u-boot.git] / doc / README.m53017evb
1 Freescale MCF53017EVB ColdFire Development Board
2 ================================================
3
4 TsiChung Liew(Tsi-Chung.Liew@freescale.com)
5 Created 10/22/08
6 ===========================================
7
8
9 Changed files:
10 ==============
11
12 - board/freescale/m53017evb/m53017evb.c Dram setup
13 - board/freescale/m53017evb/mii.c       Mii access
14 - board/freescale/m53017evb/Makefile    Makefile
15 - board/freescale/m53017evb/config.mk   config make
16 - board/freescale/m53017evb/u-boot.lds  Linker description
17
18 - arch/m68k/cpu/mcf532x/cpu.c                   cpu specific code
19 - arch/m68k/cpu/mcf532x/cpu_init.c              FBCS, Mux pins, icache and RTC extra regs
20 - arch/m68k/cpu/mcf532x/interrupts.c            cpu specific interrupt support
21 - arch/m68k/cpu/mcf532x/speed.c                 system, flexbus, and cpu clock
22 - arch/m68k/cpu/mcf532x/Makefile                        Makefile
23 - arch/m68k/cpu/mcf532x/config.mk                       config make
24 - arch/m68k/cpu/mcf532x/start.S                 start up assembly code
25
26 - doc/README.m53017evb                  This readme file
27
28 - drivers/net/mcffec.c                  ColdFire common FEC driver
29 - drivers/net/mcfmii.c                  ColdFire common Mii driver
30 - drivers/serial/mcfuart.c              ColdFire common UART driver
31 - drivers/rtc/mcfrtc.c                  Realtime clock Driver
32
33 - include/asm-m68k/bitops.h             Bit operation function export
34 - include/asm-m68k/byteorder.h          Byte order functions
35 - include/asm-m68k/fec.h                FEC structure and definition
36 - include/asm-m68k/fsl_i2c.h            I2C structure and definition
37 - include/asm-m68k/global_data.h        Global data structure
38 - include/asm-m68k/immap.h              ColdFire specific header file and driver macros
39 - include/asm-m68k/immap_5301x.h        mcf5301x specific header file
40 - include/asm-m68k/io.h                 io functions
41 - include/asm-m68k/m532x.h              mcf5301x specific header file
42 - include/asm-m68k/posix_types.h        Posix
43 - include/asm-m68k/processor.h          header file
44 - include/asm-m68k/ptrace.h             Exception structure
45 - include/asm-m68k/rtc.h                Realtime clock header file
46 - include/asm-m68k/string.h             String function export
47 - include/asm-m68k/timer.h              Timer structure and definition
48 - include/asm-m68k/types.h              Data types definition
49 - include/asm-m68k/uart.h               Uart structure and definition
50 - include/asm-m68k/u-boot.h             u-boot structure
51
52 - include/configs/M53017EVB.h           Board specific configuration file
53
54 - arch/m68k/lib/board.c                 board init function
55 - arch/m68k/lib/cache.c
56 - arch/m68k/lib/interrupts                      Coldfire common interrupt functions
57 - arch/m68k/lib/m68k_linux.c
58 - arch/m68k/lib/time.c                  Timer functions (Dma timer and PIT)
59 - arch/m68k/lib/traps.c                 Exception init code
60
61 1 MCF5301x specific Options/Settings
62 ====================================
63 1.1 pre-loader is no longer suppoer in thie coldfire family
64
65 1.2 Configuration settings for M53017EVB Development Board
66 CONFIG_MCF5301x                 -- define for all MCF5301x CPUs
67 CONFIG_M53015                   -- define for MCF53015 CPUs
68 CONFIG_M53017EVB                -- define for M53017EVB board
69
70 CONFIG_MCFUART                  -- define to use common CF Uart driver
71 CONFIG_SYS_UART_PORT            -- define UART port number, start with 0, 1 and 2
72 CONFIG_BAUDRATE                 -- define UART baudrate
73
74 CONFIG_MCFRTC                   -- define to use common CF RTC driver
75 CONFIG_SYS_MCFRTC_BASE          -- provide base address for RTC in immap.h
76 CONFIG_SYS_RTC_OSCILLATOR       -- define RTC clock frequency
77 RTC_DEBUG                       -- define to show RTC debug message
78 CONFIG_CMD_DATE                 -- enable to use date feature in u-boot
79
80 CONFIG_MCFFEC                   -- define to use common CF FEC driver
81 CONFIG_MII                      -- enable to use MII driver
82 CONFIG_CF_DOMII                 -- enable to use MII feature in cmd_mii.c
83 CONFIG_SYS_DISCOVER_PHY         -- enable PHY discovery
84 CONFIG_SYS_RX_ETH_BUFFER        -- Set FEC Receive buffer
85 CONFIG_SYS_FAULT_ECHO_LINK_DOWN --
86 CONFIG_SYS_FEC0_PINMUX          -- Set FEC0 Pin configuration
87 CONFIG_SYS_FEC0_MIIBASE         -- Set FEC0 MII base register
88 MCFFEC_TOUT_LOOP                -- set FEC timeout loop
89
90 CONFIG_MCFTMR                   -- define to use DMA timer
91 CONFIG_MCFPIT                   -- define to use PIT timer
92
93 CONFIG_FSL_I2C                  -- define to use FSL common I2C driver
94 CONFIG_HARD_I2C                 -- define for I2C hardware support
95 CONFIG_SOFT_I2C                 -- define for I2C bit-banged
96 CONFIG_SYS_I2C_SPEED            -- define for I2C speed
97 CONFIG_SYS_I2C_SLAVE            -- define for I2C slave address
98 CONFIG_SYS_I2C_OFFSET           -- define for I2C base address offset
99 CONFIG_SYS_IMMR                 -- define for MBAR offset
100
101 CONFIG_SYS_MBAR                 -- define MBAR offset
102
103 CONFIG_MONITOR_IS_IN_RAM        -- Not support
104
105 CONFIG_SYS_INIT_RAM_ADDR        -- defines the base address of the MCF5301x internal SRAM
106
107 CONFIG_SYS_CSn_BASE             -- defines the Chip Select Base register
108 CONFIG_SYS_CSn_MASK             -- defines the Chip Select Mask register
109 CONFIG_SYS_CSn_CTRL             -- defines the Chip Select Control register
110
111 CONFIG_SYS_SDRAM_BASE           -- defines the DRAM Base
112
113 2. MEMORY MAP UNDER U-BOOT AND LINUX KERNEL
114 ===========================================
115 2.1. System memory map:
116         Flash:          0x00000000-0x3FFFFFFF (1024MB)
117         DDR:            0x40000000-0x7FFFFFFF (1024MB)
118         SRAM:           0x80000000-0x8FFFFFFF (256MB)
119         IP:             0xFC000000-0xFFFFFFFF (256MB)
120
121 2.2. For the initial bringup, we adopted a consistent memory scheme between u-boot and
122         linux kernel, you can customize it based on your system requirements:
123         Flash0:         0x00000000-0x00FFFFFF (16MB)
124         DDR:            0x40000000-0x4FFFFFFF (256MB)
125         SRAM:           0x80000000-0x80007FFF (32KB)
126         IP:             0xFC000000-0xFC0FFFFF (64KB)
127
128 3. COMPILATION
129 ==============
130 3.1     To create U-Boot the gcc-4.x-xx compiler set (ColdFire ELF or
131 uClinux version) from codesourcery.com was used. Download it from:
132 http://www.codesourcery.com/gnu_toolchains/coldfire/download.html
133
134 3.2 Compilation
135    export CROSS_COMPILE=cross-compile-prefix
136    cd u-boot
137    make distclean
138    make M53017EVB_config
139    make
140
141 4. SCREEN DUMP
142 ==============
143 4.1 M53017EVB Development board
144     (NOTE: May not show exactly the same)
145
146 U-Boot 2008.10 (Oct 22 2007 - 11:07:57)
147
148 CPU:   Freescale MCF53015 (Mask:76 Version:0)
149        CPU CLK 240 Mhz BUS CLK 80 Mhz
150 Board: Freescale M53017EVB
151 I2C:   ready
152 DRAM:  64 MB
153 FLASH: 16 MB
154 In:    serial
155 Out:   serial
156 Err:   serial
157 NAND:  16 MiB
158 Net:   FEC0, FEC1
159 -> print
160 bootdelay=1
161 baudrate=115200
162 ethaddr=00:e0:0c:bc:e5:60
163 hostname=M53017EVB
164 netdev=eth0
165 loadaddr=40010000
166 u-boot=u-boot.bin
167 load=tftp ${loadaddr) ${u-boot}
168 upd=run load; run prog
169 prog=prot off 0 3ffff;era 0 3ffff;cp.b ${loadaddr} 0 ${filesize};save
170 gatewayip=192.168.1.1
171 netmask=255.255.255.0
172 ipaddr=192.168.1.3
173 serverip=192.168.1.2
174 stdin=serial
175 stdout=serial
176 stderr=serial
177 mem=65024k
178
179 Environment size: 437/4092 bytes
180 ->