; the Commodore 1351 mouse users guide.
;
- .export _mouse_init, _mouse_done
- .export _mouse_hide, _mouse_show
- .export _mouse_box, _mouse_info
- .export _mouse_move
+ .export _mouse_init, _mouse_done
+ .export _mouse_hide, _mouse_show
+ .export _mouse_box, _mouse_info
+ .export _mouse_move, _mouse_pos
+ .export _mouse_buttons, _mouse_info
- .import popa, popsreg, addysp1
- .importzp sp, sreg
+ .import _readjoy
+ .import popax, addysp1
+ .importzp ptr1, sp
+
+ .include "c64.inc"
+
+ .macpack generic
- .include "c64.inc"
.code
; --------------------------------------------------------------------------
;
-; void __fastcall__ mouse_init (unsigned char port, unsigned char sprite);
+; Constants
;
-_mouse_init:
- tax ; Save sprite number
- jsr popa ; Get the port number
+SPRITE_HEIGHT = 21
+SPRITE_WIDTH = 24
+SCREEN_HEIGHT = 200
+SCREEN_WIDTH = 320
+XCORR = SPRITE_WIDTH
- ldy OldIRQ+1 ; Already initialized?
- bne Done ; Jump if yes
+; --------------------------------------------------------------------------
+;
+; unsigned char __fastcall__ mouse_init (unsigned char type);
+;
- stx MouseSprite ; Remember the sprite number
- sta MousePort ; Remember the port number
+_mouse_init:
+ lda OldIRQ+1 ; Already initialized?
+ bne AlreadyInitialized ; Jump if yes
; Initialize variables
ldx #0
- stx XPos
+ lda #XCORR
+ sta XPos
stx XPos+1
- stx YPos
+ stx YPos
stx YPos+1
stx OldPotX
stx OldPotY
stx XMin
- stx XMin+1
- stx YMin
- stx YMin+1
- stx YMax+1
- inx ; X = 1
- stx Visible ; Mouse *not* visible
- stx XMax+1 ; >320
- ldx #<320
- stx XMax
- ldx #200
- stx YMax
+ stx XMin+1 ; XMin = 0
+ lda #50 ; ## FIXME: This is the PAL value
+ sta YCorr
+ sta YPos
+ stx YPos+1
+ sec
+ sbc #SPRITE_HEIGHT ; Sprite height in pixels
+ sta YMin
+ stx YMin+1 ; YMin = 29
+ lda #SCREEN_HEIGHT ; Vertical screen res
+ add YCorr ; Add correction factor
+ sta YMax
+ stx YMax+1
+ inx ; X = 1
+ stx Invisible ; Mouse *not* visible
+ lda #<(SCREEN_WIDTH + SPRITE_WIDTH)
+ sta XMax
+ stx XMax+1 ; XMax = 320 + sprite width
; Remember the old IRQ vector
lda IRQVec+1
sta OldIRQ+1
-; Set our own IRQ vector
+; Set our own IRQ vector.
- lda #<MouseIRQ
- ldx #>MouseIRQ
- bne SetIRQ
+ ldx #<MouseIRQ
+ ldy #>MouseIRQ
+ jsr SetIRQ ; Set our IRQ vector, disable sprite 0
+ lda #1 ; Mouse successfully initialized
+ rts
+
+AlreadyInitialized:
+ lda #0 ; Error
+ rts
; --------------------------------------------------------------------------
;
;
_mouse_done:
- lda OldIRQ ; Initialized?
- ldx OldIRQ+1
- beq Done ; Jump if no
- ldy #0
- sty OldIRQ+1 ; Reset the initialized flag
-SetIRQ: sei ; Disable interrupts
- sta IRQVec ; Set the new/old vector
- stx IRQVec+1
- cli ; Enable interrupts
+ ldx OldIRQ
+ ldy OldIRQ+1 ; Initialized?
+ beq Done ; Jump if no
+ lda #0
+ sta OldIRQ+1 ; Reset the initialized flag
+SetIRQ: sei ; Disable interrupts
+ stx IRQVec ; Set the new/old vector
+ sty IRQVec+1
+ lda VIC_SPR_ENA ; Get sprite enable register
+ and #$FE ; Disable sprite #0
+ sta VIC_SPR_ENA ; Write back
+ cli ; Enable interrupts
Done: rts
+
; --------------------------------------------------------------------------
;
; void mouse_hide (void);
;
_mouse_hide:
- lda Visible ; Get the flag
- bne @L1 ; Jump if already invisible
- ldx MouseSprite ; Sprite defined?
- beq @L1 ; Jump if no
-
- lda BitMask-1,x ; Get bit mask
- eor #$FF ; We must clear the bit
+ lda Invisible ; Get the flag
+ bne @L1 ; Jump if already invisible
- sei ; Disable interrupts
- and VIC_SPR_ENA
- sta VIC_SPR_ENA ; Disable sprite
- cli ; Enable interrupts
+ lda #$FE ; Clear bit for sprite #0
+ sei ; Disable interrupts
+ and VIC_SPR_ENA
+ sta VIC_SPR_ENA ; Disable sprite
+ cli ; Enable interrupts
-@L1: inc Visible ; Set the flag to invisible
+@L1: inc Invisible ; Set the flag to invisible
rts
; --------------------------------------------------------------------------
;
_mouse_show:
- dec Visible ; Get the flag
- bne @L1 ; Jump if still invisible
- ldx MouseSprite ; Sprite defined?
- beq @L1 ; Jump if no
-
- lda BitMask-1,x ; Get bit mask
- sei ; Disable interrupts
- ora VIC_SPR_ENA
- sta VIC_SPR_ENA ; Enable sprite
- cli ; Enable interrupts
+ lda Invisible ; Mouse invisible?
+ beq @L1 ; Jump if no
+ dec Invisible ; Set the flag
+ bne @L1 ; Jump if still invisible
+
+ sei ; Disable interrupts
+ jsr MoveSprite1 ; Move the sprite to it's position
+ lda VIC_SPR_ENA ; Get sprite enable register
+ ora #$01 ; Enable sprite #0
+ sta VIC_SPR_ENA ; Write back
+ cli ; Enable interrupts
@L1: rts
;
_mouse_box:
- sei ; Disable interrupts
+ ldy #0 ; Stack offset
+
+ add YCorr ; Adjust the Y value
+ bcc @L1
+ inx
+ clc
+@L1: sei ; Disable interrupts
+
+ sta YMax
+ stx YMax+1 ; maxy
+
+ lda (sp),y
+ adc #XCORR
+ sta XMax
+ iny
+ lda (sp),y
+ adc #$00
+ sta XMax+1 ; maxx
+
+ iny
+ lda (sp),y
+ add YCorr
+ sta YMin
+ iny
+ lda (sp),y
+ adc #$00
+ sta YMin+1 ; miny
+
+ iny
+ lda (sp),y
+ add #XCORR
+ sta XMin
+ iny
+ lda (sp),y
+ adc #$00
+ sta XMin+1 ; minx
- sta YMax
- stx YMax+1 ; maxy
+ cli ; Enable interrupts
- ldy #0
- lda (sp),y
- sta XMax
- iny
- lda (sp),y
- sta XMax+1 ; maxx
+ jmp addysp1 ; Drop params, return
- iny
- lda (sp),y
- sta YMin
- iny
- lda (sp),y
- sta YMin+1 ; miny
+; --------------------------------------------------------------------------
+;
+; void __fastcall__ mouse_pos (struct mouse_pos* pos);
+; /* Return the current mouse position */
+;
- iny
- lda (sp),y
- sta XMin
- iny
- lda (sp),y
- sta XMin+1 ; minx
+_mouse_pos:
+ sta ptr1
+ stx ptr1+1 ; Remember the argument pointer
- cli ; Enable interrupts
+ ldy #0 ; Structure offset
+ sec ; Needed for the SBC later
- jmp addysp1 ; Drop params, return
+ sei ; Disable interrupts
+ lda XPos ; Transfer the position
+ sbc #XCORR
+ sta (ptr1),y
+ lda XPos+1
+ sbc #$00
+ iny
+ sta (ptr1),y
+ lda YPos
+ ldx YPos+1
+ cli ; Restore initial interrupt state
+
+ sub YCorr ; Apply the Y correction value
+ bcs @L1
+ dex
+@L1: iny
+ sta (ptr1),y ; Store YPos
+ txa
+ iny
+ sta (ptr1),y
+
+ rts ; Done
; --------------------------------------------------------------------------
;
-; void mouse_info (...);
+; void __fastcall__ mouse_info (struct mouse_info* info);
+; /* Return the state of the mouse buttons and the position of the mouse */
;
_mouse_info:
- rts
+; We're cheating here to keep the code smaller: The first fields of the
+; mouse_info struct are identical to the mouse_pos struct, so we will just
+; call _mouse_pos to initialize the struct pointer and fill the position
+; fields.
+
+ jsr _mouse_pos
+
+; Fill in the button state
+
+ jsr _mouse_buttons ; Will not touch ptr1
+ ldy #4
+ sta (ptr1),y
+
+ rts
; --------------------------------------------------------------------------
;
;
_mouse_move:
- jsr popsreg ; Get X
- sei ; Disable interrupts
-
- sta YPos
- stx YPos+1
- lda sreg
- ldx sreg+1
- sta XPos
- stx XPos+1 ; Set new position
+ add YCorr ; Add Y coordinate correction
+ bcc @L1
+ inx
+ clc
+@L1: sei
+ sta YPos
+ stx YPos+1
+ cli
+
+ jsr popax ; Get X
+ adc #XCORR ; Adjust X coordinate
+ bcc @L2
+ inx
+@L2: sei
+ sta XPos
+ stx XPos+1 ; Set new position
+ jsr MoveSprite ; Move the sprite to the mouse pos
+ cli ; Enable interrupts
- lda Visible ; Mouse visible?
- bne @L9 ; Jump if no
- lda MouseSprite ; Sprite defined?
- beq @L9
+ rts
- jsr MoveSprite ; Move the sprite to the mouse pos
+; --------------------------------------------------------------------------
+;
+; unsigned char mouse_buttons (void);
+;
-@L9: cli ; Enable interrupts
- rts
+_mouse_buttons:
+ lda #$00 ; Use port #0
+ jmp _readjoy ; Same as joystick
; --------------------------------------------------------------------------
;
MouseIRQ:
cld
- lda SID_ADConv1 ; Get mouse X movement
- ldy OldPotX
- jsr MoveCheck ; Calculate movement vector
- sty OldPotX
+ lda SID_ADConv1 ; Get mouse X movement
+ ldy OldPotX
+ jsr MoveCheck ; Calculate movement vector
+ sty OldPotX
; Calculate the new X coordinate (--> a/y)
- clc
- adc XPos
- tay ; Remember low byte
- txa
- adc XPos+1
+ add XPos
+ tay ; Remember low byte
+ txa
+ adc XPos+1
+ tax
; Limit the X coordinate to the bounding box
- cpy XMin+1
- bne @L1
- cmp XMin
-@L1: bpl @L2
- ldy XMin
- lda XMin+1
- jmp @L4
-
-@L2: cpy XMax+1
- bne @L3
- cmp XMax
- beq @L4
-@L3: bmi @L4
- ldy XMax
- lda XMax+1
-@L4: sty XPos
- sta XPos+1
+ cpy XMin
+ sbc XMin+1
+ bpl @L1
+ ldy XMin
+ ldx XMin+1
+ jmp @L2
+@L1: txa
+
+ cpy XMax
+ sbc XMax+1
+ bmi @L2
+ ldy XMax
+ ldx XMax+1
+@L2: sty XPos
+ stx XPos+1
; Calculate the Y movement vector
; Calculate the new Y coordinate (--> a/y)
- clc
- adc YPos
- tay ; Remember low byte
- txa
- adc YPos+1
-
-; Limit the Y coordinate to the bounding box
-
- cpy YMin+1
- bne @L5
- cmp YMin
-@L5: bpl @L6
- ldy YMin
- lda YMin+1
- jmp @L8
-
-@L6: cpy YMax+1
- bne @L7
- cmp YMax
- beq @L8
-@L7: bmi @L8
- ldy YMax
- lda YMax+1
-@L8: sty YPos
- sta YPos+1
+ sta OldValue
+ lda YPos
+ sub OldValue
+ tay
+ stx OldValue
+ lda YPos+1
+ sbc OldValue
+ tax
+
+ cpy YMin
+ sbc YMin+1
+ bpl @L3
+ ldy YMin
+ ldx YMin+1
+ jmp @L4
+@L3: txa
+
+ cpy YMax
+ sbc YMax+1
+ bmi @L4
+ ldy YMax
+ ldx YMax+1
+@L4: sty YPos
+ stx YPos+1
+
+; Move the mouse sprite if it is enabled
+
+ jsr MoveSprite ; Move the sprite
; Jump to the next IRQ handler
- jmp (OldIRQ)
+ jmp (OldIRQ)
; --------------------------------------------------------------------------
;
; Move check routine, called for both coordinates.
;
-; Entry: y = old value of pot register
-; a = current value of pot register
-; Exit: y = value to use for old value
-; x/a = delta value for position
+; Entry: y = old value of pot register
+; a = current value of pot register
+; Exit: y = value to use for old value
+; x/a = delta value for position
;
MoveCheck:
sty OldValue
sta NewValue
- ldx #$00
+ ldx #$00
- sec ; a = mod64 (new - old)
- sbc OldValue
+ sub OldValue ; a = mod64 (new - old)
and #%01111111
cmp #%01000000 ; if (a > 0)
bcs @L1 ;
lsr a ; a /= 2;
beq @L2 ; if (a != 0)
- ldy NewValue ; y = NewValue
- rts ; return
+ ldy NewValue ; y = NewValue
+ rts ; return
-@L1: ora #%11000000 ; else or in high order bits
- cmp #$FF ; if (a != -1)
- beq @L2
+@L1: ora #%11000000 ; else or in high order bits
+ cmp #$FF ; if (a != -1)
+ beq @L2
sec
- ror a ; a /= 2
- ldx #$FF ; high byte = -1
- ldy NewValue
+ ror a ; a /= 2
+ dex ; high byte = -1 (X = $FF)
+ ldy NewValue
rts
-@L2: lda #0
+@L2: txa ; A = $00
rts
; --------------------------------------------------------------------------
;
; Move the mouse sprite to the current mouse position. Must be called
-; with interrupts off.
+; with interrupts off. MoveSprite1 is an entry without checking.
;
MoveSprite:
- lda Visible ; Mouse pointer visible?
- bne @L9 ; Jump if no
- ldx MouseSprite ; Sprite defined?
- beq @L9 ; Jump if no
- ldy BitMask-1,x ; Get high bit mask
- txa
- asl a ; Index*2
- tax
-; Set the X position
+ lda Invisible ; Mouse visible?
+ bne MoveSpriteDone ; Jump if no
- lda XPos+1 ; Negative?
- bmi @L2 ; Jump if yes
- beq @L1
- tya ; Load high position bit
-@L1: ora VIC_SPR_HI_X ; Set high bit
- sta VIC_SPR_HI_X
- lda XPos
- sta VIC_SPR0_X,x ; Set low byte
+; Set the high X bit
+
+MoveSprite1:
+ lda VIC_SPR_HI_X ; Get high X bits of all sprites
+ and #$FE ; Clear bit for sprite #0
+ ldy XPos+1 ; Test Y position
+ beq @L1
+ ora #$01 ; Set high X bit
+@L1: sta VIC_SPR_HI_X ; Set hi X sprite values
+
+; Set the low X byte
+
+ lda XPos
+ sta VIC_SPR0_X ; Set low byte
; Set the Y position
-@L2: ldy YPos+1 ; Negative or too large?
- bne @L9 ; Jump if yes
- lda YPos
- sta VIC_SPR0_Y,x ; Set Y position
+ ldy YPos+1 ; Negative or too large?
+ bne MoveSpriteDone ; Jump if yes
+ lda YPos
+ sta VIC_SPR0_Y ; Set Y position
; Done
-@L9: rts
+MoveSpriteDone:
+ rts
; --------------------------------------------------------------------------
; Data
.bss
-OldIRQ: .res 2 ; Old IRQ vector
-MousePort: .res 1 ; Port used for the mouse
-MouseSprite: .res 1 ; Number of sprite to control
+OldIRQ: .res 2 ; Old IRQ vector
OldValue: .res 1 ; Temp for MoveCheck routine
NewValue: .res 1 ; Temp for MoveCheck routine
+YCorr: .res 1 ; Correction for Y coordinate
-Visible: .res 1 ; Is the mouse visible?
-OldPotX: .res 1 ; Old hw counter values
+Invisible: .res 1 ; Is the mouse invisible?
+OldPotX: .res 1 ; Old hw counter values
OldPotY: .res 1
XPos: .res 2 ; Current mouse position, X
XMax: .res 2 ; X2 value of bounding box
YMax: .res 2 ; Y2 value of bounding box
-.data
-
-BitMask: .byte $01, $02, $04, $08, $10, $20, $40, $80
-
-
-
-