intr.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (C) 2008, 2024 embedded brains GmbH & Co. KG
 * Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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.
 */
 
/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */
 
/* Generated from spec:/rtems/intr/if/header */
 
#ifndef _RTEMS_RTEMS_INTR_H
#define _RTEMS_RTEMS_INTR_H
 
#include <stddef.h>
#include <stdint.h>
#include <sys/cpuset.h>
#include <rtems/rtems/attr.h>
#include <rtems/rtems/modes.h>
#include <rtems/rtems/options.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
#include <rtems/score/basedefs.h>
#include <rtems/score/chain.h>
#include <rtems/score/cpu.h>
#include <rtems/score/cpuopts.h>
#include <rtems/score/isr.h>
#include <rtems/score/isrlevel.h>
#include <rtems/score/isrlock.h>
#include <rtems/score/smplock.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Generated from spec:/rtems/intr/if/group */
 
/* Generated from spec:/rtems/intr/if/vector-number */
 
typedef ISR_Vector_number rtems_vector_number;
 
/* Generated from spec:/rtems/intr/if/level */
 
typedef ISR_Level rtems_interrupt_level;
 
/* Generated from spec:/rtems/intr/if/isr */
 
typedef ISR_Handler rtems_isr;
 
/* Generated from spec:/rtems/intr/if/isr-entry */
 
#if CPU_SIMPLE_VECTORED_INTERRUPTS == TRUE
  typedef ISR_Handler_entry rtems_isr_entry;
#else
  typedef void ( *rtems_isr_entry )( void * );
#endif
 
/* Generated from spec:/rtems/intr/if/catch */
 
rtems_status_code rtems_interrupt_catch(
  rtems_isr_entry     new_isr_handler,
  rtems_vector_number vector,
  rtems_isr_entry    *old_isr_handler
);
 
#if !defined(RTEMS_SMP)
  /* Generated from spec:/rtems/intr/if/disable */
 
  #define rtems_interrupt_disable( _isr_cookie ) _ISR_Local_disable( _isr_cookie )
#endif
 
#if !defined(RTEMS_SMP)
  /* Generated from spec:/rtems/intr/if/enable */
 
  #define rtems_interrupt_enable( _isr_cookie ) _ISR_Local_enable( _isr_cookie )
#endif
 
#if !defined(RTEMS_SMP)
  /* Generated from spec:/rtems/intr/if/flash */
 
  #define rtems_interrupt_flash( _isr_cookie ) _ISR_Local_flash( _isr_cookie )
#endif
 
/* Generated from spec:/rtems/intr/if/local-disable */
 
#define rtems_interrupt_local_disable( _isr_cookie ) \
  _ISR_Local_disable( _isr_cookie )
 
/* Generated from spec:/rtems/intr/if/local-enable */
 
#define rtems_interrupt_local_enable( _isr_cookie ) \
  _ISR_Local_enable( _isr_cookie )
 
/* Generated from spec:/rtems/intr/if/is-in-progress */
 
#define rtems_interrupt_is_in_progress() _ISR_Is_in_progress()
 
/* Generated from spec:/rtems/intr/if/lock */
 
#if ISR_LOCK_NEEDS_OBJECT
  typedef ISR_lock_Control rtems_interrupt_lock;
#else
  typedef char rtems_interrupt_lock;
#endif
 
/* Generated from spec:/rtems/intr/if/lock-needs-object */
 
#define RTEMS_INTERRUPT_LOCK_NEEDS_OBJECT ISR_LOCK_NEEDS_OBJECT
 
/* Generated from spec:/rtems/intr/if/lock-context */
 
typedef ISR_lock_Context rtems_interrupt_lock_context;
 
/* Generated from spec:/rtems/intr/if/lock-initialize */
 
#define rtems_interrupt_lock_initialize( _lock, _name ) \
  _ISR_lock_Initialize( _lock, _name )
 
/* Generated from spec:/rtems/intr/if/lock-destroy */
 
#define rtems_interrupt_lock_destroy( _lock ) _ISR_lock_Destroy( _lock )
 
/* Generated from spec:/rtems/intr/if/lock-acquire */
 
#define rtems_interrupt_lock_acquire( _lock, _lock_context ) \
  _ISR_lock_ISR_disable_and_acquire( _lock, _lock_context )
 
