Merge branches 'gemini' and 'misc' into devel
[pandora-kernel.git] / Documentation / arm / SPEAr / overview.txt
1                         SPEAr ARM Linux Overview
2                         ==========================
3
4 Introduction
5 ------------
6
7   SPEAr (Structured Processor Enhanced Architecture).
8   weblink : http://www.st.com/spear
9
10   The ST Microelectronics SPEAr range of ARM9/CortexA9 System-on-Chip CPUs are
11   supported by the 'spear' platform of ARM Linux. Currently SPEAr300,
12   SPEAr310, SPEAr320 and SPEAr600 SOCs are supported. Support for the SPEAr13XX
13   series is in progress.
14
15   Hierarchy in SPEAr is as follows:
16
17   SPEAr (Platform)
18         - SPEAr3XX (3XX SOC series, based on ARM9)
19                 - SPEAr300 (SOC)
20                         - SPEAr300_EVB (Evaluation Board)
21                 - SPEAr310 (SOC)
22                         - SPEAr310_EVB (Evaluation Board)
23                 - SPEAr320 (SOC)
24                         - SPEAr320_EVB (Evaluation Board)
25         - SPEAr6XX (6XX SOC series, based on ARM9)
26                 - SPEAr600 (SOC)
27                         - SPEAr600_EVB (Evaluation Board)
28         - SPEAr13XX (13XX SOC series, based on ARM CORTEXA9)
29                 - SPEAr1300 (SOC)
30
31   Configuration
32   -------------
33
34   A generic configuration is provided for each machine, and can be used as the
35   default by
36         make spear600_defconfig
37         make spear300_defconfig
38         make spear310_defconfig
39         make spear320_defconfig
40
41   Layout
42   ------
43
44   The common files for multiple machine families (SPEAr3XX, SPEAr6XX and
45   SPEAr13XX) are located in the platform code contained in arch/arm/plat-spear
46   with headers in plat/.
47
48   Each machine series have a directory with name arch/arm/mach-spear followed by
49   series name. Like mach-spear3xx, mach-spear6xx and mach-spear13xx.
50
51   Common file for machines of spear3xx family is mach-spear3xx/spear3xx.c and for
52   spear6xx is mach-spear6xx/spear6xx.c. mach-spear* also contain soc/machine
53   specific files, like spear300.c, spear310.c, spear320.c and spear600.c.
54   mach-spear* also contains board specific files for each machine type.
55
56
57   Document Author
58   ---------------
59
60   Viresh Kumar, (c) 2010 ST Microelectronics