xilinx_irq.c File Reference

Implementation of Xilinx IRQ Generic Driver. More...

#include <xparameters.h>
#include <stdlib.h>
#include "no_os_error.h"
#include "no_os_irq.h"
#include "no_os_alloc.h"
#include "xilinx_irq.h"

Include dependency graph for xilinx_irq.c:

Functions
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. More...
int32_t	xil_irq_global_enable (struct no_os_irq_ctrl_desc *desc)
	Enable global interrupts. More...
int32_t	xil_irq_global_disable (struct no_os_irq_ctrl_desc *desc)
	Disable global interrupts. More...
int32_t	xil_irq_enable (struct no_os_irq_ctrl_desc *desc, uint32_t irq_id)
	Enable specific interrupt. More...
int32_t	xil_irq_disable (struct no_os_irq_ctrl_desc *desc, uint32_t irq_id)
	Disable specific interrupt. More...
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. More...
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. More...
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. More...
int32_t	xil_irq_ctrl_remove (struct no_os_irq_ctrl_desc *desc)
	Free the resources allocated by no_os_irq_ctrl_init(). More...

Variables
const struct no_os_irq_platform_ops	xil_irq_ops
	Xilinx platform specific IRQ platform ops structure. More...

Detailed Description

Implementation of Xilinx IRQ Generic Driver.

Author

Cristian Pop (crist.nosp@m.ian..nosp@m.pop@a.nosp@m.nalo.nosp@m.g.com)

Copyright 2019(c) Analog Devices, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

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.

Parameters

desc	- The IRQ controller descriptor.
param	- The structure that contains the IRQ parameters.

Returns

0 in case of success, -1 otherwise.

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().

Parameters

desc	- The IRQ control descriptor.

Returns

0 in case of success, -1 otherwise.

xil_irq_disable()

int32_t xil_irq_disable	(	struct no_os_irq_ctrl_desc *	desc,
		uint32_t	irq_id
	)

Disable specific interrupt.

Parameters

desc	- The IRQ controller descriptor.
irq_id	- Interrupt identifier.

Returns

0 in case of success, -1 otherwise.

xil_irq_enable()

int32_t xil_irq_enable	(	struct no_os_irq_ctrl_desc *	desc,
		uint32_t	irq_id
	)

Enable specific interrupt.

Parameters

desc	- The IRQ controller descriptor.
irq_id	- Interrupt identifier.

Returns

0 in case of success, -1 otherwise.

xil_irq_global_disable()

int32_t xil_irq_global_disable

(

struct no_os_irq_ctrl_desc *

desc

)

Disable global interrupts.

Returns

0 in case of success, -1 otherwise.

xil_irq_global_enable()

int32_t xil_irq_global_enable

(

struct no_os_irq_ctrl_desc *

desc

)

Enable global interrupts.

Returns

0 in case of success, -1 otherwise.

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.

Parameters

desc	- The IRQ controller descriptor.
irq_id	- Interrupt identifier.
callback_desc	- Callback descriptor

Returns

0 in case of success, -1 otherwise.

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.

Parameters

desc	- The IRQ controller descriptor.
irq_id	- Interrupt identifier.
trig	- New trigger level for the interrupt.

Returns

0 in case of success, -1 otherwise.

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.

Parameters

desc	- The IRQ controller descriptor.
irq_id	- Interrupt identifier.
cb	- Callback descriptor.

Returns

0 in case of success, -1 otherwise.

Variable Documentation

xil_irq_ops

const struct no_os_irq_platform_ops xil_irq_ops

Initial value:

= {
    .init = &xil_irq_ctrl_init,
    .register_callback = &xil_irq_register_callback,
    .unregister_callback = &xil_irq_unregister_callback,
    .global_enable = &xil_irq_global_enable,
    .global_disable = &xil_irq_global_disable,
    .trigger_level_set = &xil_irq_trigger_level_set,
    .enable = &xil_irq_enable,
    .disable = &xil_irq_disable,
    .remove = &xil_irq_ctrl_remove
}

Xilinx platform specific IRQ platform ops structure.

Xilinx specific IRQ platform ops structure.