iLLD_TC27xC
1.0
IfxEmem.h
Go to the documentation of this file.
1
/**
2
* \file IfxEmem.h
3
* \brief EMEM basic functionality
4
* \ingroup IfxLld_Emem
5
*
6
* \version iLLD_0_1_0_10
7
* \copyright Copyright (c) 2013 Infineon Technologies AG. All rights reserved.
8
*
9
*
10
* IMPORTANT NOTICE
11
*
12
*
13
* Infineon Technologies AG (Infineon) is supplying this file for use
14
* exclusively with Infineon's microcontroller products. This file can be freely
15
* distributed within development tools that are supporting such microcontroller
16
* products.
17
*
18
* THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED
19
* OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
20
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
21
* INFINEON SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL,
22
* OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
23
*
24
* \defgroup IfxLld_Emem EMEM
25
* \ingroup IfxLld
26
* \defgroup IfxLld_Emem_Std Standard Driver
27
* \ingroup IfxLld_Emem
28
* \defgroup IfxLld_Emem_Std_Enumerations Enumerations
29
* \ingroup IfxLld_Emem_Std
30
* \defgroup IfxLld_Emem_Std_Module Module Functions
31
* \ingroup IfxLld_Emem_Std
32
*/
33
34
#ifndef IFXEMEM_H
35
#define IFXEMEM_H 1
36
37
/******************************************************************************/
38
/*----------------------------------Includes----------------------------------*/
39
/******************************************************************************/
40
41
#include "
_Impl/IfxEmem_cfg.h
"
42
#include "_Reg/IfxEmem_reg.h"
43
#include "
Cpu/Std/Ifx_Types.h
"
44
45
/******************************************************************************/
46
/*--------------------------------Enumerations--------------------------------*/
47
/******************************************************************************/
48
49
/** \addtogroup IfxLld_Emem_Std_Enumerations
50
* \{ */
51
/** \brief EMEM lock state defined in MODULE_EMEM.SBRCTR.B.STBLOCK.
52
*/
53
typedef
enum
54
{
55
IfxEmem_LockedState_locked
= 0,
/**< \brief EMEM locked state. */
56
IfxEmem_LockedState_unlocked
= 1
/**< \brief EMEM unlocked state. */
57
}
IfxEmem_LockedState
;
58
59
/** \brief EMEM module clock enabled or disabled state defined in MODULE_EMEM.CLC.B.DISR.
60
*/
61
typedef
enum
62
{
63
IfxEmem_State_disabled
= 0,
/**< \brief EMEM module clock disabled state. */
64
IfxEmem_State_enabled
= 1
/**< \brief EMEM module clock enabled state. */
65
}
IfxEmem_State
;
66
67
/** \brief EMEM tile configuration mode defined in MODULE_EMEM.TILECONFIG.B.Tx( x = 0,1,..).
68
*/
69
typedef
enum
70
{
71
IfxEmem_TileConfigMode_calibMode
= 0
/**< \brief EMEM tile mode to calibration memory. */
72
}
IfxEmem_TileConfigMode
;
73
74
/** \} */
75
76
/** \addtogroup IfxLld_Emem_Std_Module
77
* \{ */
78
79
/******************************************************************************/
80
/*-------------------------Inline Function Prototypes-------------------------*/
81
/******************************************************************************/
82
83
/** \brief Returns the status of module enabled or disabled
84
* \return Status (TRUE / FALSE)
85
*/
86
IFX_INLINE
boolean
IfxEmem_isModuleEnabled
(
void
);
87
88
/******************************************************************************/
89
/*-------------------------Global Function Prototypes-------------------------*/
90
/******************************************************************************/
91
92
/** \brief Gets the EMEM stand RAM lock state.
93
* \return EMEM stand RAM lock state.
94
*/
95
IFX_EXTERN
IfxEmem_LockedState
IfxEmem_getLockedState
(
void
);
96
97
/** \brief Enable or disable state of the EMEM module clock.
98
* \param state EMEM module clock enabled or disabled state.
99
* \return None
100
*/
101
IFX_EXTERN
void
IfxEmem_setClockEnableState
(
const
IfxEmem_State
state);
102
103
/** \brief Sets all EMEM tiles to calibration memory mode.
104
* \param mode EMEM tile configuration mode.
105
* \return None
106
*/
107
IFX_EXTERN
void
IfxEmem_setTileConfigMode
(
const
IfxEmem_TileConfigMode
mode);
108
109
/** \brief Sets Unlock standby lock flag.
110
* \param flag Unlock standby lock flag value.
111
* \return None
112
*/
113
IFX_EXTERN
void
IfxEmem_setUnlockStandbyLockFlag
(
const
uint8
flag);
114
115
/** \} */
116
117
/******************************************************************************/
118
/*---------------------Inline Function Implementations------------------------*/
119
/******************************************************************************/
120
121
IFX_INLINE
boolean
IfxEmem_isModuleEnabled
(
void
)
122
{
123
return
(MODULE_EMEM.CLC.B.DISS == 0) ?
TRUE
:
FALSE
;
124
}
125
126
127
#endif
/* IFXEMEM_H */
home
mclld
Libraries
release
iLLD_0_1_0_10
src
ifx
TC27xC
Emem
Std
IfxEmem.h
Generated by
1.8.4