2 ; Mouse driver for Atari Touch Tablet
4 ; Christian Groessler, 2014-01-05
7 .include "zeropage.inc"
8 .include "mouse-kernel.inc"
14 ; ------------------------------------------------------------------------
15 ; Header. Includes jump table
18 module_header _atrxtt_mou
20 module_header _atrtt_mou
27 .byte $6d, $6f, $75 ; "mou"
28 .byte MOUSE_API_VERSION ; Mouse driver API version number
51 .byte MOUSE_FLAG_LATE_IRQ
53 ; Callback table, set by the kernel before INSTALL is called
55 CHIDE: jmp $0000 ; Hide the cursor
56 CSHOW: jmp $0000 ; Show the cursor
57 CPREP: jmp $0000 ; Prepare to move the cursor
58 CDRAW: jmp $0000 ; Draw the cursor
59 CMOVEX: jmp $0000 ; Move the cursor to X coord
60 CMOVEY: jmp $0000 ; Move the cursor to Y coord
63 ;----------------------------------------------------------------------------
76 ;----------------------------------------------------------------------------
77 ; Global variables. The bounding box values are sorted so that they can be
78 ; written with the least effort in the SETBOX and GETBOX routines, so don't
84 YPos: .res 2 ; Current mouse position, Y
85 XPos: .res 2 ; Current mouse position, X
86 XMin: .res 2 ; X1 value of bounding box
87 YMin: .res 2 ; Y1 value of bounding box
88 XMax: .res 2 ; X2 value of bounding box
89 YMax: .res 2 ; Y2 value of bounding box
90 Buttons: .res 1 ; Button mask
91 OldButton: .res 1 ; previous buttons
93 ; Default values for above variables
97 ; (We use ".proc" because we want to define both a label and a scope.)
100 .word SCREEN_HEIGHT/2 ; YPos
101 .word SCREEN_WIDTH/2 ; XPos
104 .word SCREEN_WIDTH ; XMax
105 .word SCREEN_HEIGHT ; YMax
111 ;----------------------------------------------------------------------------
112 ; INSTALL routine. Is called after the driver is loaded into memory. If
113 ; possible, check if the hardware is present.
114 ; Must return an MOUSE_ERR_xx code in a/x.
118 ; Initialize variables. Just copy the default stuff over
120 ldx #.sizeof(DefVars)-1
126 ; Make sure the mouse cursor is at the default location.
135 ; Done, return zero (= MOUSE_ERR_OK)
141 ;----------------------------------------------------------------------------
142 ; UNINSTALL routine. Is called before the driver is removed from memory.
143 ; No return code required (the driver is removed from memory on return).
145 UNINSTALL = HIDE ; Hide cursor on exit
147 ;----------------------------------------------------------------------------
148 ; HIDE routine. Is called to hide the mouse pointer. The mouse kernel manages
149 ; a counter for calls to show/hide, and the driver entry point is only called
150 ; if the mouse is currently visible and should get hidden. For most drivers,
151 ; no special action is required besides hiding the mouse cursor.
152 ; No return code required.
160 ;----------------------------------------------------------------------------
161 ; SHOW routine. Is called to show the mouse pointer. The mouse kernel manages
162 ; a counter for calls to show/hide, and the driver entry point is only called
163 ; if the mouse is currently hidden and should become visible. For most drivers,
164 ; no special action is required besides enabling the mouse cursor.
165 ; No return code required.
173 ;----------------------------------------------------------------------------
174 ; SETBOX: Set the mouse bounding box. The parameters are passed as they come
175 ; from the C program, that is, a pointer to a mouse_box struct in a/x.
176 ; No checks are done if the mouse is currently inside the box, this is the job
177 ; of the caller. It is not necessary to validate the parameters, trust the
178 ; caller and save some code here. No return code required.
181 stx ptr1+1 ; Save data pointer
183 ldy #.sizeof (MOUSE_BOX)-1
195 ;----------------------------------------------------------------------------
196 ; GETBOX: Return the mouse bounding box. The parameters are passed as they
197 ; come from the C program, that is, a pointer to a mouse_box struct in a/x.
200 stx ptr1+1 ; Save data pointer
202 ldy #.sizeof (MOUSE_BOX)-1
214 ;----------------------------------------------------------------------------
215 ; MOVE: Move the mouse to a new position. The position is passed as it comes
216 ; from the C program, that is: X on the stack and Y in a/x. The C wrapper will
217 ; remove the parameter from the stack on return.
218 ; No checks are done if the new position is valid (within the bounding box or
219 ; the screen). No return code required.
234 stx YPos+1 ; New Y position
243 sta XPos ; New X position
244 jsr CMOVEX ; Move the cursor
248 plp ; Restore interrupt flag
251 ;----------------------------------------------------------------------------
252 ; BUTTONS: Return the button mask in a/x.
259 ;----------------------------------------------------------------------------
260 ; POS: Return the mouse position in the MOUSE_POS struct pointed to by ptr1.
261 ; No return code required.
263 POS: ldy #MOUSE_POS::XCOORD ; Structure offset
266 sei ; Disable interrupts
267 lda XPos ; Transfer the position
276 plp ; Restore interrupt flag
279 sta (ptr1),y ; Store last byte
283 ;----------------------------------------------------------------------------
284 ; INFO: Returns mouse position and current button mask in the MOUSE_INFO
285 ; struct pointed to by ptr1. No return code required.
287 ; We're cheating here to keep the code smaller: The first fields of the
288 ; mouse_info struct are identical to the mouse_pos struct, so we will just
289 ; call _mouse_pos to initialize the struct pointer and fill the position
294 ; Fill in the button state
297 ldy #MOUSE_INFO::BUTTONS
302 ;----------------------------------------------------------------------------
303 ; IOCTL: Driver defined entry point. The wrapper will pass a pointer to ioctl
304 ; specific data in ptr1, and the ioctl code in A.
305 ; Must return an error code in a/x.
308 IOCTL: lda #<MOUSE_ERR_INV_IOCTL ; We don't support ioclts for now
309 ldx #>MOUSE_ERR_INV_IOCTL
312 ;----------------------------------------------------------------------------
313 ; IRQ: Irq handler entry point. Called as a subroutine but in IRQ context
314 ; (so be careful). The routine MUST return carry set if the interrupt has been
315 ; 'handled' - which means that the interrupt source is gone. Otherwise it
316 ; MUST return carry clear.
321 ; Check for a pressed button and place the result into Buttons
326 lda PORTA ; get other buttons
329 and #5 ; pen button and left button are mapped to left mouse button
341 ; Check if button status changed, and disable "attract mode" if yes
350 ; If we read 228 for X or Y positions, we assume the user has lifted the pen
351 ; and don't change the cursor position.
355 beq @Cont ; CF set if equal
357 cmp #228 ; CF set if equal
359 @Cont: php ; remember CF
369 stx ATRACT ; disable "attract mode"
371 ; Get cursor position
372 ; -------------------
373 ; The touch pad is read thru the paddle potentiometers. The possible
374 ; values are 1..228. Since the maximum value is less than the X
375 ; dimension we have to "stretch" this value. In order to use only
376 ; divisions by powers of two, we use the following appoximation:
378 ; 1+1/2-1/8+1/32 = 1.4062
379 ; For Y we subtract 1/8 of it to get in the YMax ballpark.
381 ; A small area in the Y dimension of the touchpad isn't used with
382 ; this approximation. The Y value is inverted, (0,0) is the bottom
383 ; left corner of the touchpad.
387 ldx PADDL0 ; get X postion
388 dex ; decrement, since it's 1-based
399 lsr a ; port value / 4
400 lsr a ; port value / 8
410 lsr a ; port value / 16
411 lsr a ; port value / 32
422 ; Limit the X coordinate to the bounding box
440 ; Move the mouse pointer to the new X pos
447 ldx PADDL1 ; get Y postion
448 dex ; decrement, since it's 1-based
452 sbc YPos ; invert value
466 ; Limit the Y coordinate to the bounding box
484 ; Move the mouse pointer to the new X pos
491 clc ; Interrupt not "handled"