2 * Freescale Management Complex (MC) bus driver
4 * Copyright (C) 2014 Freescale Semiconductor, Inc.
5 * Author: German Rivera <German.Rivera@freescale.com>
7 * This file is licensed under the terms of the GNU General Public
8 * License version 2. This program is licensed "as is" without any
9 * warranty of any kind, whether express or implied.
12 #include <linux/module.h>
13 #include <linux/of_device.h>
14 #include <linux/of_address.h>
15 #include <linux/ioport.h>
16 #include <linux/slab.h>
17 #include <linux/limits.h>
18 #include <linux/bitops.h>
19 #include <linux/msi.h>
20 #include <linux/dma-mapping.h>
21 #include "../include/mc-bus.h"
22 #include "../include/dpmng.h"
23 #include "../include/mc-sys.h"
25 #include "fsl-mc-private.h"
28 static struct kmem_cache *mc_dev_cache;
31 * Default DMA mask for devices on a fsl-mc bus
33 #define FSL_MC_DEFAULT_DMA_MASK (~0ULL)
36 * struct fsl_mc - Private data of a "fsl,qoriq-mc" platform device
37 * @root_mc_bus_dev: MC object device representing the root DPRC
38 * @num_translation_ranges: number of entries in addr_translation_ranges
39 * @translation_ranges: array of bus to system address translation ranges
42 struct fsl_mc_device *root_mc_bus_dev;
43 u8 num_translation_ranges;
44 struct fsl_mc_addr_translation_range *translation_ranges;
48 * struct fsl_mc_addr_translation_range - bus to system address translation
50 * @mc_region_type: Type of MC region for the range being translated
51 * @start_mc_offset: Start MC offset of the range being translated
52 * @end_mc_offset: MC offset of the first byte after the range (last MC
53 * offset of the range is end_mc_offset - 1)
54 * @start_phys_addr: system physical address corresponding to start_mc_addr
56 struct fsl_mc_addr_translation_range {
57 enum dprc_region_type mc_region_type;
60 phys_addr_t start_phys_addr;
64 * fsl_mc_bus_match - device to driver matching callback
65 * @dev: the MC object device structure to match against
66 * @drv: the device driver to search for matching MC object device id
69 * Returns 1 on success, 0 otherwise.
71 static int fsl_mc_bus_match(struct device *dev, struct device_driver *drv)
73 const struct fsl_mc_device_id *id;
74 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
75 struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(drv);
78 if (WARN_ON(!fsl_mc_bus_exists()))
81 if (!mc_drv->match_id_table)
85 * If the object is not 'plugged' don't match.
86 * Only exception is the root DPRC, which is a special case.
88 if ((mc_dev->obj_desc.state & DPRC_OBJ_STATE_PLUGGED) == 0 &&
89 !fsl_mc_is_root_dprc(&mc_dev->dev))
93 * Traverse the match_id table of the given driver, trying to find
94 * a matching for the given MC object device.
96 for (id = mc_drv->match_id_table; id->vendor != 0x0; id++) {
97 if (id->vendor == mc_dev->obj_desc.vendor &&
98 strcmp(id->obj_type, mc_dev->obj_desc.type) == 0) {
106 dev_dbg(dev, "%smatched\n", found ? "" : "not ");
111 * fsl_mc_bus_uevent - callback invoked when a device is added
113 static int fsl_mc_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
115 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
117 if (add_uevent_var(env, "MODALIAS=fsl-mc:v%08Xd%s",
118 mc_dev->obj_desc.vendor,
119 mc_dev->obj_desc.type))
125 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
128 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
130 return sprintf(buf, "fsl-mc:v%08Xd%s\n", mc_dev->obj_desc.vendor,
131 mc_dev->obj_desc.type);
133 static DEVICE_ATTR_RO(modalias);
135 static struct attribute *fsl_mc_dev_attrs[] = {
136 &dev_attr_modalias.attr,
140 ATTRIBUTE_GROUPS(fsl_mc_dev);
142 struct bus_type fsl_mc_bus_type = {
144 .match = fsl_mc_bus_match,
145 .uevent = fsl_mc_bus_uevent,
146 .dev_groups = fsl_mc_dev_groups,
148 EXPORT_SYMBOL_GPL(fsl_mc_bus_type);
150 static atomic_t root_dprc_count = ATOMIC_INIT(0);
152 static int fsl_mc_driver_probe(struct device *dev)
154 struct fsl_mc_driver *mc_drv;
155 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
158 if (WARN_ON(!dev->driver))
161 mc_drv = to_fsl_mc_driver(dev->driver);
162 if (WARN_ON(!mc_drv->probe))
165 error = mc_drv->probe(mc_dev);
167 dev_err(dev, "MC object device probe callback failed: %d\n",
175 static int fsl_mc_driver_remove(struct device *dev)
177 struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(dev->driver);
178 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
181 if (WARN_ON(!dev->driver))
184 error = mc_drv->remove(mc_dev);
187 "MC object device remove callback failed: %d\n",
195 static void fsl_mc_driver_shutdown(struct device *dev)
197 struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(dev->driver);
198 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
200 mc_drv->shutdown(mc_dev);
204 * __fsl_mc_driver_register - registers a child device driver with the
207 * This function is implicitly invoked from the registration function of
208 * fsl_mc device drivers, which is generated by the
209 * module_fsl_mc_driver() macro.
211 int __fsl_mc_driver_register(struct fsl_mc_driver *mc_driver,
212 struct module *owner)
216 mc_driver->driver.owner = owner;
217 mc_driver->driver.bus = &fsl_mc_bus_type;
219 if (mc_driver->probe)
220 mc_driver->driver.probe = fsl_mc_driver_probe;
222 if (mc_driver->remove)
223 mc_driver->driver.remove = fsl_mc_driver_remove;
225 if (mc_driver->shutdown)
226 mc_driver->driver.shutdown = fsl_mc_driver_shutdown;
228 error = driver_register(&mc_driver->driver);
230 pr_err("driver_register() failed for %s: %d\n",
231 mc_driver->driver.name, error);
235 pr_info("MC object device driver %s registered\n",
236 mc_driver->driver.name);
239 EXPORT_SYMBOL_GPL(__fsl_mc_driver_register);
242 * fsl_mc_driver_unregister - unregisters a device driver from the
245 void fsl_mc_driver_unregister(struct fsl_mc_driver *mc_driver)
247 driver_unregister(&mc_driver->driver);
249 EXPORT_SYMBOL_GPL(fsl_mc_driver_unregister);
252 * fsl_mc_bus_exists - check if a root dprc exists
254 bool fsl_mc_bus_exists(void)
256 return atomic_read(&root_dprc_count) > 0;
258 EXPORT_SYMBOL_GPL(fsl_mc_bus_exists);
261 * fsl_mc_get_root_dprc - function to traverse to the root dprc
263 void fsl_mc_get_root_dprc(struct device *dev,
264 struct device **root_dprc_dev)
267 *root_dprc_dev = NULL;
268 } else if (WARN_ON(!dev_is_fsl_mc(dev))) {
269 *root_dprc_dev = NULL;
271 *root_dprc_dev = dev;
272 while (dev_is_fsl_mc((*root_dprc_dev)->parent))
273 *root_dprc_dev = (*root_dprc_dev)->parent;
276 EXPORT_SYMBOL_GPL(fsl_mc_get_root_dprc);
278 static int get_dprc_attr(struct fsl_mc_io *mc_io,
279 int container_id, struct dprc_attributes *attr)
284 error = dprc_open(mc_io, 0, container_id, &dprc_handle);
286 dev_err(mc_io->dev, "dprc_open() failed: %d\n", error);
290 memset(attr, 0, sizeof(struct dprc_attributes));
291 error = dprc_get_attributes(mc_io, 0, dprc_handle, attr);
293 dev_err(mc_io->dev, "dprc_get_attributes() failed: %d\n",
301 (void)dprc_close(mc_io, 0, dprc_handle);
305 static int get_dprc_icid(struct fsl_mc_io *mc_io,
306 int container_id, u16 *icid)
308 struct dprc_attributes attr;
311 error = get_dprc_attr(mc_io, container_id, &attr);
318 static int get_dprc_version(struct fsl_mc_io *mc_io,
319 int container_id, u16 *major, u16 *minor)
321 struct dprc_attributes attr;
324 error = get_dprc_attr(mc_io, container_id, &attr);
326 *major = attr.version.major;
327 *minor = attr.version.minor;
333 static int translate_mc_addr(struct fsl_mc_device *mc_dev,
334 enum dprc_region_type mc_region_type,
335 u64 mc_offset, phys_addr_t *phys_addr)
338 struct device *root_dprc_dev;
341 fsl_mc_get_root_dprc(&mc_dev->dev, &root_dprc_dev);
342 if (WARN_ON(!root_dprc_dev))
344 mc = dev_get_drvdata(root_dprc_dev->parent);
346 if (mc->num_translation_ranges == 0) {
348 * Do identity mapping:
350 *phys_addr = mc_offset;
354 for (i = 0; i < mc->num_translation_ranges; i++) {
355 struct fsl_mc_addr_translation_range *range =
356 &mc->translation_ranges[i];
358 if (mc_region_type == range->mc_region_type &&
359 mc_offset >= range->start_mc_offset &&
360 mc_offset < range->end_mc_offset) {
361 *phys_addr = range->start_phys_addr +
362 (mc_offset - range->start_mc_offset);
370 static int fsl_mc_device_get_mmio_regions(struct fsl_mc_device *mc_dev,
371 struct fsl_mc_device *mc_bus_dev)
375 struct resource *regions;
376 struct dprc_obj_desc *obj_desc = &mc_dev->obj_desc;
377 struct device *parent_dev = mc_dev->dev.parent;
378 enum dprc_region_type mc_region_type;
380 if (strcmp(obj_desc->type, "dprc") == 0 ||
381 strcmp(obj_desc->type, "dpmcp") == 0) {
382 mc_region_type = DPRC_REGION_TYPE_MC_PORTAL;
383 } else if (strcmp(obj_desc->type, "dpio") == 0) {
384 mc_region_type = DPRC_REGION_TYPE_QBMAN_PORTAL;
387 * This function should not have been called for this MC object
388 * type, as this object type is not supposed to have MMIO
395 regions = kmalloc_array(obj_desc->region_count,
396 sizeof(regions[0]), GFP_KERNEL);
400 for (i = 0; i < obj_desc->region_count; i++) {
401 struct dprc_region_desc region_desc;
403 error = dprc_get_obj_region(mc_bus_dev->mc_io,
405 mc_bus_dev->mc_handle,
407 obj_desc->id, i, ®ion_desc);
410 "dprc_get_obj_region() failed: %d\n", error);
411 goto error_cleanup_regions;
414 WARN_ON(region_desc.size == 0);
415 error = translate_mc_addr(mc_dev, mc_region_type,
416 region_desc.base_offset,
420 "Invalid MC offset: %#x (for %s.%d\'s region %d)\n",
421 region_desc.base_offset,
422 obj_desc->type, obj_desc->id, i);
423 goto error_cleanup_regions;
426 regions[i].end = regions[i].start + region_desc.size - 1;
427 regions[i].name = "fsl-mc object MMIO region";
428 regions[i].flags = IORESOURCE_IO;
429 if (region_desc.flags & DPRC_REGION_CACHEABLE)
430 regions[i].flags |= IORESOURCE_CACHEABLE;
433 mc_dev->regions = regions;
436 error_cleanup_regions:
442 * fsl_mc_is_root_dprc - function to check if a given device is a root dprc
444 bool fsl_mc_is_root_dprc(struct device *dev)
446 struct device *root_dprc_dev;
448 fsl_mc_get_root_dprc(dev, &root_dprc_dev);
451 return dev == root_dprc_dev;
455 * Add a newly discovered MC object device to be visible in Linux
457 int fsl_mc_device_add(struct dprc_obj_desc *obj_desc,
458 struct fsl_mc_io *mc_io,
459 struct device *parent_dev,
460 struct fsl_mc_device **new_mc_dev)
463 struct fsl_mc_device *mc_dev = NULL;
464 struct fsl_mc_bus *mc_bus = NULL;
465 struct fsl_mc_device *parent_mc_dev;
467 if (dev_is_fsl_mc(parent_dev))
468 parent_mc_dev = to_fsl_mc_device(parent_dev);
470 parent_mc_dev = NULL;
472 if (strcmp(obj_desc->type, "dprc") == 0) {
474 * Allocate an MC bus device object:
476 mc_bus = devm_kzalloc(parent_dev, sizeof(*mc_bus), GFP_KERNEL);
480 mc_dev = &mc_bus->mc_dev;
483 * Allocate a regular fsl_mc_device object:
485 mc_dev = kmem_cache_zalloc(mc_dev_cache, GFP_KERNEL);
490 mc_dev->obj_desc = *obj_desc;
491 mc_dev->mc_io = mc_io;
492 device_initialize(&mc_dev->dev);
493 mc_dev->dev.parent = parent_dev;
494 mc_dev->dev.bus = &fsl_mc_bus_type;
495 dev_set_name(&mc_dev->dev, "%s.%d", obj_desc->type, obj_desc->id);
497 if (strcmp(obj_desc->type, "dprc") == 0) {
498 struct fsl_mc_io *mc_io2;
500 mc_dev->flags |= FSL_MC_IS_DPRC;
503 * To get the DPRC's ICID, we need to open the DPRC
504 * in get_dprc_icid(). For child DPRCs, we do so using the
505 * parent DPRC's MC portal instead of the child DPRC's MC
506 * portal, in case the child DPRC is already opened with
507 * its own portal (e.g., the DPRC used by AIOP).
509 * NOTE: There cannot be more than one active open for a
510 * given MC object, using the same MC portal.
514 * device being added is a child DPRC device
516 mc_io2 = parent_mc_dev->mc_io;
519 * device being added is the root DPRC device
521 if (WARN_ON(!mc_io)) {
523 goto error_cleanup_dev;
528 atomic_inc(&root_dprc_count);
531 error = get_dprc_icid(mc_io2, obj_desc->id, &mc_dev->icid);
533 goto error_cleanup_dev;
536 * A non-DPRC MC object device has to be a child of another
537 * MC object (specifically a DPRC object)
539 mc_dev->icid = parent_mc_dev->icid;
540 mc_dev->dma_mask = FSL_MC_DEFAULT_DMA_MASK;
541 mc_dev->dev.dma_mask = &mc_dev->dma_mask;
542 dev_set_msi_domain(&mc_dev->dev,
543 dev_get_msi_domain(&parent_mc_dev->dev));
547 * Get MMIO regions for the device from the MC:
549 * NOTE: the root DPRC is a special case as its MMIO region is
550 * obtained from the device tree
552 if (parent_mc_dev && obj_desc->region_count != 0) {
553 error = fsl_mc_device_get_mmio_regions(mc_dev,
556 goto error_cleanup_dev;
559 /* Objects are coherent, unless 'no shareability' flag set. */
560 if (!(obj_desc->flags & DPRC_OBJ_FLAG_NO_MEM_SHAREABILITY))
561 arch_setup_dma_ops(&mc_dev->dev, 0, 0, NULL, true);
564 * The device-specific probe callback will get invoked by device_add()
566 error = device_add(&mc_dev->dev);
569 "device_add() failed for device %s: %d\n",
570 dev_name(&mc_dev->dev), error);
571 goto error_cleanup_dev;
574 (void)get_device(&mc_dev->dev);
575 dev_dbg(parent_dev, "Added MC object device %s\n",
576 dev_name(&mc_dev->dev));
578 *new_mc_dev = mc_dev;
582 kfree(mc_dev->regions);
584 devm_kfree(parent_dev, mc_bus);
586 kmem_cache_free(mc_dev_cache, mc_dev);
590 EXPORT_SYMBOL_GPL(fsl_mc_device_add);
593 * fsl_mc_device_remove - Remove a MC object device from being visible to
596 * @mc_dev: Pointer to a MC object device object
598 void fsl_mc_device_remove(struct fsl_mc_device *mc_dev)
600 struct fsl_mc_bus *mc_bus = NULL;
602 kfree(mc_dev->regions);
605 * The device-specific remove callback will get invoked by device_del()
607 device_del(&mc_dev->dev);
608 put_device(&mc_dev->dev);
610 if (strcmp(mc_dev->obj_desc.type, "dprc") == 0) {
611 mc_bus = to_fsl_mc_bus(mc_dev);
613 if (fsl_mc_is_root_dprc(&mc_dev->dev)) {
614 if (atomic_read(&root_dprc_count) > 0)
615 atomic_dec(&root_dprc_count);
622 devm_kfree(mc_dev->dev.parent, mc_bus);
624 kmem_cache_free(mc_dev_cache, mc_dev);
626 EXPORT_SYMBOL_GPL(fsl_mc_device_remove);
628 static int parse_mc_ranges(struct device *dev,
632 const __be32 **ranges_start,
636 int range_tuple_cell_count;
639 struct device_node *mc_node = dev->of_node;
641 *ranges_start = of_get_property(mc_node, "ranges", &ranges_len);
642 if (!(*ranges_start) || !ranges_len) {
644 "missing or empty ranges property for device tree node '%s'\n",
651 *paddr_cells = of_n_addr_cells(mc_node);
653 prop = of_get_property(mc_node, "#address-cells", NULL);
655 *mc_addr_cells = be32_to_cpup(prop);
657 *mc_addr_cells = *paddr_cells;
659 prop = of_get_property(mc_node, "#size-cells", NULL);
661 *mc_size_cells = be32_to_cpup(prop);
663 *mc_size_cells = of_n_size_cells(mc_node);
665 range_tuple_cell_count = *paddr_cells + *mc_addr_cells +
668 tuple_len = range_tuple_cell_count * sizeof(__be32);
669 if (ranges_len % tuple_len != 0) {
670 dev_err(dev, "malformed ranges property '%s'\n", mc_node->name);
674 *num_ranges = ranges_len / tuple_len;
678 static int get_mc_addr_translation_ranges(struct device *dev,
679 struct fsl_mc_addr_translation_range
688 const __be32 *ranges_start;
691 error = parse_mc_ranges(dev,
700 if (!(*num_ranges)) {
702 * Missing or empty ranges property ("ranges;") for the
703 * 'fsl,qoriq-mc' node. In this case, identity mapping
710 *ranges = devm_kcalloc(dev, *num_ranges,
711 sizeof(struct fsl_mc_addr_translation_range),
717 for (i = 0; i < *num_ranges; ++i) {
718 struct fsl_mc_addr_translation_range *range = &(*ranges)[i];
720 range->mc_region_type = of_read_number(cell, 1);
721 range->start_mc_offset = of_read_number(cell + 1,
723 cell += mc_addr_cells;
724 range->start_phys_addr = of_read_number(cell, paddr_cells);
726 range->end_mc_offset = range->start_mc_offset +
727 of_read_number(cell, mc_size_cells);
729 cell += mc_size_cells;
736 * fsl_mc_bus_probe - callback invoked when the root MC bus is being
739 static int fsl_mc_bus_probe(struct platform_device *pdev)
741 struct dprc_obj_desc obj_desc;
744 struct fsl_mc_device *mc_bus_dev = NULL;
745 struct fsl_mc_io *mc_io = NULL;
747 phys_addr_t mc_portal_phys_addr;
749 struct mc_version mc_version;
752 dev_info(&pdev->dev, "Root MC bus device probed");
754 mc = devm_kzalloc(&pdev->dev, sizeof(*mc), GFP_KERNEL);
758 platform_set_drvdata(pdev, mc);
761 * Get physical address of MC portal for the root DPRC:
763 error = of_address_to_resource(pdev->dev.of_node, 0, &res);
766 "of_address_to_resource() failed for %s\n",
767 pdev->dev.of_node->full_name);
771 mc_portal_phys_addr = res.start;
772 mc_portal_size = resource_size(&res);
773 error = fsl_create_mc_io(&pdev->dev, mc_portal_phys_addr,
774 mc_portal_size, NULL,
775 FSL_MC_IO_ATOMIC_CONTEXT_PORTAL, &mc_io);
779 error = mc_get_version(mc_io, 0, &mc_version);
782 "mc_get_version() failed with error %d\n", error);
783 goto error_cleanup_mc_io;
787 "Freescale Management Complex Firmware version: %u.%u.%u\n",
788 mc_version.major, mc_version.minor, mc_version.revision);
790 error = get_mc_addr_translation_ranges(&pdev->dev,
791 &mc->translation_ranges,
792 &mc->num_translation_ranges);
794 goto error_cleanup_mc_io;
796 error = dpmng_get_container_id(mc_io, 0, &container_id);
799 "dpmng_get_container_id() failed: %d\n", error);
800 goto error_cleanup_mc_io;
803 memset(&obj_desc, 0, sizeof(struct dprc_obj_desc));
804 error = get_dprc_version(mc_io, container_id,
805 &obj_desc.ver_major, &obj_desc.ver_minor);
807 goto error_cleanup_mc_io;
809 obj_desc.vendor = FSL_MC_VENDOR_FREESCALE;
810 strcpy(obj_desc.type, "dprc");
811 obj_desc.id = container_id;
812 obj_desc.irq_count = 1;
813 obj_desc.region_count = 0;
815 error = fsl_mc_device_add(&obj_desc, mc_io, &pdev->dev, &mc_bus_dev);
817 goto error_cleanup_mc_io;
819 mc->root_mc_bus_dev = mc_bus_dev;
823 fsl_destroy_mc_io(mc_io);
828 * fsl_mc_bus_remove - callback invoked when the root MC bus is being
831 static int fsl_mc_bus_remove(struct platform_device *pdev)
833 struct fsl_mc *mc = platform_get_drvdata(pdev);
835 if (WARN_ON(!fsl_mc_is_root_dprc(&mc->root_mc_bus_dev->dev)))
838 fsl_mc_device_remove(mc->root_mc_bus_dev);
840 fsl_destroy_mc_io(mc->root_mc_bus_dev->mc_io);
841 mc->root_mc_bus_dev->mc_io = NULL;
843 dev_info(&pdev->dev, "Root MC bus device removed");
847 static const struct of_device_id fsl_mc_bus_match_table[] = {
848 {.compatible = "fsl,qoriq-mc",},
852 MODULE_DEVICE_TABLE(of, fsl_mc_bus_match_table);
854 static struct platform_driver fsl_mc_bus_driver = {
856 .name = "fsl_mc_bus",
858 .of_match_table = fsl_mc_bus_match_table,
860 .probe = fsl_mc_bus_probe,
861 .remove = fsl_mc_bus_remove,
864 static int __init fsl_mc_bus_driver_init(void)
868 mc_dev_cache = kmem_cache_create("fsl_mc_device",
869 sizeof(struct fsl_mc_device), 0, 0,
872 pr_err("Could not create fsl_mc_device cache\n");
876 error = bus_register(&fsl_mc_bus_type);
878 pr_err("fsl-mc bus type registration failed: %d\n", error);
879 goto error_cleanup_cache;
882 pr_info("fsl-mc bus type registered\n");
884 error = platform_driver_register(&fsl_mc_bus_driver);
886 pr_err("platform_driver_register() failed: %d\n", error);
887 goto error_cleanup_bus;
890 error = dprc_driver_init();
892 goto error_cleanup_driver;
894 error = fsl_mc_allocator_driver_init();
896 goto error_cleanup_dprc_driver;
898 error = its_fsl_mc_msi_init();
900 goto error_cleanup_mc_allocator;
904 error_cleanup_mc_allocator:
905 fsl_mc_allocator_driver_exit();
907 error_cleanup_dprc_driver:
910 error_cleanup_driver:
911 platform_driver_unregister(&fsl_mc_bus_driver);
914 bus_unregister(&fsl_mc_bus_type);
917 kmem_cache_destroy(mc_dev_cache);
920 postcore_initcall(fsl_mc_bus_driver_init);