Linux-libre 3.10.70-gnu
[librecmc/linux-libre.git] / drivers / media / platform / s3c-camif / camif-core.c
1 /*
2  * s3c24xx/s3c64xx SoC series Camera Interface (CAMIF) driver
3  *
4  * Copyright (C) 2012 Sylwester Nawrocki <sylvester.nawrocki@gmail.com>
5  * Copyright (C) 2012 Tomasz Figa <tomasz.figa@gmail.com>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published
9  * by the Free Software Foundation, either version 2 of the License,
10  * or (at your option) any later version.
11  */
12 #define pr_fmt(fmt) "%s:%d " fmt, __func__, __LINE__
13
14 #include <linux/bug.h>
15 #include <linux/clk.h>
16 #include <linux/delay.h>
17 #include <linux/device.h>
18 #include <linux/errno.h>
19 #include <linux/gpio.h>
20 #include <linux/i2c.h>
21 #include <linux/interrupt.h>
22 #include <linux/io.h>
23 #include <linux/kernel.h>
24 #include <linux/list.h>
25 #include <linux/module.h>
26 #include <linux/platform_device.h>
27 #include <linux/pm_runtime.h>
28 #include <linux/slab.h>
29 #include <linux/types.h>
30 #include <linux/version.h>
31
32 #include <media/media-device.h>
33 #include <media/v4l2-ctrls.h>
34 #include <media/v4l2-ioctl.h>
35 #include <media/videobuf2-core.h>
36 #include <media/videobuf2-dma-contig.h>
37
38 #include "camif-core.h"
39
40 static char *camif_clocks[CLK_MAX_NUM] = {
41         /* HCLK CAMIF clock */
42         [CLK_GATE]      = "camif",
43         /* CAMIF / external camera sensor master clock */
44         [CLK_CAM]       = "camera",
45 };
46
47 static const struct camif_fmt camif_formats[] = {
48         {
49                 .name           = "YUV 4:2:2 planar, Y/Cb/Cr",
50                 .fourcc         = V4L2_PIX_FMT_YUV422P,
51                 .depth          = 16,
52                 .ybpp           = 1,
53                 .color          = IMG_FMT_YCBCR422P,
54                 .colplanes      = 3,
55                 .flags          = FMT_FL_S3C24XX_CODEC |
56                                   FMT_FL_S3C64XX,
57         }, {
58                 .name           = "YUV 4:2:0 planar, Y/Cb/Cr",
59                 .fourcc         = V4L2_PIX_FMT_YUV420,
60                 .depth          = 12,
61                 .ybpp           = 1,
62                 .color          = IMG_FMT_YCBCR420,
63                 .colplanes      = 3,
64                 .flags          = FMT_FL_S3C24XX_CODEC |
65                                   FMT_FL_S3C64XX,
66         }, {
67                 .name           = "YVU 4:2:0 planar, Y/Cr/Cb",
68                 .fourcc         = V4L2_PIX_FMT_YVU420,
69                 .depth          = 12,
70                 .ybpp           = 1,
71                 .color          = IMG_FMT_YCRCB420,
72                 .colplanes      = 3,
73                 .flags          = FMT_FL_S3C24XX_CODEC |
74                                   FMT_FL_S3C64XX,
75         }, {
76                 .name           = "RGB565, 16 bpp",
77                 .fourcc         = V4L2_PIX_FMT_RGB565X,
78                 .depth          = 16,
79                 .ybpp           = 2,
80                 .color          = IMG_FMT_RGB565,
81                 .colplanes      = 1,
82                 .flags          = FMT_FL_S3C24XX_PREVIEW |
83                                   FMT_FL_S3C64XX,
84         }, {
85                 .name           = "XRGB8888, 32 bpp",
86                 .fourcc         = V4L2_PIX_FMT_RGB32,
87                 .depth          = 32,
88                 .ybpp           = 4,
89                 .color          = IMG_FMT_XRGB8888,
90                 .colplanes      = 1,
91                 .flags          = FMT_FL_S3C24XX_PREVIEW |
92                                   FMT_FL_S3C64XX,
93         }, {
94                 .name           = "BGR666",
95                 .fourcc         = V4L2_PIX_FMT_BGR666,
96                 .depth          = 32,
97                 .ybpp           = 4,
98                 .color          = IMG_FMT_RGB666,
99                 .colplanes      = 1,
100                 .flags          = FMT_FL_S3C64XX,
101         }
102 };
103
104 /**
105  * s3c_camif_find_format() - lookup camif color format by fourcc or an index
106  * @pixelformat: fourcc to match, ignored if null
107  * @index: index to the camif_formats array, ignored if negative
108  */
109 const struct camif_fmt *s3c_camif_find_format(struct camif_vp *vp,
110                                               const u32 *pixelformat,
111                                               int index)
112 {
113         const struct camif_fmt *fmt, *def_fmt = NULL;
114         unsigned int i;
115         int id = 0;
116
117         if (index >= (int)ARRAY_SIZE(camif_formats))
118                 return NULL;
119
120         for (i = 0; i < ARRAY_SIZE(camif_formats); ++i) {
121                 fmt = &camif_formats[i];
122                 if (vp && !(vp->fmt_flags & fmt->flags))
123                         continue;
124                 if (pixelformat && fmt->fourcc == *pixelformat)
125                         return fmt;
126                 if (index == id)
127                         def_fmt = fmt;
128                 id++;
129         }
130         return def_fmt;
131 }
132
133 static int camif_get_scaler_factor(u32 src, u32 tar, u32 *ratio, u32 *shift)
134 {
135         unsigned int sh = 6;
136
137         if (src >= 64 * tar)
138                 return -EINVAL;
139
140         while (sh--) {
141                 unsigned int tmp = 1 << sh;
142                 if (src >= tar * tmp) {
143                         *shift = sh, *ratio = tmp;
144                         return 0;
145                 }
146         }
147         *shift = 0, *ratio = 1;
148         return 0;
149 }
150
151 int s3c_camif_get_scaler_config(struct camif_vp *vp,
152                                 struct camif_scaler *scaler)
153 {
154         struct v4l2_rect *camif_crop = &vp->camif->camif_crop;
155         int source_x = camif_crop->width;
156         int source_y = camif_crop->height;
157         int target_x = vp->out_frame.rect.width;
158         int target_y = vp->out_frame.rect.height;
159         int ret;
160
161         if (vp->rotation == 90 || vp->rotation == 270)
162                 swap(target_x, target_y);
163
164         ret = camif_get_scaler_factor(source_x, target_x, &scaler->pre_h_ratio,
165                                       &scaler->h_shift);
166         if (ret < 0)
167                 return ret;
168
169         ret = camif_get_scaler_factor(source_y, target_y, &scaler->pre_v_ratio,
170                                       &scaler->v_shift);
171         if (ret < 0)
172                 return ret;
173
174         scaler->pre_dst_width = source_x / scaler->pre_h_ratio;
175         scaler->pre_dst_height = source_y / scaler->pre_v_ratio;
176
177         scaler->main_h_ratio = (source_x << 8) / (target_x << scaler->h_shift);
178         scaler->main_v_ratio = (source_y << 8) / (target_y << scaler->v_shift);
179
180         scaler->scaleup_h = (target_x >= source_x);
181         scaler->scaleup_v = (target_y >= source_y);
182
183         scaler->copy = 0;
184
185         pr_debug("H: ratio: %u, shift: %u. V: ratio: %u, shift: %u.\n",
186                  scaler->pre_h_ratio, scaler->h_shift,
187                  scaler->pre_v_ratio, scaler->v_shift);
188
189         pr_debug("Source: %dx%d, Target: %dx%d, scaleup_h/v: %d/%d\n",
190                  source_x, source_y, target_x, target_y,
191                  scaler->scaleup_h, scaler->scaleup_v);
192
193         return 0;
194 }
195
196 static int camif_register_sensor(struct camif_dev *camif)
197 {
198         struct s3c_camif_sensor_info *sensor = &camif->pdata.sensor;
199         struct v4l2_device *v4l2_dev = &camif->v4l2_dev;
200         struct i2c_adapter *adapter;
201         struct v4l2_subdev_format format;
202         struct v4l2_subdev *sd;
203         int ret;
204
205         camif->sensor.sd = NULL;
206
207         if (sensor->i2c_board_info.addr == 0)
208                 return -EINVAL;
209
210         adapter = i2c_get_adapter(sensor->i2c_bus_num);
211         if (adapter == NULL) {
212                 v4l2_warn(v4l2_dev, "failed to get I2C adapter %d\n",
213                           sensor->i2c_bus_num);
214                 return -EPROBE_DEFER;
215         }
216
217         sd = v4l2_i2c_new_subdev_board(v4l2_dev, adapter,
218                                        &sensor->i2c_board_info, NULL);
219         if (sd == NULL) {
220                 i2c_put_adapter(adapter);
221                 v4l2_warn(v4l2_dev, "failed to acquire subdev %s\n",
222                           sensor->i2c_board_info.type);
223                 return -EPROBE_DEFER;
224         }
225         camif->sensor.sd = sd;
226
227         v4l2_info(v4l2_dev, "registered sensor subdevice %s\n", sd->name);
228
229         /* Get initial pixel format and set it at the camif sink pad */
230         format.pad = 0;
231         format.which = V4L2_SUBDEV_FORMAT_ACTIVE;
232         ret = v4l2_subdev_call(sd, pad, get_fmt, NULL, &format);
233
234         if (ret < 0)
235                 return 0;
236
237         format.pad = CAMIF_SD_PAD_SINK;
238         v4l2_subdev_call(&camif->subdev, pad, set_fmt, NULL, &format);
239
240         v4l2_info(sd, "Initial format from sensor: %dx%d, %#x\n",
241                   format.format.width, format.format.height,
242                   format.format.code);
243         return 0;
244 }
245
246 static void camif_unregister_sensor(struct camif_dev *camif)
247 {
248         struct v4l2_subdev *sd = camif->sensor.sd;
249         struct i2c_client *client = sd ? v4l2_get_subdevdata(sd) : NULL;
250         struct i2c_adapter *adapter;
251
252         if (client == NULL)
253                 return;
254
255         adapter = client->adapter;
256         v4l2_device_unregister_subdev(sd);
257         camif->sensor.sd = NULL;
258         i2c_unregister_device(client);
259         if (adapter)
260                 i2c_put_adapter(adapter);
261 }
262
263 static int camif_create_media_links(struct camif_dev *camif)
264 {
265         int i, ret;
266
267         ret = media_entity_create_link(&camif->sensor.sd->entity, 0,
268                                 &camif->subdev.entity, CAMIF_SD_PAD_SINK,
269                                 MEDIA_LNK_FL_IMMUTABLE |
270                                 MEDIA_LNK_FL_ENABLED);
271         if (ret)
272                 return ret;
273
274         for (i = 1; i < CAMIF_SD_PADS_NUM && !ret; i++) {
275                 ret = media_entity_create_link(&camif->subdev.entity, i,
276                                 &camif->vp[i - 1].vdev.entity, 0,
277                                 MEDIA_LNK_FL_IMMUTABLE |
278                                 MEDIA_LNK_FL_ENABLED);
279         }
280
281         return ret;
282 }
283
284 static int camif_register_video_nodes(struct camif_dev *camif)
285 {
286         int ret = s3c_camif_register_video_node(camif, VP_CODEC);
287         if (ret < 0)
288                 return ret;
289
290         return s3c_camif_register_video_node(camif, VP_PREVIEW);
291 }
292
293 static void camif_unregister_video_nodes(struct camif_dev *camif)
294 {
295         s3c_camif_unregister_video_node(camif, VP_CODEC);
296         s3c_camif_unregister_video_node(camif, VP_PREVIEW);
297 }
298
299 static void camif_unregister_media_entities(struct camif_dev *camif)
300 {
301         camif_unregister_video_nodes(camif);
302         camif_unregister_sensor(camif);
303         s3c_camif_unregister_subdev(camif);
304 }
305
306 /*
307  * Media device
308  */
309 static int camif_media_dev_register(struct camif_dev *camif)
310 {
311         struct media_device *md = &camif->media_dev;
312         struct v4l2_device *v4l2_dev = &camif->v4l2_dev;
313         unsigned int ip_rev = camif->variant->ip_revision;
314         int ret;
315
316         memset(md, 0, sizeof(*md));
317         snprintf(md->model, sizeof(md->model), "SAMSUNG S3C%s CAMIF",
318                  ip_rev == S3C6410_CAMIF_IP_REV ? "6410" : "244X");
319         strlcpy(md->bus_info, "platform", sizeof(md->bus_info));
320         md->hw_revision = ip_rev;
321         md->driver_version = KERNEL_VERSION(1, 0, 0);
322
323         md->dev = camif->dev;
324
325         strlcpy(v4l2_dev->name, "s3c-camif", sizeof(v4l2_dev->name));
326         v4l2_dev->mdev = md;
327
328         ret = v4l2_device_register(camif->dev, v4l2_dev);
329         if (ret < 0)
330                 return ret;
331
332         ret = media_device_register(md);
333         if (ret < 0)
334                 v4l2_device_unregister(v4l2_dev);
335
336         return ret;
337 }
338
339 static void camif_clk_put(struct camif_dev *camif)
340 {
341         int i;
342
343         for (i = 0; i < CLK_MAX_NUM; i++) {
344                 if (IS_ERR_OR_NULL(camif->clock[i]))
345                         continue;
346                 clk_unprepare(camif->clock[i]);
347                 clk_put(camif->clock[i]);
348         }
349 }
350
351 static int camif_clk_get(struct camif_dev *camif)
352 {
353         int ret, i;
354
355         for (i = 0; i < CLK_MAX_NUM; i++) {
356                 camif->clock[i] = clk_get(camif->dev, camif_clocks[i]);
357                 if (IS_ERR(camif->clock[i])) {
358                         ret = PTR_ERR(camif->clock[i]);
359                         goto err;
360                 }
361                 ret = clk_prepare(camif->clock[i]);
362                 if (ret < 0) {
363                         clk_put(camif->clock[i]);
364                         camif->clock[i] = NULL;
365                         goto err;
366                 }
367         }
368         return 0;
369 err:
370         camif_clk_put(camif);
371         dev_err(camif->dev, "failed to get clock: %s\n",
372                 camif_clocks[i]);
373         return ret;
374 }
375
376 /*
377  * The CAMIF device has two relatively independent data processing paths
378  * that can source data from memory or the common camera input frontend.
379  * Register interrupts for each data processing path (camif_vp).
380  */
381 static int camif_request_irqs(struct platform_device *pdev,
382                               struct camif_dev *camif)
383 {
384         int irq, ret, i;
385
386         for (i = 0; i < CAMIF_VP_NUM; i++) {
387                 struct camif_vp *vp = &camif->vp[i];
388
389                 init_waitqueue_head(&vp->irq_queue);
390
391                 irq = platform_get_irq(pdev, i);
392                 if (irq <= 0) {
393                         dev_err(&pdev->dev, "failed to get IRQ %d\n", i);
394                         return -ENXIO;
395                 }
396
397                 ret = devm_request_irq(&pdev->dev, irq, s3c_camif_irq_handler,
398                                        0, dev_name(&pdev->dev), vp);
399                 if (ret < 0) {
400                         dev_err(&pdev->dev, "failed to install IRQ: %d\n", ret);
401                         break;
402                 }
403         }
404
405         return ret;
406 }
407
408 static int s3c_camif_probe(struct platform_device *pdev)
409 {
410         struct device *dev = &pdev->dev;
411         struct s3c_camif_plat_data *pdata = dev->platform_data;
412         struct s3c_camif_drvdata *drvdata;
413         struct camif_dev *camif;
414         struct resource *mres;
415         int ret = 0;
416
417         camif = devm_kzalloc(dev, sizeof(*camif), GFP_KERNEL);
418         if (!camif)
419                 return -ENOMEM;
420
421         spin_lock_init(&camif->slock);
422         mutex_init(&camif->lock);
423
424         camif->dev = dev;
425
426         if (!pdata || !pdata->gpio_get || !pdata->gpio_put) {
427                 dev_err(dev, "wrong platform data\n");
428                 return -EINVAL;
429         }
430
431         camif->pdata = *pdata;
432         drvdata = (void *)platform_get_device_id(pdev)->driver_data;
433         camif->variant = drvdata->variant;
434
435         mres = platform_get_resource(pdev, IORESOURCE_MEM, 0);
436
437         camif->io_base = devm_ioremap_resource(dev, mres);
438         if (IS_ERR(camif->io_base))
439                 return PTR_ERR(camif->io_base);
440
441         ret = camif_request_irqs(pdev, camif);
442         if (ret < 0)
443                 return ret;
444
445         ret = pdata->gpio_get();
446         if (ret < 0)
447                 return ret;
448
449         ret = s3c_camif_create_subdev(camif);
450         if (ret < 0)
451                 goto err_sd;
452
453         ret = camif_clk_get(camif);
454         if (ret < 0)
455                 goto err_clk;
456
457         platform_set_drvdata(pdev, camif);
458         clk_set_rate(camif->clock[CLK_CAM],
459                         camif->pdata.sensor.clock_frequency);
460
461         dev_info(dev, "sensor clock frequency: %lu\n",
462                  clk_get_rate(camif->clock[CLK_CAM]));
463         /*
464          * Set initial pixel format, resolution and crop rectangle.
465          * Must be done before a sensor subdev is registered as some
466          * settings are overrode with values from sensor subdev.
467          */
468         s3c_camif_set_defaults(camif);
469
470         pm_runtime_enable(dev);
471
472         ret = pm_runtime_get_sync(dev);
473         if (ret < 0)
474                 goto err_pm;
475
476         /* Initialize contiguous memory allocator */
477         camif->alloc_ctx = vb2_dma_contig_init_ctx(dev);
478         if (IS_ERR(camif->alloc_ctx)) {
479                 ret = PTR_ERR(camif->alloc_ctx);
480                 goto err_alloc;
481         }
482
483         ret = camif_media_dev_register(camif);
484         if (ret < 0)
485                 goto err_mdev;
486
487         ret = camif_register_sensor(camif);
488         if (ret < 0)
489                 goto err_sens;
490
491         ret = v4l2_device_register_subdev(&camif->v4l2_dev, &camif->subdev);
492         if (ret < 0)
493                 goto err_sens;
494
495         mutex_lock(&camif->media_dev.graph_mutex);
496
497         ret = v4l2_device_register_subdev_nodes(&camif->v4l2_dev);
498         if (ret < 0)
499                 goto err_unlock;
500
501         ret = camif_register_video_nodes(camif);
502         if (ret < 0)
503                 goto err_unlock;
504
505         ret = camif_create_media_links(camif);
506         if (ret < 0)
507                 goto err_unlock;
508
509         mutex_unlock(&camif->media_dev.graph_mutex);
510         pm_runtime_put(dev);
511         return 0;
512
513 err_unlock:
514         mutex_unlock(&camif->media_dev.graph_mutex);
515 err_sens:
516         v4l2_device_unregister(&camif->v4l2_dev);
517         media_device_unregister(&camif->media_dev);
518         camif_unregister_media_entities(camif);
519 err_mdev:
520         vb2_dma_contig_cleanup_ctx(camif->alloc_ctx);
521 err_alloc:
522         pm_runtime_put(dev);
523         pm_runtime_disable(dev);
524 err_pm:
525         camif_clk_put(camif);
526 err_clk:
527         s3c_camif_unregister_subdev(camif);
528 err_sd:
529         pdata->gpio_put();
530         return ret;
531 }
532
533 static int s3c_camif_remove(struct platform_device *pdev)
534 {
535         struct camif_dev *camif = platform_get_drvdata(pdev);
536         struct s3c_camif_plat_data *pdata = &camif->pdata;
537
538         media_device_unregister(&camif->media_dev);
539         camif_unregister_media_entities(camif);
540         v4l2_device_unregister(&camif->v4l2_dev);
541
542         pm_runtime_disable(&pdev->dev);
543         camif_clk_put(camif);
544         pdata->gpio_put();
545
546         return 0;
547 }
548
549 static int s3c_camif_runtime_resume(struct device *dev)
550 {
551         struct camif_dev *camif = dev_get_drvdata(dev);
552
553         clk_enable(camif->clock[CLK_GATE]);
554         /* null op on s3c244x */
555         clk_enable(camif->clock[CLK_CAM]);
556         return 0;
557 }
558
559 static int s3c_camif_runtime_suspend(struct device *dev)
560 {
561         struct camif_dev *camif = dev_get_drvdata(dev);
562
563         /* null op on s3c244x */
564         clk_disable(camif->clock[CLK_CAM]);
565
566         clk_disable(camif->clock[CLK_GATE]);
567         return 0;
568 }
569
570 static const struct s3c_camif_variant s3c244x_camif_variant = {
571         .vp_pix_limits = {
572                 [VP_CODEC] = {
573                         .max_out_width          = 4096,
574                         .max_sc_out_width       = 2048,
575                         .out_width_align        = 16,
576                         .min_out_width          = 16,
577                         .max_height             = 4096,
578                 },
579                 [VP_PREVIEW] = {
580                         .max_out_width          = 640,
581                         .max_sc_out_width       = 640,
582                         .out_width_align        = 16,
583                         .min_out_width          = 16,
584                         .max_height             = 480,
585                 }
586         },
587         .pix_limits = {
588                 .win_hor_offset_align   = 8,
589         },
590         .ip_revision = S3C244X_CAMIF_IP_REV,
591 };
592
593 static struct s3c_camif_drvdata s3c244x_camif_drvdata = {
594         .variant        = &s3c244x_camif_variant,
595         .bus_clk_freq   = 24000000UL,
596 };
597
598 static const struct s3c_camif_variant s3c6410_camif_variant = {
599         .vp_pix_limits = {
600                 [VP_CODEC] = {
601                         .max_out_width          = 4096,
602                         .max_sc_out_width       = 2048,
603                         .out_width_align        = 16,
604                         .min_out_width          = 16,
605                         .max_height             = 4096,
606                 },
607                 [VP_PREVIEW] = {
608                         .max_out_width          = 4096,
609                         .max_sc_out_width       = 720,
610                         .out_width_align        = 16,
611                         .min_out_width          = 16,
612                         .max_height             = 4096,
613                 }
614         },
615         .pix_limits = {
616                 .win_hor_offset_align   = 8,
617         },
618         .ip_revision = S3C6410_CAMIF_IP_REV,
619         .has_img_effect = 1,
620         .vp_offset = 0x20,
621 };
622
623 static struct s3c_camif_drvdata s3c6410_camif_drvdata = {
624         .variant        = &s3c6410_camif_variant,
625         .bus_clk_freq   = 133000000UL,
626 };
627
628 static struct platform_device_id s3c_camif_driver_ids[] = {
629         {
630                 .name           = "s3c2440-camif",
631                 .driver_data    = (unsigned long)&s3c244x_camif_drvdata,
632         }, {
633                 .name           = "s3c6410-camif",
634                 .driver_data    = (unsigned long)&s3c6410_camif_drvdata,
635         },
636         { /* sentinel */ },
637 };
638 MODULE_DEVICE_TABLE(platform, s3c_camif_driver_ids);
639
640 static const struct dev_pm_ops s3c_camif_pm_ops = {
641         .runtime_suspend        = s3c_camif_runtime_suspend,
642         .runtime_resume         = s3c_camif_runtime_resume,
643 };
644
645 static struct platform_driver s3c_camif_driver = {
646         .probe          = s3c_camif_probe,
647         .remove         = s3c_camif_remove,
648         .id_table       = s3c_camif_driver_ids,
649         .driver = {
650                 .name   = S3C_CAMIF_DRIVER_NAME,
651                 .owner  = THIS_MODULE,
652                 .pm     = &s3c_camif_pm_ops,
653         }
654 };
655
656 module_platform_driver(s3c_camif_driver);
657
658 MODULE_AUTHOR("Sylwester Nawrocki <sylvester.nawrocki@gmail.com>");
659 MODULE_AUTHOR("Tomasz Figa <tomasz.figa@gmail.com>");
660 MODULE_DESCRIPTION("S3C24XX/S3C64XX SoC camera interface driver");
661 MODULE_LICENSE("GPL");