summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/inline/rtems/rtems/status.inl
blob: a518c102f30e3ca1dcac1162376ab5a362a64d33 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/**
 * @file rtems/rtems/status.inl
 *
 *  This include file contains the implementations of the inlined
 *  routines for the status package.
 */

/*  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_RTEMS_STATUS_H
# error "Never use <rtems/rtems/status.inl> directly; include <rtems/rtems/status.h> instead."
#endif

#ifndef _RTEMS_RTEMS_STATUS_INL
#define _RTEMS_RTEMS_STATUS_INL

#include <rtems/score/basedefs.h>

/**
 *  @addtogroup ClassicStatus
 *  @{
 */

/**
 *  @brief rtems_is_status_successful
 *
 *  This function returns TRUE if the status code is equal to RTEMS_SUCCESSFUL,
 *  and FALSE otherwise.
 */
RTEMS_INLINE_ROUTINE bool rtems_is_status_successful(
  rtems_status_code code
)
{
  return (code == RTEMS_SUCCESSFUL);
}

/**
 *  @brief rtems_are_statuses_equal
 *
 *  This function returns TRUE if the status code1 is equal to code2,
 *  and FALSE otherwise.
 */
RTEMS_INLINE_ROUTINE bool rtems_are_statuses_equal(
  rtems_status_code code1,
  rtems_status_code code2
)
{
   return (code1 == code2);
}

/**@}*/

#endif
/* end of include file */