summaryrefslogtreecommitdiffstats
path: root/cpukit/itron/inline/rtems/itron/mbox.inl
blob: d824a70de1712c369a3e19ae0c31c77ff6001521 (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/**
 * @file rtems/itron/mbox.inl
 */

/*
 *  COPYRIGHT (c) 1989-1999.
 *  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_ITRON_MBOX_H
# error "Never use <rtems/itron/mbox.inl> directly; include <rtems/itron/mbox.h> instead."
#endif

#ifndef _RTEMS_ITRON_MBOX_INL
#define _RTEMS_ITRON_MBOX_INL

#ifdef __cplusplus
extern "C" {
#endif

/*
 *  _ITRON_Mailbox_Allocate
 *
 *  DESCRIPTION:
 *
 *  This routine allocates the mailbox associated with the specified
 *  mailbox ID from the pool of inactive mailboxs.
 *
 *  Input parameters:
 *    mbxid   - id of mailbox to allocate
 *    status  - pointer to status variable
 *
 *  Output parameters:
 *    returns - pointer to the mailbox control block
 *    *status - status
 */

RTEMS_INLINE_ROUTINE ITRON_Mailbox_Control *_ITRON_Mailbox_Allocate(
  ID   mbxid
)
{
  return (ITRON_Mailbox_Control *)_ITRON_Objects_Allocate_by_index(
    &_ITRON_Mailbox_Information,
    mbxid,
    sizeof(ITRON_Mailbox_Control)
  );
}

/*
 *  _ITRON_Mailbox_Clarify_allocation_id_error
 *
 *  This function is invoked when an object allocation ID error
 *  occurs to determine the specific ITRON error code to return.
 */

#define _ITRON_Mailbox_Clarify_allocation_id_error( _id ) \
  _ITRON_Objects_Clarify_allocation_id_error( \
      &_ITRON_Mailbox_Information, (_id) )

/*
 *  _ITRON_Mailbox_Clarify_get_id_error
 *
 *  This function is invoked when an object get ID error
 *  occurs to determine the specific ITRON error code to return.
 */

#define _ITRON_Mailbox_Clarify_get_id_error( _id ) \
 _ITRON_Objects_Clarify_get_id_error( &_ITRON_Mailbox_Information, (_id) )

/*
 *  _ITRON_Mailbox_Free
 *
 *  DESCRIPTION:
 *
 *  This routine frees a mailbox control block to the
 *  inactive chain of free mailbox control blocks.
 *
 *  Input parameters:
 *    the_mailbox - pointer to mailbox control block
 *
 *  Output parameters: NONE
 */

RTEMS_INLINE_ROUTINE void _ITRON_Mailbox_Free (
  ITRON_Mailbox_Control *the_mailbox
)
{
  _ITRON_Objects_Free( &_ITRON_Mailbox_Information, &the_mailbox->Object );
}

/*PAGE
 *
 *  _ITRON_Mailbox_Get
 *
 *  DESCRIPTION:
 *
 *  This function maps mailbox IDs to mailbox control blocks.
 *  If ID corresponds to a local mailbox, then it returns
 *  the_mailbox control pointer which maps to ID and location
 *  is set to OBJECTS_LOCAL.  if the mailbox ID is global and
 *  resides on a remote node, then location is set to OBJECTS_REMOTE,
 *  and the_mailbox is undefined.  Otherwise, location is set
 *  to OBJECTS_ERROR and the_mailbox is undefined.
 *
 *  Input parameters:
 *    id            - ITRON mailbox ID.
 *    the_location  - pointer to a location variable
 *
 *  Output parameters:
 *    *the_location  - location of the object
 */

RTEMS_INLINE_ROUTINE ITRON_Mailbox_Control *_ITRON_Mailbox_Get (
  ID                 id,
  Objects_Locations *location
)
{
  return (ITRON_Mailbox_Control *)
    _ITRON_Objects_Get( &_ITRON_Mailbox_Information, id, location );
}

/*PAGE
 *
 *  _ITRON_Mailbox_Is_null
 *
 *  This function returns TRUE if the_mailbox is NULL and FALSE otherwise.
 *
 *  Input parameters:
 *    the_mailbox - pointer to mailbox control block
 *
 *  Output parameters:
 *    TRUE  - if the_mailbox is NULL
 *    FALSE - otherwise
 */

RTEMS_INLINE_ROUTINE boolean _ITRON_Mailbox_Is_null (
  ITRON_Mailbox_Control *the_mailbox
)
{
  return ( the_mailbox == NULL );
}

/*  
 *  XXX insert inline routines here
 */ 

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */