2 ; Driver for a potentiometer "mouse" e.g. Koala Pad
4 ; Ullrich von Bassewitz, 2004-03-29, 2009-09-26
5 ; Stefan Haubenthal, 2006-08-20
8 .include "zeropage.inc"
9 .include "mouse-kernel.inc"
14 ; ------------------------------------------------------------------------
15 ; Header. Includes jump table
23 .byte $6d, $6f, $75 ; "mou"
24 .byte MOUSE_API_VERSION ; Mouse driver API version number
45 ; Callback table, set by the kernel before INSTALL is called
47 CHIDE: jmp $0000 ; Hide the cursor
48 CSHOW: jmp $0000 ; Show the cursor
49 CMOVEX: jmp $0000 ; Move the cursor to X coord
50 CMOVEY: jmp $0000 ; Move the cursor to Y coord
53 ;----------------------------------------------------------------------------
67 ;----------------------------------------------------------------------------
68 ; Global variables. The bounding box values are sorted so that they can be
69 ; written with the least effort in the SETBOX and GETBOX routines, so don't
75 YPos: .res 2 ; Current mouse position, Y
76 XPos: .res 2 ; Current mouse position, X
77 XMin: .res 2 ; X1 value of bounding box
78 YMin: .res 2 ; Y1 value of bounding box
79 XMax: .res 2 ; X2 value of bounding box
80 YMax: .res 2 ; Y2 value of bounding box
81 Buttons: .res 1 ; Button mask
83 ; Temporary value used in the int handler
87 ; Default values for above variables
92 .word SCREEN_HEIGHT/2 ; YPos
93 .word SCREEN_WIDTH/2 ; XPos
96 .word SCREEN_WIDTH ; XMax
97 .word SCREEN_HEIGHT ; YMax
103 ;----------------------------------------------------------------------------
104 ; INSTALL routine. Is called after the driver is loaded into memory. If
105 ; possible, check if the hardware is present.
106 ; Must return an MOUSE_ERR_xx code in a/x.
110 ; Initialize variables. Just copy the default stuff over
112 ldx #.sizeof(DefVars)-1
118 ; Be sure the mouse cursor is invisible and at the default location. We
119 ; need to do that here, because our mouse interrupt handler doesn't set the
120 ; mouse position if it hasn't changed.
132 ; Done, return zero (= MOUSE_ERR_OK)
138 ;----------------------------------------------------------------------------
139 ; UNINSTALL routine. Is called before the driver is removed from memory.
140 ; No return code required (the driver is removed from memory on return).
142 UNINSTALL = HIDE ; Hide cursor on exit
144 ;----------------------------------------------------------------------------
145 ; HIDE routine. Is called to hide the mouse pointer. The mouse kernel manages
146 ; a counter for calls to show/hide, and the driver entry point is only called
147 ; if the mouse is currently visible and should get hidden. For most drivers,
148 ; no special action is required besides hiding the mouse cursor.
149 ; No return code required.
156 ;----------------------------------------------------------------------------
157 ; SHOW routine. Is called to show the mouse pointer. The mouse kernel manages
158 ; a counter for calls to show/hide, and the driver entry point is only called
159 ; if the mouse is currently hidden and should become visible. For most drivers,
160 ; no special action is required besides enabling the mouse cursor.
161 ; No return code required.
168 ;----------------------------------------------------------------------------
169 ; SETBOX: Set the mouse bounding box. The parameters are passed as they come
170 ; from the C program, that is, a pointer to a mouse_box struct in a/x.
171 ; No checks are done if the mouse is currently inside the box, this is the job
172 ; of the caller. It is not necessary to validate the parameters, trust the
173 ; caller and save some code here. No return code required.
176 stx ptr1+1 ; Save data pointer
178 ldy #.sizeof (MOUSE_BOX)-1
189 ;----------------------------------------------------------------------------
190 ; GETBOX: Return the mouse bounding box. The parameters are passed as they
191 ; come from the C program, that is, a pointer to a mouse_box struct in a/x.
194 stx ptr1+1 ; Save data pointer
196 ldy #.sizeof (MOUSE_BOX)-1
207 ;----------------------------------------------------------------------------
208 ; MOVE: Move the mouse to a new position. The position is passed as it comes
209 ; from the C program, that is: X on the stack and Y in a/x. The C wrapper will
210 ; remove the parameter from the stack on return.
211 ; No checks are done if the new position is valid (within the bounding box or
212 ; the screen). No return code required.
215 MOVE: sei ; No interrupts
218 stx YPos+1 ; New Y position
227 sta XPos ; New X position
229 jsr CMOVEX ; Move the cursor
231 cli ; Allow interrupts
234 ;----------------------------------------------------------------------------
235 ; BUTTONS: Return the button mask in a/x.
242 ;----------------------------------------------------------------------------
243 ; POS: Return the mouse position in the MOUSE_POS struct pointed to by ptr1.
244 ; No return code required.
246 POS: ldy #MOUSE_POS::XCOORD ; Structure offset
248 sei ; Disable interrupts
249 lda XPos ; Transfer the position
258 cli ; Enable interrupts
261 sta (ptr1),y ; Store last byte
265 ;----------------------------------------------------------------------------
266 ; INFO: Returns mouse position and current button mask in the MOUSE_INFO
267 ; struct pointed to by ptr1. No return code required.
269 ; We're cheating here to keep the code smaller: The first fields of the
270 ; mouse_info struct are identical to the mouse_pos struct, so we will just
271 ; call _mouse_pos to initialize the struct pointer and fill the position
276 ; Fill in the button state
279 ldy #MOUSE_INFO::BUTTONS
284 ;----------------------------------------------------------------------------
285 ; IOCTL: Driver defined entry point. The wrapper will pass a pointer to ioctl
286 ; specific data in ptr1, and the ioctl code in A.
287 ; Must return an error code in a/x.
290 IOCTL: lda #<MOUSE_ERR_INV_IOCTL ; We don't support ioclts for now
291 ldx #>MOUSE_ERR_INV_IOCTL
294 ;----------------------------------------------------------------------------
295 ; IRQ: Irq handler entry point. Called as a subroutine but in IRQ context
301 lda CIA1_PRB ; Read port #1
303 eor #%00001100 ; Make all bits active high
324 bne @AddX ; Branch always
328 ; Calculate the new X coordinate (--> a/y)
331 tay ; Remember low byte
336 ; Limit the X coordinate to the bounding box
354 ; Move the mouse pointer to the new X pos
365 ; Calculate the new Y coordinate (--> a/y)
368 tay ; Remember low byte
373 ; Limit the Y coordinate to the bounding box
391 ; Move the mouse pointer to the new X pos