summaryrefslogtreecommitdiffstats
path: root/spec/rtems/intr/if
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-07-22 16:14:35 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-07-22 16:32:43 +0200
commitb2f87ba6c9b7661fa495d291876b4f3fa6ac4e2b (patch)
treed43aa1ebe431fd8ab46a6208acd19733944014e1 /spec/rtems/intr/if
parentspecview.py: Filter items by validated status (diff)
downloadrtems-central-b2f87ba6c9b7661fa495d291876b4f3fa6ac4e2b.tar.bz2
spec: Rename "cause" in "raise"
Diffstat (limited to 'spec/rtems/intr/if')
-rw-r--r--spec/rtems/intr/if/attributes.yml18
-rw-r--r--spec/rtems/intr/if/clear.yml2
-rw-r--r--spec/rtems/intr/if/group.yml4
-rw-r--r--spec/rtems/intr/if/is-pending.yml4
-rw-r--r--spec/rtems/intr/if/raise-on.yml (renamed from spec/rtems/intr/if/cause-on.yml)12
-rw-r--r--spec/rtems/intr/if/raise.yml (renamed from spec/rtems/intr/if/cause.yml)10
-rw-r--r--spec/rtems/intr/if/vector-enable.yml2
7 files changed, 26 insertions, 26 deletions
diff --git a/spec/rtems/intr/if/attributes.yml b/spec/rtems/intr/if/attributes.yml
index 1280a175..d14fb75c 100644
--- a/spec/rtems/intr/if/attributes.yml
+++ b/spec/rtems/intr/if/attributes.yml
@@ -80,21 +80,21 @@ definition:
variants: []
- default:
brief: |
- This member is true, if the interrupt vector can be caused by
- ${cause:/name}, otherwise it is false.
+ This member is true, if the interrupt vector can be raised by
+ ${raise:/name}, otherwise it is false.
definition: bool ${.:name}
description: null
kind: member
- name: can_cause
+ name: can_raise
variants: []
- default:
brief: |
- This member is true, if the interrupt vector can be caused on a processor
- by ${cause-on:/name}, otherwise it is false.
+ This member is true, if the interrupt vector can be raised on a processor
+ by ${raise-on:/name}, otherwise it is false.
definition: bool ${.:name}
description: null
kind: member
- name: can_cause_on
+ name: can_raise_on
variants: []
- default:
brief: |
@@ -139,8 +139,8 @@ definition:
vector can be triggered by a message.
definition: bool ${.:name}
description: |
- Interrupts may be also triggered by signals, ${cause:/name}, or
- ${cause-on:/name}. Examples for message triggered interrupts are the
+ Interrupts may be also triggered by signals, ${raise:/name}, or
+ ${raise-on:/name}. Examples for message triggered interrupts are the
PCIe MSI/MSI-X and the ARM GICv3 Locality-specific Peripheral Interrupts
(LPI).
kind: member
@@ -154,7 +154,7 @@ definition:
description: |
Interrupts are normally triggered by signals which indicate an interrupt
request from a peripheral. Interrupts may be also triggered by messages,
- ${cause:/name}, or ${cause-on:/name}.
+ ${raise:/name}, or ${raise-on:/name}.
kind: member
name: trigger_signal
variants: []
diff --git a/spec/rtems/intr/if/clear.yml b/spec/rtems/intr/if/clear.yml
index c9730e7d..07ec774f 100644
--- a/spec/rtems/intr/if/clear.yml
+++ b/spec/rtems/intr/if/clear.yml
@@ -49,6 +49,6 @@ return:
${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
- The request to cause the interrupt vector has not been satisfied.
+ The request to raise the interrupt vector has not been satisfied.
value: ${../../status/if/unsatisfied:/name}
type: interface
diff --git a/spec/rtems/intr/if/group.yml b/spec/rtems/intr/if/group.yml
index 975bd8ca..c16e0a7a 100644
--- a/spec/rtems/intr/if/group.yml
+++ b/spec/rtems/intr/if/group.yml
@@ -92,9 +92,9 @@ links:
- role: placement-order
uid: is-pending
- role: placement-order
- uid: cause
+ uid: raise
- role: placement-order
- uid: cause-on
+ uid: raise-on
- role: placement-order
uid: clear
- role: placement-order
diff --git a/spec/rtems/intr/if/is-pending.yml b/spec/rtems/intr/if/is-pending.yml
index 5ef1861d..bef64fe9 100644
--- a/spec/rtems/intr/if/is-pending.yml
+++ b/spec/rtems/intr/if/is-pending.yml
@@ -34,8 +34,8 @@ links:
uid: /constraint/directive-no-preempt
name: rtems_interrupt_is_pending
notes: |
- Interrupts may be made pending by calling the ${cause:/name} or
- ${cause-on:/name} directives or due to exernal signals or messages. The
+ Interrupts may be made pending by calling the ${raise:/name} or
+ ${raise-on:/name} directives or due to exernal signals or messages. The
pending state may be cleared by ${clear:/name}.
params:
- description: |
diff --git a/spec/rtems/intr/if/cause-on.yml b/spec/rtems/intr/if/raise-on.yml
index 6aee24d2..c079383e 100644
--- a/spec/rtems/intr/if/cause-on.yml
+++ b/spec/rtems/intr/if/raise-on.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Causes the interrupt vector on the processor.
+ Raises the interrupt vector on the processor.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -29,17 +29,17 @@ links:
uid: /constraint/directive-ctx-task
- role: constraint
uid: /constraint/directive-no-preempt
-name: rtems_interrupt_cause_on
+name: rtems_interrupt_raise_on
notes: |
The ${get-attributes:/name} directive may be used to check if an interrupt
- vector can be caused on a processor.
+ vector can be raised on a processor.
params:
- description: |
- is the number of the interrupt vector to cause.
+ is the number of the interrupt vector to raise.
dir: null
name: vector
- description: |
- is the index of the target processor of the interrupt vector to cause.
+ is the index of the target processor of the interrupt vector to raise.
dir: null
name: cpu_index
return:
@@ -61,6 +61,6 @@ return:
by the application, however, it was not online.
value: ${../../status/if/incorrect-state:/name}
- description: |
- The request to cause the interrupt vector has not been satisfied.
+ The request to raise the interrupt vector has not been satisfied.
value: ${../../status/if/unsatisfied:/name}
type: interface
diff --git a/spec/rtems/intr/if/cause.yml b/spec/rtems/intr/if/raise.yml
index e93835da..268ba158 100644
--- a/spec/rtems/intr/if/cause.yml
+++ b/spec/rtems/intr/if/raise.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Causes the interrupt vector.
+ Raises the interrupt vector.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -29,13 +29,13 @@ links:
uid: /constraint/directive-ctx-task
- role: constraint
uid: /constraint/directive-no-preempt
-name: rtems_interrupt_cause
+name: rtems_interrupt_raise
notes: |
The ${get-attributes:/name} directive may be used to check if an interrupt
- vector can be caused.
+ vector can be raised.
params:
- description: |
- is the number of the interrupt vector to cause.
+ is the number of the interrupt vector to raise.
dir: null
name: vector
return:
@@ -49,6 +49,6 @@ return:
${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
- The request to cause the interrupt vector has not been satisfied.
+ The request to raise the interrupt vector has not been satisfied.
value: ${../../status/if/unsatisfied:/name}
type: interface
diff --git a/spec/rtems/intr/if/vector-enable.yml b/spec/rtems/intr/if/vector-enable.yml
index 359a4ae2..c9081ae3 100644
--- a/spec/rtems/intr/if/vector-enable.yml
+++ b/spec/rtems/intr/if/vector-enable.yml
@@ -15,7 +15,7 @@ description: |
The directive enables the interrupt vector specified by ${.:/params[0]/name}.
This allows that interrupt service requests are issued to the target
processors of the interrupt vector. Interrupt service requests for an
- interrupt vector may be caused by ${cause:/name}, ${cause-on:/name},
+ interrupt vector may be raised by ${raise:/name}, ${raise-on:/name},
external signals, or messages.
enabled-by: true
index-entries: []