Linux/include/uapi/linux/input.h

来源:互联网 发布:淘宝网被冻结了怎么办 编辑:程序博客网 时间:2024/06/14 02:32
  1 /*  2  * Copyright (c) 1999-2002 Vojtech Pavlik  3  *  4  * This program is free software; you can redistribute it and/or modify it  5  * under the terms of the GNU General Public License version 2 as published by  6  * the Free Software Foundation.  7  */  8 #ifndef _UAPI_INPUT_H  9 #define _UAPI_INPUT_H 10  11  12 #ifndef __KERNEL__ 13 #include <sys/time.h> 14 #include <sys/ioctl.h> 15 #include <sys/types.h> 16 #include <linux/types.h> 17 #endif 18  19 #include "input-event-codes.h" 20  21 /* 22  * The event structure itself 23  */ 24  25 struct input_event { 26         struct timeval time; 27         __u16 type; 28         __u16 code; 29         __s32 value; 30 }; 31  32 /* 33  * Protocol version. 34  */ 35  36 #define EV_VERSION              0x010001 37  38 /* 39  * IOCTLs (0x00 - 0x7f) 40  */ 41  42 struct input_id { 43         __u16 bustype; 44         __u16 vendor; 45         __u16 product; 46         __u16 version; 47 }; 48  49 /** 50  * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls 51  * @value: latest reported value for the axis. 52  * @minimum: specifies minimum value for the axis. 53  * @maximum: specifies maximum value for the axis. 54  * @fuzz: specifies fuzz value that is used to filter noise from 55  *      the event stream. 56  * @flat: values that are within this value will be discarded by 57  *      joydev interface and reported as 0 instead. 58  * @resolution: specifies resolution for the values reported for 59  *      the axis. 60  * 61  * Note that input core does not clamp reported values to the 62  * [minimum, maximum] limits, such task is left to userspace. 63  * 64  * Resolution for main axes (ABS_X, ABS_Y, ABS_Z) is reported in 65  * units per millimeter (units/mm), resolution for rotational axes 66  * (ABS_RX, ABS_RY, ABS_RZ) is reported in units per radian. 67  */ 68 struct input_absinfo { 69         __s32 value; 70         __s32 minimum; 71         __s32 maximum; 72         __s32 fuzz; 73         __s32 flat; 74         __s32 resolution; 75 }; 76  77 /** 78  * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls 79  * @scancode: scancode represented in machine-endian form. 80  * @len: length of the scancode that resides in @scancode buffer. 81  * @index: index in the keymap, may be used instead of scancode 82  * @flags: allows to specify how kernel should handle the request. For 83  *      example, setting INPUT_KEYMAP_BY_INDEX flag indicates that kernel 84  *      should perform lookup in keymap by @index instead of @scancode 85  * @keycode: key code assigned to this scancode 86  * 87  * The structure is used to retrieve and modify keymap data. Users have 88  * option of performing lookup either by @scancode itself or by @index 89  * in keymap entry. EVIOCGKEYCODE will also return scancode or index 90  * (depending on which element was used to perform lookup). 91  */ 92 struct input_keymap_entry { 93 #define INPUT_KEYMAP_BY_INDEX   (1 << 0) 94         __u8  flags; 95         __u8  len; 96         __u16 index; 97         __u32 keycode; 98         __u8  scancode[32]; 99 };100 101 struct input_mask {102         __u32 type;103         __u32 codes_size;104         __u64 codes_ptr;105 };106 107 #define EVIOCGVERSION           _IOR('E', 0x01, int)                    /* get driver version */108 #define EVIOCGID                _IOR('E', 0x02, struct input_id)        /* get device ID */109 #define EVIOCGREP               _IOR('E', 0x03, unsigned int[2])        /* get repeat settings */110 #define EVIOCSREP               _IOW('E', 0x03, unsigned int[2])        /* set repeat settings */111 112 #define EVIOCGKEYCODE           _IOR('E', 0x04, unsigned int[2])        /* get keycode */113 #define EVIOCGKEYCODE_V2        _IOR('E', 0x04, struct input_keymap_entry)114 #define EVIOCSKEYCODE           _IOW('E', 0x04, unsigned int[2])        /* set keycode */115 #define EVIOCSKEYCODE_V2        _IOW('E', 0x04, struct input_keymap_entry)116 117 #define EVIOCGNAME(len)         _IOC(_IOC_READ, 'E', 0x06, len)         /* get device name */118 #define EVIOCGPHYS(len)         _IOC(_IOC_READ, 'E', 0x07, len)         /* get physical location */119 #define EVIOCGUNIQ(len)         _IOC(_IOC_READ, 'E', 0x08, len)         /* get unique identifier */120 #define EVIOCGPROP(len)         _IOC(_IOC_READ, 'E', 0x09, len)         /* get device properties */121 122 /**123  * EVIOCGMTSLOTS(len) - get MT slot values124  * @len: size of the data buffer in bytes125  *126  * The ioctl buffer argument should be binary equivalent to127  *128  * struct input_mt_request_layout {129  *      __u32 code;130  *      __s32 values[num_slots];131  * };132  *133  * where num_slots is the (arbitrary) number of MT slots to extract.134  *135  * The ioctl size argument (len) is the size of the buffer, which136  * should satisfy len = (num_slots + 1) * sizeof(__s32).  If len is137  * too small to fit all available slots, the first num_slots are138  * returned.139  *140  * Before the call, code is set to the wanted ABS_MT event type. On141  * return, values[] is filled with the slot values for the specified142  * ABS_MT code.143  *144  * If the request code is not an ABS_MT value, -EINVAL is returned.145  */146 #define EVIOCGMTSLOTS(len)      _IOC(_IOC_READ, 'E', 0x0a, len)147 148 #define EVIOCGKEY(len)          _IOC(_IOC_READ, 'E', 0x18, len)         /* get global key state */149 #define EVIOCGLED(len)          _IOC(_IOC_READ, 'E', 0x19, len)         /* get all LEDs */150 #define EVIOCGSND(len)          _IOC(_IOC_READ, 'E', 0x1a, len)         /* get all sounds status */151 #define EVIOCGSW(len)           _IOC(_IOC_READ, 'E', 0x1b, len)         /* get all switch states */152 153 #define EVIOCGBIT(ev,len)       _IOC(_IOC_READ, 'E', 0x20 + (ev), len)  /* get event bits */154 #define EVIOCGABS(abs)          _IOR('E', 0x40 + (abs), struct input_absinfo)   /* get abs value/limits */155 #define EVIOCSABS(abs)          _IOW('E', 0xc0 + (abs), struct input_absinfo)   /* set abs value/limits */156 157 #define EVIOCSFF                _IOW('E', 0x80, struct ff_effect)       /* send a force effect to a force feedback device */158 #define EVIOCRMFF               _IOW('E', 0x81, int)                    /* Erase a force effect */159 #define EVIOCGEFFECTS           _IOR('E', 0x84, int)                    /* Report number of effects playable at the same time */160 161 #define EVIOCGRAB               _IOW('E', 0x90, int)                    /* Grab/Release device */162 #define EVIOCREVOKE             _IOW('E', 0x91, int)                    /* Revoke device access */163 164 /**165  * EVIOCGMASK - Retrieve current event mask166  *167  * This ioctl allows user to retrieve the current event mask for specific168  * event type. The argument must be of type "struct input_mask" and169  * specifies the event type to query, the address of the receive buffer and170  * the size of the receive buffer.171  *172  * The event mask is a per-client mask that specifies which events are173  * forwarded to the client. Each event code is represented by a single bit174  * in the event mask. If the bit is set, the event is passed to the client175  * normally. Otherwise, the event is filtered and will never be queued on176  * the client's receive buffer.177  *178  * Event masks do not affect global state of the input device. They only179  * affect the file descriptor they are applied to.180  *181  * The default event mask for a client has all bits set, i.e. all events182  * are forwarded to the client. If the kernel is queried for an unknown183  * event type or if the receive buffer is larger than the number of184  * event codes known to the kernel, the kernel returns all zeroes for those185  * codes.186  *187  * At maximum, codes_size bytes are copied.188  *189  * This ioctl may fail with ENODEV in case the file is revoked, EFAULT190  * if the receive-buffer points to invalid memory, or EINVAL if the kernel191  * does not implement the ioctl.192  */193 #define EVIOCGMASK              _IOR('E', 0x92, struct input_mask)      /* Get event-masks */194 195 /**196  * EVIOCSMASK - Set event mask197  *198  * This ioctl is the counterpart to EVIOCGMASK. Instead of receiving the199  * current event mask, this changes the client's event mask for a specific200  * type.  See EVIOCGMASK for a description of event-masks and the201  * argument-type.202  *203  * This ioctl provides full forward compatibility. If the passed event type204  * is unknown to the kernel, or if the number of event codes specified in205  * the mask is bigger than what is known to the kernel, the ioctl is still206  * accepted and applied. However, any unknown codes are left untouched and207  * stay cleared. That means, the kernel always filters unknown codes208  * regardless of what the client requests.  If the new mask doesn't cover209  * all known event-codes, all remaining codes are automatically cleared and210  * thus filtered.211  *212  * This ioctl may fail with ENODEV in case the file is revoked. EFAULT is213  * returned if the receive-buffer points to invalid memory. EINVAL is returned214  * if the kernel does not implement the ioctl.215  */216 #define EVIOCSMASK              _IOW('E', 0x93, struct input_mask)      /* Set event-masks */217 218 #define EVIOCSCLOCKID           _IOW('E', 0xa0, int)                    /* Set clockid to be used for timestamps */219 220 /*221  * IDs.222  */223 224 #define ID_BUS                  0225 #define ID_VENDOR               1226 #define ID_PRODUCT              2227 #define ID_VERSION              3228 229 #define BUS_PCI                 0x01230 #define BUS_ISAPNP              0x02231 #define BUS_USB                 0x03232 #define BUS_HIL                 0x04233 #define BUS_BLUETOOTH           0x05234 #define BUS_VIRTUAL             0x06235 236 #define BUS_ISA                 0x10237 #define BUS_I8042               0x11238 #define BUS_XTKBD               0x12239 #define BUS_RS232               0x13240 #define BUS_GAMEPORT            0x14241 #define BUS_PARPORT             0x15242 #define BUS_AMIGA               0x16243 #define BUS_ADB                 0x17244 #define BUS_I2C                 0x18245 #define BUS_HOST                0x19246 #define BUS_GSC                 0x1A247 #define BUS_ATARI               0x1B248 #define BUS_SPI                 0x1C249 250 /*251  * MT_TOOL types252  */253 #define MT_TOOL_FINGER          0254 #define MT_TOOL_PEN             1255 #define MT_TOOL_PALM            2256 #define MT_TOOL_MAX             2257 258 /*259  * Values describing the status of a force-feedback effect260  */261 #define FF_STATUS_STOPPED       0x00262 #define FF_STATUS_PLAYING       0x01263 #define FF_STATUS_MAX           0x01264 265 /*266  * Structures used in ioctls to upload effects to a device267  * They are pieces of a bigger structure (called ff_effect)268  */269 270 /*271  * All duration values are expressed in ms. Values above 32767 ms (0x7fff)272  * should not be used and have unspecified results.273  */274 275 /**276  * struct ff_replay - defines scheduling of the force-feedback effect277  * @length: duration of the effect278  * @delay: delay before effect should start playing279  */280 struct ff_replay {281         __u16 length;282         __u16 delay;283 };284 285 /**286  * struct ff_trigger - defines what triggers the force-feedback effect287  * @button: number of the button triggering the effect288  * @interval: controls how soon the effect can be re-triggered289  */290 struct ff_trigger {291         __u16 button;292         __u16 interval;293 };294 295 /**296  * struct ff_envelope - generic force-feedback effect envelope297  * @attack_length: duration of the attack (ms)298  * @attack_level: level at the beginning of the attack299  * @fade_length: duration of fade (ms)300  * @fade_level: level at the end of fade301  *302  * The @attack_level and @fade_level are absolute values; when applying303  * envelope force-feedback core will convert to positive/negative304  * value based on polarity of the default level of the effect.305  * Valid range for the attack and fade levels is 0x0000 - 0x7fff306  */307 struct ff_envelope {308         __u16 attack_length;309         __u16 attack_level;310         __u16 fade_length;311         __u16 fade_level;312 };313 314 /**315  * struct ff_constant_effect - defines parameters of a constant force-feedback effect316  * @level: strength of the effect; may be negative317  * @envelope: envelope data318  */319 struct ff_constant_effect {320         __s16 level;321         struct ff_envelope envelope;322 };323 324 /**325  * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect326  * @start_level: beginning strength of the effect; may be negative327  * @end_level: final strength of the effect; may be negative328  * @envelope: envelope data329  */330 struct ff_ramp_effect {331         __s16 start_level;332         __s16 end_level;333         struct ff_envelope envelope;334 };335 336 /**337  * struct ff_condition_effect - defines a spring or friction force-feedback effect338  * @right_saturation: maximum level when joystick moved all way to the right339  * @left_saturation: same for the left side340  * @right_coeff: controls how fast the force grows when the joystick moves341  *      to the right342  * @left_coeff: same for the left side343  * @deadband: size of the dead zone, where no force is produced344  * @center: position of the dead zone345  */346 struct ff_condition_effect {347         __u16 right_saturation;348         __u16 left_saturation;349 350         __s16 right_coeff;351         __s16 left_coeff;352 353         __u16 deadband;354         __s16 center;355 };356 357 /**358  * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect359  * @waveform: kind of the effect (wave)360  * @period: period of the wave (ms)361  * @magnitude: peak value362  * @offset: mean value of the wave (roughly)363  * @phase: 'horizontal' shift364  * @envelope: envelope data365  * @custom_len: number of samples (FF_CUSTOM only)366  * @custom_data: buffer of samples (FF_CUSTOM only)367  *368  * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,369  * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined370  * for the time being as no driver supports it yet.371  *372  * Note: the data pointed by custom_data is copied by the driver.373  * You can therefore dispose of the memory after the upload/update.374  */375 struct ff_periodic_effect {376         __u16 waveform;377         __u16 period;378         __s16 magnitude;379         __s16 offset;380         __u16 phase;381 382         struct ff_envelope envelope;383 384         __u32 custom_len;385         __s16 __user *custom_data;386 };387 388 /**389  * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect390  * @strong_magnitude: magnitude of the heavy motor391  * @weak_magnitude: magnitude of the light one392  *393  * Some rumble pads have two motors of different weight. Strong_magnitude394  * represents the magnitude of the vibration generated by the heavy one.395  */396 struct ff_rumble_effect {397         __u16 strong_magnitude;398         __u16 weak_magnitude;399 };400 401 /**402  * struct ff_effect - defines force feedback effect403  * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,404  *      FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)405  * @id: an unique id assigned to an effect406  * @direction: direction of the effect407  * @trigger: trigger conditions (struct ff_trigger)408  * @replay: scheduling of the effect (struct ff_replay)409  * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,410  *      ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further411  *      defining effect parameters412  *413  * This structure is sent through ioctl from the application to the driver.414  * To create a new effect application should set its @id to -1; the kernel415  * will return assigned @id which can later be used to update or delete416  * this effect.417  *418  * Direction of the effect is encoded as follows:419  *      0 deg -> 0x0000 (down)420  *      90 deg -> 0x4000 (left)421  *      180 deg -> 0x8000 (up)422  *      270 deg -> 0xC000 (right)423  */424 struct ff_effect {425         __u16 type;426         __s16 id;427         __u16 direction;428         struct ff_trigger trigger;429         struct ff_replay replay;430 431         union {432                 struct ff_constant_effect constant;433                 struct ff_ramp_effect ramp;434                 struct ff_periodic_effect periodic;435                 struct ff_condition_effect condition[2]; /* One for each axis */436                 struct ff_rumble_effect rumble;437         } u;438 };439 440 /*441  * Force feedback effect types442  */443 444 #define FF_RUMBLE       0x50445 #define FF_PERIODIC     0x51446 #define FF_CONSTANT     0x52447 #define FF_SPRING       0x53448 #define FF_FRICTION     0x54449 #define FF_DAMPER       0x55450 #define FF_INERTIA      0x56451 #define FF_RAMP         0x57452 453 #define FF_EFFECT_MIN   FF_RUMBLE454 #define FF_EFFECT_MAX   FF_RAMP455 456 /*457  * Force feedback periodic effect types458  */459 460 #define FF_SQUARE       0x58461 #define FF_TRIANGLE     0x59462 #define FF_SINE         0x5a463 #define FF_SAW_UP       0x5b464 #define FF_SAW_DOWN     0x5c465 #define FF_CUSTOM       0x5d466 467 #define FF_WAVEFORM_MIN FF_SQUARE468 #define FF_WAVEFORM_MAX FF_CUSTOM469 470 /*471  * Set ff device properties472  */473 474 #define FF_GAIN         0x60475 #define FF_AUTOCENTER   0x61476 477 /*478  * ff->playback(effect_id = FF_GAIN) is the first effect_id to479  * cause a collision with another ff method, in this case ff->set_gain().480  * Therefore the greatest safe value for effect_id is FF_GAIN - 1,481  * and thus the total number of effects should never exceed FF_GAIN.482  */483 #define FF_MAX_EFFECTS  FF_GAIN484 485 #define FF_MAX          0x7f486 #define FF_CNT          (FF_MAX+1)487 488 #endif /* _UAPI_INPUT_H */489 

This page was automatically generated byLXR 0.3.1 (source). • Linux is a registered trademark of Linus Torvalds • Contact us

0 0
原创粉丝点击