SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Initializes the interrupt server entry.
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-entry:/name} *${.:/params[1]/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_entry_initialize
notes: |
  After initialization, the list of actions of the interrupt server entry is
  empty.  Actions may be prepended by ${server-action-prepend:/name}.
  Interrupt server entries may be moved to another interrupt vector with
  ${server-entry-move:/name}.  Server entries may be submitted to get serviced
  by the interrupt server with ${server-entry-submit:/name}.  Server entries
  may be destroyed by ${server-entry-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 entry to initialize.
  dir: null
  name: entry
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