vfio: fix API description

[dpdk.git] / lib / librte_eal / include / rte_eal_interrupts.h

diff --git a/lib/librte_eal/include/rte_eal_interrupts.h b/lib/librte_eal/include/rte_eal_interrupts.h
index 773a34a..00bcc19 100644 (file)
--- a/lib/librte_eal/include/rte_eal_interrupts.h
+++ b/lib/librte_eal/include/rte_eal_interrupts.h
@@ -59,7 +59,7 @@ enum {
 
 /** interrupt epoll event obj, taken by epoll_event.ptr */
 struct rte_epoll_event {
-       volatile uint32_t status;  /**< OUT: event status */
+       uint32_t status;           /**< OUT: event status */
        int fd;                    /**< OUT: event fd */
        int epfd;       /**< OUT: epoll instance the ev associated with */
        struct rte_epoll_data epdata;
@@ -69,10 +69,18 @@ struct rte_epoll_event {
 struct rte_intr_handle {
        RTE_STD_C11
        union {
-               int vfio_dev_fd;  /**< VFIO device file descriptor */
-               int uio_cfg_fd;  /**< UIO cfg file desc for uio_pci_generic */
+               struct {
+                       RTE_STD_C11
+                       union {
+                               /** VFIO device file descriptor */
+                               int vfio_dev_fd;
+                               /** UIO cfg file desc for uio_pci_generic */
+                               int uio_cfg_fd;
+                       };
+                       int fd; /**< interrupt event file descriptor */
+               };
+               void *handle; /**< device driver handle (Windows) */
        };
-       int fd;  /**< interrupt event file descriptor */
        enum rte_intr_handle_type type;  /**< handle type */
        uint32_t max_intr;             /**< max interrupt requested */
        uint32_t nb_efd;               /**< number of available efd(event fd) */
@@ -87,6 +95,7 @@ struct rte_intr_handle {
 
 /**
  * It waits for events on the epoll instance.
+ * Retries if signal received.
  *
  * @param epfd
  *   Epoll instance fd on which the caller wait for events.
@@ -105,6 +114,28 @@ int
 rte_epoll_wait(int epfd, struct rte_epoll_event *events,
               int maxevents, int timeout);
 
+/**
+ * It waits for events on the epoll instance.
+ * Does not retry if signal received.
+ *
+ * @param epfd
+ *   Epoll instance fd on which the caller wait for events.
+ * @param events
+ *   Memory area contains the events that will be available for the caller.
+ * @param maxevents
+ *   Up to maxevents are returned, must greater than zero.
+ * @param timeout
+ *   Specifying a timeout of -1 causes a block indefinitely.
+ *   Specifying a timeout equal to zero cause to return immediately.
+ * @return
+ *   - On success, returns the number of available event.
+ *   - On failure, a negative value.
+ */
+__rte_experimental
+int
+rte_epoll_wait_interruptible(int epfd, struct rte_epoll_event *events,
+              int maxevents, int timeout);
+
 /**
  * It performs control operations on epoll instance referred by the epfd.
  * It requests that the operation op be performed for the target fd.