[media] v4l2-core: create MC interfaces for devnodes
[linux-block.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
5c7b25b9 26#include <linux/bitops.h>
0149a2e1 27#include <linux/kernel.h>
53e269c1 28#include <linux/list.h>
1651333b 29#include <linux/media.h>
53e269c1 30
ec6e4c95
MCC
31/* Enums used internally at the media controller to represent graphs */
32
33/**
34 * enum media_gobj_type - type of a graph object
35 *
bfab2aac 36 * @MEDIA_GRAPH_ENTITY: Identify a media entity
18710dc6 37 * @MEDIA_GRAPH_PAD: Identify a media pad
6b6a4278 38 * @MEDIA_GRAPH_LINK: Identify a media link
27e543fa
MCC
39 * @MEDIA_GRAPH_INTF_DEVNODE: Identify a media Kernel API interface via
40 * a device node
ec6e4c95
MCC
41 */
42enum media_gobj_type {
bfab2aac 43 MEDIA_GRAPH_ENTITY,
18710dc6 44 MEDIA_GRAPH_PAD,
6b6a4278 45 MEDIA_GRAPH_LINK,
27e543fa 46 MEDIA_GRAPH_INTF_DEVNODE,
ec6e4c95
MCC
47};
48
49#define MEDIA_BITS_PER_TYPE 8
50#define MEDIA_BITS_PER_LOCAL_ID (32 - MEDIA_BITS_PER_TYPE)
51#define MEDIA_LOCAL_ID_MASK GENMASK(MEDIA_BITS_PER_LOCAL_ID - 1, 0)
52
53/* Structs to represent the objects that belong to a media graph */
54
55/**
56 * struct media_gobj - Define a graph object.
57 *
58 * @id: Non-zero object ID identifier. The ID should be unique
59 * inside a media_device, as it is composed by
60 * MEDIA_BITS_PER_TYPE to store the type plus
61 * MEDIA_BITS_PER_LOCAL_ID to store a per-type ID
62 * (called as "local ID").
63 *
64 * All objects on the media graph should have this struct embedded
65 */
66struct media_gobj {
39a956c4 67 struct media_device *mdev;
ec6e4c95 68 u32 id;
05bfa9fa 69 struct list_head list;
ec6e4c95
MCC
70};
71
72
e02188c9
LP
73struct media_pipeline {
74};
75
53e269c1 76struct media_link {
6b6a4278 77 struct media_gobj graph_obj;
57208e5e 78 struct list_head list;
4b8a3c08
MCC
79 union {
80 struct media_gobj *gobj0;
81 struct media_pad *source;
86e26620 82 struct media_interface *intf;
4b8a3c08
MCC
83 };
84 union {
85 struct media_gobj *gobj1;
86 struct media_pad *sink;
86e26620 87 struct media_entity *entity;
4b8a3c08 88 };
53e269c1
LP
89 struct media_link *reverse; /* Link in the reverse direction */
90 unsigned long flags; /* Link flags (MEDIA_LNK_FL_*) */
91};
92
93struct media_pad {
4b8a3c08 94 struct media_gobj graph_obj; /* must be first field in struct */
53e269c1
LP
95 struct media_entity *entity; /* Entity this pad belongs to */
96 u16 index; /* Pad index in the entity pads array */
97 unsigned long flags; /* Pad flags (MEDIA_PAD_FL_*) */
98};
99
5a5394be
LP
100/**
101 * struct media_entity_operations - Media entity operations
102 * @link_setup: Notify the entity of link changes. The operation can
103 * return an error, in which case link setup will be
104 * cancelled. Optional.
105 * @link_validate: Return whether a link is valid from the entity point of
106 * view. The media_entity_pipeline_start() function
107 * validates all links by calling this operation. Optional.
108 */
97548ed4
LP
109struct media_entity_operations {
110 int (*link_setup)(struct media_entity *entity,
111 const struct media_pad *local,
112 const struct media_pad *remote, u32 flags);
af88be38 113 int (*link_validate)(struct media_link *link);
97548ed4
LP
114};
115
53e269c1 116struct media_entity {
4b8a3c08 117 struct media_gobj graph_obj; /* must be first field in struct */
53e269c1
LP
118 const char *name; /* Entity name */
119 u32 type; /* Entity type (MEDIA_ENT_T_*) */
120 u32 revision; /* Entity revision, driver specific */
121 unsigned long flags; /* Entity flags (MEDIA_ENT_FL_*) */
122 u32 group_id; /* Entity group ID */
123
124 u16 num_pads; /* Number of sink and source pads */
125 u16 num_links; /* Number of existing links, both
126 * enabled and disabled */
127 u16 num_backlinks; /* Number of backlinks */
53e269c1 128
57208e5e 129 struct media_pad *pads; /* Pads array (num_pads objects) */
4b8a3c08 130 struct list_head links; /* Pad-to-pad links list */
53e269c1 131
97548ed4
LP
132 const struct media_entity_operations *ops; /* Entity operations */
133
503c3d82
LP
134 /* Reference counts must never be negative, but are signed integers on
135 * purpose: a simple WARN_ON(<0) check can be used to detect reference
136 * count bugs that would make them negative.
137 */
e02188c9 138 int stream_count; /* Stream count for the entity. */
503c3d82
LP
139 int use_count; /* Use count for the entity. */
140
e02188c9
LP
141 struct media_pipeline *pipe; /* Pipeline this entity belongs to. */
142
53e269c1
LP
143 union {
144 /* Node specifications */
145 struct {
146 u32 major;
147 u32 minor;
e31a0ba7 148 } dev;
53e269c1
LP
149
150 /* Sub-device specifications */
151 /* Nothing needed yet */
fa5034c6 152 } info;
53e269c1
LP
153};
154
27e543fa
MCC
155/**
156 * struct media_intf_devnode - Define a Kernel API interface
157 *
158 * @graph_obj: embedded graph object
57cf79b7
MCC
159 * @list: Linked list used to find other interfaces that belong
160 * to the same media controller
86e26620 161 * @links: List of links pointing to graph entities
27e543fa
MCC
162 * @type: Type of the interface as defined at the
163 * uapi/media/media.h header, e. g.
164 * MEDIA_INTF_T_*
165 * @flags: Interface flags as defined at uapi/media/media.h
166 */
167struct media_interface {
168 struct media_gobj graph_obj;
86e26620 169 struct list_head links;
27e543fa
MCC
170 u32 type;
171 u32 flags;
172};
173
174/**
175 * struct media_intf_devnode - Define a Kernel API interface via a device node
176 *
177 * @intf: embedded interface object
178 * @major: Major number of a device node
179 * @minor: Minor number of a device node
180 */
181struct media_intf_devnode {
182 struct media_interface intf;
c398bb64
MCC
183
184 /* Should match the fields at media_v2_intf_devnode */
27e543fa
MCC
185 u32 major;
186 u32 minor;
187};
188
fa762394
MCC
189static inline u32 media_entity_id(struct media_entity *entity)
190{
bfab2aac 191 return entity->graph_obj.id;
fa762394
MCC
192}
193
ec6e4c95
MCC
194static inline enum media_gobj_type media_type(struct media_gobj *gobj)
195{
196 return gobj->id >> MEDIA_BITS_PER_LOCAL_ID;
197}
198
199static inline u32 media_localid(struct media_gobj *gobj)
200{
201 return gobj->id & MEDIA_LOCAL_ID_MASK;
202}
203
204static inline u32 media_gobj_gen_id(enum media_gobj_type type, u32 local_id)
205{
206 u32 id;
207
208 id = type << MEDIA_BITS_PER_LOCAL_ID;
209 id |= local_id & MEDIA_LOCAL_ID_MASK;
210
211 return id;
212}
213
fa17b46a
MCC
214static inline bool is_media_entity_v4l2_io(struct media_entity *entity)
215{
216 if (!entity)
217 return false;
218
219 switch (entity->type) {
220 case MEDIA_ENT_T_V4L2_VIDEO:
221 case MEDIA_ENT_T_V4L2_VBI:
222 case MEDIA_ENT_T_V4L2_SWRADIO:
223 return true;
224 default:
225 return false;
226 }
227}
228
229static inline bool is_media_entity_v4l2_subdev(struct media_entity *entity)
230{
231 if (!entity)
232 return false;
233
234 switch (entity->type) {
235 case MEDIA_ENT_T_V4L2_SUBDEV_UNKNOWN:
236 case MEDIA_ENT_T_V4L2_SUBDEV_SENSOR:
237 case MEDIA_ENT_T_V4L2_SUBDEV_FLASH:
238 case MEDIA_ENT_T_V4L2_SUBDEV_LENS:
239 case MEDIA_ENT_T_V4L2_SUBDEV_DECODER:
240 case MEDIA_ENT_T_V4L2_SUBDEV_TUNER:
241 return true;
242
243 default:
244 return false;
245 }
246}
247
a5ccc48a 248#define MEDIA_ENTITY_ENUM_MAX_DEPTH 16
5c7b25b9 249#define MEDIA_ENTITY_ENUM_MAX_ID 64
a5ccc48a 250
ef69ee1b
MCC
251/*
252 * The number of pads can't be bigger than the number of entities,
253 * as the worse-case scenario is to have one entity linked up to
254 * MEDIA_ENTITY_ENUM_MAX_ID - 1 entities.
255 */
256#define MEDIA_ENTITY_MAX_PADS (MEDIA_ENTITY_ENUM_MAX_ID - 1)
257
a5ccc48a
SA
258struct media_entity_graph {
259 struct {
260 struct media_entity *entity;
57208e5e 261 struct list_head *link;
a5ccc48a 262 } stack[MEDIA_ENTITY_ENUM_MAX_DEPTH];
5c7b25b9
LP
263
264 DECLARE_BITMAP(entities, MEDIA_ENTITY_ENUM_MAX_ID);
a5ccc48a
SA
265 int top;
266};
267
ec6e4c95
MCC
268#define gobj_to_entity(gobj) \
269 container_of(gobj, struct media_entity, graph_obj)
270
39a956c4
MCC
271#define gobj_to_pad(gobj) \
272 container_of(gobj, struct media_pad, graph_obj)
273
274#define gobj_to_link(gobj) \
275 container_of(gobj, struct media_link, graph_obj)
276
27e543fa
MCC
277#define gobj_to_link(gobj) \
278 container_of(gobj, struct media_link, graph_obj)
279
280#define gobj_to_pad(gobj) \
281 container_of(gobj, struct media_pad, graph_obj)
282
283#define gobj_to_intf(gobj) \
284 container_of(gobj, struct media_interface, graph_obj)
285
286#define intf_to_devnode(intf) \
287 container_of(intf, struct media_intf_devnode, intf)
288
ec6e4c95
MCC
289void media_gobj_init(struct media_device *mdev,
290 enum media_gobj_type type,
291 struct media_gobj *gobj);
292void media_gobj_remove(struct media_gobj *gobj);
293
53e269c1 294int media_entity_init(struct media_entity *entity, u16 num_pads,
57208e5e 295 struct media_pad *pads);
53e269c1 296void media_entity_cleanup(struct media_entity *entity);
e02188c9 297
8df00a15 298int media_create_pad_link(struct media_entity *source, u16 source_pad,
53e269c1 299 struct media_entity *sink, u16 sink_pad, u32 flags);
7349cec1
SN
300void __media_entity_remove_links(struct media_entity *entity);
301void media_entity_remove_links(struct media_entity *entity);
302
97548ed4
LP
303int __media_entity_setup_link(struct media_link *link, u32 flags);
304int media_entity_setup_link(struct media_link *link, u32 flags);
305struct media_link *media_entity_find_link(struct media_pad *source,
306 struct media_pad *sink);
1bddf1b3 307struct media_pad *media_entity_remote_pad(struct media_pad *pad);
53e269c1 308
503c3d82
LP
309struct media_entity *media_entity_get(struct media_entity *entity);
310void media_entity_put(struct media_entity *entity);
311
a5ccc48a
SA
312void media_entity_graph_walk_start(struct media_entity_graph *graph,
313 struct media_entity *entity);
314struct media_entity *
315media_entity_graph_walk_next(struct media_entity_graph *graph);
af88be38
SA
316__must_check int media_entity_pipeline_start(struct media_entity *entity,
317 struct media_pipeline *pipe);
e02188c9 318void media_entity_pipeline_stop(struct media_entity *entity);
a5ccc48a 319
27e543fa
MCC
320struct media_intf_devnode *media_devnode_create(struct media_device *mdev,
321 u32 type, u32 flags,
322 u32 major, u32 minor,
323 gfp_t gfp_flags);
324void media_devnode_remove(struct media_intf_devnode *devnode);
86e26620
MCC
325struct media_link *media_create_intf_link(struct media_entity *entity,
326 struct media_interface *intf,
327 u32 flags);
d47109fa 328void __media_remove_intf_link(struct media_link *link);
86e26620 329void media_remove_intf_link(struct media_link *link);
7c4696a9
MCC
330void __media_remove_intf_links(struct media_interface *intf);
331void media_remove_intf_links(struct media_interface *intf);
332
86e26620 333
97548ed4
LP
334#define media_entity_call(entity, operation, args...) \
335 (((entity)->ops && (entity)->ops->operation) ? \
336 (entity)->ops->operation((entity) , ##args) : -ENOIOCTLCMD)
337
53e269c1 338#endif