source: rtems/cpukit/posix/include/rtems/posix/priority.h @ 1de949a8

/**
 * @file rtems/posix/priority.h
 */

/*
 *  COPYRIGHT (c) 1989-2008.
 *  On-Line Applications Research Corporation (OAR).
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.com/license/LICENSE.
 *
 *  $Id$
 */

#ifndef _RTEMS_POSIX_PRIORITY_H
#define _RTEMS_POSIX_PRIORITY_H

#include <rtems/score/priority.h>

/**
 *  1003.1b-1993,2.2.2.80 definition of priority, p. 19
 *
 *  "Numerically higher values represent higher priorities."
 *
 *  Thus, RTEMS Core has priorities run in the opposite sense of the POSIX API.
 *
 *  There are only 254 posix priority levels since a task at priority level
 *  255 would never run because of the RTEMS idle task.  This is necessary
 *  because GNAT maps the lowest Ada task priority to the lowest thread
 *  priority.  The lowest priority Ada task should get to run, so there is
 *  a fundamental conflict with having 255 priorities.
 *
 *  But since RTEMS can be configured with fewer than 256 priorities,
 *  we use the internal constant.
 */
#define POSIX_SCHEDULER_MAXIMUM_PRIORITY (PRIORITY_MAXIMUM - 1)


/**
 *  This is the numerically least important POSIX priority.
 */
#define POSIX_SCHEDULER_MINIMUM_PRIORITY (1)

/**
 *  1003.1b-1993,2.2.2.80 definition of priority, p. 19
 *
 *  "Numerically higher values represent higher priorities."
 *
 *  Thus, RTEMS Core has priorities run in the opposite sense of the POSIX API.
 *
 *  @param[in] priority is the priority to test
 *
 *  @return This method returns true if the priority is valid and
 *          false otherwise.
 */
bool _POSIX_Priority_Is_valid(
  int priority
);

/**
 *  @brief Convert POSIX Priority To SuperCore Priority
 *
 *  This method converts a POSIX API priority into onto the corresponding
 *  SuperCore value.
 *
 *  @param[in] priority is the POSIX API priority.
 *
 *  @return This method returns the corresponding SuperCore priority.
 */
RTEMS_INLINE_ROUTINE Priority_Control _POSIX_Priority_To_core(
  int priority
);

/**
 *  @brief Convert SuperCore Priority To POSIX Priority
 *
 *  This method converts a SuperCore priority into onto the corresponding
 *  POSIX API value.
 *
 *  @param[in] priority is the POSIX API priority.
 *
 *  @return This method returns the corresponding POSIX priority.
 */
RTEMS_INLINE_ROUTINE int _POSIX_Priority_From_core(
  Priority_Control priority
);

#include <rtems/posix/priority.inl>

#endif