lib/librte_eal/common/include/rte_interrupts.h

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