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