From 96d6da4e252b06dcfdc041e7df23e86161c33007 Mon Sep 17 00:00:00 2001 From: rihab kouki Date: Tue, 28 Jul 2020 11:24:49 +0100 Subject: Official ARM version: v5.6.0 --- docs/Pack/html/pdsc_components_pg.html | 77 ++++++++++++++++++++++++++++++---- 1 file changed, 68 insertions(+), 9 deletions(-) (limited to 'docs/Pack/html/pdsc_components_pg.html') diff --git a/docs/Pack/html/pdsc_components_pg.html b/docs/Pack/html/pdsc_components_pg.html index ac5c62e..a4732e8 100644 --- a/docs/Pack/html/pdsc_components_pg.html +++ b/docs/Pack/html/pdsc_components_pg.html @@ -32,7 +32,7 @@ Logo
CMSIS-Pack -  Version 1.5.0 +  Version 1.6.0
Delivery Mechanism for Software Packs
@@ -245,7 +245,15 @@ RTE_Components.h
#define RTE_Network_Socket_UDP /* Network Socket UDP */
#endif /* RTE_COMPONENTS_H */
-

The typical usage of the RTE_Components.h file is in header files to control for example the inclusion of files that are related to other components for the same Software Pack.

+

The RTE_Components.h file allows to create software that works with any supported device as it gives access to the CMSIS_device_header. The CMSIS_device_header reflects the current selected device and gives you for example access to the processor configuration. Refer to "Device Header File <device.h>" in CMSIS-Core(M) or CMSIS-Core(A) for more information.

+
#include CMSIS_device_header /* header file of the selected device in the project */
+
+
#if (defined (__MPU_PRESENT)) && (__MPU_PRESENT == 1)
+
// device has MPU, start the related code
+
#else
+
#error "Software Component requires a device with MPU"
+
#endif
+

Another typical usage of the RTE_Components.h file is in header files to control for example the inclusion of files that are related to other components for the same Software Pack.

#include "RTE_Components.h"
#ifdef RTE_Network_Interface_ETH_0 // generated when software component Network Interface ETH 0 is included
@@ -253,6 +261,45 @@ RTE_Components.h
#endif

 

+

+Pre_Include_Global_h

+

The build environment shall generate a C/C++ header file with the name Pre_Include_Global.h from all selected components and add this file to the command line as a pre-include file for the build of all modules in the project. Note: the file shall be generated into the RTE/<target> subdirectory.

+
<component Cclass="Other" Cgroup="Alpha" ...>
+
<Pre_Include_Global_h>
+
// enabling global pre include
+
#define GLOBAL_Component_Alpha 0x4
+
</Pre_Include_Global_h>
+
</component>
+
+
<component Cclass="Other" Cgroup="Beta" ...>
+
<Pre_Include_Global_h>
+
// enabling global pre include
+
#define GLOBAL_Component_Beta 0x8
+
</Pre_Include_Global_h>
+
</component>
+

results in .../RTE/target_1/Pre_Include_Global.h:

+
// enabling global pre include
+
#define GLOBAL_Component_Alpha 0x4
+
// enabling global pre include
+
#define GLOBAL_Component_Beta 0x8
+

No need to explicitly include this file as it is automatically added as pre-include into the build for all modules.

+

 

+
+

+Pre_Include_Local_h

+

The build environment shall generate a C/C++ header file with the name Pre_Include_<Cclass>_<component>.h from the selected component and add this file to the command line as a pre-include file for the build of all modules of this component. The same is done for each component containing a "Pre_Include_Local_h" element. Note: files shall be generated into the RTE/<target> subdirectory.

+
<component Cclass="Other" Cgroup="Alpha" ...>
+
<Pre_Include_Local_h>
+
// enabling local pre include
+
#define Local_Component_Alpha 1
+
</Pre_Include_Local_h>
+
</component>
+

results in .../RTE/target_1/Pre_Include_Other_Alpha.h:

+
// enabling local pre include
+
#define Local_Component_Alpha 1
+

No need to explicitly include this file as it is automatically added as pre-include into the build for all modules of component Other:Alpha.

+

 

+

/package/components

Grouping element containing a choice of at least one bundle or component. No more than one element components can exist in a Pack.

@@ -349,7 +396,13 @@ RTE_Components.h description Brief description of the component. xs:string 1..1 -RTE_Components_h Source code that is copied into the file RTE_Components.h when the component is included into a software project. xs:string 0..1 +RTE_Components_h Source code that is copied into the file RTE_Components.h when the component is selected by the run time environment configuration. xs:string 0..1 + +Pre_Include_Global_h Source code that is copied into the file Pre_Include_Global_h when the component is selected by the run time environment configuration. xs:string 0..1 + +Pre_Include_Local_Component_h Source code that is copied into the file Pre_Include_Local_h <Cclass>_<Component_name>.h when the component is selected by the run time environment configuration. xs:string

0..1

+

+ files Grouping element for all files that are part of this component. group 1 @@ -451,9 +504,11 @@ RTE_Components.h name File path, file name, and file extension in the format path/name.extension. The file path is relative to the root directory of the Pack. xs:string required -category Defines the purpose of the file. Select the predefined value as listed in the table File Categories. FileCategoryEnum required +path for category="header" the path attribute explicitly can be used to specify the include path to be added to the commandline of the build tools, specifying an imcomplete path. This way the include file requires the specification of the subdirectory (e.g. #include "sub_dir/includeFile.h") which can act as acting as namespace for header files which otherwise have the same name. xs:string optional -attr Defines the special use and handling of a file. Select a predefined value as defined in the table File Attributes. FileAttributeEnum optional +category Defines the purpose of the file. Select the predefined value as listed in the table File Categories. FileCategoryEnum required + +attr Defines the special use and handling of a file. Select a predefined value as defined in the table File Attributes. FileAttributeEnum optional condition Enter the identifier (attribute id) of a condition. The element is used if the condition resolves to true. If the condition resolves to false, then the element will be ignored. For example, a library might be specific for a certain toolchain or processor instruction set. xs:string optional @@ -472,7 +527,7 @@ RTE_Components.h attr= Description -config The file is a configuration file of the component. It is expected that only configuration options are modified. The file is managed as part of the component, as a project-specific file typically copied into the component section of the project. +config The file is a configuration file of the component. It is expected that only configuration options are modified. The file is managed as part of the component, as a project-specific file typically copied into the component section of the project.s template

The file is used as a source code template file. It is expected to be edited and extended by the software developer. The file can be copied into a user section of the project.

@@ -496,9 +551,9 @@ RTE_Components.h doc Documentation -header Header file used in the component. Sets an include file path. +header Header file used in the component. Sets an include file path and adds the file name attribute to the list of files to be added to a module using the #include statement. Note: specify only those files as header files that form part of the API of the component, required to use the component -include Sets an include file path. +include Sets an include file path. Note: ensure that the name attribute specifies a directory and ends with a '/'. library Library file @@ -518,6 +573,10 @@ RTE_Components.h image Files of image type are marked for special processing into a File System Image embedded into the application. This category requires the attr being set to template. +preIncludeGlobal The specified file is added as a pre-include file to the compiler command line for all modules of the whole project (globally). + +preIncludeLocal The specified file is added as a pre-include file to the compiler command line for all modules of the component (locally). + other Other file types not covered in the list above

 

@@ -528,7 +587,7 @@ RTE_Components.h