summaryrefslogtreecommitdiffstats
path: root/spec/rtems/timer/if
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/timer/if')
-rw-r--r--spec/rtems/timer/if/cancel.yml30
-rw-r--r--spec/rtems/timer/if/class-bit-not-dormant.yml19
-rw-r--r--spec/rtems/timer/if/class-bit-on-task.yml19
-rw-r--r--spec/rtems/timer/if/class-bit-time-of-day.yml19
-rw-r--r--spec/rtems/timer/if/classes.yml27
-rw-r--r--spec/rtems/timer/if/create.yml34
-rw-r--r--spec/rtems/timer/if/delete.yml30
-rw-r--r--spec/rtems/timer/if/dormant.yml15
-rw-r--r--spec/rtems/timer/if/fire-after.yml42
-rw-r--r--spec/rtems/timer/if/fire-when.yml42
-rw-r--r--spec/rtems/timer/if/get-information.yml34
-rw-r--r--spec/rtems/timer/if/group.yml19
-rw-r--r--spec/rtems/timer/if/header.yml12
-rw-r--r--spec/rtems/timer/if/ident.yml59
-rw-r--r--spec/rtems/timer/if/information.yml50
-rw-r--r--spec/rtems/timer/if/initiate-server.yml38
-rw-r--r--spec/rtems/timer/if/interval-on-task.yml17
-rw-r--r--spec/rtems/timer/if/interval.yml15
-rw-r--r--spec/rtems/timer/if/reset.yml30
-rw-r--r--spec/rtems/timer/if/server-default-priority.yml19
-rw-r--r--spec/rtems/timer/if/server-fire-after.yml42
-rw-r--r--spec/rtems/timer/if/server-fire-when.yml42
-rw-r--r--spec/rtems/timer/if/service-routine-entry.yml20
-rw-r--r--spec/rtems/timer/if/service-routine.yml19
-rw-r--r--spec/rtems/timer/if/time-of-day-on-task.yml18
-rw-r--r--spec/rtems/timer/if/time-of-day.yml17
26 files changed, 728 insertions, 0 deletions
diff --git a/spec/rtems/timer/if/cancel.yml b/spec/rtems/timer/if/cancel.yml
new file mode 100644
index 00000000..0d34be46
--- /dev/null
+++ b/spec/rtems/timer/if/cancel.yml
@@ -0,0 +1,30 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../type/if/id:/name} ${.:/params[0]/name}
+ return: ${../../status/if/code:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_cancel
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/timer/if/class-bit-not-dormant.yml b/spec/rtems/timer/if/class-bit-not-dormant.yml
new file mode 100644
index 00000000..9c955b73
--- /dev/null
+++ b/spec/rtems/timer/if/class-bit-not-dormant.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: '0x4'
+ variants: []
+description: null
+enabled-by: true
+interface-type: define
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: TIMER_CLASS_BIT_NOT_DORMANT
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/class-bit-on-task.yml b/spec/rtems/timer/if/class-bit-on-task.yml
new file mode 100644
index 00000000..04a206eb
--- /dev/null
+++ b/spec/rtems/timer/if/class-bit-on-task.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: '0x2'
+ variants: []
+description: null
+enabled-by: true
+interface-type: define
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: TIMER_CLASS_BIT_ON_TASK
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/class-bit-time-of-day.yml b/spec/rtems/timer/if/class-bit-time-of-day.yml
new file mode 100644
index 00000000..9bd0d9d0
--- /dev/null
+++ b/spec/rtems/timer/if/class-bit-time-of-day.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: '0x1'
+ variants: []
+description: null
+enabled-by: true
+interface-type: define
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: TIMER_CLASS_BIT_TIME_OF_DAY
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/classes.yml b/spec/rtems/timer/if/classes.yml
new file mode 100644
index 00000000..15339559
--- /dev/null
+++ b/spec/rtems/timer/if/classes.yml
@@ -0,0 +1,27 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition-kind: typedef-only
+description: null
+enabled-by: true
+interface-type: enum
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+- role: interface-enumerator
+ uid: dormant
+- role: interface-enumerator
+ uid: interval
+- role: interface-enumerator
+ uid: interval-on-task
+- role: interface-enumerator
+ uid: time-of-day
+- role: interface-enumerator
+ uid: time-of-day-on-task
+name: Timer_Classes
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/create.yml b/spec/rtems/timer/if/create.yml
new file mode 100644
index 00000000..eefb8ea9
--- /dev/null
+++ b/spec/rtems/timer/if/create.yml
@@ -0,0 +1,34 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../type/if/name:/name} ${.:/params[0]/name}
+ - ${../../type/if/id:/name} *${.:/params[1]/name}
+ return: ${../../status/if/code:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_create
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: name
+- description: '%'
+ dir: null
+ name: id
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/timer/if/delete.yml b/spec/rtems/timer/if/delete.yml
new file mode 100644
index 00000000..e8cbeda8
--- /dev/null
+++ b/spec/rtems/timer/if/delete.yml
@@ -0,0 +1,30 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../type/if/id:/name} ${.:/params[0]/name}
+ return: ${../../status/if/code:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_delete
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/timer/if/dormant.yml b/spec/rtems/timer/if/dormant.yml
new file mode 100644
index 00000000..332c48d7
--- /dev/null
+++ b/spec/rtems/timer/if/dormant.yml
@@ -0,0 +1,15 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: null
+ variants: []
+description: null
+enabled-by: true
+interface-type: enumerator
+links: []
+name: TIMER_DORMANT
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/fire-after.yml b/spec/rtems/timer/if/fire-after.yml
new file mode 100644
index 00000000..fba01068
--- /dev/null
+++ b/spec/rtems/timer/if/fire-after.yml
@@ -0,0 +1,42 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../type/if/id:/name} ${.:/params[0]/name}
+ - ${../../type/if/interval:/name} ${.:/params[1]/name}
+ - ${service-routine-entry:/name} ${.:/params[2]/name}
+ - void *${.:/params[3]/name}
+ return: ${../../status/if/code:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_fire_after
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+- description: '%'
+ dir: null
+ name: ticks
+- description: '%'
+ dir: null
+ name: routine
+- description: '%'
+ dir: null
+ name: user_data
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/timer/if/fire-when.yml b/spec/rtems/timer/if/fire-when.yml
new file mode 100644
index 00000000..d654ba60
--- /dev/null
+++ b/spec/rtems/timer/if/fire-when.yml
@@ -0,0 +1,42 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../type/if/id:/name} ${.:/params[0]/name}
+ - ${../../type/if/time-of-day:/name} *${.:/params[1]/name}
+ - ${service-routine-entry:/name} ${.:/params[2]/name}
+ - void *${.:/params[3]/name}
+ return: ${../../status/if/code:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_fire_when
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+- description: '%'
+ dir: null
+ name: wall_time
+- description: '%'
+ dir: null
+ name: routine
+- description: '%'
+ dir: null
+ name: user_data
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/timer/if/get-information.yml b/spec/rtems/timer/if/get-information.yml
new file mode 100644
index 00000000..8568c490
--- /dev/null
+++ b/spec/rtems/timer/if/get-information.yml
@@ -0,0 +1,34 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../type/if/id:/name} ${.:/params[0]/name}
+ - ${information:/name} *${.:/params[1]/name}
+ return: ${../../status/if/code:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_get_information
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+- description: '%'
+ dir: null
+ name: the_info
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/timer/if/group.yml b/spec/rtems/timer/if/group.yml
new file mode 100644
index 00000000..b805e1f9
--- /dev/null
+++ b/spec/rtems/timer/if/group.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ The Timer Manager provides support for timer facilities.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: null
+enabled-by: true
+identifier: RTEMSAPIClassicTimer
+interface-type: group
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: ../../if/group
+name: Timer Manager
+text: |
+ The Classic API shall provide an interface to the Timer Manager.
+type: interface
diff --git a/spec/rtems/timer/if/header.yml b/spec/rtems/timer/if/header.yml
new file mode 100644
index 00000000..ed157f2e
--- /dev/null
+++ b/spec/rtems/timer/if/header.yml
@@ -0,0 +1,12 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Timer Manager API.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-type: header-file
+links:
+- role: interface-placement
+ uid: /if/domain
+path: rtems/rtems/timer.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/rtems/timer/if/ident.yml b/spec/rtems/timer/if/ident.yml
new file mode 100644
index 00000000..5796c890
--- /dev/null
+++ b/spec/rtems/timer/if/ident.yml
@@ -0,0 +1,59 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Identifies a timer object by the specified object name.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ 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 obtains the timer identifier associated with the timer name
+ specified in ``${.:/params[0]/name}``.
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_ident
+notes: |
+ If the timer name is not unique, then the timer identifier will match the
+ first timer with that name in the search order. However, this timer
+ identifier is not guaranteed to correspond to the desired timer. The timer
+ identifier is used with other timer related directives to access the timer.
+
+ The objects are searched from lowest to the highest index. Only the local
+ node is searched.
+params:
+- description: is the object name to look up.
+ dir: null
+ name: name
+- description: |
+ is the pointer to an object identifier variable. The object identifier of
+ an object with the specified name 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[1]/name} parameter was ${/c/if/null:/name}.
+ value: ${../../status/if/invalid-address:/name}
+ - description: |
+ The ${.:/params[0]/name} parameter was 0.
+ value: ${../../status/if/invalid-name:/name}
+ - description: |
+ There was no object with the specified name on the local node.
+ value: ${../../status/if/invalid-name:/name}
+type: interface
diff --git a/spec/rtems/timer/if/information.yml b/spec/rtems/timer/if/information.yml
new file mode 100644
index 00000000..69db1665
--- /dev/null
+++ b/spec/rtems/timer/if/information.yml
@@ -0,0 +1,50 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+- default:
+ brief: |
+ This member is
+ definition: ${classes:/name} ${.:name}
+ description: '%'
+ kind: member
+ name: the_class
+ variants: []
+- default:
+ brief: |
+ This member is
+ definition: ${/score/watchdog/if/interval:/name} ${.:name}
+ description: '%'
+ kind: member
+ name: initial
+ variants: []
+- default:
+ brief: |
+ This member is
+ definition: ${/score/watchdog/if/interval:/name} ${.:name}
+ description: '%'
+ kind: member
+ name: start_time
+ variants: []
+- default:
+ brief: |
+ This member is
+ definition: ${/score/watchdog/if/interval:/name} ${.:name}
+ description: '%'
+ kind: member
+ name: stop_time
+ variants: []
+definition-kind: typedef-only
+description: null
+enabled-by: true
+interface-type: struct
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_information
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/initiate-server.yml b/spec/rtems/timer/if/initiate-server.yml
new file mode 100644
index 00000000..3d5512de
--- /dev/null
+++ b/spec/rtems/timer/if/initiate-server.yml
@@ -0,0 +1,38 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../task/if/priority:/name} ${.:/params[0]/name}
+ - ${/c/if/size_t:/name} ${.:/params[1]/name}
+ - ${../../attr/if/attribute:/name} ${.:/params[2]/name}
+ return: ${../../status/if/code:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_initiate_server
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: priority
+- description: '%'
+ dir: null
+ name: stack_size
+- description: '%'
+ dir: null
+ name: attribute_set
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/timer/if/interval-on-task.yml b/spec/rtems/timer/if/interval-on-task.yml
new file mode 100644
index 00000000..ca246210
--- /dev/null
+++ b/spec/rtems/timer/if/interval-on-task.yml
@@ -0,0 +1,17 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: |
+ ${class-bit-not-dormant:/name} |
+ ${class-bit-on-task:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: enumerator
+links: []
+name: TIMER_INTERVAL_ON_TASK
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/interval.yml b/spec/rtems/timer/if/interval.yml
new file mode 100644
index 00000000..1d6507c8
--- /dev/null
+++ b/spec/rtems/timer/if/interval.yml
@@ -0,0 +1,15 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: ${class-bit-not-dormant:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: enumerator
+links: []
+name: TIMER_INTERVAL
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/reset.yml b/spec/rtems/timer/if/reset.yml
new file mode 100644
index 00000000..1abd2c17
--- /dev/null
+++ b/spec/rtems/timer/if/reset.yml
@@ -0,0 +1,30 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../type/if/id:/name} ${.:/params[0]/name}
+ return: ${../../status/if/code:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_reset
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/timer/if/server-default-priority.yml b/spec/rtems/timer/if/server-default-priority.yml
new file mode 100644
index 00000000..896d0db6
--- /dev/null
+++ b/spec/rtems/timer/if/server-default-priority.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: ( (${../../task/if/priority:/name}) -1 )
+ variants: []
+description: null
+enabled-by: true
+interface-type: define
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: RTEMS_TIMER_SERVER_DEFAULT_PRIORITY
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/server-fire-after.yml b/spec/rtems/timer/if/server-fire-after.yml
new file mode 100644
index 00000000..20f6704c
--- /dev/null
+++ b/spec/rtems/timer/if/server-fire-after.yml
@@ -0,0 +1,42 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../type/if/id:/name} ${.:/params[0]/name}
+ - ${../../type/if/interval:/name} ${.:/params[1]/name}
+ - ${service-routine-entry:/name} ${.:/params[2]/name}
+ - void *${.:/params[3]/name}
+ return: ${../../status/if/code:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_server_fire_after
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+- description: '%'
+ dir: null
+ name: ticks
+- description: '%'
+ dir: null
+ name: routine
+- description: '%'
+ dir: null
+ name: user_data
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/timer/if/server-fire-when.yml b/spec/rtems/timer/if/server-fire-when.yml
new file mode 100644
index 00000000..fd7b20cd
--- /dev/null
+++ b/spec/rtems/timer/if/server-fire-when.yml
@@ -0,0 +1,42 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../type/if/id:/name} ${.:/params[0]/name}
+ - ${../../type/if/time-of-day:/name} *${.:/params[1]/name}
+ - ${service-routine-entry:/name} ${.:/params[2]/name}
+ - void *${.:/params[3]/name}
+ return: ${../../status/if/code:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_server_fire_when
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+- description: '%'
+ dir: null
+ name: wall_time
+- description: '%'
+ dir: null
+ name: routine
+- description: '%'
+ dir: null
+ name: user_data
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/timer/if/service-routine-entry.yml b/spec/rtems/timer/if/service-routine-entry.yml
new file mode 100644
index 00000000..d8f767e1
--- /dev/null
+++ b/spec/rtems/timer/if/service-routine-entry.yml
@@ -0,0 +1,20 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: |
+ ${service-routine:/name} ( *${.:/name} )( ${../../type/if/id:/name}, void * )
+ variants: []
+description: null
+enabled-by: true
+interface-type: typedef
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_service_routine_entry
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/service-routine.yml b/spec/rtems/timer/if/service-routine.yml
new file mode 100644
index 00000000..61e6db56
--- /dev/null
+++ b/spec/rtems/timer/if/service-routine.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: void ${.:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: typedef
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_timer_service_routine
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/time-of-day-on-task.yml b/spec/rtems/timer/if/time-of-day-on-task.yml
new file mode 100644
index 00000000..37340cae
--- /dev/null
+++ b/spec/rtems/timer/if/time-of-day-on-task.yml
@@ -0,0 +1,18 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: |
+ ${class-bit-not-dormant:/name} |
+ ${class-bit-time-of-day:/name} |
+ ${class-bit-on-task:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: enumerator
+links: []
+name: TIMER_TIME_OF_DAY_ON_TASK
+notes: null
+type: interface
diff --git a/spec/rtems/timer/if/time-of-day.yml b/spec/rtems/timer/if/time-of-day.yml
new file mode 100644
index 00000000..e0d81840
--- /dev/null
+++ b/spec/rtems/timer/if/time-of-day.yml
@@ -0,0 +1,17 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: |
+ ${class-bit-not-dormant:/name} |
+ ${class-bit-time-of-day:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: enumerator
+links: []
+name: TIMER_TIME_OF_DAY
+notes: null
+type: interface