no-OS
Classes | Macros | Enumerations | Functions | Variables
irq_extra.h File Reference

Header file of IRQ driver for ADuCM302x. More...

#include <drivers/xint/adi_xint.h>
#include <stdbool.h>
#include <stdint.h>
#include "no_os_irq.h"
Include dependency graph for irq_extra.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  aducm_irq_ctrl_desc
 Stores specific platform parameters. More...
 
struct  irq_action
 Struct used to store a (peripheral, callback) pair. More...
 

Macros

#define RTC_COUNT_INT   ADI_RTC_COUNT_INT
 
#define RTC_COUNT_ROLLOVER_INT   ADI_RTC_COUNT_ROLLOVER_INT
 

Enumerations

enum  irq_id {
  ADUCM_UART_INT_ID,
  ADUCM_RTC_INT_ID,
  ADUCM_TIMER1_INT_ID,
  NB_INTERRUPTS,
  EXTERNAL_INT_ID1,
  EXTERNAL_INT_ID2,
  EXTERNAL_INT_ID3,
  EXTERNAL_INT_ID4,
  EXTERNAL_INT_ID5,
  UART_RX_INT_ID1,
  TICKER_INT_ID,
  NB_INTERRUPTS
}
 Interrupts IDs supported by the irq driver. More...
 
enum  irq_mode {
  IRQ_RISING_EDGE = ADI_XINT_IRQ_RISING_EDGE,
  IRQ_FALLING_EDGE = ADI_XINT_IRQ_FALLING_EDGE,
  IRQ_EITHER_EDGE = ADI_XINT_IRQ_EITHER_EDGE,
  IRQ_HIGH_LEVEL = ADI_XINT_IRQ_HIGH_LEVEL,
  IRQ_LOW_LEVEL = ADI_XINT_IRQ_LOW_LEVEL
}
 Trigger condition for the external interrupt. More...
 
enum  gpio_irq_mode {
  GPIO_GROUP_NEGATIVE_EDGE,
  GPIO_GROUP_POSITIVE_EDGE
}
 Interrupt conditions for GPIO group interrupts. More...
 

Functions

int32_t irq_action_cmp (void *data1, void *data2)
 Action comparator function. More...
 

Variables

const struct no_os_irq_platform_ops aducm_irq_ops
 ADuCM3029 specific IRQ platform ops structure. More...
 

Detailed Description

Header file of IRQ driver for ADuCM302x.

Author
Mihail Chindris (mihai.nosp@m.l.ch.nosp@m.indri.nosp@m.s@an.nosp@m.alog..nosp@m.com)

Copyright 2019(c) Analog Devices, Inc.

All rights reserved.

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

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.

Macro Definition Documentation

◆ RTC_COUNT_INT

#define RTC_COUNT_INT   ADI_RTC_COUNT_INT

RTC interrupt defines

◆ RTC_COUNT_ROLLOVER_INT

#define RTC_COUNT_ROLLOVER_INT   ADI_RTC_COUNT_ROLLOVER_INT

Enumeration Type Documentation

◆ gpio_irq_mode

Interrupt conditions for GPIO group interrupts.

Enumerator
GPIO_GROUP_NEGATIVE_EDGE 

Falling edge

GPIO_GROUP_POSITIVE_EDGE 

Rising edge

◆ irq_id

enum irq_id

Interrupts IDs supported by the irq driver.

Interrupt IDs supported by the mbed irq driver.

mapped with 'irq_ctrl_id' from 'irq_init_param' structure in 'no-os/irq.h' file.

Note
Every interrupt instance should have unique interrupt ID. For instance, there are 5 interrupt IDs for external/gpio interrupts. The IDs can be mapped randomly to any of the instances as Mbed layer abstracts most of the low level MCU details such as IRQn_type, IRQn_number, etc. Example: struct irq_init_param my_ext_irq_init_param = { .irq_ctrl_id = EXTERNAL_INT_ID1 }
Enumerator
ADUCM_UART_INT_ID 

UART interrupt ID

ADUCM_RTC_INT_ID 

RTC interrupt ID

ADUCM_TIMER1_INT_ID 

TIMER1 interrupt ID

NB_INTERRUPTS 

Number of available interrupts

EXTERNAL_INT_ID1 

External interrupt ID1

EXTERNAL_INT_ID2 

External interrupt ID2

EXTERNAL_INT_ID3 

External interrupt ID3

EXTERNAL_INT_ID4 

External interrupt ID4

EXTERNAL_INT_ID5 

External interrupt ID5

UART_RX_INT_ID1 

UART Rx interrupt ID1 (Multiple instances of UART Rx IRQs are possible but only one implemented in mbed irq module)

TICKER_INT_ID 

Ticker interrupt ID (Only one instance of Ticker IRQ possible)

NB_INTERRUPTS 

◆ irq_mode

enum irq_mode

Trigger condition for the external interrupt.

Enumerator
IRQ_RISING_EDGE 

Rising edge

IRQ_FALLING_EDGE 

Falling edge

IRQ_EITHER_EDGE 

Either edge

IRQ_HIGH_LEVEL 

High level

IRQ_LOW_LEVEL 

Low level

Function Documentation

◆ irq_action_cmp()

int32_t irq_action_cmp ( void *  data1,
void *  data2 
)

Action comparator function.

Action comparator function

Parameters
data1- List element
data2- Key
Returns
0 if the two are equal, any other integer otherwise

Variable Documentation

◆ aducm_irq_ops

const struct no_os_irq_platform_ops aducm_irq_ops

ADuCM3029 specific IRQ platform ops structure.

ADuCM3029 specific IRQ platform ops structure.