[mirror_ubuntu-artful-kernel.git] / drivers / of / of_pci.c

#include <linux/kernel.h>
#include <linux/export.h>
#include <linux/of.h>
#include <linux/of_address.h>
#include <linux/of_pci.h>
#include <linux/slab.h>

static inline int __of_pci_pci_compare(struct device_node *node,
				       unsigned int data)
{
	int devfn;

	devfn = of_pci_get_devfn(node);
	if (devfn < 0)
		return 0;

	return devfn == data;
}

struct device_node *of_pci_find_child_device(struct device_node *parent,
					     unsigned int devfn)
{
	struct device_node *node, *node2;

	for_each_child_of_node(parent, node) {
		if (__of_pci_pci_compare(node, devfn))
			return node;
		/*
		 * Some OFs create a parent node "multifunc-device" as
		 * a fake root for all functions of a multi-function
		 * device we go down them as well.
		 */
		if (!strcmp(node->name, "multifunc-device")) {
			for_each_child_of_node(node, node2) {
				if (__of_pci_pci_compare(node2, devfn)) {
					of_node_put(node);
					return node2;
				}
			}
		}
	}
	return NULL;
}
EXPORT_SYMBOL_GPL(of_pci_find_child_device);

/**
 * of_pci_get_devfn() - Get device and function numbers for a device node
 * @np: device node
 *
 * Parses a standard 5-cell PCI resource and returns an 8-bit value that can
 * be passed to the PCI_SLOT() and PCI_FUNC() macros to extract the device
 * and function numbers respectively. On error a negative error code is
 * returned.
 */
int of_pci_get_devfn(struct device_node *np)
{
	unsigned int size;
	const __be32 *reg;

	reg = of_get_property(np, "reg", &size);

	if (!reg || size < 5 * sizeof(__be32))
		return -EINVAL;

	return (be32_to_cpup(reg) >> 8) & 0xff;
}
EXPORT_SYMBOL_GPL(of_pci_get_devfn);

/**
 * of_pci_parse_bus_range() - parse the bus-range property of a PCI device
 * @node: device node
 * @res: address to a struct resource to return the bus-range
 *
 * Returns 0 on success or a negative error-code on failure.
 */
int of_pci_parse_bus_range(struct device_node *node, struct resource *res)
{
	const __be32 *values;
	int len;

	values = of_get_property(node, "bus-range", &len);
	if (!values || len < sizeof(*values) * 2)
		return -EINVAL;

	res->name = node->name;
	res->start = be32_to_cpup(values++);
	res->end = be32_to_cpup(values);
	res->flags = IORESOURCE_BUS;

	return 0;
}
EXPORT_SYMBOL_GPL(of_pci_parse_bus_range);

/**
 * This function will try to obtain the host bridge domain number by
 * finding a property called "linux,pci-domain" of the given device node.
 *
 * @node: device tree node with the domain information
 *
 * Returns the associated domain number from DT in the range [0-0xffff], or
 * a negative value if the required property is not found.
 */
int of_get_pci_domain_nr(struct device_node *node)
{
	const __be32 *value;
	int len;
	u16 domain;

	value = of_get_property(node, "linux,pci-domain", &len);
	if (!value || len < sizeof(*value))
		return -EINVAL;

	domain = (u16)be32_to_cpup(value);

	return domain;
}
EXPORT_SYMBOL_GPL(of_get_pci_domain_nr);

#if defined(CONFIG_OF_ADDRESS)
/**
 * of_pci_get_host_bridge_resources - Parse PCI host bridge resources from DT
 * @dev: device node of the host bridge having the range property
 * @busno: bus number associated with the bridge root bus
 * @bus_max: maximum number of buses for this bridge
 * @resources: list where the range of resources will be added after DT parsing
 * @io_base: pointer to a variable that will contain on return the physical
 * address for the start of the I/O range. Can be NULL if the caller doesn't
 * expect IO ranges to be present in the device tree.
 *
 * It is the caller's job to free the @resources list.
 *
 * This function will parse the "ranges" property of a PCI host bridge device
 * node and setup the resource mapping based on its content. It is expected
 * that the property conforms with the Power ePAPR document.
 *
 * It returns zero if the range parsing has been successful or a standard error
 * value if it failed.
 */
