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 /** Handle for interrupts. */
  55 struct rte_intr_handle {
  56         union {
  57                 int vfio_dev_fd;  /**< VFIO device file descriptor */
  58                 int uio_cfg_fd;  /**< UIO config file descriptor
  59                                         for uio_pci_generic */
  60         };
  61         int fd;  /**< interrupt event file descriptor */
  62         enum rte_intr_handle_type type;  /**< handle type */
  63 #ifdef RTE_NEXT_ABI
  64         uint32_t max_intr;             /**< max interrupt requested */
  65         uint32_t nb_efd;               /**< number of available efd(event fd) */
  66         int efds[RTE_MAX_RXTX_INTR_VEC_ID];  /**< intr vectors/efds mapping */
  67         int *intr_vec;                 /**< intr vector number array */
  68 #endif
  69 };
  70
  71 #endif /* _RTE_LINUXAPP_INTERRUPTS_H_ */