Merge tag '4.13-fixes' of git://git.lwn.net/linux
[sfrench/cifs-2.6.git] / Documentation / arm / Atmel / README
1 ARM Atmel SoCs (aka AT91)
2 =========================
3
4
5 Introduction
6 ------------
7 This document gives useful information about the ARM Atmel SoCs that are
8 currently supported in Linux Mainline (you know, the one on kernel.org).
9
10 It is important to note that the Atmel | SMART ARM-based MPU product line is
11 historically named "AT91" or "at91" throughout the Linux kernel development
12 process even if this product prefix has completely disappeared from the
13 official Atmel product name. Anyway, files, directories, git trees,
14 git branches/tags and email subject always contain this "at91" sub-string.
15
16
17 AT91 SoCs
18 ---------
19 Documentation and detailed datasheet for each product are available on
20 the Atmel website: http://www.atmel.com.
21
22   Flavors:
23     * ARM 920 based SoC
24       - at91rm9200
25         + Datasheet
26           http://www.atmel.com/Images/doc1768.pdf
27
28     * ARM 926 based SoCs
29       - at91sam9260
30         + Datasheet
31           http://www.atmel.com/Images/doc6221.pdf
32
33       - at91sam9xe
34         + Datasheet
35           http://www.atmel.com/Images/Atmel-6254-32-bit-ARM926EJ-S-Embedded-Microprocessor-SAM9XE_Datasheet.pdf
36
37       - at91sam9261
38         + Datasheet
39           http://www.atmel.com/Images/doc6062.pdf
40
41       - at91sam9263
42         + Datasheet
43           http://www.atmel.com/Images/Atmel_6249_32-bit-ARM926EJ-S-Microcontroller_SAM9263_Datasheet.pdf
44
45       - at91sam9rl
46         + Datasheet
47           http://www.atmel.com/Images/doc6289.pdf
48
49       - at91sam9g20
50         + Datasheet
51           http://www.atmel.com/Images/doc6384.pdf
52
53       - at91sam9g45 family
54         - at91sam9g45
55         - at91sam9g46
56         - at91sam9m10
57         - at91sam9m11 (device superset)
58         + Datasheet
59           http://www.atmel.com/Images/Atmel-6437-32-bit-ARM926-Embedded-Microprocessor-SAM9M11_Datasheet.pdf
60
61       - at91sam9x5 family (aka "The 5 series")
62         - at91sam9g15
63         - at91sam9g25
64         - at91sam9g35
65         - at91sam9x25
66         - at91sam9x35
67         + Datasheet (can be considered as covering the whole family)
68           http://www.atmel.com/Images/Atmel_11055_32-bit-ARM926EJ-S-Microcontroller_SAM9X35_Datasheet.pdf
69
70       - at91sam9n12
71         + Datasheet
72           http://www.atmel.com/Images/Atmel_11063_32-bit-ARM926EJ-S-Microcontroller_SAM9N12CN11CN12_Datasheet.pdf
73
74     * ARM Cortex-A5 based SoCs
75       - sama5d3 family
76         - sama5d31
77         - sama5d33
78         - sama5d34
79         - sama5d35
80         - sama5d36 (device superset)
81         + Datasheet
82           http://www.atmel.com/Images/Atmel-11121-32-bit-Cortex-A5-Microcontroller-SAMA5D3_Datasheet.pdf
83
84     * ARM Cortex-A5 + NEON based SoCs
85       - sama5d4 family
86         - sama5d41
87         - sama5d42
88         - sama5d43
89         - sama5d44 (device superset)
90         + Datasheet
91           http://www.atmel.com/Images/Atmel-11238-32-bit-Cortex-A5-Microcontroller-SAMA5D4_Datasheet.pdf
92
93       - sama5d2 family
94         - sama5d21
95         - sama5d22
96         - sama5d23
97         - sama5d24
98         - sama5d26
99         - sama5d27 (device superset)
100         - sama5d28 (device superset + environmental monitors)
101         + Datasheet
102           http://www.atmel.com/Images/Atmel-11267-32-bit-Cortex-A5-Microcontroller-SAMA5D2_Datasheet.pdf
103
104     * ARM Cortex-M7 MCUs
105       - sams70 family
106         - sams70j19
107         - sams70j20
108         - sams70j21
109         - sams70n19
110         - sams70n20
111         - sams70n21
112         - sams70q19
113         - sams70q20
114         - sams70q21
115         + Datasheet
116           http://www.atmel.com/Images/Atmel-11242-32-bit-Cortex-M7-Microcontroller-SAM-S70Q-SAM-S70N-SAM-S70J_Datasheet.pdf
117
118       - samv70 family
119         - samv70j19
120         - samv70j20
121         - samv70n19
122         - samv70n20
123         - samv70q19
124         - samv70q20
125         + Datasheet
126           http://www.atmel.com/Images/Atmel-11297-32-bit-Cortex-M7-Microcontroller-SAM-V70Q-SAM-V70N-SAM-V70J_Datasheet.pdf
127
128       - samv71 family
129         - samv71j19
130         - samv71j20
131         - samv71j21
132         - samv71n19
133         - samv71n20
134         - samv71n21
135         - samv71q19
136         - samv71q20
137         - samv71q21
138         + Datasheet
139           http://www.atmel.com/Images/Atmel-44003-32-bit-Cortex-M7-Microcontroller-SAM-V71Q-SAM-V71N-SAM-V71J_Datasheet.pdf
140
141 Linux kernel information
142 ------------------------
143 Linux kernel mach directory: arch/arm/mach-at91
144 MAINTAINERS entry is: "ARM/ATMEL AT91RM9200 AND AT91SAM ARM ARCHITECTURES"
145
146
147 Device Tree for AT91 SoCs and boards
148 ------------------------------------
149 All AT91 SoCs are converted to Device Tree. Since Linux 3.19, these products
150 must use this method to boot the Linux kernel.
151
152 Work In Progress statement:
153 Device Tree files and Device Tree bindings that apply to AT91 SoCs and boards are
154 considered as "Unstable". To be completely clear, any at91 binding can change at
155 any time. So, be sure to use a Device Tree Binary and a Kernel Image generated from
156 the same source tree.
157 Please refer to the Documentation/devicetree/bindings/ABI.txt file for a
158 definition of a "Stable" binding/ABI.
159 This statement will be removed by AT91 MAINTAINERS when appropriate.
160
161 Naming conventions and best practice:
162 - SoCs Device Tree Source Include files are named after the official name of
163   the product (at91sam9g20.dtsi or sama5d33.dtsi for instance).
164 - Device Tree Source Include files (.dtsi) are used to collect common nodes that can be
165   shared across SoCs or boards (sama5d3.dtsi or at91sam9x5cm.dtsi for instance).
166   When collecting nodes for a particular peripheral or topic, the identifier have to
167   be placed at the end of the file name, separated with a "_" (at91sam9x5_can.dtsi
168   or sama5d3_gmac.dtsi for example).
169 - board Device Tree Source files (.dts) are prefixed by the string "at91-" so
170   that they can be identified easily. Note that some files are historical exceptions
171   to this rule (sama5d3[13456]ek.dts, usb_a9g20.dts or animeo_ip.dts for example).