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/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 /** 875e8cb403SKishon Vijay Abraham I * pci_epc_stop() - stop the PCI link 885e8cb403SKishon Vijay Abraham I * @epc: the link of the EPC device that has to be stopped 895e8cb403SKishon Vijay Abraham I * 905e8cb403SKishon Vijay Abraham I * Invoke to stop the PCI link 915e8cb403SKishon Vijay Abraham I */ 925e8cb403SKishon Vijay Abraham I void pci_epc_stop(struct pci_epc *epc) 935e8cb403SKishon Vijay Abraham I { 945e8cb403SKishon Vijay Abraham I unsigned long flags; 955e8cb403SKishon Vijay Abraham I 965e8cb403SKishon Vijay Abraham I if (IS_ERR(epc) || !epc->ops->stop) 975e8cb403SKishon Vijay Abraham I return; 985e8cb403SKishon Vijay Abraham I 995e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 1005e8cb403SKishon Vijay Abraham I epc->ops->stop(epc); 1015e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 1025e8cb403SKishon Vijay Abraham I } 1035e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_stop); 1045e8cb403SKishon Vijay Abraham I 1055e8cb403SKishon Vijay Abraham I /** 1065e8cb403SKishon Vijay Abraham I * pci_epc_start() - start the PCI link 1075e8cb403SKishon Vijay Abraham I * @epc: the link of *this* EPC device has to be started 1085e8cb403SKishon Vijay Abraham I * 1095e8cb403SKishon Vijay Abraham I * Invoke to start the PCI link 1105e8cb403SKishon Vijay Abraham I */ 1115e8cb403SKishon Vijay Abraham I int pci_epc_start(struct pci_epc *epc) 1125e8cb403SKishon Vijay Abraham I { 1135e8cb403SKishon Vijay Abraham I int ret; 1145e8cb403SKishon Vijay Abraham I unsigned long flags; 1155e8cb403SKishon Vijay Abraham I 1165e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 1175e8cb403SKishon Vijay Abraham I return -EINVAL; 1185e8cb403SKishon Vijay Abraham I 1195e8cb403SKishon Vijay Abraham I if (!epc->ops->start) 1205e8cb403SKishon Vijay Abraham I return 0; 1215e8cb403SKishon Vijay Abraham I 1225e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 1235e8cb403SKishon Vijay Abraham I ret = epc->ops->start(epc); 1245e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 1255e8cb403SKishon Vijay Abraham I 1265e8cb403SKishon Vijay Abraham I return ret; 1275e8cb403SKishon Vijay Abraham I } 1285e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_start); 1295e8cb403SKishon Vijay Abraham I 1305e8cb403SKishon Vijay Abraham I /** 1315e8cb403SKishon Vijay Abraham I * pci_epc_raise_irq() - interrupt the host system 1325e8cb403SKishon Vijay Abraham I * @epc: the EPC device which has to interrupt the host 1334494738dSCyrille Pitchen * @func_no: the endpoint function number in the EPC device 134d3c70a98SGustavo Pimentel * @type: specify the type of interrupt; legacy, MSI or MSI-X 135d3c70a98SGustavo Pimentel * @interrupt_num: the MSI or MSI-X interrupt number 1365e8cb403SKishon Vijay Abraham I * 137d3c70a98SGustavo Pimentel * Invoke to raise an legacy, MSI or MSI-X interrupt 1385e8cb403SKishon Vijay Abraham I */ 1394494738dSCyrille Pitchen int pci_epc_raise_irq(struct pci_epc *epc, u8 func_no, 140d3c70a98SGustavo Pimentel enum pci_epc_irq_type type, u16 interrupt_num) 1415e8cb403SKishon Vijay Abraham I { 1425e8cb403SKishon Vijay Abraham I int ret; 1435e8cb403SKishon Vijay Abraham I unsigned long flags; 1445e8cb403SKishon Vijay Abraham I 1454494738dSCyrille Pitchen if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions) 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); 1524494738dSCyrille Pitchen ret = epc->ops->raise_irq(epc, func_no, 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 1624494738dSCyrille Pitchen * @func_no: the endpoint function number in the EPC device 1635e8cb403SKishon Vijay Abraham I * 1645e8cb403SKishon Vijay Abraham I * Invoke to get the number of MSI interrupts allocated by the RC 1655e8cb403SKishon Vijay Abraham I */ 1664494738dSCyrille Pitchen int pci_epc_get_msi(struct pci_epc *epc, u8 func_no) 1675e8cb403SKishon Vijay Abraham I { 1685e8cb403SKishon Vijay Abraham I int interrupt; 1695e8cb403SKishon Vijay Abraham I unsigned long flags; 1705e8cb403SKishon Vijay Abraham I 1714494738dSCyrille Pitchen if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions) 1725e8cb403SKishon Vijay Abraham I return 0; 1735e8cb403SKishon Vijay Abraham I 1745e8cb403SKishon Vijay Abraham I if (!epc->ops->get_msi) 1755e8cb403SKishon Vijay Abraham I return 0; 1765e8cb403SKishon Vijay Abraham I 1775e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 1784494738dSCyrille Pitchen interrupt = epc->ops->get_msi(epc, func_no); 1795e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 1805e8cb403SKishon Vijay Abraham I 1815e8cb403SKishon Vijay Abraham I if (interrupt < 0) 1825e8cb403SKishon Vijay Abraham I return 0; 1835e8cb403SKishon Vijay Abraham I 1845e8cb403SKishon Vijay Abraham I interrupt = 1 << interrupt; 1855e8cb403SKishon Vijay Abraham I 1865e8cb403SKishon Vijay Abraham I return interrupt; 1875e8cb403SKishon Vijay Abraham I } 1885e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_get_msi); 1895e8cb403SKishon Vijay Abraham I 1905e8cb403SKishon Vijay Abraham I /** 1915e8cb403SKishon Vijay Abraham I * pci_epc_set_msi() - set the number of MSI interrupt numbers required 1925e8cb403SKishon Vijay Abraham I * @epc: the EPC device on which MSI has to be configured 1934494738dSCyrille Pitchen * @func_no: the endpoint function number in the EPC device 1945e8cb403SKishon Vijay Abraham I * @interrupts: number of MSI interrupts required by the EPF 1955e8cb403SKishon Vijay Abraham I * 1965e8cb403SKishon Vijay Abraham I * Invoke to set the required number of MSI interrupts. 1975e8cb403SKishon Vijay Abraham I */ 1984494738dSCyrille Pitchen int pci_epc_set_msi(struct pci_epc *epc, u8 func_no, u8 interrupts) 1995e8cb403SKishon Vijay Abraham I { 2005e8cb403SKishon Vijay Abraham I int ret; 2015e8cb403SKishon Vijay Abraham I u8 encode_int; 2025e8cb403SKishon Vijay Abraham I unsigned long flags; 2035e8cb403SKishon Vijay Abraham I 2044494738dSCyrille Pitchen if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions) 2055e8cb403SKishon Vijay Abraham I return -EINVAL; 2065e8cb403SKishon Vijay Abraham I 2075e8cb403SKishon Vijay Abraham I if (!epc->ops->set_msi) 2085e8cb403SKishon Vijay Abraham I return 0; 2095e8cb403SKishon Vijay Abraham I 2105e8cb403SKishon Vijay Abraham I encode_int = order_base_2(interrupts); 2115e8cb403SKishon Vijay Abraham I 2125e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 2134494738dSCyrille Pitchen ret = epc->ops->set_msi(epc, func_no, encode_int); 2145e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 2155e8cb403SKishon Vijay Abraham I 2165e8cb403SKishon Vijay Abraham I return ret; 2175e8cb403SKishon Vijay Abraham I } 2185e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_set_msi); 2195e8cb403SKishon Vijay Abraham I 2205e8cb403SKishon Vijay Abraham I /** 2218963106eSGustavo Pimentel * pci_epc_get_msix() - get the number of MSI-X interrupt numbers allocated 2228963106eSGustavo Pimentel * @epc: the EPC device to which MSI-X interrupts was requested 2238963106eSGustavo Pimentel * @func_no: the endpoint function number in the EPC device 2248963106eSGustavo Pimentel * 2258963106eSGustavo Pimentel * Invoke to get the number of MSI-X interrupts allocated by the RC 2268963106eSGustavo Pimentel */ 2278963106eSGustavo Pimentel int pci_epc_get_msix(struct pci_epc *epc, u8 func_no) 2288963106eSGustavo Pimentel { 2298963106eSGustavo Pimentel int interrupt; 2308963106eSGustavo Pimentel unsigned long flags; 2318963106eSGustavo Pimentel 2328963106eSGustavo Pimentel if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions) 2338963106eSGustavo Pimentel return 0; 2348963106eSGustavo Pimentel 2358963106eSGustavo Pimentel if (!epc->ops->get_msix) 2368963106eSGustavo Pimentel return 0; 2378963106eSGustavo Pimentel 2388963106eSGustavo Pimentel spin_lock_irqsave(&epc->lock, flags); 2398963106eSGustavo Pimentel interrupt = epc->ops->get_msix(epc, func_no); 2408963106eSGustavo Pimentel spin_unlock_irqrestore(&epc->lock, flags); 2418963106eSGustavo Pimentel 2428963106eSGustavo Pimentel if (interrupt < 0) 2438963106eSGustavo Pimentel return 0; 2448963106eSGustavo Pimentel 2458963106eSGustavo Pimentel return interrupt + 1; 2468963106eSGustavo Pimentel } 2478963106eSGustavo Pimentel EXPORT_SYMBOL_GPL(pci_epc_get_msix); 2488963106eSGustavo Pimentel 2498963106eSGustavo Pimentel /** 2508963106eSGustavo Pimentel * pci_epc_set_msix() - set the number of MSI-X interrupt numbers required 2518963106eSGustavo Pimentel * @epc: the EPC device on which MSI-X has to be configured 2528963106eSGustavo Pimentel * @func_no: the endpoint function number in the EPC device 2538963106eSGustavo Pimentel * @interrupts: number of MSI-X interrupts required by the EPF 2548963106eSGustavo Pimentel * 2558963106eSGustavo Pimentel * Invoke to set the required number of MSI-X interrupts. 2568963106eSGustavo Pimentel */ 2578963106eSGustavo Pimentel int pci_epc_set_msix(struct pci_epc *epc, u8 func_no, u16 interrupts) 2588963106eSGustavo Pimentel { 2598963106eSGustavo Pimentel int ret; 2608963106eSGustavo Pimentel unsigned long flags; 2618963106eSGustavo Pimentel 2628963106eSGustavo Pimentel if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions || 2638963106eSGustavo Pimentel interrupts < 1 || interrupts > 2048) 2648963106eSGustavo Pimentel return -EINVAL; 2658963106eSGustavo Pimentel 2668963106eSGustavo Pimentel if (!epc->ops->set_msix) 2678963106eSGustavo Pimentel return 0; 2688963106eSGustavo Pimentel 2698963106eSGustavo Pimentel spin_lock_irqsave(&epc->lock, flags); 2708963106eSGustavo Pimentel ret = epc->ops->set_msix(epc, func_no, interrupts - 1); 2718963106eSGustavo Pimentel spin_unlock_irqrestore(&epc->lock, flags); 2728963106eSGustavo Pimentel 2738963106eSGustavo Pimentel return ret; 2748963106eSGustavo Pimentel } 2758963106eSGustavo Pimentel EXPORT_SYMBOL_GPL(pci_epc_set_msix); 2768963106eSGustavo Pimentel 2778963106eSGustavo Pimentel /** 2785e8cb403SKishon Vijay Abraham I * pci_epc_unmap_addr() - unmap CPU address from PCI address 2795e8cb403SKishon Vijay Abraham I * @epc: the EPC device on which address is allocated 2804494738dSCyrille Pitchen * @func_no: the endpoint function number in the EPC device 2815e8cb403SKishon Vijay Abraham I * @phys_addr: physical address of the local system 2825e8cb403SKishon Vijay Abraham I * 2835e8cb403SKishon Vijay Abraham I * Invoke to unmap the CPU address from PCI address. 2845e8cb403SKishon Vijay Abraham I */ 2854494738dSCyrille Pitchen void pci_epc_unmap_addr(struct pci_epc *epc, u8 func_no, 2864494738dSCyrille Pitchen phys_addr_t phys_addr) 2875e8cb403SKishon Vijay Abraham I { 2885e8cb403SKishon Vijay Abraham I unsigned long flags; 2895e8cb403SKishon Vijay Abraham I 2904494738dSCyrille Pitchen if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions) 2915e8cb403SKishon Vijay Abraham I return; 2925e8cb403SKishon Vijay Abraham I 2935e8cb403SKishon Vijay Abraham I if (!epc->ops->unmap_addr) 2945e8cb403SKishon Vijay Abraham I return; 2955e8cb403SKishon Vijay Abraham I 2965e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 2974494738dSCyrille Pitchen epc->ops->unmap_addr(epc, func_no, phys_addr); 2985e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 2995e8cb403SKishon Vijay Abraham I } 3005e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_unmap_addr); 3015e8cb403SKishon Vijay Abraham I 3025e8cb403SKishon Vijay Abraham I /** 3035e8cb403SKishon Vijay Abraham I * pci_epc_map_addr() - map CPU address to PCI address 3045e8cb403SKishon Vijay Abraham I * @epc: the EPC device on which address is allocated 3054494738dSCyrille Pitchen * @func_no: the endpoint function number in the EPC device 3065e8cb403SKishon Vijay Abraham I * @phys_addr: physical address of the local system 3075e8cb403SKishon Vijay Abraham I * @pci_addr: PCI address to which the physical address should be mapped 3085e8cb403SKishon Vijay Abraham I * @size: the size of the allocation 3095e8cb403SKishon Vijay Abraham I * 3105e8cb403SKishon Vijay Abraham I * Invoke to map CPU address with PCI address. 3115e8cb403SKishon Vijay Abraham I */ 3124494738dSCyrille Pitchen int pci_epc_map_addr(struct pci_epc *epc, u8 func_no, 3134494738dSCyrille Pitchen phys_addr_t phys_addr, u64 pci_addr, size_t size) 3145e8cb403SKishon Vijay Abraham I { 3155e8cb403SKishon Vijay Abraham I int ret; 3165e8cb403SKishon Vijay Abraham I unsigned long flags; 3175e8cb403SKishon Vijay Abraham I 3184494738dSCyrille Pitchen if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions) 3195e8cb403SKishon Vijay Abraham I return -EINVAL; 3205e8cb403SKishon Vijay Abraham I 3215e8cb403SKishon Vijay Abraham I if (!epc->ops->map_addr) 3225e8cb403SKishon Vijay Abraham I return 0; 3235e8cb403SKishon Vijay Abraham I 3245e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 3254494738dSCyrille Pitchen ret = epc->ops->map_addr(epc, func_no, phys_addr, pci_addr, size); 3265e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 3275e8cb403SKishon Vijay Abraham I 3285e8cb403SKishon Vijay Abraham I return ret; 3295e8cb403SKishon Vijay Abraham I } 3305e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_map_addr); 3315e8cb403SKishon Vijay Abraham I 3325e8cb403SKishon Vijay Abraham I /** 3335e8cb403SKishon Vijay Abraham I * pci_epc_clear_bar() - reset the BAR 3345e8cb403SKishon Vijay Abraham I * @epc: the EPC device for which the BAR has to be cleared 3354494738dSCyrille Pitchen * @func_no: the endpoint function number in the EPC device 33677d08dbdSNiklas Cassel * @epf_bar: the struct epf_bar that contains the BAR information 3375e8cb403SKishon Vijay Abraham I * 3385e8cb403SKishon Vijay Abraham I * Invoke to reset the BAR of the endpoint device. 3395e8cb403SKishon Vijay Abraham I */ 34077d08dbdSNiklas Cassel void pci_epc_clear_bar(struct pci_epc *epc, u8 func_no, 34177d08dbdSNiklas Cassel struct pci_epf_bar *epf_bar) 3425e8cb403SKishon Vijay Abraham I { 3435e8cb403SKishon Vijay Abraham I unsigned long flags; 3445e8cb403SKishon Vijay Abraham I 3456474a4e5SNiklas Cassel if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions || 3466474a4e5SNiklas Cassel (epf_bar->barno == BAR_5 && 3476474a4e5SNiklas Cassel epf_bar->flags & PCI_BASE_ADDRESS_MEM_TYPE_64)) 3485e8cb403SKishon Vijay Abraham I return; 3495e8cb403SKishon Vijay Abraham I 3505e8cb403SKishon Vijay Abraham I if (!epc->ops->clear_bar) 3515e8cb403SKishon Vijay Abraham I return; 3525e8cb403SKishon Vijay Abraham I 3535e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 35477d08dbdSNiklas Cassel epc->ops->clear_bar(epc, func_no, epf_bar); 3555e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 3565e8cb403SKishon Vijay Abraham I } 3575e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_clear_bar); 3585e8cb403SKishon Vijay Abraham I 3595e8cb403SKishon Vijay Abraham I /** 3605e8cb403SKishon Vijay Abraham I * pci_epc_set_bar() - configure BAR in order for host to assign PCI addr space 3615e8cb403SKishon Vijay Abraham I * @epc: the EPC device on which BAR has to be configured 3624494738dSCyrille Pitchen * @func_no: the endpoint function number in the EPC device 363bc4a4897SNiklas Cassel * @epf_bar: the struct epf_bar that contains the BAR information 3645e8cb403SKishon Vijay Abraham I * 3655e8cb403SKishon Vijay Abraham I * Invoke to configure the BAR of the endpoint device. 3665e8cb403SKishon Vijay Abraham I */ 367bc4a4897SNiklas Cassel int pci_epc_set_bar(struct pci_epc *epc, u8 func_no, 368bc4a4897SNiklas Cassel struct pci_epf_bar *epf_bar) 3695e8cb403SKishon Vijay Abraham I { 3705e8cb403SKishon Vijay Abraham I int ret; 3715e8cb403SKishon Vijay Abraham I unsigned long irq_flags; 3723567a4edSNiklas Cassel int flags = epf_bar->flags; 3735e8cb403SKishon Vijay Abraham I 374f16b1f6fSNiklas Cassel if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions || 375f16b1f6fSNiklas Cassel (epf_bar->barno == BAR_5 && 3763567a4edSNiklas Cassel flags & PCI_BASE_ADDRESS_MEM_TYPE_64) || 3773567a4edSNiklas Cassel (flags & PCI_BASE_ADDRESS_SPACE_IO && 378f25b5faeSNiklas Cassel flags & PCI_BASE_ADDRESS_IO_MASK) || 379f25b5faeSNiklas Cassel (upper_32_bits(epf_bar->size) && 380f25b5faeSNiklas Cassel !(flags & PCI_BASE_ADDRESS_MEM_TYPE_64))) 3815e8cb403SKishon Vijay Abraham I return -EINVAL; 3825e8cb403SKishon Vijay Abraham I 3835e8cb403SKishon Vijay Abraham I if (!epc->ops->set_bar) 3845e8cb403SKishon Vijay Abraham I return 0; 3855e8cb403SKishon Vijay Abraham I 3865e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, irq_flags); 387bc4a4897SNiklas Cassel ret = epc->ops->set_bar(epc, func_no, epf_bar); 3885e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, irq_flags); 3895e8cb403SKishon Vijay Abraham I 3905e8cb403SKishon Vijay Abraham I return ret; 3915e8cb403SKishon Vijay Abraham I } 3925e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_set_bar); 3935e8cb403SKishon Vijay Abraham I 3945e8cb403SKishon Vijay Abraham I /** 3955e8cb403SKishon Vijay Abraham I * pci_epc_write_header() - write standard configuration header 3965e8cb403SKishon Vijay Abraham I * @epc: the EPC device to which the configuration header should be written 3974494738dSCyrille Pitchen * @func_no: the endpoint function number in the EPC device 3985e8cb403SKishon Vijay Abraham I * @header: standard configuration header fields 3995e8cb403SKishon Vijay Abraham I * 4005e8cb403SKishon Vijay Abraham I * Invoke to write the configuration header to the endpoint controller. Every 4015e8cb403SKishon Vijay Abraham I * endpoint controller will have a dedicated location to which the standard 4025e8cb403SKishon Vijay Abraham I * configuration header would be written. The callback function should write 4035e8cb403SKishon Vijay Abraham I * the header fields to this dedicated location. 4045e8cb403SKishon Vijay Abraham I */ 4054494738dSCyrille Pitchen int pci_epc_write_header(struct pci_epc *epc, u8 func_no, 4064494738dSCyrille Pitchen struct pci_epf_header *header) 4075e8cb403SKishon Vijay Abraham I { 4085e8cb403SKishon Vijay Abraham I int ret; 4095e8cb403SKishon Vijay Abraham I unsigned long flags; 4105e8cb403SKishon Vijay Abraham I 4114494738dSCyrille Pitchen if (IS_ERR_OR_NULL(epc) || func_no >= epc->max_functions) 4125e8cb403SKishon Vijay Abraham I return -EINVAL; 4135e8cb403SKishon Vijay Abraham I 4145e8cb403SKishon Vijay Abraham I if (!epc->ops->write_header) 4155e8cb403SKishon Vijay Abraham I return 0; 4165e8cb403SKishon Vijay Abraham I 4175e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 4184494738dSCyrille Pitchen ret = epc->ops->write_header(epc, func_no, header); 4195e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 4205e8cb403SKishon Vijay Abraham I 4215e8cb403SKishon Vijay Abraham I return ret; 4225e8cb403SKishon Vijay Abraham I } 4235e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_write_header); 4245e8cb403SKishon Vijay Abraham I 4255e8cb403SKishon Vijay Abraham I /** 4265e8cb403SKishon Vijay Abraham I * pci_epc_add_epf() - bind PCI endpoint function to an endpoint controller 4275e8cb403SKishon Vijay Abraham I * @epc: the EPC device to which the endpoint function should be added 4285e8cb403SKishon Vijay Abraham I * @epf: the endpoint function to be added 4295e8cb403SKishon Vijay Abraham I * 4305e8cb403SKishon Vijay Abraham I * A PCI endpoint device can have one or more functions. In the case of PCIe, 4315e8cb403SKishon Vijay Abraham I * the specification allows up to 8 PCIe endpoint functions. Invoke 4325e8cb403SKishon Vijay Abraham I * pci_epc_add_epf() to add a PCI endpoint function to an endpoint controller. 4335e8cb403SKishon Vijay Abraham I */ 4345e8cb403SKishon Vijay Abraham I int pci_epc_add_epf(struct pci_epc *epc, struct pci_epf *epf) 4355e8cb403SKishon Vijay Abraham I { 4365e8cb403SKishon Vijay Abraham I unsigned long flags; 4375e8cb403SKishon Vijay Abraham I 4385e8cb403SKishon Vijay Abraham I if (epf->epc) 4395e8cb403SKishon Vijay Abraham I return -EBUSY; 4405e8cb403SKishon Vijay Abraham I 4415e8cb403SKishon Vijay Abraham I if (IS_ERR(epc)) 4425e8cb403SKishon Vijay Abraham I return -EINVAL; 4435e8cb403SKishon Vijay Abraham I 4445e8cb403SKishon Vijay Abraham I if (epf->func_no > epc->max_functions - 1) 4455e8cb403SKishon Vijay Abraham I return -EINVAL; 4465e8cb403SKishon Vijay Abraham I 4475e8cb403SKishon Vijay Abraham I epf->epc = epc; 4485e8cb403SKishon Vijay Abraham I 4495e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 4505e8cb403SKishon Vijay Abraham I list_add_tail(&epf->list, &epc->pci_epf); 4515e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 4525e8cb403SKishon Vijay Abraham I 4535e8cb403SKishon Vijay Abraham I return 0; 4545e8cb403SKishon Vijay Abraham I } 4555e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_add_epf); 4565e8cb403SKishon Vijay Abraham I 4575e8cb403SKishon Vijay Abraham I /** 4585e8cb403SKishon Vijay Abraham I * pci_epc_remove_epf() - remove PCI endpoint function from endpoint controller 4595e8cb403SKishon Vijay Abraham I * @epc: the EPC device from which the endpoint function should be removed 4605e8cb403SKishon Vijay Abraham I * @epf: the endpoint function to be removed 4615e8cb403SKishon Vijay Abraham I * 4625e8cb403SKishon Vijay Abraham I * Invoke to remove PCI endpoint function from the endpoint controller. 4635e8cb403SKishon Vijay Abraham I */ 4645e8cb403SKishon Vijay Abraham I void pci_epc_remove_epf(struct pci_epc *epc, struct pci_epf *epf) 4655e8cb403SKishon Vijay Abraham I { 4665e8cb403SKishon Vijay Abraham I unsigned long flags; 4675e8cb403SKishon Vijay Abraham I 4685e8cb403SKishon Vijay Abraham I if (!epc || IS_ERR(epc)) 4695e8cb403SKishon Vijay Abraham I return; 4705e8cb403SKishon Vijay Abraham I 4715e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 4725e8cb403SKishon Vijay Abraham I list_del(&epf->list); 4735e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 4745e8cb403SKishon Vijay Abraham I } 4755e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_remove_epf); 4765e8cb403SKishon Vijay Abraham I 4775e8cb403SKishon Vijay Abraham I /** 4785e8cb403SKishon Vijay Abraham I * pci_epc_linkup() - Notify the EPF device that EPC device has established a 4795e8cb403SKishon Vijay Abraham I * connection with the Root Complex. 4805e8cb403SKishon Vijay Abraham I * @epc: the EPC device which has established link with the host 4815e8cb403SKishon Vijay Abraham I * 4825e8cb403SKishon Vijay Abraham I * Invoke to Notify the EPF device that the EPC device has established a 4835e8cb403SKishon Vijay Abraham I * connection with the Root Complex. 4845e8cb403SKishon Vijay Abraham I */ 4855e8cb403SKishon Vijay Abraham I void pci_epc_linkup(struct pci_epc *epc) 4865e8cb403SKishon Vijay Abraham I { 4875e8cb403SKishon Vijay Abraham I unsigned long flags; 4885e8cb403SKishon Vijay Abraham I struct pci_epf *epf; 4895e8cb403SKishon Vijay Abraham I 4905e8cb403SKishon Vijay Abraham I if (!epc || IS_ERR(epc)) 4915e8cb403SKishon Vijay Abraham I return; 4925e8cb403SKishon Vijay Abraham I 4935e8cb403SKishon Vijay Abraham I spin_lock_irqsave(&epc->lock, flags); 4945e8cb403SKishon Vijay Abraham I list_for_each_entry(epf, &epc->pci_epf, list) 4955e8cb403SKishon Vijay Abraham I pci_epf_linkup(epf); 4965e8cb403SKishon Vijay Abraham I spin_unlock_irqrestore(&epc->lock, flags); 4975e8cb403SKishon Vijay Abraham I } 4985e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_linkup); 4995e8cb403SKishon Vijay Abraham I 5005e8cb403SKishon Vijay Abraham I /** 5015e8cb403SKishon Vijay Abraham I * pci_epc_destroy() - destroy the EPC device 5025e8cb403SKishon Vijay Abraham I * @epc: the EPC device that has to be destroyed 5035e8cb403SKishon Vijay Abraham I * 5045e8cb403SKishon Vijay Abraham I * Invoke to destroy the PCI EPC device 5055e8cb403SKishon Vijay Abraham I */ 5065e8cb403SKishon Vijay Abraham I void pci_epc_destroy(struct pci_epc *epc) 5075e8cb403SKishon Vijay Abraham I { 5083a401a2cSKishon Vijay Abraham I pci_ep_cfs_remove_epc_group(epc->group); 5095e8cb403SKishon Vijay Abraham I device_unregister(&epc->dev); 5105e8cb403SKishon Vijay Abraham I kfree(epc); 5115e8cb403SKishon Vijay Abraham I } 5125e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(pci_epc_destroy); 5135e8cb403SKishon Vijay Abraham I 5145e8cb403SKishon Vijay Abraham I /** 5155e8cb403SKishon Vijay Abraham I * devm_pci_epc_destroy() - destroy the EPC device 5165e8cb403SKishon Vijay Abraham I * @dev: device that wants to destroy the EPC 5175e8cb403SKishon Vijay Abraham I * @epc: the EPC device that has to be destroyed 5185e8cb403SKishon Vijay Abraham I * 5195e8cb403SKishon Vijay Abraham I * Invoke to destroy the devres associated with this 5205e8cb403SKishon Vijay Abraham I * pci_epc and destroy the EPC device. 5215e8cb403SKishon Vijay Abraham I */ 5225e8cb403SKishon Vijay Abraham I void devm_pci_epc_destroy(struct device *dev, struct pci_epc *epc) 5235e8cb403SKishon Vijay Abraham I { 5245e8cb403SKishon Vijay Abraham I int r; 5255e8cb403SKishon Vijay Abraham I 5265e8cb403SKishon Vijay Abraham I r = devres_destroy(dev, devm_pci_epc_release, devm_pci_epc_match, 5275e8cb403SKishon Vijay Abraham I epc); 5285e8cb403SKishon Vijay Abraham I dev_WARN_ONCE(dev, r, "couldn't find PCI EPC resource\n"); 5295e8cb403SKishon Vijay Abraham I } 5305e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(devm_pci_epc_destroy); 5315e8cb403SKishon Vijay Abraham I 5325e8cb403SKishon Vijay Abraham I /** 5335e8cb403SKishon Vijay Abraham I * __pci_epc_create() - create a new endpoint controller (EPC) device 5345e8cb403SKishon Vijay Abraham I * @dev: device that is creating the new EPC 5355e8cb403SKishon Vijay Abraham I * @ops: function pointers for performing EPC operations 5365e8cb403SKishon Vijay Abraham I * @owner: the owner of the module that creates the EPC device 5375e8cb403SKishon Vijay Abraham I * 5385e8cb403SKishon Vijay Abraham I * Invoke to create a new EPC device and add it to pci_epc class. 5395e8cb403SKishon Vijay Abraham I */ 5405e8cb403SKishon Vijay Abraham I struct pci_epc * 5415e8cb403SKishon Vijay Abraham I __pci_epc_create(struct device *dev, const struct pci_epc_ops *ops, 5425e8cb403SKishon Vijay Abraham I struct module *owner) 5435e8cb403SKishon Vijay Abraham I { 5445e8cb403SKishon Vijay Abraham I int ret; 5455e8cb403SKishon Vijay Abraham I struct pci_epc *epc; 5465e8cb403SKishon Vijay Abraham I 5475e8cb403SKishon Vijay Abraham I if (WARN_ON(!dev)) { 5485e8cb403SKishon Vijay Abraham I ret = -EINVAL; 5495e8cb403SKishon Vijay Abraham I goto err_ret; 5505e8cb403SKishon Vijay Abraham I } 5515e8cb403SKishon Vijay Abraham I 5525e8cb403SKishon Vijay Abraham I epc = kzalloc(sizeof(*epc), GFP_KERNEL); 5535e8cb403SKishon Vijay Abraham I if (!epc) { 5545e8cb403SKishon Vijay Abraham I ret = -ENOMEM; 5555e8cb403SKishon Vijay Abraham I goto err_ret; 5565e8cb403SKishon Vijay Abraham I } 5575e8cb403SKishon Vijay Abraham I 5585e8cb403SKishon Vijay Abraham I spin_lock_init(&epc->lock); 5595e8cb403SKishon Vijay Abraham I INIT_LIST_HEAD(&epc->pci_epf); 5605e8cb403SKishon Vijay Abraham I 5615e8cb403SKishon Vijay Abraham I device_initialize(&epc->dev); 5625e8cb403SKishon Vijay Abraham I epc->dev.class = pci_epc_class; 56364c1a02aSKishon Vijay Abraham I epc->dev.parent = dev; 5645e8cb403SKishon Vijay Abraham I epc->ops = ops; 5655e8cb403SKishon Vijay Abraham I 5665e8cb403SKishon Vijay Abraham I ret = dev_set_name(&epc->dev, "%s", dev_name(dev)); 5675e8cb403SKishon Vijay Abraham I if (ret) 5685e8cb403SKishon Vijay Abraham I goto put_dev; 5695e8cb403SKishon Vijay Abraham I 5705e8cb403SKishon Vijay Abraham I ret = device_add(&epc->dev); 5715e8cb403SKishon Vijay Abraham I if (ret) 5725e8cb403SKishon Vijay Abraham I goto put_dev; 5735e8cb403SKishon Vijay Abraham I 5743a401a2cSKishon Vijay Abraham I epc->group = pci_ep_cfs_add_epc_group(dev_name(dev)); 5753a401a2cSKishon Vijay Abraham I 5765e8cb403SKishon Vijay Abraham I return epc; 5775e8cb403SKishon Vijay Abraham I 5785e8cb403SKishon Vijay Abraham I put_dev: 5795e8cb403SKishon Vijay Abraham I put_device(&epc->dev); 5805e8cb403SKishon Vijay Abraham I kfree(epc); 5815e8cb403SKishon Vijay Abraham I 5825e8cb403SKishon Vijay Abraham I err_ret: 5835e8cb403SKishon Vijay Abraham I return ERR_PTR(ret); 5845e8cb403SKishon Vijay Abraham I } 5855e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(__pci_epc_create); 5865e8cb403SKishon Vijay Abraham I 5875e8cb403SKishon Vijay Abraham I /** 5885e8cb403SKishon Vijay Abraham I * __devm_pci_epc_create() - create a new endpoint controller (EPC) device 5895e8cb403SKishon Vijay Abraham I * @dev: device that is creating the new EPC 5905e8cb403SKishon Vijay Abraham I * @ops: function pointers for performing EPC operations 5915e8cb403SKishon Vijay Abraham I * @owner: the owner of the module that creates the EPC device 5925e8cb403SKishon Vijay Abraham I * 5935e8cb403SKishon Vijay Abraham I * Invoke to create a new EPC device and add it to pci_epc class. 5945e8cb403SKishon Vijay Abraham I * While at that, it also associates the device with the pci_epc using devres. 5955e8cb403SKishon Vijay Abraham I * On driver detach, release function is invoked on the devres data, 5965e8cb403SKishon Vijay Abraham I * then, devres data is freed. 5975e8cb403SKishon Vijay Abraham I */ 5985e8cb403SKishon Vijay Abraham I struct pci_epc * 5995e8cb403SKishon Vijay Abraham I __devm_pci_epc_create(struct device *dev, const struct pci_epc_ops *ops, 6005e8cb403SKishon Vijay Abraham I struct module *owner) 6015e8cb403SKishon Vijay Abraham I { 6025e8cb403SKishon Vijay Abraham I struct pci_epc **ptr, *epc; 6035e8cb403SKishon Vijay Abraham I 6045e8cb403SKishon Vijay Abraham I ptr = devres_alloc(devm_pci_epc_release, sizeof(*ptr), GFP_KERNEL); 6055e8cb403SKishon Vijay Abraham I if (!ptr) 6065e8cb403SKishon Vijay Abraham I return ERR_PTR(-ENOMEM); 6075e8cb403SKishon Vijay Abraham I 6085e8cb403SKishon Vijay Abraham I epc = __pci_epc_create(dev, ops, owner); 6095e8cb403SKishon Vijay Abraham I if (!IS_ERR(epc)) { 6105e8cb403SKishon Vijay Abraham I *ptr = epc; 6115e8cb403SKishon Vijay Abraham I devres_add(dev, ptr); 6125e8cb403SKishon Vijay Abraham I } else { 6135e8cb403SKishon Vijay Abraham I devres_free(ptr); 6145e8cb403SKishon Vijay Abraham I } 6155e8cb403SKishon Vijay Abraham I 6165e8cb403SKishon Vijay Abraham I return epc; 6175e8cb403SKishon Vijay Abraham I } 6185e8cb403SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(__devm_pci_epc_create); 6195e8cb403SKishon Vijay Abraham I 6205e8cb403SKishon Vijay Abraham I static int __init pci_epc_init(void) 6215e8cb403SKishon Vijay Abraham I { 6225e8cb403SKishon Vijay Abraham I pci_epc_class = class_create(THIS_MODULE, "pci_epc"); 6235e8cb403SKishon Vijay Abraham I if (IS_ERR(pci_epc_class)) { 6245e8cb403SKishon Vijay Abraham I pr_err("failed to create pci epc class --> %ld\n", 6255e8cb403SKishon Vijay Abraham I PTR_ERR(pci_epc_class)); 6265e8cb403SKishon Vijay Abraham I return PTR_ERR(pci_epc_class); 6275e8cb403SKishon Vijay Abraham I } 6285e8cb403SKishon Vijay Abraham I 6295e8cb403SKishon Vijay Abraham I return 0; 6305e8cb403SKishon Vijay Abraham I } 6315e8cb403SKishon Vijay Abraham I module_init(pci_epc_init); 6325e8cb403SKishon Vijay Abraham I 6335e8cb403SKishon Vijay Abraham I static void __exit pci_epc_exit(void) 6345e8cb403SKishon Vijay Abraham I { 6355e8cb403SKishon Vijay Abraham I class_destroy(pci_epc_class); 6365e8cb403SKishon Vijay Abraham I } 6375e8cb403SKishon Vijay Abraham I module_exit(pci_epc_exit); 6385e8cb403SKishon Vijay Abraham I 6395e8cb403SKishon Vijay Abraham I MODULE_DESCRIPTION("PCI EPC Library"); 6405e8cb403SKishon Vijay Abraham I MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>"); 6415e8cb403SKishon Vijay Abraham I MODULE_LICENSE("GPL v2"); 642