mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-23 20:53:53 +08:00
3d5afd324a
Usbhid structure is allocated on start invoked only from probe of some driver. When there is no driver, the structure is null and causes null-dereference oopses. Fix it by allocating the structure on probe and disconnect of the device itself. Also make sure we won't race between start and resume or stop and suspend respectively. References: http://bugzilla.kernel.org/show_bug.cgi?id=11827 Signed-off-by: Jiri Slaby <jirislaby@gmail.com> Cc: Johannes Berg <johannes@sipsolutions.net> Cc: Andreas Schwab <schwab@suse.de> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
812 lines
23 KiB
C
812 lines
23 KiB
C
#ifndef __HID_H
|
|
#define __HID_H
|
|
|
|
/*
|
|
* Copyright (c) 1999 Andreas Gal
|
|
* Copyright (c) 2000-2001 Vojtech Pavlik
|
|
* Copyright (c) 2006-2007 Jiri Kosina
|
|
*/
|
|
|
|
/*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
*
|
|
* Should you need to contact me, the author, you can do so either by
|
|
* e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
|
|
* Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
|
|
*/
|
|
|
|
/*
|
|
* USB HID (Human Interface Device) interface class code
|
|
*/
|
|
|
|
#define USB_INTERFACE_CLASS_HID 3
|
|
|
|
/*
|
|
* USB HID interface subclass and protocol codes
|
|
*/
|
|
|
|
#define USB_INTERFACE_SUBCLASS_BOOT 1
|
|
#define USB_INTERFACE_PROTOCOL_KEYBOARD 1
|
|
#define USB_INTERFACE_PROTOCOL_MOUSE 2
|
|
|
|
/*
|
|
* HID class requests
|
|
*/
|
|
|
|
#define HID_REQ_GET_REPORT 0x01
|
|
#define HID_REQ_GET_IDLE 0x02
|
|
#define HID_REQ_GET_PROTOCOL 0x03
|
|
#define HID_REQ_SET_REPORT 0x09
|
|
#define HID_REQ_SET_IDLE 0x0A
|
|
#define HID_REQ_SET_PROTOCOL 0x0B
|
|
|
|
/*
|
|
* HID class descriptor types
|
|
*/
|
|
|
|
#define HID_DT_HID (USB_TYPE_CLASS | 0x01)
|
|
#define HID_DT_REPORT (USB_TYPE_CLASS | 0x02)
|
|
#define HID_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
|
|
|
|
#define HID_MAX_DESCRIPTOR_SIZE 4096
|
|
|
|
#ifdef __KERNEL__
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/slab.h>
|
|
#include <linux/list.h>
|
|
#include <linux/mod_devicetable.h> /* hid_device_id */
|
|
#include <linux/timer.h>
|
|
#include <linux/workqueue.h>
|
|
#include <linux/input.h>
|
|
|
|
/*
|
|
* We parse each description item into this structure. Short items data
|
|
* values are expanded to 32-bit signed int, long items contain a pointer
|
|
* into the data area.
|
|
*/
|
|
|
|
struct hid_item {
|
|
unsigned format;
|
|
__u8 size;
|
|
__u8 type;
|
|
__u8 tag;
|
|
union {
|
|
__u8 u8;
|
|
__s8 s8;
|
|
__u16 u16;
|
|
__s16 s16;
|
|
__u32 u32;
|
|
__s32 s32;
|
|
__u8 *longdata;
|
|
} data;
|
|
};
|
|
|
|
/*
|
|
* HID report item format
|
|
*/
|
|
|
|
#define HID_ITEM_FORMAT_SHORT 0
|
|
#define HID_ITEM_FORMAT_LONG 1
|
|
|
|
/*
|
|
* Special tag indicating long items
|
|
*/
|
|
|
|
#define HID_ITEM_TAG_LONG 15
|
|
|
|
/*
|
|
* HID report descriptor item type (prefix bit 2,3)
|
|
*/
|
|
|
|
#define HID_ITEM_TYPE_MAIN 0
|
|
#define HID_ITEM_TYPE_GLOBAL 1
|
|
#define HID_ITEM_TYPE_LOCAL 2
|
|
#define HID_ITEM_TYPE_RESERVED 3
|
|
|
|
/*
|
|
* HID report descriptor main item tags
|
|
*/
|
|
|
|
#define HID_MAIN_ITEM_TAG_INPUT 8
|
|
#define HID_MAIN_ITEM_TAG_OUTPUT 9
|
|
#define HID_MAIN_ITEM_TAG_FEATURE 11
|
|
#define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
|
|
#define HID_MAIN_ITEM_TAG_END_COLLECTION 12
|
|
|
|
/*
|
|
* HID report descriptor main item contents
|
|
*/
|
|
|
|
#define HID_MAIN_ITEM_CONSTANT 0x001
|
|
#define HID_MAIN_ITEM_VARIABLE 0x002
|
|
#define HID_MAIN_ITEM_RELATIVE 0x004
|
|
#define HID_MAIN_ITEM_WRAP 0x008
|
|
#define HID_MAIN_ITEM_NONLINEAR 0x010
|
|
#define HID_MAIN_ITEM_NO_PREFERRED 0x020
|
|
#define HID_MAIN_ITEM_NULL_STATE 0x040
|
|
#define HID_MAIN_ITEM_VOLATILE 0x080
|
|
#define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
|
|
|
|
/*
|
|
* HID report descriptor collection item types
|
|
*/
|
|
|
|
#define HID_COLLECTION_PHYSICAL 0
|
|
#define HID_COLLECTION_APPLICATION 1
|
|
#define HID_COLLECTION_LOGICAL 2
|
|
|
|
/*
|
|
* HID report descriptor global item tags
|
|
*/
|
|
|
|
#define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
|
|
#define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
|
|
#define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
|
|
#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
|
|
#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
|
|
#define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
|
|
#define HID_GLOBAL_ITEM_TAG_UNIT 6
|
|
#define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
|
|
#define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
|
|
#define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
|
|
#define HID_GLOBAL_ITEM_TAG_PUSH 10
|
|
#define HID_GLOBAL_ITEM_TAG_POP 11
|
|
|
|
/*
|
|
* HID report descriptor local item tags
|
|
*/
|
|
|
|
#define HID_LOCAL_ITEM_TAG_USAGE 0
|
|
#define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
|
|
#define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
|
|
#define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
|
|
#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
|
|
#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
|
|
#define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
|
|
#define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
|
|
#define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
|
|
#define HID_LOCAL_ITEM_TAG_DELIMITER 10
|
|
|
|
/*
|
|
* HID usage tables
|
|
*/
|
|
|
|
#define HID_USAGE_PAGE 0xffff0000
|
|
|
|
#define HID_UP_UNDEFINED 0x00000000
|
|
#define HID_UP_GENDESK 0x00010000
|
|
#define HID_UP_SIMULATION 0x00020000
|
|
#define HID_UP_KEYBOARD 0x00070000
|
|
#define HID_UP_LED 0x00080000
|
|
#define HID_UP_BUTTON 0x00090000
|
|
#define HID_UP_ORDINAL 0x000a0000
|
|
#define HID_UP_CONSUMER 0x000c0000
|
|
#define HID_UP_DIGITIZER 0x000d0000
|
|
#define HID_UP_PID 0x000f0000
|
|
#define HID_UP_HPVENDOR 0xff7f0000
|
|
#define HID_UP_MSVENDOR 0xff000000
|
|
#define HID_UP_CUSTOM 0x00ff0000
|
|
#define HID_UP_LOGIVENDOR 0xffbc0000
|
|
|
|
#define HID_USAGE 0x0000ffff
|
|
|
|
#define HID_GD_POINTER 0x00010001
|
|
#define HID_GD_MOUSE 0x00010002
|
|
#define HID_GD_JOYSTICK 0x00010004
|
|
#define HID_GD_GAMEPAD 0x00010005
|
|
#define HID_GD_KEYBOARD 0x00010006
|
|
#define HID_GD_KEYPAD 0x00010007
|
|
#define HID_GD_MULTIAXIS 0x00010008
|
|
#define HID_GD_X 0x00010030
|
|
#define HID_GD_Y 0x00010031
|
|
#define HID_GD_Z 0x00010032
|
|
#define HID_GD_RX 0x00010033
|
|
#define HID_GD_RY 0x00010034
|
|
#define HID_GD_RZ 0x00010035
|
|
#define HID_GD_SLIDER 0x00010036
|
|
#define HID_GD_DIAL 0x00010037
|
|
#define HID_GD_WHEEL 0x00010038
|
|
#define HID_GD_HATSWITCH 0x00010039
|
|
#define HID_GD_BUFFER 0x0001003a
|
|
#define HID_GD_BYTECOUNT 0x0001003b
|
|
#define HID_GD_MOTION 0x0001003c
|
|
#define HID_GD_START 0x0001003d
|
|
#define HID_GD_SELECT 0x0001003e
|
|
#define HID_GD_VX 0x00010040
|
|
#define HID_GD_VY 0x00010041
|
|
#define HID_GD_VZ 0x00010042
|
|
#define HID_GD_VBRX 0x00010043
|
|
#define HID_GD_VBRY 0x00010044
|
|
#define HID_GD_VBRZ 0x00010045
|
|
#define HID_GD_VNO 0x00010046
|
|
#define HID_GD_FEATURE 0x00010047
|
|
#define HID_GD_UP 0x00010090
|
|
#define HID_GD_DOWN 0x00010091
|
|
#define HID_GD_RIGHT 0x00010092
|
|
#define HID_GD_LEFT 0x00010093
|
|
|
|
/*
|
|
* HID report types --- Ouch! HID spec says 1 2 3!
|
|
*/
|
|
|
|
#define HID_INPUT_REPORT 0
|
|
#define HID_OUTPUT_REPORT 1
|
|
#define HID_FEATURE_REPORT 2
|
|
|
|
/*
|
|
* HID connect requests
|
|
*/
|
|
|
|
#define HID_CONNECT_HIDINPUT 0x01
|
|
#define HID_CONNECT_HIDINPUT_FORCE 0x02
|
|
#define HID_CONNECT_HIDRAW 0x04
|
|
#define HID_CONNECT_HIDDEV 0x08
|
|
#define HID_CONNECT_HIDDEV_FORCE 0x10
|
|
#define HID_CONNECT_FF 0x20
|
|
#define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
|
|
HID_CONNECT_HIDDEV|HID_CONNECT_FF)
|
|
|
|
/*
|
|
* HID device quirks.
|
|
*/
|
|
|
|
/*
|
|
* Increase this if you need to configure more HID quirks at module load time
|
|
*/
|
|
#define MAX_USBHID_BOOT_QUIRKS 4
|
|
|
|
#define HID_QUIRK_INVERT 0x00000001
|
|
#define HID_QUIRK_NOTOUCH 0x00000002
|
|
#define HID_QUIRK_NOGET 0x00000008
|
|
#define HID_QUIRK_BADPAD 0x00000020
|
|
#define HID_QUIRK_MULTI_INPUT 0x00000040
|
|
#define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000
|
|
#define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
|
|
|
|
/*
|
|
* This is the global environment of the parser. This information is
|
|
* persistent for main-items. The global environment can be saved and
|
|
* restored with PUSH/POP statements.
|
|
*/
|
|
|
|
struct hid_global {
|
|
unsigned usage_page;
|
|
__s32 logical_minimum;
|
|
__s32 logical_maximum;
|
|
__s32 physical_minimum;
|
|
__s32 physical_maximum;
|
|
__s32 unit_exponent;
|
|
unsigned unit;
|
|
unsigned report_id;
|
|
unsigned report_size;
|
|
unsigned report_count;
|
|
};
|
|
|
|
/*
|
|
* This is the local environment. It is persistent up the next main-item.
|
|
*/
|
|
|
|
#define HID_MAX_USAGES 12288
|
|
#define HID_DEFAULT_NUM_COLLECTIONS 16
|
|
|
|
struct hid_local {
|
|
unsigned usage[HID_MAX_USAGES]; /* usage array */
|
|
unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
|
|
unsigned usage_index;
|
|
unsigned usage_minimum;
|
|
unsigned delimiter_depth;
|
|
unsigned delimiter_branch;
|
|
};
|
|
|
|
/*
|
|
* This is the collection stack. We climb up the stack to determine
|
|
* application and function of each field.
|
|
*/
|
|
|
|
struct hid_collection {
|
|
unsigned type;
|
|
unsigned usage;
|
|
unsigned level;
|
|
};
|
|
|
|
struct hid_usage {
|
|
unsigned hid; /* hid usage code */
|
|
unsigned collection_index; /* index into collection array */
|
|
/* hidinput data */
|
|
__u16 code; /* input driver code */
|
|
__u8 type; /* input driver type */
|
|
__s8 hat_min; /* hat switch fun */
|
|
__s8 hat_max; /* ditto */
|
|
__s8 hat_dir; /* ditto */
|
|
};
|
|
|
|
struct hid_input;
|
|
|
|
struct hid_field {
|
|
unsigned physical; /* physical usage for this field */
|
|
unsigned logical; /* logical usage for this field */
|
|
unsigned application; /* application usage for this field */
|
|
struct hid_usage *usage; /* usage table for this function */
|
|
unsigned maxusage; /* maximum usage index */
|
|
unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
|
|
unsigned report_offset; /* bit offset in the report */
|
|
unsigned report_size; /* size of this field in the report */
|
|
unsigned report_count; /* number of this field in the report */
|
|
unsigned report_type; /* (input,output,feature) */
|
|
__s32 *value; /* last known value(s) */
|
|
__s32 logical_minimum;
|
|
__s32 logical_maximum;
|
|
__s32 physical_minimum;
|
|
__s32 physical_maximum;
|
|
__s32 unit_exponent;
|
|
unsigned unit;
|
|
struct hid_report *report; /* associated report */
|
|
unsigned index; /* index into report->field[] */
|
|
/* hidinput data */
|
|
struct hid_input *hidinput; /* associated input structure */
|
|
__u16 dpad; /* dpad input code */
|
|
};
|
|
|
|
#define HID_MAX_FIELDS 64
|
|
|
|
struct hid_report {
|
|
struct list_head list;
|
|
unsigned id; /* id of this report */
|
|
unsigned type; /* report type */
|
|
struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
|
|
unsigned maxfield; /* maximum valid field index */
|
|
unsigned size; /* size of the report (bits) */
|
|
struct hid_device *device; /* associated device */
|
|
};
|
|
|
|
struct hid_report_enum {
|
|
unsigned numbered;
|
|
struct list_head report_list;
|
|
struct hid_report *report_id_hash[256];
|
|
};
|
|
|
|
#define HID_REPORT_TYPES 3
|
|
|
|
#define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
|
|
#define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
|
|
#define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
|
|
#define HID_OUTPUT_FIFO_SIZE 64
|
|
|
|
struct hid_control_fifo {
|
|
unsigned char dir;
|
|
struct hid_report *report;
|
|
char *raw_report;
|
|
};
|
|
|
|
struct hid_output_fifo {
|
|
struct hid_report *report;
|
|
char *raw_report;
|
|
};
|
|
|
|
#define HID_CLAIMED_INPUT 1
|
|
#define HID_CLAIMED_HIDDEV 2
|
|
#define HID_CLAIMED_HIDRAW 4
|
|
|
|
#define HID_STAT_ADDED 1
|
|
#define HID_STAT_PARSED 2
|
|
|
|
#define HID_CTRL_RUNNING 1
|
|
#define HID_OUT_RUNNING 2
|
|
#define HID_IN_RUNNING 3
|
|
#define HID_RESET_PENDING 4
|
|
#define HID_SUSPENDED 5
|
|
#define HID_CLEAR_HALT 6
|
|
#define HID_DISCONNECTED 7
|
|
#define HID_STARTED 8
|
|
|
|
struct hid_input {
|
|
struct list_head list;
|
|
struct hid_report *report;
|
|
struct input_dev *input;
|
|
};
|
|
|
|
enum hid_type {
|
|
HID_TYPE_OTHER = 0,
|
|
HID_TYPE_USBMOUSE
|
|
};
|
|
|
|
struct hid_driver;
|
|
struct hid_ll_driver;
|
|
|
|
struct hid_device { /* device report descriptor */
|
|
__u8 *rdesc;
|
|
unsigned rsize;
|
|
struct hid_collection *collection; /* List of HID collections */
|
|
unsigned collection_size; /* Number of allocated hid_collections */
|
|
unsigned maxcollection; /* Number of parsed collections */
|
|
unsigned maxapplication; /* Number of applications */
|
|
__u16 bus; /* BUS ID */
|
|
__u32 vendor; /* Vendor ID */
|
|
__u32 product; /* Product ID */
|
|
__u32 version; /* HID version */
|
|
enum hid_type type; /* device type (mouse, kbd, ...) */
|
|
unsigned country; /* HID country */
|
|
struct hid_report_enum report_enum[HID_REPORT_TYPES];
|
|
|
|
struct device dev; /* device */
|
|
struct hid_driver *driver;
|
|
struct hid_ll_driver *ll_driver;
|
|
|
|
unsigned int status; /* see STAT flags above */
|
|
unsigned claimed; /* Claimed by hidinput, hiddev? */
|
|
unsigned quirks; /* Various quirks the device can pull on us */
|
|
|
|
struct list_head inputs; /* The list of inputs */
|
|
void *hiddev; /* The hiddev structure */
|
|
void *hidraw;
|
|
int minor; /* Hiddev minor number */
|
|
|
|
int open; /* is the device open by anyone? */
|
|
char name[128]; /* Device name */
|
|
char phys[64]; /* Device physical location */
|
|
char uniq[64]; /* Device unique identifier (serial #) */
|
|
|
|
void *driver_data;
|
|
|
|
/* temporary hid_ff handling (until moved to the drivers) */
|
|
int (*ff_init)(struct hid_device *);
|
|
|
|
/* hiddev event handler */
|
|
int (*hiddev_connect)(struct hid_device *, unsigned int);
|
|
void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
|
|
struct hid_usage *, __s32);
|
|
void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
|
|
|
|
/* handler for raw output data, used by hidraw */
|
|
int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t);
|
|
};
|
|
|
|
static inline void *hid_get_drvdata(struct hid_device *hdev)
|
|
{
|
|
return dev_get_drvdata(&hdev->dev);
|
|
}
|
|
|
|
static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
|
|
{
|
|
dev_set_drvdata(&hdev->dev, data);
|
|
}
|
|
|
|
#define HID_GLOBAL_STACK_SIZE 4
|
|
#define HID_COLLECTION_STACK_SIZE 4
|
|
|
|
struct hid_parser {
|
|
struct hid_global global;
|
|
struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
|
|
unsigned global_stack_ptr;
|
|
struct hid_local local;
|
|
unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
|
|
unsigned collection_stack_ptr;
|
|
struct hid_device *device;
|
|
};
|
|
|
|
struct hid_class_descriptor {
|
|
__u8 bDescriptorType;
|
|
__le16 wDescriptorLength;
|
|
} __attribute__ ((packed));
|
|
|
|
struct hid_descriptor {
|
|
__u8 bLength;
|
|
__u8 bDescriptorType;
|
|
__le16 bcdHID;
|
|
__u8 bCountryCode;
|
|
__u8 bNumDescriptors;
|
|
|
|
struct hid_class_descriptor desc[1];
|
|
} __attribute__ ((packed));
|
|
|
|
#define HID_DEVICE(b, ven, prod) \
|
|
.bus = (b), \
|
|
.vendor = (ven), .product = (prod)
|
|
|
|
#define HID_USB_DEVICE(ven, prod) HID_DEVICE(BUS_USB, ven, prod)
|
|
#define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
|
|
|
|
#define HID_REPORT_ID(rep) \
|
|
.report_type = (rep)
|
|
#define HID_USAGE_ID(uhid, utype, ucode) \
|
|
.usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
|
|
/* we don't want to catch types and codes equal to 0 */
|
|
#define HID_TERMINATOR (HID_ANY_ID - 1)
|
|
|
|
struct hid_report_id {
|
|
__u32 report_type;
|
|
};
|
|
struct hid_usage_id {
|
|
__u32 usage_hid;
|
|
__u32 usage_type;
|
|
__u32 usage_code;
|
|
};
|
|
|
|
/**
|
|
* struct hid_driver
|
|
* @name: driver name (e.g. "Footech_bar-wheel")
|
|
* @id_table: which devices is this driver for (must be non-NULL for probe
|
|
* to be called)
|
|
* @probe: new device inserted
|
|
* @remove: device removed (NULL if not a hot-plug capable driver)
|
|
* @report_table: on which reports to call raw_event (NULL means all)
|
|
* @raw_event: if report in report_table, this hook is called (NULL means nop)
|
|
* @usage_table: on which events to call event (NULL means all)
|
|
* @event: if usage in usage_table, this hook is called (NULL means nop)
|
|
* @report_fixup: called before report descriptor parsing (NULL means nop)
|
|
* @input_mapping: invoked on input registering before mapping an usage
|
|
* @input_mapped: invoked on input registering after mapping an usage
|
|
*
|
|
* raw_event and event should return 0 on no action performed, 1 when no
|
|
* further processing should be done and negative on error
|
|
*
|
|
* input_mapping shall return a negative value to completely ignore this usage
|
|
* (e.g. doubled or invalid usage), zero to continue with parsing of this
|
|
* usage by generic code (no special handling needed) or positive to skip
|
|
* generic parsing (needed special handling which was done in the hook already)
|
|
* input_mapped shall return negative to inform the layer that this usage
|
|
* should not be considered for further processing or zero to notify that
|
|
* no processing was performed and should be done in a generic manner
|
|
* Both these functions may be NULL which means the same behavior as returning
|
|
* zero from them.
|
|
*/
|
|
struct hid_driver {
|
|
char *name;
|
|
const struct hid_device_id *id_table;
|
|
|
|
int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
|
|
void (*remove)(struct hid_device *dev);
|
|
|
|
const struct hid_report_id *report_table;
|
|
int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
|
|
u8 *data, int size);
|
|
const struct hid_usage_id *usage_table;
|
|
int (*event)(struct hid_device *hdev, struct hid_field *field,
|
|
struct hid_usage *usage, __s32 value);
|
|
|
|
void (*report_fixup)(struct hid_device *hdev, __u8 *buf,
|
|
unsigned int size);
|
|
|
|
int (*input_mapping)(struct hid_device *hdev,
|
|
struct hid_input *hidinput, struct hid_field *field,
|
|
struct hid_usage *usage, unsigned long **bit, int *max);
|
|
int (*input_mapped)(struct hid_device *hdev,
|
|
struct hid_input *hidinput, struct hid_field *field,
|
|
struct hid_usage *usage, unsigned long **bit, int *max);
|
|
/* private: */
|
|
struct device_driver driver;
|
|
};
|
|
|
|
/**
|
|
* hid_ll_driver - low level driver callbacks
|
|
* @start: called on probe to start the device
|
|
* @stop: called on remove
|
|
* @open: called by input layer on open
|
|
* @close: called by input layer on close
|
|
* @hidinput_input_event: event input event (e.g. ff or leds)
|
|
* @parse: this method is called only once to parse the device data,
|
|
* shouldn't allocate anything to not leak memory
|
|
*/
|
|
struct hid_ll_driver {
|
|
int (*start)(struct hid_device *hdev);
|
|
void (*stop)(struct hid_device *hdev);
|
|
|
|
int (*open)(struct hid_device *hdev);
|
|
void (*close)(struct hid_device *hdev);
|
|
|
|
int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
|
|
unsigned int code, int value);
|
|
|
|
int (*parse)(struct hid_device *hdev);
|
|
};
|
|
|
|
/* Applications from HID Usage Tables 4/8/99 Version 1.1 */
|
|
/* We ignore a few input applications that are not widely used */
|
|
#define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || (a == 0x000d0002))
|
|
|
|
/* HID core API */
|
|
|
|
#ifdef CONFIG_HID_DEBUG
|
|
extern int hid_debug;
|
|
#endif
|
|
|
|
extern int hid_add_device(struct hid_device *);
|
|
extern void hid_destroy_device(struct hid_device *);
|
|
|
|
extern int __must_check __hid_register_driver(struct hid_driver *,
|
|
struct module *, const char *mod_name);
|
|
static inline int __must_check hid_register_driver(struct hid_driver *driver)
|
|
{
|
|
return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
|
|
}
|
|
extern void hid_unregister_driver(struct hid_driver *);
|
|
|
|
extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
|
|
extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
|
|
extern int hidinput_connect(struct hid_device *hid, unsigned int force);
|
|
extern void hidinput_disconnect(struct hid_device *);
|
|
|
|
int hid_set_field(struct hid_field *, unsigned, __s32);
|
|
int hid_input_report(struct hid_device *, int type, u8 *, int, int);
|
|
int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
|
|
void hid_output_report(struct hid_report *report, __u8 *data);
|
|
struct hid_device *hid_allocate_device(void);
|
|
int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
|
|
int hid_connect(struct hid_device *hid, unsigned int connect_mask);
|
|
|
|
/**
|
|
* hid_map_usage - map usage input bits
|
|
*
|
|
* @hidinput: hidinput which we are interested in
|
|
* @usage: usage to fill in
|
|
* @bit: pointer to input->{}bit (out parameter)
|
|
* @max: maximal valid usage->code to consider later (out parameter)
|
|
* @type: input event type (EV_KEY, EV_REL, ...)
|
|
* @c: code which corresponds to this usage and type
|
|
*/
|
|
static inline void hid_map_usage(struct hid_input *hidinput,
|
|
struct hid_usage *usage, unsigned long **bit, int *max,
|
|
__u8 type, __u16 c)
|
|
{
|
|
struct input_dev *input = hidinput->input;
|
|
|
|
usage->type = type;
|
|
usage->code = c;
|
|
|
|
switch (type) {
|
|
case EV_ABS:
|
|
*bit = input->absbit;
|
|
*max = ABS_MAX;
|
|
break;
|
|
case EV_REL:
|
|
*bit = input->relbit;
|
|
*max = REL_MAX;
|
|
break;
|
|
case EV_KEY:
|
|
*bit = input->keybit;
|
|
*max = KEY_MAX;
|
|
break;
|
|
case EV_LED:
|
|
*bit = input->ledbit;
|
|
*max = LED_MAX;
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* hid_map_usage_clear - map usage input bits and clear the input bit
|
|
*
|
|
* The same as hid_map_usage, except the @c bit is also cleared in supported
|
|
* bits (@bit).
|
|
*/
|
|
static inline void hid_map_usage_clear(struct hid_input *hidinput,
|
|
struct hid_usage *usage, unsigned long **bit, int *max,
|
|
__u8 type, __u16 c)
|
|
{
|
|
hid_map_usage(hidinput, usage, bit, max, type, c);
|
|
clear_bit(c, *bit);
|
|
}
|
|
|
|
/**
|
|
* hid_parse - parse HW reports
|
|
*
|
|
* @hdev: hid device
|
|
*
|
|
* Call this from probe after you set up the device (if needed). Your
|
|
* report_fixup will be called (if non-NULL) after reading raw report from
|
|
* device before passing it to hid layer for real parsing.
|
|
*/
|
|
static inline int __must_check hid_parse(struct hid_device *hdev)
|
|
{
|
|
int ret;
|
|
|
|
if (hdev->status & HID_STAT_PARSED)
|
|
return 0;
|
|
|
|
ret = hdev->ll_driver->parse(hdev);
|
|
if (!ret)
|
|
hdev->status |= HID_STAT_PARSED;
|
|
|
|
return ret;
|
|
}
|
|
|
|
/**
|
|
* hid_hw_start - start underlaying HW
|
|
*
|
|
* @hdev: hid device
|
|
* @connect_mask: which outputs to connect, see HID_CONNECT_*
|
|
*
|
|
* Call this in probe function *after* hid_parse. This will setup HW buffers
|
|
* and start the device (if not deffered to device open). hid_hw_stop must be
|
|
* called if this was successfull.
|
|
*/
|
|
static inline int __must_check hid_hw_start(struct hid_device *hdev,
|
|
unsigned int connect_mask)
|
|
{
|
|
int ret = hdev->ll_driver->start(hdev);
|
|
if (ret || !connect_mask)
|
|
return ret;
|
|
ret = hid_connect(hdev, connect_mask);
|
|
if (ret)
|
|
hdev->ll_driver->stop(hdev);
|
|
return ret;
|
|
}
|
|
|
|
/**
|
|
* hid_hw_stop - stop underlaying HW
|
|
*
|
|
* @hdev: hid device
|
|
*
|
|
* This is usually called from remove function or from probe when something
|
|
* failed and hid_hw_start was called already.
|
|
*/
|
|
static inline void hid_hw_stop(struct hid_device *hdev)
|
|
{
|
|
hdev->ll_driver->stop(hdev);
|
|
}
|
|
|
|
void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
|
|
int interrupt);
|
|
|
|
extern int hid_generic_init(void);
|
|
extern void hid_generic_exit(void);
|
|
|
|
/* HID quirks API */
|
|
u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
|
|
int usbhid_quirks_init(char **quirks_param);
|
|
void usbhid_quirks_exit(void);
|
|
void usbhid_set_leds(struct hid_device *hid);
|
|
|
|
#ifdef CONFIG_HID_PID
|
|
int hid_pidff_init(struct hid_device *hid);
|
|
#else
|
|
#define hid_pidff_init NULL
|
|
#endif
|
|
|
|
#ifdef CONFIG_HID_DEBUG
|
|
#define dbg_hid(format, arg...) if (hid_debug) \
|
|
printk(KERN_DEBUG "%s: " format ,\
|
|
__FILE__ , ## arg)
|
|
#define dbg_hid_line(format, arg...) if (hid_debug) \
|
|
printk(format, ## arg)
|
|
#else
|
|
static inline int __attribute__((format(printf, 1, 2)))
|
|
dbg_hid(const char *fmt, ...)
|
|
{
|
|
return 0;
|
|
}
|
|
#define dbg_hid_line dbg_hid
|
|
#endif /* HID_DEBUG */
|
|
|
|
#define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
|
|
__FILE__ , ## arg)
|
|
#endif /* HID_FF */
|
|
|
|
#ifdef CONFIG_HID_COMPAT
|
|
#define HID_COMPAT_LOAD_DRIVER(name) \
|
|
void hid_compat_##name(void) { } \
|
|
EXPORT_SYMBOL(hid_compat_##name)
|
|
#else
|
|
#define HID_COMPAT_LOAD_DRIVER(name)
|
|
#endif /* HID_COMPAT */
|
|
#define HID_COMPAT_CALL_DRIVER(name) do { \
|
|
extern void hid_compat_##name(void); \
|
|
hid_compat_##name(); \
|
|
} while (0)
|
|
|
|
#endif
|
|
|