-
Notifications
You must be signed in to change notification settings - Fork 34
/
Copy pathesif_sdk_iface_esif.h
187 lines (165 loc) · 8.83 KB
/
esif_sdk_iface_esif.h
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
/*******************************************************************************
** This file is provided under a dual BSD/GPLv2 license. When using or
** redistributing this file, you may do so under either license.
**
** GPL LICENSE SUMMARY
**
** Copyright (c) 2013-2023 Intel Corporation All Rights Reserved
**
** This program is free software; you can redistribute it and/or modify it under
** the terms of version 2 of the GNU General Public License as published by the
** Free Software Foundation.
**
** This program is distributed in the hope that it will be useful, but WITHOUT
** ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
** FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
** details.
**
** You should have received a copy of the GNU General Public License along with
** this program; if not, write to the Free Software Foundation, Inc.,
** 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
** The full GNU General Public License is included in this distribution in the
** file called LICENSE.GPL.
**
** BSD LICENSE
**
** Copyright (c) 2013-2023 Intel Corporation All Rights Reserved
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are met:
**
** * Redistributions of source code must retain the above copyright notice, this
** list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright notice,
** this list of conditions and the following disclaimer in the documentation
** and/or other materials provided with the distribution.
** * Neither the name of Intel Corporation nor the names of its contributors may
** be used to endorse or promote products derived from this software without
** specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
** CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
** SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
** INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
** CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
** ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
** POSSIBILITY OF SUCH DAMAGE.
**
*******************************************************************************/
#pragma once
#include "esif_sdk.h"
#include "esif_sdk_iface.h"
/*
* INTERFACE Flags
* These flags will be used by the ESIF Configuration Management Data Base CMDB
*/
#define ESIF_SERVICE_CONFIG_PERSIST 0x00000001 /* Persist Data To Disk */
#define ESIF_SERVICE_CONFIG_SCRAMBLE 0x00000002 /* Scramble Data For Storage */
#define ESIF_SERVICE_CONFIG_READONLY 0x00000004 /* Data is Read-Only */
#define ESIF_SERVICE_CONFIG_NOCACHE 0x00000008 /* Data is not cached in memory (except key) */
#define ESIF_SERVICE_CONFIG_DELETE 0x00010000 /* Delete from memory and disk */
#define ESIF_SERVICE_CONFIG_DELAYWRITE 0x20000000 /* Delayed Write */
#define ESIF_SERVICE_CONFIG_COMPRESSED 0x40000000 /* Payload is Compressed */
#define ESIF_SERVICE_CONFIG_STATIC 0x80000000 /* Statically Linked Repository */
/*
* Message Routing Prefix Tags
* Prefix Trace Message strings with this to override default Trace Message routing
*/
#define ESIF_SERVICE_ROUTE_EVENTLOG "<EVENTLOG>" /* Route message to EventLog */
/*
* EsifServiceInterface Callback Functions
* These functions are only used by the INTERFACE as method to loosely
* couple ESIF with its hosted application. There are used for the application
* to request information and services from the ESIF.
*/
/* Get Config */
typedef eEsifError(ESIF_CALLCONV *AppGetConfigFunction)(
const esif_handle_t esifHandle, /* ESIF provided context handle */
const EsifDataPtr nameSpace, /* Name space to use e.g. ESIF, DPTF, ACT, Etc. */
const EsifDataPtr elementPath, /* Element path e.g. /a/b/c must be unique within a name space */
EsifDataPtr elementValue /* Any valid esif_data_type maybe retrieved including ESIF_DATA_AUTO */
);
/* Set Config */
typedef eEsifError(ESIF_CALLCONV *AppSetConfigFunction)(
const esif_handle_t esifHandle, /* ESIF provided context handle */
const EsifDataPtr nameSpace, /* Name space to use e.g. ESIF, DPTF, ACT, Etc. */
const EsifDataPtr elementPath, /* Element path e.g. /a/b/c must be unique within a name space */
const EsifDataPtr elementValue, /* Any valid esif_data_type maybe set accept ESIF_DATA_AUTO */
const EsifFlags elementFlags /* Flags for handling data including persist, scramble, etc. */
);
/*
* Primitive Execution note that you may execute against any participant or the IETM object if the optional
* participant identifier is ESIF_HANDLE_PRIMARY_PARTICIPANT So for example if you wanted to retrieve the ART you would mark
* the participant as ESIF_HANDLE_PRIMARY_PARTICIPANT. If you wanted to retrieve GET_TEMPERATURE you would have to provide
* a valid particpant handle and domain handle to that ESIF knows "which" temperature to retrieve.
*/
typedef eEsifError(ESIF_CALLCONV *AppPrimitiveFunction)(
const esif_handle_t esifHandle, /* ESIF provided context handle */
const esif_handle_t participantHandle, /* Optional participant identifier */
const esif_handle_t domainHandle, /* Optional required if particpant identifier is provided */
const EsifDataPtr request, /* Request data for SET_* based primitives */
EsifDataPtr response, /* Response data for GET_* based primitives */
const ePrimitiveType primitive, /* Primitive ID e.g. GET_TEMPERATURE */
const UInt8 instance /* Primitive instance may be 255 or ESIF_INSTANCE_INVALID */
);
/* Write Log */
typedef eEsifError(ESIF_CALLCONV *AppWriteLogFunction)(
const esif_handle_t esifHandle, /* ESIF provided context handle */
const esif_handle_t participantHandle, /* optional may be ESIF_HANDLE_PRIMARY_PARTICIPANT used to augment log detail*/
const esif_handle_t domainHandle, /* optional may be ESIF_INVALID_HANDLE used to augment log detail*/
const EsifDataPtr message, /* Message For Log */
const eLogType logType /* Log Type e.g. crticial, debug, info,e tc */
);
/* Event Register */
typedef eEsifError(ESIF_CALLCONV *AppEventRegisterFunction)(
const esif_handle_t esifHandle, /* ESIF provided context handle */
const esif_handle_t participantHandle, /* optional may be ESIF_HANDLE_PRIMARY_PARTICIPANT indicates app event regisration */
const esif_handle_t domainHandle, /* optional may be ESIF_INVALID_HANDLE indicates participant event registration */
const EsifDataPtr eventGuid /* Event GUID to be registered */
);
/* Event Unregister */
typedef eEsifError(ESIF_CALLCONV *AppEventUnregisterFunction)(
const esif_handle_t esifHandle, /* ESIF provided context handle */
const esif_handle_t participantHandle, /* optional may be ESIF_HANDLE_PRIMARY_PARTICIPANT indicates app event registration */
const esif_handle_t domainHandle, /* optional may be ESIF_INVALID_HANDLE indicates participant event registraion */
const EsifDataPtr eventGuid /* Event GUID to be unregistered */
);
/* Version 2*/
/* Send Event Application -> ESIF */
typedef eEsifError(ESIF_CALLCONV *AppSendEventFunction)(
const esif_handle_t esifHandle, /* ESIF provided context handle */
const esif_handle_t participantHandle, /* Optional Participant ESIF_HANDLE_PRIMARY_PARTICIPANT indicates App Level Event */
const esif_handle_t domainHandle, /* Optional Domain ESIF_INVALID_HANDLE indicates non-domain Level Event */
const EsifDataPtr eventData, /* Data included with the event if any MAY Be NULL */
const EsifDataPtr eventGuid /* Event GUID */
);
/* CLI Command Application -> ESIF */
typedef eEsifError(ESIF_CALLCONV *AppSendCommandFunction)(
const esif_handle_t esifHandle, /* ESIF provided context handle */
const UInt32 argc, /* command arguments count (1 or more) */
const EsifDataArray argv, /* array of command arguments must be ESIF_DATA_STRING today */
EsifDataPtr response /* response must be ESIF_DATA_STRING today */
);
/*
* ESIF Service Interface ESIF <-- APPLICATION
* Forward declared and typedef in esif_uf_iface.h
*/
#pragma pack(push, 1)
struct _t_EsifInterface {
/* Configuration Management */
AppGetConfigFunction fGetConfigFuncPtr;
AppSetConfigFunction fSetConfigFuncPtr;
/* Execute */
AppPrimitiveFunction fPrimitiveFuncPtr;
AppWriteLogFunction fWriteLogFuncPtr;
/* Event Registration */
AppEventRegisterFunction fRegisterEventFuncPtr;
AppEventUnregisterFunction fUnregisterEventFuncPtr;
AppSendEventFunction fSendEventFuncPtr;
AppSendCommandFunction fSendCommandFuncPtr;
};
#pragma pack(pop)