mirror of
https://git.rtems.org/rtems-docs/
synced 2025-05-17 18:51:43 +08:00
c-user: Generate Partition Manager documentation
The manager documentation is a consolidation of the comments in Doxygen markup and the documentation sources in Sphinx markup. The documentation was transfered to interface specification items. This header file was generated from the items by a script. Update #3993.
This commit is contained in:
Sebastian Huber
parent
ec4dcc0098
commit
530bc2b0e3
@ -1,28 +1,47 @@
|
|||||||
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
|
||||||
|
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
|
||||||
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
|
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
|
||||||
|
|
||||||
|
.. This file is part of the RTEMS quality process and was automatically
|
||||||
|
.. generated. If you find something that needs to be fixed or
|
||||||
|
.. worded better please post a report or patch to an RTEMS mailing list
|
||||||
|
.. or raise a bug report:
|
||||||
|
..
|
||||||
|
.. https://docs.rtems.org/branches/master/user/support/bugs.html
|
||||||
|
..
|
||||||
|
.. For information on updating and regenerating please refer to:
|
||||||
|
..
|
||||||
|
.. https://docs.rtems.org/branches/master/eng/req/howto.html
|
||||||
|
|
||||||
|
.. _PartitionManagerDirectives:
|
||||||
|
|
||||||
Directives
|
Directives
|
||||||
==========
|
==========
|
||||||
|
|
||||||
This section details the partition manager's directives. A subsection is
|
This section details the directives of the Partition Manager. A subsection is
|
||||||
dedicated to each of this manager's directives and describes the calling
|
dedicated to each of this manager's directives and lists the calling sequence,
|
||||||
sequence, related constants, usage, and status codes.
|
parameters, description, return values, and notes of the directive.
|
||||||
|
|
||||||
|
.. Generated from spec:/rtems/part/if/create
|
||||||
|
|
||||||
.. raw:: latex
|
.. raw:: latex
|
||||||
|
|
||||||
\clearpage
|
\clearpage
|
||||||
|
|
||||||
|
.. index:: rtems_partition_create()
|
||||||
.. index:: create a partition
|
.. index:: create a partition
|
||||||
.. index:: rtems_partition_create
|
|
||||||
|
|
||||||
.. _rtems_partition_create:
|
.. _InterfaceRtemsPartitionCreate:
|
||||||
|
|
||||||
PARTITION_CREATE - Create a partition
|
rtems_partition_create()
|
||||||
-------------------------------------
|
------------------------
|
||||||
|
|
||||||
CALLING SEQUENCE:
|
Creates a partition.
|
||||||
.. code-block:: c
|
|
||||||
|
.. rubric:: CALLING SEQUENCE:
|
||||||
|
|
||||||
|
.. code-block:: c
|
||||||
|
|
||||||
rtems_status_code rtems_partition_create(
|
rtems_status_code rtems_partition_create(
|
||||||
rtems_name name,
|
rtems_name name,
|
||||||
@ -33,134 +52,144 @@ CALLING SEQUENCE:
|
|||||||
rtems_id *id
|
rtems_id *id
|
||||||
);
|
);
|
||||||
|
|
||||||
DIRECTIVE STATUS CODES:
|
.. rubric:: PARAMETERS:
|
||||||
.. list-table::
|
|
||||||
:class: rtems-table
|
|
||||||
|
|
||||||
* - ``RTEMS_SUCCESSFUL``
|
``name``
|
||||||
- partition created successfully
|
This parameter is the name of the partition.
|
||||||
* - ``RTEMS_INVALID_NAME``
|
|
||||||
- invalid partition ``name``
|
|
||||||
* - ``RTEMS_TOO_MANY``
|
|
||||||
- too many partitions created
|
|
||||||
* - ``RTEMS_INVALID_ADDRESS``
|
|
||||||
- ``starting_address`` is not on a pointer size boundary
|
|
||||||
* - ``RTEMS_INVALID_ADDRESS``
|
|
||||||
- ``starting_address`` is NULL
|
|
||||||
* - ``RTEMS_INVALID_ADDRESS``
|
|
||||||
- ``id`` is NULL
|
|
||||||
* - ``RTEMS_INVALID_SIZE``
|
|
||||||
- ``length`` or ``buffer_size`` is 0
|
|
||||||
* - ``RTEMS_INVALID_SIZE``
|
|
||||||
- ``length`` is less than the ``buffer_size``
|
|
||||||
* - ``RTEMS_INVALID_SIZE``
|
|
||||||
- ``buffer_size`` is not an integral multiple of the pointer size
|
|
||||||
* - ``RTEMS_INVALID_SIZE``
|
|
||||||
- ``buffer_size`` is less than two times the pointer size
|
|
||||||
* - ``RTEMS_TOO_MANY``
|
|
||||||
- too many global objects
|
|
||||||
|
|
||||||
DESCRIPTION:
|
``starting_address``
|
||||||
This directive creates a partition of fixed size buffers from a physically
|
This parameter is the starting address of the buffer area used by the
|
||||||
contiguous memory space which starts at starting_address and is length
|
partition.
|
||||||
bytes in size. Each allocated buffer is to be of ``buffer_size`` in bytes.
|
|
||||||
The assigned partition id is returned in ``id``. This partition id is used
|
|
||||||
to access the partition with other partition related directives. For
|
|
||||||
control and maintenance of the partition, RTEMS allocates a PTCB from the
|
|
||||||
local PTCB free pool and initializes it.
|
|
||||||
|
|
||||||
NOTES:
|
``length``
|
||||||
This directive may cause the calling task to be preempted due to an
|
This parameter is the length in bytes of the buffer area used by the
|
||||||
obtain and release of the object allocator mutex.
|
partition.
|
||||||
|
|
||||||
The partition buffer area specified by the ``starting_address`` must be
|
``buffer_size``
|
||||||
properly aligned. It must be possible to directly store target
|
This parameter is the size in bytes of a buffer managed by the partition.
|
||||||
architecture pointers and the also the user data. For example, if the user
|
|
||||||
data contains some long double or vector data types, the partition buffer
|
|
||||||
area and the buffer size must take the alignment of these types into
|
|
||||||
account which is usually larger than the pointer alignment. A cache line
|
|
||||||
alignment may be also a factor.
|
|
||||||
|
|
||||||
The ``buffer_size`` parameter must be an integral multiple of the pointer
|
``attribute_set``
|
||||||
size on the target architecture. Additionally, ``buffer_size`` must be
|
This parameter is the attribute set of the partition.
|
||||||
large enough to hold two pointers on the target architecture. This is
|
|
||||||
required for RTEMS to manage the buffers when they are free.
|
|
||||||
|
|
||||||
Memory from the partition is not used by RTEMS to store the Partition
|
``id``
|
||||||
Control Block.
|
This parameter is the pointer to an object identifier variable. The
|
||||||
|
identifier of the created partition object will be stored in this variable,
|
||||||
|
in case of a successful operation.
|
||||||
|
|
||||||
The following partition attribute constants are defined by RTEMS:
|
.. rubric:: DESCRIPTION:
|
||||||
|
|
||||||
.. list-table::
|
This directive creates a partition of fixed size buffers from a physically
|
||||||
:class: rtems-table
|
contiguous memory space which starts at ``starting_address`` and is ``length``
|
||||||
|
bytes in size. Each allocated buffer is to be of ``buffer_size`` in bytes.
|
||||||
|
The assigned partition identifier is returned in ``id``. This partition
|
||||||
|
identifier is used to access the partition with other partition related
|
||||||
|
directives.
|
||||||
|
|
||||||
* - ``RTEMS_LOCAL``
|
The **attribute set** specified in ``attribute_set`` is built through a
|
||||||
- local partition (default)
|
*bitwise or* of the attribute constants described below. Attributes not
|
||||||
* - ``RTEMS_GLOBAL``
|
mentioned below are not evaluated by this directive and have no effect.
|
||||||
- global partition
|
|
||||||
|
|
||||||
The PTCB for a global partition is allocated on the local node. The memory
|
The partition can have **local** or **global** scope in a multiprocessing
|
||||||
space used for the partition must reside in shared memory. Partitions
|
network (this attribute does not refer to SMP systems).
|
||||||
should not be made global unless remote tasks must interact with the
|
|
||||||
partition. This is to avoid the overhead incurred by the creation of a
|
|
||||||
global partition. When a global partition is created, the partition's name
|
|
||||||
and id must be transmitted to every node in the system for insertion in the
|
|
||||||
local copy of the global object table.
|
|
||||||
|
|
||||||
The total number of global objects, including partitions, is limited by the
|
* A **local** scope is the default and can be emphasized through the use of the
|
||||||
maximum_global_objects field in the Configuration Table.
|
:c:macro:`RTEMS_LOCAL` attribute. A local partition can be only used by the
|
||||||
|
node which created it.
|
||||||
|
|
||||||
EXAMPLE:
|
* A **global** scope is established if the :c:macro:`RTEMS_GLOBAL` attribute is
|
||||||
.. code-block:: c
|
set. The memory space used for the partition must reside in shared memory.
|
||||||
|
Setting the global attribute in a single node system has no effect.
|
||||||
|
|
||||||
#include <rtems.h>
|
.. rubric:: RETURN VALUES:
|
||||||
#include <rtems/chain.h>
|
|
||||||
|
|
||||||
#include <assert.h>
|
:c:macro:`RTEMS_SUCCESSFUL`
|
||||||
|
The requested operation was successful.
|
||||||
|
|
||||||
typedef struct {
|
:c:macro:`RTEMS_INVALID_NAME`
|
||||||
char less;
|
The partition name was invalid.
|
||||||
short more;
|
|
||||||
} item;
|
|
||||||
|
|
||||||
union {
|
:c:macro:`RTEMS_INVALID_ADDRESS`
|
||||||
item data;
|
The ``id`` parameter was `NULL
|
||||||
rtems_chain_node node;
|
<https://en.cppreference.com/w/c/types/NULL>`_.
|
||||||
} items[ 13 ];
|
|
||||||
|
|
||||||
rtems_id create_partition(void)
|
:c:macro:`RTEMS_INVALID_SIZE`
|
||||||
{
|
The ``length`` parameter was 0.
|
||||||
rtems_id id;
|
|
||||||
rtems_status_code sc;
|
|
||||||
|
|
||||||
sc = rtems_partition_create(
|
:c:macro:`RTEMS_INVALID_SIZE`
|
||||||
rtems_build_name( 'P', 'A', 'R', 'T' ),
|
The ``buffer_size`` parameter was 0.
|
||||||
items,
|
|
||||||
sizeof( items ),
|
|
||||||
sizeof( items[ 0 ] ),
|
|
||||||
RTEMS_DEFAULT_ATTRIBUTES,
|
|
||||||
&id
|
|
||||||
);
|
|
||||||
assert(sc == RTEMS_SUCCESSFUL);
|
|
||||||
|
|
||||||
return id;
|
:c:macro:`RTEMS_INVALID_SIZE`
|
||||||
}
|
The ``length`` parameter was less than the ``buffer_size`` parameter.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_SIZE`
|
||||||
|
The ``buffer_size`` parameter was not an integral multiple of the pointer
|
||||||
|
size.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_SIZE`
|
||||||
|
The ``buffer_size`` parameter was less than two times the pointer size.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_ADDRESS`
|
||||||
|
The ``starting_address`` parameter was not on a pointer size boundary.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_TOO_MANY`
|
||||||
|
There was no inactive object available to create a new partition. The
|
||||||
|
number of partitions available to the application is configured through the
|
||||||
|
:ref:`CONFIGURE_MAXIMUM_PARTITIONS` configuration option.
|
||||||
|
|
||||||
|
.. rubric:: NOTES:
|
||||||
|
|
||||||
|
This directive may cause the calling task to be preempted due to an obtain and
|
||||||
|
release of the object allocator mutex.
|
||||||
|
|
||||||
|
The partition buffer area specified by the ``starting_address`` must be
|
||||||
|
properly aligned. It must be possible to directly store target architecture
|
||||||
|
pointers and also the user data. For example, if the user data contains some
|
||||||
|
long double or vector data types, the partition buffer area and the buffer size
|
||||||
|
must take the alignment of these types into account which is usually larger
|
||||||
|
than the pointer alignment. A cache line alignment may be also a factor. Use
|
||||||
|
:c:macro:`RTEMS_PARTITION_ALIGNMENT` to specify the minimum alignment of a
|
||||||
|
partition buffer type.
|
||||||
|
|
||||||
|
The ``buffer_size`` parameter must be an integral multiple of the pointer size
|
||||||
|
on the target architecture. Additionally, ``buffer_size`` must be large enough
|
||||||
|
to hold two pointers on the target architecture. This is required for RTEMS to
|
||||||
|
manage the buffers when they are free.
|
||||||
|
|
||||||
|
For control and maintenance of the partition, RTEMS allocates a :term:`PTCB`
|
||||||
|
from the local PTCB free pool and initializes it. Memory from the partition
|
||||||
|
buffer area is not used by RTEMS to store the PTCB.
|
||||||
|
|
||||||
|
The PTCB for a global partition is allocated on the local node. Partitions
|
||||||
|
should not be made global unless remote tasks must interact with the partition.
|
||||||
|
This is to avoid the overhead incurred by the creation of a global partition.
|
||||||
|
When a global partition is created, the partition's name and identifier must be
|
||||||
|
transmitted to every node in the system for insertion in the local copy of the
|
||||||
|
global object table.
|
||||||
|
|
||||||
|
The total number of global objects, including partitions, is limited by the
|
||||||
|
value of the :ref:`CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS` application
|
||||||
|
configuration option.
|
||||||
|
|
||||||
|
.. Generated from spec:/rtems/part/if/ident
|
||||||
|
|
||||||
.. raw:: latex
|
.. raw:: latex
|
||||||
|
|
||||||
\clearpage
|
\clearpage
|
||||||
|
|
||||||
|
.. index:: rtems_partition_ident()
|
||||||
.. index:: get ID of a partition
|
.. index:: get ID of a partition
|
||||||
.. index:: obtain ID of a partition
|
.. index:: obtain ID of a partition
|
||||||
.. index:: rtems_partition_ident
|
|
||||||
|
|
||||||
.. _rtems_partition_ident:
|
.. _InterfaceRtemsPartitionIdent:
|
||||||
|
|
||||||
PARTITION_IDENT - Get ID of a partition
|
rtems_partition_ident()
|
||||||
---------------------------------------
|
-----------------------
|
||||||
|
|
||||||
CALLING SEQUENCE:
|
Identifies a partition by the object name.
|
||||||
.. code-block:: c
|
|
||||||
|
.. rubric:: CALLING SEQUENCE:
|
||||||
|
|
||||||
|
.. code-block:: c
|
||||||
|
|
||||||
rtems_status_code rtems_partition_ident(
|
rtems_status_code rtems_partition_ident(
|
||||||
rtems_name name,
|
rtems_name name,
|
||||||
@ -168,182 +197,253 @@ CALLING SEQUENCE:
|
|||||||
rtems_id *id
|
rtems_id *id
|
||||||
);
|
);
|
||||||
|
|
||||||
DIRECTIVE STATUS CODES:
|
.. rubric:: PARAMETERS:
|
||||||
.. list-table::
|
|
||||||
:class: rtems-table
|
|
||||||
|
|
||||||
* - ``RTEMS_SUCCESSFUL``
|
``name``
|
||||||
- partition identified successfully
|
This parameter is the object name to look up.
|
||||||
* - ``RTEMS_INVALID_ADDRESS``
|
|
||||||
- ``id`` is NULL
|
|
||||||
* - ``RTEMS_INVALID_NAME``
|
|
||||||
- partition name not found
|
|
||||||
* - ``RTEMS_INVALID_NODE``
|
|
||||||
- invalid node id
|
|
||||||
|
|
||||||
DESCRIPTION:
|
``node``
|
||||||
This directive obtains the partition id associated with the partition name.
|
This parameter is the node or node set to search for a matching object.
|
||||||
If the partition name is not unique, then the partition id will match one
|
|
||||||
of the partitions with that name. However, this partition id is not
|
|
||||||
guaranteed to correspond to the desired partition. The partition id is
|
|
||||||
used with other partition related directives to access the partition.
|
|
||||||
|
|
||||||
NOTES:
|
``id``
|
||||||
This directive will not cause the running task to be preempted.
|
This parameter 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.
|
||||||
|
|
||||||
If node is ``RTEMS_SEARCH_ALL_NODES``, all nodes are searched with the
|
.. rubric:: DESCRIPTION:
|
||||||
local node being searched first. All other nodes are searched with the
|
|
||||||
lowest numbered node searched first.
|
|
||||||
|
|
||||||
If node is a valid node number which does not represent the local node,
|
This directive obtains a partition identifier associated with the partition
|
||||||
then only the partitions exported by the designated node are searched.
|
name specified in ``name``.
|
||||||
|
|
||||||
This directive does not generate activity on remote nodes. It accesses
|
The node to search is specified in ``node``. It shall be
|
||||||
only the local copy of the global object table.
|
|
||||||
|
* a valid node number,
|
||||||
|
|
||||||
|
* the constant :c:macro:`RTEMS_SEARCH_ALL_NODES` to search in all nodes,
|
||||||
|
|
||||||
|
* the constant :c:macro:`RTEMS_SEARCH_LOCAL_NODE` to search in the local node
|
||||||
|
only, or
|
||||||
|
|
||||||
|
* the constant :c:macro:`RTEMS_SEARCH_OTHER_NODES` to search in all nodes
|
||||||
|
except the local node.
|
||||||
|
|
||||||
|
.. rubric:: RETURN VALUES:
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_SUCCESSFUL`
|
||||||
|
The requested operation was successful.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_ADDRESS`
|
||||||
|
The id parameter was `NULL <https://en.cppreference.com/w/c/types/NULL>`_.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_NAME`
|
||||||
|
The name parameter was 0.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_NAME`
|
||||||
|
There was no object with the specified name on the specified nodes.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_NODE`
|
||||||
|
In multiprocessing configurations, the specified node was invalid.
|
||||||
|
|
||||||
|
.. rubric:: NOTES:
|
||||||
|
|
||||||
|
If the partition name is not unique, then the partition identifier will match
|
||||||
|
the first partition with that name in the search order. However, this
|
||||||
|
partition identifier is not guaranteed to correspond to the desired partition.
|
||||||
|
The partition identifier is used with other partition related directives to
|
||||||
|
access the partition.
|
||||||
|
|
||||||
|
If node is :c:macro:`RTEMS_SEARCH_ALL_NODES`, all nodes are searched with the
|
||||||
|
local node being searched first. All other nodes are searched with the lowest
|
||||||
|
numbered node searched first.
|
||||||
|
|
||||||
|
If node is a valid node number which does not represent the local node, then
|
||||||
|
only the partitions exported by the designated node are searched.
|
||||||
|
|
||||||
|
This directive does not generate activity on remote nodes. It accesses only
|
||||||
|
the local copy of the global object table.
|
||||||
|
|
||||||
|
.. Generated from spec:/rtems/part/if/delete
|
||||||
|
|
||||||
.. raw:: latex
|
.. raw:: latex
|
||||||
|
|
||||||
\clearpage
|
\clearpage
|
||||||
|
|
||||||
|
.. index:: rtems_partition_delete()
|
||||||
.. index:: delete a partition
|
.. index:: delete a partition
|
||||||
.. index:: rtems_partition_delete
|
|
||||||
|
|
||||||
.. _rtems_partition_delete:
|
.. _InterfaceRtemsPartitionDelete:
|
||||||
|
|
||||||
PARTITION_DELETE - Delete a partition
|
rtems_partition_delete()
|
||||||
-------------------------------------
|
------------------------
|
||||||
|
|
||||||
CALLING SEQUENCE:
|
Deletes the partition.
|
||||||
.. code-block:: c
|
|
||||||
|
|
||||||
rtems_status_code rtems_partition_delete(
|
.. rubric:: CALLING SEQUENCE:
|
||||||
rtems_id id
|
|
||||||
);
|
|
||||||
|
|
||||||
DIRECTIVE STATUS CODES:
|
.. code-block:: c
|
||||||
.. list-table::
|
|
||||||
:class: rtems-table
|
|
||||||
|
|
||||||
* - ``RTEMS_SUCCESSFUL``
|
rtems_status_code rtems_partition_delete( rtems_id id );
|
||||||
- partition deleted successfully
|
|
||||||
* - ``RTEMS_INVALID_ID``
|
|
||||||
- invalid partition id
|
|
||||||
* - ``RTEMS_RESOURCE_IN_USE``
|
|
||||||
- buffers still in use
|
|
||||||
* - ``RTEMS_ILLEGAL_ON_REMOTE_OBJECT``
|
|
||||||
- cannot delete remote partition
|
|
||||||
|
|
||||||
DESCRIPTION:
|
.. rubric:: PARAMETERS:
|
||||||
This directive deletes the partition specified by id. The partition cannot
|
|
||||||
be deleted if any of its buffers are still allocated. The PTCB for the
|
|
||||||
deleted partition is reclaimed by RTEMS.
|
|
||||||
|
|
||||||
NOTES:
|
``id``
|
||||||
This directive may cause the calling task to be preempted due to an
|
This parameter is the partition identifier.
|
||||||
obtain and release of the object allocator mutex.
|
|
||||||
|
|
||||||
The calling task does not have to be the task that created the partition.
|
.. rubric:: DESCRIPTION:
|
||||||
Any local task that knows the partition id can delete the partition.
|
|
||||||
|
|
||||||
When a global partition is deleted, the partition id must be transmitted to
|
This directive deletes the partition specified by the id parameter. The
|
||||||
every node in the system for deletion from the local copy of the global
|
partition cannot be deleted if any of its buffers are still allocated. The
|
||||||
object table.
|
:term:`PTCB` for the deleted partition is reclaimed by RTEMS.
|
||||||
|
|
||||||
The partition must reside on the local node, even if the partition was
|
.. rubric:: RETURN VALUES:
|
||||||
created with the ``RTEMS_GLOBAL`` option.
|
|
||||||
|
:c:macro:`RTEMS_SUCCESSFUL`
|
||||||
|
The requested operation was successful.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_ID`
|
||||||
|
There was no partition with the specified identifier.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_ILLEGAL_ON_REMOTE_OBJECT`
|
||||||
|
The partition resided on a remote node.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_RESOURCE_IN_USE`
|
||||||
|
There were buffers of the partition still in use.
|
||||||
|
|
||||||
|
.. rubric:: NOTES:
|
||||||
|
|
||||||
|
This directive may cause the calling task to be preempted due to an obtain and
|
||||||
|
release of the object allocator mutex.
|
||||||
|
|
||||||
|
The calling task does not have to be the task that created the partition. Any
|
||||||
|
local task that knows the partition identifier can delete the partition.
|
||||||
|
|
||||||
|
When a global partition is deleted, the partition identifier must be
|
||||||
|
transmitted to every node in the system for deletion from the local copy of the
|
||||||
|
global object table.
|
||||||
|
|
||||||
|
The partition must reside on the local node, even if the partition was created
|
||||||
|
with the :c:macro:`RTEMS_GLOBAL` attribute.
|
||||||
|
|
||||||
|
.. Generated from spec:/rtems/part/if/get-buffer
|
||||||
|
|
||||||
.. raw:: latex
|
.. raw:: latex
|
||||||
|
|
||||||
\clearpage
|
\clearpage
|
||||||
|
|
||||||
|
.. index:: rtems_partition_get_buffer()
|
||||||
.. index:: get buffer from partition
|
.. index:: get buffer from partition
|
||||||
.. index:: obtain buffer from partition
|
.. index:: obtain buffer from partition
|
||||||
.. index:: rtems_partition_get_buffer
|
|
||||||
|
|
||||||
.. _rtems_partition_get_buffer:
|
.. _InterfaceRtemsPartitionGetBuffer:
|
||||||
|
|
||||||
PARTITION_GET_BUFFER - Get buffer from a partition
|
rtems_partition_get_buffer()
|
||||||
--------------------------------------------------
|
----------------------------
|
||||||
|
|
||||||
CALLING SEQUENCE:
|
Tries to get a buffer from the partition.
|
||||||
.. code-block:: c
|
|
||||||
|
|
||||||
rtems_status_code rtems_partition_get_buffer(
|
.. rubric:: CALLING SEQUENCE:
|
||||||
rtems_id id,
|
|
||||||
void **buffer
|
|
||||||
);
|
|
||||||
|
|
||||||
DIRECTIVE STATUS CODES:
|
.. code-block:: c
|
||||||
.. list-table::
|
|
||||||
:class: rtems-table
|
|
||||||
|
|
||||||
* - ``RTEMS_SUCCESSFUL``
|
rtems_status_code rtems_partition_get_buffer( rtems_id id, void **buffer );
|
||||||
- buffer obtained successfully
|
|
||||||
* - ``RTEMS_INVALID_ADDRESS``
|
|
||||||
- ``buffer`` is NULL
|
|
||||||
* - ``RTEMS_INVALID_ID``
|
|
||||||
- invalid partition id
|
|
||||||
* - ``RTEMS_UNSATISFIED``
|
|
||||||
- all buffers are allocated
|
|
||||||
|
|
||||||
DESCRIPTION:
|
.. rubric:: PARAMETERS:
|
||||||
This directive allows a buffer to be obtained from the partition specified
|
|
||||||
in id. The address of the allocated buffer is returned in buffer.
|
|
||||||
|
|
||||||
NOTES:
|
``id``
|
||||||
This directive will not cause the running task to be preempted.
|
This parameter is the partition identifier.
|
||||||
|
|
||||||
All buffers begin on a four byte boundary.
|
``buffer``
|
||||||
|
This parameter is the pointer to a buffer pointer variable. The pointer to
|
||||||
|
the allocated buffer will be stored in this variable, in case of a
|
||||||
|
successful operation.
|
||||||
|
|
||||||
A task cannot wait on a buffer to become available.
|
.. rubric:: DESCRIPTION:
|
||||||
|
|
||||||
Getting a buffer from a global partition which does not reside on the local
|
This directive allows a buffer to be obtained from the partition specified in
|
||||||
node will generate a request telling the remote node to allocate a buffer
|
the ``id`` parameter. The address of the allocated buffer is returned through
|
||||||
from the specified partition.
|
the ``buffer`` parameter.
|
||||||
|
|
||||||
|
.. rubric:: RETURN VALUES:
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_SUCCESSFUL`
|
||||||
|
The requested operation was successful.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_ID`
|
||||||
|
There was no partition with the specified identifier.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_ADDRESS`
|
||||||
|
The ``buffer`` parameter was `NULL
|
||||||
|
<https://en.cppreference.com/w/c/types/NULL>`_.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_UNSATISFIED`
|
||||||
|
There was no free buffer available to allocate and return.
|
||||||
|
|
||||||
|
.. rubric:: NOTES:
|
||||||
|
|
||||||
|
This directive will not cause the running task to be preempted.
|
||||||
|
|
||||||
|
The buffer start alignment is determined by the memory area and buffer size
|
||||||
|
used to create the partition.
|
||||||
|
|
||||||
|
A task cannot wait on a buffer to become available.
|
||||||
|
|
||||||
|
Getting a buffer from a global partition which does not reside on the local
|
||||||
|
node will generate a request telling the remote node to allocate a buffer from
|
||||||
|
the partition.
|
||||||
|
|
||||||
|
.. Generated from spec:/rtems/part/if/return-buffer
|
||||||
|
|
||||||
.. raw:: latex
|
.. raw:: latex
|
||||||
|
|
||||||
\clearpage
|
\clearpage
|
||||||
|
|
||||||
.. index:: return buffer to partitition
|
.. index:: rtems_partition_return_buffer()
|
||||||
.. index:: rtems_partition_return_buffer
|
.. index:: return buffer to partition
|
||||||
|
|
||||||
.. _rtems_partition_return_buffer:
|
.. _InterfaceRtemsPartitionReturnBuffer:
|
||||||
|
|
||||||
PARTITION_RETURN_BUFFER - Return buffer to a partition
|
rtems_partition_return_buffer()
|
||||||
------------------------------------------------------
|
-------------------------------
|
||||||
|
|
||||||
CALLING SEQUENCE:
|
Returns the buffer to the partition.
|
||||||
.. code-block:: c
|
|
||||||
|
|
||||||
rtems_status_code rtems_partition_return_buffer(
|
.. rubric:: CALLING SEQUENCE:
|
||||||
rtems_id id,
|
|
||||||
void *buffer
|
|
||||||
);
|
|
||||||
|
|
||||||
DIRECTIVE STATUS CODES:
|
.. code-block:: c
|
||||||
.. list-table::
|
|
||||||
:class: rtems-table
|
|
||||||
|
|
||||||
* - ``RTEMS_SUCCESSFUL``
|
rtems_status_code rtems_partition_return_buffer( rtems_id id, void *buffer );
|
||||||
- buffer returned successfully
|
|
||||||
* - ``RTEMS_INVALID_ADDRESS``
|
|
||||||
- ``buffer`` is NULL
|
|
||||||
* - ``RTEMS_INVALID_ID``
|
|
||||||
- invalid partition id
|
|
||||||
* - ``RTEMS_INVALID_ADDRESS``
|
|
||||||
- buffer address not in partition
|
|
||||||
|
|
||||||
DESCRIPTION:
|
.. rubric:: PARAMETERS:
|
||||||
This directive returns the buffer specified by buffer to the partition
|
|
||||||
specified by id.
|
|
||||||
|
|
||||||
NOTES:
|
``id``
|
||||||
This directive will not cause the running task to be preempted.
|
This parameter is the partition identifier.
|
||||||
|
|
||||||
Returning a buffer to a global partition which does not reside on the local
|
``buffer``
|
||||||
node will generate a request telling the remote node to return the buffer
|
This parameter is the pointer to the buffer to return.
|
||||||
to the specified partition.
|
|
||||||
|
|
||||||
Returning a buffer multiple times is an error. It will corrupt the
|
.. rubric:: DESCRIPTION:
|
||||||
internal state of the partition.
|
|
||||||
|
This directive returns the buffer specified by ``buffer`` to the partition
|
||||||
|
specified by ``id``.
|
||||||
|
|
||||||
|
.. rubric:: RETURN VALUES:
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_SUCCESSFUL`
|
||||||
|
The requested operation was successful.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_ID`
|
||||||
|
There was no partition with the specified identifier.
|
||||||
|
|
||||||
|
:c:macro:`RTEMS_INVALID_ADDRESS`
|
||||||
|
The buffer referenced by ``buffer`` was not in the partition.
|
||||||
|
|
||||||
|
.. rubric:: NOTES:
|
||||||
|
|
||||||
|
This directive will not cause the running task to be preempted.
|
||||||
|
|
||||||
|
Returning a buffer to a global partition which does not reside on the local
|
||||||
|
node will generate a request telling the remote node to return the buffer to
|
||||||
|
the partition.
|
||||||
|
|
||||||
|
Returning a buffer multiple times is an error. It will corrupt the internal
|
||||||
|
state of the partition.
|
||||||
|
|||||||
@ -1,19 +1,45 @@
|
|||||||
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
|
||||||
|
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
|
||||||
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
|
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
|
||||||
|
|
||||||
|
.. This file is part of the RTEMS quality process and was automatically
|
||||||
|
.. generated. If you find something that needs to be fixed or
|
||||||
|
.. worded better please post a report or patch to an RTEMS mailing list
|
||||||
|
.. or raise a bug report:
|
||||||
|
..
|
||||||
|
.. https://docs.rtems.org/branches/master/user/support/bugs.html
|
||||||
|
..
|
||||||
|
.. For information on updating and regenerating please refer to:
|
||||||
|
..
|
||||||
|
.. https://docs.rtems.org/branches/master/eng/req/howto.html
|
||||||
|
|
||||||
|
.. Generated from spec:/rtems/part/if/group
|
||||||
|
|
||||||
|
.. _PartitionManagerIntroduction:
|
||||||
|
|
||||||
Introduction
|
Introduction
|
||||||
============
|
============
|
||||||
|
|
||||||
The partition manager provides facilities to dynamically allocate memory in
|
.. The following list was generated from:
|
||||||
fixed-size units. The directives provided by the partition manager are:
|
.. spec:/rtems/part/if/create
|
||||||
|
.. spec:/rtems/part/if/ident
|
||||||
|
.. spec:/rtems/part/if/delete
|
||||||
|
.. spec:/rtems/part/if/get-buffer
|
||||||
|
.. spec:/rtems/part/if/return-buffer
|
||||||
|
|
||||||
- :ref:`rtems_partition_create`
|
The Partition Manager provides facilities to dynamically allocate memory in
|
||||||
|
fixed-size units. The directives provided by the Partition Manager are:
|
||||||
|
|
||||||
- :ref:`rtems_partition_ident`
|
* :ref:`InterfaceRtemsPartitionCreate` - Creates a partition.
|
||||||
|
|
||||||
- :ref:`rtems_partition_delete`
|
* :ref:`InterfaceRtemsPartitionIdent` - Identifies a partition by the object
|
||||||
|
name.
|
||||||
|
|
||||||
- :ref:`rtems_partition_get_buffer`
|
* :ref:`InterfaceRtemsPartitionDelete` - Deletes the partition.
|
||||||
|
|
||||||
- :ref:`rtems_partition_return_buffer`
|
* :ref:`InterfaceRtemsPartitionGetBuffer` - Tries to get a buffer from the
|
||||||
|
partition.
|
||||||
|
|
||||||
|
* :ref:`InterfaceRtemsPartitionReturnBuffer` - Returns the buffer to the
|
||||||
|
partition.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user