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> |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 27 | #include <linux/list.h> |
Laurent Pinchart | 1651333 | 2009-12-09 08:40:01 -0300 | [diff] [blame] | 28 | #include <linux/media.h> |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 29 | |
Laurent Pinchart | e02188c | 2010-08-25 09:00:41 -0300 | [diff] [blame] | 30 | struct media_pipeline { |
| 31 | }; |
| 32 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 33 | struct media_link { |
| 34 | struct media_pad *source; /* Source pad */ |
| 35 | struct media_pad *sink; /* Sink pad */ |
| 36 | struct media_link *reverse; /* Link in the reverse direction */ |
| 37 | unsigned long flags; /* Link flags (MEDIA_LNK_FL_*) */ |
| 38 | }; |
| 39 | |
| 40 | struct media_pad { |
| 41 | struct media_entity *entity; /* Entity this pad belongs to */ |
| 42 | u16 index; /* Pad index in the entity pads array */ |
| 43 | unsigned long flags; /* Pad flags (MEDIA_PAD_FL_*) */ |
| 44 | }; |
| 45 | |
Laurent Pinchart | 97548ed | 2009-12-09 08:40:03 -0300 | [diff] [blame] | 46 | struct media_entity_operations { |
| 47 | int (*link_setup)(struct media_entity *entity, |
| 48 | const struct media_pad *local, |
| 49 | const struct media_pad *remote, u32 flags); |
Sakari Ailus | af88be3 | 2012-01-11 06:25:15 -0300 | [diff] [blame] | 50 | int (*link_validate)(struct media_link *link); |
Laurent Pinchart | 97548ed | 2009-12-09 08:40:03 -0300 | [diff] [blame] | 51 | }; |
| 52 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 53 | struct media_entity { |
| 54 | struct list_head list; |
| 55 | struct media_device *parent; /* Media device this entity belongs to*/ |
| 56 | u32 id; /* Entity ID, unique in the parent media |
| 57 | * device context */ |
| 58 | const char *name; /* Entity name */ |
| 59 | u32 type; /* Entity type (MEDIA_ENT_T_*) */ |
| 60 | u32 revision; /* Entity revision, driver specific */ |
| 61 | unsigned long flags; /* Entity flags (MEDIA_ENT_FL_*) */ |
| 62 | u32 group_id; /* Entity group ID */ |
| 63 | |
| 64 | u16 num_pads; /* Number of sink and source pads */ |
| 65 | u16 num_links; /* Number of existing links, both |
| 66 | * enabled and disabled */ |
| 67 | u16 num_backlinks; /* Number of backlinks */ |
| 68 | u16 max_links; /* Maximum number of links */ |
| 69 | |
| 70 | struct media_pad *pads; /* Pads array (num_pads elements) */ |
| 71 | struct media_link *links; /* Links array (max_links elements)*/ |
| 72 | |
Laurent Pinchart | 97548ed | 2009-12-09 08:40:03 -0300 | [diff] [blame] | 73 | const struct media_entity_operations *ops; /* Entity operations */ |
| 74 | |
Laurent Pinchart | 503c3d82 | 2010-03-07 15:04:59 -0300 | [diff] [blame] | 75 | /* Reference counts must never be negative, but are signed integers on |
| 76 | * purpose: a simple WARN_ON(<0) check can be used to detect reference |
| 77 | * count bugs that would make them negative. |
| 78 | */ |
Laurent Pinchart | e02188c | 2010-08-25 09:00:41 -0300 | [diff] [blame] | 79 | int stream_count; /* Stream count for the entity. */ |
Laurent Pinchart | 503c3d82 | 2010-03-07 15:04:59 -0300 | [diff] [blame] | 80 | int use_count; /* Use count for the entity. */ |
| 81 | |
Laurent Pinchart | e02188c | 2010-08-25 09:00:41 -0300 | [diff] [blame] | 82 | struct media_pipeline *pipe; /* Pipeline this entity belongs to. */ |
| 83 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 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 */ |
Clemens Ladisch | fa5034c | 2011-11-05 18:42:01 -0300 | [diff] [blame] | 103 | } info; |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 104 | }; |
| 105 | |
| 106 | static inline u32 media_entity_type(struct media_entity *entity) |
| 107 | { |
| 108 | return entity->type & MEDIA_ENT_TYPE_MASK; |
| 109 | } |
| 110 | |
| 111 | static inline u32 media_entity_subtype(struct media_entity *entity) |
| 112 | { |
| 113 | return entity->type & MEDIA_ENT_SUBTYPE_MASK; |
| 114 | } |
| 115 | |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 116 | #define MEDIA_ENTITY_ENUM_MAX_DEPTH 16 |
Laurent Pinchart | 5c7b25b | 2013-06-07 12:45:11 -0300 | [diff] [blame^] | 117 | #define MEDIA_ENTITY_ENUM_MAX_ID 64 |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 118 | |
| 119 | struct media_entity_graph { |
| 120 | struct { |
| 121 | struct media_entity *entity; |
| 122 | int link; |
| 123 | } stack[MEDIA_ENTITY_ENUM_MAX_DEPTH]; |
Laurent Pinchart | 5c7b25b | 2013-06-07 12:45:11 -0300 | [diff] [blame^] | 124 | |
| 125 | DECLARE_BITMAP(entities, MEDIA_ENTITY_ENUM_MAX_ID); |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 126 | int top; |
| 127 | }; |
| 128 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 129 | int media_entity_init(struct media_entity *entity, u16 num_pads, |
| 130 | struct media_pad *pads, u16 extra_links); |
| 131 | void media_entity_cleanup(struct media_entity *entity); |
Laurent Pinchart | e02188c | 2010-08-25 09:00:41 -0300 | [diff] [blame] | 132 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 133 | int media_entity_create_link(struct media_entity *source, u16 source_pad, |
| 134 | struct media_entity *sink, u16 sink_pad, u32 flags); |
Sylwester Nawrocki | 7349cec | 2013-05-09 08:29:32 -0300 | [diff] [blame] | 135 | void __media_entity_remove_links(struct media_entity *entity); |
| 136 | void media_entity_remove_links(struct media_entity *entity); |
| 137 | |
Laurent Pinchart | 97548ed | 2009-12-09 08:40:03 -0300 | [diff] [blame] | 138 | int __media_entity_setup_link(struct media_link *link, u32 flags); |
| 139 | int media_entity_setup_link(struct media_link *link, u32 flags); |
| 140 | struct media_link *media_entity_find_link(struct media_pad *source, |
| 141 | struct media_pad *sink); |
Andrzej Hajda | 1bddf1b | 2013-06-03 05:16:13 -0300 | [diff] [blame] | 142 | struct media_pad *media_entity_remote_pad(struct media_pad *pad); |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 143 | |
Laurent Pinchart | 503c3d82 | 2010-03-07 15:04:59 -0300 | [diff] [blame] | 144 | struct media_entity *media_entity_get(struct media_entity *entity); |
| 145 | void media_entity_put(struct media_entity *entity); |
| 146 | |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 147 | void media_entity_graph_walk_start(struct media_entity_graph *graph, |
| 148 | struct media_entity *entity); |
| 149 | struct media_entity * |
| 150 | media_entity_graph_walk_next(struct media_entity_graph *graph); |
Sakari Ailus | af88be3 | 2012-01-11 06:25:15 -0300 | [diff] [blame] | 151 | __must_check int media_entity_pipeline_start(struct media_entity *entity, |
| 152 | struct media_pipeline *pipe); |
Laurent Pinchart | e02188c | 2010-08-25 09:00:41 -0300 | [diff] [blame] | 153 | void media_entity_pipeline_stop(struct media_entity *entity); |
Sakari Ailus | a5ccc48 | 2010-03-07 16:14:14 -0300 | [diff] [blame] | 154 | |
Laurent Pinchart | 97548ed | 2009-12-09 08:40:03 -0300 | [diff] [blame] | 155 | #define media_entity_call(entity, operation, args...) \ |
| 156 | (((entity)->ops && (entity)->ops->operation) ? \ |
| 157 | (entity)->ops->operation((entity) , ##args) : -ENOIOCTLCMD) |
| 158 | |
Laurent Pinchart | 53e269c | 2009-12-09 08:40:00 -0300 | [diff] [blame] | 159 | #endif |