125404788e8d5da8f2f573daf57fc5b99b99c427
[linux-3.10.git] / arch / m68k / mac / via.c
1 /*
2  *      6522 Versatile Interface Adapter (VIA)
3  *
4  *      There are two of these on the Mac II. Some IRQs are vectored
5  *      via them as are assorted bits and bobs - eg RTC, ADB.
6  *
7  * CSA: Motorola seems to have removed documentation on the 6522 from
8  * their web site; try
9  *     http://nerini.drf.com/vectrex/other/text/chips/6522/
10  *     http://www.zymurgy.net/classic/vic20/vicdet1.htm
11  * and
12  *     http://193.23.168.87/mikro_laborversuche/via_iobaustein/via6522_1.html
13  * for info.  A full-text web search on 6522 AND VIA will probably also
14  * net some usefulness. <cananian@alumni.princeton.edu> 20apr1999
15  *
16  * Additional data is here (the SY6522 was used in the Mac II etc):
17  *     http://www.6502.org/documents/datasheets/synertek/synertek_sy6522.pdf
18  *     http://www.6502.org/documents/datasheets/synertek/synertek_sy6522_programming_reference.pdf
19  *
20  * PRAM/RTC access algorithms are from the NetBSD RTC toolkit version 1.08b
21  * by Erik Vogan and adapted to Linux by Joshua M. Thompson (funaho@jurai.org)
22  *
23  */
24
25 #include <linux/types.h>
26 #include <linux/kernel.h>
27 #include <linux/mm.h>
28 #include <linux/delay.h>
29 #include <linux/init.h>
30 #include <linux/module.h>
31
32 #include <asm/bootinfo.h>
33 #include <asm/macintosh.h>
34 #include <asm/macints.h>
35 #include <asm/machw.h>
36 #include <asm/mac_via.h>
37 #include <asm/mac_psc.h>
38
39 volatile __u8 *via1, *via2;
40 int rbv_present;
41 int via_alt_mapping;
42 EXPORT_SYMBOL(via_alt_mapping);
43 static __u8 rbv_clear;
44
45 /*
46  * Globals for accessing the VIA chip registers without having to
47  * check if we're hitting a real VIA or an RBV. Normally you could
48  * just hit the combined register (ie, vIER|rIER) but that seems to
49  * break on AV Macs...probably because they actually decode more than
50  * eight address bits. Why can't Apple engineers at least be
51  * _consistently_ lazy?                          - 1999-05-21 (jmt)
52  */
53
54 static int gIER,gIFR,gBufA,gBufB;
55
56 /*
57  * Timer defs.
58  */
59
60 #define TICK_SIZE               10000
61 #define MAC_CLOCK_TICK          (783300/HZ)             /* ticks per HZ */
62 #define MAC_CLOCK_LOW           (MAC_CLOCK_TICK&0xFF)
63 #define MAC_CLOCK_HIGH          (MAC_CLOCK_TICK>>8)
64
65 /* To disable a NuBus slot on Quadras we make that slot IRQ line an output set
66  * high. On RBV we just use the slot interrupt enable register. On Macs with
67  * genuine VIA chips we must use nubus_disabled to keep track of disabled slot
68  * interrupts. When any slot IRQ is disabled we mask the (edge triggered) CA1
69  * or "SLOTS" interrupt. When no slot is disabled, we unmask the CA1 interrupt.
70  * So, on genuine VIAs, having more than one NuBus IRQ can mean trouble,
71  * because closing one of those drivers can mask all of the NuBus interrupts.
72  * Also, since we can't mask the unregistered slot IRQs on genuine VIAs, it's
73  * possible to get interrupts from cards that MacOS or the ROM has configured
74  * but we have not. FWIW, "Designing Cards and Drivers for Macintosh II and
75  * Macintosh SE", page 9-8, says, a slot IRQ with no driver would crash MacOS.
76  */
77 static u8 nubus_disabled;
78
79 void via_debug_dump(void);
80 irqreturn_t via1_irq(int, void *);
81 irqreturn_t via2_irq(int, void *);
82 irqreturn_t via_nubus_irq(int, void *);
83 void via_irq_enable(int irq);
84 void via_irq_disable(int irq);
85 void via_irq_clear(int irq);
86
87 extern irqreturn_t mac_scc_dispatch(int, void *);
88 extern int oss_present;
89
90 /*
91  * Initialize the VIAs
92  *
93  * First we figure out where they actually _are_ as well as what type of
94  * VIA we have for VIA2 (it could be a real VIA or an RBV or even an OSS.)
95  * Then we pretty much clear them out and disable all IRQ sources.
96  *
97  * Note: the OSS is actually "detected" here and not in oss_init(). It just
98  *       seems more logical to do it here since via_init() needs to know
99  *       these things anyways.
100  */
101
102 void __init via_init(void)
103 {
104         switch(macintosh_config->via_type) {
105
106                 /* IIci, IIsi, IIvx, IIvi (P6xx), LC series */
107
108                 case MAC_VIA_IIci:
109                         via1 = (void *) VIA1_BASE;
110                         if (macintosh_config->ident == MAC_MODEL_IIFX) {
111                                 via2 = NULL;
112                                 rbv_present = 0;
113                                 oss_present = 1;
114                         } else {
115                                 via2 = (void *) RBV_BASE;
116                                 rbv_present = 1;
117                                 oss_present = 0;
118                         }
119                         if (macintosh_config->ident == MAC_MODEL_LCIII) {
120                                 rbv_clear = 0x00;
121                         } else {
122                                 /* on most RBVs (& unlike the VIAs), you   */
123                                 /* need to set bit 7 when you write to IFR */
124                                 /* in order for your clear to occur.       */
125                                 rbv_clear = 0x80;
126                         }
127                         gIER = rIER;
128                         gIFR = rIFR;
129                         gBufA = rSIFR;
130                         gBufB = rBufB;
131                         break;
132
133                 /* Quadra and early MacIIs agree on the VIA locations */
134
135                 case MAC_VIA_QUADRA:
136                 case MAC_VIA_II:
137                         via1 = (void *) VIA1_BASE;
138                         via2 = (void *) VIA2_BASE;
139                         rbv_present = 0;
140                         oss_present = 0;
141                         rbv_clear = 0x00;
142                         gIER = vIER;
143                         gIFR = vIFR;
144                         gBufA = vBufA;
145                         gBufB = vBufB;
146                         break;
147                 default:
148                         panic("UNKNOWN VIA TYPE");
149         }
150
151         printk(KERN_INFO "VIA1 at %p is a 6522 or clone\n", via1);
152
153         printk(KERN_INFO "VIA2 at %p is ", via2);
154         if (rbv_present) {
155                 printk("an RBV\n");
156         } else if (oss_present) {
157                 printk("an OSS\n");
158         } else {
159                 printk("a 6522 or clone\n");
160         }
161
162 #ifdef DEBUG_VIA
163         via_debug_dump();
164 #endif
165
166         /*
167          * Shut down all IRQ sources, reset the timers, and
168          * kill the timer latch on VIA1.
169          */
170
171         via1[vIER] = 0x7F;
172         via1[vIFR] = 0x7F;
173         via1[vT1LL] = 0;
174         via1[vT1LH] = 0;
175         via1[vT1CL] = 0;
176         via1[vT1CH] = 0;
177         via1[vT2CL] = 0;
178         via1[vT2CH] = 0;
179         via1[vACR] &= ~0xC0; /* setup T1 timer with no PB7 output */
180         via1[vACR] &= ~0x03; /* disable port A & B latches */
181
182         /*
183          * SE/30: disable video IRQ
184          * XXX: testing for SE/30 VBL
185          */
186
187         if (macintosh_config->ident == MAC_MODEL_SE30) {
188                 via1[vDirB] |= 0x40;
189                 via1[vBufB] |= 0x40;
190         }
191
192         /*
193          * Set the RTC bits to a known state: all lines to outputs and
194          * RTC disabled (yes that's 0 to enable and 1 to disable).
195          */
196
197         via1[vDirB] |= (VIA1B_vRTCEnb | VIA1B_vRTCClk | VIA1B_vRTCData);
198         via1[vBufB] |= (VIA1B_vRTCEnb | VIA1B_vRTCClk);
199
200         /* Everything below this point is VIA2/RBV only... */
201
202         if (oss_present)
203                 return;
204
205         /* Some machines support an alternate IRQ mapping that spreads  */
206         /* Ethernet and Sound out to their own autolevel IRQs and moves */
207         /* VIA1 to level 6. A/UX uses this mapping and we do too.  Note */
208         /* that the IIfx emulates this alternate mapping using the OSS. */
209
210         via_alt_mapping = 0;
211         if (macintosh_config->via_type == MAC_VIA_QUADRA)
212                 switch (macintosh_config->ident) {
213                 case MAC_MODEL_C660:
214                 case MAC_MODEL_Q840:
215                         /* not applicable */
216                         break;
217                 case MAC_MODEL_P588:
218                 case MAC_MODEL_TV:
219                 case MAC_MODEL_PB140:
220                 case MAC_MODEL_PB145:
221                 case MAC_MODEL_PB160:
222                 case MAC_MODEL_PB165:
223                 case MAC_MODEL_PB165C:
224                 case MAC_MODEL_PB170:
225                 case MAC_MODEL_PB180:
226                 case MAC_MODEL_PB180C:
227                 case MAC_MODEL_PB190:
228                 case MAC_MODEL_PB520:
229                         /* not yet tested */
230                         break;
231                 default:
232                         via_alt_mapping = 1;
233                         via1[vDirB] |= 0x40;
234                         via1[vBufB] &= ~0x40;
235                         break;
236                 }
237
238         /*
239          * Now initialize VIA2. For RBV we just kill all interrupts;
240          * for a regular VIA we also reset the timers and stuff.
241          */
242
243         via2[gIER] = 0x7F;
244         via2[gIFR] = 0x7F | rbv_clear;
245         if (!rbv_present) {
246                 via2[vT1LL] = 0;
247                 via2[vT1LH] = 0;
248                 via2[vT1CL] = 0;
249                 via2[vT1CH] = 0;
250                 via2[vT2CL] = 0;
251                 via2[vT2CH] = 0;
252                 via2[vACR] &= ~0xC0; /* setup T1 timer with no PB7 output */
253                 via2[vACR] &= ~0x03; /* disable port A & B latches */
254         }
255
256         /*
257          * Set vPCR for control line interrupts (but not on RBV)
258          */
259         if (!rbv_present) {
260                 /* For all VIA types, CA1 (SLOTS IRQ) and CB1 (ASC IRQ)
261                  * are made negative edge triggered here.
262                  */
263                 if (macintosh_config->scsi_type == MAC_SCSI_OLD) {
264                         /* CB2 (IRQ) indep. input, positive edge */
265                         /* CA2 (DRQ) indep. input, positive edge */
266                         via2[vPCR] = 0x66;
267                 } else {
268                         /* CB2 (IRQ) indep. input, negative edge */
269                         /* CA2 (DRQ) indep. input, negative edge */
270                         via2[vPCR] = 0x22;
271                 }
272         }
273 }
274
275 /*
276  * Start the 100 Hz clock
277  */
278
279 void __init via_init_clock(irq_handler_t func)
280 {
281         via1[vACR] |= 0x40;
282         via1[vT1LL] = MAC_CLOCK_LOW;
283         via1[vT1LH] = MAC_CLOCK_HIGH;
284         via1[vT1CL] = MAC_CLOCK_LOW;
285         via1[vT1CH] = MAC_CLOCK_HIGH;
286
287         request_irq(IRQ_MAC_TIMER_1, func, IRQ_FLG_LOCK, "timer", func);
288 }
289
290 /*
291  * Register the interrupt dispatchers for VIA or RBV machines only.
292  */
293
294 void __init via_register_interrupts(void)
295 {
296         if (via_alt_mapping) {
297                 request_irq(IRQ_AUTO_1, via1_irq,
298                                 IRQ_FLG_LOCK|IRQ_FLG_FAST, "software",
299                                 (void *) via1);
300                 request_irq(IRQ_AUTO_6, via1_irq,
301                                 IRQ_FLG_LOCK|IRQ_FLG_FAST, "via1",
302                                 (void *) via1);
303         } else {
304                 request_irq(IRQ_AUTO_1, via1_irq,
305                                 IRQ_FLG_LOCK|IRQ_FLG_FAST, "via1",
306                                 (void *) via1);
307         }
308         request_irq(IRQ_AUTO_2, via2_irq, IRQ_FLG_LOCK|IRQ_FLG_FAST,
309                         "via2", (void *) via2);
310         if (!psc_present) {
311                 request_irq(IRQ_AUTO_4, mac_scc_dispatch, IRQ_FLG_LOCK,
312                                 "scc", mac_scc_dispatch);
313         }
314         request_irq(IRQ_MAC_NUBUS, via_nubus_irq, IRQ_FLG_LOCK|IRQ_FLG_FAST,
315                         "nubus", (void *) via2);
316 }
317
318 /*
319  * Debugging dump, used in various places to see what's going on.
320  */
321
322 void via_debug_dump(void)
323 {
324         printk(KERN_DEBUG "VIA1: DDRA = 0x%02X DDRB = 0x%02X ACR = 0x%02X\n",
325                 (uint) via1[vDirA], (uint) via1[vDirB], (uint) via1[vACR]);
326         printk(KERN_DEBUG "         PCR = 0x%02X  IFR = 0x%02X IER = 0x%02X\n",
327                 (uint) via1[vPCR], (uint) via1[vIFR], (uint) via1[vIER]);
328         if (oss_present) {
329                 printk(KERN_DEBUG "VIA2: <OSS>\n");
330         } else if (rbv_present) {
331                 printk(KERN_DEBUG "VIA2:  IFR = 0x%02X  IER = 0x%02X\n",
332                         (uint) via2[rIFR], (uint) via2[rIER]);
333                 printk(KERN_DEBUG "      SIFR = 0x%02X SIER = 0x%02X\n",
334                         (uint) via2[rSIFR], (uint) via2[rSIER]);
335         } else {
336                 printk(KERN_DEBUG "VIA2: DDRA = 0x%02X DDRB = 0x%02X ACR = 0x%02X\n",
337                         (uint) via2[vDirA], (uint) via2[vDirB],
338                         (uint) via2[vACR]);
339                 printk(KERN_DEBUG "         PCR = 0x%02X  IFR = 0x%02X IER = 0x%02X\n",
340                         (uint) via2[vPCR],
341                         (uint) via2[vIFR], (uint) via2[vIER]);
342         }
343 }
344
345 /*
346  * This is always executed with interrupts disabled.
347  *
348  * TBI: get time offset between scheduling timer ticks
349  */
350
351 unsigned long mac_gettimeoffset (void)
352 {
353         unsigned long ticks, offset = 0;
354
355         /* read VIA1 timer 2 current value */
356         ticks = via1[vT1CL] | (via1[vT1CH] << 8);
357         /* The probability of underflow is less than 2% */
358         if (ticks > MAC_CLOCK_TICK - MAC_CLOCK_TICK / 50)
359                 /* Check for pending timer interrupt in VIA1 IFR */
360                 if (via1[vIFR] & 0x40) offset = TICK_SIZE;
361
362         ticks = MAC_CLOCK_TICK - ticks;
363         ticks = ticks * 10000L / MAC_CLOCK_TICK;
364
365         return ticks + offset;
366 }
367
368 /*
369  * Flush the L2 cache on Macs that have it by flipping
370  * the system into 24-bit mode for an instant.
371  */
372
373 void via_flush_cache(void)
374 {
375         via2[gBufB] &= ~VIA2B_vMode32;
376         via2[gBufB] |= VIA2B_vMode32;
377 }
378
379 /*
380  * Return the status of the L2 cache on a IIci
381  */
382
383 int via_get_cache_disable(void)
384 {
385         /* Safeguard against being called accidentally */
386         if (!via2) {
387                 printk(KERN_ERR "via_get_cache_disable called on a non-VIA machine!\n");
388                 return 1;
389         }
390
391         return (int) via2[gBufB] & VIA2B_vCDis;
392 }
393
394 /*
395  * Initialize VIA2 for Nubus access
396  */
397
398 void __init via_nubus_init(void)
399 {
400         /* unlock nubus transactions */
401
402         if ((macintosh_config->adb_type != MAC_ADB_PB1) &&
403             (macintosh_config->adb_type != MAC_ADB_PB2)) {
404                 /* set the line to be an output on non-RBV machines */
405                 if (!rbv_present)
406                         via2[vDirB] |= 0x02;
407
408                 /* this seems to be an ADB bit on PMU machines */
409                 /* according to MkLinux.  -- jmt               */
410                 via2[gBufB] |= 0x02;
411         }
412
413         /* Disable all the slot interrupts (where possible). */
414
415         switch (macintosh_config->via_type) {
416         case MAC_VIA_II:
417                 /* Just make the port A lines inputs. */
418                 switch(macintosh_config->ident) {
419                 case MAC_MODEL_II:
420                 case MAC_MODEL_IIX:
421                 case MAC_MODEL_IICX:
422                 case MAC_MODEL_SE30:
423                         /* The top two bits are RAM size outputs. */
424                         via2[vDirA] &= 0xC0;
425                         break;
426                 default:
427                         via2[vDirA] &= 0x80;
428                 }
429                 break;
430         case MAC_VIA_IIci:
431                 /* RBV. Disable all the slot interrupts. SIER works like IER. */
432                 via2[rSIER] = 0x7F;
433                 break;
434         case MAC_VIA_QUADRA:
435                 /* Disable the inactive slot interrupts by making those lines outputs. */
436                 if ((macintosh_config->adb_type != MAC_ADB_PB1) &&
437                     (macintosh_config->adb_type != MAC_ADB_PB2)) {
438                         via2[vBufA] |= 0x7F;
439                         via2[vDirA] |= 0x7F;
440                 }
441                 break;
442         }
443 }
444
445 /*
446  * The generic VIA interrupt routines (shamelessly stolen from Alan Cox's
447  * via6522.c :-), disable/pending masks added.
448  */
449
450 irqreturn_t via1_irq(int irq, void *dev_id)
451 {
452         int irq_num;
453         unsigned char irq_bit, events;
454
455         events = via1[vIFR] & via1[vIER] & 0x7F;
456         if (!events)
457                 return IRQ_NONE;
458
459         irq_num = VIA1_SOURCE_BASE;
460         irq_bit = 1;
461         do {
462                 if (events & irq_bit) {
463                         via1[vIFR] = irq_bit;
464                         m68k_handle_int(irq_num);
465                 }
466                 ++irq_num;
467                 irq_bit <<= 1;
468         } while (events >= irq_bit);
469         return IRQ_HANDLED;
470 }
471
472 irqreturn_t via2_irq(int irq, void *dev_id)
473 {
474         int irq_num;
475         unsigned char irq_bit, events;
476
477         events = via2[gIFR] & via2[gIER] & 0x7F;
478         if (!events)
479                 return IRQ_NONE;
480
481         irq_num = VIA2_SOURCE_BASE;
482         irq_bit = 1;
483         do {
484                 if (events & irq_bit) {
485                         via2[gIFR] = irq_bit | rbv_clear;
486                         m68k_handle_int(irq_num);
487                 }
488                 ++irq_num;
489                 irq_bit <<= 1;
490         } while (events >= irq_bit);
491         return IRQ_HANDLED;
492 }
493
494 /*
495  * Dispatch Nubus interrupts. We are called as a secondary dispatch by the
496  * VIA2 dispatcher as a fast interrupt handler.
497  */
498
499 irqreturn_t via_nubus_irq(int irq, void *dev_id)
500 {
501         int slot_irq;
502         unsigned char slot_bit, events;
503
504         events = ~via2[gBufA] & 0x7F;
505         if (rbv_present)
506                 events &= via2[rSIER];
507         else
508                 events &= ~via2[vDirA];
509         if (!events)
510                 return IRQ_NONE;
511
512         do {
513                 slot_irq = IRQ_NUBUS_F;
514                 slot_bit = 0x40;
515                 do {
516                         if (events & slot_bit) {
517                                 events &= ~slot_bit;
518                                 m68k_handle_int(slot_irq);
519                         }
520                         --slot_irq;
521                         slot_bit >>= 1;
522                 } while (events);
523
524                 /* clear the CA1 interrupt and make certain there's no more. */
525                 via2[gIFR] = 0x02 | rbv_clear;
526                 events = ~via2[gBufA] & 0x7F;
527                 if (rbv_present)
528                         events &= via2[rSIER];
529                 else
530                         events &= ~via2[vDirA];
531         } while (events);
532         return IRQ_HANDLED;
533 }
534
535 void via_irq_enable(int irq) {
536         int irq_src     = IRQ_SRC(irq);
537         int irq_idx     = IRQ_IDX(irq);
538
539 #ifdef DEBUG_IRQUSE
540         printk(KERN_DEBUG "via_irq_enable(%d)\n", irq);
541 #endif
542
543         if (irq_src == 1) {
544                 via1[vIER] = IER_SET_BIT(irq_idx);
545         } else if (irq_src == 2) {
546                 if (irq != IRQ_MAC_NUBUS || nubus_disabled == 0)
547                         via2[gIER] = IER_SET_BIT(irq_idx);
548         } else if (irq_src == 7) {
549                 switch (macintosh_config->via_type) {
550                 case MAC_VIA_II:
551                         nubus_disabled &= ~(1 << irq_idx);
552                         /* Enable the CA1 interrupt when no slot is disabled. */
553                         if (!nubus_disabled)
554                                 via2[gIER] = IER_SET_BIT(1);
555                         break;
556                 case MAC_VIA_IIci:
557                         /* On RBV, enable the slot interrupt.
558                          * SIER works like IER.
559                          */
560                         via2[rSIER] = IER_SET_BIT(irq_idx);
561                         break;
562                 case MAC_VIA_QUADRA:
563                         /* Make the port A line an input to enable the slot irq.
564                          * But not on PowerBooks, that's ADB.
565                          */
566                         if ((macintosh_config->adb_type != MAC_ADB_PB1) &&
567                             (macintosh_config->adb_type != MAC_ADB_PB2))
568                                 via2[vDirA] &= ~(1 << irq_idx);
569                         break;
570                 }
571         }
572 }
573
574 void via_irq_disable(int irq) {
575         int irq_src     = IRQ_SRC(irq);
576         int irq_idx     = IRQ_IDX(irq);
577
578 #ifdef DEBUG_IRQUSE
579         printk(KERN_DEBUG "via_irq_disable(%d)\n", irq);
580 #endif
581
582         if (irq_src == 1) {
583                 via1[vIER] = IER_CLR_BIT(irq_idx);
584         } else if (irq_src == 2) {
585                 via2[gIER] = IER_CLR_BIT(irq_idx);
586         } else if (irq_src == 7) {
587                 switch (macintosh_config->via_type) {
588                 case MAC_VIA_II:
589                         nubus_disabled |= 1 << irq_idx;
590                         if (nubus_disabled)
591                                 via2[gIER] = IER_CLR_BIT(1);
592                         break;
593                 case MAC_VIA_IIci:
594                         via2[rSIER] = IER_CLR_BIT(irq_idx);
595                         break;
596                 case MAC_VIA_QUADRA:
597                         if ((macintosh_config->adb_type != MAC_ADB_PB1) &&
598                             (macintosh_config->adb_type != MAC_ADB_PB2))
599                                 via2[vDirA] |= 1 << irq_idx;
600                         break;
601                 }
602         }
603 }
604
605 void via_irq_clear(int irq) {
606         int irq_src     = IRQ_SRC(irq);
607         int irq_idx     = IRQ_IDX(irq);
608         int irq_bit     = 1 << irq_idx;
609
610         if (irq_src == 1) {
611                 via1[vIFR] = irq_bit;
612         } else if (irq_src == 2) {
613                 via2[gIFR] = irq_bit | rbv_clear;
614         } else if (irq_src == 7) {
615                 /* FIXME: There is no way to clear an individual nubus slot
616                  * IRQ flag, other than getting the device to do it.
617                  */
618         }
619 }
620
621 /*
622  * Returns nonzero if an interrupt is pending on the given
623  * VIA/IRQ combination.
624  */
625
626 int via_irq_pending(int irq)
627 {
628         int irq_src     = IRQ_SRC(irq);
629         int irq_idx     = IRQ_IDX(irq);
630         int irq_bit     = 1 << irq_idx;
631
632         if (irq_src == 1) {
633                 return via1[vIFR] & irq_bit;
634         } else if (irq_src == 2) {
635                 return via2[gIFR] & irq_bit;
636         } else if (irq_src == 7) {
637                 /* Always 0 for MAC_VIA_QUADRA if the slot irq is disabled. */
638                 return ~via2[gBufA] & irq_bit;
639         }
640         return 0;
641 }