summaryrefslogtreecommitdiffstats
path: root/cpukit/itron/inline/rtems/itron/msgbuffer.inl
blob: 4790fdd1589e399bd7ba644c1abbf9cc5c7f80e6 (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
160
/**
 * @file rtems/itron/msgbuffer.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_MSGBUFFER_INL
#define _RTEMS_ITRON_MSGBUFFER_INL

#ifdef __cplusplus
extern "C" {
#endif

/*
 *  _ITRON_Message_buffer_Allocate
 *
 *  DESCRIPTION:
 *
 *  This routine allocates the message buffer associated with the specified
 *  message buffer ID from the pool of inactive message buffers.
 *
 *  Input parameters:
 *    mbfid   - id of message buffer to allocate
 *    status  - pointer to status variable
 *
 *  Output parameters:
 *    returns - pointer to the message buffer control block
 *    *status - status
 */

RTEMS_INLINE_ROUTINE ITRON_Message_buffer_Control
 *_ITRON_Message_buffer_Allocate(
  ID   mbfid
)
{
  return (ITRON_Message_buffer_Control *)_ITRON_Objects_Allocate_by_index(
    &_ITRON_Message_buffer_Information,
    mbfid,
    sizeof(ITRON_Message_buffer_Control)
  );
}

/*
 *  _ITRON_Message_buffer_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_Message_buffer_Clarify_allocation_id_error( _id ) \
  _ITRON_Objects_Clarify_allocation_id_error( \
      &_ITRON_Message_buffer_Information, (_id) )

/*
 *  _ITRON_Message_buffer_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_Message_buffer_Clarify_get_id_error( _id ) \
 _ITRON_Objects_Clarify_get_id_error( &_ITRON_Message_buffer_Information, (_id) )

/*
 *  _ITRON_Message_buffer_Free
 *
 *  DESCRIPTION:
 *
 *  This routine frees a message buffer control block to the
 *  inactive chain of free message buffer control blocks.
 *
 *  Input parameters:
 *    the_message_buffer - pointer to message_buffer control block
 *
 *  Output parameters: NONE
 */

RTEMS_INLINE_ROUTINE void _ITRON_Message_buffer_Free (
  ITRON_Message_buffer_Control *the_message_buffer
)
{
  _ITRON_Objects_Free(
    &_ITRON_Message_buffer_Information,
    &the_message_buffer->Object
  );
}

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

RTEMS_INLINE_ROUTINE ITRON_Message_buffer_Control *_ITRON_Message_buffer_Get (
  ID                 id,
  Objects_Locations *location
)
{
  return (ITRON_Message_buffer_Control *)
    _ITRON_Objects_Get( &_ITRON_Message_buffer_Information, id, location );
}

/*PAGE
 *
 *  _ITRON_Message_buffer_Is_null
 *
 *  This function returns TRUE if the_message_buffer is NULL
 *  and FALSE otherwise.
 *
 *  Input parameters:
 *    the_message_buffer - pointer to message buffer control block
 *
 *  Output parameters:
 *    TRUE  - if the_message_buffer is NULL
 *    FALSE - otherwise
 */

RTEMS_INLINE_ROUTINE boolean _ITRON_Message_buffer_Is_null (
  ITRON_Message_buffer_Control *the_message_buffer
)
{
  return ( the_message_buffer == NULL );
}

/*  
 *  XXX insert inline routines here
 */ 

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */