summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2018-05-30 10:52:39 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2018-06-05 07:04:43 +0200
commitb5d29c996b6be3b9a17d68e2d6e8bde11dd5cd9f (patch)
tree58bff0309196355b77983d010dee52725e47272b
parentconfiguring_a_system.rst, scheduling_concepts.rst: Fix spelling of arbitrary. (diff)
downloadrtems-docs-b5d29c996b6be3b9a17d68e2d6e8bde11dd5cd9f.tar.bz2
c-user: Update rtems_region_create()
-rw-r--r--c-user/region_manager.rst19
1 files changed, 10 insertions, 9 deletions
diff --git a/c-user/region_manager.rst b/c-user/region_manager.rst
index 1bebd8a..6a894d7 100644
--- a/c-user/region_manager.rst
+++ b/c-user/region_manager.rst
@@ -255,17 +255,22 @@ DIRECTIVE STATUS CODES:
- ``id`` is NULL
* - ``RTEMS_INVALID_ADDRESS``
- ``starting_address`` is NULL
- * - ``RTEMS_INVALID_ADDRESS``
- - address not on four byte boundary
* - ``RTEMS_TOO_MANY``
- too many regions created
* - ``RTEMS_INVALID_SIZE``
- invalid page size
+ * - ``RTEMS_INVALID_SIZE``
+ - the memory area defined by the starting address and the length
+ parameters is too small
DESCRIPTION:
- This directive creates a region from a physically contiguous memory space
- which starts at starting_address and is length bytes long. Segments
- allocated from the region will be a multiple of page_size bytes in length.
+ This directive creates a region from a contiguous memory area
+ which starts at starting_address and is length bytes long. The memory area
+ must be large enough to contain some internal region administration data.
+ Segments allocated from the region will be a multiple of page_size bytes in
+ length. The specified page size will be aligned to an
+ architecture-specific minimum alignment if necessary.
+
The assigned region id is returned in id. This region id is used as an
argument to other region related directives to access the region.
@@ -279,10 +284,6 @@ DESCRIPTION:
``RTEMS_FIFO`` in attribute_set or selecting ``RTEMS_DEFAULT_ATTRIBUTES``
will cause waiting tasks to be serviced in First In-First Out order.
- The ``starting_address`` parameter must be aligned on a four byte boundary.
- The ``page_size`` parameter must be a multiple of four greater than or
- equal to eight.
-
NOTES:
This directive will obtain the allocator mutex and may cause the calling
task to be preempted.