lib/librte_eal/common/include/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 #define _RTE_INTERRUPTS_H_
  36
  37 #include <rte_common.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 /** Interrupt handle */
  51 struct rte_intr_handle;
  52
  53 /** Function to be registered for the specific interrupt */
  54 typedef void (*rte_intr_callback_fn)(void *cb_arg);
  55
  56 #include "rte_eal_interrupts.h"
  57
  58 /**
  59  * It registers the callback for the specific interrupt. Multiple
  60  * callbacks cal be registered at the same time.
  61  * @param intr_handle
  62  *  Pointer to the interrupt handle.
  63  * @param cb
  64  *  callback address.
  65  * @param cb_arg
  66  *  address of parameter for callback.
  67  *
  68  * @return
  69  *  - On success, zero.
  70  *  - On failure, a negative value.
  71  */
  72 int rte_intr_callback_register(const struct rte_intr_handle *intr_handle,
  73                                 rte_intr_callback_fn cb, void *cb_arg);
  74
  75 /**
  76  * It unregisters the callback according to the specified interrupt handle.
  77  *
  78  * @param intr_handle
  79  *  pointer to the interrupt handle.
  80  * @param cb
  81  *  callback address.
  82  * @param cb_arg
  83  *  address of parameter for callback, (void *)-1 means to remove all
  84  *  registered which has the same callback address.
  85  *
  86  * @return
  87  *  - On success, return the number of callback entities removed.
  88  *  - On failure, a negative value.
  89  */
  90 int rte_intr_callback_unregister(const struct rte_intr_handle *intr_handle,
  91                                 rte_intr_callback_fn cb, void *cb_arg);
  92
  93 /**
  94  * It enables the interrupt for the specified handle.
  95  *
  96  * @param intr_handle
  97  *  pointer to the interrupt handle.
  98  *
  99  * @return
 100  *  - On success, zero.
 101  *  - On failure, a negative value.
 102  */
 103 int rte_intr_enable(const struct rte_intr_handle *intr_handle);
 104
 105 /**
 106  * It disables the interrupt for the specified handle.
 107  *
 108  * @param intr_handle
 109  *  pointer to the interrupt handle.
 110  *
 111  * @return
 112  *  - On success, zero.
 113  *  - On failure, a negative value.
 114  */
 115 int rte_intr_disable(const struct rte_intr_handle *intr_handle);
 116
 117 #ifdef __cplusplus
 118 }
 119 #endif
 120
 121 #endif