[linux-block.git] / lib / logic_pio.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright (C) 2017 HiSilicon Limited, All Rights Reserved.
 * Author: Gabriele Paoloni <gabriele.paoloni@huawei.com>
 * Author: Zhichang Yuan <yuanzhichang@hisilicon.com>
 * Author: John Garry <john.garry@huawei.com>
 */

#define pr_fmt(fmt)	"LOGIC PIO: " fmt

#include <linux/of.h>
#include <linux/io.h>
#include <linux/logic_pio.h>
#include <linux/mm.h>
#include <linux/rculist.h>
#include <linux/sizes.h>
#include <linux/slab.h>

/* The unique hardware address list */
static LIST_HEAD(io_range_list);
static DEFINE_MUTEX(io_range_mutex);

/* Consider a kernel general helper for this */
#define in_range(b, first, len)        ((b) >= (first) && (b) < (first) + (len))

/**
 * logic_pio_register_range - register logical PIO range for a host
 * @new_range: pointer to the IO range to be registered.
 *
 * Returns 0 on success, the error code in case of failure.
 * If the range already exists, -EEXIST will be returned, which should be
 * considered a success.
 *
 * Register a new IO range node in the IO range list.
 */
int logic_pio_register_range(struct logic_pio_hwaddr *new_range)
{
	struct logic_pio_hwaddr *range;
	resource_size_t start;
	resource_size_t end;
	resource_size_t mmio_end = 0;
	resource_size_t iio_sz = MMIO_UPPER_LIMIT;
	int ret = 0;

	if (!new_range || !new_range->fwnode || !new_range->size ||
	    (new_range->flags == LOGIC_PIO_INDIRECT && !new_range->ops))
		return -EINVAL;

	start = new_range->hw_start;
	end = new_range->hw_start + new_range->size;

	mutex_lock(&io_range_mutex);
	list_for_each_entry(range, &io_range_list, list) {
		if (range->fwnode == new_range->fwnode) {
			/* range already there */
			ret = -EEXIST;
			goto end_register;
		}
		if (range->flags == LOGIC_PIO_CPU_MMIO &&
		    new_range->flags == LOGIC_PIO_CPU_MMIO) {
			/* for MMIO ranges we need to check for overlap */
			if (start >= range->hw_start + range->size ||
			    end < range->hw_start) {
				mmio_end = range->io_start + range->size;
			} else {
				ret = -EFAULT;
				goto end_register;
			}
		} else if (range->flags == LOGIC_PIO_INDIRECT &&
			   new_range->flags == LOGIC_PIO_INDIRECT) {
			iio_sz += range->size;
		}
	}

	/* range not registered yet, check for available space */
	if (new_range->flags == LOGIC_PIO_CPU_MMIO) {
		if (mmio_end + new_range->size - 1 > MMIO_UPPER_LIMIT) {
			/* if it's too big check if 64K space can be reserved */
			if (mmio_end + SZ_64K - 1 > MMIO_UPPER_LIMIT) {
				ret = -E2BIG;
				goto end_register;
			}
			new_range->size = SZ_64K;
			pr_warn("Requested IO range too big, new size set to 64K\n");
		}
		new_range->io_start = mmio_end;
	} else if (new_range->flags == LOGIC_PIO_INDIRECT) {
		if (iio_sz + new_range->size - 1 > IO_SPACE_LIMIT) {
			ret = -E2BIG;
			goto end_register;
		}
		new_range->io_start = iio_sz;
	} else {
		/* invalid flag */
		ret = -EINVAL;
		goto end_register;
	}

	list_add_tail_rcu(&new_range->list, &io_range_list);

end_register:
	mutex_unlock(&io_range_mutex);
	return ret;
}

/**
 * logic_pio_unregister_range - unregister a logical PIO range for a host
 * @range: pointer to the IO range which has been already registered.
 *
 * Unregister a previously-registered IO range node.
 */
void logic_pio_unregister_range(struct logic_pio_hwaddr *range)
{
	mutex_lock(&io_range_mutex);
	list_del_rcu(&range->list);
	mutex_unlock(&io_range_mutex);
	synchronize_rcu();
}

