iLLD_TC27xC
1.0
Ifx_GlobalResources.h
Go to the documentation of this file.
1
/**
2
* \file Ifx_GlobalResources.h
3
* \brief Handling of global resources
4
*
5
* \version iLLD_0_1_0_10
6
* \copyright Copyright (c) 2013 Infineon Technologies AG. All rights reserved.
7
*
8
*
9
* IMPORTANT NOTICE
10
*
11
*
12
* Infineon Technologies AG (Infineon) is supplying this file for use
13
* exclusively with Infineon's microcontroller products. This file can be freely
14
* distributed within development tools that are supporting such microcontroller
15
* products.
16
*
17
* THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED
18
* OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
19
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
20
* INFINEON SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL,
21
* OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
22
*
23
* \defgroup library_srvsw_sysse_general_globalresources Global resources
24
* This module implements the global resources handling
25
* \ingroup library_srvsw_sysse_general
26
*/
27
28
#ifndef IFX_GLOBALRESOURCES_H
29
#define IFX_GLOBALRESOURCES_H 1
30
31
#include "Ifx_Cfg.h"
32
#include "
Cpu/Std/Ifx_Types.h
"
33
34
#ifndef IFX_CFG_GLOBAL_RESOURCES_ENABLED
35
#define IFX_CFG_GLOBAL_RESOURCES_ENABLED (0)
36
#endif
37
38
typedef
struct
39
{
40
void
*
resource
;
41
pchar
name
;
42
}
Ifx_GlobalResources_Item
;
43
44
/** \addtogroup library_srvsw_sysse_general_globalresources
45
* \{ */
46
/** Return a pointer to the global resource
47
*
48
* \param id index of the Ifx_GlobalResources_Item in the table, the index starts with 0
49
*
50
* \return return Ifx_GlobalResources_Item.resource
51
*/
52
IFX_EXTERN
void
*
Ifx_GlobalResources_get
(
sint32
id
);
53
54
/** \brief Returns the global resource index.
55
*
56
* \return Returns the global resource index, -1 if not found
57
*/
58
IFX_EXTERN
sint32
Ifx_GlobalResources_getIndex
(
void
*resource);
59
60
/** Return a pointer to the global resource item
61
*
62
* \param id index of the Ifx_GlobalResources_Item in the table, the index starts with 0
63
*
64
* \return return the Ifx_GlobalResources_Item
65
*/
66
IFX_EXTERN
const
Ifx_GlobalResources_Item
*
Ifx_GlobalResources_getItem
(
sint32
id
);
67
68
/** Return a the resource name as an NULL terminated string
69
*
70
* \param id index of the Ifx_GlobalResources_Item in the table, the index starts with 0
71
*
72
* \return return Ifx_GlobalResources_Item.name
73
*/
74
IFX_EXTERN
pchar
Ifx_GlobalResources_getName
(
sint32
id
);
75
76
/** Initialize the global resource handler
77
*
78
* \param table pointer to an array of Ifx_GlobalResources_Item
79
* \param size number of item in the table corresponds to sizeof(table)
80
*
81
* return returns TRUE in case of success else FALSE
82
*
83
*/
84
IFX_EXTERN
boolean
Ifx_GlobalResources_init
(
const
Ifx_GlobalResources_Item
*table,
uint32
size);
85
/** \} */
86
87
#endif
/* IFX_GLOBALRESOURCES_H */
home
mclld
Libraries
release
iLLD_0_1_0_10
src
ifx
SrvSw
SysSe
General
Ifx_GlobalResources.h
Generated by
1.8.4