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
|
/**
* @file
*
* @ingroup ClassicChains
*
* @brief Chain API.
*/
/*
* Copyright (c) 2010 embedded brains GmbH.
*
* COPYRIGHT (c) 1989-2008.
* 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_CHAIN_H
#define _RTEMS_CHAIN_H
#include <rtems/system.h>
#include <rtems/score/chain.h>
#include <rtems/rtems/event.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup ClassicChains Chains
*
* @ingroup ClassicRTEMS
*
* @brief Chain API.
*
* @{
*/
typedef Chain_Node rtems_chain_node;
typedef Chain_Control rtems_chain_control;
/**
* @brief Chain initializer for an empty chain with designator @a name.
*/
#define RTEMS_CHAIN_INITIALIZER_EMPTY(name) \
CHAIN_INITIALIZER_EMPTY(name)
/**
* @brief Chain definition for an empty chain with designator @a name.
*/
#define RTEMS_CHAIN_DEFINE_EMPTY(name) \
CHAIN_DEFINE_EMPTY(name)
/** @} */
#include <rtems/chain.inl>
/**
* @addtogroup ClassicChains
*
* @{
*/
/**
* @brief Appends the @a node to the @a chain and sends the @a events to the
* @a task if the @a chain was empty before the append.
*
* @see rtems_chain_append_with_empty_check() and rtems_event_send().
*
* @retval RTEMS_SUCCESSFUL Successful operation.
* @retval RTEMS_INVALID_ID No such task.
*/
rtems_status_code rtems_chain_append_with_notification(
rtems_chain_control *chain,
rtems_chain_node *node,
rtems_id task,
rtems_event_set events
);
/**
* @brief Prepends the @a node to the @a chain and sends the @a events to the
* @a task if the @a chain was empty before the prepend.
*
* @see rtems_chain_prepend_with_empty_check() and rtems_event_send().
*
* @retval RTEMS_SUCCESSFUL Successful operation.
* @retval RTEMS_INVALID_ID No such task.
*/
rtems_status_code rtems_chain_prepend_with_notification(
rtems_chain_control *chain,
rtems_chain_node *node,
rtems_id task,
rtems_event_set events
);
/**
* @brief Gets the first @a node of the @a chain and sends the @a events to the
* @a task if the @a chain is empty after the get.
*
* @see rtems_chain_get_with_empty_check() and rtems_event_send().
*
* @retval RTEMS_SUCCESSFUL Successful operation.
* @retval RTEMS_INVALID_ID No such task.
*/
rtems_status_code rtems_chain_get_with_notification(
rtems_chain_control *chain,
rtems_id task,
rtems_event_set events,
rtems_chain_node **node
);
/**
* @brief Gets the first @a node of the @a chain and sends the @a events to the
* @a task if the @a chain is empty afterwards.
*
* @see rtems_chain_get() and rtems_event_receive().
*
* @retval RTEMS_SUCCESSFUL Successful operation.
* @retval RTEMS_TIMEOUT Timeout.
*/
rtems_status_code rtems_chain_get_with_wait(
rtems_chain_control *chain,
rtems_event_set events,
rtems_interval timeout,
rtems_chain_node **node
);
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
