2 * Freescale Management Complex (MC) bus driver
4 * Copyright (C) 2014-2016 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 #define pr_fmt(fmt) "fsl-mc: " fmt
14 #include <linux/module.h>
15 #include <linux/of_device.h>
16 #include <linux/of_address.h>
17 #include <linux/ioport.h>
18 #include <linux/slab.h>
19 #include <linux/limits.h>
20 #include <linux/bitops.h>
21 #include <linux/msi.h>
22 #include <linux/dma-mapping.h>
24 #include "fsl-mc-private.h"
26 #include "dpmng-cmd.h"
29 * Default DMA mask for devices on a fsl-mc bus
31 #define FSL_MC_DEFAULT_DMA_MASK (~0ULL)
34 * struct fsl_mc - Private data of a "fsl,qoriq-mc" platform device
35 * @root_mc_bus_dev: fsl-mc device representing the root DPRC
36 * @num_translation_ranges: number of entries in addr_translation_ranges
37 * @translation_ranges: array of bus to system address translation ranges
40 struct fsl_mc_device *root_mc_bus_dev;
41 u8 num_translation_ranges;
42 struct fsl_mc_addr_translation_range *translation_ranges;
46 * struct fsl_mc_addr_translation_range - bus to system address translation
48 * @mc_region_type: Type of MC region for the range being translated
49 * @start_mc_offset: Start MC offset of the range being translated
50 * @end_mc_offset: MC offset of the first byte after the range (last MC
51 * offset of the range is end_mc_offset - 1)
52 * @start_phys_addr: system physical address corresponding to start_mc_addr
54 struct fsl_mc_addr_translation_range {
55 enum dprc_region_type mc_region_type;
58 phys_addr_t start_phys_addr;
63 * @major: Major version number: incremented on API compatibility changes
64 * @minor: Minor version number: incremented on API additions (that are
65 * backward compatible); reset when major version is incremented
66 * @revision: Internal revision number: incremented on implementation changes
67 * and/or bug fixes that have no impact on API
76 * fsl_mc_bus_match - device to driver matching callback
77 * @dev: the fsl-mc device to match against
78 * @drv: the device driver to search for matching fsl-mc object type
81 * Returns 1 on success, 0 otherwise.
83 static int fsl_mc_bus_match(struct device *dev, struct device_driver *drv)
85 const struct fsl_mc_device_id *id;
86 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
87 struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(drv);
90 if (!mc_drv->match_id_table)
94 * If the object is not 'plugged' don't match.
95 * Only exception is the root DPRC, which is a special case.
97 if ((mc_dev->obj_desc.state & FSL_MC_OBJ_STATE_PLUGGED) == 0 &&
98 !fsl_mc_is_root_dprc(&mc_dev->dev))
102 * Traverse the match_id table of the given driver, trying to find
103 * a matching for the given device.
105 for (id = mc_drv->match_id_table; id->vendor != 0x0; id++) {
106 if (id->vendor == mc_dev->obj_desc.vendor &&
107 strcmp(id->obj_type, mc_dev->obj_desc.type) == 0) {
115 dev_dbg(dev, "%smatched\n", found ? "" : "not ");
120 * fsl_mc_bus_uevent - callback invoked when a device is added
122 static int fsl_mc_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
124 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
126 if (add_uevent_var(env, "MODALIAS=fsl-mc:v%08Xd%s",
127 mc_dev->obj_desc.vendor,
128 mc_dev->obj_desc.type))
134 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
137 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
139 return sprintf(buf, "fsl-mc:v%08Xd%s\n", mc_dev->obj_desc.vendor,
140 mc_dev->obj_desc.type);
142 static DEVICE_ATTR_RO(modalias);
144 static struct attribute *fsl_mc_dev_attrs[] = {
145 &dev_attr_modalias.attr,
149 ATTRIBUTE_GROUPS(fsl_mc_dev);
151 struct bus_type fsl_mc_bus_type = {
153 .match = fsl_mc_bus_match,
154 .uevent = fsl_mc_bus_uevent,
155 .dev_groups = fsl_mc_dev_groups,
157 EXPORT_SYMBOL_GPL(fsl_mc_bus_type);
159 static int fsl_mc_driver_probe(struct device *dev)
161 struct fsl_mc_driver *mc_drv;
162 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
165 if (WARN_ON(!dev->driver))
168 mc_drv = to_fsl_mc_driver(dev->driver);
169 if (WARN_ON(!mc_drv->probe))
172 error = mc_drv->probe(mc_dev);
174 dev_err(dev, "%s failed: %d\n", __func__, error);
181 static int fsl_mc_driver_remove(struct device *dev)
183 struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(dev->driver);
184 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
187 if (WARN_ON(!dev->driver))
190 error = mc_drv->remove(mc_dev);
192 dev_err(dev, "%s failed: %d\n", __func__, error);
199 static void fsl_mc_driver_shutdown(struct device *dev)
201 struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(dev->driver);
202 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
204 mc_drv->shutdown(mc_dev);
208 * __fsl_mc_driver_register - registers a child device driver with the
211 * This function is implicitly invoked from the registration function of
212 * fsl_mc device drivers, which is generated by the
213 * module_fsl_mc_driver() macro.
215 int __fsl_mc_driver_register(struct fsl_mc_driver *mc_driver,
216 struct module *owner)
220 mc_driver->driver.owner = owner;
221 mc_driver->driver.bus = &fsl_mc_bus_type;
223 if (mc_driver->probe)
224 mc_driver->driver.probe = fsl_mc_driver_probe;
226 if (mc_driver->remove)
227 mc_driver->driver.remove = fsl_mc_driver_remove;
229 if (mc_driver->shutdown)
230 mc_driver->driver.shutdown = fsl_mc_driver_shutdown;
232 error = driver_register(&mc_driver->driver);
234 pr_err("driver_register() failed for %s: %d\n",
235 mc_driver->driver.name, error);
241 EXPORT_SYMBOL_GPL(__fsl_mc_driver_register);
244 * fsl_mc_driver_unregister - unregisters a device driver from the
247 void fsl_mc_driver_unregister(struct fsl_mc_driver *mc_driver)
249 driver_unregister(&mc_driver->driver);
251 EXPORT_SYMBOL_GPL(fsl_mc_driver_unregister);
254 * mc_get_version() - Retrieves the Management Complex firmware
255 * version information
256 * @mc_io: Pointer to opaque I/O object
257 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
258 * @mc_ver_info: Returned version information structure
260 * Return: '0' on Success; Error code otherwise.
262 static int mc_get_version(struct fsl_mc_io *mc_io,
264 struct mc_version *mc_ver_info)
266 struct mc_command cmd = { 0 };
267 struct dpmng_rsp_get_version *rsp_params;
270 /* prepare command */
271 cmd.header = mc_encode_cmd_header(DPMNG_CMDID_GET_VERSION,
275 /* send command to mc*/
276 err = mc_send_command(mc_io, &cmd);
280 /* retrieve response parameters */
281 rsp_params = (struct dpmng_rsp_get_version *)cmd.params;
282 mc_ver_info->revision = le32_to_cpu(rsp_params->revision);
283 mc_ver_info->major = le32_to_cpu(rsp_params->version_major);
284 mc_ver_info->minor = le32_to_cpu(rsp_params->version_minor);
290 * fsl_mc_get_root_dprc - function to traverse to the root dprc
292 static void fsl_mc_get_root_dprc(struct device *dev,
293 struct device **root_dprc_dev)
296 *root_dprc_dev = NULL;
297 } else if (WARN_ON(!dev_is_fsl_mc(dev))) {
298 *root_dprc_dev = NULL;
300 *root_dprc_dev = dev;
301 while (dev_is_fsl_mc((*root_dprc_dev)->parent))
302 *root_dprc_dev = (*root_dprc_dev)->parent;
306 static int get_dprc_attr(struct fsl_mc_io *mc_io,
307 int container_id, struct dprc_attributes *attr)
312 error = dprc_open(mc_io, 0, container_id, &dprc_handle);
314 dev_err(mc_io->dev, "dprc_open() failed: %d\n", error);
318 memset(attr, 0, sizeof(struct dprc_attributes));
319 error = dprc_get_attributes(mc_io, 0, dprc_handle, attr);
321 dev_err(mc_io->dev, "dprc_get_attributes() failed: %d\n",
329 (void)dprc_close(mc_io, 0, dprc_handle);
333 static int get_dprc_icid(struct fsl_mc_io *mc_io,
334 int container_id, u16 *icid)
336 struct dprc_attributes attr;
339 error = get_dprc_attr(mc_io, container_id, &attr);
346 static int translate_mc_addr(struct fsl_mc_device *mc_dev,
347 enum dprc_region_type mc_region_type,
348 u64 mc_offset, phys_addr_t *phys_addr)
351 struct device *root_dprc_dev;
354 fsl_mc_get_root_dprc(&mc_dev->dev, &root_dprc_dev);
355 if (WARN_ON(!root_dprc_dev))
357 mc = dev_get_drvdata(root_dprc_dev->parent);
359 if (mc->num_translation_ranges == 0) {
361 * Do identity mapping:
363 *phys_addr = mc_offset;
367 for (i = 0; i < mc->num_translation_ranges; i++) {
368 struct fsl_mc_addr_translation_range *range =
369 &mc->translation_ranges[i];
371 if (mc_region_type == range->mc_region_type &&
372 mc_offset >= range->start_mc_offset &&
373 mc_offset < range->end_mc_offset) {
374 *phys_addr = range->start_phys_addr +
375 (mc_offset - range->start_mc_offset);
383 static int fsl_mc_device_get_mmio_regions(struct fsl_mc_device *mc_dev,
384 struct fsl_mc_device *mc_bus_dev)
388 struct resource *regions;
389 struct fsl_mc_obj_desc *obj_desc = &mc_dev->obj_desc;
390 struct device *parent_dev = mc_dev->dev.parent;
391 enum dprc_region_type mc_region_type;
393 if (strcmp(obj_desc->type, "dprc") == 0 ||
394 strcmp(obj_desc->type, "dpmcp") == 0) {
395 mc_region_type = DPRC_REGION_TYPE_MC_PORTAL;
396 } else if (strcmp(obj_desc->type, "dpio") == 0) {
397 mc_region_type = DPRC_REGION_TYPE_QBMAN_PORTAL;
400 * This function should not have been called for this MC object
401 * type, as this object type is not supposed to have MMIO
408 regions = kmalloc_array(obj_desc->region_count,
409 sizeof(regions[0]), GFP_KERNEL);
413 for (i = 0; i < obj_desc->region_count; i++) {
414 struct dprc_region_desc region_desc;
416 error = dprc_get_obj_region(mc_bus_dev->mc_io,
418 mc_bus_dev->mc_handle,
420 obj_desc->id, i, ®ion_desc);
423 "dprc_get_obj_region() failed: %d\n", error);
424 goto error_cleanup_regions;
427 WARN_ON(region_desc.size == 0);
428 error = translate_mc_addr(mc_dev, mc_region_type,
429 region_desc.base_offset,
433 "Invalid MC offset: %#x (for %s.%d\'s region %d)\n",
434 region_desc.base_offset,
435 obj_desc->type, obj_desc->id, i);
436 goto error_cleanup_regions;
439 regions[i].end = regions[i].start + region_desc.size - 1;
440 regions[i].name = "fsl-mc object MMIO region";
441 regions[i].flags = IORESOURCE_IO;
442 if (region_desc.flags & DPRC_REGION_CACHEABLE)
443 regions[i].flags |= IORESOURCE_CACHEABLE;
446 mc_dev->regions = regions;
449 error_cleanup_regions:
455 * fsl_mc_is_root_dprc - function to check if a given device is a root dprc
457 bool fsl_mc_is_root_dprc(struct device *dev)
459 struct device *root_dprc_dev;
461 fsl_mc_get_root_dprc(dev, &root_dprc_dev);
464 return dev == root_dprc_dev;
467 static void fsl_mc_device_release(struct device *dev)
469 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
471 kfree(mc_dev->regions);
473 if (strcmp(mc_dev->obj_desc.type, "dprc") == 0)
474 kfree(to_fsl_mc_bus(mc_dev));
480 * Add a newly discovered fsl-mc device to be visible in Linux
482 int fsl_mc_device_add(struct fsl_mc_obj_desc *obj_desc,
483 struct fsl_mc_io *mc_io,
484 struct device *parent_dev,
485 struct fsl_mc_device **new_mc_dev)
488 struct fsl_mc_device *mc_dev = NULL;
489 struct fsl_mc_bus *mc_bus = NULL;
490 struct fsl_mc_device *parent_mc_dev;
492 if (dev_is_fsl_mc(parent_dev))
493 parent_mc_dev = to_fsl_mc_device(parent_dev);
495 parent_mc_dev = NULL;
497 if (strcmp(obj_desc->type, "dprc") == 0) {
499 * Allocate an MC bus device object:
501 mc_bus = kzalloc(sizeof(*mc_bus), GFP_KERNEL);
505 mc_dev = &mc_bus->mc_dev;
508 * Allocate a regular fsl_mc_device object:
510 mc_dev = kzalloc(sizeof(*mc_dev), GFP_KERNEL);
515 mc_dev->obj_desc = *obj_desc;
516 mc_dev->mc_io = mc_io;
517 device_initialize(&mc_dev->dev);
518 mc_dev->dev.parent = parent_dev;
519 mc_dev->dev.bus = &fsl_mc_bus_type;
520 mc_dev->dev.release = fsl_mc_device_release;
521 dev_set_name(&mc_dev->dev, "%s.%d", obj_desc->type, obj_desc->id);
523 if (strcmp(obj_desc->type, "dprc") == 0) {
524 struct fsl_mc_io *mc_io2;
526 mc_dev->flags |= FSL_MC_IS_DPRC;
529 * To get the DPRC's ICID, we need to open the DPRC
530 * in get_dprc_icid(). For child DPRCs, we do so using the
531 * parent DPRC's MC portal instead of the child DPRC's MC
532 * portal, in case the child DPRC is already opened with
533 * its own portal (e.g., the DPRC used by AIOP).
535 * NOTE: There cannot be more than one active open for a
536 * given MC object, using the same MC portal.
540 * device being added is a child DPRC device
542 mc_io2 = parent_mc_dev->mc_io;
545 * device being added is the root DPRC device
547 if (WARN_ON(!mc_io)) {
549 goto error_cleanup_dev;
555 error = get_dprc_icid(mc_io2, obj_desc->id, &mc_dev->icid);
557 goto error_cleanup_dev;
560 * A non-DPRC object has to be a child of a DPRC, use the
561 * parent's ICID and interrupt domain.
563 mc_dev->icid = parent_mc_dev->icid;
564 mc_dev->dma_mask = FSL_MC_DEFAULT_DMA_MASK;
565 mc_dev->dev.dma_mask = &mc_dev->dma_mask;
566 dev_set_msi_domain(&mc_dev->dev,
567 dev_get_msi_domain(&parent_mc_dev->dev));
571 * Get MMIO regions for the device from the MC:
573 * NOTE: the root DPRC is a special case as its MMIO region is
574 * obtained from the device tree
576 if (parent_mc_dev && obj_desc->region_count != 0) {
577 error = fsl_mc_device_get_mmio_regions(mc_dev,
580 goto error_cleanup_dev;
583 /* Objects are coherent, unless 'no shareability' flag set. */
584 if (!(obj_desc->flags & FSL_MC_OBJ_FLAG_NO_MEM_SHAREABILITY))
585 arch_setup_dma_ops(&mc_dev->dev, 0, 0, NULL, true);
588 * The device-specific probe callback will get invoked by device_add()
590 error = device_add(&mc_dev->dev);
593 "device_add() failed for device %s: %d\n",
594 dev_name(&mc_dev->dev), error);
595 goto error_cleanup_dev;
598 dev_dbg(parent_dev, "added %s\n", dev_name(&mc_dev->dev));
600 *new_mc_dev = mc_dev;
604 kfree(mc_dev->regions);
610 EXPORT_SYMBOL_GPL(fsl_mc_device_add);
613 * fsl_mc_device_remove - Remove an fsl-mc device from being visible to
616 * @mc_dev: Pointer to an fsl-mc device
618 void fsl_mc_device_remove(struct fsl_mc_device *mc_dev)
621 * The device-specific remove callback will get invoked by device_del()
623 device_del(&mc_dev->dev);
624 put_device(&mc_dev->dev);
626 EXPORT_SYMBOL_GPL(fsl_mc_device_remove);
628 static int parse_mc_ranges(struct device *dev,
632 const __be32 **ranges_start)
635 int range_tuple_cell_count;
638 struct device_node *mc_node = dev->of_node;
640 *ranges_start = of_get_property(mc_node, "ranges", &ranges_len);
641 if (!(*ranges_start) || !ranges_len) {
643 "missing or empty ranges property for device tree node '%s'\n",
648 *paddr_cells = of_n_addr_cells(mc_node);
650 prop = of_get_property(mc_node, "#address-cells", NULL);
652 *mc_addr_cells = be32_to_cpup(prop);
654 *mc_addr_cells = *paddr_cells;
656 prop = of_get_property(mc_node, "#size-cells", NULL);
658 *mc_size_cells = be32_to_cpup(prop);
660 *mc_size_cells = of_n_size_cells(mc_node);
662 range_tuple_cell_count = *paddr_cells + *mc_addr_cells +
665 tuple_len = range_tuple_cell_count * sizeof(__be32);
666 if (ranges_len % tuple_len != 0) {
667 dev_err(dev, "malformed ranges property '%s'\n", mc_node->name);
671 return ranges_len / tuple_len;
674 static int get_mc_addr_translation_ranges(struct device *dev,
675 struct fsl_mc_addr_translation_range
684 const __be32 *ranges_start;
687 ret = parse_mc_ranges(dev,
698 * Missing or empty ranges property ("ranges;") for the
699 * 'fsl,qoriq-mc' node. In this case, identity mapping
706 *ranges = devm_kcalloc(dev, *num_ranges,
707 sizeof(struct fsl_mc_addr_translation_range),
713 for (i = 0; i < *num_ranges; ++i) {
714 struct fsl_mc_addr_translation_range *range = &(*ranges)[i];
716 range->mc_region_type = of_read_number(cell, 1);
717 range->start_mc_offset = of_read_number(cell + 1,
719 cell += mc_addr_cells;
720 range->start_phys_addr = of_read_number(cell, paddr_cells);
722 range->end_mc_offset = range->start_mc_offset +
723 of_read_number(cell, mc_size_cells);
725 cell += mc_size_cells;
732 * fsl_mc_bus_probe - callback invoked when the root MC bus is being
735 static int fsl_mc_bus_probe(struct platform_device *pdev)
737 struct fsl_mc_obj_desc obj_desc;
740 struct fsl_mc_device *mc_bus_dev = NULL;
741 struct fsl_mc_io *mc_io = NULL;
743 phys_addr_t mc_portal_phys_addr;
745 struct mc_version mc_version;
748 mc = devm_kzalloc(&pdev->dev, sizeof(*mc), GFP_KERNEL);
752 platform_set_drvdata(pdev, mc);
755 * Get physical address of MC portal for the root DPRC:
757 error = of_address_to_resource(pdev->dev.of_node, 0, &res);
760 "of_address_to_resource() failed for %pOF\n",
765 mc_portal_phys_addr = res.start;
766 mc_portal_size = resource_size(&res);
767 error = fsl_create_mc_io(&pdev->dev, mc_portal_phys_addr,
768 mc_portal_size, NULL,
769 FSL_MC_IO_ATOMIC_CONTEXT_PORTAL, &mc_io);
773 error = mc_get_version(mc_io, 0, &mc_version);
776 "mc_get_version() failed with error %d\n", error);
777 goto error_cleanup_mc_io;
780 dev_info(&pdev->dev, "MC firmware version: %u.%u.%u\n",
781 mc_version.major, mc_version.minor, mc_version.revision);
783 error = get_mc_addr_translation_ranges(&pdev->dev,
784 &mc->translation_ranges,
785 &mc->num_translation_ranges);
787 goto error_cleanup_mc_io;
789 error = dprc_get_container_id(mc_io, 0, &container_id);
792 "dprc_get_container_id() failed: %d\n", error);
793 goto error_cleanup_mc_io;
796 memset(&obj_desc, 0, sizeof(struct fsl_mc_obj_desc));
797 error = dprc_get_api_version(mc_io, 0,
799 &obj_desc.ver_minor);
801 goto error_cleanup_mc_io;
803 obj_desc.vendor = FSL_MC_VENDOR_FREESCALE;
804 strcpy(obj_desc.type, "dprc");
805 obj_desc.id = container_id;
806 obj_desc.irq_count = 1;
807 obj_desc.region_count = 0;
809 error = fsl_mc_device_add(&obj_desc, mc_io, &pdev->dev, &mc_bus_dev);
811 goto error_cleanup_mc_io;
813 mc->root_mc_bus_dev = mc_bus_dev;
817 fsl_destroy_mc_io(mc_io);
822 * fsl_mc_bus_remove - callback invoked when the root MC bus is being
825 static int fsl_mc_bus_remove(struct platform_device *pdev)
827 struct fsl_mc *mc = platform_get_drvdata(pdev);
829 if (WARN_ON(!fsl_mc_is_root_dprc(&mc->root_mc_bus_dev->dev)))
832 fsl_mc_device_remove(mc->root_mc_bus_dev);
834 fsl_destroy_mc_io(mc->root_mc_bus_dev->mc_io);
835 mc->root_mc_bus_dev->mc_io = NULL;
840 static const struct of_device_id fsl_mc_bus_match_table[] = {
841 {.compatible = "fsl,qoriq-mc",},
845 MODULE_DEVICE_TABLE(of, fsl_mc_bus_match_table);
847 static struct platform_driver fsl_mc_bus_driver = {
849 .name = "fsl_mc_bus",
851 .of_match_table = fsl_mc_bus_match_table,
853 .probe = fsl_mc_bus_probe,
854 .remove = fsl_mc_bus_remove,
857 static int __init fsl_mc_bus_driver_init(void)
861 error = bus_register(&fsl_mc_bus_type);
863 pr_err("bus type registration failed: %d\n", error);
864 goto error_cleanup_cache;
867 error = platform_driver_register(&fsl_mc_bus_driver);
869 pr_err("platform_driver_register() failed: %d\n", error);
870 goto error_cleanup_bus;
873 error = dprc_driver_init();
875 goto error_cleanup_driver;
877 error = fsl_mc_allocator_driver_init();
879 goto error_cleanup_dprc_driver;
881 error = its_fsl_mc_msi_init();
883 goto error_cleanup_mc_allocator;
887 error_cleanup_mc_allocator:
888 fsl_mc_allocator_driver_exit();
890 error_cleanup_dprc_driver:
893 error_cleanup_driver:
894 platform_driver_unregister(&fsl_mc_bus_driver);
897 bus_unregister(&fsl_mc_bus_type);
902 postcore_initcall(fsl_mc_bus_driver_init);