summaryrefslogblamecommitdiffstats
path: root/spec/rtems/intr/if/handler-remove.yml
blob: 32470e1c17cbe0fd183a232e98313a217ea20ddc (plain) (tree)




















                                                                               
             


                         

                                              











































                                                                           
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Removes the interrupt handler routine and argument from the interrupt vector.
copyrights:
- Copyright (C) 2008, 2021 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    attributes: null
    body: null
    params:
    - ${vector-number:/name} ${.:/params[0]/name}
    - ${handler:/name} ${.:/params[1]/name}
    - void *${.:/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_handler_remove
notes: null
params:
- description: |
    is the interrupt vector number.
  dir: null
  name: vector
- description: |
    is the interrupt handler routine to remove.
  dir: null
  name: routine
- description: |
    is the interrupt handler argument to remove.
  dir: null
  name: arg
return:
  return: null
  return-values:
  - description: |
      The requested operation was successful.
    value: ${../../status/if/successful:/name}
  - description: |
      The service was not initialized.
    value: ${../../status/if/incorrect-state:/name}
  - description: |
      The ${.:/params[1]/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[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: |
      There was no handler routine and argument pair installed specified by
      ${.:/params[1]/name} and ${.:/params[2]/name}.
    value: ${../../status/if/unsatisfied:/name}
type: interface