IntelFrameworkPkg/Library/DxeBootScriptLibNull/BootScriptLib.c

   1 /*++
   2
   3   Copyright (c) 2006 - 2007, Intel Corporation<BR>
   4   All rights reserved. This program and the accompanying materials
   5   are licensed and made available under the terms and conditions of the BSD License
   6   which accompanies this distribution.  The full text of the license may be found at
   7   http://opensource.org/licenses/bsd-license.php
   8
   9   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14     BootScriptLib.c
  15
  16 Abstract:
  17
  18   Support for EFI script.
  19
  20 --*/
  21
  22 //
  23 // The package level header files this module uses
  24 //
  25 #include <PiDxe.h>
  26 //
  27 // The protocols, PPI and GUID defintions for this module
  28 //
  29 //
  30 // The Library classes this module consumes
  31 //
  32 #include <Library/BootScriptLib.h>
  33
  34 EFI_STATUS
  35 EFIAPI
  36 BootScriptSaveIoWrite (
  37   IN  UINT16                            TableName,
  38   IN  EFI_BOOT_SCRIPT_WIDTH             Width,
  39   IN  UINT64                            Address,
  40   IN  UINTN                             Count,
  41   IN  VOID                              *Buffer
  42   )
  43 /*++
  44
  45 Routine Description:
  46
  47   Save I/O write to boot script
  48
  49 Arguments:
  50
  51   TableName - Desired boot script table
  52
  53   (Standard EFI IO write script parameter)
  54
  55 Returns:
  56
  57   EFI_NOT_FOUND - BootScriptSave Protocol not exist.
  58
  59   EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
  60
  61 --*/
  62 // GC_TODO:    Width - add argument and description to function comment
  63 // GC_TODO:    Address - add argument and description to function comment
  64 // GC_TODO:    Count - add argument and description to function comment
  65 // GC_TODO:    Buffer - add argument and description to function comment
  66 {
  67   return EFI_SUCCESS;
  68 }
  69
  70 EFI_STATUS
  71 EFIAPI
  72 BootScriptSaveIoReadWrite (
  73   IN  UINT16                            TableName,
  74   IN  EFI_BOOT_SCRIPT_WIDTH             Width,
  75   IN  UINT64                            Address,
  76   IN  VOID                              *Data,
  77   IN  VOID                              *DataMask
  78   )
  79 /*++
  80
  81 Routine Description:
  82
  83   Save I/O write to boot script
  84
  85 Arguments:
  86
  87   TableName - Desired boot script table
  88
  89   (Standard EFI IO read write script parameter)
  90
  91 Returns:
  92
  93   EFI_NOT_FOUND - BootScriptSave Protocol not exist.
  94
  95   EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
  96
  97 --*/
  98 // GC_TODO:    Width - add argument and description to function comment
  99 // GC_TODO:    Address - add argument and description to function comment
 100 // GC_TODO:    Data - add argument and description to function comment
 101 // GC_TODO:    DataMask - add argument and description to function comment
 102 {
 103   return EFI_SUCCESS;
 104 }
 105
 106 EFI_STATUS
 107 EFIAPI
 108 BootScriptSaveMemWrite (
 109   IN  UINT16                            TableName,
 110   IN  EFI_BOOT_SCRIPT_WIDTH             Width,
 111   IN  UINT64                            Address,
 112   IN  UINTN                             Count,
 113   IN  VOID                              *Buffer
 114   )
 115 /*++
 116
 117 Routine Description:
 118
 119   Save I/O write to boot script
 120
 121 Arguments:
 122
 123   TableName - Desired boot script table
 124
 125   (Standard EFI MEM write script parameter)
 126
 127 Returns:
 128
 129   EFI_NOT_FOUND - BootScriptSave Protocol not exist.
 130
 131   EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
 132
 133 --*/
 134 // GC_TODO:    Width - add argument and description to function comment
 135 // GC_TODO:    Address - add argument and description to function comment
 136 // GC_TODO:    Count - add argument and description to function comment
 137 // GC_TODO:    Buffer - add argument and description to function comment
 138 {
 139   return EFI_SUCCESS;
 140 }
 141
 142 EFI_STATUS
 143 EFIAPI
 144 BootScriptSaveMemReadWrite (
 145   IN  UINT16                            TableName,
 146   IN  EFI_BOOT_SCRIPT_WIDTH             Width,
 147   IN  UINT64                            Address,
 148   IN  VOID                              *Data,
 149   IN  VOID                              *DataMask
 150   )
 151 /*++
 152
 153 Routine Description:
 154
 155   Save I/O write to boot script
 156
 157 Arguments:
 158
 159   TableName - Desired boot script table
 160
 161   (Standard EFI MEM read write script parameter)
 162
 163 Returns:
 164
 165   EFI_NOT_FOUND - BootScriptSave Protocol not exist.
 166
 167   EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
 168
 169 --*/
 170 // GC_TODO:    Width - add argument and description to function comment
 171 // GC_TODO:    Address - add argument and description to function comment
 172 // GC_TODO:    Data - add argument and description to function comment
 173 // GC_TODO:    DataMask - add argument and description to function comment
 174 {
 175   return EFI_SUCCESS;
 176 }
 177
 178 EFI_STATUS
 179 EFIAPI
 180 BootScriptSavePciCfgWrite (
 181   IN  UINT16                            TableName,
 182   IN  EFI_BOOT_SCRIPT_WIDTH             Width,
 183   IN  UINT64                            Address,
 184   IN  UINTN                             Count,
 185   IN  VOID                              *Buffer
 186   )
 187 /*++
 188
 189 Routine Description:
 190
 191   Save I/O write to boot script
 192
 193 Arguments:
 194
 195   TableName - Desired boot script table
 196
 197   (Standard EFI PCI write script parameter)
 198
 199 Returns:
 200
 201   EFI_NOT_FOUND - BootScriptSave Protocol not exist.
 202
 203   EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
 204
 205 --*/
 206 // GC_TODO:    Width - add argument and description to function comment
 207 // GC_TODO:    Address - add argument and description to function comment
 208 // GC_TODO:    Count - add argument and description to function comment
 209 // GC_TODO:    Buffer - add argument and description to function comment
 210 {
 211   return EFI_SUCCESS;
 212 }
 213
 214 EFI_STATUS
 215 EFIAPI
 216 BootScriptSavePciCfgReadWrite (
 217   IN  UINT16                            TableName,
 218   IN  EFI_BOOT_SCRIPT_WIDTH             Width,
 219   IN  UINT64                            Address,
 220   IN  VOID                              *Data,
 221   IN  VOID                              *DataMask
 222   )
 223 /*++
 224
 225 Routine Description:
 226
 227   Save I/O write to boot script
 228
 229 Arguments:
 230
 231   TableName - Desired boot script table
 232
 233   (Standard EFI PCI read write script parameter)
 234
 235 Returns:
 236
 237   EFI_NOT_FOUND - BootScriptSave Protocol not exist.
 238
 239   EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
 240
 241 --*/
 242 // GC_TODO:    Width - add argument and description to function comment
 243 // GC_TODO:    Address - add argument and description to function comment
 244 // GC_TODO:    Data - add argument and description to function comment
 245 // GC_TODO:    DataMask - add argument and description to function comment
 246 {
 247   return EFI_SUCCESS;
 248 }
 249
 250 EFI_STATUS
 251 EFIAPI
 252 BootScriptSaveSmbusExecute (
 253   IN  UINT16                            TableName,
 254   IN  EFI_SMBUS_DEVICE_ADDRESS          SlaveAddress,
 255   IN  EFI_SMBUS_DEVICE_COMMAND          Command,
 256   IN  EFI_SMBUS_OPERATION               Operation,
 257   IN  BOOLEAN                           PecCheck,
 258   IN  UINTN                             *Length,
 259   IN  VOID                              *Buffer
 260   )
 261 /*++
 262
 263 Routine Description:
 264
 265   Save I/O write to boot script
 266
 267 Arguments:
 268
 269   TableName - Desired boot script table
 270
 271   (Standard EFI Smbus execute script parameter)
 272
 273 Returns:
 274
 275   EFI_NOT_FOUND - BootScriptSave Protocol not exist.
 276
 277   EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
 278
 279 --*/
 280 // GC_TODO:    SlaveAddress - add argument and description to function comment
 281 // GC_TODO:    Command - add argument and description to function comment
 282 // GC_TODO:    Operation - add argument and description to function comment
 283 // GC_TODO:    PecCheck - add argument and description to function comment
 284 // GC_TODO:    Length - add argument and description to function comment
 285 // GC_TODO:    Buffer - add argument and description to function comment
 286 {
 287   return EFI_SUCCESS;
 288 }
 289
 290 EFI_STATUS
 291 EFIAPI
 292 BootScriptSaveStall (
 293   IN  UINT16                            TableName,
 294   IN  UINTN                             Duration
 295   )
 296 /*++
 297
 298 Routine Description:
 299
 300   Save I/O write to boot script
 301
 302 Arguments:
 303
 304   TableName - Desired boot script table
 305
 306   (Standard EFI stall script parameter)
 307
 308 Returns:
 309
 310   EFI_NOT_FOUND - BootScriptSave Protocol not exist.
 311
 312   EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
 313
 314 --*/
 315 // GC_TODO:    Duration - add argument and description to function comment
 316 {
 317   return EFI_SUCCESS;
 318 }
 319
 320 EFI_STATUS
 321 EFIAPI
 322 BootScriptSaveDispatch2 (
 323   IN  UINT16                            TableName,
 324   IN  EFI_PHYSICAL_ADDRESS              EntryPoint,
 325   IN  EFI_PHYSICAL_ADDRESS              Context
 326   )
 327 /*++
 328
 329 Routine Description:
 330
 331   GC_TODO: Add function description
 332
 333 Arguments:
 334
 335   TableName   - GC_TODO: add argument description
 336   EntryPoint  - GC_TODO: add argument description
 337
 338 Returns:
 339
 340   EFI_NOT_FOUND - GC_TODO: Add description for return value
 341   EFI_SUCCESS - GC_TODO: Add description for return value
 342
 343 --*/
 344 {
 345   return EFI_SUCCESS;
 346 }
 347
 348 EFI_STATUS
 349 EFIAPI
 350 BootScriptSaveInformation (
 351   IN  UINT16                                 TableName,
 352   IN  UINT32                                 Length,
 353   IN  EFI_PHYSICAL_ADDRESS                   Buffer
 354   )
 355 /*++
 356
 357 Routine Description:
 358
 359   GC_TODO: Add function description
 360
 361 Arguments:
 362
 363   TableName   - GC_TODO: add argument description
 364   EntryPoint  - GC_TODO: add argument description
 365
 366 Returns:
 367
 368   EFI_NOT_FOUND - GC_TODO: Add description for return value
 369   EFI_SUCCESS - GC_TODO: Add description for return value
 370
 371 --*/
 372 {
 373   return EFI_SUCCESS;
 374 }
 375
 376 EFI_STATUS
 377 EFIAPI
 378 BootScriptSaveInformationUnicodeString (
 379   IN        UINT16              TableName,
 380   IN  CONST CHAR16              *String
 381   )
 382   /*++
 383
 384 Routine Description:
 385
 386   Save unicode string information specified by Buffer to
 387   boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE
 388
 389 Arguments:
 390
 391   TableName     - Desired boot script table
 392
 393   FfsName       - The file name of the code to be dispatched.
 394
 395   Context       - The data that will be passed into code.
 396
 397   ParentHandle  - The caller's image handle.
 398
 399 Returns:
 400
 401   EFI_NOT_FOUND - BootScriptSave Protocol not exist.
 402
 403   EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
 404
 405 --*/
 406 {
 407   return EFI_SUCCESS;
 408 }
 409
 410 EFI_STATUS
 411 EFIAPI
 412 BootScriptSaveInformationAsciiString (
 413   IN        UINT16              TableName,
 414   IN  CONST CHAR8               *String
 415   )
 416   /*++
 417
 418 Routine Description:
 419
 420   Save ASCII string information specified by Buffer to
 421   boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE
 422
 423 Arguments:
 424
 425   TableName     - Desired boot script table
 426
 427   FfsName       - The file name of the code to be dispatched.
 428
 429   Context       - The data that will be passed into code.
 430
 431   ParentHandle  - The caller's image handle.
 432
 433 Returns:
 434
 435   EFI_NOT_FOUND - BootScriptSave Protocol not exist.
 436
 437   EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
 438
 439 --*/
 440 {
 441   return EFI_SUCCESS;
 442 }
 443
 444
 445 EFI_STATUS
 446 EFIAPI
 447 BootScriptSaveDispatch (
 448   IN  UINT16                            TableName,
 449   IN  EFI_PHYSICAL_ADDRESS              EntryPoint
 450   )
 451 /*++
 452
 453 Routine Description:
 454
 455   GC_TODO: Add function description
 456
 457 Arguments:
 458
 459   TableName   - GC_TODO: add argument description
 460   EntryPoint  - GC_TODO: add argument description
 461
 462 Returns:
 463
 464   EFI_NOT_FOUND - GC_TODO: Add description for return value
 465   EFI_SUCCESS - GC_TODO: Add description for return value
 466
 467 --*/
 468 {
 469   return EFI_SUCCESS;
 470 }
 471
 472 EFI_STATUS
 473 EFIAPI
 474 BootScriptSaveDispatch2Image (
 475   IN  UINT16                            TableName,
 476   IN  EFI_GUID                          *FfsName,
 477   IN  EFI_PHYSICAL_ADDRESS              Context,
 478   IN  EFI_HANDLE                        ParentHandle
 479   )
 480 /*++
 481
 482 Routine Description:
 483
 484   Save dispatching specified arbitrary code to boot script with opcode
 485   EFI_BOOT_SCRIPT_DISPATCH_OPCODE
 486
 487 Arguments:
 488
 489   TableName     - Desired boot script table
 490
 491   FfsName       - The file name of the code to be dispatched.
 492
 493   Context       - The data that will be passed into code.
 494
 495   ParentHandle  - The caller's image handle.
 496
 497 Returns:
 498
 499   EFI_NOT_FOUND - BootScriptSave Protocol not exist.
 500
 501   EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
 502
 503 --*/
 504 {
 505   return EFI_SUCCESS;
 506 }