[people/ms/u-boot.git] / doc / README.m68k


U-Boot for Motorola M68K

====================================================================
History

August 08,2005; 	Jens Scharsig <esw@bus-elektronik.de>
			MCF5282 implementation without preloader
January 12, 2004; 	<josef.baumgartner@telex.de>
====================================================================

This file contains status information for the port of U-Boot to the
Motorola M68K series of CPUs.

1. OVERVIEW
-----------
Bernhard Kuhn ported U-Boot 0.4.0 to the Motorola Coldfire
architecture. The patches of Bernhard support the MCF5272 and
MCF5282. A great disadvantage of these patches was that they needed
a pre-bootloader to start u-boot. Because of this, a new port was
created which no longer needs a first stage booter.

Although this port is intended to cover all M68k processors, only
the parts for the Motorola Coldfire MCF5272 and MCF5282 are
implemented at the moment. Additional CPUs and boards will be
hopefully added soon!


2. SUPPORTED CPUs
-----------------

2.1 Motorola Coldfire MCF5272
-----------------------------
CPU specific code is located in: cpu/mcf52x2


2.1 Motorola Coldfire MCF5282
-----------------------------
CPU specific code is located in: cpu/mcf52x2

The MCF5282 Port no longer needs a preloader and can place in external or
internal FLASH.


3. SUPPORTED BOARDs
-------------------

3.1 Motorola M5272C3 EVB
------------------------
Board specific code is located in: board/m5272c3

To configure the board, type: make M5272C3_config

U-Boot Memory Map:
------------------
0xffe00000 - 0xffe3ffff		u-boot
0xffe04000 - 0xffe05fff		environment (embedded in u-boot!)
0xffe40000 - 0xffffffff		free for linux/applications


3.2 Motorola M5282 EVB
------------------------
Board specific code is located in: board/m5282evb

To configure the board, type: make M5272C3_config

At the moment the code isn't fully implemented and still needs a pre-loader!
The preloader must initialize the processor and then start u-boot. The board
must be configured for a pre-loader (see 4.1)

For the preloader, please see
http://mailman.uclinux.org/pipermail/uclinux-dev/2003-December/023384.html

U-boot is configured to run at 0x20000 at default. This can be configured by
change TEXT_BASE in board/m5282evb/config.mk and CFG_MONITOR_BASE in
include/configs/M5282EVB.h.

3.2 BuS EB+MCF-EV123
---------------------

Board specific code is located in: board/bus/EB+MCF-EV123

To configure the board, type:

make EB+MCF-EV123_config 		for external FLASH
make EB+MCF-EV123_internal_config 	for internal FLASH


4. CONFIGURATION OPTIONS/SETTINGS
----------------------------------

4.1 Configuration to use a pre-loader
-------------------------------------
If u-boot should be loaded to RAM and started by a pre-loader
CONFIG_MONITOR_IS_IN_RAM must be defined. If it is defined the
initial vector table and basic processor initialization will not
be compiled in. The start address of u-boot must be adjusted in
the boards config header file (CFG_MONITOR_BASE) and Makefile
(TEXT_BASE) to the load address.

4.1 MCF5272 specific Options/Settings
-------------------------------------

CONFIG_MCF52x2	-- defined for all MCF52x2 CPUs
CONFIG_M5272	-- defined for all Motorola MCF5272 CPUs

CONFIG_MONITOR_IS_IN_RAM
		-- defined if u-boot is loaded by a pre-loader

CFG_MBAR	-- defines the base address of the MCF5272 configuration registers
CFG_INIT_RAM_ADDR
		-- defines the base address of the MCF5272 internal SRAM
CFG_ENET_BD_BASE
		-- defines the base addres of the FEC buffer descriptors

CFG_SCR		-- defines the contents of the System Configuration Register
CFG_SPR		-- defines the contents of the System Protection Register
CFG_BRx_PRELIM	-- defines the contents of the Chip Select Base Registers
CFG_ORx_PRELIM	-- defines the contents of the Chip Select Option Registers

CFG_PxDDR	-- defines the contents of the Data Direction Registers
CFG_PxDAT	-- defines the contents of the Data Registers
CFG_PXCNT	-- defines the contents of the Port Configuration Registers


4.2 MCF5282 specific Options/Settings
-------------------------------------

CONFIG_MCF52x2	-- defined for all MCF52x2 CPUs
CONFIG_M5282	-- defined for all Motorola MCF5282 CPUs

