diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-06-22 08:36:48 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-07-03 10:22:46 +0200 |
commit | c51ff93dba0a909beb30a5478102524a789769a5 (patch) | |
tree | eb0d0dd5cfc18ed12b0485013a822244ffe612ae /spec/if | |
parent | spec: Add /if/rtems/signal/* (diff) | |
download | rtems-central-c51ff93dba0a909beb30a5478102524a789769a5.tar.bz2 |
spec: Add /if/rtems/support/*
Diffstat (limited to 'spec/if')
-rw-r--r-- | spec/if/rtems/support/header.yml | 11 | ||||
-rw-r--r-- | spec/if/rtems/support/is-name-valid.yml | 36 | ||||
-rw-r--r-- | spec/if/rtems/support/microseconds-to-ticks.yml | 31 | ||||
-rw-r--r-- | spec/if/rtems/support/milliseconds-to-microseconds.yml | 29 | ||||
-rw-r--r-- | spec/if/rtems/support/milliseconds-to-ticks.yml | 31 | ||||
-rw-r--r-- | spec/if/rtems/support/name-to-characters.yml | 51 | ||||
-rw-r--r-- | spec/if/rtems/support/workspace-allocate.yml | 34 | ||||
-rw-r--r-- | spec/if/rtems/support/workspace-free.yml | 30 | ||||
-rw-r--r-- | spec/if/rtems/support/workspace-get-information.yml | 30 | ||||
-rw-r--r-- | spec/if/rtems/support/workspace-greedy-allocate-all-except-largest.yml | 30 | ||||
-rw-r--r-- | spec/if/rtems/support/workspace-greedy-allocate.yml | 34 | ||||
-rw-r--r-- | spec/if/rtems/support/workspace-greedy-free.yml | 30 |
12 files changed, 377 insertions, 0 deletions
diff --git a/spec/if/rtems/support/header.yml b/spec/if/rtems/support/header.yml new file mode 100644 index 00000000..5bdd2dcb --- /dev/null +++ b/spec/if/rtems/support/header.yml @@ -0,0 +1,11 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +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/domains/api +path: rtems/rtems/support.h +prefix: cpukit/include +type: interface diff --git a/spec/if/rtems/support/is-name-valid.yml b/spec/if/rtems/support/is-name-valid.yml new file mode 100644 index 00000000..00f8158f --- /dev/null +++ b/spec/if/rtems/support/is-name-valid.yml @@ -0,0 +1,36 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns true, if the specified object name is valid, otherwise returns false. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: + body: | + return ${.:/params[0]/name} != 0; + params: + - ${../status/code:/name} ${.:/params[0]/name} + return: ${/if/c/bool:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/support +name: rtems_is_name_valid +notes: null +params: +- description: is the object name to check. + dir: null + name: name +return: + return: null + return-values: + - description: The specified object name is valid. + value: 'true' + - description: Otherwise. + value: 'false' +type: interface diff --git a/spec/if/rtems/support/microseconds-to-ticks.yml b/spec/if/rtems/support/microseconds-to-ticks.yml new file mode 100644 index 00000000..024656b1 --- /dev/null +++ b/spec/if/rtems/support/microseconds-to-ticks.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the number of clock ticks for the specified microseconds value. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: | + ( ( ${.:/params[0]/name} ) / ${../config/get-microseconds-per-tick:/name}() ) + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/support +name: RTEMS_MICROSECONDS_TO_TICKS +notes: | + The number of clock ticks per second is defined by the + ${/acfg/opt/microsecondspertick:/name} application configuration option. +params: +- description: is the microseconds value to convert to clock ticks. + dir: null + name: _us +return: + return: | + The number of clock ticks for the specified microseconds value is returned. + return-values: [] +type: interface diff --git a/spec/if/rtems/support/milliseconds-to-microseconds.yml b/spec/if/rtems/support/milliseconds-to-microseconds.yml new file mode 100644 index 00000000..a0b42cbf --- /dev/null +++ b/spec/if/rtems/support/milliseconds-to-microseconds.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the number of microseconds for the specified milliseconds value. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: | + ( ( ${.:/params[0]/name} ) * 1000UL ) + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/support +name: RTEMS_MILLISECONDS_TO_MICROSECONDS +notes: null +params: +- description: is the milliseconds value to convert to microseconds. + dir: null + name: _ms +return: + return: | + The number of microseconds for the specified milliseconds value is returned. + return-values: [] +type: interface diff --git a/spec/if/rtems/support/milliseconds-to-ticks.yml b/spec/if/rtems/support/milliseconds-to-ticks.yml new file mode 100644 index 00000000..c8c9cc13 --- /dev/null +++ b/spec/if/rtems/support/milliseconds-to-ticks.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the number of clock ticks for the specified milliseconds value. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: | + ${microseconds-to-ticks:/name}( ${milliseconds-to-microseconds:/name}( ${.:/params[0]/name} ) ) + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/support +name: RTEMS_MILLISECONDS_TO_TICKS +notes: | + The number of clock ticks per second is defined by the + ${/acfg/opt/microsecondspertick:/name} application configuration option. +params: +- description: is the milliseconds value to convert to clock ticks. + dir: null + name: _ms +return: + return: | + The number of clock ticks for the specified milliseconds value is returned. + return-values: [] +type: interface diff --git a/spec/if/rtems/support/name-to-characters.yml b/spec/if/rtems/support/name-to-characters.yml new file mode 100644 index 00000000..8e99d627 --- /dev/null +++ b/spec/if/rtems/support/name-to-characters.yml @@ -0,0 +1,51 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Breaks the object name into the four component characters. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: + body: | + *${.:/params[1]/name} = (char) ( ${.:/params[0]/name} >> 24 ); + *${.:/params[2]/name} = (char) ( ${.:/params[0]/name} >> 16 ); + *${.:/params[3]/name} = (char) ( ${.:/params[0]/name} >> 8 ); + *${.:/params[4]/name} = (char) ${.:/params[0]/name}; + params: + - ${../types/name:/name} ${.:/params[0]/name} + - char *${.:/params[1]/name} + - char *${.:/params[2]/name} + - char *${.:/params[3]/name} + - char *${.:/params[4]/name} + return: void + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/support +name: rtems_name_to_characters +notes: null +params: +- description: is the object name to break into four component characters. + dir: null + name: name +- description: is the first character of the object name. + dir: out + name: c1 +- description: is the second character of the object name. + dir: out + name: c2 +- description: is the third character of the object name. + dir: out + name: c3 +- description: is the fourth character of the object name. + dir: out + name: c4 +return: + return: null + return-values: [] +type: interface diff --git a/spec/if/rtems/support/workspace-allocate.yml b/spec/if/rtems/support/workspace-allocate.yml new file mode 100644 index 00000000..9776af64 --- /dev/null +++ b/spec/if/rtems/support/workspace-allocate.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: + - ${/if/c/size_t:/name} ${.:/params[0]/name} + - void **${.:/params[1]/name} + return: ${/if/c/bool:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/support +name: rtems_workspace_allocate +notes: null +params: +- description: '%' + dir: null + name: bytes +- description: '%' + dir: null + name: pointer +return: + return: null + return-values: [] +type: interface diff --git a/spec/if/rtems/support/workspace-free.yml b/spec/if/rtems/support/workspace-free.yml new file mode 100644 index 00000000..4d4f437f --- /dev/null +++ b/spec/if/rtems/support/workspace-free.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: + - void *${.:/params[0]/name} + return: ${/if/c/bool:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/support +name: rtems_workspace_free +notes: null +params: +- description: '%' + dir: null + name: pointer +return: + return: null + return-values: [] +type: interface diff --git a/spec/if/rtems/support/workspace-get-information.yml b/spec/if/rtems/support/workspace-get-information.yml new file mode 100644 index 00000000..9edf0823 --- /dev/null +++ b/spec/if/rtems/support/workspace-get-information.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: + - ${/if/impl/heap/information-block:/name} *${.:/params[0]/name} + return: ${/if/c/bool:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/support +name: rtems_workspace_get_information +notes: null +params: +- description: '%' + dir: null + name: the_info +return: + return: null + return-values: [] +type: interface diff --git a/spec/if/rtems/support/workspace-greedy-allocate-all-except-largest.yml b/spec/if/rtems/support/workspace-greedy-allocate-all-except-largest.yml new file mode 100644 index 00000000..298a2c1f --- /dev/null +++ b/spec/if/rtems/support/workspace-greedy-allocate-all-except-largest.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: + - ${/if/c/uintptr_t:/name} *${.:/params[0]/name} + return: void * + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/support +name: rtems_workspace_greedy_allocate_all_except_largest +notes: null +params: +- description: '%' + dir: null + name: allocatable_size +return: + return: null + return-values: [] +type: interface diff --git a/spec/if/rtems/support/workspace-greedy-allocate.yml b/spec/if/rtems/support/workspace-greedy-allocate.yml new file mode 100644 index 00000000..30e3a34c --- /dev/null +++ b/spec/if/rtems/support/workspace-greedy-allocate.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: + - const ${/if/c/uintptr_t:/name} *${.:/params[0]/name} + - ${/if/c/size_t:/name} ${.:/params[1]/name} + return: void * + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/support +name: rtems_workspace_greedy_allocate +notes: null +params: +- description: '%' + dir: null + name: block_sizes +- description: '%' + dir: null + name: block_count +return: + return: null + return-values: [] +type: interface diff --git a/spec/if/rtems/support/workspace-greedy-free.yml b/spec/if/rtems/support/workspace-greedy-free.yml new file mode 100644 index 00000000..078b6ba8 --- /dev/null +++ b/spec/if/rtems/support/workspace-greedy-free.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: + - void *${.:/params[0]/name} + return: void + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/support +name: rtems_workspace_greedy_free +notes: null +params: +- description: '%' + dir: null + name: opaque +return: + return: null + return-values: [] +type: interface |