path: root/spec/rtems/intr/if/is-in-progress.yml

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Checks if an ISR is in progress on the current processor.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default: ${/score/isr/if/is-in-progress:/name}()
  variants: []
description: |
  This directive returns ``true``, if the current processor is currently
  servicing an interrupt, and ``false`` otherwise.  A return value of ``true``
  indicates that the caller is an interrupt service routine, **not** a task.
  The directives available to an interrupt service routine are restricted.
enabled-by: true
index-entries:
- is interrupt in progress
interface-type: macro
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-not-pre-qualified
- role: constraint
  uid: /constraint/directive-ctx-any
- role: constraint
  uid: /constraint/directive-no-preempt
name: rtems_interrupt_is_in_progress
notes: null
params: []
return:
  return: |
    Returns true, if the current processor is currently servicing an interrupt,
    otherwise false.
  return-values: []
type: interface