Merge greybus driver tree into 4.8-rc6
[sfrench/cifs-2.6.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 SPEAr1310,
12   SPEAr1340, SPEAr300, SPEAr310, SPEAr320 and SPEAr600 SOCs are supported.
13
14   Hierarchy in SPEAr is as follows:
15
16   SPEAr (Platform)
17         - SPEAr3XX (3XX SOC series, based on ARM9)
18                 - SPEAr300 (SOC)
19                         - SPEAr300 Evaluation Board
20                 - SPEAr310 (SOC)
21                         - SPEAr310 Evaluation Board
22                 - SPEAr320 (SOC)
23                         - SPEAr320 Evaluation Board
24         - SPEAr6XX (6XX SOC series, based on ARM9)
25                 - SPEAr600 (SOC)
26                         - SPEAr600 Evaluation Board
27         - SPEAr13XX (13XX SOC series, based on ARM CORTEXA9)
28                 - SPEAr1310 (SOC)
29                         - SPEAr1310 Evaluation Board
30                 - SPEAr1340 (SOC)
31                         - SPEAr1340 Evaluation Board
32
33   Configuration
34   -------------
35
36   A generic configuration is provided for each machine, and can be used as the
37   default by
38         make spear13xx_defconfig
39         make spear3xx_defconfig
40         make spear6xx_defconfig
41
42   Layout
43   ------
44
45   The common files for multiple machine families (SPEAr3xx, SPEAr6xx and
46   SPEAr13xx) are located in the platform code contained in arch/arm/plat-spear
47   with headers in plat/.
48
49   Each machine series have a directory with name arch/arm/mach-spear followed by
50   series name. Like mach-spear3xx, mach-spear6xx and mach-spear13xx.
51
52   Common file for machines of spear3xx family is mach-spear3xx/spear3xx.c, for
53   spear6xx is mach-spear6xx/spear6xx.c and for spear13xx family is
54   mach-spear13xx/spear13xx.c. mach-spear* also contain soc/machine specific
55   files, like spear1310.c, spear1340.c spear300.c, spear310.c, spear320.c and
56   spear600.c.  mach-spear* doesn't contains board specific files as they fully
57   support Flattened Device Tree.
58
59
60   Document Author
61   ---------------
62
63   Viresh Kumar <vireshk@kernel.org>, (c) 2010-2012 ST Microelectronics