;/* */
;/* mouse-kernel.inc */
;/* */
-;/* Mouse API */
+;/* Mouse API */
;/* */
;/* */
;/* */
-;/* (C) 2003-2004 Ullrich von Bassewitz */
+;/* (C) 2003-2006 Ullrich von Bassewitz */
;/* Römerstraße 52 */
;/* D-70794 Filderstadt */
;/* EMail: uz@cc65.org */
IOCTL .addr
IRQ .addr
.endstruct
+ FLAGS .byte ; Mouse driver flags
CALLBACKS .struct ; Jump instructions
.byte ; JMP opcode
CHIDE .addr ; Jump address
;------------------------------------------------------------------------------
; The mouse API version, stored in MOUSE_HDR::VERSION
-MOUSE_API_VERSION = $00
+MOUSE_API_VERSION = $01
+
+;------------------------------------------------------------------------------
+; Bitmapped mouse driver flags, stored in MOUSE_HDR::FLAGS.
+; Note: If neither of MOUSE_FLAG_XXX_IRQ is set, no interrupts are supplied
+; to the driver. If one of the bits is set, the interrupt vector MUST be
+; valid.
+
+MOUSE_FLAG_EARLY_IRQ = $40 ; Enable IRQ *before* calling INSTALL
+MOUSE_FLAG_LATE_IRQ = $80 ; Enable IRQ *after* calling INSTALL
;------------------------------------------------------------------------------
; Mouse button definitions
.addr IOCTL
.addr IRQ
+ ; Mouse driver flags
+ .byte MOUSE_FLAG_EARLY_IRQ
+
; Callback table, set by the kernel before INSTALL is called
CHIDE: jmp $0000 ; Hide the cursor
CSHOW: jmp $0000 ; Show the cursor
; ------------------------------------------------------------------------
.bss
-
+
slot: .res 1
visible:.res 1
-
+
; ------------------------------------------------------------------------
.rodata
; ------------------------------------------------------------------------
.data
-
+
info: .word 279 / 2 ; MOUSE_INFO::MOUSE_POS::XCOORD
.word 191 / 2 ; MOUSE_INFO::MOUSE_POS::YCOORD
.byte %00000000 ; MOUSE_INFO::BUTTONS
yparam: ldy #$FF ; Patched at runtime
jump: jmp $FFFF ; Patched at runtime
-
+
; ------------------------------------------------------------------------
.code
bne next
dex
bpl :-
-
+
; Get and patch firmware address hibyte
lda ptr1+1
sta lookup+2
sta xparam+1
sta jump+2
-
+
; Convert to and save slot number
and #$0F
sta slot
ldx #SETMOUSE
jsr firmware
- ; Set initial mouse clamps
+ ; Set initial mouse clamps
lda #<279
ldx #>279
sta pos2_lo
; Hide cursor
sei
jsr CHIDE
-
+
; Turn mouse off
lda #%00000000
ldx #SETMOUSE
ldx #$01 ; Set y clamps
ldy #$00 ; Start at top of stack
jsr :+
-
+
ldx #$00 ; Set x clamps
ldy #$00 ; Start at top of stack
; Update cursor
jsr update
-
+
ldx #POSMOUSE
bne common ; Branch always
lda #<MOUSE_ERR_INV_IOCTL
ldx #>MOUSE_ERR_INV_IOCTL
rts
-
+
; IRQ: Called from the builtin runtime IRQ handler as a subroutine. All
; registers are already saved, no parameters are passed, but the carry flag
; is clear on entry. The routine must return with carry set if the interrupt
ldy slot
lda status,y
tax ; Save status
-
+
; Extract button down values
asl ; C = Button 0 is currently down
and #%00100000 ; !Z = Button 1 is currently down
: bcc :+
ora #MOUSE_BTN_LEFT
: sta info + MOUSE_INFO::BUTTONS
-
+
; Check for mouse movement
txa ; Restore status
and #%00100000 ; X or Y changed since last READMOUSE
; Remove the cursor at the old position
update: jsr CHIDE
-
+
; Get and set the new X position
ldy slot
lda pos1_lo,y
sta info + MOUSE_POS::XCOORD
stx info + MOUSE_POS::XCOORD+1
jsr CMOVEX
-
+
; Get and set the new Y position
ldy slot
lda pos2_lo,y
.addr IOCTL
.addr IRQ
+; Mouse driver flags
+
+ .byte MOUSE_FLAG_LATE_IRQ
+
; Callback table, set by the kernel before INSTALL is called
CHIDE: jmp $0000 ; Hide the cursor
.addr IOCTL
.addr IRQ
+; Mouse driver flags
+
+ .byte MOUSE_FLAG_LATE_IRQ
+
; Callback table, set by the kernel before INSTALL is called
CHIDE: jmp $0000 ; Hide the cursor
.addr IOCTL
.addr IRQ
+; Mouse driver flags
+
+ .byte MOUSE_FLAG_LATE_IRQ
+
; Callback table, set by the kernel before INSTALL is called
CHIDE: jmp $0000 ; Hide the cursor
; Move the mouse pointer to the new X pos
tya
- jsr CMOVEY
+ jsr CMOVEY
; Done
.addr IOCTL
.addr IRQ
+; Mouse driver flags
+
+ .byte MOUSE_FLAG_LATE_IRQ
+
; Callback table, set by the kernel before INSTALL is called
CHIDE: jmp $0000 ; Hide the cursor
mouse_info: jmp return0
mouse_ioctl: jmp return0
mouse_irq: .byte $60, $00, $00 ; RTS plus two dummy bytes
+mouse_flags: .byte $00
; Driver header signature
.rodata
cpy #(MOUSE_HDR::JUMPTAB + .sizeof(MOUSE_HDR::JUMPTAB))
bne @L1
+; Copy the flags byte. It is located directly behind the jump vectors, so Y
+; is already correct when we come here. To save code, we use copyjv - crude
+; but effective.
+
+ jsr copyjv
+
; Copy the callback vectors into the driver space
jsr popsreg
; Install the IRQ vector if the driver needs it
- lda mouse_irq+2 ; Check high byte of IRQ vector
- beq @L3 ; Jump if vector invalid
- lda #$4C ; Jump opcode
- sta mouse_irq ; Activate IRQ routine
+ bit mouse_flags ; Test MOUSE_FLAG_EARLY_IRQ
+ bvc @L3 ; Jump if no interrupts at this time
+ jsr install_irq ; Activate IRQ routine
; Call driver install routine and check for errors
@L3: jsr mouse_install
tay ; Test error code
- beq @L4 ; Jump if no error
+ bne uninstall_irq ; Jump on error
+
+; No errors on INSTALL. If the driver needs late IRQs, enable them now. Be
+; careful not to use A/X since these registers contain the error code from
+; INSTALL.
-; Uninstall IRQ vector if install routine had errors. A/X contains the error
-; code from mouse_install, so don't use it.
+ bit mouse_flags ; Test MOUSE_FLAG_LATE_IRQ
+ bpl Exit ; Jump if vector not needed
+install_irq:
+ ldy #$4C ; Jump opcode
+ sty mouse_irq ; Activate IRQ routine
+Exit: rts
+; Uninstall IRQ vector if install routine had errors. A/X may contain the
+; error code from mouse_install, so don't use it.
+
+uninstall_irq:
ldy #$60 ; RTS opcode
sty mouse_irq ; Disable IRQ entry point
-@L4: rts
+ rts
; Driver signature invalid. One word is still on the stack
; /* Uninstall the currently loaded driver. Returns an error code. */
_mouse_uninstall:
- lda #$60 ; RTS opcode
- sta mouse_irq ; Disable IRQ entry point
-
+ jsr uninstall_irq ; Disable driver interrupts
jsr mouse_uninstall ; Call driver routine
mouse_clear_ptr: ; External entry point