/* Generated from spec:/rtems/intr/if/lock-release */
 
#define rtems_interrupt_lock_release( _lock, _lock_context ) \
  _ISR_lock_Release_and_ISR_enable( _lock, _lock_context )
 
/* Generated from spec:/rtems/intr/if/lock-acquire-isr */
 
#if ISR_LOCK_NEEDS_OBJECT
  #define rtems_interrupt_lock_acquire_isr( _lock, _lock_context ) \
    _SMP_lock_Acquire( \
      &( _lock )->Lock, \
      &( _lock_context )->Lock_context \
    )
#else
  #define rtems_interrupt_lock_acquire_isr( _lock, _lock_context ) \
    do { (void) _lock_context; } while ( 0 )
#endif
 
/* Generated from spec:/rtems/intr/if/lock-release-isr */
 
#if ISR_LOCK_NEEDS_OBJECT
  #define rtems_interrupt_lock_release_isr( _lock, _lock_context ) \
    _SMP_lock_Release( \
      &( _lock )->Lock, \
      &( _lock_context )->Lock_context \
    )
#else
  #define rtems_interrupt_lock_release_isr( _lock, _lock_context ) \
    do { (void) _lock_context; } while ( 0 )
#endif
 
/* Generated from spec:/rtems/intr/if/lock-isr-disable */
 
#define rtems_interrupt_lock_interrupt_disable( _lock_context ) \
  _ISR_lock_ISR_disable( _lock_context )
 
/* Generated from spec:/rtems/intr/if/lock-declare */
 
#if ISR_LOCK_NEEDS_OBJECT
  #define RTEMS_INTERRUPT_LOCK_DECLARE( _specifier, _designator ) \
    _specifier rtems_interrupt_lock _designator;
#else
  #define RTEMS_INTERRUPT_LOCK_DECLARE( _specifier, _designator )
#endif
 
/* Generated from spec:/rtems/intr/if/lock-define */
 
#if ISR_LOCK_NEEDS_OBJECT
  #define RTEMS_INTERRUPT_LOCK_DEFINE( _specifier, _designator, _name ) \
    _specifier rtems_interrupt_lock _designator = ISR_LOCK_INITIALIZER( _name );
#else
  #define RTEMS_INTERRUPT_LOCK_DEFINE( _specifier, _designator, _name )
#endif
 
/* Generated from spec:/rtems/intr/if/lock-initializer */
 
#if ISR_LOCK_NEEDS_OBJECT
  #define RTEMS_INTERRUPT_LOCK_INITIALIZER( _name ) ISR_LOCK_INITIALIZER( _name )
#else
  #define RTEMS_INTERRUPT_LOCK_INITIALIZER( _name ) 0
#endif
 
/* Generated from spec:/rtems/intr/if/lock-member */
 
#if ISR_LOCK_NEEDS_OBJECT
  #define RTEMS_INTERRUPT_LOCK_MEMBER( _designator ) \
    rtems_interrupt_lock _designator;
#else
  #define RTEMS_INTERRUPT_LOCK_MEMBER( _designator )
#endif
 
/* Generated from spec:/rtems/intr/if/lock-reference */
 
#if ISR_LOCK_NEEDS_OBJECT
  #define RTEMS_INTERRUPT_LOCK_REFERENCE( _designator, _target ) \
    rtems_interrupt_lock *_designator = _target;
#else
  #define RTEMS_INTERRUPT_LOCK_REFERENCE( _designator, _target )
#endif
 
/* Generated from spec:/rtems/intr/if/shared */
 
#define RTEMS_INTERRUPT_SHARED ( (rtems_option) 0x00000000 )
 
/* Generated from spec:/rtems/intr/if/unique */
 
#define RTEMS_INTERRUPT_UNIQUE ( (rtems_option) 0x00000001 )
 
/* Generated from spec:/rtems/intr/if/replace */
 
#define RTEMS_INTERRUPT_REPLACE ( (rtems_option) 0x00000002 )
 
/* Generated from spec:/rtems/intr/if/is-shared */
 
#define RTEMS_INTERRUPT_IS_SHARED( _options ) \
  ( ( _options ) & RTEMS_INTERRUPT_SHARED )
 
/* Generated from spec:/rtems/intr/if/is-unique */
 
