Print subdev device node names in dot diagrams
[media-ctl.git] / media.c
1 /*
2  * Media controller test application
3  *
4  * Copyright (C) 2010 Ideas on board SPRL <laurent.pinchart@ideasonboard.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  * You should have received a copy of the GNU General Public License along
17  * with this program; if not, write to the Free Software Foundation, Inc.,
18  */
19
20 #include <sys/ioctl.h>
21 #include <sys/stat.h>
22 #include <sys/types.h>
23
24 #include <unistd.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <fcntl.h>
29 #include <errno.h>
30
31 #include <linux/videodev2.h>
32 #include <linux/media.h>
33
34 #include "media.h"
35 #include "subdev.h"
36 #include "tools.h"
37
38 static const char *media_entity_type_to_string(unsigned type)
39 {
40         static const struct {
41                 __u32 type;
42                 const char *name;
43         } types[] = {
44                 { MEDIA_ENTITY_TYPE_NODE, "Node" },
45                 { MEDIA_ENTITY_TYPE_SUBDEV, "V4L2 subdev" },
46         };
47
48         unsigned int i;
49
50         for (i = 0; i < ARRAY_SIZE(types); i++) {
51                 if (types[i].type == type)
52                         return types[i].name;
53         }
54
55         return "Unknown";
56 }
57
58 static const char *media_entity_subtype_to_string(unsigned type, unsigned subtype)
59 {
60         static const char *node_types[] = {
61                 "Unknown",
62                 "V4L",
63                 "FB",
64                 "ALSA",
65                 "DVB",
66         };
67         static const char *subdev_types[] = {
68                 "Unknown",
69                 "Video Decoder",
70                 "Video Encoder",
71                 "Miscellaneous",
72         };
73
74         switch (type) {
75         case MEDIA_ENTITY_TYPE_NODE:
76                 if (subtype > 4)
77                         subtype = 0;
78                 return node_types[subtype];
79
80         case MEDIA_ENTITY_TYPE_SUBDEV:
81                 if (subtype > 3)
82                         subtype = 0;
83                 return subdev_types[subtype];
84         default:
85                 return node_types[0];
86         }
87 }
88
89 static const char *media_pad_type_to_string(unsigned type)
90 {
91         static const struct {
92                 __u32 type;
93                 const char *name;
94         } types[] = {
95                 { MEDIA_PAD_TYPE_INPUT, "Input" },
96                 { MEDIA_PAD_TYPE_OUTPUT, "Output" },
97         };
98
99         unsigned int i;
100
101         for (i = 0; i < ARRAY_SIZE(types); i++) {
102                 if (types[i].type == type)
103                         return types[i].name;
104         }
105
106         return "Unknown";
107 }
108
109 /*
110  * media_entity_remote_pad -
111  */
112 struct media_entity_pad *media_entity_remote_pad(struct media_entity_pad *pad)
113 {
114         unsigned int i;
115
116         for (i = 0; i < pad->entity->info.links; ++i) {
117                 struct media_entity_link *link = &pad->entity->links[i];
118
119                 if (!(link->flags & MEDIA_LINK_FLAG_ACTIVE))
120                         continue;
121
122                 if (link->source == pad)
123                         return link->sink;
124
125                 if (link->sink == pad)
126                         return link->source;
127         }
128
129         return NULL;
130 }
131
132 /*
133  * media_get_entity_by_name -
134  */
135 struct media_entity *media_get_entity_by_name(struct media_device *media,
136                                               const char *name, size_t length)
137 {
138         unsigned int i;
139
140         for (i = 0; i < media->entities_count; ++i) {
141                 struct media_entity *entity = &media->entities[i];
142
143                 if (strncmp(entity->info.name, name, length) == 0)
144                         return entity;
145         }
146
147         return NULL;
148 }
149
150 /*
151  * media_get_entity_by_id -
152  */
153 struct media_entity *media_get_entity_by_id(struct media_device *media,
154                                             __u32 id)
155 {
156         unsigned int i;
157
158         for (i = 0; i < media->entities_count; ++i) {
159                 struct media_entity *entity = &media->entities[i];
160
161                 if (entity->info.id == id)
162                         return entity;
163         }
164
165         return NULL;
166 }
167
168 /*
169  * media_setup_link -
170  */
171 int media_setup_link(struct media_device *media,
172                      struct media_entity_pad *source,
173                      struct media_entity_pad *sink,
174                      __u32 flags)
175 {
176         struct media_entity_link *link;
177         struct media_user_link ulink;
178         unsigned int i;
179         int ret;
180
181         for (i = 0; i < source->entity->info.links; i++) {
182                 link = &source->entity->links[i];
183
184                 if (link->source->entity == source->entity &&
185                     link->source->index == source->index &&
186                     link->sink->entity == sink->entity &&
187                     link->sink->index == sink->index)
188                         break;
189         }
190
191         if (i == source->entity->info.links) {
192                 printf("%s: Link not found\n", __func__);
193                 return -EINVAL;
194         }
195
196         /* source pad */
197         ulink.source.entity = source->entity->info.id;
198         ulink.source.index = source->index;
199         ulink.source.type = MEDIA_PAD_TYPE_OUTPUT;
200
201         /* sink pad */
202         ulink.sink.entity = sink->entity->info.id;
203         ulink.sink.index = sink->index;
204         ulink.sink.type = MEDIA_PAD_TYPE_INPUT;
205
206         ulink.flags = flags | (link->flags & MEDIA_LINK_FLAG_IMMUTABLE);
207
208         ret = ioctl(media->fd, MEDIA_IOC_SETUP_LINK, &ulink);
209         if (ret < 0) {
210                 printf("%s: Unable to setup link (%s)\n", __func__,
211                         strerror(errno));
212                 return ret;
213         }
214
215         link->flags = flags;
216         return 0;
217 }
218
219 int media_reset_links(struct media_device *media)
220 {
221         unsigned int i, j;
222         int ret;
223
224         for (i = 0; i < media->entities_count; ++i) {
225                 struct media_entity *entity = &media->entities[i];
226
227                 for (j = 0; j < entity->info.links; j++) {
228                         struct media_entity_link *link = &entity->links[j];
229
230                         if (link->flags & MEDIA_LINK_FLAG_IMMUTABLE)
231                                 continue;
232
233                         ret = media_setup_link(media, link->source, link->sink,
234                                                link->flags & ~MEDIA_LINK_FLAG_ACTIVE);
235                         if (ret < 0)
236                                 return ret;
237                 }
238         }
239
240         return 0;
241 }
242
243 static void media_print_topology_dot(struct media_device *media)
244 {
245         unsigned int i, j;
246
247         printf("digraph board {\n");
248         printf("\trankdir=TB\n");
249
250         for (i = 0; i < media->entities_count; ++i) {
251                 struct media_entity *entity = &media->entities[i];
252                 unsigned int npads;
253
254                 switch (entity->info.type) {
255                 case MEDIA_ENTITY_TYPE_NODE:
256                         printf("\tn%08x [label=\"%s\\n%s\", shape=box, style=filled, "
257                                "fillcolor=yellow]\n",
258                                entity->info.id, entity->info.name, entity->devname);
259                         break;
260
261                 case MEDIA_ENTITY_TYPE_SUBDEV:
262                         printf("\tn%08x [label=\"{{", entity->info.id);
263
264                         for (j = 0, npads = 0; j < entity->info.pads; ++j) {
265                                 if (entity->pads[j].type != MEDIA_PAD_TYPE_INPUT)
266                                         continue;
267
268                                 printf("%s<port%u> %u", npads ? " | " : "", j, j);
269                                 npads++;
270                         }
271
272                         printf("} | %s", entity->info.name);
273                         if (entity->devname)
274                                 printf("\\n%s", entity->devname);
275                         printf(" | {");
276
277                         for (j = 0, npads = 0; j < entity->info.pads; ++j) {
278                                 if (entity->pads[j].type != MEDIA_PAD_TYPE_OUTPUT)
279                                         continue;
280
281                                 printf("%s<port%u> %u", npads ? " | " : "", j, j);
282                                 npads++;
283                         }
284
285                         printf("}}\", shape=Mrecord, style=filled, fillcolor=green]\n");
286                         break;
287
288                 default:
289                         continue;
290                 }
291
292                 for (j = 0; j < entity->info.links; j++) {
293                         struct media_entity_link *link = &entity->links[j];
294
295                         if (link->source->entity != entity)
296                                 continue;
297
298                         printf("\tn%08x", link->source->entity->info.id);
299                         if (link->source->entity->info.type == MEDIA_ENTITY_TYPE_SUBDEV)
300                                 printf(":port%u", link->source->index);
301                         printf(" -> ");
302                         printf("n%08x", link->sink->entity->info.id);
303                         if (link->sink->entity->info.type == MEDIA_ENTITY_TYPE_SUBDEV)
304                                 printf(":port%u", link->sink->index);
305
306                         if (link->flags & MEDIA_LINK_FLAG_IMMUTABLE)
307                                 printf(" [style=bold]");
308                         else if (!(link->flags & MEDIA_LINK_FLAG_ACTIVE))
309                                 printf(" [style=dashed]");
310                         printf("\n");
311                 }
312         }
313
314         printf("}\n");
315 }
316
317 static void media_print_topology_text(struct media_device *media)
318 {
319         unsigned int i, j, k;
320         unsigned int padding;
321
322         printf("Device topology\n");
323
324         for (i = 0; i < media->entities_count; ++i) {
325                 struct media_entity *entity = &media->entities[i];
326
327                 padding = printf("- entity %u: ", entity->info.id);
328                 printf("%s (%u pad%s, %u link%s)\n", entity->info.name,
329                         entity->info.pads, entity->info.pads > 1 ? "s" : "",
330                         entity->info.links, entity->info.links > 1 ? "s" : "");
331                 printf("%*ctype %s subtype %s\n", padding, ' ',
332                         media_entity_type_to_string(entity->info.type),
333                         media_entity_subtype_to_string(entity->info.type, entity->info.subtype));
334                 if (entity->devname[0])
335                         printf("%*cdevice node name %s\n", padding, ' ', entity->devname);
336
337                 for (j = 0; j < entity->info.pads; j++) {
338                         struct media_entity_pad *pad = &entity->pads[j];
339
340                         printf("\tpad%u: %s ", j, media_pad_type_to_string(pad->type));
341
342                         if (entity->info.type == MEDIA_ENTITY_TYPE_SUBDEV)
343                                 v4l2_subdev_print_format(entity, j, V4L2_SUBDEV_FORMAT_ACTIVE);
344
345                         printf("\n");
346
347                         for (k = 0; k < entity->info.links; k++) {
348                                 struct media_entity_link *link = &entity->links[k];
349
350                                 if (link->source->entity != entity ||
351                                     link->source->index != j)
352                                         continue;
353
354                                 printf("\t\t-> '%s':pad%u [",
355                                         link->sink->entity->info.name, link->sink->index);
356
357                                 if (link->flags & MEDIA_LINK_FLAG_IMMUTABLE)
358                                         printf("IMMUTABLE,");
359                                 if (link->flags & MEDIA_LINK_FLAG_ACTIVE)
360                                         printf("ACTIVE");
361
362                                 printf("]\n");
363                         }
364                 }
365                 printf("\n");
366         }
367 }
368
369 void media_print_topology(struct media_device *media, int dot)
370 {
371         if (dot)
372                 media_print_topology_dot(media);
373         else
374                 media_print_topology_text(media);
375 }
376
377 static int media_enum_links(struct media_device *media)
378 {
379         __u32 id;
380         int ret = 0;
381
382         for (id = 1; id <= media->entities_count; id++) {
383                 struct media_entity *entity = &media->entities[id - 1];
384                 struct media_user_links links;
385                 unsigned int i;
386
387                 links.entity = entity->info.id;
388                 links.pads = malloc(entity->info.pads * sizeof(struct media_user_pad));
389                 links.links = malloc(entity->info.links * sizeof(struct media_user_link));
390
391                 if (ioctl(media->fd, MEDIA_IOC_ENUM_LINKS, &links) < 0) {
392                         printf("%s: Unable to enumerate pads and links (%s).\n",
393                                 __func__, strerror(errno));
394                         free(links.pads);
395                         free(links.links);
396                         return -errno;
397                 }
398
399                 for (i = 0; i < entity->info.pads; ++i) {
400                         entity->pads[i].entity = entity;
401                         entity->pads[i].type = links.pads[i].type;
402                         entity->pads[i].index = links.pads[i].index;
403                 }
404
405                 for (i = 0; i < entity->info.links; ++i) {
406                         struct media_user_link *link = &links.links[i];
407                         struct media_entity *source;
408                         struct media_entity *sink;
409
410                         source = media_get_entity_by_id(media, link->source.entity);
411                         sink = media_get_entity_by_id(media, link->sink.entity);
412
413                         if (source == NULL || sink == NULL) {
414                                 printf("WARNING entity %u link %u from %u/%u to %u/%u is invalid!\n",
415                                         id, i, link->source.entity, link->source.index,
416                                         link->sink.entity, link->sink.index);
417                                 ret = -EINVAL;
418                         }
419
420                         entity->links[i].source = &source->pads[link->source.index];
421                         entity->links[i].sink = &sink->pads[link->sink.index];
422                         entity->links[i].flags = links.links[i].flags;
423                 }
424
425                 free(links.pads);
426                 free(links.links);
427         }
428
429         return ret;
430 }
431
432 static int media_enum_entities(struct media_device *media)
433 {
434         struct media_entity *entity;
435         struct stat devstat;
436         unsigned int size;
437         char devname[32];
438         char sysname[32];
439         char target[1024];
440         char *p;
441         __u32 id;
442         int ret;
443
444         for (id = 0; ; id = entity->info.id) {
445                 size = (media->entities_count + 1) * sizeof(*media->entities);
446                 media->entities = realloc(media->entities, size);
447
448                 entity = &media->entities[media->entities_count];
449                 memset(entity, 0, sizeof(*entity));
450                 entity->fd = -1;
451                 entity->info.id = id | MEDIA_ENTITY_ID_FLAG_NEXT;
452
453                 ret = ioctl(media->fd, MEDIA_IOC_ENUM_ENTITIES, &entity->info);
454                 if (ret < 0) {
455                         if (errno == EINVAL)
456                                 break;
457                         return -errno;
458                 }
459
460                 entity->pads = malloc(entity->info.pads * sizeof(*entity->pads));
461                 entity->links = malloc(entity->info.links * sizeof(*entity->links));
462                 if (entity->pads == NULL || entity->links == NULL)
463                         return -ENOMEM;
464
465                 media->entities_count++;
466
467                 /* Find the corresponding device name. */
468                 if ((entity->info.type != MEDIA_ENTITY_TYPE_NODE ||
469                      entity->info.type != MEDIA_NODE_TYPE_V4L) &&
470                     (entity->info.type != MEDIA_ENTITY_TYPE_SUBDEV))
471                         continue;
472
473                 sprintf(sysname, "/sys/dev/char/%u:%u", entity->info.v4l.major,
474                         entity->info.v4l.minor);
475                 ret = readlink(sysname, target, sizeof(target));
476                 if (ret < 0)
477                         continue;
478
479                 target[ret] = '\0';
480                 p = strrchr(target, '/');
481                 if (p == NULL)
482                         continue;
483
484                 sprintf(devname, "/dev/%s", p + 1);
485                 ret = stat(devname, &devstat);
486                 if (ret < 0)
487                         continue;
488
489                 /* Sanity check: udev might have reordered the device nodes.
490                  * Make sure the major/minor match. We should really use
491                  * libudev.
492                  */
493                 if (major(devstat.st_rdev) == entity->info.v4l.major &&
494                     minor(devstat.st_rdev) == entity->info.v4l.minor)
495                         strcpy(entity->devname, devname);
496         }
497
498         return 0;
499 }
500
501 /*
502  * media_open -
503  */
504 struct media_device *media_open(const char *name, int verbose)
505 {
506         struct media_device *media;
507         int ret;
508
509         media = malloc(sizeof(*media));
510         if (media == NULL) {
511                 printf("%s: unable to allocate memory\n", __func__);
512                 return NULL;
513         }
514         memset(media, 0, sizeof(*media));
515
516         if (verbose)
517                 printf("Opening media device %s\n", name);
518         media->fd = open(name, O_RDWR);
519         if (media->fd < 0) {
520                 media_close(media);
521                 printf("%s: Can't open media device %s\n", __func__, name);
522                 return NULL;
523         }
524
525         if (verbose)
526                 printf("Enumerating entities\n");
527
528         ret = media_enum_entities(media);
529         if (ret < 0) {
530                 printf("%s: Unable to enumerate entities for device %s (%s)\n",
531                         __func__, name, strerror(-ret));
532                 media_close(media);
533                 return NULL;
534         }
535
536         if (verbose) {
537                 printf("Found %u entities\n", media->entities_count);
538                 printf("Enumerating pads and links\n");
539         }
540
541         ret = media_enum_links(media);
542         if (ret < 0) {
543                 printf("%s: Unable to enumerate pads and linksfor device %s\n",
544                         __func__, name);
545                 media_close(media);
546                 return NULL;
547         }
548
549         return media;
550 }
551
552 /*
553  * media_close -
554  */
555 void media_close(struct media_device *media)
556 {
557         unsigned int i;
558
559         if (media->fd != -1)
560                 close(media->fd);
561
562         for (i = 0; i < media->entities_count; ++i) {
563                 struct media_entity *entity = &media->entities[i];
564
565                 free(entity->pads);
566                 free(entity->links);
567                 if (entity->fd != -1)
568                         close(entity->fd);
569         }
570
571         free(media->entities);
572         free(media);
573 }
574