CONFIG_MONITOR_IS_IN_RAM
		-- defined if u-boot is loaded by a pre-loader

CFG_MBAR	-- defines the base address of the MCF5282 internal register space
CFG_INIT_RAM_ADDR
		-- defines the base address of the MCF5282 internal SRAM
CFG_INT_FLASH_BASE
		-- defines the base address of the MCF5282 internal Flash memory
CFG_ENET_BD_BASE
		-- defines the base addres of the FEC buffer descriptors

CFG_MFD
		-- defines the PLL Multiplication Factor Devider
		   (see table 9-4 of MCF user manual)
CFG_RFD		-- defines the PLL Reduce Frecuency Devider
		   (see table 9-4 of MCF user manual)

CFG_CSx_BASE	-- defines the base address of chip select x
CFG_CSx_SIZE	-- defines the memory size (address range) of chip select x
CFG_CSx_WIDTH	-- defines the bus with of chip select x
CFG_CSx_RO 	-- if set to 0 chip select x is read/wirte
			else chipselct is read only
CFG_CSx_WS	-- defines the number of wait states  of chip select x

CFG_PxDDR	-- defines the contents of the Data Direction Registers
CFG_PxDAT	-- defines the contents of the Data Registers
CFG_PXCNT	-- defines the contents of the Port Configuration Registers

CFG_PxPAR	-- defines the function of ports


5. COMPILER
-----------
To create U-Boot the gcc-2.95.3 compiler set (m68k-elf-20030314) from uClinux.org was used.
You can download it from: http://www.uclinux.org/pub/uClinux/m68k-elf-tools/
Commit	Line	Data
bf9e3b38 WD	1
	2	U-Boot for Motorola M68K
	3
9acb626f HS	4	====================================================================
	5	History
	6
	7	August 08,2005; Jens Scharsig <esw@bus-elektronik.de>
	8	MCF5282 implementation without preloader
	9	January 12, 2004; <josef.baumgartner@telex.de>
bf9e3b38 WD	10	====================================================================
	11
	12	This file contains status information for the port of U-Boot to the
	13	Motorola M68K series of CPUs.
	14
	15	1. OVERVIEW
	16	-----------
	17	Bernhard Kuhn ported U-Boot 0.4.0 to the Motorola Coldfire
	18	architecture. The patches of Bernhard support the MCF5272 and
	19	MCF5282. A great disadvantage of these patches was that they needed
	20	a pre-bootloader to start u-boot. Because of this, a new port was
	21	created which no longer needs a first stage booter.
	22
	23	Although this port is intended to cover all M68k processors, only
	24	the parts for the Motorola Coldfire MCF5272 and MCF5282 are
	25	implemented at the moment. Additional CPUs and boards will be
	26	hopefully added soon!
	27
	28
	29	2. SUPPORTED CPUs
	30	-----------------
	31
	32	2.1 Motorola Coldfire MCF5272
	33	-----------------------------
	34	CPU specific code is located in: cpu/mcf52x2
	35
	36
	37	2.1 Motorola Coldfire MCF5282
	38	-----------------------------
	39	CPU specific code is located in: cpu/mcf52x2
	40
9acb626f HS	41	The MCF5282 Port no longer needs a preloader and can place in external or
9acb626f HS	42	internal FLASH.
bf9e3b38 WD	43
	44
	45	3. SUPPORTED BOARDs
	46	-------------------
	47
	48	3.1 Motorola M5272C3 EVB
	49	------------------------
	50	Board specific code is located in: board/m5272c3
	51
	52	To configure the board, type: make M5272C3_config
	53
	54	U-Boot Memory Map:
	55	------------------
	56	0xffe00000 - 0xffe3ffff u-boot
	57	0xffe04000 - 0xffe05fff environment (embedded in u-boot!)
	58	0xffe40000 - 0xffffffff free for linux/applications
	59
	60
	61	3.2 Motorola M5282 EVB
	62	------------------------
	63	Board specific code is located in: board/m5282evb
	64
	65	To configure the board, type: make M5272C3_config
	66
9acb626f HS	67	At the moment the code isn't fully implemented and still needs a pre-loader!
	68	The preloader must initialize the processor and then start u-boot. The board
	69	must be configured for a pre-loader (see 4.1)
	70
	71	For the preloader, please see
	72	http://mailman.uclinux.org/pipermail/uclinux-dev/2003-December/023384.html
	73
	74	U-boot is configured to run at 0x20000 at default. This can be configured by
	75	change TEXT_BASE in board/m5282evb/config.mk and CFG_MONITOR_BASE in
	76	include/configs/M5282EVB.h.
	77
	78	3.2 BuS EB+MCF-EV123
	79	---------------------
	80
	81	Board specific code is located in: board/bus/EB+MCF-EV123
	82
	83	To configure the board, type:
	84
	85	make EB+MCF-EV123_config for external FLASH
	86	make EB+MCF-EV123_internal_config for internal FLASH
	87
