* added 0.99 linux version
[mascara-docs.git] / i386 / linux / linux-2.3.21 / arch / m68k / q40 / README
blob60134d9de5bb401c781085693da6fca287c4a6a2
1 Linux for the Q40
2 =================
4 You may try http://www.geocities.com/SiliconValley/Bay/2602/ for
5 some up to date information. Booter and other tools will be also
6 available from this place and ftp.uni-erlangen.de/linux/680x0/q40/
7 and mirrors.
9 Hints to documentation usually refer to the linux source tree in
10 /usr/src/linux/Documentation unless URL given.
12 It seems IRQ unmasking can't be safely done on a Q40. Autoprobing is 
13 not yet implemented - do not try it! (See below)
15 For a list of kernel commandline options read the documentation for the
16 particular device drivers.
18 The floppy imposes a very high interrupt load on the CPU, approx 30K/s.
19 When something blocks interrupts (HD) it will loose some of them, so far 
20 this is not known to have caused any data loss. On hihgly loaded systems
21 it can make the floppy very slow or practicaly stop. Other Q40 OS' simply 
22 poll the floppy for this reason - something that can't be done in Linux.
23 Only possible cure is getting a 82072 contoler with fifo instead of 
24 the 8272A
26 drivers used by the Q40, appart from the very obvious (console etc.):
27         drivers/char/q40_keyb.c         # use PC keymaps for national keyboards
28                      serial.c           # normal PC driver - any speed
29                      lp.c               # printer driver
30                 char/joystick/*         # most of this should work
31                 block/q40ide.c          # startup for ide
32                       ide*              # see Documentation/ide.txt
33                       floppy.c          # normal PC driver, DMA emu in asm/floppy.h
34                                         # and arch/m68k/kernel/entry.S
35                                         # see drivers/block/README.fd
36                 video/q40fb.c
37                 misc/parport_pc.c
39 Various other PC drivers can be enabled simply by adding them to 
40 arch/m68k/config.in, especially 8 bit devices should be without any
41 problems. For cards using 16bit io/mem more care is required, like 
42 checking byteorder issues, hacking memcpy_*_io etc.
45 Debugging
46 =========
48 Upon startup the kernel will usually output "ABCQGHIJ" into the SRAM, 
49 preceded by the booter signature. This is a trace just in case something 
50 went wrong during earliest setup stages. 
51 **Changed** to preserve SRAM contents by default, this is only done when 
52 requested - SRAM must start with '%LX$' signature to do this. '-d' option 
53 to 'lxx' loader enables this.
55 SRAM can also be used as additional console device, use debug=mem.
56 This will save kernel startup msgs into SRAM, the screen will display 
57 only the penguin - and shell prompt if it gets that far..
59 Serial console works and can also be used for debugging, provided serial
60 initialisation works.
62 Most problems seem to be caused by fawlty or badly configured io-cards or 
63 harddrives anyway..there are so many things that can go wrong here.
64 Make sure to configure the parallel port as SPP for first testing..the
65 Q40 may have trouble with parallel interrupts.
68 Q40 Hardware Description
69 ========================
71 This is just an overview, see asm-m68k/* for details ask if you have any 
72 questions.
74 The Q40 consists of a 68040@40 MHz, 1MB video RAM, up to 32MB RAM, AT-style
75 keyboard interface, 1 Programmable LED, 2 8bit DACs and up to 1MB ROM, 1MB
76 shadow ROM.
78 Most interfacing like floppy, hd, serial, parallel ports is done via ISA 
79 slots. The ISA io and mem range is mapped (sparse&byteswapped!) into separate 
80 regions of the memory.
81 The main interrupt register IIRQ_REG will indicate whether an IRQ was internal 
82 or from some ISA devices, EIRQ_REG can distinguish up to 8 ISA IRQs.
84 The Q40 custom chip is programmable to provide 2 periodic timers:
85         - 50 or 200 Hz - level 2,  !!THIS CANT BE DISABLED!!
86         - 10 or 20 KHz - level 4 (and possibly 6 - hardware decoding..)
88 Linux uses the 200 Hz interrupt for timer and beep by default.
91 Interrupts
92 ==========
94 q40 master chip handles only level triggered interrupts :-((
95 further limitation is no disabling etc. There is NO WAY to remove
96 an ISA irq request other than serve the HW specific control register,
97 the ISA irq lines are connected straight to the CPU ipl1 pin..
99 IRQ sharing is not yet implemented but this should be only a minor
100 problem..
102 Linux has some requirements wrt interrupt architecture, these are
103 to my knowledge:
104         (a) interrupt handler must not be reentered even when sti() is called
105         (b) working enable/disable_irq
107 Luckily these requirements are only important for drivers shared
108 with other architectures - ide,serial,parallel, ethernet..
109 q40ints.c now contains a trivial hack for (a), however (b) could
110 be only solved by driver-specific code
112 Keyboard
113 ========
115 q40 receives AT make/break codes from the keyboard, these are translated to
116 the PC scancodes x86 Linux uses. So by theory every national keyboard should
117 work just by loading the apropriate x86 keytable - see any national-HOWTO.
119 Unfortunately the AT->PC translation isn't quite trivial and even worse, my 
120 documentation of it is absolutely minimal - thus some exotic keys may not 
121 behave exactly as expected.
123 There is still hope that it can be fixed completely though. If you encounter 
124 problems, email me idealy this:
125         - exact keypress/release sequence
126         - 'showkey -s' run on q40, non-X session
127         - 'showkey -s' run on a PC, non-X session
128         - AT codes as displayed by the q40 debuging ROM
129 btw if the showkey output from PC and Q40 doesn't differ then you have some
130 classic configuration problem - don't send me anything in this case