lib/librte_eventdev/rte_eventdev_pmd_pci.h

   1 /*
   2  *
   3  *   Copyright(c) 2016-2017 Cavium networks. All rights reserved.
   4  *
   5  *   Redistribution and use in source and binary forms, with or without
   6  *   modification, are permitted provided that the following conditions
   7  *   are met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  *       notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above copyright
  12  *       notice, this list of conditions and the following disclaimer in
  13  *       the documentation and/or other materials provided with the
  14  *       distribution.
  15  *     * Neither the name of Cavium networks nor the names of its
  16  *       contributors may be used to endorse or promote products derived
  17  *       from this software without specific prior written permission.
  18  *
  19  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef _RTE_EVENTDEV_PMD_PCI_H_
  33 #define _RTE_EVENTDEV_PMD_PCI_H_
  34
  35 /** @file
  36  * RTE Eventdev PCI PMD APIs
  37  *
  38  * @note
  39  * These API are from event PCI PMD only and user applications should not call
  40  * them directly.
  41  */
  42
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #include <string.h>
  49
  50 #include <rte_pci.h>
  51
  52 #include "rte_eventdev_pmd.h"
  53
  54 typedef int (*eventdev_pmd_pci_callback_t)(struct rte_eventdev *dev);
  55
  56 /**
  57  * @internal
  58  * Wrapper for use by pci drivers as a .probe function to attach to a event
  59  * interface.
  60  */
  61 static int
  62 rte_event_pmd_pci_probe(struct rte_pci_driver *pci_drv,
  63                             struct rte_pci_device *pci_dev,
  64                             size_t private_data_size,
  65                             eventdev_pmd_pci_callback_t devinit)
  66 {
  67         struct rte_eventdev *eventdev;
  68
  69         char eventdev_name[RTE_EVENTDEV_NAME_MAX_LEN];
  70
  71         int retval;
  72
  73         if (devinit == NULL)
  74                 return -EINVAL;
  75
  76         rte_pci_device_name(&pci_dev->addr, eventdev_name,
  77                         sizeof(eventdev_name));
  78
  79         eventdev = rte_event_pmd_allocate(eventdev_name,
  80                          pci_dev->device.numa_node);
  81         if (eventdev == NULL)
  82                 return -ENOMEM;
  83
  84         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
  85                 eventdev->data->dev_private =
  86                                 rte_zmalloc_socket(
  87                                                 "eventdev private structure",
  88                                                 private_data_size,
  89                                                 RTE_CACHE_LINE_SIZE,
  90                                                 rte_socket_id());
  91
  92                 if (eventdev->data->dev_private == NULL)
  93                         rte_panic("Cannot allocate memzone for private "
  94                                         "device data");
  95         }
  96
  97         eventdev->dev = &pci_dev->device;
  98
  99         /* Invoke PMD device initialization function */
 100         retval = devinit(eventdev);
 101         if (retval == 0)
 102                 return 0;
 103
 104         RTE_EDEV_LOG_ERR("driver %s: (vendor_id=0x%x device_id=0x%x)"
 105                         " failed", pci_drv->driver.name,
 106                         (unsigned int) pci_dev->id.vendor_id,
 107                         (unsigned int) pci_dev->id.device_id);
 108
 109         rte_event_pmd_release(eventdev);
 110
 111         return -ENXIO;
 112 }
 113
 114
 115 /**
 116  * @internal
 117  * Wrapper for use by pci drivers as a .remove function to detach a event
 118  * interface.
 119  */
 120 static inline int
 121 rte_event_pmd_pci_remove(struct rte_pci_device *pci_dev,
 122                              eventdev_pmd_pci_callback_t devuninit)
 123 {
 124         struct rte_eventdev *eventdev;
 125         char eventdev_name[RTE_EVENTDEV_NAME_MAX_LEN];
 126         int ret = 0;
 127
 128         if (pci_dev == NULL)
 129                 return -EINVAL;
 130
 131         rte_pci_device_name(&pci_dev->addr, eventdev_name,
 132                         sizeof(eventdev_name));
 133
 134         eventdev = rte_event_pmd_get_named_dev(eventdev_name);
 135         if (eventdev == NULL)
 136                 return -ENODEV;
 137
 138         ret = rte_event_dev_close(eventdev->data->dev_id);
 139         if (ret < 0)
 140                 return ret;
 141
 142         /* Invoke PMD device un-init function */
 143         if (devuninit)
 144                 ret = devuninit(eventdev);
 145         if (ret)
 146                 return ret;
 147
 148         /* Free event device */
 149         rte_event_pmd_release(eventdev);
 150
 151         eventdev->dev = NULL;
 152
 153         return 0;
 154 }
 155
 156 #ifdef __cplusplus
 157 }
 158 #endif
 159
 160 #endif /* _RTE_EVENTDEV_PMD_PCI_H_ */