diff options
Diffstat (limited to 'dix/devices.c')
| -rw-r--r-- | dix/devices.c | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/dix/devices.c b/dix/devices.c index 6c694547b..923bc0d86 100644 --- a/dix/devices.c +++ b/dix/devices.c @@ -80,9 +80,20 @@ SOFTWARE. #include "exglobals.h" #include "exevents.h" +/** @file + * This file handles input device-related stuff. + */ + int CoreDevicePrivatesIndex = 0; static int CoreDevicePrivatesGeneration = -1; +/** + * Create a new input device and init it to sane values. The device is added + * to the server's off_devices list. + * + * @param deviceProc Callback for device control function (switch dev on/off). + * @return The newly created device. + */ DeviceIntPtr AddInputDevice(DeviceProc deviceProc, Bool autoStart) { @@ -138,6 +149,7 @@ AddInputDevice(DeviceProc deviceProc, Bool autoStart) #ifdef XKB dev->xkb_interest = NULL; #endif + dev->config_info = NULL; dev->nPrivates = 0; dev->devPrivates = NULL; dev->unwrapProc = NULL; @@ -153,6 +165,15 @@ AddInputDevice(DeviceProc deviceProc, Bool autoStart) return dev; } +/** + * Switch device ON through the driver and push it onto the global device + * list. All clients are notified about the device being enabled. + * + * A device will send events once enabled. + * + * @param The device to be enabled. + * @return TRUE on success or FALSE otherwise. + */ Bool EnableDevice(DeviceIntPtr dev) { @@ -189,6 +210,13 @@ EnableDevice(DeviceIntPtr dev) return TRUE; } +/** + * Switch a device off through the driver and push it onto the off_devices + * list. A device will not send events while disabled. All clients are + * notified about the device being disabled. + * + * @return TRUE on success or FALSE otherwise. + */ Bool DisableDevice(DeviceIntPtr dev) { @@ -219,6 +247,14 @@ DisableDevice(DeviceIntPtr dev) return TRUE; } +/** + * Initialise a new device through the driver and tell all clients about the + * new device. + * + * The device will NOT send events until it is enabled! + * + * @return Success or an error code on failure. + */ int ActivateDevice(DeviceIntPtr dev) { @@ -243,6 +279,10 @@ ActivateDevice(DeviceIntPtr dev) return ret; } +/** + * Ring the bell. + * The actual task of ringing the bell is the job of the DDX. + */ static void CoreKeyboardBell(int volume, DeviceIntPtr pDev, pointer arg, int something) { @@ -257,6 +297,9 @@ CoreKeyboardCtl(DeviceIntPtr pDev, KeybdCtrl *ctrl) return; } +/** + * Device control function for the Virtual Core Keyboard. + */ static int CoreKeyboardProc(DeviceIntPtr pDev, int what) { @@ -317,6 +360,9 @@ CoreKeyboardProc(DeviceIntPtr pDev, int what) return Success; } +/** + * Device control function for the Virtual Core Pointer. + */ static int CorePointerProc(DeviceIntPtr pDev, int what) { @@ -347,6 +393,12 @@ CorePointerProc(DeviceIntPtr pDev, int what) return Success; } +/** + * Initialise the two core devices, VCP and VCK (see events.c). + * The devices are activated but not enabled. + * Note that the server MUST have two core devices at all times, even if there + * is no physical device connected. + */ void InitCoreDevices(void) { @@ -406,6 +458,14 @@ InitCoreDevices(void) } } +/** + * Activate all switched-off devices and then enable all those devices. + * + * Will return an error if no core keyboard or core pointer is present. + * In theory this should never happen if you call InitCoreDevices() first. + * + * @return Success or error code on failure. + */ int InitAndStartDevices(void) { @@ -441,6 +501,13 @@ InitAndStartDevices(void) return Success; } +/** + * Close down a device and free all resources. + * Once closed down, the driver will probably not expect you that you'll ever + * enable it again and free associated structs. If you want the device to just + * be disabled, DisableDevice(). + * Don't call this function directly, use RemoveDevice() instead. + */ static void CloseDevice(DeviceIntPtr dev) { @@ -542,6 +609,10 @@ CloseDevice(DeviceIntPtr dev) xfree(dev); } +/** + * Shut down all devices, free all resources, etc. + * Only useful if you're shutting down the server! + */ void CloseDownDevices(void) { @@ -563,6 +634,12 @@ CloseDownDevices(void) inputInfo.pointer = NULL; } +/** + * Remove a device from the device list, closes it and thus frees all + * resources. + * Removes both enabled and disabled devices and notifies all devices about + * the removal of the device. + */ int RemoveDevice(DeviceIntPtr dev) { |