Merge tag 'v5.15.65' into rpi-5.15.y
[platform/kernel/linux-rpi.git] / Documentation / arm / spear / overview.rst
1 ========================
2 SPEAr ARM Linux Overview
3 ========================
4
5 Introduction
6 ------------
7
8   SPEAr (Structured Processor Enhanced Architecture).
9   weblink : http://www.st.com/spear
10
11   The ST Microelectronics SPEAr range of ARM9/CortexA9 System-on-Chip CPUs are
12   supported by the 'spear' platform of ARM Linux. Currently SPEAr1310,
13   SPEAr1340, SPEAr300, SPEAr310, SPEAr320 and SPEAr600 SOCs are supported.
14
15   Hierarchy in SPEAr is as follows:
16
17   SPEAr (Platform)
18
19         - SPEAr3XX (3XX SOC series, based on ARM9)
20                 - SPEAr300 (SOC)
21                         - SPEAr300 Evaluation Board
22                 - SPEAr310 (SOC)
23                         - SPEAr310 Evaluation Board
24                 - SPEAr320 (SOC)
25                         - SPEAr320 Evaluation Board
26         - SPEAr6XX (6XX SOC series, based on ARM9)
27                 - SPEAr600 (SOC)
28                         - SPEAr600 Evaluation Board
29         - SPEAr13XX (13XX SOC series, based on ARM CORTEXA9)
30                 - SPEAr1310 (SOC)
31                         - SPEAr1310 Evaluation Board
32                 - SPEAr1340 (SOC)
33                         - SPEAr1340 Evaluation Board
34
35 Configuration
36 -------------
37
38   A generic configuration is provided for each machine, and can be used as the
39   default by::
40
41         make spear13xx_defconfig
42         make spear3xx_defconfig
43         make spear6xx_defconfig
44
45 Layout
46 ------
47
48   The common files for multiple machine families (SPEAr3xx, SPEAr6xx and
49   SPEAr13xx) are located in the platform code contained in arch/arm/plat-spear
50   with headers in plat/.
51
52   Each machine series have a directory with name arch/arm/mach-spear followed by
53   series name. Like mach-spear3xx, mach-spear6xx and mach-spear13xx.
54
55   Common file for machines of spear3xx family is mach-spear3xx/spear3xx.c, for
56   spear6xx is mach-spear6xx/spear6xx.c and for spear13xx family is
57   mach-spear13xx/spear13xx.c. mach-spear* also contain soc/machine specific
58   files, like spear1310.c, spear1340.c spear300.c, spear310.c, spear320.c and
59   spear600.c.  mach-spear* doesn't contains board specific files as they fully
60   support Flattened Device Tree.
61
62
63 Document Author
64 ---------------
65
66   Viresh Kumar <vireshk@kernel.org>, (c) 2010-2012 ST Microelectronics