#define RTEMS_INTERRUPT_IS_UNIQUE( _options ) \
  ( ( _options ) & RTEMS_INTERRUPT_UNIQUE )
 
/* Generated from spec:/rtems/intr/if/is-replace */
 
#define RTEMS_INTERRUPT_IS_REPLACE( _options ) \
  ( ( _options ) & RTEMS_INTERRUPT_REPLACE )
 
/* Generated from spec:/rtems/intr/if/handler */
 
typedef void ( *rtems_interrupt_handler )( void * );
 
/* Generated from spec:/rtems/intr/if/per-handler-routine */
 
typedef void ( *rtems_interrupt_per_handler_routine )(
  void *,
  const char *,
  rtems_option,
  rtems_interrupt_handler,
  void *
);
 
/* Generated from spec:/rtems/intr/if/entry */
 
typedef struct rtems_interrupt_entry {
  rtems_interrupt_handler handler;
 
  void *arg;
 
  struct rtems_interrupt_entry *next;
 
  const char *info;
} rtems_interrupt_entry;
 
/* Generated from spec:/rtems/intr/if/entry-initializer */
 
#define RTEMS_INTERRUPT_ENTRY_INITIALIZER( _routine, _arg, _info ) \
  { _routine, _arg, NULL, _info }
 
/* Generated from spec:/rtems/intr/if/entry-initialize */
 
static inline void rtems_interrupt_entry_initialize(
  rtems_interrupt_entry  *entry,
  rtems_interrupt_handler routine,
  void                   *arg,
  const char             *info
)
{
  entry->handler = routine;
  entry->arg = arg;
  entry->next = NULL;
  entry->info = info;
}
 
/* Generated from spec:/rtems/intr/if/entry-install */
 
rtems_status_code rtems_interrupt_entry_install(
  rtems_vector_number    vector,
  rtems_option           options,
  rtems_interrupt_entry *entry
);
 
/* Generated from spec:/rtems/intr/if/entry-remove */
 
rtems_status_code rtems_interrupt_entry_remove(
  rtems_vector_number    vector,
  rtems_interrupt_entry *entry
);
 
/* Generated from spec:/rtems/intr/if/handler-install */
 
rtems_status_code rtems_interrupt_handler_install(
  rtems_vector_number     vector,
  const char             *info,
  rtems_option            options,
  rtems_interrupt_handler routine,
  void                   *arg
);
 
/* Generated from spec:/rtems/intr/if/handler-remove */
 
rtems_status_code rtems_interrupt_handler_remove(
  rtems_vector_number     vector,
  rtems_interrupt_handler routine,
  void                   *arg
);
 
/* Generated from spec:/rtems/intr/if/vector-is-enabled */
 
rtems_status_code rtems_interrupt_vector_is_enabled(
  rtems_vector_number vector,
  bool               *enabled
);
 
/* Generated from spec:/rtems/intr/if/vector-enable */
 
rtems_status_code rtems_interrupt_vector_enable( rtems_vector_number vector );
 
/* Generated from spec:/rtems/intr/if/vector-disable */
 
rtems_status_code rtems_interrupt_vector_disable( rtems_vector_number vector );
 
/* Generated from spec:/rtems/intr/if/is-pending */
 
rtems_status_code rtems_interrupt_is_pending(
  rtems_vector_number vector,
  bool               *pending
);
 
/* Generated from spec:/rtems/intr/if/raise */
 
rtems_status_code rtems_interrupt_raise( rtems_vector_number vector );
 
/* Generated from spec:/rtems/intr/if/raise-on */
 
rtems_status_code rtems_interrupt_raise_on(
  rtems_vector_number vector,
  uint32_t            cpu_index
);
 
/* Generated from spec:/rtems/intr/if/clear */
 
rtems_status_code rtems_interrupt_clear( rtems_vector_number vector );
 
/* Generated from spec:/rtems/intr/if/get-priority */
 
rtems_status_code rtems_interrupt_get_priority(
  rtems_vector_number vector,
  uint32_t           *priority
);
 
/* Generated from spec:/rtems/intr/if/set-priority */
 
rtems_status_code rtems_interrupt_set_priority(
  rtems_vector_number vector,
  uint32_t            priority
);
 
/* Generated from spec:/rtems/intr/if/get-affinity */
 
