URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [rtos/] [rtems/] [c/] [src/] [exec/] [itron/] [inline/] [rtems/] [itron/] [msgbuffer.inl] - Blame information for rev 173

Details | Compare with Previous | View Log


/*
 *  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.OARcorp.com/rtems/license.html.
 *
 *  $Id: msgbuffer.inl,v 1.2 2001-09-27 11:59:13 chris Exp $
 */
 
#ifndef __ITRON_MESSAGE_BUFFER_inl_
#define __ITRON_MESSAGE_BUFFER_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 */
 

Line No.	Rev	Author	Line
1	30	unneback	`/*`
2			`* COPYRIGHT (c) 1989-1999.`
3			`* On-Line Applications Research Corporation (OAR).`
4			`*`
5			`* The license and distribution terms for this file may be`
6			`* found in the file LICENSE in this distribution or at`
7			`* http://www.OARcorp.com/rtems/license.html.`
8			`*`
9			`* $Id: msgbuffer.inl,v 1.2 2001-09-27 11:59:13 chris Exp $`
10			`*/`
11
12			`#ifndef __ITRON_MESSAGE_BUFFER_inl_`
13			`#define __ITRON_MESSAGE_BUFFER_inl_`
14
15			`#ifdef __cplusplus`
16			`extern "C" {`
17			`#endif`
18
19			`/*`
20			`* _ITRON_Message_buffer_Allocate`
21			`*`
22			`* DESCRIPTION:`
23			`*`
24			`* This routine allocates the message buffer associated with the specified`
25			`* message buffer ID from the pool of inactive message buffers.`
26			`*`
27			`* Input parameters:`
28			`* mbfid - id of message buffer to allocate`
29			`* status - pointer to status variable`
30			`*`
31			`* Output parameters:`
32			`* returns - pointer to the message buffer control block`
33			`* *status - status`
34			`*/`
35
36			`RTEMS_INLINE_ROUTINE ITRON_Message_buffer_Control`
37			`*_ITRON_Message_buffer_Allocate(`
38			`ID mbfid`
39			`)`
40			`{`
41			`return (ITRON_Message_buffer_Control *)_ITRON_Objects_Allocate_by_index(`
42			`&_ITRON_Message_buffer_Information,`
43			`mbfid,`
44			`sizeof(ITRON_Message_buffer_Control)`
45			`);`
46			`}`
47
48			`/*`
49			`* _ITRON_Message_buffer_Clarify_allocation_id_error`
50			`*`
51			`* This function is invoked when an object allocation ID error`
52			`* occurs to determine the specific ITRON error code to return.`
53			`*/`
54
55			`#define _ITRON_Message_buffer_Clarify_allocation_id_error( _id ) \`
56			`_ITRON_Objects_Clarify_allocation_id_error( \`
57			`&_ITRON_Message_buffer_Information, (_id) )`
58
59			`/*`
60			`* _ITRON_Message_buffer_Clarify_get_id_error`
61			`*`
62			`* This function is invoked when an object get ID error`
63			`* occurs to determine the specific ITRON error code to return.`
64			`*/`
65
66			`#define _ITRON_Message_buffer_Clarify_get_id_error( _id ) \`
67			`_ITRON_Objects_Clarify_get_id_error( &_ITRON_Message_buffer_Information, (_id) )`
68
69			`/*`
70			`* _ITRON_Message_buffer_Free`
71			`*`
72			`* DESCRIPTION:`
73			`*`
74			`* This routine frees a message buffer control block to the`
75			`* inactive chain of free message buffer control blocks.`
76			`*`
77			`* Input parameters:`
78			`* the_message_buffer - pointer to message_buffer control block`
79			`*`
80			`* Output parameters: NONE`
81			`*/`
82
83			`RTEMS_INLINE_ROUTINE void _ITRON_Message_buffer_Free (`
84			`ITRON_Message_buffer_Control *the_message_buffer`
85			`)`
86			`{`
87			`_ITRON_Objects_Free(`
88			`&_ITRON_Message_buffer_Information,`
89			`&the_message_buffer->Object`
90			`);`
91			`}`
92
93			`/*PAGE`
94			`*`
95			`* _ITRON_Message_buffer_Get`
96			`*`
97			`* DESCRIPTION:`
98			`*`
99			`* This function maps message buffer IDs to message buffer control blocks.`
100			`* If ID corresponds to a local message buffer, then it returns`
101			`* the message buffer control pointer which maps to ID and location`
102			`* is set to OBJECTS_LOCAL. if the message buffer ID is global and`
103			`* resides on a remote node, then location is set to OBJECTS_REMOTE,`
104			`* and the message buffer is undefined. Otherwise, location is set`
105			`* to OBJECTS_ERROR and the message buffer is undefined.`
106			`*`
107			`* Input parameters:`
108			`* id - ITRON message_buffer ID.`
109			`* the_location - pointer to a location variable`
110			`*`
111			`* Output parameters:`
112			`* *the_location - location of the object`
113			`*/`
114
115			`RTEMS_INLINE_ROUTINE ITRON_Message_buffer_Control *_ITRON_Message_buffer_Get (`
116			`ID id,`
117			`Objects_Locations *location`
118			`)`
119			`{`
120			`return (ITRON_Message_buffer_Control *)`
121			`_ITRON_Objects_Get( &_ITRON_Message_buffer_Information, id, location );`
122			`}`
123
124			`/*PAGE`
125			`*`
126			`* _ITRON_Message_buffer_Is_null`
127			`*`
128			`* This function returns TRUE if the_message_buffer is NULL`
129			`* and FALSE otherwise.`
130			`*`
131			`* Input parameters:`
132			`* the_message_buffer - pointer to message buffer control block`
133			`*`
134			`* Output parameters:`
135			`* TRUE - if the_message_buffer is NULL`
136			`* FALSE - otherwise`
137			`*/`
138
139			`RTEMS_INLINE_ROUTINE boolean _ITRON_Message_buffer_Is_null (`
140			`ITRON_Message_buffer_Control *the_message_buffer`
141			`)`
142			`{`
143			`return ( the_message_buffer == NULL );`
144			`}`
145
146			`/*`
147			`* XXX insert inline routines here`
148			`*/`
149
150			`#ifdef __cplusplus`
151			`}`
152			`#endif`
153
154			`#endif`
155			`/* end of include file */`
156

Browse

Tools

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [rtos/] [rtems/] [c/] [src/] [exec/] [itron/] [inline/] [rtems/] [itron/] [msgbuffer.inl] - Blame information for rev 173