2 * vimc-core.c Virtual Media Controller Driver
4 * Copyright (C) 2015-2017 Helen Koike <helen.fornazier@gmail.com>
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.
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.
18 #include <linux/component.h>
19 #include <linux/init.h>
20 #include <linux/module.h>
21 #include <linux/platform_device.h>
22 #include <media/media-device.h>
23 #include <media/v4l2-device.h>
25 #include "vimc-common.h"
27 #define VIMC_PDEV_NAME "vimc"
28 #define VIMC_MDEV_MODEL_NAME "VIMC MDEV"
30 #define VIMC_ENT_LINK(src, srcpad, sink, sinkpad, link_flags) { \
34 .sink_pad = sinkpad, \
35 .flags = link_flags, \
39 /* The platform device */
40 struct platform_device pdev;
42 /* The pipeline configuration */
43 const struct vimc_pipeline_config *pipe_cfg;
45 /* The Associated media_device parent */
46 struct media_device mdev;
48 /* Internal v4l2 parent device*/
49 struct v4l2_device v4l2_dev;
52 struct platform_device **subdevs;
55 /* Structure which describes individual configuration for each entity */
56 struct vimc_ent_config {
61 /* Structure which describes links between entities */
62 struct vimc_ent_link {
65 unsigned int sink_ent;
70 /* Structure which describes the whole topology */
71 struct vimc_pipeline_config {
72 const struct vimc_ent_config *ents;
74 const struct vimc_ent_link *links;
78 /* --------------------------------------------------------------------------
79 * Topology Configuration
82 static const struct vimc_ent_config ent_config[] = {
93 .drv = "vimc-debayer",
97 .drv = "vimc-debayer",
100 .name = "Raw Capture 0",
101 .drv = "vimc-capture",
104 .name = "Raw Capture 1",
105 .drv = "vimc-capture",
108 .name = "RGB/YUV Input",
109 /* TODO: change this to vimc-input when it is implemented */
110 .drv = "vimc-sensor",
114 .drv = "vimc-scaler",
117 .name = "RGB/YUV Capture",
118 .drv = "vimc-capture",
122 static const struct vimc_ent_link ent_links[] = {
123 /* Link: Sensor A (Pad 0)->(Pad 0) Debayer A */
124 VIMC_ENT_LINK(0, 0, 2, 0, MEDIA_LNK_FL_ENABLED | MEDIA_LNK_FL_IMMUTABLE),
125 /* Link: Sensor A (Pad 0)->(Pad 0) Raw Capture 0 */
126 VIMC_ENT_LINK(0, 0, 4, 0, MEDIA_LNK_FL_ENABLED | MEDIA_LNK_FL_IMMUTABLE),
127 /* Link: Sensor B (Pad 0)->(Pad 0) Debayer B */
128 VIMC_ENT_LINK(1, 0, 3, 0, MEDIA_LNK_FL_ENABLED | MEDIA_LNK_FL_IMMUTABLE),
129 /* Link: Sensor B (Pad 0)->(Pad 0) Raw Capture 1 */
130 VIMC_ENT_LINK(1, 0, 5, 0, MEDIA_LNK_FL_ENABLED | MEDIA_LNK_FL_IMMUTABLE),
131 /* Link: Debayer A (Pad 1)->(Pad 0) Scaler */
132 VIMC_ENT_LINK(2, 1, 7, 0, MEDIA_LNK_FL_ENABLED),
133 /* Link: Debayer B (Pad 1)->(Pad 0) Scaler */
134 VIMC_ENT_LINK(3, 1, 7, 0, 0),
135 /* Link: RGB/YUV Input (Pad 0)->(Pad 0) Scaler */
136 VIMC_ENT_LINK(6, 0, 7, 0, 0),
137 /* Link: Scaler (Pad 1)->(Pad 0) RGB/YUV Capture */
138 VIMC_ENT_LINK(7, 1, 8, 0, MEDIA_LNK_FL_ENABLED | MEDIA_LNK_FL_IMMUTABLE),
141 static const struct vimc_pipeline_config pipe_cfg = {
143 .num_ents = ARRAY_SIZE(ent_config),
145 .num_links = ARRAY_SIZE(ent_links)
148 /* -------------------------------------------------------------------------- */
150 static int vimc_create_links(struct vimc_device *vimc)
155 /* Initialize the links between entities */
156 for (i = 0; i < vimc->pipe_cfg->num_links; i++) {
157 const struct vimc_ent_link *link = &vimc->pipe_cfg->links[i];
159 * TODO: Check another way of retrieving ved struct without
160 * relying on platform_get_drvdata
162 struct vimc_ent_device *ved_src =
163 platform_get_drvdata(vimc->subdevs[link->src_ent]);
164 struct vimc_ent_device *ved_sink =
165 platform_get_drvdata(vimc->subdevs[link->sink_ent]);
167 ret = media_create_pad_link(ved_src->ent, link->src_pad,
168 ved_sink->ent, link->sink_pad,
177 static int vimc_comp_bind(struct device *master)
179 struct vimc_device *vimc = container_of(to_platform_device(master),
180 struct vimc_device, pdev);
183 dev_dbg(master, "bind");
185 /* Register the v4l2 struct */
186 ret = v4l2_device_register(vimc->mdev.dev, &vimc->v4l2_dev);
188 dev_err(vimc->mdev.dev,
189 "v4l2 device register failed (err=%d)\n", ret);
193 /* Bind subdevices */
194 ret = component_bind_all(master, &vimc->v4l2_dev);
196 goto err_v4l2_unregister;
198 /* Initialize links */
199 ret = vimc_create_links(vimc);
201 goto err_comp_unbind_all;
203 /* Register the media device */
204 ret = media_device_register(&vimc->mdev);
206 dev_err(vimc->mdev.dev,
207 "media device register failed (err=%d)\n", ret);
208 goto err_comp_unbind_all;
211 /* Expose all subdev's nodes*/
212 ret = v4l2_device_register_subdev_nodes(&vimc->v4l2_dev);
214 dev_err(vimc->mdev.dev,
215 "vimc subdev nodes registration failed (err=%d)\n",
217 goto err_mdev_unregister;
223 media_device_unregister(&vimc->mdev);
225 component_unbind_all(master, NULL);
227 v4l2_device_unregister(&vimc->v4l2_dev);
232 static void vimc_comp_unbind(struct device *master)
234 struct vimc_device *vimc = container_of(to_platform_device(master),
235 struct vimc_device, pdev);
237 dev_dbg(master, "unbind");
239 media_device_unregister(&vimc->mdev);
240 component_unbind_all(master, NULL);
241 v4l2_device_unregister(&vimc->v4l2_dev);
244 static int vimc_comp_compare(struct device *comp, void *data)
246 const struct platform_device *pdev = to_platform_device(comp);
247 const char *name = data;
249 return !strcmp(pdev->dev.platform_data, name);
252 static struct component_match *vimc_add_subdevs(struct vimc_device *vimc)
254 struct component_match *match = NULL;
255 struct vimc_platform_data pdata;
258 for (i = 0; i < vimc->pipe_cfg->num_ents; i++) {
259 dev_dbg(&vimc->pdev.dev, "new pdev for %s\n",
260 vimc->pipe_cfg->ents[i].drv);
262 strlcpy(pdata.entity_name, vimc->pipe_cfg->ents[i].name,
263 sizeof(pdata.entity_name));
265 vimc->subdevs[i] = platform_device_register_data(&vimc->pdev.dev,
266 vimc->pipe_cfg->ents[i].drv,
270 if (!vimc->subdevs[i]) {
272 platform_device_unregister(vimc->subdevs[i]);
274 return ERR_PTR(-ENOMEM);
277 component_match_add(&vimc->pdev.dev, &match, vimc_comp_compare,
278 (void *)vimc->pipe_cfg->ents[i].name);
284 static void vimc_rm_subdevs(struct vimc_device *vimc)
288 for (i = 0; i < vimc->pipe_cfg->num_ents; i++)
289 platform_device_unregister(vimc->subdevs[i]);
292 static const struct component_master_ops vimc_comp_ops = {
293 .bind = vimc_comp_bind,
294 .unbind = vimc_comp_unbind,
297 static int vimc_probe(struct platform_device *pdev)
299 struct vimc_device *vimc = container_of(pdev, struct vimc_device, pdev);
300 struct component_match *match = NULL;
303 dev_dbg(&pdev->dev, "probe");
305 /* Create platform_device for each entity in the topology*/
306 vimc->subdevs = devm_kcalloc(&vimc->pdev.dev, vimc->pipe_cfg->num_ents,
307 sizeof(*vimc->subdevs), GFP_KERNEL);
311 match = vimc_add_subdevs(vimc);
313 return PTR_ERR(match);
315 /* Link the media device within the v4l2_device */
316 vimc->v4l2_dev.mdev = &vimc->mdev;
318 /* Initialize media device */
319 strlcpy(vimc->mdev.model, VIMC_MDEV_MODEL_NAME,
320 sizeof(vimc->mdev.model));
321 vimc->mdev.dev = &pdev->dev;
322 media_device_init(&vimc->mdev);
324 /* Add self to the component system */
325 ret = component_master_add_with_match(&pdev->dev, &vimc_comp_ops,
328 media_device_cleanup(&vimc->mdev);
329 vimc_rm_subdevs(vimc);
337 static int vimc_remove(struct platform_device *pdev)
339 struct vimc_device *vimc = container_of(pdev, struct vimc_device, pdev);
341 dev_dbg(&pdev->dev, "remove");
343 component_master_del(&pdev->dev, &vimc_comp_ops);
344 vimc_rm_subdevs(vimc);
349 static void vimc_dev_release(struct device *dev)
353 static struct vimc_device vimc_dev = {
354 .pipe_cfg = &pipe_cfg,
356 .name = VIMC_PDEV_NAME,
357 .dev.release = vimc_dev_release,
361 static struct platform_driver vimc_pdrv = {
363 .remove = vimc_remove,
365 .name = VIMC_PDEV_NAME,
369 static int __init vimc_init(void)
373 ret = platform_device_register(&vimc_dev.pdev);
375 dev_err(&vimc_dev.pdev.dev,
376 "platform device registration failed (err=%d)\n", ret);
380 ret = platform_driver_register(&vimc_pdrv);
382 dev_err(&vimc_dev.pdev.dev,
383 "platform driver registration failed (err=%d)\n", ret);
384 platform_driver_unregister(&vimc_pdrv);
391 static void __exit vimc_exit(void)
393 platform_driver_unregister(&vimc_pdrv);
395 platform_device_unregister(&vimc_dev.pdev);
398 module_init(vimc_init);
399 module_exit(vimc_exit);
401 MODULE_DESCRIPTION("Virtual Media Controller Driver (VIMC)");
402 MODULE_AUTHOR("Helen Fornazier <helen.fornazier@gmail.com>");
403 MODULE_LICENSE("GPL");