MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h

   1 /*++
   2
   3 Copyright (c) 2004 - 2007, 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 Module Name:
  13
  14   IScsiDriver.h
  15
  16 Abstract:
  17
  18 --*/
  19
  20 #ifndef _ISCSI_DRIVER_H_
  21 #define _ISCSI_DRIVER_H_
  22
  23 #include <PiDxe.h>
  24 #include <Protocol/DevicePath.h>
  25 #include <Protocol/LoadedImage.h>
  26 #include <Library/UefiDriverEntryPoint.h>
  27 #include <Library/UefiBootServicesTableLib.h>
  28 #include <Library/UefiLib.h>
  29 #include <Library/DevicePathLib.h>
  30 #include <protocol/DriverBinding.h>
  31 #include <protocol/ScsiPassThruExt.h>
  32 #include <protocol/IScsiInitiatorName.h>
  33 #include <protocol/Ip4Config.h>
  34 #include <protocol/ComponentName.h>
  35 #include <protocol/ComponentName2.h>
  36
  37 #define ISCSI_PRIVATE_GUID \
  38   { \
  39     0xfa3cde4c, 0x87c2, 0x427d, 0xae, 0xde, 0x7d, 0xd0, 0x96, 0xc8, 0x8c, 0x58 \
  40   }
  41
  42 #define ISCSI_INITIATOR_NAME_VAR_NAME L"I_NAME"
  43
  44 extern EFI_COMPONENT_NAME2_PROTOCOL       gIScsiComponentName2;
  45 extern EFI_COMPONENT_NAME_PROTOCOL        gIScsiComponentName;
  46
  47 extern EFI_ISCSI_INITIATOR_NAME_PROTOCOL  gIScsiInitiatorName;
  48
  49 extern EFI_GUID                           mIScsiPrivateGuid;
  50
  51 typedef struct _ISCSI_PRIVATE_PROTOCOL {
  52   UINT32  Reserved;
  53 } ISCSI_PRIVATE_PROTOCOL;
  54
  55 //
  56 // EFI Driver Binding Protocol for iSCSI driver.
  57 //
  58 EFI_STATUS
  59 EFIAPI
  60 IScsiDriverBindingSupported (
  61   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  62   IN EFI_HANDLE                   ControllerHandle,
  63   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  64   );
  65
  66 EFI_STATUS
  67 EFIAPI
  68 IScsiDriverBindingStart (
  69   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  70   IN EFI_HANDLE                   ControllerHandle,
  71   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  72   );
  73
  74 EFI_STATUS
  75 EFIAPI
  76 IScsiDriverBindingStop (
  77   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  78   IN EFI_HANDLE                   ControllerHandle,
  79   IN UINTN                        NumberOfChildren,
  80   IN EFI_HANDLE                   *ChildHandleBuffer
  81   );
  82
  83 //
  84 // EFI Component Name Protocol for iSCSI driver.
  85 //
  86 EFI_STATUS
  87 EFIAPI
  88 IScsiComponentNameGetDriverName (
  89   IN  EFI_COMPONENT_NAME_PROTOCOL   *This,
  90   IN  CHAR8                         *Language,
  91   OUT CHAR16                        **DriverName
  92   );
  93
  94 EFI_STATUS
  95 EFIAPI
  96 IScsiComponentNameGetControllerName (
  97   IN  EFI_COMPONENT_NAME_PROTOCOL   *This,
  98   IN  EFI_HANDLE                    ControllerHandle,
  99   IN  EFI_HANDLE                    ChildHandle        OPTIONAL,
 100   IN  CHAR8                         *Language,
 101   OUT CHAR16                        **ControllerName
 102   );
 103
 104 //
 105 // EFI iSCSI Initiator Name Protocol for iSCSI driver.
 106 //
 107 EFI_STATUS
 108 EFIAPI
 109 IScsiGetInitiatorName (
 110   IN     EFI_ISCSI_INITIATOR_NAME_PROTOCOL  *This,
 111   IN OUT UINTN                              *BufferSize,
 112   OUT    VOID                               *Buffer
 113   );
 114
 115 EFI_STATUS
 116 EFIAPI
 117 IScsiSetInitiatorName (
 118   IN     EFI_ISCSI_INITIATOR_NAME_PROTOCOL  *This,
 119   IN OUT UINTN                              *BufferSize,
 120   OUT    VOID                               *Buffer
 121   );
 122
 123 #endif