Linux Audio

Check our new training course

Loading...
v6.2
  1// SPDX-License-Identifier: GPL-2.0-only
  2/*
  3 * Copyright (c) 2012-2015 Synaptics Incorporated
  4 * Copyright (C) 2016 Zodiac Inflight Innovations
 
 
 
 
  5 */
  6
  7#include <linux/kernel.h>
  8#include <linux/rmi.h>
  9#include <linux/input.h>
 10#include <linux/slab.h>
 11#include <linux/delay.h>
 12#include <linux/i2c.h>
 13#include <media/v4l2-device.h>
 14#include <media/v4l2-ioctl.h>
 15#include <media/videobuf2-v4l2.h>
 16#include <media/videobuf2-vmalloc.h>
 17#include "rmi_driver.h"
 18
 19#define F54_NAME		"rmi4_f54"
 20
 21/* F54 data offsets */
 22#define F54_REPORT_DATA_OFFSET  3
 23#define F54_FIFO_OFFSET         1
 24#define F54_NUM_TX_OFFSET       1
 25#define F54_NUM_RX_OFFSET       0
 26
 27/*
 28 * The smbus protocol can read only 32 bytes max at a time.
 29 * But this should be fine for i2c/spi as well.
 30 */
 31#define F54_REPORT_DATA_SIZE	32
 32
 33/* F54 commands */
 34#define F54_GET_REPORT          1
 35#define F54_FORCE_CAL           2
 36
 37/* F54 capabilities */
 38#define F54_CAP_BASELINE	(1 << 2)
 39#define F54_CAP_IMAGE8		(1 << 3)
 40#define F54_CAP_IMAGE16		(1 << 6)
 41
 42/**
 43 * enum rmi_f54_report_type - RMI4 F54 report types
 44 *
 45 * @F54_REPORT_NONE:	No Image Report.
 46 *
 47 * @F54_8BIT_IMAGE:	Normalized 8-Bit Image Report. The capacitance variance
 48 *			from baseline for each pixel.
 49 *
 50 * @F54_16BIT_IMAGE:	Normalized 16-Bit Image Report. The capacitance variance
 51 *			from baseline for each pixel.
 52 *
 53 * @F54_RAW_16BIT_IMAGE:
 54 *			Raw 16-Bit Image Report. The raw capacitance for each
 55 *			pixel.
 56 *
 57 * @F54_TRUE_BASELINE:	True Baseline Report. The baseline capacitance for each
 58 *			pixel.
 59 *
 60 * @F54_FULL_RAW_CAP:   Full Raw Capacitance Report. The raw capacitance with
 61 *			low reference set to its minimum value and high
 62 *			reference set to its maximum value.
 63 *
 64 * @F54_FULL_RAW_CAP_RX_OFFSET_REMOVED:
 65 *			Full Raw Capacitance with Receiver Offset Removed
 66 *			Report. Set Low reference to its minimum value and high
 67 *			references to its maximum value, then report the raw
 68 *			capacitance for each pixel.
 69 *
 70 * @F54_MAX_REPORT_TYPE:
 71 *			Maximum number of Report Types.  Used for sanity
 72 *			checking.
 73 */
 74enum rmi_f54_report_type {
 75	F54_REPORT_NONE = 0,
 76	F54_8BIT_IMAGE = 1,
 77	F54_16BIT_IMAGE = 2,
 78	F54_RAW_16BIT_IMAGE = 3,
 79	F54_TRUE_BASELINE = 9,
 80	F54_FULL_RAW_CAP = 19,
 81	F54_FULL_RAW_CAP_RX_OFFSET_REMOVED = 20,
 82	F54_MAX_REPORT_TYPE,
 83};
 84
 85static const char * const rmi_f54_report_type_names[] = {
 86	[F54_REPORT_NONE]		= "Unknown",
 87	[F54_8BIT_IMAGE]		= "Normalized 8-Bit Image",
 88	[F54_16BIT_IMAGE]		= "Normalized 16-Bit Image",
 89	[F54_RAW_16BIT_IMAGE]		= "Raw 16-Bit Image",
 90	[F54_TRUE_BASELINE]		= "True Baseline",
 91	[F54_FULL_RAW_CAP]		= "Full Raw Capacitance",
 92	[F54_FULL_RAW_CAP_RX_OFFSET_REMOVED]
 93					= "Full Raw Capacitance RX Offset Removed",
 94};
 95
 
 
 
 
 
 96struct f54_data {
 97	struct rmi_function *fn;
 98
 99	u8 num_rx_electrodes;
100	u8 num_tx_electrodes;
101	u8 capabilities;
102	u16 clock_rate;
103	u8 family;
104
105	enum rmi_f54_report_type report_type;
106	u8 *report_data;
107	int report_size;
 
108
109	bool is_busy;
110	struct mutex status_mutex;
111	struct mutex data_mutex;
112
113	struct workqueue_struct *workqueue;
114	struct delayed_work work;
115	unsigned long timeout;
116
117	struct completion cmd_done;
118
119	/* V4L2 support */
120	struct v4l2_device v4l2;
121	struct v4l2_pix_format format;
122	struct video_device vdev;
123	struct vb2_queue queue;
124	struct mutex lock;
125	u32 sequence;
126	int input;
127	enum rmi_f54_report_type inputs[F54_MAX_REPORT_TYPE];
128};
129
130/*
131 * Basic checks on report_type to ensure we write a valid type
132 * to the sensor.
133 */
134static bool is_f54_report_type_valid(struct f54_data *f54,
135				     enum rmi_f54_report_type reptype)
136{
137	switch (reptype) {
138	case F54_8BIT_IMAGE:
139		return f54->capabilities & F54_CAP_IMAGE8;
140	case F54_16BIT_IMAGE:
141	case F54_RAW_16BIT_IMAGE:
142		return f54->capabilities & F54_CAP_IMAGE16;
143	case F54_TRUE_BASELINE:
144		return f54->capabilities & F54_CAP_IMAGE16;
145	case F54_FULL_RAW_CAP:
146	case F54_FULL_RAW_CAP_RX_OFFSET_REMOVED:
147		return true;
148	default:
149		return false;
150	}
151}
152
153static enum rmi_f54_report_type rmi_f54_get_reptype(struct f54_data *f54,
154						unsigned int i)
155{
156	if (i >= F54_MAX_REPORT_TYPE)
157		return F54_REPORT_NONE;
158
159	return f54->inputs[i];
160}
161
162static void rmi_f54_create_input_map(struct f54_data *f54)
163{
164	int i = 0;
165	enum rmi_f54_report_type reptype;
166
167	for (reptype = 1; reptype < F54_MAX_REPORT_TYPE; reptype++) {
168		if (!is_f54_report_type_valid(f54, reptype))
169			continue;
170
171		f54->inputs[i++] = reptype;
172	}
173
174	/* Remaining values are zero via kzalloc */
175}
176
177static int rmi_f54_request_report(struct rmi_function *fn, u8 report_type)
178{
179	struct f54_data *f54 = dev_get_drvdata(&fn->dev);
180	struct rmi_device *rmi_dev = fn->rmi_dev;
181	int error;
182
183	/* Write Report Type into F54_AD_Data0 */
184	if (f54->report_type != report_type) {
185		error = rmi_write(rmi_dev, f54->fn->fd.data_base_addr,
186				  report_type);
187		if (error)
188			return error;
189		f54->report_type = report_type;
190	}
191
192	/*
193	 * Small delay after disabling interrupts to avoid race condition
194	 * in firmare. This value is a bit higher than absolutely necessary.
195	 * Should be removed once issue is resolved in firmware.
196	 */
197	usleep_range(2000, 3000);
198
199	mutex_lock(&f54->data_mutex);
200
201	error = rmi_write(rmi_dev, fn->fd.command_base_addr, F54_GET_REPORT);
202	if (error < 0)
203		goto unlock;
204
205	init_completion(&f54->cmd_done);
206
207	f54->is_busy = 1;
208	f54->timeout = jiffies + msecs_to_jiffies(100);
209
210	queue_delayed_work(f54->workqueue, &f54->work, 0);
211
212unlock:
213	mutex_unlock(&f54->data_mutex);
214
215	return error;
216}
217
218static size_t rmi_f54_get_report_size(struct f54_data *f54)
219{
220	struct rmi_device *rmi_dev = f54->fn->rmi_dev;
221	struct rmi_driver_data *drv_data = dev_get_drvdata(&rmi_dev->dev);
222	u8 rx = drv_data->num_rx_electrodes ? : f54->num_rx_electrodes;
223	u8 tx = drv_data->num_tx_electrodes ? : f54->num_tx_electrodes;
224	size_t size;
225
226	switch (rmi_f54_get_reptype(f54, f54->input)) {
227	case F54_8BIT_IMAGE:
228		size = rx * tx;
229		break;
230	case F54_16BIT_IMAGE:
231	case F54_RAW_16BIT_IMAGE:
232	case F54_TRUE_BASELINE:
233	case F54_FULL_RAW_CAP:
234	case F54_FULL_RAW_CAP_RX_OFFSET_REMOVED:
235		size = sizeof(u16) * rx * tx;
236		break;
237	default:
238		size = 0;
239	}
240
241	return size;
242}
243
244static int rmi_f54_get_pixel_fmt(enum rmi_f54_report_type reptype, u32 *pixfmt)
245{
246	int ret = 0;
247
248	switch (reptype) {
249	case F54_8BIT_IMAGE:
250		*pixfmt = V4L2_TCH_FMT_DELTA_TD08;
251		break;
252
253	case F54_16BIT_IMAGE:
254		*pixfmt = V4L2_TCH_FMT_DELTA_TD16;
255		break;
256
257	case F54_RAW_16BIT_IMAGE:
258	case F54_TRUE_BASELINE:
259	case F54_FULL_RAW_CAP:
260	case F54_FULL_RAW_CAP_RX_OFFSET_REMOVED:
261		*pixfmt = V4L2_TCH_FMT_TU16;
262		break;
263
264	case F54_REPORT_NONE:
265	case F54_MAX_REPORT_TYPE:
266		ret = -EINVAL;
267		break;
268	}
269
270	return ret;
271}
272
273static const struct v4l2_file_operations rmi_f54_video_fops = {
274	.owner = THIS_MODULE,
275	.open = v4l2_fh_open,
276	.release = vb2_fop_release,
277	.unlocked_ioctl = video_ioctl2,
278	.read = vb2_fop_read,
279	.mmap = vb2_fop_mmap,
280	.poll = vb2_fop_poll,
281};
282
283static int rmi_f54_queue_setup(struct vb2_queue *q, unsigned int *nbuffers,
284			       unsigned int *nplanes, unsigned int sizes[],
285			       struct device *alloc_devs[])
286{
287	struct f54_data *f54 = q->drv_priv;
288
289	if (*nplanes)
290		return sizes[0] < rmi_f54_get_report_size(f54) ? -EINVAL : 0;
291
292	*nplanes = 1;
293	sizes[0] = rmi_f54_get_report_size(f54);
294
295	return 0;
296}
297
298static void rmi_f54_buffer_queue(struct vb2_buffer *vb)
299{
300	struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
301	struct f54_data *f54 = vb2_get_drv_priv(vb->vb2_queue);
302	u16 *ptr;
303	enum vb2_buffer_state state;
304	enum rmi_f54_report_type reptype;
305	int ret;
306
307	mutex_lock(&f54->status_mutex);
308
309	vb2_set_plane_payload(vb, 0, 0);
310	reptype = rmi_f54_get_reptype(f54, f54->input);
311	if (reptype == F54_REPORT_NONE) {
312		state = VB2_BUF_STATE_ERROR;
313		goto done;
314	}
315
316	if (f54->is_busy) {
317		state = VB2_BUF_STATE_ERROR;
318		goto done;
319	}
320
321	ret = rmi_f54_request_report(f54->fn, reptype);
322	if (ret) {
323		dev_err(&f54->fn->dev, "Error requesting F54 report\n");
324		state = VB2_BUF_STATE_ERROR;
325		goto done;
326	}
327
328	/* get frame data */
329	mutex_lock(&f54->data_mutex);
330
331	while (f54->is_busy) {
332		mutex_unlock(&f54->data_mutex);
333		if (!wait_for_completion_timeout(&f54->cmd_done,
334						 msecs_to_jiffies(1000))) {
335			dev_err(&f54->fn->dev, "Timed out\n");
336			state = VB2_BUF_STATE_ERROR;
337			goto done;
338		}
339		mutex_lock(&f54->data_mutex);
340	}
341
342	ptr = vb2_plane_vaddr(vb, 0);
343	if (!ptr) {
344		dev_err(&f54->fn->dev, "Error acquiring frame ptr\n");
345		state = VB2_BUF_STATE_ERROR;
346		goto data_done;
347	}
348
349	memcpy(ptr, f54->report_data, f54->report_size);
350	vb2_set_plane_payload(vb, 0, rmi_f54_get_report_size(f54));
351	state = VB2_BUF_STATE_DONE;
352
353data_done:
354	mutex_unlock(&f54->data_mutex);
355done:
356	vb->timestamp = ktime_get_ns();
357	vbuf->field = V4L2_FIELD_NONE;
358	vbuf->sequence = f54->sequence++;
359	vb2_buffer_done(vb, state);
360	mutex_unlock(&f54->status_mutex);
361}
362
363static void rmi_f54_stop_streaming(struct vb2_queue *q)
364{
365	struct f54_data *f54 = vb2_get_drv_priv(q);
366
367	f54->sequence = 0;
368}
369
370/* V4L2 structures */
371static const struct vb2_ops rmi_f54_queue_ops = {
372	.queue_setup            = rmi_f54_queue_setup,
373	.buf_queue              = rmi_f54_buffer_queue,
374	.stop_streaming		= rmi_f54_stop_streaming,
375	.wait_prepare           = vb2_ops_wait_prepare,
376	.wait_finish            = vb2_ops_wait_finish,
377};
378
379static const struct vb2_queue rmi_f54_queue = {
380	.type = V4L2_BUF_TYPE_VIDEO_CAPTURE,
381	.io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF | VB2_READ,
382	.buf_struct_size = sizeof(struct vb2_v4l2_buffer),
383	.ops = &rmi_f54_queue_ops,
384	.mem_ops = &vb2_vmalloc_memops,
385	.timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC,
 
386};
387
388static int rmi_f54_vidioc_querycap(struct file *file, void *priv,
389				   struct v4l2_capability *cap)
390{
391	struct f54_data *f54 = video_drvdata(file);
392
393	strscpy(cap->driver, F54_NAME, sizeof(cap->driver));
394	strscpy(cap->card, SYNAPTICS_INPUT_DEVICE_NAME, sizeof(cap->card));
395	snprintf(cap->bus_info, sizeof(cap->bus_info),
396		"rmi4:%s", dev_name(&f54->fn->dev));
397
398	return 0;
399}
400
401static int rmi_f54_vidioc_enum_input(struct file *file, void *priv,
402				     struct v4l2_input *i)
403{
404	struct f54_data *f54 = video_drvdata(file);
405	enum rmi_f54_report_type reptype;
406
407	reptype = rmi_f54_get_reptype(f54, i->index);
408	if (reptype == F54_REPORT_NONE)
409		return -EINVAL;
410
411	i->type = V4L2_INPUT_TYPE_TOUCH;
412
413	strscpy(i->name, rmi_f54_report_type_names[reptype], sizeof(i->name));
414	return 0;
415}
416
417static int rmi_f54_set_input(struct f54_data *f54, unsigned int i)
418{
419	struct rmi_device *rmi_dev = f54->fn->rmi_dev;
420	struct rmi_driver_data *drv_data = dev_get_drvdata(&rmi_dev->dev);
421	u8 rx = drv_data->num_rx_electrodes ? : f54->num_rx_electrodes;
422	u8 tx = drv_data->num_tx_electrodes ? : f54->num_tx_electrodes;
423	struct v4l2_pix_format *f = &f54->format;
424	enum rmi_f54_report_type reptype;
425	int ret;
426
427	reptype = rmi_f54_get_reptype(f54, i);
428	if (reptype == F54_REPORT_NONE)
429		return -EINVAL;
430
431	ret = rmi_f54_get_pixel_fmt(reptype, &f->pixelformat);
432	if (ret)
433		return ret;
434
435	f54->input = i;
436
437	f->width = rx;
438	f->height = tx;
439	f->field = V4L2_FIELD_NONE;
440	f->colorspace = V4L2_COLORSPACE_RAW;
441	f->bytesperline = f->width * sizeof(u16);
442	f->sizeimage = f->width * f->height * sizeof(u16);
443
444	return 0;
445}
446
447static int rmi_f54_vidioc_s_input(struct file *file, void *priv, unsigned int i)
448{
449	return rmi_f54_set_input(video_drvdata(file), i);
450}
451
452static int rmi_f54_vidioc_g_input(struct file *file, void *priv,
453				  unsigned int *i)
454{
455	struct f54_data *f54 = video_drvdata(file);
456
457	*i = f54->input;
458
459	return 0;
460}
461
462static int rmi_f54_vidioc_fmt(struct file *file, void *priv,
463			      struct v4l2_format *f)
464{
465	struct f54_data *f54 = video_drvdata(file);
466
467	f->fmt.pix = f54->format;
468
469	return 0;
470}
471
472static int rmi_f54_vidioc_enum_fmt(struct file *file, void *priv,
473				   struct v4l2_fmtdesc *fmt)
474{
475	struct f54_data *f54 = video_drvdata(file);
476
477	if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
478		return -EINVAL;
479
480	if (fmt->index)
481		return -EINVAL;
 
 
 
 
 
 
482
483	fmt->pixelformat = f54->format.pixelformat;
 
 
 
 
 
 
484
485	return 0;
486}
487
488static int rmi_f54_vidioc_g_parm(struct file *file, void *fh,
489				 struct v4l2_streamparm *a)
490{
491	if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
492		return -EINVAL;
493
494	a->parm.capture.readbuffers = 1;
495	a->parm.capture.timeperframe.numerator = 1;
496	a->parm.capture.timeperframe.denominator = 10;
497	return 0;
498}
499
500static const struct v4l2_ioctl_ops rmi_f54_video_ioctl_ops = {
501	.vidioc_querycap	= rmi_f54_vidioc_querycap,
502
503	.vidioc_enum_fmt_vid_cap = rmi_f54_vidioc_enum_fmt,
504	.vidioc_s_fmt_vid_cap	= rmi_f54_vidioc_fmt,
505	.vidioc_g_fmt_vid_cap	= rmi_f54_vidioc_fmt,
506	.vidioc_try_fmt_vid_cap	= rmi_f54_vidioc_fmt,
507	.vidioc_g_parm		= rmi_f54_vidioc_g_parm,
508
509	.vidioc_enum_input	= rmi_f54_vidioc_enum_input,
510	.vidioc_g_input		= rmi_f54_vidioc_g_input,
511	.vidioc_s_input		= rmi_f54_vidioc_s_input,
512
513	.vidioc_reqbufs		= vb2_ioctl_reqbufs,
514	.vidioc_create_bufs	= vb2_ioctl_create_bufs,
515	.vidioc_querybuf	= vb2_ioctl_querybuf,
516	.vidioc_qbuf		= vb2_ioctl_qbuf,
517	.vidioc_dqbuf		= vb2_ioctl_dqbuf,
518	.vidioc_expbuf		= vb2_ioctl_expbuf,
519
520	.vidioc_streamon	= vb2_ioctl_streamon,
521	.vidioc_streamoff	= vb2_ioctl_streamoff,
522};
523
524static const struct video_device rmi_f54_video_device = {
525	.name = "Synaptics RMI4",
526	.fops = &rmi_f54_video_fops,
527	.ioctl_ops = &rmi_f54_video_ioctl_ops,
528	.release = video_device_release_empty,
529	.device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TOUCH |
530		       V4L2_CAP_READWRITE | V4L2_CAP_STREAMING,
531};
532
533static void rmi_f54_work(struct work_struct *work)
534{
535	struct f54_data *f54 = container_of(work, struct f54_data, work.work);
536	struct rmi_function *fn = f54->fn;
537	u8 fifo[2];
 
538	int report_size;
539	u8 command;
 
540	int error;
541	int i;
542
 
543	report_size = rmi_f54_get_report_size(f54);
544	if (report_size == 0) {
545		dev_err(&fn->dev, "Bad report size, report type=%d\n",
546				f54->report_type);
547		error = -EINVAL;
548		goto error;     /* retry won't help */
549	}
 
 
550
551	mutex_lock(&f54->data_mutex);
552
553	/*
554	 * Need to check if command has completed.
555	 * If not try again later.
556	 */
557	error = rmi_read(fn->rmi_dev, f54->fn->fd.command_base_addr,
558			 &command);
559	if (error) {
560		dev_err(&fn->dev, "Failed to read back command\n");
561		goto error;
562	}
563	if (command & F54_GET_REPORT) {
564		if (time_after(jiffies, f54->timeout)) {
565			dev_err(&fn->dev, "Get report command timed out\n");
566			error = -ETIMEDOUT;
567		}
568		report_size = 0;
569		goto error;
570	}
571
572	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "Get report command completed, reading data\n");
573
574	for (i = 0; i < report_size; i += F54_REPORT_DATA_SIZE) {
575		int size = min(F54_REPORT_DATA_SIZE, report_size - i);
576
577		fifo[0] = i & 0xff;
578		fifo[1] = i >> 8;
579		error = rmi_write_block(fn->rmi_dev,
580					fn->fd.data_base_addr + F54_FIFO_OFFSET,
581					fifo, sizeof(fifo));
582		if (error) {
583			dev_err(&fn->dev, "Failed to set fifo start offset\n");
584			goto abort;
585		}
586
587		error = rmi_read_block(fn->rmi_dev, fn->fd.data_base_addr +
588				       F54_REPORT_DATA_OFFSET,
589				       f54->report_data + i, size);
590		if (error) {
591			dev_err(&fn->dev, "%s: read [%d bytes] returned %d\n",
592				__func__, size, error);
593			goto abort;
594		}
 
 
595	}
596
597abort:
598	f54->report_size = error ? 0 : report_size;
599error:
600	if (error)
601		report_size = 0;
602
603	if (report_size == 0 && !error) {
604		queue_delayed_work(f54->workqueue, &f54->work,
605				   msecs_to_jiffies(1));
606	} else {
607		f54->is_busy = false;
608		complete(&f54->cmd_done);
609	}
610
611	mutex_unlock(&f54->data_mutex);
612}
613
 
 
 
 
 
