]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/media/media-entity.h
[media] media: Entities, pads and links
[mirror_ubuntu-bionic-kernel.git] / include / media / media-entity.h
CommitLineData
53e269c1
LP
1/*
2 * Media entity
3 *
4 * Copyright (C) 2010 Nokia Corporation
5 *
6 * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
7 * Sakari Ailus <sakari.ailus@iki.fi>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
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 General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
23#ifndef _MEDIA_ENTITY_H
24#define _MEDIA_ENTITY_H
25
26#include <linux/list.h>
27
28#define MEDIA_ENT_TYPE_SHIFT 16
29#define MEDIA_ENT_TYPE_MASK 0x00ff0000
30#define MEDIA_ENT_SUBTYPE_MASK 0x0000ffff
31
32#define MEDIA_ENT_T_DEVNODE (1 << MEDIA_ENT_TYPE_SHIFT)
33#define MEDIA_ENT_T_DEVNODE_V4L (MEDIA_ENT_T_DEVNODE + 1)
34#define MEDIA_ENT_T_DEVNODE_FB (MEDIA_ENT_T_DEVNODE + 2)
35#define MEDIA_ENT_T_DEVNODE_ALSA (MEDIA_ENT_T_DEVNODE + 3)
36#define MEDIA_ENT_T_DEVNODE_DVB (MEDIA_ENT_T_DEVNODE + 4)
37
38#define MEDIA_ENT_T_V4L2_SUBDEV (2 << MEDIA_ENT_TYPE_SHIFT)
39#define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR (MEDIA_ENT_T_V4L2_SUBDEV + 1)
40#define MEDIA_ENT_T_V4L2_SUBDEV_FLASH (MEDIA_ENT_T_V4L2_SUBDEV + 2)
41#define MEDIA_ENT_T_V4L2_SUBDEV_LENS (MEDIA_ENT_T_V4L2_SUBDEV + 3)
42
43#define MEDIA_ENT_FL_DEFAULT (1 << 0)
44
45#define MEDIA_LNK_FL_ENABLED (1 << 0)
46#define MEDIA_LNK_FL_IMMUTABLE (1 << 1)
47
48#define MEDIA_PAD_FL_SINK (1 << 0)
49#define MEDIA_PAD_FL_SOURCE (1 << 1)
50
51struct media_link {
52 struct media_pad *source; /* Source pad */
53 struct media_pad *sink; /* Sink pad */
54 struct media_link *reverse; /* Link in the reverse direction */
55 unsigned long flags; /* Link flags (MEDIA_LNK_FL_*) */
56};
57
58struct media_pad {
59 struct media_entity *entity; /* Entity this pad belongs to */
60 u16 index; /* Pad index in the entity pads array */
61 unsigned long flags; /* Pad flags (MEDIA_PAD_FL_*) */
62};
63
64struct media_entity {
65 struct list_head list;
66 struct media_device *parent; /* Media device this entity belongs to*/
67 u32 id; /* Entity ID, unique in the parent media
68 * device context */
69 const char *name; /* Entity name */
70 u32 type; /* Entity type (MEDIA_ENT_T_*) */
71 u32 revision; /* Entity revision, driver specific */
72 unsigned long flags; /* Entity flags (MEDIA_ENT_FL_*) */
73 u32 group_id; /* Entity group ID */
74
75 u16 num_pads; /* Number of sink and source pads */
76 u16 num_links; /* Number of existing links, both
77 * enabled and disabled */
78 u16 num_backlinks; /* Number of backlinks */
79 u16 max_links; /* Maximum number of links */
80
81 struct media_pad *pads; /* Pads array (num_pads elements) */
82 struct media_link *links; /* Links array (max_links elements)*/
83
84 union {
85 /* Node specifications */
86 struct {
87 u32 major;
88 u32 minor;
89 } v4l;
90 struct {
91 u32 major;
92 u32 minor;
93 } fb;
94 struct {
95 u32 card;
96 u32 device;
97 u32 subdevice;
98 } alsa;
99 int dvb;
100
101 /* Sub-device specifications */
102 /* Nothing needed yet */
103 };
104};
105
106static inline u32 media_entity_type(struct media_entity *entity)
107{
108 return entity->type & MEDIA_ENT_TYPE_MASK;
109}
110
111static inline u32 media_entity_subtype(struct media_entity *entity)
112{
113 return entity->type & MEDIA_ENT_SUBTYPE_MASK;
114}
115
116int media_entity_init(struct media_entity *entity, u16 num_pads,
117 struct media_pad *pads, u16 extra_links);
118void media_entity_cleanup(struct media_entity *entity);
119int media_entity_create_link(struct media_entity *source, u16 source_pad,
120 struct media_entity *sink, u16 sink_pad, u32 flags);
121
122#endif