18cfab3cfSBjorn Helgaas // SPDX-License-Identifier: GPL-2.0
29b41d19aSKrzysztof Kozlowski /*
35e8cb403SKishon Vijay Abraham I  * PCI Endpoint *Controller* (EPC) library
45e8cb403SKishon Vijay Abraham I  *
55e8cb403SKishon Vijay Abraham I  * Copyright (C) 2017 Texas Instruments
65e8cb403SKishon Vijay Abraham I  * Author: Kishon Vijay Abraham I <kishon@ti.com>
75e8cb403SKishon Vijay Abraham I  */
85e8cb403SKishon Vijay Abraham I 
95e8cb403SKishon Vijay Abraham I #include <linux/device.h>
105e8cb403SKishon Vijay Abraham I #include <linux/slab.h>
115e8cb403SKishon Vijay Abraham I #include <linux/module.h>
1264c1a02aSKishon Vijay Abraham I #include <linux/of_device.h>
135e8cb403SKishon Vijay Abraham I 
145e8cb403SKishon Vijay Abraham I #include <linux/pci-epc.h>
155e8cb403SKishon Vijay Abraham I #include <linux/pci-epf.h>
163a401a2cSKishon Vijay Abraham I #include <linux/pci-ep-cfs.h>
175e8cb403SKishon Vijay Abraham I 
185e8cb403SKishon Vijay Abraham I static struct class *pci_epc_class;
195e8cb403SKishon Vijay Abraham I 
205e8cb403SKishon Vijay Abraham I static void devm_pci_epc_release(struct device *dev, void *res)
215e8cb403SKishon Vijay Abraham I {
225e8cb403SKishon Vijay Abraham I 	struct pci_epc *epc = *(struct pci_epc **)res;
235e8cb403SKishon Vijay Abraham I 
245e8cb403SKishon Vijay Abraham I 	pci_epc_destroy(epc);
255e8cb403SKishon Vijay Abraham I }
265e8cb403SKishon Vijay Abraham I 
275e8cb403SKishon Vijay Abraham I static int devm_pci_epc_match(struct device *dev, void *res, void *match_data)
285e8cb403SKishon Vijay Abraham I {
295e8cb403SKishon Vijay Abraham I 	struct pci_epc **epc = res;
305e8cb403SKishon Vijay Abraham I 
315e8cb403SKishon Vijay Abraham I 	return *epc == match_data;
325e8cb403SKishon Vijay Abraham I }
335e8cb403SKishon Vijay Abraham I 
345e8cb403SKishon Vijay Abraham I /**
355e8cb403SKishon Vijay Abraham I  * pci_epc_put() - release the PCI endpoint controller
365e8cb403SKishon Vijay Abraham I  * @epc: epc returned by pci_epc_get()
375e8cb403SKishon Vijay Abraham I  *
385e8cb403SKishon Vijay Abraham I  * release the refcount the caller obtained by invoking pci_epc_get()
395e8cb403SKishon Vijay Abraham I  */
405e8cb403SKishon Vijay Abraham I void pci_epc_put(struct pci_epc *epc)
415e8cb403SKishon Vijay Abraham I {
425e8cb403SKishon Vijay Abraham I 	if (!epc || IS_ERR(epc))
435e8cb403SKishon Vijay Abraham I 		return;
445e8cb403SKishon Vijay Abraham I 
455e8cb403SKishon Vijay Abraham I 	module_put(epc->ops->owner);
465e8cb403SKishon Vijay Abraham I 	put_device(&epc->dev);
475e8cb403SKishon Vijay Abraham I }
485e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_put);
495e8cb403SKishon Vijay Abraham I 
505e8cb403SKishon Vijay Abraham I /**
515e8cb403SKishon Vijay Abraham I  * pci_epc_get() - get the PCI endpoint controller
525e8cb403SKishon Vijay Abraham I  * @epc_name: device name of the endpoint controller
535e8cb403SKishon Vijay Abraham I  *
545e8cb403SKishon Vijay Abraham I  * Invoke to get struct pci_epc * corresponding to the device name of the
555e8cb403SKishon Vijay Abraham I  * endpoint controller
565e8cb403SKishon Vijay Abraham I  */
575e8cb403SKishon Vijay Abraham I struct pci_epc *pci_epc_get(const char *epc_name)
585e8cb403SKishon Vijay Abraham I {
595e8cb403SKishon Vijay Abraham I 	int ret = -EINVAL;
605e8cb403SKishon Vijay Abraham I 	struct pci_epc *epc;
615e8cb403SKishon Vijay Abraham I 	struct device *dev;
625e8cb403SKishon Vijay Abraham I 	struct class_dev_iter iter;
635e8cb403SKishon Vijay Abraham I 
645e8cb403SKishon Vijay Abraham I 	class_dev_iter_init(&iter, pci_epc_class, NULL, NULL);
655e8cb403SKishon Vijay Abraham I 	while ((dev = class_dev_iter_next(&iter))) {
665e8cb403SKishon Vijay Abraham I 		if (strcmp(epc_name, dev_name(dev)))
675e8cb403SKishon Vijay Abraham I 			continue;
685e8cb403SKishon Vijay Abraham I 
695e8cb403SKishon Vijay Abraham I 		epc = to_pci_epc(dev);
705e8cb403SKishon Vijay Abraham I 		if (!try_module_get(epc->ops->owner)) {
715e8cb403SKishon Vijay Abraham I 			ret = -EINVAL;
725e8cb403SKishon Vijay Abraham I 			goto err;
735e8cb403SKishon Vijay Abraham I 		}
745e8cb403SKishon Vijay Abraham I 
755e8cb403SKishon Vijay Abraham I 		class_dev_iter_exit(&iter);
765e8cb403SKishon Vijay Abraham I 		get_device(&epc->dev);
775e8cb403SKishon Vijay Abraham I 		return epc;
785e8cb403SKishon Vijay Abraham I 	}
795e8cb403SKishon Vijay Abraham I 
805e8cb403SKishon Vijay Abraham I err:
815e8cb403SKishon Vijay Abraham I 	class_dev_iter_exit(&iter);
825e8cb403SKishon Vijay Abraham I 	return ERR_PTR(ret);
835e8cb403SKishon Vijay Abraham I }
845e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_get);
855e8cb403SKishon Vijay Abraham I 
865e8cb403SKishon Vijay Abraham I /**
871e9efe6cSKishon Vijay Abraham I  * pci_epc_get_first_free_bar() - helper to get first unreserved BAR
881e9efe6cSKishon Vijay Abraham I  * @epc_features: pci_epc_features structure that holds the reserved bar bitmap
891e9efe6cSKishon Vijay Abraham I  *
90fa8fef0eSKishon Vijay Abraham I  * Invoke to get the first unreserved BAR that can be used by the endpoint
911e9efe6cSKishon Vijay Abraham I  * function. For any incorrect value in reserved_bar return '0'.
921e9efe6cSKishon Vijay Abraham I  */
930e27aeccSKishon Vijay Abraham I enum pci_barno
940e27aeccSKishon Vijay Abraham I pci_epc_get_first_free_bar(const struct pci_epc_features *epc_features)
951e9efe6cSKishon Vijay Abraham I {
96fa8fef0eSKishon Vijay Abraham I 	return pci_epc_get_next_free_bar(epc_features, BAR_0);
97fa8fef0eSKishon Vijay Abraham I }
98fa8fef0eSKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_get_first_free_bar);
99fa8fef0eSKishon Vijay Abraham I 
100fa8fef0eSKishon Vijay Abraham I /**
101fa8fef0eSKishon Vijay Abraham I  * pci_epc_get_next_free_bar() - helper to get unreserved BAR starting from @bar
102fa8fef0eSKishon Vijay Abraham I  * @epc_features: pci_epc_features structure that holds the reserved bar bitmap
103fa8fef0eSKishon Vijay Abraham I  * @bar: the starting BAR number from where unreserved BAR should be searched
104fa8fef0eSKishon Vijay Abraham I  *
105fa8fef0eSKishon Vijay Abraham I  * Invoke to get the next unreserved BAR starting from @bar that can be used
106fa8fef0eSKishon Vijay Abraham I  * for endpoint function. For any incorrect value in reserved_bar return '0'.
107fa8fef0eSKishon Vijay Abraham I  */
1080e27aeccSKishon Vijay Abraham I enum pci_barno pci_epc_get_next_free_bar(const struct pci_epc_features
109fa8fef0eSKishon Vijay Abraham I 					 *epc_features, enum pci_barno bar)
110fa8fef0eSKishon Vijay Abraham I {
111959a48d0SKishon Vijay Abraham I 	unsigned long free_bar;
1121e9efe6cSKishon Vijay Abraham I 
1131e9efe6cSKishon Vijay Abraham I 	if (!epc_features)
1140e27aeccSKishon Vijay Abraham I 		return BAR_0;
1151e9efe6cSKishon Vijay Abraham I 
116fa8fef0eSKishon Vijay Abraham I 	/* If 'bar - 1' is a 64-bit BAR, move to the next BAR */
117fa8fef0eSKishon Vijay Abraham I 	if ((epc_features->bar_fixed_64bit << 1) & 1 << bar)
118fa8fef0eSKishon Vijay Abraham I 		bar++;
119fa8fef0eSKishon Vijay Abraham I 
120959a48d0SKishon Vijay Abraham I 	/* Find if the reserved BAR is also a 64-bit BAR */
121959a48d0SKishon Vijay Abraham I 	free_bar = epc_features->reserved_bar & epc_features->bar_fixed_64bit;
122959a48d0SKishon Vijay Abraham I 
123959a48d0SKishon Vijay Abraham I 	/* Set the adjacent bit if the reserved BAR is also a 64-bit BAR */
124959a48d0SKishon Vijay Abraham I 	free_bar <<= 1;
125959a48d0SKishon Vijay Abraham I 	free_bar |= epc_features->reserved_bar;
126959a48d0SKishon Vijay Abraham I 
127fa8fef0eSKishon Vijay Abraham I 	free_bar = find_next_zero_bit(&free_bar, 6, bar);
1281e9efe6cSKishon Vijay Abraham I 	if (free_bar > 5)
1290e27aeccSKishon Vijay Abraham I 		return NO_BAR;
1301e9efe6cSKishon Vijay Abraham I 
1311e9efe6cSKishon Vijay Abraham I 	return free_bar;
1321e9efe6cSKishon Vijay Abraham I }
133fa8fef0eSKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_get_next_free_bar);
1341e9efe6cSKishon Vijay Abraham I 
1351e9efe6cSKishon Vijay Abraham I /**
13641cb8d18SKishon Vijay Abraham I  * pci_epc_get_features() - get the features supported by EPC
13741cb8d18SKishon Vijay Abraham I  * @epc: the features supported by *this* EPC device will be returned
13841cb8d18SKishon Vijay Abraham I  * @func_no: the features supported by the EPC device specific to the
13941cb8d18SKishon Vijay Abraham I  *	     endpoint function with func_no will be returned
14041cb8d18SKishon Vijay Abraham I  *
14141cb8d18SKishon Vijay Abraham I  * Invoke to get the features provided by the EPC which may be
14241cb8d18SKishon Vijay Abraham I  * specific to an endpoint function. Returns pci_epc_features on success
14341cb8d18SKishon Vijay Abraham I  * and NULL for any failures.
14441cb8d18SKishon Vijay Abraham I  */
14541cb8d18SKishon Vijay Abraham I const struct pci_epc_features *pci_epc_get_features(struct pci_epc *epc,
14641cb8d18SKishon Vijay Abraham I 						    u8 func_no)
14741cb8d18SKishon Vijay Abraham I {
14841cb8d18SKishon Vijay Abraham I 	const struct pci_epc_features *epc_features;
14941cb8d18SKishon Vijay Abraham I 
15041cb8d18SKishon Vijay Abraham I 	if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions)
15141cb8d18SKishon Vijay Abraham I 		return NULL;
15241cb8d18SKishon Vijay Abraham I 
15341cb8d18SKishon Vijay Abraham I 	if (!epc->ops->get_features)
15441cb8d18SKishon Vijay Abraham I 		return NULL;
15541cb8d18SKishon Vijay Abraham I 
1563d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
15741cb8d18SKishon Vijay Abraham I 	epc_features = epc->ops->get_features(epc, func_no);
1583d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
15941cb8d18SKishon Vijay Abraham I 
16041cb8d18SKishon Vijay Abraham I 	return epc_features;
16141cb8d18SKishon Vijay Abraham I }
16241cb8d18SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_get_features);
16341cb8d18SKishon Vijay Abraham I 
16441cb8d18SKishon Vijay Abraham I /**
1655e8cb403SKishon Vijay Abraham I  * pci_epc_stop() - stop the PCI link
1665e8cb403SKishon Vijay Abraham I  * @epc: the link of the EPC device that has to be stopped
1675e8cb403SKishon Vijay Abraham I  *
1685e8cb403SKishon Vijay Abraham I  * Invoke to stop the PCI link
1695e8cb403SKishon Vijay Abraham I  */
1705e8cb403SKishon Vijay Abraham I void pci_epc_stop(struct pci_epc *epc)
1715e8cb403SKishon Vijay Abraham I {
1725e8cb403SKishon Vijay Abraham I 	if (IS_ERR(epc) || !epc->ops->stop)
1735e8cb403SKishon Vijay Abraham I 		return;
1745e8cb403SKishon Vijay Abraham I 
1753d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
1765e8cb403SKishon Vijay Abraham I 	epc->ops->stop(epc);
1773d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
1785e8cb403SKishon Vijay Abraham I }
1795e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_stop);
1805e8cb403SKishon Vijay Abraham I 
1815e8cb403SKishon Vijay Abraham I /**
1825e8cb403SKishon Vijay Abraham I  * pci_epc_start() - start the PCI link
1835e8cb403SKishon Vijay Abraham I  * @epc: the link of *this* EPC device has to be started
1845e8cb403SKishon Vijay Abraham I  *
1855e8cb403SKishon Vijay Abraham I  * Invoke to start the PCI link
1865e8cb403SKishon Vijay Abraham I  */
1875e8cb403SKishon Vijay Abraham I int pci_epc_start(struct pci_epc *epc)
1885e8cb403SKishon Vijay Abraham I {
1895e8cb403SKishon Vijay Abraham I 	int ret;
1905e8cb403SKishon Vijay Abraham I 
1915e8cb403SKishon Vijay Abraham I 	if (IS_ERR(epc))
1925e8cb403SKishon Vijay Abraham I 		return -EINVAL;
1935e8cb403SKishon Vijay Abraham I 
1945e8cb403SKishon Vijay Abraham I 	if (!epc->ops->start)
1955e8cb403SKishon Vijay Abraham I 		return 0;
1965e8cb403SKishon Vijay Abraham I 
1973d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
1985e8cb403SKishon Vijay Abraham I 	ret = epc->ops->start(epc);
1993d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
2005e8cb403SKishon Vijay Abraham I 
2015e8cb403SKishon Vijay Abraham I 	return ret;
2025e8cb403SKishon Vijay Abraham I }
2035e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_start);
2045e8cb403SKishon Vijay Abraham I 
2055e8cb403SKishon Vijay Abraham I /**
2065e8cb403SKishon Vijay Abraham I  * pci_epc_raise_irq() - interrupt the host system
2075e8cb403SKishon Vijay Abraham I  * @epc: the EPC device which has to interrupt the host
2084494738dSCyrille Pitchen  * @func_no: the endpoint function number in the EPC device
209d3c70a98SGustavo Pimentel  * @type: specify the type of interrupt; legacy, MSI or MSI-X
210d3c70a98SGustavo Pimentel  * @interrupt_num: the MSI or MSI-X interrupt number
2115e8cb403SKishon Vijay Abraham I  *
212d3c70a98SGustavo Pimentel  * Invoke to raise an legacy, MSI or MSI-X interrupt
2135e8cb403SKishon Vijay Abraham I  */
2144494738dSCyrille Pitchen int pci_epc_raise_irq(struct pci_epc *epc, u8 func_no,
215d3c70a98SGustavo Pimentel 		      enum pci_epc_irq_type type, u16 interrupt_num)
2165e8cb403SKishon Vijay Abraham I {
2175e8cb403SKishon Vijay Abraham I 	int ret;
2185e8cb403SKishon Vijay Abraham I 
2194494738dSCyrille Pitchen 	if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions)
2205e8cb403SKishon Vijay Abraham I 		return -EINVAL;
2215e8cb403SKishon Vijay Abraham I 
2225e8cb403SKishon Vijay Abraham I 	if (!epc->ops->raise_irq)
2235e8cb403SKishon Vijay Abraham I 		return 0;
2245e8cb403SKishon Vijay Abraham I 
2253d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
2264494738dSCyrille Pitchen 	ret = epc->ops->raise_irq(epc, func_no, type, interrupt_num);
2273d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
2285e8cb403SKishon Vijay Abraham I 
2295e8cb403SKishon Vijay Abraham I 	return ret;
2305e8cb403SKishon Vijay Abraham I }
2315e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_raise_irq);
2325e8cb403SKishon Vijay Abraham I 
2335e8cb403SKishon Vijay Abraham I /**
23487d5972eSKishon Vijay Abraham I  * pci_epc_map_msi_irq() - Map physical address to MSI address and return
23587d5972eSKishon Vijay Abraham I  *                         MSI data
23687d5972eSKishon Vijay Abraham I  * @epc: the EPC device which has the MSI capability
23787d5972eSKishon Vijay Abraham I  * @func_no: the physical endpoint function number in the EPC device
23887d5972eSKishon Vijay Abraham I  * @phys_addr: the physical address of the outbound region
23987d5972eSKishon Vijay Abraham I  * @interrupt_num: the MSI interrupt number
24087d5972eSKishon Vijay Abraham I  * @entry_size: Size of Outbound address region for each interrupt
24187d5972eSKishon Vijay Abraham I  * @msi_data: the data that should be written in order to raise MSI interrupt
24287d5972eSKishon Vijay Abraham I  *            with interrupt number as 'interrupt num'
24387d5972eSKishon Vijay Abraham I  * @msi_addr_offset: Offset of MSI address from the aligned outbound address
24487d5972eSKishon Vijay Abraham I  *                   to which the MSI address is mapped
24587d5972eSKishon Vijay Abraham I  *
24687d5972eSKishon Vijay Abraham I  * Invoke to map physical address to MSI address and return MSI data. The
24787d5972eSKishon Vijay Abraham I  * physical address should be an address in the outbound region. This is
24887d5972eSKishon Vijay Abraham I  * required to implement doorbell functionality of NTB wherein EPC on either
24987d5972eSKishon Vijay Abraham I  * side of the interface (primary and secondary) can directly write to the
25087d5972eSKishon Vijay Abraham I  * physical address (in outbound region) of the other interface to ring
25187d5972eSKishon Vijay Abraham I  * doorbell.
25287d5972eSKishon Vijay Abraham I  */
25387d5972eSKishon Vijay Abraham I int pci_epc_map_msi_irq(struct pci_epc *epc, u8 func_no, phys_addr_t phys_addr,
25487d5972eSKishon Vijay Abraham I 			u8 interrupt_num, u32 entry_size, u32 *msi_data,
25587d5972eSKishon Vijay Abraham I 			u32 *msi_addr_offset)
25687d5972eSKishon Vijay Abraham I {
25787d5972eSKishon Vijay Abraham I 	int ret;
25887d5972eSKishon Vijay Abraham I 
25987d5972eSKishon Vijay Abraham I 	if (IS_ERR_OR_NULL(epc))
26087d5972eSKishon Vijay Abraham I 		return -EINVAL;
26187d5972eSKishon Vijay Abraham I 
26287d5972eSKishon Vijay Abraham I 	if (!epc->ops->map_msi_irq)
26387d5972eSKishon Vijay Abraham I 		return -EINVAL;
26487d5972eSKishon Vijay Abraham I 
26587d5972eSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
26687d5972eSKishon Vijay Abraham I 	ret = epc->ops->map_msi_irq(epc, func_no, phys_addr, interrupt_num,
26787d5972eSKishon Vijay Abraham I 				    entry_size, msi_data, msi_addr_offset);
26887d5972eSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
26987d5972eSKishon Vijay Abraham I 
27087d5972eSKishon Vijay Abraham I 	return ret;
27187d5972eSKishon Vijay Abraham I }
27287d5972eSKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_map_msi_irq);
27387d5972eSKishon Vijay Abraham I 
27487d5972eSKishon Vijay Abraham I /**
2755e8cb403SKishon Vijay Abraham I  * pci_epc_get_msi() - get the number of MSI interrupt numbers allocated
2765e8cb403SKishon Vijay Abraham I  * @epc: the EPC device to which MSI interrupts was requested
2774494738dSCyrille Pitchen  * @func_no: the endpoint function number in the EPC device
2785e8cb403SKishon Vijay Abraham I  *
2795e8cb403SKishon Vijay Abraham I  * Invoke to get the number of MSI interrupts allocated by the RC
2805e8cb403SKishon Vijay Abraham I  */
2814494738dSCyrille Pitchen int pci_epc_get_msi(struct pci_epc *epc, u8 func_no)
2825e8cb403SKishon Vijay Abraham I {
2835e8cb403SKishon Vijay Abraham I 	int interrupt;
2845e8cb403SKishon Vijay Abraham I 
2854494738dSCyrille Pitchen 	if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions)
2865e8cb403SKishon Vijay Abraham I 		return 0;
2875e8cb403SKishon Vijay Abraham I 
2885e8cb403SKishon Vijay Abraham I 	if (!epc->ops->get_msi)
2895e8cb403SKishon Vijay Abraham I 		return 0;
2905e8cb403SKishon Vijay Abraham I 
2913d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
2924494738dSCyrille Pitchen 	interrupt = epc->ops->get_msi(epc, func_no);
2933d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
2945e8cb403SKishon Vijay Abraham I 
2955e8cb403SKishon Vijay Abraham I 	if (interrupt < 0)
2965e8cb403SKishon Vijay Abraham I 		return 0;
2975e8cb403SKishon Vijay Abraham I 
2985e8cb403SKishon Vijay Abraham I 	interrupt = 1 << interrupt;
2995e8cb403SKishon Vijay Abraham I 
3005e8cb403SKishon Vijay Abraham I 	return interrupt;
3015e8cb403SKishon Vijay Abraham I }
3025e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_get_msi);
3035e8cb403SKishon Vijay Abraham I 
3045e8cb403SKishon Vijay Abraham I /**
3055e8cb403SKishon Vijay Abraham I  * pci_epc_set_msi() - set the number of MSI interrupt numbers required
3065e8cb403SKishon Vijay Abraham I  * @epc: the EPC device on which MSI has to be configured
3074494738dSCyrille Pitchen  * @func_no: the endpoint function number in the EPC device
3085e8cb403SKishon Vijay Abraham I  * @interrupts: number of MSI interrupts required by the EPF
3095e8cb403SKishon Vijay Abraham I  *
3105e8cb403SKishon Vijay Abraham I  * Invoke to set the required number of MSI interrupts.
3115e8cb403SKishon Vijay Abraham I  */
3124494738dSCyrille Pitchen int pci_epc_set_msi(struct pci_epc *epc, u8 func_no, u8 interrupts)
3135e8cb403SKishon Vijay Abraham I {
3145e8cb403SKishon Vijay Abraham I 	int ret;
3155e8cb403SKishon Vijay Abraham I 	u8 encode_int;
3165e8cb403SKishon Vijay Abraham I 
31715c972dfSGustavo Pimentel 	if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions ||
31815c972dfSGustavo Pimentel 	    interrupts > 32)
3195e8cb403SKishon Vijay Abraham I 		return -EINVAL;
3205e8cb403SKishon Vijay Abraham I 
3215e8cb403SKishon Vijay Abraham I 	if (!epc->ops->set_msi)
3225e8cb403SKishon Vijay Abraham I 		return 0;
3235e8cb403SKishon Vijay Abraham I 
3245e8cb403SKishon Vijay Abraham I 	encode_int = order_base_2(interrupts);
3255e8cb403SKishon Vijay Abraham I 
3263d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
3274494738dSCyrille Pitchen 	ret = epc->ops->set_msi(epc, func_no, encode_int);
3283d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
3295e8cb403SKishon Vijay Abraham I 
3305e8cb403SKishon Vijay Abraham I 	return ret;
3315e8cb403SKishon Vijay Abraham I }
3325e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_set_msi);
3335e8cb403SKishon Vijay Abraham I 
3345e8cb403SKishon Vijay Abraham I /**
3358963106eSGustavo Pimentel  * pci_epc_get_msix() - get the number of MSI-X interrupt numbers allocated
3368963106eSGustavo Pimentel  * @epc: the EPC device to which MSI-X interrupts was requested
3378963106eSGustavo Pimentel  * @func_no: the endpoint function number in the EPC device
3388963106eSGustavo Pimentel  *
3398963106eSGustavo Pimentel  * Invoke to get the number of MSI-X interrupts allocated by the RC
3408963106eSGustavo Pimentel  */
3418963106eSGustavo Pimentel int pci_epc_get_msix(struct pci_epc *epc, u8 func_no)
3428963106eSGustavo Pimentel {
3438963106eSGustavo Pimentel 	int interrupt;
3448963106eSGustavo Pimentel 
3458963106eSGustavo Pimentel 	if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions)
3468963106eSGustavo Pimentel 		return 0;
3478963106eSGustavo Pimentel 
3488963106eSGustavo Pimentel 	if (!epc->ops->get_msix)
3498963106eSGustavo Pimentel 		return 0;
3508963106eSGustavo Pimentel 
3513d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
3528963106eSGustavo Pimentel 	interrupt = epc->ops->get_msix(epc, func_no);
3533d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
3548963106eSGustavo Pimentel 
3558963106eSGustavo Pimentel 	if (interrupt < 0)
3568963106eSGustavo Pimentel 		return 0;
3578963106eSGustavo Pimentel 
3588963106eSGustavo Pimentel 	return interrupt + 1;
3598963106eSGustavo Pimentel }
3608963106eSGustavo Pimentel EXPORT_SYMBOL_GPL(pci_epc_get_msix);
3618963106eSGustavo Pimentel 
3628963106eSGustavo Pimentel /**
3638963106eSGustavo Pimentel  * pci_epc_set_msix() - set the number of MSI-X interrupt numbers required
3648963106eSGustavo Pimentel  * @epc: the EPC device on which MSI-X has to be configured
3658963106eSGustavo Pimentel  * @func_no: the endpoint function number in the EPC device
3668963106eSGustavo Pimentel  * @interrupts: number of MSI-X interrupts required by the EPF
36783153d9fSKishon Vijay Abraham I  * @bir: BAR where the MSI-X table resides
36883153d9fSKishon Vijay Abraham I  * @offset: Offset pointing to the start of MSI-X table
3698963106eSGustavo Pimentel  *
3708963106eSGustavo Pimentel  * Invoke to set the required number of MSI-X interrupts.
3718963106eSGustavo Pimentel  */
37283153d9fSKishon Vijay Abraham I int pci_epc_set_msix(struct pci_epc *epc, u8 func_no, u16 interrupts,
37383153d9fSKishon Vijay Abraham I 		     enum pci_barno bir, u32 offset)
3748963106eSGustavo Pimentel {
3758963106eSGustavo Pimentel 	int ret;
3768963106eSGustavo Pimentel 
3778963106eSGustavo Pimentel 	if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions ||
3788963106eSGustavo Pimentel 	    interrupts < 1 || interrupts > 2048)
3798963106eSGustavo Pimentel 		return -EINVAL;
3808963106eSGustavo Pimentel 
3818963106eSGustavo Pimentel 	if (!epc->ops->set_msix)
3828963106eSGustavo Pimentel 		return 0;
3838963106eSGustavo Pimentel 
3843d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
38583153d9fSKishon Vijay Abraham I 	ret = epc->ops->set_msix(epc, func_no, interrupts - 1, bir, offset);
3863d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
3878963106eSGustavo Pimentel 
3888963106eSGustavo Pimentel 	return ret;
3898963106eSGustavo Pimentel }
3908963106eSGustavo Pimentel EXPORT_SYMBOL_GPL(pci_epc_set_msix);
3918963106eSGustavo Pimentel 
3928963106eSGustavo Pimentel /**
3935e8cb403SKishon Vijay Abraham I  * pci_epc_unmap_addr() - unmap CPU address from PCI address
3945e8cb403SKishon Vijay Abraham I  * @epc: the EPC device on which address is allocated
3954494738dSCyrille Pitchen  * @func_no: the endpoint function number in the EPC device
3965e8cb403SKishon Vijay Abraham I  * @phys_addr: physical address of the local system
3975e8cb403SKishon Vijay Abraham I  *
3985e8cb403SKishon Vijay Abraham I  * Invoke to unmap the CPU address from PCI address.
3995e8cb403SKishon Vijay Abraham I  */
4004494738dSCyrille Pitchen void pci_epc_unmap_addr(struct pci_epc *epc, u8 func_no,
4014494738dSCyrille Pitchen 			phys_addr_t phys_addr)
4025e8cb403SKishon Vijay Abraham I {
4034494738dSCyrille Pitchen 	if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions)
4045e8cb403SKishon Vijay Abraham I 		return;
4055e8cb403SKishon Vijay Abraham I 
4065e8cb403SKishon Vijay Abraham I 	if (!epc->ops->unmap_addr)
4075e8cb403SKishon Vijay Abraham I 		return;
4085e8cb403SKishon Vijay Abraham I 
4093d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
4104494738dSCyrille Pitchen 	epc->ops->unmap_addr(epc, func_no, phys_addr);
4113d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
4125e8cb403SKishon Vijay Abraham I }
4135e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_unmap_addr);
4145e8cb403SKishon Vijay Abraham I 
4155e8cb403SKishon Vijay Abraham I /**
4165e8cb403SKishon Vijay Abraham I  * pci_epc_map_addr() - map CPU address to PCI address
4175e8cb403SKishon Vijay Abraham I  * @epc: the EPC device on which address is allocated
4184494738dSCyrille Pitchen  * @func_no: the endpoint function number in the EPC device
4195e8cb403SKishon Vijay Abraham I  * @phys_addr: physical address of the local system
4205e8cb403SKishon Vijay Abraham I  * @pci_addr: PCI address to which the physical address should be mapped
4215e8cb403SKishon Vijay Abraham I  * @size: the size of the allocation
4225e8cb403SKishon Vijay Abraham I  *
4235e8cb403SKishon Vijay Abraham I  * Invoke to map CPU address with PCI address.
4245e8cb403SKishon Vijay Abraham I  */
4254494738dSCyrille Pitchen int pci_epc_map_addr(struct pci_epc *epc, u8 func_no,
4264494738dSCyrille Pitchen 		     phys_addr_t phys_addr, u64 pci_addr, size_t size)
4275e8cb403SKishon Vijay Abraham I {
4285e8cb403SKishon Vijay Abraham I 	int ret;
4295e8cb403SKishon Vijay Abraham I 
4304494738dSCyrille Pitchen 	if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions)
4315e8cb403SKishon Vijay Abraham I 		return -EINVAL;
4325e8cb403SKishon Vijay Abraham I 
4335e8cb403SKishon Vijay Abraham I 	if (!epc->ops->map_addr)
4345e8cb403SKishon Vijay Abraham I 		return 0;
4355e8cb403SKishon Vijay Abraham I 
4363d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
4374494738dSCyrille Pitchen 	ret = epc->ops->map_addr(epc, func_no, phys_addr, pci_addr, size);
4383d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
4395e8cb403SKishon Vijay Abraham I 
4405e8cb403SKishon Vijay Abraham I 	return ret;
4415e8cb403SKishon Vijay Abraham I }
4425e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_map_addr);
4435e8cb403SKishon Vijay Abraham I 
4445e8cb403SKishon Vijay Abraham I /**
4455e8cb403SKishon Vijay Abraham I  * pci_epc_clear_bar() - reset the BAR
4465e8cb403SKishon Vijay Abraham I  * @epc: the EPC device for which the BAR has to be cleared
4474494738dSCyrille Pitchen  * @func_no: the endpoint function number in the EPC device
44877d08dbdSNiklas Cassel  * @epf_bar: the struct epf_bar that contains the BAR information
4495e8cb403SKishon Vijay Abraham I  *
4505e8cb403SKishon Vijay Abraham I  * Invoke to reset the BAR of the endpoint device.
4515e8cb403SKishon Vijay Abraham I  */
45277d08dbdSNiklas Cassel void pci_epc_clear_bar(struct pci_epc *epc, u8 func_no,
45377d08dbdSNiklas Cassel 		       struct pci_epf_bar *epf_bar)
4545e8cb403SKishon Vijay Abraham I {
4556474a4e5SNiklas Cassel 	if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions ||
4566474a4e5SNiklas Cassel 	    (epf_bar->barno == BAR_5 &&
4576474a4e5SNiklas Cassel 	     epf_bar->flags & PCI_BASE_ADDRESS_MEM_TYPE_64))
4585e8cb403SKishon Vijay Abraham I 		return;
4595e8cb403SKishon Vijay Abraham I 
4605e8cb403SKishon Vijay Abraham I 	if (!epc->ops->clear_bar)
4615e8cb403SKishon Vijay Abraham I 		return;
4625e8cb403SKishon Vijay Abraham I 
4633d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
46477d08dbdSNiklas Cassel 	epc->ops->clear_bar(epc, func_no, epf_bar);
4653d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
4665e8cb403SKishon Vijay Abraham I }
4675e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_clear_bar);
4685e8cb403SKishon Vijay Abraham I 
4695e8cb403SKishon Vijay Abraham I /**
4705e8cb403SKishon Vijay Abraham I  * pci_epc_set_bar() - configure BAR in order for host to assign PCI addr space
4715e8cb403SKishon Vijay Abraham I  * @epc: the EPC device on which BAR has to be configured
4724494738dSCyrille Pitchen  * @func_no: the endpoint function number in the EPC device
473bc4a4897SNiklas Cassel  * @epf_bar: the struct epf_bar that contains the BAR information
4745e8cb403SKishon Vijay Abraham I  *
4755e8cb403SKishon Vijay Abraham I  * Invoke to configure the BAR of the endpoint device.
4765e8cb403SKishon Vijay Abraham I  */
477bc4a4897SNiklas Cassel int pci_epc_set_bar(struct pci_epc *epc, u8 func_no,
478bc4a4897SNiklas Cassel 		    struct pci_epf_bar *epf_bar)
4795e8cb403SKishon Vijay Abraham I {
4805e8cb403SKishon Vijay Abraham I 	int ret;
4813567a4edSNiklas Cassel 	int flags = epf_bar->flags;
4825e8cb403SKishon Vijay Abraham I 
483f16b1f6fSNiklas Cassel 	if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions ||
484f16b1f6fSNiklas Cassel 	    (epf_bar->barno == BAR_5 &&
4853567a4edSNiklas Cassel 	     flags & PCI_BASE_ADDRESS_MEM_TYPE_64) ||
4863567a4edSNiklas Cassel 	    (flags & PCI_BASE_ADDRESS_SPACE_IO &&
487f25b5faeSNiklas Cassel 	     flags & PCI_BASE_ADDRESS_IO_MASK) ||
488f25b5faeSNiklas Cassel 	    (upper_32_bits(epf_bar->size) &&
489f25b5faeSNiklas Cassel 	     !(flags & PCI_BASE_ADDRESS_MEM_TYPE_64)))
4905e8cb403SKishon Vijay Abraham I 		return -EINVAL;
4915e8cb403SKishon Vijay Abraham I 
4925e8cb403SKishon Vijay Abraham I 	if (!epc->ops->set_bar)
4935e8cb403SKishon Vijay Abraham I 		return 0;
4945e8cb403SKishon Vijay Abraham I 
4953d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
496bc4a4897SNiklas Cassel 	ret = epc->ops->set_bar(epc, func_no, epf_bar);
4973d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
4985e8cb403SKishon Vijay Abraham I 
4995e8cb403SKishon Vijay Abraham I 	return ret;
5005e8cb403SKishon Vijay Abraham I }
5015e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_set_bar);
5025e8cb403SKishon Vijay Abraham I 
5035e8cb403SKishon Vijay Abraham I /**
5045e8cb403SKishon Vijay Abraham I  * pci_epc_write_header() - write standard configuration header
5055e8cb403SKishon Vijay Abraham I  * @epc: the EPC device to which the configuration header should be written
5064494738dSCyrille Pitchen  * @func_no: the endpoint function number in the EPC device
5075e8cb403SKishon Vijay Abraham I  * @header: standard configuration header fields
5085e8cb403SKishon Vijay Abraham I  *
5095e8cb403SKishon Vijay Abraham I  * Invoke to write the configuration header to the endpoint controller. Every
5105e8cb403SKishon Vijay Abraham I  * endpoint controller will have a dedicated location to which the standard
5115e8cb403SKishon Vijay Abraham I  * configuration header would be written. The callback function should write
5125e8cb403SKishon Vijay Abraham I  * the header fields to this dedicated location.
5135e8cb403SKishon Vijay Abraham I  */
5144494738dSCyrille Pitchen int pci_epc_write_header(struct pci_epc *epc, u8 func_no,
5154494738dSCyrille Pitchen 			 struct pci_epf_header *header)
5165e8cb403SKishon Vijay Abraham I {
5175e8cb403SKishon Vijay Abraham I 	int ret;
5185e8cb403SKishon Vijay Abraham I 
5194494738dSCyrille Pitchen 	if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions)
5205e8cb403SKishon Vijay Abraham I 		return -EINVAL;
5215e8cb403SKishon Vijay Abraham I 
5225e8cb403SKishon Vijay Abraham I 	if (!epc->ops->write_header)
5235e8cb403SKishon Vijay Abraham I 		return 0;
5245e8cb403SKishon Vijay Abraham I 
5253d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
5264494738dSCyrille Pitchen 	ret = epc->ops->write_header(epc, func_no, header);
5273d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
5285e8cb403SKishon Vijay Abraham I 
5295e8cb403SKishon Vijay Abraham I 	return ret;
5305e8cb403SKishon Vijay Abraham I }
5315e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_write_header);
5325e8cb403SKishon Vijay Abraham I 
5335e8cb403SKishon Vijay Abraham I /**
5345e8cb403SKishon Vijay Abraham I  * pci_epc_add_epf() - bind PCI endpoint function to an endpoint controller
5355e8cb403SKishon Vijay Abraham I  * @epc: the EPC device to which the endpoint function should be added
5365e8cb403SKishon Vijay Abraham I  * @epf: the endpoint function to be added
53763840ff5SKishon Vijay Abraham I  * @type: Identifies if the EPC is connected to the primary or secondary
53863840ff5SKishon Vijay Abraham I  *        interface of EPF
5395e8cb403SKishon Vijay Abraham I  *
5405e8cb403SKishon Vijay Abraham I  * A PCI endpoint device can have one or more functions. In the case of PCIe,
5415e8cb403SKishon Vijay Abraham I  * the specification allows up to 8 PCIe endpoint functions. Invoke
5425e8cb403SKishon Vijay Abraham I  * pci_epc_add_epf() to add a PCI endpoint function to an endpoint controller.
5435e8cb403SKishon Vijay Abraham I  */
54463840ff5SKishon Vijay Abraham I int pci_epc_add_epf(struct pci_epc *epc, struct pci_epf *epf,
54563840ff5SKishon Vijay Abraham I 		    enum pci_epc_interface_type type)
5465e8cb403SKishon Vijay Abraham I {
54763840ff5SKishon Vijay Abraham I 	struct list_head *list;
5482499ee84SKishon Vijay Abraham I 	u32 func_no;
5492499ee84SKishon Vijay Abraham I 	int ret = 0;
5502499ee84SKishon Vijay Abraham I 
551*1cf362e9SKishon Vijay Abraham I 	if (IS_ERR_OR_NULL(epc) || epf->is_vf)
55263840ff5SKishon Vijay Abraham I 		return -EINVAL;
55363840ff5SKishon Vijay Abraham I 
55463840ff5SKishon Vijay Abraham I 	if (type == PRIMARY_INTERFACE && epf->epc)
5555e8cb403SKishon Vijay Abraham I 		return -EBUSY;
5565e8cb403SKishon Vijay Abraham I 
55763840ff5SKishon Vijay Abraham I 	if (type == SECONDARY_INTERFACE && epf->sec_epc)
55863840ff5SKishon Vijay Abraham I 		return -EBUSY;
5595e8cb403SKishon Vijay Abraham I 
5602499ee84SKishon Vijay Abraham I 	mutex_lock(&epc->lock);
5612499ee84SKishon Vijay Abraham I 	func_no = find_first_zero_bit(&epc->function_num_map,
5622499ee84SKishon Vijay Abraham I 				      BITS_PER_LONG);
5632499ee84SKishon Vijay Abraham I 	if (func_no >= BITS_PER_LONG) {
5642499ee84SKishon Vijay Abraham I 		ret = -EINVAL;
5652499ee84SKishon Vijay Abraham I 		goto ret;
5662499ee84SKishon Vijay Abraham I 	}
5675e8cb403SKishon Vijay Abraham I 
5682499ee84SKishon Vijay Abraham I 	if (func_no > epc->max_functions - 1) {
5692499ee84SKishon Vijay Abraham I 		dev_err(&epc->dev, "Exceeding max supported Function Number\n");
5702499ee84SKishon Vijay Abraham I 		ret = -EINVAL;
5712499ee84SKishon Vijay Abraham I 		goto ret;
5722499ee84SKishon Vijay Abraham I 	}
5732499ee84SKishon Vijay Abraham I 
5742499ee84SKishon Vijay Abraham I 	set_bit(func_no, &epc->function_num_map);
57563840ff5SKishon Vijay Abraham I 	if (type == PRIMARY_INTERFACE) {
5762499ee84SKishon Vijay Abraham I 		epf->func_no = func_no;
5775e8cb403SKishon Vijay Abraham I 		epf->epc = epc;
57863840ff5SKishon Vijay Abraham I 		list = &epf->list;
57963840ff5SKishon Vijay Abraham I 	} else {
58063840ff5SKishon Vijay Abraham I 		epf->sec_epc_func_no = func_no;
58163840ff5SKishon Vijay Abraham I 		epf->sec_epc = epc;
58263840ff5SKishon Vijay Abraham I 		list = &epf->sec_epc_list;
58363840ff5SKishon Vijay Abraham I 	}
5845e8cb403SKishon Vijay Abraham I 
58563840ff5SKishon Vijay Abraham I 	list_add_tail(list, &epc->pci_epf);
5862499ee84SKishon Vijay Abraham I ret:
5873d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
5885e8cb403SKishon Vijay Abraham I 
5892499ee84SKishon Vijay Abraham I 	return ret;
5905e8cb403SKishon Vijay Abraham I }
5915e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_add_epf);
5925e8cb403SKishon Vijay Abraham I 
5935e8cb403SKishon Vijay Abraham I /**
5945e8cb403SKishon Vijay Abraham I  * pci_epc_remove_epf() - remove PCI endpoint function from endpoint controller
5955e8cb403SKishon Vijay Abraham I  * @epc: the EPC device from which the endpoint function should be removed
5965e8cb403SKishon Vijay Abraham I  * @epf: the endpoint function to be removed
59743395d9eSKrzysztof Wilczyński  * @type: identifies if the EPC is connected to the primary or secondary
59843395d9eSKrzysztof Wilczyński  *        interface of EPF
5995e8cb403SKishon Vijay Abraham I  *
6005e8cb403SKishon Vijay Abraham I  * Invoke to remove PCI endpoint function from the endpoint controller.
6015e8cb403SKishon Vijay Abraham I  */
60263840ff5SKishon Vijay Abraham I void pci_epc_remove_epf(struct pci_epc *epc, struct pci_epf *epf,
60363840ff5SKishon Vijay Abraham I 			enum pci_epc_interface_type type)
6045e8cb403SKishon Vijay Abraham I {
60563840ff5SKishon Vijay Abraham I 	struct list_head *list;
60663840ff5SKishon Vijay Abraham I 	u32 func_no = 0;
60763840ff5SKishon Vijay Abraham I 
608db7a6248SAlan Mikhak 	if (!epc || IS_ERR(epc) || !epf)
6095e8cb403SKishon Vijay Abraham I 		return;
6105e8cb403SKishon Vijay Abraham I 
61163840ff5SKishon Vijay Abraham I 	if (type == PRIMARY_INTERFACE) {
61263840ff5SKishon Vijay Abraham I 		func_no = epf->func_no;
61363840ff5SKishon Vijay Abraham I 		list = &epf->list;
61463840ff5SKishon Vijay Abraham I 	} else {
61563840ff5SKishon Vijay Abraham I 		func_no = epf->sec_epc_func_no;
61663840ff5SKishon Vijay Abraham I 		list = &epf->sec_epc_list;
61763840ff5SKishon Vijay Abraham I 	}
61863840ff5SKishon Vijay Abraham I 
6193d3248dbSKishon Vijay Abraham I 	mutex_lock(&epc->lock);
62063840ff5SKishon Vijay Abraham I 	clear_bit(func_no, &epc->function_num_map);
62163840ff5SKishon Vijay Abraham I 	list_del(list);
622db7a6248SAlan Mikhak 	epf->epc = NULL;
6233d3248dbSKishon Vijay Abraham I 	mutex_unlock(&epc->lock);
6245e8cb403SKishon Vijay Abraham I }
6255e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_remove_epf);
6265e8cb403SKishon Vijay Abraham I 
6275e8cb403SKishon Vijay Abraham I /**
6285e8cb403SKishon Vijay Abraham I  * pci_epc_linkup() - Notify the EPF device that EPC device has established a
6295e8cb403SKishon Vijay Abraham I  *		      connection with the Root Complex.
6305e8cb403SKishon Vijay Abraham I  * @epc: the EPC device which has established link with the host
6315e8cb403SKishon Vijay Abraham I  *
6325e8cb403SKishon Vijay Abraham I  * Invoke to Notify the EPF device that the EPC device has established a
6335e8cb403SKishon Vijay Abraham I  * connection with the Root Complex.
6345e8cb403SKishon Vijay Abraham I  */
6355e8cb403SKishon Vijay Abraham I void pci_epc_linkup(struct pci_epc *epc)
6365e8cb403SKishon Vijay Abraham I {
6375e8cb403SKishon Vijay Abraham I 	if (!epc || IS_ERR(epc))
6385e8cb403SKishon Vijay Abraham I 		return;
6395e8cb403SKishon Vijay Abraham I 
6400ef22dcfSVidya Sagar 	atomic_notifier_call_chain(&epc->notifier, LINK_UP, NULL);
6415e8cb403SKishon Vijay Abraham I }
6425e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_linkup);
6435e8cb403SKishon Vijay Abraham I 
6445e8cb403SKishon Vijay Abraham I /**
6450ef22dcfSVidya Sagar  * pci_epc_init_notify() - Notify the EPF device that EPC device's core
6460ef22dcfSVidya Sagar  *			   initialization is completed.
6470ef22dcfSVidya Sagar  * @epc: the EPC device whose core initialization is completeds
6480ef22dcfSVidya Sagar  *
6490ef22dcfSVidya Sagar  * Invoke to Notify the EPF device that the EPC device's initialization
6500ef22dcfSVidya Sagar  * is completed.
6510ef22dcfSVidya Sagar  */
6520ef22dcfSVidya Sagar void pci_epc_init_notify(struct pci_epc *epc)
6530ef22dcfSVidya Sagar {
6540ef22dcfSVidya Sagar 	if (!epc || IS_ERR(epc))
6550ef22dcfSVidya Sagar 		return;
6560ef22dcfSVidya Sagar 
6570ef22dcfSVidya Sagar 	atomic_notifier_call_chain(&epc->notifier, CORE_INIT, NULL);
6580ef22dcfSVidya Sagar }
6590ef22dcfSVidya Sagar EXPORT_SYMBOL_GPL(pci_epc_init_notify);
6600ef22dcfSVidya Sagar 
6610ef22dcfSVidya Sagar /**
6625e8cb403SKishon Vijay Abraham I  * pci_epc_destroy() - destroy the EPC device
6635e8cb403SKishon Vijay Abraham I  * @epc: the EPC device that has to be destroyed
6645e8cb403SKishon Vijay Abraham I  *
6655e8cb403SKishon Vijay Abraham I  * Invoke to destroy the PCI EPC device
6665e8cb403SKishon Vijay Abraham I  */
6675e8cb403SKishon Vijay Abraham I void pci_epc_destroy(struct pci_epc *epc)
6685e8cb403SKishon Vijay Abraham I {
6693a401a2cSKishon Vijay Abraham I 	pci_ep_cfs_remove_epc_group(epc->group);
6705e8cb403SKishon Vijay Abraham I 	device_unregister(&epc->dev);
6715e8cb403SKishon Vijay Abraham I 	kfree(epc);
6725e8cb403SKishon Vijay Abraham I }
6735e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_destroy);
6745e8cb403SKishon Vijay Abraham I 
6755e8cb403SKishon Vijay Abraham I /**
6765e8cb403SKishon Vijay Abraham I  * devm_pci_epc_destroy() - destroy the EPC device
6775e8cb403SKishon Vijay Abraham I  * @dev: device that wants to destroy the EPC
6785e8cb403SKishon Vijay Abraham I  * @epc: the EPC device that has to be destroyed
6795e8cb403SKishon Vijay Abraham I  *
6805e8cb403SKishon Vijay Abraham I  * Invoke to destroy the devres associated with this
6815e8cb403SKishon Vijay Abraham I  * pci_epc and destroy the EPC device.
6825e8cb403SKishon Vijay Abraham I  */
6835e8cb403SKishon Vijay Abraham I void devm_pci_epc_destroy(struct device *dev, struct pci_epc *epc)
6845e8cb403SKishon Vijay Abraham I {
6855e8cb403SKishon Vijay Abraham I 	int r;
6865e8cb403SKishon Vijay Abraham I 
6875e8cb403SKishon Vijay Abraham I 	r = devres_destroy(dev, devm_pci_epc_release, devm_pci_epc_match,
6885e8cb403SKishon Vijay Abraham I 			   epc);
6895e8cb403SKishon Vijay Abraham I 	dev_WARN_ONCE(dev, r, "couldn't find PCI EPC resource\n");
6905e8cb403SKishon Vijay Abraham I }
6915e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(devm_pci_epc_destroy);
6925e8cb403SKishon Vijay Abraham I 
6935e8cb403SKishon Vijay Abraham I /**
6945e8cb403SKishon Vijay Abraham I  * __pci_epc_create() - create a new endpoint controller (EPC) device
6955e8cb403SKishon Vijay Abraham I  * @dev: device that is creating the new EPC
6965e8cb403SKishon Vijay Abraham I  * @ops: function pointers for performing EPC operations
6975e8cb403SKishon Vijay Abraham I  * @owner: the owner of the module that creates the EPC device
6985e8cb403SKishon Vijay Abraham I  *
6995e8cb403SKishon Vijay Abraham I  * Invoke to create a new EPC device and add it to pci_epc class.
7005e8cb403SKishon Vijay Abraham I  */
7015e8cb403SKishon Vijay Abraham I struct pci_epc *
7025e8cb403SKishon Vijay Abraham I __pci_epc_create(struct device *dev, const struct pci_epc_ops *ops,
7035e8cb403SKishon Vijay Abraham I 		 struct module *owner)
7045e8cb403SKishon Vijay Abraham I {
7055e8cb403SKishon Vijay Abraham I 	int ret;
7065e8cb403SKishon Vijay Abraham I 	struct pci_epc *epc;
7075e8cb403SKishon Vijay Abraham I 
7085e8cb403SKishon Vijay Abraham I 	if (WARN_ON(!dev)) {
7095e8cb403SKishon Vijay Abraham I 		ret = -EINVAL;
7105e8cb403SKishon Vijay Abraham I 		goto err_ret;
7115e8cb403SKishon Vijay Abraham I 	}
7125e8cb403SKishon Vijay Abraham I 
7135e8cb403SKishon Vijay Abraham I 	epc = kzalloc(sizeof(*epc), GFP_KERNEL);
7145e8cb403SKishon Vijay Abraham I 	if (!epc) {
7155e8cb403SKishon Vijay Abraham I 		ret = -ENOMEM;
7165e8cb403SKishon Vijay Abraham I 		goto err_ret;
7175e8cb403SKishon Vijay Abraham I 	}
7185e8cb403SKishon Vijay Abraham I 
7193d3248dbSKishon Vijay Abraham I 	mutex_init(&epc->lock);
7205e8cb403SKishon Vijay Abraham I 	INIT_LIST_HEAD(&epc->pci_epf);
7215779dd0aSKishon Vijay Abraham I 	ATOMIC_INIT_NOTIFIER_HEAD(&epc->notifier);
7225e8cb403SKishon Vijay Abraham I 
7235e8cb403SKishon Vijay Abraham I 	device_initialize(&epc->dev);
7245e8cb403SKishon Vijay Abraham I 	epc->dev.class = pci_epc_class;
72564c1a02aSKishon Vijay Abraham I 	epc->dev.parent = dev;
7265e8cb403SKishon Vijay Abraham I 	epc->ops = ops;
7275e8cb403SKishon Vijay Abraham I 
7285e8cb403SKishon Vijay Abraham I 	ret = dev_set_name(&epc->dev, "%s", dev_name(dev));
7295e8cb403SKishon Vijay Abraham I 	if (ret)
7305e8cb403SKishon Vijay Abraham I 		goto put_dev;
7315e8cb403SKishon Vijay Abraham I 
7325e8cb403SKishon Vijay Abraham I 	ret = device_add(&epc->dev);
7335e8cb403SKishon Vijay Abraham I 	if (ret)
7345e8cb403SKishon Vijay Abraham I 		goto put_dev;
7355e8cb403SKishon Vijay Abraham I 
7363a401a2cSKishon Vijay Abraham I 	epc->group = pci_ep_cfs_add_epc_group(dev_name(dev));
7373a401a2cSKishon Vijay Abraham I 
7385e8cb403SKishon Vijay Abraham I 	return epc;
7395e8cb403SKishon Vijay Abraham I 
7405e8cb403SKishon Vijay Abraham I put_dev:
7415e8cb403SKishon Vijay Abraham I 	put_device(&epc->dev);
7425e8cb403SKishon Vijay Abraham I 	kfree(epc);
7435e8cb403SKishon Vijay Abraham I 
7445e8cb403SKishon Vijay Abraham I err_ret:
7455e8cb403SKishon Vijay Abraham I 	return ERR_PTR(ret);
7465e8cb403SKishon Vijay Abraham I }
7475e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(__pci_epc_create);
7485e8cb403SKishon Vijay Abraham I 
7495e8cb403SKishon Vijay Abraham I /**
7505e8cb403SKishon Vijay Abraham I  * __devm_pci_epc_create() - create a new endpoint controller (EPC) device
7515e8cb403SKishon Vijay Abraham I  * @dev: device that is creating the new EPC
7525e8cb403SKishon Vijay Abraham I  * @ops: function pointers for performing EPC operations
7535e8cb403SKishon Vijay Abraham I  * @owner: the owner of the module that creates the EPC device
7545e8cb403SKishon Vijay Abraham I  *
7555e8cb403SKishon Vijay Abraham I  * Invoke to create a new EPC device and add it to pci_epc class.
7565e8cb403SKishon Vijay Abraham I  * While at that, it also associates the device with the pci_epc using devres.
7575e8cb403SKishon Vijay Abraham I  * On driver detach, release function is invoked on the devres data,
7585e8cb403SKishon Vijay Abraham I  * then, devres data is freed.
7595e8cb403SKishon Vijay Abraham I  */
7605e8cb403SKishon Vijay Abraham I struct pci_epc *
7615e8cb403SKishon Vijay Abraham I __devm_pci_epc_create(struct device *dev, const struct pci_epc_ops *ops,
7625e8cb403SKishon Vijay Abraham I 		      struct module *owner)
7635e8cb403SKishon Vijay Abraham I {
7645e8cb403SKishon Vijay Abraham I 	struct pci_epc **ptr, *epc;
7655e8cb403SKishon Vijay Abraham I 
7665e8cb403SKishon Vijay Abraham I 	ptr = devres_alloc(devm_pci_epc_release, sizeof(*ptr), GFP_KERNEL);
7675e8cb403SKishon Vijay Abraham I 	if (!ptr)
7685e8cb403SKishon Vijay Abraham I 		return ERR_PTR(-ENOMEM);
7695e8cb403SKishon Vijay Abraham I 
7705e8cb403SKishon Vijay Abraham I 	epc = __pci_epc_create(dev, ops, owner);
7715e8cb403SKishon Vijay Abraham I 	if (!IS_ERR(epc)) {
7725e8cb403SKishon Vijay Abraham I 		*ptr = epc;
7735e8cb403SKishon Vijay Abraham I 		devres_add(dev, ptr);
7745e8cb403SKishon Vijay Abraham I 	} else {
7755e8cb403SKishon Vijay Abraham I 		devres_free(ptr);
7765e8cb403SKishon Vijay Abraham I 	}
7775e8cb403SKishon Vijay Abraham I 
7785e8cb403SKishon Vijay Abraham I 	return epc;
7795e8cb403SKishon Vijay Abraham I }
7805e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(__devm_pci_epc_create);
7815e8cb403SKishon Vijay Abraham I 
7825e8cb403SKishon Vijay Abraham I static int __init pci_epc_init(void)
7835e8cb403SKishon Vijay Abraham I {
7845e8cb403SKishon Vijay Abraham I 	pci_epc_class = class_create(THIS_MODULE, "pci_epc");
7855e8cb403SKishon Vijay Abraham I 	if (IS_ERR(pci_epc_class)) {
7865e8cb403SKishon Vijay Abraham I 		pr_err("failed to create pci epc class --> %ld\n",
7875e8cb403SKishon Vijay Abraham I 		       PTR_ERR(pci_epc_class));
7885e8cb403SKishon Vijay Abraham I 		return PTR_ERR(pci_epc_class);
7895e8cb403SKishon Vijay Abraham I 	}
7905e8cb403SKishon Vijay Abraham I 
7915e8cb403SKishon Vijay Abraham I 	return 0;
7925e8cb403SKishon Vijay Abraham I }
7935e8cb403SKishon Vijay Abraham I module_init(pci_epc_init);
7945e8cb403SKishon Vijay Abraham I 
7955e8cb403SKishon Vijay Abraham I static void __exit pci_epc_exit(void)
7965e8cb403SKishon Vijay Abraham I {
7975e8cb403SKishon Vijay Abraham I 	class_destroy(pci_epc_class);
7985e8cb403SKishon Vijay Abraham I }
7995e8cb403SKishon Vijay Abraham I module_exit(pci_epc_exit);
8005e8cb403SKishon Vijay Abraham I 
8015e8cb403SKishon Vijay Abraham I MODULE_DESCRIPTION("PCI EPC Library");
8025e8cb403SKishon Vijay Abraham I MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
8035e8cb403SKishon Vijay Abraham I MODULE_LICENSE("GPL v2");
804