source: rtems-central/spec/rtems/part/if/return-buffer.yml @ 0500b9a

Last change on this file since 0500b9a was 0500b9a, checked in by Sebastian Huber <sebastian.huber@…>, on Dec 1, 2020 at 1:23:41 PM

interface/interfacedoc: Format parameter names

  • Property mode set to 100644
File size: 1.7 KB
Line 
1SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
2brief: |
3  Returns the buffer to the partition.
4copyrights:
5- Copyright (C) 2020 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/id:/name} ${.:/params[0]/name}
13    - void *${.:/params[1]/name}
14    return: ${../../status/if/code:/name}
15  variants: []
16description: |
17  This directive returns the buffer specified by ${.:/params[1]/name} to the
18  partition specified by ${.:/params[0]/name}.
19enabled-by: true
20index-entries:
21- return buffer to partition
22interface-type: function
23links:
24- role: interface-placement
25  uid: header
26- role: interface-ingroup
27  uid: group
28name: rtems_partition_return_buffer
29notes: |
30  This directive will not cause the running task to be preempted.
31
32  Returning a buffer to a global partition which does not reside on the local
33  node will generate a request telling the remote node to return the buffer to
34  the partition.
35
36  Returning a buffer multiple times is an error.  It will corrupt the internal
37  state of the partition.
38params:
39- description: is the partition identifier.
40  dir: null
41  name: id
42- description: is the pointer to the buffer to return.
43  dir: null
44  name: buffer
45return:
46  return: null
47  return-values:
48  - description: |
49      The requested operation was successful.
50    value: ${../../status/if/successful:/name}
51  - description: |
52      There was no partition with the specified identifier.
53    value: ${../../status/if/invalid-id:/name}
54  - description: |
55      The buffer referenced by ${.:/params[1]/name} was not in the
56      partition.
57    value: ${../../status/if/invalid-address:/name}
58type: interface
Note: See TracBrowser for help on using the repository browser.