GNU Linux-libre 4.14.332-gnu1
[releases.git] / drivers / media / platform / vimc / vimc-common.c
1 /*
2  * vimc-common.c Virtual Media Controller Driver
3  *
4  * Copyright (C) 2015-2017 Helen Koike <helen.fornazier@gmail.com>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  */
17
18 #include <linux/init.h>
19 #include <linux/module.h>
20
21 #include "vimc-common.h"
22
23 /*
24  * NOTE: non-bayer formats need to come first (necessary for enum_mbus_code
25  * in the scaler)
26  */
27 static const struct vimc_pix_map vimc_pix_map_list[] = {
28         /* TODO: add all missing formats */
29
30         /* RGB formats */
31         {
32                 .code = MEDIA_BUS_FMT_BGR888_1X24,
33                 .pixelformat = V4L2_PIX_FMT_BGR24,
34                 .bpp = 3,
35                 .bayer = false,
36         },
37         {
38                 .code = MEDIA_BUS_FMT_RGB888_1X24,
39                 .pixelformat = V4L2_PIX_FMT_RGB24,
40                 .bpp = 3,
41                 .bayer = false,
42         },
43         {
44                 .code = MEDIA_BUS_FMT_ARGB8888_1X32,
45                 .pixelformat = V4L2_PIX_FMT_ARGB32,
46                 .bpp = 4,
47                 .bayer = false,
48         },
49
50         /* Bayer formats */
51         {
52                 .code = MEDIA_BUS_FMT_SBGGR8_1X8,
53                 .pixelformat = V4L2_PIX_FMT_SBGGR8,
54                 .bpp = 1,
55                 .bayer = true,
56         },
57         {
58                 .code = MEDIA_BUS_FMT_SGBRG8_1X8,
59                 .pixelformat = V4L2_PIX_FMT_SGBRG8,
60                 .bpp = 1,
61                 .bayer = true,
62         },
63         {
64                 .code = MEDIA_BUS_FMT_SGRBG8_1X8,
65                 .pixelformat = V4L2_PIX_FMT_SGRBG8,
66                 .bpp = 1,
67                 .bayer = true,
68         },
69         {
70                 .code = MEDIA_BUS_FMT_SRGGB8_1X8,
71                 .pixelformat = V4L2_PIX_FMT_SRGGB8,
72                 .bpp = 1,
73                 .bayer = true,
74         },
75         {
76                 .code = MEDIA_BUS_FMT_SBGGR10_1X10,
77                 .pixelformat = V4L2_PIX_FMT_SBGGR10,
78                 .bpp = 2,
79                 .bayer = true,
80         },
81         {
82                 .code = MEDIA_BUS_FMT_SGBRG10_1X10,
83                 .pixelformat = V4L2_PIX_FMT_SGBRG10,
84                 .bpp = 2,
85                 .bayer = true,
86         },
87         {
88                 .code = MEDIA_BUS_FMT_SGRBG10_1X10,
89                 .pixelformat = V4L2_PIX_FMT_SGRBG10,
90                 .bpp = 2,
91                 .bayer = true,
92         },
93         {
94                 .code = MEDIA_BUS_FMT_SRGGB10_1X10,
95                 .pixelformat = V4L2_PIX_FMT_SRGGB10,
96                 .bpp = 2,
97                 .bayer = true,
98         },
99
100         /* 10bit raw bayer a-law compressed to 8 bits */
101         {
102                 .code = MEDIA_BUS_FMT_SBGGR10_ALAW8_1X8,
103                 .pixelformat = V4L2_PIX_FMT_SBGGR10ALAW8,
104                 .bpp = 1,
105                 .bayer = true,
106         },
107         {
108                 .code = MEDIA_BUS_FMT_SGBRG10_ALAW8_1X8,
109                 .pixelformat = V4L2_PIX_FMT_SGBRG10ALAW8,
110                 .bpp = 1,
111                 .bayer = true,
112         },
113         {
114                 .code = MEDIA_BUS_FMT_SGRBG10_ALAW8_1X8,
115                 .pixelformat = V4L2_PIX_FMT_SGRBG10ALAW8,
116                 .bpp = 1,
117                 .bayer = true,
118         },
119         {
120                 .code = MEDIA_BUS_FMT_SRGGB10_ALAW8_1X8,
121                 .pixelformat = V4L2_PIX_FMT_SRGGB10ALAW8,
122                 .bpp = 1,
123                 .bayer = true,
124         },
125
126         /* 10bit raw bayer DPCM compressed to 8 bits */
127         {
128                 .code = MEDIA_BUS_FMT_SBGGR10_DPCM8_1X8,
129                 .pixelformat = V4L2_PIX_FMT_SBGGR10DPCM8,
130                 .bpp = 1,
131                 .bayer = true,
132         },
133         {
134                 .code = MEDIA_BUS_FMT_SGBRG10_DPCM8_1X8,
135                 .pixelformat = V4L2_PIX_FMT_SGBRG10DPCM8,
136                 .bpp = 1,
137                 .bayer = true,
138         },
139         {
140                 .code = MEDIA_BUS_FMT_SGRBG10_DPCM8_1X8,
141                 .pixelformat = V4L2_PIX_FMT_SGRBG10DPCM8,
142                 .bpp = 1,
143                 .bayer = true,
144         },
145         {
146                 .code = MEDIA_BUS_FMT_SRGGB10_DPCM8_1X8,
147                 .pixelformat = V4L2_PIX_FMT_SRGGB10DPCM8,
148                 .bpp = 1,
149                 .bayer = true,
150         },
151         {
152                 .code = MEDIA_BUS_FMT_SBGGR12_1X12,
153                 .pixelformat = V4L2_PIX_FMT_SBGGR12,
154                 .bpp = 2,
155                 .bayer = true,
156         },
157         {
158                 .code = MEDIA_BUS_FMT_SGBRG12_1X12,
159                 .pixelformat = V4L2_PIX_FMT_SGBRG12,
160                 .bpp = 2,
161                 .bayer = true,
162         },
163         {
164                 .code = MEDIA_BUS_FMT_SGRBG12_1X12,
165                 .pixelformat = V4L2_PIX_FMT_SGRBG12,
166                 .bpp = 2,
167                 .bayer = true,
168         },
169         {
170                 .code = MEDIA_BUS_FMT_SRGGB12_1X12,
171                 .pixelformat = V4L2_PIX_FMT_SRGGB12,
172                 .bpp = 2,
173                 .bayer = true,
174         },
175 };
176
177 const struct vimc_pix_map *vimc_pix_map_by_index(unsigned int i)
178 {
179         if (i >= ARRAY_SIZE(vimc_pix_map_list))
180                 return NULL;
181
182         return &vimc_pix_map_list[i];
183 }
184 EXPORT_SYMBOL_GPL(vimc_pix_map_by_index);
185
186 const struct vimc_pix_map *vimc_pix_map_by_code(u32 code)
187 {
188         unsigned int i;
189
190         for (i = 0; i < ARRAY_SIZE(vimc_pix_map_list); i++) {
191                 if (vimc_pix_map_list[i].code == code)
192                         return &vimc_pix_map_list[i];
193         }
194         return NULL;
195 }
196 EXPORT_SYMBOL_GPL(vimc_pix_map_by_code);
197
198 const struct vimc_pix_map *vimc_pix_map_by_pixelformat(u32 pixelformat)
199 {
200         unsigned int i;
201
202         for (i = 0; i < ARRAY_SIZE(vimc_pix_map_list); i++) {
203                 if (vimc_pix_map_list[i].pixelformat == pixelformat)
204                         return &vimc_pix_map_list[i];
205         }
206         return NULL;
207 }
208 EXPORT_SYMBOL_GPL(vimc_pix_map_by_pixelformat);
209
210 /* Helper function to allocate and initialize pads */
211 struct media_pad *vimc_pads_init(u16 num_pads, const unsigned long *pads_flag)
212 {
213         struct media_pad *pads;
214         unsigned int i;
215
216         /* Allocate memory for the pads */
217         pads = kcalloc(num_pads, sizeof(*pads), GFP_KERNEL);
218         if (!pads)
219                 return ERR_PTR(-ENOMEM);
220
221         /* Initialize the pads */
222         for (i = 0; i < num_pads; i++) {
223                 pads[i].index = i;
224                 pads[i].flags = pads_flag[i];
225         }
226
227         return pads;
228 }
229 EXPORT_SYMBOL_GPL(vimc_pads_init);
230
231 int vimc_pipeline_s_stream(struct media_entity *ent, int enable)
232 {
233         struct v4l2_subdev *sd;
234         struct media_pad *pad;
235         unsigned int i;
236         int ret;
237
238         for (i = 0; i < ent->num_pads; i++) {
239                 if (ent->pads[i].flags & MEDIA_PAD_FL_SOURCE)
240                         continue;
241
242                 /* Start the stream in the subdevice direct connected */
243                 pad = media_entity_remote_pad(&ent->pads[i]);
244                 if (!pad)
245                         continue;
246
247                 if (!is_media_entity_v4l2_subdev(pad->entity))
248                         return -EINVAL;
249
250                 sd = media_entity_to_v4l2_subdev(pad->entity);
251                 ret = v4l2_subdev_call(sd, video, s_stream, enable);
252                 if (ret && ret != -ENOIOCTLCMD)
253                         return ret;
254         }
255
256         return 0;
257 }
258 EXPORT_SYMBOL_GPL(vimc_pipeline_s_stream);
259
260 static int vimc_get_mbus_format(struct media_pad *pad,
261                                 struct v4l2_subdev_format *fmt)
262 {
263         if (is_media_entity_v4l2_subdev(pad->entity)) {
264                 struct v4l2_subdev *sd =
265                         media_entity_to_v4l2_subdev(pad->entity);
266                 int ret;
267
268                 fmt->which = V4L2_SUBDEV_FORMAT_ACTIVE;
269                 fmt->pad = pad->index;
270
271                 ret = v4l2_subdev_call(sd, pad, get_fmt, NULL, fmt);
272                 if (ret)
273                         return ret;
274
275         } else if (is_media_entity_v4l2_video_device(pad->entity)) {
276                 struct video_device *vdev = container_of(pad->entity,
277                                                          struct video_device,
278                                                          entity);
279                 struct vimc_ent_device *ved = video_get_drvdata(vdev);
280                 const struct vimc_pix_map *vpix;
281                 struct v4l2_pix_format vdev_fmt;
282
283                 if (!ved->vdev_get_format)
284                         return -ENOIOCTLCMD;
285
286                 ved->vdev_get_format(ved, &vdev_fmt);
287                 vpix = vimc_pix_map_by_pixelformat(vdev_fmt.pixelformat);
288                 v4l2_fill_mbus_format(&fmt->format, &vdev_fmt, vpix->code);
289         } else {
290                 return -EINVAL;
291         }
292
293         return 0;
294 }
295
296 int vimc_link_validate(struct media_link *link)
297 {
298         struct v4l2_subdev_format source_fmt, sink_fmt;
299         int ret;
300
301         ret = vimc_get_mbus_format(link->source, &source_fmt);
302         if (ret)
303                 return ret;
304
305         ret = vimc_get_mbus_format(link->sink, &sink_fmt);
306         if (ret)
307                 return ret;
308
309         pr_info("vimc link validate: "
310                 "%s:src:%dx%d (0x%x, %d, %d, %d, %d) "
311                 "%s:snk:%dx%d (0x%x, %d, %d, %d, %d)\n",
312                 /* src */
313                 link->source->entity->name,
314                 source_fmt.format.width, source_fmt.format.height,
315                 source_fmt.format.code, source_fmt.format.colorspace,
316                 source_fmt.format.quantization, source_fmt.format.xfer_func,
317                 source_fmt.format.ycbcr_enc,
318                 /* sink */
319                 link->sink->entity->name,
320                 sink_fmt.format.width, sink_fmt.format.height,
321                 sink_fmt.format.code, sink_fmt.format.colorspace,
322                 sink_fmt.format.quantization, sink_fmt.format.xfer_func,
323                 sink_fmt.format.ycbcr_enc);
324
325         /* The width, height and code must match. */
326         if (source_fmt.format.width != sink_fmt.format.width
327             || source_fmt.format.height != sink_fmt.format.height
328             || source_fmt.format.code != sink_fmt.format.code)
329                 return -EPIPE;
330
331         /*
332          * The field order must match, or the sink field order must be NONE
333          * to support interlaced hardware connected to bridges that support
334          * progressive formats only.
335          */
336         if (source_fmt.format.field != sink_fmt.format.field &&
337             sink_fmt.format.field != V4L2_FIELD_NONE)
338                 return -EPIPE;
339
340         /*
341          * If colorspace is DEFAULT, then assume all the colorimetry is also
342          * DEFAULT, return 0 to skip comparing the other colorimetry parameters
343          */
344         if (source_fmt.format.colorspace == V4L2_COLORSPACE_DEFAULT
345             || sink_fmt.format.colorspace == V4L2_COLORSPACE_DEFAULT)
346                 return 0;
347
348         /* Colorspace must match. */
349         if (source_fmt.format.colorspace != sink_fmt.format.colorspace)
350                 return -EPIPE;
351
352         /* Colorimetry must match if they are not set to DEFAULT */
353         if (source_fmt.format.ycbcr_enc != V4L2_YCBCR_ENC_DEFAULT
354             && sink_fmt.format.ycbcr_enc != V4L2_YCBCR_ENC_DEFAULT
355             && source_fmt.format.ycbcr_enc != sink_fmt.format.ycbcr_enc)
356                 return -EPIPE;
357
358         if (source_fmt.format.quantization != V4L2_QUANTIZATION_DEFAULT
359             && sink_fmt.format.quantization != V4L2_QUANTIZATION_DEFAULT
360             && source_fmt.format.quantization != sink_fmt.format.quantization)
361                 return -EPIPE;
362
363         if (source_fmt.format.xfer_func != V4L2_XFER_FUNC_DEFAULT
364             && sink_fmt.format.xfer_func != V4L2_XFER_FUNC_DEFAULT
365             && source_fmt.format.xfer_func != sink_fmt.format.xfer_func)
366                 return -EPIPE;
367
368         return 0;
369 }
370 EXPORT_SYMBOL_GPL(vimc_link_validate);
371
372 static const struct media_entity_operations vimc_ent_sd_mops = {
373         .link_validate = vimc_link_validate,
374 };
375
376 int vimc_ent_sd_register(struct vimc_ent_device *ved,
377                          struct v4l2_subdev *sd,
378                          struct v4l2_device *v4l2_dev,
379                          const char *const name,
380                          u32 function,
381                          u16 num_pads,
382                          const unsigned long *pads_flag,
383                          const struct v4l2_subdev_ops *sd_ops)
384 {
385         int ret;
386
387         /* Allocate the pads */
388         ved->pads = vimc_pads_init(num_pads, pads_flag);
389         if (IS_ERR(ved->pads))
390                 return PTR_ERR(ved->pads);
391
392         /* Fill the vimc_ent_device struct */
393         ved->ent = &sd->entity;
394
395         /* Initialize the subdev */
396         v4l2_subdev_init(sd, sd_ops);
397         sd->entity.function = function;
398         sd->entity.ops = &vimc_ent_sd_mops;
399         sd->owner = THIS_MODULE;
400         strlcpy(sd->name, name, sizeof(sd->name));
401         v4l2_set_subdevdata(sd, ved);
402
403         /* Expose this subdev to user space */
404         sd->flags = V4L2_SUBDEV_FL_HAS_DEVNODE;
405
406         /* Initialize the media entity */
407         ret = media_entity_pads_init(&sd->entity, num_pads, ved->pads);
408         if (ret)
409                 goto err_clean_pads;
410
411         /* Register the subdev with the v4l2 and the media framework */
412         ret = v4l2_device_register_subdev(v4l2_dev, sd);
413         if (ret) {
414                 dev_err(v4l2_dev->dev,
415                         "%s: subdev register failed (err=%d)\n",
416                         name, ret);
417                 goto err_clean_m_ent;
418         }
419
420         return 0;
421
422 err_clean_m_ent:
423         media_entity_cleanup(&sd->entity);
424 err_clean_pads:
425         vimc_pads_cleanup(ved->pads);
426         return ret;
427 }
428 EXPORT_SYMBOL_GPL(vimc_ent_sd_register);
429
430 void vimc_ent_sd_unregister(struct vimc_ent_device *ved, struct v4l2_subdev *sd)
431 {
432         v4l2_device_unregister_subdev(sd);
433         media_entity_cleanup(ved->ent);
434         vimc_pads_cleanup(ved->pads);
435 }
436 EXPORT_SYMBOL_GPL(vimc_ent_sd_unregister);
437
438 MODULE_DESCRIPTION("Virtual Media Controller Driver (VIMC) Common");
439 MODULE_AUTHOR("Helen Koike <helen.fornazier@gmail.com>");
440 MODULE_LICENSE("GPL");