SataController.h

Go to the documentation of this file.

 
#ifndef _SATA_CONTROLLER_H_
#define _SATA_CONTROLLER_H_
 
#include <Uefi.h>
 
#include <IndustryStandard/Pci.h>
 
#include <Protocol/ComponentName.h>
#include <Protocol/DriverBinding.h>
#include <Protocol/PciIo.h>
#include <Protocol/IdeControllerInit.h>
#include <Protocol/DevicePath.h>
 
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
 
//
// Global Variables definitions
//
extern EFI_DRIVER_BINDING_PROTOCOL   gSataControllerDriverBinding;
extern EFI_COMPONENT_NAME_PROTOCOL   gSataControllerComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gSataControllerComponentName2;
 
#define AHCI_BAR_INDEX    0x05
#define R_AHCI_CAP        0x0
#define   B_AHCI_CAP_NPS  (BIT4 | BIT3 | BIT2 | BIT1 | BIT0) // Number of Ports
#define   B_AHCI_CAP_SPM  BIT17                              // Supports Port Multiplier
#define R_AHCI_PI         0xC
 
#define AHCI_MAX_DEVICES  0x01
 
#define AHCI_MULTI_MAX_DEVICES  0x0F
 
#define IDE_MAX_CHANNEL  0x02
 
#define IDE_MAX_DEVICES  0x02
 
#define SATA_ENUMER_ALL  FALSE
 
//
// Sata Controller driver private data structure
//
#define SATA_CONTROLLER_SIGNATURE  SIGNATURE_32('S','A','T','A')
 
typedef struct _EFI_SATA_CONTROLLER_PRIVATE_DATA {
  //
  // Standard signature used to identify Sata Controller private data
  //
  UINT32                              Signature;
 
  //
  // Protocol instance of IDE_CONTROLLER_INIT produced by this driver
  //
  EFI_IDE_CONTROLLER_INIT_PROTOCOL    IdeInit;
 
  //
  // Copy of protocol pointers used by this driver
  //
  EFI_PCI_IO_PROTOCOL                 *PciIo;
 
  //
  // The number of devices that are supported by this channel
  //
  UINT8                               DeviceCount;
 
  //
  // The highest disqulified mode for each attached device,
  // From ATA/ATAPI spec, if a mode is not supported,
  // the modes higher than it is also not supported
  //
  EFI_ATA_COLLECTIVE_MODE             *DisqualifiedModes;
 
  //
  // A copy of EFI_IDENTIFY_DATA data for each attached SATA device and its flag
  //
  EFI_IDENTIFY_DATA                   *IdentifyData;
  BOOLEAN                             *IdentifyValid;
 
  //
  // Track the state so that the PCI attributes that were modified
  // can be restored to the original value later.
  //
  BOOLEAN                             PciAttributesChanged;
 
  //
  // Copy of the original PCI Attributes
  //
  UINT64                              OriginalPciAttributes;
} EFI_SATA_CONTROLLER_PRIVATE_DATA;
 
#define SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS(a)  CR(a, EFI_SATA_CONTROLLER_PRIVATE_DATA, IdeInit, SATA_CONTROLLER_SIGNATURE)
 
//
// Driver binding functions declaration
//
 
EFI_STATUS
EFIAPI
SataControllerSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
SataControllerStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
SataControllerStop (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN UINTN                        NumberOfChildren,
  IN EFI_HANDLE                   *ChildHandleBuffer
  );
 
//
// IDE controller init functions declaration
//
 
EFI_STATUS
EFIAPI
IdeInitGetChannelInfo (
  IN EFI_IDE_CONTROLLER_INIT_PROTOCOL  *This,
  IN UINT8                             Channel,
  OUT BOOLEAN                          *Enabled,
  OUT UINT8                            *MaxDevices
  );
 
EFI_STATUS
EFIAPI
IdeInitNotifyPhase (
  IN EFI_IDE_CONTROLLER_INIT_PROTOCOL  *This,
  IN EFI_IDE_CONTROLLER_ENUM_PHASE     Phase,
  IN UINT8                             Channel
  );
 
EFI_STATUS
EFIAPI
IdeInitSubmitData (
  IN EFI_IDE_CONTROLLER_INIT_PROTOCOL  *This,
  IN UINT8                             Channel,
  IN UINT8                             Device,
  IN EFI_IDENTIFY_DATA                 *IdentifyData
  );
 
EFI_STATUS
EFIAPI
IdeInitDisqualifyMode (
  IN EFI_IDE_CONTROLLER_INIT_PROTOCOL  *This,
  IN UINT8                             Channel,
  IN UINT8                             Device,
  IN EFI_ATA_COLLECTIVE_MODE           *BadModes
  );
 
EFI_STATUS
EFIAPI
IdeInitCalculateMode (
  IN EFI_IDE_CONTROLLER_INIT_PROTOCOL  *This,
  IN UINT8                             Channel,
  IN UINT8                             Device,
  OUT EFI_ATA_COLLECTIVE_MODE          **SupportedModes
  );
 
EFI_STATUS
EFIAPI
IdeInitSetTiming (
  IN EFI_IDE_CONTROLLER_INIT_PROTOCOL  *This,
  IN UINT8                             Channel,
  IN UINT8                             Device,
  IN EFI_ATA_COLLECTIVE_MODE           *Modes
  );
 
//
// Forward reference declaration
//
 
EFI_STATUS
EFIAPI
SataControllerComponentNameGetDriverName (
  IN EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN CHAR8                        *Language,
  OUT CHAR16                      **DriverName
  );
 
EFI_STATUS
EFIAPI
SataControllerComponentNameGetControllerName (
  IN EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN EFI_HANDLE                   ChildHandle OPTIONAL,
  IN CHAR8                        *Language,
  OUT CHAR16                      **ControllerName
  );
 
#endif