Changeset c970d63 in rtems-central for spec/rtems/timer/if/create.yml


Ignore:
Timestamp:
Dec 1, 2020, 1:57:03 PM (7 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
0adc07b
Parents:
cb4eca2
git-author:
Sebastian Huber <sebastian.huber@…> (12/01/20 13:57:03)
git-committer:
Sebastian Huber <sebastian.huber@…> (12/02/20 10:13:36)
Message:

spec: Review Timer Manager API

File:
1 edited

Legend:

Unmodified
Added
Removed
  • spec/rtems/timer/if/create.yml

    rcb4eca2 rc970d63  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    2 brief: '%'
     2brief: |
     3  Creates a timer.
    34copyrights:
    45- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
     
    1314    return: ${../../status/if/code:/name}
    1415  variants: []
    15 description: null
     16description: |
     17  This directive creates a timer.  The assigned object identifier is returned
     18  in ${.:/params[1]/name}.  This identifier is used to access the timer with
     19  other timer related directives.
    1620enabled-by: true
    17 index-entries: []
     21index-entries:
     22- create a timer
    1823interface-type: function
    1924links:
     
    2328  uid: group
    2429name: rtems_timer_create
    25 notes: null
     30notes: |
     31  This directive may cause the calling task to be preempted due to an obtain
     32  and release of the object allocator mutex.
     33
     34  For control and maintenance of the timer, RTEMS allocates a
     35  ${/glossary/tmcb:/term} from the local TMCB free pool and initializes it.
     36
     37  In SMP configurations, the processor of the currently executing thread
     38  determines the processor used for the created timer.  During the life-time of
     39  the timer this processor is used to manage the timer internally.
    2640params:
    27 - description: '%'
     41- description: is the name of the timer.
    2842  dir: null
    2943  name: name
    30 - description: '%'
    31   dir: null
     44- description: |
     45    is the pointer to an object identifier variable.  The identifier of the
     46    created timer object will be stored in this variable, in case of a
     47    successful operation.
     48  dir: out
    3249  name: id
    3350return:
    3451  return: null
    35   return-values: []
     52  return-values:
     53  - description: |
     54      The requested operation was successful.
     55    value: ${../../status/if/successful:/name}
     56  - description: |
     57      The timer name was invalid.
     58    value: ${../../status/if/invalid-name:/name}
     59  - description: |
     60      The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
     61    value: ${../../status/if/invalid-address:/name}
     62  - description: |
     63      There was no inactive object available to create a new timer.  The number
     64      of timers available to the application is configured through the
     65      ${/acfg/if/max-timers:/name} configuration option.
     66    value: ${../../status/if/too-many:/name}
    3667type: interface
Note: See TracChangeset for help on using the changeset viewer.