| d1f95000 |
1 | /** @file\r |
| 2 | Platform Configuration Database (PCD) Protocol\r |
| 3 | \r |
| 4 | Copyright (c) 2006, Intel Corporation \r |
| 5 | All rights reserved. This program and the accompanying materials \r |
| 6 | are licensed and made available under the terms and conditions of the BSD License \r |
| 7 | which accompanies this distribution. The full text of the license may be found at \r |
| 8 | http://opensource.org/licenses/bsd-license.php \r |
| 9 | \r |
| 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
| 11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r |
| 12 | \r |
| d1f95000 |
13 | **/\r |
| 14 | \r |
| 15 | #ifndef __PCD_H__\r |
| 16 | #define __PCD_H__\r |
| 17 | \r |
| 3f748e52 |
18 | #include <PiDxe.h>\r |
| 19 | \r |
| d1f95000 |
20 | extern EFI_GUID gPcdProtocolGuid;\r |
| 21 | \r |
| 22 | #define PCD_PROTOCOL_GUID \\r |
| 23 | { 0x11b34006, 0xd85b, 0x4d0a, { 0xa2, 0x90, 0xd5, 0xa5, 0x71, 0x31, 0xe, 0xf7 } }\r |
| 24 | \r |
| 25 | #define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)\r |
| 26 | \r |
| 27 | \r |
| 28 | /**\r |
| 29 | Sets the SKU value for subsequent calls to set or get PCD token values.\r |
| 30 | \r |
| 31 | SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values. \r |
| 32 | SetSku() is normally called only once by the system.\r |
| 33 | \r |
| 34 | For each item (token), the database can hold a single value that applies to all SKUs, \r |
| 35 | or multiple values, where each value is associated with a specific SKU Id. Items with multiple, \r |
| 36 | SKU-specific values are called SKU enabled. \r |
| 37 | \r |
| 38 | The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255. \r |
| 39 | For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the \r |
| 40 | single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the \r |
| 41 | last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token, \r |
| 42 | the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been \r |
| 43 | set for that Id, the results are unpredictable.\r |
| 44 | \r |
| 45 | @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and \r |
| 46 | set values associated with a PCD token.\r |
| 47 | \r |
| 48 | @retval VOID\r |
| 49 | \r |
| 50 | **/\r |
| 51 | typedef \r |
| 52 | VOID\r |
| 8b13229b |
53 | (EFIAPI *PCD_PROTOCOL_SET_SKU)(\r |
| d1f95000 |
54 | IN UINTN SkuId\r |
| 55 | );\r |
| 56 | \r |
| 57 | \r |
| 58 | \r |
| 59 | /**\r |
| 60 | Retrieves an 8-bit value for a given PCD token.\r |
| 61 | \r |
| 62 | Retrieves the current byte-sized value for a PCD token number. \r |
| 63 | If the TokenNumber is invalid, the results are unpredictable.\r |
| 64 | \r |
| 65 | @param[in] TokenNumber The PCD token number. \r |
| 66 | \r |
| 67 | @return The UINT8 value.\r |
| 68 | \r |
| 69 | **/\r |
| 70 | typedef\r |
| 71 | UINT8\r |
| 8b13229b |
72 | (EFIAPI *PCD_PROTOCOL_GET8)(\r |
| d1f95000 |
73 | IN UINTN TokenNumber\r |
| 74 | );\r |
| 75 | \r |
| 76 | \r |
| 77 | \r |
| 78 | /**\r |
| 79 | Retrieves an 16-bit value for a given PCD token.\r |
| 80 | \r |
| 81 | Retrieves the current 16-bits value for a PCD token number. \r |
| 82 | If the TokenNumber is invalid, the results are unpredictable.\r |
| 83 | \r |
| 84 | @param[in] TokenNumber The PCD token number. \r |
| 85 | \r |
| 86 | @return The UINT16 value.\r |
| 87 | \r |
| 88 | **/\r |
| 89 | typedef\r |
| 90 | UINT16\r |
| 8b13229b |
91 | (EFIAPI *PCD_PROTOCOL_GET16)(\r |
| d1f95000 |
92 | IN UINTN TokenNumber\r |
| 93 | );\r |
| 94 | \r |
| 95 | \r |
| 96 | \r |
| 97 | /**\r |
| 98 | Retrieves an 32-bit value for a given PCD token.\r |
| 99 | \r |
| 100 | Retrieves the current 32-bits value for a PCD token number. \r |
| 101 | If the TokenNumber is invalid, the results are unpredictable.\r |
| 102 | \r |
| 103 | @param[in] TokenNumber The PCD token number. \r |
| 104 | \r |
| 105 | @return The UINT32 value.\r |
| 106 | \r |
| 107 | **/\r |
| 108 | typedef\r |
| 109 | UINT32\r |
| 8b13229b |
110 | (EFIAPI *PCD_PROTOCOL_GET32)(\r |
| d1f95000 |
111 | IN UINTN TokenNumber\r |
| 112 | );\r |
| 113 | \r |
| 114 | \r |
| 115 | \r |
| 116 | /**\r |
| 117 | Retrieves an 64-bit value for a given PCD token.\r |
| 118 | \r |
| 119 | Retrieves the current 64-bits value for a PCD token number. \r |
| 120 | If the TokenNumber is invalid, the results are unpredictable.\r |
| 121 | \r |
| 122 | @param[in] TokenNumber The PCD token number. \r |
| 123 | \r |
| 124 | @return The UINT64 value.\r |
| 125 | \r |
| 126 | **/\r |
| 127 | typedef\r |
| 128 | UINT64\r |
| 8b13229b |
129 | (EFIAPI *PCD_PROTOCOL_GET64)(\r |
| d1f95000 |
130 | IN UINTN TokenNumber\r |
| 131 | );\r |
| 132 | \r |
| 133 | \r |
| 134 | \r |
| 135 | /**\r |
| 136 | Retrieves a pointer to a value for a given PCD token.\r |
| 137 | \r |
| 138 | Retrieves the current pointer to the buffer for a PCD token number. \r |
| 139 | Do not make any assumptions about the alignment of the pointer that \r |
| 140 | is returned by this function call. If the TokenNumber is invalid, \r |
| 141 | the results are unpredictable.\r |
| 142 | \r |
| 143 | @param[in] TokenNumber The PCD token number. \r |
| 144 | \r |
| 145 | @return The pointer to the buffer to be retrived.\r |
| 146 | \r |
| 147 | **/\r |
| 148 | typedef\r |
| 149 | VOID *\r |
| 8b13229b |
150 | (EFIAPI *PCD_PROTOCOL_GET_POINTER)(\r |
| d1f95000 |
151 | IN UINTN TokenNumber\r |
| 152 | );\r |
| 153 | \r |
| 154 | \r |
| 155 | \r |
| 156 | /**\r |
| 157 | Retrieves a Boolean value for a given PCD token.\r |
| 158 | \r |
| 159 | Retrieves the current boolean value for a PCD token number. \r |
| 160 | Do not make any assumptions about the alignment of the pointer that \r |
| 161 | is returned by this function call. If the TokenNumber is invalid, \r |
| 162 | the results are unpredictable.\r |
| 163 | \r |
| 164 | @param[in] TokenNumber The PCD token number. \r |
| 165 | \r |
| 166 | @return The Boolean value.\r |
| 167 | \r |
| 168 | **/\r |
| 169 | typedef\r |
| 170 | BOOLEAN\r |
| 8b13229b |
171 | (EFIAPI *PCD_PROTOCOL_GET_BOOLEAN)(\r |
| d1f95000 |
172 | IN UINTN TokenNumber\r |
| 173 | );\r |
| 174 | \r |
| 175 | \r |
| 176 | \r |
| 177 | /**\r |
| 178 | Retrieves the size of the value for a given PCD token.\r |
| 179 | \r |
| 180 | Retrieves the current size of a particular PCD token. \r |
| 181 | If the TokenNumber is invalid, the results are unpredictable.\r |
| 182 | \r |
| 183 | @param[in] TokenNumber The PCD token number. \r |
| 184 | \r |
| 185 | @return The size of the value for the PCD token.\r |
| 186 | \r |
| 187 | **/\r |
| 188 | typedef\r |
| 189 | UINTN\r |
| 8b13229b |
190 | (EFIAPI *PCD_PROTOCOL_GET_SIZE)(\r |
| d1f95000 |
191 | IN UINTN TokenNumber\r |
| 192 | );\r |
| 193 | \r |
| 194 | \r |
| 195 | \r |
| 196 | /**\r |
| 197 | Retrieves an 8-bit value for a given PCD token.\r |
| 198 | \r |
| 199 | Retrieves the 8-bit value of a particular PCD token. \r |
| 200 | If the TokenNumber is invalid or the token space\r |
| 201 | specified by Guid does not exist, the results are \r |
| 202 | unpredictable.\r |
| 203 | \r |
| 204 | @param[in] Guid The token space for the token number.\r |
| 205 | @param[in] TokenNumber The PCD token number. \r |
| 206 | \r |
| 207 | @return The size 8-bit value for the PCD token.\r |
| 208 | \r |
| 209 | **/\r |
| 210 | typedef\r |
| 211 | UINT8\r |
| 8b13229b |
212 | (EFIAPI *PCD_PROTOCOL_GET_EX_8)(\r |
| d1f95000 |
213 | IN CONST EFI_GUID *Guid,\r |
| 214 | IN UINTN TokenNumber\r |
| 215 | );\r |
| 216 | \r |
| 217 | \r |
| 218 | \r |
| 219 | /**\r |
| 220 | Retrieves an 16-bit value for a given PCD token.\r |
| 221 | \r |
| 222 | Retrieves the 16-bit value of a particular PCD token. \r |
| 223 | If the TokenNumber is invalid or the token space\r |
| 224 | specified by Guid does not exist, the results are \r |
| 225 | unpredictable.\r |
| 226 | \r |
| 227 | @param[in] Guid The token space for the token number.\r |
| 228 | @param[in] TokenNumber The PCD token number. \r |
| 229 | \r |
| 230 | @return The size 16-bit value for the PCD token.\r |
| 231 | \r |
| 232 | **/\r |
| 233 | typedef\r |
| 234 | UINT16\r |
| 8b13229b |
235 | (EFIAPI *PCD_PROTOCOL_GET_EX_16)(\r |
| d1f95000 |
236 | IN CONST EFI_GUID *Guid,\r |
| 237 | IN UINTN TokenNumber\r |
| 238 | );\r |
| 239 | \r |
| 240 | \r |
| 241 | \r |
| 242 | /**\r |
| 243 | Retrieves an 32-bit value for a given PCD token.\r |
| 244 | \r |
| 245 | Retrieves the 32-bit value of a particular PCD token. \r |
| 246 | If the TokenNumber is invalid or the token space\r |
| 247 | specified by Guid does not exist, the results are \r |
| 248 | unpredictable.\r |
| 249 | \r |
| 250 | @param[in] Guid The token space for the token number.\r |
| 251 | @param[in] TokenNumber The PCD token number. \r |
| 252 | \r |
| 253 | @return The size 32-bit value for the PCD token.\r |
| 254 | \r |
| 63e4dba9 |
255 | **/\r |
| 256 | typedef\r |
| d1f95000 |
257 | UINT32\r |
| 8b13229b |
258 | (EFIAPI *PCD_PROTOCOL_GET_EX_32)(\r |
| d1f95000 |
259 | IN CONST EFI_GUID *Guid,\r |
| 260 | IN UINTN TokenNumber\r |
| 261 | );\r |
| 262 | \r |
| 263 | \r |
| 264 | \r |
| 265 | /**\r |
| 266 | Retrieves an 64-bit value for a given PCD token.\r |
| 267 | \r |
| 268 | Retrieves the 64-bit value of a particular PCD token. \r |
| 269 | If the TokenNumber is invalid or the token space\r |
| 270 | specified by Guid does not exist, the results are \r |
| 271 | unpredictable.\r |
| 272 | \r |
| 273 | @param[in] Guid The token space for the token number.\r |
| 274 | @param[in] TokenNumber The PCD token number. \r |
| 275 | \r |
| 276 | @return The size 64-bit value for the PCD token.\r |
| 277 | \r |
| 278 | **/\r |
| 279 | typedef\r |
| 280 | UINT64\r |
| 8b13229b |
281 | (EFIAPI *PCD_PROTOCOL_GET_EX_64)(\r |
| d1f95000 |
282 | IN CONST EFI_GUID *Guid,\r |
| 283 | IN UINTN TokenNumber\r |
| 284 | );\r |
| 285 | \r |
| 286 | \r |
| 287 | \r |
| 288 | /**\r |
| 289 | Retrieves a pointer to a value for a given PCD token.\r |
| 290 | \r |
| 291 | Retrieves the current pointer to the buffer for a PCD token number. \r |
| 292 | Do not make any assumptions about the alignment of the pointer that \r |
| 293 | is returned by this function call. If the TokenNumber is invalid, \r |
| 294 | the results are unpredictable.\r |
| 295 | \r |
| 296 | @param[in] Guid The token space for the token number.\r |
| 297 | @param[in] TokenNumber The PCD token number. \r |
| 298 | \r |
| 299 | @return The pointer to the buffer to be retrived.\r |
| 300 | \r |
| 301 | **/\r |
| 302 | typedef\r |
| 303 | VOID *\r |
| 8b13229b |
304 | (EFIAPI *PCD_PROTOCOL_GET_EX_POINTER)(\r |
| d1f95000 |
305 | IN CONST EFI_GUID *Guid,\r |
| 306 | IN UINTN TokenNumber\r |
| 307 | );\r |
| 308 | \r |
| 309 | \r |
| 310 | \r |
| 311 | /**\r |
| 312 | Retrieves an Boolean value for a given PCD token.\r |
| 313 | \r |
| 314 | Retrieves the Boolean value of a particular PCD token. \r |
| 315 | If the TokenNumber is invalid or the token space\r |
| 316 | specified by Guid does not exist, the results are \r |
| 317 | unpredictable.\r |
| 318 | \r |
| 319 | @param[in] Guid The token space for the token number.\r |
| 320 | @param[in] TokenNumber The PCD token number. \r |
| 321 | \r |
| 322 | @return The size Boolean value for the PCD token.\r |
| 323 | \r |
| 324 | **/\r |
| 325 | typedef\r |
| 326 | BOOLEAN\r |
| 8b13229b |
327 | (EFIAPI *PCD_PROTOCOL_GET_EX_BOOLEAN)(\r |
| d1f95000 |
328 | IN CONST EFI_GUID *Guid,\r |
| 329 | IN UINTN TokenNumber\r |
| 330 | );\r |
| 331 | \r |
| 332 | \r |
| 333 | \r |
| 334 | /**\r |
| 335 | Retrieves the size of the value for a given PCD token.\r |
| 336 | \r |
| 337 | Retrieves the current size of a particular PCD token. \r |
| 338 | If the TokenNumber is invalid, the results are unpredictable.\r |
| 339 | \r |
| 340 | @param[in] Guid The token space for the token number.\r |
| 341 | @param[in] TokenNumber The PCD token number. \r |
| 342 | \r |
| 343 | @return The size of the value for the PCD token.\r |
| 344 | \r |
| 345 | **/\r |
| 346 | typedef\r |
| 347 | UINTN\r |
| 8b13229b |
348 | (EFIAPI *PCD_PROTOCOL_GET_EX_SIZE)(\r |
| d1f95000 |
349 | IN CONST EFI_GUID *Guid,\r |
| 350 | IN UINTN TokenNumber\r |
| 351 | );\r |
| 352 | \r |
| 353 | \r |
| 354 | \r |
| 355 | /**\r |
| 356 | Sets an 8-bit value for a given PCD token.\r |
| 357 | \r |
| 358 | When the PCD service sets a value, it will check to ensure that the \r |
| 359 | size of the value being set is compatible with the Token's existing definition. \r |
| 360 | If it is not, an error will be returned.\r |
| 361 | \r |
| 362 | @param[in] TokenNumber The PCD token number. \r |
| 363 | @param[in] Value The value to set for the PCD token.\r |
| 364 | \r |
| 365 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 366 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 367 | being set was incompatible with a call to this function. \r |
| 368 | Use GetSize() to retrieve the size of the target data.\r |
| 369 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 370 | \r |
| 371 | **/\r |
| 372 | typedef\r |
| 373 | EFI_STATUS\r |
| 8b13229b |
374 | (EFIAPI *PCD_PROTOCOL_SET8)(\r |
| d1f95000 |
375 | IN UINTN TokenNumber,\r |
| 376 | IN UINT8 Value\r |
| 377 | );\r |
| 378 | \r |
| 379 | \r |
| 380 | \r |
| 381 | /**\r |
| 382 | Sets an 16-bit value for a given PCD token.\r |
| 383 | \r |
| 384 | When the PCD service sets a value, it will check to ensure that the \r |
| 385 | size of the value being set is compatible with the Token's existing definition. \r |
| 386 | If it is not, an error will be returned.\r |
| 387 | \r |
| 388 | @param[in] TokenNumber The PCD token number. \r |
| 389 | @param[in] Value The value to set for the PCD token.\r |
| 390 | \r |
| 391 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 392 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 393 | being set was incompatible with a call to this function. \r |
| 394 | Use GetSize() to retrieve the size of the target data.\r |
| 395 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 396 | \r |
| 397 | **/\r |
| 398 | typedef\r |
| 399 | EFI_STATUS\r |
| 8b13229b |
400 | (EFIAPI *PCD_PROTOCOL_SET16)(\r |
| d1f95000 |
401 | IN UINTN TokenNumber,\r |
| 402 | IN UINT16 Value\r |
| 403 | );\r |
| 404 | \r |
| 405 | \r |
| 406 | \r |
| 407 | /**\r |
| 408 | Sets an 32-bit value for a given PCD token.\r |
| 409 | \r |
| 410 | When the PCD service sets a value, it will check to ensure that the \r |
| 411 | size of the value being set is compatible with the Token's existing definition. \r |
| 412 | If it is not, an error will be returned.\r |
| 413 | \r |
| 414 | @param[in] TokenNumber The PCD token number. \r |
| 415 | @param[in] Value The value to set for the PCD token.\r |
| 416 | \r |
| 417 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 418 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 419 | being set was incompatible with a call to this function. \r |
| 420 | Use GetSize() to retrieve the size of the target data.\r |
| 421 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 422 | \r |
| 423 | **/\r |
| 424 | typedef\r |
| 425 | EFI_STATUS\r |
| 8b13229b |
426 | (EFIAPI *PCD_PROTOCOL_SET32)(\r |
| d1f95000 |
427 | IN UINTN TokenNumber,\r |
| 428 | IN UINT32 Value\r |
| 429 | );\r |
| 430 | \r |
| 431 | \r |
| 432 | \r |
| 433 | /**\r |
| 434 | Sets an 64-bit value for a given PCD token.\r |
| 435 | \r |
| 436 | When the PCD service sets a value, it will check to ensure that the \r |
| 437 | size of the value being set is compatible with the Token's existing definition. \r |
| 438 | If it is not, an error will be returned.\r |
| 439 | \r |
| 440 | @param[in] TokenNumber The PCD token number. \r |
| 441 | @param[in] Value The value to set for the PCD token.\r |
| 442 | \r |
| 443 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 444 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 445 | being set was incompatible with a call to this function. \r |
| 446 | Use GetSize() to retrieve the size of the target data.\r |
| 447 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 448 | \r |
| 449 | **/\r |
| 450 | typedef\r |
| 451 | EFI_STATUS\r |
| 8b13229b |
452 | (EFIAPI *PCD_PROTOCOL_SET64)(\r |
| d1f95000 |
453 | IN UINTN TokenNumber,\r |
| 454 | IN UINT64 Value\r |
| 455 | );\r |
| 456 | \r |
| 457 | \r |
| 458 | \r |
| 459 | /**\r |
| 460 | Sets a value of a specified size for a given PCD token.\r |
| 461 | \r |
| 462 | When the PCD service sets a value, it will check to ensure that the \r |
| 463 | size of the value being set is compatible with the Token's existing definition. \r |
| 464 | If it is not, an error will be returned.\r |
| 465 | \r |
| 466 | @param[in] TokenNumber The PCD token number. \r |
| 467 | @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. \r |
| 468 | On input, if the SizeOfValue is greater than the maximum size supported \r |
| 469 | for this TokenNumber then the output value of SizeOfValue will reflect \r |
| 470 | the maximum size supported for this TokenNumber.\r |
| 471 | @param[in] Buffer The buffer to set for the PCD token.\r |
| 472 | \r |
| 473 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 474 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 475 | being set was incompatible with a call to this function. \r |
| 476 | Use GetSize() to retrieve the size of the target data.\r |
| 477 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 478 | \r |
| 479 | **/\r |
| 480 | typedef\r |
| 481 | EFI_STATUS\r |
| 8b13229b |
482 | (EFIAPI *PCD_PROTOCOL_SET_POINTER)(\r |
| d1f95000 |
483 | IN UINTN TokenNumber,\r |
| 484 | IN OUT UINTN *SizeOfBuffer,\r |
| 485 | IN VOID *Buffer\r |
| 486 | );\r |
| 487 | \r |
| 488 | \r |
| 489 | \r |
| 490 | /**\r |
| 491 | Sets an Boolean value for a given PCD token.\r |
| 492 | \r |
| 493 | When the PCD service sets a value, it will check to ensure that the \r |
| 494 | size of the value being set is compatible with the Token's existing definition. \r |
| 495 | If it is not, an error will be returned.\r |
| 496 | \r |
| 497 | @param[in] TokenNumber The PCD token number. \r |
| 498 | @param[in] Value The value to set for the PCD token.\r |
| 499 | \r |
| 500 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 501 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 502 | being set was incompatible with a call to this function. \r |
| 503 | Use GetSize() to retrieve the size of the target data.\r |
| 504 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 505 | \r |
| 506 | **/\r |
| 507 | typedef\r |
| 508 | EFI_STATUS\r |
| 8b13229b |
509 | (EFIAPI *PCD_PROTOCOL_SET_BOOLEAN)(\r |
| d1f95000 |
510 | IN UINTN TokenNumber,\r |
| 511 | IN BOOLEAN Value\r |
| 512 | );\r |
| 513 | \r |
| 514 | \r |
| 515 | \r |
| 516 | /**\r |
| 517 | Sets an 8-bit value for a given PCD token.\r |
| 518 | \r |
| 519 | When the PCD service sets a value, it will check to ensure that the \r |
| 520 | size of the value being set is compatible with the Token's existing definition. \r |
| 521 | If it is not, an error will be returned.\r |
| 522 | \r |
| 523 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r |
| 524 | @param[in] TokenNumber The PCD token number. \r |
| 525 | @param[in] Value The value to set for the PCD token.\r |
| 526 | \r |
| 527 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 528 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 529 | being set was incompatible with a call to this function. \r |
| 530 | Use GetSize() to retrieve the size of the target data.\r |
| 531 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 532 | \r |
| 533 | **/\r |
| 534 | typedef\r |
| 535 | EFI_STATUS\r |
| 8b13229b |
536 | (EFIAPI *PCD_PROTOCOL_SET_EX_8)(\r |
| d1f95000 |
537 | IN CONST EFI_GUID *Guid,\r |
| 538 | IN UINTN TokenNumber,\r |
| 539 | IN UINT8 Value\r |
| 540 | );\r |
| 541 | \r |
| 542 | \r |
| 543 | \r |
| 544 | /**\r |
| 545 | Sets an 16-bit value for a given PCD token.\r |
| 546 | \r |
| 547 | When the PCD service sets a value, it will check to ensure that the \r |
| 548 | size of the value being set is compatible with the Token's existing definition. \r |
| 549 | If it is not, an error will be returned.\r |
| 550 | \r |
| 551 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r |
| 552 | @param[in] TokenNumber The PCD token number. \r |
| 553 | @param[in] Value The value to set for the PCD token.\r |
| 554 | \r |
| 555 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 556 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 557 | being set was incompatible with a call to this function. \r |
| 558 | Use GetSize() to retrieve the size of the target data.\r |
| 559 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 560 | \r |
| 561 | **/\r |
| 562 | typedef\r |
| 563 | EFI_STATUS\r |
| 8b13229b |
564 | (EFIAPI *PCD_PROTOCOL_SET_EX_16)(\r |
| d1f95000 |
565 | IN CONST EFI_GUID *Guid,\r |
| 566 | IN UINTN TokenNumber,\r |
| 567 | IN UINT16 Value\r |
| 568 | );\r |
| 569 | \r |
| 570 | \r |
| 571 | \r |
| 572 | /**\r |
| 573 | Sets an 32-bit value for a given PCD token.\r |
| 574 | \r |
| 575 | When the PCD service sets a value, it will check to ensure that the \r |
| 576 | size of the value being set is compatible with the Token's existing definition. \r |
| 577 | If it is not, an error will be returned.\r |
| 578 | \r |
| 579 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r |
| 580 | @param[in] TokenNumber The PCD token number. \r |
| 581 | @param[in] Value The value to set for the PCD token.\r |
| 582 | \r |
| 583 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 584 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 585 | being set was incompatible with a call to this function. \r |
| 586 | Use GetSize() to retrieve the size of the target data.\r |
| 587 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 588 | \r |
| 589 | **/\r |
| 590 | typedef\r |
| 591 | EFI_STATUS\r |
| 8b13229b |
592 | (EFIAPI *PCD_PROTOCOL_SET_EX_32)(\r |
| d1f95000 |
593 | IN CONST EFI_GUID *Guid,\r |
| 594 | IN UINTN TokenNumber,\r |
| 595 | IN UINT32 Value\r |
| 596 | );\r |
| 597 | \r |
| 598 | \r |
| 599 | \r |
| 600 | /**\r |
| 601 | Sets an 64-bit value for a given PCD token.\r |
| 602 | \r |
| 603 | When the PCD service sets a value, it will check to ensure that the \r |
| 604 | size of the value being set is compatible with the Token's existing definition. \r |
| 605 | If it is not, an error will be returned.\r |
| 606 | \r |
| 607 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r |
| 608 | @param[in] TokenNumber The PCD token number. \r |
| 609 | @param[in] Value The value to set for the PCD token.\r |
| 610 | \r |
| 611 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 612 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 613 | being set was incompatible with a call to this function. \r |
| 614 | Use GetSize() to retrieve the size of the target data.\r |
| 615 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 616 | \r |
| 617 | **/\r |
| 618 | typedef\r |
| 619 | EFI_STATUS\r |
| 8b13229b |
620 | (EFIAPI *PCD_PROTOCOL_SET_EX_64)(\r |
| d1f95000 |
621 | IN CONST EFI_GUID *Guid,\r |
| 622 | IN UINTN TokenNumber,\r |
| 623 | IN UINT64 Value\r |
| 624 | );\r |
| 625 | \r |
| 626 | \r |
| 627 | \r |
| 628 | /**\r |
| 629 | Sets a value of a specified size for a given PCD token.\r |
| 630 | \r |
| 631 | When the PCD service sets a value, it will check to ensure that the \r |
| 632 | size of the value being set is compatible with the Token's existing definition. \r |
| 633 | If it is not, an error will be returned.\r |
| 634 | \r |
| 635 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r |
| 636 | @param[in] TokenNumber The PCD token number. \r |
| 637 | @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. \r |
| 638 | On input, if the SizeOfValue is greater than the maximum size supported \r |
| 639 | for this TokenNumber then the output value of SizeOfValue will reflect \r |
| 640 | the maximum size supported for this TokenNumber.\r |
| 641 | @param[in] Buffer The buffer to set for the PCD token.\r |
| 642 | \r |
| 643 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 644 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 645 | being set was incompatible with a call to this function. \r |
| 646 | Use GetSize() to retrieve the size of the target data.\r |
| 647 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 648 | \r |
| 649 | **/\r |
| 650 | typedef\r |
| 651 | EFI_STATUS\r |
| 8b13229b |
652 | (EFIAPI *PCD_PROTOCOL_SET_EX_POINTER)(\r |
| d1f95000 |
653 | IN CONST EFI_GUID *Guid,\r |
| 654 | IN UINTN TokenNumber,\r |
| 655 | IN OUT UINTN *SizeOfBuffer,\r |
| 656 | IN VOID *Buffer\r |
| 657 | );\r |
| 658 | \r |
| 659 | \r |
| 660 | \r |
| 661 | /**\r |
| 662 | Sets an Boolean value for a given PCD token.\r |
| 663 | \r |
| 664 | When the PCD service sets a value, it will check to ensure that the \r |
| 665 | size of the value being set is compatible with the Token's existing definition. \r |
| 666 | If it is not, an error will be returned.\r |
| 667 | \r |
| 668 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r |
| 669 | @param[in] TokenNumber The PCD token number. \r |
| 670 | @param[in] Value The value to set for the PCD token.\r |
| 671 | \r |
| 672 | @retval EFI_SUCCESS Procedure returned successfully.\r |
| 673 | @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r |
| 674 | being set was incompatible with a call to this function. \r |
| 675 | Use GetSize() to retrieve the size of the target data.\r |
| 676 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r |
| 677 | \r |
| 678 | **/\r |
| 679 | typedef\r |
| 680 | EFI_STATUS\r |
| 8b13229b |
681 | (EFIAPI *PCD_PROTOCOL_SET_EX_BOOLEAN)(\r |
| d1f95000 |
682 | IN CONST EFI_GUID *Guid,\r |
| 683 | IN UINTN TokenNumber,\r |
| 684 | IN BOOLEAN Value\r |
| 685 | );\r |
| 686 | \r |
| 687 | \r |
| 688 | \r |
| 689 | /**\r |
| 690 | Callback on SET function prototype definition.\r |
| 691 | \r |
| 692 | This notification function serves two purposes. \r |
| 693 | Firstly, it notifies the module which did the registration that the value \r |
| 694 | of this PCD token has been set. Secondly, it provides a mechanism for the \r |
| 695 | module which did the registration to intercept the set operation and override \r |
| 696 | the value been set if necessary. After the invocation of the callback function, \r |
| 697 | TokenData will be used by PCD service DXE driver to modify the internal data in \r |
| 698 | PCD database.\r |
| 699 | \r |
| 700 | @param[in] CallBackGuid The PCD token GUID being set.\r |
| 701 | @param[in] CallBackToken The PCD token number being set.\r |
| 702 | @param[in, out] TokenData A pointer to the token data being set.\r |
| 703 | @param[in] TokenDataSize The size, in bytes, of the data being set.\r |
| 704 | \r |
| 705 | @retval VOID\r |
| 706 | \r |
| 707 | **/\r |
| 708 | typedef\r |
| 709 | VOID\r |
| 8b13229b |
710 | (EFIAPI *PCD_PROTOCOL_CALLBACK)(\r |
| d1f95000 |
711 | IN CONST EFI_GUID *CallBackGuid, OPTIONAL\r |
| 712 | IN UINTN CallBackToken,\r |
| 713 | IN OUT VOID *TokenData,\r |
| 714 | IN UINTN TokenDataSize\r |
| 715 | );\r |
| 716 | \r |
| 717 | \r |
| 718 | \r |
| 719 | /**\r |
| 720 | Specifies a function to be called anytime the value of a designated token is changed.\r |
| 721 | \r |
| 722 | @param[in] TokenNumber The PCD token number. \r |
| 723 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r |
| 724 | @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. \r |
| 725 | \r |
| 726 | @retval EFI_SUCCESS The PCD service has successfully established a call event \r |
| 727 | for the CallBackToken requested.\r |
| 728 | @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.\r |
| 729 | \r |
| 730 | **/\r |
| 731 | typedef\r |
| 732 | EFI_STATUS\r |
| 8b13229b |
733 | (EFIAPI *PCD_PROTOCOL_CALLBACK_ONSET)(\r |
| d1f95000 |
734 | IN CONST EFI_GUID *Guid, OPTIONAL\r |
| 735 | IN UINTN TokenNumber,\r |
| 736 | IN PCD_PROTOCOL_CALLBACK CallBackFunction\r |
| 737 | );\r |
| 738 | \r |
| 739 | \r |
| 740 | \r |
| 741 | /**\r |
| 742 | Cancels a previously set callback function for a particular PCD token number.\r |
| 743 | \r |
| 744 | @param[in] TokenNumber The PCD token number. \r |
| 745 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r |
| 746 | @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. \r |
| 747 | \r |
| 748 | @retval EFI_SUCCESS The PCD service has successfully established a call event \r |
| 749 | for the CallBackToken requested.\r |
| 750 | @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.\r |
| 751 | \r |
| 752 | **/\r |
| 753 | typedef\r |
| 754 | EFI_STATUS\r |
| 8b13229b |
755 | (EFIAPI *PCD_PROTOCOL_CANCEL_CALLBACK)(\r |
| d1f95000 |
756 | IN CONST EFI_GUID *Guid, OPTIONAL\r |
| 757 | IN UINTN TokenNumber,\r |
| 758 | IN PCD_PROTOCOL_CALLBACK CallBackFunction\r |
| 759 | );\r |
| 760 | \r |
| 761 | \r |
| 762 | \r |
| 763 | /**\r |
| 764 | Retrieves the next valid PCD token for a given namespace.\r |
| 765 | \r |
| 766 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r |
| 767 | @param[in,out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number. \r |
| 768 | If the input token namespace or token number does not exist on the platform, \r |
| 769 | an error is returned and the value of *TokenNumber is undefined. To retrieve the "first" token, \r |
| 770 | have the pointer reference a TokenNumber value of 0. If the input token number is 0 and \r |
| 771 | there is no valid token number for this token namespace, *TokenNumber will be assigned to \r |
| 772 | 0 and the function return EFI_SUCCESS. If the token number is the last valid token number, \r |
| 773 | *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS.\r |
| 774 | \r |
| 775 | @retval EFI_SUCCESS The PCD service retrieved the next valid token number. Or the input token number \r |
| 776 | is already the last valid token number in the PCD database. \r |
| 777 | In the later case, *TokenNumber is updated with the value of 0.\r |
| 778 | @retval EFI_NOT_FOUND If this input token number and token namespace does not exist on the platform.\r |
| 779 | \r |
| 780 | **/\r |
| 781 | typedef \r |
| 782 | EFI_STATUS\r |
| 8b13229b |
783 | (EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKEN)(\r |
| d1f95000 |
784 | IN CONST EFI_GUID *Guid, OPTIONAL\r |
| 785 | IN OUT UINTN *TokenNumber\r |
| 786 | );\r |
| 787 | \r |
| 788 | \r |
| 789 | \r |
| 790 | /**\r |
| 791 | Retrieves the next valid PCD token namespace for a given namespace.\r |
| 792 | \r |
| 793 | @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates \r |
| 794 | a known token namespace from which the search will start. On output, \r |
| 795 | it designates the next valid token namespace on the platform. If the input \r |
| 796 | token namespace does not exist on the platform, an error is returned and \r |
| 797 | the value of *Guid is undefined. If *Guid is NULL, then the GUID of the \r |
| 798 | first token space of the current platform is assigned to *Guid the function \r |
| 799 | return EFI_SUCCESS. If *Guid is NULL and there is no namespace exist in \r |
| 800 | the platform other than the default (NULL) tokennamespace, *Guid is unchanged \r |
| 801 | and the function return EFI_SUCCESS. If this input token namespace is the last \r |
| 802 | namespace on the platform, *Guid will be assigned to NULL and the function return \r |
| 803 | EFI_SUCCESS. \r |
| 804 | \r |
| 805 | @retval EFI_SUCCESS The PCD service retrieved the next valid token space Guid. \r |
| 806 | Or the input token space Guid is already the last valid token space Guid \r |
| 807 | in the PCD database. In the later case, *Guid is updated with the value of NULL.\r |
| 808 | @retval EFI_NOT_FOUND If the input token namespace does not exist on the platform.\r |
| 809 | \r |
| 810 | **/\r |
| 811 | typedef \r |
| 812 | EFI_STATUS\r |
| 8b13229b |
813 | (EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKENSPACE)(\r |
| d1f95000 |
814 | IN OUT CONST EFI_GUID **Guid\r |
| 815 | );\r |
| 816 | \r |
| 817 | \r |
| 818 | \r |
| 819 | //\r |
| 820 | // Interface structure for the PCD Protocol\r |
| 821 | //\r |
| 822 | typedef struct {\r |
| 823 | PCD_PROTOCOL_SET_SKU SetSku;\r |
| 824 | \r |
| 825 | PCD_PROTOCOL_GET8 Get8;\r |
| 826 | PCD_PROTOCOL_GET16 Get16;\r |
| 827 | PCD_PROTOCOL_GET32 Get32;\r |
| 828 | PCD_PROTOCOL_GET64 Get64;\r |
| 829 | PCD_PROTOCOL_GET_POINTER GetPtr;\r |
| 830 | PCD_PROTOCOL_GET_BOOLEAN GetBool;\r |
| 831 | PCD_PROTOCOL_GET_SIZE GetSize;\r |
| 832 | \r |
| 833 | PCD_PROTOCOL_GET_EX_8 Get8Ex;\r |
| 834 | PCD_PROTOCOL_GET_EX_16 Get16Ex;\r |
| 835 | PCD_PROTOCOL_GET_EX_32 Get32Ex;\r |
| 836 | PCD_PROTOCOL_GET_EX_64 Get64Ex;\r |
| 837 | PCD_PROTOCOL_GET_EX_POINTER GetPtrEx;\r |
| 838 | PCD_PROTOCOL_GET_EX_BOOLEAN GetBoolEx;\r |
| 839 | PCD_PROTOCOL_GET_EX_SIZE GetSizeEx;\r |
| 840 | \r |
| 841 | PCD_PROTOCOL_SET8 Set8;\r |
| 842 | PCD_PROTOCOL_SET16 Set16;\r |
| 843 | PCD_PROTOCOL_SET32 Set32;\r |
| 844 | PCD_PROTOCOL_SET64 Set64;\r |
| 845 | PCD_PROTOCOL_SET_POINTER SetPtr;\r |
| 846 | PCD_PROTOCOL_SET_BOOLEAN SetBool;\r |
| 847 | \r |
| 848 | PCD_PROTOCOL_SET_EX_8 Set8Ex;\r |
| 849 | PCD_PROTOCOL_SET_EX_16 Set16Ex;\r |
| 850 | PCD_PROTOCOL_SET_EX_32 Set32Ex;\r |
| 851 | PCD_PROTOCOL_SET_EX_64 Set64Ex;\r |
| 852 | PCD_PROTOCOL_SET_EX_POINTER SetPtrEx;\r |
| 853 | PCD_PROTOCOL_SET_EX_BOOLEAN SetBoolEx;\r |
| 854 | \r |
| 855 | PCD_PROTOCOL_CALLBACK_ONSET CallbackOnSet;\r |
| 856 | PCD_PROTOCOL_CANCEL_CALLBACK CancelCallback;\r |
| 857 | PCD_PROTOCOL_GET_NEXT_TOKEN GetNextToken;\r |
| 858 | PCD_PROTOCOL_GET_NEXT_TOKENSPACE GetNextTokenSpace;\r |
| 859 | } PCD_PROTOCOL;\r |
| 860 | \r |
| 861 | #endif\r |
projects / mirror_edk2.git / blame