+#define MPT_SCSI_DMA_ADDR(Dev, MemberName) \\r
+ (Dev->DmaPhysical + OFFSET_OF (MPT_SCSI_DMA_BUFFER, MemberName))\r
+\r
+#define MPT_SCSI_DMA_ADDR_HIGH(Dev, MemberName) \\r
+ ((UINT32)RShiftU64 (MPT_SCSI_DMA_ADDR (Dev, MemberName), 32))\r
+\r
+#define MPT_SCSI_DMA_ADDR_LOW(Dev, MemberName) \\r
+ ((UINT32)MPT_SCSI_DMA_ADDR (Dev, MemberName))\r
+\r
+//\r
+// Hardware functions\r
+//\r
+\r
+STATIC\r
+EFI_STATUS\r
+Out32 (\r
+ IN MPT_SCSI_DEV *Dev,\r
+ IN UINT32 Addr,\r
+ IN UINT32 Data\r
+ )\r
+{\r
+ return Dev->PciIo->Io.Write (\r
+ Dev->PciIo,\r
+ EfiPciIoWidthUint32,\r
+ PCI_BAR_IDX0,\r
+ Addr,\r
+ 1,\r
+ &Data\r
+ );\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+In32 (\r
+ IN MPT_SCSI_DEV *Dev,\r
+ IN UINT32 Addr,\r
+ OUT UINT32 *Data\r
+ )\r
+{\r
+ return Dev->PciIo->Io.Read (\r
+ Dev->PciIo,\r
+ EfiPciIoWidthUint32,\r
+ PCI_BAR_IDX0,\r
+ Addr,\r
+ 1,\r
+ Data\r
+ );\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+MptDoorbell (\r
+ IN MPT_SCSI_DEV *Dev,\r
+ IN UINT8 DoorbellFunc,\r
+ IN UINT8 DoorbellArg\r
+ )\r
+{\r
+ return Out32 (\r
+ Dev,\r
+ MPT_REG_DOORBELL,\r
+ (((UINT32)DoorbellFunc) << 24) | (DoorbellArg << 16)\r
+ );\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+MptScsiReset (\r
+ IN MPT_SCSI_DEV *Dev\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ //\r
+ // Reset hardware\r
+ //\r
+ Status = MptDoorbell (Dev, MPT_DOORBELL_RESET, 0);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ //\r
+ // Mask interrupts\r
+ //\r
+ Status = Out32 (Dev, MPT_REG_IMASK, MPT_IMASK_DOORBELL | MPT_IMASK_REPLY);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ //\r
+ // Clear interrupt status\r
+ //\r
+ Status = Out32 (Dev, MPT_REG_ISTATUS, 0);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+MptScsiInit (\r
+ IN MPT_SCSI_DEV *Dev\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ union {\r
+ MPT_IO_CONTROLLER_INIT_REQUEST Data;\r
+ UINT32 Uint32;\r
+ } AlignedReq;\r
+ MPT_IO_CONTROLLER_INIT_REQUEST *Req;\r
+ MPT_IO_CONTROLLER_INIT_REPLY Reply;\r
+ UINT8 *ReplyBytes;\r
+ UINT32 ReplyWord;\r
+\r
+ Req = &AlignedReq.Data;\r
+\r
+ Status = MptScsiReset (Dev);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ ZeroMem (Req, sizeof (*Req));\r
+ ZeroMem (&Reply, sizeof (Reply));\r
+ Req->WhoInit = MPT_IOC_WHOINIT_ROM_BIOS;\r
+ Req->Function = MPT_MESSAGE_HDR_FUNCTION_IOC_INIT;\r
+ STATIC_ASSERT (\r
+ FixedPcdGet8 (PcdMptScsiMaxTargetLimit) < 255,\r
+ "Req supports 255 targets only (max target is 254)"\r
+ );\r
+ Req->MaxDevices = Dev->MaxTarget + 1;\r
+ Req->MaxBuses = 1;\r
+ Req->ReplyFrameSize = sizeof Dev->Dma->IoReply.Data;\r
+ Req->HostMfaHighAddr = MPT_SCSI_DMA_ADDR_HIGH (Dev, IoRequest);\r
+ Req->SenseBufferHighAddr = MPT_SCSI_DMA_ADDR_HIGH (Dev, Sense);\r
+\r
+ //\r
+ // Send controller init through doorbell\r
+ //\r
+ STATIC_ASSERT (\r
+ sizeof (*Req) % sizeof (UINT32) == 0,\r
+ "Req must be multiple of UINT32"\r
+ );\r
+ STATIC_ASSERT (\r
+ sizeof (*Req) / sizeof (UINT32) <= MAX_UINT8,\r
+ "Req must fit in MAX_UINT8 Dwords"\r
+ );\r
+ Status = MptDoorbell (\r
+ Dev,\r
+ MPT_DOORBELL_HANDSHAKE,\r
+ (UINT8)(sizeof (*Req) / sizeof (UINT32))\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ Status = Dev->PciIo->Io.Write (\r
+ Dev->PciIo,\r
+ EfiPciIoWidthFifoUint32,\r
+ PCI_BAR_IDX0,\r
+ MPT_REG_DOORBELL,\r
+ sizeof (*Req) / sizeof (UINT32),\r
+ Req\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Read reply through doorbell\r
+ // Each 32bit (Dword) read produces 16bit (Word) of data\r
+ //\r
+ // The reply is read back to complete the doorbell function but it\r
+ // isn't useful because it doesn't contain relevant data or status\r
+ // codes.\r
+ //\r
+ STATIC_ASSERT (\r
+ sizeof (Reply) % sizeof (UINT16) == 0,\r
+ "Reply must be multiple of UINT16"\r
+ );\r
+ ReplyBytes = (UINT8 *)&Reply;\r
+ while (ReplyBytes != (UINT8 *)(&Reply + 1)) {\r
+ Status = In32 (Dev, MPT_REG_DOORBELL, &ReplyWord);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ CopyMem (ReplyBytes, &ReplyWord, sizeof (UINT16));\r
+ ReplyBytes += sizeof (UINT16);\r
+ }\r
+\r
+ //\r
+ // Clear interrupts generated by doorbell reply\r
+ //\r
+ Status = Out32 (Dev, MPT_REG_ISTATUS, 0);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+ReportHostAdapterError (\r
+ OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
+ )\r
+{\r
+ DEBUG ((DEBUG_ERROR, "%a: fatal error in scsi request\n", __FUNCTION__));\r
+ Packet->InTransferLength = 0;\r
+ Packet->OutTransferLength = 0;\r
+ Packet->SenseDataLength = 0;\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OTHER;\r
+ Packet->TargetStatus = EFI_EXT_SCSI_STATUS_TARGET_TASK_ABORTED;\r
+ return EFI_DEVICE_ERROR;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+ReportHostAdapterOverrunError (\r
+ OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
+ )\r
+{\r
+ Packet->SenseDataLength = 0;\r
+ Packet->HostAdapterStatus =\r
+ EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN;\r
+ Packet->TargetStatus = EFI_EXT_SCSI_STATUS_TARGET_GOOD;\r
+ return EFI_BAD_BUFFER_SIZE;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+MptScsiPopulateRequest (\r
+ IN MPT_SCSI_DEV *Dev,\r
+ IN UINT8 Target,\r
+ IN UINT64 Lun,\r
+ IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
+ )\r
+{\r
+ MPT_SCSI_REQUEST_WITH_SG *Request;\r
+\r
+ Request = &Dev->Dma->IoRequest.Data;\r
+\r
+ if (Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_BIDIRECTIONAL ||\r
+ (Packet->InTransferLength > 0 && Packet->OutTransferLength > 0) ||\r
+ Packet->CdbLength > sizeof (Request->Header.Cdb)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ if (Target > Dev->MaxTarget || Lun > 0 ||\r
+ Packet->DataDirection > EFI_EXT_SCSI_DATA_DIRECTION_BIDIRECTIONAL ||\r
+ //\r
+ // Trying to receive, but destination pointer is NULL, or contradicting\r
+ // transfer direction\r
+ //\r
+ (Packet->InTransferLength > 0 &&\r
+ (Packet->InDataBuffer == NULL ||\r
+ Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_WRITE\r
+ )\r
+ ) ||\r
+\r
+ //\r
+ // Trying to send, but source pointer is NULL, or contradicting transfer\r
+ // direction\r
+ //\r
+ (Packet->OutTransferLength > 0 &&\r
+ (Packet->OutDataBuffer == NULL ||\r
+ Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_READ\r
+ )\r
+ )\r
+ ) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ if (Packet->InTransferLength > sizeof (Dev->Dma->Data)) {\r
+ Packet->InTransferLength = sizeof (Dev->Dma->Data);\r
+ return ReportHostAdapterOverrunError (Packet);\r
+ }\r
+ if (Packet->OutTransferLength > sizeof (Dev->Dma->Data)) {\r
+ Packet->OutTransferLength = sizeof (Dev->Dma->Data);\r
+ return ReportHostAdapterOverrunError (Packet);\r
+ }\r
+\r
+ ZeroMem (Request, sizeof (*Request));\r
+ Request->Header.TargetId = Target;\r
+ //\r
+ // Only LUN 0 is currently supported, hence the cast is safe\r
+ //\r
+ Request->Header.Lun[1] = (UINT8)Lun;\r
+ Request->Header.Function = MPT_MESSAGE_HDR_FUNCTION_SCSI_IO_REQUEST;\r
+ Request->Header.MessageContext = 1; // We handle one request at a time\r
+\r
+ Request->Header.CdbLength = Packet->CdbLength;\r
+ CopyMem (Request->Header.Cdb, Packet->Cdb, Packet->CdbLength);\r
+\r
+ //\r
+ // SenseDataLength is UINT8, Sense[] is MAX_UINT8, so we can't overflow\r
+ //\r
+ ZeroMem (Dev->Dma->Sense, Packet->SenseDataLength);\r
+ Request->Header.SenseBufferLength = Packet->SenseDataLength;\r
+ Request->Header.SenseBufferLowAddress = MPT_SCSI_DMA_ADDR_LOW (Dev, Sense);\r
+\r
+ Request->Sg.EndOfList = 1;\r
+ Request->Sg.EndOfBuffer = 1;\r
+ Request->Sg.LastElement = 1;\r
+ Request->Sg.ElementType = MPT_SG_ENTRY_TYPE_SIMPLE;\r
+ Request->Sg.Is64BitAddress = 1;\r
+ Request->Sg.DataBufferAddress = MPT_SCSI_DMA_ADDR (Dev, Data);\r
+\r
+ //\r
+ // "MPT_SG_ENTRY_SIMPLE.Length" is a 24-bit quantity.\r
+ //\r
+ STATIC_ASSERT (\r
+ sizeof (Dev->Dma->Data) < SIZE_16MB,\r
+ "MPT_SCSI_DMA_BUFFER.Data must be smaller than 16MB"\r
+ );\r
+\r
+ if (Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_READ) {\r
+ Request->Header.DataLength = Packet->InTransferLength;\r
+ Request->Sg.Length = Packet->InTransferLength;\r
+ Request->Header.Control = MPT_SCSIIO_REQUEST_CONTROL_TXDIR_READ;\r
+ } else {\r
+ Request->Header.DataLength = Packet->OutTransferLength;\r
+ Request->Sg.Length = Packet->OutTransferLength;\r
+ Request->Header.Control = MPT_SCSIIO_REQUEST_CONTROL_TXDIR_WRITE;\r
+\r
+ CopyMem (Dev->Dma->Data, Packet->OutDataBuffer, Packet->OutTransferLength);\r
+ Request->Sg.BufferContainsData = 1;\r
+ }\r
+\r
+ if (Request->Header.DataLength == 0) {\r
+ Request->Header.Control = MPT_SCSIIO_REQUEST_CONTROL_TXDIR_NONE;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+MptScsiSendRequest (\r
+ IN MPT_SCSI_DEV *Dev,\r
+ IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ if (!Dev->IoReplyEnqueued) {\r
+ //\r
+ // Put one free reply frame on the reply queue, the hardware may use it to\r
+ // report an error to us.\r
+ //\r
+ Status = Out32 (Dev, MPT_REG_REP_Q, MPT_SCSI_DMA_ADDR_LOW (Dev, IoReply));\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+ Dev->IoReplyEnqueued = TRUE;\r
+ }\r
+\r
+ Status = Out32 (Dev, MPT_REG_REQ_Q, MPT_SCSI_DMA_ADDR_LOW (Dev, IoRequest));\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+MptScsiGetReply (\r
+ IN MPT_SCSI_DEV *Dev,\r
+ OUT UINT32 *Reply\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINT32 Istatus;\r
+ UINT32 EmptyReply;\r
+\r
+ //\r
+ // Timeouts are not supported for\r
+ // EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() in this implementation.\r
+ //\r
+ for (;;) {\r
+ Status = In32 (Dev, MPT_REG_ISTATUS, &Istatus);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Interrupt raised\r
+ //\r
+ if (Istatus & MPT_IMASK_REPLY) {\r
+ break;\r
+ }\r
+\r
+ gBS->Stall (Dev->StallPerPollUsec);\r
+ }\r
+\r
+ Status = In32 (Dev, MPT_REG_REP_Q, Reply);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // The driver is supposed to fetch replies until 0xffffffff is returned, which\r
+ // will reset the interrupt status. We put only one request, so we expect the\r
+ // next read reply to be the last.\r
+ //\r
+ Status = In32 (Dev, MPT_REG_REP_Q, &EmptyReply);\r
+ if (EFI_ERROR (Status) || EmptyReply != MAX_UINT32) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+MptScsiHandleReply (\r
+ IN MPT_SCSI_DEV *Dev,\r
+ IN UINT32 Reply,\r
+ OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
+ )\r
+{\r
+ if (Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_READ) {\r
+ CopyMem (Packet->InDataBuffer, Dev->Dma->Data, Packet->InTransferLength);\r
+ }\r
+\r
+ if (Reply == Dev->Dma->IoRequest.Data.Header.MessageContext) {\r
+ //\r
+ // This is a turbo reply, everything is good\r
+ //\r
+ Packet->SenseDataLength = 0;\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK;\r
+ Packet->TargetStatus = EFI_EXT_SCSI_STATUS_TARGET_GOOD;\r
+\r
+ } else if ((Reply & BIT31) != 0) {\r
+ DEBUG ((DEBUG_INFO, "%a: Full reply returned\n", __FUNCTION__));\r
+ //\r
+ // When reply MSB is set, we got a full reply. Since we submitted only one\r
+ // reply frame, we know it's IoReply.\r
+ //\r
+ Dev->IoReplyEnqueued = FALSE;\r
+\r
+ Packet->TargetStatus = Dev->Dma->IoReply.Data.ScsiStatus;\r
+ //\r
+ // Make sure device only lowers SenseDataLength before copying sense\r
+ //\r
+ ASSERT (Dev->Dma->IoReply.Data.SenseCount <= Packet->SenseDataLength);\r
+ Packet->SenseDataLength =\r
+ (UINT8)MIN (Dev->Dma->IoReply.Data.SenseCount, Packet->SenseDataLength);\r
+ CopyMem (Packet->SenseData, Dev->Dma->Sense, Packet->SenseDataLength);\r
+\r
+ if (Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_READ) {\r
+ Packet->InTransferLength = Dev->Dma->IoReply.Data.TransferCount;\r
+ } else {\r
+ Packet->OutTransferLength = Dev->Dma->IoReply.Data.TransferCount;\r
+ }\r
+\r
+ switch (Dev->Dma->IoReply.Data.IocStatus) {\r
+ case MPT_SCSI_IOCSTATUS_SUCCESS:\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK;\r
+ break;\r
+ case MPT_SCSI_IOCSTATUS_DEVICE_NOT_THERE:\r
+ Packet->HostAdapterStatus =\r
+ EFI_EXT_SCSI_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT;\r
+ return EFI_TIMEOUT;\r
+ case MPT_SCSI_IOCSTATUS_DATA_UNDERRUN:\r
+ case MPT_SCSI_IOCSTATUS_DATA_OVERRUN:\r
+ Packet->HostAdapterStatus =\r
+ EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN;\r
+ break;\r
+ default:\r
+ Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OTHER;\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ } else {\r
+ DEBUG ((DEBUG_ERROR, "%a: unexpected reply (%x)\n", __FUNCTION__, Reply));\r
+ return ReportHostAdapterError (Packet);\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r