1 /* SPDX-License-Identifier: GPL-2.0-or-later * 1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* 2 /*
3 * v4l2-mc.h - Media Controller V4L2 types and 3 * v4l2-mc.h - Media Controller V4L2 types and prototypes
4 * 4 *
5 * Copyright (C) 2016 Mauro Carvalho Chehab <m 5 * Copyright (C) 2016 Mauro Carvalho Chehab <mchehab@kernel.org>
6 * Copyright (C) 2006-2010 Nokia Corporation 6 * Copyright (C) 2006-2010 Nokia Corporation
7 * Copyright (c) 2016 Intel Corporation. 7 * Copyright (c) 2016 Intel Corporation.
8 */ 8 */
9 9
10 #ifndef _V4L2_MC_H 10 #ifndef _V4L2_MC_H
11 #define _V4L2_MC_H 11 #define _V4L2_MC_H
12 12
13 #include <media/media-device.h> 13 #include <media/media-device.h>
14 #include <media/v4l2-dev.h> 14 #include <media/v4l2-dev.h>
15 #include <media/v4l2-subdev.h> 15 #include <media/v4l2-subdev.h>
16 #include <linux/types.h> 16 #include <linux/types.h>
17 17
18 /* We don't need to include pci.h or usb.h her 18 /* We don't need to include pci.h or usb.h here */
19 struct pci_dev; 19 struct pci_dev;
20 struct usb_device; 20 struct usb_device;
21 21
22 #ifdef CONFIG_MEDIA_CONTROLLER 22 #ifdef CONFIG_MEDIA_CONTROLLER
23 /** 23 /**
24 * v4l2_mc_create_media_graph() - create Media 24 * v4l2_mc_create_media_graph() - create Media Controller links at the graph.
25 * 25 *
26 * @mdev: pointer to the &media_device s 26 * @mdev: pointer to the &media_device struct.
27 * 27 *
28 * Add links between the entities commonly fou 28 * Add links between the entities commonly found on PC customer's hardware at
29 * the V4L2 side: camera sensors, audio and vi 29 * the V4L2 side: camera sensors, audio and video PLL-IF decoders, tuners,
30 * analog TV decoder and I/O entities (video, 30 * analog TV decoder and I/O entities (video, VBI and Software Defined Radio).
31 * 31 *
32 * .. note:: 32 * .. note::
33 * 33 *
34 * Webcams are modelled on a very simple wa 34 * Webcams are modelled on a very simple way: the sensor is
35 * connected directly to the I/O entity. Al 35 * connected directly to the I/O entity. All dirty details, like
36 * scaler and crop HW are hidden. While suc 36 * scaler and crop HW are hidden. While such mapping is enough for v4l2
37 * interface centric PC-consumer's hardware 37 * interface centric PC-consumer's hardware, V4L2 subdev centric camera
38 * hardware should not use this routine, as 38 * hardware should not use this routine, as it will not build the right graph.
39 */ 39 */
40 int v4l2_mc_create_media_graph(struct media_de 40 int v4l2_mc_create_media_graph(struct media_device *mdev);
41 41
42 /** 42 /**
43 * v4l_enable_media_source() - Hold media sou 43 * v4l_enable_media_source() - Hold media source for exclusive use
44 * if free 44 * if free
45 * 45 *
46 * @vdev: pointer to struct video_device 46 * @vdev: pointer to struct video_device
47 * 47 *
48 * This interface calls enable_source handler 48 * This interface calls enable_source handler to determine if
49 * media source is free for use. The enable_so 49 * media source is free for use. The enable_source handler is
50 * responsible for checking is the media sourc 50 * responsible for checking is the media source is free and
51 * start a pipeline between the media source a 51 * start a pipeline between the media source and the media
52 * entity associated with the video device. Th 52 * entity associated with the video device. This interface
53 * should be called from v4l2-core and dvb-cor 53 * should be called from v4l2-core and dvb-core interfaces
54 * that change the source configuration. 54 * that change the source configuration.
55 * 55 *
56 * Return: returns zero on success or a negati 56 * Return: returns zero on success or a negative error code.
57 */ 57 */
58 int v4l_enable_media_source(struct video_devic 58 int v4l_enable_media_source(struct video_device *vdev);
59 59
60 /** 60 /**
61 * v4l_disable_media_source() - Release media 61 * v4l_disable_media_source() - Release media source
62 * 62 *
63 * @vdev: pointer to struct video_device 63 * @vdev: pointer to struct video_device
64 * 64 *
65 * This interface calls disable_source handler 65 * This interface calls disable_source handler to release
66 * the media source. The disable_source handle 66 * the media source. The disable_source handler stops the
67 * active media pipeline between the media sou 67 * active media pipeline between the media source and the
68 * media entity associated with the video devi 68 * media entity associated with the video device.
69 * 69 *
70 * Return: returns zero on success or a negati 70 * Return: returns zero on success or a negative error code.
71 */ 71 */
72 void v4l_disable_media_source(struct video_dev 72 void v4l_disable_media_source(struct video_device *vdev);
73 73
74 /* 74 /*
75 * v4l_vb2q_enable_media_tuner - Hold media s 75 * v4l_vb2q_enable_media_tuner - Hold media source for exclusive use
76 * if free. 76 * if free.
77 * @q - pointer to struct vb2_queue 77 * @q - pointer to struct vb2_queue
78 * 78 *
79 * Wrapper for v4l_enable_media_source(). This 79 * Wrapper for v4l_enable_media_source(). This function should
80 * be called from v4l2-core to enable the medi 80 * be called from v4l2-core to enable the media source with
81 * pointer to struct vb2_queue as the input ar 81 * pointer to struct vb2_queue as the input argument. Some
82 * v4l2-core interfaces don't have access to v 82 * v4l2-core interfaces don't have access to video device and
83 * this interface finds the struct video_devic 83 * this interface finds the struct video_device for the q and
84 * calls v4l_enable_media_source(). 84 * calls v4l_enable_media_source().
85 */ 85 */
86 int v4l_vb2q_enable_media_source(struct vb2_qu 86 int v4l_vb2q_enable_media_source(struct vb2_queue *q);
87 87
88 /** 88 /**
89 * v4l2_create_fwnode_links_to_pad - Create fw 89 * v4l2_create_fwnode_links_to_pad - Create fwnode-based links from a
90 * source su 90 * source subdev to a sink pad.
91 * 91 *
92 * @src_sd: pointer to a source subdev 92 * @src_sd: pointer to a source subdev
93 * @sink: pointer to a sink pad 93 * @sink: pointer to a sink pad
94 * @flags: the link flags 94 * @flags: the link flags
95 * 95 *
96 * This function searches for fwnode endpoint 96 * This function searches for fwnode endpoint connections from a source
97 * subdevice to a single sink pad, and if suit 97 * subdevice to a single sink pad, and if suitable connections are found,
98 * translates them into media links to that pa 98 * translates them into media links to that pad. The function can be
99 * called by the sink, in its v4l2-async notif 99 * called by the sink, in its v4l2-async notifier bound callback, to create
100 * links from a bound source subdevice. 100 * links from a bound source subdevice.
101 * 101 *
102 * The @flags argument specifies the link flag 102 * The @flags argument specifies the link flags. The caller shall ensure that
103 * the flags are valid regardless of the numbe 103 * the flags are valid regardless of the number of links that may be created.
104 * For instance, setting the MEDIA_LNK_FL_ENAB 104 * For instance, setting the MEDIA_LNK_FL_ENABLED flag will cause all created
105 * links to be enabled, which isn't valid if m 105 * links to be enabled, which isn't valid if more than one link is created.
106 * 106 *
107 * .. note:: 107 * .. note::
108 * 108 *
109 * Any sink subdevice that calls this funct 109 * Any sink subdevice that calls this function must implement the
110 * .get_fwnode_pad media operation in order 110 * .get_fwnode_pad media operation in order to verify endpoints passed
111 * to the sink are owned by the sink. 111 * to the sink are owned by the sink.
112 * 112 *
113 * Return 0 on success or a negative error cod 113 * Return 0 on success or a negative error code on failure.
114 */ 114 */
115 int v4l2_create_fwnode_links_to_pad(struct v4l 115 int v4l2_create_fwnode_links_to_pad(struct v4l2_subdev *src_sd,
116 struct med 116 struct media_pad *sink, u32 flags);
117 117
118 /** 118 /**
119 * v4l2_create_fwnode_links - Create fwnode-ba 119 * v4l2_create_fwnode_links - Create fwnode-based links from a source
120 * subdev to a sink 120 * subdev to a sink subdev.
121 * 121 *
122 * @src_sd: pointer to a source subdevice 122 * @src_sd: pointer to a source subdevice
123 * @sink_sd: pointer to a sink subdevice 123 * @sink_sd: pointer to a sink subdevice
124 * 124 *
125 * This function searches for any and all fwno 125 * This function searches for any and all fwnode endpoint connections
126 * between source and sink subdevices, and tra 126 * between source and sink subdevices, and translates them into media
127 * links. The function can be called by the si 127 * links. The function can be called by the sink subdevice, in its
128 * v4l2-async notifier subdev bound callback, 128 * v4l2-async notifier subdev bound callback, to create all links from
129 * a bound source subdevice. 129 * a bound source subdevice.
130 * 130 *
131 * .. note:: 131 * .. note::
132 * 132 *
133 * Any sink subdevice that calls this funct 133 * Any sink subdevice that calls this function must implement the
134 * .get_fwnode_pad media operation in order 134 * .get_fwnode_pad media operation in order to verify endpoints passed
135 * to the sink are owned by the sink. 135 * to the sink are owned by the sink.
136 * 136 *
137 * Return 0 on success or a negative error cod 137 * Return 0 on success or a negative error code on failure.
138 */ 138 */
139 int v4l2_create_fwnode_links(struct v4l2_subde 139 int v4l2_create_fwnode_links(struct v4l2_subdev *src_sd,
140 struct v4l2_subde 140 struct v4l2_subdev *sink_sd);
141 141
142 /** 142 /**
143 * v4l2_pipeline_pm_get - Increase the use cou 143 * v4l2_pipeline_pm_get - Increase the use count of a pipeline
144 * @entity: The root entity of a pipeline 144 * @entity: The root entity of a pipeline
145 * 145 *
146 * THIS FUNCTION IS DEPRECATED. DO NOT USE IN <<
147 * ON SUB-DEVICE DRIVERS INSTEAD. <<
148 * <<
149 * Update the use count of all entities in the 146 * Update the use count of all entities in the pipeline and power entities on.
150 * 147 *
151 * This function is intended to be called in v 148 * This function is intended to be called in video node open. It uses
152 * struct media_entity.use_count to track the 149 * struct media_entity.use_count to track the power status. The use
153 * of this function should be paired with v4l2 150 * of this function should be paired with v4l2_pipeline_link_notify().
154 * 151 *
155 * Return 0 on success or a negative error cod 152 * Return 0 on success or a negative error code on failure.
156 */ 153 */
157 int v4l2_pipeline_pm_get(struct media_entity * 154 int v4l2_pipeline_pm_get(struct media_entity *entity);
158 155
159 /** 156 /**
160 * v4l2_pipeline_pm_put - Decrease the use cou 157 * v4l2_pipeline_pm_put - Decrease the use count of a pipeline
161 * @entity: The root entity of a pipeline 158 * @entity: The root entity of a pipeline
162 * <<
163 * THIS FUNCTION IS DEPRECATED. DO NOT USE IN <<
164 * ON SUB-DEVICE DRIVERS INSTEAD. <<
165 * 159 *
166 * Update the use count of all entities in the 160 * Update the use count of all entities in the pipeline and power entities off.
167 * 161 *
168 * This function is intended to be called in v 162 * This function is intended to be called in video node release. It uses
169 * struct media_entity.use_count to track the 163 * struct media_entity.use_count to track the power status. The use
170 * of this function should be paired with v4l2 164 * of this function should be paired with v4l2_pipeline_link_notify().
171 */ 165 */
172 void v4l2_pipeline_pm_put(struct media_entity 166 void v4l2_pipeline_pm_put(struct media_entity *entity);
173 167
174 168
175 /** 169 /**
176 * v4l2_pipeline_link_notify - Link management 170 * v4l2_pipeline_link_notify - Link management notification callback
177 * @link: The link 171 * @link: The link
178 * @flags: New link flags that will be applied 172 * @flags: New link flags that will be applied
179 * @notification: The link's state change noti 173 * @notification: The link's state change notification type (MEDIA_DEV_NOTIFY_*)
180 * 174 *
181 * React to link management on powered pipelin 175 * React to link management on powered pipelines by updating the use count of
182 * all entities in the source and sink sides o 176 * all entities in the source and sink sides of the link. Entities are powered
183 * on or off accordingly. The use of this func 177 * on or off accordingly. The use of this function should be paired
184 * with v4l2_pipeline_pm_{get,put}(). 178 * with v4l2_pipeline_pm_{get,put}().
185 * 179 *
186 * Return 0 on success or a negative error cod 180 * Return 0 on success or a negative error code on failure. Powering entities
187 * off is assumed to never fail. This function 181 * off is assumed to never fail. This function will not fail for disconnection
188 * events. 182 * events.
189 */ 183 */
190 int v4l2_pipeline_link_notify(struct media_lin 184 int v4l2_pipeline_link_notify(struct media_link *link, u32 flags,
191 unsigned int not 185 unsigned int notification);
192 186
193 #else /* CONFIG_MEDIA_CONTROLLER */ 187 #else /* CONFIG_MEDIA_CONTROLLER */
194 188
195 static inline int v4l2_mc_create_media_graph(s 189 static inline int v4l2_mc_create_media_graph(struct media_device *mdev)
196 { 190 {
197 return 0; 191 return 0;
198 } 192 }
199 193
200 static inline int v4l_enable_media_source(stru 194 static inline int v4l_enable_media_source(struct video_device *vdev)
201 { 195 {
202 return 0; 196 return 0;
203 } 197 }
204 198
205 static inline void v4l_disable_media_source(st 199 static inline void v4l_disable_media_source(struct video_device *vdev)
206 { 200 {
207 } 201 }
208 202
209 static inline int v4l_vb2q_enable_media_source 203 static inline int v4l_vb2q_enable_media_source(struct vb2_queue *q)
210 { 204 {
211 return 0; 205 return 0;
212 } 206 }
213 207
214 static inline int v4l2_pipeline_pm_get(struct 208 static inline int v4l2_pipeline_pm_get(struct media_entity *entity)
215 { 209 {
216 return 0; 210 return 0;
217 } 211 }
218 212
219 static inline void v4l2_pipeline_pm_put(struct 213 static inline void v4l2_pipeline_pm_put(struct media_entity *entity)
220 {} 214 {}
221 215
222 static inline int v4l2_pipeline_link_notify(st 216 static inline int v4l2_pipeline_link_notify(struct media_link *link, u32 flags,
223 un 217 unsigned int notification)
224 { 218 {
225 return 0; 219 return 0;
226 } 220 }
227 221
228 #endif /* CONFIG_MEDIA_CONTROLLER */ 222 #endif /* CONFIG_MEDIA_CONTROLLER */
229 #endif /* _V4L2_MC_H */ 223 #endif /* _V4L2_MC_H */
230 224
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.