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

Subversion Repositories openrisc_me

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

Go to most recent revision | 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: mbox.inl,v 1.2 2001-09-27 11:59:13 chris Exp $
 */
 
#ifndef __ITRON_MAILBOX_inl_
#define __ITRON_MAILBOX_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 */
 

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: mbox.inl,v 1.2 2001-09-27 11:59:13 chris Exp $`
10			`*/`
11
12			`#ifndef __ITRON_MAILBOX_inl_`
13			`#define __ITRON_MAILBOX_inl_`
14
15			`#ifdef __cplusplus`
16			`extern "C" {`
17			`#endif`
18
19			`/*`
20			`* _ITRON_Mailbox_Allocate`
21			`*`
22			`* DESCRIPTION:`
23			`*`
24			`* This routine allocates the mailbox associated with the specified`
25			`* mailbox ID from the pool of inactive mailboxs.`
26			`*`
27			`* Input parameters:`
28			`* mbxid - id of mailbox to allocate`
29			`* status - pointer to status variable`
30			`*`
31			`* Output parameters:`
32			`* returns - pointer to the mailbox control block`
33			`* *status - status`
34			`*/`
35
36			`RTEMS_INLINE_ROUTINE ITRON_Mailbox_Control *_ITRON_Mailbox_Allocate(`
37			`ID mbxid`
38			`)`
39			`{`
40			`return (ITRON_Mailbox_Control *)_ITRON_Objects_Allocate_by_index(`
41			`&_ITRON_Mailbox_Information,`
42			`mbxid,`
43			`sizeof(ITRON_Mailbox_Control)`
44			`);`
45			`}`
46
47			`/*`
48			`* _ITRON_Mailbox_Clarify_allocation_id_error`
49			`*`
50			`* This function is invoked when an object allocation ID error`
51			`* occurs to determine the specific ITRON error code to return.`
52			`*/`
53
54			`#define _ITRON_Mailbox_Clarify_allocation_id_error( _id ) \`
55			`_ITRON_Objects_Clarify_allocation_id_error( \`
56			`&_ITRON_Mailbox_Information, (_id) )`
57
58			`/*`
59			`* _ITRON_Mailbox_Clarify_get_id_error`
60			`*`
61			`* This function is invoked when an object get ID error`
62			`* occurs to determine the specific ITRON error code to return.`
63			`*/`
64
65			`#define _ITRON_Mailbox_Clarify_get_id_error( _id ) \`
66			`_ITRON_Objects_Clarify_get_id_error( &_ITRON_Mailbox_Information, (_id) )`
67
68			`/*`
69			`* _ITRON_Mailbox_Free`
70			`*`
71			`* DESCRIPTION:`
72			`*`
73			`* This routine frees a mailbox control block to the`
74			`* inactive chain of free mailbox control blocks.`
75			`*`
76			`* Input parameters:`
77			`* the_mailbox - pointer to mailbox control block`
78			`*`
79			`* Output parameters: NONE`
80			`*/`
81
82			`RTEMS_INLINE_ROUTINE void _ITRON_Mailbox_Free (`
83			`ITRON_Mailbox_Control *the_mailbox`
84			`)`
85			`{`
86			`_ITRON_Objects_Free( &_ITRON_Mailbox_Information, &the_mailbox->Object );`
87			`}`
88
89			`/*PAGE`
90			`*`
91			`* _ITRON_Mailbox_Get`
92			`*`
93			`* DESCRIPTION:`
94			`*`
95			`* This function maps mailbox IDs to mailbox control blocks.`
96			`* If ID corresponds to a local mailbox, then it returns`
97			`* the_mailbox control pointer which maps to ID and location`
98			`* is set to OBJECTS_LOCAL. if the mailbox ID is global and`
99			`* resides on a remote node, then location is set to OBJECTS_REMOTE,`
100			`* and the_mailbox is undefined. Otherwise, location is set`
101			`* to OBJECTS_ERROR and the_mailbox is undefined.`
102			`*`
103			`* Input parameters:`
104			`* id - ITRON mailbox ID.`
105			`* the_location - pointer to a location variable`
106			`*`
107			`* Output parameters:`
108			`* *the_location - location of the object`
109			`*/`
110
111			`RTEMS_INLINE_ROUTINE ITRON_Mailbox_Control *_ITRON_Mailbox_Get (`
112			`ID id,`
113			`Objects_Locations *location`
114			`)`
115			`{`
116			`return (ITRON_Mailbox_Control *)`
117			`_ITRON_Objects_Get( &_ITRON_Mailbox_Information, id, location );`
118			`}`
119
120			`/*PAGE`
121			`*`
122			`* _ITRON_Mailbox_Is_null`
123			`*`
124			`* This function returns TRUE if the_mailbox is NULL and FALSE otherwise.`
125			`*`
126			`* Input parameters:`
127			`* the_mailbox - pointer to mailbox control block`
128			`*`
129			`* Output parameters:`
130			`* TRUE - if the_mailbox is NULL`
131			`* FALSE - otherwise`
132			`*/`
133
134			`RTEMS_INLINE_ROUTINE boolean _ITRON_Mailbox_Is_null (`
135			`ITRON_Mailbox_Control *the_mailbox`
136			`)`
137			`{`
138			`return ( the_mailbox == NULL );`
139			`}`
140
141			`/*`
142			`* XXX insert inline routines here`
143			`*/`
144
145			`#ifdef __cplusplus`
146			`}`
147			`#endif`
148
149			`#endif`
150			`/* end of include file */`
151

Browse

Tools

Subversion Repositories openrisc_me

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