Header file of IRQ interface. More...

#include <stdint.h>

Include dependency graph for irq.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	irq_init_param
	Structure holding the initial parameters for Interrupt Request. More...

struct	irq_ctrl_desc

struct	callback_desc
	Structure describing a callback to be registered. More...

struct	irq_platform_ops
	Structure holding IRQ function pointers that point to the platform specific function. More...

Enumerations
enum	irq_uart_event_e { IRQ_WRITE_DONE, IRQ_READ_DONE, IRQ_ERROR }
	Possible events for uart interrupt. More...

enum	irq_trig_level { IRQ_LEVEL_LOW, IRQ_LEVEL_HIGH, IRQ_EDGE_FALLING, IRQ_EDGE_RISING, IRQ_EDGE_BOTH }

Functions
int32_t	irq_ctrl_init (struct irq_ctrl_desc *desc, const struct irq_init_param param)
	Initialize the IRQ interrupts. More...

int32_t	irq_ctrl_remove (struct irq_ctrl_desc *desc)
	Free the resources allocated by irq_ctrl_init(). More...

int32_t	irq_register_callback (struct irq_ctrl_desc desc, uint32_t irq_id, struct callback_desc callback_desc)
	Register a callback to handle the irq events. More...

int32_t	irq_unregister (struct irq_ctrl_desc *desc, uint32_t irq_id)
	Unregisters a generic IRQ handling function. More...

int32_t	irq_global_enable (struct irq_ctrl_desc *desc)
	Enable global interrupts. More...

int32_t	irq_global_disable (struct irq_ctrl_desc *desc)
	Disable global interrupts. More...

int32_t	irq_trigger_level_set (struct irq_ctrl_desc *desc, uint32_t irq_id, enum irq_trig_level trig)
	Set interrupt trigger level. More...

int32_t	irq_enable (struct irq_ctrl_desc *desc, uint32_t irq_id)
	Enable specific interrupt. More...

int32_t	irq_disable (struct irq_ctrl_desc *desc, uint32_t irq_id)
	Disable specific interrupt. More...

Detailed Description

Header file of IRQ interface.

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

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

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.
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.
The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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.

Enumeration Type Documentation

◆ irq_trig_level

enum irq_trig_level

Enumerator
IRQ_LEVEL_LOW
IRQ_LEVEL_HIGH
IRQ_EDGE_FALLING
IRQ_EDGE_RISING
IRQ_EDGE_BOTH

◆ irq_uart_event_e

enum irq_uart_event_e

Possible events for uart interrupt.

Enumerator
IRQ_WRITE_DONE	Write operation finalized
IRQ_READ_DONE	Read operation finalized
IRQ_ERROR	An error occurred

Function Documentation

◆ irq_ctrl_init()

int32_t irq_ctrl_init	(	struct irq_ctrl_desc **	desc,
		const struct irq_init_param *	param
	)

Initialize the IRQ interrupts.

Parameters

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

Returns: SUCCESS in case of success, FAILURE otherwise.

Here is the caller graph for this function:

◆ irq_ctrl_remove()

int32_t irq_ctrl_remove ( struct irq_ctrl_desc * desc )

Free the resources allocated by irq_ctrl_init().

Parameters

desc	- The SPI descriptor.

Returns: SUCCESS in case of success, FAILURE otherwise.

Here is the caller graph for this function:

◆ irq_disable()

int32_t irq_disable	(	struct irq_ctrl_desc *	desc,
		uint32_t	irq_id
	)

Disable specific interrupt.

Parameters

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

Returns: SUCCESS in case of success, FAILURE otherwise.

◆ irq_enable()

int32_t irq_enable	(	struct irq_ctrl_desc *	desc,
		uint32_t	irq_id
	)

Enable specific interrupt.

Parameters

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

Returns: SUCCESS in case of success, FAILURE otherwise.

◆ irq_global_disable()

int32_t irq_global_disable ( struct irq_ctrl_desc * desc )

Disable global interrupts.

Returns: SUCCESS in case of success, FAILURE otherwise.

Here is the caller graph for this function:

◆ irq_global_enable()

int32_t irq_global_enable ( struct irq_ctrl_desc * desc )

Enable global interrupts.

Returns: SUCCESS in case of success, FAILURE otherwise.

Here is the caller graph for this function:

◆ irq_register_callback()

int32_t irq_register_callback	(	struct irq_ctrl_desc *	desc,
		uint32_t	irq_id,
		struct 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: SUCCESS in case of success, FAILURE otherwise.

◆ irq_trigger_level_set()

int32_t irq_trigger_level_set	(	struct irq_ctrl_desc *	desc,
		uint32_t	irq_id,
		enum 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: SUCCESS in case of success, FAILURE otherwise.

◆ irq_unregister()

int32_t irq_unregister	(	struct irq_ctrl_desc *	desc,
		uint32_t	irq_id
	)

Unregisters a generic IRQ handling function.

Parameters

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

Returns: SUCCESS in case of success, FAILURE otherwise.

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ irq_trig_level

◆ irq_uart_event_e

Function Documentation

◆ irq_ctrl_init()

◆ irq_ctrl_remove()

◆ irq_disable()

◆ irq_enable()

◆ irq_global_disable()

◆ irq_global_enable()

◆ irq_register_callback()

◆ irq_trigger_level_set()

◆ irq_unregister()