]> begriffs open source - cmsis/blob - CMSIS/Documentation/Doxygen/Core/src/ref_deprecated.txt
CMSIS-Core(M) Doc: added info about deprecated symbols.
[cmsis] / CMSIS / Documentation / Doxygen / Core / src / ref_deprecated.txt
1 /* ##################################### Debug In/Output function ############################### */
2 /**
3 \defgroup deprecated_gr Deprecated Symbols
4 \brief List of deprecated symbols
5 \details
6
7 Deprecated items listed in this section are present in the \ref cmsis_standard_files starting from CMSIS-Core 6.1.0 and improve backward compatibility to CMSIS 5 based software.
8
9 Note that these deprecated symbols do not resolve all potential breaking changes introduced in CMSIS 6. For more information also see \ref core6_changes. Whenever possible, it is recommended to update to new CMSIS 6 compliant symbols.
10
11 \ref CMSIS_DISABLE_DEPRECATED can be defined to fully exclude the definitions of deprecated symbols from CMSIS-Core header files.
12
13 @{
14 */
15
16 /**
17 \brief **[Deprecated]** Structure type to access the Core Debug Register.
18 \details The **CoreDebug_Type** structure is present to enable backward compatibility for CMSIS 5 based projects. For new projects based on CMSIS 6, the DCB_Type shall be used instead.
19 */
20 typedef struct
21 {
22   __IOM uint32_t DHCSR;                  ///< Offset: 0x000 (R/W)  Debug Halting Control and Status Register
23   __OM  uint32_t DCRSR;                  ///< Offset: 0x004 ( /W)  Debug Core Register Selector Register
24   __IOM uint32_t DCRDR;                  ///< Offset: 0x008 (R/W)  Debug Core Register Data Register
25   __IOM uint32_t DEMCR;                  ///< Offset: 0x00C (R/W)  Debug Exception and Monitor Control Register
26   __OM  uint32_t DSCEMCR;                ///< Offset: 0x010 ( /W)  Debug Set Clear Exception and Monitor Control Register (Armv8.1-M only)
27   __IOM uint32_t DAUTHCTRL;              ///< Offset: 0x014 (R/W)  Debug Authentication Control Register (Armv8-M only)
28   __IOM uint32_t DSCSR;                  ///< Offset: 0x018 (R/W)  Debug Security Control and Status Register (Armv8-M only)
29 } CoreDebug_Type;
30
31 /**
32 \def CoreDebug
33 \brief **[Deprecated]** Core Debug configuration structure
34 \details The **CoreDebug** configuration structure is present to enable backward compatibility for CMSIS 5 based projects. For new projects based on CMSIS 6, the **DCB** structure shall be used instead.
35 */
36 #define CoreDebug           ((CoreDebug_Type *)     DCB_BASE)
37
38 /**
39 \def CMSIS_DISABLE_DEPRECATED
40 \brief Disables deprecated items
41 \details When CMSIS_DISABLE_DEPRECATED is defined in the project then definitions of deprecated items are excluded from the CMSIS-Core build.
42 */
43 #define CMSIS_DISABLE_DEPRECATED
44
45
46 /** @} */