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

Last change on this file since 45b6997 was 45b6997, checked in by Sebastian Huber <sebastian.huber@…>, on Jan 13, 2021 at 1:05:42 PM

spec: Document all create directives

  • Property mode set to 100644
File size: 2.4 KB
Line 
1SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
2brief: |
3  Creates a period.
4copyrights:
5- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
6- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
7definition:
8  default:
9    attributes: null
10    body: null
11    params:
12    - ${../../type/if/name:/name} ${.:/params[0]/name}
13    - ${../../type/if/id:/name} *${.:/params[1]/name}
14    return: ${../../status/if/code:/name}
15  variants: []
16description: |
17  This directive creates a period which resides on the local node.  The period
18  has the user-defined object name specified in ${.:/params[0]/name} The
19  assigned object identifier is returned in ${.:/params[1]/name}.  This
20  identifier is used to access the period with other rate monotonic related
21  directives.
22enabled-by: true
23index-entries:
24- create a period
25interface-type: function
26links:
27- role: interface-placement
28  uid: header
29- role: interface-ingroup
30  uid: group
31- role: constraint
32  uid: /constraint/directive-ctx-devinit
33- role: constraint
34  uid: /constraint/directive-ctx-task
35- role: constraint
36  uid: /constraint/object-allocator
37- role: constraint
38  uid: ../constraint/max
39- role: constraint
40  uid: /constraint/obj-unlimited-alloc
41name: rtems_rate_monotonic_create
42notes: |
43  The calling task is registered as the owner of the created period.  Some
44  directives can be only used by this task for the created period.
45
46  For control and maintenance of the period, RTEMS allocates a
47  ${/glossary/pcb:/term} from the local PCB free pool and initializes it.
48params:
49- description: |
50    is the object name of the period.
51  dir: null
52  name: name
53- description: |
54    is the pointer to an object identifier variable.  The identifier of the
55    created period will be stored in this variable, in case of a successful
56    operation.
57  dir: out
58  name: id
59return:
60  return: null
61  return-values:
62  - description: |
63      The requested operation was successful.
64    value: ${../../status/if/successful:/name}
65  - description: |
66      The ${.:/params[0]/name} parameter was invalid.
67    value: ${../../status/if/invalid-name:/name}
68  - description: |
69      There was no inactive object available to create a period.  The number of
70      periods available to the application is configured through the
71      ${/acfg/if/max-periods:/name} application configuration option.
72    value: ${../../status/if/too-many:/name}
73type: interface
Note: See TracBrowser for help on using the repository browser.