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