add SER_ERR_NOT_OPEN status code

[cc65] / include / joystick.h

diff --git a/include/joystick.h b/include/joystick.h
index f541cd0b809eeed8cf0b6657f51158281a566b18..18b552f08f81818e142148678a797640857f3845 100644 (file)
--- a/include/joystick.h
+++ b/include/joystick.h
@@ -1,15 +1,15 @@
 /*****************************************************************************/
 /*                                                                           */
-/*                               joystick.h                                 */
+/*                                joystick.h                                 */
 /*                                                                           */
-/*              Read the joystick on systems that support it                */
+/*               Read the joystick on systems that support it                */
 /*                                                                           */
 /*                                                                           */
 /*                                                                           */
-/* (C) 1998-2001 Ullrich von Bassewitz                                       */
-/*               Wacholderweg 14                                             */
-/*               D-70597 Stuttgart                                           */
-/* EMail:        uz@musoftware.de                                            */
+/* (C) 1998-2011, Ullrich von Bassewitz                                      */
+/*                Roemerstrasse 52                                           */
+/*                D-70794 Filderstadt                                        */
+/* EMail:         uz@cc65.org                                                */
 /*                                                                           */
 /*                                                                           */
 /* This software is provided 'as-is', without any expressed or implied       */
@@ -38,38 +38,75 @@
 
 
 
-/* Define __JOYSTICK__ for systems that support a joystick */
-#if defined(__ATARI__) || defined(__C64__) || defined(__C128__) || defined(__PLUS4__) || defined(__CBM510__) || defined(__VIC20__)
-#  define __JOYSTICK__
-#else
-#  error The target system does not support a joystick!
-# endif
+/*****************************************************************************/
+/*                                  Definitions                              */
+/*****************************************************************************/
 
-/* Argument for the function */
-#define JOY_1          0
-#define JOY_2          1
 
-/* Result codes of the function. The actual code is a bitwise or
- * of one or more of the following values.
- */
-#if defined(__VIC20__)
-#  define JOY_UP        0x04
-#  define JOY_DOWN      0x08
-#  define JOY_LEFT      0x10
-#  define JOY_RIGHT     0x80
-#  define JOY_FIRE      0x20
-#else
-#  define JOY_UP               0x01
-#  define JOY_DOWN     0x02
-#  define JOY_LEFT     0x04
-#  define JOY_RIGHT    0x08
-#  define JOY_FIRE     0x10
-#endif
 
+/* Error codes */
+#define JOY_ERR_OK              0       /* No error */
+#define JOY_ERR_NO_DRIVER       1       /* No driver available */
+#define JOY_ERR_CANNOT_LOAD     2       /* Error loading driver */
+#define JOY_ERR_INV_DRIVER      3       /* Invalid driver */
+#define JOY_ERR_NO_DEVICE       4       /* Device (hardware) not found */
+
+/* Argument for the joy_read function */
+#define JOY_1           0
+#define JOY_2           1
+
+/* The following codes are *indices* into the joy_masks array */
+#define JOY_UP          0
+#define JOY_DOWN        1
+#define JOY_LEFT        2
+#define JOY_RIGHT       3
+#define JOY_FIRE        4
+#define JOY_FIRE2       5               /* Second fire button if available */
+
+/* Array of masks used to check the return value of joy_read for a state */
+extern const unsigned char joy_masks[8];
+
+/* Macros that evaluate the return code of joy_read */
+#define JOY_BTN_UP(v)           ((v) & joy_masks[JOY_UP])
+#define JOY_BTN_DOWN(v)         ((v) & joy_masks[JOY_DOWN])
+#define JOY_BTN_LEFT(v)         ((v) & joy_masks[JOY_LEFT])
+#define JOY_BTN_RIGHT(v)        ((v) & joy_masks[JOY_RIGHT])
+#define JOY_BTN_FIRE(v)         ((v) & joy_masks[JOY_FIRE])
+#define JOY_BTN_FIRE2(v)        ((v) & joy_masks[JOY_FIRE2])
+
+/* The name of the standard joystick driver for a platform */
+extern const char joy_stddrv[];
+
+/* The address of the static standard joystick driver for a platform */
+extern const void joy_static_stddrv[];
+
+
+
+/*****************************************************************************/
+/*                                 Functions                                 */
+/*****************************************************************************/
+
+
+
+unsigned char __fastcall__ joy_load_driver (const char* driver);
+/* Load and install a joystick driver. Return an error code. */
+
+unsigned char joy_unload (void);
+/* Uninstall, then unload the currently loaded driver. */
+
+unsigned char __fastcall__ joy_install (void* driver);
+/* Install an already loaded driver. Return an error code. */
+
+unsigned char joy_uninstall (void);
+/* Uninstall the currently loaded driver and return an error code.
+ * Note: This call does not free allocated memory.
+ */
 
+unsigned char joy_count (void);
+/* Return the number of joysticks supported by the driver */
 
-unsigned __fastcall__ readjoy (unsigned char joy);
-/* Read the joystick. The argument is one of JOY_1/JOY2 */
+unsigned char __fastcall__ joy_read (unsigned char joystick);
+/* Read a particular joystick */