Read errno before media_dbg calls
[media-ctl.git] / src / mediactl.c
1 /*
2  * Media controller 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 "config.h"
23
24 #include <sys/ioctl.h>
25 #include <sys/stat.h>
26 #include <sys/types.h>
27
28 #include <ctype.h>
29 #include <errno.h>
30 #include <fcntl.h>
31 #include <stdbool.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <unistd.h>
36
37 #include <linux/media.h>
38 #include <linux/videodev2.h>
39
40 #include "mediactl.h"
41 #include "tools.h"
42
43 struct media_pad *media_entity_remote_source(struct media_pad *pad)
44 {
45         unsigned int i;
46
47         if (!(pad->flags & MEDIA_PAD_FL_SINK))
48                 return NULL;
49
50         for (i = 0; i < pad->entity->num_links; ++i) {
51                 struct media_link *link = &pad->entity->links[i];
52
53                 if (!(link->flags & MEDIA_LNK_FL_ENABLED))
54                         continue;
55
56                 if (link->sink == pad)
57                         return link->source;
58         }
59
60         return NULL;
61 }
62
63 struct media_entity *media_get_entity_by_name(struct media_device *media,
64                                               const char *name, size_t length)
65 {
66         unsigned int i;
67
68         /* A match is impossible if the entity name is longer than the maximum
69          * size we can get from the kernel.
70          */
71         if (length >= FIELD_SIZEOF(struct media_entity_desc, name))
72                 return NULL;
73
74         for (i = 0; i < media->entities_count; ++i) {
75                 struct media_entity *entity = &media->entities[i];
76
77                 if (strncmp(entity->info.name, name, length) == 0 &&
78                     entity->info.name[length] == '\0')
79                         return entity;
80         }
81
82         return NULL;
83 }
84
85 struct media_entity *media_get_entity_by_id(struct media_device *media,
86                                             __u32 id)
87 {
88         bool next = id & MEDIA_ENT_ID_FLAG_NEXT;
89         unsigned int i;
90
91         id &= ~MEDIA_ENT_ID_FLAG_NEXT;
92
93         for (i = 0; i < media->entities_count; ++i) {
94                 struct media_entity *entity = &media->entities[i];
95
96                 if ((entity->info.id == id && !next) ||
97                     (entity->info.id > id && next))
98                         return entity;
99         }
100
101         return NULL;
102 }
103
104 int media_setup_link(struct media_device *media,
105                      struct media_pad *source,
106                      struct media_pad *sink,
107                      __u32 flags)
108 {
109         struct media_link *link;
110         struct media_link_desc ulink;
111         unsigned int i;
112         int ret;
113
114         for (i = 0; i < source->entity->num_links; i++) {
115                 link = &source->entity->links[i];
116
117                 if (link->source->entity == source->entity &&
118                     link->source->index == source->index &&
119                     link->sink->entity == sink->entity &&
120                     link->sink->index == sink->index)
121                         break;
122         }
123
124         if (i == source->entity->num_links) {
125                 media_dbg(media, "%s: Link not found\n", __func__);
126                 return -ENOENT;
127         }
128
129         /* source pad */
130         ulink.source.entity = source->entity->info.id;
131         ulink.source.index = source->index;
132         ulink.source.flags = MEDIA_PAD_FL_SOURCE;
133
134         /* sink pad */
135         ulink.sink.entity = sink->entity->info.id;
136         ulink.sink.index = sink->index;
137         ulink.sink.flags = MEDIA_PAD_FL_SINK;
138
139         ulink.flags = flags | (link->flags & MEDIA_LNK_FL_IMMUTABLE);
140
141         ret = ioctl(media->fd, MEDIA_IOC_SETUP_LINK, &ulink);
142         if (ret == -1) {
143                 ret = -errno;
144                 media_dbg(media, "%s: Unable to setup link (%s)\n",
145                           __func__, strerror(errno));
146                 return ret;
147         }
148
149         link->flags = ulink.flags;
150         link->twin->flags = ulink.flags;
151         return 0;
152 }
153
154 int media_reset_links(struct media_device *media)
155 {
156         unsigned int i, j;
157         int ret;
158
159         for (i = 0; i < media->entities_count; ++i) {
160                 struct media_entity *entity = &media->entities[i];
161
162                 for (j = 0; j < entity->num_links; j++) {
163                         struct media_link *link = &entity->links[j];
164
165                         if (link->flags & MEDIA_LNK_FL_IMMUTABLE ||
166                             link->source->entity != entity)
167                                 continue;
168
169                         ret = media_setup_link(media, link->source, link->sink,
170                                                link->flags & ~MEDIA_LNK_FL_ENABLED);
171                         if (ret < 0)
172                                 return ret;
173                 }
174         }
175
176         return 0;
177 }
178
179 static struct media_link *media_entity_add_link(struct media_entity *entity)
180 {
181         if (entity->num_links >= entity->max_links) {
182                 struct media_link *links = entity->links;
183                 unsigned int max_links = entity->max_links * 2;
184                 unsigned int i;
185
186                 links = realloc(links, max_links * sizeof *links);
187                 if (links == NULL)
188                         return NULL;
189
190                 for (i = 0; i < entity->num_links; ++i)
191                         links[i].twin->twin = &links[i];
192
193                 entity->max_links = max_links;
194                 entity->links = links;
195         }
196
197         return &entity->links[entity->num_links++];
198 }
199
200 static int media_enum_links(struct media_device *media)
201 {
202         __u32 id;
203         int ret = 0;
204
205         for (id = 1; id <= media->entities_count; id++) {
206                 struct media_entity *entity = &media->entities[id - 1];
207                 struct media_links_enum links;
208                 unsigned int i;
209
210                 links.entity = entity->info.id;
211                 links.pads = calloc(entity->info.pads, sizeof(struct media_pad_desc));
212                 links.links = calloc(entity->info.links, sizeof(struct media_link_desc));
213
214                 if (ioctl(media->fd, MEDIA_IOC_ENUM_LINKS, &links) < 0) {
215                         ret = -errno;
216                         media_dbg(media,
217                                   "%s: Unable to enumerate pads and links (%s).\n",
218                                   __func__, strerror(errno));
219                         free(links.pads);
220                         free(links.links);
221                         return ret;
222                 }
223
224                 for (i = 0; i < entity->info.pads; ++i) {
225                         entity->pads[i].entity = entity;
226                         entity->pads[i].index = links.pads[i].index;
227                         entity->pads[i].flags = links.pads[i].flags;
228                 }
229
230                 for (i = 0; i < entity->info.links; ++i) {
231                         struct media_link_desc *link = &links.links[i];
232                         struct media_link *fwdlink;
233                         struct media_link *backlink;
234                         struct media_entity *source;
235                         struct media_entity *sink;
236
237                         source = media_get_entity_by_id(media, link->source.entity);
238                         sink = media_get_entity_by_id(media, link->sink.entity);
239
240                         if (source == NULL || sink == NULL) {
241                                 media_dbg(media,
242                                           "WARNING entity %u link %u from %u/%u to %u/%u is invalid!\n",
243                                           id, i, link->source.entity,
244                                           link->source.index,
245                                           link->sink.entity,
246                                           link->sink.index);
247                                 ret = -EINVAL;
248                         } else {
249                                 fwdlink = media_entity_add_link(source);
250                                 fwdlink->source = &source->pads[link->source.index];
251                                 fwdlink->sink = &sink->pads[link->sink.index];
252                                 fwdlink->flags = link->flags;
253
254                                 backlink = media_entity_add_link(sink);
255                                 backlink->source = &source->pads[link->source.index];
256                                 backlink->sink = &sink->pads[link->sink.index];
257                                 backlink->flags = link->flags;
258
259                                 fwdlink->twin = backlink;
260                                 backlink->twin = fwdlink;
261                         }
262                 }
263
264                 free(links.pads);
265                 free(links.links);
266         }
267
268         return ret;
269 }
270
271 #ifdef HAVE_LIBUDEV
272
273 #include <libudev.h>
274
275 static inline int media_udev_open(struct udev **udev)
276 {
277         *udev = udev_new();
278         if (*udev == NULL)
279                 return -ENOMEM;
280         return 0;
281 }
282
283 static inline void media_udev_close(struct udev *udev)
284 {
285         if (udev != NULL)
286                 udev_unref(udev);
287 }
288
289 static int media_get_devname_udev(struct udev *udev,
290                 struct media_entity *entity)
291 {
292         struct udev_device *device;
293         dev_t devnum;
294         const char *p;
295         int ret = -ENODEV;
296
297         if (udev == NULL)
298                 return -EINVAL;
299
300         devnum = makedev(entity->info.v4l.major, entity->info.v4l.minor);
301         media_dbg(entity->media, "looking up device: %u:%u\n",
302                   major(devnum), minor(devnum));
303         device = udev_device_new_from_devnum(udev, 'c', devnum);
304         if (device) {
305                 p = udev_device_get_devnode(device);
306                 if (p) {
307                         strncpy(entity->devname, p, sizeof(entity->devname));
308                         entity->devname[sizeof(entity->devname) - 1] = '\0';
309                 }
310                 ret = 0;
311         }
312
313         udev_device_unref(device);
314
315         return ret;
316 }
317
318 #else   /* HAVE_LIBUDEV */
319
320 struct udev;
321
322 static inline int media_udev_open(struct udev **udev) { return 0; }
323
324 static inline void media_udev_close(struct udev *udev) { }
325
326 static inline int media_get_devname_udev(struct udev *udev,
327                 struct media_entity *entity)
328 {
329         return -ENOTSUP;
330 }
331
332 #endif  /* HAVE_LIBUDEV */
333
334 static int media_get_devname_sysfs(struct media_entity *entity)
335 {
336         struct stat devstat;
337         char devname[32];
338         char sysname[32];
339         char target[1024];
340         char *p;
341         int ret;
342
343         sprintf(sysname, "/sys/dev/char/%u:%u", entity->info.v4l.major,
344                 entity->info.v4l.minor);
345         ret = readlink(sysname, target, sizeof(target));
346         if (ret < 0)
347                 return -errno;
348
349         target[ret] = '\0';
350         p = strrchr(target, '/');
351         if (p == NULL)
352                 return -EINVAL;
353
354         sprintf(devname, "/dev/%s", p + 1);
355         ret = stat(devname, &devstat);
356         if (ret < 0)
357                 return -errno;
358
359         /* Sanity check: udev might have reordered the device nodes.
360          * Make sure the major/minor match. We should really use
361          * libudev.
362          */
363         if (major(devstat.st_rdev) == entity->info.v4l.major &&
364             minor(devstat.st_rdev) == entity->info.v4l.minor)
365                 strcpy(entity->devname, devname);
366
367         return 0;
368 }
369
370 static int media_enum_entities(struct media_device *media)
371 {
372         struct media_entity *entity;
373         struct udev *udev;
374         unsigned int size;
375         __u32 id;
376         int ret;
377
378         ret = media_udev_open(&udev);
379         if (ret < 0)
380                 media_dbg(media, "Can't get udev context\n");
381
382         for (id = 0, ret = 0; ; id = entity->info.id) {
383                 size = (media->entities_count + 1) * sizeof(*media->entities);
384                 media->entities = realloc(media->entities, size);
385
386                 entity = &media->entities[media->entities_count];
387                 memset(entity, 0, sizeof(*entity));
388                 entity->fd = -1;
389                 entity->info.id = id | MEDIA_ENT_ID_FLAG_NEXT;
390                 entity->media = media;
391
392                 ret = ioctl(media->fd, MEDIA_IOC_ENUM_ENTITIES, &entity->info);
393                 if (ret < 0) {
394                         ret = errno != EINVAL ? -errno : 0;
395                         break;
396                 }
397
398                 /* Number of links (for outbound links) plus number of pads (for
399                  * inbound links) is a good safe initial estimate of the total
400                  * number of links.
401                  */
402                 entity->max_links = entity->info.pads + entity->info.links;
403
404                 entity->pads = malloc(entity->info.pads * sizeof(*entity->pads));
405                 entity->links = malloc(entity->max_links * sizeof(*entity->links));
406                 if (entity->pads == NULL || entity->links == NULL) {
407                         ret = -ENOMEM;
408                         break;
409                 }
410
411                 media->entities_count++;
412
413                 /* Find the corresponding device name. */
414                 if (media_entity_type(entity) != MEDIA_ENT_T_DEVNODE &&
415                     media_entity_type(entity) != MEDIA_ENT_T_V4L2_SUBDEV)
416                         continue;
417
418                 /* Try to get the device name via udev */
419                 if (!media_get_devname_udev(udev, entity))
420                         continue;
421
422                 /* Fall back to get the device name via sysfs */
423                 media_get_devname_sysfs(entity);
424         }
425
426         media_udev_close(udev);
427         return ret;
428 }
429
430 static void media_debug_default(void *ptr, ...)
431 {
432 }
433
434 void media_debug_set_handler(struct media_device *media,
435                              void (*debug_handler)(void *, ...),
436                              void *debug_priv)
437 {
438         if (debug_handler) {
439                 media->debug_handler = debug_handler;
440                 media->debug_priv = debug_priv;
441         } else {
442                 media->debug_handler = media_debug_default;
443                 media->debug_priv = NULL;
444         }
445 }
446
447 struct media_device *media_open_debug(
448         const char *name, void (*debug_handler)(void *, ...),
449         void *debug_priv)
450 {
451         struct media_device *media;
452         int ret;
453
454         media = calloc(1, sizeof(*media));
455         if (media == NULL)
456                 return NULL;
457
458         media_debug_set_handler(media, debug_handler, debug_priv);
459
460         media_dbg(media, "Opening media device %s\n", name);
461
462         media->fd = open(name, O_RDWR);
463         if (media->fd < 0) {
464                 media_close(media);
465                 media_dbg(media, "%s: Can't open media device %s\n",
466                           __func__, name);
467                 return NULL;
468         }
469
470         ret = ioctl(media->fd, MEDIA_IOC_DEVICE_INFO, &media->info);
471         if (ret < 0) {
472                 media_dbg(media, "%s: Unable to retrieve media device "
473                           "information for device %s (%s)\n", __func__,
474                           name, strerror(errno));
475                 media_close(media);
476                 return NULL;
477         }
478
479         media_dbg(media, "Enumerating entities\n");
480
481         ret = media_enum_entities(media);
482
483         if (ret < 0) {
484                 media_dbg(media,
485                           "%s: Unable to enumerate entities for device %s (%s)\n",
486                           __func__, name, strerror(-ret));
487                 media_close(media);
488                 return NULL;
489         }
490
491         media_dbg(media, "Found %u entities\n", media->entities_count);
492         media_dbg(media, "Enumerating pads and links\n");
493
494         ret = media_enum_links(media);
495         if (ret < 0) {
496                 media_dbg(media,
497                           "%s: Unable to enumerate pads and linksfor device %s\n",
498                           __func__, name);
499                 media_close(media);
500                 return NULL;
501         }
502
503         return media;
504 }
505
506 struct media_device *media_open(const char *name)
507 {
508         return media_open_debug(name, NULL, NULL);
509 }
510
511 void media_close(struct media_device *media)
512 {
513         unsigned int i;
514
515         if (media->fd != -1)
516                 close(media->fd);
517
518         for (i = 0; i < media->entities_count; ++i) {
519                 struct media_entity *entity = &media->entities[i];
520
521                 free(entity->pads);
522                 free(entity->links);
523                 if (entity->fd != -1)
524                         close(entity->fd);
525         }
526
527         free(media->entities);
528         free(media);
529 }
530
531 struct media_pad *media_parse_pad(struct media_device *media,
532                                   const char *p, char **endp)
533 {
534         unsigned int entity_id, pad;
535         struct media_entity *entity;
536         char *end;
537
538         /* endp can be NULL. To avoid spreading NULL checks across the function,
539          * set endp to &end in that case.
540          */
541         if (endp == NULL)
542                 endp = &end;
543
544         for (; isspace(*p); ++p);
545
546         if (*p == '"' || *p == '\'') {
547                 for (end = (char *)p + 1; *end && *end != '"' && *end != '\''; ++end);
548                 if (*end != '"' && *end != '\'') {
549                         media_dbg(media, "missing matching '\"'\n");
550                         *endp = end;
551                         return NULL;
552                 }
553
554                 entity = media_get_entity_by_name(media, p + 1, end - p - 1);
555                 if (entity == NULL) {
556                         media_dbg(media, "no such entity \"%.*s\"\n", end - p - 1, p + 1);
557                         *endp = (char *)p + 1;
558                         return NULL;
559                 }
560
561                 ++end;
562         } else {
563                 entity_id = strtoul(p, &end, 10);
564                 entity = media_get_entity_by_id(media, entity_id);
565                 if (entity == NULL) {
566                         media_dbg(media, "no such entity %d\n", entity_id);
567                         *endp = (char *)p;
568                         return NULL;
569                 }
570         }
571         for (; isspace(*end); ++end);
572
573         if (*end != ':') {
574                 media_dbg(media, "Expected ':'\n", *end);
575                 *endp = end;
576                 return NULL;
577         }
578
579         for (p = end + 1; isspace(*p); ++p);
580
581         pad = strtoul(p, &end, 10);
582
583         if (pad >= entity->info.pads) {
584                 media_dbg(media, "No pad '%d' on entity \"%s\". Maximum pad number is %d\n",
585                                 pad, entity->info.name, entity->info.pads - 1);
586                 *endp = (char *)p;
587                 return NULL;
588         }
589
590         for (p = end; isspace(*p); ++p);
591         *endp = (char *)p;
592
593         return &entity->pads[pad];
594 }
595
596 struct media_link *media_parse_link(struct media_device *media,
597                                     const char *p, char **endp)
598 {
599         struct media_link *link;
600         struct media_pad *source;
601         struct media_pad *sink;
602         unsigned int i;
603         char *end;
604
605         source = media_parse_pad(media, p, &end);
606         if (source == NULL) {
607                 *endp = end;
608                 return NULL;
609         }
610
611         if (end[0] != '-' || end[1] != '>') {
612                 *endp = end;
613                 media_dbg(media, "Expected '->'\n");
614                 return NULL;
615         }
616
617         p = end + 2;
618
619         sink = media_parse_pad(media, p, &end);
620         if (sink == NULL) {
621                 *endp = end;
622                 return NULL;
623         }
624
625         *endp = end;
626
627         for (i = 0; i < source->entity->num_links; i++) {
628                 link = &source->entity->links[i];
629
630                 if (link->source == source && link->sink == sink)
631                         return link;
632         }
633
634         media_dbg(media, "No link between \"%s\":%d and \"%s\":%d\n",
635                         source->entity->info.name, source->index,
636                         sink->entity->info.name, sink->index);
637         return NULL;
638 }
639
640 int media_parse_setup_link(struct media_device *media,
641                            const char *p, char **endp)
642 {
643         struct media_link *link;
644         __u32 flags;
645         char *end;
646
647         link = media_parse_link(media, p, &end);
648         if (link == NULL) {
649                 media_dbg(media,
650                           "%s: Unable to parse link\n", __func__);
651                 *endp = end;
652                 return -EINVAL;
653         }
654
655         p = end;
656         if (*p++ != '[') {
657                 media_dbg(media, "Unable to parse link flags: expected '['.\n");
658                 *endp = (char *)p - 1;
659                 return -EINVAL;
660         }
661
662         flags = strtoul(p, &end, 10);
663         for (p = end; isspace(*p); p++);
664         if (*p++ != ']') {
665                 media_dbg(media, "Unable to parse link flags: expected ']'.\n");
666                 *endp = (char *)p - 1;
667                 return -EINVAL;
668         }
669
670         for (; isspace(*p); p++);
671         *endp = (char *)p;
672
673         media_dbg(media,
674                   "Setting up link %u:%u -> %u:%u [%u]\n",
675                   link->source->entity->info.id, link->source->index,
676                   link->sink->entity->info.id, link->sink->index,
677                   flags);
678
679         return media_setup_link(media, link->source, link->sink, flags);
680 }
681
682 void media_print_streampos(struct media_device *media, const char *p,
683                            const char *end)
684 {
685         int pos;
686
687         pos = end - p + 1;
688
689         if (pos < 0)
690                 pos = 0;
691         if (pos > strlen(p))
692                 pos = strlen(p);
693
694         media_dbg(media, "\n");
695         media_dbg(media, " %s\n", p);
696         media_dbg(media, " %*s\n", pos, "^");
697 }
698
699 int media_parse_setup_links(struct media_device *media, const char *p)
700 {
701         char *end;
702         int ret;
703
704         do {
705                 ret = media_parse_setup_link(media, p, &end);
706                 if (ret < 0) {
707                         media_print_streampos(media, p, end);
708                         return ret;
709                 }
710
711                 p = end + 1;
712         } while (*end == ',');
713
714         return *end ? -EINVAL : 0;
715 }