drivers/media/platform/vimc/vimc-core.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * vimc-core.c Virtual Media Controller Driver
   4  *
   5  * Copyright (C) 2015-2017 Helen Koike <helen.fornazier@gmail.com>
   6  */
   7
   8 #include <linux/init.h>
   9 #include <linux/module.h>
  10 #include <linux/platform_device.h>
  11 #include <media/media-device.h>
  12 #include <media/v4l2-device.h>
  13
  14 #include "vimc-common.h"
  15
  16 #define VIMC_MDEV_MODEL_NAME "VIMC MDEV"
  17
  18 #define VIMC_ENT_LINK(src, srcpad, sink, sinkpad, link_flags) { \
  19         .src_ent = src,                                         \
  20         .src_pad = srcpad,                                      \
  21         .sink_ent = sink,                                       \
  22         .sink_pad = sinkpad,                                    \
  23         .flags = link_flags,                                    \
  24 }
  25
  26 /* Structure which describes links between entities */
  27 struct vimc_ent_link {
  28         unsigned int src_ent;
  29         u16 src_pad;
  30         unsigned int sink_ent;
  31         u16 sink_pad;
  32         u32 flags;
  33 };
  34
  35 /* Structure which describes the whole topology */
  36 struct vimc_pipeline_config {
  37         const struct vimc_ent_config *ents;
  38         size_t num_ents;
  39         const struct vimc_ent_link *links;
  40         size_t num_links;
  41 };
  42
  43 /* --------------------------------------------------------------------------
  44  * Topology Configuration
  45  */
  46
  47 static struct vimc_ent_config ent_config[] = {
  48         {
  49                 .name = "Sensor A",
  50                 .add = vimc_sen_add,
  51                 .rm = vimc_sen_rm,
  52         },
  53         {
  54                 .name = "Sensor B",
  55                 .add = vimc_sen_add,
  56                 .rm = vimc_sen_rm,
  57         },
  58         {
  59                 .name = "Debayer A",
  60                 .add = vimc_deb_add,
  61                 .rm = vimc_deb_rm,
  62         },
  63         {
  64                 .name = "Debayer B",
  65                 .add = vimc_deb_add,
  66                 .rm = vimc_deb_rm,
  67         },
  68         {
  69                 .name = "Raw Capture 0",
  70                 .add = vimc_cap_add,
  71                 .rm = vimc_cap_rm,
  72         },
  73         {
  74                 .name = "Raw Capture 1",
  75                 .add = vimc_cap_add,
  76                 .rm = vimc_cap_rm,
  77         },
  78         {
  79                 /* TODO: change this to vimc-input when it is implemented */
  80                 .name = "RGB/YUV Input",
  81                 .add = vimc_sen_add,
  82                 .rm = vimc_sen_rm,
  83         },
  84         {
  85                 .name = "Scaler",
  86                 .add = vimc_sca_add,
  87                 .rm = vimc_sca_rm,
  88         },
  89         {
  90                 .name = "RGB/YUV Capture",
  91                 .add = vimc_cap_add,
  92                 .rm = vimc_cap_rm,
  93         },
  94 };
  95
  96 static const struct vimc_ent_link ent_links[] = {
  97         /* Link: Sensor A (Pad 0)->(Pad 0) Debayer A */
  98         VIMC_ENT_LINK(0, 0, 2, 0, MEDIA_LNK_FL_ENABLED | MEDIA_LNK_FL_IMMUTABLE),
  99         /* Link: Sensor A (Pad 0)->(Pad 0) Raw Capture 0 */
 100         VIMC_ENT_LINK(0, 0, 4, 0, MEDIA_LNK_FL_ENABLED | MEDIA_LNK_FL_IMMUTABLE),
 101         /* Link: Sensor B (Pad 0)->(Pad 0) Debayer B */
 102         VIMC_ENT_LINK(1, 0, 3, 0, MEDIA_LNK_FL_ENABLED | MEDIA_LNK_FL_IMMUTABLE),
 103         /* Link: Sensor B (Pad 0)->(Pad 0) Raw Capture 1 */
 104         VIMC_ENT_LINK(1, 0, 5, 0, MEDIA_LNK_FL_ENABLED | MEDIA_LNK_FL_IMMUTABLE),
 105         /* Link: Debayer A (Pad 1)->(Pad 0) Scaler */
 106         VIMC_ENT_LINK(2, 1, 7, 0, MEDIA_LNK_FL_ENABLED),
 107         /* Link: Debayer B (Pad 1)->(Pad 0) Scaler */
 108         VIMC_ENT_LINK(3, 1, 7, 0, 0),
 109         /* Link: RGB/YUV Input (Pad 0)->(Pad 0) Scaler */
 110         VIMC_ENT_LINK(6, 0, 7, 0, 0),
 111         /* Link: Scaler (Pad 1)->(Pad 0) RGB/YUV Capture */
 112         VIMC_ENT_LINK(7, 1, 8, 0, MEDIA_LNK_FL_ENABLED | MEDIA_LNK_FL_IMMUTABLE),
 113 };
 114
 115 static struct vimc_pipeline_config pipe_cfg = {
 116         .ents           = ent_config,
 117         .num_ents       = ARRAY_SIZE(ent_config),
 118         .links          = ent_links,
 119         .num_links      = ARRAY_SIZE(ent_links)
 120 };
 121
 122 /* -------------------------------------------------------------------------- */
 123
 124 static void vimc_rm_links(struct vimc_device *vimc)
 125 {
 126         unsigned int i;
 127
 128         for (i = 0; i < vimc->pipe_cfg->num_ents; i++)
 129                 media_entity_remove_links(vimc->ent_devs[i]->ent);
 130 }
 131
 132 static int vimc_create_links(struct vimc_device *vimc)
 133 {
 134         unsigned int i;
 135         int ret;
 136
 137         /* Initialize the links between entities */
 138         for (i = 0; i < vimc->pipe_cfg->num_links; i++) {
 139                 const struct vimc_ent_link *link = &vimc->pipe_cfg->links[i];
 140
 141                 struct vimc_ent_device *ved_src =
 142                         vimc->ent_devs[link->src_ent];
 143                 struct vimc_ent_device *ved_sink =
 144                         vimc->ent_devs[link->sink_ent];
 145
 146                 ret = media_create_pad_link(ved_src->ent, link->src_pad,
 147                                             ved_sink->ent, link->sink_pad,
 148                                             link->flags);
 149                 if (ret)
 150                         goto err_rm_links;
 151         }
 152
 153         return 0;
 154
 155 err_rm_links:
 156         vimc_rm_links(vimc);
 157         return ret;
 158 }
 159
 160 static int vimc_add_subdevs(struct vimc_device *vimc)
 161 {
 162         unsigned int i;
 163
 164         for (i = 0; i < vimc->pipe_cfg->num_ents; i++) {
 165                 dev_dbg(&vimc->pdev.dev, "new entity for %s\n",
 166                         vimc->pipe_cfg->ents[i].name);
 167                 vimc->ent_devs[i] = vimc->pipe_cfg->ents[i].add(vimc,
 168                                         vimc->pipe_cfg->ents[i].name);
 169                 if (!vimc->ent_devs[i]) {
 170                         dev_err(&vimc->pdev.dev, "add new entity for %s\n",
 171                                 vimc->pipe_cfg->ents[i].name);
 172                         return -EINVAL;
 173                 }
 174         }
 175         return 0;
 176 }
 177
 178 static void vimc_rm_subdevs(struct vimc_device *vimc)
 179 {
 180         unsigned int i;
 181
 182         for (i = 0; i < vimc->pipe_cfg->num_ents; i++)
 183                 if (vimc->ent_devs[i])
 184                         vimc->pipe_cfg->ents[i].rm(vimc, vimc->ent_devs[i]);
 185 }
 186
 187 static int vimc_register_devices(struct vimc_device *vimc)
 188 {
 189         int ret;
 190
 191         /* Register the v4l2 struct */
 192         ret = v4l2_device_register(vimc->mdev.dev, &vimc->v4l2_dev);
 193         if (ret) {
 194                 dev_err(vimc->mdev.dev,
 195                         "v4l2 device register failed (err=%d)\n", ret);
 196                 return ret;
 197         }
 198
 199         /* allocate ent_devs */
 200         vimc->ent_devs = kcalloc(vimc->pipe_cfg->num_ents,
 201                                  sizeof(*vimc->ent_devs), GFP_KERNEL);
 202         if (!vimc->ent_devs) {
 203                 ret = -ENOMEM;
 204                 goto err_v4l2_unregister;
 205         }
 206
 207         /* Invoke entity config hooks to initialize and register subdevs */
 208         ret = vimc_add_subdevs(vimc);
 209         if (ret)
 210                 /* remove sundevs that got added */
 211                 goto err_rm_subdevs;
 212
 213         /* Initialize links */
 214         ret = vimc_create_links(vimc);
 215         if (ret)
 216                 goto err_rm_subdevs;
 217
 218         /* Register the media device */
 219         ret = media_device_register(&vimc->mdev);
 220         if (ret) {
 221                 dev_err(vimc->mdev.dev,
 222                         "media device register failed (err=%d)\n", ret);
 223                 goto err_rm_subdevs;
 224         }
 225
 226         /* Expose all subdev's nodes*/
 227         ret = v4l2_device_register_subdev_nodes(&vimc->v4l2_dev);
 228         if (ret) {
 229                 dev_err(vimc->mdev.dev,
 230                         "vimc subdev nodes registration failed (err=%d)\n",
 231                         ret);
 232                 goto err_mdev_unregister;
 233         }
 234
 235         return 0;
 236
 237 err_mdev_unregister:
 238         media_device_unregister(&vimc->mdev);
 239         media_device_cleanup(&vimc->mdev);
 240 err_rm_subdevs:
 241         vimc_rm_subdevs(vimc);
 242         kfree(vimc->ent_devs);
 243 err_v4l2_unregister:
 244         v4l2_device_unregister(&vimc->v4l2_dev);
 245
 246         return ret;
 247 }
 248
 249 static void vimc_unregister(struct vimc_device *vimc)
 250 {
 251         media_device_unregister(&vimc->mdev);
 252         media_device_cleanup(&vimc->mdev);
 253         v4l2_device_unregister(&vimc->v4l2_dev);
 254         kfree(vimc->ent_devs);
 255 }
 256
 257 static int vimc_probe(struct platform_device *pdev)
 258 {
 259         struct vimc_device *vimc = container_of(pdev, struct vimc_device, pdev);
 260         int ret;
 261
 262         dev_dbg(&pdev->dev, "probe");
 263
 264         memset(&vimc->mdev, 0, sizeof(vimc->mdev));
 265
 266         /* Link the media device within the v4l2_device */
 267         vimc->v4l2_dev.mdev = &vimc->mdev;
 268
 269         /* Initialize media device */
 270         strscpy(vimc->mdev.model, VIMC_MDEV_MODEL_NAME,
 271                 sizeof(vimc->mdev.model));
 272         snprintf(vimc->mdev.bus_info, sizeof(vimc->mdev.bus_info),
 273                  "platform:%s", VIMC_PDEV_NAME);
 274         vimc->mdev.dev = &pdev->dev;
 275         media_device_init(&vimc->mdev);
 276
 277         ret = vimc_register_devices(vimc);
 278         if (ret) {
 279                 media_device_cleanup(&vimc->mdev);
 280                 return ret;
 281         }
 282
 283         return 0;
 284 }
 285
 286 static int vimc_remove(struct platform_device *pdev)
 287 {
 288         struct vimc_device *vimc = container_of(pdev, struct vimc_device, pdev);
 289
 290         dev_dbg(&pdev->dev, "remove");
 291
 292         vimc_rm_subdevs(vimc);
 293         vimc_unregister(vimc);
 294
 295         return 0;
 296 }
 297
 298 static void vimc_dev_release(struct device *dev)
 299 {
 300 }
 301
 302 static struct vimc_device vimc_dev = {
 303         .pipe_cfg = &pipe_cfg,
 304         .pdev = {
 305                 .name = VIMC_PDEV_NAME,
 306                 .dev.release = vimc_dev_release,
 307         }
 308 };
 309
 310 static struct platform_driver vimc_pdrv = {
 311         .probe          = vimc_probe,
 312         .remove         = vimc_remove,
 313         .driver         = {
 314                 .name   = VIMC_PDEV_NAME,
 315         },
 316 };
 317
 318 static int __init vimc_init(void)
 319 {
 320         int ret;
 321
 322         ret = platform_device_register(&vimc_dev.pdev);
 323         if (ret) {
 324                 dev_err(&vimc_dev.pdev.dev,
 325                         "platform device registration failed (err=%d)\n", ret);
 326                 return ret;
 327         }
 328
 329         ret = platform_driver_register(&vimc_pdrv);
 330         if (ret) {
 331                 dev_err(&vimc_dev.pdev.dev,
 332                         "platform driver registration failed (err=%d)\n", ret);
 333                 platform_driver_unregister(&vimc_pdrv);
 334                 return ret;
 335         }
 336
 337         return 0;
 338 }
 339
 340 static void __exit vimc_exit(void)
 341 {
 342         platform_driver_unregister(&vimc_pdrv);
 343
 344         platform_device_unregister(&vimc_dev.pdev);
 345 }
 346
 347 module_init(vimc_init);
 348 module_exit(vimc_exit);
 349
 350 MODULE_DESCRIPTION("Virtual Media Controller Driver (VIMC)");
 351 MODULE_AUTHOR("Helen Fornazier <helen.fornazier@gmail.com>");
 352 MODULE_LICENSE("GPL");