bf9e3b38 WD	88
	89	4. CONFIGURATION OPTIONS/SETTINGS
	90	----------------------------------
	91
	92	4.1 Configuration to use a pre-loader
	93	-------------------------------------
	94	If u-boot should be loaded to RAM and started by a pre-loader
	95	CONFIG_MONITOR_IS_IN_RAM must be defined. If it is defined the
	96	initial vector table and basic processor initialization will not
	97	be compiled in. The start address of u-boot must be adjusted in
	98	the boards config header file (CFG_MONITOR_BASE) and Makefile
	99	(TEXT_BASE) to the load address.
	100
bf9e3b38 WD	101	4.1 MCF5272 specific Options/Settings
	102	-------------------------------------
	103
	104	CONFIG_MCF52x2 -- defined for all MCF52x2 CPUs
	105	CONFIG_M5272 -- defined for all Motorola MCF5272 CPUs
	106
	107	CONFIG_MONITOR_IS_IN_RAM
	108	-- defined if u-boot is loaded by a pre-loader
	109
	110	CFG_MBAR -- defines the base address of the MCF5272 configuration registers
	111	CFG_INIT_RAM_ADDR
	112	-- defines the base address of the MCF5272 internal SRAM
	113	CFG_ENET_BD_BASE
	114	-- defines the base addres of the FEC buffer descriptors
	115
	116	CFG_SCR -- defines the contents of the System Configuration Register
	117	CFG_SPR -- defines the contents of the System Protection Register
	118	CFG_BRx_PRELIM -- defines the contents of the Chip Select Base Registers
	119	CFG_ORx_PRELIM -- defines the contents of the Chip Select Option Registers
	120
	121	CFG_PxDDR -- defines the contents of the Data Direction Registers
	122	CFG_PxDAT -- defines the contents of the Data Registers
	123	CFG_PXCNT -- defines the contents of the Port Configuration Registers
	124
	125
	126	4.2 MCF5282 specific Options/Settings
	127	-------------------------------------
	128
	129	CONFIG_MCF52x2 -- defined for all MCF52x2 CPUs
	130	CONFIG_M5282 -- defined for all Motorola MCF5282 CPUs
	131
	132	CONFIG_MONITOR_IS_IN_RAM
	133	-- defined if u-boot is loaded by a pre-loader
	134
	135	CFG_MBAR -- defines the base address of the MCF5282 internal register space
	136	CFG_INIT_RAM_ADDR
	137	-- defines the base address of the MCF5282 internal SRAM
	138	CFG_INT_FLASH_BASE
	139	-- defines the base address of the MCF5282 internal Flash memory
	140	CFG_ENET_BD_BASE
	141	-- defines the base addres of the FEC buffer descriptors
	142
9acb626f HS	143	CFG_MFD
	144	-- defines the PLL Multiplication Factor Devider
	145	(see table 9-4 of MCF user manual)
	146	CFG_RFD -- defines the PLL Reduce Frecuency Devider
	147	(see table 9-4 of MCF user manual)
	148
	149	CFG_CSx_BASE -- defines the base address of chip select x
	150	CFG_CSx_SIZE -- defines the memory size (address range) of chip select x
	151	CFG_CSx_WIDTH -- defines the bus with of chip select x
	152	CFG_CSx_RO -- if set to 0 chip select x is read/wirte
	153	else chipselct is read only
	154	CFG_CSx_WS -- defines the number of wait states of chip select x
	155
	156	CFG_PxDDR -- defines the contents of the Data Direction Registers
	157	CFG_PxDAT -- defines the contents of the Data Registers
	158	CFG_PXCNT -- defines the contents of the Port Configuration Registers
	159
	160	CFG_PxPAR -- defines the function of ports
	161
bf9e3b38 WD	162
	163	5. COMPILER
	164	-----------
	165	To create U-Boot the gcc-2.95.3 compiler set (m68k-elf-20030314) from uClinux.org was used.
	166	You can download it from: http://www.uclinux.org/pub/uClinux/m68k-elf-tools/