summaryrefslogtreecommitdiff
path: root/isp/media.h
blob: 81031e06005cfdb55edecf972259949394250e4b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/*
 * OMAP3 ISP library - Media controller
 *
 * Copyright (C) 2010-2011 Ideas on board SPRL
 *
 * Contact: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at
 * your option) any later version.
 *
 * This library 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 Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef __MEDIA_H__
#define __MEDIA_H__

#include <linux/media.h>

struct media_entity_link {
	struct media_entity_pad *source;
	struct media_entity_pad *sink;
	struct media_entity_link *reverse;
	__u32 flags;
};

struct media_entity_pad {
	struct media_entity *entity;
	__u32 index;
	__u32 flags;
};

struct media_entity {
	struct media_entity_desc info;
	struct media_entity_pad *pads;
	struct media_entity_link *links;
	unsigned int max_links;
	unsigned int num_links;

	char devname[32];
	int fd;
};

struct media_device {
	int fd;
	struct media_device_info info;
	struct media_entity *entities;
	unsigned int entities_count;
};

/*
 * media_open - Open a media device
 * @name: Name (including path) of the device node
 * @verbose: Whether to print verbose information on the standard output
 *
 * Open the media device referenced by @name and enumerate entities, pads and
 * links.
 *
 * Return a pointer to a newly allocated media_device structure instance on
 * success and NULL on failure. The returned pointer must be freed with
 * media_close when the device isn't needed anymore.
 */
struct media_device *media_open(const char *name, int verbose);

/*
 * media_close - Close a media device
 * @media: Device instance
 *
 * Close the @media device instance and free allocated resources. Access to the
 * device instance is forbidden after this function returns.
 */
void media_close(struct media_device *media);

/*
 * media_entity_remote_source - Locate the pad at the other end of a link
 * @pad: Sink pad at one end of the link
 *
 * Locate the source pad connected to @pad through an enabled link. As only one
 * link connected to a sink pad can be enabled at a time, the connected source
 * pad is guaranteed to be unique.
 *
 * Return a pointer to the connected source pad, or NULL if all links connected
 * to @pad are disabled.
 */
struct media_entity_pad *media_entity_remote_source(struct media_entity_pad *pad);

/*
 * media_entity_type - Get the type of an entity
 * @entity: The entity
 *
 * Return the type of @entity.
 */
static inline unsigned int media_entity_type(struct media_entity *entity)
{
	return entity->info.type & MEDIA_ENT_TYPE_MASK;
}

/*
 * media_get_entity_by_name - Find an entity by its name
 * @media: Media device
 * @name: Entity name
 *
 * Search for an entity with a name equal to @name. Return a pointer to the
 * entity if found, or NULL otherwise.
 */
struct media_entity *media_get_entity_by_name(struct media_device *media,
	const char *name);

/*
 * media_get_entity_by_id - Find an entity by its ID
 * @media: Media device
 * @id: Entity ID
 *
 * Search for an entity with an ID equal to @id. Return a pointer to the entity
 * if found, or NULL otherwise.
 */
struct media_entity *media_get_entity_by_id(struct media_device *media,
	__u32 id);

/*
 * media_setup_link - Configure a link
 * @media: Media device
 * @source: Source pad at the link origin
 * @sink: Sink pad at the link target
 * @flags: Configuration flags
 *
 * Locate the link between @source and @sink, and configure it by applying the
 * new @flags.
 *
 * Only the MEDIA_LINK_FLAG_ENABLED flag is writable.
 *
 * Return 0 on success, or a negative error code on failure.
 */
int media_setup_link(struct media_device *media,
	struct media_entity_pad *source, struct media_entity_pad *sink,
	__u32 flags);

/*
 * media_reset_links - Reset all links to the disabled state.
 * @media: Media device
 *
 * Disable all links in the media device. This function is usually used after
 * opening a media device to reset all links to a known state.
 * 
 * Return 0 on success, or a negative error code on failure.
 */
int media_reset_links(struct media_device *media);

#endif