summaryrefslogtreecommitdiffstats
path: root/spec/rtems/intr/if/is-in-progress.yml
blob: 80fbffe63c9c5a87ea5c38a41f459fb51627c12d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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 & Co. KG
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default:
    attributes: null
    body: ${/score/isr/if/is-in-progress:/name}()
    params: []
    return: ${/c/if/bool:/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