/**
 * find_io_range_by_fwnode - find logical PIO range for given FW node
 * @fwnode: FW node handle associated with logical PIO range
 *
 * Returns pointer to node on success, NULL otherwise.
 *
 * Traverse the io_range_list to find the registered node for @fwnode.
 */
struct logic_pio_hwaddr *find_io_range_by_fwnode(struct fwnode_handle *fwnode)
{
	struct logic_pio_hwaddr *range, *found_range = NULL;

	rcu_read_lock();
	list_for_each_entry_rcu(range, &io_range_list, list) {
		if (range->fwnode == fwnode) {
			found_range = range;
			break;
		}
	}
	rcu_read_unlock();

	return found_range;
}

/* Return a registered range given an input PIO token */
static struct logic_pio_hwaddr *find_io_range(unsigned long pio)
{
	struct logic_pio_hwaddr *range, *found_range = NULL;

	rcu_read_lock();
	list_for_each_entry_rcu(range, &io_range_list, list) {
		if (in_range(pio, range->io_start, range->size)) {
			found_range = range;
			break;
		}
	}
	rcu_read_unlock();

	if (!found_range)
		pr_err("PIO entry token 0x%lx invalid\n", pio);

	return found_range;
}

/**
 * logic_pio_to_hwaddr - translate logical PIO to HW address
 * @pio: logical PIO value
 *
 * Returns HW address if valid, ~0 otherwise.
 *
 * Translate the input logical PIO to the corresponding hardware address.
 * The input PIO should be unique in the whole logical PIO space.
 */
resource_size_t logic_pio_to_hwaddr(unsigned long pio)
{
	struct logic_pio_hwaddr *range;

	range = find_io_range(pio);
	if (range)
		return range->hw_start + pio - range->io_start;

	return (resource_size_t)~0;
}

/**
 * logic_pio_trans_hwaddr - translate HW address to logical PIO
 * @fwnode: FW node reference for the host
 * @addr: Host-relative HW address
 * @size: size to translate
 *
 * Returns Logical PIO value if successful, ~0UL otherwise
 */
unsigned long logic_pio_trans_hwaddr(struct fwnode_handle *fwnode,
				     resource_size_t addr, resource_size_t size)
{
	struct logic_pio_hwaddr *range;

	range = find_io_range_by_fwnode(fwnode);
	if (!range || range->flags == LOGIC_PIO_CPU_MMIO) {
		pr_err("IO range not found or invalid\n");
		return ~0UL;
	}
	if (range->size < size) {
		pr_err("resource size %pa cannot fit in IO range size %pa\n",
		       &size, &range->size);
		return ~0UL;
	}
	return addr - range->hw_start + range->io_start;
}

unsigned long logic_pio_trans_cpuaddr(resource_size_t addr)
{
	struct logic_pio_hwaddr *range;

	rcu_read_lock();
	list_for_each_entry_rcu(range, &io_range_list, list) {
		if (range->flags != LOGIC_PIO_CPU_MMIO)
			continue;
		if (in_range(addr, range->hw_start, range->size)) {
			unsigned long cpuaddr;

			cpuaddr = addr - range->hw_start + range->io_start;

			rcu_read_unlock();
			return cpuaddr;
		}
	}
	rcu_read_unlock();

	pr_err("addr %pa not registered in io_range_list\n", &addr);

	return ~0UL;
}

#if defined(CONFIG_INDIRECT_PIO) && defined(PCI_IOBASE)
#define BUILD_LOGIC_IO(bwl, type)					\
type logic_in##bwl(unsigned long addr)					\
{									\
	type ret = (type)~0;						\
									\
	if (addr < MMIO_UPPER_LIMIT) {					\
		ret = _in##bwl(addr);					\
	} else if (addr >= MMIO_UPPER_LIMIT && addr < IO_SPACE_LIMIT) { \
		struct logic_pio_hwaddr *entry = find_io_range(addr);	\
									\
		if (entry)						\
			ret = entry->ops->in(entry->hostdata,		\
					addr, sizeof(type));		\
		else							\
			WARN_ON_ONCE(1);				\
	}								\
	return ret;							\
}									\
									\
