]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - arch/mips/include/asm/mips-cm.h
MIPS: Add platform callback before initializing the L2 cache
[mirror_ubuntu-eoan-kernel.git] / arch / mips / include / asm / mips-cm.h
CommitLineData
9f98f3dd
PB
1/*
2 * Copyright (C) 2013 Imagination Technologies
3 * Author: Paul Burton <paul.burton@imgtec.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version.
9 */
10
11#ifndef __MIPS_ASM_MIPS_CM_H__
12#define __MIPS_ASM_MIPS_CM_H__
13
56d4c99b 14#include <linux/errno.h>
9f98f3dd
PB
15#include <linux/io.h>
16#include <linux/types.h>
17
18/* The base address of the CM GCR block */
19extern void __iomem *mips_cm_base;
20
21/* The base address of the CM L2-only sync region */
22extern void __iomem *mips_cm_l2sync_base;
23
24/**
25 * __mips_cm_phys_base - retrieve the physical base address of the CM
26 *
27 * This function returns the physical base address of the Coherence Manager
28 * global control block, or 0 if no Coherence Manager is present. It provides
29 * a default implementation which reads the CMGCRBase register where available,
30 * and may be overriden by platforms which determine this address in a
31 * different way by defining a function with the same prototype except for the
32 * name mips_cm_phys_base (without underscores).
33 */
15d45cce 34extern phys_addr_t __mips_cm_phys_base(void);
9f98f3dd
PB
35
36/**
37 * mips_cm_probe - probe for a Coherence Manager
38 *
39 * Attempt to detect the presence of a Coherence Manager. Returns 0 if a CM
40 * is successfully detected, else -errno.
41 */
42#ifdef CONFIG_MIPS_CM
43extern int mips_cm_probe(void);
44#else
45static inline int mips_cm_probe(void)
46{
47 return -ENODEV;
48}
49#endif
50
51/**
52 * mips_cm_present - determine whether a Coherence Manager is present
53 *
54 * Returns true if a CM is present in the system, else false.
55 */
56static inline bool mips_cm_present(void)
57{
58#ifdef CONFIG_MIPS_CM
59 return mips_cm_base != NULL;
60#else
61 return false;
62#endif
63}
64
65/**
66 * mips_cm_has_l2sync - determine whether an L2-only sync region is present
67 *
68 * Returns true if the system implements an L2-only sync region, else false.
69 */
70static inline bool mips_cm_has_l2sync(void)
71{
72#ifdef CONFIG_MIPS_CM
73 return mips_cm_l2sync_base != NULL;
74#else
75 return false;
76#endif
77}
78
79/* Offsets to register blocks from the CM base address */
80#define MIPS_CM_GCB_OFS 0x0000 /* Global Control Block */
81#define MIPS_CM_CLCB_OFS 0x2000 /* Core Local Control Block */
82#define MIPS_CM_COCB_OFS 0x4000 /* Core Other Control Block */
83#define MIPS_CM_GDB_OFS 0x6000 /* Global Debug Block */
84
85/* Total size of the CM memory mapped registers */
86#define MIPS_CM_GCR_SIZE 0x8000
87
88/* Size of the L2-only sync region */
89#define MIPS_CM_L2SYNC_SIZE 0x1000
90
91/* Macros to ease the creation of register access functions */
92#define BUILD_CM_R_(name, off) \
50083928 93static inline u32 __iomem *addr_gcr_##name(void) \
9f98f3dd 94{ \
50083928 95 return (u32 __iomem *)(mips_cm_base + (off)); \
9f98f3dd
PB
96} \
97 \
98static inline u32 read_gcr_##name(void) \
99{ \
cd217546 100 return __raw_readl(addr_gcr_##name()); \
9f98f3dd
PB
101}
102
103#define BUILD_CM__W(name, off) \
104static inline void write_gcr_##name(u32 value) \
105{ \
cd217546 106 __raw_writel(value, addr_gcr_##name()); \
9f98f3dd
PB
107}
108
109#define BUILD_CM_RW(name, off) \
110 BUILD_CM_R_(name, off) \
111 BUILD_CM__W(name, off)
112
113#define BUILD_CM_Cx_R_(name, off) \
114 BUILD_CM_R_(cl_##name, MIPS_CM_CLCB_OFS + (off)) \
115 BUILD_CM_R_(co_##name, MIPS_CM_COCB_OFS + (off))
116
117#define BUILD_CM_Cx__W(name, off) \
118 BUILD_CM__W(cl_##name, MIPS_CM_CLCB_OFS + (off)) \
119 BUILD_CM__W(co_##name, MIPS_CM_COCB_OFS + (off))
120
121#define BUILD_CM_Cx_RW(name, off) \
122 BUILD_CM_Cx_R_(name, off) \
123 BUILD_CM_Cx__W(name, off)
124
125/* GCB register accessor functions */
126BUILD_CM_R_(config, MIPS_CM_GCB_OFS + 0x00)
127BUILD_CM_RW(base, MIPS_CM_GCB_OFS + 0x08)
128BUILD_CM_RW(access, MIPS_CM_GCB_OFS + 0x20)
129BUILD_CM_R_(rev, MIPS_CM_GCB_OFS + 0x30)
130BUILD_CM_RW(error_mask, MIPS_CM_GCB_OFS + 0x40)
131BUILD_CM_RW(error_cause, MIPS_CM_GCB_OFS + 0x48)
132BUILD_CM_RW(error_addr, MIPS_CM_GCB_OFS + 0x50)
133BUILD_CM_RW(error_mult, MIPS_CM_GCB_OFS + 0x58)
134BUILD_CM_RW(l2_only_sync_base, MIPS_CM_GCB_OFS + 0x70)
135BUILD_CM_RW(gic_base, MIPS_CM_GCB_OFS + 0x80)
136BUILD_CM_RW(cpc_base, MIPS_CM_GCB_OFS + 0x88)
137BUILD_CM_RW(reg0_base, MIPS_CM_GCB_OFS + 0x90)
138BUILD_CM_RW(reg0_mask, MIPS_CM_GCB_OFS + 0x98)
139BUILD_CM_RW(reg1_base, MIPS_CM_GCB_OFS + 0xa0)
140BUILD_CM_RW(reg1_mask, MIPS_CM_GCB_OFS + 0xa8)
141BUILD_CM_RW(reg2_base, MIPS_CM_GCB_OFS + 0xb0)
142BUILD_CM_RW(reg2_mask, MIPS_CM_GCB_OFS + 0xb8)
143BUILD_CM_RW(reg3_base, MIPS_CM_GCB_OFS + 0xc0)
144BUILD_CM_RW(reg3_mask, MIPS_CM_GCB_OFS + 0xc8)
145BUILD_CM_R_(gic_status, MIPS_CM_GCB_OFS + 0xd0)
146BUILD_CM_R_(cpc_status, MIPS_CM_GCB_OFS + 0xf0)
0ba3c125 147BUILD_CM_RW(l2_config, MIPS_CM_GCB_OFS + 0x130)
9f98f3dd
PB
148
149/* Core Local & Core Other register accessor functions */
150BUILD_CM_Cx_RW(reset_release, 0x00)
151BUILD_CM_Cx_RW(coherence, 0x08)
152BUILD_CM_Cx_R_(config, 0x10)
153BUILD_CM_Cx_RW(other, 0x18)
154BUILD_CM_Cx_RW(reset_base, 0x20)
155BUILD_CM_Cx_R_(id, 0x28)
156BUILD_CM_Cx_RW(reset_ext_base, 0x30)
157BUILD_CM_Cx_R_(tcid_0_priority, 0x40)
158BUILD_CM_Cx_R_(tcid_1_priority, 0x48)
159BUILD_CM_Cx_R_(tcid_2_priority, 0x50)
160BUILD_CM_Cx_R_(tcid_3_priority, 0x58)
161BUILD_CM_Cx_R_(tcid_4_priority, 0x60)
162BUILD_CM_Cx_R_(tcid_5_priority, 0x68)
163BUILD_CM_Cx_R_(tcid_6_priority, 0x70)
164BUILD_CM_Cx_R_(tcid_7_priority, 0x78)
165BUILD_CM_Cx_R_(tcid_8_priority, 0x80)
166
167/* GCR_CONFIG register fields */
168#define CM_GCR_CONFIG_NUMIOCU_SHF 8
169#define CM_GCR_CONFIG_NUMIOCU_MSK (_ULCAST_(0xf) << 8)
170#define CM_GCR_CONFIG_PCORES_SHF 0
171#define CM_GCR_CONFIG_PCORES_MSK (_ULCAST_(0xff) << 0)
172
173/* GCR_BASE register fields */
174#define CM_GCR_BASE_GCRBASE_SHF 15
175#define CM_GCR_BASE_GCRBASE_MSK (_ULCAST_(0x1ffff) << 15)
176#define CM_GCR_BASE_CMDEFTGT_SHF 0
177#define CM_GCR_BASE_CMDEFTGT_MSK (_ULCAST_(0x3) << 0)
178#define CM_GCR_BASE_CMDEFTGT_DISABLED 0
179#define CM_GCR_BASE_CMDEFTGT_MEM 1
180#define CM_GCR_BASE_CMDEFTGT_IOCU0 2
181#define CM_GCR_BASE_CMDEFTGT_IOCU1 3
182
183/* GCR_ACCESS register fields */
184#define CM_GCR_ACCESS_ACCESSEN_SHF 0
185#define CM_GCR_ACCESS_ACCESSEN_MSK (_ULCAST_(0xff) << 0)
186
187/* GCR_REV register fields */
188#define CM_GCR_REV_MAJOR_SHF 8
189#define CM_GCR_REV_MAJOR_MSK (_ULCAST_(0xff) << 8)
190#define CM_GCR_REV_MINOR_SHF 0
191#define CM_GCR_REV_MINOR_MSK (_ULCAST_(0xff) << 0)
192
197e89e0
PB
193#define CM_ENCODE_REV(major, minor) \
194 (((major) << CM_GCR_REV_MAJOR_SHF) | \
195 ((minor) << CM_GCR_REV_MINOR_SHF))
196
197#define CM_REV_CM2 CM_ENCODE_REV(6, 0)
198#define CM_REV_CM3 CM_ENCODE_REV(8, 0)
199
9f98f3dd
PB
200/* GCR_ERROR_CAUSE register fields */
201#define CM_GCR_ERROR_CAUSE_ERRTYPE_SHF 27
202#define CM_GCR_ERROR_CAUSE_ERRTYPE_MSK (_ULCAST_(0x1f) << 27)
203#define CM_GCR_ERROR_CAUSE_ERRINFO_SHF 0
204#define CM_GCR_ERROR_CAUSE_ERRINGO_MSK (_ULCAST_(0x7ffffff) << 0)
205
206/* GCR_ERROR_MULT register fields */
207#define CM_GCR_ERROR_MULT_ERR2ND_SHF 0
208#define CM_GCR_ERROR_MULT_ERR2ND_MSK (_ULCAST_(0x1f) << 0)
209
210/* GCR_L2_ONLY_SYNC_BASE register fields */
211#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCBASE_SHF 12
212#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCBASE_MSK (_ULCAST_(0xfffff) << 12)
213#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCEN_SHF 0
214#define CM_GCR_L2_ONLY_SYNC_BASE_SYNCEN_MSK (_ULCAST_(0x1) << 0)
215
216/* GCR_GIC_BASE register fields */
217#define CM_GCR_GIC_BASE_GICBASE_SHF 17
218#define CM_GCR_GIC_BASE_GICBASE_MSK (_ULCAST_(0x7fff) << 17)
219#define CM_GCR_GIC_BASE_GICEN_SHF 0
220#define CM_GCR_GIC_BASE_GICEN_MSK (_ULCAST_(0x1) << 0)
221
222/* GCR_CPC_BASE register fields */
223#define CM_GCR_CPC_BASE_CPCBASE_SHF 17
224#define CM_GCR_CPC_BASE_CPCBASE_MSK (_ULCAST_(0x7fff) << 17)
225#define CM_GCR_CPC_BASE_CPCEN_SHF 0
226#define CM_GCR_CPC_BASE_CPCEN_MSK (_ULCAST_(0x1) << 0)
227
921d55e3
PB
228/* GCR_GIC_STATUS register fields */
229#define CM_GCR_GIC_STATUS_GICEX_SHF 0
230#define CM_GCR_GIC_STATUS_GICEX_MSK (_ULCAST_(0x1) << 0)
231
9f98f3dd
PB
232/* GCR_REGn_BASE register fields */
233#define CM_GCR_REGn_BASE_BASEADDR_SHF 16
234#define CM_GCR_REGn_BASE_BASEADDR_MSK (_ULCAST_(0xffff) << 16)
235
236/* GCR_REGn_MASK register fields */
237#define CM_GCR_REGn_MASK_ADDRMASK_SHF 16
238#define CM_GCR_REGn_MASK_ADDRMASK_MSK (_ULCAST_(0xffff) << 16)
239#define CM_GCR_REGn_MASK_CCAOVR_SHF 5
240#define CM_GCR_REGn_MASK_CCAOVR_MSK (_ULCAST_(0x3) << 5)
241#define CM_GCR_REGn_MASK_CCAOVREN_SHF 4
242#define CM_GCR_REGn_MASK_CCAOVREN_MSK (_ULCAST_(0x1) << 4)
243#define CM_GCR_REGn_MASK_DROPL2_SHF 2
244#define CM_GCR_REGn_MASK_DROPL2_MSK (_ULCAST_(0x1) << 2)
245#define CM_GCR_REGn_MASK_CMTGT_SHF 0
246#define CM_GCR_REGn_MASK_CMTGT_MSK (_ULCAST_(0x3) << 0)
247#define CM_GCR_REGn_MASK_CMTGT_DISABLED (_ULCAST_(0x0) << 0)
248#define CM_GCR_REGn_MASK_CMTGT_MEM (_ULCAST_(0x1) << 0)
249#define CM_GCR_REGn_MASK_CMTGT_IOCU0 (_ULCAST_(0x2) << 0)
250#define CM_GCR_REGn_MASK_CMTGT_IOCU1 (_ULCAST_(0x3) << 0)
251
252/* GCR_GIC_STATUS register fields */
253#define CM_GCR_GIC_STATUS_EX_SHF 0
254#define CM_GCR_GIC_STATUS_EX_MSK (_ULCAST_(0x1) << 0)
255
256/* GCR_CPC_STATUS register fields */
257#define CM_GCR_CPC_STATUS_EX_SHF 0
258#define CM_GCR_CPC_STATUS_EX_MSK (_ULCAST_(0x1) << 0)
259
0ba3c125
PB
260/* GCR_L2_CONFIG register fields */
261#define CM_GCR_L2_CONFIG_BYPASS_SHF 20
262#define CM_GCR_L2_CONFIG_BYPASS_MSK (_ULCAST_(0x1) << 20)
263#define CM_GCR_L2_CONFIG_SET_SIZE_SHF 12
264#define CM_GCR_L2_CONFIG_SET_SIZE_MSK (_ULCAST_(0xf) << 12)
265#define CM_GCR_L2_CONFIG_LINE_SIZE_SHF 8
266#define CM_GCR_L2_CONFIG_LINE_SIZE_MSK (_ULCAST_(0xf) << 8)
267#define CM_GCR_L2_CONFIG_ASSOC_SHF 0
268#define CM_GCR_L2_CONFIG_ASSOC_MSK (_ULCAST_(0xff) << 0)
269
9f98f3dd
PB
270/* GCR_Cx_COHERENCE register fields */
271#define CM_GCR_Cx_COHERENCE_COHDOMAINEN_SHF 0
272#define CM_GCR_Cx_COHERENCE_COHDOMAINEN_MSK (_ULCAST_(0xff) << 0)
273
274/* GCR_Cx_CONFIG register fields */
275#define CM_GCR_Cx_CONFIG_IOCUTYPE_SHF 10
276#define CM_GCR_Cx_CONFIG_IOCUTYPE_MSK (_ULCAST_(0x3) << 10)
277#define CM_GCR_Cx_CONFIG_PVPE_SHF 0
278#define CM_GCR_Cx_CONFIG_PVPE_MSK (_ULCAST_(0x1ff) << 0)
279
280/* GCR_Cx_OTHER register fields */
281#define CM_GCR_Cx_OTHER_CORENUM_SHF 16
282#define CM_GCR_Cx_OTHER_CORENUM_MSK (_ULCAST_(0xffff) << 16)
283
284/* GCR_Cx_RESET_BASE register fields */
285#define CM_GCR_Cx_RESET_BASE_BEVEXCBASE_SHF 12
286#define CM_GCR_Cx_RESET_BASE_BEVEXCBASE_MSK (_ULCAST_(0xfffff) << 12)
287
288/* GCR_Cx_RESET_EXT_BASE register fields */
289#define CM_GCR_Cx_RESET_EXT_BASE_EVARESET_SHF 31
290#define CM_GCR_Cx_RESET_EXT_BASE_EVARESET_MSK (_ULCAST_(0x1) << 31)
291#define CM_GCR_Cx_RESET_EXT_BASE_UEB_SHF 30
292#define CM_GCR_Cx_RESET_EXT_BASE_UEB_MSK (_ULCAST_(0x1) << 30)
293#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCMASK_SHF 20
294#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCMASK_MSK (_ULCAST_(0xff) << 20)
295#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCPA_SHF 1
296#define CM_GCR_Cx_RESET_EXT_BASE_BEVEXCPA_MSK (_ULCAST_(0x7f) << 1)
297#define CM_GCR_Cx_RESET_EXT_BASE_PRESENT_SHF 0
298#define CM_GCR_Cx_RESET_EXT_BASE_PRESENT_MSK (_ULCAST_(0x1) << 0)
299
300/**
301 * mips_cm_numcores - return the number of cores present in the system
302 *
303 * Returns the value of the PCORES field of the GCR_CONFIG register plus 1, or
304 * zero if no Coherence Manager is present.
305 */
306static inline unsigned mips_cm_numcores(void)
307{
308 if (!mips_cm_present())
309 return 0;
310
311 return ((read_gcr_config() & CM_GCR_CONFIG_PCORES_MSK)
312 >> CM_GCR_CONFIG_PCORES_SHF) + 1;
313}
314
315/**
316 * mips_cm_numiocu - return the number of IOCUs present in the system
317 *
318 * Returns the value of the NUMIOCU field of the GCR_CONFIG register, or zero
319 * if no Coherence Manager is present.
320 */
321static inline unsigned mips_cm_numiocu(void)
322{
323 if (!mips_cm_present())
324 return 0;
325
326 return (read_gcr_config() & CM_GCR_CONFIG_NUMIOCU_MSK)
327 >> CM_GCR_CONFIG_NUMIOCU_SHF;
328}
329
330/**
331 * mips_cm_l2sync - perform an L2-only sync operation
332 *
333 * If an L2-only sync region is present in the system then this function
334 * performs and L2-only sync and returns zero. Otherwise it returns -ENODEV.
335 */
336static inline int mips_cm_l2sync(void)
337{
338 if (!mips_cm_has_l2sync())
339 return -ENODEV;
340
341 writel(0, mips_cm_l2sync_base);
342 return 0;
343}
344
197e89e0
PB
345/**
346 * mips_cm_revision() - return CM revision
347 *
348 * Return: The revision of the CM, from GCR_REV, or 0 if no CM is present. The
349 * return value should be checked against the CM_REV_* macros.
350 */
351static inline int mips_cm_revision(void)
352{
353 if (!mips_cm_present())
354 return 0;
355
356 return read_gcr_rev();
357}
358
9f98f3dd 359#endif /* __MIPS_ASM_MIPS_CM_H__ */