4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef _RTE_INTERRUPTS_H_
35 #define _RTE_INTERRUPTS_H_
37 #include <rte_common.h>
42 * The RTE interrupt interface provides functions to register/unregister
43 * callbacks for a specific interrupt.
50 /** Interrupt handle */
51 struct rte_intr_handle;
53 /** Function to be registered for the specific interrupt */
54 typedef void (*rte_intr_callback_fn)(struct rte_intr_handle *intr_handle,
57 #include <exec-env/rte_interrupts.h>
60 * It registers the callback for the specific interrupt. Multiple
61 * callbacks cal be registered at the same time.
63 * Pointer to the interrupt handle.
67 * address of parameter for callback.
71 * - On failure, a negative value.
73 int rte_intr_callback_register(struct rte_intr_handle *intr_handle,
74 rte_intr_callback_fn cb, void *cb_arg);
77 * It unregisters the callback according to the specified interrupt handle.
80 * pointer to the interrupt handle.
84 * address of parameter for callback, (void *)-1 means to remove all
85 * registered which has the same callback address.
88 * - On success, return the number of callback entities removed.
89 * - On failure, a negative value.
91 int rte_intr_callback_unregister(struct rte_intr_handle *intr_handle,
92 rte_intr_callback_fn cb, void *cb_arg);
95 * It enables the interrupt for the specified handle.
98 * pointer to the interrupt handle.
101 * - On success, zero.
102 * - On failure, a negative value.
104 int rte_intr_enable(struct rte_intr_handle *intr_handle);
107 * It disables the interrupt for the specified handle.
110 * pointer to the interrupt handle.
113 * - On success, zero.
114 * - On failure, a negative value.
116 int rte_intr_disable(struct rte_intr_handle *intr_handle);