/** @file
 DXE Chipset Services Library.

 This file contains only one function that is DxeCsSvcInstallPciRomSwitchTextMode().
 The function DxeCsSvcInstallPciRomSwitchTextMode() use chipset services to determine
 should to switch to text mode.
  
;***************************************************************************
;* Copyright (c) 2014, Insyde Software Corp. All Rights Reserved.
;*
;* You may not reproduce, distribute, publish, display, perform, modify, adapt,
;* transmit, broadcast, present, recite, release, license or otherwise exploit
;* any part of this publication in any form, by any means, without the prior
;* written permission of Insyde Software Corporation.
;*
;******************************************************************************
*/

#include <Library/DebugLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Protocol/PciIo.h>
#include <Protocol/SetupUtility.h>
#include <IndustryStandard/Pci30.h>
#include <ChipsetSetupConfig.h>
#include <Register/PchRegs.h>
#include "Register/SataRegs.h"

#define V_CNL_PCH_H_SATA_CFG_DEVICE_ID_D_AHCI         0xA352  ///< SATA Controller (AHCI)
#define V_CNL_PCH_LP_SATA_CFG_DEVICE_ID_M_AHCI        0x9DD3  ///< SATA Controller (AHCI) - Mobile

/**
 Called by LegacyBiosPlatform when legacy bios is going to install option Rom.
 The chipset platform library can determine if it requires to switch to text
 mode while installing option rom for specific device.

 @param[in]         DeviceHandle        Handle of device OPROM is associated with.
 @param[in, out]    ForceSwitchTextMode Initial value contains the upper level's switch text
                                        mode policy. Set to TRUE if it requires to switch to
                                        text mode.

 @retval            EFI_SUCCESS           Function returns successfully
 @retval            EFI_INVALID_PARAMETER The parameters Address has an invalid value.
                                          1. DeviceHandle is NULL.
*/
EFI_STATUS
InstallPciRomSwitchTextMode (
  IN      EFI_HANDLE                    DeviceHandle,
  IN OUT  BOOLEAN                       *ForceSwitchTextMode
  )
{
  EFI_STATUS                            Status;
  EFI_PCI_IO_PROTOCOL                   *PciIo;
  PCI_TYPE00                            PciConfigHeader00;

  if (DeviceHandle == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  Status = gBS->HandleProtocol (DeviceHandle,
                                &gEfiPciIoProtocolGuid,
                                (VOID **)&PciIo);

  ASSERT_EFI_ERROR (Status);

  Status = PciIo->Pci.Read (PciIo,
                            EfiPciIoWidthUint32,
                            0,
                            sizeof (PciConfigHeader00) / sizeof (UINT32),
                            &PciConfigHeader00);
  ASSERT_EFI_ERROR (Status);

  //
  // For all devices, it requires to switch to text mode by default.
  //
  *ForceSwitchTextMode = TRUE;

  //
  // Check what device option ROM is going to installed
  //
  if ((PciConfigHeader00.Hdr.VendorId == V_PCH_INTEL_VENDOR_ID) 
    && ((PciConfigHeader00.Hdr.DeviceId == V_CNL_PCH_H_SATA_CFG_DEVICE_ID_D_AHCI)
    || (PciConfigHeader00.Hdr.DeviceId == V_CNL_PCH_LP_SATA_CFG_DEVICE_ID_M_AHCI))) {
    //
    // If AHCI option ROM is dispatching, don't switch to text mode
    //
    *ForceSwitchTextMode = FALSE;
  }
  
  return EFI_SUCCESS;
}