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
|
/**
* @defgroup MCLF MobiCore Load Format
*
* @defgroup MCLF_VER MCLF Versions
* @ingroup MCLF
*
* @addtogroup MCLF
* @{
*
* MobiCore Load Format declarations.
*
* Holds the definitions for the layout of MobiCore Trustlet Blob.
* <!-- Copyright Giesecke & Devrient GmbH 2009-2012 -->
*/
#ifndef MCLOADFORMAT_H_
#define MCLOADFORMAT_H_
#include "mcUuid.h"
#include "mcDriverId.h"
#define MCLF_VERSION_MAJOR 2
#define MCLF_VERSION_MINOR 0
#define MC_SERVICE_HEADER_MAGIC_BE ((uint32_t)('M'|('C'<<8)|('L'<<16)|('F'<<24))) /**< "MCLF" in big endian integer representation */
#define MC_SERVICE_HEADER_MAGIC_LE ((uint32_t)(('M'<<24)|('C'<<16)|('L'<<8)|'F')) /**< "MCLF" in little endian integer representation */
#define MC_SERVICE_HEADER_MAGIC_STR "MCLF" /**< "MCLF" as string */
/** @name MCLF flags */
/*@{*/
#define MC_SERVICE_HEADER_FLAGS_PERMANENT (1U << 0) /**< Loaded service cannot be unloaded from MobiCore. */
#define MC_SERVICE_HEADER_FLAGS_NO_CONTROL_INTERFACE (1U << 1) /**< Service has no WSM control interface. */
/*@}*/
#if !defined(ADDR_T_DEFINED)
#define ADDR_T_DEFINED
typedef void* addr_t; /**< an address, can be physical or virtual */
#endif // !defined(ADDR_T_DEFINED)
/** Service type.
* The service type defines the type of executable.
*/
typedef enum {
SERVICE_TYPE_ILLEGAL = 0, /**< Service type is invalid. */
SERVICE_TYPE_DRIVER = 1, /**< Service is a driver. */
SERVICE_TYPE_SP_TRUSTLET = 2, /**< Service is a Trustlet. */
SERVICE_TYPE_SYSTEM_TRUSTLET = 3 /**< Service is a system Trustlet. */
} serviceType_t;
/**
* Memory types.
*/
typedef enum {
MCLF_MEM_TYPE_INTERNAL_PREFERRED = 0, /**< If available use internal memory; otherwise external memory. */
MCLF_MEM_TYPE_INTERNAL = 1, /**< Internal memory must be used for executing the service. */
MCLF_MEM_TYPE_EXTERNAL = 2, /**< External memory must be used for executing the service. */
} memType_t;
/**
* Descriptor for a memory segment.
*/
typedef struct {
addr_t start; /**< Virtual start address. */
uint32_t len; /**< Length of the segment in bytes. */
} segmentDescriptor_t, *segmentDescriptor_ptr;
/**
* MCLF intro for data structure identification.
* Must be the first element of a valid MCLF file.
*/
typedef struct {
uint32_t magic; /**< Header magic value ASCII "MCLF". */
uint32_t version; /**< Version of the MCLF header structure. */
} mclfIntro_t, *mclfIntro_ptr;
/** @} */
// Version 1 /////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* @defgroup MCLF_VER_V1 MCLF Version 1
* @ingroup MCLF_VER
*
* @addtogroup MCLF_VER_V1
* @{
*/
/**
* Version 1 MCLF header.
*/
typedef struct {
mclfIntro_t intro; /**< MCLF header start with the mandatory intro. */
uint32_t flags; /**< Service flags. */
memType_t memType; /**< Type of memory the service must be executed from. */
serviceType_t serviceType; /**< Type of service. */
uint32_t numInstances; /**< Number of instances which can be run simultaneously. */
mcUuid_t uuid; /**< Loadable service unique identifier (UUID). */
mcDriverId_t driverId; /**< If the serviceType is SERVICE_TYPE_DRIVER the Driver ID is used. */
uint32_t numThreads; /**<
* <pre>
* <br>Number of threads (N) in a service depending on service type.<br>
*
* SERVICE_TYPE_SP_TRUSTLET: N = 1
* SERVICE_TYPE_SYSTEM_TRUSTLET: N = 1
* SERVICE_TYPE_DRIVER: N >= 1
* </pre>
*/
segmentDescriptor_t text; /**< Virtual text segment. */
segmentDescriptor_t data; /**< Virtual data segment. */
uint32_t bssLen; /**< Length of the BSS segment in bytes. MUST be at least 8 byte. */
addr_t entry; /**< Virtual start address of service code. */
} mclfHeaderV1_t, *mclfHeaderV1_ptr;
/** @} */
// Version 2 /////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* @defgroup MCLF_VER_V2 MCLF Version 2
* @ingroup MCLF_VER
*
* @addtogroup MCLF_VER_V2
* @{
*/
/**
* Version 2 MCLF header.
*/
typedef struct {
mclfIntro_t intro; /**< MCLF header start with the mandatory intro. */
uint32_t flags; /**< Service flags. */
memType_t memType; /**< Type of memory the service must be executed from. */
serviceType_t serviceType; /**< Type of service. */
uint32_t numInstances; /**< Number of instances which can be run simultaneously. */
mcUuid_t uuid; /**< Loadable service unique identifier (UUID). */
mcDriverId_t driverId; /**< If the serviceType is SERVICE_TYPE_DRIVER the Driver ID is used. */
uint32_t numThreads; /**<
* <pre>
* <br>Number of threads (N) in a service depending on service type.<br>
*
* SERVICE_TYPE_SP_TRUSTLET: N = 1
* SERVICE_TYPE_SYSTEM_TRUSTLET: N = 1
* SERVICE_TYPE_DRIVER: N >= 1
* </pre>
*/
segmentDescriptor_t text; /**< Virtual text segment. */
segmentDescriptor_t data; /**< Virtual data segment. */
uint32_t bssLen; /**< Length of the BSS segment in bytes. MUST be at least 8 byte. */
addr_t entry; /**< Virtual start address of service code. */
uint32_t serviceVersion; /**< Version of the interface the driver exports. */
} mclfHeaderV2_t, *mclfHeaderV2_ptr;
/** @} */
// Version 1 and 2 ///////////////////////////////////////////////////////////////////////////////////////////////////
/**
* @addtogroup MCLF
* @{
*/
/** MCLF header */
typedef union {
mclfIntro_t intro; /**< Intro for data structure identification. */
mclfHeaderV1_t mclfHeaderV1; /**< Version 1 header */
mclfHeaderV2_t mclfHeaderV2; /**< Version 2 header */
} mclfHeader_t, *mclfHeader_ptr;
#endif /* MCLOADFORMAT_H_ */
/** @} */
|
