diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-06 12:44:23 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-28 10:38:22 +0200 |
| commit | 31a305f1d26256c5439d1dd552a4136848e841f0 (patch) | |
| tree | f8c6584f4ec5ca2c98e94476da874fe066519a8d /spec/if/rtems/basedefs/container-of.yml | |
| parent | interface: Support void functions (diff) | |
| download | rtems-central-31a305f1d26256c5439d1dd552a4136848e841f0.tar.bz2 | |
spec: Add some interface items
Diffstat (limited to 'spec/if/rtems/basedefs/container-of.yml')
| -rw-r--r-- | spec/if/rtems/basedefs/container-of.yml | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/spec/if/rtems/basedefs/container-of.yml b/spec/if/rtems/basedefs/container-of.yml new file mode 100644 index 00000000..8da027fd --- /dev/null +++ b/spec/if/rtems/basedefs/container-of.yml @@ -0,0 +1,36 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2014 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: [] +interface-brief: | + Returns the pointer to the container of a specified member pointer. +interface-definition: + default: | + ( (_type *) ( (${/if/c/uintptr_t:/interface-name}) ( _m ) - ${/if/c/offsetof:/interface-name}( _type, _member_name ) ) ) + variants: [] +interface-description: null +interface-name: RTEMS_CONTAINER_OF +interface-params: +- description: | + is the pointer to a member of the container. + dir: null + name: _m +- description: | + is the type of the container. + dir: null + name: _type +- description: | + is the designator name of the container member. + dir: null + name: _member_name +interface-return: + return: | + Returns the pointer to the container of a specified member pointer. + return-values: [] +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +type: interface |