fbd7813372f2a3f57188300e8d143037426226ad
[media-ctl.git] / src / mediactl.h
1 /*
2  * Media controller interface library
3  *
4  * Copyright (C) 2010 Ideas on board SPRL <laurent.pinchart@ideasonboard.com>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program; if not, write to the Free Software Foundation, Inc.,
18  */
19
20 #ifndef __MEDIA_H__
21 #define __MEDIA_H__
22
23 #include <linux/media.h>
24
25 struct media_link {
26         struct media_pad *source;
27         struct media_pad *sink;
28         struct media_link *twin;
29         __u32 flags;
30         __u32 padding[3];
31 };
32
33 struct media_pad {
34         struct media_entity *entity;
35         __u32 index;
36         __u32 flags;
37         __u32 padding[3];
38 };
39
40 struct media_entity {
41         struct media_device *media;
42         struct media_entity_desc info;
43         struct media_pad *pads;
44         struct media_link *links;
45         unsigned int max_links;
46         unsigned int num_links;
47
48         char devname[32];
49         int fd;
50         __u32 padding[6];
51 };
52
53 struct media_device {
54         int fd;
55         struct media_entity *entities;
56         unsigned int entities_count;
57         __u32 padding[6];
58 };
59
60 /**
61  * @brief Open a media device.
62  * @param name - name (including path) of the device node.
63  * @param verbose - whether to print verbose information on the standard output.
64  *
65  * Open the media device referenced by @a name and enumerate entities, pads and
66  * links.
67  *
68  * @return A pointer to a newly allocated media_device structure instance on
69  * success and NULL on failure. The returned pointer must be freed with
70  * media_close when the device isn't needed anymore.
71  */
72 struct media_device *media_open(const char *name, int verbose);
73
74 /**
75  * @brief Close a media device.
76  * @param media - device instance.
77  *
78  * Close the @a media device instance and free allocated resources. Access to the
79  * device instance is forbidden after this function returns.
80  */
81 void media_close(struct media_device *media);
82
83 /**
84  * @brief Locate the pad at the other end of a link.
85  * @param pad - sink pad at one end of the link.
86  *
87  * Locate the source pad connected to @a pad through an enabled link. As only one
88  * link connected to a sink pad can be enabled at a time, the connected source
89  * pad is guaranteed to be unique.
90  *
91  * @return A pointer to the connected source pad, or NULL if all links connected
92  * to @a pad are disabled. Return NULL also if @a pad is not a sink pad.
93  */
94 struct media_pad *media_entity_remote_source(struct media_pad *pad);
95
96 /**
97  * @brief Get the type of an entity.
98  * @param entity - the entity.
99  *
100  * @return The type of @a entity.
101  */
102 static inline unsigned int media_entity_type(struct media_entity *entity)
103 {
104         return entity->info.type & MEDIA_ENT_TYPE_MASK;
105 }
106
107 /**
108  * @brief Find an entity by its name.
109  * @param media - media device.
110  * @param name - entity name.
111  * @param length - size of @a name.
112  *
113  * Search for an entity with a name equal to @a name.
114  *
115  * @return A pointer to the entity if found, or NULL otherwise.
116  */
117 struct media_entity *media_get_entity_by_name(struct media_device *media,
118         const char *name, size_t length);
119
120 /**
121  * @brief Find an entity by its ID.
122  * @param media - media device.
123  * @param id - entity ID.
124  *
125  * Search for an entity with an ID equal to @a id.
126  *
127  * @return A pointer to the entity if found, or NULL otherwise.
128  */
129 struct media_entity *media_get_entity_by_id(struct media_device *media,
130         __u32 id);
131
132 /**
133  * @brief Configure a link.
134  * @param media - media device.
135  * @param source - source pad at the link origin.
136  * @param sink - sink pad at the link target.
137  * @param flags - configuration flags.
138  *
139  * Locate the link between @a source and @a sink, and configure it by applying
140  * the new @a flags.
141  *
142  * Only the MEDIA_LINK_FLAG_ENABLED flag is writable.
143  *
144  * @return 0 on success, -1 on failure:
145  *         -ENOENT: link not found
146  *         - other error codes returned by MEDIA_IOC_SETUP_LINK
147  */
148 int media_setup_link(struct media_device *media,
149         struct media_pad *source, struct media_pad *sink,
150         __u32 flags);
151
152 /**
153  * @brief Reset all links to the disabled state.
154  * @param media - media device.
155  *
156  * Disable all links in the media device. This function is usually used after
157  * opening a media device to reset all links to a known state.
158  *
159  * @return 0 on success, or a negative error code on failure.
160  */
161 int media_reset_links(struct media_device *media);
162
163 /**
164  * @brief Parse string to a pad on the media device.
165  * @param media - media device.
166  * @param p - input string
167  * @param endp - pointer to string where parsing ended
168  *
169  * Parse NULL terminated string describing a pad and return its struct
170  * media_pad instance.
171  *
172  * @return Pointer to struct media_pad on success, NULL on failure.
173  */
174 struct media_pad *media_parse_pad(struct media_device *media,
175                                   const char *p, char **endp);
176
177 /**
178  * @brief Parse string to a link on the media device.
179  * @param media - media device.
180  * @param p - input string
181  * @param endp - pointer to p where parsing ended
182  *
183  * Parse NULL terminated string p describing a link and return its struct
184  * media_link instance.
185  *
186  * @return Pointer to struct media_link on success, NULL on failure.
187  */
188 struct media_link *media_parse_link(struct media_device *media,
189                                     const char *p, char **endp);
190
191 /**
192  * @brief Parse string to a link on the media device and set it up.
193  * @param media - media device.
194  * @param p - input string
195  *
196  * Parse NULL terminated string p describing a link and its configuration
197  * and configure the link.
198  *
199  * @return 0 on success, or a negative error code on failure.
200  */
201 int media_parse_setup_link(struct media_device *media,
202                            const char *p, char **endp);
203
204 /**
205  * @brief Parse string to link(s) on the media device and set it up.
206  * @param media - media device.
207  * @param p - input string
208  *
209  * Parse NULL terminated string p describing link(s) separated by
210  * commas (,) and configure the link(s).
211  *
212  * @return 0 on success, or a negative error code on failure.
213  */
214 int media_parse_setup_links(struct media_device *media, const char *p);
215
216 #endif