1 //----------------------------------------------------------------------------
3 // Copyright (C) Intel Corporation, 2004 - 2007
5 // File: StatusCodeDefinitions.h
7 // Notes: This file contains the definitions of the status codes
8 // as defined in the Intel® AMT Network Design Guide.
10 //----------------------------------------------------------------------------
12 #ifndef STATUS_CODE_DEFINITIONS_H
13 #define STATUS_CODE_DEFINITIONS_H
15 typedef unsigned int PT_STATUS;
16 typedef unsigned int AMT_STATUS;
19 #define PT_STATUS_SUCCESS 0x0
20 #define AMT_STATUS_SUCCESS 0x0
22 //An internal error in the Intel® AMT device has occurred
23 #define PT_STATUS_INTERNAL_ERROR 0x1
24 #define AMT_STATUS_INTERNAL_ERROR 0x1
26 //Intel® AMT device has not progressed far enough in its
27 //initialization to process the command.
28 #define PT_STATUS_NOT_READY 0x2
29 #define AMT_STATUS_NOT_READY 0x2
31 //Command is not permitted in current operating mode.
32 #define PT_STATUS_INVALID_PT_MODE 0x3
33 #define AMT_STATUS_INVALID_PT_MODE 0x3
35 //Length field of header is invalid.
36 #define PT_STATUS_INVALID_MESSAGE_LENGTH 0x4
37 #define AMT_STATUS_INVALID_MESSAGE_LENGTH 0x4
39 //The requested hardware asset inventory table
40 //checksum is not available.
41 #define PT_STATUS_TABLE_FINGERPRINT_NOT_AVAILABLE 0x5
42 #define AMT_STATUS_TABLE_FINGERPRINT_NOT_AVAILABLE 0x5
44 //The Integrity Check Value field of the request
45 //message sent by Intel® AMT enabled device is invalid.
46 #define PT_STATUS_INTEGRITY_CHECK_FAILED 0x6
47 #define AMT_STATUS_INTEGRITY_CHECK_FAILED 0x6
49 //The specified ISV version is not supported
50 #define PT_STATUS_UNSUPPORTED_ISVS_VERSION 0x7
51 #define AMT_STATUS_UNSUPPORTED_ISVS_VERSION 0x7
53 //The specified queried application is not registered.
54 #define PT_STATUS_APPLICATION_NOT_REGISTERED 0x8
55 #define AMT_STATUS_APPLICATION_NOT_REGISTERED 0x8
57 //Either an invalid name or a not previously registered
58 //
\93Enterprise
\94 name was specified
59 #define PT_STATUS_INVALID_REGISTRATION_DATA 0x9
60 #define AMT_STATUS_INVALID_REGISTRATION_DATA 0x9
62 //The application handle provided in the request
63 //message has never been allocated.
64 #define PT_STATUS_APPLICATION_DOES_NOT_EXIST 0xA
65 #define AMT_STATUS_APPLICATION_DOES_NOT_EXIST 0xA
67 //The requested number of bytes cannot be allocated in ISV storage.
68 #define PT_STATUS_NOT_ENOUGH_STORAGE 0xB
69 #define AMT_STATUS_NOT_ENOUGH_STORAGE 0xB
71 //The specified name is invalid.
72 #define PT_STATUS_INVALID_NAME 0xC
73 #define AMT_STATUS_INVALID_NAME 0xC
75 //The specified block does not exist.
76 #define PT_STATUS_BLOCK_DOES_NOT_EXIST 0xD
77 #define AMT_STATUS_BLOCK_DOES_NOT_EXIST 0xD
79 //The specified byte offset is invalid.
80 #define PT_STATUS_INVALID_BYTE_OFFSET 0xE
81 #define AMT_STATUS_INVALID_BYTE_OFFSET 0xE
83 //The specified byte count is invalid.
84 #define PT_STATUS_INVALID_BYTE_COUNT 0xF
85 #define AMT_STATUS_INVALID_BYTE_COUNT 0xF
87 //The requesting application is not
88 //permitted to request execution of the specified operation.
89 #define PT_STATUS_NOT_PERMITTED 0x10
90 #define AMT_STATUS_NOT_PERMITTED 0x10
92 //The requesting application is not the owner of the block
93 //as required for the requested operation.
94 #define PT_STATUS_NOT_OWNER 0x11
95 #define AMT_STATUS_NOT_OWNER 0x11
97 //The specified block is locked by another application.
98 #define PT_STATUS_BLOCK_LOCKED_BY_OTHER 0x12
99 #define AMT_STATUS_BLOCK_LOCKED_BY_OTHER 0x12
101 //The specified block is not locked.
102 #define PT_STATUS_BLOCK_NOT_LOCKED 0x13
103 #define AMT_STATUS_BLOCK_NOT_LOCKED 0x13
105 //The specified group permission bits are invalid.
106 #define PT_STATUS_INVALID_GROUP_PERMISSIONS 0x14
107 #define AMT_STATUS_INVALID_GROUP_PERMISSIONS 0x14
109 //The specified group does not exist.
110 #define PT_STATUS_GROUP_DOES_NOT_EXIST 0x15
111 #define AMT_STATUS_GROUP_DOES_NOT_EXIST 0x15
113 //The specified member count is invalid.
114 #define PT_STATUS_INVALID_MEMBER_COUNT 0x16
115 #define AMT_STATUS_INVALID_MEMBER_COUNT 0x16
117 //The request cannot be satisfied because a maximum
118 //limit associated with the request has been reached.
119 #define PT_STATUS_MAX_LIMIT_REACHED 0x17
120 #define AMT_STATUS_MAX_LIMIT_REACHED 0x17
122 //specified key algorithm is invalid.
123 #define PT_STATUS_INVALID_AUTH_TYPE 0x18
124 #define AMT_STATUS_INVALID_AUTH_TYPE 0x18
127 #define PT_STATUS_AUTHENTICATION_FAILED 0x19
128 #define AMT_STATUS_AUTHENTICATION_FAILED 0x19
130 //The specified DHCP mode is invalid.
131 #define PT_STATUS_INVALID_DHCP_MODE 0x1A
132 #define AMT_STATUS_INVALID_DHCP_MODE 0x1A
134 //The specified IP address is not a valid IP unicast address.
135 #define PT_STATUS_INVALID_IP_ADDRESS 0x1B
136 #define AMT_STATUS_INVALID_IP_ADDRESS 0x1B
138 //The specified domain name is not a valid domain name.
139 #define PT_STATUS_INVALID_DOMAIN_NAME 0x1C
140 #define AMT_STATUS_INVALID_DOMAIN_NAME 0x1C
143 #define PT_STATUS_UNSUPPORTED_VERSION 0x1D
144 #define AMT_STATUS_UNSUPPORTED_VERSION 0x1D
146 //The requested operation cannot be performed because a
147 //prerequisite request message has not been received.
148 #define PT_STATUS_REQUEST_UNEXPECTED 0x1E
149 #define AMT_STATUS_REQUEST_UNEXPECTED 0x1E
152 #define PT_STATUS_INVALID_TABLE_TYPE 0x1F
153 #define AMT_STATUS_INVALID_TABLE_TYPE 0x1F
155 //The specified provisioning mode code is undefined.
156 #define PT_STATUS_INVALID_PROVISIONING_STATE 0x20
157 #define AMT_STATUS_INVALID_PROVISIONING_STATE 0x20
160 #define PT_STATUS_UNSUPPORTED_OBJECT 0x21
161 #define AMT_STATUS_UNSUPPORTED_OBJECT 0x21
163 //The specified time was not accepted by the Intel® AMT device
164 //since it is earlier than the baseline time set for the device.
165 #define PT_STATUS_INVALID_TIME 0x22
166 #define AMT_STATUS_INVALID_TIME 0x22
168 //StartingIndex is invalid.
169 #define PT_STATUS_INVALID_INDEX 0x23
170 #define AMT_STATUS_INVALID_INDEX 0x23
172 //A parameter is invalid.
173 #define PT_STATUS_INVALID_PARAMETER 0x24
174 #define AMT_STATUS_INVALID_PARAMETER 0x24
176 //An invalid netmask was supplied
177 //(a valid netmask is an IP address in which all
\911
\92s are before
178 //the
\910
\92 \96 e.g. FFFC0000h is valid, FF0C0000h is invalid).
179 #define PT_STATUS_INVALID_NETMASK 0x25
180 #define AMT_STATUS_INVALID_NETMASK 0x25
182 //The operation failed because the Flash wear-out
183 //protection mechanism prevented a write to an NVRAM sector.
184 #define PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED 0x26
185 #define AMT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED 0x26
187 //ME FW did not receive the entire image file.
188 #define PT_STATUS_INVALID_IMAGE_LENGTH 0x27
189 #define AMT_STATUS_INVALID_IMAGE_LENGTH 0x27
191 //ME FW received an image file with an invalid signature.
192 #define PT_STATUS_INVALID_IMAGE_SIGNATURE 0x28
193 #define AMT_STATUS_INVALID_IMAGE_SIGNATURE 0x28
195 //LME can not support the requested version.
196 #define PT_STATUS_PROPOSE_ANOTHER_VERSION 0x29
197 #define AMT_STATUS_PROPOSE_ANOTHER_VERSION 0x29
199 //The PID must be a 64 bit quantity made up of ASCII codes
200 //of some combination of 8 characters
\96
201 //capital alphabets (A
\96Z), and numbers (0
\969).
202 #define PT_STATUS_INVALID_PID_FORMAT 0x2A
203 #define AMT_STATUS_INVALID_PID_FORMAT 0x2A
205 //The PPS must be a 256 bit quantity made up of ASCII codes
206 //of some combination of 32 characters
\96
207 //capital alphabets (A
\96Z), and numbers (0
\969).
208 #define PT_STATUS_INVALID_PPS_FORMAT 0x2B
209 #define AMT_STATUS_INVALID_PPS_FORMAT 0x2B
211 //Full BIST test has been blocked
212 #define PT_STATUS_BIST_COMMAND_BLOCKED 0x2C
213 #define AMT_STATUS_BIST_COMMAND_BLOCKED 0x2C
215 //A TCP/IP connection could not be opened on with the selected port.
216 #define PT_STATUS_CONNECTION_FAILED 0x2D
217 #define AMT_STATUS_CONNECTION_FAILED 0x2D
219 //Max number of connection reached.
220 //LME can not open the requested connection.
221 #define PT_STATUS_CONNECTION_TOO_MANY 0x2E
222 #define AMT_STATUS_CONNECTION_TOO_MANY 0x2E
224 //Random key generation is in progress.
225 #define PT_STATUS_RNG_GENERATION_IN_PROGRESS 0x2F
226 #define AMT_STATUS_RNG_GENERATION_IN_PROGRESS 0x2F
228 //A randomly generated key does not exist.
229 #define PT_STATUS_RNG_NOT_READY 0x30
230 #define AMT_STATUS_RNG_NOT_READY 0x30
232 //Self-generated AMT certificate does not exist.
233 #define PT_STATUS_CERTIFICATE_NOT_READY 0x31
234 #define AMT_STATUS_CERTIFICATE_NOT_READY 0x31
236 //This code establishes a dividing line between
237 //status codes which are common to host interface and
238 //network interface and status codes which are used by
239 //network interface only.
240 #define PT_STATUS_NETWORK_IF_ERROR_BASE 0x800
241 #define AMT_STATUS_NETWORK_IF_ERROR_BASE 0x800
243 //The OEM number specified in the remote control
244 //command is not supported by the Intel® AMT device
245 #define PT_STATUS_UNSUPPORTED_OEM_NUMBER 0x801
246 #define AMT_STATUS_UNSUPPORTED_OEM_NUMBER 0x801
248 //The boot option specified in the remote control command
249 //is not supported by the Intel® AMT device
250 #define PT_STATUS_UNSUPPORTED_BOOT_OPTION 0x802
251 #define AMT_STATUS_UNSUPPORTED_BOOT_OPTION 0x802
253 //The command specified in the remote control command
254 //is not supported by the Intel® AMT device
255 #define PT_STATUS_INVALID_COMMAND 0x803
256 #define AMT_STATUS_INVALID_COMMAND 0x803
258 //The special command specified in the remote control command
259 //is not supported by the Intel® AMT device
260 #define PT_STATUS_INVALID_SPECIAL_COMMAND 0x804
261 #define AMT_STATUS_INVALID_SPECIAL_COMMAND 0x804
263 //The handle specified in the command is invalid
264 #define PT_STATUS_INVALID_HANDLE 0x805
265 #define AMT_STATUS_INVALID_HANDLE 0x805
267 //The password specified in the User ACL is invalid
268 #define PT_STATUS_INVALID_PASSWORD 0x806
269 #define AMT_STATUS_INVALID_PASSWORD 0x806
271 //The realm specified in the User ACL is invalid
272 #define PT_STATUS_INVALID_REALM 0x807
273 #define AMT_STATUS_INVALID_REALM 0x807
275 //The FPACL or EACL entry is used by an active
276 //registration and cannot be removed or modified.
277 #define PT_STATUS_STORAGE_ACL_ENTRY_IN_USE 0x808
278 #define AMT_STATUS_STORAGE_ACL_ENTRY_IN_USE 0x808
280 //Essential data is missing on CommitChanges command.
281 #define PT_STATUS_DATA_MISSING 0x809
282 #define AMT_STATUS_DATA_MISSING 0x809
284 //The parameter specified is a duplicate of an existing value.
285 //Returned for a case where duplicate entries are added to FPACL
286 //(Factory Partner Allocation Control List) or EACL
287 //(Enterprise Access Control List) lists.
288 #define PT_STATUS_DUPLICATE 0x80A
289 #define AMT_STATUS_DUPLICATE 0x80A
291 //Event Log operation failed due to the current freeze status of the log.
292 #define PT_STATUS_EVENTLOG_FROZEN 0x80B
293 #define AMT_STATUS_EVENTLOG_FROZEN 0x80B
295 //The device is missing private key material.
296 #define PT_STATUS_PKI_MISSING_KEYS 0x80C
297 #define AMT_STATUS_PKI_MISSING_KEYS 0x80C
299 //The device is currently generating a keypair.
300 //Caller may try repeating this operation at a later time.
301 #define PT_STATUS_PKI_GENERATING_KEYS 0x80D
302 #define AMT_STATUS_PKI_GENERATING_KEYS 0x80D
304 //An invalid Key was entered.
305 #define PT_STATUS_INVALID_KEY 0x80E
306 #define AMT_STATUS_INVALID_KEY 0x80E
308 //An invalid X.509 certificate was entered.
309 #define PT_STATUS_INVALID_CERT 0x80F
310 #define AMT_STATUS_INVALID_CERT 0x80F
312 //Certificate Chain and Private Key do not match.
313 #define PT_STATUS_CERT_KEY_NOT_MATCH 0x810
314 #define AMT_STATUS_CERT_KEY_NOT_MATCH 0x810
316 //The request cannot be satisfied because the maximum
317 //number of allowed Kerberos domains has been reached.
318 //(The domain is determined by the first 24 Bytes of the SID.)
319 #define PT_STATUS_MAX_KERB_DOMAIN_REACHED 0x811
320 #define AMT_STATUS_MAX_KERB_DOMAIN_REACHED 0x811
322 // The requested configuration is unsupported
323 #define PT_STATUS_UNSUPPORTED 0x812
324 #define AMT_STATUS_UNSUPPORTED 0x812
326 // A profile with the requested priority already exists
327 #define PT_STATUS_INVALID_PRIORITY 0x813
328 #define AMT_STATUS_INVALID_PRIORITY 0x813
330 // Unable to find specified element
331 #define PT_STATUS_NOT_FOUND 0x814
332 #define AMT_STATUS_NOT_FOUND 0x814
334 // Invalid User credentials
335 #define PT_STATUS_INVALID_CREDENTIALS 0x815
336 #define AMT_STATUS_INVALID_CREDENTIALS 0x815
338 // Passphrase is invalid
339 #define PT_STATUS_INVALID_PASSPHRASE 0x816
340 #define AMT_STATUS_INVALID_PASSPHRASE 0x816
342 // A certificate handle must be chosen before the
343 // operation can be completed.
344 #define PT_STATUS_NO_ASSOCIATION 0x818
345 #define AMT_STATUS_NO_ASSOCIATION 0x818
347 //The application has identified an internal error
348 #define PTSDK_STATUS_INTERNAL_ERROR 0x1000
350 //An ISV operation was called while the library is not
352 #define PTSDK_STATUS_NOT_INITIALIZED 0x1001
354 //The requested library I/F is not supported by the current library
356 #define PTSDK_STATUS_LIB_VERSION_UNSUPPORTED 0x1002
358 //One of the parameters is invalid (usually indicates a
359 //NULL pointer or an invalid session handle is specified)
360 #define PTSDK_STATUS_INVALID_PARAM 0x1003
362 //The SDK could not allocate sufficient resources to complete the operation.
363 #define PTSDK_STATUS_RESOURCES 0x1004
365 //The Library has identified a HW Internal error.
366 #define PTSDK_STATUS_HARDWARE_ACCESS_ERROR 0x1005
368 //The application that sent the request message is not registered.
369 //Usually indicates the registration timeout has elapsed.
370 //The caller should reregister with the Intel AMT enabled device.
371 #define PTSDK_STATUS_REQUESTOR_NOT_REGISTERED 0x1006
373 //A network error has occurred while processing the call.
374 #define PTSDK_STATUS_NETWORK_ERROR 0x1007
376 //Specified container can not hold the requested string
377 #define PTSDK_STATUS_PARAM_BUFFER_TOO_SHORT 0x1008
380 //ISVS_InitializeCOMinThread was not called by the current thread.
381 #define PTSDK_STATUS_COM_NOT_INITIALIZED_IN_THREAD 0x1009
383 //The URL parameter was not optional in current configuration.
384 #define PTSDK_STATUS_URL_REQUIRED 0x100A