drivers/fpga/fpga-region.c

   1 /*
   2  * FPGA Region - Device Tree support for FPGA programming under Linux
   3  *
   4  *  Copyright (C) 2013-2016 Altera Corporation
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along with
  16  * this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include <linux/fpga/fpga-bridge.h>
  20 #include <linux/fpga/fpga-mgr.h>
  21 #include <linux/idr.h>
  22 #include <linux/kernel.h>
  23 #include <linux/list.h>
  24 #include <linux/module.h>
  25 #include <linux/of_platform.h>
  26 #include <linux/slab.h>
  27 #include <linux/spinlock.h>
  28
  29 /**
  30  * struct fpga_region - FPGA Region structure
  31  * @dev: FPGA Region device
  32  * @mutex: enforces exclusive reference to region
  33  * @bridge_list: list of FPGA bridges specified in region
  34  * @mgr: FPGA manager
  35  * @info: fpga image specific information
  36  */
  37 struct fpga_region {
  38         struct device dev;
  39         struct mutex mutex; /* for exclusive reference to region */
  40         struct list_head bridge_list;
  41         struct fpga_manager *mgr;
  42         struct fpga_image_info *info;
  43 };
  44
  45 #define to_fpga_region(d) container_of(d, struct fpga_region, dev)
  46
  47 static DEFINE_IDA(fpga_region_ida);
  48 static struct class *fpga_region_class;
  49
  50 static const struct of_device_id fpga_region_of_match[] = {
  51         { .compatible = "fpga-region", },
  52         {},
  53 };
  54 MODULE_DEVICE_TABLE(of, fpga_region_of_match);
  55
  56 static int fpga_region_of_node_match(struct device *dev, const void *data)
  57 {
  58         return dev->of_node == data;
  59 }
  60
  61 /**
  62  * fpga_region_find - find FPGA region
  63  * @np: device node of FPGA Region
  64  * Caller will need to put_device(&region->dev) when done.
  65  * Returns FPGA Region struct or NULL
  66  */
  67 static struct fpga_region *fpga_region_find(struct device_node *np)
  68 {
  69         struct device *dev;
  70
  71         dev = class_find_device(fpga_region_class, NULL, np,
  72                                 fpga_region_of_node_match);
  73         if (!dev)
  74                 return NULL;
  75
  76         return to_fpga_region(dev);
  77 }
  78
  79 /**
  80  * fpga_region_get - get an exclusive reference to a fpga region
  81  * @region: FPGA Region struct
  82  *
  83  * Caller should call fpga_region_put() when done with region.
  84  *
  85  * Return fpga_region struct if successful.
  86  * Return -EBUSY if someone already has a reference to the region.
  87  * Return -ENODEV if @np is not a FPGA Region.
  88  */
  89 static struct fpga_region *fpga_region_get(struct fpga_region *region)
  90 {
  91         struct device *dev = &region->dev;
  92
  93         if (!mutex_trylock(&region->mutex)) {
  94                 dev_dbg(dev, "%s: FPGA Region already in use\n", __func__);
  95                 return ERR_PTR(-EBUSY);
  96         }
  97
  98         get_device(dev);
  99         if (!try_module_get(dev->parent->driver->owner)) {
 100                 put_device(dev);
 101                 mutex_unlock(&region->mutex);
 102                 return ERR_PTR(-ENODEV);
 103         }
 104
 105         dev_dbg(dev, "get\n");
 106
 107         return region;
 108 }
 109
 110 /**
 111  * fpga_region_put - release a reference to a region
 112  *
 113  * @region: FPGA region
 114  */
 115 static void fpga_region_put(struct fpga_region *region)
 116 {
 117         struct device *dev = &region->dev;
 118
 119         dev_dbg(dev, "put\n");
 120
 121         module_put(dev->parent->driver->owner);
 122         put_device(dev);
 123         mutex_unlock(&region->mutex);
 124 }
 125
 126 /**
 127  * fpga_region_get_manager - get reference for FPGA manager
 128  * @np: device node of FPGA region
 129  *
 130  * Get FPGA Manager from "fpga-mgr" property or from ancestor region.
 131  *
 132  * Caller should call fpga_mgr_put() when done with manager.
 133  *
 134  * Return: fpga manager struct or IS_ERR() condition containing error code.
 135  */
 136 static struct fpga_manager *fpga_region_get_manager(struct device_node *np)
 137 {
 138         struct device_node  *mgr_node;
 139         struct fpga_manager *mgr;
 140
 141         of_node_get(np);
 142         while (np) {
 143                 if (of_device_is_compatible(np, "fpga-region")) {
 144                         mgr_node = of_parse_phandle(np, "fpga-mgr", 0);
 145                         if (mgr_node) {
 146                                 mgr = of_fpga_mgr_get(mgr_node);
 147                                 of_node_put(np);
 148                                 return mgr;
 149                         }
 150                 }
 151                 np = of_get_next_parent(np);
 152         }
 153         of_node_put(np);
 154
 155         return ERR_PTR(-EINVAL);
 156 }
 157
 158 /**
 159  * fpga_region_get_bridges - create a list of bridges
 160  * @region: FPGA region
 161  * @overlay: device node of the overlay
 162  *
 163  * Create a list of bridges including the parent bridge and the bridges
 164  * specified by "fpga-bridges" property.  Note that the
 165  * fpga_bridges_enable/disable/put functions are all fine with an empty list
 166  * if that happens.
 167  *
 168  * Caller should call fpga_bridges_put(&region->bridge_list) when
 169  * done with the bridges.
 170  *
 171  * Return 0 for success (even if there are no bridges specified)
 172  * or -EBUSY if any of the bridges are in use.
 173  */
 174 static int fpga_region_get_bridges(struct fpga_region *region,
 175                                    struct device_node *overlay)
 176 {
 177         struct device *dev = &region->dev;
 178         struct device_node *region_np = dev->of_node;
 179         struct device_node *br, *np, *parent_br = NULL;
 180         int i, ret;
 181
 182         /* If parent is a bridge, add to list */
 183         ret = of_fpga_bridge_get_to_list(region_np->parent, region->info,
 184                                          &region->bridge_list);
 185
 186         /* -EBUSY means parent is a bridge that is under use. Give up. */
 187         if (ret == -EBUSY)
 188                 return ret;
 189
 190         /* Zero return code means parent was a bridge and was added to list. */
 191         if (!ret)
 192                 parent_br = region_np->parent;
 193
 194         /* If overlay has a list of bridges, use it. */
 195         if (of_parse_phandle(overlay, "fpga-bridges", 0))
 196                 np = overlay;
 197         else
 198                 np = region_np;
 199
 200         for (i = 0; ; i++) {
 201                 br = of_parse_phandle(np, "fpga-bridges", i);
 202                 if (!br)
 203                         break;
 204
 205                 /* If parent bridge is in list, skip it. */
 206                 if (br == parent_br)
 207                         continue;
 208
 209                 /* If node is a bridge, get it and add to list */
 210                 ret = of_fpga_bridge_get_to_list(br, region->info,
 211                                                  &region->bridge_list);
 212
 213                 /* If any of the bridges are in use, give up */
 214                 if (ret == -EBUSY) {
 215                         fpga_bridges_put(&region->bridge_list);
 216                         return -EBUSY;
 217                 }
 218         }
 219
 220         return 0;
 221 }
 222
 223 /**
 224  * fpga_region_program_fpga - program FPGA
 225  * @region: FPGA region
 226  * @overlay: device node of the overlay
 227  * Program an FPGA using information in the region's fpga image info.
 228  * Return 0 for success or negative error code.
 229  */
 230 static int fpga_region_program_fpga(struct fpga_region *region,
 231                                     struct device_node *overlay)
 232 {
 233         struct device *dev = &region->dev;
 234         int ret;
 235
 236         region = fpga_region_get(region);
 237         if (IS_ERR(region)) {
 238                 dev_err(dev, "failed to get FPGA region\n");
 239                 return PTR_ERR(region);
 240         }
 241
 242         ret = fpga_mgr_lock(region->mgr);
 243         if (ret) {
 244                 dev_err(dev, "FPGA manager is busy\n");
 245                 goto err_put_region;
 246         }
 247
 248         ret = fpga_region_get_bridges(region, overlay);
 249         if (ret) {
 250                 dev_err(dev, "failed to get FPGA bridges\n");
 251                 goto err_unlock_mgr;
 252         }
 253
 254         ret = fpga_bridges_disable(&region->bridge_list);
 255         if (ret) {
 256                 dev_err(dev, "failed to disable bridges\n");
 257                 goto err_put_br;
 258         }
 259
 260         ret = fpga_mgr_load(region->mgr, region->info);
 261         if (ret) {
 262                 dev_err(dev, "failed to load FPGA image\n");
 263                 goto err_put_br;
 264         }
 265
 266         ret = fpga_bridges_enable(&region->bridge_list);
 267         if (ret) {
 268                 dev_err(dev, "failed to enable region bridges\n");
 269                 goto err_put_br;
 270         }
 271
 272         fpga_mgr_unlock(region->mgr);
 273         fpga_region_put(region);
 274
 275         return 0;
 276
 277 err_put_br:
 278         fpga_bridges_put(&region->bridge_list);
 279 err_unlock_mgr:
 280         fpga_mgr_unlock(region->mgr);
 281 err_put_region:
 282         fpga_region_put(region);
 283
 284         return ret;
 285 }
 286
 287 /**
 288  * child_regions_with_firmware
 289  * @overlay: device node of the overlay
 290  *
 291  * If the overlay adds child FPGA regions, they are not allowed to have
 292  * firmware-name property.
 293  *
 294  * Return 0 for OK or -EINVAL if child FPGA region adds firmware-name.
 295  */
 296 static int child_regions_with_firmware(struct device_node *overlay)
 297 {
 298         struct device_node *child_region;
 299         const char *child_firmware_name;
 300         int ret = 0;
 301
 302         of_node_get(overlay);
 303
 304         child_region = of_find_matching_node(overlay, fpga_region_of_match);
 305         while (child_region) {
 306                 if (!of_property_read_string(child_region, "firmware-name",
 307                                              &child_firmware_name)) {
 308                         ret = -EINVAL;
 309                         break;
 310                 }
 311                 child_region = of_find_matching_node(child_region,
 312                                                      fpga_region_of_match);
 313         }
 314
 315         of_node_put(child_region);
 316
 317         if (ret)
 318                 pr_err("firmware-name not allowed in child FPGA region: %pOF",
 319                        child_region);
 320
 321         return ret;
 322 }
 323
 324 /**
 325  * fpga_region_notify_pre_apply - pre-apply overlay notification
 326  *
 327  * @region: FPGA region that the overlay was applied to
 328  * @nd: overlay notification data
 329  *
 330  * Called after when an overlay targeted to a FPGA Region is about to be
 331  * applied.  Function will check the properties that will be added to the FPGA
 332  * region.  If the checks pass, it will program the FPGA.
 333  *
 334  * The checks are:
 335  * The overlay must add either firmware-name or external-fpga-config property
 336  * to the FPGA Region.
 337  *
 338  *   firmware-name         : program the FPGA
 339  *   external-fpga-config  : FPGA is already programmed
 340  *   encrypted-fpga-config : FPGA bitstream is encrypted
 341  *
 342  * The overlay can add other FPGA regions, but child FPGA regions cannot have a
 343  * firmware-name property since those regions don't exist yet.
 344  *
 345  * If the overlay that breaks the rules, notifier returns an error and the
 346  * overlay is rejected before it goes into the main tree.
 347  *
 348  * Returns 0 for success or negative error code for failure.
 349  */
 350 static int fpga_region_notify_pre_apply(struct fpga_region *region,
 351                                         struct of_overlay_notify_data *nd)
 352 {
 353         struct device *dev = &region->dev;
 354         struct fpga_image_info *info;
 355         const char *firmware_name;
 356         int ret;
 357
 358         /*
 359          * Reject overlay if child FPGA Regions added in the overlay have
 360          * firmware-name property (would mean that an FPGA region that has
 361          * not been added to the live tree yet is doing FPGA programming).
 362          */
 363         ret = child_regions_with_firmware(nd->overlay);
 364         if (ret)
 365                 return ret;
 366
 367         info = fpga_image_info_alloc(dev);
 368         if (!info)
 369                 return -ENOMEM;
 370
 371         /* Read FPGA region properties from the overlay */
 372         if (of_property_read_bool(nd->overlay, "partial-fpga-config"))
 373                 info->flags |= FPGA_MGR_PARTIAL_RECONFIG;
 374
 375         if (of_property_read_bool(nd->overlay, "external-fpga-config"))
 376                 info->flags |= FPGA_MGR_EXTERNAL_CONFIG;
 377
 378         if (of_property_read_bool(nd->overlay, "encrypted-fpga-config"))
 379                 info->flags |= FPGA_MGR_ENCRYPTED_BITSTREAM;
 380
 381         if (!of_property_read_string(nd->overlay, "firmware-name",
 382                                      &firmware_name)) {
 383                 info->firmware_name = devm_kstrdup(dev, firmware_name,
 384                                                    GFP_KERNEL);
 385                 if (!info->firmware_name)
 386                         return -ENOMEM;
 387         }
 388
 389         of_property_read_u32(nd->overlay, "region-unfreeze-timeout-us",
 390                              &info->enable_timeout_us);
 391
 392         of_property_read_u32(nd->overlay, "region-freeze-timeout-us",
 393                              &info->disable_timeout_us);
 394
 395         of_property_read_u32(nd->overlay, "config-complete-timeout-us",
 396                              &info->config_complete_timeout_us);
 397
 398         /* If FPGA was externally programmed, don't specify firmware */
 399         if ((info->flags & FPGA_MGR_EXTERNAL_CONFIG) && info->firmware_name) {
 400                 dev_err(dev, "error: specified firmware and external-fpga-config");
 401                 fpga_image_info_free(info);
 402                 return -EINVAL;
 403         }
 404
 405         /* FPGA is already configured externally.  We're done. */
 406         if (info->flags & FPGA_MGR_EXTERNAL_CONFIG) {
 407                 fpga_image_info_free(info);
 408                 return 0;
 409         }
 410
 411         /* If we got this far, we should be programming the FPGA */
 412         if (!info->firmware_name) {
 413                 dev_err(dev, "should specify firmware-name or external-fpga-config\n");
 414                 fpga_image_info_free(info);
 415                 return -EINVAL;
 416         }
 417
 418         region->info = info;
 419         ret = fpga_region_program_fpga(region, nd->overlay);
 420         if (ret) {
 421                 fpga_image_info_free(info);
 422                 region->info = NULL;
 423         }
 424
 425         return ret;
 426 }
 427
 428 /**
 429  * fpga_region_notify_post_remove - post-remove overlay notification
 430  *
 431  * @region: FPGA region that was targeted by the overlay that was removed
 432  * @nd: overlay notification data
 433  *
 434  * Called after an overlay has been removed if the overlay's target was a
 435  * FPGA region.
 436  */
 437 static void fpga_region_notify_post_remove(struct fpga_region *region,
 438                                            struct of_overlay_notify_data *nd)
 439 {
 440         fpga_bridges_disable(&region->bridge_list);
 441         fpga_bridges_put(&region->bridge_list);
 442         fpga_image_info_free(region->info);
 443         region->info = NULL;
 444 }
 445
 446 /**
 447  * of_fpga_region_notify - reconfig notifier for dynamic DT changes
 448  * @nb:         notifier block
 449  * @action:     notifier action
 450  * @arg:        reconfig data
 451  *
 452  * This notifier handles programming a FPGA when a "firmware-name" property is
 453  * added to a fpga-region.
 454  *
 455  * Returns NOTIFY_OK or error if FPGA programming fails.
 456  */
 457 static int of_fpga_region_notify(struct notifier_block *nb,
 458                                  unsigned long action, void *arg)
 459 {
 460         struct of_overlay_notify_data *nd = arg;
 461         struct fpga_region *region;
 462         int ret;
 463
 464         switch (action) {
 465         case OF_OVERLAY_PRE_APPLY:
 466                 pr_debug("%s OF_OVERLAY_PRE_APPLY\n", __func__);
 467                 break;
 468         case OF_OVERLAY_POST_APPLY:
 469                 pr_debug("%s OF_OVERLAY_POST_APPLY\n", __func__);
 470                 return NOTIFY_OK;       /* not for us */
 471         case OF_OVERLAY_PRE_REMOVE:
 472                 pr_debug("%s OF_OVERLAY_PRE_REMOVE\n", __func__);
 473                 return NOTIFY_OK;       /* not for us */
 474         case OF_OVERLAY_POST_REMOVE:
 475                 pr_debug("%s OF_OVERLAY_POST_REMOVE\n", __func__);
 476                 break;
 477         default:                        /* should not happen */
 478                 return NOTIFY_OK;
 479         }
 480
 481         region = fpga_region_find(nd->target);
 482         if (!region)
 483                 return NOTIFY_OK;
 484
 485         ret = 0;
 486         switch (action) {
 487         case OF_OVERLAY_PRE_APPLY:
 488                 ret = fpga_region_notify_pre_apply(region, nd);
 489                 break;
 490
 491         case OF_OVERLAY_POST_REMOVE:
 492                 fpga_region_notify_post_remove(region, nd);
 493                 break;
 494         }
 495
 496         put_device(&region->dev);
 497
 498         if (ret)
 499                 return notifier_from_errno(ret);
 500
 501         return NOTIFY_OK;
 502 }
 503
 504 static struct notifier_block fpga_region_of_nb = {
 505         .notifier_call = of_fpga_region_notify,
 506 };
 507
 508 static int fpga_region_probe(struct platform_device *pdev)
 509 {
 510         struct device *dev = &pdev->dev;
 511         struct device_node *np = dev->of_node;
 512         struct fpga_region *region;
 513         struct fpga_manager *mgr;
 514         int id, ret = 0;
 515
 516         mgr = fpga_region_get_manager(np);
 517         if (IS_ERR(mgr))
 518                 return -EPROBE_DEFER;
 519
 520         region = kzalloc(sizeof(*region), GFP_KERNEL);
 521         if (!region) {
 522                 ret = -ENOMEM;
 523                 goto err_put_mgr;
 524         }
 525
 526         region->mgr = mgr;
 527
 528         id = ida_simple_get(&fpga_region_ida, 0, 0, GFP_KERNEL);
 529         if (id < 0) {
 530                 ret = id;
 531                 goto err_kfree;
 532         }
 533
 534         mutex_init(&region->mutex);
 535         INIT_LIST_HEAD(&region->bridge_list);
 536
 537         device_initialize(&region->dev);
 538         region->dev.class = fpga_region_class;
 539         region->dev.parent = dev;
 540         region->dev.of_node = np;
 541         region->dev.id = id;
 542         dev_set_drvdata(dev, region);
 543
 544         ret = dev_set_name(&region->dev, "region%d", id);
 545         if (ret)
 546                 goto err_remove;
 547
 548         ret = device_add(&region->dev);
 549         if (ret)
 550                 goto err_remove;
 551
 552         of_platform_populate(np, fpga_region_of_match, NULL, &region->dev);
 553
 554         dev_info(dev, "FPGA Region probed\n");
 555
 556         return 0;
 557
 558 err_remove:
 559         ida_simple_remove(&fpga_region_ida, id);
 560 err_kfree:
 561         kfree(region);
 562 err_put_mgr:
 563         fpga_mgr_put(mgr);
 564
 565         return ret;
 566 }
 567
 568 static int fpga_region_remove(struct platform_device *pdev)
 569 {
 570         struct fpga_region *region = platform_get_drvdata(pdev);
 571
 572         device_unregister(&region->dev);
 573         fpga_mgr_put(region->mgr);
 574
 575         return 0;
 576 }
 577
 578 static struct platform_driver fpga_region_driver = {
 579         .probe = fpga_region_probe,
 580         .remove = fpga_region_remove,
 581         .driver = {
 582                 .name   = "fpga-region",
 583                 .of_match_table = of_match_ptr(fpga_region_of_match),
 584         },
 585 };
 586
 587 static void fpga_region_dev_release(struct device *dev)
 588 {
 589         struct fpga_region *region = to_fpga_region(dev);
 590
 591         ida_simple_remove(&fpga_region_ida, region->dev.id);
 592         kfree(region);
 593 }
 594
 595 /**
 596  * fpga_region_init - init function for fpga_region class
 597  * Creates the fpga_region class and registers a reconfig notifier.
 598  */
 599 static int __init fpga_region_init(void)
 600 {
 601         int ret;
 602
 603         fpga_region_class = class_create(THIS_MODULE, "fpga_region");
 604         if (IS_ERR(fpga_region_class))
 605                 return PTR_ERR(fpga_region_class);
 606
 607         fpga_region_class->dev_release = fpga_region_dev_release;
 608
 609         ret = of_overlay_notifier_register(&fpga_region_of_nb);
 610         if (ret)
 611                 goto err_class;
 612
 613         ret = platform_driver_register(&fpga_region_driver);
 614         if (ret)
 615                 goto err_plat;
 616
 617         return 0;
 618
 619 err_plat:
 620         of_overlay_notifier_unregister(&fpga_region_of_nb);
 621 err_class:
 622         class_destroy(fpga_region_class);
 623         ida_destroy(&fpga_region_ida);
 624         return ret;
 625 }
 626
 627 static void __exit fpga_region_exit(void)
 628 {
 629         platform_driver_unregister(&fpga_region_driver);
 630         of_overlay_notifier_unregister(&fpga_region_of_nb);
 631         class_destroy(fpga_region_class);
 632         ida_destroy(&fpga_region_ida);
 633 }
 634
 635 subsys_initcall(fpga_region_init);
 636 module_exit(fpga_region_exit);
 637
 638 MODULE_DESCRIPTION("FPGA Region");
 639 MODULE_AUTHOR("Alan Tull <[email protected]>");
 640 MODULE_LICENSE("GPL v2");