/* SPDX-License-Identifier: GPL-2.0-only */ /* * ISHTP-HID glue driver's definitions. * * Copyright (c) 2014-2016, Intel Corporation. */ #ifndef ISHTP_HID__H #define ISHTP_HID__H /* The fixed ISH product and vendor id */ #define ISH_HID_VENDOR … #define ISH_HID_PRODUCT … #define ISH_HID_VERSION … #define CMD_MASK … #define IS_RESPONSE … /* Used to dump to Linux trace buffer, if enabled */ extern ishtp_print_log ishtp_hid_print_trace; #define hid_ishtp_trace(client, ...) … /* ISH HID message structure */ struct hostif_msg_hdr { … } __packed; struct hostif_msg { … } __packed; struct hostif_msg_to_sensor { … } __packed; struct device_info { … } __packed; struct ishtp_version { … } __packed; /* struct for ISHTP aggregated input data */ struct report_list { … } __packed; /* HOSTIF commands */ #define HOSTIF_HID_COMMAND_BASE … #define HOSTIF_GET_HID_DESCRIPTOR … #define HOSTIF_GET_REPORT_DESCRIPTOR … #define HOSTIF_GET_FEATURE_REPORT … #define HOSTIF_SET_FEATURE_REPORT … #define HOSTIF_GET_INPUT_REPORT … #define HOSTIF_PUBLISH_INPUT_REPORT … #define HOSTIF_PUBLISH_INPUT_REPORT_LIST … #define HOSTIF_DM_COMMAND_BASE … #define HOSTIF_DM_ENUM_DEVICES … #define HOSTIF_DM_ADD_DEVICE … #define MAX_HID_DEVICES … /** * struct ishtp_cl_data - Encapsulate per ISH TP HID Client * @enum_device_done: Enum devices response complete flag * @hid_descr_done: HID descriptor complete flag * @report_descr_done: Get report descriptor complete flag * @init_done: Init process completed successfully * @suspended: System is under suspend state or in progress * @num_hid_devices: Number of HID devices enumerated in this client * @cur_hid_dev: This keeps track of the device index for which * initialization and registration with HID core * in progress. * @hid_devices: Store vid/pid/devid for each enumerated HID device * @report_descr: Stores the raw report descriptors for each HID device * @report_descr_size: Report description of size of above repo_descr[] * @hid_sensor_hubs: Pointer to hid_device for all HID device, so that * when clients are removed, they can be freed * @hid_descr: Pointer to hid descriptor for each enumerated hid * device * @hid_descr_size: Size of each above report descriptor * @init_wait: Wait queue to wait during initialization, where the * client send message to ISH FW and wait for response * @ishtp_hid_wait: The wait for get report during wait callback from hid * core * @bad_recv_cnt: Running count of packets received with error * @multi_packet_cnt: Count of fragmented packet count * * This structure is used to store completion flags and per client data like * report description, number of HID devices etc. */ struct ishtp_cl_data { … }; /** * struct ishtp_hid_data - Per instance HID data * @index: Device index in the order of enumeration * @request_done: Get Feature/Input report complete flag * used during get/set request from hid core * @client_data: Link to the client instance * @hid_wait: Completion waitq * * @raw_get_req: Flag indicating raw get request ongoing * @raw_buf: raw request buffer filled on receiving get report * @raw_buf_size: raw request buffer size * Used to tie hid hid->driver data to driver client instance */ struct ishtp_hid_data { … }; /* Interface functions between HID LL driver and ISH TP client */ void hid_ishtp_set_feature(struct hid_device *hid, char *buf, unsigned int len, int report_id); void hid_ishtp_get_report(struct hid_device *hid, int report_id, int report_type); int ishtp_hid_probe(unsigned int cur_hid_dev, struct ishtp_cl_data *client_data); void ishtp_hid_remove(struct ishtp_cl_data *client_data); int ishtp_hid_link_ready_wait(struct ishtp_cl_data *client_data); void ishtp_hid_wakeup(struct hid_device *hid); #endif /* ISHTP_HID__H */