18cfab3cfSBjorn Helgaas // SPDX-License-Identifier: GPL-2.0 25e8cb403SKishon Vijay Abraham I /** 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/dma-mapping.h> 115e8cb403SKishon Vijay Abraham I #include <linux/slab.h> 125e8cb403SKishon Vijay Abraham I #include <linux/module.h> 1364c1a02aSKishon Vijay Abraham I #include <linux/of_device.h> 145e8cb403SKishon Vijay Abraham I 155e8cb403SKishon Vijay Abraham I #include <linux/pci-epc.h> 165e8cb403SKishon Vijay Abraham I #include <linux/pci-epf.h> 173a401a2cSKishon Vijay Abraham I #include <linux/pci-ep-cfs.h> 185e8cb403SKishon Vijay Abraham I 195e8cb403SKishon Vijay Abraham I static struct class *pci_epc_class; 205e8cb403SKishon Vijay Abraham I 215e8cb403SKishon Vijay Abraham I static void devm_pci_epc_release(struct device *dev, void *res) 225e8cb403SKishon Vijay Abraham I { 235e8cb403SKishon Vijay Abraham I struct pci_epc *epc = *(struct pci_epc **)res; 245e8cb403SKishon Vijay Abraham I 255e8cb403SKishon Vijay Abraham I pci_epc_destroy(epc); 265e8cb403SKishon Vijay Abraham I } 275e8cb403SKishon Vijay Abraham I 285e8cb403SKishon Vijay Abraham I static int devm_pci_epc_match(struct device *dev, void *res, void *match_data) 295e8cb403SKishon Vijay Abraham I { 305e8cb403SKishon Vijay Abraham I struct pci_epc **epc = res; 315e8cb403SKishon Vijay Abraham I 325e8cb403SKishon Vijay Abraham I return *epc == match_data; 335e8cb403SKishon Vijay Abraham I } 345e8cb403SKishon Vijay Abraham I 355e8cb403SKishon Vijay Abraham I /** 365e8cb403SKishon Vijay Abraham I * pci_epc_put() - release the PCI endpoint controller 375e8cb403SKishon Vijay Abraham I * @epc: epc returned by pci_epc_get() 385e8cb403SKishon Vijay Abraham I * 395e8cb403SKishon Vijay Abraham I * release the refcount the caller obtained by invoking pci_epc_get() 405e8cb403SKishon Vijay Abraham I */ 415e8cb403SKishon Vijay Abraham I void pci_epc_put(struct pci_epc *epc) 425e8cb403SKishon Vijay Abraham I { 435e8cb403SKishon Vijay Abraham I if (!epc || IS_ERR(epc)) 445e8cb403SKishon Vijay Abraham I return; 455e8cb403SKishon Vijay Abraham I 465e8cb403SKishon Vijay Abraham I module_put(epc->ops->owner); 475e8cb403SKishon Vijay Abraham I put_device(&epc->dev); 485e8cb403SKishon Vijay Abraham I } 495e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_put); 505e8cb403SKishon Vijay Abraham I 515e8cb403SKishon Vijay Abraham I /** 525e8cb403SKishon Vijay Abraham I * pci_epc_get() - get the PCI endpoint controller 535e8cb403SKishon Vijay Abraham I * @epc_name: device name of the endpoint controller 545e8cb403SKishon Vijay Abraham I * 555e8cb403SKishon Vijay Abraham I * Invoke to get struct pci_epc * corresponding to the device name of the 565e8cb403SKishon Vijay Abraham I * endpoint controller 575e8cb403SKishon Vijay Abraham I */ 585e8cb403SKishon Vijay Abraham I struct pci_epc *pci_epc_get(const char *epc_name) 595e8cb403SKishon Vijay Abraham I { 605e8cb403SKishon Vijay Abraham I int ret = -EINVAL; 615e8cb403SKishon Vijay Abraham I struct pci_epc *epc; 625e8cb403SKishon Vijay Abraham I struct device *dev; 635e8cb403SKishon Vijay Abraham I struct class_dev_iter iter; 645e8cb403SKishon Vijay Abraham I 655e8cb403SKishon Vijay Abraham I class_dev_iter_init(&iter, pci_epc_class, NULL, NULL); 665e8cb403SKishon Vijay Abraham I while ((dev = class_dev_iter_next(&iter))) { 675e8cb403SKishon Vijay Abraham I if (strcmp(epc_name, dev_name(dev))) 685e8cb403SKishon Vijay Abraham I continue; 695e8cb403SKishon Vijay Abraham I 705e8cb403SKishon Vijay Abraham I epc = to_pci_epc(dev); 715e8cb403SKishon Vijay Abraham I if (!try_module_get(epc->ops->owner)) { 725e8cb403SKishon Vijay Abraham I ret = -EINVAL; 735e8cb403SKishon Vijay Abraham I goto err; 745e8cb403SKishon Vijay Abraham I } 755e8cb403SKishon Vijay Abraham I 765e8cb403SKishon Vijay Abraham I class_dev_iter_exit(&iter); 775e8cb403SKishon Vijay Abraham I get_device(&epc->dev); 785e8cb403SKishon Vijay Abraham I return epc; 795e8cb403SKishon Vijay Abraham I } 805e8cb403SKishon Vijay Abraham I 815e8cb403SKishon Vijay Abraham I err: 825e8cb403SKishon Vijay Abraham I class_dev_iter_exit(&iter); 835e8cb403SKishon Vijay Abraham I return ERR_PTR(ret); 845e8cb403SKishon Vijay Abraham I } 855e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_get); 865e8cb403SKishon Vijay Abraham I 875e8cb403SKishon Vijay Abraham I /** 885e8cb403SKishon Vijay Abraham I * pci_epc_stop() - stop the PCI link 895e8cb403SKishon Vijay Abraham I * @epc: the link of the EPC device that has to be stopped 905e8cb403SKishon Vijay Abraham I * 915e8cb403SKishon Vijay Abraham I * Invoke to stop the PCI link 925e8cb403SKishon Vijay Abraham I */ 935e8cb403SKishon Vijay Abraham I void pci_epc_stop(struct pci_epc *epc) 945e8cb403SKishon Vijay Abraham I { 955e8cb403SKishon Vijay Abraham I unsigned long flags; 965e8cb403SKishon Vijay Abraham I 975e8cb403SKishon Vijay Abraham I if (IS_ERR(epc) || !epc->ops->stop) 985e8cb403SKishon Vijay Abraham I return; 995e8cb403SKishon Vijay Abraham I 1005e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 1015e8cb403SKishon Vijay Abraham I epc->ops->stop(epc); 1025e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 1035e8cb403SKishon Vijay Abraham I } 1045e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_stop); 1055e8cb403SKishon Vijay Abraham I 1065e8cb403SKishon Vijay Abraham I /** 1075e8cb403SKishon Vijay Abraham I * pci_epc_start() - start the PCI link 1085e8cb403SKishon Vijay Abraham I * @epc: the link of *this* EPC device has to be started 1095e8cb403SKishon Vijay Abraham I * 1105e8cb403SKishon Vijay Abraham I * Invoke to start the PCI link 1115e8cb403SKishon Vijay Abraham I */ 1125e8cb403SKishon Vijay Abraham I int pci_epc_start(struct pci_epc *epc) 1135e8cb403SKishon Vijay Abraham I { 1145e8cb403SKishon Vijay Abraham I int ret; 1155e8cb403SKishon Vijay Abraham I unsigned long flags; 1165e8cb403SKishon Vijay Abraham I 1175e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 1185e8cb403SKishon Vijay Abraham I return -EINVAL; 1195e8cb403SKishon Vijay Abraham I 1205e8cb403SKishon Vijay Abraham I if (!epc->ops->start) 1215e8cb403SKishon Vijay Abraham I return 0; 1225e8cb403SKishon Vijay Abraham I 1235e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 1245e8cb403SKishon Vijay Abraham I ret = epc->ops->start(epc); 1255e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 1265e8cb403SKishon Vijay Abraham I 1275e8cb403SKishon Vijay Abraham I return ret; 1285e8cb403SKishon Vijay Abraham I } 1295e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_start); 1305e8cb403SKishon Vijay Abraham I 1315e8cb403SKishon Vijay Abraham I /** 1325e8cb403SKishon Vijay Abraham I * pci_epc_raise_irq() - interrupt the host system 1335e8cb403SKishon Vijay Abraham I * @epc: the EPC device which has to interrupt the host 1345e8cb403SKishon Vijay Abraham I * @type: specify the type of interrupt; legacy or MSI 1355e8cb403SKishon Vijay Abraham I * @interrupt_num: the MSI interrupt number 1365e8cb403SKishon Vijay Abraham I * 1375e8cb403SKishon Vijay Abraham I * Invoke to raise an MSI or legacy interrupt 1385e8cb403SKishon Vijay Abraham I */ 1395e8cb403SKishon Vijay Abraham I int pci_epc_raise_irq(struct pci_epc *epc, enum pci_epc_irq_type type, 1405e8cb403SKishon Vijay Abraham I u8 interrupt_num) 1415e8cb403SKishon Vijay Abraham I { 1425e8cb403SKishon Vijay Abraham I int ret; 1435e8cb403SKishon Vijay Abraham I unsigned long flags; 1445e8cb403SKishon Vijay Abraham I 1455e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 1465e8cb403SKishon Vijay Abraham I return -EINVAL; 1475e8cb403SKishon Vijay Abraham I 1485e8cb403SKishon Vijay Abraham I if (!epc->ops->raise_irq) 1495e8cb403SKishon Vijay Abraham I return 0; 1505e8cb403SKishon Vijay Abraham I 1515e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 1525e8cb403SKishon Vijay Abraham I ret = epc->ops->raise_irq(epc, type, interrupt_num); 1535e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 1545e8cb403SKishon Vijay Abraham I 1555e8cb403SKishon Vijay Abraham I return ret; 1565e8cb403SKishon Vijay Abraham I } 1575e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_raise_irq); 1585e8cb403SKishon Vijay Abraham I 1595e8cb403SKishon Vijay Abraham I /** 1605e8cb403SKishon Vijay Abraham I * pci_epc_get_msi() - get the number of MSI interrupt numbers allocated 1615e8cb403SKishon Vijay Abraham I * @epc: the EPC device to which MSI interrupts was requested 1625e8cb403SKishon Vijay Abraham I * 1635e8cb403SKishon Vijay Abraham I * Invoke to get the number of MSI interrupts allocated by the RC 1645e8cb403SKishon Vijay Abraham I */ 1655e8cb403SKishon Vijay Abraham I int pci_epc_get_msi(struct pci_epc *epc) 1665e8cb403SKishon Vijay Abraham I { 1675e8cb403SKishon Vijay Abraham I int interrupt; 1685e8cb403SKishon Vijay Abraham I unsigned long flags; 1695e8cb403SKishon Vijay Abraham I 1705e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 1715e8cb403SKishon Vijay Abraham I return 0; 1725e8cb403SKishon Vijay Abraham I 1735e8cb403SKishon Vijay Abraham I if (!epc->ops->get_msi) 1745e8cb403SKishon Vijay Abraham I return 0; 1755e8cb403SKishon Vijay Abraham I 1765e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 1775e8cb403SKishon Vijay Abraham I interrupt = epc->ops->get_msi(epc); 1785e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 1795e8cb403SKishon Vijay Abraham I 1805e8cb403SKishon Vijay Abraham I if (interrupt < 0) 1815e8cb403SKishon Vijay Abraham I return 0; 1825e8cb403SKishon Vijay Abraham I 1835e8cb403SKishon Vijay Abraham I interrupt = 1 << interrupt; 1845e8cb403SKishon Vijay Abraham I 1855e8cb403SKishon Vijay Abraham I return interrupt; 1865e8cb403SKishon Vijay Abraham I } 1875e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_get_msi); 1885e8cb403SKishon Vijay Abraham I 1895e8cb403SKishon Vijay Abraham I /** 1905e8cb403SKishon Vijay Abraham I * pci_epc_set_msi() - set the number of MSI interrupt numbers required 1915e8cb403SKishon Vijay Abraham I * @epc: the EPC device on which MSI has to be configured 1925e8cb403SKishon Vijay Abraham I * @interrupts: number of MSI interrupts required by the EPF 1935e8cb403SKishon Vijay Abraham I * 1945e8cb403SKishon Vijay Abraham I * Invoke to set the required number of MSI interrupts. 1955e8cb403SKishon Vijay Abraham I */ 1965e8cb403SKishon Vijay Abraham I int pci_epc_set_msi(struct pci_epc *epc, u8 interrupts) 1975e8cb403SKishon Vijay Abraham I { 1985e8cb403SKishon Vijay Abraham I int ret; 1995e8cb403SKishon Vijay Abraham I u8 encode_int; 2005e8cb403SKishon Vijay Abraham I unsigned long flags; 2015e8cb403SKishon Vijay Abraham I 2025e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 2035e8cb403SKishon Vijay Abraham I return -EINVAL; 2045e8cb403SKishon Vijay Abraham I 2055e8cb403SKishon Vijay Abraham I if (!epc->ops->set_msi) 2065e8cb403SKishon Vijay Abraham I return 0; 2075e8cb403SKishon Vijay Abraham I 2085e8cb403SKishon Vijay Abraham I encode_int = order_base_2(interrupts); 2095e8cb403SKishon Vijay Abraham I 2105e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 2115e8cb403SKishon Vijay Abraham I ret = epc->ops->set_msi(epc, encode_int); 2125e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 2135e8cb403SKishon Vijay Abraham I 2145e8cb403SKishon Vijay Abraham I return ret; 2155e8cb403SKishon Vijay Abraham I } 2165e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_set_msi); 2175e8cb403SKishon Vijay Abraham I 2185e8cb403SKishon Vijay Abraham I /** 2195e8cb403SKishon Vijay Abraham I * pci_epc_unmap_addr() - unmap CPU address from PCI address 2205e8cb403SKishon Vijay Abraham I * @epc: the EPC device on which address is allocated 2215e8cb403SKishon Vijay Abraham I * @phys_addr: physical address of the local system 2225e8cb403SKishon Vijay Abraham I * 2235e8cb403SKishon Vijay Abraham I * Invoke to unmap the CPU address from PCI address. 2245e8cb403SKishon Vijay Abraham I */ 2255e8cb403SKishon Vijay Abraham I void pci_epc_unmap_addr(struct pci_epc *epc, phys_addr_t phys_addr) 2265e8cb403SKishon Vijay Abraham I { 2275e8cb403SKishon Vijay Abraham I unsigned long flags; 2285e8cb403SKishon Vijay Abraham I 2295e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 2305e8cb403SKishon Vijay Abraham I return; 2315e8cb403SKishon Vijay Abraham I 2325e8cb403SKishon Vijay Abraham I if (!epc->ops->unmap_addr) 2335e8cb403SKishon Vijay Abraham I return; 2345e8cb403SKishon Vijay Abraham I 2355e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 2365e8cb403SKishon Vijay Abraham I epc->ops->unmap_addr(epc, phys_addr); 2375e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 2385e8cb403SKishon Vijay Abraham I } 2395e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_unmap_addr); 2405e8cb403SKishon Vijay Abraham I 2415e8cb403SKishon Vijay Abraham I /** 2425e8cb403SKishon Vijay Abraham I * pci_epc_map_addr() - map CPU address to PCI address 2435e8cb403SKishon Vijay Abraham I * @epc: the EPC device on which address is allocated 2445e8cb403SKishon Vijay Abraham I * @phys_addr: physical address of the local system 2455e8cb403SKishon Vijay Abraham I * @pci_addr: PCI address to which the physical address should be mapped 2465e8cb403SKishon Vijay Abraham I * @size: the size of the allocation 2475e8cb403SKishon Vijay Abraham I * 2485e8cb403SKishon Vijay Abraham I * Invoke to map CPU address with PCI address. 2495e8cb403SKishon Vijay Abraham I */ 2505e8cb403SKishon Vijay Abraham I int pci_epc_map_addr(struct pci_epc *epc, phys_addr_t phys_addr, 2515e8cb403SKishon Vijay Abraham I u64 pci_addr, size_t size) 2525e8cb403SKishon Vijay Abraham I { 2535e8cb403SKishon Vijay Abraham I int ret; 2545e8cb403SKishon Vijay Abraham I unsigned long flags; 2555e8cb403SKishon Vijay Abraham I 2565e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 2575e8cb403SKishon Vijay Abraham I return -EINVAL; 2585e8cb403SKishon Vijay Abraham I 2595e8cb403SKishon Vijay Abraham I if (!epc->ops->map_addr) 2605e8cb403SKishon Vijay Abraham I return 0; 2615e8cb403SKishon Vijay Abraham I 2625e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 2635e8cb403SKishon Vijay Abraham I ret = epc->ops->map_addr(epc, phys_addr, pci_addr, size); 2645e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 2655e8cb403SKishon Vijay Abraham I 2665e8cb403SKishon Vijay Abraham I return ret; 2675e8cb403SKishon Vijay Abraham I } 2685e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_map_addr); 2695e8cb403SKishon Vijay Abraham I 2705e8cb403SKishon Vijay Abraham I /** 2715e8cb403SKishon Vijay Abraham I * pci_epc_clear_bar() - reset the BAR 2725e8cb403SKishon Vijay Abraham I * @epc: the EPC device for which the BAR has to be cleared 2735e8cb403SKishon Vijay Abraham I * @bar: the BAR number that has to be reset 2745e8cb403SKishon Vijay Abraham I * 2755e8cb403SKishon Vijay Abraham I * Invoke to reset the BAR of the endpoint device. 2765e8cb403SKishon Vijay Abraham I */ 2775e8cb403SKishon Vijay Abraham I void pci_epc_clear_bar(struct pci_epc *epc, int bar) 2785e8cb403SKishon Vijay Abraham I { 2795e8cb403SKishon Vijay Abraham I unsigned long flags; 2805e8cb403SKishon Vijay Abraham I 2815e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 2825e8cb403SKishon Vijay Abraham I return; 2835e8cb403SKishon Vijay Abraham I 2845e8cb403SKishon Vijay Abraham I if (!epc->ops->clear_bar) 2855e8cb403SKishon Vijay Abraham I return; 2865e8cb403SKishon Vijay Abraham I 2875e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 2885e8cb403SKishon Vijay Abraham I epc->ops->clear_bar(epc, bar); 2895e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 2905e8cb403SKishon Vijay Abraham I } 2915e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_clear_bar); 2925e8cb403SKishon Vijay Abraham I 2935e8cb403SKishon Vijay Abraham I /** 2945e8cb403SKishon Vijay Abraham I * pci_epc_set_bar() - configure BAR in order for host to assign PCI addr space 2955e8cb403SKishon Vijay Abraham I * @epc: the EPC device on which BAR has to be configured 2965e8cb403SKishon Vijay Abraham I * @bar: the BAR number that has to be configured 2975e8cb403SKishon Vijay Abraham I * @size: the size of the addr space 2985e8cb403SKishon Vijay Abraham I * @flags: specify memory allocation/io allocation/32bit address/64 bit address 2995e8cb403SKishon Vijay Abraham I * 3005e8cb403SKishon Vijay Abraham I * Invoke to configure the BAR of the endpoint device. 3015e8cb403SKishon Vijay Abraham I */ 3025e8cb403SKishon Vijay Abraham I int pci_epc_set_bar(struct pci_epc *epc, enum pci_barno bar, 3035e8cb403SKishon Vijay Abraham I dma_addr_t bar_phys, size_t size, int flags) 3045e8cb403SKishon Vijay Abraham I { 3055e8cb403SKishon Vijay Abraham I int ret; 3065e8cb403SKishon Vijay Abraham I unsigned long irq_flags; 3075e8cb403SKishon Vijay Abraham I 3085e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 3095e8cb403SKishon Vijay Abraham I return -EINVAL; 3105e8cb403SKishon Vijay Abraham I 3115e8cb403SKishon Vijay Abraham I if (!epc->ops->set_bar) 3125e8cb403SKishon Vijay Abraham I return 0; 3135e8cb403SKishon Vijay Abraham I 3145e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, irq_flags); 3155e8cb403SKishon Vijay Abraham I ret = epc->ops->set_bar(epc, bar, bar_phys, size, flags); 3165e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, irq_flags); 3175e8cb403SKishon Vijay Abraham I 3185e8cb403SKishon Vijay Abraham I return ret; 3195e8cb403SKishon Vijay Abraham I } 3205e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_set_bar); 3215e8cb403SKishon Vijay Abraham I 3225e8cb403SKishon Vijay Abraham I /** 3235e8cb403SKishon Vijay Abraham I * pci_epc_write_header() - write standard configuration header 3245e8cb403SKishon Vijay Abraham I * @epc: the EPC device to which the configuration header should be written 3255e8cb403SKishon Vijay Abraham I * @header: standard configuration header fields 3265e8cb403SKishon Vijay Abraham I * 3275e8cb403SKishon Vijay Abraham I * Invoke to write the configuration header to the endpoint controller. Every 3285e8cb403SKishon Vijay Abraham I * endpoint controller will have a dedicated location to which the standard 3295e8cb403SKishon Vijay Abraham I * configuration header would be written. The callback function should write 3305e8cb403SKishon Vijay Abraham I * the header fields to this dedicated location. 3315e8cb403SKishon Vijay Abraham I */ 3325e8cb403SKishon Vijay Abraham I int pci_epc_write_header(struct pci_epc *epc, struct pci_epf_header *header) 3335e8cb403SKishon Vijay Abraham I { 3345e8cb403SKishon Vijay Abraham I int ret; 3355e8cb403SKishon Vijay Abraham I unsigned long flags; 3365e8cb403SKishon Vijay Abraham I 3375e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 3385e8cb403SKishon Vijay Abraham I return -EINVAL; 3395e8cb403SKishon Vijay Abraham I 3405e8cb403SKishon Vijay Abraham I if (!epc->ops->write_header) 3415e8cb403SKishon Vijay Abraham I return 0; 3425e8cb403SKishon Vijay Abraham I 3435e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 3445e8cb403SKishon Vijay Abraham I ret = epc->ops->write_header(epc, header); 3455e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 3465e8cb403SKishon Vijay Abraham I 3475e8cb403SKishon Vijay Abraham I return ret; 3485e8cb403SKishon Vijay Abraham I } 3495e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_write_header); 3505e8cb403SKishon Vijay Abraham I 3515e8cb403SKishon Vijay Abraham I /** 3525e8cb403SKishon Vijay Abraham I * pci_epc_add_epf() - bind PCI endpoint function to an endpoint controller 3535e8cb403SKishon Vijay Abraham I * @epc: the EPC device to which the endpoint function should be added 3545e8cb403SKishon Vijay Abraham I * @epf: the endpoint function to be added 3555e8cb403SKishon Vijay Abraham I * 3565e8cb403SKishon Vijay Abraham I * A PCI endpoint device can have one or more functions. In the case of PCIe, 3575e8cb403SKishon Vijay Abraham I * the specification allows up to 8 PCIe endpoint functions. Invoke 3585e8cb403SKishon Vijay Abraham I * pci_epc_add_epf() to add a PCI endpoint function to an endpoint controller. 3595e8cb403SKishon Vijay Abraham I */ 3605e8cb403SKishon Vijay Abraham I int pci_epc_add_epf(struct pci_epc *epc, struct pci_epf *epf) 3615e8cb403SKishon Vijay Abraham I { 3625e8cb403SKishon Vijay Abraham I unsigned long flags; 36364c1a02aSKishon Vijay Abraham I struct device *dev = epc->dev.parent; 3645e8cb403SKishon Vijay Abraham I 3655e8cb403SKishon Vijay Abraham I if (epf->epc) 3665e8cb403SKishon Vijay Abraham I return -EBUSY; 3675e8cb403SKishon Vijay Abraham I 3685e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 3695e8cb403SKishon Vijay Abraham I return -EINVAL; 3705e8cb403SKishon Vijay Abraham I 3715e8cb403SKishon Vijay Abraham I if (epf->func_no > epc->max_functions - 1) 3725e8cb403SKishon Vijay Abraham I return -EINVAL; 3735e8cb403SKishon Vijay Abraham I 3745e8cb403SKishon Vijay Abraham I epf->epc = epc; 37564c1a02aSKishon Vijay Abraham I if (dev->of_node) { 37664c1a02aSKishon Vijay Abraham I of_dma_configure(&epf->dev, dev->of_node); 37764c1a02aSKishon Vijay Abraham I } else { 3785e8cb403SKishon Vijay Abraham I dma_set_coherent_mask(&epf->dev, epc->dev.coherent_dma_mask); 3795e8cb403SKishon Vijay Abraham I epf->dev.dma_mask = epc->dev.dma_mask; 38064c1a02aSKishon Vijay Abraham I } 3815e8cb403SKishon Vijay Abraham I 3825e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 3835e8cb403SKishon Vijay Abraham I list_add_tail(&epf->list, &epc->pci_epf); 3845e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 3855e8cb403SKishon Vijay Abraham I 3865e8cb403SKishon Vijay Abraham I return 0; 3875e8cb403SKishon Vijay Abraham I } 3885e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_add_epf); 3895e8cb403SKishon Vijay Abraham I 3905e8cb403SKishon Vijay Abraham I /** 3915e8cb403SKishon Vijay Abraham I * pci_epc_remove_epf() - remove PCI endpoint function from endpoint controller 3925e8cb403SKishon Vijay Abraham I * @epc: the EPC device from which the endpoint function should be removed 3935e8cb403SKishon Vijay Abraham I * @epf: the endpoint function to be removed 3945e8cb403SKishon Vijay Abraham I * 3955e8cb403SKishon Vijay Abraham I * Invoke to remove PCI endpoint function from the endpoint controller. 3965e8cb403SKishon Vijay Abraham I */ 3975e8cb403SKishon Vijay Abraham I void pci_epc_remove_epf(struct pci_epc *epc, struct pci_epf *epf) 3985e8cb403SKishon Vijay Abraham I { 3995e8cb403SKishon Vijay Abraham I unsigned long flags; 4005e8cb403SKishon Vijay Abraham I 4015e8cb403SKishon Vijay Abraham I if (!epc || IS_ERR(epc)) 4025e8cb403SKishon Vijay Abraham I return; 4035e8cb403SKishon Vijay Abraham I 4045e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 4055e8cb403SKishon Vijay Abraham I list_del(&epf->list); 4065e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 4075e8cb403SKishon Vijay Abraham I } 4085e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_remove_epf); 4095e8cb403SKishon Vijay Abraham I 4105e8cb403SKishon Vijay Abraham I /** 4115e8cb403SKishon Vijay Abraham I * pci_epc_linkup() - Notify the EPF device that EPC device has established a 4125e8cb403SKishon Vijay Abraham I * connection with the Root Complex. 4135e8cb403SKishon Vijay Abraham I * @epc: the EPC device which has established link with the host 4145e8cb403SKishon Vijay Abraham I * 4155e8cb403SKishon Vijay Abraham I * Invoke to Notify the EPF device that the EPC device has established a 4165e8cb403SKishon Vijay Abraham I * connection with the Root Complex. 4175e8cb403SKishon Vijay Abraham I */ 4185e8cb403SKishon Vijay Abraham I void pci_epc_linkup(struct pci_epc *epc) 4195e8cb403SKishon Vijay Abraham I { 4205e8cb403SKishon Vijay Abraham I unsigned long flags; 4215e8cb403SKishon Vijay Abraham I struct pci_epf *epf; 4225e8cb403SKishon Vijay Abraham I 4235e8cb403SKishon Vijay Abraham I if (!epc || IS_ERR(epc)) 4245e8cb403SKishon Vijay Abraham I return; 4255e8cb403SKishon Vijay Abraham I 4265e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 4275e8cb403SKishon Vijay Abraham I list_for_each_entry(epf, &epc->pci_epf, list) 4285e8cb403SKishon Vijay Abraham I pci_epf_linkup(epf); 4295e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 4305e8cb403SKishon Vijay Abraham I } 4315e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_linkup); 4325e8cb403SKishon Vijay Abraham I 4335e8cb403SKishon Vijay Abraham I /** 4345e8cb403SKishon Vijay Abraham I * pci_epc_destroy() - destroy the EPC device 4355e8cb403SKishon Vijay Abraham I * @epc: the EPC device that has to be destroyed 4365e8cb403SKishon Vijay Abraham I * 4375e8cb403SKishon Vijay Abraham I * Invoke to destroy the PCI EPC device 4385e8cb403SKishon Vijay Abraham I */ 4395e8cb403SKishon Vijay Abraham I void pci_epc_destroy(struct pci_epc *epc) 4405e8cb403SKishon Vijay Abraham I { 4413a401a2cSKishon Vijay Abraham I pci_ep_cfs_remove_epc_group(epc->group); 4425e8cb403SKishon Vijay Abraham I device_unregister(&epc->dev); 4435e8cb403SKishon Vijay Abraham I kfree(epc); 4445e8cb403SKishon Vijay Abraham I } 4455e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_destroy); 4465e8cb403SKishon Vijay Abraham I 4475e8cb403SKishon Vijay Abraham I /** 4485e8cb403SKishon Vijay Abraham I * devm_pci_epc_destroy() - destroy the EPC device 4495e8cb403SKishon Vijay Abraham I * @dev: device that wants to destroy the EPC 4505e8cb403SKishon Vijay Abraham I * @epc: the EPC device that has to be destroyed 4515e8cb403SKishon Vijay Abraham I * 4525e8cb403SKishon Vijay Abraham I * Invoke to destroy the devres associated with this 4535e8cb403SKishon Vijay Abraham I * pci_epc and destroy the EPC device. 4545e8cb403SKishon Vijay Abraham I */ 4555e8cb403SKishon Vijay Abraham I void devm_pci_epc_destroy(struct device *dev, struct pci_epc *epc) 4565e8cb403SKishon Vijay Abraham I { 4575e8cb403SKishon Vijay Abraham I int r; 4585e8cb403SKishon Vijay Abraham I 4595e8cb403SKishon Vijay Abraham I r = devres_destroy(dev, devm_pci_epc_release, devm_pci_epc_match, 4605e8cb403SKishon Vijay Abraham I epc); 4615e8cb403SKishon Vijay Abraham I dev_WARN_ONCE(dev, r, "couldn't find PCI EPC resource\n"); 4625e8cb403SKishon Vijay Abraham I } 4635e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(devm_pci_epc_destroy); 4645e8cb403SKishon Vijay Abraham I 4655e8cb403SKishon Vijay Abraham I /** 4665e8cb403SKishon Vijay Abraham I * __pci_epc_create() - create a new endpoint controller (EPC) device 4675e8cb403SKishon Vijay Abraham I * @dev: device that is creating the new EPC 4685e8cb403SKishon Vijay Abraham I * @ops: function pointers for performing EPC operations 4695e8cb403SKishon Vijay Abraham I * @owner: the owner of the module that creates the EPC device 4705e8cb403SKishon Vijay Abraham I * 4715e8cb403SKishon Vijay Abraham I * Invoke to create a new EPC device and add it to pci_epc class. 4725e8cb403SKishon Vijay Abraham I */ 4735e8cb403SKishon Vijay Abraham I struct pci_epc * 4745e8cb403SKishon Vijay Abraham I __pci_epc_create(struct device *dev, const struct pci_epc_ops *ops, 4755e8cb403SKishon Vijay Abraham I struct module *owner) 4765e8cb403SKishon Vijay Abraham I { 4775e8cb403SKishon Vijay Abraham I int ret; 4785e8cb403SKishon Vijay Abraham I struct pci_epc *epc; 4795e8cb403SKishon Vijay Abraham I 4805e8cb403SKishon Vijay Abraham I if (WARN_ON(!dev)) { 4815e8cb403SKishon Vijay Abraham I ret = -EINVAL; 4825e8cb403SKishon Vijay Abraham I goto err_ret; 4835e8cb403SKishon Vijay Abraham I } 4845e8cb403SKishon Vijay Abraham I 4855e8cb403SKishon Vijay Abraham I epc = kzalloc(sizeof(*epc), GFP_KERNEL); 4865e8cb403SKishon Vijay Abraham I if (!epc) { 4875e8cb403SKishon Vijay Abraham I ret = -ENOMEM; 4885e8cb403SKishon Vijay Abraham I goto err_ret; 4895e8cb403SKishon Vijay Abraham I } 4905e8cb403SKishon Vijay Abraham I 4915e8cb403SKishon Vijay Abraham I spin_lock_init(&epc->lock); 4925e8cb403SKishon Vijay Abraham I INIT_LIST_HEAD(&epc->pci_epf); 4935e8cb403SKishon Vijay Abraham I 4945e8cb403SKishon Vijay Abraham I device_initialize(&epc->dev); 4955e8cb403SKishon Vijay Abraham I dma_set_coherent_mask(&epc->dev, dev->coherent_dma_mask); 4965e8cb403SKishon Vijay Abraham I epc->dev.class = pci_epc_class; 4975e8cb403SKishon Vijay Abraham I epc->dev.dma_mask = dev->dma_mask; 49864c1a02aSKishon Vijay Abraham I epc->dev.parent = dev; 4995e8cb403SKishon Vijay Abraham I epc->ops = ops; 5005e8cb403SKishon Vijay Abraham I 5015e8cb403SKishon Vijay Abraham I ret = dev_set_name(&epc->dev, "%s", dev_name(dev)); 5025e8cb403SKishon Vijay Abraham I if (ret) 5035e8cb403SKishon Vijay Abraham I goto put_dev; 5045e8cb403SKishon Vijay Abraham I 5055e8cb403SKishon Vijay Abraham I ret = device_add(&epc->dev); 5065e8cb403SKishon Vijay Abraham I if (ret) 5075e8cb403SKishon Vijay Abraham I goto put_dev; 5085e8cb403SKishon Vijay Abraham I 5093a401a2cSKishon Vijay Abraham I epc->group = pci_ep_cfs_add_epc_group(dev_name(dev)); 5103a401a2cSKishon Vijay Abraham I 5115e8cb403SKishon Vijay Abraham I return epc; 5125e8cb403SKishon Vijay Abraham I 5135e8cb403SKishon Vijay Abraham I put_dev: 5145e8cb403SKishon Vijay Abraham I put_device(&epc->dev); 5155e8cb403SKishon Vijay Abraham I kfree(epc); 5165e8cb403SKishon Vijay Abraham I 5175e8cb403SKishon Vijay Abraham I err_ret: 5185e8cb403SKishon Vijay Abraham I return ERR_PTR(ret); 5195e8cb403SKishon Vijay Abraham I } 5205e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(__pci_epc_create); 5215e8cb403SKishon Vijay Abraham I 5225e8cb403SKishon Vijay Abraham I /** 5235e8cb403SKishon Vijay Abraham I * __devm_pci_epc_create() - create a new endpoint controller (EPC) device 5245e8cb403SKishon Vijay Abraham I * @dev: device that is creating the new EPC 5255e8cb403SKishon Vijay Abraham I * @ops: function pointers for performing EPC operations 5265e8cb403SKishon Vijay Abraham I * @owner: the owner of the module that creates the EPC device 5275e8cb403SKishon Vijay Abraham I * 5285e8cb403SKishon Vijay Abraham I * Invoke to create a new EPC device and add it to pci_epc class. 5295e8cb403SKishon Vijay Abraham I * While at that, it also associates the device with the pci_epc using devres. 5305e8cb403SKishon Vijay Abraham I * On driver detach, release function is invoked on the devres data, 5315e8cb403SKishon Vijay Abraham I * then, devres data is freed. 5325e8cb403SKishon Vijay Abraham I */ 5335e8cb403SKishon Vijay Abraham I struct pci_epc * 5345e8cb403SKishon Vijay Abraham I __devm_pci_epc_create(struct device *dev, const struct pci_epc_ops *ops, 5355e8cb403SKishon Vijay Abraham I struct module *owner) 5365e8cb403SKishon Vijay Abraham I { 5375e8cb403SKishon Vijay Abraham I struct pci_epc **ptr, *epc; 5385e8cb403SKishon Vijay Abraham I 5395e8cb403SKishon Vijay Abraham I ptr = devres_alloc(devm_pci_epc_release, sizeof(*ptr), GFP_KERNEL); 5405e8cb403SKishon Vijay Abraham I if (!ptr) 5415e8cb403SKishon Vijay Abraham I return ERR_PTR(-ENOMEM); 5425e8cb403SKishon Vijay Abraham I 5435e8cb403SKishon Vijay Abraham I epc = __pci_epc_create(dev, ops, owner); 5445e8cb403SKishon Vijay Abraham I if (!IS_ERR(epc)) { 5455e8cb403SKishon Vijay Abraham I *ptr = epc; 5465e8cb403SKishon Vijay Abraham I devres_add(dev, ptr); 5475e8cb403SKishon Vijay Abraham I } else { 5485e8cb403SKishon Vijay Abraham I devres_free(ptr); 5495e8cb403SKishon Vijay Abraham I } 5505e8cb403SKishon Vijay Abraham I 5515e8cb403SKishon Vijay Abraham I return epc; 5525e8cb403SKishon Vijay Abraham I } 5535e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(__devm_pci_epc_create); 5545e8cb403SKishon Vijay Abraham I 5555e8cb403SKishon Vijay Abraham I static int __init pci_epc_init(void) 5565e8cb403SKishon Vijay Abraham I { 5575e8cb403SKishon Vijay Abraham I pci_epc_class = class_create(THIS_MODULE, "pci_epc"); 5585e8cb403SKishon Vijay Abraham I if (IS_ERR(pci_epc_class)) { 5595e8cb403SKishon Vijay Abraham I pr_err("failed to create pci epc class --> %ld\n", 5605e8cb403SKishon Vijay Abraham I PTR_ERR(pci_epc_class)); 5615e8cb403SKishon Vijay Abraham I return PTR_ERR(pci_epc_class); 5625e8cb403SKishon Vijay Abraham I } 5635e8cb403SKishon Vijay Abraham I 5645e8cb403SKishon Vijay Abraham I return 0; 5655e8cb403SKishon Vijay Abraham I } 5665e8cb403SKishon Vijay Abraham I module_init(pci_epc_init); 5675e8cb403SKishon Vijay Abraham I 5685e8cb403SKishon Vijay Abraham I static void __exit pci_epc_exit(void) 5695e8cb403SKishon Vijay Abraham I { 5705e8cb403SKishon Vijay Abraham I class_destroy(pci_epc_class); 5715e8cb403SKishon Vijay Abraham I } 5725e8cb403SKishon Vijay Abraham I module_exit(pci_epc_exit); 5735e8cb403SKishon Vijay Abraham I 5745e8cb403SKishon Vijay Abraham I MODULE_DESCRIPTION("PCI EPC Library"); 5755e8cb403SKishon Vijay Abraham I MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>"); 5765e8cb403SKishon Vijay Abraham I MODULE_LICENSE("GPL v2"); 577