MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbBotPei / BotPeim.h

/** @file\r
BOT Transportation implementation.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _PEI_BOT_PEIM_H_\r
#define _PEI_BOT_PEIM_H_\r
\r
\r
#include <PiPei.h>\r
\r
#include <Ppi/UsbIo.h>\r
#include <Ppi/UsbHostController.h>\r
#include <Ppi/BlockIo.h>\r
\r
//#include <Library/DebugLib.h>\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/BaseMemoryLib.h>\r
\r
#include <IndustryStandard/Atapi.h>\r
\r
#pragma pack(1)\r
//\r
// Bulk Only device protocol\r
//\r
typedef struct {\r
  UINT32  Signature;\r
  UINT32  Tag;\r
  UINT32  DataTransferLength;\r
  UINT8   Flags;\r
  UINT8   Lun;\r
  UINT8   CmdLen;\r
  UINT8   CmdBlock[16];\r
} CBW;\r
\r
typedef struct {\r
  UINT32  Signature;\r
  UINT32  Tag;\r
  UINT32  DataResidue;\r
  UINT8   Status;\r
} CSW;\r
\r
#pragma pack()\r
//\r
// Status code, see Usb Bot device spec\r
//\r
#define CSWSIG  0x53425355\r
#define CBWSIG  0x43425355\r
\r
/**\r
  Sends out ATAPI Inquiry Packet Command to the specified device. This command will\r
  return INQUIRY data of the device.\r
\r
  @param PeiServices    The pointer of EFI_PEI_SERVICES.\r
  @param PeiBotDevice   The pointer to PEI_BOT_DEVICE instance.\r
\r
  @retval EFI_SUCCESS       Inquiry command completes successfully.\r
  @retval EFI_DEVICE_ERROR  Inquiry command failed.\r
\r
**/\r
EFI_STATUS\r
PeiUsbInquiry (\r
  IN  EFI_PEI_SERVICES  **PeiServices,\r
  IN  PEI_BOT_DEVICE    *PeiBotDevice\r
  );\r
\r
/**\r
  Sends out ATAPI Test Unit Ready Packet Command to the specified device\r
  to find out whether device is accessible.\r
\r
  @param PeiServices    The pointer of EFI_PEI_SERVICES.\r
  @param PeiBotDevice   The pointer to PEI_BOT_DEVICE instance.\r
\r
  @retval EFI_SUCCESS        TestUnit command executed successfully.\r
  @retval EFI_DEVICE_ERROR   Device cannot be executed TestUnit command successfully.\r
\r
**/\r
EFI_STATUS\r
PeiUsbTestUnitReady (\r
  IN  EFI_PEI_SERVICES  **PeiServices,\r
  IN  PEI_BOT_DEVICE    *PeiBotDevice\r
  );\r
\r
/**\r
  Sends out ATAPI Request Sense Packet Command to the specified device.\r
\r
  @param PeiServices    The pointer of EFI_PEI_SERVICES.\r
  @param PeiBotDevice   The pointer to PEI_BOT_DEVICE instance.\r
  @param SenseCounts    Length of sense buffer.\r
  @param SenseKeyBuffer Pointer to sense buffer.\r
\r
  @retval EFI_SUCCESS           Command executed successfully.\r
  @retval EFI_DEVICE_ERROR      Some device errors happen.\r
\r
**/\r
EFI_STATUS\r
PeiUsbRequestSense (\r
  IN  EFI_PEI_SERVICES  **PeiServices,\r
  IN  PEI_BOT_DEVICE    *PeiBotDevice,\r
  OUT UINTN             *SenseCounts,\r
  IN  UINT8             *SenseKeyBuffer\r
  );\r
\r
/**\r
  Sends out ATAPI Read Capacity Packet Command to the specified device.\r
  This command will return the information regarding the capacity of the\r
  media in the device.\r
\r
  @param PeiServices    The pointer of EFI_PEI_SERVICES.\r
  @param PeiBotDevice   The pointer to PEI_BOT_DEVICE instance.\r
\r
  @retval EFI_SUCCESS           Command executed successfully.\r
  @retval EFI_DEVICE_ERROR      Some device errors happen.\r
\r
**/\r
EFI_STATUS\r
PeiUsbReadCapacity (\r
  IN  EFI_PEI_SERVICES  **PeiServices,\r
  IN  PEI_BOT_DEVICE    *PeiBotDevice\r
  );\r
\r
/**\r
  Sends out ATAPI Read Format Capacity Data Command to the specified device.\r
  This command will return the information regarding the capacity of the\r
  media in the device.\r
\r
  @param PeiServices    The pointer of EFI_PEI_SERVICES.\r
  @param PeiBotDevice   The pointer to PEI_BOT_DEVICE instance.\r
\r
  @retval EFI_SUCCESS           Command executed successfully.\r
  @retval EFI_DEVICE_ERROR      Some device errors happen.\r
\r
**/\r
EFI_STATUS\r
PeiUsbReadFormattedCapacity (\r
  IN  EFI_PEI_SERVICES  **PeiServices,\r
  IN  PEI_BOT_DEVICE    *PeiBotDevice\r
  );\r
\r
/**\r
  Execute Read(10) ATAPI command on a specific SCSI target.\r
\r
  Executes the ATAPI Read(10) command on the ATAPI target specified by PeiBotDevice.\r
\r
  @param PeiServices       The pointer of EFI_PEI_SERVICES.\r
  @param PeiBotDevice      The pointer to PEI_BOT_DEVICE instance.\r
  @param Buffer            The pointer to data buffer.\r
  @param Lba               The start logic block address of reading.\r
  @param NumberOfBlocks    The block number of reading.\r
\r
  @retval EFI_SUCCESS           Command executed successfully.\r
  @retval EFI_DEVICE_ERROR      Some device errors happen.\r
\r
**/\r
EFI_STATUS\r
PeiUsbRead10 (\r
  IN  EFI_PEI_SERVICES  **PeiServices,\r
  IN  PEI_BOT_DEVICE    *PeiBotDevice,\r
  IN  VOID              *Buffer,\r
  IN  EFI_PEI_LBA       Lba,\r
  IN  UINTN             NumberOfBlocks\r
  );\r
\r
/**\r
  Check if there is media according to sense data.\r
\r
  @param  SenseData   Pointer to sense data.\r
  @param  SenseCounts Count of sense data.\r
\r
  @retval TRUE    No media\r
  @retval FALSE   Media exists\r
\r
**/\r
BOOLEAN\r
IsNoMedia (\r
  IN  ATAPI_REQUEST_SENSE_DATA    *SenseData,\r
  IN  UINTN                 SenseCounts\r
  );\r
\r
/**\r
  Check if there is media error according to sense data.\r
\r
  @param  SenseData   Pointer to sense data.\r
  @param  SenseCounts Count of sense data.\r
\r
  @retval TRUE    Media error\r
  @retval FALSE   No media error\r
\r
**/\r
BOOLEAN\r
IsMediaError (\r
  IN  ATAPI_REQUEST_SENSE_DATA    *SenseData,\r
  IN  UINTN                 SenseCounts\r
  );\r
\r
/**\r
  Check if media is changed according to sense data.\r
\r
  @param  SenseData   Pointer to sense data.\r
  @param  SenseCounts Count of sense data.\r
\r
  @retval TRUE    There is media change event.\r
  @retval FALSE   media is NOT changed.\r
\r
**/\r
BOOLEAN\r
IsMediaChange (\r
  IN  ATAPI_REQUEST_SENSE_DATA    *SenseData,\r
  IN  UINTN                 SenseCounts\r
  );\r
\r
#endif\r