Usermode/Libraries/ld-acess.so_src/include_exp/acess/devices.h

   1 /**
   2  * Acess2 User Core
   3  * - By John Hodge (thePowersGang)
   4  *
   5  * acess/devices.h
   6  * - Core device IOCtls
   7  */
   8 #ifndef _ACESS_DRIVERS_H
   9 #define _ACESS_DRIVERS_H
  10
  11 // === COMMON ===
  12 enum eDrv_Common {
  13         /**
  14          * ioctl(...)
  15          * \brief Get driver type
  16          * \return The relevant entry from ::eTplDrv_Type
  17          */
  18         DRV_IOCTL_TYPE,
  19
  20         /**
  21          * ioctl(..., char *dest[32])
  22          * \brief Get driver identifier string
  23          * \return 0 on no error
  24          *
  25          * This call sets the 32-byte array \a dest to the drivers 31 character
  26          * identifier. This identifier must be unique to the driver series.
  27          */
  28         DRV_IOCTL_IDENT,
  29
  30         /**
  31          * ioctl(...)
  32          * \brief Get driver version number
  33          * \return 24-bit BCD version number (2.2.2)
  34          *
  35          * This call returns the 6-digit (2 major, 2 minor, 2 patch) version
  36          * number of the driver.
  37          */
  38         DRV_IOCTL_VERSION,
  39
  40         /**
  41          * ioctl(..., char *name)
  42          * \brief Get a IOCtl call ID from a symbolic name
  43          * \return ID number of the call, or 0 if not found
  44          *
  45          * This call allows user applications to not need to know the ID numbers
  46          * of this driver's IOCtl calls by taking a string and returning the
  47          * IOCtl call number associated with that method name.
  48          */
  49         DRV_IOCTL_LOOKUP,
  50
  51         /**
  52          * \brief First non-reserved IOCtl number for driver extension
  53          */
  54         DRV_IOCTL_USERMIN = 0x1000,
  55 };
  56
  57 enum eDrv_Types {
  58         DRV_TYPE_NULL,          //!< NULL Type - Custom Interface (must support core calls)
  59         DRV_TYPE_MISC,          //!< Miscelanious Compilant - Supports the core calls
  60         DRV_TYPE_TERMINAL,      //!< Terminal - see api_drv_terminal.h
  61         DRV_TYPE_VIDEO,         //!< Video - see api_drv_video.h
  62         DRV_TYPE_SOUND,         //!< Audio
  63         DRV_TYPE_DISK,          //!< Disk - see api_drv_disk.h
  64         DRV_TYPE_KEYBOARD,      //!< Keyboard - see api_drv_keyboard.h
  65         DRV_TYPE_MOUSE,         //!< Mouse
  66         DRV_TYPE_JOYSTICK,      //!< Joystick / Gamepad
  67         DRV_TYPE_NETWORK        //!< Network Device - see api_drv_network.h
  68 };
  69
  70 #endif