MdeModulePkg: Apply uncrustify changes

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / UhciDxe / UhciQueue.c

/** @file\r
\r
  The UHCI register operation routines.\r
\r
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "Uhci.h"\r
\r
/**\r
  Map address of request structure buffer.\r
\r
  @param  Uhc                The UHCI device.\r
  @param  Request            The user request buffer.\r
  @param  MappedAddr         Mapped address of request.\r
  @param  Map                Identificaion of this mapping to return.\r
\r
  @return EFI_SUCCESS        Success.\r
  @return EFI_DEVICE_ERROR   Fail to map the user request.\r
\r
**/\r
EFI_STATUS\r
UhciMapUserRequest (\r
  IN  USB_HC_DEV  *Uhc,\r
  IN  OUT VOID    *Request,\r
  OUT UINT8       **MappedAddr,\r
  OUT VOID        **Map\r
  )\r
{\r
  EFI_STATUS            Status;\r
  UINTN                 Len;\r
  EFI_PHYSICAL_ADDRESS  PhyAddr;\r
\r
  Len    = sizeof (EFI_USB_DEVICE_REQUEST);\r
  Status = Uhc->PciIo->Map (\r
                         Uhc->PciIo,\r
                         EfiPciIoOperationBusMasterRead,\r
                         Request,\r
                         &Len,\r
                         &PhyAddr,\r
                         Map\r
                         );\r
\r
  if (!EFI_ERROR (Status)) {\r
    *MappedAddr = (UINT8 *)(UINTN)PhyAddr;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Map address of user data buffer.\r
\r
  @param  Uhc                The UHCI device.\r
  @param  Direction          Direction of the data transfer.\r
  @param  Data               The user data buffer.\r
  @param  Len                Length of the user data.\r
  @param  PktId              Packet identificaion.\r
  @param  MappedAddr         Mapped address to return.\r
  @param  Map                Identificaion of this mapping to return.\r
\r
  @return EFI_SUCCESS        Success.\r
  @return EFI_DEVICE_ERROR   Fail to map the user data.\r
\r
**/\r
EFI_STATUS\r
UhciMapUserData (\r
  IN  USB_HC_DEV              *Uhc,\r
  IN  EFI_USB_DATA_DIRECTION  Direction,\r
  IN  VOID                    *Data,\r
  IN  OUT UINTN               *Len,\r
  OUT UINT8                   *PktId,\r
  OUT UINT8                   **MappedAddr,\r
  OUT VOID                    **Map\r
  )\r
{\r
  EFI_STATUS            Status;\r
  EFI_PHYSICAL_ADDRESS  PhyAddr;\r
\r
  Status = EFI_SUCCESS;\r
\r
  switch (Direction) {\r
    case EfiUsbDataIn:\r
      //\r
      // BusMasterWrite means cpu read\r
      //\r
      *PktId = INPUT_PACKET_ID;\r
      Status = Uhc->PciIo->Map (\r
                             Uhc->PciIo,\r
                             EfiPciIoOperationBusMasterWrite,\r
                             Data,\r
                             Len,\r
                             &PhyAddr,\r
                             Map\r
                             );\r
\r
      if (EFI_ERROR (Status)) {\r
        goto EXIT;\r
      }\r
\r
      *MappedAddr = (UINT8 *)(UINTN)PhyAddr;\r
      break;\r
\r
    case EfiUsbDataOut:\r
      *PktId = OUTPUT_PACKET_ID;\r
      Status = Uhc->PciIo->Map (\r
                             Uhc->PciIo,\r
                             EfiPciIoOperationBusMasterRead,\r
                             Data,\r
                             Len,\r
                             &PhyAddr,\r
                             Map\r
                             );\r
\r
      if (EFI_ERROR (Status)) {\r
        goto EXIT;\r
      }\r
\r
      *MappedAddr = (UINT8 *)(UINTN)PhyAddr;\r
      break;\r
\r
    case EfiUsbNoData:\r
      if ((Len != NULL) && (*Len != 0)) {\r
        Status = EFI_INVALID_PARAMETER;\r
        goto EXIT;\r
      }\r
\r
      *PktId      = OUTPUT_PACKET_ID;\r
      *MappedAddr = NULL;\r
      *Map        = NULL;\r
      break;\r
\r
    default:\r
      Status = EFI_INVALID_PARAMETER;\r
  }\r
\r
EXIT:\r
  return Status;\r
}\r
\r
/**\r
  Link the TD To QH.\r
\r
  @param  Uhc         The UHCI device.\r
  @param  Qh          The queue head for the TD to link to.\r
  @param  Td          The TD to link.\r
\r
**/\r
VOID\r
UhciLinkTdToQh (\r
  IN USB_HC_DEV  *Uhc,\r
  IN UHCI_QH_SW  *Qh,\r
  IN UHCI_TD_SW  *Td\r
  )\r
{\r
  EFI_PHYSICAL_ADDRESS  PhyAddr;\r
\r
  PhyAddr = UsbHcGetPciAddressForHostMem (Uhc->MemPool, Td, sizeof (UHCI_TD_HW));\r
\r
  ASSERT ((Qh != NULL) && (Td != NULL));\r
\r
  Qh->QhHw.VerticalLink = QH_VLINK (PhyAddr, FALSE);\r
  Qh->TDs               = (VOID *)Td;\r
}\r
\r
/**\r
  Unlink TD from the QH.\r
\r
  @param  Qh          The queue head to unlink from.\r
  @param  Td          The TD to unlink.\r
\r
**/\r
VOID\r
UhciUnlinkTdFromQh (\r
  IN UHCI_QH_SW  *Qh,\r
  IN UHCI_TD_SW  *Td\r
  )\r
{\r
  ASSERT ((Qh != NULL) && (Td != NULL));\r
\r
  Qh->QhHw.VerticalLink = QH_VLINK (NULL, TRUE);\r
  Qh->TDs               = NULL;\r
}\r
\r
/**\r
  Append a new TD To the previous TD.\r
\r
  @param  Uhc         The UHCI device.\r
  @param  PrevTd      Previous UHCI_TD_SW to be linked to.\r
  @param  ThisTd      TD to link.\r
\r
**/\r
VOID\r
UhciAppendTd (\r
  IN USB_HC_DEV  *Uhc,\r
  IN UHCI_TD_SW  *PrevTd,\r
  IN UHCI_TD_SW  *ThisTd\r
  )\r
{\r
  EFI_PHYSICAL_ADDRESS  PhyAddr;\r
\r
  PhyAddr = UsbHcGetPciAddressForHostMem (Uhc->MemPool, ThisTd, sizeof (UHCI_TD_HW));\r
\r
  ASSERT ((PrevTd != NULL) && (ThisTd != NULL));\r
\r
  PrevTd->TdHw.NextLink = TD_LINK (PhyAddr, TRUE, FALSE);\r
  PrevTd->NextTd        = (VOID *)ThisTd;\r
}\r
\r
/**\r
  Delete a list of TDs.\r
\r
  @param  Uhc         The UHCI device.\r
  @param  FirstTd     TD link list head.\r
\r
  @return None.\r
\r
**/\r
VOID\r
UhciDestoryTds (\r
  IN USB_HC_DEV  *Uhc,\r
  IN UHCI_TD_SW  *FirstTd\r
  )\r
{\r
  UHCI_TD_SW  *NextTd;\r
  UHCI_TD_SW  *ThisTd;\r
\r
  NextTd = FirstTd;\r
\r
  while (NextTd != NULL) {\r
    ThisTd = NextTd;\r
    NextTd = ThisTd->NextTd;\r
    UsbHcFreeMem (Uhc->MemPool, ThisTd, sizeof (UHCI_TD_SW));\r
  }\r
}\r
\r
/**\r
  Create an initialize a new queue head.\r
\r
  @param  Uhc         The UHCI device.\r
  @param  Interval    The polling interval for the queue.\r
\r
  @return The newly created queue header.\r
\r
**/\r
UHCI_QH_SW *\r
UhciCreateQh (\r
  IN  USB_HC_DEV  *Uhc,\r
  IN  UINTN       Interval\r
  )\r
{\r
  UHCI_QH_SW  *Qh;\r
\r
  Qh = UsbHcAllocateMem (Uhc->MemPool, sizeof (UHCI_QH_SW));\r
\r
  if (Qh == NULL) {\r
    return NULL;\r
  }\r
\r
  Qh->QhHw.HorizonLink  = QH_HLINK (NULL, TRUE);\r
  Qh->QhHw.VerticalLink = QH_VLINK (NULL, TRUE);\r
  Qh->Interval          = UhciConvertPollRate (Interval);\r
  Qh->TDs               = NULL;\r
  Qh->NextQh            = NULL;\r
\r
  return Qh;\r
}\r
\r
/**\r
  Create and intialize a TD.\r
\r
  @param  Uhc         The UHCI device.\r
\r
  @return The newly allocated and initialized TD.\r
\r
**/\r
UHCI_TD_SW *\r
UhciCreateTd (\r
  IN  USB_HC_DEV  *Uhc\r
  )\r
{\r
  UHCI_TD_SW  *Td;\r
\r
  Td = UsbHcAllocateMem (Uhc->MemPool, sizeof (UHCI_TD_SW));\r
  if (Td == NULL) {\r
    return NULL;\r
  }\r
\r
  Td->TdHw.NextLink = TD_LINK (NULL, FALSE, TRUE);\r
  Td->NextTd        = NULL;\r
  Td->Data          = NULL;\r
  Td->DataLen       = 0;\r
\r
  return Td;\r
}\r
\r
/**\r
  Create and initialize a TD for Setup Stage of a control transfer.\r
\r
  @param  Uhc         The UHCI device.\r
  @param  DevAddr     Device address.\r
  @param  Request     A pointer to cpu memory address of Device request.\r
  @param  RequestPhy  A pointer to pci memory address of Device request.\r
  @param  IsLow       Full speed or low speed.\r
\r
  @return The created setup Td Pointer.\r
\r
**/\r
UHCI_TD_SW *\r
UhciCreateSetupTd (\r
  IN  USB_HC_DEV  *Uhc,\r
  IN  UINT8       DevAddr,\r
  IN  UINT8       *Request,\r
  IN  UINT8       *RequestPhy,\r
  IN  BOOLEAN     IsLow\r
  )\r
{\r
  UHCI_TD_SW  *Td;\r
\r
  Td = UhciCreateTd (Uhc);\r
\r
  if (Td == NULL) {\r
    return NULL;\r
  }\r
\r
  Td->TdHw.NextLink     = TD_LINK (NULL, TRUE, TRUE);\r
  Td->TdHw.ShortPacket  = FALSE;\r
  Td->TdHw.IsIsoch      = FALSE;\r
  Td->TdHw.IntOnCpl     = FALSE;\r
  Td->TdHw.ErrorCount   = 0x03;\r
  Td->TdHw.Status      |= USBTD_ACTIVE;\r
  Td->TdHw.DataToggle   = 0;\r
  Td->TdHw.EndPoint     = 0;\r
  Td->TdHw.LowSpeed     = IsLow ? 1 : 0;\r
  Td->TdHw.DeviceAddr   = DevAddr & 0x7F;\r
  Td->TdHw.MaxPacketLen = (UINT32)(sizeof (EFI_USB_DEVICE_REQUEST) - 1);\r
  Td->TdHw.PidCode      = SETUP_PACKET_ID;\r
  Td->TdHw.DataBuffer   = (UINT32)(UINTN)RequestPhy;\r
\r
  Td->Data    = Request;\r
  Td->DataLen = (UINT16)sizeof (EFI_USB_DEVICE_REQUEST);\r
\r
  return Td;\r
}\r
\r
/**\r
  Create a TD for data.\r
\r
  @param  Uhc         The UHCI device.\r
  @param  DevAddr     Device address.\r
  @param  Endpoint    Endpoint number.\r
  @param  DataPtr     A pointer to cpu memory address of Data buffer.\r
  @param  DataPhyPtr  A pointer to pci memory address of Data buffer.\r
  @param  Len         Data length.\r
  @param  PktId       Packet ID.\r
  @param  Toggle      Data toggle value.\r
  @param  IsLow       Full speed or low speed.\r
\r
  @return Data Td pointer if success, otherwise NULL.\r
\r
**/\r
UHCI_TD_SW *\r
UhciCreateDataTd (\r
  IN  USB_HC_DEV  *Uhc,\r
  IN  UINT8       DevAddr,\r
  IN  UINT8       Endpoint,\r
  IN  UINT8       *DataPtr,\r
  IN  UINT8       *DataPhyPtr,\r
  IN  UINTN       Len,\r
  IN  UINT8       PktId,\r
  IN  UINT8       Toggle,\r
  IN  BOOLEAN     IsLow\r
  )\r
{\r
  UHCI_TD_SW  *Td;\r
\r
  //\r
  // Code as length - 1, and the max valid length is 0x500\r
  //\r
  ASSERT (Len <= 0x500);\r
\r
  Td = UhciCreateTd (Uhc);\r
\r
  if (Td == NULL) {\r
    return NULL;\r
  }\r
\r
  Td->TdHw.NextLink     = TD_LINK (NULL, TRUE, TRUE);\r
  Td->TdHw.ShortPacket  = FALSE;\r
  Td->TdHw.IsIsoch      = FALSE;\r
  Td->TdHw.IntOnCpl     = FALSE;\r
  Td->TdHw.ErrorCount   = 0x03;\r
  Td->TdHw.Status       = USBTD_ACTIVE;\r
  Td->TdHw.LowSpeed     = IsLow ? 1 : 0;\r
  Td->TdHw.DataToggle   = Toggle & 0x01;\r
  Td->TdHw.EndPoint     = Endpoint & 0x0F;\r
  Td->TdHw.DeviceAddr   = DevAddr & 0x7F;\r
  Td->TdHw.MaxPacketLen = (UINT32)(Len - 1);\r
  Td->TdHw.PidCode      = (UINT8)PktId;\r
  Td->TdHw.DataBuffer   = (UINT32)(UINTN)DataPhyPtr;\r
\r
  Td->Data    = DataPtr;\r
  Td->DataLen = (UINT16)Len;\r
\r
  return Td;\r
}\r
\r
/**\r
  Create TD for the Status Stage of control transfer.\r
\r
  @param  Uhc         The UHCI device.\r
  @param  DevAddr     Device address.\r
  @param  PktId       Packet ID.\r
  @param  IsLow       Full speed or low speed.\r
\r
  @return Status Td Pointer.\r
\r
**/\r
UHCI_TD_SW *\r
UhciCreateStatusTd (\r
  IN  USB_HC_DEV  *Uhc,\r
  IN  UINT8       DevAddr,\r
  IN  UINT8       PktId,\r
  IN  BOOLEAN     IsLow\r
  )\r
{\r
  UHCI_TD_SW  *Td;\r
\r
  Td = UhciCreateTd (Uhc);\r
\r
  if (Td == NULL) {\r
    return NULL;\r
  }\r
\r
  Td->TdHw.NextLink     = TD_LINK (NULL, TRUE, TRUE);\r
  Td->TdHw.ShortPacket  = FALSE;\r
  Td->TdHw.IsIsoch      = FALSE;\r
  Td->TdHw.IntOnCpl     = FALSE;\r
  Td->TdHw.ErrorCount   = 0x03;\r
  Td->TdHw.Status      |= USBTD_ACTIVE;\r
  Td->TdHw.MaxPacketLen = 0x7FF;      // 0x7FF: there is no data (refer to UHCI spec)\r
  Td->TdHw.DataToggle   = 1;\r
  Td->TdHw.EndPoint     = 0;\r
  Td->TdHw.LowSpeed     = IsLow ? 1 : 0;\r
  Td->TdHw.DeviceAddr   = DevAddr & 0x7F;\r
  Td->TdHw.PidCode      = (UINT8)PktId;\r
  Td->TdHw.DataBuffer   = (UINT32)(UINTN)NULL;\r
\r
  Td->Data    = NULL;\r
  Td->DataLen = 0;\r
\r
  return Td;\r
}\r
\r
/**\r
  Create Tds list for Control Transfer.\r
\r
  @param  Uhc         The UHCI device.\r
  @param  DeviceAddr  The device address.\r
  @param  DataPktId   Packet Identification of Data Tds.\r
  @param  Request     A pointer to cpu memory address of request structure buffer to transfer.\r
  @param  RequestPhy  A pointer to pci memory address of request structure buffer to transfer.\r
  @param  Data        A pointer to cpu memory address of user data buffer to transfer.\r
  @param  DataPhy     A pointer to pci memory address of user data buffer to transfer.\r
  @param  DataLen     Length of user data to transfer.\r
  @param  MaxPacket   Maximum packet size for control transfer.\r
  @param  IsLow       Full speed or low speed.\r
\r
  @return The Td list head for the control transfer.\r
\r
**/\r
UHCI_TD_SW *\r
UhciCreateCtrlTds (\r
  IN USB_HC_DEV  *Uhc,\r
  IN UINT8       DeviceAddr,\r
  IN UINT8       DataPktId,\r
  IN UINT8       *Request,\r
  IN UINT8       *RequestPhy,\r
  IN UINT8       *Data,\r
  IN UINT8       *DataPhy,\r
  IN UINTN       DataLen,\r
  IN UINT8       MaxPacket,\r
  IN BOOLEAN     IsLow\r
  )\r
{\r
  UHCI_TD_SW  *SetupTd;\r
  UHCI_TD_SW  *FirstDataTd;\r
  UHCI_TD_SW  *DataTd;\r
  UHCI_TD_SW  *PrevDataTd;\r
  UHCI_TD_SW  *StatusTd;\r
  UINT8       DataToggle;\r
  UINT8       StatusPktId;\r
  UINTN       ThisTdLen;\r
\r
  DataTd      = NULL;\r
  SetupTd     = NULL;\r
  FirstDataTd = NULL;\r
  PrevDataTd  = NULL;\r
  StatusTd    = NULL;\r
\r
  //\r
  // Create setup packets for the transfer\r
  //\r
  SetupTd = UhciCreateSetupTd (Uhc, DeviceAddr, Request, RequestPhy, IsLow);\r
\r
  if (SetupTd == NULL) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Create data packets for the transfer\r
  //\r
  DataToggle = 1;\r
\r
  while (DataLen > 0) {\r
    //\r
    // PktSize is the data load size in each Td.\r
    //\r
    ThisTdLen = (DataLen > MaxPacket ? MaxPacket : DataLen);\r
\r
    DataTd = UhciCreateDataTd (\r
               Uhc,\r
               DeviceAddr,\r
               0,\r
               Data,    // cpu memory address\r
               DataPhy, // Pci memory address\r
               ThisTdLen,\r
               DataPktId,\r
               DataToggle,\r
               IsLow\r
               );\r
\r
    if (DataTd == NULL) {\r
      goto FREE_TD;\r
    }\r
\r
    if (FirstDataTd == NULL) {\r
      FirstDataTd         = DataTd;\r
      FirstDataTd->NextTd = NULL;\r
    } else {\r
      UhciAppendTd (Uhc, PrevDataTd, DataTd);\r
    }\r
\r
    DataToggle ^= 1;\r
    PrevDataTd  = DataTd;\r
    Data       += ThisTdLen;\r
    DataPhy    += ThisTdLen;\r
    DataLen    -= ThisTdLen;\r
  }\r
\r
  //\r
  // Status packet is on the opposite direction to data packets\r
  //\r
  if (OUTPUT_PACKET_ID == DataPktId) {\r
    StatusPktId = INPUT_PACKET_ID;\r
  } else {\r
    StatusPktId = OUTPUT_PACKET_ID;\r
  }\r
\r
  StatusTd = UhciCreateStatusTd (Uhc, DeviceAddr, StatusPktId, IsLow);\r
\r
  if (StatusTd == NULL) {\r
    goto FREE_TD;\r
  }\r
\r
  //\r
  // Link setup Td -> data Tds -> status Td together\r
  //\r
  if (FirstDataTd != NULL) {\r
    UhciAppendTd (Uhc, SetupTd, FirstDataTd);\r
    UhciAppendTd (Uhc, PrevDataTd, StatusTd);\r
  } else {\r
    UhciAppendTd (Uhc, SetupTd, StatusTd);\r
  }\r
\r
  return SetupTd;\r
\r
FREE_TD:\r
  if (SetupTd != NULL) {\r
    UhciDestoryTds (Uhc, SetupTd);\r
  }\r
\r
  if (FirstDataTd != NULL) {\r
    UhciDestoryTds (Uhc, FirstDataTd);\r
  }\r
\r
  return NULL;\r
}\r
\r
/**\r
  Create Tds list for Bulk/Interrupt Transfer.\r
\r
  @param  Uhc         USB_HC_DEV.\r
  @param  DevAddr     Address of Device.\r
  @param  EndPoint    Endpoint Number.\r
  @param  PktId       Packet Identification of Data Tds.\r
  @param  Data        A pointer to cpu memory address of user data buffer to transfer.\r
  @param  DataPhy     A pointer to pci memory address of user data buffer to transfer.\r
  @param  DataLen     Length of user data to transfer.\r
  @param  DataToggle  Data Toggle Pointer.\r
  @param  MaxPacket   Maximum packet size for Bulk/Interrupt transfer.\r
  @param  IsLow       Is Low Speed Device.\r
\r
  @return The Tds list head for the bulk transfer.\r
\r
**/\r
UHCI_TD_SW *\r
UhciCreateBulkOrIntTds (\r
  IN USB_HC_DEV  *Uhc,\r
  IN UINT8       DevAddr,\r
  IN UINT8       EndPoint,\r
  IN UINT8       PktId,\r
  IN UINT8       *Data,\r
  IN UINT8       *DataPhy,\r
  IN UINTN       DataLen,\r
  IN OUT UINT8   *DataToggle,\r
  IN UINT8       MaxPacket,\r
  IN BOOLEAN     IsLow\r
  )\r
{\r
  UHCI_TD_SW  *DataTd;\r
  UHCI_TD_SW  *FirstDataTd;\r
  UHCI_TD_SW  *PrevDataTd;\r
  UINTN       ThisTdLen;\r
\r
  DataTd      = NULL;\r
  FirstDataTd = NULL;\r
  PrevDataTd  = NULL;\r
\r
  //\r
  // Create data packets for the transfer\r
  //\r
  while (DataLen > 0) {\r
    //\r
    // PktSize is the data load size that each Td.\r
    //\r
    ThisTdLen = DataLen;\r
\r
    if (DataLen > MaxPacket) {\r
      ThisTdLen = MaxPacket;\r
    }\r
\r
    DataTd = UhciCreateDataTd (\r
               Uhc,\r
               DevAddr,\r
               EndPoint,\r
               Data,\r
               DataPhy,\r
               ThisTdLen,\r
               PktId,\r
               *DataToggle,\r
               IsLow\r
               );\r
\r
    if (DataTd == NULL) {\r
      goto FREE_TD;\r
    }\r
\r
    if (PktId == INPUT_PACKET_ID) {\r
      DataTd->TdHw.ShortPacket = TRUE;\r
    }\r
\r
    if (FirstDataTd == NULL) {\r
      FirstDataTd         = DataTd;\r
      FirstDataTd->NextTd = NULL;\r
    } else {\r
      UhciAppendTd (Uhc, PrevDataTd, DataTd);\r
    }\r
\r
    *DataToggle ^= 1;\r
    PrevDataTd   = DataTd;\r
    Data        += ThisTdLen;\r
    DataPhy     += ThisTdLen;\r
    DataLen     -= ThisTdLen;\r
  }\r
\r
  return FirstDataTd;\r
\r
FREE_TD:\r
  if (FirstDataTd != NULL) {\r
    UhciDestoryTds (Uhc, FirstDataTd);\r
  }\r
\r
  return NULL;\r
}\r