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   IN EFI_DEVICE_PATH_PROTOCOL           *RemainingDevicePath
 249   )
 250 /*++
 251
 252 Routine Description:
 253
 254   TODO: Add function description
 255
 256 Arguments:
 257
 258   Controller          - TODO: add argument description
 259   RemainingDevicePath - TODO: add argument description
 260
 261 Returns:
 262
 263   TODO: add return values
 264
 265 --*/
 266 ;
 267
 268 PCI_IO_DEVICE *
 269 CreateRootBridge (
 270   IN EFI_HANDLE RootBridgeHandle
 271   )
 272 /*++
 273
 274 Routine Description:
 275
 276   TODO: Add function description
 277
 278 Arguments:
 279
 280   RootBridgeHandle  - TODO: add argument description
 281
 282 Returns:
 283
 284   TODO: add return values
 285
 286 --*/
 287 ;
 288
 289 PCI_IO_DEVICE *
 290 GetRootBridgeByHandle (
 291   EFI_HANDLE RootBridgeHandle
 292   )
 293 /*++
 294
 295 Routine Description:
 296
 297   TODO: Add function description
 298
 299 Arguments:
 300
 301   RootBridgeHandle  - TODO: add argument description
 302
 303 Returns:
 304
 305   TODO: add return values
 306
 307 --*/
 308 ;
 309
 310 BOOLEAN
 311 RootBridgeExisted (
 312   IN EFI_HANDLE RootBridgeHandle
 313   )
 314 /*++
 315
 316 Routine Description:
 317
 318   TODO: Add function description
 319
 320 Arguments:
 321
 322   RootBridgeHandle  - TODO: add argument description
 323
 324 Returns:
 325
 326   TODO: add return values
 327
 328 --*/
 329 ;
 330
 331 BOOLEAN
 332 PciDeviceExisted (
 333   IN PCI_IO_DEVICE    *Bridge,
 334   IN PCI_IO_DEVICE    *PciIoDevice
 335   )
 336 /*++
 337
 338 Routine Description:
 339
 340   TODO: Add function description
 341
 342 Arguments:
 343
 344   Bridge      - TODO: add argument description
 345   PciIoDevice - TODO: add argument description
 346
 347 Returns:
 348
 349   TODO: add return values
 350
 351 --*/
 352 ;
 353
 354 PCI_IO_DEVICE *
 355 ActiveVGADeviceOnTheSameSegment (
 356   IN PCI_IO_DEVICE        *VgaDevice
 357   )
 358 /*++
 359
 360 Routine Description:
 361
 362   TODO: Add function description
 363
 364 Arguments:
 365
 366   VgaDevice - TODO: add argument description
 367
 368 Returns:
 369
 370   TODO: add return values
 371
 372 --*/
 373 ;
 374
 375 PCI_IO_DEVICE *
 376 ActiveVGADeviceOnTheRootBridge (
 377   IN PCI_IO_DEVICE        *RootBridge
 378   )
 379 /*++
 380
 381 Routine Description:
 382
 383   TODO: Add function description
 384
 385 Arguments:
 386
 387   RootBridge  - TODO: add argument description
 388
 389 Returns:
 390
 391   TODO: add return values
 392
 393 --*/
 394 ;
 395
 396 EFI_STATUS
 397 GetHpcPciAddress (
 398   IN  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,
 399   IN  EFI_DEVICE_PATH_PROTOCOL         *HpcDevicePath,
 400   OUT UINT64                           *PciAddress
 401   )
 402 /*++
 403
 404 Routine Description:
 405
 406   TODO: Add function description
 407
 408 Arguments:
 409
 410   PciRootBridgeIo - TODO: add argument description
 411   HpcDevicePath   - TODO: add argument description
 412   PciAddress      - TODO: add argument description
 413
 414 Returns:
 415
 416   TODO: add return values
 417
 418 --*/
 419 ;
 420
 421 EFI_STATUS
 422 GetHpcPciAddressFromRootBridge (
 423   IN  PCI_IO_DEVICE                    *RootBridge,
 424   IN  EFI_DEVICE_PATH_PROTOCOL         *RemainingDevicePath,
 425   OUT UINT64                           *PciAddress
 426   )
 427 /*++
 428
 429 Routine Description:
 430
 431   TODO: Add function description
 432
 433 Arguments:
 434
 435   RootBridge          - TODO: add argument description
 436   RemainingDevicePath - TODO: add argument description
 437   PciAddress          - TODO: add argument description
 438
 439 Returns:
 440
 441   TODO: add return values
 442
 443 --*/
 444 ;
 445
 446 EFI_STATUS
 447 FreePciDevice (
 448   IN PCI_IO_DEVICE *PciIoDevice
 449   )
 450 /*++
 451
 452 Routine Description:
 453
 454   TODO: Add function description
 455
 456 Arguments:
 457
 458   PciIoDevice - TODO: add argument description
 459
 460 Returns:
 461
 462   TODO: add return values
 463
 464 --*/
 465 ;
 466
 467 #endif