gpio: rcar: Fix runtime PM imbalance on error
[linux/fpc-iii.git] / drivers / media / platform / s5p-mfc / s5p_mfc.c
blob5c2a23b953a41d8681286cbb614e24b926dc8f89
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, S_IRUGO | S_IWUSR);
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) {
151 /* This means that hw is busy and no interrupts were
152 * generated by hw for the Nth time of running this
153 * watchdog timer. This usually means a serious hw
154 * error. Now it is time to kill all instances and
155 * reset the MFC. */
156 mfc_err("Time out during waiting for HW\n");
157 schedule_work(&dev->watchdog_work);
159 dev->watchdog_timer.expires = jiffies +
160 msecs_to_jiffies(MFC_WATCHDOG_INTERVAL);
161 add_timer(&dev->watchdog_timer);
164 static void s5p_mfc_watchdog_worker(struct work_struct *work)
166 struct s5p_mfc_dev *dev;
167 struct s5p_mfc_ctx *ctx;
168 unsigned long flags;
169 int mutex_locked;
170 int i, ret;
172 dev = container_of(work, struct s5p_mfc_dev, watchdog_work);
174 mfc_err("Driver timeout error handling\n");
175 /* Lock the mutex that protects open and release.
176 * This is necessary as they may load and unload firmware. */
177 mutex_locked = mutex_trylock(&dev->mfc_mutex);
178 if (!mutex_locked)
179 mfc_err("Error: some instance may be closing/opening\n");
180 spin_lock_irqsave(&dev->irqlock, flags);
182 s5p_mfc_clock_off();
184 for (i = 0; i < MFC_NUM_CONTEXTS; i++) {
185 ctx = dev->ctx[i];
186 if (!ctx)
187 continue;
188 ctx->state = MFCINST_ERROR;
189 s5p_mfc_cleanup_queue(&ctx->dst_queue, &ctx->vq_dst);
190 s5p_mfc_cleanup_queue(&ctx->src_queue, &ctx->vq_src);
191 clear_work_bit(ctx);
192 wake_up_ctx(ctx, S5P_MFC_R2H_CMD_ERR_RET, 0);
194 clear_bit(0, &dev->hw_lock);
195 spin_unlock_irqrestore(&dev->irqlock, flags);
197 /* De-init MFC */
198 s5p_mfc_deinit_hw(dev);
200 /* Double check if there is at least one instance running.
201 * If no instance is in memory than no firmware should be present */
202 if (dev->num_inst > 0) {
203 ret = s5p_mfc_load_firmware(dev);
204 if (ret) {
205 mfc_err("Failed to reload FW\n");
206 goto unlock;
208 s5p_mfc_clock_on();
209 ret = s5p_mfc_init_hw(dev);
210 s5p_mfc_clock_off();
211 if (ret)
212 mfc_err("Failed to reinit FW\n");
214 unlock:
215 if (mutex_locked)
216 mutex_unlock(&dev->mfc_mutex);
219 static void s5p_mfc_handle_frame_all_extracted(struct s5p_mfc_ctx *ctx)
221 struct s5p_mfc_buf *dst_buf;
222 struct s5p_mfc_dev *dev = ctx->dev;
224 ctx->state = MFCINST_FINISHED;
225 ctx->sequence++;
226 while (!list_empty(&ctx->dst_queue)) {
227 dst_buf = list_entry(ctx->dst_queue.next,
228 struct s5p_mfc_buf, list);
229 mfc_debug(2, "Cleaning up buffer: %d\n",
230 dst_buf->b->vb2_buf.index);
231 vb2_set_plane_payload(&dst_buf->b->vb2_buf, 0, 0);
232 vb2_set_plane_payload(&dst_buf->b->vb2_buf, 1, 0);
233 list_del(&dst_buf->list);
234 dst_buf->flags |= MFC_BUF_FLAG_EOS;
235 ctx->dst_queue_cnt--;
236 dst_buf->b->sequence = (ctx->sequence++);
238 if (s5p_mfc_hw_call(dev->mfc_ops, get_pic_type_top, ctx) ==
239 s5p_mfc_hw_call(dev->mfc_ops, get_pic_type_bot, ctx))
240 dst_buf->b->field = V4L2_FIELD_NONE;
241 else
242 dst_buf->b->field = V4L2_FIELD_INTERLACED;
243 dst_buf->b->flags |= V4L2_BUF_FLAG_LAST;
245 ctx->dec_dst_flag &= ~(1 << dst_buf->b->vb2_buf.index);
246 vb2_buffer_done(&dst_buf->b->vb2_buf, VB2_BUF_STATE_DONE);
250 static void s5p_mfc_handle_frame_copy_time(struct s5p_mfc_ctx *ctx)
252 struct s5p_mfc_dev *dev = ctx->dev;
253 struct s5p_mfc_buf *dst_buf, *src_buf;
254 u32 dec_y_addr;
255 unsigned int frame_type;
257 /* Make sure we actually have a new frame before continuing. */
258 frame_type = s5p_mfc_hw_call(dev->mfc_ops, get_dec_frame_type, dev);
259 if (frame_type == S5P_FIMV_DECODE_FRAME_SKIPPED)
260 return;
261 dec_y_addr = (u32)s5p_mfc_hw_call(dev->mfc_ops, get_dec_y_adr, dev);
263 /* Copy timestamp / timecode from decoded src to dst and set
264 appropriate flags. */
265 src_buf = list_entry(ctx->src_queue.next, struct s5p_mfc_buf, list);
266 list_for_each_entry(dst_buf, &ctx->dst_queue, list) {
267 u32 addr = (u32)vb2_dma_contig_plane_dma_addr(&dst_buf->b->vb2_buf, 0);
269 if (addr == dec_y_addr) {
270 dst_buf->b->timecode = src_buf->b->timecode;
271 dst_buf->b->vb2_buf.timestamp =
272 src_buf->b->vb2_buf.timestamp;
273 dst_buf->b->flags &=
274 ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
275 dst_buf->b->flags |=
276 src_buf->b->flags
277 & V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
278 switch (frame_type) {
279 case S5P_FIMV_DECODE_FRAME_I_FRAME:
280 dst_buf->b->flags |=
281 V4L2_BUF_FLAG_KEYFRAME;
282 break;
283 case S5P_FIMV_DECODE_FRAME_P_FRAME:
284 dst_buf->b->flags |=
285 V4L2_BUF_FLAG_PFRAME;
286 break;
287 case S5P_FIMV_DECODE_FRAME_B_FRAME:
288 dst_buf->b->flags |=
289 V4L2_BUF_FLAG_BFRAME;
290 break;
291 default:
292 /* Don't know how to handle
293 S5P_FIMV_DECODE_FRAME_OTHER_FRAME. */
294 mfc_debug(2, "Unexpected frame type: %d\n",
295 frame_type);
297 break;
302 static void s5p_mfc_handle_frame_new(struct s5p_mfc_ctx *ctx, unsigned int err)
304 struct s5p_mfc_dev *dev = ctx->dev;
305 struct s5p_mfc_buf *dst_buf;
306 u32 dspl_y_addr;
307 unsigned int frame_type;
309 dspl_y_addr = (u32)s5p_mfc_hw_call(dev->mfc_ops, get_dspl_y_adr, dev);
310 if (IS_MFCV6_PLUS(dev))
311 frame_type = s5p_mfc_hw_call(dev->mfc_ops,
312 get_disp_frame_type, ctx);
313 else
314 frame_type = s5p_mfc_hw_call(dev->mfc_ops,
315 get_dec_frame_type, dev);
317 /* If frame is same as previous then skip and do not dequeue */
318 if (frame_type == S5P_FIMV_DECODE_FRAME_SKIPPED) {
319 if (!ctx->after_packed_pb)
320 ctx->sequence++;
321 ctx->after_packed_pb = 0;
322 return;
324 ctx->sequence++;
325 /* The MFC returns address of the buffer, now we have to
326 * check which videobuf does it correspond to */
327 list_for_each_entry(dst_buf, &ctx->dst_queue, list) {
328 u32 addr = (u32)vb2_dma_contig_plane_dma_addr(&dst_buf->b->vb2_buf, 0);
330 /* Check if this is the buffer we're looking for */
331 if (addr == dspl_y_addr) {
332 list_del(&dst_buf->list);
333 ctx->dst_queue_cnt--;
334 dst_buf->b->sequence = ctx->sequence;
335 if (s5p_mfc_hw_call(dev->mfc_ops,
336 get_pic_type_top, ctx) ==
337 s5p_mfc_hw_call(dev->mfc_ops,
338 get_pic_type_bot, ctx))
339 dst_buf->b->field = V4L2_FIELD_NONE;
340 else
341 dst_buf->b->field =
342 V4L2_FIELD_INTERLACED;
343 vb2_set_plane_payload(&dst_buf->b->vb2_buf, 0,
344 ctx->luma_size);
345 vb2_set_plane_payload(&dst_buf->b->vb2_buf, 1,
346 ctx->chroma_size);
347 clear_bit(dst_buf->b->vb2_buf.index,
348 &ctx->dec_dst_flag);
350 vb2_buffer_done(&dst_buf->b->vb2_buf, err ?
351 VB2_BUF_STATE_ERROR : VB2_BUF_STATE_DONE);
353 break;
358 /* Handle frame decoding interrupt */
359 static void s5p_mfc_handle_frame(struct s5p_mfc_ctx *ctx,
360 unsigned int reason, unsigned int err)
362 struct s5p_mfc_dev *dev = ctx->dev;
363 unsigned int dst_frame_status;
364 unsigned int dec_frame_status;
365 struct s5p_mfc_buf *src_buf;
366 unsigned int res_change;
368 dst_frame_status = s5p_mfc_hw_call(dev->mfc_ops, get_dspl_status, dev)
369 & S5P_FIMV_DEC_STATUS_DECODING_STATUS_MASK;
370 dec_frame_status = s5p_mfc_hw_call(dev->mfc_ops, get_dec_status, dev)
371 & S5P_FIMV_DEC_STATUS_DECODING_STATUS_MASK;
372 res_change = (s5p_mfc_hw_call(dev->mfc_ops, get_dspl_status, dev)
373 & S5P_FIMV_DEC_STATUS_RESOLUTION_MASK)
374 >> S5P_FIMV_DEC_STATUS_RESOLUTION_SHIFT;
375 mfc_debug(2, "Frame Status: %x\n", dst_frame_status);
376 if (ctx->state == MFCINST_RES_CHANGE_INIT)
377 ctx->state = MFCINST_RES_CHANGE_FLUSH;
378 if (res_change == S5P_FIMV_RES_INCREASE ||
379 res_change == S5P_FIMV_RES_DECREASE) {
380 ctx->state = MFCINST_RES_CHANGE_INIT;
381 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
382 wake_up_ctx(ctx, reason, err);
383 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
384 s5p_mfc_clock_off();
385 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
386 return;
388 if (ctx->dpb_flush_flag)
389 ctx->dpb_flush_flag = 0;
391 /* All frames remaining in the buffer have been extracted */
392 if (dst_frame_status == S5P_FIMV_DEC_STATUS_DECODING_EMPTY) {
393 if (ctx->state == MFCINST_RES_CHANGE_FLUSH) {
394 static const struct v4l2_event ev_src_ch = {
395 .type = V4L2_EVENT_SOURCE_CHANGE,
396 .u.src_change.changes =
397 V4L2_EVENT_SRC_CH_RESOLUTION,
400 s5p_mfc_handle_frame_all_extracted(ctx);
401 ctx->state = MFCINST_RES_CHANGE_END;
402 v4l2_event_queue_fh(&ctx->fh, &ev_src_ch);
404 goto leave_handle_frame;
405 } else {
406 s5p_mfc_handle_frame_all_extracted(ctx);
410 if (dec_frame_status == S5P_FIMV_DEC_STATUS_DECODING_DISPLAY)
411 s5p_mfc_handle_frame_copy_time(ctx);
413 /* A frame has been decoded and is in the buffer */
414 if (dst_frame_status == S5P_FIMV_DEC_STATUS_DISPLAY_ONLY ||
415 dst_frame_status == S5P_FIMV_DEC_STATUS_DECODING_DISPLAY) {
416 s5p_mfc_handle_frame_new(ctx, err);
417 } else {
418 mfc_debug(2, "No frame decode\n");
420 /* Mark source buffer as complete */
421 if (dst_frame_status != S5P_FIMV_DEC_STATUS_DISPLAY_ONLY
422 && !list_empty(&ctx->src_queue)) {
423 src_buf = list_entry(ctx->src_queue.next, struct s5p_mfc_buf,
424 list);
425 ctx->consumed_stream += s5p_mfc_hw_call(dev->mfc_ops,
426 get_consumed_stream, dev);
427 if (ctx->codec_mode != S5P_MFC_CODEC_H264_DEC &&
428 ctx->codec_mode != S5P_MFC_CODEC_VP8_DEC &&
429 ctx->consumed_stream + STUFF_BYTE <
430 src_buf->b->vb2_buf.planes[0].bytesused) {
431 /* Run MFC again on the same buffer */
432 mfc_debug(2, "Running again the same buffer\n");
433 ctx->after_packed_pb = 1;
434 } else {
435 mfc_debug(2, "MFC needs next buffer\n");
436 ctx->consumed_stream = 0;
437 if (src_buf->flags & MFC_BUF_FLAG_EOS)
438 ctx->state = MFCINST_FINISHING;
439 list_del(&src_buf->list);
440 ctx->src_queue_cnt--;
441 if (s5p_mfc_hw_call(dev->mfc_ops, err_dec, err) > 0)
442 vb2_buffer_done(&src_buf->b->vb2_buf,
443 VB2_BUF_STATE_ERROR);
444 else
445 vb2_buffer_done(&src_buf->b->vb2_buf,
446 VB2_BUF_STATE_DONE);
449 leave_handle_frame:
450 if ((ctx->src_queue_cnt == 0 && ctx->state != MFCINST_FINISHING)
451 || ctx->dst_queue_cnt < ctx->pb_count)
452 clear_work_bit(ctx);
453 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
454 wake_up_ctx(ctx, reason, err);
455 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
456 s5p_mfc_clock_off();
457 /* if suspending, wake up device and do not try_run again*/
458 if (test_bit(0, &dev->enter_suspend))
459 wake_up_dev(dev, reason, err);
460 else
461 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
464 /* Error handling for interrupt */
465 static void s5p_mfc_handle_error(struct s5p_mfc_dev *dev,
466 struct s5p_mfc_ctx *ctx, unsigned int reason, unsigned int err)
468 mfc_err("Interrupt Error: %08x\n", err);
470 if (ctx) {
471 /* Error recovery is dependent on the state of context */
472 switch (ctx->state) {
473 case MFCINST_RES_CHANGE_INIT:
474 case MFCINST_RES_CHANGE_FLUSH:
475 case MFCINST_RES_CHANGE_END:
476 case MFCINST_FINISHING:
477 case MFCINST_FINISHED:
478 case MFCINST_RUNNING:
479 /* It is highly probable that an error occurred
480 * while decoding a frame */
481 clear_work_bit(ctx);
482 ctx->state = MFCINST_ERROR;
483 /* Mark all dst buffers as having an error */
484 s5p_mfc_cleanup_queue(&ctx->dst_queue, &ctx->vq_dst);
485 /* Mark all src buffers as having an error */
486 s5p_mfc_cleanup_queue(&ctx->src_queue, &ctx->vq_src);
487 wake_up_ctx(ctx, reason, err);
488 break;
489 default:
490 clear_work_bit(ctx);
491 ctx->state = MFCINST_ERROR;
492 wake_up_ctx(ctx, reason, err);
493 break;
496 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
497 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
498 s5p_mfc_clock_off();
499 wake_up_dev(dev, reason, err);
502 /* Header parsing interrupt handling */
503 static void s5p_mfc_handle_seq_done(struct s5p_mfc_ctx *ctx,
504 unsigned int reason, unsigned int err)
506 struct s5p_mfc_dev *dev;
508 if (!ctx)
509 return;
510 dev = ctx->dev;
511 if (ctx->c_ops->post_seq_start) {
512 if (ctx->c_ops->post_seq_start(ctx))
513 mfc_err("post_seq_start() failed\n");
514 } else {
515 ctx->img_width = s5p_mfc_hw_call(dev->mfc_ops, get_img_width,
516 dev);
517 ctx->img_height = s5p_mfc_hw_call(dev->mfc_ops, get_img_height,
518 dev);
520 s5p_mfc_hw_call(dev->mfc_ops, dec_calc_dpb_size, ctx);
522 ctx->pb_count = s5p_mfc_hw_call(dev->mfc_ops, get_dpb_count,
523 dev);
524 ctx->mv_count = s5p_mfc_hw_call(dev->mfc_ops, get_mv_count,
525 dev);
526 if (FW_HAS_E_MIN_SCRATCH_BUF(dev))
527 ctx->scratch_buf_size = s5p_mfc_hw_call(dev->mfc_ops,
528 get_min_scratch_buf_size, dev);
529 if (ctx->img_width == 0 || ctx->img_height == 0)
530 ctx->state = MFCINST_ERROR;
531 else
532 ctx->state = MFCINST_HEAD_PARSED;
534 if ((ctx->codec_mode == S5P_MFC_CODEC_H264_DEC ||
535 ctx->codec_mode == S5P_MFC_CODEC_H264_MVC_DEC) &&
536 !list_empty(&ctx->src_queue)) {
537 struct s5p_mfc_buf *src_buf;
538 src_buf = list_entry(ctx->src_queue.next,
539 struct s5p_mfc_buf, list);
540 if (s5p_mfc_hw_call(dev->mfc_ops, get_consumed_stream,
541 dev) <
542 src_buf->b->vb2_buf.planes[0].bytesused)
543 ctx->head_processed = 0;
544 else
545 ctx->head_processed = 1;
546 } else {
547 ctx->head_processed = 1;
550 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
551 clear_work_bit(ctx);
552 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
553 s5p_mfc_clock_off();
554 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
555 wake_up_ctx(ctx, reason, err);
558 /* Header parsing interrupt handling */
559 static void s5p_mfc_handle_init_buffers(struct s5p_mfc_ctx *ctx,
560 unsigned int reason, unsigned int err)
562 struct s5p_mfc_buf *src_buf;
563 struct s5p_mfc_dev *dev;
565 if (!ctx)
566 return;
567 dev = ctx->dev;
568 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
569 ctx->int_type = reason;
570 ctx->int_err = err;
571 ctx->int_cond = 1;
572 clear_work_bit(ctx);
573 if (err == 0) {
574 ctx->state = MFCINST_RUNNING;
575 if (!ctx->dpb_flush_flag && ctx->head_processed) {
576 if (!list_empty(&ctx->src_queue)) {
577 src_buf = list_entry(ctx->src_queue.next,
578 struct s5p_mfc_buf, list);
579 list_del(&src_buf->list);
580 ctx->src_queue_cnt--;
581 vb2_buffer_done(&src_buf->b->vb2_buf,
582 VB2_BUF_STATE_DONE);
584 } else {
585 ctx->dpb_flush_flag = 0;
587 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
589 s5p_mfc_clock_off();
591 wake_up(&ctx->queue);
592 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
593 } else {
594 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
596 s5p_mfc_clock_off();
598 wake_up(&ctx->queue);
602 static void s5p_mfc_handle_stream_complete(struct s5p_mfc_ctx *ctx)
604 struct s5p_mfc_dev *dev = ctx->dev;
605 struct s5p_mfc_buf *mb_entry;
607 mfc_debug(2, "Stream completed\n");
609 ctx->state = MFCINST_FINISHED;
611 if (!list_empty(&ctx->dst_queue)) {
612 mb_entry = list_entry(ctx->dst_queue.next, struct s5p_mfc_buf,
613 list);
614 list_del(&mb_entry->list);
615 ctx->dst_queue_cnt--;
616 vb2_set_plane_payload(&mb_entry->b->vb2_buf, 0, 0);
617 vb2_buffer_done(&mb_entry->b->vb2_buf, VB2_BUF_STATE_DONE);
620 clear_work_bit(ctx);
622 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
624 s5p_mfc_clock_off();
625 wake_up(&ctx->queue);
626 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
629 /* Interrupt processing */
630 static irqreturn_t s5p_mfc_irq(int irq, void *priv)
632 struct s5p_mfc_dev *dev = priv;
633 struct s5p_mfc_ctx *ctx;
634 unsigned int reason;
635 unsigned int err;
637 mfc_debug_enter();
638 /* Reset the timeout watchdog */
639 atomic_set(&dev->watchdog_cnt, 0);
640 spin_lock(&dev->irqlock);
641 ctx = dev->ctx[dev->curr_ctx];
642 /* Get the reason of interrupt and the error code */
643 reason = s5p_mfc_hw_call(dev->mfc_ops, get_int_reason, dev);
644 err = s5p_mfc_hw_call(dev->mfc_ops, get_int_err, dev);
645 mfc_debug(1, "Int reason: %d (err: %08x)\n", reason, err);
646 switch (reason) {
647 case S5P_MFC_R2H_CMD_ERR_RET:
648 /* An error has occurred */
649 if (ctx->state == MFCINST_RUNNING &&
650 (s5p_mfc_hw_call(dev->mfc_ops, err_dec, err) >=
651 dev->warn_start ||
652 err == S5P_FIMV_ERR_NO_VALID_SEQ_HDR ||
653 err == S5P_FIMV_ERR_INCOMPLETE_FRAME ||
654 err == S5P_FIMV_ERR_TIMEOUT))
655 s5p_mfc_handle_frame(ctx, reason, err);
656 else
657 s5p_mfc_handle_error(dev, ctx, reason, err);
658 clear_bit(0, &dev->enter_suspend);
659 break;
661 case S5P_MFC_R2H_CMD_SLICE_DONE_RET:
662 case S5P_MFC_R2H_CMD_FIELD_DONE_RET:
663 case S5P_MFC_R2H_CMD_FRAME_DONE_RET:
664 if (ctx->c_ops->post_frame_start) {
665 if (ctx->c_ops->post_frame_start(ctx))
666 mfc_err("post_frame_start() failed\n");
668 if (ctx->state == MFCINST_FINISHING &&
669 list_empty(&ctx->ref_queue)) {
670 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
671 s5p_mfc_handle_stream_complete(ctx);
672 break;
674 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
675 WARN_ON(test_and_clear_bit(0, &dev->hw_lock) == 0);
676 s5p_mfc_clock_off();
677 wake_up_ctx(ctx, reason, err);
678 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
679 } else {
680 s5p_mfc_handle_frame(ctx, reason, err);
682 break;
684 case S5P_MFC_R2H_CMD_SEQ_DONE_RET:
685 s5p_mfc_handle_seq_done(ctx, reason, err);
686 break;
688 case S5P_MFC_R2H_CMD_OPEN_INSTANCE_RET:
689 ctx->inst_no = s5p_mfc_hw_call(dev->mfc_ops, get_inst_no, dev);
690 ctx->state = MFCINST_GOT_INST;
691 goto irq_cleanup_hw;
693 case S5P_MFC_R2H_CMD_CLOSE_INSTANCE_RET:
694 ctx->inst_no = MFC_NO_INSTANCE_SET;
695 ctx->state = MFCINST_FREE;
696 goto irq_cleanup_hw;
698 case S5P_MFC_R2H_CMD_SYS_INIT_RET:
699 case S5P_MFC_R2H_CMD_FW_STATUS_RET:
700 case S5P_MFC_R2H_CMD_SLEEP_RET:
701 case S5P_MFC_R2H_CMD_WAKEUP_RET:
702 if (ctx)
703 clear_work_bit(ctx);
704 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
705 clear_bit(0, &dev->hw_lock);
706 clear_bit(0, &dev->enter_suspend);
707 wake_up_dev(dev, reason, err);
708 break;
710 case S5P_MFC_R2H_CMD_INIT_BUFFERS_RET:
711 s5p_mfc_handle_init_buffers(ctx, reason, err);
712 break;
714 case S5P_MFC_R2H_CMD_COMPLETE_SEQ_RET:
715 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
716 ctx->int_type = reason;
717 ctx->int_err = err;
718 s5p_mfc_handle_stream_complete(ctx);
719 break;
721 case S5P_MFC_R2H_CMD_DPB_FLUSH_RET:
722 ctx->state = MFCINST_RUNNING;
723 goto irq_cleanup_hw;
725 default:
726 mfc_debug(2, "Unknown int reason\n");
727 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
729 spin_unlock(&dev->irqlock);
730 mfc_debug_leave();
731 return IRQ_HANDLED;
732 irq_cleanup_hw:
733 s5p_mfc_hw_call(dev->mfc_ops, clear_int_flags, dev);
734 ctx->int_type = reason;
735 ctx->int_err = err;
736 ctx->int_cond = 1;
737 if (test_and_clear_bit(0, &dev->hw_lock) == 0)
738 mfc_err("Failed to unlock hw\n");
740 s5p_mfc_clock_off();
741 clear_work_bit(ctx);
742 wake_up(&ctx->queue);
744 s5p_mfc_hw_call(dev->mfc_ops, try_run, dev);
745 spin_unlock(&dev->irqlock);
746 mfc_debug(2, "Exit via irq_cleanup_hw\n");
747 return IRQ_HANDLED;
750 /* Open an MFC node */
751 static int s5p_mfc_open(struct file *file)
753 struct video_device *vdev = video_devdata(file);
754 struct s5p_mfc_dev *dev = video_drvdata(file);
755 struct s5p_mfc_ctx *ctx = NULL;
756 struct vb2_queue *q;
757 int ret = 0;
759 mfc_debug_enter();
760 if (mutex_lock_interruptible(&dev->mfc_mutex))
761 return -ERESTARTSYS;
762 dev->num_inst++; /* It is guarded by mfc_mutex in vfd */
763 /* Allocate memory for context */
764 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
765 if (!ctx) {
766 ret = -ENOMEM;
767 goto err_alloc;
769 init_waitqueue_head(&ctx->queue);
770 v4l2_fh_init(&ctx->fh, vdev);
771 file->private_data = &ctx->fh;
772 v4l2_fh_add(&ctx->fh);
773 ctx->dev = dev;
774 INIT_LIST_HEAD(&ctx->src_queue);
775 INIT_LIST_HEAD(&ctx->dst_queue);
776 ctx->src_queue_cnt = 0;
777 ctx->dst_queue_cnt = 0;
778 /* Get context number */
779 ctx->num = 0;
780 while (dev->ctx[ctx->num]) {
781 ctx->num++;
782 if (ctx->num >= MFC_NUM_CONTEXTS) {
783 mfc_debug(2, "Too many open contexts\n");
784 ret = -EBUSY;
785 goto err_no_ctx;
788 /* Mark context as idle */
789 clear_work_bit_irqsave(ctx);
790 dev->ctx[ctx->num] = ctx;
791 if (vdev == dev->vfd_dec) {
792 ctx->type = MFCINST_DECODER;
793 ctx->c_ops = get_dec_codec_ops();
794 s5p_mfc_dec_init(ctx);
795 /* Setup ctrl handler */
796 ret = s5p_mfc_dec_ctrls_setup(ctx);
797 if (ret) {
798 mfc_err("Failed to setup mfc controls\n");
799 goto err_ctrls_setup;
801 } else if (vdev == dev->vfd_enc) {
802 ctx->type = MFCINST_ENCODER;
803 ctx->c_ops = get_enc_codec_ops();
804 /* only for encoder */
805 INIT_LIST_HEAD(&ctx->ref_queue);
806 ctx->ref_queue_cnt = 0;
807 s5p_mfc_enc_init(ctx);
808 /* Setup ctrl handler */
809 ret = s5p_mfc_enc_ctrls_setup(ctx);
810 if (ret) {
811 mfc_err("Failed to setup mfc controls\n");
812 goto err_ctrls_setup;
814 } else {
815 ret = -ENOENT;
816 goto err_bad_node;
818 ctx->fh.ctrl_handler = &ctx->ctrl_handler;
819 ctx->inst_no = MFC_NO_INSTANCE_SET;
820 /* Load firmware if this is the first instance */
821 if (dev->num_inst == 1) {
822 dev->watchdog_timer.expires = jiffies +
823 msecs_to_jiffies(MFC_WATCHDOG_INTERVAL);
824 add_timer(&dev->watchdog_timer);
825 ret = s5p_mfc_power_on();
826 if (ret < 0) {
827 mfc_err("power on failed\n");
828 goto err_pwr_enable;
830 s5p_mfc_clock_on();
831 ret = s5p_mfc_load_firmware(dev);
832 if (ret) {
833 s5p_mfc_clock_off();
834 goto err_load_fw;
836 /* Init the FW */
837 ret = s5p_mfc_init_hw(dev);
838 s5p_mfc_clock_off();
839 if (ret)
840 goto err_init_hw;
842 /* Init videobuf2 queue for CAPTURE */
843 q = &ctx->vq_dst;
844 q->type = V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE;
845 q->drv_priv = &ctx->fh;
846 q->lock = &dev->mfc_mutex;
847 if (vdev == dev->vfd_dec) {
848 q->io_modes = VB2_MMAP;
849 q->ops = get_dec_queue_ops();
850 } else if (vdev == dev->vfd_enc) {
851 q->io_modes = VB2_MMAP | VB2_USERPTR;
852 q->ops = get_enc_queue_ops();
853 } else {
854 ret = -ENOENT;
855 goto err_queue_init;
858 * We'll do mostly sequential access, so sacrifice TLB efficiency for
859 * faster allocation.
861 q->dma_attrs = DMA_ATTR_ALLOC_SINGLE_PAGES;
862 q->mem_ops = &vb2_dma_contig_memops;
863 q->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_COPY;
864 ret = vb2_queue_init(q);
865 if (ret) {
866 mfc_err("Failed to initialize videobuf2 queue(capture)\n");
867 goto err_queue_init;
869 /* Init videobuf2 queue for OUTPUT */
870 q = &ctx->vq_src;
871 q->type = V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE;
872 q->drv_priv = &ctx->fh;
873 q->lock = &dev->mfc_mutex;
874 if (vdev == dev->vfd_dec) {
875 q->io_modes = VB2_MMAP;
876 q->ops = get_dec_queue_ops();
877 } else if (vdev == dev->vfd_enc) {
878 q->io_modes = VB2_MMAP | VB2_USERPTR;
879 q->ops = get_enc_queue_ops();
880 } else {
881 ret = -ENOENT;
882 goto err_queue_init;
884 /* One way to indicate end-of-stream for MFC is to set the
885 * bytesused == 0. However by default videobuf2 handles bytesused
886 * equal to 0 as a special case and changes its value to the size
887 * of the buffer. Set the allow_zero_bytesused flag so that videobuf2
888 * will keep the value of bytesused intact.
890 q->allow_zero_bytesused = 1;
893 * We'll do mostly sequential access, so sacrifice TLB efficiency for
894 * faster allocation.
896 q->dma_attrs = DMA_ATTR_ALLOC_SINGLE_PAGES;
897 q->mem_ops = &vb2_dma_contig_memops;
898 q->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_COPY;
899 ret = vb2_queue_init(q);
900 if (ret) {
901 mfc_err("Failed to initialize videobuf2 queue(output)\n");
902 goto err_queue_init;
904 mutex_unlock(&dev->mfc_mutex);
905 mfc_debug_leave();
906 return ret;
907 /* Deinit when failure occurred */
908 err_queue_init:
909 if (dev->num_inst == 1)
910 s5p_mfc_deinit_hw(dev);
911 err_init_hw:
912 err_load_fw:
913 err_pwr_enable:
914 if (dev->num_inst == 1) {
915 if (s5p_mfc_power_off() < 0)
916 mfc_err("power off failed\n");
917 del_timer_sync(&dev->watchdog_timer);
919 err_ctrls_setup:
920 s5p_mfc_dec_ctrls_delete(ctx);
921 err_bad_node:
922 dev->ctx[ctx->num] = NULL;
923 err_no_ctx:
924 v4l2_fh_del(&ctx->fh);
925 v4l2_fh_exit(&ctx->fh);
926 kfree(ctx);
927 err_alloc:
928 dev->num_inst--;
929 mutex_unlock(&dev->mfc_mutex);
930 mfc_debug_leave();
931 return ret;
934 /* Release MFC context */
935 static int s5p_mfc_release(struct file *file)
937 struct s5p_mfc_ctx *ctx = fh_to_ctx(file->private_data);
938 struct s5p_mfc_dev *dev = ctx->dev;
940 /* if dev is null, do cleanup that doesn't need dev */
941 mfc_debug_enter();
942 if (dev)
943 mutex_lock(&dev->mfc_mutex);
944 vb2_queue_release(&ctx->vq_src);
945 vb2_queue_release(&ctx->vq_dst);
946 if (dev) {
947 s5p_mfc_clock_on();
949 /* Mark context as idle */
950 clear_work_bit_irqsave(ctx);
952 * If instance was initialised and not yet freed,
953 * return instance and free resources
955 if (ctx->state != MFCINST_FREE && ctx->state != MFCINST_INIT) {
956 mfc_debug(2, "Has to free instance\n");
957 s5p_mfc_close_mfc_inst(dev, ctx);
959 /* hardware locking scheme */
960 if (dev->curr_ctx == ctx->num)
961 clear_bit(0, &dev->hw_lock);
962 dev->num_inst--;
963 if (dev->num_inst == 0) {
964 mfc_debug(2, "Last instance\n");
965 s5p_mfc_deinit_hw(dev);
966 del_timer_sync(&dev->watchdog_timer);
967 s5p_mfc_clock_off();
968 if (s5p_mfc_power_off() < 0)
969 mfc_err("Power off failed\n");
970 } else {
971 mfc_debug(2, "Shutting down clock\n");
972 s5p_mfc_clock_off();
975 if (dev)
976 dev->ctx[ctx->num] = NULL;
977 s5p_mfc_dec_ctrls_delete(ctx);
978 v4l2_fh_del(&ctx->fh);
979 /* vdev is gone if dev is null */
980 if (dev)
981 v4l2_fh_exit(&ctx->fh);
982 kfree(ctx);
983 mfc_debug_leave();
984 if (dev)
985 mutex_unlock(&dev->mfc_mutex);
987 return 0;
990 /* Poll */
991 static __poll_t s5p_mfc_poll(struct file *file,
992 struct poll_table_struct *wait)
994 struct s5p_mfc_ctx *ctx = fh_to_ctx(file->private_data);
995 struct s5p_mfc_dev *dev = ctx->dev;
996 struct vb2_queue *src_q, *dst_q;
997 struct vb2_buffer *src_vb = NULL, *dst_vb = NULL;
998 __poll_t rc = 0;
999 unsigned long flags;
1001 mutex_lock(&dev->mfc_mutex);
1002 src_q = &ctx->vq_src;
1003 dst_q = &ctx->vq_dst;
1005 * There has to be at least one buffer queued on each queued_list, which
1006 * means either in driver already or waiting for driver to claim it
1007 * and start processing.
1009 if ((!src_q->streaming || list_empty(&src_q->queued_list))
1010 && (!dst_q->streaming || list_empty(&dst_q->queued_list))) {
1011 rc = EPOLLERR;
1012 goto end;
1014 mutex_unlock(&dev->mfc_mutex);
1015 poll_wait(file, &ctx->fh.wait, wait);
1016 poll_wait(file, &src_q->done_wq, wait);
1017 poll_wait(file, &dst_q->done_wq, wait);
1018 mutex_lock(&dev->mfc_mutex);
1019 if (v4l2_event_pending(&ctx->fh))
1020 rc |= EPOLLPRI;
1021 spin_lock_irqsave(&src_q->done_lock, flags);
1022 if (!list_empty(&src_q->done_list))
1023 src_vb = list_first_entry(&src_q->done_list, struct vb2_buffer,
1024 done_entry);
1025 if (src_vb && (src_vb->state == VB2_BUF_STATE_DONE
1026 || src_vb->state == VB2_BUF_STATE_ERROR))
1027 rc |= EPOLLOUT | EPOLLWRNORM;
1028 spin_unlock_irqrestore(&src_q->done_lock, flags);
1029 spin_lock_irqsave(&dst_q->done_lock, flags);
1030 if (!list_empty(&dst_q->done_list))
1031 dst_vb = list_first_entry(&dst_q->done_list, struct vb2_buffer,
1032 done_entry);
1033 if (dst_vb && (dst_vb->state == VB2_BUF_STATE_DONE
1034 || dst_vb->state == VB2_BUF_STATE_ERROR))
1035 rc |= EPOLLIN | EPOLLRDNORM;
1036 spin_unlock_irqrestore(&dst_q->done_lock, flags);
1037 end:
1038 mutex_unlock(&dev->mfc_mutex);
1039 return rc;
1042 /* Mmap */
1043 static int s5p_mfc_mmap(struct file *file, struct vm_area_struct *vma)
1045 struct s5p_mfc_ctx *ctx = fh_to_ctx(file->private_data);
1046 unsigned long offset = vma->vm_pgoff << PAGE_SHIFT;
1047 int ret;
1049 if (offset < DST_QUEUE_OFF_BASE) {
1050 mfc_debug(2, "mmaping source\n");
1051 ret = vb2_mmap(&ctx->vq_src, vma);
1052 } else { /* capture */
1053 mfc_debug(2, "mmaping destination\n");
1054 vma->vm_pgoff -= (DST_QUEUE_OFF_BASE >> PAGE_SHIFT);
1055 ret = vb2_mmap(&ctx->vq_dst, vma);
1057 return ret;
1060 /* v4l2 ops */
1061 static const struct v4l2_file_operations s5p_mfc_fops = {
1062 .owner = THIS_MODULE,
1063 .open = s5p_mfc_open,
1064 .release = s5p_mfc_release,
1065 .poll = s5p_mfc_poll,
1066 .unlocked_ioctl = video_ioctl2,
1067 .mmap = s5p_mfc_mmap,
1070 /* DMA memory related helper functions */
1071 static void s5p_mfc_memdev_release(struct device *dev)
1073 of_reserved_mem_device_release(dev);
1076 static struct device *s5p_mfc_alloc_memdev(struct device *dev,
1077 const char *name, unsigned int idx)
1079 struct device *child;
1080 int ret;
1082 child = devm_kzalloc(dev, sizeof(*child), GFP_KERNEL);
1083 if (!child)
1084 return NULL;
1086 device_initialize(child);
1087 dev_set_name(child, "%s:%s", dev_name(dev), name);
1088 child->parent = dev;
1089 child->coherent_dma_mask = dev->coherent_dma_mask;
1090 child->dma_mask = dev->dma_mask;
1091 child->release = s5p_mfc_memdev_release;
1094 * The memdevs are not proper OF platform devices, so in order for them
1095 * to be treated as valid DMA masters we need a bit of a hack to force
1096 * them to inherit the MFC node's DMA configuration.
1098 of_dma_configure(child, dev->of_node, true);
1100 if (device_add(child) == 0) {
1101 ret = of_reserved_mem_device_init_by_idx(child, dev->of_node,
1102 idx);
1103 if (ret == 0)
1104 return child;
1105 device_del(child);
1108 put_device(child);
1109 return NULL;
1112 static int s5p_mfc_configure_2port_memory(struct s5p_mfc_dev *mfc_dev)
1114 struct device *dev = &mfc_dev->plat_dev->dev;
1115 void *bank2_virt;
1116 dma_addr_t bank2_dma_addr;
1117 unsigned long align_size = 1 << MFC_BASE_ALIGN_ORDER;
1118 int ret;
1121 * Create and initialize virtual devices for accessing
1122 * reserved memory regions.
1124 mfc_dev->mem_dev[BANK_L_CTX] = s5p_mfc_alloc_memdev(dev, "left",
1125 BANK_L_CTX);
1126 if (!mfc_dev->mem_dev[BANK_L_CTX])
1127 return -ENODEV;
1128 mfc_dev->mem_dev[BANK_R_CTX] = s5p_mfc_alloc_memdev(dev, "right",
1129 BANK_R_CTX);
1130 if (!mfc_dev->mem_dev[BANK_R_CTX]) {
1131 device_unregister(mfc_dev->mem_dev[BANK_L_CTX]);
1132 return -ENODEV;
1135 /* Allocate memory for firmware and initialize both banks addresses */
1136 ret = s5p_mfc_alloc_firmware(mfc_dev);
1137 if (ret) {
1138 device_unregister(mfc_dev->mem_dev[BANK_R_CTX]);
1139 device_unregister(mfc_dev->mem_dev[BANK_L_CTX]);
1140 return ret;
1143 mfc_dev->dma_base[BANK_L_CTX] = mfc_dev->fw_buf.dma;
1145 bank2_virt = dma_alloc_coherent(mfc_dev->mem_dev[BANK_R_CTX],
1146 align_size, &bank2_dma_addr, GFP_KERNEL);
1147 if (!bank2_virt) {
1148 mfc_err("Allocating bank2 base failed\n");
1149 s5p_mfc_release_firmware(mfc_dev);
1150 device_unregister(mfc_dev->mem_dev[BANK_R_CTX]);
1151 device_unregister(mfc_dev->mem_dev[BANK_L_CTX]);
1152 return -ENOMEM;
1155 /* Valid buffers passed to MFC encoder with LAST_FRAME command
1156 * should not have address of bank2 - MFC will treat it as a null frame.
1157 * To avoid such situation we set bank2 address below the pool address.
1159 mfc_dev->dma_base[BANK_R_CTX] = bank2_dma_addr - align_size;
1161 dma_free_coherent(mfc_dev->mem_dev[BANK_R_CTX], align_size, bank2_virt,
1162 bank2_dma_addr);
1164 vb2_dma_contig_set_max_seg_size(mfc_dev->mem_dev[BANK_L_CTX],
1165 DMA_BIT_MASK(32));
1166 vb2_dma_contig_set_max_seg_size(mfc_dev->mem_dev[BANK_R_CTX],
1167 DMA_BIT_MASK(32));
1169 return 0;
1172 static void s5p_mfc_unconfigure_2port_memory(struct s5p_mfc_dev *mfc_dev)
1174 device_unregister(mfc_dev->mem_dev[BANK_L_CTX]);
1175 device_unregister(mfc_dev->mem_dev[BANK_R_CTX]);
1176 vb2_dma_contig_clear_max_seg_size(mfc_dev->mem_dev[BANK_L_CTX]);
1177 vb2_dma_contig_clear_max_seg_size(mfc_dev->mem_dev[BANK_R_CTX]);
1180 static int s5p_mfc_configure_common_memory(struct s5p_mfc_dev *mfc_dev)
1182 struct device *dev = &mfc_dev->plat_dev->dev;
1183 unsigned long mem_size = SZ_4M;
1184 unsigned int bitmap_size;
1186 if (IS_ENABLED(CONFIG_DMA_CMA) || exynos_is_iommu_available(dev))
1187 mem_size = SZ_8M;
1189 if (mfc_mem_size)
1190 mem_size = memparse(mfc_mem_size, NULL);
1192 bitmap_size = BITS_TO_LONGS(mem_size >> PAGE_SHIFT) * sizeof(long);
1194 mfc_dev->mem_bitmap = kzalloc(bitmap_size, GFP_KERNEL);
1195 if (!mfc_dev->mem_bitmap)
1196 return -ENOMEM;
1198 mfc_dev->mem_virt = dma_alloc_coherent(dev, mem_size,
1199 &mfc_dev->mem_base, GFP_KERNEL);
1200 if (!mfc_dev->mem_virt) {
1201 kfree(mfc_dev->mem_bitmap);
1202 dev_err(dev, "failed to preallocate %ld MiB for the firmware and context buffers\n",
1203 (mem_size / SZ_1M));
1204 return -ENOMEM;
1206 mfc_dev->mem_size = mem_size;
1207 mfc_dev->dma_base[BANK_L_CTX] = mfc_dev->mem_base;
1208 mfc_dev->dma_base[BANK_R_CTX] = mfc_dev->mem_base;
1211 * MFC hardware cannot handle 0 as a base address, so mark first 128K
1212 * as used (to keep required base alignment) and adjust base address
1214 if (mfc_dev->mem_base == (dma_addr_t)0) {
1215 unsigned int offset = 1 << MFC_BASE_ALIGN_ORDER;
1217 bitmap_set(mfc_dev->mem_bitmap, 0, offset >> PAGE_SHIFT);
1218 mfc_dev->dma_base[BANK_L_CTX] += offset;
1219 mfc_dev->dma_base[BANK_R_CTX] += offset;
1222 /* Firmware allocation cannot fail in this case */
1223 s5p_mfc_alloc_firmware(mfc_dev);
1225 mfc_dev->mem_dev[BANK_L_CTX] = mfc_dev->mem_dev[BANK_R_CTX] = dev;
1226 vb2_dma_contig_set_max_seg_size(dev, DMA_BIT_MASK(32));
1228 dev_info(dev, "preallocated %ld MiB buffer for the firmware and context buffers\n",
1229 (mem_size / SZ_1M));
1231 return 0;
1234 static void s5p_mfc_unconfigure_common_memory(struct s5p_mfc_dev *mfc_dev)
1236 struct device *dev = &mfc_dev->plat_dev->dev;
1238 dma_free_coherent(dev, mfc_dev->mem_size, mfc_dev->mem_virt,
1239 mfc_dev->mem_base);
1240 kfree(mfc_dev->mem_bitmap);
1241 vb2_dma_contig_clear_max_seg_size(dev);
1244 static int s5p_mfc_configure_dma_memory(struct s5p_mfc_dev *mfc_dev)
1246 struct device *dev = &mfc_dev->plat_dev->dev;
1248 if (exynos_is_iommu_available(dev) || !IS_TWOPORT(mfc_dev))
1249 return s5p_mfc_configure_common_memory(mfc_dev);
1250 else
1251 return s5p_mfc_configure_2port_memory(mfc_dev);
1254 static void s5p_mfc_unconfigure_dma_memory(struct s5p_mfc_dev *mfc_dev)
1256 struct device *dev = &mfc_dev->plat_dev->dev;
1258 s5p_mfc_release_firmware(mfc_dev);
1259 if (exynos_is_iommu_available(dev) || !IS_TWOPORT(mfc_dev))
1260 s5p_mfc_unconfigure_common_memory(mfc_dev);
1261 else
1262 s5p_mfc_unconfigure_2port_memory(mfc_dev);
1265 /* MFC probe function */
1266 static int s5p_mfc_probe(struct platform_device *pdev)
1268 struct s5p_mfc_dev *dev;
1269 struct video_device *vfd;
1270 struct resource *res;
1271 int ret;
1273 pr_debug("%s++\n", __func__);
1274 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1275 if (!dev)
1276 return -ENOMEM;
1278 spin_lock_init(&dev->irqlock);
1279 spin_lock_init(&dev->condlock);
1280 dev->plat_dev = pdev;
1281 if (!dev->plat_dev) {
1282 dev_err(&pdev->dev, "No platform data specified\n");
1283 return -ENODEV;
1286 dev->variant = of_device_get_match_data(&pdev->dev);
1288 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1289 dev->regs_base = devm_ioremap_resource(&pdev->dev, res);
1290 if (IS_ERR(dev->regs_base))
1291 return PTR_ERR(dev->regs_base);
1293 res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
1294 if (!res) {
1295 dev_err(&pdev->dev, "failed to get irq resource\n");
1296 return -ENOENT;
1298 dev->irq = res->start;
1299 ret = devm_request_irq(&pdev->dev, dev->irq, s5p_mfc_irq,
1300 0, pdev->name, dev);
1301 if (ret) {
1302 dev_err(&pdev->dev, "Failed to install irq (%d)\n", ret);
1303 return ret;
1306 ret = s5p_mfc_configure_dma_memory(dev);
1307 if (ret < 0) {
1308 dev_err(&pdev->dev, "failed to configure DMA memory\n");
1309 return ret;
1312 ret = s5p_mfc_init_pm(dev);
1313 if (ret < 0) {
1314 dev_err(&pdev->dev, "failed to get mfc clock source\n");
1315 goto err_dma;
1319 * Load fails if fs isn't mounted. Try loading anyway.
1320 * _open() will load it, it it fails now. Ignore failure.
1322 s5p_mfc_load_firmware(dev);
1324 mutex_init(&dev->mfc_mutex);
1325 init_waitqueue_head(&dev->queue);
1326 dev->hw_lock = 0;
1327 INIT_WORK(&dev->watchdog_work, s5p_mfc_watchdog_worker);
1328 atomic_set(&dev->watchdog_cnt, 0);
1329 timer_setup(&dev->watchdog_timer, s5p_mfc_watchdog, 0);
1331 ret = v4l2_device_register(&pdev->dev, &dev->v4l2_dev);
1332 if (ret)
1333 goto err_v4l2_dev_reg;
1335 /* decoder */
1336 vfd = video_device_alloc();
1337 if (!vfd) {
1338 v4l2_err(&dev->v4l2_dev, "Failed to allocate video device\n");
1339 ret = -ENOMEM;
1340 goto err_dec_alloc;
1342 vfd->fops = &s5p_mfc_fops;
1343 vfd->ioctl_ops = get_dec_v4l2_ioctl_ops();
1344 vfd->release = video_device_release;
1345 vfd->lock = &dev->mfc_mutex;
1346 vfd->v4l2_dev = &dev->v4l2_dev;
1347 vfd->vfl_dir = VFL_DIR_M2M;
1348 vfd->device_caps = V4L2_CAP_VIDEO_M2M_MPLANE | V4L2_CAP_STREAMING;
1349 set_bit(V4L2_FL_QUIRK_INVERTED_CROP, &vfd->flags);
1350 snprintf(vfd->name, sizeof(vfd->name), "%s", S5P_MFC_DEC_NAME);
1351 dev->vfd_dec = vfd;
1352 video_set_drvdata(vfd, dev);
1354 /* encoder */
1355 vfd = video_device_alloc();
1356 if (!vfd) {
1357 v4l2_err(&dev->v4l2_dev, "Failed to allocate video device\n");
1358 ret = -ENOMEM;
1359 goto err_enc_alloc;
1361 vfd->fops = &s5p_mfc_fops;
1362 vfd->ioctl_ops = get_enc_v4l2_ioctl_ops();
1363 vfd->release = video_device_release;
1364 vfd->lock = &dev->mfc_mutex;
1365 vfd->v4l2_dev = &dev->v4l2_dev;
1366 vfd->vfl_dir = VFL_DIR_M2M;
1367 vfd->device_caps = V4L2_CAP_VIDEO_M2M_MPLANE | V4L2_CAP_STREAMING;
1368 snprintf(vfd->name, sizeof(vfd->name), "%s", S5P_MFC_ENC_NAME);
1369 dev->vfd_enc = vfd;
1370 video_set_drvdata(vfd, dev);
1371 platform_set_drvdata(pdev, dev);
1373 /* Initialize HW ops and commands based on MFC version */
1374 s5p_mfc_init_hw_ops(dev);
1375 s5p_mfc_init_hw_cmds(dev);
1376 s5p_mfc_init_regs(dev);
1378 /* Register decoder and encoder */
1379 ret = video_register_device(dev->vfd_dec, VFL_TYPE_VIDEO, 0);
1380 if (ret) {
1381 v4l2_err(&dev->v4l2_dev, "Failed to register video device\n");
1382 goto err_dec_reg;
1384 v4l2_info(&dev->v4l2_dev,
1385 "decoder registered as /dev/video%d\n", dev->vfd_dec->num);
1387 ret = video_register_device(dev->vfd_enc, VFL_TYPE_VIDEO, 0);
1388 if (ret) {
1389 v4l2_err(&dev->v4l2_dev, "Failed to register video device\n");
1390 goto err_enc_reg;
1392 v4l2_info(&dev->v4l2_dev,
1393 "encoder registered as /dev/video%d\n", dev->vfd_enc->num);
1395 pr_debug("%s--\n", __func__);
1396 return 0;
1398 /* Deinit MFC if probe had failed */
1399 err_enc_reg:
1400 video_unregister_device(dev->vfd_dec);
1401 err_dec_reg:
1402 video_device_release(dev->vfd_enc);
1403 err_enc_alloc:
1404 video_device_release(dev->vfd_dec);
1405 err_dec_alloc:
1406 v4l2_device_unregister(&dev->v4l2_dev);
1407 err_v4l2_dev_reg:
1408 s5p_mfc_final_pm(dev);
1409 err_dma:
1410 s5p_mfc_unconfigure_dma_memory(dev);
1412 pr_debug("%s-- with error\n", __func__);
1413 return ret;
1417 /* Remove the driver */
1418 static int s5p_mfc_remove(struct platform_device *pdev)
1420 struct s5p_mfc_dev *dev = platform_get_drvdata(pdev);
1421 struct s5p_mfc_ctx *ctx;
1422 int i;
1424 v4l2_info(&dev->v4l2_dev, "Removing %s\n", pdev->name);
1427 * Clear ctx dev pointer to avoid races between s5p_mfc_remove()
1428 * and s5p_mfc_release() and s5p_mfc_release() accessing ctx->dev
1429 * after s5p_mfc_remove() is run during unbind.
1431 mutex_lock(&dev->mfc_mutex);
1432 for (i = 0; i < MFC_NUM_CONTEXTS; i++) {
1433 ctx = dev->ctx[i];
1434 if (!ctx)
1435 continue;
1436 /* clear ctx->dev */
1437 ctx->dev = NULL;
1439 mutex_unlock(&dev->mfc_mutex);
1441 del_timer_sync(&dev->watchdog_timer);
1442 flush_work(&dev->watchdog_work);
1444 video_unregister_device(dev->vfd_enc);
1445 video_unregister_device(dev->vfd_dec);
1446 video_device_release(dev->vfd_enc);
1447 video_device_release(dev->vfd_dec);
1448 v4l2_device_unregister(&dev->v4l2_dev);
1449 s5p_mfc_unconfigure_dma_memory(dev);
1451 s5p_mfc_final_pm(dev);
1452 return 0;
1455 #ifdef CONFIG_PM_SLEEP
1457 static int s5p_mfc_suspend(struct device *dev)
1459 struct s5p_mfc_dev *m_dev = dev_get_drvdata(dev);
1460 int ret;
1462 if (m_dev->num_inst == 0)
1463 return 0;
1465 if (test_and_set_bit(0, &m_dev->enter_suspend) != 0) {
1466 mfc_err("Error: going to suspend for a second time\n");
1467 return -EIO;
1470 /* Check if we're processing then wait if it necessary. */
1471 while (test_and_set_bit(0, &m_dev->hw_lock) != 0) {
1472 /* Try and lock the HW */
1473 /* Wait on the interrupt waitqueue */
1474 ret = wait_event_interruptible_timeout(m_dev->queue,
1475 m_dev->int_cond, msecs_to_jiffies(MFC_INT_TIMEOUT));
1476 if (ret == 0) {
1477 mfc_err("Waiting for hardware to finish timed out\n");
1478 clear_bit(0, &m_dev->enter_suspend);
1479 return -EIO;
1483 ret = s5p_mfc_sleep(m_dev);
1484 if (ret) {
1485 clear_bit(0, &m_dev->enter_suspend);
1486 clear_bit(0, &m_dev->hw_lock);
1488 return ret;
1491 static int s5p_mfc_resume(struct device *dev)
1493 struct s5p_mfc_dev *m_dev = dev_get_drvdata(dev);
1495 if (m_dev->num_inst == 0)
1496 return 0;
1497 return s5p_mfc_wakeup(m_dev);
1499 #endif
1501 /* Power management */
1502 static const struct dev_pm_ops s5p_mfc_pm_ops = {
1503 SET_SYSTEM_SLEEP_PM_OPS(s5p_mfc_suspend, s5p_mfc_resume)
1506 static struct s5p_mfc_buf_size_v5 mfc_buf_size_v5 = {
1507 .h264_ctx = MFC_H264_CTX_BUF_SIZE,
1508 .non_h264_ctx = MFC_CTX_BUF_SIZE,
1509 .dsc = DESC_BUF_SIZE,
1510 .shm = SHARED_BUF_SIZE,
1513 static struct s5p_mfc_buf_size buf_size_v5 = {
1514 .fw = MAX_FW_SIZE,
1515 .cpb = MAX_CPB_SIZE,
1516 .priv = &mfc_buf_size_v5,
1519 static struct s5p_mfc_variant mfc_drvdata_v5 = {
1520 .version = MFC_VERSION,
1521 .version_bit = MFC_V5_BIT,
1522 .port_num = MFC_NUM_PORTS,
1523 .buf_size = &buf_size_v5,
1524 .fw_name[0] = "s5p-mfc.fw",
1525 .clk_names = {"mfc", "sclk_mfc"},
1526 .num_clocks = 2,
1527 .use_clock_gating = true,
1530 static struct s5p_mfc_buf_size_v6 mfc_buf_size_v6 = {
1531 .dev_ctx = MFC_CTX_BUF_SIZE_V6,
1532 .h264_dec_ctx = MFC_H264_DEC_CTX_BUF_SIZE_V6,
1533 .other_dec_ctx = MFC_OTHER_DEC_CTX_BUF_SIZE_V6,
1534 .h264_enc_ctx = MFC_H264_ENC_CTX_BUF_SIZE_V6,
1535 .other_enc_ctx = MFC_OTHER_ENC_CTX_BUF_SIZE_V6,
1538 static struct s5p_mfc_buf_size buf_size_v6 = {
1539 .fw = MAX_FW_SIZE_V6,
1540 .cpb = MAX_CPB_SIZE_V6,
1541 .priv = &mfc_buf_size_v6,
1544 static struct s5p_mfc_variant mfc_drvdata_v6 = {
1545 .version = MFC_VERSION_V6,
1546 .version_bit = MFC_V6_BIT,
1547 .port_num = MFC_NUM_PORTS_V6,
1548 .buf_size = &buf_size_v6,
1549 .fw_name[0] = "s5p-mfc-v6.fw",
1551 * v6-v2 firmware contains bug fixes and interface change
1552 * for init buffer command
1554 .fw_name[1] = "s5p-mfc-v6-v2.fw",
1555 .clk_names = {"mfc"},
1556 .num_clocks = 1,
1559 static struct s5p_mfc_buf_size_v6 mfc_buf_size_v7 = {
1560 .dev_ctx = MFC_CTX_BUF_SIZE_V7,
1561 .h264_dec_ctx = MFC_H264_DEC_CTX_BUF_SIZE_V7,
1562 .other_dec_ctx = MFC_OTHER_DEC_CTX_BUF_SIZE_V7,
1563 .h264_enc_ctx = MFC_H264_ENC_CTX_BUF_SIZE_V7,
1564 .other_enc_ctx = MFC_OTHER_ENC_CTX_BUF_SIZE_V7,
1567 static struct s5p_mfc_buf_size buf_size_v7 = {
1568 .fw = MAX_FW_SIZE_V7,
1569 .cpb = MAX_CPB_SIZE_V7,
1570 .priv = &mfc_buf_size_v7,
1573 static struct s5p_mfc_variant mfc_drvdata_v7 = {
1574 .version = MFC_VERSION_V7,
1575 .version_bit = MFC_V7_BIT,
1576 .port_num = MFC_NUM_PORTS_V7,
1577 .buf_size = &buf_size_v7,
1578 .fw_name[0] = "s5p-mfc-v7.fw",
1579 .clk_names = {"mfc", "sclk_mfc"},
1580 .num_clocks = 2,
1583 static struct s5p_mfc_buf_size_v6 mfc_buf_size_v8 = {
1584 .dev_ctx = MFC_CTX_BUF_SIZE_V8,
1585 .h264_dec_ctx = MFC_H264_DEC_CTX_BUF_SIZE_V8,
1586 .other_dec_ctx = MFC_OTHER_DEC_CTX_BUF_SIZE_V8,
1587 .h264_enc_ctx = MFC_H264_ENC_CTX_BUF_SIZE_V8,
1588 .other_enc_ctx = MFC_OTHER_ENC_CTX_BUF_SIZE_V8,
1591 static struct s5p_mfc_buf_size buf_size_v8 = {
1592 .fw = MAX_FW_SIZE_V8,
1593 .cpb = MAX_CPB_SIZE_V8,
1594 .priv = &mfc_buf_size_v8,
1597 static struct s5p_mfc_variant mfc_drvdata_v8 = {
1598 .version = MFC_VERSION_V8,
1599 .version_bit = MFC_V8_BIT,
1600 .port_num = MFC_NUM_PORTS_V8,
1601 .buf_size = &buf_size_v8,
1602 .fw_name[0] = "s5p-mfc-v8.fw",
1603 .clk_names = {"mfc"},
1604 .num_clocks = 1,
1607 static struct s5p_mfc_variant mfc_drvdata_v8_5433 = {
1608 .version = MFC_VERSION_V8,
1609 .version_bit = MFC_V8_BIT,
1610 .port_num = MFC_NUM_PORTS_V8,
1611 .buf_size = &buf_size_v8,
1612 .fw_name[0] = "s5p-mfc-v8.fw",
1613 .clk_names = {"pclk", "aclk", "aclk_xiu"},
1614 .num_clocks = 3,
1617 static struct s5p_mfc_buf_size_v6 mfc_buf_size_v10 = {
1618 .dev_ctx = MFC_CTX_BUF_SIZE_V10,
1619 .h264_dec_ctx = MFC_H264_DEC_CTX_BUF_SIZE_V10,
1620 .other_dec_ctx = MFC_OTHER_DEC_CTX_BUF_SIZE_V10,
1621 .h264_enc_ctx = MFC_H264_ENC_CTX_BUF_SIZE_V10,
1622 .hevc_enc_ctx = MFC_HEVC_ENC_CTX_BUF_SIZE_V10,
1623 .other_enc_ctx = MFC_OTHER_ENC_CTX_BUF_SIZE_V10,
1626 static struct s5p_mfc_buf_size buf_size_v10 = {
1627 .fw = MAX_FW_SIZE_V10,
1628 .cpb = MAX_CPB_SIZE_V10,
1629 .priv = &mfc_buf_size_v10,
1632 static struct s5p_mfc_variant mfc_drvdata_v10 = {
1633 .version = MFC_VERSION_V10,
1634 .version_bit = MFC_V10_BIT,
1635 .port_num = MFC_NUM_PORTS_V10,
1636 .buf_size = &buf_size_v10,
1637 .fw_name[0] = "s5p-mfc-v10.fw",
1640 static const struct of_device_id exynos_mfc_match[] = {
1642 .compatible = "samsung,mfc-v5",
1643 .data = &mfc_drvdata_v5,
1644 }, {
1645 .compatible = "samsung,mfc-v6",
1646 .data = &mfc_drvdata_v6,
1647 }, {
1648 .compatible = "samsung,mfc-v7",
1649 .data = &mfc_drvdata_v7,
1650 }, {
1651 .compatible = "samsung,mfc-v8",
1652 .data = &mfc_drvdata_v8,
1653 }, {
1654 .compatible = "samsung,exynos5433-mfc",
1655 .data = &mfc_drvdata_v8_5433,
1656 }, {
1657 .compatible = "samsung,mfc-v10",
1658 .data = &mfc_drvdata_v10,
1662 MODULE_DEVICE_TABLE(of, exynos_mfc_match);
1664 static struct platform_driver s5p_mfc_driver = {
1665 .probe = s5p_mfc_probe,
1666 .remove = s5p_mfc_remove,
1667 .driver = {
1668 .name = S5P_MFC_NAME,
1669 .pm = &s5p_mfc_pm_ops,
1670 .of_match_table = exynos_mfc_match,
1674 module_platform_driver(s5p_mfc_driver);
1676 MODULE_LICENSE("GPL");
1677 MODULE_AUTHOR("Kamil Debski <k.debski@samsung.com>");
1678 MODULE_DESCRIPTION("Samsung S5P Multi Format Codec V4L2 driver");