Changeset b5d29c9 in rtems-docs


Ignore:
Timestamp:
May 30, 2018, 8:52:39 AM (2 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, am, master
Children:
aaf9c78
Parents:
ecd9d18
git-author:
Sebastian Huber <sebastian.huber@…> (05/30/18 08:52:39)
git-committer:
Sebastian Huber <sebastian.huber@…> (06/05/18 05:04:43)
Message:

c-user: Update rtems_region_create()

File:
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/region_manager.rst

    recd9d18 rb5d29c9  
    256256     * - ``RTEMS_INVALID_ADDRESS``
    257257       - ``starting_address`` is NULL
    258      * - ``RTEMS_INVALID_ADDRESS``
    259        - address not on four byte boundary
    260258     * - ``RTEMS_TOO_MANY``
    261259       - too many regions created
    262260     * - ``RTEMS_INVALID_SIZE``
    263261       - invalid page size
    264 
    265 DESCRIPTION:
    266     This directive creates a region from a physically contiguous memory space
    267     which starts at starting_address and is length bytes long.  Segments
    268     allocated from the region will be a multiple of page_size bytes in length.
     262     * - ``RTEMS_INVALID_SIZE``
     263       - the memory area defined by the starting address and the length
     264         parameters is too small
     265
     266DESCRIPTION:
     267    This directive creates a region from a contiguous memory area
     268    which starts at starting_address and is length bytes long.  The memory area
     269    must be large enough to contain some internal region administration data.
     270    Segments allocated from the region will be a multiple of page_size bytes in
     271    length.  The specified page size will be aligned to an
     272    architecture-specific minimum alignment if necessary.
     273
    269274    The assigned region id is returned in id.  This region id is used as an
    270275    argument to other region related directives to access the region.
     
    279284    ``RTEMS_FIFO`` in attribute_set or selecting ``RTEMS_DEFAULT_ATTRIBUTES``
    280285    will cause waiting tasks to be serviced in First In-First Out order.
    281 
    282     The ``starting_address`` parameter must be aligned on a four byte boundary.
    283     The ``page_size`` parameter must be a multiple of four greater than or
    284     equal to eight.
    285286
    286287NOTES:
Note: See TracChangeset for help on using the changeset viewer.