Changeset 9889463 in rtems-docs


Ignore:
Timestamp:
Jan 27, 2017, 7:06:56 AM (3 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
c660173
Parents:
dc3ef53
Message:

c-user: Clarify rtems_heap_extend()

Update #1747.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/region_manager.rst

    rdc3ef53 r9889463  
    155155memory being added.
    156156
    157 .. note::
    158 
    159   Please see the release notes or RTEMS source code for information regarding
    160   restrictions on the location of the memory being added in relation to memory
    161   already in the region.
    162 
    163157Acquiring a Segment
    164158-------------------
     
    418412
    419413DESCRIPTION:
    420     This directive adds the memory which starts at starting_address for length
    421     bytes to the region specified by id.
     414    This directive adds the memory area which starts at
     415    :c:data:`starting_address` for :c:data:`length` bytes to the region
     416    specified by :c:data:`id`.
     417
     418    There are no alignment requirements for the memory area.  The memory area
     419    must be big enough to contain some maintenance blocks.  It must not overlap
     420    parts of the current heap memory areas.  Disconnected memory areas added to
     421    the heap will lead to used blocks which cover the gaps.  Extending with an
     422    inappropriate memory area will corrupt the heap resulting in undefined
     423    behaviour.
    422424
    423425NOTES:
     
    426428
    427429    The calling task does not have to be the task that created the region.  Any
    428     local task that knows the region id can extend the region.
     430    local task that knows the region identifier can extend the region.
    429431
    430432.. raw:: latex
Note: See TracChangeset for help on using the changeset viewer.