void logic_out##bwl(type value, unsigned long addr)			\
{									\
	if (addr < MMIO_UPPER_LIMIT) {					\
		_out##bwl(value, addr);				\
	} else if (addr >= MMIO_UPPER_LIMIT && addr < IO_SPACE_LIMIT) {	\
		struct logic_pio_hwaddr *entry = find_io_range(addr);	\
									\
		if (entry)						\
			entry->ops->out(entry->hostdata,		\
					addr, value, sizeof(type));	\
		else							\
			WARN_ON_ONCE(1);				\
	}								\
}									\
									\
void logic_ins##bwl(unsigned long addr, void *buffer,			\
		    unsigned int count)					\
{									\
	if (addr < MMIO_UPPER_LIMIT) {					\
		reads##bwl(PCI_IOBASE + addr, buffer, count);		\
	} else if (addr >= MMIO_UPPER_LIMIT && addr < IO_SPACE_LIMIT) {	\
		struct logic_pio_hwaddr *entry = find_io_range(addr);	\
									\
		if (entry)						\
			entry->ops->ins(entry->hostdata,		\
				addr, buffer, sizeof(type), count);	\
		else							\
			WARN_ON_ONCE(1);				\
	}								\
									\
}									\
									\
void logic_outs##bwl(unsigned long addr, const void *buffer,		\
		     unsigned int count)				\
{									\
	if (addr < MMIO_UPPER_LIMIT) {					\
		writes##bwl(PCI_IOBASE + addr, buffer, count);		\
	} else if (addr >= MMIO_UPPER_LIMIT && addr < IO_SPACE_LIMIT) {	\
		struct logic_pio_hwaddr *entry = find_io_range(addr);	\
									\
		if (entry)						\
			entry->ops->outs(entry->hostdata,		\
				addr, buffer, sizeof(type), count);	\
		else							\
			WARN_ON_ONCE(1);				\
	}								\
}

BUILD_LOGIC_IO(b, u8)
EXPORT_SYMBOL(logic_inb);
EXPORT_SYMBOL(logic_insb);
EXPORT_SYMBOL(logic_outb);
EXPORT_SYMBOL(logic_outsb);

BUILD_LOGIC_IO(w, u16)
EXPORT_SYMBOL(logic_inw);
EXPORT_SYMBOL(logic_insw);
EXPORT_SYMBOL(logic_outw);
EXPORT_SYMBOL(logic_outsw);

BUILD_LOGIC_IO(l, u32)
EXPORT_SYMBOL(logic_inl);
EXPORT_SYMBOL(logic_insl);
EXPORT_SYMBOL(logic_outl);
EXPORT_SYMBOL(logic_outsl);

