SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Creates an interrupt server.
copyrights:
- Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    attributes: null
    body: null
    params:
    - ${server-control:/name} *${.:/params[0]/name}
    - const ${server-config:/name} *${.:/params[1]/name}
    - ${/c/if/uint32_t:/name} *${.:/params[2]/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_create
notes: |
  See also ${server-initialize:/name} and ${server-delete:/name}.
params:
- description: |
    is the pointer to an ${server-control:/name} object.  When the directive
    call was successful, the ownership of the object was transferred from the
    caller of the directive to the interrupt server management.
  dir: out
  name: control
- description: |
    is the interrupt server configuration.
  dir: null
  name: config
- description: |
    is the pointer to an ${/c/if/uint32_t:/name} object.  When the directive
    call was successful, the index of the created interrupt server will be
    stored in this object.
  dir: out
  name: server_index
return:
  return: |
    The directive uses ${../../task/if/create:/name}.  If this directive fails,
    then its error status will be returned.
  return-values:
  - description: |
      The requested operation was successful.
    value: ${../../status/if/successful:/name}
type: interface