614static int rmi_f54_config(struct rmi_function *fn)
615{
616	struct rmi_driver *drv = fn->rmi_dev->driver;
617
618	drv->clear_irq_bits(fn->rmi_dev, fn->irq_mask);
619
620	return 0;
621}
622
623static int rmi_f54_detect(struct rmi_function *fn)
624{
625	int error;
626	struct f54_data *f54;
627	u8 buf[6];
628
629	f54 = dev_get_drvdata(&fn->dev);
630
631	error = rmi_read_block(fn->rmi_dev, fn->fd.query_base_addr,
632			       buf, sizeof(buf));
633	if (error) {
634		dev_err(&fn->dev, "%s: Failed to query F54 properties\n",
635			__func__);
636		return error;
637	}
638
639	f54->num_rx_electrodes = buf[0];
640	f54->num_tx_electrodes = buf[1];
641	f54->capabilities = buf[2];
642	f54->clock_rate = buf[3] | (buf[4] << 8);
643	f54->family = buf[5];
644
645	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "F54 num_rx_electrodes: %d\n",
646		f54->num_rx_electrodes);
647	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "F54 num_tx_electrodes: %d\n",
648		f54->num_tx_electrodes);
649	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "F54 capabilities: 0x%x\n",
650		f54->capabilities);
651	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "F54 clock rate: 0x%x\n",
652		f54->clock_rate);
653	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "F54 family: 0x%x\n",
654		f54->family);
655
656	f54->is_busy = false;
657
658	return 0;
659}
660
661static int rmi_f54_probe(struct rmi_function *fn)
662{
663	struct f54_data *f54;
664	int ret;
665	u8 rx, tx;
666
667	f54 = devm_kzalloc(&fn->dev, sizeof(struct f54_data), GFP_KERNEL);
668	if (!f54)
669		return -ENOMEM;
670
671	f54->fn = fn;
672	dev_set_drvdata(&fn->dev, f54);
673
674	ret = rmi_f54_detect(fn);
675	if (ret)
676		return ret;
677
678	mutex_init(&f54->data_mutex);
679	mutex_init(&f54->status_mutex);
680
681	rx = f54->num_rx_electrodes;
682	tx = f54->num_tx_electrodes;
683	f54->report_data = devm_kzalloc(&fn->dev,
684					array3_size(tx, rx, sizeof(u16)),
685					GFP_KERNEL);
686	if (f54->report_data == NULL)
687		return -ENOMEM;
688
689	INIT_DELAYED_WORK(&f54->work, rmi_f54_work);
690
691	f54->workqueue = create_singlethread_workqueue("rmi4-poller");
692	if (!f54->workqueue)
693		return -ENOMEM;
694
695	rmi_f54_create_input_map(f54);
696	rmi_f54_set_input(f54, 0);
697
698	/* register video device */
699	strscpy(f54->v4l2.name, F54_NAME, sizeof(f54->v4l2.name));
700	ret = v4l2_device_register(&fn->dev, &f54->v4l2);
701	if (ret) {
702		dev_err(&fn->dev, "Unable to register video dev.\n");
703		goto remove_wq;
704	}
705
706	/* initialize the queue */
707	mutex_init(&f54->lock);
708	f54->queue = rmi_f54_queue;
709	f54->queue.drv_priv = f54;
710	f54->queue.lock = &f54->lock;
711	f54->queue.dev = &fn->dev;
712
713	ret = vb2_queue_init(&f54->queue);
714	if (ret)
715		goto remove_v4l2;
716
717	f54->vdev = rmi_f54_video_device;
718	f54->vdev.v4l2_dev = &f54->v4l2;
719	f54->vdev.lock = &f54->lock;
720	f54->vdev.vfl_dir = VFL_DIR_RX;
721	f54->vdev.queue = &f54->queue;
722	video_set_drvdata(&f54->vdev, f54);
723
724	ret = video_register_device(&f54->vdev, VFL_TYPE_TOUCH, -1);
725	if (ret) {
726		dev_err(&fn->dev, "Unable to register video subdevice.");
727		goto remove_v4l2;
728	}
729
730	return 0;
731
732remove_v4l2:
733	v4l2_device_unregister(&f54->v4l2);
734remove_wq:
735	cancel_delayed_work_sync(&f54->work);
 
736	destroy_workqueue(f54->workqueue);
737	return ret;
738}
739
740static void rmi_f54_remove(struct rmi_function *fn)
741{
742	struct f54_data *f54 = dev_get_drvdata(&fn->dev);
743
744	video_unregister_device(&f54->vdev);
745	v4l2_device_unregister(&f54->v4l2);
746	destroy_workqueue(f54->workqueue);
747}
748
749struct rmi_function_handler rmi_f54_handler = {
750	.driver = {
751		.name = F54_NAME,
752	},
753	.func = 0x54,
754	.probe = rmi_f54_probe,
755	.config = rmi_f54_config,
 
756	.remove = rmi_f54_remove,
757};
v4.17
 
  1/*
  2 * Copyright (c) 2012-2015 Synaptics Incorporated
  3 * Copyright (C) 2016 Zodiac Inflight Innovations
  4 *
  5 * This program is free software; you can redistribute it and/or modify it
  6 * under the terms of the GNU General Public License version 2 as published by
  7 * the Free Software Foundation.
  8 */
  9
 10#include <linux/kernel.h>
 11#include <linux/rmi.h>
 12#include <linux/input.h>
 13#include <linux/slab.h>
 14#include <linux/delay.h>
 15#include <linux/i2c.h>
 16#include <media/v4l2-device.h>
 17#include <media/v4l2-ioctl.h>
 18#include <media/videobuf2-v4l2.h>
 19#include <media/videobuf2-vmalloc.h>
 20#include "rmi_driver.h"
 21
 22#define F54_NAME		"rmi4_f54"
 23
 24/* F54 data offsets */
 25#define F54_REPORT_DATA_OFFSET  3
 26#define F54_FIFO_OFFSET         1
 27#define F54_NUM_TX_OFFSET       1
 28#define F54_NUM_RX_OFFSET       0
 29
 
 
 
 
 
 
 30/* F54 commands */
 31#define F54_GET_REPORT          1
 32#define F54_FORCE_CAL           2
 33
 34/* F54 capabilities */
 35#define F54_CAP_BASELINE	(1 << 2)
 36#define F54_CAP_IMAGE8		(1 << 3)
 37#define F54_CAP_IMAGE16		(1 << 6)
 38
 39/**
 40 * enum rmi_f54_report_type - RMI4 F54 report types
 41 *
 
 
 42 * @F54_8BIT_IMAGE:	Normalized 8-Bit Image Report. The capacitance variance
 43 *			from baseline for each pixel.
 44 *
 45 * @F54_16BIT_IMAGE:	Normalized 16-Bit Image Report. The capacitance variance
 46 *			from baseline for each pixel.
 47 *
 48 * @F54_RAW_16BIT_IMAGE:
 49 *			Raw 16-Bit Image Report. The raw capacitance for each
 50 *			pixel.
 51 *
 52 * @F54_TRUE_BASELINE:	True Baseline Report. The baseline capacitance for each
 53 *			pixel.
 54 *
 55 * @F54_FULL_RAW_CAP:   Full Raw Capacitance Report. The raw capacitance with
 56 *			low reference set to its minimum value and high
 57 *			reference set to its maximum value.
 58 *
 59 * @F54_FULL_RAW_CAP_RX_OFFSET_REMOVED:
 60 *			Full Raw Capacitance with Receiver Offset Removed
 61 *			Report. Set Low reference to its minimum value and high
 62 *			references to its maximum value, then report the raw
 63 *			capacitance for each pixel.
 
 
 
 
 64 */
 65enum rmi_f54_report_type {
 66	F54_REPORT_NONE = 0,
 67	F54_8BIT_IMAGE = 1,
 68	F54_16BIT_IMAGE = 2,
 69	F54_RAW_16BIT_IMAGE = 3,
 70	F54_TRUE_BASELINE = 9,
 71	F54_FULL_RAW_CAP = 19,
 72	F54_FULL_RAW_CAP_RX_OFFSET_REMOVED = 20,
 73	F54_MAX_REPORT_TYPE,
 74};
 75
 76static const char * const rmi_f54_report_type_names[] = {
 77	[F54_REPORT_NONE]		= "Unknown",
 78	[F54_8BIT_IMAGE]		= "Normalized 8-Bit Image",
 79	[F54_16BIT_IMAGE]		= "Normalized 16-Bit Image",
 80	[F54_RAW_16BIT_IMAGE]		= "Raw 16-Bit Image",
 81	[F54_TRUE_BASELINE]		= "True Baseline",
 82	[F54_FULL_RAW_CAP]		= "Full Raw Capacitance",
 83	[F54_FULL_RAW_CAP_RX_OFFSET_REMOVED]
 84					= "Full Raw Capacitance RX Offset Removed",
 85};
 86
 87struct rmi_f54_reports {
 88	int start;
 89	int size;
 90};
 91
 92struct f54_data {
 93	struct rmi_function *fn;
 94
 95	u8 num_rx_electrodes;
 96	u8 num_tx_electrodes;
 97	u8 capabilities;
 98	u16 clock_rate;
 99	u8 family;
100
101	enum rmi_f54_report_type report_type;
102	u8 *report_data;
103	int report_size;
104	struct rmi_f54_reports standard_report[2];
105
106	bool is_busy;
107	struct mutex status_mutex;
108	struct mutex data_mutex;
109
110	struct workqueue_struct *workqueue;
111	struct delayed_work work;
112	unsigned long timeout;
113
114	struct completion cmd_done;
115
116	/* V4L2 support */
117	struct v4l2_device v4l2;
118	struct v4l2_pix_format format;
119	struct video_device vdev;
120	struct vb2_queue queue;
121	struct mutex lock;
 
122	int input;
123	enum rmi_f54_report_type inputs[F54_MAX_REPORT_TYPE];
124};
125
126/*
127 * Basic checks on report_type to ensure we write a valid type
128 * to the sensor.
129 */
130static bool is_f54_report_type_valid(struct f54_data *f54,
131				     enum rmi_f54_report_type reptype)
132{
133	switch (reptype) {
134	case F54_8BIT_IMAGE:
135		return f54->capabilities & F54_CAP_IMAGE8;
136	case F54_16BIT_IMAGE:
137	case F54_RAW_16BIT_IMAGE:
138		return f54->capabilities & F54_CAP_IMAGE16;
139	case F54_TRUE_BASELINE:
140		return f54->capabilities & F54_CAP_IMAGE16;
141	case F54_FULL_RAW_CAP:
142	case F54_FULL_RAW_CAP_RX_OFFSET_REMOVED:
143		return true;
144	default:
145		return false;
146	}
147}
148
149static enum rmi_f54_report_type rmi_f54_get_reptype(struct f54_data *f54,
150						unsigned int i)
151{
152	if (i >= F54_MAX_REPORT_TYPE)
153		return F54_REPORT_NONE;
154
155	return f54->inputs[i];
156}
157
158static void rmi_f54_create_input_map(struct f54_data *f54)
159{
160	int i = 0;
161	enum rmi_f54_report_type reptype;
162
163	for (reptype = 1; reptype < F54_MAX_REPORT_TYPE; reptype++) {
164		if (!is_f54_report_type_valid(f54, reptype))
165			continue;
166
167		f54->inputs[i++] = reptype;
168	}
169
170	/* Remaining values are zero via kzalloc */
171}
172
173static int rmi_f54_request_report(struct rmi_function *fn, u8 report_type)
174{
175	struct f54_data *f54 = dev_get_drvdata(&fn->dev);
176	struct rmi_device *rmi_dev = fn->rmi_dev;
177	int error;
178
179	/* Write Report Type into F54_AD_Data0 */
180	if (f54->report_type != report_type) {
181		error = rmi_write(rmi_dev, f54->fn->fd.data_base_addr,
182				  report_type);
183		if (error)
184			return error;
185		f54->report_type = report_type;
186	}
187
188	/*
189	 * Small delay after disabling interrupts to avoid race condition
190	 * in firmare. This value is a bit higher than absolutely necessary.
191	 * Should be removed once issue is resolved in firmware.
192	 */
193	usleep_range(2000, 3000);
194
195	mutex_lock(&f54->data_mutex);
196
197	error = rmi_write(rmi_dev, fn->fd.command_base_addr, F54_GET_REPORT);
198	if (error < 0)
199		goto unlock;
200
201	init_completion(&f54->cmd_done);
202
203	f54->is_busy = 1;
204	f54->timeout = jiffies + msecs_to_jiffies(100);
205
206	queue_delayed_work(f54->workqueue, &f54->work, 0);
207
208unlock:
209	mutex_unlock(&f54->data_mutex);
210
211	return error;
212}
213
214static size_t rmi_f54_get_report_size(struct f54_data *f54)
215{
216	struct rmi_device *rmi_dev = f54->fn->rmi_dev;
217	struct rmi_driver_data *drv_data = dev_get_drvdata(&rmi_dev->dev);
218	u8 rx = drv_data->num_rx_electrodes ? : f54->num_rx_electrodes;
219	u8 tx = drv_data->num_tx_electrodes ? : f54->num_tx_electrodes;
220	size_t size;
221
222	switch (rmi_f54_get_reptype(f54, f54->input)) {
223	case F54_8BIT_IMAGE:
224		size = rx * tx;
225		break;
226	case F54_16BIT_IMAGE:
227	case F54_RAW_16BIT_IMAGE:
228	case F54_TRUE_BASELINE:
229	case F54_FULL_RAW_CAP:
230	case F54_FULL_RAW_CAP_RX_OFFSET_REMOVED:
231		size = sizeof(u16) * rx * tx;
232		break;
233	default:
234		size = 0;
235	}
236
237	return size;
238}
239
240static int rmi_f54_get_pixel_fmt(enum rmi_f54_report_type reptype, u32 *pixfmt)
241{
242	int ret = 0;
243
244	switch (reptype) {
245	case F54_8BIT_IMAGE:
246		*pixfmt = V4L2_TCH_FMT_DELTA_TD08;
247		break;
248
249	case F54_16BIT_IMAGE:
250		*pixfmt = V4L2_TCH_FMT_DELTA_TD16;
251		break;
252
253	case F54_RAW_16BIT_IMAGE:
254	case F54_TRUE_BASELINE:
255	case F54_FULL_RAW_CAP:
256	case F54_FULL_RAW_CAP_RX_OFFSET_REMOVED:
257		*pixfmt = V4L2_TCH_FMT_TU16;
258		break;
259
260	case F54_REPORT_NONE:
261	case F54_MAX_REPORT_TYPE:
262		ret = -EINVAL;
263		break;
264	}
265
266	return ret;
267}
268
269static const struct v4l2_file_operations rmi_f54_video_fops = {
270	.owner = THIS_MODULE,
271	.open = v4l2_fh_open,
272	.release = vb2_fop_release,
273	.unlocked_ioctl = video_ioctl2,
274	.read = vb2_fop_read,
275	.mmap = vb2_fop_mmap,
276	.poll = vb2_fop_poll,
277};
278
279static int rmi_f54_queue_setup(struct vb2_queue *q, unsigned int *nbuffers,
280			       unsigned int *nplanes, unsigned int sizes[],
281			       struct device *alloc_devs[])
282{
283	struct f54_data *f54 = q->drv_priv;
284
285	if (*nplanes)
286		return sizes[0] < rmi_f54_get_report_size(f54) ? -EINVAL : 0;
287
288	*nplanes = 1;
289	sizes[0] = rmi_f54_get_report_size(f54);
290
291	return 0;
292}
293
294static void rmi_f54_buffer_queue(struct vb2_buffer *vb)
295{
 
296	struct f54_data *f54 = vb2_get_drv_priv(vb->vb2_queue);
297	u16 *ptr;
298	enum vb2_buffer_state state;
299	enum rmi_f54_report_type reptype;
300	int ret;
301
302	mutex_lock(&f54->status_mutex);
303
 
304	reptype = rmi_f54_get_reptype(f54, f54->input);
305	if (reptype == F54_REPORT_NONE) {
306		state = VB2_BUF_STATE_ERROR;
307		goto done;
308	}
309
310	if (f54->is_busy) {
311		state = VB2_BUF_STATE_ERROR;
312		goto done;
313	}
314
315	ret = rmi_f54_request_report(f54->fn, reptype);
316	if (ret) {
317		dev_err(&f54->fn->dev, "Error requesting F54 report\n");
318		state = VB2_BUF_STATE_ERROR;
319		goto done;
320	}
321
322	/* get frame data */
323	mutex_lock(&f54->data_mutex);
324
325	while (f54->is_busy) {
326		mutex_unlock(&f54->data_mutex);
327		if (!wait_for_completion_timeout(&f54->cmd_done,
328						 msecs_to_jiffies(1000))) {
329			dev_err(&f54->fn->dev, "Timed out\n");
330			state = VB2_BUF_STATE_ERROR;
331			goto done;
332		}
333		mutex_lock(&f54->data_mutex);
334	}
335
336	ptr = vb2_plane_vaddr(vb, 0);
337	if (!ptr) {
338		dev_err(&f54->fn->dev, "Error acquiring frame ptr\n");
339		state = VB2_BUF_STATE_ERROR;
340		goto data_done;
341	}
342
343	memcpy(ptr, f54->report_data, f54->report_size);
344	vb2_set_plane_payload(vb, 0, rmi_f54_get_report_size(f54));
345	state = VB2_BUF_STATE_DONE;
346
347data_done:
348	mutex_unlock(&f54->data_mutex);
349done:
 
 
 
350	vb2_buffer_done(vb, state);
351	mutex_unlock(&f54->status_mutex);
352}
353
 
 
 
 
 
 
 
