drm/bridge: dw-hdmi: Sync comment block with actual bus formats order
[drm/drm-misc.git] / drivers / media / platform / samsung / s5p-mfc / s5p_mfc.c
blob5f80931f056dbf3f492a216aa09d4abea909a9d5
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * Samsung S5P Multi Format Codec v 5.1
5 * Copyright (c) 2011 Samsung Electronics Co., Ltd.
6 * Kamil Debski, <k.debski@samsung.com>
7 */
9 #include <linux/clk.h>
10 #include <linux/delay.h>
11 #include <linux/interrupt.h>
12 #include <linux/io.h>
13 #include <linux/module.h>
14 #include <linux/platform_device.h>
15 #include <linux/sched.h>
16 #include <linux/slab.h>
17 #include <linux/videodev2.h>
18 #include <media/v4l2-event.h>
19 #include <linux/workqueue.h>
20 #include <linux/of.h>
21 #include <linux/of_device.h>
22 #include <linux/of_reserved_mem.h>
23 #include <media/videobuf2-v4l2.h>
24 #include "s5p_mfc_common.h"
25 #include "s5p_mfc_ctrl.h"
26 #include "s5p_mfc_debug.h"
27 #include "s5p_mfc_dec.h"
28 #include "s5p_mfc_enc.h"
29 #include "s5p_mfc_intr.h"
30 #include "s5p_mfc_iommu.h"
31 #include "s5p_mfc_opr.h"
32 #include "s5p_mfc_cmd.h"
33 #include "s5p_mfc_pm.h"
35 #define S5P_MFC_DEC_NAME "s5p-mfc-dec"
36 #define S5P_MFC_ENC_NAME "s5p-mfc-enc"
38 int mfc_debug_level;
39 module_param_named(debug, mfc_debug_level, int, 0644);
40 MODULE_PARM_DESC(debug, "Debug level - higher value produces more verbose messages");
42 static char *mfc_mem_size;
43 module_param_named(mem, mfc_mem_size, charp, 0644);
44 MODULE_PARM_DESC(mem, "Preallocated memory size for the firmware and context buffers");
46 /* Helper functions for interrupt processing */
48 /* Remove from hw execution round robin */
49 void clear_work_bit(struct s5p_mfc_ctx *ctx)
51 struct s5p_mfc_dev *dev = ctx->dev;
53 spin_lock(&dev->condlock);
54 __clear_bit(ctx->num, &dev->ctx_work_bits);
55 spin_unlock(&dev->condlock);
58 /* Add to hw execution round robin */
59 void set_work_bit(struct s5p_mfc_ctx *ctx)
61 struct s5p_mfc_dev *dev = ctx->dev;
63 spin_lock(&dev->condlock);
64 __set_bit(ctx->num, &dev->ctx_work_bits);
65 spin_unlock(&dev->condlock);
68 /* Remove from hw execution round robin */
69 void clear_work_bit_irqsave(struct s5p_mfc_ctx *ctx)
71 struct s5p_mfc_dev *dev = ctx->dev;
72 unsigned long flags;
74 spin_lock_irqsave(&dev->condlock, flags);
75 __clear_bit(ctx->num, &dev->ctx_work_bits);
76 spin_unlock_irqrestore(&dev->condlock, flags);
79 /* Add to hw execution round robin */
80 void set_work_bit_irqsave(struct s5p_mfc_ctx *ctx)
82 struct s5p_mfc_dev *dev = ctx->dev;
83 unsigned long flags;
85 spin_lock_irqsave(&dev->condlock, flags);
86 __set_bit(ctx->num, &dev->ctx_work_bits);
87 spin_unlock_irqrestore(&dev->condlock, flags);
90 int s5p_mfc_get_new_ctx(struct s5p_mfc_dev *dev)
92 unsigned long flags;
93 int ctx;
95 spin_lock_irqsave(&dev->condlock, flags);
96 ctx = dev->curr_ctx;
97 do {
98 ctx = (ctx + 1) % MFC_NUM_CONTEXTS;
99 if (ctx == dev->curr_ctx) {
100 if (!test_bit(ctx, &dev->ctx_work_bits))
101 ctx = -EAGAIN;
102 break;
104 } while (!test_bit(ctx, &dev->ctx_work_bits));
105 spin_unlock_irqrestore(&dev->condlock, flags);
107 return ctx;
110 /* Wake up context wait_queue */
111 static void wake_up_ctx(struct s5p_mfc_ctx *ctx, unsigned int reason,
112 unsigned int err)
114 ctx->int_cond = 1;
115 ctx->int_type = reason;
116 ctx->int_err = err;
117 wake_up(&ctx->queue);
120 /* Wake up device wait_queue */
121 static void wake_up_dev(struct s5p_mfc_dev *dev, unsigned int reason,
122 unsigned int err)
124 dev->int_cond = 1;
125 dev->int_type = reason;
126 dev->int_err = err;
127 wake_up(&dev->queue);
130 void s5p_mfc_cleanup_queue(struct list_head *lh, struct vb2_queue *vq)
132 struct s5p_mfc_buf *b;
133 int i;
135 while (!list_empty(lh)) {
136 b = list_entry(lh->next, struct s5p_mfc_buf, list);
137 for (i = 0; i < b->b->vb2_buf.num_planes; i++)
138 vb2_set_plane_payload(&b->b->vb2_buf, i, 0);
139 vb2_buffer_done(&b->b->vb2_buf, VB2_BUF_STATE_ERROR);
140 list_del(&b->list);
144 static void s5p_mfc_watchdog(struct timer_list *t)
146 struct s5p_mfc_dev *dev = from_timer(dev, t, watchdog_timer);
148 if (test_bit(0, &dev->hw_lock))
149 atomic_inc(&dev->watchdog_cnt);
150 if (atomic_read(&dev->watchdog_cnt) >= MFC_WATCHDOG_CNT) {
152 * This means that hw is busy and no interrupts were
153 * generated by hw for the Nth time of running this
154 * watchdog timer. This usually means a serious hw
155 * error. Now it is time to kill all instances and
156 * reset the MFC.
158 mfc_err("Time out during waiting for HW\n");
159 schedule_work(&dev->watchdog_work);
161 dev->watchdog_timer.expires = jiffies +
162 msecs_to_jiffies(MFC_WATCHDOG_INTERVAL);
163 add_timer(&dev->watchdog_timer);
166 static void s5p_mfc_watchdog_worker(struct work_struct *work)
168 struct s5p_mfc_dev *dev;
169 struct s5p_mfc_ctx *ctx;
170 unsigned long flags;
171 int mutex_locked;
172 int i, ret;
174 dev = container_of(work, struct s5p_mfc_dev, watchdog_work);
176 mfc_err("Driver timeout error handling\n");
178 * Lock the mutex that protects open and release.
179 * This is necessary as they may load and unload firmware.
181 mutex_locked = mutex_trylock(&dev->mfc_mutex);
182 if (!mutex_locked)
183 mfc_err("Error: some instance may be closing/opening\n");
184 spin_lock_irqsave(&dev->irqlock, flags);
186 s5p_mfc_clock_off(dev);
188 for (i = 0; i < MFC_NUM_CONTEXTS; i++) {
189 ctx = dev->ctx[i];
190 if (!ctx)
191 continue;
192 ctx->state = MFCINST_ERROR;
193 s5p_mfc_cleanup_queue(&ctx->dst_queue, &ctx->vq_dst);
194 s5p_mfc_cleanup_queue(&ctx->src_queue, &ctx->vq_src);
195 clear_work_bit(ctx);
196 wake_up_ctx(ctx, S5P_MFC_R2H_CMD_ERR_RET, 0);
198 clear_bit(0, &dev->hw_lock);
199 spin_unlock_irqrestore(&dev->irqlock, flags);
201 /* De-init MFC */
202 s5p_mfc_deinit_hw(dev);
205 * Double check if there is at least one instance running.
206 * If no instance is in memory than no firmware should be present
208 if (dev->num_inst > 0) {
209 ret = s5p_mfc_load_firmware(dev);
210 if (ret) {
211 mfc_err("Failed to reload FW\n");
212 goto unlock;
214 s5p_mfc_clock_on(dev);
215 ret = s5p_mfc_init_hw(dev);
216 s5p_mfc_clock_off(dev);
217 if (ret)
218 mfc_err("Failed to reinit FW\n");
220 unlock:
221 if (mutex_locked)
222 mutex_unlock(&dev->mfc_mutex);
225 static void s5p_mfc_handle_frame_all_extracted(struct s5p_mfc_ctx *ctx)
227 struct s5p_mfc_buf *dst_buf;
228 struct s5p_mfc_dev *dev = ctx->dev;
230 ctx->state = MFCINST_FINISHED;
231 ctx->sequence++;
232 while (!list_empty(&ctx->dst_queue)) {
233 dst_buf = list_entry(ctx->dst_queue.next,
234 struct s5p_mfc_buf, list);
235 mfc_debug(2, "Cleaning up buffer: %d\n",
236 dst_buf->b->vb2_buf.index);
237 vb2_set_plane_payload(&dst_buf->b->vb2_buf, 0, 0);
238 vb2_set_plane_payload(&dst_buf->b->vb2_buf, 1, 0);
239 list_del(&dst_buf->list);
240 dst_buf->flags |= MFC_BUF_FLAG_EOS;
241 ctx->dst_queue_cnt--;
242 dst_buf->b->sequence = (ctx->sequence++);
244 if (s5p_mfc_hw_call(dev->mfc_ops, get_pic_type_top, ctx) ==
245 s5p_mfc_hw_call(dev->mfc_ops, get_pic_type_bot, ctx))
246 dst_buf->b->field = V4L2_FIELD_NONE;
247 else
248 dst_buf->b->field = V4L2_FIELD_INTERLACED;
249 dst_buf->b->flags |= V4L2_BUF_FLAG_LAST;
251 ctx->dec_dst_flag &= ~(1 << dst_buf->b->vb2_buf.index);
252 vb2_buffer_done(&dst_buf->b->vb2_buf, VB2_BUF_STATE_DONE);
256 static void s5p_mfc_handle_frame_copy_time(struct s5p_mfc_ctx *ctx)
258 struct s5p_mfc_dev *dev = ctx->dev;
259 struct s5p_mfc_buf *dst_buf, *src_buf;
260 u32 dec_y_addr;
261 unsigned int frame_type;
263 /* Make sure we actually have a new frame before continuing. */
264 frame_type = s5p_mfc_hw_call(dev->mfc_ops, get_dec_frame_type, dev);
265 if (frame_type == S5P_FIMV_DECODE_FRAME_SKIPPED)
266 return;
267 dec_y_addr = (u32)s5p_mfc_hw_call(dev->mfc_ops, get_dec_y_adr, dev);
270 * Copy timestamp / timecode from decoded src to dst and set
271 * appropriate flags.
273 src_buf = list_entry(ctx->src_queue.next, struct s5p_mfc_buf, list);
274 list_for_each_entry(dst_buf, &ctx->dst_queue, list) {
275 u32 addr = (u32)vb2_dma_contig_plane_dma_addr(&dst_buf->b->vb2_buf, 0);
277 if (addr == dec_y_addr) {
278 dst_buf->b->timecode = src_buf->b->timecode;
279 dst_buf->b->vb2_buf.timestamp =
280 src_buf->b->vb2_buf.timestamp;
281 dst_buf->b->flags &=
282 ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
283 dst_buf->b->flags |=
284 src_buf->b->flags
285 & V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
286 switch (frame_type) {
287 case S5P_FIMV_DECODE_FRAME_I_FRAME:
288 dst_buf->b->flags |=
289 V4L2_BUF_FLAG_KEYFRAME;
290 break;
291 case S5P_FIMV_DECODE_FRAME_P_FRAME:
292 dst_buf->b->flags |=
293 V4L2_BUF_FLAG_PFRAME;
294 break;
295 case S5P_FIMV_DECODE_FRAME_B_FRAME:
296 dst_buf->b->flags |=
297 V4L2_BUF_FLAG_BFRAME;
298 break;
299 default:
301 * Don't know how to handle
302 * S5P_FIMV_DECODE_FRAME_OTHER_FRAME.
304 mfc_debug(2, "Unexpected frame type: %d\n",
305 frame_type);
307 break;
312 static void s5p_mfc_handle_frame_new(struct s5p_mfc_ctx *ctx, unsigned int err)
314 struct s5p_mfc_dev *dev = ctx->dev;
315 struct s5p_mfc_buf *dst_buf;
316 u32 dspl_y_addr;
317 unsigned int frame_type;
319 dspl_y_addr = (u32)s5p_mfc_hw_call(dev->mfc_ops, get_dspl_y_adr, dev);
320 if (IS_MFCV6_PLUS(dev))
321 frame_type = s5p_mfc_hw_call(dev->mfc_ops,
322 get_disp_frame_type, ctx);
323 else
324 frame_type = s5p_mfc_hw_call(dev->mfc_ops,
325 get_dec_frame_type, dev);
327 /* If frame is same as previous then skip and do not dequeue */
328 if (frame_type == S5P_FIMV_DECODE_FRAME_SKIPPED) {
329 if (!ctx->after_packed_pb)
330 ctx->sequence++;
331 ctx->after_packed_pb = 0;
332 return;
334 ctx->sequence++;
336 * The MFC returns address of the buffer, now we have to
337 * check which vb2_buffer does it correspond to
339 list_for_each_entry(dst_buf, &ctx->dst_queue, list) {
340 u32 addr = (u32)vb2_dma_contig_plane_dma_addr(&dst_buf->b->vb2_buf, 0);
342 /* Check if this is the buffer we're looking for */
343 if (addr == dspl_y_addr) {
344 list_del(&dst_buf->list);
345 ctx->dst_queue_cnt--;
346 dst_buf->b->sequence = ctx->sequence;
347 if (s5p_mfc_hw_call(dev->mfc_ops,
348 get_pic_type_top, ctx) ==
349 s5p_mfc_hw_call(dev->mfc_ops,
350 get_pic_type_bot, ctx))
351 dst_buf->b->field = V4L2_FIELD_NONE;
352 else
353 dst_buf->b->field =
354 V4L2_FIELD_INTERLACED;
355 vb2_set_plane_payload(&dst_buf->b->vb2_buf, 0,
356 ctx->luma_size);
357 vb2_set_plane_payload(&dst_buf->b->vb2_buf, 1,
358 ctx->chroma_size);
359 clear_bit(dst_buf->b->vb2_buf.index,
360 &ctx->dec_dst_flag);
362 vb2_buffer_done(&dst_buf->b->vb2_buf, err ?
363 VB2_BUF_STATE_ERROR : VB2_BUF_STATE_DONE);
365 break;
370 /* Handle frame decoding interrupt */
371 static void s5p_mfc_handle_frame(struct s5p_mfc_ctx *ctx,
372 unsigned int reason, unsigned int err)
374 struct s5p_mfc_dev *dev = ctx->dev;
375 unsigned int dst_frame_status;
376 unsigned int dec_frame_status;
377 struct s5p_mfc_buf *src_buf;
378 unsigned int res_change;
380 dst_frame_status = s5p_mfc_hw_call(dev->mfc_ops, get_dspl_status, dev)
381 & S5P_FIMV_DEC_STATUS_DECODING_STATUS_MASK;
382 dec_frame_status = s5p_mfc_hw_call(dev->mfc_ops, get_dec_status, dev)
383 & S5P_FIMV_DEC_STATUS_DECODING_STATUS_MASK;
384 res_change = (s5p_mfc_hw_call(dev->mfc_ops, get_dspl_status, dev)
385 & S5P_FIMV_DEC_STATUS_RESOLUTION_MASK)
386 >> S5P_FIMV_DEC_STATUS_RESOLUTION_SHIFT;
387 mfc_debug(2, "Frame Status: %x\n", dst_frame_status);
388 if (ctx->state == MFCINST_RES_CHANGE_INIT)
389 ctx->state = MFCINST_RES_CHANGE_FLUSH;
390 if (res_change == S5P_FIMV_RES_INCREASE ||
391 res_change == S5P_FIMV_RES_DECREASE) {
392 ctx->state = MFCINST_RES_CHANGE_INIT;
393 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
394 wake_up_ctx(ctx, reason, err);
395 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
396 s5p_mfc_clock_off(dev);
397 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
398 return;
400 if (ctx->dpb_flush_flag)
401 ctx->dpb_flush_flag = 0;
403 /* All frames remaining in the buffer have been extracted */
404 if (dst_frame_status == S5P_FIMV_DEC_STATUS_DECODING_EMPTY) {
405 if (ctx->state == MFCINST_RES_CHANGE_FLUSH) {
406 static const struct v4l2_event ev_src_ch = {
407 .type = V4L2_EVENT_SOURCE_CHANGE,
408 .u.src_change.changes =
409 V4L2_EVENT_SRC_CH_RESOLUTION,
412 s5p_mfc_handle_frame_all_extracted(ctx);
413 ctx->state = MFCINST_RES_CHANGE_END;
414 v4l2_event_queue_fh(&ctx->fh, &ev_src_ch);
416 goto leave_handle_frame;
417 } else {
418 s5p_mfc_handle_frame_all_extracted(ctx);
422 if (dec_frame_status == S5P_FIMV_DEC_STATUS_DECODING_DISPLAY)
423 s5p_mfc_handle_frame_copy_time(ctx);
425 /* A frame has been decoded and is in the buffer */
426 if (dst_frame_status == S5P_FIMV_DEC_STATUS_DISPLAY_ONLY ||
427 dst_frame_status == S5P_FIMV_DEC_STATUS_DECODING_DISPLAY) {
428 s5p_mfc_handle_frame_new(ctx, err);
429 } else {
430 mfc_debug(2, "No frame decode\n");
432 /* Mark source buffer as complete */
433 if (dst_frame_status != S5P_FIMV_DEC_STATUS_DISPLAY_ONLY
434 && !list_empty(&ctx->src_queue)) {
435 src_buf = list_entry(ctx->src_queue.next, struct s5p_mfc_buf,
436 list);
437 ctx->consumed_stream += s5p_mfc_hw_call(dev->mfc_ops,
438 get_consumed_stream, dev);
439 if (ctx->codec_mode != S5P_MFC_CODEC_H264_DEC &&
440 ctx->codec_mode != S5P_MFC_CODEC_VP8_DEC &&
441 ctx->consumed_stream + STUFF_BYTE <
442 src_buf->b->vb2_buf.planes[0].bytesused) {
443 /* Run MFC again on the same buffer */
444 mfc_debug(2, "Running again the same buffer\n");
445 ctx->after_packed_pb = 1;
446 } else {
447 mfc_debug(2, "MFC needs next buffer\n");
448 ctx->consumed_stream = 0;
449 if (src_buf->flags & MFC_BUF_FLAG_EOS)
450 ctx->state = MFCINST_FINISHING;
451 list_del(&src_buf->list);
452 ctx->src_queue_cnt--;
453 if (s5p_mfc_hw_call(dev->mfc_ops, err_dec, err) > 0)
454 vb2_buffer_done(&src_buf->b->vb2_buf,
455 VB2_BUF_STATE_ERROR);
456 else
457 vb2_buffer_done(&src_buf->b->vb2_buf,
458 VB2_BUF_STATE_DONE);
461 leave_handle_frame:
462 if ((ctx->src_queue_cnt == 0 && ctx->state != MFCINST_FINISHING)
463 || ctx->dst_queue_cnt < ctx->pb_count)
464 clear_work_bit(ctx);
465 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
466 wake_up_ctx(ctx, reason, err);
467 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
468 s5p_mfc_clock_off(dev);
469 /* if suspending, wake up device and do not try_run again*/
470 if (test_bit(0, &dev->enter_suspend))
471 wake_up_dev(dev, reason, err);
472 else
473 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
476 /* Error handling for interrupt */
477 static void s5p_mfc_handle_error(struct s5p_mfc_dev *dev,
478 struct s5p_mfc_ctx *ctx, unsigned int reason, unsigned int err)
480 mfc_err("Interrupt Error: %08x\n", err);
482 if (ctx) {
483 /* Error recovery is dependent on the state of context */
484 switch (ctx->state) {
485 case MFCINST_RES_CHANGE_INIT:
486 case MFCINST_RES_CHANGE_FLUSH:
487 case MFCINST_RES_CHANGE_END:
488 case MFCINST_FINISHING:
489 case MFCINST_FINISHED:
490 case MFCINST_RUNNING:
492 * It is highly probable that an error occurred
493 * while decoding a frame
495 clear_work_bit(ctx);
496 ctx->state = MFCINST_ERROR;
497 /* Mark all dst buffers as having an error */
498 s5p_mfc_cleanup_queue(&ctx->dst_queue, &ctx->vq_dst);
499 /* Mark all src buffers as having an error */
500 s5p_mfc_cleanup_queue(&ctx->src_queue, &ctx->vq_src);
501 wake_up_ctx(ctx, reason, err);
502 break;
503 default:
504 clear_work_bit(ctx);
505 ctx->state = MFCINST_ERROR;
506 wake_up_ctx(ctx, reason, err);
507 break;
510 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
511 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
512 s5p_mfc_clock_off(dev);
513 wake_up_dev(dev, reason, err);
516 /* Header parsing interrupt handling */
517 static void s5p_mfc_handle_seq_done(struct s5p_mfc_ctx *ctx,
518 unsigned int reason, unsigned int err)
520 struct s5p_mfc_dev *dev;
522 if (!ctx)
523 return;
524 dev = ctx->dev;
525 if (ctx->c_ops->post_seq_start) {
526 if (ctx->c_ops->post_seq_start(ctx))
527 mfc_err("post_seq_start() failed\n");
528 } else {
529 ctx->img_width = s5p_mfc_hw_call(dev->mfc_ops, get_img_width,
530 dev);
531 ctx->img_height = s5p_mfc_hw_call(dev->mfc_ops, get_img_height,
532 dev);
534 s5p_mfc_hw_call(dev->mfc_ops, dec_calc_dpb_size, ctx);
536 ctx->pb_count = s5p_mfc_hw_call(dev->mfc_ops, get_dpb_count,
537 dev);
538 ctx->mv_count = s5p_mfc_hw_call(dev->mfc_ops, get_mv_count,
539 dev);
540 if (FW_HAS_E_MIN_SCRATCH_BUF(dev))
541 ctx->scratch_buf_size = s5p_mfc_hw_call(dev->mfc_ops,
542 get_min_scratch_buf_size, dev);
543 if (ctx->img_width == 0 || ctx->img_height == 0)
544 ctx->state = MFCINST_ERROR;
545 else
546 ctx->state = MFCINST_HEAD_PARSED;
548 if ((ctx->codec_mode == S5P_MFC_CODEC_H264_DEC ||
549 ctx->codec_mode == S5P_MFC_CODEC_H264_MVC_DEC) &&
550 !list_empty(&ctx->src_queue)) {
551 struct s5p_mfc_buf *src_buf;
553 src_buf = list_entry(ctx->src_queue.next,
554 struct s5p_mfc_buf, list);
555 if (s5p_mfc_hw_call(dev->mfc_ops, get_consumed_stream,
556 dev) <
557 src_buf->b->vb2_buf.planes[0].bytesused)
558 ctx->head_processed = 0;
559 else
560 ctx->head_processed = 1;
561 } else {
562 ctx->head_processed = 1;
565 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
566 clear_work_bit(ctx);
567 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
568 s5p_mfc_clock_off(dev);
569 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
570 wake_up_ctx(ctx, reason, err);
573 /* Header parsing interrupt handling */
574 static void s5p_mfc_handle_init_buffers(struct s5p_mfc_ctx *ctx,
575 unsigned int reason, unsigned int err)
577 struct s5p_mfc_buf *src_buf;
578 struct s5p_mfc_dev *dev;
580 if (!ctx)
581 return;
582 dev = ctx->dev;
583 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
584 ctx->int_type = reason;
585 ctx->int_err = err;
586 ctx->int_cond = 1;
587 clear_work_bit(ctx);
588 if (err == 0) {
589 ctx->state = MFCINST_RUNNING;
590 if (!ctx->dpb_flush_flag && ctx->head_processed) {
591 if (!list_empty(&ctx->src_queue)) {
592 src_buf = list_entry(ctx->src_queue.next,
593 struct s5p_mfc_buf, list);
594 list_del(&src_buf->list);
595 ctx->src_queue_cnt--;
596 vb2_buffer_done(&src_buf->b->vb2_buf,
597 VB2_BUF_STATE_DONE);
599 } else {
600 ctx->dpb_flush_flag = 0;
602 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
604 s5p_mfc_clock_off(dev);
606 wake_up(&ctx->queue);
607 if (ctx->src_queue_cnt >= 1 && ctx->dst_queue_cnt >= 1)
608 set_work_bit_irqsave(ctx);
609 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
610 } else {
611 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
613 s5p_mfc_clock_off(dev);
615 wake_up(&ctx->queue);
619 static void s5p_mfc_handle_stream_complete(struct s5p_mfc_ctx *ctx)
621 struct s5p_mfc_dev *dev = ctx->dev;
622 struct s5p_mfc_buf *mb_entry;
624 mfc_debug(2, "Stream completed\n");
626 ctx->state = MFCINST_FINISHED;
628 if (!list_empty(&ctx->dst_queue)) {
629 mb_entry = list_entry(ctx->dst_queue.next, struct s5p_mfc_buf,
630 list);
631 list_del(&mb_entry->list);
632 ctx->dst_queue_cnt--;
633 vb2_set_plane_payload(&mb_entry->b->vb2_buf, 0, 0);
634 vb2_buffer_done(&mb_entry->b->vb2_buf, VB2_BUF_STATE_DONE);
637 clear_work_bit(ctx);
639 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
641 s5p_mfc_clock_off(dev);
642 wake_up(&ctx->queue);
643 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
646 /* Interrupt processing */
647 static irqreturn_t s5p_mfc_irq(int irq, void *priv)
649 struct s5p_mfc_dev *dev = priv;
650 struct s5p_mfc_ctx *ctx;
651 unsigned int reason;
652 unsigned int err;
654 mfc_debug_enter();
655 /* Reset the timeout watchdog */
656 atomic_set(&dev->watchdog_cnt, 0);
657 spin_lock(&dev->irqlock);
658 ctx = dev->ctx[dev->curr_ctx];
659 /* Get the reason of interrupt and the error code */
660 reason = s5p_mfc_hw_call(dev->mfc_ops, get_int_reason, dev);
661 err = s5p_mfc_hw_call(dev->mfc_ops, get_int_err, dev);
662 mfc_debug(1, "Int reason: %d (err: %08x)\n", reason, err);
663 switch (reason) {
664 case S5P_MFC_R2H_CMD_ERR_RET:
665 /* An error has occurred */
666 if (ctx->state == MFCINST_RUNNING &&
667 (s5p_mfc_hw_call(dev->mfc_ops, err_dec, err) >=
668 dev->warn_start ||
669 err == S5P_FIMV_ERR_NO_VALID_SEQ_HDR ||
670 err == S5P_FIMV_ERR_INCOMPLETE_FRAME ||
671 err == S5P_FIMV_ERR_TIMEOUT))
672 s5p_mfc_handle_frame(ctx, reason, err);
673 else
674 s5p_mfc_handle_error(dev, ctx, reason, err);
675 clear_bit(0, &dev->enter_suspend);
676 break;
678 case S5P_MFC_R2H_CMD_SLICE_DONE_RET:
679 case S5P_MFC_R2H_CMD_FIELD_DONE_RET:
680 case S5P_MFC_R2H_CMD_FRAME_DONE_RET:
681 if (ctx->c_ops->post_frame_start) {
682 if (ctx->c_ops->post_frame_start(ctx))
683 mfc_err("post_frame_start() failed\n");
685 if (ctx->state == MFCINST_FINISHING &&
686 list_empty(&ctx->ref_queue)) {
687 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
688 s5p_mfc_handle_stream_complete(ctx);
689 break;
691 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
692 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
693 s5p_mfc_clock_off(dev);
694 wake_up_ctx(ctx, reason, err);
695 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
696 } else {
697 s5p_mfc_handle_frame(ctx, reason, err);
699 break;
701 case S5P_MFC_R2H_CMD_SEQ_DONE_RET:
702 s5p_mfc_handle_seq_done(ctx, reason, err);
703 break;
705 case S5P_MFC_R2H_CMD_OPEN_INSTANCE_RET:
706 ctx->inst_no = s5p_mfc_hw_call(dev->mfc_ops, get_inst_no, dev);
707 ctx->state = MFCINST_GOT_INST;
708 goto irq_cleanup_hw;
710 case S5P_MFC_R2H_CMD_CLOSE_INSTANCE_RET:
711 ctx->inst_no = MFC_NO_INSTANCE_SET;
712 ctx->state = MFCINST_FREE;
713 goto irq_cleanup_hw;
715 case S5P_MFC_R2H_CMD_SYS_INIT_RET:
716 case S5P_MFC_R2H_CMD_FW_STATUS_RET:
717 case S5P_MFC_R2H_CMD_SLEEP_RET:
718 case S5P_MFC_R2H_CMD_WAKEUP_RET:
719 if (ctx)
720 clear_work_bit(ctx);
721 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
722 clear_bit(0, &dev->hw_lock);
723 clear_bit(0, &dev->enter_suspend);
724 wake_up_dev(dev, reason, err);
725 break;
727 case S5P_MFC_R2H_CMD_INIT_BUFFERS_RET:
728 s5p_mfc_handle_init_buffers(ctx, reason, err);
729 break;
731 case S5P_MFC_R2H_CMD_COMPLETE_SEQ_RET:
732 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
733 ctx->int_type = reason;
734 ctx->int_err = err;
735 s5p_mfc_handle_stream_complete(ctx);
736 break;
738 case S5P_MFC_R2H_CMD_DPB_FLUSH_RET:
739 ctx->state = MFCINST_RUNNING;
740 goto irq_cleanup_hw;
742 default:
743 mfc_debug(2, "Unknown int reason\n");
744 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
746 spin_unlock(&dev->irqlock);
747 mfc_debug_leave();
748 return IRQ_HANDLED;
749 irq_cleanup_hw:
750 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
751 ctx->int_type = reason;
752 ctx->int_err = err;
753 ctx->int_cond = 1;
754 if (test_and_clear_bit(0, &dev->hw_lock) == 0)
755 mfc_err("Failed to unlock hw\n");
757 s5p_mfc_clock_off(dev);
758 clear_work_bit(ctx);
759 wake_up(&ctx->queue);
761 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
762 spin_unlock(&dev->irqlock);
763 mfc_debug(2, "Exit via irq_cleanup_hw\n");
764 return IRQ_HANDLED;
767 /* Open an MFC node */
768 static int s5p_mfc_open(struct file *file)
770 struct video_device *vdev = video_devdata(file);
771 struct s5p_mfc_dev *dev = video_drvdata(file);
772 struct s5p_mfc_ctx *ctx = NULL;
773 struct vb2_queue *q;
774 int ret = 0;
776 mfc_debug_enter();
777 if (mutex_lock_interruptible(&dev->mfc_mutex)) {
778 ret = -ERESTARTSYS;
779 goto err_enter;
781 dev->num_inst++; /* It is guarded by mfc_mutex in vfd */
782 /* Allocate memory for context */
783 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
784 if (!ctx) {
785 ret = -ENOMEM;
786 goto err_alloc;
788 init_waitqueue_head(&ctx->queue);
789 v4l2_fh_init(&ctx->fh, vdev);
790 file->private_data = &ctx->fh;
791 v4l2_fh_add(&ctx->fh);
792 ctx->dev = dev;
793 INIT_LIST_HEAD(&ctx->src_queue);
794 INIT_LIST_HEAD(&ctx->dst_queue);
795 ctx->src_queue_cnt = 0;
796 ctx->dst_queue_cnt = 0;
797 ctx->is_422 = 0;
798 ctx->is_10bit = 0;
799 /* Get context number */
800 ctx->num = 0;
801 while (dev->ctx[ctx->num]) {
802 ctx->num++;
803 if (ctx->num >= MFC_NUM_CONTEXTS) {
804 mfc_debug(2, "Too many open contexts\n");
805 ret = -EBUSY;
806 goto err_no_ctx;
809 /* Mark context as idle */
810 clear_work_bit_irqsave(ctx);
811 dev->ctx[ctx->num] = ctx;
812 if (vdev == dev->vfd_dec) {
813 ctx->type = MFCINST_DECODER;
814 ctx->c_ops = get_dec_codec_ops();
815 s5p_mfc_dec_init(ctx);
816 /* Setup ctrl handler */
817 ret = s5p_mfc_dec_ctrls_setup(ctx);
818 if (ret) {
819 mfc_err("Failed to setup mfc controls\n");
820 goto err_ctrls_setup;
822 } else if (vdev == dev->vfd_enc) {
823 ctx->type = MFCINST_ENCODER;
824 ctx->c_ops = get_enc_codec_ops();
825 /* only for encoder */
826 INIT_LIST_HEAD(&ctx->ref_queue);
827 ctx->ref_queue_cnt = 0;
828 s5p_mfc_enc_init(ctx);
829 /* Setup ctrl handler */
830 ret = s5p_mfc_enc_ctrls_setup(ctx);
831 if (ret) {
832 mfc_err("Failed to setup mfc controls\n");
833 goto err_ctrls_setup;
835 } else {
836 ret = -ENOENT;
837 goto err_bad_node;
839 ctx->fh.ctrl_handler = &ctx->ctrl_handler;
840 ctx->inst_no = MFC_NO_INSTANCE_SET;
841 /* Load firmware if this is the first instance */
842 if (dev->num_inst == 1) {
843 dev->watchdog_timer.expires = jiffies +
844 msecs_to_jiffies(MFC_WATCHDOG_INTERVAL);
845 add_timer(&dev->watchdog_timer);
846 ret = s5p_mfc_power_on(dev);
847 if (ret < 0) {
848 mfc_err("power on failed\n");
849 goto err_pwr_enable;
851 s5p_mfc_clock_on(dev);
852 ret = s5p_mfc_load_firmware(dev);
853 if (ret) {
854 s5p_mfc_clock_off(dev);
855 goto err_load_fw;
857 /* Init the FW */
858 ret = s5p_mfc_init_hw(dev);
859 s5p_mfc_clock_off(dev);
860 if (ret)
861 goto err_init_hw;
863 /* Init videobuf2 queue for CAPTURE */
864 q = &ctx->vq_dst;
865 q->type = V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE;
866 q->drv_priv = &ctx->fh;
867 q->lock = &dev->mfc_mutex;
868 if (vdev == dev->vfd_dec) {
869 q->io_modes = VB2_MMAP;
870 q->ops = get_dec_queue_ops();
871 } else if (vdev == dev->vfd_enc) {
872 q->io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF;
873 q->ops = get_enc_queue_ops();
874 } else {
875 ret = -ENOENT;
876 goto err_queue_init;
879 * We'll do mostly sequential access, so sacrifice TLB efficiency for
880 * faster allocation.
882 q->dma_attrs = DMA_ATTR_ALLOC_SINGLE_PAGES;
883 q->mem_ops = &vb2_dma_contig_memops;
884 q->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_COPY;
885 ret = vb2_queue_init(q);
886 if (ret) {
887 mfc_err("Failed to initialize videobuf2 queue(capture)\n");
888 goto err_queue_init;
890 /* Init videobuf2 queue for OUTPUT */
891 q = &ctx->vq_src;
892 q->type = V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE;
893 q->drv_priv = &ctx->fh;
894 q->lock = &dev->mfc_mutex;
895 if (vdev == dev->vfd_dec) {
896 q->io_modes = VB2_MMAP;
897 q->ops = get_dec_queue_ops();
898 } else if (vdev == dev->vfd_enc) {
899 q->io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF;
900 q->ops = get_enc_queue_ops();
901 } else {
902 ret = -ENOENT;
903 goto err_queue_init;
905 /* One way to indicate end-of-stream for MFC is to set the
906 * bytesused == 0. However by default videobuf2 handles bytesused
907 * equal to 0 as a special case and changes its value to the size
908 * of the buffer. Set the allow_zero_bytesused flag so that videobuf2
909 * will keep the value of bytesused intact.
911 q->allow_zero_bytesused = 1;
914 * We'll do mostly sequential access, so sacrifice TLB efficiency for
915 * faster allocation.
917 q->dma_attrs = DMA_ATTR_ALLOC_SINGLE_PAGES;
918 q->mem_ops = &vb2_dma_contig_memops;
919 q->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_COPY;
920 ret = vb2_queue_init(q);
921 if (ret) {
922 mfc_err("Failed to initialize videobuf2 queue(output)\n");
923 goto err_queue_init;
925 mutex_unlock(&dev->mfc_mutex);
926 mfc_debug_leave();
927 return ret;
928 /* Deinit when failure occurred */
929 err_queue_init:
930 if (dev->num_inst == 1)
931 s5p_mfc_deinit_hw(dev);
932 err_init_hw:
933 err_load_fw:
934 err_pwr_enable:
935 if (dev->num_inst == 1) {
936 if (s5p_mfc_power_off(dev) < 0)
937 mfc_err("power off failed\n");
938 del_timer_sync(&dev->watchdog_timer);
940 err_ctrls_setup:
941 s5p_mfc_dec_ctrls_delete(ctx);
942 err_bad_node:
943 dev->ctx[ctx->num] = NULL;
944 err_no_ctx:
945 v4l2_fh_del(&ctx->fh);
946 v4l2_fh_exit(&ctx->fh);
947 kfree(ctx);
948 err_alloc:
949 dev->num_inst--;
950 mutex_unlock(&dev->mfc_mutex);
951 err_enter:
952 mfc_debug_leave();
953 return ret;
956 /* Release MFC context */
957 static int s5p_mfc_release(struct file *file)
959 struct s5p_mfc_ctx *ctx = fh_to_ctx(file->private_data);
960 struct s5p_mfc_dev *dev = ctx->dev;
962 /* if dev is null, do cleanup that doesn't need dev */
963 mfc_debug_enter();
964 if (dev)
965 mutex_lock(&dev->mfc_mutex);
966 vb2_queue_release(&ctx->vq_src);
967 vb2_queue_release(&ctx->vq_dst);
968 if (dev) {
969 s5p_mfc_clock_on(dev);
971 /* Mark context as idle */
972 clear_work_bit_irqsave(ctx);
974 * If instance was initialised and not yet freed,
975 * return instance and free resources
977 if (ctx->state != MFCINST_FREE && ctx->state != MFCINST_INIT) {
978 mfc_debug(2, "Has to free instance\n");
979 s5p_mfc_close_mfc_inst(dev, ctx);
981 /* hardware locking scheme */
982 if (dev->curr_ctx == ctx->num)
983 clear_bit(0, &dev->hw_lock);
984 dev->num_inst--;
985 if (dev->num_inst == 0) {
986 mfc_debug(2, "Last instance\n");
987 s5p_mfc_deinit_hw(dev);
988 del_timer_sync(&dev->watchdog_timer);
989 s5p_mfc_clock_off(dev);
990 if (s5p_mfc_power_off(dev) < 0)
991 mfc_err("Power off failed\n");
992 } else {
993 mfc_debug(2, "Shutting down clock\n");
994 s5p_mfc_clock_off(dev);
997 if (dev)
998 dev->ctx[ctx->num] = NULL;
999 s5p_mfc_dec_ctrls_delete(ctx);
1000 v4l2_fh_del(&ctx->fh);
1001 /* vdev is gone if dev is null */
1002 if (dev)
1003 v4l2_fh_exit(&ctx->fh);
1004 kfree(ctx);
1005 mfc_debug_leave();
1006 if (dev)
1007 mutex_unlock(&dev->mfc_mutex);
1009 return 0;
1012 /* Poll */
1013 static __poll_t s5p_mfc_poll(struct file *file,
1014 struct poll_table_struct *wait)
1016 struct s5p_mfc_ctx *ctx = fh_to_ctx(file->private_data);
1017 struct s5p_mfc_dev *dev = ctx->dev;
1018 struct vb2_queue *src_q, *dst_q;
1019 struct vb2_buffer *src_vb = NULL, *dst_vb = NULL;
1020 __poll_t rc = 0;
1021 unsigned long flags;
1023 mutex_lock(&dev->mfc_mutex);
1024 src_q = &ctx->vq_src;
1025 dst_q = &ctx->vq_dst;
1027 * There has to be at least one buffer queued on each queued_list, which
1028 * means either in driver already or waiting for driver to claim it
1029 * and start processing.
1031 if ((!vb2_is_streaming(src_q) || list_empty(&src_q->queued_list)) &&
1032 (!vb2_is_streaming(dst_q) || list_empty(&dst_q->queued_list))) {
1033 rc = EPOLLERR;
1034 goto end;
1036 mutex_unlock(&dev->mfc_mutex);
1037 poll_wait(file, &ctx->fh.wait, wait);
1038 poll_wait(file, &src_q->done_wq, wait);
1039 poll_wait(file, &dst_q->done_wq, wait);
1040 mutex_lock(&dev->mfc_mutex);
1041 if (v4l2_event_pending(&ctx->fh))
1042 rc |= EPOLLPRI;
1043 spin_lock_irqsave(&src_q->done_lock, flags);
1044 if (!list_empty(&src_q->done_list))
1045 src_vb = list_first_entry(&src_q->done_list, struct vb2_buffer,
1046 done_entry);
1047 if (src_vb && (src_vb->state == VB2_BUF_STATE_DONE
1048 || src_vb->state == VB2_BUF_STATE_ERROR))
1049 rc |= EPOLLOUT | EPOLLWRNORM;
1050 spin_unlock_irqrestore(&src_q->done_lock, flags);
1051 spin_lock_irqsave(&dst_q->done_lock, flags);
1052 if (!list_empty(&dst_q->done_list))
1053 dst_vb = list_first_entry(&dst_q->done_list, struct vb2_buffer,
1054 done_entry);
1055 if (dst_vb && (dst_vb->state == VB2_BUF_STATE_DONE
1056 || dst_vb->state == VB2_BUF_STATE_ERROR))
1057 rc |= EPOLLIN | EPOLLRDNORM;
1058 spin_unlock_irqrestore(&dst_q->done_lock, flags);
1059 end:
1060 mutex_unlock(&dev->mfc_mutex);
1061 return rc;
1064 /* Mmap */
1065 static int s5p_mfc_mmap(struct file *file, struct vm_area_struct *vma)
1067 struct s5p_mfc_ctx *ctx = fh_to_ctx(file->private_data);
1068 unsigned long offset = vma->vm_pgoff << PAGE_SHIFT;
1069 int ret;
1071 if (offset < DST_QUEUE_OFF_BASE) {
1072 mfc_debug(2, "mmapping source\n");
1073 ret = vb2_mmap(&ctx->vq_src, vma);
1074 } else { /* capture */
1075 mfc_debug(2, "mmapping destination\n");
1076 vma->vm_pgoff -= (DST_QUEUE_OFF_BASE >> PAGE_SHIFT);
1077 ret = vb2_mmap(&ctx->vq_dst, vma);
1079 return ret;
1082 /* v4l2 ops */
1083 static const struct v4l2_file_operations s5p_mfc_fops = {
1084 .owner = THIS_MODULE,
1085 .open = s5p_mfc_open,
1086 .release = s5p_mfc_release,
1087 .poll = s5p_mfc_poll,
1088 .unlocked_ioctl = video_ioctl2,
1089 .mmap = s5p_mfc_mmap,
1092 /* DMA memory related helper functions */
1093 static void s5p_mfc_memdev_release(struct device *dev)
1095 of_reserved_mem_device_release(dev);
1098 static struct device *s5p_mfc_alloc_memdev(struct device *dev,
1099 const char *name, unsigned int idx)
1101 struct device *child;
1102 int ret;
1104 child = devm_kzalloc(dev, sizeof(*child), GFP_KERNEL);
1105 if (!child)
1106 return NULL;
1108 device_initialize(child);
1109 dev_set_name(child, "%s:%s", dev_name(dev), name);
1110 child->parent = dev;
1111 child->coherent_dma_mask = dev->coherent_dma_mask;
1112 child->dma_mask = dev->dma_mask;
1113 child->release = s5p_mfc_memdev_release;
1114 child->dma_parms = devm_kzalloc(dev, sizeof(*child->dma_parms),
1115 GFP_KERNEL);
1116 if (!child->dma_parms)
1117 goto err;
1120 * The memdevs are not proper OF platform devices, so in order for them
1121 * to be treated as valid DMA masters we need a bit of a hack to force
1122 * them to inherit the MFC node's DMA configuration.
1124 of_dma_configure(child, dev->of_node, true);
1126 if (device_add(child) == 0) {
1127 ret = of_reserved_mem_device_init_by_idx(child, dev->of_node,
1128 idx);
1129 if (ret == 0)
1130 return child;
1131 device_del(child);
1133 err:
1134 put_device(child);
1135 return NULL;
1138 static int s5p_mfc_configure_2port_memory(struct s5p_mfc_dev *mfc_dev)
1140 struct device *dev = &mfc_dev->plat_dev->dev;
1141 void *bank2_virt;
1142 dma_addr_t bank2_dma_addr;
1143 unsigned long align_size = 1 << MFC_BASE_ALIGN_ORDER;
1144 int ret;
1147 * Create and initialize virtual devices for accessing
1148 * reserved memory regions.
1150 mfc_dev->mem_dev[BANK_L_CTX] = s5p_mfc_alloc_memdev(dev, "left",
1151 BANK_L_CTX);
1152 if (!mfc_dev->mem_dev[BANK_L_CTX])
1153 return -ENODEV;
1154 mfc_dev->mem_dev[BANK_R_CTX] = s5p_mfc_alloc_memdev(dev, "right",
1155 BANK_R_CTX);
1156 if (!mfc_dev->mem_dev[BANK_R_CTX]) {
1157 device_unregister(mfc_dev->mem_dev[BANK_L_CTX]);
1158 return -ENODEV;
1161 /* Allocate memory for firmware and initialize both banks addresses */
1162 ret = s5p_mfc_alloc_firmware(mfc_dev);
1163 if (ret) {
1164 device_unregister(mfc_dev->mem_dev[BANK_R_CTX]);
1165 device_unregister(mfc_dev->mem_dev[BANK_L_CTX]);
1166 return ret;
1169 mfc_dev->dma_base[BANK_L_CTX] = mfc_dev->fw_buf.dma;
1171 bank2_virt = dma_alloc_coherent(mfc_dev->mem_dev[BANK_R_CTX],
1172 align_size, &bank2_dma_addr, GFP_KERNEL);
1173 if (!bank2_virt) {
1174 s5p_mfc_release_firmware(mfc_dev);
1175 device_unregister(mfc_dev->mem_dev[BANK_R_CTX]);
1176 device_unregister(mfc_dev->mem_dev[BANK_L_CTX]);
1177 return -ENOMEM;
1180 /* Valid buffers passed to MFC encoder with LAST_FRAME command
1181 * should not have address of bank2 - MFC will treat it as a null frame.
1182 * To avoid such situation we set bank2 address below the pool address.
1184 mfc_dev->dma_base[BANK_R_CTX] = bank2_dma_addr - align_size;
1186 dma_free_coherent(mfc_dev->mem_dev[BANK_R_CTX], align_size, bank2_virt,
1187 bank2_dma_addr);
1189 vb2_dma_contig_set_max_seg_size(mfc_dev->mem_dev[BANK_L_CTX],
1190 DMA_BIT_MASK(32));
1191 vb2_dma_contig_set_max_seg_size(mfc_dev->mem_dev[BANK_R_CTX],
1192 DMA_BIT_MASK(32));
1194 return 0;
1197 static void s5p_mfc_unconfigure_2port_memory(struct s5p_mfc_dev *mfc_dev)
1199 device_unregister(mfc_dev->mem_dev[BANK_L_CTX]);
1200 device_unregister(mfc_dev->mem_dev[BANK_R_CTX]);
1201 vb2_dma_contig_clear_max_seg_size(mfc_dev->mem_dev[BANK_L_CTX]);
1202 vb2_dma_contig_clear_max_seg_size(mfc_dev->mem_dev[BANK_R_CTX]);
1205 static int s5p_mfc_configure_common_memory(struct s5p_mfc_dev *mfc_dev)
1207 struct device *dev = &mfc_dev->plat_dev->dev;
1208 unsigned long mem_size = SZ_4M;
1210 if (IS_ENABLED(CONFIG_DMA_CMA) || exynos_is_iommu_available(dev))
1211 mem_size = SZ_8M;
1213 if (mfc_mem_size)
1214 mem_size = memparse(mfc_mem_size, NULL);
1216 mfc_dev->mem_bitmap = bitmap_zalloc(mem_size >> PAGE_SHIFT, GFP_KERNEL);
1217 if (!mfc_dev->mem_bitmap)
1218 return -ENOMEM;
1220 mfc_dev->mem_virt = dma_alloc_coherent(dev, mem_size,
1221 &mfc_dev->mem_base, GFP_KERNEL);
1222 if (!mfc_dev->mem_virt) {
1223 bitmap_free(mfc_dev->mem_bitmap);
1224 dev_err(dev, "failed to preallocate %ld MiB for the firmware and context buffers\n",
1225 (mem_size / SZ_1M));
1226 return -ENOMEM;
1228 mfc_dev->mem_size = mem_size;
1229 mfc_dev->dma_base[BANK_L_CTX] = mfc_dev->mem_base;
1230 mfc_dev->dma_base[BANK_R_CTX] = mfc_dev->mem_base;
1233 * MFC hardware cannot handle 0 as a base address, so mark first 128K
1234 * as used (to keep required base alignment) and adjust base address
1236 if (mfc_dev->mem_base == (dma_addr_t)0) {
1237 unsigned int offset = 1 << MFC_BASE_ALIGN_ORDER;
1239 bitmap_set(mfc_dev->mem_bitmap, 0, offset >> PAGE_SHIFT);
1240 mfc_dev->dma_base[BANK_L_CTX] += offset;
1241 mfc_dev->dma_base[BANK_R_CTX] += offset;
1244 /* Firmware allocation cannot fail in this case */
1245 s5p_mfc_alloc_firmware(mfc_dev);
1247 mfc_dev->mem_dev[BANK_L_CTX] = mfc_dev->mem_dev[BANK_R_CTX] = dev;
1248 vb2_dma_contig_set_max_seg_size(dev, DMA_BIT_MASK(32));
1250 dev_info(dev, "preallocated %ld MiB buffer for the firmware and context buffers\n",
1251 (mem_size / SZ_1M));
1253 return 0;
1256 static void s5p_mfc_unconfigure_common_memory(struct s5p_mfc_dev *mfc_dev)
1258 struct device *dev = &mfc_dev->plat_dev->dev;
1260 dma_free_coherent(dev, mfc_dev->mem_size, mfc_dev->mem_virt,
1261 mfc_dev->mem_base);
1262 bitmap_free(mfc_dev->mem_bitmap);
1263 vb2_dma_contig_clear_max_seg_size(dev);
1266 static int s5p_mfc_configure_dma_memory(struct s5p_mfc_dev *mfc_dev)
1268 struct device *dev = &mfc_dev->plat_dev->dev;
1270 if (exynos_is_iommu_available(dev) || !IS_TWOPORT(mfc_dev))
1271 return s5p_mfc_configure_common_memory(mfc_dev);
1272 else
1273 return s5p_mfc_configure_2port_memory(mfc_dev);
1276 static void s5p_mfc_unconfigure_dma_memory(struct s5p_mfc_dev *mfc_dev)
1278 struct device *dev = &mfc_dev->plat_dev->dev;
1280 s5p_mfc_release_firmware(mfc_dev);
1281 if (exynos_is_iommu_available(dev) || !IS_TWOPORT(mfc_dev))
1282 s5p_mfc_unconfigure_common_memory(mfc_dev);
1283 else
1284 s5p_mfc_unconfigure_2port_memory(mfc_dev);
1287 /* MFC probe function */
1288 static int s5p_mfc_probe(struct platform_device *pdev)
1290 struct s5p_mfc_dev *dev;
1291 struct video_device *vfd;
1292 int ret;
1294 pr_debug("%s++\n", __func__);
1295 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1296 if (!dev)
1297 return -ENOMEM;
1299 spin_lock_init(&dev->irqlock);
1300 spin_lock_init(&dev->condlock);
1301 dev->plat_dev = pdev;
1302 if (!dev->plat_dev) {
1303 mfc_err("No platform data specified\n");
1304 return -ENODEV;
1307 dev->variant = of_device_get_match_data(&pdev->dev);
1308 if (!dev->variant) {
1309 dev_err(&pdev->dev, "Failed to get device MFC hardware variant information\n");
1310 return -ENOENT;
1313 dev->regs_base = devm_platform_ioremap_resource(pdev, 0);
1314 if (IS_ERR(dev->regs_base))
1315 return PTR_ERR(dev->regs_base);
1317 ret = platform_get_irq(pdev, 0);
1318 if (ret < 0)
1319 return ret;
1320 dev->irq = ret;
1321 ret = devm_request_irq(&pdev->dev, dev->irq, s5p_mfc_irq,
1322 0, pdev->name, dev);
1323 if (ret) {
1324 dev_err(&pdev->dev, "Failed to install irq (%d)\n", ret);
1325 return ret;
1328 ret = s5p_mfc_configure_dma_memory(dev);
1329 if (ret < 0) {
1330 dev_err(&pdev->dev, "failed to configure DMA memory\n");
1331 return ret;
1334 ret = s5p_mfc_init_pm(dev);
1335 if (ret < 0) {
1336 dev_err(&pdev->dev, "failed to get mfc clock source\n");
1337 goto err_dma;
1341 * Load fails if fs isn't mounted. Try loading anyway.
1342 * _open() will load it, it fails now. Ignore failure.
1344 s5p_mfc_load_firmware(dev);
1346 mutex_init(&dev->mfc_mutex);
1347 init_waitqueue_head(&dev->queue);
1348 dev->hw_lock = 0;
1349 INIT_WORK(&dev->watchdog_work, s5p_mfc_watchdog_worker);
1350 atomic_set(&dev->watchdog_cnt, 0);
1351 timer_setup(&dev->watchdog_timer, s5p_mfc_watchdog, 0);
1353 ret = v4l2_device_register(&pdev->dev, &dev->v4l2_dev);
1354 if (ret)
1355 goto err_v4l2_dev_reg;
1357 /* decoder */
1358 vfd = video_device_alloc();
1359 if (!vfd) {
1360 v4l2_err(&dev->v4l2_dev, "Failed to allocate video device\n");
1361 ret = -ENOMEM;
1362 goto err_dec_alloc;
1364 vfd->fops = &s5p_mfc_fops;
1365 vfd->ioctl_ops = get_dec_v4l2_ioctl_ops();
1366 vfd->release = video_device_release;
1367 vfd->lock = &dev->mfc_mutex;
1368 vfd->v4l2_dev = &dev->v4l2_dev;
1369 vfd->vfl_dir = VFL_DIR_M2M;
1370 vfd->device_caps = V4L2_CAP_VIDEO_M2M_MPLANE | V4L2_CAP_STREAMING;
1371 set_bit(V4L2_FL_QUIRK_INVERTED_CROP, &vfd->flags);
1372 snprintf(vfd->name, sizeof(vfd->name), "%s", S5P_MFC_DEC_NAME);
1373 dev->vfd_dec = vfd;
1374 video_set_drvdata(vfd, dev);
1376 /* encoder */
1377 vfd = video_device_alloc();
1378 if (!vfd) {
1379 v4l2_err(&dev->v4l2_dev, "Failed to allocate video device\n");
1380 ret = -ENOMEM;
1381 goto err_enc_alloc;
1383 vfd->fops = &s5p_mfc_fops;
1384 vfd->ioctl_ops = get_enc_v4l2_ioctl_ops();
1385 vfd->release = video_device_release;
1386 vfd->lock = &dev->mfc_mutex;
1387 vfd->v4l2_dev = &dev->v4l2_dev;
1388 vfd->vfl_dir = VFL_DIR_M2M;
1389 vfd->device_caps = V4L2_CAP_VIDEO_M2M_MPLANE | V4L2_CAP_STREAMING;
1390 snprintf(vfd->name, sizeof(vfd->name), "%s", S5P_MFC_ENC_NAME);
1391 dev->vfd_enc = vfd;
1392 video_set_drvdata(vfd, dev);
1393 platform_set_drvdata(pdev, dev);
1395 /* Initialize HW ops and commands based on MFC version */
1396 s5p_mfc_init_hw_ops(dev);
1397 s5p_mfc_init_hw_cmds(dev);
1398 s5p_mfc_init_regs(dev);
1400 /* Register decoder and encoder */
1401 ret = video_register_device(dev->vfd_dec, VFL_TYPE_VIDEO, 0);
1402 if (ret) {
1403 v4l2_err(&dev->v4l2_dev, "Failed to register video device\n");
1404 goto err_dec_reg;
1406 v4l2_info(&dev->v4l2_dev,
1407 "decoder registered as /dev/video%d\n", dev->vfd_dec->num);
1409 ret = video_register_device(dev->vfd_enc, VFL_TYPE_VIDEO, 0);
1410 if (ret) {
1411 v4l2_err(&dev->v4l2_dev, "Failed to register video device\n");
1412 goto err_enc_reg;
1414 v4l2_info(&dev->v4l2_dev,
1415 "encoder registered as /dev/video%d\n", dev->vfd_enc->num);
1417 pr_debug("%s--\n", __func__);
1418 return 0;
1420 /* Deinit MFC if probe had failed */
1421 err_enc_reg:
1422 video_unregister_device(dev->vfd_dec);
1423 dev->vfd_dec = NULL;
1424 err_dec_reg:
1425 video_device_release(dev->vfd_enc);
1426 err_enc_alloc:
1427 video_device_release(dev->vfd_dec);
1428 err_dec_alloc:
1429 v4l2_device_unregister(&dev->v4l2_dev);
1430 err_v4l2_dev_reg:
1431 s5p_mfc_final_pm(dev);
1432 err_dma:
1433 s5p_mfc_unconfigure_dma_memory(dev);
1435 pr_debug("%s-- with error\n", __func__);
1436 return ret;
1440 /* Remove the driver */
1441 static void s5p_mfc_remove(struct platform_device *pdev)
1443 struct s5p_mfc_dev *dev = platform_get_drvdata(pdev);
1444 struct s5p_mfc_ctx *ctx;
1445 int i;
1447 v4l2_info(&dev->v4l2_dev, "Removing %s\n", pdev->name);
1450 * Clear ctx dev pointer to avoid races between s5p_mfc_remove()
1451 * and s5p_mfc_release() and s5p_mfc_release() accessing ctx->dev
1452 * after s5p_mfc_remove() is run during unbind.
1454 mutex_lock(&dev->mfc_mutex);
1455 for (i = 0; i < MFC_NUM_CONTEXTS; i++) {
1456 ctx = dev->ctx[i];
1457 if (!ctx)
1458 continue;
1459 /* clear ctx->dev */
1460 ctx->dev = NULL;
1462 mutex_unlock(&dev->mfc_mutex);
1464 del_timer_sync(&dev->watchdog_timer);
1465 flush_work(&dev->watchdog_work);
1467 video_unregister_device(dev->vfd_enc);
1468 video_unregister_device(dev->vfd_dec);
1469 v4l2_device_unregister(&dev->v4l2_dev);
1470 s5p_mfc_unconfigure_dma_memory(dev);
1472 s5p_mfc_final_pm(dev);
1475 #ifdef CONFIG_PM_SLEEP
1477 static int s5p_mfc_suspend(struct device *dev)
1479 struct s5p_mfc_dev *m_dev = dev_get_drvdata(dev);
1480 int ret;
1482 if (m_dev->num_inst == 0)
1483 return 0;
1485 if (test_and_set_bit(0, &m_dev->enter_suspend) != 0) {
1486 mfc_err("Error: going to suspend for a second time\n");
1487 return -EIO;
1490 /* Check if we're processing then wait if it necessary. */
1491 while (test_and_set_bit(0, &m_dev->hw_lock) != 0) {
1492 /* Try and lock the HW */
1493 /* Wait on the interrupt waitqueue */
1494 ret = wait_event_interruptible_timeout(m_dev->queue,
1495 m_dev->int_cond, msecs_to_jiffies(MFC_INT_TIMEOUT));
1496 if (ret == 0) {
1497 mfc_err("Waiting for hardware to finish timed out\n");
1498 clear_bit(0, &m_dev->enter_suspend);
1499 return -EIO;
1503 ret = s5p_mfc_sleep(m_dev);
1504 if (ret) {
1505 clear_bit(0, &m_dev->enter_suspend);
1506 clear_bit(0, &m_dev->hw_lock);
1508 return ret;
1511 static int s5p_mfc_resume(struct device *dev)
1513 struct s5p_mfc_dev *m_dev = dev_get_drvdata(dev);
1515 if (m_dev->num_inst == 0)
1516 return 0;
1517 return s5p_mfc_wakeup(m_dev);
1519 #endif
1521 /* Power management */
1522 static const struct dev_pm_ops s5p_mfc_pm_ops = {
1523 SET_SYSTEM_SLEEP_PM_OPS(s5p_mfc_suspend, s5p_mfc_resume)
1526 static const struct s5p_mfc_buf_size_v5 mfc_buf_size_v5 = {
1527 .h264_ctx = MFC_H264_CTX_BUF_SIZE,
1528 .non_h264_ctx = MFC_CTX_BUF_SIZE,
1529 .dsc = DESC_BUF_SIZE,
1530 .shm = SHARED_BUF_SIZE,
1533 static const struct s5p_mfc_buf_size buf_size_v5 = {
1534 .fw = MAX_FW_SIZE,
1535 .cpb = MAX_CPB_SIZE,
1536 .priv = &mfc_buf_size_v5,
1539 static const struct s5p_mfc_variant mfc_drvdata_v5 = {
1540 .version = MFC_VERSION,
1541 .version_bit = MFC_V5_BIT,
1542 .port_num = MFC_NUM_PORTS,
1543 .buf_size = &buf_size_v5,
1544 .fw_name[0] = "s5p-mfc.fw",
1545 .clk_names = {"mfc", "sclk_mfc"},
1546 .num_clocks = 2,
1547 .use_clock_gating = true,
1550 static const struct s5p_mfc_buf_size_v6 mfc_buf_size_v6 = {
1551 .dev_ctx = MFC_CTX_BUF_SIZE_V6,
1552 .h264_dec_ctx = MFC_H264_DEC_CTX_BUF_SIZE_V6,
1553 .other_dec_ctx = MFC_OTHER_DEC_CTX_BUF_SIZE_V6,
1554 .h264_enc_ctx = MFC_H264_ENC_CTX_BUF_SIZE_V6,
1555 .other_enc_ctx = MFC_OTHER_ENC_CTX_BUF_SIZE_V6,
1558 static const struct s5p_mfc_buf_size buf_size_v6 = {
1559 .fw = MAX_FW_SIZE_V6,
1560 .cpb = MAX_CPB_SIZE_V6,
1561 .priv = &mfc_buf_size_v6,
1564 static const struct s5p_mfc_variant mfc_drvdata_v6 = {
1565 .version = MFC_VERSION_V6,
1566 .version_bit = MFC_V6_BIT,
1567 .port_num = MFC_NUM_PORTS_V6,
1568 .buf_size = &buf_size_v6,
1569 .fw_name[0] = "s5p-mfc-v6.fw",
1571 * v6-v2 firmware contains bug fixes and interface change
1572 * for init buffer command
1574 .fw_name[1] = "s5p-mfc-v6-v2.fw",
1575 .clk_names = {"mfc"},
1576 .num_clocks = 1,
1579 static const struct s5p_mfc_buf_size_v6 mfc_buf_size_v7 = {
1580 .dev_ctx = MFC_CTX_BUF_SIZE_V7,
1581 .h264_dec_ctx = MFC_H264_DEC_CTX_BUF_SIZE_V7,
1582 .other_dec_ctx = MFC_OTHER_DEC_CTX_BUF_SIZE_V7,
1583 .h264_enc_ctx = MFC_H264_ENC_CTX_BUF_SIZE_V7,
1584 .other_enc_ctx = MFC_OTHER_ENC_CTX_BUF_SIZE_V7,
1587 static const struct s5p_mfc_buf_size buf_size_v7 = {
1588 .fw = MAX_FW_SIZE_V7,
1589 .cpb = MAX_CPB_SIZE_V7,
1590 .priv = &mfc_buf_size_v7,
1593 static const struct s5p_mfc_variant mfc_drvdata_v7 = {
1594 .version = MFC_VERSION_V7,
1595 .version_bit = MFC_V7_BIT,
1596 .port_num = MFC_NUM_PORTS_V7,
1597 .buf_size = &buf_size_v7,
1598 .fw_name[0] = "s5p-mfc-v7.fw",
1599 .clk_names = {"mfc"},
1600 .num_clocks = 1,
1603 static const struct s5p_mfc_variant mfc_drvdata_v7_3250 = {
1604 .version = MFC_VERSION_V7,
1605 .version_bit = MFC_V7_BIT,
1606 .port_num = MFC_NUM_PORTS_V7,
1607 .buf_size = &buf_size_v7,
1608 .fw_name[0] = "s5p-mfc-v7.fw",
1609 .clk_names = {"mfc", "sclk_mfc"},
1610 .num_clocks = 2,
1613 static const struct s5p_mfc_buf_size_v6 mfc_buf_size_v8 = {
1614 .dev_ctx = MFC_CTX_BUF_SIZE_V8,
1615 .h264_dec_ctx = MFC_H264_DEC_CTX_BUF_SIZE_V8,
1616 .other_dec_ctx = MFC_OTHER_DEC_CTX_BUF_SIZE_V8,
1617 .h264_enc_ctx = MFC_H264_ENC_CTX_BUF_SIZE_V8,
1618 .other_enc_ctx = MFC_OTHER_ENC_CTX_BUF_SIZE_V8,
1621 static const struct s5p_mfc_buf_size buf_size_v8 = {
1622 .fw = MAX_FW_SIZE_V8,
1623 .cpb = MAX_CPB_SIZE_V8,
1624 .priv = &mfc_buf_size_v8,
1627 static const struct s5p_mfc_variant mfc_drvdata_v8 = {
1628 .version = MFC_VERSION_V8,
1629 .version_bit = MFC_V8_BIT,
1630 .port_num = MFC_NUM_PORTS_V8,
1631 .buf_size = &buf_size_v8,
1632 .fw_name[0] = "s5p-mfc-v8.fw",
1633 .clk_names = {"mfc"},
1634 .num_clocks = 1,
1637 static const struct s5p_mfc_variant mfc_drvdata_v8_5433 = {
1638 .version = MFC_VERSION_V8,
1639 .version_bit = MFC_V8_BIT,
1640 .port_num = MFC_NUM_PORTS_V8,
1641 .buf_size = &buf_size_v8,
1642 .fw_name[0] = "s5p-mfc-v8.fw",
1643 .clk_names = {"pclk", "aclk", "aclk_xiu"},
1644 .num_clocks = 3,
1647 static const struct s5p_mfc_buf_size_v6 mfc_buf_size_v10 = {
1648 .dev_ctx = MFC_CTX_BUF_SIZE_V10,
1649 .h264_dec_ctx = MFC_H264_DEC_CTX_BUF_SIZE_V10,
1650 .other_dec_ctx = MFC_OTHER_DEC_CTX_BUF_SIZE_V10,
1651 .h264_enc_ctx = MFC_H264_ENC_CTX_BUF_SIZE_V10,
1652 .hevc_enc_ctx = MFC_HEVC_ENC_CTX_BUF_SIZE_V10,
1653 .other_enc_ctx = MFC_OTHER_ENC_CTX_BUF_SIZE_V10,
1656 static const struct s5p_mfc_buf_size buf_size_v10 = {
1657 .fw = MAX_FW_SIZE_V10,
1658 .cpb = MAX_CPB_SIZE_V10,
1659 .priv = &mfc_buf_size_v10,
1662 static const struct s5p_mfc_variant mfc_drvdata_v10 = {
1663 .version = MFC_VERSION_V10,
1664 .version_bit = MFC_V10_BIT,
1665 .port_num = MFC_NUM_PORTS_V10,
1666 .buf_size = &buf_size_v10,
1667 .fw_name[0] = "s5p-mfc-v10.fw",
1670 static struct s5p_mfc_buf_size_v6 mfc_buf_size_v12 = {
1671 .dev_ctx = MFC_CTX_BUF_SIZE_V12,
1672 .h264_dec_ctx = MFC_H264_DEC_CTX_BUF_SIZE_V12,
1673 .other_dec_ctx = MFC_OTHER_DEC_CTX_BUF_SIZE_V12,
1674 .h264_enc_ctx = MFC_H264_ENC_CTX_BUF_SIZE_V12,
1675 .hevc_enc_ctx = MFC_HEVC_ENC_CTX_BUF_SIZE_V12,
1676 .other_enc_ctx = MFC_OTHER_ENC_CTX_BUF_SIZE_V12,
1679 static struct s5p_mfc_buf_size buf_size_v12 = {
1680 .fw = MAX_FW_SIZE_V12,
1681 .cpb = MAX_CPB_SIZE_V12,
1682 .priv = &mfc_buf_size_v12,
1685 static struct s5p_mfc_variant mfc_drvdata_v12 = {
1686 .version = MFC_VERSION_V12,
1687 .version_bit = MFC_V12_BIT,
1688 .port_num = MFC_NUM_PORTS_V12,
1689 .buf_size = &buf_size_v12,
1690 .fw_name[0] = "s5p-mfc-v12.fw",
1691 .clk_names = {"mfc"},
1692 .num_clocks = 1,
1695 static const struct of_device_id exynos_mfc_match[] = {
1697 .compatible = "samsung,mfc-v5",
1698 .data = &mfc_drvdata_v5,
1699 }, {
1700 .compatible = "samsung,mfc-v6",
1701 .data = &mfc_drvdata_v6,
1702 }, {
1703 .compatible = "samsung,mfc-v7",
1704 .data = &mfc_drvdata_v7,
1705 }, {
1706 .compatible = "samsung,exynos3250-mfc",
1707 .data = &mfc_drvdata_v7_3250,
1708 }, {
1709 .compatible = "samsung,mfc-v8",
1710 .data = &mfc_drvdata_v8,
1711 }, {
1712 .compatible = "samsung,exynos5433-mfc",
1713 .data = &mfc_drvdata_v8_5433,
1714 }, {
1715 .compatible = "samsung,mfc-v10",
1716 .data = &mfc_drvdata_v10,
1717 }, {
1718 .compatible = "tesla,fsd-mfc",
1719 .data = &mfc_drvdata_v12,
1723 MODULE_DEVICE_TABLE(of, exynos_mfc_match);
1725 static struct platform_driver s5p_mfc_driver = {
1726 .probe = s5p_mfc_probe,
1727 .remove = s5p_mfc_remove,
1728 .driver = {
1729 .name = S5P_MFC_NAME,
1730 .pm = &s5p_mfc_pm_ops,
1731 .of_match_table = exynos_mfc_match,
1735 module_platform_driver(s5p_mfc_driver);
1737 MODULE_LICENSE("GPL");
1738 MODULE_AUTHOR("Kamil Debski <k.debski@samsung.com>");
1739 MODULE_DESCRIPTION("Samsung S5P Multi Format Codec V4L2 driver");