Fixed LinuxDoc Tools issues in some verbatim blocks in the Atari document.

[cc65] / asminc / mouse-kernel.inc

diff --git a/asminc/mouse-kernel.inc b/asminc/mouse-kernel.inc
index 006f3e475e7ae9b8bd14d560ab34a7c0a3346819..ab4790d1dd6444c0930c3883979d2f019a21d0d7 100644 (file)
--- a/asminc/mouse-kernel.inc
+++ b/asminc/mouse-kernel.inc
@@ -2,14 +2,14 @@
 ;/*                                                                           */
 ;/*                            mouse-kernel.inc                               */
 ;/*                                                                           */
-;/*                               Mouse API                                  */
+;/*                                Mouse API                                  */
 ;/*                                                                           */
 ;/*                                                                           */
 ;/*                                                                           */
-;/* (C) 2003      Ullrich von Bassewitz                                       */
-;/*               Römerstraße 52                                              */
-;/*               D-70794 Filderstadt                                         */
-;/* EMail:        uz@cc65.org                                                 */
+;/* (C) 2003-2009, Ullrich von Bassewitz                                      */
+;/*                Roemerstrasse 52                                           */
+;/*                D-70794 Filderstadt                                        */
+;/* EMail:         uz@cc65.org                                                */
 ;/*                                                                           */
 ;/*                                                                           */
 ;/*                                                                           */
@@ -45,36 +45,81 @@
         MOUSE_ERR_CANNOT_LOAD           ; Error loading driver
         MOUSE_ERR_INV_DRIVER            ; Invalid driver
         MOUSE_ERR_NO_DEVICE             ; Mouse hardware not found
+        MOUSE_ERR_INV_IOCTL             ; Invalid ioctl code
+
+        MOUSE_ERR_COUNT                 ; Special: Number of error codes
 .endenum
 
 ;------------------------------------------------------------------------------
 ; The driver header
 
-.struct        MOUSE_HDR
-       ID      .byte   3       ; Contains 0x6D, 0x6F, 0x75 ("mou")
-       VERSION .byte   1       ; Interface version
-       JUMPTAB .struct
-           INSTALL     .addr
-           UNINSTALL   .addr
-                   HIDE        .addr
-           SHOW        .addr
-           BOX         .addr
-           MOVE        .addr
-           BUTTONS     .addr
-           POS         .addr
+.struct MOUSE_HDR
+        ID              .byte   3       ; Contains 0x6D, 0x6F, 0x75 ("mou")
+        VERSION         .byte   1       ; Interface version
+        LIBREF          .addr           ; Library reference
+        JUMPTAB         .struct
+            INSTALL     .addr
+            UNINSTALL   .addr
+            HIDE        .addr
+            SHOW        .addr
+            SETBOX      .addr
+            GETBOX      .addr
+            MOVE        .addr
+            BUTTONS     .addr
+            POS         .addr
             INFO        .addr
-       .endstruct
+            IOCTL       .addr
+            IRQ         .addr
+        .endstruct
+        FLAGS           .byte           ; Mouse driver flags
+        CALLBACKS .struct               ; Jump instructions
+                        .byte           ; JMP opcode
+            CHIDE       .addr           ; Jump address
+                        .byte
+            CSHOW       .addr
+                        .byte
+            CPREP       .addr
+                        .byte
+            CDRAW       .addr
+                        .byte
+            CMOVEX      .addr
+                        .byte
+            CMOVEY      .addr
+        .endstruct
+.endstruct
+
+;------------------------------------------------------------------------------
+; The mouse callback structure
+
+.struct MOUSE_CALLBACKS
+        HIDE    .addr                   ; Hide the mouse cursor
+        SHOW    .addr                   ; Show the mouse cursor
+        PREP    .addr                   ; Prepare to move the mouse cursor
+        DRAW    .addr                   ; Draw the mouse cursor
+        MOVEX   .addr                   ; Move the mouse cursor to X coord
+        MOVEY   .addr                   ; Move the mouse cursor to Y coord
 .endstruct
 
 ;------------------------------------------------------------------------------
 ; The mouse API version, stored in MOUSE_HDR::VERSION
 
-MOUSE_API_VERSION       = $00
+MOUSE_API_VERSION       = $06
+
+;------------------------------------------------------------------------------
+; 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.
+; Beware: Some of the bits are tested using the BIT instruction, so do not
+; change the values without checking the code!
+
+MOUSE_FLAG_EARLY_IRQ    = $40           ; Enable IRQ *before* calling INSTALL
+MOUSE_FLAG_LATE_IRQ     = $80           ; Enable IRQ *after* calling INSTALL
 
 ;------------------------------------------------------------------------------
 ; Mouse button definitions
 
-MOUSE_BTN_LEFT                 = $10
+MOUSE_BTN_LEFT          = $10
 MOUSE_BTN_RIGHT         = $01
 
 ;------------------------------------------------------------------------------
@@ -90,39 +135,50 @@ MOUSE_BTN_RIGHT         = $01
         BUTTONS .byte
 .endstruct
 
+.struct MOUSE_BOX
+        MINX    .word
+        MINY    .word
+        MAXX    .word
+        MAXY    .word
+.endstruct
 
 ;------------------------------------------------------------------------------
 ; Variables
 
-               .global _mouse_drv                      ; Pointer to driver
+        .global _mouse_drv              ; Pointer to driver
+        .global _mouse_hidden           ; Counter, 0 = mouse is visible
 
 ;------------------------------------------------------------------------------
 ; C callable functions
 
-        .global _mouse_set_callbacks
         .global _mouse_load_driver
         .global _mouse_unload
         .global _mouse_install
         .global _mouse_uninstall
+        .global _mouse_geterrormsg
         .global _mouse_hide
         .global _mouse_show
-        .global _mouse_box
+        .global _mouse_setbox
+        .global _mouse_getbox
         .global _mouse_move
         .global _mouse_buttons
         .global _mouse_pos
         .global _mouse_info
+        .global _mouse_ioctl
+
+        .global _mouse_clear_ptr
 
 ;------------------------------------------------------------------------------
-; Driver entry points
+; Driver entry points (asm callable)
 
         .global mouse_install
         .global mouse_uninstall
         .global mouse_hide
         .global mouse_show
-        .global mouse_box
+        .global mouse_setbox
+        .global mouse_getbox
         .global mouse_move
         .global mouse_buttons
         .global mouse_pos
         .global mouse_info
-
-
+        .global mouse_ioctl