EdkModulePkg/Universal/Disk/DiskIo/Dxe/DiskIo.h

   1 /*++
   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 Module Name:
  13
  14   DiskIo.h
  15
  16 Abstract:
  17   Private Data definition for Disk IO driver
  18
  19 --*/
  20
  21 #ifndef _DISK_IO_H
  22 #define _DISK_IO_H
  23
  24
  25
  26 #define DISK_IO_PRIVATE_DATA_SIGNATURE  EFI_SIGNATURE_32 ('d', 's', 'k', 'I')
  27
  28 #define DATA_BUFFER_BLOCK_NUM           (64)
  29
  30 typedef struct {
  31   UINTN                 Signature;
  32   EFI_DISK_IO_PROTOCOL  DiskIo;
  33   EFI_BLOCK_IO_PROTOCOL *BlockIo;
  34 } DISK_IO_PRIVATE_DATA;
  35
  36 #define DISK_IO_PRIVATE_DATA_FROM_THIS(a) CR (a, DISK_IO_PRIVATE_DATA, DiskIo, DISK_IO_PRIVATE_DATA_SIGNATURE)
  37
  38 //
  39 // Global Variables
  40 //
  41 extern EFI_DRIVER_BINDING_PROTOCOL  gDiskIoDriverBinding;
  42 extern EFI_COMPONENT_NAME_PROTOCOL  gDiskIoComponentName;
  43
  44 //
  45 // Prototypes
  46 // Driver model protocol interface
  47 //
  48 EFI_STATUS
  49 EFIAPI
  50 DiskIoDriverBindingSupported (
  51   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
  52   IN EFI_HANDLE                     ControllerHandle,
  53   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
  54   );
  55
  56 EFI_STATUS
  57 EFIAPI
  58 DiskIoDriverBindingStart (
  59   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
  60   IN EFI_HANDLE                     ControllerHandle,
  61   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
  62   );
  63
  64 EFI_STATUS
  65 EFIAPI
  66 DiskIoDriverBindingStop (
  67   IN  EFI_DRIVER_BINDING_PROTOCOL    *This,
  68   IN  EFI_HANDLE                     ControllerHandle,
  69   IN  UINTN                          NumberOfChildren,
  70   IN  EFI_HANDLE                     *ChildHandleBuffer
  71   );
  72
  73 //
  74 // Disk I/O Protocol Interface
  75 //
  76 EFI_STATUS
  77 EFIAPI
  78 DiskIoReadDisk (
  79   IN EFI_DISK_IO_PROTOCOL  *This,
  80   IN UINT32                MediaId,
  81   IN UINT64                Offset,
  82   IN UINTN                 BufferSize,
  83   OUT VOID                 *Buffer
  84   );
  85
  86 EFI_STATUS
  87 EFIAPI
  88 DiskIoWriteDisk (
  89   IN EFI_DISK_IO_PROTOCOL  *This,
  90   IN UINT32                MediaId,
  91   IN UINT64                Offset,
  92   IN UINTN                 BufferSize,
  93   IN VOID                  *Buffer
  94   );
  95
  96 //
  97 // EFI Component Name Functions
  98 //
  99 EFI_STATUS
 100 EFIAPI
 101 DiskIoComponentNameGetDriverName (
 102   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 103   IN  CHAR8                        *Language,
 104   OUT CHAR16                       **DriverName
 105   );
 106
 107 EFI_STATUS
 108 EFIAPI
 109 DiskIoComponentNameGetControllerName (
 110   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
 111   IN  EFI_HANDLE                                      ControllerHandle,
 112   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
 113   IN  CHAR8                                           *Language,
 114   OUT CHAR16                                          **ControllerName
 115   );
 116
 117 #endif