1 // SPDX-License-Identifier: GPL-2.0
3 * Freescale Management Complex (MC) bus driver
5 * Copyright (C) 2014-2016 Freescale Semiconductor, Inc.
6 * Copyright 2019-2020 NXP
7 * Author: German Rivera <German.Rivera@freescale.com>
11 #define pr_fmt(fmt) "fsl-mc: " fmt
13 #include <linux/module.h>
14 #include <linux/of_device.h>
15 #include <linux/of_address.h>
16 #include <linux/ioport.h>
17 #include <linux/slab.h>
18 #include <linux/limits.h>
19 #include <linux/bitops.h>
20 #include <linux/msi.h>
21 #include <linux/dma-mapping.h>
22 #include <linux/acpi.h>
23 #include <linux/iommu.h>
25 #include "fsl-mc-private.h"
28 * Default DMA mask for devices on a fsl-mc bus
30 #define FSL_MC_DEFAULT_DMA_MASK (~0ULL)
32 static struct fsl_mc_version mc_version;
35 * struct fsl_mc - Private data of a "fsl,qoriq-mc" platform device
36 * @root_mc_bus_dev: fsl-mc device representing the root DPRC
37 * @num_translation_ranges: number of entries in addr_translation_ranges
38 * @translation_ranges: array of bus to system address translation ranges
39 * @fsl_mc_regs: base address of register bank
42 struct fsl_mc_device *root_mc_bus_dev;
43 u8 num_translation_ranges;
44 struct fsl_mc_addr_translation_range *translation_ranges;
45 void __iomem *fsl_mc_regs;
49 * struct fsl_mc_addr_translation_range - bus to system address translation
51 * @mc_region_type: Type of MC region for the range being translated
52 * @start_mc_offset: Start MC offset of the range being translated
53 * @end_mc_offset: MC offset of the first byte after the range (last MC
54 * offset of the range is end_mc_offset - 1)
55 * @start_phys_addr: system physical address corresponding to start_mc_addr
57 struct fsl_mc_addr_translation_range {
58 enum dprc_region_type mc_region_type;
61 phys_addr_t start_phys_addr;
64 #define FSL_MC_GCR1 0x0
65 #define GCR1_P1_STOP BIT(31)
66 #define GCR1_P2_STOP BIT(30)
68 #define FSL_MC_FAPR 0x28
69 #define MC_FAPR_PL BIT(18)
70 #define MC_FAPR_BMT BIT(17)
72 static phys_addr_t mc_portal_base_phys_addr;
75 * fsl_mc_bus_match - device to driver matching callback
76 * @dev: the fsl-mc device to match against
77 * @drv: the device driver to search for matching fsl-mc object type
80 * Returns 1 on success, 0 otherwise.
82 static int fsl_mc_bus_match(struct device *dev, struct device_driver *drv)
84 const struct fsl_mc_device_id *id;
85 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
86 struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(drv);
89 /* When driver_override is set, only bind to the matching driver */
90 if (mc_dev->driver_override) {
91 found = !strcmp(mc_dev->driver_override, mc_drv->driver.name);
95 if (!mc_drv->match_id_table)
99 * If the object is not 'plugged' don't match.
100 * Only exception is the root DPRC, which is a special case.
102 if ((mc_dev->obj_desc.state & FSL_MC_OBJ_STATE_PLUGGED) == 0 &&
103 !fsl_mc_is_root_dprc(&mc_dev->dev))
107 * Traverse the match_id table of the given driver, trying to find
108 * a matching for the given device.
110 for (id = mc_drv->match_id_table; id->vendor != 0x0; id++) {
111 if (id->vendor == mc_dev->obj_desc.vendor &&
112 strcmp(id->obj_type, mc_dev->obj_desc.type) == 0) {
120 dev_dbg(dev, "%smatched\n", found ? "" : "not ");
125 * fsl_mc_bus_uevent - callback invoked when a device is added
127 static int fsl_mc_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
129 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
131 if (add_uevent_var(env, "MODALIAS=fsl-mc:v%08Xd%s",
132 mc_dev->obj_desc.vendor,
133 mc_dev->obj_desc.type))
139 static int fsl_mc_dma_configure(struct device *dev)
141 struct device *dma_dev = dev;
142 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
143 u32 input_id = mc_dev->icid;
145 while (dev_is_fsl_mc(dma_dev))
146 dma_dev = dma_dev->parent;
148 if (dev_of_node(dma_dev))
149 return of_dma_configure_id(dev, dma_dev->of_node, 0, &input_id);
151 return acpi_dma_configure_id(dev, DEV_DMA_COHERENT, &input_id);
154 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
157 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
159 return sprintf(buf, "fsl-mc:v%08Xd%s\n", mc_dev->obj_desc.vendor,
160 mc_dev->obj_desc.type);
162 static DEVICE_ATTR_RO(modalias);
164 static ssize_t driver_override_store(struct device *dev,
165 struct device_attribute *attr,
166 const char *buf, size_t count)
168 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
169 char *driver_override, *old = mc_dev->driver_override;
172 if (WARN_ON(dev->bus != &fsl_mc_bus_type))
175 if (count >= (PAGE_SIZE - 1))
178 driver_override = kstrndup(buf, count, GFP_KERNEL);
179 if (!driver_override)
182 cp = strchr(driver_override, '\n');
186 if (strlen(driver_override)) {
187 mc_dev->driver_override = driver_override;
189 kfree(driver_override);
190 mc_dev->driver_override = NULL;
198 static ssize_t driver_override_show(struct device *dev,
199 struct device_attribute *attr, char *buf)
201 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
203 return snprintf(buf, PAGE_SIZE, "%s\n", mc_dev->driver_override);
205 static DEVICE_ATTR_RW(driver_override);
207 static struct attribute *fsl_mc_dev_attrs[] = {
208 &dev_attr_modalias.attr,
209 &dev_attr_driver_override.attr,
213 ATTRIBUTE_GROUPS(fsl_mc_dev);
215 static int scan_fsl_mc_bus(struct device *dev, void *data)
217 struct fsl_mc_device *root_mc_dev;
218 struct fsl_mc_bus *root_mc_bus;
220 if (!fsl_mc_is_root_dprc(dev))
223 root_mc_dev = to_fsl_mc_device(dev);
224 root_mc_bus = to_fsl_mc_bus(root_mc_dev);
225 mutex_lock(&root_mc_bus->scan_mutex);
226 dprc_scan_objects(root_mc_dev, false);
227 mutex_unlock(&root_mc_bus->scan_mutex);
233 static ssize_t rescan_store(struct bus_type *bus,
234 const char *buf, size_t count)
238 if (kstrtoul(buf, 0, &val) < 0)
242 bus_for_each_dev(bus, NULL, NULL, scan_fsl_mc_bus);
246 static BUS_ATTR_WO(rescan);
248 static int fsl_mc_bus_set_autorescan(struct device *dev, void *data)
250 struct fsl_mc_device *root_mc_dev;
254 if (!fsl_mc_is_root_dprc(dev))
257 root_mc_dev = to_fsl_mc_device(dev);
259 if (kstrtoul(buf, 0, &val) < 0)
263 enable_dprc_irq(root_mc_dev);
265 disable_dprc_irq(root_mc_dev);
271 static int fsl_mc_bus_get_autorescan(struct device *dev, void *data)
273 struct fsl_mc_device *root_mc_dev;
276 if (!fsl_mc_is_root_dprc(dev))
279 root_mc_dev = to_fsl_mc_device(dev);
281 sprintf(buf, "%d\n", get_dprc_irq_state(root_mc_dev));
286 static ssize_t autorescan_store(struct bus_type *bus,
287 const char *buf, size_t count)
289 bus_for_each_dev(bus, NULL, (void *)buf, fsl_mc_bus_set_autorescan);
294 static ssize_t autorescan_show(struct bus_type *bus, char *buf)
296 bus_for_each_dev(bus, NULL, (void *)buf, fsl_mc_bus_get_autorescan);
300 static BUS_ATTR_RW(autorescan);
302 static struct attribute *fsl_mc_bus_attrs[] = {
303 &bus_attr_rescan.attr,
304 &bus_attr_autorescan.attr,
308 ATTRIBUTE_GROUPS(fsl_mc_bus);
310 struct bus_type fsl_mc_bus_type = {
312 .match = fsl_mc_bus_match,
313 .uevent = fsl_mc_bus_uevent,
314 .dma_configure = fsl_mc_dma_configure,
315 .dev_groups = fsl_mc_dev_groups,
316 .bus_groups = fsl_mc_bus_groups,
318 EXPORT_SYMBOL_GPL(fsl_mc_bus_type);
320 struct device_type fsl_mc_bus_dprc_type = {
321 .name = "fsl_mc_bus_dprc"
323 EXPORT_SYMBOL_GPL(fsl_mc_bus_dprc_type);
325 struct device_type fsl_mc_bus_dpni_type = {
326 .name = "fsl_mc_bus_dpni"
328 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpni_type);
330 struct device_type fsl_mc_bus_dpio_type = {
331 .name = "fsl_mc_bus_dpio"
333 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpio_type);
335 struct device_type fsl_mc_bus_dpsw_type = {
336 .name = "fsl_mc_bus_dpsw"
338 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpsw_type);
340 struct device_type fsl_mc_bus_dpbp_type = {
341 .name = "fsl_mc_bus_dpbp"
343 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpbp_type);
345 struct device_type fsl_mc_bus_dpcon_type = {
346 .name = "fsl_mc_bus_dpcon"
348 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpcon_type);
350 struct device_type fsl_mc_bus_dpmcp_type = {
351 .name = "fsl_mc_bus_dpmcp"
353 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpmcp_type);
355 struct device_type fsl_mc_bus_dpmac_type = {
356 .name = "fsl_mc_bus_dpmac"
358 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpmac_type);
360 struct device_type fsl_mc_bus_dprtc_type = {
361 .name = "fsl_mc_bus_dprtc"
363 EXPORT_SYMBOL_GPL(fsl_mc_bus_dprtc_type);
365 struct device_type fsl_mc_bus_dpseci_type = {
366 .name = "fsl_mc_bus_dpseci"
368 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpseci_type);
370 struct device_type fsl_mc_bus_dpdmux_type = {
371 .name = "fsl_mc_bus_dpdmux"
373 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpdmux_type);
375 struct device_type fsl_mc_bus_dpdcei_type = {
376 .name = "fsl_mc_bus_dpdcei"
378 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpdcei_type);
380 struct device_type fsl_mc_bus_dpaiop_type = {
381 .name = "fsl_mc_bus_dpaiop"
383 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpaiop_type);
385 struct device_type fsl_mc_bus_dpci_type = {
386 .name = "fsl_mc_bus_dpci"
388 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpci_type);
390 struct device_type fsl_mc_bus_dpdmai_type = {
391 .name = "fsl_mc_bus_dpdmai"
393 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpdmai_type);
395 struct device_type fsl_mc_bus_dpdbg_type = {
396 .name = "fsl_mc_bus_dpdbg"
398 EXPORT_SYMBOL_GPL(fsl_mc_bus_dpdbg_type);
400 static struct device_type *fsl_mc_get_device_type(const char *type)
402 static const struct {
403 struct device_type *dev_type;
406 { &fsl_mc_bus_dprc_type, "dprc" },
407 { &fsl_mc_bus_dpni_type, "dpni" },
408 { &fsl_mc_bus_dpio_type, "dpio" },
409 { &fsl_mc_bus_dpsw_type, "dpsw" },
410 { &fsl_mc_bus_dpbp_type, "dpbp" },
411 { &fsl_mc_bus_dpcon_type, "dpcon" },
412 { &fsl_mc_bus_dpmcp_type, "dpmcp" },
413 { &fsl_mc_bus_dpmac_type, "dpmac" },
414 { &fsl_mc_bus_dprtc_type, "dprtc" },
415 { &fsl_mc_bus_dpseci_type, "dpseci" },
416 { &fsl_mc_bus_dpdmux_type, "dpdmux" },
417 { &fsl_mc_bus_dpdcei_type, "dpdcei" },
418 { &fsl_mc_bus_dpaiop_type, "dpaiop" },
419 { &fsl_mc_bus_dpci_type, "dpci" },
420 { &fsl_mc_bus_dpdmai_type, "dpdmai" },
421 { &fsl_mc_bus_dpdbg_type, "dpdbg" },
426 for (i = 0; dev_types[i].dev_type; i++)
427 if (!strcmp(dev_types[i].type, type))
428 return dev_types[i].dev_type;
433 static int fsl_mc_driver_probe(struct device *dev)
435 struct fsl_mc_driver *mc_drv;
436 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
439 mc_drv = to_fsl_mc_driver(dev->driver);
441 error = mc_drv->probe(mc_dev);
443 if (error != -EPROBE_DEFER)
444 dev_err(dev, "%s failed: %d\n", __func__, error);
451 static int fsl_mc_driver_remove(struct device *dev)
453 struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(dev->driver);
454 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
457 error = mc_drv->remove(mc_dev);
459 dev_err(dev, "%s failed: %d\n", __func__, error);
466 static void fsl_mc_driver_shutdown(struct device *dev)
468 struct fsl_mc_driver *mc_drv = to_fsl_mc_driver(dev->driver);
469 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
471 mc_drv->shutdown(mc_dev);
475 * __fsl_mc_driver_register - registers a child device driver with the
478 * This function is implicitly invoked from the registration function of
479 * fsl_mc device drivers, which is generated by the
480 * module_fsl_mc_driver() macro.
482 int __fsl_mc_driver_register(struct fsl_mc_driver *mc_driver,
483 struct module *owner)
487 mc_driver->driver.owner = owner;
488 mc_driver->driver.bus = &fsl_mc_bus_type;
490 if (mc_driver->probe)
491 mc_driver->driver.probe = fsl_mc_driver_probe;
493 if (mc_driver->remove)
494 mc_driver->driver.remove = fsl_mc_driver_remove;
496 if (mc_driver->shutdown)
497 mc_driver->driver.shutdown = fsl_mc_driver_shutdown;
499 error = driver_register(&mc_driver->driver);
501 pr_err("driver_register() failed for %s: %d\n",
502 mc_driver->driver.name, error);
508 EXPORT_SYMBOL_GPL(__fsl_mc_driver_register);
511 * fsl_mc_driver_unregister - unregisters a device driver from the
514 void fsl_mc_driver_unregister(struct fsl_mc_driver *mc_driver)
516 driver_unregister(&mc_driver->driver);
518 EXPORT_SYMBOL_GPL(fsl_mc_driver_unregister);
521 * mc_get_version() - Retrieves the Management Complex firmware
522 * version information
523 * @mc_io: Pointer to opaque I/O object
524 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
525 * @mc_ver_info: Returned version information structure
527 * Return: '0' on Success; Error code otherwise.
529 static int mc_get_version(struct fsl_mc_io *mc_io,
531 struct fsl_mc_version *mc_ver_info)
533 struct fsl_mc_command cmd = { 0 };
534 struct dpmng_rsp_get_version *rsp_params;
537 /* prepare command */
538 cmd.header = mc_encode_cmd_header(DPMNG_CMDID_GET_VERSION,
542 /* send command to mc*/
543 err = mc_send_command(mc_io, &cmd);
547 /* retrieve response parameters */
548 rsp_params = (struct dpmng_rsp_get_version *)cmd.params;
549 mc_ver_info->revision = le32_to_cpu(rsp_params->revision);
550 mc_ver_info->major = le32_to_cpu(rsp_params->version_major);
551 mc_ver_info->minor = le32_to_cpu(rsp_params->version_minor);
557 * fsl_mc_get_version - function to retrieve the MC f/w version information
559 * Return: mc version when called after fsl-mc-bus probe; NULL otherwise.
561 struct fsl_mc_version *fsl_mc_get_version(void)
563 if (mc_version.major)
568 EXPORT_SYMBOL_GPL(fsl_mc_get_version);
571 * fsl_mc_get_root_dprc - function to traverse to the root dprc
573 void fsl_mc_get_root_dprc(struct device *dev,
574 struct device **root_dprc_dev)
577 *root_dprc_dev = NULL;
578 } else if (!dev_is_fsl_mc(dev)) {
579 *root_dprc_dev = NULL;
581 *root_dprc_dev = dev;
582 while (dev_is_fsl_mc((*root_dprc_dev)->parent))
583 *root_dprc_dev = (*root_dprc_dev)->parent;
587 static int get_dprc_attr(struct fsl_mc_io *mc_io,
588 int container_id, struct dprc_attributes *attr)
593 error = dprc_open(mc_io, 0, container_id, &dprc_handle);
595 dev_err(mc_io->dev, "dprc_open() failed: %d\n", error);
599 memset(attr, 0, sizeof(struct dprc_attributes));
600 error = dprc_get_attributes(mc_io, 0, dprc_handle, attr);
602 dev_err(mc_io->dev, "dprc_get_attributes() failed: %d\n",
610 (void)dprc_close(mc_io, 0, dprc_handle);
614 static int get_dprc_icid(struct fsl_mc_io *mc_io,
615 int container_id, u32 *icid)
617 struct dprc_attributes attr;
620 error = get_dprc_attr(mc_io, container_id, &attr);
627 static int translate_mc_addr(struct fsl_mc_device *mc_dev,
628 enum dprc_region_type mc_region_type,
629 u64 mc_offset, phys_addr_t *phys_addr)
632 struct device *root_dprc_dev;
635 fsl_mc_get_root_dprc(&mc_dev->dev, &root_dprc_dev);
636 mc = dev_get_drvdata(root_dprc_dev->parent);
638 if (mc->num_translation_ranges == 0) {
640 * Do identity mapping:
642 *phys_addr = mc_offset;
646 for (i = 0; i < mc->num_translation_ranges; i++) {
647 struct fsl_mc_addr_translation_range *range =
648 &mc->translation_ranges[i];
650 if (mc_region_type == range->mc_region_type &&
651 mc_offset >= range->start_mc_offset &&
652 mc_offset < range->end_mc_offset) {
653 *phys_addr = range->start_phys_addr +
654 (mc_offset - range->start_mc_offset);
662 static int fsl_mc_device_get_mmio_regions(struct fsl_mc_device *mc_dev,
663 struct fsl_mc_device *mc_bus_dev)
667 struct resource *regions;
668 struct fsl_mc_obj_desc *obj_desc = &mc_dev->obj_desc;
669 struct device *parent_dev = mc_dev->dev.parent;
670 enum dprc_region_type mc_region_type;
672 if (is_fsl_mc_bus_dprc(mc_dev) ||
673 is_fsl_mc_bus_dpmcp(mc_dev)) {
674 mc_region_type = DPRC_REGION_TYPE_MC_PORTAL;
675 } else if (is_fsl_mc_bus_dpio(mc_dev)) {
676 mc_region_type = DPRC_REGION_TYPE_QBMAN_PORTAL;
679 * This function should not have been called for this MC object
680 * type, as this object type is not supposed to have MMIO
686 regions = kmalloc_array(obj_desc->region_count,
687 sizeof(regions[0]), GFP_KERNEL);
691 for (i = 0; i < obj_desc->region_count; i++) {
692 struct dprc_region_desc region_desc;
694 error = dprc_get_obj_region(mc_bus_dev->mc_io,
696 mc_bus_dev->mc_handle,
698 obj_desc->id, i, ®ion_desc);
701 "dprc_get_obj_region() failed: %d\n", error);
702 goto error_cleanup_regions;
705 * Older MC only returned region offset and no base address
706 * If base address is in the region_desc use it otherwise
707 * revert to old mechanism
709 if (region_desc.base_address) {
710 regions[i].start = region_desc.base_address +
711 region_desc.base_offset;
713 error = translate_mc_addr(mc_dev, mc_region_type,
714 region_desc.base_offset,
718 * Some versions of the MC firmware wrongly report
719 * 0 for register base address of the DPMCP associated
720 * with child DPRC objects thus rendering them unusable.
721 * This is particularly troublesome in ACPI boot
722 * scenarios where the legacy way of extracting this
723 * base address from the device tree does not apply.
724 * Given that DPMCPs share the same base address,
725 * workaround this by using the base address extracted
726 * from the root DPRC container.
728 if (is_fsl_mc_bus_dprc(mc_dev) &&
729 regions[i].start == region_desc.base_offset)
730 regions[i].start += mc_portal_base_phys_addr;
735 "Invalid MC offset: %#x (for %s.%d\'s region %d)\n",
736 region_desc.base_offset,
737 obj_desc->type, obj_desc->id, i);
738 goto error_cleanup_regions;
741 regions[i].end = regions[i].start + region_desc.size - 1;
742 regions[i].name = "fsl-mc object MMIO region";
743 regions[i].flags = region_desc.flags & IORESOURCE_BITS;
744 regions[i].flags |= IORESOURCE_MEM;
747 mc_dev->regions = regions;
750 error_cleanup_regions:
756 * fsl_mc_is_root_dprc - function to check if a given device is a root dprc
758 bool fsl_mc_is_root_dprc(struct device *dev)
760 struct device *root_dprc_dev;
762 fsl_mc_get_root_dprc(dev, &root_dprc_dev);
765 return dev == root_dprc_dev;
768 static void fsl_mc_device_release(struct device *dev)
770 struct fsl_mc_device *mc_dev = to_fsl_mc_device(dev);
772 kfree(mc_dev->regions);
774 if (is_fsl_mc_bus_dprc(mc_dev))
775 kfree(to_fsl_mc_bus(mc_dev));
781 * Add a newly discovered fsl-mc device to be visible in Linux
783 int fsl_mc_device_add(struct fsl_mc_obj_desc *obj_desc,
784 struct fsl_mc_io *mc_io,
785 struct device *parent_dev,
786 struct fsl_mc_device **new_mc_dev)
789 struct fsl_mc_device *mc_dev = NULL;
790 struct fsl_mc_bus *mc_bus = NULL;
791 struct fsl_mc_device *parent_mc_dev;
793 if (dev_is_fsl_mc(parent_dev))
794 parent_mc_dev = to_fsl_mc_device(parent_dev);
796 parent_mc_dev = NULL;
798 if (strcmp(obj_desc->type, "dprc") == 0) {
800 * Allocate an MC bus device object:
802 mc_bus = kzalloc(sizeof(*mc_bus), GFP_KERNEL);
806 mutex_init(&mc_bus->scan_mutex);
807 mc_dev = &mc_bus->mc_dev;
810 * Allocate a regular fsl_mc_device object:
812 mc_dev = kzalloc(sizeof(*mc_dev), GFP_KERNEL);
817 mc_dev->obj_desc = *obj_desc;
818 mc_dev->mc_io = mc_io;
819 device_initialize(&mc_dev->dev);
820 mc_dev->dev.parent = parent_dev;
821 mc_dev->dev.bus = &fsl_mc_bus_type;
822 mc_dev->dev.release = fsl_mc_device_release;
823 mc_dev->dev.type = fsl_mc_get_device_type(obj_desc->type);
824 if (!mc_dev->dev.type) {
826 dev_err(parent_dev, "unknown device type %s\n", obj_desc->type);
827 goto error_cleanup_dev;
829 dev_set_name(&mc_dev->dev, "%s.%d", obj_desc->type, obj_desc->id);
831 if (strcmp(obj_desc->type, "dprc") == 0) {
832 struct fsl_mc_io *mc_io2;
834 mc_dev->flags |= FSL_MC_IS_DPRC;
837 * To get the DPRC's ICID, we need to open the DPRC
838 * in get_dprc_icid(). For child DPRCs, we do so using the
839 * parent DPRC's MC portal instead of the child DPRC's MC
840 * portal, in case the child DPRC is already opened with
841 * its own portal (e.g., the DPRC used by AIOP).
843 * NOTE: There cannot be more than one active open for a
844 * given MC object, using the same MC portal.
848 * device being added is a child DPRC device
850 mc_io2 = parent_mc_dev->mc_io;
853 * device being added is the root DPRC device
857 goto error_cleanup_dev;
863 error = get_dprc_icid(mc_io2, obj_desc->id, &mc_dev->icid);
865 goto error_cleanup_dev;
868 * A non-DPRC object has to be a child of a DPRC, use the
869 * parent's ICID and interrupt domain.
871 mc_dev->icid = parent_mc_dev->icid;
872 mc_dev->dma_mask = FSL_MC_DEFAULT_DMA_MASK;
873 mc_dev->dev.dma_mask = &mc_dev->dma_mask;
874 mc_dev->dev.coherent_dma_mask = mc_dev->dma_mask;
875 dev_set_msi_domain(&mc_dev->dev,
876 dev_get_msi_domain(&parent_mc_dev->dev));
880 * Get MMIO regions for the device from the MC:
882 * NOTE: the root DPRC is a special case as its MMIO region is
883 * obtained from the device tree
885 if (parent_mc_dev && obj_desc->region_count != 0) {
886 error = fsl_mc_device_get_mmio_regions(mc_dev,
889 goto error_cleanup_dev;
893 * The device-specific probe callback will get invoked by device_add()
895 error = device_add(&mc_dev->dev);
898 "device_add() failed for device %s: %d\n",
899 dev_name(&mc_dev->dev), error);
900 goto error_cleanup_dev;
903 dev_dbg(parent_dev, "added %s\n", dev_name(&mc_dev->dev));
905 *new_mc_dev = mc_dev;
909 kfree(mc_dev->regions);
915 EXPORT_SYMBOL_GPL(fsl_mc_device_add);
917 static struct notifier_block fsl_mc_nb;
920 * fsl_mc_device_remove - Remove an fsl-mc device from being visible to
923 * @mc_dev: Pointer to an fsl-mc device
925 void fsl_mc_device_remove(struct fsl_mc_device *mc_dev)
927 kfree(mc_dev->driver_override);
928 mc_dev->driver_override = NULL;
931 * The device-specific remove callback will get invoked by device_del()
933 device_del(&mc_dev->dev);
934 put_device(&mc_dev->dev);
936 EXPORT_SYMBOL_GPL(fsl_mc_device_remove);
938 struct fsl_mc_device *fsl_mc_get_endpoint(struct fsl_mc_device *mc_dev,
941 struct fsl_mc_device *mc_bus_dev, *endpoint;
942 struct fsl_mc_obj_desc endpoint_desc = {{ 0 }};
943 struct dprc_endpoint endpoint1 = {{ 0 }};
944 struct dprc_endpoint endpoint2 = {{ 0 }};
947 mc_bus_dev = to_fsl_mc_device(mc_dev->dev.parent);
948 strcpy(endpoint1.type, mc_dev->obj_desc.type);
949 endpoint1.id = mc_dev->obj_desc.id;
950 endpoint1.if_id = if_id;
952 err = dprc_get_connection(mc_bus_dev->mc_io, 0,
953 mc_bus_dev->mc_handle,
954 &endpoint1, &endpoint2,
957 if (err == -ENOTCONN || state == -1)
958 return ERR_PTR(-ENOTCONN);
961 dev_err(&mc_bus_dev->dev, "dprc_get_connection() = %d\n", err);
965 strcpy(endpoint_desc.type, endpoint2.type);
966 endpoint_desc.id = endpoint2.id;
967 endpoint = fsl_mc_device_lookup(&endpoint_desc, mc_bus_dev);
970 * We know that the device has an endpoint because we verified by
971 * interrogating the firmware. This is the case when the device was not
972 * yet discovered by the fsl-mc bus, thus the lookup returned NULL.
973 * Force a rescan of the devices in this container and retry the lookup.
976 struct fsl_mc_bus *mc_bus = to_fsl_mc_bus(mc_bus_dev);
978 if (mutex_trylock(&mc_bus->scan_mutex)) {
979 err = dprc_scan_objects(mc_bus_dev, true);
980 mutex_unlock(&mc_bus->scan_mutex);
987 endpoint = fsl_mc_device_lookup(&endpoint_desc, mc_bus_dev);
989 * This means that the endpoint might reside in a different isolation
990 * context (DPRC/container). Not much to do, so return a permssion
994 return ERR_PTR(-EPERM);
998 EXPORT_SYMBOL_GPL(fsl_mc_get_endpoint);
1000 static int parse_mc_ranges(struct device *dev,
1004 const __be32 **ranges_start)
1007 int range_tuple_cell_count;
1010 struct device_node *mc_node = dev->of_node;
1012 *ranges_start = of_get_property(mc_node, "ranges", &ranges_len);
1013 if (!(*ranges_start) || !ranges_len) {
1015 "missing or empty ranges property for device tree node '%pOFn'\n",
1020 *paddr_cells = of_n_addr_cells(mc_node);
1022 prop = of_get_property(mc_node, "#address-cells", NULL);
1024 *mc_addr_cells = be32_to_cpup(prop);
1026 *mc_addr_cells = *paddr_cells;
1028 prop = of_get_property(mc_node, "#size-cells", NULL);
1030 *mc_size_cells = be32_to_cpup(prop);
1032 *mc_size_cells = of_n_size_cells(mc_node);
1034 range_tuple_cell_count = *paddr_cells + *mc_addr_cells +
1037 tuple_len = range_tuple_cell_count * sizeof(__be32);
1038 if (ranges_len % tuple_len != 0) {
1039 dev_err(dev, "malformed ranges property '%pOFn'\n", mc_node);
1043 return ranges_len / tuple_len;
1046 static int get_mc_addr_translation_ranges(struct device *dev,
1047 struct fsl_mc_addr_translation_range
1056 const __be32 *ranges_start;
1059 ret = parse_mc_ranges(dev,
1070 * Missing or empty ranges property ("ranges;") for the
1071 * 'fsl,qoriq-mc' node. In this case, identity mapping
1078 *ranges = devm_kcalloc(dev, *num_ranges,
1079 sizeof(struct fsl_mc_addr_translation_range),
1084 cell = ranges_start;
1085 for (i = 0; i < *num_ranges; ++i) {
1086 struct fsl_mc_addr_translation_range *range = &(*ranges)[i];
1088 range->mc_region_type = of_read_number(cell, 1);
1089 range->start_mc_offset = of_read_number(cell + 1,
1091 cell += mc_addr_cells;
1092 range->start_phys_addr = of_read_number(cell, paddr_cells);
1093 cell += paddr_cells;
1094 range->end_mc_offset = range->start_mc_offset +
1095 of_read_number(cell, mc_size_cells);
1097 cell += mc_size_cells;
1104 * fsl_mc_bus_probe - callback invoked when the root MC bus is being
1107 static int fsl_mc_bus_probe(struct platform_device *pdev)
1109 struct fsl_mc_obj_desc obj_desc;
1112 struct fsl_mc_device *mc_bus_dev = NULL;
1113 struct fsl_mc_io *mc_io = NULL;
1115 phys_addr_t mc_portal_phys_addr;
1116 u32 mc_portal_size, mc_stream_id;
1117 struct resource *plat_res;
1119 mc = devm_kzalloc(&pdev->dev, sizeof(*mc), GFP_KERNEL);
1123 platform_set_drvdata(pdev, mc);
1125 plat_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1127 mc->fsl_mc_regs = devm_ioremap_resource(&pdev->dev, plat_res);
1128 if (IS_ERR(mc->fsl_mc_regs))
1129 return PTR_ERR(mc->fsl_mc_regs);
1132 if (mc->fsl_mc_regs) {
1133 if (IS_ENABLED(CONFIG_ACPI) && !dev_of_node(&pdev->dev)) {
1134 mc_stream_id = readl(mc->fsl_mc_regs + FSL_MC_FAPR);
1136 * HW ORs the PL and BMT bit, places the result in bit
1137 * 14 of the StreamID and ORs in the ICID. Calculate it
1140 mc_stream_id = (mc_stream_id & 0xffff) |
1141 ((mc_stream_id & (MC_FAPR_PL | MC_FAPR_BMT)) ?
1143 error = acpi_dma_configure_id(&pdev->dev,
1146 if (error == -EPROBE_DEFER)
1149 dev_warn(&pdev->dev,
1150 "failed to configure dma: %d.\n",
1155 * Some bootloaders pause the MC firmware before booting the
1156 * kernel so that MC will not cause faults as soon as the
1157 * SMMU probes due to the fact that there's no configuration
1159 * At this point MC should have all its SMMU setup done so make
1160 * sure it is resumed.
1162 writel(readl(mc->fsl_mc_regs + FSL_MC_GCR1) &
1163 (~(GCR1_P1_STOP | GCR1_P2_STOP)),
1164 mc->fsl_mc_regs + FSL_MC_GCR1);
1168 * Get physical address of MC portal for the root DPRC:
1170 plat_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1171 mc_portal_phys_addr = plat_res->start;
1172 mc_portal_size = resource_size(plat_res);
1173 mc_portal_base_phys_addr = mc_portal_phys_addr & ~0x3ffffff;
1175 error = fsl_create_mc_io(&pdev->dev, mc_portal_phys_addr,
1176 mc_portal_size, NULL,
1177 FSL_MC_IO_ATOMIC_CONTEXT_PORTAL, &mc_io);
1181 error = mc_get_version(mc_io, 0, &mc_version);
1184 "mc_get_version() failed with error %d\n", error);
1185 goto error_cleanup_mc_io;
1188 dev_info(&pdev->dev, "MC firmware version: %u.%u.%u\n",
1189 mc_version.major, mc_version.minor, mc_version.revision);
1191 if (dev_of_node(&pdev->dev)) {
1192 error = get_mc_addr_translation_ranges(&pdev->dev,
1193 &mc->translation_ranges,
1194 &mc->num_translation_ranges);
1196 goto error_cleanup_mc_io;
1199 error = dprc_get_container_id(mc_io, 0, &container_id);
1202 "dprc_get_container_id() failed: %d\n", error);
1203 goto error_cleanup_mc_io;
1206 memset(&obj_desc, 0, sizeof(struct fsl_mc_obj_desc));
1207 error = dprc_get_api_version(mc_io, 0,
1208 &obj_desc.ver_major,
1209 &obj_desc.ver_minor);
1211 goto error_cleanup_mc_io;
1213 obj_desc.vendor = FSL_MC_VENDOR_FREESCALE;
1214 strcpy(obj_desc.type, "dprc");
1215 obj_desc.id = container_id;
1216 obj_desc.irq_count = 1;
1217 obj_desc.region_count = 0;
1219 error = fsl_mc_device_add(&obj_desc, mc_io, &pdev->dev, &mc_bus_dev);
1221 goto error_cleanup_mc_io;
1223 mc->root_mc_bus_dev = mc_bus_dev;
1224 mc_bus_dev->dev.fwnode = pdev->dev.fwnode;
1227 error_cleanup_mc_io:
1228 fsl_destroy_mc_io(mc_io);
1233 * fsl_mc_bus_remove - callback invoked when the root MC bus is being
1236 static int fsl_mc_bus_remove(struct platform_device *pdev)
1238 struct fsl_mc *mc = platform_get_drvdata(pdev);
1240 if (!fsl_mc_is_root_dprc(&mc->root_mc_bus_dev->dev))
1243 fsl_mc_device_remove(mc->root_mc_bus_dev);
1245 fsl_destroy_mc_io(mc->root_mc_bus_dev->mc_io);
1246 mc->root_mc_bus_dev->mc_io = NULL;
1248 bus_unregister_notifier(&fsl_mc_bus_type, &fsl_mc_nb);
1250 if (mc->fsl_mc_regs) {
1252 * Pause the MC firmware so that it doesn't crash in certain
1253 * scenarios, such as kexec.
1255 writel(readl(mc->fsl_mc_regs + FSL_MC_GCR1) |
1256 (GCR1_P1_STOP | GCR1_P2_STOP),
1257 mc->fsl_mc_regs + FSL_MC_GCR1);
1263 static void fsl_mc_bus_shutdown(struct platform_device *pdev)
1265 fsl_mc_bus_remove(pdev);
1268 static const struct of_device_id fsl_mc_bus_match_table[] = {
1269 {.compatible = "fsl,qoriq-mc",},
1273 MODULE_DEVICE_TABLE(of, fsl_mc_bus_match_table);
1275 static const struct acpi_device_id fsl_mc_bus_acpi_match_table[] = {
1279 MODULE_DEVICE_TABLE(acpi, fsl_mc_bus_acpi_match_table);
1281 static struct platform_driver fsl_mc_bus_driver = {
1283 .name = "fsl_mc_bus",
1285 .of_match_table = fsl_mc_bus_match_table,
1286 .acpi_match_table = fsl_mc_bus_acpi_match_table,
1288 .probe = fsl_mc_bus_probe,
1289 .remove = fsl_mc_bus_remove,
1290 .shutdown = fsl_mc_bus_shutdown,
1293 static int fsl_mc_bus_notifier(struct notifier_block *nb,
1294 unsigned long action, void *data)
1296 struct device *dev = data;
1297 struct resource *res;
1298 void __iomem *fsl_mc_regs;
1300 if (action != BUS_NOTIFY_ADD_DEVICE)
1303 if (!of_match_device(fsl_mc_bus_match_table, dev) &&
1304 !acpi_match_device(fsl_mc_bus_acpi_match_table, dev))
1307 res = platform_get_resource(to_platform_device(dev), IORESOURCE_MEM, 1);
1311 fsl_mc_regs = ioremap(res->start, resource_size(res));
1316 * Make sure that the MC firmware is paused before the IOMMU setup for
1317 * it is done or otherwise the firmware will crash right after the SMMU
1318 * gets probed and enabled.
1320 writel(readl(fsl_mc_regs + FSL_MC_GCR1) | (GCR1_P1_STOP | GCR1_P2_STOP),
1321 fsl_mc_regs + FSL_MC_GCR1);
1322 iounmap(fsl_mc_regs);
1327 static struct notifier_block fsl_mc_nb = {
1328 .notifier_call = fsl_mc_bus_notifier,
1331 static int __init fsl_mc_bus_driver_init(void)
1335 error = bus_register(&fsl_mc_bus_type);
1337 pr_err("bus type registration failed: %d\n", error);
1338 goto error_cleanup_cache;
1341 error = platform_driver_register(&fsl_mc_bus_driver);
1343 pr_err("platform_driver_register() failed: %d\n", error);
1344 goto error_cleanup_bus;
1347 error = dprc_driver_init();
1349 goto error_cleanup_driver;
1351 error = fsl_mc_allocator_driver_init();
1353 goto error_cleanup_dprc_driver;
1355 return bus_register_notifier(&platform_bus_type, &fsl_mc_nb);
1357 error_cleanup_dprc_driver:
1360 error_cleanup_driver:
1361 platform_driver_unregister(&fsl_mc_bus_driver);
1364 bus_unregister(&fsl_mc_bus_type);
1366 error_cleanup_cache:
1369 postcore_initcall(fsl_mc_bus_driver_init);