SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Adds the processor to the set of processors owned by the scheduler.
copyrights:
- Copyright (C) 2016, 2021 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    attributes: null
    body: null
    params:
    - ${../../type/if/id:/name} ${.:/params[0]/name}
    - ${/c/if/uint32_t:/name} ${.:/params[1]/name}
    return: ${../../status/if/code:/name}
  variants: []
description: |
  This directive adds the processor specified by the ${.:/params[1]/name} to
  the scheduler 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-ctx-devinit
- role: constraint
  uid: /constraint/directive-ctx-task
- role: constraint
  uid: /constraint/object-allocator
name: rtems_scheduler_add_processor
notes: null
params:
- description: |
    is the scheduler identifier.
  dir: null
  name: scheduler_id
- description: |
    is the index of the processor to add.
  dir: null
  name: cpu_index
return:
  return: null
  return-values:
  - description: |
      The requested operation was successful.
    value: ${../../status/if/successful:/name}
  - description: |
      There was no scheduler associated with the identifier specified by
      ${.:/params[0]/name}.
    value: ${../../status/if/invalid-id:/name}
  - description: |
      The processor was not configured to be used by the application.
    value: ${../../status/if/not-configured:/name}
  - description: |
      The processor was configured to be used by the application, however, it
      was not online.
    value: ${../../status/if/incorrect-state:/name}
  - description: |
      The processor was already assigned to a scheduler.
    value: ${../../status/if/resource-in-use:/name}
type: interface