rtems_status_code rtems_interrupt_get_affinity(
  rtems_vector_number vector,
  size_t              affinity_size,
  cpu_set_t          *affinity
);
 
/* Generated from spec:/rtems/intr/if/set-affinity */
 
rtems_status_code rtems_interrupt_set_affinity(
  rtems_vector_number vector,
  size_t              affinity_size,
  const cpu_set_t    *affinity
);
 
/* Generated from spec:/rtems/intr/if/signal-variant */
 
typedef enum {
  RTEMS_INTERRUPT_UNSPECIFIED_SIGNAL,
 
  RTEMS_INTERRUPT_NO_SIGNAL,
 
  RTEMS_INTERRUPT_SIGNAL_LEVEL_LOW,
 
  RTEMS_INTERRUPT_SIGNAL_LEVEL_HIGH,
 
  RTEMS_INTERRUPT_SIGNAL_EDGE_FALLING,
 
  RTEMS_INTERRUPT_SIGNAL_EDGE_RAISING
} rtems_interrupt_signal_variant;
 
/* Generated from spec:/rtems/intr/if/attributes */
 
typedef struct {
  bool is_maskable;
 
  bool can_enable;
 
  bool maybe_enable;
 
  bool can_disable;
 
  bool maybe_disable;
 
  bool can_raise;
 
  bool can_raise_on;
 
  bool can_clear;
 
  bool cleared_by_acknowledge;
 
  bool can_get_affinity;
 
  bool can_set_affinity;
 
  bool can_be_triggered_by_message;
 
  rtems_interrupt_signal_variant trigger_signal;
 
  bool can_get_priority;
 
  bool can_set_priority;
 
  uint32_t maximum_priority;
} rtems_interrupt_attributes;
 
/* Generated from spec:/rtems/intr/if/get-attributes */
 
rtems_status_code rtems_interrupt_get_attributes(
  rtems_vector_number         vector,
  rtems_interrupt_attributes *attributes
);
 
/* Generated from spec:/rtems/intr/if/handler-iterate */
 
rtems_status_code rtems_interrupt_handler_iterate(
  rtems_vector_number                 vector,
  rtems_interrupt_per_handler_routine routine,
  void                               *arg
);
 
/* Generated from spec:/rtems/intr/if/server-default */
 
#define RTEMS_INTERRUPT_SERVER_DEFAULT 0
 
/* Generated from spec:/rtems/intr/if/server-control */
 
typedef struct rtems_interrupt_server_control {
  #if defined(RTEMS_SMP)
    rtems_interrupt_lock lock;
  #endif
 
  Chain_Control entries;
 
  rtems_id server;
 
  unsigned long errors;
 
  uint32_t index;
 
  Chain_Node node;
 
  void ( *destroy )( struct rtems_interrupt_server_control * );
} rtems_interrupt_server_control;
 
/* Generated from spec:/rtems/intr/if/server-config */
 
typedef struct {
  rtems_name name;
 
  rtems_task_priority priority;
 
  void *storage_area;
 
  size_t storage_size;
 
  rtems_mode modes;
 
  rtems_attribute attributes;
 
  void ( *destroy )( rtems_interrupt_server_control * );
} rtems_interrupt_server_config;
 
/* Generated from spec:/rtems/intr/if/server-initialize */
 
rtems_status_code rtems_interrupt_server_initialize(
  rtems_task_priority priority,
  size_t              stack_size,
  rtems_mode          modes,
  rtems_attribute     attributes,
  uint32_t           *server_count
);
 
/* Generated from spec:/rtems/intr/if/server-create */
 
rtems_status_code rtems_interrupt_server_create(
  rtems_interrupt_server_control      *control,
  const rtems_interrupt_server_config *config,
  uint32_t                            *server_index
);
 
/* Generated from spec:/rtems/intr/if/server-handler-install */
 
rtems_status_code rtems_interrupt_server_handler_install(
  uint32_t                server_index,
  rtems_vector_number     vector,
  const char             *info,
  rtems_option            options,
  rtems_interrupt_handler routine,
  void                   *arg
);
 
/* Generated from spec:/rtems/intr/if/server-handler-remove */
 
rtems_status_code rtems_interrupt_server_handler_remove(
  uint32_t                server_index,
  rtems_vector_number     vector,
  rtems_interrupt_handler routine,
  void                   *arg
);
 
