no-OS
xilinx_irq.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * @file xilinx_irq.h
3  * @brief Header containing types used in the irq driver.
4  * @author Cristian Pop (cristian.pop@analog.com)
5 ********************************************************************************
6  * Copyright 2019(c) Analog Devices, Inc.
7  *
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  * - Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * - Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  * - Neither the name of Analog Devices, Inc. nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  * - The use of this software may or may not infringe the patent rights
22  * of one or more patent holders. This license does not release you
23  * from the requirement that you obtain separate licenses from these
24  * patent holders to use this software.
25  * - Use of the software either in source or binary form, must be run
26  * on or directly connected to an Analog Devices Inc. component.
27  *
28  * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
29  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
30  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
31  * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
32  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33  * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
34  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
35  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
36  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 *******************************************************************************/
39 
40 #ifndef XILINX_IRQ_H_
41 #define XILINX_IRQ_H_
42 
43 /******************************************************************************/
44 /***************************** Include Files **********************************/
45 /******************************************************************************/
46 
47 #include <stdint.h>
48 #include "no_os_irq.h"
49 
50 /******************************************************************************/
51 /*************************** Types Declarations *******************************/
52 /******************************************************************************/
53 
63 };
64 
73 };
74 
79 struct xil_irq_desc {
83  void *instance;
84 };
85 
89 extern const struct no_os_irq_platform_ops xil_irq_ops;
90 
91 #endif
no_os_alloc.h
xil_irq_ctrl_remove
int32_t xil_irq_ctrl_remove(struct no_os_irq_ctrl_desc *desc)
Free the resources allocated by no_os_irq_ctrl_init().
Definition: xilinx_irq.c:366
no_os_callback_desc
Structure describing a callback to be registered.
Definition: no_os_irq.h:148
no_os_irq.h
Header file of IRQ interface.
xil_irq_register_callback
int32_t xil_irq_register_callback(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id, struct no_os_callback_desc *callback_desc)
Register a callback to handle the irq events.
Definition: xilinx_irq.c:245
NO_OS_IS_ERR_VALUE
#define NO_OS_IS_ERR_VALUE(x)
Definition: no_os_error.h:56
xil_irq_init_param::type
enum xil_irq_type type
Definition: xilinx_irq.h:72
xil_irq_type
xil_irq_type
Xilinx platform architecture sections.
Definition: xilinx_irq.h:58
no_os_irq_platform_ops::init
int32_t(* init)(struct no_os_irq_ctrl_desc **desc, const struct no_os_irq_init_param *param)
Definition: no_os_irq.h:168
xil_irq_desc
Xilinx platform specific IRQ descriptor.
Definition: xilinx_irq.h:79
no_os_calloc
void * no_os_calloc(size_t nitems, size_t size)
Allocate memory and return a pointer to it, set memory to 0.
Definition: chibios_alloc.c:60
no_os_irq_init_param::extra
void * extra
Definition: no_os_irq.h:122
no_os_error.h
Error codes definition.
xil_irq_desc::type
enum xil_irq_type type
Definition: xilinx_irq.h:81
xil_irq_ops
const struct no_os_irq_platform_ops xil_irq_ops
Xilinx platform specific IRQ platform ops structure.
Definition: xilinx_irq.c:379
no_os_callback_desc::ctx
void * ctx
Definition: no_os_irq.h:152
no_os_irq_trig_level
no_os_irq_trig_level
Definition: no_os_irq.h:82
no_os_irq_init_param::irq_ctrl_id
uint32_t irq_ctrl_id
Definition: no_os_irq.h:115
no_os_callback_desc::callback
void(* callback)(void *context)
Definition: no_os_irq.h:150
xil_irq_desc::instance
void * instance
Definition: xilinx_irq.h:83
xil_irq_global_disable
int32_t xil_irq_global_disable(struct no_os_irq_ctrl_desc *desc)
Disable global interrupts.
Definition: xilinx_irq.c:172
IRQ_PS
@ IRQ_PS
Definition: xilinx_irq.h:62
xilinx_irq.h
xil_irq_unregister_callback
int32_t xil_irq_unregister_callback(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id, struct no_os_callback_desc *cb)
Unregisters a generic IRQ handling function.
Definition: xilinx_irq.c:337
irq_id
irq_id
Interrupts IDs supported by the irq driver.
Definition: aducm3029_irq.h:68
xil_irq_ops
const struct no_os_irq_platform_ops xil_irq_ops
Xilinx specific IRQ platform ops structure.
Definition: xilinx_irq.c:379
no_os_free
void no_os_free(void *ptr)
Deallocate memory previously allocated by a call to no_os_calloc or no_os_malloc.
Definition: chibios_alloc.c:75
NULL
#define NULL
Definition: wrapper.h:64
no_os_irq_ctrl_desc::irq_ctrl_id
uint32_t irq_ctrl_id
Definition: no_os_irq.h:131
no_os_irq_init_param
Structure holding the initial parameters for Interrupt Request.
Definition: no_os_irq.h:113
xil_irq_disable
int32_t xil_irq_disable(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id)
Disable specific interrupt.
Definition: xilinx_irq.c:215
IRQ_PL
@ IRQ_PL
Definition: xilinx_irq.h:60
no_os_irq_platform_ops
Structure holding IRQ function pointers that point to the platform specific function.
Definition: no_os_irq.h:166
xil_irq_enable
int32_t xil_irq_enable(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id)
Enable specific interrupt.
Definition: xilinx_irq.c:186
NO_OS_IRQ_EDGE_BOTH
@ NO_OS_IRQ_EDGE_BOTH
Definition: no_os_irq.h:87
xil_irq_ctrl_init
int32_t xil_irq_ctrl_init(struct no_os_irq_ctrl_desc **desc, const struct no_os_irq_init_param *param)
Initialize the IRQ interrupts.
Definition: xilinx_irq.c:70
no_os_irq_ctrl_desc
Definition: no_os_irq.h:129
no_os_irq_ctrl_desc::extra
void * extra
Definition: no_os_irq.h:140
xil_irq_init_param
Structure holding the initialization parameters for Xilinx platform specific IRQ parameters.
Definition: xilinx_irq.h:70
xil_irq_global_enable
int32_t xil_irq_global_enable(struct no_os_irq_ctrl_desc *desc)
Enable global interrupts.
Definition: xilinx_irq.c:160
xil_irq_trigger_level_set
int32_t xil_irq_trigger_level_set(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id, enum no_os_irq_trig_level trig)
Set interrupt trigger level.
Definition: xilinx_irq.c:293