irq-generic.h

Go to the documentation of this file.

/*
 * Based on concepts of Pavel Pisa, Till Straumann and Eric Valette.
 *
 * Copyright (c) 2008, 2017 embedded brains GmbH.
 *
 *  embedded brains GmbH
 *  Dornierstr. 4
 *  82178 Puchheim
 *  Germany
 *  <rtems@embedded-brains.de>
 *
 * Copyright (c) 2016 Chris Johns <chrisj@rtems.org>
 *
 * The license and distribution terms for this file may be
 * found in the file LICENSE in this distribution or at
 * http://www.rtems.org/license/LICENSE.
 */

#ifndef LIBBSP_SHARED_IRQ_GENERIC_H
#define LIBBSP_SHARED_IRQ_GENERIC_H

#include <stdbool.h>

#include <rtems/irq-extension.h>
#include <rtems/score/assert.h>

#ifdef RTEMS_SMP
  #include <rtems/score/atomic.h>
#endif

#include <bsp/irq.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#if !defined(BSP_INTERRUPT_VECTOR_MIN) || !defined(BSP_INTERRUPT_VECTOR_MAX) || (BSP_INTERRUPT_VECTOR_MAX + 1) < BSP_INTERRUPT_VECTOR_MIN
  #error "invalid BSP_INTERRUPT_VECTOR_MIN or BSP_INTERRUPT_VECTOR_MAX"
#endif

#if defined(BSP_INTERRUPT_USE_INDEX_TABLE) && !defined(BSP_INTERRUPT_HANDLER_TABLE_SIZE)
  #error "if you define BSP_INTERRUPT_USE_INDEX_TABLE, you have to define BSP_INTERRUPT_HANDLER_TABLE_SIZE etc. as well"
#endif

#if defined(BSP_INTERRUPT_NO_HEAP_USAGE) && !defined(BSP_INTERRUPT_USE_INDEX_TABLE)
  #error "if you define BSP_INTERRUPT_NO_HEAP_USAGE, you have to define BSP_INTERRUPT_USE_INDEX_TABLE etc. as well"
#endif

#define BSP_INTERRUPT_VECTOR_NUMBER \
  (BSP_INTERRUPT_VECTOR_MAX - BSP_INTERRUPT_VECTOR_MIN + 1)

#ifndef BSP_INTERRUPT_HANDLER_TABLE_SIZE
  #define BSP_INTERRUPT_HANDLER_TABLE_SIZE BSP_INTERRUPT_VECTOR_NUMBER
#endif

/* Internal macros for SMP support, do not use externally */
#ifdef RTEMS_SMP
  #define bsp_interrupt_disable(level) do { (void) level; } while (0)
  #define bsp_interrupt_enable(level) do { } while (0)
  #define bsp_interrupt_fence(order) _Atomic_Fence(order)
#else
  #define bsp_interrupt_disable(level) rtems_interrupt_disable(level)
  #define bsp_interrupt_enable(level) rtems_interrupt_enable(level)
  #define bsp_interrupt_fence(order) do { } while (0)
#endif

#define bsp_interrupt_assert(e) _Assert(e)

struct bsp_interrupt_handler_entry {
  rtems_interrupt_handler handler;
  void *arg;
  const char *info;
  struct bsp_interrupt_handler_entry *next;
};

typedef struct bsp_interrupt_handler_entry bsp_interrupt_handler_entry;

extern bsp_interrupt_handler_entry bsp_interrupt_handler_table [];

#ifdef BSP_INTERRUPT_USE_INDEX_TABLE
  #if BSP_INTERRUPT_HANDLER_TABLE_SIZE < 0x100
    typedef uint8_t bsp_interrupt_handler_index_type;
  #elif BSP_INTERRUPT_HANDLER_TABLE_SIZE < 0x10000
    typedef uint16_t bsp_interrupt_handler_index_type;
  #else
    typedef uint32_t bsp_interrupt_handler_index_type;
  #endif
  extern bsp_interrupt_handler_index_type bsp_interrupt_handler_index_table [];
#endif

static inline rtems_vector_number bsp_interrupt_handler_index(
  rtems_vector_number vector
)
{
  #ifdef BSP_INTERRUPT_USE_INDEX_TABLE
    return bsp_interrupt_handler_index_table [vector - BSP_INTERRUPT_VECTOR_MIN];
  #else
    return vector - BSP_INTERRUPT_VECTOR_MIN;
  #endif
}

#ifdef BSP_INTERRUPT_CUSTOM_VALID_VECTOR
  bool bsp_interrupt_is_valid_vector(rtems_vector_number vector);
#else

  static inline bool bsp_interrupt_is_valid_vector(rtems_vector_number vector)
  {
    return (rtems_vector_number) BSP_INTERRUPT_VECTOR_MIN <= vector
      && vector <= (rtems_vector_number) BSP_INTERRUPT_VECTOR_MAX;
  }
#endif

void bsp_interrupt_handler_default(rtems_vector_number vector);

void bsp_interrupt_initialize(void);

rtems_status_code bsp_interrupt_facility_initialize(void);

void bsp_interrupt_vector_enable(rtems_vector_number vector);

void bsp_interrupt_vector_disable(rtems_vector_number vector);

static inline void bsp_interrupt_handler_dispatch(rtems_vector_number vector)
{
  if (bsp_interrupt_is_valid_vector(vector)) {
    const bsp_interrupt_handler_entry *e =
      &bsp_interrupt_handler_table [bsp_interrupt_handler_index(vector)];

    do {
      rtems_interrupt_handler handler;
      void *arg;

      arg = e->arg;
      bsp_interrupt_fence(ATOMIC_ORDER_ACQUIRE);
      handler = e->handler;
      (*handler)(arg);

      e = e->next;
    } while (e != NULL);
  } else {
    bsp_interrupt_handler_default(vector);
  }
}

bool bsp_interrupt_handler_is_empty(rtems_vector_number vector);

/* For internal use only */
void bsp_interrupt_lock(void);

/* For internal use only */
void bsp_interrupt_unlock(void);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* LIBBSP_SHARED_IRQ_GENERIC_H */