GNU Linux-libre 4.14.251-gnu1
[releases.git] / arch / m68k / mac / via.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  *      6522 Versatile Interface Adapter (VIA)
4  *
5  *      There are two of these on the Mac II. Some IRQs are vectored
6  *      via them as are assorted bits and bobs - eg RTC, ADB.
7  *
8  * CSA: Motorola seems to have removed documentation on the 6522 from
9  * their web site; try
10  *     http://nerini.drf.com/vectrex/other/text/chips/6522/
11  *     http://www.zymurgy.net/classic/vic20/vicdet1.htm
12  * and
13  *     http://193.23.168.87/mikro_laborversuche/via_iobaustein/via6522_1.html
14  * for info.  A full-text web search on 6522 AND VIA will probably also
15  * net some usefulness. <cananian@alumni.princeton.edu> 20apr1999
16  *
17  * Additional data is here (the SY6522 was used in the Mac II etc):
18  *     http://www.6502.org/documents/datasheets/synertek/synertek_sy6522.pdf
19  *     http://www.6502.org/documents/datasheets/synertek/synertek_sy6522_programming_reference.pdf
20  *
21  * PRAM/RTC access algorithms are from the NetBSD RTC toolkit version 1.08b
22  * by Erik Vogan and adapted to Linux by Joshua M. Thompson (funaho@jurai.org)
23  *
24  */
25
26 #include <linux/types.h>
27 #include <linux/kernel.h>
28 #include <linux/mm.h>
29 #include <linux/delay.h>
30 #include <linux/init.h>
31 #include <linux/module.h>
32 #include <linux/irq.h>
33
34 #include <asm/macintosh.h>
35 #include <asm/macints.h>
36 #include <asm/mac_via.h>
37 #include <asm/mac_psc.h>
38 #include <asm/mac_oss.h>
39
40 volatile __u8 *via1, *via2;
41 int rbv_present;
42 int via_alt_mapping;
43 EXPORT_SYMBOL(via_alt_mapping);
44 static __u8 rbv_clear;
45
46 /*
47  * Globals for accessing the VIA chip registers without having to
48  * check if we're hitting a real VIA or an RBV. Normally you could
49  * just hit the combined register (ie, vIER|rIER) but that seems to
50  * break on AV Macs...probably because they actually decode more than
51  * eight address bits. Why can't Apple engineers at least be
52  * _consistently_ lazy?                          - 1999-05-21 (jmt)
53  */
54
55 static int gIER,gIFR,gBufA,gBufB;
56
57 /*
58  * On Macs with a genuine VIA chip there is no way to mask an individual slot
59  * interrupt. This limitation also seems to apply to VIA clone logic cores in
60  * Quadra-like ASICs. (RBV and OSS machines don't have this limitation.)
61  *
62  * We used to fake it by configuring the relevant VIA pin as an output
63  * (to mask the interrupt) or input (to unmask). That scheme did not work on
64  * (at least) the Quadra 700. A NuBus card's /NMRQ signal is an open-collector
65  * circuit (see Designing Cards and Drivers for Macintosh II and Macintosh SE,
66  * p. 10-11 etc) but VIA outputs are not (see datasheet).
67  *
68  * Driving these outputs high must cause the VIA to source current and the
69  * card to sink current when it asserts /NMRQ. Current will flow but the pin
70  * voltage is uncertain and so the /NMRQ condition may still cause a transition
71  * at the VIA2 CA1 input (which explains the lost interrupts). A side effect
72  * is that a disabled slot IRQ can never be tested as pending or not.
73  *
74  * Driving these outputs low doesn't work either. All the slot /NMRQ lines are
75  * (active low) OR'd together to generate the CA1 (aka "SLOTS") interrupt (see
76  * The Guide To Macintosh Family Hardware, 2nd edition p. 167). If we drive a
77  * disabled /NMRQ line low, the falling edge immediately triggers a CA1
78  * interrupt and all slot interrupts after that will generate no transition
79  * and therefore no interrupt, even after being re-enabled.
80  *
81  * So we make the VIA port A I/O lines inputs and use nubus_disabled to keep
82  * track of their states. When any slot IRQ becomes disabled we mask the CA1
83  * umbrella interrupt. Only when all slot IRQs become enabled do we unmask
84  * the CA1 interrupt. It must remain enabled even when cards have no interrupt
85  * handler registered. Drivers must therefore disable a slot interrupt at the
86  * device before they call free_irq (like shared and autovector interrupts).
87  *
88  * There is also a related problem when MacOS is used to boot Linux. A network
89  * card brought up by a MacOS driver may raise an interrupt while Linux boots.
90  * This can be fatal since it can't be handled until the right driver loads
91  * (if such a driver exists at all). Apparently related to this hardware
92  * limitation, "Designing Cards and Drivers", p. 9-8, says that a slot
93  * interrupt with no driver would crash MacOS (the book was written before
94  * the appearance of Macs with RBV or OSS).
95  */
96
97 static u8 nubus_disabled;
98
99 void via_debug_dump(void);
100
101 /*
102  * Initialize the VIAs
103  *
104  * First we figure out where they actually _are_ as well as what type of
105  * VIA we have for VIA2 (it could be a real VIA or an RBV or even an OSS.)
106  * Then we pretty much clear them out and disable all IRQ sources.
107  *
108  * Note: the OSS is actually "detected" here and not in oss_init(). It just
109  *       seems more logical to do it here since via_init() needs to know
110  *       these things anyways.
111  */
112
113 void __init via_init(void)
114 {
115         switch(macintosh_config->via_type) {
116
117                 /* IIci, IIsi, IIvx, IIvi (P6xx), LC series */
118
119                 case MAC_VIA_IICI:
120                         via1 = (void *) VIA1_BASE;
121                         if (macintosh_config->ident == MAC_MODEL_IIFX) {
122                                 via2 = NULL;
123                                 rbv_present = 0;
124                                 oss_present = 1;
125                         } else {
126                                 via2 = (void *) RBV_BASE;
127                                 rbv_present = 1;
128                                 oss_present = 0;
129                         }
130                         if (macintosh_config->ident == MAC_MODEL_LCIII) {
131                                 rbv_clear = 0x00;
132                         } else {
133                                 /* on most RBVs (& unlike the VIAs), you   */
134                                 /* need to set bit 7 when you write to IFR */
135                                 /* in order for your clear to occur.       */
136                                 rbv_clear = 0x80;
137                         }
138                         gIER = rIER;
139                         gIFR = rIFR;
140                         gBufA = rSIFR;
141                         gBufB = rBufB;
142                         break;
143
144                 /* Quadra and early MacIIs agree on the VIA locations */
145
146                 case MAC_VIA_QUADRA:
147                 case MAC_VIA_II:
148                         via1 = (void *) VIA1_BASE;
149                         via2 = (void *) VIA2_BASE;
150                         rbv_present = 0;
151                         oss_present = 0;
152                         rbv_clear = 0x00;
153                         gIER = vIER;
154                         gIFR = vIFR;
155                         gBufA = vBufA;
156                         gBufB = vBufB;
157                         break;
158                 default:
159                         panic("UNKNOWN VIA TYPE");
160         }
161
162         printk(KERN_INFO "VIA1 at %p is a 6522 or clone\n", via1);
163
164         printk(KERN_INFO "VIA2 at %p is ", via2);
165         if (rbv_present) {
166                 printk("an RBV\n");
167         } else if (oss_present) {
168                 printk("an OSS\n");
169         } else {
170                 printk("a 6522 or clone\n");
171         }
172
173 #ifdef DEBUG_VIA
174         via_debug_dump();
175 #endif
176
177         /*
178          * Shut down all IRQ sources, reset the timers, and
179          * kill the timer latch on VIA1.
180          */
181
182         via1[vIER] = 0x7F;
183         via1[vIFR] = 0x7F;
184         via1[vT1LL] = 0;
185         via1[vT1LH] = 0;
186         via1[vT1CL] = 0;
187         via1[vT1CH] = 0;
188         via1[vT2CL] = 0;
189         via1[vT2CH] = 0;
190         via1[vACR] &= ~0xC0; /* setup T1 timer with no PB7 output */
191         via1[vACR] &= ~0x03; /* disable port A & B latches */
192
193         /*
194          * SE/30: disable video IRQ
195          * XXX: testing for SE/30 VBL
196          */
197
198         if (macintosh_config->ident == MAC_MODEL_SE30) {
199                 via1[vDirB] |= 0x40;
200                 via1[vBufB] |= 0x40;
201         }
202
203         /*
204          * Set the RTC bits to a known state: all lines to outputs and
205          * RTC disabled (yes that's 0 to enable and 1 to disable).
206          */
207
208         via1[vDirB] |= (VIA1B_vRTCEnb | VIA1B_vRTCClk | VIA1B_vRTCData);
209         via1[vBufB] |= (VIA1B_vRTCEnb | VIA1B_vRTCClk);
210
211         /* Everything below this point is VIA2/RBV only... */
212
213         if (oss_present)
214                 return;
215
216         if ((macintosh_config->via_type == MAC_VIA_QUADRA) &&
217             (macintosh_config->adb_type != MAC_ADB_PB1) &&
218             (macintosh_config->adb_type != MAC_ADB_PB2) &&
219             (macintosh_config->ident    != MAC_MODEL_C660) &&
220             (macintosh_config->ident    != MAC_MODEL_Q840)) {
221                 via_alt_mapping = 1;
222                 via1[vDirB] |= 0x40;
223                 via1[vBufB] &= ~0x40;
224         } else {
225                 via_alt_mapping = 0;
226         }
227
228         /*
229          * Now initialize VIA2. For RBV we just kill all interrupts;
230          * for a regular VIA we also reset the timers and stuff.
231          */
232
233         via2[gIER] = 0x7F;
234         via2[gIFR] = 0x7F | rbv_clear;
235         if (!rbv_present) {
236                 via2[vT1LL] = 0;
237                 via2[vT1LH] = 0;
238                 via2[vT1CL] = 0;
239                 via2[vT1CH] = 0;
240                 via2[vT2CL] = 0;
241                 via2[vT2CH] = 0;
242                 via2[vACR] &= ~0xC0; /* setup T1 timer with no PB7 output */
243                 via2[vACR] &= ~0x03; /* disable port A & B latches */
244         }
245
246         /* Everything below this point is VIA2 only... */
247
248         if (rbv_present)
249                 return;
250
251         /*
252          * Set vPCR for control line interrupts.
253          *
254          * CA1 (SLOTS IRQ), CB1 (ASC IRQ): negative edge trigger.
255          *
256          * Macs with ESP SCSI have a negative edge triggered SCSI interrupt.
257          * Testing reveals that PowerBooks do too. However, the SE/30
258          * schematic diagram shows an active high NCR5380 IRQ line.
259          */
260
261         pr_debug("VIA2 vPCR is 0x%02X\n", via2[vPCR]);
262         if (macintosh_config->via_type == MAC_VIA_II) {
263                 /* CA2 (SCSI DRQ), CB2 (SCSI IRQ): indep. input, pos. edge */
264                 via2[vPCR] = 0x66;
265         } else {
266                 /* CA2 (SCSI DRQ), CB2 (SCSI IRQ): indep. input, neg. edge */
267                 via2[vPCR] = 0x22;
268         }
269 }
270
271 /*
272  * Debugging dump, used in various places to see what's going on.
273  */
274
275 void via_debug_dump(void)
276 {
277         printk(KERN_DEBUG "VIA1: DDRA = 0x%02X DDRB = 0x%02X ACR = 0x%02X\n",
278                 (uint) via1[vDirA], (uint) via1[vDirB], (uint) via1[vACR]);
279         printk(KERN_DEBUG "         PCR = 0x%02X  IFR = 0x%02X IER = 0x%02X\n",
280                 (uint) via1[vPCR], (uint) via1[vIFR], (uint) via1[vIER]);
281         if (oss_present) {
282                 printk(KERN_DEBUG "VIA2: <OSS>\n");
283         } else if (rbv_present) {
284                 printk(KERN_DEBUG "VIA2:  IFR = 0x%02X  IER = 0x%02X\n",
285                         (uint) via2[rIFR], (uint) via2[rIER]);
286                 printk(KERN_DEBUG "      SIFR = 0x%02X SIER = 0x%02X\n",
287                         (uint) via2[rSIFR], (uint) via2[rSIER]);
288         } else {
289                 printk(KERN_DEBUG "VIA2: DDRA = 0x%02X DDRB = 0x%02X ACR = 0x%02X\n",
290                         (uint) via2[vDirA], (uint) via2[vDirB],
291                         (uint) via2[vACR]);
292                 printk(KERN_DEBUG "         PCR = 0x%02X  IFR = 0x%02X IER = 0x%02X\n",
293                         (uint) via2[vPCR],
294                         (uint) via2[vIFR], (uint) via2[vIER]);
295         }
296 }
297
298 /*
299  * Flush the L2 cache on Macs that have it by flipping
300  * the system into 24-bit mode for an instant.
301  */
302
303 void via_l2_flush(int writeback)
304 {
305         unsigned long flags;
306
307         local_irq_save(flags);
308         via2[gBufB] &= ~VIA2B_vMode32;
309         via2[gBufB] |= VIA2B_vMode32;
310         local_irq_restore(flags);
311 }
312
313 /*
314  * Return the status of the L2 cache on a IIci
315  */
316
317 int via_get_cache_disable(void)
318 {
319         /* Safeguard against being called accidentally */
320         if (!via2) {
321                 printk(KERN_ERR "via_get_cache_disable called on a non-VIA machine!\n");
322                 return 1;
323         }
324
325         return (int) via2[gBufB] & VIA2B_vCDis;
326 }
327
328 /*
329  * Initialize VIA2 for Nubus access
330  */
331
332 void __init via_nubus_init(void)
333 {
334         /* unlock nubus transactions */
335
336         if ((macintosh_config->adb_type != MAC_ADB_PB1) &&
337             (macintosh_config->adb_type != MAC_ADB_PB2)) {
338                 /* set the line to be an output on non-RBV machines */
339                 if (!rbv_present)
340                         via2[vDirB] |= 0x02;
341
342                 /* this seems to be an ADB bit on PMU machines */
343                 /* according to MkLinux.  -- jmt               */
344                 via2[gBufB] |= 0x02;
345         }
346
347         /*
348          * Disable the slot interrupts. On some hardware that's not possible.
349          * On some hardware it's unclear what all of these I/O lines do.
350          */
351
352         switch (macintosh_config->via_type) {
353         case MAC_VIA_II:
354         case MAC_VIA_QUADRA:
355                 pr_debug("VIA2 vDirA is 0x%02X\n", via2[vDirA]);
356                 break;
357         case MAC_VIA_IICI:
358                 /* RBV. Disable all the slot interrupts. SIER works like IER. */
359                 via2[rSIER] = 0x7F;
360                 break;
361         }
362 }
363
364 void via_nubus_irq_startup(int irq)
365 {
366         int irq_idx = IRQ_IDX(irq);
367
368         switch (macintosh_config->via_type) {
369         case MAC_VIA_II:
370         case MAC_VIA_QUADRA:
371                 /* Make the port A line an input. Probably redundant. */
372                 if (macintosh_config->via_type == MAC_VIA_II) {
373                         /* The top two bits are RAM size outputs. */
374                         via2[vDirA] &= 0xC0 | ~(1 << irq_idx);
375                 } else {
376                         /* Allow NuBus slots 9 through F. */
377                         via2[vDirA] &= 0x80 | ~(1 << irq_idx);
378                 }
379                 /* fall through */
380         case MAC_VIA_IICI:
381                 via_irq_enable(irq);
382                 break;
383         }
384 }
385
386 void via_nubus_irq_shutdown(int irq)
387 {
388         switch (macintosh_config->via_type) {
389         case MAC_VIA_II:
390         case MAC_VIA_QUADRA:
391                 /* Ensure that the umbrella CA1 interrupt remains enabled. */
392                 via_irq_enable(irq);
393                 break;
394         case MAC_VIA_IICI:
395                 via_irq_disable(irq);
396                 break;
397         }
398 }
399
400 /*
401  * The generic VIA interrupt routines (shamelessly stolen from Alan Cox's
402  * via6522.c :-), disable/pending masks added.
403  */
404
405 #define VIA_TIMER_1_INT BIT(6)
406
407 void via1_irq(struct irq_desc *desc)
408 {
409         int irq_num;
410         unsigned char irq_bit, events;
411
412         events = via1[vIFR] & via1[vIER] & 0x7F;
413         if (!events)
414                 return;
415
416         irq_num = IRQ_MAC_TIMER_1;
417         irq_bit = VIA_TIMER_1_INT;
418         if (events & irq_bit) {
419                 unsigned long flags;
420
421                 local_irq_save(flags);
422                 via1[vIFR] = irq_bit;
423                 generic_handle_irq(irq_num);
424                 local_irq_restore(flags);
425
426                 events &= ~irq_bit;
427                 if (!events)
428                         return;
429         }
430
431         irq_num = VIA1_SOURCE_BASE;
432         irq_bit = 1;
433         do {
434                 if (events & irq_bit) {
435                         via1[vIFR] = irq_bit;
436                         generic_handle_irq(irq_num);
437                 }
438                 ++irq_num;
439                 irq_bit <<= 1;
440         } while (events >= irq_bit);
441 }
442
443 static void via2_irq(struct irq_desc *desc)
444 {
445         int irq_num;
446         unsigned char irq_bit, events;
447
448         events = via2[gIFR] & via2[gIER] & 0x7F;
449         if (!events)
450                 return;
451
452         irq_num = VIA2_SOURCE_BASE;
453         irq_bit = 1;
454         do {
455                 if (events & irq_bit) {
456                         via2[gIFR] = irq_bit | rbv_clear;
457                         generic_handle_irq(irq_num);
458                 }
459                 ++irq_num;
460                 irq_bit <<= 1;
461         } while (events >= irq_bit);
462 }
463
464 /*
465  * Dispatch Nubus interrupts. We are called as a secondary dispatch by the
466  * VIA2 dispatcher as a fast interrupt handler.
467  */
468
469 static void via_nubus_irq(struct irq_desc *desc)
470 {
471         int slot_irq;
472         unsigned char slot_bit, events;
473
474         events = ~via2[gBufA] & 0x7F;
475         if (rbv_present)
476                 events &= via2[rSIER];
477         else
478                 events &= ~via2[vDirA];
479         if (!events)
480                 return;
481
482         do {
483                 slot_irq = IRQ_NUBUS_F;
484                 slot_bit = 0x40;
485                 do {
486                         if (events & slot_bit) {
487                                 events &= ~slot_bit;
488                                 generic_handle_irq(slot_irq);
489                         }
490                         --slot_irq;
491                         slot_bit >>= 1;
492                 } while (events);
493
494                 /* clear the CA1 interrupt and make certain there's no more. */
495                 via2[gIFR] = 0x02 | rbv_clear;
496                 events = ~via2[gBufA] & 0x7F;
497                 if (rbv_present)
498                         events &= via2[rSIER];
499                 else
500                         events &= ~via2[vDirA];
501         } while (events);
502 }
503
504 /*
505  * Register the interrupt dispatchers for VIA or RBV machines only.
506  */
507
508 void __init via_register_interrupts(void)
509 {
510         if (via_alt_mapping) {
511                 /* software interrupt */
512                 irq_set_chained_handler(IRQ_AUTO_1, via1_irq);
513                 /* via1 interrupt */
514                 irq_set_chained_handler(IRQ_AUTO_6, via1_irq);
515         } else {
516                 irq_set_chained_handler(IRQ_AUTO_1, via1_irq);
517         }
518         irq_set_chained_handler(IRQ_AUTO_2, via2_irq);
519         irq_set_chained_handler(IRQ_MAC_NUBUS, via_nubus_irq);
520 }
521
522 void via_irq_enable(int irq) {
523         int irq_src     = IRQ_SRC(irq);
524         int irq_idx     = IRQ_IDX(irq);
525
526         if (irq_src == 1) {
527                 via1[vIER] = IER_SET_BIT(irq_idx);
528         } else if (irq_src == 2) {
529                 if (irq != IRQ_MAC_NUBUS || nubus_disabled == 0)
530                         via2[gIER] = IER_SET_BIT(irq_idx);
531         } else if (irq_src == 7) {
532                 switch (macintosh_config->via_type) {
533                 case MAC_VIA_II:
534                 case MAC_VIA_QUADRA:
535                         nubus_disabled &= ~(1 << irq_idx);
536                         /* Enable the CA1 interrupt when no slot is disabled. */
537                         if (!nubus_disabled)
538                                 via2[gIER] = IER_SET_BIT(1);
539                         break;
540                 case MAC_VIA_IICI:
541                         /* On RBV, enable the slot interrupt.
542                          * SIER works like IER.
543                          */
544                         via2[rSIER] = IER_SET_BIT(irq_idx);
545                         break;
546                 }
547         }
548 }
549
550 void via_irq_disable(int irq) {
551         int irq_src     = IRQ_SRC(irq);
552         int irq_idx     = IRQ_IDX(irq);
553
554         if (irq_src == 1) {
555                 via1[vIER] = IER_CLR_BIT(irq_idx);
556         } else if (irq_src == 2) {
557                 via2[gIER] = IER_CLR_BIT(irq_idx);
558         } else if (irq_src == 7) {
559                 switch (macintosh_config->via_type) {
560                 case MAC_VIA_II:
561                 case MAC_VIA_QUADRA:
562                         nubus_disabled |= 1 << irq_idx;
563                         if (nubus_disabled)
564                                 via2[gIER] = IER_CLR_BIT(1);
565                         break;
566                 case MAC_VIA_IICI:
567                         via2[rSIER] = IER_CLR_BIT(irq_idx);
568                         break;
569                 }
570         }
571 }
572
573 void via1_set_head(int head)
574 {
575         if (head == 0)
576                 via1[vBufA] &= ~VIA1A_vHeadSel;
577         else
578                 via1[vBufA] |= VIA1A_vHeadSel;
579 }
580 EXPORT_SYMBOL(via1_set_head);
581
582 int via2_scsi_drq_pending(void)
583 {
584         return via2[gIFR] & (1 << IRQ_IDX(IRQ_MAC_SCSIDRQ));
585 }
586 EXPORT_SYMBOL(via2_scsi_drq_pending);
587
588 /* timer and clock source */
589
590 #define VIA_CLOCK_FREQ     783360                /* VIA "phase 2" clock in Hz */
591 #define VIA_TIMER_INTERVAL (1000000 / HZ)        /* microseconds per jiffy */
592 #define VIA_TIMER_CYCLES   (VIA_CLOCK_FREQ / HZ) /* clock cycles per jiffy */
593
594 #define VIA_TC             (VIA_TIMER_CYCLES - 2) /* including 0 and -1 */
595 #define VIA_TC_LOW         (VIA_TC & 0xFF)
596 #define VIA_TC_HIGH        (VIA_TC >> 8)
597
598 void __init via_init_clock(irq_handler_t timer_routine)
599 {
600         if (request_irq(IRQ_MAC_TIMER_1, timer_routine, 0, "timer", NULL)) {
601                 pr_err("Couldn't register %s interrupt\n", "timer");
602                 return;
603         }
604
605         via1[vT1LL] = VIA_TC_LOW;
606         via1[vT1LH] = VIA_TC_HIGH;
607         via1[vT1CL] = VIA_TC_LOW;
608         via1[vT1CH] = VIA_TC_HIGH;
609         via1[vACR] |= 0x40;
610 }
611
612 u32 mac_gettimeoffset(void)
613 {
614         unsigned long flags;
615         u8 count_high;
616         u16 count, offset = 0;
617
618         /*
619          * Timer counter wrap-around is detected with the timer interrupt flag
620          * but reading the counter low byte (vT1CL) would reset the flag.
621          * Also, accessing both counter registers is essentially a data race.
622          * These problems are avoided by ignoring the low byte. Clock accuracy
623          * is 256 times worse (error can reach 0.327 ms) but CPU overhead is
624          * reduced by avoiding slow VIA register accesses.
625          */
626
627         local_irq_save(flags);
628         count_high = via1[vT1CH];
629         if (count_high == 0xFF)
630                 count_high = 0;
631         if (count_high > 0 && (via1[vIFR] & VIA_TIMER_1_INT))
632                 offset = VIA_TIMER_CYCLES;
633         local_irq_restore(flags);
634
635         count = count_high << 8;
636         count = VIA_TIMER_CYCLES - count + offset;
637
638         return ((count * VIA_TIMER_INTERVAL) / VIA_TIMER_CYCLES) * 1000;
639 }