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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSAPIAssociativity
*
* @brief RTEMS Associativity Routines
*/
/*
* Copyright (C) 1995 Tony Bennett <tbennett@divnc.com>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _RTEMS_RTEMS_ASSOC_H
#define _RTEMS_RTEMS_ASSOC_H
#include <stddef.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup RTEMSAPIAssociativity Associativity Routines
*
* @ingroup RTEMSAPI
*
* RTEMS associativity routines. Mainly used to convert a value from
* one space to another (eg: our errno's to host errno's and vice-versa)
*
* @{
*/
typedef struct {
const char *name;
uint32_t local_value;
uint32_t remote_value;
} rtems_assoc_t;
/*
* Flag/marker for optional default value in each table
*/
#define RTEMS_ASSOC_DEFAULT_NAME "(default)"
/**
* @brief RTEMS Associate Pointer by Name
*/
const rtems_assoc_t *rtems_assoc_ptr_by_name(
const rtems_assoc_t *,
const char *
);
/**
* @brief RTEMS Associate Pointer by Remote
*/
const rtems_assoc_t *rtems_assoc_ptr_by_remote(
const rtems_assoc_t *,
uint32_t
);
uint32_t rtems_assoc_remote_by_local(
const rtems_assoc_t *,
uint32_t
);
/**
* @brief RTEMS Associate Local by Remote
*/
uint32_t rtems_assoc_local_by_remote(
const rtems_assoc_t *,
uint32_t
);
/**
* @brief RTEMS Associate Remote by Name
*/
uint32_t rtems_assoc_remote_by_name(
const rtems_assoc_t *,
const char *
);
/**
* @brief RTEMS Associate Local by Name
*/
uint32_t rtems_assoc_local_by_name(
const rtems_assoc_t *,
const char *
);
/**
* @brief RTEMS Associate Name by Local
*/
const char *rtems_assoc_name_by_local(
const rtems_assoc_t *,
uint32_t
);
/**
* @brief RTEMS Associate Name by Remote
*/
const char *rtems_assoc_name_by_remote(
const rtems_assoc_t *,
uint32_t
);
/**
* @brief RTEMS Assoc Routines
*/
uint32_t rtems_assoc_remote_by_local_bitfield(
const rtems_assoc_t *,
uint32_t
);
/**
* @brief RTEMS Associate Name by Local Bitfield
*/
char *rtems_assoc_name_by_local_bitfield(
const rtems_assoc_t *,
uint32_t ,
char *
);
/**
* @brief RTEMS Associate Name by Remote Bitfield
*/
char *rtems_assoc_name_by_remote_bitfield(
const rtems_assoc_t *,
uint32_t ,
char *
);
uint32_t rtems_assoc_local_by_remote_bitfield(
const rtems_assoc_t *,
uint32_t
);
/**
* @brief RTEMS Associate Pointer by Local
*/
const rtems_assoc_t *rtems_assoc_ptr_by_local(
const rtems_assoc_t *ap,
uint32_t local_value
);
#if defined(INSIDE_ASSOC)
#define rtems_assoc_is_default(_ap) \
((_ap)->name && !strcmp((_ap)->name, RTEMS_ASSOC_DEFAULT_NAME))
/**
* @brief RTEMS Associate Bad Name
*
* what to return if a value is not found
* this is not reentrant, but it really shouldn't be invoked anyway
*/
const char *rtems_assoc_name_bad(
uint32_t bad_value
);
#endif
typedef struct {
uint32_t bits;
const char *name;
} rtems_assoc_32_pair;
/**
* @brief Converts the specified value into a text representation.
*
* @param[in] value The value to convert.
* @param[in] buffer The buffer for the text representation.
* @param[in] buffer_size The buffer size in characters.
* @param[in] pairs Names for particular bits.
* @param[in] pair_count Count of pairs.
* @param[in] separator Separator between individual names.
* @param[in] fallback Fallback value in case no bits contained in the pairs
* are set in the value.
*
* @retval The length of the text representation. May be greater than or equal
* to the buffer size if truncation occurred.
*/
size_t rtems_assoc_32_to_string(
uint32_t value,
char *buffer,
size_t buffer_size,
const rtems_assoc_32_pair *pairs,
size_t pair_count,
const char *separator,
const char *fallback
);
/**
* @brief Converts the specified thread states into a text representation.
*
* @param[in] states The thread states to convert.
* @param[in] buffer The buffer for the text representation.
* @param[in] buffer_size The buffer size in characters.
*
* @retval The length of the text representation. May be greater than or equal
* to the buffer size if truncation occurred.
*/
size_t rtems_assoc_thread_states_to_string(
uint32_t states,
char *buffer,
size_t buffer_size
);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* ! _RTEMS_RTEMS_ASSOC_H */
|
