1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Hantro VPU codec driver
4  *
5  * Copyright (C) 2018 Collabora, Ltd.
6  * Copyright 2018 Google LLC.
7  *	Tomasz Figa <tfiga@chromium.org>
8  *
9  * Based on s5p-mfc driver by Samsung Electronics Co., Ltd.
10  * Copyright (C) 2011 Samsung Electronics Co., Ltd.
11  */
12 
13 #include <linux/clk.h>
14 #include <linux/module.h>
15 #include <linux/of.h>
16 #include <linux/platform_device.h>
17 #include <linux/pm.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/slab.h>
20 #include <linux/videodev2.h>
21 #include <linux/workqueue.h>
22 #include <media/v4l2-event.h>
23 #include <media/v4l2-mem2mem.h>
24 #include <media/videobuf2-core.h>
25 #include <media/videobuf2-vmalloc.h>
26 
27 #include "hantro_v4l2.h"
28 #include "hantro.h"
29 #include "hantro_hw.h"
30 
31 #define DRIVER_NAME "hantro-vpu"
32 
33 int hantro_debug;
34 module_param_named(debug, hantro_debug, int, 0644);
35 MODULE_PARM_DESC(debug,
36 		 "Debug level - higher value produces more verbose messages");
37 
hantro_get_ctrl(struct hantro_ctx * ctx,u32 id)38 void *hantro_get_ctrl(struct hantro_ctx *ctx, u32 id)
39 {
40 	struct v4l2_ctrl *ctrl;
41 
42 	ctrl = v4l2_ctrl_find(&ctx->ctrl_handler, id);
43 	return ctrl ? ctrl->p_cur.p : NULL;
44 }
45 
hantro_get_ref(struct hantro_ctx * ctx,u64 ts)46 dma_addr_t hantro_get_ref(struct hantro_ctx *ctx, u64 ts)
47 {
48 	struct vb2_queue *q = v4l2_m2m_get_dst_vq(ctx->fh.m2m_ctx);
49 	struct vb2_buffer *buf;
50 	int index;
51 
52 	index = vb2_find_timestamp(q, ts, 0);
53 	if (index < 0)
54 		return 0;
55 	buf = vb2_get_buffer(q, index);
56 	return hantro_get_dec_buf_addr(ctx, buf);
57 }
58 
hantro_job_finish(struct hantro_dev * vpu,struct hantro_ctx * ctx,enum vb2_buffer_state result)59 static void hantro_job_finish(struct hantro_dev *vpu,
60 			      struct hantro_ctx *ctx,
61 			      enum vb2_buffer_state result)
62 {
63 	struct vb2_v4l2_buffer *src, *dst;
64 
65 	pm_runtime_mark_last_busy(vpu->dev);
66 	pm_runtime_put_autosuspend(vpu->dev);
67 	clk_bulk_disable(vpu->variant->num_clocks, vpu->clocks);
68 
69 	src = v4l2_m2m_next_src_buf(ctx->fh.m2m_ctx);
70 	dst = v4l2_m2m_next_dst_buf(ctx->fh.m2m_ctx);
71 
72 	if (WARN_ON(!src))
73 		return;
74 	if (WARN_ON(!dst))
75 		return;
76 
77 	src->sequence = ctx->sequence_out++;
78 	dst->sequence = ctx->sequence_cap++;
79 
80 	v4l2_m2m_buf_done_and_job_finish(ctx->dev->m2m_dev, ctx->fh.m2m_ctx,
81 					 result);
82 }
83 
hantro_irq_done(struct hantro_dev * vpu,enum vb2_buffer_state result)84 void hantro_irq_done(struct hantro_dev *vpu,
85 		     enum vb2_buffer_state result)
86 {
87 	struct hantro_ctx *ctx =
88 		v4l2_m2m_get_curr_priv(vpu->m2m_dev);
89 
90 	/*
91 	 * If cancel_delayed_work returns false
92 	 * the timeout expired. The watchdog is running,
93 	 * and will take care of finishing the job.
94 	 */
95 	if (cancel_delayed_work(&vpu->watchdog_work)) {
96 		if (result == VB2_BUF_STATE_DONE && ctx->codec_ops->done)
97 			ctx->codec_ops->done(ctx);
98 		hantro_job_finish(vpu, ctx, result);
99 	}
100 }
101 
hantro_watchdog(struct work_struct * work)102 void hantro_watchdog(struct work_struct *work)
103 {
104 	struct hantro_dev *vpu;
105 	struct hantro_ctx *ctx;
106 
107 	vpu = container_of(to_delayed_work(work),
108 			   struct hantro_dev, watchdog_work);
109 	ctx = v4l2_m2m_get_curr_priv(vpu->m2m_dev);
110 	if (ctx) {
111 		vpu_err("frame processing timed out!\n");
112 		ctx->codec_ops->reset(ctx);
113 		hantro_job_finish(vpu, ctx, VB2_BUF_STATE_ERROR);
114 	}
115 }
116 
hantro_start_prepare_run(struct hantro_ctx * ctx)117 void hantro_start_prepare_run(struct hantro_ctx *ctx)
118 {
119 	struct vb2_v4l2_buffer *src_buf;
120 
121 	src_buf = hantro_get_src_buf(ctx);
122 	v4l2_ctrl_request_setup(src_buf->vb2_buf.req_obj.req,
123 				&ctx->ctrl_handler);
124 
125 	if (!ctx->is_encoder) {
126 		if (hantro_needs_postproc(ctx, ctx->vpu_dst_fmt))
127 			hantro_postproc_enable(ctx);
128 		else
129 			hantro_postproc_disable(ctx);
130 	}
131 }
132 
hantro_end_prepare_run(struct hantro_ctx * ctx)133 void hantro_end_prepare_run(struct hantro_ctx *ctx)
134 {
135 	struct vb2_v4l2_buffer *src_buf;
136 
137 	src_buf = hantro_get_src_buf(ctx);
138 	v4l2_ctrl_request_complete(src_buf->vb2_buf.req_obj.req,
139 				   &ctx->ctrl_handler);
140 
141 	/* Kick the watchdog. */
142 	schedule_delayed_work(&ctx->dev->watchdog_work,
143 			      msecs_to_jiffies(2000));
144 }
145 
device_run(void * priv)146 static void device_run(void *priv)
147 {
148 	struct hantro_ctx *ctx = priv;
149 	struct vb2_v4l2_buffer *src, *dst;
150 	int ret;
151 
152 	src = hantro_get_src_buf(ctx);
153 	dst = hantro_get_dst_buf(ctx);
154 
155 	ret = clk_bulk_enable(ctx->dev->variant->num_clocks, ctx->dev->clocks);
156 	if (ret)
157 		goto err_cancel_job;
158 	ret = pm_runtime_get_sync(ctx->dev->dev);
159 	if (ret < 0)
160 		goto err_cancel_job;
161 
162 	v4l2_m2m_buf_copy_metadata(src, dst, true);
163 
164 	ctx->codec_ops->run(ctx);
165 	return;
166 
167 err_cancel_job:
168 	hantro_job_finish(ctx->dev, ctx, VB2_BUF_STATE_ERROR);
169 }
170 
171 static struct v4l2_m2m_ops vpu_m2m_ops = {
172 	.device_run = device_run,
173 };
174 
175 static int
queue_init(void * priv,struct vb2_queue * src_vq,struct vb2_queue * dst_vq)176 queue_init(void *priv, struct vb2_queue *src_vq, struct vb2_queue *dst_vq)
177 {
178 	struct hantro_ctx *ctx = priv;
179 	int ret;
180 
181 	src_vq->type = V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE;
182 	src_vq->io_modes = VB2_MMAP | VB2_DMABUF;
183 	src_vq->drv_priv = ctx;
184 	src_vq->ops = &hantro_queue_ops;
185 	src_vq->mem_ops = &vb2_dma_contig_memops;
186 
187 	/*
188 	 * Driver does mostly sequential access, so sacrifice TLB efficiency
189 	 * for faster allocation. Also, no CPU access on the source queue,
190 	 * so no kernel mapping needed.
191 	 */
192 	src_vq->dma_attrs = DMA_ATTR_ALLOC_SINGLE_PAGES |
193 			    DMA_ATTR_NO_KERNEL_MAPPING;
194 	src_vq->buf_struct_size = sizeof(struct v4l2_m2m_buffer);
195 	src_vq->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_COPY;
196 	src_vq->lock = &ctx->dev->vpu_mutex;
197 	src_vq->dev = ctx->dev->v4l2_dev.dev;
198 	src_vq->supports_requests = true;
199 
200 	ret = vb2_queue_init(src_vq);
201 	if (ret)
202 		return ret;
203 
204 	/*
205 	 * When encoding, the CAPTURE queue doesn't need dma memory,
206 	 * as the CPU needs to create the JPEG frames, from the
207 	 * hardware-produced JPEG payload.
208 	 *
209 	 * For the DMA destination buffer, we use a bounce buffer.
210 	 */
211 	if (ctx->is_encoder) {
212 		dst_vq->mem_ops = &vb2_vmalloc_memops;
213 	} else {
214 		dst_vq->bidirectional = true;
215 		dst_vq->mem_ops = &vb2_dma_contig_memops;
216 		dst_vq->dma_attrs = DMA_ATTR_ALLOC_SINGLE_PAGES |
217 				    DMA_ATTR_NO_KERNEL_MAPPING;
218 	}
219 
220 	dst_vq->type = V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE;
221 	dst_vq->io_modes = VB2_MMAP | VB2_DMABUF;
222 	dst_vq->drv_priv = ctx;
223 	dst_vq->ops = &hantro_queue_ops;
224 	dst_vq->buf_struct_size = sizeof(struct v4l2_m2m_buffer);
225 	dst_vq->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_COPY;
226 	dst_vq->lock = &ctx->dev->vpu_mutex;
227 	dst_vq->dev = ctx->dev->v4l2_dev.dev;
228 
229 	return vb2_queue_init(dst_vq);
230 }
231 
hantro_try_ctrl(struct v4l2_ctrl * ctrl)232 static int hantro_try_ctrl(struct v4l2_ctrl *ctrl)
233 {
234 	if (ctrl->id == V4L2_CID_MPEG_VIDEO_H264_SPS) {
235 		const struct v4l2_ctrl_h264_sps *sps = ctrl->p_new.p_h264_sps;
236 
237 		if (sps->chroma_format_idc > 1)
238 			/* Only 4:0:0 and 4:2:0 are supported */
239 			return -EINVAL;
240 		if (sps->bit_depth_luma_minus8 != sps->bit_depth_chroma_minus8)
241 			/* Luma and chroma bit depth mismatch */
242 			return -EINVAL;
243 		if (sps->bit_depth_luma_minus8 != 0)
244 			/* Only 8-bit is supported */
245 			return -EINVAL;
246 	}
247 	return 0;
248 }
249 
hantro_jpeg_s_ctrl(struct v4l2_ctrl * ctrl)250 static int hantro_jpeg_s_ctrl(struct v4l2_ctrl *ctrl)
251 {
252 	struct hantro_ctx *ctx;
253 
254 	ctx = container_of(ctrl->handler,
255 			   struct hantro_ctx, ctrl_handler);
256 
257 	vpu_debug(1, "s_ctrl: id = %d, val = %d\n", ctrl->id, ctrl->val);
258 
259 	switch (ctrl->id) {
260 	case V4L2_CID_JPEG_COMPRESSION_QUALITY:
261 		ctx->jpeg_quality = ctrl->val;
262 		break;
263 	default:
264 		return -EINVAL;
265 	}
266 
267 	return 0;
268 }
269 
270 static const struct v4l2_ctrl_ops hantro_ctrl_ops = {
271 	.try_ctrl = hantro_try_ctrl,
272 };
273 
274 static const struct v4l2_ctrl_ops hantro_jpeg_ctrl_ops = {
275 	.s_ctrl = hantro_jpeg_s_ctrl,
276 };
277 
278 static const struct hantro_ctrl controls[] = {
279 	{
280 		.codec = HANTRO_JPEG_ENCODER,
281 		.cfg = {
282 			.id = V4L2_CID_JPEG_COMPRESSION_QUALITY,
283 			.min = 5,
284 			.max = 100,
285 			.step = 1,
286 			.def = 50,
287 			.ops = &hantro_jpeg_ctrl_ops,
288 		},
289 	}, {
290 		.codec = HANTRO_MPEG2_DECODER,
291 		.cfg = {
292 			.id = V4L2_CID_MPEG_VIDEO_MPEG2_SLICE_PARAMS,
293 		},
294 	}, {
295 		.codec = HANTRO_MPEG2_DECODER,
296 		.cfg = {
297 			.id = V4L2_CID_MPEG_VIDEO_MPEG2_QUANTIZATION,
298 		},
299 	}, {
300 		.codec = HANTRO_VP8_DECODER,
301 		.cfg = {
302 			.id = V4L2_CID_MPEG_VIDEO_VP8_FRAME_HEADER,
303 		},
304 	}, {
305 		.codec = HANTRO_H264_DECODER,
306 		.cfg = {
307 			.id = V4L2_CID_MPEG_VIDEO_H264_DECODE_PARAMS,
308 		},
309 	}, {
310 		.codec = HANTRO_H264_DECODER,
311 		.cfg = {
312 			.id = V4L2_CID_MPEG_VIDEO_H264_SPS,
313 			.ops = &hantro_ctrl_ops,
314 		},
315 	}, {
316 		.codec = HANTRO_H264_DECODER,
317 		.cfg = {
318 			.id = V4L2_CID_MPEG_VIDEO_H264_PPS,
319 		},
320 	}, {
321 		.codec = HANTRO_H264_DECODER,
322 		.cfg = {
323 			.id = V4L2_CID_MPEG_VIDEO_H264_SCALING_MATRIX,
324 		},
325 	}, {
326 		.codec = HANTRO_H264_DECODER,
327 		.cfg = {
328 			.id = V4L2_CID_MPEG_VIDEO_H264_DECODE_MODE,
329 			.min = V4L2_MPEG_VIDEO_H264_DECODE_MODE_FRAME_BASED,
330 			.def = V4L2_MPEG_VIDEO_H264_DECODE_MODE_FRAME_BASED,
331 			.max = V4L2_MPEG_VIDEO_H264_DECODE_MODE_FRAME_BASED,
332 		},
333 	}, {
334 		.codec = HANTRO_H264_DECODER,
335 		.cfg = {
336 			.id = V4L2_CID_MPEG_VIDEO_H264_START_CODE,
337 			.min = V4L2_MPEG_VIDEO_H264_START_CODE_ANNEX_B,
338 			.def = V4L2_MPEG_VIDEO_H264_START_CODE_ANNEX_B,
339 			.max = V4L2_MPEG_VIDEO_H264_START_CODE_ANNEX_B,
340 		},
341 	}, {
342 		.codec = HANTRO_H264_DECODER,
343 		.cfg = {
344 			.id = V4L2_CID_MPEG_VIDEO_H264_PROFILE,
345 			.min = V4L2_MPEG_VIDEO_H264_PROFILE_BASELINE,
346 			.max = V4L2_MPEG_VIDEO_H264_PROFILE_HIGH,
347 			.menu_skip_mask =
348 			BIT(V4L2_MPEG_VIDEO_H264_PROFILE_EXTENDED),
349 			.def = V4L2_MPEG_VIDEO_H264_PROFILE_MAIN,
350 		}
351 	}, {
352 	},
353 };
354 
hantro_ctrls_setup(struct hantro_dev * vpu,struct hantro_ctx * ctx,int allowed_codecs)355 static int hantro_ctrls_setup(struct hantro_dev *vpu,
356 			      struct hantro_ctx *ctx,
357 			      int allowed_codecs)
358 {
359 	int i, num_ctrls = ARRAY_SIZE(controls);
360 
361 	v4l2_ctrl_handler_init(&ctx->ctrl_handler, num_ctrls);
362 
363 	for (i = 0; i < num_ctrls; i++) {
364 		if (!(allowed_codecs & controls[i].codec))
365 			continue;
366 
367 		v4l2_ctrl_new_custom(&ctx->ctrl_handler,
368 				     &controls[i].cfg, NULL);
369 		if (ctx->ctrl_handler.error) {
370 			vpu_err("Adding control (%d) failed %d\n",
371 				controls[i].cfg.id,
372 				ctx->ctrl_handler.error);
373 			v4l2_ctrl_handler_free(&ctx->ctrl_handler);
374 			return ctx->ctrl_handler.error;
375 		}
376 	}
377 	return v4l2_ctrl_handler_setup(&ctx->ctrl_handler);
378 }
379 
380 /*
381  * V4L2 file operations.
382  */
383 
hantro_open(struct file * filp)384 static int hantro_open(struct file *filp)
385 {
386 	struct hantro_dev *vpu = video_drvdata(filp);
387 	struct video_device *vdev = video_devdata(filp);
388 	struct hantro_func *func = hantro_vdev_to_func(vdev);
389 	struct hantro_ctx *ctx;
390 	int allowed_codecs, ret;
391 
392 	/*
393 	 * We do not need any extra locking here, because we operate only
394 	 * on local data here, except reading few fields from dev, which
395 	 * do not change through device's lifetime (which is guaranteed by
396 	 * reference on module from open()) and V4L2 internal objects (such
397 	 * as vdev and ctx->fh), which have proper locking done in respective
398 	 * helper functions used here.
399 	 */
400 
401 	ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
402 	if (!ctx)
403 		return -ENOMEM;
404 
405 	ctx->dev = vpu;
406 	if (func->id == MEDIA_ENT_F_PROC_VIDEO_ENCODER) {
407 		allowed_codecs = vpu->variant->codec & HANTRO_ENCODERS;
408 		ctx->is_encoder = true;
409 	} else if (func->id == MEDIA_ENT_F_PROC_VIDEO_DECODER) {
410 		allowed_codecs = vpu->variant->codec & HANTRO_DECODERS;
411 		ctx->is_encoder = false;
412 	} else {
413 		ret = -ENODEV;
414 		goto err_ctx_free;
415 	}
416 
417 	ctx->fh.m2m_ctx = v4l2_m2m_ctx_init(vpu->m2m_dev, ctx, queue_init);
418 	if (IS_ERR(ctx->fh.m2m_ctx)) {
419 		ret = PTR_ERR(ctx->fh.m2m_ctx);
420 		goto err_ctx_free;
421 	}
422 
423 	v4l2_fh_init(&ctx->fh, vdev);
424 	filp->private_data = &ctx->fh;
425 	v4l2_fh_add(&ctx->fh);
426 
427 	hantro_reset_fmts(ctx);
428 
429 	ret = hantro_ctrls_setup(vpu, ctx, allowed_codecs);
430 	if (ret) {
431 		vpu_err("Failed to set up controls\n");
432 		goto err_fh_free;
433 	}
434 	ctx->fh.ctrl_handler = &ctx->ctrl_handler;
435 
436 	return 0;
437 
438 err_fh_free:
439 	v4l2_fh_del(&ctx->fh);
440 	v4l2_fh_exit(&ctx->fh);
441 err_ctx_free:
442 	kfree(ctx);
443 	return ret;
444 }
445 
hantro_release(struct file * filp)446 static int hantro_release(struct file *filp)
447 {
448 	struct hantro_ctx *ctx =
449 		container_of(filp->private_data, struct hantro_ctx, fh);
450 
451 	/*
452 	 * No need for extra locking because this was the last reference
453 	 * to this file.
454 	 */
455 	v4l2_m2m_ctx_release(ctx->fh.m2m_ctx);
456 	v4l2_fh_del(&ctx->fh);
457 	v4l2_fh_exit(&ctx->fh);
458 	v4l2_ctrl_handler_free(&ctx->ctrl_handler);
459 	kfree(ctx);
460 
461 	return 0;
462 }
463 
464 static const struct v4l2_file_operations hantro_fops = {
465 	.owner = THIS_MODULE,
466 	.open = hantro_open,
467 	.release = hantro_release,
468 	.poll = v4l2_m2m_fop_poll,
469 	.unlocked_ioctl = video_ioctl2,
470 	.mmap = v4l2_m2m_fop_mmap,
471 };
472 
473 static const struct of_device_id of_hantro_match[] = {
474 #ifdef CONFIG_VIDEO_HANTRO_ROCKCHIP
475 	{ .compatible = "rockchip,rk3399-vpu", .data = &rk3399_vpu_variant, },
476 	{ .compatible = "rockchip,rk3328-vpu", .data = &rk3328_vpu_variant, },
477 	{ .compatible = "rockchip,rk3288-vpu", .data = &rk3288_vpu_variant, },
478 #endif
479 #ifdef CONFIG_VIDEO_HANTRO_IMX8M
480 	{ .compatible = "nxp,imx8mq-vpu", .data = &imx8mq_vpu_variant, },
481 #endif
482 	{ /* sentinel */ }
483 };
484 MODULE_DEVICE_TABLE(of, of_hantro_match);
485 
hantro_register_entity(struct media_device * mdev,struct media_entity * entity,const char * entity_name,struct media_pad * pads,int num_pads,int function,struct video_device * vdev)486 static int hantro_register_entity(struct media_device *mdev,
487 				  struct media_entity *entity,
488 				  const char *entity_name,
489 				  struct media_pad *pads, int num_pads,
490 				  int function, struct video_device *vdev)
491 {
492 	char *name;
493 	int ret;
494 
495 	entity->obj_type = MEDIA_ENTITY_TYPE_BASE;
496 	if (function == MEDIA_ENT_F_IO_V4L) {
497 		entity->info.dev.major = VIDEO_MAJOR;
498 		entity->info.dev.minor = vdev->minor;
499 	}
500 
501 	name = devm_kasprintf(mdev->dev, GFP_KERNEL, "%s-%s", vdev->name,
502 			      entity_name);
503 	if (!name)
504 		return -ENOMEM;
505 
506 	entity->name = name;
507 	entity->function = function;
508 
509 	ret = media_entity_pads_init(entity, num_pads, pads);
510 	if (ret)
511 		return ret;
512 
513 	ret = media_device_register_entity(mdev, entity);
514 	if (ret)
515 		return ret;
516 
517 	return 0;
518 }
519 
hantro_attach_func(struct hantro_dev * vpu,struct hantro_func * func)520 static int hantro_attach_func(struct hantro_dev *vpu,
521 			      struct hantro_func *func)
522 {
523 	struct media_device *mdev = &vpu->mdev;
524 	struct media_link *link;
525 	int ret;
526 
527 	/* Create the three encoder entities with their pads */
528 	func->source_pad.flags = MEDIA_PAD_FL_SOURCE;
529 	ret = hantro_register_entity(mdev, &func->vdev.entity, "source",
530 				     &func->source_pad, 1, MEDIA_ENT_F_IO_V4L,
531 				     &func->vdev);
532 	if (ret)
533 		return ret;
534 
535 	func->proc_pads[0].flags = MEDIA_PAD_FL_SINK;
536 	func->proc_pads[1].flags = MEDIA_PAD_FL_SOURCE;
537 	ret = hantro_register_entity(mdev, &func->proc, "proc",
538 				     func->proc_pads, 2, func->id,
539 				     &func->vdev);
540 	if (ret)
541 		goto err_rel_entity0;
542 
543 	func->sink_pad.flags = MEDIA_PAD_FL_SINK;
544 	ret = hantro_register_entity(mdev, &func->sink, "sink",
545 				     &func->sink_pad, 1, MEDIA_ENT_F_IO_V4L,
546 				     &func->vdev);
547 	if (ret)
548 		goto err_rel_entity1;
549 
550 	/* Connect the three entities */
551 	ret = media_create_pad_link(&func->vdev.entity, 0, &func->proc, 0,
552 				    MEDIA_LNK_FL_IMMUTABLE |
553 				    MEDIA_LNK_FL_ENABLED);
554 	if (ret)
555 		goto err_rel_entity2;
556 
557 	ret = media_create_pad_link(&func->proc, 1, &func->sink, 0,
558 				    MEDIA_LNK_FL_IMMUTABLE |
559 				    MEDIA_LNK_FL_ENABLED);
560 	if (ret)
561 		goto err_rm_links0;
562 
563 	/* Create video interface */
564 	func->intf_devnode = media_devnode_create(mdev, MEDIA_INTF_T_V4L_VIDEO,
565 						  0, VIDEO_MAJOR,
566 						  func->vdev.minor);
567 	if (!func->intf_devnode) {
568 		ret = -ENOMEM;
569 		goto err_rm_links1;
570 	}
571 
572 	/* Connect the two DMA engines to the interface */
573 	link = media_create_intf_link(&func->vdev.entity,
574 				      &func->intf_devnode->intf,
575 				      MEDIA_LNK_FL_IMMUTABLE |
576 				      MEDIA_LNK_FL_ENABLED);
577 	if (!link) {
578 		ret = -ENOMEM;
579 		goto err_rm_devnode;
580 	}
581 
582 	link = media_create_intf_link(&func->sink, &func->intf_devnode->intf,
583 				      MEDIA_LNK_FL_IMMUTABLE |
584 				      MEDIA_LNK_FL_ENABLED);
585 	if (!link) {
586 		ret = -ENOMEM;
587 		goto err_rm_devnode;
588 	}
589 	return 0;
590 
591 err_rm_devnode:
592 	media_devnode_remove(func->intf_devnode);
593 
594 err_rm_links1:
595 	media_entity_remove_links(&func->sink);
596 
597 err_rm_links0:
598 	media_entity_remove_links(&func->proc);
599 	media_entity_remove_links(&func->vdev.entity);
600 
601 err_rel_entity2:
602 	media_device_unregister_entity(&func->sink);
603 
604 err_rel_entity1:
605 	media_device_unregister_entity(&func->proc);
606 
607 err_rel_entity0:
608 	media_device_unregister_entity(&func->vdev.entity);
609 	return ret;
610 }
611 
hantro_detach_func(struct hantro_func * func)612 static void hantro_detach_func(struct hantro_func *func)
613 {
614 	media_devnode_remove(func->intf_devnode);
615 	media_entity_remove_links(&func->sink);
616 	media_entity_remove_links(&func->proc);
617 	media_entity_remove_links(&func->vdev.entity);
618 	media_device_unregister_entity(&func->sink);
619 	media_device_unregister_entity(&func->proc);
620 	media_device_unregister_entity(&func->vdev.entity);
621 }
622 
hantro_add_func(struct hantro_dev * vpu,unsigned int funcid)623 static int hantro_add_func(struct hantro_dev *vpu, unsigned int funcid)
624 {
625 	const struct of_device_id *match;
626 	struct hantro_func *func;
627 	struct video_device *vfd;
628 	int ret;
629 
630 	match = of_match_node(of_hantro_match, vpu->dev->of_node);
631 	func = devm_kzalloc(vpu->dev, sizeof(*func), GFP_KERNEL);
632 	if (!func) {
633 		v4l2_err(&vpu->v4l2_dev, "Failed to allocate video device\n");
634 		return -ENOMEM;
635 	}
636 
637 	func->id = funcid;
638 
639 	vfd = &func->vdev;
640 	vfd->fops = &hantro_fops;
641 	vfd->release = video_device_release_empty;
642 	vfd->lock = &vpu->vpu_mutex;
643 	vfd->v4l2_dev = &vpu->v4l2_dev;
644 	vfd->vfl_dir = VFL_DIR_M2M;
645 	vfd->device_caps = V4L2_CAP_STREAMING | V4L2_CAP_VIDEO_M2M_MPLANE;
646 	vfd->ioctl_ops = &hantro_ioctl_ops;
647 	snprintf(vfd->name, sizeof(vfd->name), "%s-%s", match->compatible,
648 		 funcid == MEDIA_ENT_F_PROC_VIDEO_ENCODER ? "enc" : "dec");
649 
650 	if (funcid == MEDIA_ENT_F_PROC_VIDEO_ENCODER)
651 		vpu->encoder = func;
652 	else
653 		vpu->decoder = func;
654 
655 	video_set_drvdata(vfd, vpu);
656 
657 	ret = video_register_device(vfd, VFL_TYPE_VIDEO, -1);
658 	if (ret) {
659 		v4l2_err(&vpu->v4l2_dev, "Failed to register video device\n");
660 		return ret;
661 	}
662 
663 	ret = hantro_attach_func(vpu, func);
664 	if (ret) {
665 		v4l2_err(&vpu->v4l2_dev,
666 			 "Failed to attach functionality to the media device\n");
667 		goto err_unreg_dev;
668 	}
669 
670 	v4l2_info(&vpu->v4l2_dev, "registered %s as /dev/video%d\n", vfd->name,
671 		  vfd->num);
672 
673 	return 0;
674 
675 err_unreg_dev:
676 	video_unregister_device(vfd);
677 	return ret;
678 }
679 
hantro_add_enc_func(struct hantro_dev * vpu)680 static int hantro_add_enc_func(struct hantro_dev *vpu)
681 {
682 	if (!vpu->variant->enc_fmts)
683 		return 0;
684 
685 	return hantro_add_func(vpu, MEDIA_ENT_F_PROC_VIDEO_ENCODER);
686 }
687 
hantro_add_dec_func(struct hantro_dev * vpu)688 static int hantro_add_dec_func(struct hantro_dev *vpu)
689 {
690 	if (!vpu->variant->dec_fmts)
691 		return 0;
692 
693 	return hantro_add_func(vpu, MEDIA_ENT_F_PROC_VIDEO_DECODER);
694 }
695 
hantro_remove_func(struct hantro_dev * vpu,unsigned int funcid)696 static void hantro_remove_func(struct hantro_dev *vpu,
697 			       unsigned int funcid)
698 {
699 	struct hantro_func *func;
700 
701 	if (funcid == MEDIA_ENT_F_PROC_VIDEO_ENCODER)
702 		func = vpu->encoder;
703 	else
704 		func = vpu->decoder;
705 
706 	if (!func)
707 		return;
708 
709 	hantro_detach_func(func);
710 	video_unregister_device(&func->vdev);
711 }
712 
hantro_remove_enc_func(struct hantro_dev * vpu)713 static void hantro_remove_enc_func(struct hantro_dev *vpu)
714 {
715 	hantro_remove_func(vpu, MEDIA_ENT_F_PROC_VIDEO_ENCODER);
716 }
717 
hantro_remove_dec_func(struct hantro_dev * vpu)718 static void hantro_remove_dec_func(struct hantro_dev *vpu)
719 {
720 	hantro_remove_func(vpu, MEDIA_ENT_F_PROC_VIDEO_DECODER);
721 }
722 
723 static const struct media_device_ops hantro_m2m_media_ops = {
724 	.req_validate = vb2_request_validate,
725 	.req_queue = v4l2_m2m_request_queue,
726 };
727 
hantro_probe(struct platform_device * pdev)728 static int hantro_probe(struct platform_device *pdev)
729 {
730 	const struct of_device_id *match;
731 	struct hantro_dev *vpu;
732 	struct resource *res;
733 	int num_bases;
734 	int i, ret;
735 
736 	vpu = devm_kzalloc(&pdev->dev, sizeof(*vpu), GFP_KERNEL);
737 	if (!vpu)
738 		return -ENOMEM;
739 
740 	vpu->dev = &pdev->dev;
741 	vpu->pdev = pdev;
742 	mutex_init(&vpu->vpu_mutex);
743 	spin_lock_init(&vpu->irqlock);
744 
745 	match = of_match_node(of_hantro_match, pdev->dev.of_node);
746 	vpu->variant = match->data;
747 
748 	INIT_DELAYED_WORK(&vpu->watchdog_work, hantro_watchdog);
749 
750 	vpu->clocks = devm_kcalloc(&pdev->dev, vpu->variant->num_clocks,
751 				   sizeof(*vpu->clocks), GFP_KERNEL);
752 	if (!vpu->clocks)
753 		return -ENOMEM;
754 
755 	for (i = 0; i < vpu->variant->num_clocks; i++)
756 		vpu->clocks[i].id = vpu->variant->clk_names[i];
757 	ret = devm_clk_bulk_get(&pdev->dev, vpu->variant->num_clocks,
758 				vpu->clocks);
759 	if (ret)
760 		return ret;
761 
762 	num_bases = vpu->variant->num_regs ?: 1;
763 	vpu->reg_bases = devm_kcalloc(&pdev->dev, num_bases,
764 				      sizeof(*vpu->reg_bases), GFP_KERNEL);
765 	if (!vpu->reg_bases)
766 		return -ENOMEM;
767 
768 	for (i = 0; i < num_bases; i++) {
769 		res = vpu->variant->reg_names ?
770 		      platform_get_resource_byname(vpu->pdev, IORESOURCE_MEM,
771 						   vpu->variant->reg_names[i]) :
772 		      platform_get_resource(vpu->pdev, IORESOURCE_MEM, 0);
773 		vpu->reg_bases[i] = devm_ioremap_resource(vpu->dev, res);
774 		if (IS_ERR(vpu->reg_bases[i]))
775 			return PTR_ERR(vpu->reg_bases[i]);
776 	}
777 	vpu->enc_base = vpu->reg_bases[0] + vpu->variant->enc_offset;
778 	vpu->dec_base = vpu->reg_bases[0] + vpu->variant->dec_offset;
779 
780 	ret = dma_set_coherent_mask(vpu->dev, DMA_BIT_MASK(32));
781 	if (ret) {
782 		dev_err(vpu->dev, "Could not set DMA coherent mask.\n");
783 		return ret;
784 	}
785 	vb2_dma_contig_set_max_seg_size(&pdev->dev, DMA_BIT_MASK(32));
786 
787 	for (i = 0; i < vpu->variant->num_irqs; i++) {
788 		const char *irq_name = vpu->variant->irqs[i].name;
789 		int irq;
790 
791 		if (!vpu->variant->irqs[i].handler)
792 			continue;
793 
794 		irq = platform_get_irq_byname(vpu->pdev, irq_name);
795 		if (irq <= 0)
796 			return -ENXIO;
797 
798 		ret = devm_request_irq(vpu->dev, irq,
799 				       vpu->variant->irqs[i].handler, 0,
800 				       dev_name(vpu->dev), vpu);
801 		if (ret) {
802 			dev_err(vpu->dev, "Could not request %s IRQ.\n",
803 				irq_name);
804 			return ret;
805 		}
806 	}
807 
808 	ret = vpu->variant->init(vpu);
809 	if (ret) {
810 		dev_err(&pdev->dev, "Failed to init VPU hardware\n");
811 		return ret;
812 	}
813 
814 	pm_runtime_set_autosuspend_delay(vpu->dev, 100);
815 	pm_runtime_use_autosuspend(vpu->dev);
816 	pm_runtime_enable(vpu->dev);
817 
818 	ret = clk_bulk_prepare(vpu->variant->num_clocks, vpu->clocks);
819 	if (ret) {
820 		dev_err(&pdev->dev, "Failed to prepare clocks\n");
821 		return ret;
822 	}
823 
824 	ret = v4l2_device_register(&pdev->dev, &vpu->v4l2_dev);
825 	if (ret) {
826 		dev_err(&pdev->dev, "Failed to register v4l2 device\n");
827 		goto err_clk_unprepare;
828 	}
829 	platform_set_drvdata(pdev, vpu);
830 
831 	vpu->m2m_dev = v4l2_m2m_init(&vpu_m2m_ops);
832 	if (IS_ERR(vpu->m2m_dev)) {
833 		v4l2_err(&vpu->v4l2_dev, "Failed to init mem2mem device\n");
834 		ret = PTR_ERR(vpu->m2m_dev);
835 		goto err_v4l2_unreg;
836 	}
837 
838 	vpu->mdev.dev = vpu->dev;
839 	strscpy(vpu->mdev.model, DRIVER_NAME, sizeof(vpu->mdev.model));
840 	strscpy(vpu->mdev.bus_info, "platform: " DRIVER_NAME,
841 		sizeof(vpu->mdev.model));
842 	media_device_init(&vpu->mdev);
843 	vpu->mdev.ops = &hantro_m2m_media_ops;
844 	vpu->v4l2_dev.mdev = &vpu->mdev;
845 
846 	ret = hantro_add_enc_func(vpu);
847 	if (ret) {
848 		dev_err(&pdev->dev, "Failed to register encoder\n");
849 		goto err_m2m_rel;
850 	}
851 
852 	ret = hantro_add_dec_func(vpu);
853 	if (ret) {
854 		dev_err(&pdev->dev, "Failed to register decoder\n");
855 		goto err_rm_enc_func;
856 	}
857 
858 	ret = media_device_register(&vpu->mdev);
859 	if (ret) {
860 		v4l2_err(&vpu->v4l2_dev, "Failed to register mem2mem media device\n");
861 		goto err_rm_dec_func;
862 	}
863 
864 	return 0;
865 
866 err_rm_dec_func:
867 	hantro_remove_dec_func(vpu);
868 err_rm_enc_func:
869 	hantro_remove_enc_func(vpu);
870 err_m2m_rel:
871 	media_device_cleanup(&vpu->mdev);
872 	v4l2_m2m_release(vpu->m2m_dev);
873 err_v4l2_unreg:
874 	v4l2_device_unregister(&vpu->v4l2_dev);
875 err_clk_unprepare:
876 	clk_bulk_unprepare(vpu->variant->num_clocks, vpu->clocks);
877 	pm_runtime_dont_use_autosuspend(vpu->dev);
878 	pm_runtime_disable(vpu->dev);
879 	return ret;
880 }
881 
hantro_remove(struct platform_device * pdev)882 static int hantro_remove(struct platform_device *pdev)
883 {
884 	struct hantro_dev *vpu = platform_get_drvdata(pdev);
885 
886 	v4l2_info(&vpu->v4l2_dev, "Removing %s\n", pdev->name);
887 
888 	media_device_unregister(&vpu->mdev);
889 	hantro_remove_dec_func(vpu);
890 	hantro_remove_enc_func(vpu);
891 	media_device_cleanup(&vpu->mdev);
892 	v4l2_m2m_release(vpu->m2m_dev);
893 	v4l2_device_unregister(&vpu->v4l2_dev);
894 	clk_bulk_unprepare(vpu->variant->num_clocks, vpu->clocks);
895 	pm_runtime_dont_use_autosuspend(vpu->dev);
896 	pm_runtime_disable(vpu->dev);
897 	return 0;
898 }
899 
900 #ifdef CONFIG_PM
hantro_runtime_resume(struct device * dev)901 static int hantro_runtime_resume(struct device *dev)
902 {
903 	struct hantro_dev *vpu = dev_get_drvdata(dev);
904 
905 	if (vpu->variant->runtime_resume)
906 		return vpu->variant->runtime_resume(vpu);
907 
908 	return 0;
909 }
910 #endif
911 
912 static const struct dev_pm_ops hantro_pm_ops = {
913 	SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
914 				pm_runtime_force_resume)
915 	SET_RUNTIME_PM_OPS(NULL, hantro_runtime_resume, NULL)
916 };
917 
918 static struct platform_driver hantro_driver = {
919 	.probe = hantro_probe,
920 	.remove = hantro_remove,
921 	.driver = {
922 		   .name = DRIVER_NAME,
923 		   .of_match_table = of_match_ptr(of_hantro_match),
924 		   .pm = &hantro_pm_ops,
925 	},
926 };
927 module_platform_driver(hantro_driver);
928 
929 MODULE_LICENSE("GPL v2");
930 MODULE_AUTHOR("Alpha Lin <Alpha.Lin@Rock-Chips.com>");
931 MODULE_AUTHOR("Tomasz Figa <tfiga@chromium.org>");
932 MODULE_AUTHOR("Ezequiel Garcia <ezequiel@collabora.com>");
933 MODULE_DESCRIPTION("Hantro VPU codec driver");
934