2 ; Driver for the 1351 proportional mouse. Parts of the code are from
3 ; the Commodore 1351 mouse users guide.
5 ; Ullrich von Bassewitz, 2003-12-29, 2009-09-26
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
47 .byte MOUSE_FLAG_LATE_IRQ
49 ; Callback table, set by the kernel before INSTALL is called
51 CHIDE: jmp $0000 ; Hide the cursor
52 CSHOW: jmp $0000 ; Show the cursor
53 CMOVEX: jmp $0000 ; Move the cursor to X coord
54 CMOVEY: jmp $0000 ; Move the cursor to Y coord
57 ;----------------------------------------------------------------------------
63 ;----------------------------------------------------------------------------
64 ; Global variables. The bounding box values are sorted so that they can be
65 ; written with the least effort in the SETBOX and GETBOX routines, so don't
71 OldPotX: .res 1 ; Old hw counter values
74 YPos: .res 2 ; Current mouse position, Y
75 XPos: .res 2 ; Current mouse position, X
76 XMin: .res 2 ; X1 value of bounding box
77 YMin: .res 2 ; Y1 value of bounding box
78 XMax: .res 2 ; X2 value of bounding box
79 YMax: .res 2 ; Y2 value of bounding box
81 OldValue: .res 1 ; Temp for MoveCheck routine
82 NewValue: .res 1 ; Temp for MoveCheck routine
84 ; Default values for above variables
89 .byte 0, 0 ; OldPotX/OldPotY
90 .word SCREEN_HEIGHT/2 ; YPos
91 .word SCREEN_WIDTH/2 ; XPos
94 .word SCREEN_WIDTH ; XMax
95 .word SCREEN_HEIGHT ; YMax
100 ;----------------------------------------------------------------------------
101 ; INSTALL routine. Is called after the driver is loaded into memory. If
102 ; possible, check if the hardware is present.
103 ; Must return an MOUSE_ERR_xx code in a/x.
107 ; Initialize variables. Just copy the default stuff over
109 ldx #.sizeof(DefVars)-1
115 ; Be sure the mouse cursor is invisible and at the default location. We
116 ; need to do that here, because our mouse interrupt handler doesn't set the
117 ; mouse position if it hasn't changed.
129 ; Done, return zero (= MOUSE_ERR_OK)
133 rts ; Run into UNINSTALL instead
135 ;----------------------------------------------------------------------------
136 ; UNINSTALL routine. Is called before the driver is removed from memory.
137 ; No return code required (the driver is removed from memory on return).
139 UNINSTALL = HIDE ; Hide cursor on exit
141 ;----------------------------------------------------------------------------
142 ; HIDE routine. Is called to hide the mouse pointer. The mouse kernel manages
143 ; a counter for calls to show/hide, and the driver entry point is only called
144 ; if the mouse is currently visible and should get hidden. For most drivers,
145 ; no special action is required besides hiding the mouse cursor.
146 ; No return code required.
153 ;----------------------------------------------------------------------------
154 ; SHOW routine. Is called to show the mouse pointer. The mouse kernel manages
155 ; a counter for calls to show/hide, and the driver entry point is only called
156 ; if the mouse is currently hidden and should become visible. For most drivers,
157 ; no special action is required besides enabling the mouse cursor.
158 ; No return code required.
165 ;----------------------------------------------------------------------------
166 ; SETBOX: Set the mouse bounding box. The parameters are passed as they come
167 ; from the C program, that is, a pointer to a mouse_box struct in a/x.
168 ; No checks are done if the mouse is currently inside the box, this is the job
169 ; of the caller. It is not necessary to validate the parameters, trust the
170 ; caller and save some code here. No return code required.
173 stx ptr1+1 ; Save data pointer
175 ldy #.sizeof (MOUSE_BOX)-1
186 ;----------------------------------------------------------------------------
187 ; GETBOX: Return the mouse bounding box. The parameters are passed as they
188 ; come from the C program, that is, a pointer to a mouse_box struct in a/x.
191 stx ptr1+1 ; Save data pointer
193 ldy #.sizeof (MOUSE_BOX)-1
204 ;----------------------------------------------------------------------------
205 ; MOVE: Move the mouse to a new position. The position is passed as it comes
206 ; from the C program, that is: X on the stack and Y in a/x. The C wrapper will
207 ; remove the parameter from the stack on return.
208 ; No checks are done if the new position is valid (within the bounding box or
209 ; the screen). No return code required.
212 MOVE: sei ; No interrupts
215 stx YPos+1 ; New Y position
224 sta XPos ; New X position
226 jsr CMOVEX ; Move the cursor
228 cli ; Allow interrupts
231 ;----------------------------------------------------------------------------
232 ; BUTTONS: Return the button mask in a/x.
238 lda CIA1_PRB ; Read joystick #0
245 ;----------------------------------------------------------------------------
246 ; POS: Return the mouse position in the MOUSE_POS struct pointed to by ptr1.
247 ; No return code required.
249 POS: ldy #MOUSE_POS::XCOORD ; Structure offset
251 sei ; Disable interrupts
252 lda XPos ; Transfer the position
261 cli ; Enable interrupts
264 sta (ptr1),y ; Store last byte
268 ;----------------------------------------------------------------------------
269 ; INFO: Returns mouse position and current button mask in the MOUSE_INFO
270 ; struct pointed to by ptr1. No return code required.
272 ; We're cheating here to keep the code smaller: The first fields of the
273 ; mouse_info struct are identical to the mouse_pos struct, so we will just
274 ; call _mouse_pos to initialize the struct pointer and fill the position
279 ; Fill in the button state
281 jsr BUTTONS ; Will not touch ptr1
282 ldy #MOUSE_INFO::BUTTONS
287 ;----------------------------------------------------------------------------
288 ; IOCTL: Driver defined entry point. The wrapper will pass a pointer to ioctl
289 ; specific data in ptr1, and the ioctl code in A.
290 ; Must return an error code in a/x.
293 IOCTL: lda #<MOUSE_ERR_INV_IOCTL ; We don't support ioclts for now
294 ldx #>MOUSE_ERR_INV_IOCTL
297 ;----------------------------------------------------------------------------
298 ; IRQ: Irq handler entry point. Called as a subroutine but in IRQ context
299 ; (so be careful). The routine MUST return carry set if the interrupt has been
300 ; 'handled' - which means that the interrupt source is gone. Otherwise it
301 ; MUST return carry clear.
304 IRQ: lda SID_ADConv1 ; Get mouse X movement
306 jsr MoveCheck ; Calculate movement vector
309 ; Skip processing if nothing has changed
313 ; Calculate the new X coordinate (--> a/y)
316 tay ; Remember low byte
321 ; Limit the X coordinate to the bounding box
339 ; Move the mouse pointer to the new X pos
344 ; Calculate the Y movement vector
346 @SkipX: lda SID_ADConv2 ; Get mouse Y movement
348 jsr MoveCheck ; Calculate movement
351 ; Skip processing if nothing has changed
355 ; Calculate the new Y coordinate (--> a/y)
366 ; Limit the Y coordinate to the bounding box
384 ; Move the mouse pointer to the new X pos
391 clc ; Interrupt not "handled"
394 ; --------------------------------------------------------------------------
396 ; Move check routine, called for both coordinates.
398 ; Entry: y = old value of pot register
399 ; a = current value of pot register
400 ; Exit: y = value to use for old value
401 ; x/a = delta value for position
409 sub OldValue ; a = mod64 (new - old)
411 cmp #%01000000 ; if (a > 0)
414 beq @L2 ; if (a != 0)
415 ldy NewValue ; y = NewValue
419 @L1: ora #%11000000 ; else or in high order bits
420 cmp #$FF ; if (a != -1)
424 dex ; high byte = -1 (X = $FF)