summaryrefslogtreecommitdiffstats
path: root/cpukit/itron/inline/rtems/itron/task.inl
blob: c3345fd606fcf3d3eb0895934d8d5732bd2bd099 (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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/**
 * @file rtems/itron/task.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_TASK_H
# error "Never use <rtems/itron/task.inl> directly; include <rtems/itron/task.h> instead."
#endif

#ifndef _RTEMS_ITRON_TASK_INL
#define _RTEMS_ITRON_TASK_INL

#ifdef __cplusplus
extern "C" {
#endif

/*
 *  _ITRON_Task_Allocate
 *
 *  DESCRIPTION:
 *
 *  This routine allocates the task associated with the specified
 *  task ID from the pool of inactive tasks.
 *
 *  Input parameters:
 *    tskid   - id of task to allocate
 *    status  - pointer to status variable
 *
 *  Output parameters:
 *    returns - pointer to the task control block
 *    *status - status
 */

RTEMS_INLINE_ROUTINE Thread_Control *_ITRON_Task_Allocate(
  ID   tskid
)
{
  return (Thread_Control *)_ITRON_Objects_Allocate_by_index(
    &_ITRON_Task_Information,
    tskid,
    sizeof(Thread_Control)
  );
}

/*
 *  _ITRON_Task_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_Task_Clarify_allocation_id_error( _id ) \
  _ITRON_Objects_Clarify_allocation_id_error( \
      &_ITRON_Task_Information, (_id) )

/*
 *  _ITRON_Task_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_Task_Clarify_get_id_error( _id ) \
 _ITRON_Objects_Clarify_get_id_error( &_ITRON_Task_Information, (_id) )

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

RTEMS_INLINE_ROUTINE void _ITRON_Task_Free (
  Thread_Control *the_task
)
{
  _ITRON_Objects_Free( &_ITRON_Task_Information, &the_task->Object );
}

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

RTEMS_INLINE_ROUTINE Thread_Control *_ITRON_Task_Get (
  ID                 id,
  Objects_Locations *location
)
{ 
  if ( id == 0 ) {
    _Thread_Disable_dispatch();
    *location = OBJECTS_LOCAL;
    return _Thread_Executing;
  }

  return (Thread_Control *)
    _ITRON_Objects_Get( &_ITRON_Task_Information, id, location );
}

/*PAGE
 *
 *  _ITRON_Task_Is_null
 *
 *  This function returns TRUE if the_task is NULL and FALSE otherwise.
 *
 *  Input parameters:
 *    the_task - pointer to task control block
 *
 *  Output parameters:
 *    TRUE  - if the_task is NULL
 *    FALSE - otherwise
 */

RTEMS_INLINE_ROUTINE boolean _ITRON_Task_Is_null (
  Thread_Control *the_task
)
{
  return ( the_task == NULL );
}

/*  
 *  XXX insert inline routines here
 */ 

/*PAGE
 *
 *  _ITRON_tasks_Priority_to_Core
 */
 
RTEMS_INLINE_ROUTINE Priority_Control _ITRON_Task_Priority_to_Core( 
  PRI   ITRON_priority 
) 
{  
  return (Priority_Control) ITRON_priority;
}

/*PAGE
 *
 *  _ITRON_tasks_Core_to_Priority
 */
 
RTEMS_INLINE_ROUTINE PRI _ITRON_Task_Core_to_Priority( 
  Priority_Control  core_priority 
) 
{  
  return (PRI) core_priority;
}


#ifdef __cplusplus
}
#endif

#endif
/* end of include file */