354/* V4L2 structures */
355static const struct vb2_ops rmi_f54_queue_ops = {
356	.queue_setup            = rmi_f54_queue_setup,
357	.buf_queue              = rmi_f54_buffer_queue,
 
358	.wait_prepare           = vb2_ops_wait_prepare,
359	.wait_finish            = vb2_ops_wait_finish,
360};
361
362static const struct vb2_queue rmi_f54_queue = {
363	.type = V4L2_BUF_TYPE_VIDEO_CAPTURE,
364	.io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF | VB2_READ,
365	.buf_struct_size = sizeof(struct vb2_buffer),
366	.ops = &rmi_f54_queue_ops,
367	.mem_ops = &vb2_vmalloc_memops,
368	.timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC,
369	.min_buffers_needed = 1,
370};
371
372static int rmi_f54_vidioc_querycap(struct file *file, void *priv,
373				   struct v4l2_capability *cap)
374{
375	struct f54_data *f54 = video_drvdata(file);
376
377	strlcpy(cap->driver, F54_NAME, sizeof(cap->driver));
378	strlcpy(cap->card, SYNAPTICS_INPUT_DEVICE_NAME, sizeof(cap->card));
379	snprintf(cap->bus_info, sizeof(cap->bus_info),
380		"rmi4:%s", dev_name(&f54->fn->dev));
381
382	return 0;
383}
384
385static int rmi_f54_vidioc_enum_input(struct file *file, void *priv,
386				     struct v4l2_input *i)
387{
388	struct f54_data *f54 = video_drvdata(file);
389	enum rmi_f54_report_type reptype;
390
391	reptype = rmi_f54_get_reptype(f54, i->index);
392	if (reptype == F54_REPORT_NONE)
393		return -EINVAL;
394
395	i->type = V4L2_INPUT_TYPE_TOUCH;
396
397	strlcpy(i->name, rmi_f54_report_type_names[reptype], sizeof(i->name));
398	return 0;
399}
400
401static int rmi_f54_set_input(struct f54_data *f54, unsigned int i)
402{
403	struct rmi_device *rmi_dev = f54->fn->rmi_dev;
404	struct rmi_driver_data *drv_data = dev_get_drvdata(&rmi_dev->dev);
405	u8 rx = drv_data->num_rx_electrodes ? : f54->num_rx_electrodes;
406	u8 tx = drv_data->num_tx_electrodes ? : f54->num_tx_electrodes;
407	struct v4l2_pix_format *f = &f54->format;
408	enum rmi_f54_report_type reptype;
409	int ret;
410
411	reptype = rmi_f54_get_reptype(f54, i);
412	if (reptype == F54_REPORT_NONE)
413		return -EINVAL;
414
415	ret = rmi_f54_get_pixel_fmt(reptype, &f->pixelformat);
416	if (ret)
417		return ret;
418
419	f54->input = i;
420
421	f->width = rx;
422	f->height = tx;
423	f->field = V4L2_FIELD_NONE;
424	f->colorspace = V4L2_COLORSPACE_RAW;
425	f->bytesperline = f->width * sizeof(u16);
426	f->sizeimage = f->width * f->height * sizeof(u16);
427
428	return 0;
429}
430
431static int rmi_f54_vidioc_s_input(struct file *file, void *priv, unsigned int i)
432{
433	return rmi_f54_set_input(video_drvdata(file), i);
434}
435
436static int rmi_f54_vidioc_g_input(struct file *file, void *priv,
437				  unsigned int *i)
438{
439	struct f54_data *f54 = video_drvdata(file);
440
441	*i = f54->input;
442
443	return 0;
444}
445
446static int rmi_f54_vidioc_fmt(struct file *file, void *priv,
447			      struct v4l2_format *f)
448{
449	struct f54_data *f54 = video_drvdata(file);
450
451	f->fmt.pix = f54->format;
452
453	return 0;
454}
455
456static int rmi_f54_vidioc_enum_fmt(struct file *file, void *priv,
457				   struct v4l2_fmtdesc *fmt)
458{
 
 
459	if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
460		return -EINVAL;
461
462	switch (fmt->index) {
463	case 0:
464		fmt->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
465		break;
466
467	case 1:
468		fmt->pixelformat = V4L2_TCH_FMT_DELTA_TD08;
469		break;
470
471	case 2:
472		fmt->pixelformat = V4L2_TCH_FMT_TU16;
473		break;
474
475	default:
476		return -EINVAL;
477	}
478
479	return 0;
480}
481
482static int rmi_f54_vidioc_g_parm(struct file *file, void *fh,
483				 struct v4l2_streamparm *a)
484{
485	if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
486		return -EINVAL;
487
488	a->parm.capture.readbuffers = 1;
489	a->parm.capture.timeperframe.numerator = 1;
490	a->parm.capture.timeperframe.denominator = 10;
491	return 0;
492}
493
494static const struct v4l2_ioctl_ops rmi_f54_video_ioctl_ops = {
495	.vidioc_querycap	= rmi_f54_vidioc_querycap,
496
497	.vidioc_enum_fmt_vid_cap = rmi_f54_vidioc_enum_fmt,
498	.vidioc_s_fmt_vid_cap	= rmi_f54_vidioc_fmt,
499	.vidioc_g_fmt_vid_cap	= rmi_f54_vidioc_fmt,
500	.vidioc_try_fmt_vid_cap	= rmi_f54_vidioc_fmt,
501	.vidioc_g_parm		= rmi_f54_vidioc_g_parm,
502
503	.vidioc_enum_input	= rmi_f54_vidioc_enum_input,
504	.vidioc_g_input		= rmi_f54_vidioc_g_input,
505	.vidioc_s_input		= rmi_f54_vidioc_s_input,
506
507	.vidioc_reqbufs		= vb2_ioctl_reqbufs,
508	.vidioc_create_bufs	= vb2_ioctl_create_bufs,
509	.vidioc_querybuf	= vb2_ioctl_querybuf,
510	.vidioc_qbuf		= vb2_ioctl_qbuf,
511	.vidioc_dqbuf		= vb2_ioctl_dqbuf,
512	.vidioc_expbuf		= vb2_ioctl_expbuf,
513
514	.vidioc_streamon	= vb2_ioctl_streamon,
515	.vidioc_streamoff	= vb2_ioctl_streamoff,
516};
517
518static const struct video_device rmi_f54_video_device = {
519	.name = "Synaptics RMI4",
520	.fops = &rmi_f54_video_fops,
521	.ioctl_ops = &rmi_f54_video_ioctl_ops,
522	.release = video_device_release_empty,
523	.device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TOUCH |
524		       V4L2_CAP_READWRITE | V4L2_CAP_STREAMING,
525};
526
527static void rmi_f54_work(struct work_struct *work)
528{
529	struct f54_data *f54 = container_of(work, struct f54_data, work.work);
530	struct rmi_function *fn = f54->fn;
531	u8 fifo[2];
532	struct rmi_f54_reports *report;
533	int report_size;
534	u8 command;
535	u8 *data;
536	int error;
 
537
538	data = f54->report_data;
539	report_size = rmi_f54_get_report_size(f54);
540	if (report_size == 0) {
541		dev_err(&fn->dev, "Bad report size, report type=%d\n",
542				f54->report_type);
543		error = -EINVAL;
544		goto error;     /* retry won't help */
545	}
546	f54->standard_report[0].size = report_size;
547	report = f54->standard_report;
548
549	mutex_lock(&f54->data_mutex);
550
551	/*
552	 * Need to check if command has completed.
553	 * If not try again later.
554	 */
555	error = rmi_read(fn->rmi_dev, f54->fn->fd.command_base_addr,
556			 &command);
557	if (error) {
558		dev_err(&fn->dev, "Failed to read back command\n");
559		goto error;
560	}
561	if (command & F54_GET_REPORT) {
562		if (time_after(jiffies, f54->timeout)) {
563			dev_err(&fn->dev, "Get report command timed out\n");
564			error = -ETIMEDOUT;
565		}
566		report_size = 0;
567		goto error;
568	}
569
570	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "Get report command completed, reading data\n");
571
572	report_size = 0;
573	for (; report->size; report++) {
574		fifo[0] = report->start & 0xff;
575		fifo[1] = (report->start >> 8) & 0xff;
 
576		error = rmi_write_block(fn->rmi_dev,
577					fn->fd.data_base_addr + F54_FIFO_OFFSET,
578					fifo, sizeof(fifo));
579		if (error) {
580			dev_err(&fn->dev, "Failed to set fifo start offset\n");
581			goto abort;
582		}
583
584		error = rmi_read_block(fn->rmi_dev, fn->fd.data_base_addr +
585				       F54_REPORT_DATA_OFFSET, data,
586				       report->size);
587		if (error) {
588			dev_err(&fn->dev, "%s: read [%d bytes] returned %d\n",
589				__func__, report->size, error);
590			goto abort;
591		}
592		data += report->size;
593		report_size += report->size;
594	}
595
596abort:
597	f54->report_size = error ? 0 : report_size;
598error:
599	if (error)
600		report_size = 0;
601
602	if (report_size == 0 && !error) {
603		queue_delayed_work(f54->workqueue, &f54->work,
604				   msecs_to_jiffies(1));
605	} else {
606		f54->is_busy = false;
607		complete(&f54->cmd_done);
608	}
609
610	mutex_unlock(&f54->data_mutex);
611}
612
613static int rmi_f54_attention(struct rmi_function *fn, unsigned long *irqbits)
614{
615	return 0;
616}
617
618static int rmi_f54_config(struct rmi_function *fn)
619{
620	struct rmi_driver *drv = fn->rmi_dev->driver;
621
622	drv->set_irq_bits(fn->rmi_dev, fn->irq_mask);
623
624	return 0;
625}
626
627static int rmi_f54_detect(struct rmi_function *fn)
628{
629	int error;
630	struct f54_data *f54;
631	u8 buf[6];
632
633	f54 = dev_get_drvdata(&fn->dev);
634
635	error = rmi_read_block(fn->rmi_dev, fn->fd.query_base_addr,
636			       buf, sizeof(buf));
637	if (error) {
638		dev_err(&fn->dev, "%s: Failed to query F54 properties\n",
639			__func__);
640		return error;
641	}
642
643	f54->num_rx_electrodes = buf[0];
644	f54->num_tx_electrodes = buf[1];
645	f54->capabilities = buf[2];
646	f54->clock_rate = buf[3] | (buf[4] << 8);
647	f54->family = buf[5];
648
649	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "F54 num_rx_electrodes: %d\n",
650		f54->num_rx_electrodes);
651	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "F54 num_tx_electrodes: %d\n",
652		f54->num_tx_electrodes);
653	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "F54 capabilities: 0x%x\n",
654		f54->capabilities);
655	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "F54 clock rate: 0x%x\n",
656		f54->clock_rate);
657	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "F54 family: 0x%x\n",
658		f54->family);
659
660	f54->is_busy = false;
661
662	return 0;
663}
664
665static int rmi_f54_probe(struct rmi_function *fn)
666{
667	struct f54_data *f54;
668	int ret;
669	u8 rx, tx;
670
671	f54 = devm_kzalloc(&fn->dev, sizeof(struct f54_data), GFP_KERNEL);
672	if (!f54)
673		return -ENOMEM;
674
675	f54->fn = fn;
676	dev_set_drvdata(&fn->dev, f54);
677
678	ret = rmi_f54_detect(fn);
679	if (ret)
680		return ret;
681
682	mutex_init(&f54->data_mutex);
683	mutex_init(&f54->status_mutex);
684
685	rx = f54->num_rx_electrodes;
686	tx = f54->num_tx_electrodes;
687	f54->report_data = devm_kzalloc(&fn->dev,
688					sizeof(u16) * tx * rx,
689					GFP_KERNEL);
690	if (f54->report_data == NULL)
691		return -ENOMEM;
692
693	INIT_DELAYED_WORK(&f54->work, rmi_f54_work);
694
695	f54->workqueue = create_singlethread_workqueue("rmi4-poller");
696	if (!f54->workqueue)
697		return -ENOMEM;
698
699	rmi_f54_create_input_map(f54);
 
700
701	/* register video device */
702	strlcpy(f54->v4l2.name, F54_NAME, sizeof(f54->v4l2.name));
703	ret = v4l2_device_register(&fn->dev, &f54->v4l2);
704	if (ret) {
705		dev_err(&fn->dev, "Unable to register video dev.\n");
706		goto remove_wq;
707	}
708
709	/* initialize the queue */
710	mutex_init(&f54->lock);
711	f54->queue = rmi_f54_queue;
712	f54->queue.drv_priv = f54;
713	f54->queue.lock = &f54->lock;
714	f54->queue.dev = &fn->dev;
715
716	ret = vb2_queue_init(&f54->queue);
717	if (ret)
718		goto remove_v4l2;
719
720	f54->vdev = rmi_f54_video_device;
721	f54->vdev.v4l2_dev = &f54->v4l2;
722	f54->vdev.lock = &f54->lock;
723	f54->vdev.vfl_dir = VFL_DIR_RX;
724	f54->vdev.queue = &f54->queue;
725	video_set_drvdata(&f54->vdev, f54);
726
727	ret = video_register_device(&f54->vdev, VFL_TYPE_TOUCH, -1);
728	if (ret) {
729		dev_err(&fn->dev, "Unable to register video subdevice.");
730		goto remove_v4l2;
731	}
732
733	return 0;
734
735remove_v4l2:
736	v4l2_device_unregister(&f54->v4l2);
737remove_wq:
738	cancel_delayed_work_sync(&f54->work);
739	flush_workqueue(f54->workqueue);
740	destroy_workqueue(f54->workqueue);
741	return ret;
742}
743
744static void rmi_f54_remove(struct rmi_function *fn)
745{
746	struct f54_data *f54 = dev_get_drvdata(&fn->dev);
747
748	video_unregister_device(&f54->vdev);
749	v4l2_device_unregister(&f54->v4l2);
 
750}
751
752struct rmi_function_handler rmi_f54_handler = {
753	.driver = {
754		.name = F54_NAME,
755	},
756	.func = 0x54,
757	.probe = rmi_f54_probe,
758	.config = rmi_f54_config,
759	.attention = rmi_f54_attention,
760	.remove = rmi_f54_remove,
761};