acf4be9d8b5c052903c1f0f3550e93888cb54726
[dpdk.git] / lib / librte_eal / linuxapp / eal / include / exec-env / rte_interrupts.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef _RTE_INTERRUPTS_H_
35 #error "don't include this file directly, please include generic <rte_interrupts.h>"
36 #endif
37
38 #ifndef _RTE_LINUXAPP_INTERRUPTS_H_
39 #define _RTE_LINUXAPP_INTERRUPTS_H_
40
41 #define RTE_MAX_RXTX_INTR_VEC_ID     32
42
43 enum rte_intr_handle_type {
44         RTE_INTR_HANDLE_UNKNOWN = 0,
45         RTE_INTR_HANDLE_UIO,          /**< uio device handle */
46         RTE_INTR_HANDLE_UIO_INTX,     /**< uio generic handle */
47         RTE_INTR_HANDLE_VFIO_LEGACY,  /**< vfio device handle (legacy) */
48         RTE_INTR_HANDLE_VFIO_MSI,     /**< vfio device handle (MSI) */
49         RTE_INTR_HANDLE_VFIO_MSIX,    /**< vfio device handle (MSIX) */
50         RTE_INTR_HANDLE_ALARM,    /**< alarm handle */
51         RTE_INTR_HANDLE_MAX
52 };
53
54 #define RTE_INTR_EVENT_ADD            1UL
55 #define RTE_INTR_EVENT_DEL            2UL
56
57 typedef void (*rte_intr_event_cb_t)(int fd, void *arg);
58
59 struct rte_epoll_data {
60         uint32_t event;               /**< event type */
61         void *data;                   /**< User data */
62         rte_intr_event_cb_t cb_fun;   /**< IN: callback fun */
63         void *cb_arg;                 /**< IN: callback arg */
64 };
65
66 enum {
67         RTE_EPOLL_INVALID = 0,
68         RTE_EPOLL_VALID,
69         RTE_EPOLL_EXEC,
70 };
71
72 /** interrupt epoll event obj, taken by epoll_event.ptr */
73 struct rte_epoll_event {
74         volatile uint32_t status;  /**< OUT: event status */
75         int fd;                    /**< OUT: event fd */
76         int epfd;       /**< OUT: epoll instance the ev associated with */
77         struct rte_epoll_data epdata;
78 };
79
80 /** Handle for interrupts. */
81 struct rte_intr_handle {
82         union {
83                 int vfio_dev_fd;  /**< VFIO device file descriptor */
84                 int uio_cfg_fd;  /**< UIO config file descriptor
85                                         for uio_pci_generic */
86         };
87         int fd;  /**< interrupt event file descriptor */
88         enum rte_intr_handle_type type;  /**< handle type */
89 #ifdef RTE_NEXT_ABI
90         uint32_t max_intr;             /**< max interrupt requested */
91         uint32_t nb_efd;               /**< number of available efd(event fd) */
92         int efds[RTE_MAX_RXTX_INTR_VEC_ID];  /**< intr vectors/efds mapping */
93         struct rte_epoll_event elist[RTE_MAX_RXTX_INTR_VEC_ID];
94                                        /**< intr vector epoll event */
95         int *intr_vec;                 /**< intr vector number array */
96 #endif
97 };
98
99 #define RTE_EPOLL_PER_THREAD        -1  /**< to hint using per thread epfd */
100
101 /**
102  * It waits for events on the epoll instance.
103  *
104  * @param epfd
105  *   Epoll instance fd on which the caller wait for events.
106  * @param events
107  *   Memory area contains the events that will be available for the caller.
108  * @param maxevents
109  *   Up to maxevents are returned, must greater than zero.
110  * @param timeout
111  *   Specifying a timeout of -1 causes a block indefinitely.
112  *   Specifying a timeout equal to zero cause to return immediately.
113  * @return
114  *   - On success, returns the number of available event.
115  *   - On failure, a negative value.
116  */
117 int
118 rte_epoll_wait(int epfd, struct rte_epoll_event *events,
119                int maxevents, int timeout);
120
121 /**
122  * It performs control operations on epoll instance referred by the epfd.
123  * It requests that the operation op be performed for the target fd.
124  *
125  * @param epfd
126  *   Epoll instance fd on which the caller perform control operations.
127  * @param op
128  *   The operation be performed for the target fd.
129  * @param fd
130  *   The target fd on which the control ops perform.
131  * @param event
132  *   Describes the object linked to the fd.
133  *   Note: The caller must take care the object deletion after CTL_DEL.
134  * @return
135  *   - On success, zero.
136  *   - On failure, a negative value.
137  */
138 int
139 rte_epoll_ctl(int epfd, int op, int fd,
140               struct rte_epoll_event *event);
141
142 /**
143  * The function returns the per thread epoll instance.
144  *
145  * @return
146  *   epfd the epoll instance referred to.
147  */
148 int
149 rte_intr_tls_epfd(void);
150
151 /**
152  * @param intr_handle
153  *   Pointer to the interrupt handle.
154  * @param epfd
155  *   Epoll instance fd which the intr vector associated to.
156  * @param op
157  *   The operation be performed for the vector.
158  *   Operation type of {ADD, DEL}.
159  * @param vec
160  *   RX intr vector number added to the epoll instance wait list.
161  * @param data
162  *   User raw data.
163  * @return
164  *   - On success, zero.
165  *   - On failure, a negative value.
166  */
167 int
168 rte_intr_rx_ctl(struct rte_intr_handle *intr_handle,
169                 int epfd, int op, unsigned int vec, void *data);
170
171 #endif /* _RTE_LINUXAPP_INTERRUPTS_H_ */