#endif /* CONFIG_INDIRECT_PIO && PCI_IOBASE */
Commit	Line	Data
031e3601 ZY	1	// SPDX-License-Identifier: GPL-2.0+
	2	/*
	3	* Copyright (C) 2017 HiSilicon Limited, All Rights Reserved.
	4	* Author: Gabriele Paoloni <gabriele.paoloni@huawei.com>
	5	* Author: Zhichang Yuan <yuanzhichang@hisilicon.com>
0376fa72	6	* Author: John Garry <john.garry@huawei.com>
031e3601 ZY	7	*/
	8
	9	#define pr_fmt(fmt) "LOGIC PIO: " fmt
	10
	11	#include <linux/of.h>
	12	#include <linux/io.h>
	13	#include <linux/logic_pio.h>
	14	#include <linux/mm.h>
	15	#include <linux/rculist.h>
	16	#include <linux/sizes.h>
	17	#include <linux/slab.h>
	18
	19	/* The unique hardware address list */
	20	static LIST_HEAD(io_range_list);
	21	static DEFINE_MUTEX(io_range_mutex);
	22
	23	/* Consider a kernel general helper for this */
	24	#define in_range(b, first, len) ((b) >= (first) && (b) < (first) + (len))
	25
	26	/**
	27	* logic_pio_register_range - register logical PIO range for a host
	28	* @new_range: pointer to the IO range to be registered.
	29	*
	30	* Returns 0 on success, the error code in case of failure.
f6bda644 GU	31	* If the range already exists, -EEXIST will be returned, which should be
f6bda644 GU	32	* considered a success.
031e3601 ZY	33	*
	34	* Register a new IO range node in the IO range list.
	35	*/
	36	int logic_pio_register_range(struct logic_pio_hwaddr *new_range)
	37	{
	38	struct logic_pio_hwaddr *range;
	39	resource_size_t start;
	40	resource_size_t end;
0a27142b	41	resource_size_t mmio_end = 0;
031e3601 ZY	42	resource_size_t iio_sz = MMIO_UPPER_LIMIT;
	43	int ret = 0;
	44
0376fa72 JG	45	if (!new_range \|\| !new_range->fwnode \|\| !new_range->size \|\|
0376fa72 JG	46	(new_range->flags == LOGIC_PIO_INDIRECT && !new_range->ops))
031e3601 ZY	47	return -EINVAL;
	48
	49	start = new_range->hw_start;
	50	end = new_range->hw_start + new_range->size;
	51
	52	mutex_lock(&io_range_mutex);
06709e81	53	list_for_each_entry(range, &io_range_list, list) {
031e3601 ZY	54	if (range->fwnode == new_range->fwnode) {
031e3601 ZY	55	/* range already there */
f6bda644	56	ret = -EEXIST;
031e3601 ZY	57	goto end_register;
	58	}
	59	if (range->flags == LOGIC_PIO_CPU_MMIO &&
	60	new_range->flags == LOGIC_PIO_CPU_MMIO) {
	61	/* for MMIO ranges we need to check for overlap */
	62	if (start >= range->hw_start + range->size \|\|
	63	end < range->hw_start) {
0a27142b	64	mmio_end = range->io_start + range->size;
031e3601 ZY	65	} else {
	66	ret = -EFAULT;
	67	goto end_register;
	68	}
	69	} else if (range->flags == LOGIC_PIO_INDIRECT &&
	70	new_range->flags == LOGIC_PIO_INDIRECT) {
	71	iio_sz += range->size;
	72	}
	73	}
	74
	75	/* range not registered yet, check for available space */
	76	if (new_range->flags == LOGIC_PIO_CPU_MMIO) {
0a27142b	77	if (mmio_end + new_range->size - 1 > MMIO_UPPER_LIMIT) {
031e3601	78	/* if it's too big check if 64K space can be reserved */
0a27142b	79	if (mmio_end + SZ_64K - 1 > MMIO_UPPER_LIMIT) {
031e3601 ZY	80	ret = -E2BIG;
	81	goto end_register;
	82	}
	83	new_range->size = SZ_64K;
	84	pr_warn("Requested IO range too big, new size set to 64K\n");
	85	}
0a27142b	86	new_range->io_start = mmio_end;
031e3601 ZY	87	} else if (new_range->flags == LOGIC_PIO_INDIRECT) {
	88	if (iio_sz + new_range->size - 1 > IO_SPACE_LIMIT) {
	89	ret = -E2BIG;
	90	goto end_register;
	91	}
	92	new_range->io_start = iio_sz;
	93	} else {
	94	/* invalid flag */
	95	ret = -EINVAL;
	96	goto end_register;
	97	}
	98
	99	list_add_tail_rcu(&new_range->list, &io_range_list);
	100
	101	end_register:
	102	mutex_unlock(&io_range_mutex);
	103	return ret;
	104	}
	105
b884e2de JG	106	/**
	107	* logic_pio_unregister_range - unregister a logical PIO range for a host
	108	* @range: pointer to the IO range which has been already registered.
	109	*
	110	* Unregister a previously-registered IO range node.
	111	*/
	112	void logic_pio_unregister_range(struct logic_pio_hwaddr *range)
	113	{
	114	mutex_lock(&io_range_mutex);
	115	list_del_rcu(&range->list);
	116	mutex_unlock(&io_range_mutex);
	117	synchronize_rcu();
	118	}
	119
