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