| lh | 9ed821d | 2023-04-07 01:36:19 -0700 | [diff] [blame] | 1 | #ifndef __HID_LOGITECH_DJ_H |
| 2 | #define __HID_LOGITECH_DJ_H |
| 3 | |
| 4 | /* |
| 5 | * HID driver for Logitech Unifying receivers |
| 6 | * |
| 7 | * Copyright (c) 2011 Logitech |
| 8 | */ |
| 9 | |
| 10 | /* |
| 11 | * This program is free software; you can redistribute it and/or modify |
| 12 | * it under the terms of the GNU General Public License version 2 as |
| 13 | * published by the Free Software Foundation. |
| 14 | * |
| 15 | * This program is distributed in the hope that it will be useful, |
| 16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 18 | * GNU General Public License for more details. |
| 19 | * |
| 20 | * You should have received a copy of the GNU General Public License |
| 21 | * along with this program; if not, write to the Free Software |
| 22 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 23 | * |
| 24 | */ |
| 25 | |
| 26 | #include <linux/kfifo.h> |
| 27 | |
| 28 | #define DJ_MAX_PAIRED_DEVICES 6 |
| 29 | #define DJ_MAX_NUMBER_NOTIFICATIONS 8 |
| 30 | #define DJ_RECEIVER_INDEX 0 |
| 31 | #define DJ_DEVICE_INDEX_MIN 1 |
| 32 | #define DJ_DEVICE_INDEX_MAX 6 |
| 33 | |
| 34 | #define DJREPORT_SHORT_LENGTH 15 |
| 35 | #define DJREPORT_LONG_LENGTH 32 |
| 36 | |
| 37 | #define REPORT_ID_DJ_SHORT 0x20 |
| 38 | #define REPORT_ID_DJ_LONG 0x21 |
| 39 | |
| 40 | #define REPORT_TYPE_RFREPORT_FIRST 0x01 |
| 41 | #define REPORT_TYPE_RFREPORT_LAST 0x1F |
| 42 | |
| 43 | /* Command Switch to DJ mode */ |
| 44 | #define REPORT_TYPE_CMD_SWITCH 0x80 |
| 45 | #define CMD_SWITCH_PARAM_DEVBITFIELD 0x00 |
| 46 | #define CMD_SWITCH_PARAM_TIMEOUT_SECONDS 0x01 |
| 47 | #define TIMEOUT_NO_KEEPALIVE 0x00 |
| 48 | |
| 49 | /* Command to Get the list of Paired devices */ |
| 50 | #define REPORT_TYPE_CMD_GET_PAIRED_DEVICES 0x81 |
| 51 | |
| 52 | /* Device Paired Notification */ |
| 53 | #define REPORT_TYPE_NOTIF_DEVICE_PAIRED 0x41 |
| 54 | #define SPFUNCTION_MORE_NOTIF_EXPECTED 0x01 |
| 55 | #define SPFUNCTION_DEVICE_LIST_EMPTY 0x02 |
| 56 | #define DEVICE_PAIRED_PARAM_SPFUNCTION 0x00 |
| 57 | #define DEVICE_PAIRED_PARAM_EQUAD_ID_LSB 0x01 |
| 58 | #define DEVICE_PAIRED_PARAM_EQUAD_ID_MSB 0x02 |
| 59 | #define DEVICE_PAIRED_RF_REPORT_TYPE 0x03 |
| 60 | |
| 61 | /* Device Un-Paired Notification */ |
| 62 | #define REPORT_TYPE_NOTIF_DEVICE_UNPAIRED 0x40 |
| 63 | |
| 64 | |
| 65 | /* Connection Status Notification */ |
| 66 | #define REPORT_TYPE_NOTIF_CONNECTION_STATUS 0x42 |
| 67 | #define CONNECTION_STATUS_PARAM_STATUS 0x00 |
| 68 | #define STATUS_LINKLOSS 0x01 |
| 69 | |
| 70 | /* Error Notification */ |
| 71 | #define REPORT_TYPE_NOTIF_ERROR 0x7F |
| 72 | #define NOTIF_ERROR_PARAM_ETYPE 0x00 |
| 73 | #define ETYPE_KEEPALIVE_TIMEOUT 0x01 |
| 74 | |
| 75 | /* supported DJ HID && RF report types */ |
| 76 | #define REPORT_TYPE_KEYBOARD 0x01 |
| 77 | #define REPORT_TYPE_MOUSE 0x02 |
| 78 | #define REPORT_TYPE_CONSUMER_CONTROL 0x03 |
| 79 | #define REPORT_TYPE_SYSTEM_CONTROL 0x04 |
| 80 | #define REPORT_TYPE_MEDIA_CENTER 0x08 |
| 81 | #define REPORT_TYPE_LEDS 0x0E |
| 82 | |
| 83 | /* RF Report types bitfield */ |
| 84 | #define STD_KEYBOARD 0x00000002 |
| 85 | #define STD_MOUSE 0x00000004 |
| 86 | #define MULTIMEDIA 0x00000008 |
| 87 | #define POWER_KEYS 0x00000010 |
| 88 | #define MEDIA_CENTER 0x00000100 |
| 89 | #define KBD_LEDS 0x00004000 |
| 90 | |
| 91 | struct dj_report { |
| 92 | u8 report_id; |
| 93 | u8 device_index; |
| 94 | u8 report_type; |
| 95 | u8 report_params[DJREPORT_SHORT_LENGTH - 3]; |
| 96 | }; |
| 97 | |
| 98 | struct dj_receiver_dev { |
| 99 | struct hid_device *hdev; |
| 100 | struct dj_device *paired_dj_devices[DJ_MAX_PAIRED_DEVICES + |
| 101 | DJ_DEVICE_INDEX_MIN]; |
| 102 | struct work_struct work; |
| 103 | struct kfifo notif_fifo; |
| 104 | spinlock_t lock; |
| 105 | bool querying_devices; |
| 106 | }; |
| 107 | |
| 108 | struct dj_device { |
| 109 | struct hid_device *hdev; |
| 110 | struct dj_receiver_dev *dj_receiver_dev; |
| 111 | u32 reports_supported; |
| 112 | u8 device_index; |
| 113 | }; |
| 114 | |
| 115 | /** |
| 116 | * is_dj_device - know if the given dj_device is not the receiver. |
| 117 | * @dj_dev: the dj device to test |
| 118 | * |
| 119 | * This macro tests if a struct dj_device pointer is a device created |
| 120 | * by the bus enumarator. |
| 121 | */ |
| 122 | #define is_dj_device(dj_dev) \ |
| 123 | (&(dj_dev)->dj_receiver_dev->hdev->dev == (dj_dev)->hdev->dev.parent) |
| 124 | |
| 125 | #endif |