lib/librte_eal/bsdapp/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_BSDAPP_INTERRUPTS_H_
  39 #define _RTE_BSDAPP_INTERRUPTS_H_
  40
  41 enum rte_intr_handle_type {
  42         RTE_INTR_HANDLE_UNKNOWN = 0,
  43         RTE_INTR_HANDLE_UIO,      /**< uio device handle */
  44         RTE_INTR_HANDLE_ALARM,    /**< alarm handle */
  45         RTE_INTR_HANDLE_MAX
  46 };
  47
  48 /** Handle for interrupts. */
  49 struct rte_intr_handle {
  50         int fd;                          /**< file descriptor */
  51         int uio_cfg_fd;                  /**< UIO config file descriptor */
  52         enum rte_intr_handle_type type;  /**< handle type */
  53         int max_intr;                    /**< max interrupt requested */
  54         uint32_t nb_efd;                 /**< number of available efds */
  55         int *intr_vec;                   /**< intr vector number array */
  56 };
  57
  58 /**
  59  * @param intr_handle
  60  *   Pointer to the interrupt handle.
  61  * @param epfd
  62  *   Epoll instance fd which the intr vector associated to.
  63  * @param op
  64  *   The operation be performed for the vector.
  65  *   Operation type of {ADD, DEL}.
  66  * @param vec
  67  *   RX intr vector number added to the epoll instance wait list.
  68  * @param data
  69  *   User raw data.
  70  * @return
  71  *   - On success, zero.
  72  *   - On failure, a negative value.
  73  */
  74 int
  75 rte_intr_rx_ctl(struct rte_intr_handle *intr_handle,
  76                 int epfd, int op, unsigned int vec, void *data);
  77
  78 /**
  79  * It enables the fastpath event fds if it's necessary.
  80  * It creates event fds when multi-vectors allowed,
  81  * otherwise it multiplexes the single event fds.
  82  *
  83  * @param intr_handle
  84  *   Pointer to the interrupt handle.
  85  * @param nb_vec
  86  *   Number of interrupt vector trying to enable.
  87  * @return
  88  *   - On success, zero.
  89  *   - On failure, a negative value.
  90  */
  91 int
  92 rte_intr_efd_enable(struct rte_intr_handle *intr_handle, uint32_t nb_efd);
  93
  94 /**
  95  * It disable the fastpath event fds.
  96  * It deletes registered eventfds and closes the open fds.
  97  *
  98  * @param intr_handle
  99  *   Pointer to the interrupt handle.
 100  */
 101 void
 102 rte_intr_efd_disable(struct rte_intr_handle *intr_handle);
 103
 104 /**
 105  * The fastpath interrupt is enabled or not.
 106  *
 107  * @param intr_handle
 108  *   Pointer to the interrupt handle.
 109  */
 110 int rte_intr_dp_is_en(struct rte_intr_handle *intr_handle);
 111
 112 /**
 113  * The interrupt handle instance allows other cause or not.
 114  * Other cause stands for none fastpath interrupt.
 115  *
 116  * @param intr_handle
 117  *   Pointer to the interrupt handle.
 118  */
 119 int rte_intr_allow_others(struct rte_intr_handle *intr_handle);
 120
 121 #endif /* _RTE_BSDAPP_INTERRUPTS_H_ */