int of_pci_get_host_bridge_resources(struct device_node *dev,
			unsigned char busno, unsigned char bus_max,
			struct list_head *resources, resource_size_t *io_base)
{
	struct resource_entry *window;
	struct resource *res;
	struct resource *bus_range;
	struct of_pci_range range;
	struct of_pci_range_parser parser;
	char range_type[4];
	int err;

	if (io_base)
		*io_base = (resource_size_t)OF_BAD_ADDR;

	bus_range = kzalloc(sizeof(*bus_range), GFP_KERNEL);
	if (!bus_range)
		return -ENOMEM;

	pr_info("PCI host bridge %s ranges:\n", dev->full_name);

	err = of_pci_parse_bus_range(dev, bus_range);
	if (err) {
		bus_range->start = busno;
		bus_range->end = bus_max;
		bus_range->flags = IORESOURCE_BUS;
		pr_info("  No bus range found for %s, using %pR\n",
			dev->full_name, bus_range);
	} else {
		if (bus_range->end > bus_range->start + bus_max)
			bus_range->end = bus_range->start + bus_max;
	}
	pci_add_resource(resources, bus_range);

	/* Check for ranges property */
	err = of_pci_range_parser_init(&parser, dev);
	if (err)
		goto parse_failed;

	pr_debug("Parsing ranges property...\n");
	for_each_of_pci_range(&parser, &range) {
		/* Read next ranges element */
		if ((range.flags & IORESOURCE_TYPE_BITS) == IORESOURCE_IO)
			snprintf(range_type, 4, " IO");
		else if ((range.flags & IORESOURCE_TYPE_BITS) == IORESOURCE_MEM)
			snprintf(range_type, 4, "MEM");
		else
			snprintf(range_type, 4, "err");
		pr_info("  %s %#010llx..%#010llx -> %#010llx\n", range_type,
			range.cpu_addr, range.cpu_addr + range.size - 1,
			range.pci_addr);

		/*
		 * If we failed translation or got a zero-sized region
		 * then skip this range
		 */
		if (range.cpu_addr == OF_BAD_ADDR || range.size == 0)
			continue;

		res = kzalloc(sizeof(struct resource), GFP_KERNEL);
		if (!res) {
			err = -ENOMEM;
			goto parse_failed;
		}

		err = of_pci_range_to_resource(&range, dev, res);
		if (err)
			goto conversion_failed;

		if (resource_type(res) == IORESOURCE_IO) {
			if (!io_base) {
				pr_err("I/O range found for %s. Please provide an io_base pointer to save CPU base address\n",
					dev->full_name);
				err = -EINVAL;
				goto conversion_failed;
			}
			if (*io_base != (resource_size_t)OF_BAD_ADDR)
				pr_warn("More than one I/O resource converted for %s. CPU base address for old range lost!\n",
					dev->full_name);
			*io_base = range.cpu_addr;
		}

		pci_add_resource_offset(resources, res,	res->start - range.pci_addr);
	}

	return 0;

conversion_failed:
	kfree(res);
parse_failed:
	resource_list_for_each_entry(window, resources)
		kfree(window->res);
	pci_free_resource_list(resources);
	return err;
}
EXPORT_SYMBOL_GPL(of_pci_get_host_bridge_resources);
#endif /* CONFIG_OF_ADDRESS */

#ifdef CONFIG_PCI_MSI

static LIST_HEAD(of_pci_msi_chip_list);
static DEFINE_MUTEX(of_pci_msi_chip_mutex);

int of_pci_msi_chip_add(struct msi_controller *chip)
{
	if (!of_property_read_bool(chip->of_node, "msi-controller"))
		return -EINVAL;

	mutex_lock(&of_pci_msi_chip_mutex);
	list_add(&chip->list, &of_pci_msi_chip_list);
	mutex_unlock(&of_pci_msi_chip_mutex);

	return 0;
}
EXPORT_SYMBOL_GPL(of_pci_msi_chip_add);

