IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDeviceSupport.h

   1 /**@file
   2
   3 Copyright (c) 2006, Intel Corporation
   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 **/
  13
  14 #ifndef _EFI_PCI_DEVICE_SUPPORT_H
  15 #define _EFI_PCI_DEVICE_SUPPORT_H
  16
  17 EFI_STATUS
  18 InitializePciDevicePool (
  19   VOID
  20   )
  21 /**
  22
  23 Routine Description:
  24
  25   TODO: Add function description
  26
  27 Arguments:
  28
  29   None
  30
  31 Returns:
  32
  33   TODO: add return values
  34
  35 **/
  36 ;
  37
  38 EFI_STATUS
  39 InsertRootBridge (
  40   PCI_IO_DEVICE *RootBridge
  41   )
  42 /**
  43
  44 Routine Description:
  45
  46   TODO: Add function description
  47
  48 Arguments:
  49
  50   RootBridge  - TODO: add argument description
  51
  52 Returns:
  53
  54   TODO: add return values
  55
  56 **/
  57 ;
  58
  59 EFI_STATUS
  60 InsertPciDevice (
  61   PCI_IO_DEVICE *Bridge,
  62   PCI_IO_DEVICE *PciDeviceNode
  63   )
  64 /**
  65
  66 Routine Description:
  67
  68   TODO: Add function description
  69
  70 Arguments:
  71
  72   Bridge        - TODO: add argument description
  73   PciDeviceNode - TODO: add argument description
  74
  75 Returns:
  76
  77   TODO: add return values
  78
  79 **/
  80 ;
  81
  82 EFI_STATUS
  83 DestroyRootBridge (
  84   IN PCI_IO_DEVICE *RootBridge
  85   )
  86 /**
  87
  88 Routine Description:
  89
  90   TODO: Add function description
  91
  92 Arguments:
  93
  94   RootBridge  - TODO: add argument description
  95
  96 Returns:
  97
  98   TODO: add return values
  99
 100 **/
 101 ;
 102
 103 EFI_STATUS
 104 DestroyPciDeviceTree (
 105   IN PCI_IO_DEVICE *Bridge
 106   )
 107 /**
 108
 109 Routine Description:
 110
 111   TODO: Add function description
 112
 113 Arguments:
 114
 115   Bridge  - TODO: add argument description
 116
 117 Returns:
 118
 119   TODO: add return values
 120
 121 **/
 122 ;
 123
 124 EFI_STATUS
 125 DestroyRootBridgeByHandle (
 126   EFI_HANDLE Controller
 127   )
 128 /**
 129
 130 Routine Description:
 131
 132   TODO: Add function description
 133
 134 Arguments:
 135
 136   Controller  - TODO: add argument description
 137
 138 Returns:
 139
 140   TODO: add return values
 141
 142 **/
 143 ;
 144
 145 EFI_STATUS
 146 RegisterPciDevice (
 147   IN  EFI_HANDLE                     Controller,
 148   IN  PCI_IO_DEVICE                  *PciIoDevice,
 149   OUT EFI_HANDLE                     *Handle OPTIONAL
 150   )
 151 /**
 152
 153 Routine Description:
 154
 155   TODO: Add function description
 156
 157 Arguments:
 158
 159   Controller  - TODO: add argument description
 160   PciIoDevice - TODO: add argument description
 161   Handle      - TODO: add argument description
 162
 163 Returns:
 164
 165   TODO: add return values
 166
 167 **/
 168 ;
 169
 170 EFI_STATUS
 171 RemoveAllPciDeviceOnBridge (
 172   EFI_HANDLE               RootBridgeHandle,
 173   PCI_IO_DEVICE            *Bridge
 174   )
 175 /**
 176
 177 Routine Description:
 178
 179   TODO: Add function description
 180
 181 Arguments:
 182
 183   RootBridgeHandle  - TODO: add argument description
 184   Bridge            - TODO: add argument description
 185
 186 Returns:
 187
 188   TODO: add return values
 189
 190 **/
 191 ;
 192
 193 EFI_STATUS
 194 DeRegisterPciDevice (
 195   IN  EFI_HANDLE                     Controller,
 196   IN  EFI_HANDLE                     Handle
 197   )
 198 /**
 199
 200 Routine Description:
 201
 202   TODO: Add function description
 203
 204 Arguments:
 205
 206   Controller  - TODO: add argument description
 207   Handle      - TODO: add argument description
 208
 209 Returns:
 210
 211   TODO: add return values
 212
 213 **/
 214 ;
 215
 216 EFI_STATUS
 217 StartPciDevicesOnBridge (
 218   IN EFI_HANDLE                          Controller,
 219   IN PCI_IO_DEVICE                       *RootBridge,
 220   IN EFI_DEVICE_PATH_PROTOCOL            *RemainingDevicePath,
 221   IN OUT UINT8                           *NumberOfChildren,
 222   IN OUT EFI_HANDLE                      *ChildHandleBuffer
 223   )
 224 /**
 225
 226 Routine Description:
 227
 228   TODO: Add function description
 229
 230 Arguments:
 231
 232   Controller          - TODO: add argument description
 233   RootBridge          - TODO: add argument description
 234   RemainingDevicePath - TODO: add argument description
 235   NumberOfChildren    - TODO: add argument description
 236   ChildHandleBuffer   - TODO: add argument description
 237
 238 Returns:
 239
 240   TODO: add return values
 241
 242 **/
 243 ;
 244
 245 EFI_STATUS
 246 StartPciDevices (
 247   IN EFI_HANDLE                         Controller
 248   )
 249 /**
 250
 251 Routine Description:
 252
 253   TODO: Add function description
 254
 255 Arguments:
 256
 257   Controller          - TODO: add argument description
 258
 259 Returns:
 260
 261   TODO: add return values
 262
 263 **/
 264 ;
 265
 266 PCI_IO_DEVICE *
 267 CreateRootBridge (
 268   IN EFI_HANDLE RootBridgeHandle
 269   )
 270 /**
 271
 272 Routine Description:
 273
 274   TODO: Add function description
 275
 276 Arguments:
 277
 278   RootBridgeHandle  - TODO: add argument description
 279
 280 Returns:
 281
 282   TODO: add return values
 283
 284 **/
 285 ;
 286
 287 PCI_IO_DEVICE *
 288 GetRootBridgeByHandle (
 289   EFI_HANDLE RootBridgeHandle
 290   )
 291 /**
 292
 293 Routine Description:
 294
 295   TODO: Add function description
 296
 297 Arguments:
 298
 299   RootBridgeHandle  - TODO: add argument description
 300
 301 Returns:
 302
 303   TODO: add return values
 304
 305 **/
 306 ;
 307
 308 BOOLEAN
 309 RootBridgeExisted (
 310   IN EFI_HANDLE RootBridgeHandle
 311   )
 312 /**
 313
 314 Routine Description:
 315
 316   TODO: Add function description
 317
 318 Arguments:
 319
 320   RootBridgeHandle  - TODO: add argument description
 321
 322 Returns:
 323
 324   TODO: add return values
 325
 326 **/
 327 ;
 328
 329 BOOLEAN
 330 PciDeviceExisted (
 331   IN PCI_IO_DEVICE    *Bridge,
 332   IN PCI_IO_DEVICE    *PciIoDevice
 333   )
 334 /**
 335
 336 Routine Description:
 337
 338   TODO: Add function description
 339
 340 Arguments:
 341
 342   Bridge      - TODO: add argument description
 343   PciIoDevice - TODO: add argument description
 344
 345 Returns:
 346
 347   TODO: add return values
 348
 349 **/
 350 ;
 351
 352 PCI_IO_DEVICE *
 353 ActiveVGADeviceOnTheSameSegment (
 354   IN PCI_IO_DEVICE        *VgaDevice
 355   )
 356 /**
 357
 358 Routine Description:
 359
 360   TODO: Add function description
 361
 362 Arguments:
 363
 364   VgaDevice - TODO: add argument description
 365
 366 Returns:
 367
 368   TODO: add return values
 369
 370 **/
 371 ;
 372
 373 PCI_IO_DEVICE *
 374 ActiveVGADeviceOnTheRootBridge (
 375   IN PCI_IO_DEVICE        *RootBridge
 376   )
 377 /**
 378
 379 Routine Description:
 380
 381   TODO: Add function description
 382
 383 Arguments:
 384
 385   RootBridge  - TODO: add argument description
 386
 387 Returns:
 388
 389   TODO: add return values
 390
 391 **/
 392 ;
 393
 394 EFI_STATUS
 395 GetHpcPciAddress (
 396   IN  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,
 397   IN  EFI_DEVICE_PATH_PROTOCOL         *HpcDevicePath,
 398   OUT UINT64                           *PciAddress
 399   )
 400 /**
 401
 402 Routine Description:
 403
 404   TODO: Add function description
 405
 406 Arguments:
 407
 408   PciRootBridgeIo - TODO: add argument description
 409   HpcDevicePath   - TODO: add argument description
 410   PciAddress      - TODO: add argument description
 411
 412 Returns:
 413
 414   TODO: add return values
 415
 416 **/
 417 ;
 418
 419 EFI_STATUS
 420 GetHpcPciAddressFromRootBridge (
 421   IN  PCI_IO_DEVICE                    *RootBridge,
 422   IN  EFI_DEVICE_PATH_PROTOCOL         *RemainingDevicePath,
 423   OUT UINT64                           *PciAddress
 424   )
 425 /**
 426
 427 Routine Description:
 428
 429   TODO: Add function description
 430
 431 Arguments:
 432
 433   RootBridge          - TODO: add argument description
 434   RemainingDevicePath - TODO: add argument description
 435   PciAddress          - TODO: add argument description
 436
 437 Returns:
 438
 439   TODO: add return values
 440
 441 **/
 442 ;
 443
 444 EFI_STATUS
 445 FreePciDevice (
 446   IN PCI_IO_DEVICE *PciIoDevice
 447   )
 448 /**
 449
 450 Routine Description:
 451
 452   TODO: Add function description
 453
 454 Arguments:
 455
 456   PciIoDevice - TODO: add argument description
 457
 458 Returns:
 459
 460   TODO: add return values
 461
 462 **/
 463 ;
 464
 465 #endif