LCOV - code coverage report
Current view: top level - include/linux - input.h (source / functions) Hit Total Coverage
Test: combined.info Lines: 13 36 36.1 %
Date: 2022-03-28 13:20:08 Functions: 0 0 -
Branches: 2 54 3.7 %

           Branch data     Line data    Source code
       1                 :            : /* SPDX-License-Identifier: GPL-2.0-only */
       2                 :            : /*
       3                 :            :  * Copyright (c) 1999-2002 Vojtech Pavlik
       4                 :            :  */
       5                 :            : #ifndef _INPUT_H
       6                 :            : #define _INPUT_H
       7                 :            : 
       8                 :            : #include <linux/time.h>
       9                 :            : #include <linux/list.h>
      10                 :            : #include <uapi/linux/input.h>
      11                 :            : /* Implementation details, userspace should not care about these */
      12                 :            : #define ABS_MT_FIRST            ABS_MT_TOUCH_MAJOR
      13                 :            : #define ABS_MT_LAST             ABS_MT_TOOL_Y
      14                 :            : 
      15                 :            : /*
      16                 :            :  * In-kernel definitions.
      17                 :            :  */
      18                 :            : 
      19                 :            : #include <linux/device.h>
      20                 :            : #include <linux/fs.h>
      21                 :            : #include <linux/timer.h>
      22                 :            : #include <linux/mod_devicetable.h>
      23                 :            : 
      24                 :            : struct input_dev_poller;
      25                 :            : 
      26                 :            : /**
      27                 :            :  * struct input_value - input value representation
      28                 :            :  * @type: type of value (EV_KEY, EV_ABS, etc)
      29                 :            :  * @code: the value code
      30                 :            :  * @value: the value
      31                 :            :  */
      32                 :            : struct input_value {
      33                 :            :         __u16 type;
      34                 :            :         __u16 code;
      35                 :            :         __s32 value;
      36                 :            : };
      37                 :            : 
      38                 :            : enum input_clock_type {
      39                 :            :         INPUT_CLK_REAL = 0,
      40                 :            :         INPUT_CLK_MONO,
      41                 :            :         INPUT_CLK_BOOT,
      42                 :            :         INPUT_CLK_MAX
      43                 :            : };
      44                 :            : 
      45                 :            : /**
      46                 :            :  * struct input_dev - represents an input device
      47                 :            :  * @name: name of the device
      48                 :            :  * @phys: physical path to the device in the system hierarchy
      49                 :            :  * @uniq: unique identification code for the device (if device has it)
      50                 :            :  * @id: id of the device (struct input_id)
      51                 :            :  * @propbit: bitmap of device properties and quirks
      52                 :            :  * @evbit: bitmap of types of events supported by the device (EV_KEY,
      53                 :            :  *      EV_REL, etc.)
      54                 :            :  * @keybit: bitmap of keys/buttons this device has
      55                 :            :  * @relbit: bitmap of relative axes for the device
      56                 :            :  * @absbit: bitmap of absolute axes for the device
      57                 :            :  * @mscbit: bitmap of miscellaneous events supported by the device
      58                 :            :  * @ledbit: bitmap of leds present on the device
      59                 :            :  * @sndbit: bitmap of sound effects supported by the device
      60                 :            :  * @ffbit: bitmap of force feedback effects supported by the device
      61                 :            :  * @swbit: bitmap of switches present on the device
      62                 :            :  * @hint_events_per_packet: average number of events generated by the
      63                 :            :  *      device in a packet (between EV_SYN/SYN_REPORT events). Used by
      64                 :            :  *      event handlers to estimate size of the buffer needed to hold
      65                 :            :  *      events.
      66                 :            :  * @keycodemax: size of keycode table
      67                 :            :  * @keycodesize: size of elements in keycode table
      68                 :            :  * @keycode: map of scancodes to keycodes for this device
      69                 :            :  * @getkeycode: optional legacy method to retrieve current keymap.
      70                 :            :  * @setkeycode: optional method to alter current keymap, used to implement
      71                 :            :  *      sparse keymaps. If not supplied default mechanism will be used.
      72                 :            :  *      The method is being called while holding event_lock and thus must
      73                 :            :  *      not sleep
      74                 :            :  * @ff: force feedback structure associated with the device if device
      75                 :            :  *      supports force feedback effects
      76                 :            :  * @poller: poller structure associated with the device if device is
      77                 :            :  *      set up to use polling mode
      78                 :            :  * @repeat_key: stores key code of the last key pressed; used to implement
      79                 :            :  *      software autorepeat
      80                 :            :  * @timer: timer for software autorepeat
      81                 :            :  * @rep: current values for autorepeat parameters (delay, rate)
      82                 :            :  * @mt: pointer to multitouch state
      83                 :            :  * @absinfo: array of &struct input_absinfo elements holding information
      84                 :            :  *      about absolute axes (current value, min, max, flat, fuzz,
      85                 :            :  *      resolution)
      86                 :            :  * @key: reflects current state of device's keys/buttons
      87                 :            :  * @led: reflects current state of device's LEDs
      88                 :            :  * @snd: reflects current state of sound effects
      89                 :            :  * @sw: reflects current state of device's switches
      90                 :            :  * @open: this method is called when the very first user calls
      91                 :            :  *      input_open_device(). The driver must prepare the device
      92                 :            :  *      to start generating events (start polling thread,
      93                 :            :  *      request an IRQ, submit URB, etc.)
      94                 :            :  * @close: this method is called when the very last user calls
      95                 :            :  *      input_close_device().
      96                 :            :  * @flush: purges the device. Most commonly used to get rid of force
      97                 :            :  *      feedback effects loaded into the device when disconnecting
      98                 :            :  *      from it
      99                 :            :  * @event: event handler for events sent _to_ the device, like EV_LED
     100                 :            :  *      or EV_SND. The device is expected to carry out the requested
     101                 :            :  *      action (turn on a LED, play sound, etc.) The call is protected
     102                 :            :  *      by @event_lock and must not sleep
     103                 :            :  * @grab: input handle that currently has the device grabbed (via
     104                 :            :  *      EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
     105                 :            :  *      recipient for all input events coming from the device
     106                 :            :  * @event_lock: this spinlock is taken when input core receives
     107                 :            :  *      and processes a new event for the device (in input_event()).
     108                 :            :  *      Code that accesses and/or modifies parameters of a device
     109                 :            :  *      (such as keymap or absmin, absmax, absfuzz, etc.) after device
     110                 :            :  *      has been registered with input core must take this lock.
     111                 :            :  * @mutex: serializes calls to open(), close() and flush() methods
     112                 :            :  * @users: stores number of users (input handlers) that opened this
     113                 :            :  *      device. It is used by input_open_device() and input_close_device()
     114                 :            :  *      to make sure that dev->open() is only called when the first
     115                 :            :  *      user opens device and dev->close() is called when the very
     116                 :            :  *      last user closes the device
     117                 :            :  * @going_away: marks devices that are in a middle of unregistering and
     118                 :            :  *      causes input_open_device*() fail with -ENODEV.
     119                 :            :  * @dev: driver model's view of this device
     120                 :            :  * @h_list: list of input handles associated with the device. When
     121                 :            :  *      accessing the list dev->mutex must be held
     122                 :            :  * @node: used to place the device onto input_dev_list
     123                 :            :  * @num_vals: number of values queued in the current frame
     124                 :            :  * @max_vals: maximum number of values queued in a frame
     125                 :            :  * @vals: array of values queued in the current frame
     126                 :            :  * @devres_managed: indicates that devices is managed with devres framework
     127                 :            :  *      and needs not be explicitly unregistered or freed.
     128                 :            :  * @timestamp: storage for a timestamp set by input_set_timestamp called
     129                 :            :  *  by a driver
     130                 :            :  */
     131                 :            : struct input_dev {
     132                 :            :         const char *name;
     133                 :            :         const char *phys;
     134                 :            :         const char *uniq;
     135                 :            :         struct input_id id;
     136                 :            : 
     137                 :            :         unsigned long propbit[BITS_TO_LONGS(INPUT_PROP_CNT)];
     138                 :            : 
     139                 :            :         unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
     140                 :            :         unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
     141                 :            :         unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
     142                 :            :         unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
     143                 :            :         unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
     144                 :            :         unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
     145                 :            :         unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
     146                 :            :         unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
     147                 :            :         unsigned long swbit[BITS_TO_LONGS(SW_CNT)];
     148                 :            : 
     149                 :            :         unsigned int hint_events_per_packet;
     150                 :            : 
     151                 :            :         unsigned int keycodemax;
     152                 :            :         unsigned int keycodesize;
     153                 :            :         void *keycode;
     154                 :            : 
     155                 :            :         int (*setkeycode)(struct input_dev *dev,
     156                 :            :                           const struct input_keymap_entry *ke,
     157                 :            :                           unsigned int *old_keycode);
     158                 :            :         int (*getkeycode)(struct input_dev *dev,
     159                 :            :                           struct input_keymap_entry *ke);
     160                 :            : 
     161                 :            :         struct ff_device *ff;
     162                 :            : 
     163                 :            :         struct input_dev_poller *poller;
     164                 :            : 
     165                 :            :         unsigned int repeat_key;
     166                 :            :         struct timer_list timer;
     167                 :            : 
     168                 :            :         int rep[REP_CNT];
     169                 :            : 
     170                 :            :         struct input_mt *mt;
     171                 :            : 
     172                 :            :         struct input_absinfo *absinfo;
     173                 :            : 
     174                 :            :         unsigned long key[BITS_TO_LONGS(KEY_CNT)];
     175                 :            :         unsigned long led[BITS_TO_LONGS(LED_CNT)];
     176                 :            :         unsigned long snd[BITS_TO_LONGS(SND_CNT)];
     177                 :            :         unsigned long sw[BITS_TO_LONGS(SW_CNT)];
     178                 :            : 
     179                 :            :         int (*open)(struct input_dev *dev);
     180                 :            :         void (*close)(struct input_dev *dev);
     181                 :            :         int (*flush)(struct input_dev *dev, struct file *file);
     182                 :            :         int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
     183                 :            : 
     184                 :            :         struct input_handle __rcu *grab;
     185                 :            : 
     186                 :            :         spinlock_t event_lock;
     187                 :            :         struct mutex mutex;
     188                 :            : 
     189                 :            :         unsigned int users;
     190                 :            :         bool going_away;
     191                 :            : 
     192                 :            :         struct device dev;
     193                 :            : 
     194                 :            :         struct list_head        h_list;
     195                 :            :         struct list_head        node;
     196                 :            : 
     197                 :            :         unsigned int num_vals;
     198                 :            :         unsigned int max_vals;
     199                 :            :         struct input_value *vals;
     200                 :            : 
     201                 :            :         bool devres_managed;
     202                 :            : 
     203                 :            :         ktime_t timestamp[INPUT_CLK_MAX];
     204                 :            : };
     205                 :            : #define to_input_dev(d) container_of(d, struct input_dev, dev)
     206                 :            : 
     207                 :            : /*
     208                 :            :  * Verify that we are in sync with input_device_id mod_devicetable.h #defines
     209                 :            :  */
     210                 :            : 
     211                 :            : #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
     212                 :            : #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
     213                 :            : #endif
     214                 :            : 
     215                 :            : #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
     216                 :            : #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
     217                 :            : #endif
     218                 :            : 
     219                 :            : #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
     220                 :            : #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
     221                 :            : #endif
     222                 :            : 
     223                 :            : #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
     224                 :            : #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
     225                 :            : #endif
     226                 :            : 
     227                 :            : #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
     228                 :            : #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
     229                 :            : #endif
     230                 :            : 
     231                 :            : #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
     232                 :            : #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
     233                 :            : #endif
     234                 :            : 
     235                 :            : #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
     236                 :            : #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
     237                 :            : #endif
     238                 :            : 
     239                 :            : #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
     240                 :            : #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
     241                 :            : #endif
     242                 :            : 
     243                 :            : #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
     244                 :            : #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
     245                 :            : #endif
     246                 :            : 
     247                 :            : #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
     248                 :            : #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
     249                 :            : #endif
     250                 :            : 
     251                 :            : #if INPUT_PROP_MAX != INPUT_DEVICE_ID_PROP_MAX
     252                 :            : #error "INPUT_PROP_MAX and INPUT_DEVICE_ID_PROP_MAX do not match"
     253                 :            : #endif
     254                 :            : 
     255                 :            : #define INPUT_DEVICE_ID_MATCH_DEVICE \
     256                 :            :         (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
     257                 :            : #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
     258                 :            :         (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
     259                 :            : 
     260                 :            : struct input_handle;
     261                 :            : 
     262                 :            : /**
     263                 :            :  * struct input_handler - implements one of interfaces for input devices
     264                 :            :  * @private: driver-specific data
     265                 :            :  * @event: event handler. This method is being called by input core with
     266                 :            :  *      interrupts disabled and dev->event_lock spinlock held and so
     267                 :            :  *      it may not sleep
     268                 :            :  * @events: event sequence handler. This method is being called by
     269                 :            :  *      input core with interrupts disabled and dev->event_lock
     270                 :            :  *      spinlock held and so it may not sleep
     271                 :            :  * @filter: similar to @event; separates normal event handlers from
     272                 :            :  *      "filters".
     273                 :            :  * @match: called after comparing device's id with handler's id_table
     274                 :            :  *      to perform fine-grained matching between device and handler
     275                 :            :  * @connect: called when attaching a handler to an input device
     276                 :            :  * @disconnect: disconnects a handler from input device
     277                 :            :  * @start: starts handler for given handle. This function is called by
     278                 :            :  *      input core right after connect() method and also when a process
     279                 :            :  *      that "grabbed" a device releases it
     280                 :            :  * @legacy_minors: set to %true by drivers using legacy minor ranges
     281                 :            :  * @minor: beginning of range of 32 legacy minors for devices this driver
     282                 :            :  *      can provide
     283                 :            :  * @name: name of the handler, to be shown in /proc/bus/input/handlers
     284                 :            :  * @id_table: pointer to a table of input_device_ids this driver can
     285                 :            :  *      handle
     286                 :            :  * @h_list: list of input handles associated with the handler
     287                 :            :  * @node: for placing the driver onto input_handler_list
     288                 :            :  *
     289                 :            :  * Input handlers attach to input devices and create input handles. There
     290                 :            :  * are likely several handlers attached to any given input device at the
     291                 :            :  * same time. All of them will get their copy of input event generated by
     292                 :            :  * the device.
     293                 :            :  *
     294                 :            :  * The very same structure is used to implement input filters. Input core
     295                 :            :  * allows filters to run first and will not pass event to regular handlers
     296                 :            :  * if any of the filters indicate that the event should be filtered (by
     297                 :            :  * returning %true from their filter() method).
     298                 :            :  *
     299                 :            :  * Note that input core serializes calls to connect() and disconnect()
     300                 :            :  * methods.
     301                 :            :  */
     302                 :            : struct input_handler {
     303                 :            : 
     304                 :            :         void *private;
     305                 :            : 
     306                 :            :         void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
     307                 :            :         void (*events)(struct input_handle *handle,
     308                 :            :                        const struct input_value *vals, unsigned int count);
     309                 :            :         bool (*filter)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
     310                 :            :         bool (*match)(struct input_handler *handler, struct input_dev *dev);
     311                 :            :         int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
     312                 :            :         void (*disconnect)(struct input_handle *handle);
     313                 :            :         void (*start)(struct input_handle *handle);
     314                 :            : 
     315                 :            :         bool legacy_minors;
     316                 :            :         int minor;
     317                 :            :         const char *name;
     318                 :            : 
     319                 :            :         const struct input_device_id *id_table;
     320                 :            : 
     321                 :            :         struct list_head        h_list;
     322                 :            :         struct list_head        node;
     323                 :            : };
     324                 :            : 
     325                 :            : /**
     326                 :            :  * struct input_handle - links input device with an input handler
     327                 :            :  * @private: handler-specific data
     328                 :            :  * @open: counter showing whether the handle is 'open', i.e. should deliver
     329                 :            :  *      events from its device
     330                 :            :  * @name: name given to the handle by handler that created it
     331                 :            :  * @dev: input device the handle is attached to
     332                 :            :  * @handler: handler that works with the device through this handle
     333                 :            :  * @d_node: used to put the handle on device's list of attached handles
     334                 :            :  * @h_node: used to put the handle on handler's list of handles from which
     335                 :            :  *      it gets events
     336                 :            :  */
     337                 :            : struct input_handle {
     338                 :            : 
     339                 :            :         void *private;
     340                 :            : 
     341                 :            :         int open;
     342                 :            :         const char *name;
     343                 :            : 
     344                 :            :         struct input_dev *dev;
     345                 :            :         struct input_handler *handler;
     346                 :            : 
     347                 :            :         struct list_head        d_node;
     348                 :            :         struct list_head        h_node;
     349                 :            : };
     350                 :            : 
     351                 :            : struct input_dev __must_check *input_allocate_device(void);
     352                 :            : struct input_dev __must_check *devm_input_allocate_device(struct device *);
     353                 :            : void input_free_device(struct input_dev *dev);
     354                 :            : 
     355                 :         90 : static inline struct input_dev *input_get_device(struct input_dev *dev)
     356                 :            : {
     357         [ +  - ]:         90 :         return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
     358                 :            : }
     359                 :            : 
     360                 :         30 : static inline void input_put_device(struct input_dev *dev)
     361                 :            : {
     362   [ #  #  #  # ]:          0 :         if (dev)
     363                 :         30 :                 put_device(&dev->dev);
     364                 :         30 : }
     365                 :            : 
     366                 :          0 : static inline void *input_get_drvdata(struct input_dev *dev)
     367                 :            : {
     368   [ #  #  #  #  :          0 :         return dev_get_drvdata(&dev->dev);
                   #  # ]
     369                 :            : }
     370                 :            : 
     371                 :         60 : static inline void input_set_drvdata(struct input_dev *dev, void *data)
     372                 :            : {
     373         [ +  - ]:         60 :         dev_set_drvdata(&dev->dev, data);
     374                 :            : }
     375                 :            : 
     376                 :            : int __must_check input_register_device(struct input_dev *);
     377                 :            : void input_unregister_device(struct input_dev *);
     378                 :            : 
     379                 :            : void input_reset_device(struct input_dev *);
     380                 :            : 
     381                 :            : int input_setup_polling(struct input_dev *dev,
     382                 :            :                         void (*poll_fn)(struct input_dev *dev));
     383                 :            : void input_set_poll_interval(struct input_dev *dev, unsigned int interval);
     384                 :            : void input_set_min_poll_interval(struct input_dev *dev, unsigned int interval);
     385                 :            : void input_set_max_poll_interval(struct input_dev *dev, unsigned int interval);
     386                 :            : int input_get_poll_interval(struct input_dev *dev);
     387                 :            : 
     388                 :            : int __must_check input_register_handler(struct input_handler *);
     389                 :            : void input_unregister_handler(struct input_handler *);
     390                 :            : 
     391                 :            : int __must_check input_get_new_minor(int legacy_base, unsigned int legacy_num,
     392                 :            :                                      bool allow_dynamic);
     393                 :            : void input_free_minor(unsigned int minor);
     394                 :            : 
     395                 :            : int input_handler_for_each_handle(struct input_handler *, void *data,
     396                 :            :                                   int (*fn)(struct input_handle *, void *));
     397                 :            : 
     398                 :            : int input_register_handle(struct input_handle *);
     399                 :            : void input_unregister_handle(struct input_handle *);
     400                 :            : 
     401                 :            : int input_grab_device(struct input_handle *);
     402                 :            : void input_release_device(struct input_handle *);
     403                 :            : 
     404                 :            : int input_open_device(struct input_handle *);
     405                 :            : void input_close_device(struct input_handle *);
     406                 :            : 
     407                 :            : int input_flush_device(struct input_handle *handle, struct file *file);
     408                 :            : 
     409                 :            : void input_set_timestamp(struct input_dev *dev, ktime_t timestamp);
     410                 :            : ktime_t *input_get_timestamp(struct input_dev *dev);
     411                 :            : 
     412                 :            : void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
     413                 :            : void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
     414                 :            : 
     415                 :         90 : static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
     416                 :            : {
     417                 :         30 :         input_event(dev, EV_KEY, code, !!value);
     418                 :          0 : }
     419                 :            : 
     420                 :         60 : static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
     421                 :            : {
     422                 :         30 :         input_event(dev, EV_REL, code, value);
     423                 :          0 : }
     424                 :            : 
     425                 :          0 : static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
     426                 :            : {
     427                 :          0 :         input_event(dev, EV_ABS, code, value);
     428                 :          0 : }
     429                 :            : 
     430                 :            : static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
     431                 :            : {
     432                 :            :         input_event(dev, EV_FF_STATUS, code, value);
     433                 :            : }
     434                 :            : 
     435                 :          0 : static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
     436                 :            : {
     437                 :          0 :         input_event(dev, EV_SW, code, !!value);
     438                 :          0 : }
     439                 :            : 
     440                 :         30 : static inline void input_sync(struct input_dev *dev)
     441                 :            : {
     442                 :         30 :         input_event(dev, EV_SYN, SYN_REPORT, 0);
     443                 :          0 : }
     444                 :            : 
     445                 :          0 : static inline void input_mt_sync(struct input_dev *dev)
     446                 :            : {
     447                 :          0 :         input_event(dev, EV_SYN, SYN_MT_REPORT, 0);
     448                 :          0 : }
     449                 :            : 
     450                 :            : void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
     451                 :            : 
     452                 :            : /**
     453                 :            :  * input_set_events_per_packet - tell handlers about the driver event rate
     454                 :            :  * @dev: the input device used by the driver
     455                 :            :  * @n_events: the average number of events between calls to input_sync()
     456                 :            :  *
     457                 :            :  * If the event rate sent from a device is unusually large, use this
     458                 :            :  * function to set the expected event rate. This will allow handlers
     459                 :            :  * to set up an appropriate buffer size for the event stream, in order
     460                 :            :  * to minimize information loss.
     461                 :            :  */
     462                 :          0 : static inline void input_set_events_per_packet(struct input_dev *dev, int n_events)
     463                 :            : {
     464                 :          0 :         dev->hint_events_per_packet = n_events;
     465                 :          0 : }
     466                 :            : 
     467                 :            : void input_alloc_absinfo(struct input_dev *dev);
     468                 :            : void input_set_abs_params(struct input_dev *dev, unsigned int axis,
     469                 :            :                           int min, int max, int fuzz, int flat);
     470                 :            : 
     471                 :            : #define INPUT_GENERATE_ABS_ACCESSORS(_suffix, _item)                    \
     472                 :            : static inline int input_abs_get_##_suffix(struct input_dev *dev,        \
     473                 :            :                                           unsigned int axis)            \
     474                 :            : {                                                                       \
     475                 :            :         return dev->absinfo ? dev->absinfo[axis]._item : 0;               \
     476                 :            : }                                                                       \
     477                 :            :                                                                         \
     478                 :            : static inline void input_abs_set_##_suffix(struct input_dev *dev,       \
     479                 :            :                                            unsigned int axis, int val)  \
     480                 :            : {                                                                       \
     481                 :            :         input_alloc_absinfo(dev);                                       \
     482                 :            :         if (dev->absinfo)                                            \
     483                 :            :                 dev->absinfo[axis]._item = val;                              \
     484                 :            : }
     485                 :            : 
     486   [ #  #  #  # ]:          0 : INPUT_GENERATE_ABS_ACCESSORS(val, value)
     487         [ #  # ]:          0 : INPUT_GENERATE_ABS_ACCESSORS(min, minimum)
     488   [ #  #  #  #  :          0 : INPUT_GENERATE_ABS_ACCESSORS(max, maximum)
          #  #  #  #  #  
                      # ]
     489   [ #  #  #  #  :          0 : INPUT_GENERATE_ABS_ACCESSORS(fuzz, fuzz)
                   #  # ]
     490                 :            : INPUT_GENERATE_ABS_ACCESSORS(flat, flat)
     491   [ #  #  #  #  :          0 : INPUT_GENERATE_ABS_ACCESSORS(res, resolution)
          #  #  #  #  #  
          #  #  #  #  #  
             #  #  #  # ]
     492                 :            : 
     493                 :            : int input_scancode_to_scalar(const struct input_keymap_entry *ke,
     494                 :            :                              unsigned int *scancode);
     495                 :            : 
     496                 :            : int input_get_keycode(struct input_dev *dev, struct input_keymap_entry *ke);
     497                 :            : int input_set_keycode(struct input_dev *dev,
     498                 :            :                       const struct input_keymap_entry *ke);
     499                 :            : 
     500                 :            : bool input_match_device_id(const struct input_dev *dev,
     501                 :            :                            const struct input_device_id *id);
     502                 :            : 
     503                 :            : void input_enable_softrepeat(struct input_dev *dev, int delay, int period);
     504                 :            : 
     505                 :            : extern struct class input_class;
     506                 :            : 
     507                 :            : /**
     508                 :            :  * struct ff_device - force-feedback part of an input device
     509                 :            :  * @upload: Called to upload an new effect into device
     510                 :            :  * @erase: Called to erase an effect from device
     511                 :            :  * @playback: Called to request device to start playing specified effect
     512                 :            :  * @set_gain: Called to set specified gain
     513                 :            :  * @set_autocenter: Called to auto-center device
     514                 :            :  * @destroy: called by input core when parent input device is being
     515                 :            :  *      destroyed
     516                 :            :  * @private: driver-specific data, will be freed automatically
     517                 :            :  * @ffbit: bitmap of force feedback capabilities truly supported by
     518                 :            :  *      device (not emulated like ones in input_dev->ffbit)
     519                 :            :  * @mutex: mutex for serializing access to the device
     520                 :            :  * @max_effects: maximum number of effects supported by device
     521                 :            :  * @effects: pointer to an array of effects currently loaded into device
     522                 :            :  * @effect_owners: array of effect owners; when file handle owning
     523                 :            :  *      an effect gets closed the effect is automatically erased
     524                 :            :  *
     525                 :            :  * Every force-feedback device must implement upload() and playback()
     526                 :            :  * methods; erase() is optional. set_gain() and set_autocenter() need
     527                 :            :  * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
     528                 :            :  * bits.
     529                 :            :  *
     530                 :            :  * Note that playback(), set_gain() and set_autocenter() are called with
     531                 :            :  * dev->event_lock spinlock held and interrupts off and thus may not
     532                 :            :  * sleep.
     533                 :            :  */
     534                 :            : struct ff_device {
     535                 :            :         int (*upload)(struct input_dev *dev, struct ff_effect *effect,
     536                 :            :                       struct ff_effect *old);
     537                 :            :         int (*erase)(struct input_dev *dev, int effect_id);
     538                 :            : 
     539                 :            :         int (*playback)(struct input_dev *dev, int effect_id, int value);
     540                 :            :         void (*set_gain)(struct input_dev *dev, u16 gain);
     541                 :            :         void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
     542                 :            : 
     543                 :            :         void (*destroy)(struct ff_device *);
     544                 :            : 
     545                 :            :         void *private;
     546                 :            : 
     547                 :            :         unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
     548                 :            : 
     549                 :            :         struct mutex mutex;
     550                 :            : 
     551                 :            :         int max_effects;
     552                 :            :         struct ff_effect *effects;
     553                 :            :         struct file *effect_owners[];
     554                 :            : };
     555                 :            : 
     556                 :            : int input_ff_create(struct input_dev *dev, unsigned int max_effects);
     557                 :            : void input_ff_destroy(struct input_dev *dev);
     558                 :            : 
     559                 :            : int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
     560                 :            : 
     561                 :            : int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
     562                 :            : int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
     563                 :            : int input_ff_flush(struct input_dev *dev, struct file *file);
     564                 :            : 
     565                 :            : int input_ff_create_memless(struct input_dev *dev, void *data,
     566                 :            :                 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
     567                 :            : 
     568                 :            : #endif

Generated by: LCOV version 1.14