blob: 803012c21d6ef1ff281e3adc0919b4822fa034ea (
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Installs the interrupt handler routine and argument at the interrupt vector
on the interrupt server.
copyrights:
- Copyright (C) 2008, 2021 embedded brains GmbH & Co. KG
definition:
default:
attributes: null
body: null
params:
- ${/c/if/uint32_t:/name} ${.:/params[0]/name}
- ${vector-number:/name} ${.:/params[1]/name}
- const char *${.:/params[2]/name}
- ${../../option/if/option:/name} ${.:/params[3]/name}
- ${handler:/name} ${.:/params[4]/name}
- void *${.:/params[5]/name}
return: ${../../status/if/code:/name}
variants: []
description: |
The handler routine specified by ${.:/params[4]/name} will be executed within
the context of the interrupt server task specified by ${.:/params[0]/name}.
enabled-by: true
index-entries: []
interface-type: function
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-devinit
- role: constraint
uid: /constraint/directive-ctx-task
- role: constraint
uid: /constraint/object-allocator
name: rtems_interrupt_server_handler_install
notes: |
See also ${handler-install:/name}.
params:
- description: |
is the interrupt server index. The constant ${server-default:/name} may be
used to specify the default interrupt server.
dir: null
name: server_index
- description: |
is the interrupt vector number.
dir: null
name: vector
- description: |
is the descriptive information of the interrupt handler to install.
dir: null
name: info
- description: |
is the interrupt handler install option set.
dir: null
name: options
- description: |
is the interrupt handler routine to install.
dir: null
name: routine
- description: |
is the interrupt handler argument to install.
dir: null
name: arg
return:
return: null
return-values:
- description: |
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
There was no interrupt server associated with the index specified by
${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The directive was called from within interrupt context.
value: ${../../status/if/called-from-isr:/name}
- description: |
The ${.:/params[4]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
There was no interrupt vector associated with the number specified by
${.:/params[1]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
An option specified by ${.:/params[2]/name} was not applicable.
value: ${../../status/if/invalid-number:/name}
- description: |
The ${unique:/name} option was set in ${.:/params[2]/name} and the
interrupt vector was already occupied by a handler.
value: ${../../status/if/resource-in-use:/name}
- description: |
The ${shared:/name} option was set in ${.:/params[2]/name} and the
interrupt vector was already occupied by a unique handler.
value: ${../../status/if/resource-in-use:/name}
- description: |
The handler specified by ${.:/params[4]/name} was already installed for
the interrupt vector specified by ${.:/params[1]/name} with an argument
equal to the argument specified by ${.:/params[5]/name}.
value: ${../../status/if/too-many:/name}
- description: |
The ${replace:/name} option was set in ${.:/params[2]/name} and no
handler to replace was installed.
value: ${../../status/if/unsatisfied:/name}
type: interface
|
