]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/input/rmi4/rmi_f30.c
Merge remote-tracking branches 'asoc/topic/adsp', 'asoc/topic/ak4613', 'asoc/topic...
[mirror_ubuntu-bionic-kernel.git] / drivers / input / rmi4 / rmi_f30.c
CommitLineData
562b42d3
AD
1/*
2 * Copyright (c) 2012-2016 Synaptics Incorporated
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
9#include <linux/kernel.h>
10#include <linux/rmi.h>
11#include <linux/input.h>
12#include <linux/slab.h>
13#include "rmi_driver.h"
14
15#define RMI_F30_QUERY_SIZE 2
16
17/* Defs for Query 0 */
18#define RMI_F30_EXTENDED_PATTERNS 0x01
bf3e8502
DT
19#define RMI_F30_HAS_MAPPABLE_BUTTONS BIT(1)
20#define RMI_F30_HAS_LED BIT(2)
21#define RMI_F30_HAS_GPIO BIT(3)
22#define RMI_F30_HAS_HAPTIC BIT(4)
23#define RMI_F30_HAS_GPIO_DRV_CTL BIT(5)
24#define RMI_F30_HAS_MECH_MOUSE_BTNS BIT(6)
562b42d3
AD
25
26/* Defs for Query 1 */
27#define RMI_F30_GPIO_LED_COUNT 0x1F
28
29/* Defs for Control Registers */
30#define RMI_F30_CTRL_1_GPIO_DEBOUNCE 0x01
bf3e8502
DT
31#define RMI_F30_CTRL_1_HALT BIT(4)
32#define RMI_F30_CTRL_1_HALTED BIT(5)
562b42d3
AD
33#define RMI_F30_CTRL_10_NUM_MECH_MOUSE_BTNS 0x03
34
562b42d3 35#define RMI_F30_CTRL_MAX_REGS 32
bf3e8502 36#define RMI_F30_CTRL_MAX_BYTES DIV_ROUND_UP(RMI_F30_CTRL_MAX_REGS, 8)
562b42d3
AD
37#define RMI_F30_CTRL_MAX_REG_BLOCKS 11
38
39#define RMI_F30_CTRL_REGS_MAX_SIZE (RMI_F30_CTRL_MAX_BYTES \
40 + 1 \
41 + RMI_F30_CTRL_MAX_BYTES \
42 + RMI_F30_CTRL_MAX_BYTES \
43 + RMI_F30_CTRL_MAX_BYTES \
44 + 6 \
45 + RMI_F30_CTRL_MAX_REGS \
46 + RMI_F30_CTRL_MAX_REGS \
47 + RMI_F30_CTRL_MAX_BYTES \
48 + 1 \
49 + 1)
50
81dec809
BT
51#define TRACKSTICK_RANGE_START 3
52#define TRACKSTICK_RANGE_END 6
53
bf3e8502
DT
54struct rmi_f30_ctrl_data {
55 int address;
56 int length;
57 u8 *regs;
58};
59
562b42d3
AD
60struct f30_data {
61 /* Query Data */
62 bool has_extended_pattern;
63 bool has_mappable_buttons;
64 bool has_led;
65 bool has_gpio;
66 bool has_haptic;
67 bool has_gpio_driver_control;
68 bool has_mech_mouse_btns;
69 u8 gpioled_count;
70
71 u8 register_count;
72
73 /* Control Register Data */
74 struct rmi_f30_ctrl_data ctrl[RMI_F30_CTRL_MAX_REG_BLOCKS];
75 u8 ctrl_regs[RMI_F30_CTRL_REGS_MAX_SIZE];
76 u32 ctrl_regs_size;
77
78 u8 data_regs[RMI_F30_CTRL_MAX_BYTES];
79 u16 *gpioled_key_map;
80
81 struct input_dev *input;
81dec809
BT
82
83 struct rmi_function *f03;
84 bool trackstick_buttons;
562b42d3
AD
85};
86
87static int rmi_f30_read_control_parameters(struct rmi_function *fn,
88 struct f30_data *f30)
89{
bf3e8502 90 int error;
562b42d3 91
bf3e8502
DT
92 error = rmi_read_block(fn->rmi_dev, fn->fd.control_base_addr,
93 f30->ctrl_regs, f30->ctrl_regs_size);
562b42d3 94 if (error) {
bf3e8502
DT
95 dev_err(&fn->dev,
96 "%s: Could not read control registers at 0x%x: %d\n",
562b42d3
AD
97 __func__, fn->fd.control_base_addr, error);
98 return error;
99 }
100
101 return 0;
102}
103
bf3e8502
DT
104static void rmi_f30_report_button(struct rmi_function *fn,
105 struct f30_data *f30, unsigned int button)
106{
107 unsigned int reg_num = button >> 3;
108 unsigned int bit_num = button & 0x07;
81dec809 109 u16 key_code = f30->gpioled_key_map[button];
bf3e8502
DT
110 bool key_down = !(f30->data_regs[reg_num] & BIT(bit_num));
111
81dec809
BT
112 if (f30->trackstick_buttons &&
113 button >= TRACKSTICK_RANGE_START &&
114 button <= TRACKSTICK_RANGE_END) {
115 rmi_f03_overwrite_button(f30->f03, key_code, key_down);
116 } else {
117 rmi_dbg(RMI_DEBUG_FN, &fn->dev,
118 "%s: call input report key (0x%04x) value (0x%02x)",
119 __func__, key_code, key_down);
bf3e8502 120
81dec809
BT
121 input_report_key(f30->input, key_code, key_down);
122 }
bf3e8502
DT
123}
124
562b42d3
AD
125static int rmi_f30_attention(struct rmi_function *fn, unsigned long *irq_bits)
126{
127 struct f30_data *f30 = dev_get_drvdata(&fn->dev);
bf3e8502
DT
128 struct rmi_driver_data *drvdata = dev_get_drvdata(&fn->rmi_dev->dev);
129 int error;
562b42d3 130 int i;
562b42d3
AD
131
132 /* Read the gpi led data. */
ae9979c3
BT
133 if (drvdata->attn_data.data) {
134 if (drvdata->attn_data.size < f30->register_count) {
bf3e8502
DT
135 dev_warn(&fn->dev,
136 "F30 interrupted, but data is missing\n");
6d0dbeae
AD
137 return 0;
138 }
ae9979c3 139 memcpy(f30->data_regs, drvdata->attn_data.data,
562b42d3 140 f30->register_count);
ae9979c3
BT
141 drvdata->attn_data.data += f30->register_count;
142 drvdata->attn_data.size -= f30->register_count;
562b42d3 143 } else {
bf3e8502
DT
144 error = rmi_read_block(fn->rmi_dev, fn->fd.data_base_addr,
145 f30->data_regs, f30->register_count);
146 if (error) {
147 dev_err(&fn->dev,
148 "%s: Failed to read F30 data registers: %d\n",
149 __func__, error);
150 return error;
562b42d3
AD
151 }
152 }
153
81dec809 154 if (f30->has_gpio) {
bf3e8502
DT
155 for (i = 0; i < f30->gpioled_count; i++)
156 if (f30->gpioled_key_map[i] != KEY_RESERVED)
157 rmi_f30_report_button(fn, f30, i);
81dec809
BT
158 if (f30->trackstick_buttons)
159 rmi_f03_commit_buttons(f30->f03);
160 }
562b42d3 161
562b42d3
AD
162 return 0;
163}
164
165static int rmi_f30_config(struct rmi_function *fn)
166{
167 struct f30_data *f30 = dev_get_drvdata(&fn->dev);
168 struct rmi_driver *drv = fn->rmi_dev->driver;
169 const struct rmi_device_platform_data *pdata =
170 rmi_get_platform_data(fn->rmi_dev);
171 int error;
172
b6573da1
BT
173 /* can happen if f30_data.disable is set */
174 if (!f30)
175 return 0;
176
81dec809
BT
177 if (pdata->f30_data.trackstick_buttons) {
178 /* Try [re-]establish link to F03. */
179 f30->f03 = rmi_find_function(fn->rmi_dev, 0x03);
180 f30->trackstick_buttons = f30->f03 != NULL;
181 }
182
0a135b88 183 if (pdata->f30_data.disable) {
562b42d3
AD
184 drv->clear_irq_bits(fn->rmi_dev, fn->irq_mask);
185 } else {
186 /* Write Control Register values back to device */
187 error = rmi_write_block(fn->rmi_dev, fn->fd.control_base_addr,
188 f30->ctrl_regs, f30->ctrl_regs_size);
189 if (error) {
bf3e8502
DT
190 dev_err(&fn->dev,
191 "%s: Could not write control registers at 0x%x: %d\n",
562b42d3
AD
192 __func__, fn->fd.control_base_addr, error);
193 return error;
194 }
195
196 drv->set_irq_bits(fn->rmi_dev, fn->irq_mask);
197 }
bf3e8502 198
562b42d3
AD
199 return 0;
200}
201
bf3e8502
DT
202static void rmi_f30_set_ctrl_data(struct rmi_f30_ctrl_data *ctrl,
203 int *ctrl_addr, int len, u8 **reg)
562b42d3
AD
204{
205 ctrl->address = *ctrl_addr;
206 ctrl->length = len;
207 ctrl->regs = *reg;
208 *ctrl_addr += len;
209 *reg += len;
210}
211
bf3e8502 212static bool rmi_f30_is_valid_button(int button, struct rmi_f30_ctrl_data *ctrl)
562b42d3
AD
213{
214 int byte_position = button >> 3;
215 int bit_position = button & 0x07;
216
217 /*
218 * ctrl2 -> dir == 0 -> input mode
219 * ctrl3 -> data == 1 -> actual button
220 */
221 return !(ctrl[2].regs[byte_position] & BIT(bit_position)) &&
222 (ctrl[3].regs[byte_position] & BIT(bit_position));
223}
224
bf3e8502
DT
225static int rmi_f30_map_gpios(struct rmi_function *fn,
226 struct f30_data *f30)
562b42d3 227{
bf3e8502
DT
228 const struct rmi_device_platform_data *pdata =
229 rmi_get_platform_data(fn->rmi_dev);
230 struct input_dev *input = f30->input;
231 unsigned int button = BTN_LEFT;
81dec809
BT
232 unsigned int trackstick_button = BTN_LEFT;
233 bool button_mapped = false;
562b42d3 234 int i;
562b42d3 235
bf3e8502
DT
236 f30->gpioled_key_map = devm_kcalloc(&fn->dev,
237 f30->gpioled_count,
238 sizeof(f30->gpioled_key_map[0]),
239 GFP_KERNEL);
240 if (!f30->gpioled_key_map) {
241 dev_err(&fn->dev, "Failed to allocate gpioled map memory.\n");
562b42d3 242 return -ENOMEM;
bf3e8502 243 }
562b42d3 244
bf3e8502 245 for (i = 0; i < f30->gpioled_count; i++) {
81dec809
BT
246 if (!rmi_f30_is_valid_button(i, f30->ctrl))
247 continue;
248
249 if (pdata->f30_data.trackstick_buttons &&
250 i >= TRACKSTICK_RANGE_START && i < TRACKSTICK_RANGE_END) {
251 f30->gpioled_key_map[i] = trackstick_button++;
252 } else if (!pdata->f30_data.buttonpad || !button_mapped) {
bf3e8502
DT
253 f30->gpioled_key_map[i] = button;
254 input_set_capability(input, EV_KEY, button++);
81dec809 255 button_mapped = true;
bf3e8502
DT
256 }
257 }
258
259 input->keycode = f30->gpioled_key_map;
260 input->keycodesize = sizeof(f30->gpioled_key_map[0]);
261 input->keycodemax = f30->gpioled_count;
262
81dec809
BT
263 /*
264 * Buttonpad could be also inferred from f30->has_mech_mouse_btns,
522214d9
BT
265 * but I am not sure, so use only the pdata info and the number of
266 * mapped buttons.
81dec809 267 */
522214d9 268 if (pdata->f30_data.buttonpad || (button - BTN_LEFT == 1))
81dec809
BT
269 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
270
bf3e8502
DT
271 return 0;
272}
562b42d3 273
bf3e8502
DT
274static int rmi_f30_initialize(struct rmi_function *fn, struct f30_data *f30)
275{
276 u8 *ctrl_reg = f30->ctrl_regs;
277 int control_address = fn->fd.control_base_addr;
278 u8 buf[RMI_F30_QUERY_SIZE];
279 int error;
562b42d3 280
bf3e8502
DT
281 error = rmi_read_block(fn->rmi_dev, fn->fd.query_base_addr,
282 buf, RMI_F30_QUERY_SIZE);
283 if (error) {
284 dev_err(&fn->dev, "Failed to read query register\n");
285 return error;
562b42d3
AD
286 }
287
288 f30->has_extended_pattern = buf[0] & RMI_F30_EXTENDED_PATTERNS;
289 f30->has_mappable_buttons = buf[0] & RMI_F30_HAS_MAPPABLE_BUTTONS;
290 f30->has_led = buf[0] & RMI_F30_HAS_LED;
291 f30->has_gpio = buf[0] & RMI_F30_HAS_GPIO;
292 f30->has_haptic = buf[0] & RMI_F30_HAS_HAPTIC;
293 f30->has_gpio_driver_control = buf[0] & RMI_F30_HAS_GPIO_DRV_CTL;
294 f30->has_mech_mouse_btns = buf[0] & RMI_F30_HAS_MECH_MOUSE_BTNS;
295 f30->gpioled_count = buf[1] & RMI_F30_GPIO_LED_COUNT;
296
bf3e8502 297 f30->register_count = DIV_ROUND_UP(f30->gpioled_count, 8);
562b42d3
AD
298
299 if (f30->has_gpio && f30->has_led)
300 rmi_f30_set_ctrl_data(&f30->ctrl[0], &control_address,
bf3e8502 301 f30->register_count, &ctrl_reg);
562b42d3 302
bf3e8502
DT
303 rmi_f30_set_ctrl_data(&f30->ctrl[1], &control_address,
304 sizeof(u8), &ctrl_reg);
562b42d3
AD
305
306 if (f30->has_gpio) {
307 rmi_f30_set_ctrl_data(&f30->ctrl[2], &control_address,
bf3e8502 308 f30->register_count, &ctrl_reg);
562b42d3
AD
309
310 rmi_f30_set_ctrl_data(&f30->ctrl[3], &control_address,
bf3e8502 311 f30->register_count, &ctrl_reg);
562b42d3
AD
312 }
313
314 if (f30->has_led) {
562b42d3 315 rmi_f30_set_ctrl_data(&f30->ctrl[4], &control_address,
bf3e8502 316 f30->register_count, &ctrl_reg);
562b42d3
AD
317
318 rmi_f30_set_ctrl_data(&f30->ctrl[5], &control_address,
bf3e8502
DT
319 f30->has_extended_pattern ? 6 : 2,
320 &ctrl_reg);
562b42d3
AD
321 }
322
323 if (f30->has_led || f30->has_gpio_driver_control) {
324 /* control 6 uses a byte per gpio/led */
325 rmi_f30_set_ctrl_data(&f30->ctrl[6], &control_address,
bf3e8502 326 f30->gpioled_count, &ctrl_reg);
562b42d3
AD
327 }
328
329 if (f30->has_mappable_buttons) {
330 /* control 7 uses a byte per gpio/led */
331 rmi_f30_set_ctrl_data(&f30->ctrl[7], &control_address,
bf3e8502 332 f30->gpioled_count, &ctrl_reg);
562b42d3
AD
333 }
334
335 if (f30->has_haptic) {
336 rmi_f30_set_ctrl_data(&f30->ctrl[8], &control_address,
bf3e8502 337 f30->register_count, &ctrl_reg);
562b42d3
AD
338
339 rmi_f30_set_ctrl_data(&f30->ctrl[9], &control_address,
bf3e8502 340 sizeof(u8), &ctrl_reg);
562b42d3
AD
341 }
342
343 if (f30->has_mech_mouse_btns)
344 rmi_f30_set_ctrl_data(&f30->ctrl[10], &control_address,
bf3e8502 345 sizeof(u8), &ctrl_reg);
562b42d3 346
bf3e8502
DT
347 f30->ctrl_regs_size = ctrl_reg -
348 f30->ctrl_regs ?: RMI_F30_CTRL_REGS_MAX_SIZE;
562b42d3 349
bf3e8502
DT
350 error = rmi_f30_read_control_parameters(fn, f30);
351 if (error) {
562b42d3 352 dev_err(&fn->dev,
bf3e8502
DT
353 "Failed to initialize F30 control params: %d\n",
354 error);
355 return error;
562b42d3
AD
356 }
357
0a135b88 358 if (f30->has_gpio) {
bf3e8502
DT
359 error = rmi_f30_map_gpios(fn, f30);
360 if (error)
361 return error;
562b42d3
AD
362 }
363
364 return 0;
365}
366
367static int rmi_f30_probe(struct rmi_function *fn)
368{
bf3e8502 369 struct rmi_device *rmi_dev = fn->rmi_dev;
562b42d3 370 const struct rmi_device_platform_data *pdata =
bf3e8502
DT
371 rmi_get_platform_data(rmi_dev);
372 struct rmi_driver_data *drv_data = dev_get_drvdata(&rmi_dev->dev);
373 struct f30_data *f30;
374 int error;
562b42d3 375
0a135b88 376 if (pdata->f30_data.disable)
562b42d3
AD
377 return 0;
378
bf3e8502
DT
379 if (!drv_data->input) {
380 dev_info(&fn->dev, "F30: no input device found, ignoring\n");
381 return -ENXIO;
382 }
562b42d3 383
bf3e8502
DT
384 f30 = devm_kzalloc(&fn->dev, sizeof(*f30), GFP_KERNEL);
385 if (!f30)
386 return -ENOMEM;
562b42d3 387
bf3e8502 388 f30->input = drv_data->input;
562b42d3 389
bf3e8502
DT
390 error = rmi_f30_initialize(fn, f30);
391 if (error)
392 return error;
562b42d3 393
bf3e8502
DT
394 dev_set_drvdata(&fn->dev, f30);
395 return 0;
562b42d3
AD
396}
397
398struct rmi_function_handler rmi_f30_handler = {
399 .driver = {
400 .name = "rmi4_f30",
401 },
402 .func = 0x30,
403 .probe = rmi_f30_probe,
404 .config = rmi_f30_config,
405 .attention = rmi_f30_attention,
406};