source: rtems-central/spec/rtems/ratemon/if/create.yml @ 45b6997

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Creates a period.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default:
    attributes: null
    body: null
    params:
    - ${../../type/if/name:/name} ${.:/params[0]/name}
    - ${../../type/if/id:/name} *${.:/params[1]/name}
    return: ${../../status/if/code:/name}
  variants: []
description: |
  This directive creates a period which resides on the local node.  The period
  has the user-defined object name specified in ${.:/params[0]/name} The
  assigned object identifier is returned in ${.:/params[1]/name}.  This
  identifier is used to access the period with other rate monotonic related
  directives.
enabled-by: true
index-entries:
- create a period
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
- role: constraint
  uid: ../constraint/max
- role: constraint
  uid: /constraint/obj-unlimited-alloc
name: rtems_rate_monotonic_create
notes: |
  The calling task is registered as the owner of the created period.  Some
  directives can be only used by this task for the created period.

  For control and maintenance of the period, RTEMS allocates a
  ${/glossary/pcb:/term} from the local PCB free pool and initializes it.
params:
- description: |
    is the object name of the period.
  dir: null
  name: name
- description: |
    is the pointer to an object identifier variable.  The identifier of the
    created period will be stored in this variable, in case of a successful
    operation.
  dir: out
  name: id
return:
  return: null
  return-values:
  - description: |
      The requested operation was successful.
    value: ${../../status/if/successful:/name}
  - description: |
      The ${.:/params[0]/name} parameter was invalid.
    value: ${../../status/if/invalid-name:/name}
  - description: |
      There was no inactive object available to create a period.  The number of
      periods available to the application is configured through the
      ${/acfg/if/max-periods:/name} application configuration option.
    value: ${../../status/if/too-many:/name}
type: interface