xref: /openbmc/linux/drivers/bus/mips_cdmm.c (revision 9a87ffc99ec8eb8d35eed7c4f816d75f5cc9662e)
18286ae03SJames Hogan /*
28286ae03SJames Hogan  * Bus driver for MIPS Common Device Memory Map (CDMM).
38286ae03SJames Hogan  *
48286ae03SJames Hogan  * Copyright (C) 2014-2015 Imagination Technologies Ltd.
58286ae03SJames Hogan  *
68286ae03SJames Hogan  * This file is subject to the terms and conditions of the GNU General Public
78286ae03SJames Hogan  * License.  See the file "COPYING" in the main directory of this archive
88286ae03SJames Hogan  * for more details.
98286ae03SJames Hogan  */
108286ae03SJames Hogan 
118286ae03SJames Hogan #include <linux/atomic.h>
128286ae03SJames Hogan #include <linux/err.h>
138286ae03SJames Hogan #include <linux/cpu.h>
148286ae03SJames Hogan #include <linux/cpumask.h>
158286ae03SJames Hogan #include <linux/io.h>
162121aa3eSSerge Semin #include <linux/of_address.h>
172121aa3eSSerge Semin #include <linux/of.h>
188286ae03SJames Hogan #include <linux/platform_device.h>
198286ae03SJames Hogan #include <linux/slab.h>
208286ae03SJames Hogan #include <linux/smp.h>
218286ae03SJames Hogan #include <asm/cdmm.h>
228286ae03SJames Hogan #include <asm/hazards.h>
238286ae03SJames Hogan #include <asm/mipsregs.h>
248286ae03SJames Hogan 
258286ae03SJames Hogan /* Access control and status register fields */
268286ae03SJames Hogan #define CDMM_ACSR_DEVTYPE_SHIFT	24
278286ae03SJames Hogan #define CDMM_ACSR_DEVTYPE	(255ul << CDMM_ACSR_DEVTYPE_SHIFT)
288286ae03SJames Hogan #define CDMM_ACSR_DEVSIZE_SHIFT	16
298286ae03SJames Hogan #define CDMM_ACSR_DEVSIZE	(31ul << CDMM_ACSR_DEVSIZE_SHIFT)
308286ae03SJames Hogan #define CDMM_ACSR_DEVREV_SHIFT	12
318286ae03SJames Hogan #define CDMM_ACSR_DEVREV	(15ul << CDMM_ACSR_DEVREV_SHIFT)
328286ae03SJames Hogan #define CDMM_ACSR_UW		(1ul << 3)
338286ae03SJames Hogan #define CDMM_ACSR_UR		(1ul << 2)
348286ae03SJames Hogan #define CDMM_ACSR_SW		(1ul << 1)
358286ae03SJames Hogan #define CDMM_ACSR_SR		(1ul << 0)
368286ae03SJames Hogan 
378286ae03SJames Hogan /* Each block of device registers is 64 bytes */
388286ae03SJames Hogan #define CDMM_DRB_SIZE		64
398286ae03SJames Hogan 
408286ae03SJames Hogan #define to_mips_cdmm_driver(d)	container_of(d, struct mips_cdmm_driver, drv)
418286ae03SJames Hogan 
428286ae03SJames Hogan /* Default physical base address */
438286ae03SJames Hogan static phys_addr_t mips_cdmm_default_base;
448286ae03SJames Hogan 
458286ae03SJames Hogan /* Bus operations */
468286ae03SJames Hogan 
478286ae03SJames Hogan static const struct mips_cdmm_device_id *
mips_cdmm_lookup(const struct mips_cdmm_device_id * table,struct mips_cdmm_device * dev)488286ae03SJames Hogan mips_cdmm_lookup(const struct mips_cdmm_device_id *table,
498286ae03SJames Hogan 		 struct mips_cdmm_device *dev)
508286ae03SJames Hogan {
518286ae03SJames Hogan 	int ret = 0;
528286ae03SJames Hogan 
538286ae03SJames Hogan 	for (; table->type; ++table) {
548286ae03SJames Hogan 		ret = (dev->type == table->type);
558286ae03SJames Hogan 		if (ret)
568286ae03SJames Hogan 			break;
578286ae03SJames Hogan 	}
588286ae03SJames Hogan 
598286ae03SJames Hogan 	return ret ? table : NULL;
608286ae03SJames Hogan }
618286ae03SJames Hogan 
mips_cdmm_match(struct device * dev,struct device_driver * drv)628286ae03SJames Hogan static int mips_cdmm_match(struct device *dev, struct device_driver *drv)
638286ae03SJames Hogan {
648286ae03SJames Hogan 	struct mips_cdmm_device *cdev = to_mips_cdmm_device(dev);
658286ae03SJames Hogan 	struct mips_cdmm_driver *cdrv = to_mips_cdmm_driver(drv);
668286ae03SJames Hogan 
678286ae03SJames Hogan 	return mips_cdmm_lookup(cdrv->id_table, cdev) != NULL;
688286ae03SJames Hogan }
698286ae03SJames Hogan 
mips_cdmm_uevent(const struct device * dev,struct kobj_uevent_env * env)70*2a81ada3SGreg Kroah-Hartman static int mips_cdmm_uevent(const struct device *dev, struct kobj_uevent_env *env)
718286ae03SJames Hogan {
72*2a81ada3SGreg Kroah-Hartman 	const struct mips_cdmm_device *cdev = to_mips_cdmm_device(dev);
738286ae03SJames Hogan 	int retval = 0;
748286ae03SJames Hogan 
758286ae03SJames Hogan 	retval = add_uevent_var(env, "CDMM_CPU=%u", cdev->cpu);
768286ae03SJames Hogan 	if (retval)
778286ae03SJames Hogan 		return retval;
788286ae03SJames Hogan 
798286ae03SJames Hogan 	retval = add_uevent_var(env, "CDMM_TYPE=0x%02x", cdev->type);
808286ae03SJames Hogan 	if (retval)
818286ae03SJames Hogan 		return retval;
828286ae03SJames Hogan 
838286ae03SJames Hogan 	retval = add_uevent_var(env, "CDMM_REV=%u", cdev->rev);
848286ae03SJames Hogan 	if (retval)
858286ae03SJames Hogan 		return retval;
868286ae03SJames Hogan 
878286ae03SJames Hogan 	retval = add_uevent_var(env, "MODALIAS=mipscdmm:t%02X", cdev->type);
888286ae03SJames Hogan 	return retval;
898286ae03SJames Hogan }
908286ae03SJames Hogan 
918286ae03SJames Hogan /* Device attributes */
928286ae03SJames Hogan 
938286ae03SJames Hogan #define CDMM_ATTR(name, fmt, arg...)					\
948286ae03SJames Hogan static ssize_t name##_show(struct device *_dev,				\
958286ae03SJames Hogan 			   struct device_attribute *attr, char *buf)	\
968286ae03SJames Hogan {									\
978286ae03SJames Hogan 	struct mips_cdmm_device *dev = to_mips_cdmm_device(_dev);	\
988286ae03SJames Hogan 	return sprintf(buf, fmt, arg);					\
998286ae03SJames Hogan }									\
1008286ae03SJames Hogan static DEVICE_ATTR_RO(name);
1018286ae03SJames Hogan 
1028286ae03SJames Hogan CDMM_ATTR(cpu, "%u\n", dev->cpu);
1038286ae03SJames Hogan CDMM_ATTR(type, "0x%02x\n", dev->type);
1048286ae03SJames Hogan CDMM_ATTR(revision, "%u\n", dev->rev);
1058286ae03SJames Hogan CDMM_ATTR(modalias, "mipscdmm:t%02X\n", dev->type);
1068286ae03SJames Hogan CDMM_ATTR(resource, "\t%016llx\t%016llx\t%016lx\n",
1078286ae03SJames Hogan 	  (unsigned long long)dev->res.start,
1088286ae03SJames Hogan 	  (unsigned long long)dev->res.end,
1098286ae03SJames Hogan 	  dev->res.flags);
1108286ae03SJames Hogan 
1118286ae03SJames Hogan static struct attribute *mips_cdmm_dev_attrs[] = {
1128286ae03SJames Hogan 	&dev_attr_cpu.attr,
1138286ae03SJames Hogan 	&dev_attr_type.attr,
1148286ae03SJames Hogan 	&dev_attr_revision.attr,
1158286ae03SJames Hogan 	&dev_attr_modalias.attr,
1168286ae03SJames Hogan 	&dev_attr_resource.attr,
1178286ae03SJames Hogan 	NULL,
1188286ae03SJames Hogan };
1198286ae03SJames Hogan ATTRIBUTE_GROUPS(mips_cdmm_dev);
1208286ae03SJames Hogan 
1218286ae03SJames Hogan struct bus_type mips_cdmm_bustype = {
1228286ae03SJames Hogan 	.name		= "cdmm",
1238286ae03SJames Hogan 	.dev_groups	= mips_cdmm_dev_groups,
1248286ae03SJames Hogan 	.match		= mips_cdmm_match,
1258286ae03SJames Hogan 	.uevent		= mips_cdmm_uevent,
1268286ae03SJames Hogan };
1278286ae03SJames Hogan EXPORT_SYMBOL_GPL(mips_cdmm_bustype);
1288286ae03SJames Hogan 
1298286ae03SJames Hogan /*
1308286ae03SJames Hogan  * Standard driver callback helpers.
1318286ae03SJames Hogan  *
1328286ae03SJames Hogan  * All the CDMM driver callbacks need to be executed on the appropriate CPU from
1338286ae03SJames Hogan  * workqueues. For the standard driver callbacks we need a work function
1348286ae03SJames Hogan  * (mips_cdmm_{void,int}_work()) to do the actual call from the right CPU, and a
1358286ae03SJames Hogan  * wrapper function (generated with BUILD_PERCPU_HELPER) to arrange for the work
1368286ae03SJames Hogan  * function to be called on that CPU.
1378286ae03SJames Hogan  */
1388286ae03SJames Hogan 
1398286ae03SJames Hogan /**
1408286ae03SJames Hogan  * struct mips_cdmm_work_dev - Data for per-device call work.
1418286ae03SJames Hogan  * @fn:		CDMM driver callback function to call for the device.
1428286ae03SJames Hogan  * @dev:	CDMM device to pass to @fn.
1438286ae03SJames Hogan  */
1448286ae03SJames Hogan struct mips_cdmm_work_dev {
1458286ae03SJames Hogan 	void			*fn;
1468286ae03SJames Hogan 	struct mips_cdmm_device *dev;
1478286ae03SJames Hogan };
1488286ae03SJames Hogan 
1498286ae03SJames Hogan /**
1508286ae03SJames Hogan  * mips_cdmm_void_work() - Call a void returning CDMM driver callback.
1518286ae03SJames Hogan  * @data:	struct mips_cdmm_work_dev pointer.
1528286ae03SJames Hogan  *
1538286ae03SJames Hogan  * A work_on_cpu() callback function to call an arbitrary CDMM driver callback
1548286ae03SJames Hogan  * function which doesn't return a value.
1558286ae03SJames Hogan  */
mips_cdmm_void_work(void * data)1568286ae03SJames Hogan static long mips_cdmm_void_work(void *data)
1578286ae03SJames Hogan {
1588286ae03SJames Hogan 	struct mips_cdmm_work_dev *work = data;
1598286ae03SJames Hogan 	void (*fn)(struct mips_cdmm_device *) = work->fn;
1608286ae03SJames Hogan 
1618286ae03SJames Hogan 	fn(work->dev);
1628286ae03SJames Hogan 	return 0;
1638286ae03SJames Hogan }
1648286ae03SJames Hogan 
1658286ae03SJames Hogan /**
1668286ae03SJames Hogan  * mips_cdmm_int_work() - Call an int returning CDMM driver callback.
1678286ae03SJames Hogan  * @data:	struct mips_cdmm_work_dev pointer.
1688286ae03SJames Hogan  *
1698286ae03SJames Hogan  * A work_on_cpu() callback function to call an arbitrary CDMM driver callback
1708286ae03SJames Hogan  * function which returns an int.
1718286ae03SJames Hogan  */
mips_cdmm_int_work(void * data)1728286ae03SJames Hogan static long mips_cdmm_int_work(void *data)
1738286ae03SJames Hogan {
1748286ae03SJames Hogan 	struct mips_cdmm_work_dev *work = data;
1758286ae03SJames Hogan 	int (*fn)(struct mips_cdmm_device *) = work->fn;
1768286ae03SJames Hogan 
1778286ae03SJames Hogan 	return fn(work->dev);
1788286ae03SJames Hogan }
1798286ae03SJames Hogan 
1808286ae03SJames Hogan #define _BUILD_RET_void
1818286ae03SJames Hogan #define _BUILD_RET_int	return
1828286ae03SJames Hogan 
1838286ae03SJames Hogan /**
1848286ae03SJames Hogan  * BUILD_PERCPU_HELPER() - Helper to call a CDMM driver callback on right CPU.
1858286ae03SJames Hogan  * @_ret:	Return type (void or int).
1868286ae03SJames Hogan  * @_name:	Name of CDMM driver callback function.
1878286ae03SJames Hogan  *
1888286ae03SJames Hogan  * Generates a specific device callback function to call a CDMM driver callback
1898286ae03SJames Hogan  * function on the appropriate CPU for the device, and if applicable return the
1908286ae03SJames Hogan  * result.
1918286ae03SJames Hogan  */
1928286ae03SJames Hogan #define BUILD_PERCPU_HELPER(_ret, _name)				\
1938286ae03SJames Hogan static _ret mips_cdmm_##_name(struct device *dev)			\
1948286ae03SJames Hogan {									\
1958286ae03SJames Hogan 	struct mips_cdmm_device *cdev = to_mips_cdmm_device(dev);	\
1968286ae03SJames Hogan 	struct mips_cdmm_driver *cdrv = to_mips_cdmm_driver(dev->driver); \
1978286ae03SJames Hogan 	struct mips_cdmm_work_dev work = {				\
1988286ae03SJames Hogan 		.fn	= cdrv->_name,					\
1998286ae03SJames Hogan 		.dev	= cdev,						\
2008286ae03SJames Hogan 	};								\
2018286ae03SJames Hogan 									\
2028286ae03SJames Hogan 	_BUILD_RET_##_ret work_on_cpu(cdev->cpu,			\
2038286ae03SJames Hogan 				      mips_cdmm_##_ret##_work, &work);	\
2048286ae03SJames Hogan }
2058286ae03SJames Hogan 
2068286ae03SJames Hogan /* Driver callback functions */
BUILD_PERCPU_HELPER(int,probe)2078286ae03SJames Hogan BUILD_PERCPU_HELPER(int, probe)     /* int mips_cdmm_probe(struct device) */
2088286ae03SJames Hogan BUILD_PERCPU_HELPER(int, remove)    /* int mips_cdmm_remove(struct device) */
2098286ae03SJames Hogan BUILD_PERCPU_HELPER(void, shutdown) /* void mips_cdmm_shutdown(struct device) */
2108286ae03SJames Hogan 
2118286ae03SJames Hogan 
2128286ae03SJames Hogan /* Driver registration */
2138286ae03SJames Hogan 
2148286ae03SJames Hogan /**
2158286ae03SJames Hogan  * mips_cdmm_driver_register() - Register a CDMM driver.
2168286ae03SJames Hogan  * @drv:	CDMM driver information.
2178286ae03SJames Hogan  *
2188286ae03SJames Hogan  * Register a CDMM driver with the CDMM subsystem. The driver will be informed
2198286ae03SJames Hogan  * of matching devices which are discovered.
2208286ae03SJames Hogan  *
2218286ae03SJames Hogan  * Returns:	0 on success.
2228286ae03SJames Hogan  */
2238286ae03SJames Hogan int mips_cdmm_driver_register(struct mips_cdmm_driver *drv)
2248286ae03SJames Hogan {
2258286ae03SJames Hogan 	drv->drv.bus = &mips_cdmm_bustype;
2268286ae03SJames Hogan 
2278286ae03SJames Hogan 	if (drv->probe)
2288286ae03SJames Hogan 		drv->drv.probe = mips_cdmm_probe;
2298286ae03SJames Hogan 	if (drv->remove)
2308286ae03SJames Hogan 		drv->drv.remove = mips_cdmm_remove;
2318286ae03SJames Hogan 	if (drv->shutdown)
2328286ae03SJames Hogan 		drv->drv.shutdown = mips_cdmm_shutdown;
2338286ae03SJames Hogan 
2348286ae03SJames Hogan 	return driver_register(&drv->drv);
2358286ae03SJames Hogan }
2368286ae03SJames Hogan EXPORT_SYMBOL_GPL(mips_cdmm_driver_register);
2378286ae03SJames Hogan 
2388286ae03SJames Hogan /**
2398286ae03SJames Hogan  * mips_cdmm_driver_unregister() - Unregister a CDMM driver.
2408286ae03SJames Hogan  * @drv:	CDMM driver information.
2418286ae03SJames Hogan  *
2428286ae03SJames Hogan  * Unregister a CDMM driver from the CDMM subsystem.
2438286ae03SJames Hogan  */
mips_cdmm_driver_unregister(struct mips_cdmm_driver * drv)2448286ae03SJames Hogan void mips_cdmm_driver_unregister(struct mips_cdmm_driver *drv)
2458286ae03SJames Hogan {
2468286ae03SJames Hogan 	driver_unregister(&drv->drv);
2478286ae03SJames Hogan }
2488286ae03SJames Hogan EXPORT_SYMBOL_GPL(mips_cdmm_driver_unregister);
2498286ae03SJames Hogan 
2508286ae03SJames Hogan 
2518286ae03SJames Hogan /* CDMM initialisation and bus discovery */
2528286ae03SJames Hogan 
2538286ae03SJames Hogan /**
2548286ae03SJames Hogan  * struct mips_cdmm_bus - Info about CDMM bus.
2558286ae03SJames Hogan  * @phys:		Physical address at which it is mapped.
2568286ae03SJames Hogan  * @regs:		Virtual address where registers can be accessed.
2578286ae03SJames Hogan  * @drbs:		Total number of DRBs.
2588286ae03SJames Hogan  * @drbs_reserved:	Number of DRBs reserved.
2598286ae03SJames Hogan  * @discovered:		Whether the devices on the bus have been discovered yet.
2608286ae03SJames Hogan  * @offline:		Whether the CDMM bus is going offline (or very early
2618286ae03SJames Hogan  *			coming back online), in which case it should be
2628286ae03SJames Hogan  *			reconfigured each time.
2638286ae03SJames Hogan  */
2648286ae03SJames Hogan struct mips_cdmm_bus {
2658286ae03SJames Hogan 	phys_addr_t	 phys;
2668286ae03SJames Hogan 	void __iomem	*regs;
2678286ae03SJames Hogan 	unsigned int	 drbs;
2688286ae03SJames Hogan 	unsigned int	 drbs_reserved;
2698286ae03SJames Hogan 	bool		 discovered;
2708286ae03SJames Hogan 	bool		 offline;
2718286ae03SJames Hogan };
2728286ae03SJames Hogan 
2738286ae03SJames Hogan static struct mips_cdmm_bus mips_cdmm_boot_bus;
2748286ae03SJames Hogan static DEFINE_PER_CPU(struct mips_cdmm_bus *, mips_cdmm_buses);
2758286ae03SJames Hogan static atomic_t mips_cdmm_next_id = ATOMIC_INIT(-1);
2768286ae03SJames Hogan 
2778286ae03SJames Hogan /**
2788286ae03SJames Hogan  * mips_cdmm_get_bus() - Get the per-CPU CDMM bus information.
2798286ae03SJames Hogan  *
2808286ae03SJames Hogan  * Get information about the per-CPU CDMM bus, if the bus is present.
2818286ae03SJames Hogan  *
2828286ae03SJames Hogan  * The caller must prevent migration to another CPU, either by disabling
2838286ae03SJames Hogan  * pre-emption or by running from a pinned kernel thread.
2848286ae03SJames Hogan  *
2858286ae03SJames Hogan  * Returns:	Pointer to CDMM bus information for the current CPU.
2868286ae03SJames Hogan  *		May return ERR_PTR(-errno) in case of error, so check with
2878286ae03SJames Hogan  *		IS_ERR().
2888286ae03SJames Hogan  */
mips_cdmm_get_bus(void)2898286ae03SJames Hogan static struct mips_cdmm_bus *mips_cdmm_get_bus(void)
2908286ae03SJames Hogan {
2918286ae03SJames Hogan 	struct mips_cdmm_bus *bus, **bus_p;
2928286ae03SJames Hogan 	unsigned long flags;
2938286ae03SJames Hogan 	unsigned int cpu;
2948286ae03SJames Hogan 
2958286ae03SJames Hogan 	if (!cpu_has_cdmm)
2968286ae03SJames Hogan 		return ERR_PTR(-ENODEV);
2978286ae03SJames Hogan 
2988286ae03SJames Hogan 	cpu = smp_processor_id();
2998286ae03SJames Hogan 	/* Avoid early use of per-cpu primitives before initialised */
3008286ae03SJames Hogan 	if (cpu == 0)
3018286ae03SJames Hogan 		return &mips_cdmm_boot_bus;
3028286ae03SJames Hogan 
3038286ae03SJames Hogan 	/* Get bus pointer */
3048286ae03SJames Hogan 	bus_p = per_cpu_ptr(&mips_cdmm_buses, cpu);
3058286ae03SJames Hogan 	local_irq_save(flags);
3068286ae03SJames Hogan 	bus = *bus_p;
3078286ae03SJames Hogan 	/* Attempt allocation if NULL */
3088286ae03SJames Hogan 	if (unlikely(!bus)) {
3098286ae03SJames Hogan 		bus = kzalloc(sizeof(*bus), GFP_ATOMIC);
3108286ae03SJames Hogan 		if (unlikely(!bus))
3118286ae03SJames Hogan 			bus = ERR_PTR(-ENOMEM);
3128286ae03SJames Hogan 		else
3138286ae03SJames Hogan 			*bus_p = bus;
3148286ae03SJames Hogan 	}
3158286ae03SJames Hogan 	local_irq_restore(flags);
3168286ae03SJames Hogan 	return bus;
3178286ae03SJames Hogan }
3188286ae03SJames Hogan 
3198286ae03SJames Hogan /**
3208286ae03SJames Hogan  * mips_cdmm_cur_base() - Find current physical base address of CDMM region.
3218286ae03SJames Hogan  *
3228286ae03SJames Hogan  * Returns:	Physical base address of CDMM region according to cdmmbase CP0
3238286ae03SJames Hogan  *		register, or 0 if the CDMM region is disabled.
3248286ae03SJames Hogan  */
mips_cdmm_cur_base(void)3258286ae03SJames Hogan static phys_addr_t mips_cdmm_cur_base(void)
3268286ae03SJames Hogan {
3278286ae03SJames Hogan 	unsigned long cdmmbase = read_c0_cdmmbase();
3288286ae03SJames Hogan 
3298286ae03SJames Hogan 	if (!(cdmmbase & MIPS_CDMMBASE_EN))
3308286ae03SJames Hogan 		return 0;
3318286ae03SJames Hogan 
3328286ae03SJames Hogan 	return (cdmmbase >> MIPS_CDMMBASE_ADDR_SHIFT)
3338286ae03SJames Hogan 		<< MIPS_CDMMBASE_ADDR_START;
3348286ae03SJames Hogan }
3358286ae03SJames Hogan 
3368286ae03SJames Hogan /**
337e1d97497SBjorn Helgaas  * mips_cdmm_phys_base() - Choose a physical base address for CDMM region.
338e1d97497SBjorn Helgaas  *
339e1d97497SBjorn Helgaas  * Picking a suitable physical address at which to map the CDMM region is
340e1d97497SBjorn Helgaas  * platform specific, so this weak function can be overridden by platform
341e1d97497SBjorn Helgaas  * code to pick a suitable value if none is configured by the bootloader.
3422121aa3eSSerge Semin  * By default this method tries to find a CDMM-specific node in the system
3432121aa3eSSerge Semin  * dtb. Note that this won't work for early serial console.
344e1d97497SBjorn Helgaas  */
mips_cdmm_phys_base(void)345e1d97497SBjorn Helgaas phys_addr_t __weak mips_cdmm_phys_base(void)
346e1d97497SBjorn Helgaas {
3472121aa3eSSerge Semin 	struct device_node *np;
3482121aa3eSSerge Semin 	struct resource res;
3492121aa3eSSerge Semin 	int err;
3502121aa3eSSerge Semin 
3512121aa3eSSerge Semin 	np = of_find_compatible_node(NULL, NULL, "mti,mips-cdmm");
3522121aa3eSSerge Semin 	if (np) {
3532121aa3eSSerge Semin 		err = of_address_to_resource(np, 0, &res);
3544528668cSMiaoqian Lin 		of_node_put(np);
3552121aa3eSSerge Semin 		if (!err)
3562121aa3eSSerge Semin 			return res.start;
3572121aa3eSSerge Semin 	}
3582121aa3eSSerge Semin 
359e1d97497SBjorn Helgaas 	return 0;
360e1d97497SBjorn Helgaas }
361e1d97497SBjorn Helgaas 
362e1d97497SBjorn Helgaas /**
3638286ae03SJames Hogan  * mips_cdmm_setup() - Ensure the CDMM bus is initialised and usable.
3648286ae03SJames Hogan  * @bus:	Pointer to bus information for current CPU.
3658286ae03SJames Hogan  *		IS_ERR(bus) is checked, so no need for caller to check.
3668286ae03SJames Hogan  *
3678286ae03SJames Hogan  * The caller must prevent migration to another CPU, either by disabling
3688286ae03SJames Hogan  * pre-emption or by running from a pinned kernel thread.
3698286ae03SJames Hogan  *
3708286ae03SJames Hogan  * Returns	0 on success, -errno on failure.
3718286ae03SJames Hogan  */
mips_cdmm_setup(struct mips_cdmm_bus * bus)3728286ae03SJames Hogan static int mips_cdmm_setup(struct mips_cdmm_bus *bus)
3738286ae03SJames Hogan {
3748286ae03SJames Hogan 	unsigned long cdmmbase, flags;
3758286ae03SJames Hogan 	int ret = 0;
3768286ae03SJames Hogan 
3778286ae03SJames Hogan 	if (IS_ERR(bus))
3788286ae03SJames Hogan 		return PTR_ERR(bus);
3798286ae03SJames Hogan 
3808286ae03SJames Hogan 	local_irq_save(flags);
3818286ae03SJames Hogan 	/* Don't set up bus a second time unless marked offline */
3828286ae03SJames Hogan 	if (bus->offline) {
3838286ae03SJames Hogan 		/* If CDMM region is still set up, nothing to do */
3848286ae03SJames Hogan 		if (bus->phys == mips_cdmm_cur_base())
3858286ae03SJames Hogan 			goto out;
3868286ae03SJames Hogan 		/*
3878286ae03SJames Hogan 		 * The CDMM region isn't set up as expected, so it needs
3888286ae03SJames Hogan 		 * reconfiguring, but then we can stop checking it.
3898286ae03SJames Hogan 		 */
3908286ae03SJames Hogan 		bus->offline = false;
3918286ae03SJames Hogan 	} else if (bus->phys > 1) {
3928286ae03SJames Hogan 		goto out;
3938286ae03SJames Hogan 	}
3948286ae03SJames Hogan 
3958286ae03SJames Hogan 	/* If the CDMM region is already configured, inherit that setup */
3968286ae03SJames Hogan 	if (!bus->phys)
3978286ae03SJames Hogan 		bus->phys = mips_cdmm_cur_base();
3988286ae03SJames Hogan 	/* Otherwise, ask platform code for suggestions */
399e1d97497SBjorn Helgaas 	if (!bus->phys)
4008286ae03SJames Hogan 		bus->phys = mips_cdmm_phys_base();
4018286ae03SJames Hogan 	/* Otherwise, copy what other CPUs have done */
4028286ae03SJames Hogan 	if (!bus->phys)
4038286ae03SJames Hogan 		bus->phys = mips_cdmm_default_base;
4048286ae03SJames Hogan 	/* Otherwise, complain once */
4058286ae03SJames Hogan 	if (!bus->phys) {
4068286ae03SJames Hogan 		bus->phys = 1;
4078286ae03SJames Hogan 		/*
4088286ae03SJames Hogan 		 * If you hit this, either your bootloader needs to set up the
4098286ae03SJames Hogan 		 * CDMM on the boot CPU, or else you need to implement
4108286ae03SJames Hogan 		 * mips_cdmm_phys_base() for your platform (see asm/cdmm.h).
4118286ae03SJames Hogan 		 */
4128286ae03SJames Hogan 		pr_err("cdmm%u: Failed to choose a physical base\n",
4138286ae03SJames Hogan 		       smp_processor_id());
4148286ae03SJames Hogan 	}
4158286ae03SJames Hogan 	/* Already complained? */
4168286ae03SJames Hogan 	if (bus->phys == 1) {
4178286ae03SJames Hogan 		ret = -ENOMEM;
4188286ae03SJames Hogan 		goto out;
4198286ae03SJames Hogan 	}
4208286ae03SJames Hogan 	/* Record our success for other CPUs to copy */
4218286ae03SJames Hogan 	mips_cdmm_default_base = bus->phys;
4228286ae03SJames Hogan 
4238286ae03SJames Hogan 	pr_debug("cdmm%u: Enabling CDMM region at %pa\n",
4248286ae03SJames Hogan 		 smp_processor_id(), &bus->phys);
4258286ae03SJames Hogan 
4268286ae03SJames Hogan 	/* Enable CDMM */
4278286ae03SJames Hogan 	cdmmbase = read_c0_cdmmbase();
4288286ae03SJames Hogan 	cdmmbase &= (1ul << MIPS_CDMMBASE_ADDR_SHIFT) - 1;
4298286ae03SJames Hogan 	cdmmbase |= (bus->phys >> MIPS_CDMMBASE_ADDR_START)
4308286ae03SJames Hogan 			<< MIPS_CDMMBASE_ADDR_SHIFT;
4318286ae03SJames Hogan 	cdmmbase |= MIPS_CDMMBASE_EN;
4328286ae03SJames Hogan 	write_c0_cdmmbase(cdmmbase);
4338286ae03SJames Hogan 	tlbw_use_hazard();
4348286ae03SJames Hogan 
4358286ae03SJames Hogan 	bus->regs = (void __iomem *)CKSEG1ADDR(bus->phys);
4368286ae03SJames Hogan 	bus->drbs = 1 + ((cdmmbase & MIPS_CDMMBASE_SIZE) >>
4378286ae03SJames Hogan 			 MIPS_CDMMBASE_SIZE_SHIFT);
4388286ae03SJames Hogan 	bus->drbs_reserved = !!(cdmmbase & MIPS_CDMMBASE_CI);
4398286ae03SJames Hogan 
4408286ae03SJames Hogan out:
4418286ae03SJames Hogan 	local_irq_restore(flags);
4428286ae03SJames Hogan 	return ret;
4438286ae03SJames Hogan }
4448286ae03SJames Hogan 
4458286ae03SJames Hogan /**
4468286ae03SJames Hogan  * mips_cdmm_early_probe() - Minimally probe for a specific device on CDMM.
4478286ae03SJames Hogan  * @dev_type:	CDMM type code to look for.
4488286ae03SJames Hogan  *
4498286ae03SJames Hogan  * Minimally configure the in-CPU Common Device Memory Map (CDMM) and look for a
4508286ae03SJames Hogan  * specific device. This can be used to find a device very early in boot for
4518286ae03SJames Hogan  * example to configure an early FDC console device.
4528286ae03SJames Hogan  *
4538286ae03SJames Hogan  * The caller must prevent migration to another CPU, either by disabling
4548286ae03SJames Hogan  * pre-emption or by running from a pinned kernel thread.
4558286ae03SJames Hogan  *
4568286ae03SJames Hogan  * Returns:	MMIO pointer to device memory. The caller can read the ACSR
4578286ae03SJames Hogan  *		register to find more information about the device (such as the
4588286ae03SJames Hogan  *		version number or the number of blocks).
4598286ae03SJames Hogan  *		May return IOMEM_ERR_PTR(-errno) in case of error, so check with
4608286ae03SJames Hogan  *		IS_ERR().
4618286ae03SJames Hogan  */
mips_cdmm_early_probe(unsigned int dev_type)4628286ae03SJames Hogan void __iomem *mips_cdmm_early_probe(unsigned int dev_type)
4638286ae03SJames Hogan {
4648286ae03SJames Hogan 	struct mips_cdmm_bus *bus;
4658286ae03SJames Hogan 	void __iomem *cdmm;
4668286ae03SJames Hogan 	u32 acsr;
4678286ae03SJames Hogan 	unsigned int drb, type, size;
4688286ae03SJames Hogan 	int err;
4698286ae03SJames Hogan 
4708286ae03SJames Hogan 	if (WARN_ON(!dev_type))
4718286ae03SJames Hogan 		return IOMEM_ERR_PTR(-ENODEV);
4728286ae03SJames Hogan 
4738286ae03SJames Hogan 	bus = mips_cdmm_get_bus();
4748286ae03SJames Hogan 	err = mips_cdmm_setup(bus);
4758286ae03SJames Hogan 	if (err)
4768286ae03SJames Hogan 		return IOMEM_ERR_PTR(err);
4778286ae03SJames Hogan 
4788286ae03SJames Hogan 	/* Skip the first block if it's reserved for more registers */
4798286ae03SJames Hogan 	drb = bus->drbs_reserved;
4808286ae03SJames Hogan 	cdmm = bus->regs;
4818286ae03SJames Hogan 
4828286ae03SJames Hogan 	/* Look for a specific device type */
4838286ae03SJames Hogan 	for (; drb < bus->drbs; drb += size + 1) {
484e21422deSJames Hogan 		acsr = __raw_readl(cdmm + drb * CDMM_DRB_SIZE);
4858286ae03SJames Hogan 		type = (acsr & CDMM_ACSR_DEVTYPE) >> CDMM_ACSR_DEVTYPE_SHIFT;
4868286ae03SJames Hogan 		if (type == dev_type)
4878286ae03SJames Hogan 			return cdmm + drb * CDMM_DRB_SIZE;
4888286ae03SJames Hogan 		size = (acsr & CDMM_ACSR_DEVSIZE) >> CDMM_ACSR_DEVSIZE_SHIFT;
4898286ae03SJames Hogan 	}
4908286ae03SJames Hogan 
4918286ae03SJames Hogan 	return IOMEM_ERR_PTR(-ENODEV);
4928286ae03SJames Hogan }
4938286ae03SJames Hogan EXPORT_SYMBOL_GPL(mips_cdmm_early_probe);
4948286ae03SJames Hogan 
4958286ae03SJames Hogan /**
4968286ae03SJames Hogan  * mips_cdmm_release() - Release a removed CDMM device.
4978286ae03SJames Hogan  * @dev:	Device object
4988286ae03SJames Hogan  *
4998286ae03SJames Hogan  * Clean up the struct mips_cdmm_device for an unused CDMM device. This is
5008286ae03SJames Hogan  * called automatically by the driver core when a device is removed.
5018286ae03SJames Hogan  */
mips_cdmm_release(struct device * dev)5028286ae03SJames Hogan static void mips_cdmm_release(struct device *dev)
5038286ae03SJames Hogan {
5048286ae03SJames Hogan 	struct mips_cdmm_device *cdev = to_mips_cdmm_device(dev);
5058286ae03SJames Hogan 
5068286ae03SJames Hogan 	kfree(cdev);
5078286ae03SJames Hogan }
5088286ae03SJames Hogan 
5098286ae03SJames Hogan /**
5108286ae03SJames Hogan  * mips_cdmm_bus_discover() - Discover the devices on the CDMM bus.
5118286ae03SJames Hogan  * @bus:	CDMM bus information, must already be set up.
5128286ae03SJames Hogan  */
mips_cdmm_bus_discover(struct mips_cdmm_bus * bus)5138286ae03SJames Hogan static void mips_cdmm_bus_discover(struct mips_cdmm_bus *bus)
5148286ae03SJames Hogan {
5158286ae03SJames Hogan 	void __iomem *cdmm;
5168286ae03SJames Hogan 	u32 acsr;
5178286ae03SJames Hogan 	unsigned int drb, type, size, rev;
5188286ae03SJames Hogan 	struct mips_cdmm_device *dev;
5198286ae03SJames Hogan 	unsigned int cpu = smp_processor_id();
5208286ae03SJames Hogan 	int ret = 0;
5218286ae03SJames Hogan 	int id = 0;
5228286ae03SJames Hogan 
5238286ae03SJames Hogan 	/* Skip the first block if it's reserved for more registers */
5248286ae03SJames Hogan 	drb = bus->drbs_reserved;
5258286ae03SJames Hogan 	cdmm = bus->regs;
5268286ae03SJames Hogan 
5278286ae03SJames Hogan 	/* Discover devices */
5288286ae03SJames Hogan 	bus->discovered = true;
5298286ae03SJames Hogan 	pr_info("cdmm%u discovery (%u blocks)\n", cpu, bus->drbs);
5308286ae03SJames Hogan 	for (; drb < bus->drbs; drb += size + 1) {
531e21422deSJames Hogan 		acsr = __raw_readl(cdmm + drb * CDMM_DRB_SIZE);
5328286ae03SJames Hogan 		type = (acsr & CDMM_ACSR_DEVTYPE) >> CDMM_ACSR_DEVTYPE_SHIFT;
5338286ae03SJames Hogan 		size = (acsr & CDMM_ACSR_DEVSIZE) >> CDMM_ACSR_DEVSIZE_SHIFT;
5348286ae03SJames Hogan 		rev  = (acsr & CDMM_ACSR_DEVREV)  >> CDMM_ACSR_DEVREV_SHIFT;
5358286ae03SJames Hogan 
5368286ae03SJames Hogan 		if (!type)
5378286ae03SJames Hogan 			continue;
5388286ae03SJames Hogan 
5398286ae03SJames Hogan 		pr_info("cdmm%u-%u: @%u (%#x..%#x), type 0x%02x, rev %u\n",
5408286ae03SJames Hogan 			cpu, id, drb, drb * CDMM_DRB_SIZE,
5418286ae03SJames Hogan 			(drb + size + 1) * CDMM_DRB_SIZE - 1,
5428286ae03SJames Hogan 			type, rev);
5438286ae03SJames Hogan 
5448286ae03SJames Hogan 		dev = kzalloc(sizeof(*dev), GFP_KERNEL);
5458286ae03SJames Hogan 		if (!dev)
5468286ae03SJames Hogan 			break;
5478286ae03SJames Hogan 
5488286ae03SJames Hogan 		dev->cpu = cpu;
5498286ae03SJames Hogan 		dev->res.start = bus->phys + drb * CDMM_DRB_SIZE;
5508286ae03SJames Hogan 		dev->res.end = bus->phys +
5518286ae03SJames Hogan 				(drb + size + 1) * CDMM_DRB_SIZE - 1;
5528286ae03SJames Hogan 		dev->res.flags = IORESOURCE_MEM;
5538286ae03SJames Hogan 		dev->type = type;
5548286ae03SJames Hogan 		dev->rev = rev;
5558286ae03SJames Hogan 		dev->dev.parent = get_cpu_device(cpu);
5568286ae03SJames Hogan 		dev->dev.bus = &mips_cdmm_bustype;
5578286ae03SJames Hogan 		dev->dev.id = atomic_inc_return(&mips_cdmm_next_id);
5588286ae03SJames Hogan 		dev->dev.release = mips_cdmm_release;
5598286ae03SJames Hogan 
5608286ae03SJames Hogan 		dev_set_name(&dev->dev, "cdmm%u-%u", cpu, id);
5618286ae03SJames Hogan 		++id;
5628286ae03SJames Hogan 		ret = device_register(&dev->dev);
563f0e82242SQinglang Miao 		if (ret)
5648286ae03SJames Hogan 			put_device(&dev->dev);
5658286ae03SJames Hogan 	}
5668286ae03SJames Hogan }
5678286ae03SJames Hogan 
5688286ae03SJames Hogan 
5698286ae03SJames Hogan /*
5708286ae03SJames Hogan  * CPU hotplug and initialisation
5718286ae03SJames Hogan  *
5728286ae03SJames Hogan  * All the CDMM driver callbacks need to be executed on the appropriate CPU from
5738286ae03SJames Hogan  * workqueues. For the CPU callbacks, they need to be called for all devices on
5748286ae03SJames Hogan  * that CPU, so the work function calls bus_for_each_dev, using a helper
5758286ae03SJames Hogan  * (generated with BUILD_PERDEV_HELPER) to call the driver callback if the
5768286ae03SJames Hogan  * device's CPU matches.
5778286ae03SJames Hogan  */
5788286ae03SJames Hogan 
5798286ae03SJames Hogan /**
5808286ae03SJames Hogan  * BUILD_PERDEV_HELPER() - Helper to call a CDMM driver callback if CPU matches.
5818286ae03SJames Hogan  * @_name:	Name of CDMM driver callback function.
5828286ae03SJames Hogan  *
5838286ae03SJames Hogan  * Generates a bus_for_each_dev callback function to call a specific CDMM driver
5848286ae03SJames Hogan  * callback function for the device if the device's CPU matches that pointed to
5858286ae03SJames Hogan  * by the data argument.
5868286ae03SJames Hogan  *
5878286ae03SJames Hogan  * This is used for informing drivers for all devices on a given CPU of some
5888286ae03SJames Hogan  * event (such as the CPU going online/offline).
5898286ae03SJames Hogan  *
5908286ae03SJames Hogan  * It is expected to already be called from the appropriate CPU.
5918286ae03SJames Hogan  */
5928286ae03SJames Hogan #define BUILD_PERDEV_HELPER(_name)					\
5938286ae03SJames Hogan static int mips_cdmm_##_name##_helper(struct device *dev, void *data)	\
5948286ae03SJames Hogan {									\
5958286ae03SJames Hogan 	struct mips_cdmm_device *cdev = to_mips_cdmm_device(dev);	\
5968286ae03SJames Hogan 	struct mips_cdmm_driver *cdrv;					\
5978286ae03SJames Hogan 	unsigned int cpu = *(unsigned int *)data;			\
5988286ae03SJames Hogan 									\
5998286ae03SJames Hogan 	if (cdev->cpu != cpu || !dev->driver)				\
6008286ae03SJames Hogan 		return 0;						\
6018286ae03SJames Hogan 									\
6028286ae03SJames Hogan 	cdrv = to_mips_cdmm_driver(dev->driver);			\
6038286ae03SJames Hogan 	if (!cdrv->_name)						\
6048286ae03SJames Hogan 		return 0;						\
6058286ae03SJames Hogan 	return cdrv->_name(cdev);					\
6068286ae03SJames Hogan }
6078286ae03SJames Hogan 
6088286ae03SJames Hogan /* bus_for_each_dev callback helper functions */
6098286ae03SJames Hogan BUILD_PERDEV_HELPER(cpu_down)       /* int mips_cdmm_cpu_down_helper(...) */
BUILD_PERDEV_HELPER(cpu_up)6108286ae03SJames Hogan BUILD_PERDEV_HELPER(cpu_up)         /* int mips_cdmm_cpu_up_helper(...) */
6118286ae03SJames Hogan 
6128286ae03SJames Hogan /**
613e8483b57SSebastian Andrzej Siewior  * mips_cdmm_cpu_down_prep() - Callback for CPUHP DOWN_PREP:
614e8483b57SSebastian Andrzej Siewior  *			       Tear down the CDMM bus.
615e8483b57SSebastian Andrzej Siewior  * @cpu:	unsigned int CPU number.
6168286ae03SJames Hogan  *
617015aa05fSAnna-Maria Gleixner  * This function is executed on the hotplugged CPU and calls the CDMM
618015aa05fSAnna-Maria Gleixner  * driver cpu_down callback for all devices on that CPU.
6198286ae03SJames Hogan  */
620e8483b57SSebastian Andrzej Siewior static int mips_cdmm_cpu_down_prep(unsigned int cpu)
6218286ae03SJames Hogan {
6228286ae03SJames Hogan 	struct mips_cdmm_bus *bus;
6238286ae03SJames Hogan 	long ret;
6248286ae03SJames Hogan 
6258286ae03SJames Hogan 	/* Inform all the devices on the bus */
626e8483b57SSebastian Andrzej Siewior 	ret = bus_for_each_dev(&mips_cdmm_bustype, NULL, &cpu,
6278286ae03SJames Hogan 			       mips_cdmm_cpu_down_helper);
6288286ae03SJames Hogan 
6298286ae03SJames Hogan 	/*
6308286ae03SJames Hogan 	 * While bus is offline, each use of it should reconfigure it just in
6318286ae03SJames Hogan 	 * case it is first use when coming back online again.
6328286ae03SJames Hogan 	 */
6338286ae03SJames Hogan 	bus = mips_cdmm_get_bus();
6348286ae03SJames Hogan 	if (!IS_ERR(bus))
6358286ae03SJames Hogan 		bus->offline = true;
6368286ae03SJames Hogan 
6378286ae03SJames Hogan 	return ret;
6388286ae03SJames Hogan }
6398286ae03SJames Hogan 
6408286ae03SJames Hogan /**
641e8483b57SSebastian Andrzej Siewior  * mips_cdmm_cpu_online() - Callback for CPUHP ONLINE: Bring up the CDMM bus.
642e8483b57SSebastian Andrzej Siewior  * @cpu:	unsigned int CPU number.
6438286ae03SJames Hogan  *
6448286ae03SJames Hogan  * This work_on_cpu callback function is executed on a given CPU to discover
6458286ae03SJames Hogan  * CDMM devices on that CPU, or to call the CDMM driver cpu_up callback for all
6468286ae03SJames Hogan  * devices already discovered on that CPU.
6478286ae03SJames Hogan  *
648015aa05fSAnna-Maria Gleixner  * It is used as work_on_cpu callback function during
649015aa05fSAnna-Maria Gleixner  * initialisation. When CPUs are brought online the function is
650015aa05fSAnna-Maria Gleixner  * invoked directly on the hotplugged CPU.
6518286ae03SJames Hogan  */
mips_cdmm_cpu_online(unsigned int cpu)652e8483b57SSebastian Andrzej Siewior static int mips_cdmm_cpu_online(unsigned int cpu)
6538286ae03SJames Hogan {
6548286ae03SJames Hogan 	struct mips_cdmm_bus *bus;
6558286ae03SJames Hogan 	long ret;
6568286ae03SJames Hogan 
6578286ae03SJames Hogan 	bus = mips_cdmm_get_bus();
6588286ae03SJames Hogan 	ret = mips_cdmm_setup(bus);
6598286ae03SJames Hogan 	if (ret)
6608286ae03SJames Hogan 		return ret;
6618286ae03SJames Hogan 
6628286ae03SJames Hogan 	/* Bus now set up, so we can drop the offline flag if still set */
6638286ae03SJames Hogan 	bus->offline = false;
6648286ae03SJames Hogan 
6658286ae03SJames Hogan 	if (!bus->discovered)
6668286ae03SJames Hogan 		mips_cdmm_bus_discover(bus);
6678286ae03SJames Hogan 	else
6688286ae03SJames Hogan 		/* Inform all the devices on the bus */
669e8483b57SSebastian Andrzej Siewior 		ret = bus_for_each_dev(&mips_cdmm_bustype, NULL, &cpu,
6708286ae03SJames Hogan 				       mips_cdmm_cpu_up_helper);
6718286ae03SJames Hogan 
6728286ae03SJames Hogan 	return ret;
6738286ae03SJames Hogan }
6748286ae03SJames Hogan 
6758286ae03SJames Hogan /**
6768286ae03SJames Hogan  * mips_cdmm_init() - Initialise CDMM bus.
6778286ae03SJames Hogan  *
6788286ae03SJames Hogan  * Initialise CDMM bus, discover CDMM devices for online CPUs, and arrange for
6798286ae03SJames Hogan  * hotplug notifications so the CDMM drivers can be kept up to date.
6808286ae03SJames Hogan  */
mips_cdmm_init(void)6818286ae03SJames Hogan static int __init mips_cdmm_init(void)
6828286ae03SJames Hogan {
6838286ae03SJames Hogan 	int ret;
6848286ae03SJames Hogan 
6858286ae03SJames Hogan 	/* Register the bus */
6868286ae03SJames Hogan 	ret = bus_register(&mips_cdmm_bustype);
6878286ae03SJames Hogan 	if (ret)
6888286ae03SJames Hogan 		return ret;
6898286ae03SJames Hogan 
6908286ae03SJames Hogan 	/* We want to be notified about new CPUs */
691e8483b57SSebastian Andrzej Siewior 	ret = cpuhp_setup_state(CPUHP_AP_ONLINE_DYN, "bus/cdmm:online",
692e8483b57SSebastian Andrzej Siewior 				mips_cdmm_cpu_online, mips_cdmm_cpu_down_prep);
693e8483b57SSebastian Andrzej Siewior 	if (ret < 0)
6948286ae03SJames Hogan 		pr_warn("cdmm: Failed to register CPU notifier\n");
6958286ae03SJames Hogan 
6968286ae03SJames Hogan 	return ret;
6978286ae03SJames Hogan }
6988286ae03SJames Hogan subsys_initcall(mips_cdmm_init);
699