/* Generated from spec:/rtems/intr/if/server-set-affinity */
 
rtems_status_code rtems_interrupt_server_set_affinity(
  uint32_t            server_index,
  size_t              affinity_size,
  const cpu_set_t    *affinity,
  rtems_task_priority priority
);
 
/* Generated from spec:/rtems/intr/if/server-delete */
 
rtems_status_code rtems_interrupt_server_delete( uint32_t server_index );
 
/* Generated from spec:/rtems/intr/if/server-suspend */
 
rtems_status_code rtems_interrupt_server_suspend( uint32_t server_index );
 
/* Generated from spec:/rtems/intr/if/server-resume */
 
rtems_status_code rtems_interrupt_server_resume( uint32_t server_index );
 
/* Generated from spec:/rtems/intr/if/server-move */
 
rtems_status_code rtems_interrupt_server_move(
  uint32_t            source_server_index,
  rtems_vector_number vector,
  uint32_t            destination_server_index
);
 
/* Generated from spec:/rtems/intr/if/server-handler-iterate */
 
rtems_status_code rtems_interrupt_server_handler_iterate(
  uint32_t                            server_index,
  rtems_vector_number                 vector,
  rtems_interrupt_per_handler_routine routine,
  void                               *arg
);
 
/* Generated from spec:/rtems/intr/if/server-action */
 
typedef struct rtems_interrupt_server_action {
  struct rtems_interrupt_server_action *next;
 
  rtems_interrupt_handler handler;
 
  void *arg;
} rtems_interrupt_server_action;
 
/* Generated from spec:/rtems/intr/if/server-entry */
 
typedef struct {
  Chain_Node node;
 
  rtems_interrupt_server_control *server;
 
  rtems_vector_number vector;
 
  rtems_interrupt_server_action *actions;
} rtems_interrupt_server_entry;
 
/* Generated from spec:/rtems/intr/if/server-entry-initialize */
 
rtems_status_code rtems_interrupt_server_entry_initialize(
  uint32_t                      server_index,
  rtems_interrupt_server_entry *entry
);
 
/* Generated from spec:/rtems/intr/if/server-action-prepend */
 
void rtems_interrupt_server_action_prepend(
  rtems_interrupt_server_entry  *entry,
  rtems_interrupt_server_action *action,
  rtems_interrupt_handler        routine,
  void                          *arg
);
 
/* Generated from spec:/rtems/intr/if/server-entry-destroy */
 
void rtems_interrupt_server_entry_destroy(
  rtems_interrupt_server_entry *entry
);
 
/* Generated from spec:/rtems/intr/if/server-entry-submit */
 
void rtems_interrupt_server_entry_submit(
  rtems_interrupt_server_entry *entry
);
 
/* Generated from spec:/rtems/intr/if/server-entry-move */
 
rtems_status_code rtems_interrupt_server_entry_move(
  rtems_interrupt_server_entry *entry,
  uint32_t                      server_index
);
 
/* Generated from spec:/rtems/intr/if/server-request */
 
typedef struct {
  rtems_interrupt_server_entry entry;
 
  rtems_interrupt_server_action action;
} rtems_interrupt_server_request;
 
/* Generated from spec:/rtems/intr/if/server-request-initialize */
 
rtems_status_code rtems_interrupt_server_request_initialize(
  uint32_t                        server_index,
  rtems_interrupt_server_request *request,
  rtems_interrupt_handler         routine,
  void                           *arg
);
 
/* Generated from spec:/rtems/intr/if/server-request-set-vector */
 
static inline void rtems_interrupt_server_request_set_vector(
  rtems_interrupt_server_request *request,
  rtems_vector_number             vector
)
{
  request->entry.vector = vector;
}
 
/* Generated from spec:/rtems/intr/if/server-request-destroy */
 
static inline void rtems_interrupt_server_request_destroy(
  rtems_interrupt_server_request *request
)
{
  rtems_interrupt_server_entry_destroy( &request->entry );
}
 
/* Generated from spec:/rtems/intr/if/server-request-submit */
 
static inline void rtems_interrupt_server_request_submit(
  rtems_interrupt_server_request *request
)
{
  rtems_interrupt_server_entry_submit( &request->entry );
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* _RTEMS_RTEMS_INTR_H */