RTEMS 4.6.0pre5 On-Line Library

Region Manager REGION_RETURN_SEGMENT - Return segment to a region

RTEMS C User's Guide

14.4.6: REGION_RETURN_SEGMENT - Return segment to a region

CALLING SEQUENCE:

rtems_status_code rtems_region_return_segment(
  rtems_id  id,
  void     *segment
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - segment returned successfully
RTEMS_INVALID_ID - invalid region id
RTEMS_INVALID_ADDRESS - segment address not in region

DESCRIPTION:

This directive returns the segment specified by segment to the region specified by id. The returned segment is merged with its neighbors to form the largest possible segment. The first task on the wait queue is examined to determine if its segment request can now be satisfied. If so, it is given a segment and unblocked. This process is repeated until the first task's segment request cannot be satisfied.

NOTES:

This directive will cause the calling task to be preempted if one or more local tasks are waiting for a segment and the following conditions exist:

a waiting task has a higher priority than the calling task
the size of the segment required by the waiting task is less than or equal to the size of the segment returned.

RTEMS C User's Guide