Print more detailed v4l parse error messages
[media-ctl.git] / src / v4l2subdev.c
1 /*
2  * V4L2 subdev interface library
3  *
4  * Copyright (C) 2010-2011 Ideas on board SPRL
5  *
6  * Contact: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License as published
10  * by the Free Software Foundation; either version 2.1 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program. If not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #include <sys/ioctl.h>
23 #include <sys/stat.h>
24 #include <sys/types.h>
25
26 #include <ctype.h>
27 #include <errno.h>
28 #include <fcntl.h>
29 #include <stdbool.h>
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33 #include <unistd.h>
34
35 #include <linux/v4l2-subdev.h>
36
37 #include "mediactl.h"
38 #include "tools.h"
39 #include "v4l2subdev.h"
40
41 int v4l2_subdev_open(struct media_entity *entity)
42 {
43         if (entity->fd != -1)
44                 return 0;
45
46         entity->fd = open(entity->devname, O_RDWR);
47         if (entity->fd == -1) {
48                 media_dbg(entity->media,
49                           "%s: Failed to open subdev device node %s\n", __func__,
50                           entity->devname);
51                 return -errno;
52         }
53
54         return 0;
55 }
56
57 void v4l2_subdev_close(struct media_entity *entity)
58 {
59         close(entity->fd);
60         entity->fd = -1;
61 }
62
63 int v4l2_subdev_get_format(struct media_entity *entity,
64         struct v4l2_mbus_framefmt *format, unsigned int pad,
65         enum v4l2_subdev_format_whence which)
66 {
67         struct v4l2_subdev_format fmt;
68         int ret;
69
70         ret = v4l2_subdev_open(entity);
71         if (ret < 0)
72                 return ret;
73
74         memset(&fmt, 0, sizeof(fmt));
75         fmt.pad = pad;
76         fmt.which = which;
77
78         ret = ioctl(entity->fd, VIDIOC_SUBDEV_G_FMT, &fmt);
79         if (ret < 0)
80                 return -errno;
81
82         *format = fmt.format;
83         return 0;
84 }
85
86 int v4l2_subdev_set_format(struct media_entity *entity,
87         struct v4l2_mbus_framefmt *format, unsigned int pad,
88         enum v4l2_subdev_format_whence which)
89 {
90         struct v4l2_subdev_format fmt;
91         int ret;
92
93         ret = v4l2_subdev_open(entity);
94         if (ret < 0)
95                 return ret;
96
97         memset(&fmt, 0, sizeof(fmt));
98         fmt.pad = pad;
99         fmt.which = which;
100         fmt.format = *format;
101
102         ret = ioctl(entity->fd, VIDIOC_SUBDEV_S_FMT, &fmt);
103         if (ret < 0)
104                 return -errno;
105
106         *format = fmt.format;
107         return 0;
108 }
109
110 int v4l2_subdev_get_selection(struct media_entity *entity,
111         struct v4l2_rect *rect, unsigned int pad, unsigned int target,
112         enum v4l2_subdev_format_whence which)
113 {
114         union {
115                 struct v4l2_subdev_selection sel;
116                 struct v4l2_subdev_crop crop;
117         } u;
118         int ret;
119
120         ret = v4l2_subdev_open(entity);
121         if (ret < 0)
122                 return ret;
123
124         memset(&u.sel, 0, sizeof(u.sel));
125         u.sel.pad = pad;
126         u.sel.target = target;
127         u.sel.which = which;
128
129         ret = ioctl(entity->fd, VIDIOC_SUBDEV_G_SELECTION, &u.sel);
130         if (ret >= 0) {
131                 *rect = u.sel.r;
132                 return 0;
133         }
134         if (errno != ENOTTY || target != V4L2_SEL_TGT_CROP)
135                 return -errno;
136
137         memset(&u.crop, 0, sizeof(u.crop));
138         u.crop.pad = pad;
139         u.crop.which = which;
140
141         ret = ioctl(entity->fd, VIDIOC_SUBDEV_G_CROP, &u.crop);
142         if (ret < 0)
143                 return -errno;
144
145         *rect = u.crop.rect;
146         return 0;
147 }
148
149 int v4l2_subdev_set_selection(struct media_entity *entity,
150         struct v4l2_rect *rect, unsigned int pad, unsigned int target,
151         enum v4l2_subdev_format_whence which)
152 {
153         union {
154                 struct v4l2_subdev_selection sel;
155                 struct v4l2_subdev_crop crop;
156         } u;
157         int ret;
158
159         ret = v4l2_subdev_open(entity);
160         if (ret < 0)
161                 return ret;
162
163         memset(&u.sel, 0, sizeof(u.sel));
164         u.sel.pad = pad;
165         u.sel.target = target;
166         u.sel.which = which;
167         u.sel.r = *rect;
168
169         ret = ioctl(entity->fd, VIDIOC_SUBDEV_S_SELECTION, &u.sel);
170         if (ret >= 0) {
171                 *rect = u.sel.r;
172                 return 0;
173         }
174         if (errno != ENOTTY || target != V4L2_SEL_TGT_CROP)
175                 return -errno;
176
177         memset(&u.crop, 0, sizeof(u.crop));
178         u.crop.pad = pad;
179         u.crop.which = which;
180         u.crop.rect = *rect;
181
182         ret = ioctl(entity->fd, VIDIOC_SUBDEV_S_CROP, &u.crop);
183         if (ret < 0)
184                 return -errno;
185
186         *rect = u.crop.rect;
187         return 0;
188 }
189
190 int v4l2_subdev_get_frame_interval(struct media_entity *entity,
191                                    struct v4l2_fract *interval)
192 {
193         struct v4l2_subdev_frame_interval ival;
194         int ret;
195
196         ret = v4l2_subdev_open(entity);
197         if (ret < 0)
198                 return ret;
199
200         memset(&ival, 0, sizeof(ival));
201
202         ret = ioctl(entity->fd, VIDIOC_SUBDEV_G_FRAME_INTERVAL, &ival);
203         if (ret < 0)
204                 return -errno;
205
206         *interval = ival.interval;
207         return 0;
208 }
209
210 int v4l2_subdev_set_frame_interval(struct media_entity *entity,
211                                    struct v4l2_fract *interval)
212 {
213         struct v4l2_subdev_frame_interval ival;
214         int ret;
215
216         ret = v4l2_subdev_open(entity);
217         if (ret < 0)
218                 return ret;
219
220         memset(&ival, 0, sizeof(ival));
221         ival.interval = *interval;
222
223         ret = ioctl(entity->fd, VIDIOC_SUBDEV_S_FRAME_INTERVAL, &ival);
224         if (ret < 0)
225                 return -errno;
226
227         *interval = ival.interval;
228         return 0;
229 }
230
231 static int v4l2_subdev_parse_format(struct media_device *media,
232                                     struct v4l2_mbus_framefmt *format,
233                                     const char *p, char **endp)
234 {
235         enum v4l2_mbus_pixelcode code;
236         unsigned int width, height;
237         char *end;
238
239         /*
240          * Compatibility with the old syntax: consider space as valid
241          * separator between the media bus pixel code and the size.
242          */
243         for (; isspace(*p); ++p);
244         for (end = (char *)p;
245              *end != '/' && *end != ' ' && *end != '\0'; ++end);
246
247         code = v4l2_subdev_string_to_pixelcode(p, end - p);
248         if (code == (enum v4l2_mbus_pixelcode)-1) {
249                 media_dbg(media, "Invalid pixel code '%.*s'\n", end - p, p);
250                 return -EINVAL;
251         }
252
253         p = end + 1;
254         width = strtoul(p, &end, 10);
255         if (*end != 'x') {
256                 media_dbg(media, "Expected 'x'\n");
257                 return -EINVAL;
258         }
259
260         p = end + 1;
261         height = strtoul(p, &end, 10);
262         *endp = end;
263
264         memset(format, 0, sizeof(*format));
265         format->width = width;
266         format->height = height;
267         format->code = code;
268
269         return 0;
270 }
271
272 static int v4l2_subdev_parse_rectangle(struct media_device *media,
273                                        struct v4l2_rect *r, const char *p,
274                                        char **endp)
275 {
276         char *end;
277
278         if (*p++ != '(') {
279                 media_dbg(media, "Expected '('\n");
280                 return -EINVAL;
281         }
282
283         r->left = strtoul(p, &end, 10);
284         if (*end != ',') {
285                 media_dbg(media, "Expected ','\n");
286                 return -EINVAL;
287         }
288
289         p = end + 1;
290         r->top = strtoul(p, &end, 10);
291         if (*end++ != ')') {
292                 media_dbg(media, "Expected ')'\n");
293                 return -EINVAL;
294         }
295         if (*end != '/') {
296                 media_dbg(media, "Expected '/'\n");
297                 return -EINVAL;
298         }
299
300         p = end + 1;
301         r->width = strtoul(p, &end, 10);
302         if (*end != 'x') {
303                 media_dbg(media, "Expected 'x'\n");
304                 return -EINVAL;
305         }
306
307         p = end + 1;
308         r->height = strtoul(p, &end, 10);
309         *endp = end;
310
311         return 0;
312 }
313
314 static int v4l2_subdev_parse_frame_interval(struct media_device *media,
315                                             struct v4l2_fract *interval,
316                                             const char *p, char **endp)
317 {
318         char *end;
319
320         for (; isspace(*p); ++p);
321
322         interval->numerator = strtoul(p, &end, 10);
323
324         for (p = end; isspace(*p); ++p);
325         if (*p++ != '/') {
326                 media_dbg(media, "Expected '/'\n");
327                 return -EINVAL;
328         }
329
330         for (; isspace(*p); ++p);
331         interval->denominator = strtoul(p, &end, 10);
332
333         *endp = end;
334         return 0;
335 }
336
337 /*
338  * The debate over whether this function should be named icanhasstr() instead
339  * has been strong and heated. If you feel like this would be an important
340  * change, patches are welcome (or not).
341  */
342 static bool strhazit(const char *str, const char **p)
343 {
344         int len = strlen(str);
345
346         if (strncmp(str, *p, len))
347                 return false;
348
349         for (*p += len; isspace(**p); ++*p);
350         return true;
351 }
352
353 static struct media_pad *v4l2_subdev_parse_pad_format(
354         struct media_device *media, struct v4l2_mbus_framefmt *format,
355         struct v4l2_rect *crop, struct v4l2_rect *compose,
356         struct v4l2_fract *interval, const char *p, char **endp)
357 {
358         struct media_pad *pad;
359         bool first;
360         char *end;
361         int ret;
362
363         for (; isspace(*p); ++p);
364
365         pad = media_parse_pad(media, p, &end);
366         if (pad == NULL)
367                 return NULL;
368
369         for (p = end; isspace(*p); ++p);
370         if (*p++ != '[') {
371                 media_dbg(media, "Expected '['\n");
372                 return NULL;
373         }
374
375         for (first = true; ; first = false) {
376                 for (; isspace(*p); p++);
377
378                 /*
379                  * Backward compatibility: if the first property starts with an
380                  * uppercase later, process it as a format description.
381                  */
382                 if (strhazit("fmt:", &p) || (first && isupper(*p))) {
383                         ret = v4l2_subdev_parse_format(format, p, &end);
384                         if (ret < 0)
385                                 return NULL;
386
387                         p = end;
388                         continue;
389                 }
390
391                 /*
392                  * Backward compatibility: crop rectangles can be specified
393                  * implicitly without the 'crop:' property name.
394                  */
395                 if (strhazit("crop:", &p) || *p == '(') {
396                         ret = v4l2_subdev_parse_rectangle(crop, p, &end);
397                         if (ret < 0)
398                                 return NULL;
399
400                         p = end;
401                         continue;
402                 }
403
404                 if (strhazit("compose:", &p)) {
405                         ret = v4l2_subdev_parse_rectangle(compose, p, &end);
406                         if (ret < 0)
407                                 return NULL;
408
409                         for (p = end; isspace(*p); p++);
410                         continue;
411                 }
412
413                 if (*p == '@') {
414                         ret = v4l2_subdev_parse_frame_interval(interval, ++p, &end);
415                         if (ret < 0)
416                                 return NULL;
417
418                         p = end;
419                         continue;
420                 }
421
422                 break;
423         }
424
425         if (*p != ']') {
426                 media_dbg(media, "Expected ']'\n");
427                 return NULL;
428         }
429
430         *endp = (char *)p + 1;
431         return pad;
432 }
433
434 static int set_format(struct media_pad *pad,
435                       struct v4l2_mbus_framefmt *format)
436 {
437         int ret;
438
439         if (format->width == 0 || format->height == 0)
440                 return 0;
441
442         media_dbg(pad->entity->media,
443                   "Setting up format %s %ux%u on pad %s/%u\n",
444                   v4l2_subdev_pixelcode_to_string(format->code),
445                   format->width, format->height,
446                   pad->entity->info.name, pad->index);
447
448         ret = v4l2_subdev_set_format(pad->entity, format, pad->index,
449                                      V4L2_SUBDEV_FORMAT_ACTIVE);
450         if (ret < 0) {
451                 media_dbg(pad->entity->media,
452                           "Unable to set format: %s (%d)\n",
453                           strerror(-ret), ret);
454                 return ret;
455         }
456
457         media_dbg(pad->entity->media,
458                   "Format set: %s %ux%u\n",
459                   v4l2_subdev_pixelcode_to_string(format->code),
460                   format->width, format->height);
461
462         return 0;
463 }
464
465 static int set_selection(struct media_pad *pad, unsigned int target,
466                          struct v4l2_rect *rect)
467 {
468         int ret;
469
470         if (rect->left == -1 || rect->top == -1)
471                 return 0;
472
473         media_dbg(pad->entity->media,
474                   "Setting up selection target %u rectangle (%u,%u)/%ux%u on pad %s/%u\n",
475                   target, rect->left, rect->top, rect->width, rect->height,
476                   pad->entity->info.name, pad->index);
477
478         ret = v4l2_subdev_set_selection(pad->entity, rect, pad->index,
479                                         target, V4L2_SUBDEV_FORMAT_ACTIVE);
480         if (ret < 0) {
481                 media_dbg(pad->entity->media,
482                           "Unable to set selection rectangle: %s (%d)\n",
483                           strerror(-ret), ret);
484                 return ret;
485         }
486
487         media_dbg(pad->entity->media,
488                   "Selection rectangle set: (%u,%u)/%ux%u\n",
489                   rect->left, rect->top, rect->width, rect->height);
490
491         return 0;
492 }
493
494 static int set_frame_interval(struct media_entity *entity,
495                               struct v4l2_fract *interval)
496 {
497         int ret;
498
499         if (interval->numerator == 0)
500                 return 0;
501
502         media_dbg(entity->media,
503                   "Setting up frame interval %u/%u on entity %s\n",
504                   interval->numerator, interval->denominator,
505                   entity->info.name);
506
507         ret = v4l2_subdev_set_frame_interval(entity, interval);
508         if (ret < 0) {
509                 media_dbg(entity->media,
510                           "Unable to set frame interval: %s (%d)",
511                           strerror(-ret), ret);
512                 return ret;
513         }
514
515         media_dbg(entity->media, "Frame interval set: %u/%u\n",
516                   interval->numerator, interval->denominator);
517
518         return 0;
519 }
520
521
522 static int v4l2_subdev_parse_setup_format(struct media_device *media,
523                                           const char *p, char **endp)
524 {
525         struct v4l2_mbus_framefmt format = { 0, 0, 0 };
526         struct media_pad *pad;
527         struct v4l2_rect crop = { -1, -1, -1, -1 };
528         struct v4l2_rect compose = crop;
529         struct v4l2_fract interval = { 0, 0 };
530         unsigned int i;
531         char *end;
532         int ret;
533
534         pad = v4l2_subdev_parse_pad_format(media, &format, &crop, &compose,
535                                            &interval, p, &end);
536         if (pad == NULL) {
537                 media_dbg(media, "Unable to parse format\n");
538                 return -EINVAL;
539         }
540
541         if (pad->flags & MEDIA_PAD_FL_SINK) {
542                 ret = set_format(pad, &format);
543                 if (ret < 0)
544                         return ret;
545         }
546
547         ret = set_selection(pad, V4L2_SEL_TGT_CROP, &crop);
548         if (ret < 0)
549                 return ret;
550
551         ret = set_selection(pad, V4L2_SEL_TGT_COMPOSE, &compose);
552         if (ret < 0)
553                 return ret;
554
555         if (pad->flags & MEDIA_PAD_FL_SOURCE) {
556                 ret = set_format(pad, &format);
557                 if (ret < 0)
558                         return ret;
559         }
560
561         ret = set_frame_interval(pad->entity, &interval);
562         if (ret < 0)
563                 return ret;
564
565
566         /* If the pad is an output pad, automatically set the same format on
567          * the remote subdev input pads, if any.
568          */
569         if (pad->flags & MEDIA_PAD_FL_SOURCE) {
570                 for (i = 0; i < pad->entity->num_links; ++i) {
571                         struct media_link *link = &pad->entity->links[i];
572                         struct v4l2_mbus_framefmt remote_format;
573
574                         if (!(link->flags & MEDIA_LNK_FL_ENABLED))
575                                 continue;
576
577                         if (link->source == pad &&
578                             link->sink->entity->info.type == MEDIA_ENT_T_V4L2_SUBDEV) {
579                                 remote_format = format;
580                                 set_format(link->sink, &remote_format);
581                         }
582                 }
583         }
584
585         *endp = end;
586         return 0;
587 }
588
589 int v4l2_subdev_parse_setup_formats(struct media_device *media, const char *p)
590 {
591         char *end;
592         int ret;
593
594         do {
595                 ret = v4l2_subdev_parse_setup_format(media, p, &end);
596                 if (ret < 0)
597                         return ret;
598
599                 p = end + 1;
600         } while (*end == ',');
601
602         return *end ? -EINVAL : 0;
603 }
604
605 static struct {
606         const char *name;
607         enum v4l2_mbus_pixelcode code;
608 } mbus_formats[] = {
609         { "Y8", V4L2_MBUS_FMT_Y8_1X8},
610         { "Y10", V4L2_MBUS_FMT_Y10_1X10 },
611         { "Y12", V4L2_MBUS_FMT_Y12_1X12 },
612         { "YUYV", V4L2_MBUS_FMT_YUYV8_1X16 },
613         { "YUYV1_5X8", V4L2_MBUS_FMT_YUYV8_1_5X8 },
614         { "YUYV2X8", V4L2_MBUS_FMT_YUYV8_2X8 },
615         { "UYVY", V4L2_MBUS_FMT_UYVY8_1X16 },
616         { "UYVY1_5X8", V4L2_MBUS_FMT_UYVY8_1_5X8 },
617         { "UYVY2X8", V4L2_MBUS_FMT_UYVY8_2X8 },
618         { "SBGGR8", V4L2_MBUS_FMT_SBGGR8_1X8 },
619         { "SGBRG8", V4L2_MBUS_FMT_SGBRG8_1X8 },
620         { "SGRBG8", V4L2_MBUS_FMT_SGRBG8_1X8 },
621         { "SRGGB8", V4L2_MBUS_FMT_SRGGB8_1X8 },
622         { "SBGGR10", V4L2_MBUS_FMT_SBGGR10_1X10 },
623         { "SGBRG10", V4L2_MBUS_FMT_SGBRG10_1X10 },
624         { "SGRBG10", V4L2_MBUS_FMT_SGRBG10_1X10 },
625         { "SRGGB10", V4L2_MBUS_FMT_SRGGB10_1X10 },
626         { "SBGGR10_DPCM8", V4L2_MBUS_FMT_SBGGR10_DPCM8_1X8 },
627         { "SGBRG10_DPCM8", V4L2_MBUS_FMT_SGBRG10_DPCM8_1X8 },
628         { "SGRBG10_DPCM8", V4L2_MBUS_FMT_SGRBG10_DPCM8_1X8 },
629         { "SRGGB10_DPCM8", V4L2_MBUS_FMT_SRGGB10_DPCM8_1X8 },
630         { "SBGGR12", V4L2_MBUS_FMT_SBGGR12_1X12 },
631         { "SGBRG12", V4L2_MBUS_FMT_SGBRG12_1X12 },
632         { "SGRBG12", V4L2_MBUS_FMT_SGRBG12_1X12 },
633         { "SRGGB12", V4L2_MBUS_FMT_SRGGB12_1X12 },
634 };
635
636 const char *v4l2_subdev_pixelcode_to_string(enum v4l2_mbus_pixelcode code)
637 {
638         unsigned int i;
639
640         for (i = 0; i < ARRAY_SIZE(mbus_formats); ++i) {
641                 if (mbus_formats[i].code == code)
642                         return mbus_formats[i].name;
643         }
644
645         return "unknown";
646 }
647
648 enum v4l2_mbus_pixelcode v4l2_subdev_string_to_pixelcode(const char *string,
649                                                          unsigned int length)
650 {
651         unsigned int i;
652
653         for (i = 0; i < ARRAY_SIZE(mbus_formats); ++i) {
654                 if (strncmp(mbus_formats[i].name, string, length) == 0)
655                         break;
656         }
657
658         if (i == ARRAY_SIZE(mbus_formats))
659                 return (enum v4l2_mbus_pixelcode)-1;
660
661         return mbus_formats[i].code;
662 }