IntelFrameworkPkg/Library/DxeBootScriptLibNull/BootScriptLib.c

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