lib/librte_eal/common/include/rte_interrupts.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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  *  version: DPDK.L.1.2.3-3
  34  */
  35
  36 #ifndef _RTE_INTERRUPTS_H_
  37 #define _RTE_INTERRUPTS_H_
  38
  39 /**
  40  * @file
  41  *
  42  * The RTE interrupt interface provides functions to register/unregister
  43  * callbacks for a specific interrupt.
  44  */
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 /** Interupt handle */
  51 struct rte_intr_handle;
  52
  53 /** Function to be registered for the specific interrupt */
  54 typedef void (*rte_intr_callback_fn)(struct rte_intr_handle *intr_handle,
  55                                                         void *cb_arg);
  56
  57 #include <exec-env/rte_interrupts.h>
  58
  59 /**
  60  * It registers the callback for the specific interrupt. Multiple
  61  * callbacks cal be registered at the same time.
  62  * @param intr_handle
  63  *  Pointer to the interrupt handle.
  64  * @param cb
  65  *  callback address.
  66  * @param cb_arg
  67  *  address of parameter for callback.
  68  *
  69  * @return
  70  *  - On success, zero.
  71  *  - On failure, a negative value.
  72  */
  73 int rte_intr_callback_register(struct rte_intr_handle *intr_handle,
  74                                 rte_intr_callback_fn cb, void *cb_arg);
  75
  76 /**
  77  * It unregisters the callback according to the specified interrupt handle.
  78  *
  79  * @param intr_handle
  80  *  pointer to the interrupt handle.
  81  * @param cb
  82  *  callback address.
  83  * @param cb_arg
  84  *  address of parameter for callback, (void *)-1 means to remove all
  85  *  registered which has the same callback address.
  86  *
  87  * @return
  88  *  - On success, return the number of callback entities removed.
  89  *  - On failure, a negative value.
  90  */
  91 int rte_intr_callback_unregister(struct rte_intr_handle *intr_handle,
  92                                 rte_intr_callback_fn cb, void *cb_arg);
  93
  94 /**
  95  * It enables the interrupt for the specified handle.
  96  *
  97  * @param intr_handle
  98  *  pointer to the interrupt handle.
  99  *
 100  * @return
 101  *  - On success, zero.
 102  *  - On failure, a negative value.
 103  */
 104 int rte_intr_enable(struct rte_intr_handle *intr_handle);
 105
 106 /**
 107  * It disables the interrupt for the specified handle.
 108  *
 109  * @param intr_handle
 110  *  pointer to the interrupt handle.
 111  *
 112  * @return
 113  *  - On success, zero.
 114  *  - On failure, a negative value.
 115  */
 116 int rte_intr_disable(struct rte_intr_handle *intr_handle);
 117
 118 #ifdef __cplusplus
 119 }
 120 #endif
 121
 122 #endif
 123