Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 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 | |
Laurent Pinchart | 5c7b25b | 2013-06-07 12:45:11 -0300 | [diff] [blame] | 26 | #include <linux/bitops.h> |
Sakari Ailus | 0149a2e | 2013-12-13 08:58:37 -0300 | [diff] [blame] | 27 | #include <linux/kernel.h> |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 28 | #include <linux/list.h> |
Laurent Pinchart | 1651333 | 2009-12-09 08:40:01 -0300 | [diff] [blame] | 29 | #include <linux/media.h> |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 30 | |
Mauro Carvalho Chehab | ec6e4c9 | 2015-08-25 10:28:36 -0300 | [diff] [blame] | 31 | /* Enums used internally at the media controller to represent graphs */ |
| 32 | |
| 33 | /** |
| 34 | * enum media_gobj_type - type of a graph object |
| 35 | * |
Mauro Carvalho Chehab | bfab2aac | 2015-08-14 12:47:48 -0300 | [diff] [blame] | 36 | * @MEDIA_GRAPH_ENTITY: Identify a media entity |
Mauro Carvalho Chehab | 18710dc | 2015-08-14 12:50:08 -0300 | [diff] [blame] | 37 | * @MEDIA_GRAPH_PAD: Identify a media pad |
Mauro Carvalho Chehab | 6b6a427 | 2015-08-14 12:54:36 -0300 | [diff] [blame] | 38 | * @MEDIA_GRAPH_LINK: Identify a media link |
Mauro Carvalho Chehab | 27e543f | 2015-08-20 09:07:34 -0300 | [diff] [blame] | 39 | * @MEDIA_GRAPH_INTF_DEVNODE: Identify a media Kernel API interface via |
| 40 | * a device node |
Mauro Carvalho Chehab | ec6e4c9 | 2015-08-25 10:28:36 -0300 | [diff] [blame] | 41 | */ |
| 42 | enum media_gobj_type { |
Mauro Carvalho Chehab | bfab2aac | 2015-08-14 12:47:48 -0300 | [diff] [blame] | 43 | MEDIA_GRAPH_ENTITY, |
Mauro Carvalho Chehab | 18710dc | 2015-08-14 12:50:08 -0300 | [diff] [blame] | 44 | MEDIA_GRAPH_PAD, |
Mauro Carvalho Chehab | 6b6a427 | 2015-08-14 12:54:36 -0300 | [diff] [blame] | 45 | MEDIA_GRAPH_LINK, |
Mauro Carvalho Chehab | 27e543f | 2015-08-20 09:07:34 -0300 | [diff] [blame] | 46 | MEDIA_GRAPH_INTF_DEVNODE, |
Mauro Carvalho Chehab | ec6e4c9 | 2015-08-25 10:28:36 -0300 | [diff] [blame] | 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 | */ |
| 66 | struct media_gobj { |
Mauro Carvalho Chehab | 39a956c | 2015-08-13 14:42:42 -0300 | [diff] [blame] | 67 | struct media_device *mdev; |
Mauro Carvalho Chehab | ec6e4c9 | 2015-08-25 10:28:36 -0300 | [diff] [blame] | 68 | u32 id; |
| 69 | }; |
| 70 | |
| 71 | |
Laurent Pinchart | e02188c | 2010-08-25 09:00:41 -0300 | [diff] [blame] | 72 | struct media_pipeline { |
| 73 | }; |
| 74 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 75 | struct media_link { |
Mauro Carvalho Chehab | 6b6a427 | 2015-08-14 12:54:36 -0300 | [diff] [blame] | 76 | struct media_gobj graph_obj; |
Mauro Carvalho Chehab | 57208e5 | 2015-08-07 06:55:40 -0300 | [diff] [blame] | 77 | struct list_head list; |
Mauro Carvalho Chehab | 4b8a3c0 | 2015-08-20 09:10:07 -0300 | [diff] [blame^] | 78 | union { |
| 79 | struct media_gobj *gobj0; |
| 80 | struct media_pad *source; |
| 81 | }; |
| 82 | union { |
| 83 | struct media_gobj *gobj1; |
| 84 | struct media_pad *sink; |
| 85 | }; |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 86 | struct media_link *reverse; /* Link in the reverse direction */ |
| 87 | unsigned long flags; /* Link flags (MEDIA_LNK_FL_*) */ |
| 88 | }; |
| 89 | |
| 90 | struct media_pad { |
Mauro Carvalho Chehab | 4b8a3c0 | 2015-08-20 09:10:07 -0300 | [diff] [blame^] | 91 | struct media_gobj graph_obj; /* must be first field in struct */ |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 92 | struct media_entity *entity; /* Entity this pad belongs to */ |
| 93 | u16 index; /* Pad index in the entity pads array */ |
| 94 | unsigned long flags; /* Pad flags (MEDIA_PAD_FL_*) */ |
| 95 | }; |
| 96 | |
Laurent Pinchart | 5a5394b | 2014-03-26 00:01:44 -0300 | [diff] [blame] | 97 | /** |
| 98 | * struct media_entity_operations - Media entity operations |
| 99 | * @link_setup: Notify the entity of link changes. The operation can |
| 100 | * return an error, in which case link setup will be |
| 101 | * cancelled. Optional. |
| 102 | * @link_validate: Return whether a link is valid from the entity point of |
| 103 | * view. The media_entity_pipeline_start() function |
| 104 | * validates all links by calling this operation. Optional. |
| 105 | */ |
Laurent Pinchart | 97548ed | 2009-12-09 08:40:03 -0300 | [diff] [blame] | 106 | struct media_entity_operations { |
| 107 | int (*link_setup)(struct media_entity *entity, |
| 108 | const struct media_pad *local, |
| 109 | const struct media_pad *remote, u32 flags); |
Sakari Ailus | af88be3 | 2012-01-11 06:25:15 -0300 | [diff] [blame] | 110 | int (*link_validate)(struct media_link *link); |
Laurent Pinchart | 97548ed | 2009-12-09 08:40:03 -0300 | [diff] [blame] | 111 | }; |
| 112 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 113 | struct media_entity { |
Mauro Carvalho Chehab | 4b8a3c0 | 2015-08-20 09:10:07 -0300 | [diff] [blame^] | 114 | struct media_gobj graph_obj; /* must be first field in struct */ |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 115 | struct list_head list; |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 116 | const char *name; /* Entity name */ |
| 117 | u32 type; /* Entity type (MEDIA_ENT_T_*) */ |
| 118 | u32 revision; /* Entity revision, driver specific */ |
| 119 | unsigned long flags; /* Entity flags (MEDIA_ENT_FL_*) */ |
| 120 | u32 group_id; /* Entity group ID */ |
| 121 | |
| 122 | u16 num_pads; /* Number of sink and source pads */ |
| 123 | u16 num_links; /* Number of existing links, both |
| 124 | * enabled and disabled */ |
| 125 | u16 num_backlinks; /* Number of backlinks */ |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 126 | |
Mauro Carvalho Chehab | 57208e5 | 2015-08-07 06:55:40 -0300 | [diff] [blame] | 127 | struct media_pad *pads; /* Pads array (num_pads objects) */ |
Mauro Carvalho Chehab | 4b8a3c0 | 2015-08-20 09:10:07 -0300 | [diff] [blame^] | 128 | struct list_head links; /* Pad-to-pad links list */ |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 129 | |
Laurent Pinchart | 97548ed | 2009-12-09 08:40:03 -0300 | [diff] [blame] | 130 | const struct media_entity_operations *ops; /* Entity operations */ |
| 131 | |
Laurent Pinchart | 503c3d82 | 2010-03-07 15:04:59 -0300 | [diff] [blame] | 132 | /* Reference counts must never be negative, but are signed integers on |
| 133 | * purpose: a simple WARN_ON(<0) check can be used to detect reference |
| 134 | * count bugs that would make them negative. |
| 135 | */ |
Laurent Pinchart | e02188c | 2010-08-25 09:00:41 -0300 | [diff] [blame] | 136 | int stream_count; /* Stream count for the entity. */ |
Laurent Pinchart | 503c3d82 | 2010-03-07 15:04:59 -0300 | [diff] [blame] | 137 | int use_count; /* Use count for the entity. */ |
| 138 | |
Laurent Pinchart | e02188c | 2010-08-25 09:00:41 -0300 | [diff] [blame] | 139 | struct media_pipeline *pipe; /* Pipeline this entity belongs to. */ |
| 140 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 141 | union { |
| 142 | /* Node specifications */ |
| 143 | struct { |
| 144 | u32 major; |
| 145 | u32 minor; |
Mauro Carvalho Chehab | e31a0ba | 2015-01-02 12:18:23 -0300 | [diff] [blame] | 146 | } dev; |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 147 | |
| 148 | /* Sub-device specifications */ |
| 149 | /* Nothing needed yet */ |
Clemens Ladisch | fa5034c | 2011-11-05 18:42:01 -0300 | [diff] [blame] | 150 | } info; |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 151 | }; |
| 152 | |
Mauro Carvalho Chehab | 27e543f | 2015-08-20 09:07:34 -0300 | [diff] [blame] | 153 | /** |
| 154 | * struct media_intf_devnode - Define a Kernel API interface |
| 155 | * |
| 156 | * @graph_obj: embedded graph object |
| 157 | * @type: Type of the interface as defined at the |
| 158 | * uapi/media/media.h header, e. g. |
| 159 | * MEDIA_INTF_T_* |
| 160 | * @flags: Interface flags as defined at uapi/media/media.h |
| 161 | */ |
| 162 | struct media_interface { |
| 163 | struct media_gobj graph_obj; |
| 164 | u32 type; |
| 165 | u32 flags; |
| 166 | }; |
| 167 | |
| 168 | /** |
| 169 | * struct media_intf_devnode - Define a Kernel API interface via a device node |
| 170 | * |
| 171 | * @intf: embedded interface object |
| 172 | * @major: Major number of a device node |
| 173 | * @minor: Minor number of a device node |
| 174 | */ |
| 175 | struct media_intf_devnode { |
| 176 | struct media_interface intf; |
| 177 | u32 major; |
| 178 | u32 minor; |
| 179 | }; |
| 180 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 181 | static inline u32 media_entity_type(struct media_entity *entity) |
| 182 | { |
| 183 | return entity->type & MEDIA_ENT_TYPE_MASK; |
| 184 | } |
| 185 | |
| 186 | static inline u32 media_entity_subtype(struct media_entity *entity) |
| 187 | { |
| 188 | return entity->type & MEDIA_ENT_SUBTYPE_MASK; |
| 189 | } |
| 190 | |
Mauro Carvalho Chehab | fa76239 | 2015-08-14 10:42:05 -0300 | [diff] [blame] | 191 | static inline u32 media_entity_id(struct media_entity *entity) |
| 192 | { |
Mauro Carvalho Chehab | bfab2aac | 2015-08-14 12:47:48 -0300 | [diff] [blame] | 193 | return entity->graph_obj.id; |
Mauro Carvalho Chehab | fa76239 | 2015-08-14 10:42:05 -0300 | [diff] [blame] | 194 | } |
| 195 | |
Mauro Carvalho Chehab | ec6e4c9 | 2015-08-25 10:28:36 -0300 | [diff] [blame] | 196 | static inline enum media_gobj_type media_type(struct media_gobj *gobj) |
| 197 | { |
| 198 | return gobj->id >> MEDIA_BITS_PER_LOCAL_ID; |
| 199 | } |
| 200 | |
| 201 | static inline u32 media_localid(struct media_gobj *gobj) |
| 202 | { |
| 203 | return gobj->id & MEDIA_LOCAL_ID_MASK; |
| 204 | } |
| 205 | |
| 206 | static inline u32 media_gobj_gen_id(enum media_gobj_type type, u32 local_id) |
| 207 | { |
| 208 | u32 id; |
| 209 | |
| 210 | id = type << MEDIA_BITS_PER_LOCAL_ID; |
| 211 | id |= local_id & MEDIA_LOCAL_ID_MASK; |
| 212 | |
| 213 | return id; |
| 214 | } |
| 215 | |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 216 | #define MEDIA_ENTITY_ENUM_MAX_DEPTH 16 |
Laurent Pinchart | 5c7b25b | 2013-06-07 12:45:11 -0300 | [diff] [blame] | 217 | #define MEDIA_ENTITY_ENUM_MAX_ID 64 |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 218 | |
Mauro Carvalho Chehab | ef69ee1 | 2015-10-01 18:07:53 -0300 | [diff] [blame] | 219 | /* |
| 220 | * The number of pads can't be bigger than the number of entities, |
| 221 | * as the worse-case scenario is to have one entity linked up to |
| 222 | * MEDIA_ENTITY_ENUM_MAX_ID - 1 entities. |
| 223 | */ |
| 224 | #define MEDIA_ENTITY_MAX_PADS (MEDIA_ENTITY_ENUM_MAX_ID - 1) |
| 225 | |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 226 | struct media_entity_graph { |
| 227 | struct { |
| 228 | struct media_entity *entity; |
Mauro Carvalho Chehab | 57208e5 | 2015-08-07 06:55:40 -0300 | [diff] [blame] | 229 | struct list_head *link; |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 230 | } stack[MEDIA_ENTITY_ENUM_MAX_DEPTH]; |
Laurent Pinchart | 5c7b25b | 2013-06-07 12:45:11 -0300 | [diff] [blame] | 231 | |
| 232 | DECLARE_BITMAP(entities, MEDIA_ENTITY_ENUM_MAX_ID); |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 233 | int top; |
| 234 | }; |
| 235 | |
Mauro Carvalho Chehab | ec6e4c9 | 2015-08-25 10:28:36 -0300 | [diff] [blame] | 236 | #define gobj_to_entity(gobj) \ |
| 237 | container_of(gobj, struct media_entity, graph_obj) |
| 238 | |
Mauro Carvalho Chehab | 39a956c | 2015-08-13 14:42:42 -0300 | [diff] [blame] | 239 | #define gobj_to_pad(gobj) \ |
| 240 | container_of(gobj, struct media_pad, graph_obj) |
| 241 | |
| 242 | #define gobj_to_link(gobj) \ |
| 243 | container_of(gobj, struct media_link, graph_obj) |
| 244 | |
Mauro Carvalho Chehab | 27e543f | 2015-08-20 09:07:34 -0300 | [diff] [blame] | 245 | #define gobj_to_link(gobj) \ |
| 246 | container_of(gobj, struct media_link, graph_obj) |
| 247 | |
| 248 | #define gobj_to_pad(gobj) \ |
| 249 | container_of(gobj, struct media_pad, graph_obj) |
| 250 | |
| 251 | #define gobj_to_intf(gobj) \ |
| 252 | container_of(gobj, struct media_interface, graph_obj) |
| 253 | |
| 254 | #define intf_to_devnode(intf) \ |
| 255 | container_of(intf, struct media_intf_devnode, intf) |
| 256 | |
Mauro Carvalho Chehab | ec6e4c9 | 2015-08-25 10:28:36 -0300 | [diff] [blame] | 257 | void media_gobj_init(struct media_device *mdev, |
| 258 | enum media_gobj_type type, |
| 259 | struct media_gobj *gobj); |
| 260 | void media_gobj_remove(struct media_gobj *gobj); |
| 261 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 262 | int media_entity_init(struct media_entity *entity, u16 num_pads, |
Mauro Carvalho Chehab | 57208e5 | 2015-08-07 06:55:40 -0300 | [diff] [blame] | 263 | struct media_pad *pads); |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 264 | void media_entity_cleanup(struct media_entity *entity); |
Laurent Pinchart | e02188c | 2010-08-25 09:00:41 -0300 | [diff] [blame] | 265 | |
Mauro Carvalho Chehab | 8df00a1 | 2015-08-07 08:14:38 -0300 | [diff] [blame] | 266 | int media_create_pad_link(struct media_entity *source, u16 source_pad, |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 267 | struct media_entity *sink, u16 sink_pad, u32 flags); |
Sylwester Nawrocki | 7349cec | 2013-05-09 08:29:32 -0300 | [diff] [blame] | 268 | void __media_entity_remove_links(struct media_entity *entity); |
| 269 | void media_entity_remove_links(struct media_entity *entity); |
| 270 | |
Laurent Pinchart | 97548ed | 2009-12-09 08:40:03 -0300 | [diff] [blame] | 271 | int __media_entity_setup_link(struct media_link *link, u32 flags); |
| 272 | int media_entity_setup_link(struct media_link *link, u32 flags); |
| 273 | struct media_link *media_entity_find_link(struct media_pad *source, |
| 274 | struct media_pad *sink); |
Andrzej Hajda | 1bddf1b | 2013-06-03 05:16:13 -0300 | [diff] [blame] | 275 | struct media_pad *media_entity_remote_pad(struct media_pad *pad); |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 276 | |
Laurent Pinchart | 503c3d82 | 2010-03-07 15:04:59 -0300 | [diff] [blame] | 277 | struct media_entity *media_entity_get(struct media_entity *entity); |
| 278 | void media_entity_put(struct media_entity *entity); |
| 279 | |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 280 | void media_entity_graph_walk_start(struct media_entity_graph *graph, |
| 281 | struct media_entity *entity); |
| 282 | struct media_entity * |
| 283 | media_entity_graph_walk_next(struct media_entity_graph *graph); |
Sakari Ailus | af88be3 | 2012-01-11 06:25:15 -0300 | [diff] [blame] | 284 | __must_check int media_entity_pipeline_start(struct media_entity *entity, |
| 285 | struct media_pipeline *pipe); |
Laurent Pinchart | e02188c | 2010-08-25 09:00:41 -0300 | [diff] [blame] | 286 | void media_entity_pipeline_stop(struct media_entity *entity); |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 287 | |
Mauro Carvalho Chehab | 27e543f | 2015-08-20 09:07:34 -0300 | [diff] [blame] | 288 | struct media_intf_devnode *media_devnode_create(struct media_device *mdev, |
| 289 | u32 type, u32 flags, |
| 290 | u32 major, u32 minor, |
| 291 | gfp_t gfp_flags); |
| 292 | void media_devnode_remove(struct media_intf_devnode *devnode); |
Laurent Pinchart | 97548ed | 2009-12-09 08:40:03 -0300 | [diff] [blame] | 293 | #define media_entity_call(entity, operation, args...) \ |
| 294 | (((entity)->ops && (entity)->ops->operation) ? \ |
| 295 | (entity)->ops->operation((entity) , ##args) : -ENOIOCTLCMD) |
| 296 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 297 | #endif |