void of_pci_msi_chip_remove(struct msi_controller *chip)
{
	mutex_lock(&of_pci_msi_chip_mutex);
	list_del(&chip->list);
	mutex_unlock(&of_pci_msi_chip_mutex);
}
EXPORT_SYMBOL_GPL(of_pci_msi_chip_remove);

struct msi_controller *of_pci_find_msi_chip_by_node(struct device_node *of_node)
{
	struct msi_controller *c;

	mutex_lock(&of_pci_msi_chip_mutex);
	list_for_each_entry(c, &of_pci_msi_chip_list, list) {
		if (c->of_node == of_node) {
			mutex_unlock(&of_pci_msi_chip_mutex);
			return c;
		}
	}
	mutex_unlock(&of_pci_msi_chip_mutex);

	return NULL;
}
EXPORT_SYMBOL_GPL(of_pci_find_msi_chip_by_node);

#endif /* CONFIG_PCI_MSI */
Commit	Line	Data
04bea68b	1	#include <linux/kernel.h>
9775913f	2	#include <linux/export.h>
a6422850	3	#include <linux/of.h>
cbe4097f	4	#include <linux/of_address.h>
04bea68b	5	#include <linux/of_pci.h>
cbe4097f	6	#include <linux/slab.h>
04bea68b	7
98d9f30c	8	static inline int __of_pci_pci_compare(struct device_node *node,
45ab9702	9	unsigned int data)
04bea68b	10	{
45ab9702	11	int devfn;
04bea68b	12
45ab9702 TR	13	devfn = of_pci_get_devfn(node);
45ab9702 TR	14	if (devfn < 0)
98d9f30c	15	return 0;
45ab9702 TR	16
45ab9702 TR	17	return devfn == data;
98d9f30c	18	}
04bea68b	19
98d9f30c BH	20	struct device_node of_pci_find_child_device(struct device_node parent,
	21	unsigned int devfn)
	22	{
	23	struct device_node node, node2;
	24
	25	for_each_child_of_node(parent, node) {
	26	if (__of_pci_pci_compare(node, devfn))
	27	return node;
	28	/*
	29	* Some OFs create a parent node "multifunc-device" as
	30	* a fake root for all functions of a multi-function
	31	* device we go down them as well.
04bea68b	32	*/
98d9f30c BH	33	if (!strcmp(node->name, "multifunc-device")) {
	34	for_each_child_of_node(node, node2) {
	35	if (__of_pci_pci_compare(node2, devfn)) {
	36	of_node_put(node);
	37	return node2;
	38	}
	39	}
	40	}
04bea68b	41	}
98d9f30c	42	return NULL;
04bea68b	43	}
98d9f30c	44	EXPORT_SYMBOL_GPL(of_pci_find_child_device);
45ab9702 TR	45
	46	/**
	47	* of_pci_get_devfn() - Get device and function numbers for a device node
	48	* @np: device node
	49	*
	50	* Parses a standard 5-cell PCI resource and returns an 8-bit value that can
	51	* be passed to the PCI_SLOT() and PCI_FUNC() macros to extract the device
	52	* and function numbers respectively. On error a negative error code is
	53	* returned.
	54	*/
	55	int of_pci_get_devfn(struct device_node *np)
	56	{
	57	unsigned int size;
	58	const __be32 *reg;
	59
	60	reg = of_get_property(np, "reg", &size);
	61
	62	if (!reg \|\| size < 5 * sizeof(__be32))
	63	return -EINVAL;
	64
	65	return (be32_to_cpup(reg) >> 8) & 0xff;
	66	}
	67	EXPORT_SYMBOL_GPL(of_pci_get_devfn);
4e23d3f5 TR	68
	69	/**
	70	* of_pci_parse_bus_range() - parse the bus-range property of a PCI device
	71	* @node: device node
	72	* @res: address to a struct resource to return the bus-range
	73	*
	74	* Returns 0 on success or a negative error-code on failure.
	75	*/
	76	int of_pci_parse_bus_range(struct device_node node, struct resource res)
	77	{
	78	const __be32 *values;
	79	int len;
	80
	81	values = of_get_property(node, "bus-range", &len);
	82	if (!values \|\| len < sizeof(values) 2)
	83	return -EINVAL;
	84
	85	res->name = node->name;
	86	res->start = be32_to_cpup(values++);
	87	res->end = be32_to_cpup(values);
	88	res->flags = IORESOURCE_BUS;
	89
	90	return 0;
	91	}
	92	EXPORT_SYMBOL_GPL(of_pci_parse_bus_range);