031e3601 ZY	120	/**
	121	* find_io_range_by_fwnode - find logical PIO range for given FW node
	122	* @fwnode: FW node handle associated with logical PIO range
	123	*
	124	* Returns pointer to node on success, NULL otherwise.
	125	*
	126	* Traverse the io_range_list to find the registered node for @fwnode.
	127	*/
	128	struct logic_pio_hwaddr find_io_range_by_fwnode(struct fwnode_handle fwnode)
	129	{
06709e81	130	struct logic_pio_hwaddr range, found_range = NULL;
031e3601	131
06709e81	132	rcu_read_lock();
031e3601	133	list_for_each_entry_rcu(range, &io_range_list, list) {
06709e81 JG	134	if (range->fwnode == fwnode) {
	135	found_range = range;
	136	break;
	137	}
031e3601	138	}
06709e81 JG	139	rcu_read_unlock();
	140
	141	return found_range;
031e3601 ZY	142	}
	143
	144	/* Return a registered range given an input PIO token */
	145	static struct logic_pio_hwaddr *find_io_range(unsigned long pio)
	146	{
06709e81	147	struct logic_pio_hwaddr range, found_range = NULL;
031e3601	148
06709e81	149	rcu_read_lock();
031e3601	150	list_for_each_entry_rcu(range, &io_range_list, list) {
06709e81 JG	151	if (in_range(pio, range->io_start, range->size)) {
	152	found_range = range;
	153	break;
	154	}
031e3601	155	}
06709e81 JG	156	rcu_read_unlock();
	157
	158	if (!found_range)
	159	pr_err("PIO entry token 0x%lx invalid\n", pio);
	160
	161	return found_range;
031e3601 ZY	162	}
	163
	164	/**
	165	* logic_pio_to_hwaddr - translate logical PIO to HW address
	166	* @pio: logical PIO value
	167	*
	168	* Returns HW address if valid, ~0 otherwise.
	169	*
	170	* Translate the input logical PIO to the corresponding hardware address.
	171	* The input PIO should be unique in the whole logical PIO space.
	172	*/
	173	resource_size_t logic_pio_to_hwaddr(unsigned long pio)
	174	{
	175	struct logic_pio_hwaddr *range;
	176
	177	range = find_io_range(pio);
	178	if (range)
	179	return range->hw_start + pio - range->io_start;
	180
	181	return (resource_size_t)~0;
	182	}
	183
	184	/**
	185	* logic_pio_trans_hwaddr - translate HW address to logical PIO
	186	* @fwnode: FW node reference for the host
	187	* @addr: Host-relative HW address
	188	* @size: size to translate
	189	*
	190	* Returns Logical PIO value if successful, ~0UL otherwise
	191	*/
	192	unsigned long logic_pio_trans_hwaddr(struct fwnode_handle *fwnode,
	193	resource_size_t addr, resource_size_t size)
	194	{
	195	struct logic_pio_hwaddr *range;
	196
	197	range = find_io_range_by_fwnode(fwnode);
	198	if (!range \|\| range->flags == LOGIC_PIO_CPU_MMIO) {
	199	pr_err("IO range not found or invalid\n");
	200	return ~0UL;
	201	}
	202	if (range->size < size) {
	203	pr_err("resource size %pa cannot fit in IO range size %pa\n",
	204	&size, &range->size);
	205	return ~0UL;
	206	}
	207	return addr - range->hw_start + range->io_start;
	208	}
	209
	210	unsigned long logic_pio_trans_cpuaddr(resource_size_t addr)
	211	{
	212	struct logic_pio_hwaddr *range;
	213
06709e81	214	rcu_read_lock();
031e3601 ZY	215	list_for_each_entry_rcu(range, &io_range_list, list) {
	216	if (range->flags != LOGIC_PIO_CPU_MMIO)
	217	continue;
06709e81 JG	218	if (in_range(addr, range->hw_start, range->size)) {
	219	unsigned long cpuaddr;
	220
	221	cpuaddr = addr - range->hw_start + range->io_start;
	222
	223	rcu_read_unlock();
	224	return cpuaddr;
	225	}
031e3601	226	}
06709e81 JG	227	rcu_read_unlock();
	228
	229	pr_err("addr %pa not registered in io_range_list\n", &addr);
	230
031e3601 ZY	231	return ~0UL;
	232	}
	233
	234	#if defined(CONFIG_INDIRECT_PIO) && defined(PCI_IOBASE)
