lib: use SPDX tag for Cavium copyright files
[dpdk.git] / lib / librte_eventdev / rte_eventdev_pmd_pci.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2016-2017 Cavium, Inc
3  */
4
5 #ifndef _RTE_EVENTDEV_PMD_PCI_H_
6 #define _RTE_EVENTDEV_PMD_PCI_H_
7
8 /** @file
9  * RTE Eventdev PCI PMD APIs
10  *
11  * @note
12  * These API are from event PCI PMD only and user applications should not call
13  * them directly.
14  */
15
16
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20
21 #include <string.h>
22
23 #include <rte_eal.h>
24 #include <rte_lcore.h>
25 #include <rte_pci.h>
26 #include <rte_bus_pci.h>
27
28 #include "rte_eventdev_pmd.h"
29
30 typedef int (*eventdev_pmd_pci_callback_t)(struct rte_eventdev *dev);
31
32 /**
33  * @internal
34  * Wrapper for use by pci drivers as a .probe function to attach to a event
35  * interface.
36  */
37 static inline int
38 rte_event_pmd_pci_probe(struct rte_pci_driver *pci_drv,
39                             struct rte_pci_device *pci_dev,
40                             size_t private_data_size,
41                             eventdev_pmd_pci_callback_t devinit)
42 {
43         struct rte_eventdev *eventdev;
44
45         char eventdev_name[RTE_EVENTDEV_NAME_MAX_LEN];
46
47         int retval;
48
49         if (devinit == NULL)
50                 return -EINVAL;
51
52         rte_pci_device_name(&pci_dev->addr, eventdev_name,
53                         sizeof(eventdev_name));
54
55         eventdev = rte_event_pmd_allocate(eventdev_name,
56                          pci_dev->device.numa_node);
57         if (eventdev == NULL)
58                 return -ENOMEM;
59
60         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
61                 eventdev->data->dev_private =
62                                 rte_zmalloc_socket(
63                                                 "eventdev private structure",
64                                                 private_data_size,
65                                                 RTE_CACHE_LINE_SIZE,
66                                                 rte_socket_id());
67
68                 if (eventdev->data->dev_private == NULL)
69                         rte_panic("Cannot allocate memzone for private "
70                                         "device data");
71         }
72
73         eventdev->dev = &pci_dev->device;
74
75         /* Invoke PMD device initialization function */
76         retval = devinit(eventdev);
77         if (retval == 0)
78                 return 0;
79
80         RTE_EDEV_LOG_ERR("driver %s: (vendor_id=0x%x device_id=0x%x)"
81                         " failed", pci_drv->driver.name,
82                         (unsigned int) pci_dev->id.vendor_id,
83                         (unsigned int) pci_dev->id.device_id);
84
85         rte_event_pmd_release(eventdev);
86
87         return -ENXIO;
88 }
89
90
91 /**
92  * @internal
93  * Wrapper for use by pci drivers as a .remove function to detach a event
94  * interface.
95  */
96 static inline int
97 rte_event_pmd_pci_remove(struct rte_pci_device *pci_dev,
98                              eventdev_pmd_pci_callback_t devuninit)
99 {
100         struct rte_eventdev *eventdev;
101         char eventdev_name[RTE_EVENTDEV_NAME_MAX_LEN];
102         int ret = 0;
103
104         if (pci_dev == NULL)
105                 return -EINVAL;
106
107         rte_pci_device_name(&pci_dev->addr, eventdev_name,
108                         sizeof(eventdev_name));
109
110         eventdev = rte_event_pmd_get_named_dev(eventdev_name);
111         if (eventdev == NULL)
112                 return -ENODEV;
113
114         ret = rte_event_dev_close(eventdev->data->dev_id);
115         if (ret < 0)
116                 return ret;
117
118         /* Invoke PMD device un-init function */
119         if (devuninit)
120                 ret = devuninit(eventdev);
121         if (ret)
122                 return ret;
123
124         /* Free event device */
125         rte_event_pmd_release(eventdev);
126
127         eventdev->dev = NULL;
128
129         return 0;
130 }
131
132 #ifdef __cplusplus
133 }
134 #endif
135
136 #endif /* _RTE_EVENTDEV_PMD_PCI_H_ */