0d5a6db3	93
41e5c0f8 LD	94	/**
	95	* This function will try to obtain the host bridge domain number by
	96	* finding a property called "linux,pci-domain" of the given device node.
	97	*
	98	* @node: device tree node with the domain information
	99	*
	100	* Returns the associated domain number from DT in the range [0-0xffff], or
	101	* a negative value if the required property is not found.
	102	*/
	103	int of_get_pci_domain_nr(struct device_node *node)
	104	{
	105	const __be32 *value;
	106	int len;
	107	u16 domain;
	108
	109	value = of_get_property(node, "linux,pci-domain", &len);
	110	if (!value \|\| len < sizeof(*value))
	111	return -EINVAL;
	112
	113	domain = (u16)be32_to_cpup(value);
	114
	115	return domain;
	116	}
	117	EXPORT_SYMBOL_GPL(of_get_pci_domain_nr);
	118
cbe4097f LD	119	#if defined(CONFIG_OF_ADDRESS)
	120	/**
	121	* of_pci_get_host_bridge_resources - Parse PCI host bridge resources from DT
	122	* @dev: device node of the host bridge having the range property
	123	* @busno: bus number associated with the bridge root bus
	124	* @bus_max: maximum number of buses for this bridge
	125	* @resources: list where the range of resources will be added after DT parsing
	126	* @io_base: pointer to a variable that will contain on return the physical
	127	* address for the start of the I/O range. Can be NULL if the caller doesn't
	128	* expect IO ranges to be present in the device tree.
	129	*
	130	* It is the caller's job to free the @resources list.
	131	*
	132	* This function will parse the "ranges" property of a PCI host bridge device
	133	* node and setup the resource mapping based on its content. It is expected
	134	* that the property conforms with the Power ePAPR document.
	135	*
	136	* It returns zero if the range parsing has been successful or a standard error
	137	* value if it failed.
	138	*/
	139	int of_pci_get_host_bridge_resources(struct device_node *dev,
	140	unsigned char busno, unsigned char bus_max,
	141	struct list_head resources, resource_size_t io_base)
	142	{
5c493df2	143	struct resource_entry *window;
cbe4097f LD	144	struct resource *res;
	145	struct resource *bus_range;
	146	struct of_pci_range range;
	147	struct of_pci_range_parser parser;
	148	char range_type[4];
	149	int err;
	150
	151	if (io_base)
	152	*io_base = (resource_size_t)OF_BAD_ADDR;
	153
	154	bus_range = kzalloc(sizeof(*bus_range), GFP_KERNEL);
	155	if (!bus_range)
	156	return -ENOMEM;
	157
	158	pr_info("PCI host bridge %s ranges:\n", dev->full_name);
	159
	160	err = of_pci_parse_bus_range(dev, bus_range);
	161	if (err) {
	162	bus_range->start = busno;
	163	bus_range->end = bus_max;
	164	bus_range->flags = IORESOURCE_BUS;
	165	pr_info(" No bus range found for %s, using %pR\n",
	166	dev->full_name, bus_range);
	167	} else {
	168	if (bus_range->end > bus_range->start + bus_max)
	169	bus_range->end = bus_range->start + bus_max;
	170	}
	171	pci_add_resource(resources, bus_range);
	172
	173	/* Check for ranges property */
	174	err = of_pci_range_parser_init(&parser, dev);
	175	if (err)
	176	goto parse_failed;
	177
	178	pr_debug("Parsing ranges property...\n");
	179	for_each_of_pci_range(&parser, &range) {
	180	/* Read next ranges element */
	181	if ((range.flags & IORESOURCE_TYPE_BITS) == IORESOURCE_IO)
	182	snprintf(range_type, 4, " IO");
	183	else if ((range.flags & IORESOURCE_TYPE_BITS) == IORESOURCE_MEM)
	184	snprintf(range_type, 4, "MEM");
	185	else
	186	snprintf(range_type, 4, "err");
	187	pr_info(" %s %#010llx..%#010llx -> %#010llx\n", range_type,
	188	range.cpu_addr, range.cpu_addr + range.size - 1,
	189	range.pci_addr);
	190
	191	/*
	192	* If we failed translation or got a zero-sized region
	193	* then skip this range
	194	*/
	195	if (range.cpu_addr == OF_BAD_ADDR \|\| range.size == 0)
	196	continue;
	197
	198	res = kzalloc(sizeof(struct resource), GFP_KERNEL);
	199	if (!res) {
	200	err = -ENOMEM;
	201	goto parse_failed;
	202	}
	203
	204	err = of_pci_range_to_resource(&range, dev, res);
	205	if (err)
	206	goto conversion_failed;
	207
208	if (resource_type(res) == IORESOURCE_IO) {
209	if (!io_base) {
210	pr_err("I/O range found for %s. Please provide an io_base pointer to save CPU base address\n",
211	dev->full_name);
212	err = -EINVAL;
213	goto conversion_failed;
214	}
215	if (*io_base != (resource_size_t)OF_BAD_ADDR)
216	pr_warn("More than one I/O resource converted for %s. CPU base address for old range lost!\n",
217	dev->full_name);
218	*io_base = range.cpu_addr;
219	}
220
221	pci_add_resource_offset(resources, res, res->start - range.pci_addr);
222	}
223
224	return 0;
225
226	conversion_failed:
227	kfree(res);
228	parse_failed:
5c493df2 RW	229	resource_list_for_each_entry(window, resources)
5c493df2 RW	230	kfree(window->res);
cbe4097f LD	231	pci_free_resource_list(resources);
	232	return err;
	233	}
	234	EXPORT_SYMBOL_GPL(of_pci_get_host_bridge_resources);
	235	#endif /* CONFIG_OF_ADDRESS */
	236