26c4c6ce JG	235	#define BUILD_LOGIC_IO(bwl, type) \
26c4c6ce JG	236	type logic_in##bwl(unsigned long addr) \
031e3601 ZY	237	{ \
	238	type ret = (type)~0; \
	239	\
	240	if (addr < MMIO_UPPER_LIMIT) { \
4acaa93e	241	ret = _in##bwl(addr); \
031e3601 ZY	242	} else if (addr >= MMIO_UPPER_LIMIT && addr < IO_SPACE_LIMIT) { \
	243	struct logic_pio_hwaddr *entry = find_io_range(addr); \
	244	\
0376fa72	245	if (entry) \
031e3601 ZY	246	ret = entry->ops->in(entry->hostdata, \
	247	addr, sizeof(type)); \
	248	else \
	249	WARN_ON_ONCE(1); \
	250	} \
	251	return ret; \
	252	} \
	253	\
26c4c6ce	254	void logic_out##bwl(type value, unsigned long addr) \
031e3601 ZY	255	{ \
031e3601 ZY	256	if (addr < MMIO_UPPER_LIMIT) { \
4acaa93e	257	_out##bwl(value, addr); \
031e3601 ZY	258	} else if (addr >= MMIO_UPPER_LIMIT && addr < IO_SPACE_LIMIT) { \
	259	struct logic_pio_hwaddr *entry = find_io_range(addr); \
	260	\
0376fa72	261	if (entry) \
031e3601 ZY	262	entry->ops->out(entry->hostdata, \
	263	addr, value, sizeof(type)); \
	264	else \
	265	WARN_ON_ONCE(1); \
	266	} \
	267	} \
	268	\
26c4c6ce JG	269	void logic_ins##bwl(unsigned long addr, void *buffer, \
26c4c6ce JG	270	unsigned int count) \
031e3601 ZY	271	{ \
031e3601 ZY	272	if (addr < MMIO_UPPER_LIMIT) { \
26c4c6ce	273	reads##bwl(PCI_IOBASE + addr, buffer, count); \
031e3601 ZY	274	} else if (addr >= MMIO_UPPER_LIMIT && addr < IO_SPACE_LIMIT) { \
	275	struct logic_pio_hwaddr *entry = find_io_range(addr); \
	276	\
0376fa72	277	if (entry) \
031e3601 ZY	278	entry->ops->ins(entry->hostdata, \
	279	addr, buffer, sizeof(type), count); \
	280	else \
	281	WARN_ON_ONCE(1); \
	282	} \
	283	\
	284	} \
	285	\
26c4c6ce JG	286	void logic_outs##bwl(unsigned long addr, const void *buffer, \
26c4c6ce JG	287	unsigned int count) \
031e3601 ZY	288	{ \
031e3601 ZY	289	if (addr < MMIO_UPPER_LIMIT) { \
26c4c6ce	290	writes##bwl(PCI_IOBASE + addr, buffer, count); \
031e3601 ZY	291	} else if (addr >= MMIO_UPPER_LIMIT && addr < IO_SPACE_LIMIT) { \
	292	struct logic_pio_hwaddr *entry = find_io_range(addr); \
	293	\
0376fa72	294	if (entry) \
031e3601 ZY	295	entry->ops->outs(entry->hostdata, \
	296	addr, buffer, sizeof(type), count); \
	297	else \
	298	WARN_ON_ONCE(1); \
	299	} \
	300	}
	301
	302	BUILD_LOGIC_IO(b, u8)
	303	EXPORT_SYMBOL(logic_inb);
	304	EXPORT_SYMBOL(logic_insb);
	305	EXPORT_SYMBOL(logic_outb);
	306	EXPORT_SYMBOL(logic_outsb);
	307
	308	BUILD_LOGIC_IO(w, u16)
	309	EXPORT_SYMBOL(logic_inw);
	310	EXPORT_SYMBOL(logic_insw);
	311	EXPORT_SYMBOL(logic_outw);
	312	EXPORT_SYMBOL(logic_outsw);
	313
	314	BUILD_LOGIC_IO(l, u32)
	315	EXPORT_SYMBOL(logic_inl);
	316	EXPORT_SYMBOL(logic_insl);
	317	EXPORT_SYMBOL(logic_outl);
	318	EXPORT_SYMBOL(logic_outsl);
	319
	320	#endif /* CONFIG_INDIRECT_PIO && PCI_IOBASE */