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