0d5a6db3 TP	237	#ifdef CONFIG_PCI_MSI
	238
	239	static LIST_HEAD(of_pci_msi_chip_list);
	240	static DEFINE_MUTEX(of_pci_msi_chip_mutex);
	241
c2791b80	242	int of_pci_msi_chip_add(struct msi_controller *chip)
0d5a6db3 TP	243	{
	244	if (!of_property_read_bool(chip->of_node, "msi-controller"))
	245	return -EINVAL;
	246
	247	mutex_lock(&of_pci_msi_chip_mutex);
	248	list_add(&chip->list, &of_pci_msi_chip_list);
	249	mutex_unlock(&of_pci_msi_chip_mutex);
	250
	251	return 0;
	252	}
	253	EXPORT_SYMBOL_GPL(of_pci_msi_chip_add);
	254
c2791b80	255	void of_pci_msi_chip_remove(struct msi_controller *chip)
0d5a6db3 TP	256	{
	257	mutex_lock(&of_pci_msi_chip_mutex);
	258	list_del(&chip->list);
	259	mutex_unlock(&of_pci_msi_chip_mutex);
	260	}
	261	EXPORT_SYMBOL_GPL(of_pci_msi_chip_remove);
	262
c2791b80	263	struct msi_controller of_pci_find_msi_chip_by_node(struct device_node of_node)
0d5a6db3	264	{
c2791b80	265	struct msi_controller *c;
0d5a6db3 TP	266
	267	mutex_lock(&of_pci_msi_chip_mutex);
	268	list_for_each_entry(c, &of_pci_msi_chip_list, list) {
	269	if (c->of_node == of_node) {
	270	mutex_unlock(&of_pci_msi_chip_mutex);
	271	return c;
	272	}
	273	}
	274	mutex_unlock(&of_pci_msi_chip_mutex);
	275
	276	return NULL;
	277	}
	278	EXPORT_SYMBOL_GPL(of_pci_find_msi_chip_by_node);
	279
	280	#endif /* CONFIG_PCI_MSI */