2009-12-09 04:40:00 -07:00
|
|
|
/*
|
|
|
|
* Media entity
|
|
|
|
*
|
|
|
|
* Copyright (C) 2010 Nokia Corporation
|
|
|
|
*
|
|
|
|
* Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
|
|
|
|
* Sakari Ailus <sakari.ailus@iki.fi>
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License version 2 as
|
|
|
|
* published by the Free Software Foundation.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _MEDIA_ENTITY_H
|
|
|
|
#define _MEDIA_ENTITY_H
|
|
|
|
|
2013-06-07 09:45:11 -06:00
|
|
|
#include <linux/bitops.h>
|
2013-12-13 04:58:37 -07:00
|
|
|
#include <linux/kernel.h>
|
2009-12-09 04:40:00 -07:00
|
|
|
#include <linux/list.h>
|
2009-12-09 04:40:01 -07:00
|
|
|
#include <linux/media.h>
|
2009-12-09 04:40:00 -07:00
|
|
|
|
2015-08-25 07:28:36 -06:00
|
|
|
/* Enums used internally at the media controller to represent graphs */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* enum media_gobj_type - type of a graph object
|
|
|
|
*
|
2015-08-14 09:47:48 -06:00
|
|
|
* @MEDIA_GRAPH_ENTITY: Identify a media entity
|
2015-08-14 09:50:08 -06:00
|
|
|
* @MEDIA_GRAPH_PAD: Identify a media pad
|
2015-08-14 09:54:36 -06:00
|
|
|
* @MEDIA_GRAPH_LINK: Identify a media link
|
2015-08-25 07:28:36 -06:00
|
|
|
*/
|
|
|
|
enum media_gobj_type {
|
2015-08-14 09:47:48 -06:00
|
|
|
MEDIA_GRAPH_ENTITY,
|
2015-08-14 09:50:08 -06:00
|
|
|
MEDIA_GRAPH_PAD,
|
2015-08-14 09:54:36 -06:00
|
|
|
MEDIA_GRAPH_LINK,
|
2015-08-25 07:28:36 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
#define MEDIA_BITS_PER_TYPE 8
|
|
|
|
#define MEDIA_BITS_PER_LOCAL_ID (32 - MEDIA_BITS_PER_TYPE)
|
|
|
|
#define MEDIA_LOCAL_ID_MASK GENMASK(MEDIA_BITS_PER_LOCAL_ID - 1, 0)
|
|
|
|
|
|
|
|
/* Structs to represent the objects that belong to a media graph */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* struct media_gobj - Define a graph object.
|
|
|
|
*
|
|
|
|
* @id: Non-zero object ID identifier. The ID should be unique
|
|
|
|
* inside a media_device, as it is composed by
|
|
|
|
* MEDIA_BITS_PER_TYPE to store the type plus
|
|
|
|
* MEDIA_BITS_PER_LOCAL_ID to store a per-type ID
|
|
|
|
* (called as "local ID").
|
|
|
|
*
|
|
|
|
* All objects on the media graph should have this struct embedded
|
|
|
|
*/
|
|
|
|
struct media_gobj {
|
2015-08-13 11:42:42 -06:00
|
|
|
struct media_device *mdev;
|
2015-08-25 07:28:36 -06:00
|
|
|
u32 id;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2010-08-25 06:00:41 -06:00
|
|
|
struct media_pipeline {
|
|
|
|
};
|
|
|
|
|
2009-12-09 04:40:00 -07:00
|
|
|
struct media_link {
|
2015-08-14 09:54:36 -06:00
|
|
|
struct media_gobj graph_obj;
|
2009-12-09 04:40:00 -07:00
|
|
|
struct media_pad *source; /* Source pad */
|
|
|
|
struct media_pad *sink; /* Sink pad */
|
|
|
|
struct media_link *reverse; /* Link in the reverse direction */
|
|
|
|
unsigned long flags; /* Link flags (MEDIA_LNK_FL_*) */
|
|
|
|
};
|
|
|
|
|
|
|
|
struct media_pad {
|
2015-08-14 09:50:08 -06:00
|
|
|
struct media_gobj graph_obj;
|
2009-12-09 04:40:00 -07:00
|
|
|
struct media_entity *entity; /* Entity this pad belongs to */
|
|
|
|
u16 index; /* Pad index in the entity pads array */
|
|
|
|
unsigned long flags; /* Pad flags (MEDIA_PAD_FL_*) */
|
|
|
|
};
|
|
|
|
|
2014-03-25 21:01:44 -06:00
|
|
|
/**
|
|
|
|
* struct media_entity_operations - Media entity operations
|
|
|
|
* @link_setup: Notify the entity of link changes. The operation can
|
|
|
|
* return an error, in which case link setup will be
|
|
|
|
* cancelled. Optional.
|
|
|
|
* @link_validate: Return whether a link is valid from the entity point of
|
|
|
|
* view. The media_entity_pipeline_start() function
|
|
|
|
* validates all links by calling this operation. Optional.
|
|
|
|
*/
|
2009-12-09 04:40:03 -07:00
|
|
|
struct media_entity_operations {
|
|
|
|
int (*link_setup)(struct media_entity *entity,
|
|
|
|
const struct media_pad *local,
|
|
|
|
const struct media_pad *remote, u32 flags);
|
2012-01-11 02:25:15 -07:00
|
|
|
int (*link_validate)(struct media_link *link);
|
2009-12-09 04:40:03 -07:00
|
|
|
};
|
|
|
|
|
2009-12-09 04:40:00 -07:00
|
|
|
struct media_entity {
|
2015-08-14 09:47:48 -06:00
|
|
|
struct media_gobj graph_obj;
|
2009-12-09 04:40:00 -07:00
|
|
|
struct list_head list;
|
|
|
|
const char *name; /* Entity name */
|
|
|
|
u32 type; /* Entity type (MEDIA_ENT_T_*) */
|
|
|
|
u32 revision; /* Entity revision, driver specific */
|
|
|
|
unsigned long flags; /* Entity flags (MEDIA_ENT_FL_*) */
|
|
|
|
u32 group_id; /* Entity group ID */
|
|
|
|
|
|
|
|
u16 num_pads; /* Number of sink and source pads */
|
|
|
|
u16 num_links; /* Number of existing links, both
|
|
|
|
* enabled and disabled */
|
|
|
|
u16 num_backlinks; /* Number of backlinks */
|
|
|
|
u16 max_links; /* Maximum number of links */
|
|
|
|
|
|
|
|
struct media_pad *pads; /* Pads array (num_pads elements) */
|
|
|
|
struct media_link *links; /* Links array (max_links elements)*/
|
|
|
|
|
2009-12-09 04:40:03 -07:00
|
|
|
const struct media_entity_operations *ops; /* Entity operations */
|
|
|
|
|
2010-03-07 11:04:59 -07:00
|
|
|
/* Reference counts must never be negative, but are signed integers on
|
|
|
|
* purpose: a simple WARN_ON(<0) check can be used to detect reference
|
|
|
|
* count bugs that would make them negative.
|
|
|
|
*/
|
2010-08-25 06:00:41 -06:00
|
|
|
int stream_count; /* Stream count for the entity. */
|
2010-03-07 11:04:59 -07:00
|
|
|
int use_count; /* Use count for the entity. */
|
|
|
|
|
2010-08-25 06:00:41 -06:00
|
|
|
struct media_pipeline *pipe; /* Pipeline this entity belongs to. */
|
|
|
|
|
2009-12-09 04:40:00 -07:00
|
|
|
union {
|
|
|
|
/* Node specifications */
|
|
|
|
struct {
|
|
|
|
u32 major;
|
|
|
|
u32 minor;
|
[media] media: Fix DVB devnode representation at media controller
The previous provision for DVB media controller support were to
define an ID (likely meaning the adapter number) for the DVB
devnodes.
This is just plain wrong. Just like V4L, DVB devices (and any other
device node)) are uniquely identified via a (major, minor) tuple.
This is enough to uniquely identify a devnode, no matter what
API it implements.
So, before we go too far, let's mark the old v4l, fb, dvb and alsa
"devnode" info as deprecated, and just call it as "dev".
We can latter add fields specific to each API if needed.
As we don't want to break compilation on already existing apps,
let's just keep the old definitions as-is, adding a note that
those are deprecated at media-entity.h.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
2015-01-02 08:18:23 -07:00
|
|
|
} dev;
|
2009-12-09 04:40:00 -07:00
|
|
|
|
|
|
|
/* Sub-device specifications */
|
|
|
|
/* Nothing needed yet */
|
2011-11-05 15:42:01 -06:00
|
|
|
} info;
|
2009-12-09 04:40:00 -07:00
|
|
|
};
|
|
|
|
|
|
|
|
static inline u32 media_entity_type(struct media_entity *entity)
|
|
|
|
{
|
|
|
|
return entity->type & MEDIA_ENT_TYPE_MASK;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline u32 media_entity_subtype(struct media_entity *entity)
|
|
|
|
{
|
|
|
|
return entity->type & MEDIA_ENT_SUBTYPE_MASK;
|
|
|
|
}
|
|
|
|
|
2015-08-14 07:42:05 -06:00
|
|
|
static inline u32 media_entity_id(struct media_entity *entity)
|
|
|
|
{
|
2015-08-14 09:47:48 -06:00
|
|
|
return entity->graph_obj.id;
|
2015-08-14 07:42:05 -06:00
|
|
|
}
|
|
|
|
|
2015-08-25 07:28:36 -06:00
|
|
|
static inline enum media_gobj_type media_type(struct media_gobj *gobj)
|
|
|
|
{
|
|
|
|
return gobj->id >> MEDIA_BITS_PER_LOCAL_ID;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline u32 media_localid(struct media_gobj *gobj)
|
|
|
|
{
|
|
|
|
return gobj->id & MEDIA_LOCAL_ID_MASK;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline u32 media_gobj_gen_id(enum media_gobj_type type, u32 local_id)
|
|
|
|
{
|
|
|
|
u32 id;
|
|
|
|
|
|
|
|
id = type << MEDIA_BITS_PER_LOCAL_ID;
|
|
|
|
id |= local_id & MEDIA_LOCAL_ID_MASK;
|
|
|
|
|
|
|
|
return id;
|
|
|
|
}
|
|
|
|
|
2010-03-07 12:14:14 -07:00
|
|
|
#define MEDIA_ENTITY_ENUM_MAX_DEPTH 16
|
2013-06-07 09:45:11 -06:00
|
|
|
#define MEDIA_ENTITY_ENUM_MAX_ID 64
|
2010-03-07 12:14:14 -07:00
|
|
|
|
2015-10-01 15:07:53 -06:00
|
|
|
/*
|
|
|
|
* The number of pads can't be bigger than the number of entities,
|
|
|
|
* as the worse-case scenario is to have one entity linked up to
|
|
|
|
* MEDIA_ENTITY_ENUM_MAX_ID - 1 entities.
|
|
|
|
*/
|
|
|
|
#define MEDIA_ENTITY_MAX_PADS (MEDIA_ENTITY_ENUM_MAX_ID - 1)
|
|
|
|
|
2010-03-07 12:14:14 -07:00
|
|
|
struct media_entity_graph {
|
|
|
|
struct {
|
|
|
|
struct media_entity *entity;
|
|
|
|
int link;
|
|
|
|
} stack[MEDIA_ENTITY_ENUM_MAX_DEPTH];
|
2013-06-07 09:45:11 -06:00
|
|
|
|
|
|
|
DECLARE_BITMAP(entities, MEDIA_ENTITY_ENUM_MAX_ID);
|
2010-03-07 12:14:14 -07:00
|
|
|
int top;
|
|
|
|
};
|
|
|
|
|
2015-08-25 07:28:36 -06:00
|
|
|
#define gobj_to_entity(gobj) \
|
|
|
|
container_of(gobj, struct media_entity, graph_obj)
|
|
|
|
|
2015-08-13 11:42:42 -06:00
|
|
|
#define gobj_to_pad(gobj) \
|
|
|
|
container_of(gobj, struct media_pad, graph_obj)
|
|
|
|
|
|
|
|
#define gobj_to_link(gobj) \
|
|
|
|
container_of(gobj, struct media_link, graph_obj)
|
|
|
|
|
2015-08-25 07:28:36 -06:00
|
|
|
void media_gobj_init(struct media_device *mdev,
|
|
|
|
enum media_gobj_type type,
|
|
|
|
struct media_gobj *gobj);
|
|
|
|
void media_gobj_remove(struct media_gobj *gobj);
|
|
|
|
|
2009-12-09 04:40:00 -07:00
|
|
|
int media_entity_init(struct media_entity *entity, u16 num_pads,
|
2015-08-06 06:25:57 -06:00
|
|
|
struct media_pad *pads);
|
2009-12-09 04:40:00 -07:00
|
|
|
void media_entity_cleanup(struct media_entity *entity);
|
2010-08-25 06:00:41 -06:00
|
|
|
|
2015-08-07 05:14:38 -06:00
|
|
|
int media_create_pad_link(struct media_entity *source, u16 source_pad,
|
2009-12-09 04:40:00 -07:00
|
|
|
struct media_entity *sink, u16 sink_pad, u32 flags);
|
2013-05-09 05:29:32 -06:00
|
|
|
void __media_entity_remove_links(struct media_entity *entity);
|
|
|
|
void media_entity_remove_links(struct media_entity *entity);
|
|
|
|
|
2009-12-09 04:40:03 -07:00
|
|
|
int __media_entity_setup_link(struct media_link *link, u32 flags);
|
|
|
|
int media_entity_setup_link(struct media_link *link, u32 flags);
|
|
|
|
struct media_link *media_entity_find_link(struct media_pad *source,
|
|
|
|
struct media_pad *sink);
|
2013-06-03 02:16:13 -06:00
|
|
|
struct media_pad *media_entity_remote_pad(struct media_pad *pad);
|
2009-12-09 04:40:00 -07:00
|
|
|
|
2010-03-07 11:04:59 -07:00
|
|
|
struct media_entity *media_entity_get(struct media_entity *entity);
|
|
|
|
void media_entity_put(struct media_entity *entity);
|
|
|
|
|
2010-03-07 12:14:14 -07:00
|
|
|
void media_entity_graph_walk_start(struct media_entity_graph *graph,
|
|
|
|
struct media_entity *entity);
|
|
|
|
struct media_entity *
|
|
|
|
media_entity_graph_walk_next(struct media_entity_graph *graph);
|
2012-01-11 02:25:15 -07:00
|
|
|
__must_check int media_entity_pipeline_start(struct media_entity *entity,
|
|
|
|
struct media_pipeline *pipe);
|
2010-08-25 06:00:41 -06:00
|
|
|
void media_entity_pipeline_stop(struct media_entity *entity);
|
2010-03-07 12:14:14 -07:00
|
|
|
|
2009-12-09 04:40:03 -07:00
|
|
|
#define media_entity_call(entity, operation, args...) \
|
|
|
|
(((entity)->ops && (entity)->ops->operation) ? \
|
|
|
|
(entity)->ops->operation((entity) , ##args) : -ENOIOCTLCMD)
|
|
|
|
|
2009-12-09 04:40:00 -07:00
|
|
|
#endif
|