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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
|
/**
* @file fapiAttributeService.H
*
* @brief Defines the FAPI_ATTR_GET and FAPI_ATTR_SET macros that a user calls
* to get/set attributes and the AttributeService functions that the
* macros use to get/set attributes
*/
#ifndef FAPIATTRIBUTESERVICE_H_
#define FAPIATTRIBUTESERVICE_H_
#include <stdint.h>
#include <fapiAttributeIds.H>
#include <fapiReturnCode.H>
#include <fapiTarget.H>
/**
* @brief Macros called by user to get/set attributes
*
* @note The user must use these macros rather than use the AttributeService
* _get/_set functions so that the type can be checked at compile time
*
* Code must have a pointer to a Target and an attribute ID (from XML file):
* fapi::ReturnCode l_rc;
* fapi::Target * l_pTarget = ????;
* AttributeId l_id = ????;
*
* To get a copy of a string attribute
* char * l_pString = NULL;
* l_rc = FAPI_ATTR_GET(l_id, l_pTarget, l_pString);
* delete[] l_pString; // When finished with the attribute
*
* To set a string attribute
* l_rc = FAPI_ATTR_SET(l_id, l_pTarget, "string-literal");
* l_rc = FAPI_ATTR_SET(l_id, l_pTarget, l_pString);
*
* To get a copy of an integer attribute and set the attribute
* uint64_t l_val = 0;
* l_rc = FAPI_ATTR_GET(l_id, l_pTarget, l_val);
* l_rc = FAPI_ATTR_SET(l_id, l_pTarget, l_val);
*
* To get a copy of an integer array attribute and set the attribute
* uint32_t l_pVal[4] = {0};
* l_rc = FAPI_ATTR_GET(l_id, l_pTarget, l_pVal);
* l_rc = FAPI_ATTR_SET(l_id, l_pTarget, l_pVal);
*/
#define FAPI_ATTR_GET(ID, PTARGET, VAL) \
fapi::AttributeService::_get<fapi::ID##_Type>(fapi::ID, PTARGET, VAL)
#define FAPI_ATTR_SET(ID, PTARGET, VAL) \
fapi::AttributeService::_set<fapi::ID##_Type>(fapi::ID, PTARGET, VAL)
namespace fapi
{
/**
* @namespace AttributeService
*
* This class defines the attribute access functions. These functions must not
* be accessed directly, they should only be called by the FAPI_ATTR_GET and
* FAPI_ATTR_SET macros.
*
* Each function comes in two parts. If the caller of FAPI_ATTR_GET attempts to
* get an incorrect type then the normal template function will be instantiated
* and the construction of the undefined InvalidTypeRequestedForAttribute class
* will cause a compile failure. Only if the caller attempts to get the correct
* type will the specialized function be called which will work.
*/
namespace AttributeService
{
/**
* @brief Forward declaration of class that will never be defined
*/
class InvalidTypeRequestedForAttribute;
/**
* @brief Get a copy of a string attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated with
* (NULL if system attribute)
* @param[out] o_pValue Reference to pointer that will be set to point to newly
* allocated memory holding the attribute value
*
* @return ReturnCode. Zero on success, else error.
*
* @note The caller must free the data with "delete [] o_pValue"
*/
template<typename T>
ReturnCode _get(const AttributeId i_id,
const Target * const i_pTarget,
char * & o_pValue)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _get<char *> (const AttributeId i_id,
const Target * const i_pTarget,
char * & o_value);
/**
* @brief Get a copy of a uint8_t attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated with
* (NULL if system attribute)
* @param[out] o_value Reference to data that will be set to the attribute val
*
* @return ReturnCode. Zero on success, else error.
*/
template<typename T>
ReturnCode _get(const AttributeId i_id,
const Target * const i_pTarget,
uint8_t& o_value)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _get<uint8_t> (const AttributeId i_id,
const Target * const i_pTarget,
uint8_t & o_value);
/**
* @brief Get a copy of a uint32_t attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated with
* (NULL if system attribute)
* @param[out] o_value Reference to data that will be set to the attribute val
*
* @return ReturnCode. Zero on success, else error.
*/
template<typename T>
ReturnCode _get(const AttributeId i_id,
const Target * const i_pTarget,
uint32_t& o_value)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _get<uint32_t> (const AttributeId i_id,
const Target * const i_pTarget,
uint32_t & o_value);
/**
* @brief Get a copy of a uint64_t attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated with
* (NULL if system attribute)
* @param[out] o_value Reference to data that will be set to the attribute val
*
* @return ReturnCode. Zero on success, else error.
*/
template<typename T>
ReturnCode _get(const AttributeId i_id,
const Target * const i_pTarget,
uint64_t& o_value)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _get<uint64_t> (const AttributeId i_id,
const Target * const i_pTarget,
uint64_t & o_value);
/**
* @brief Get a copy of a uint8_t array attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated with
* (NULL if system attribute)
* @param[out] o_pValues Pointer to data that will be set to the attribute value
*
* @return ReturnCode. Zero on success, else error.
*
* @note The caller's o_pValues pointer must point to memory large enough to
* hold the attribute.
*/
template<typename T>
ReturnCode _get(const AttributeId i_id,
const Target * const i_pTarget,
uint8_t * const o_pValues)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _get<uint8_t *> (const AttributeId i_id,
const Target * const i_pTarget,
uint8_t * const o_pValues);
/**
* @brief Get a copy of a uint32_t array attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated with
* (NULL if system attribute)
* @param[out] o_pValues Pointer to data that will be set to the attribute value
*
* @return ReturnCode. Zero on success, else error.
*
* @note The caller's o_pValues pointer must point to memory large enough to
* hold the attribute.
*/
template<typename T>
ReturnCode _get(const AttributeId i_id,
const Target * const i_pTarget,
uint32_t * const o_pValues)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _get<uint32_t *> (const AttributeId i_id,
const Target * const i_pTarget,
uint32_t * const o_pValues);
/**
* @brief Get a copy of a uint64_t array attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated with
* (NULL if system attribute)
* @param[out] o_pValues Pointer to data that will be set to the attribute value
*
* @return ReturnCode. Zero on success, else error.
*
* @note The caller's o_pValues pointer must point to memory large enough to
* hold the attribute.
*/
template<typename T>
ReturnCode _get(const AttributeId i_id,
const Target * const i_pTarget,
uint64_t * const o_pValues)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _get<uint64_t *> (const AttributeId i_id,
const Target * const i_pTarget,
uint64_t * const o_pValues);
/**
* @brief Set a string attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated with
* (NULL if system attribute)
* @param[in] i_pValue Pointer to string containing the attribute value to set
*
* @return ReturnCode. Zero on success, else error.
*/
template<typename T>
ReturnCode _set(const AttributeId i_id,
const Target * const i_pTarget,
const char * const i_pValue)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _set<char *> (const AttributeId i_id,
const Target * const i_pTarget,
const char * const i_pValue);
/**
* @brief Set a uint8_t attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated with
* (NULL if system attribute)
* @param[in] i_value Attribute value to set
*
* @return ReturnCode. Zero on success, else error.
*/
template<typename T>
ReturnCode _set(const AttributeId i_id,
const Target * const i_pTarget,
const uint8_t i_value)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _set<uint8_t> (const AttributeId i_id,
const Target * const i_pTarget,
const uint8_t i_value);
/**
* @brief Set a uint32_t attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated with
* (NULL if system attribute)
* @param[in] i_value Attribute value to set
*
* @return ReturnCode. Zero on success, else error.
*/
template<typename T>
ReturnCode _set(const AttributeId i_id,
const Target * const i_pTarget,
const uint32_t i_value)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _set<uint32_t> (const AttributeId i_id,
const Target * const i_pTarget,
const uint32_t i_value);
/**
* @brief Set a uint64_t attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated with
* (NULL if system attribute)
* @param[in] i_value Attribute value to set
*
* @return ReturnCode. Zero on success, else error.
*/
template<typename T>
ReturnCode _set(const AttributeId i_id,
const Target * const i_pTarget,
const uint64_t i_value)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _set<uint64_t> (const AttributeId i_id,
const Target * const i_pTarget,
const uint64_t i_value);
/**
* @brief Set a uint8_t array attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated
* with (NULL if system attribute)
* @param[out] i_pValues Pointer to array containing the attribute values to
* set
*
* @return ReturnCode. Zero on success, else error.
*
* @note The caller's o_pValues pointer must point to memory large enough to
* hold the attribute.
*/
template<typename T>
ReturnCode _set(const AttributeId i_id,
const Target * const i_pTarget,
const uint8_t * const i_pValues)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _set<uint8_t *> (const AttributeId i_id,
const Target * const i_pTarget,
const uint8_t * const i_pValues);
/**
* @brief Set a uint32_t array attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated
* with (NULL if system attribute)
* @param[out] i_pValues Pointer to array containing the attribute values to
* set
*
* @return ReturnCode. Zero on success, else error.
*
* @note The caller's o_pValues pointer must point to memory large enough to
* hold the attribute.
*/
template<typename T>
ReturnCode _set(const AttributeId i_id,
const Target * const i_pTarget,
const uint32_t * const i_pValues)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _set<uint32_t *> (const AttributeId i_id,
const Target * const i_pTarget,
const uint32_t * const i_pValues);
/**
* @brief Set a uint64_t array attribute
*
* @param[in] i_id Attribute ID
* @param[in] i_pTarget Pointer to Target that the attribute is associated
* with (NULL if system attribute)
* @param[out] i_pValues Pointer to array containing the attribute values to
* set
*
* @return ReturnCode. Zero on success, else error.
*
* @note The caller's o_pValues pointer must point to memory large enough to
* hold the attribute.
*/
template<typename T>
ReturnCode _set(const AttributeId i_id,
const Target * const i_pTarget,
const uint64_t * const i_pValues)
{
InvalidTypeRequestedForAttribute();
return FAPI_RC_SUCCESS;
}
template<> // Specialized template function defined in fapiAttributeService.C
ReturnCode _set<uint64_t *> (const AttributeId i_id,
const Target * const i_pTarget,
const uint64_t * const i_pValues);
} // namespace AttributeService
} // namespace fapi
#endif // FAPIATTRIBUTESERVICE_H_
|
