xref: /openbmc/qemu/hw/misc/eccmemctl.c (revision 2c9b15ca)
1 /*
2  * QEMU Sparc Sun4m ECC memory controller emulation
3  *
4  * Copyright (c) 2007 Robert Reif
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 
25 #include "hw/sysbus.h"
26 #include "trace.h"
27 
28 /* There are 3 versions of this chip used in SMP sun4m systems:
29  * MCC (version 0, implementation 0) SS-600MP
30  * EMC (version 0, implementation 1) SS-10
31  * SMC (version 0, implementation 2) SS-10SX and SS-20
32  *
33  * Chipset docs:
34  * "Sun-4M System Architecture (revision 2.0) by Chuck Narad", 950-1373-01,
35  * http://mediacast.sun.com/users/Barton808/media/Sun4M_SystemArchitecture_edited2.pdf
36  */
37 
38 #define ECC_MCC        0x00000000
39 #define ECC_EMC        0x10000000
40 #define ECC_SMC        0x20000000
41 
42 /* Register indexes */
43 #define ECC_MER        0               /* Memory Enable Register */
44 #define ECC_MDR        1               /* Memory Delay Register */
45 #define ECC_MFSR       2               /* Memory Fault Status Register */
46 #define ECC_VCR        3               /* Video Configuration Register */
47 #define ECC_MFAR0      4               /* Memory Fault Address Register 0 */
48 #define ECC_MFAR1      5               /* Memory Fault Address Register 1 */
49 #define ECC_DR         6               /* Diagnostic Register */
50 #define ECC_ECR0       7               /* Event Count Register 0 */
51 #define ECC_ECR1       8               /* Event Count Register 1 */
52 
53 /* ECC fault control register */
54 #define ECC_MER_EE     0x00000001      /* Enable ECC checking */
55 #define ECC_MER_EI     0x00000002      /* Enable Interrupts on
56                                           correctable errors */
57 #define ECC_MER_MRR0   0x00000004      /* SIMM 0 */
58 #define ECC_MER_MRR1   0x00000008      /* SIMM 1 */
59 #define ECC_MER_MRR2   0x00000010      /* SIMM 2 */
60 #define ECC_MER_MRR3   0x00000020      /* SIMM 3 */
61 #define ECC_MER_MRR4   0x00000040      /* SIMM 4 */
62 #define ECC_MER_MRR5   0x00000080      /* SIMM 5 */
63 #define ECC_MER_MRR6   0x00000100      /* SIMM 6 */
64 #define ECC_MER_MRR7   0x00000200      /* SIMM 7 */
65 #define ECC_MER_REU    0x00000100      /* Memory Refresh Enable (600MP) */
66 #define ECC_MER_MRR    0x000003fc      /* MRR mask */
67 #define ECC_MER_A      0x00000400      /* Memory controller addr map select */
68 #define ECC_MER_DCI    0x00000800      /* Disables Coherent Invalidate ACK */
69 #define ECC_MER_VER    0x0f000000      /* Version */
70 #define ECC_MER_IMPL   0xf0000000      /* Implementation */
71 #define ECC_MER_MASK_0 0x00000103      /* Version 0 (MCC) mask */
72 #define ECC_MER_MASK_1 0x00000bff      /* Version 1 (EMC) mask */
73 #define ECC_MER_MASK_2 0x00000bff      /* Version 2 (SMC) mask */
74 
75 /* ECC memory delay register */
76 #define ECC_MDR_RRI    0x000003ff      /* Refresh Request Interval */
77 #define ECC_MDR_MI     0x00001c00      /* MIH Delay */
78 #define ECC_MDR_CI     0x0000e000      /* Coherent Invalidate Delay */
79 #define ECC_MDR_MDL    0x001f0000      /* MBus Master arbitration delay */
80 #define ECC_MDR_MDH    0x03e00000      /* MBus Master arbitration delay */
81 #define ECC_MDR_GAD    0x7c000000      /* Graphics Arbitration Delay */
82 #define ECC_MDR_RSC    0x80000000      /* Refresh load control */
83 #define ECC_MDR_MASK   0x7fffffff
84 
85 /* ECC fault status register */
86 #define ECC_MFSR_CE    0x00000001      /* Correctable error */
87 #define ECC_MFSR_BS    0x00000002      /* C2 graphics bad slot access */
88 #define ECC_MFSR_TO    0x00000004      /* Timeout on write */
89 #define ECC_MFSR_UE    0x00000008      /* Uncorrectable error */
90 #define ECC_MFSR_DW    0x000000f0      /* Index of double word in block */
91 #define ECC_MFSR_SYND  0x0000ff00      /* Syndrome for correctable error */
92 #define ECC_MFSR_ME    0x00010000      /* Multiple errors */
93 #define ECC_MFSR_C2ERR 0x00020000      /* C2 graphics error */
94 
95 /* ECC fault address register 0 */
96 #define ECC_MFAR0_PADDR 0x0000000f     /* PA[32-35] */
97 #define ECC_MFAR0_TYPE  0x000000f0     /* Transaction type */
98 #define ECC_MFAR0_SIZE  0x00000700     /* Transaction size */
99 #define ECC_MFAR0_CACHE 0x00000800     /* Mapped cacheable */
100 #define ECC_MFAR0_LOCK  0x00001000     /* Error occurred in atomic cycle */
101 #define ECC_MFAR0_BMODE 0x00002000     /* Boot mode */
102 #define ECC_MFAR0_VADDR 0x003fc000     /* VA[12-19] (superset bits) */
103 #define ECC_MFAR0_S     0x08000000     /* Supervisor mode */
104 #define ECC_MFARO_MID   0xf0000000     /* Module ID */
105 
106 /* ECC diagnostic register */
107 #define ECC_DR_CBX     0x00000001
108 #define ECC_DR_CB0     0x00000002
109 #define ECC_DR_CB1     0x00000004
110 #define ECC_DR_CB2     0x00000008
111 #define ECC_DR_CB4     0x00000010
112 #define ECC_DR_CB8     0x00000020
113 #define ECC_DR_CB16    0x00000040
114 #define ECC_DR_CB32    0x00000080
115 #define ECC_DR_DMODE   0x00000c00
116 
117 #define ECC_NREGS      9
118 #define ECC_SIZE       (ECC_NREGS * sizeof(uint32_t))
119 
120 #define ECC_DIAG_SIZE  4
121 #define ECC_DIAG_MASK  (ECC_DIAG_SIZE - 1)
122 
123 typedef struct ECCState {
124     SysBusDevice busdev;
125     MemoryRegion iomem, iomem_diag;
126     qemu_irq irq;
127     uint32_t regs[ECC_NREGS];
128     uint8_t diag[ECC_DIAG_SIZE];
129     uint32_t version;
130 } ECCState;
131 
132 static void ecc_mem_write(void *opaque, hwaddr addr, uint64_t val,
133                           unsigned size)
134 {
135     ECCState *s = opaque;
136 
137     switch (addr >> 2) {
138     case ECC_MER:
139         if (s->version == ECC_MCC)
140             s->regs[ECC_MER] = (val & ECC_MER_MASK_0);
141         else if (s->version == ECC_EMC)
142             s->regs[ECC_MER] = s->version | (val & ECC_MER_MASK_1);
143         else if (s->version == ECC_SMC)
144             s->regs[ECC_MER] = s->version | (val & ECC_MER_MASK_2);
145         trace_ecc_mem_writel_mer(val);
146         break;
147     case ECC_MDR:
148         s->regs[ECC_MDR] =  val & ECC_MDR_MASK;
149         trace_ecc_mem_writel_mdr(val);
150         break;
151     case ECC_MFSR:
152         s->regs[ECC_MFSR] =  val;
153         qemu_irq_lower(s->irq);
154         trace_ecc_mem_writel_mfsr(val);
155         break;
156     case ECC_VCR:
157         s->regs[ECC_VCR] =  val;
158         trace_ecc_mem_writel_vcr(val);
159         break;
160     case ECC_DR:
161         s->regs[ECC_DR] =  val;
162         trace_ecc_mem_writel_dr(val);
163         break;
164     case ECC_ECR0:
165         s->regs[ECC_ECR0] =  val;
166         trace_ecc_mem_writel_ecr0(val);
167         break;
168     case ECC_ECR1:
169         s->regs[ECC_ECR0] =  val;
170         trace_ecc_mem_writel_ecr1(val);
171         break;
172     }
173 }
174 
175 static uint64_t ecc_mem_read(void *opaque, hwaddr addr,
176                              unsigned size)
177 {
178     ECCState *s = opaque;
179     uint32_t ret = 0;
180 
181     switch (addr >> 2) {
182     case ECC_MER:
183         ret = s->regs[ECC_MER];
184         trace_ecc_mem_readl_mer(ret);
185         break;
186     case ECC_MDR:
187         ret = s->regs[ECC_MDR];
188         trace_ecc_mem_readl_mdr(ret);
189         break;
190     case ECC_MFSR:
191         ret = s->regs[ECC_MFSR];
192         trace_ecc_mem_readl_mfsr(ret);
193         break;
194     case ECC_VCR:
195         ret = s->regs[ECC_VCR];
196         trace_ecc_mem_readl_vcr(ret);
197         break;
198     case ECC_MFAR0:
199         ret = s->regs[ECC_MFAR0];
200         trace_ecc_mem_readl_mfar0(ret);
201         break;
202     case ECC_MFAR1:
203         ret = s->regs[ECC_MFAR1];
204         trace_ecc_mem_readl_mfar1(ret);
205         break;
206     case ECC_DR:
207         ret = s->regs[ECC_DR];
208         trace_ecc_mem_readl_dr(ret);
209         break;
210     case ECC_ECR0:
211         ret = s->regs[ECC_ECR0];
212         trace_ecc_mem_readl_ecr0(ret);
213         break;
214     case ECC_ECR1:
215         ret = s->regs[ECC_ECR0];
216         trace_ecc_mem_readl_ecr1(ret);
217         break;
218     }
219     return ret;
220 }
221 
222 static const MemoryRegionOps ecc_mem_ops = {
223     .read = ecc_mem_read,
224     .write = ecc_mem_write,
225     .endianness = DEVICE_NATIVE_ENDIAN,
226     .valid = {
227         .min_access_size = 4,
228         .max_access_size = 4,
229     },
230 };
231 
232 static void ecc_diag_mem_write(void *opaque, hwaddr addr,
233                                uint64_t val, unsigned size)
234 {
235     ECCState *s = opaque;
236 
237     trace_ecc_diag_mem_writeb(addr, val);
238     s->diag[addr & ECC_DIAG_MASK] = val;
239 }
240 
241 static uint64_t ecc_diag_mem_read(void *opaque, hwaddr addr,
242                                   unsigned size)
243 {
244     ECCState *s = opaque;
245     uint32_t ret = s->diag[(int)addr];
246 
247     trace_ecc_diag_mem_readb(addr, ret);
248     return ret;
249 }
250 
251 static const MemoryRegionOps ecc_diag_mem_ops = {
252     .read = ecc_diag_mem_read,
253     .write = ecc_diag_mem_write,
254     .endianness = DEVICE_NATIVE_ENDIAN,
255     .valid = {
256         .min_access_size = 1,
257         .max_access_size = 1,
258     },
259 };
260 
261 static const VMStateDescription vmstate_ecc = {
262     .name ="ECC",
263     .version_id = 3,
264     .minimum_version_id = 3,
265     .minimum_version_id_old = 3,
266     .fields      = (VMStateField []) {
267         VMSTATE_UINT32_ARRAY(regs, ECCState, ECC_NREGS),
268         VMSTATE_BUFFER(diag, ECCState),
269         VMSTATE_UINT32(version, ECCState),
270         VMSTATE_END_OF_LIST()
271     }
272 };
273 
274 static void ecc_reset(DeviceState *d)
275 {
276     ECCState *s = container_of(d, ECCState, busdev.qdev);
277 
278     if (s->version == ECC_MCC)
279         s->regs[ECC_MER] &= ECC_MER_REU;
280     else
281         s->regs[ECC_MER] &= (ECC_MER_VER | ECC_MER_IMPL | ECC_MER_MRR |
282                              ECC_MER_DCI);
283     s->regs[ECC_MDR] = 0x20;
284     s->regs[ECC_MFSR] = 0;
285     s->regs[ECC_VCR] = 0;
286     s->regs[ECC_MFAR0] = 0x07c00000;
287     s->regs[ECC_MFAR1] = 0;
288     s->regs[ECC_DR] = 0;
289     s->regs[ECC_ECR0] = 0;
290     s->regs[ECC_ECR1] = 0;
291 }
292 
293 static int ecc_init1(SysBusDevice *dev)
294 {
295     ECCState *s = FROM_SYSBUS(ECCState, dev);
296 
297     sysbus_init_irq(dev, &s->irq);
298     s->regs[0] = s->version;
299     memory_region_init_io(&s->iomem, NULL, &ecc_mem_ops, s, "ecc", ECC_SIZE);
300     sysbus_init_mmio(dev, &s->iomem);
301 
302     if (s->version == ECC_MCC) { // SS-600MP only
303         memory_region_init_io(&s->iomem_diag, NULL, &ecc_diag_mem_ops, s,
304                               "ecc.diag", ECC_DIAG_SIZE);
305         sysbus_init_mmio(dev, &s->iomem_diag);
306     }
307 
308     return 0;
309 }
310 
311 static Property ecc_properties[] = {
312     DEFINE_PROP_HEX32("version", ECCState, version, -1),
313     DEFINE_PROP_END_OF_LIST(),
314 };
315 
316 static void ecc_class_init(ObjectClass *klass, void *data)
317 {
318     DeviceClass *dc = DEVICE_CLASS(klass);
319     SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);
320 
321     k->init = ecc_init1;
322     dc->reset = ecc_reset;
323     dc->vmsd = &vmstate_ecc;
324     dc->props = ecc_properties;
325 }
326 
327 static const TypeInfo ecc_info = {
328     .name          = "eccmemctl",
329     .parent        = TYPE_SYS_BUS_DEVICE,
330     .instance_size = sizeof(ECCState),
331     .class_init    = ecc_class_init,
332 };
333 
334 
335 static void ecc_register_types(void)
336 {
337     type_register_static(&ecc_info);
338 }
339 
340 type_init(ecc_register_types)
341