summaryrefslogtreecommitdiffstats
path: root/spec/rtems/intr/if/server-request-initialize.yml
blob: b6b50f9267e32e5af712929ff128e148808e3944 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Initializes the interrupt server request.
copyrights:
- Copyright (C) 2017, 2021 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    attributes: null
    body: null
    params:
    - ${/c/if/uint32_t:/name} ${.:/params[0]/name}
    - ${server-request:/name} *${.:/params[1]/name}
    - ${handler:/name} ${.:/params[2]/name}
    - void *${.:/params[3]/name}
    return: ${../../status/if/code:/name}
  variants: []
description: null
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_request_initialize
notes: |
  An interrupt server requests consists of an interrupt server entry and
  exactly one interrupt server action.  The interrupt vector of the request may
  be changed with ${server-request-set-vector:/name}.  Interrupt server
  requests may be submitted to get serviced by the interrupt server with
  ${server-request-submit:/name}.  Requests may be destroyed by
  ${server-request-destroy:/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 server request to initialize.
  dir: out
  name: request
- description: |
    is the interrupt handler routine for the request action.
  dir: null
  name: routine
- description: |
    is the interrupt handler argument for the request action.
  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}
type: interface