projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 4b738c76 HT |
1 | /** @file\r |
| 2 | Header file for ATA/ATAPI PASS THRU driver.\r | |
| 3 | \r | |
| 23a596db | 4 | Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>\r |
| 4b738c76 HT |
5 | This program and the accompanying materials\r |
| 6 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 7 | which accompanies this distribution. The full text of the license may be found at\r | |
| 8 | http://opensource.org/licenses/bsd-license.php\r | |
| 9 | \r | |
| 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 12 | \r | |
| 13 | **/\r | |
| 14 | #ifndef __ATA_ATAPI_PASS_THRU_H__\r | |
| 15 | #define __ATA_ATAPI_PASS_THRU_H__\r | |
| 16 | \r | |
| 17 | #include <Uefi.h>\r | |
| 18 | \r | |
| 19 | #include <IndustryStandard/Pci.h>\r | |
| 20 | #include <IndustryStandard/Atapi.h>\r | |
| 21 | #include <IndustryStandard/Scsi.h>\r | |
| 22 | \r | |
| 23 | #include <Protocol/PciIo.h>\r | |
| 24 | #include <Protocol/IdeControllerInit.h>\r | |
| 25 | #include <Protocol/AtaPassThru.h>\r | |
| 26 | #include <Protocol/ScsiPassThruExt.h>\r | |
| 27 | \r | |
| 28 | #include <Library/DebugLib.h>\r | |
| 29 | #include <Library/BaseLib.h>\r | |
| 30 | #include <Library/BaseMemoryLib.h>\r | |
| 31 | #include <Library/UefiDriverEntryPoint.h>\r | |
| 32 | #include <Library/UefiBootServicesTableLib.h>\r | |
| 33 | #include <Library/UefiLib.h>\r | |
| 34 | #include <Library/PciLib.h>\r | |
| 35 | #include <Library/PcdLib.h>\r | |
| 36 | #include <Library/TimerLib.h>\r | |
| 37 | #include <Library/MemoryAllocationLib.h>\r | |
| 38 | #include <Library/ReportStatusCodeLib.h>\r | |
| 39 | #include <Library/DevicePathLib.h>\r | |
| 40 | \r | |
| 41 | #include "IdeMode.h"\r | |
| 42 | #include "AhciMode.h"\r | |
| 43 | \r | |
| 44 | extern EFI_DRIVER_BINDING_PROTOCOL gAtaAtapiPassThruDriverBinding;\r | |
| 45 | extern EFI_COMPONENT_NAME_PROTOCOL gAtaAtapiPassThruComponentName;\r | |
| 46 | extern EFI_COMPONENT_NAME2_PROTOCOL gAtaAtapiPassThruComponentName2;\r | |
| 47 | \r | |
| 48 | #define ATA_ATAPI_PASS_THRU_SIGNATURE SIGNATURE_32 ('a', 'a', 'p', 't')\r | |
| 49 | #define ATA_ATAPI_DEVICE_SIGNATURE SIGNATURE_32 ('a', 'd', 'e', 'v')\r | |
| 50 | #define ATA_NONBLOCKING_TASK_SIGNATURE SIGNATURE_32 ('a', 't', 's', 'k')\r | |
| 51 | \r | |
| 52 | typedef struct _ATA_NONBLOCK_TASK ATA_NONBLOCK_TASK;\r | |
| 53 | \r | |
| 54 | typedef enum {\r | |
| 55 | EfiAtaIdeMode,\r | |
| 56 | EfiAtaAhciMode,\r | |
| 57 | EfiAtaRaidMode,\r | |
| 58 | EfiAtaUnknownMode\r | |
| 59 | } EFI_ATA_HC_WORK_MODE;\r | |
| 60 | \r | |
| 61 | typedef enum {\r | |
| 62 | EfiIdeCdrom, /* ATAPI CDROM */\r | |
| 63 | EfiIdeHarddisk, /* Hard Disk */\r | |
| 64 | EfiPortMultiplier, /* Port Multiplier */\r | |
| 65 | EfiIdeUnknown\r | |
| 66 | } EFI_ATA_DEVICE_TYPE;\r | |
| 67 | \r | |
| 68 | //\r | |
| 69 | // Ahci mode device info\r | |
| 70 | //\r | |
| 71 | typedef struct {\r | |
| 72 | UINT32 Signature;\r | |
| 73 | LIST_ENTRY Link;\r | |
| 74 | \r | |
| 75 | UINT16 Port;\r | |
| 76 | UINT16 PortMultiplier;\r | |
| 77 | EFI_ATA_DEVICE_TYPE Type;\r | |
| 78 | \r | |
| 79 | EFI_IDENTIFY_DATA *IdentifyData;\r | |
| 80 | } EFI_ATA_DEVICE_INFO;\r | |
| 81 | \r | |
| 82 | typedef struct {\r | |
| 83 | UINT32 Signature;\r | |
| 84 | \r | |
| 85 | EFI_HANDLE ControllerHandle;\r | |
| 86 | EFI_PCI_IO_PROTOCOL *PciIo;\r | |
| 87 | EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeControllerInit;\r | |
| 88 | \r | |
| 89 | EFI_ATA_PASS_THRU_MODE AtaPassThruMode;\r | |
| 90 | EFI_ATA_PASS_THRU_PROTOCOL AtaPassThru;\r | |
| 91 | EFI_EXT_SCSI_PASS_THRU_MODE ExtScsiPassThruMode;\r | |
| 92 | EFI_EXT_SCSI_PASS_THRU_PROTOCOL ExtScsiPassThru;\r | |
| 93 | \r | |
| 94 | EFI_ATA_HC_WORK_MODE Mode;\r | |
| 95 | \r | |
| 96 | EFI_IDE_REGISTERS IdeRegisters[EfiIdeMaxChannel];\r | |
| 97 | EFI_AHCI_REGISTERS AhciRegisters;\r | |
| 98 | \r | |
| 99 | //\r | |
| 100 | // The attached device list\r | |
| 101 | //\r | |
| 102 | LIST_ENTRY DeviceList;\r | |
| eed3f713 | 103 | UINT64 EnabledPciAttributes;\r |
| 4b738c76 HT |
104 | UINT64 OriginalPciAttributes;\r |
| 105 | \r | |
| 106 | //\r | |
| 107 | // For AtaPassThru protocol, using the following bytes to record the previous call in\r | |
| 108 | // GetNextPort()/GetNextDevice().\r | |
| 109 | //\r | |
| 110 | UINT16 PreviousPort;\r | |
| 111 | UINT16 PreviousPortMultiplier;\r | |
| 112 | //\r | |
| 113 | // For ExtScsiPassThru protocol, using the following bytes to record the previous call in\r | |
| 114 | // GetNextTarget()/GetNextTargetLun().\r | |
| 115 | //\r | |
| 116 | UINT16 PreviousTargetId;\r | |
| 117 | UINT64 PreviousLun;\r | |
| 118 | \r | |
| 119 | //\r | |
| 120 | // For Non-blocking.\r | |
| 121 | //\r | |
| 122 | EFI_EVENT TimerEvent;\r | |
| 123 | LIST_ENTRY NonBlockingTaskList;\r | |
| 6fb8ddd3 LE |
124 | \r |
| 125 | //\r | |
| 126 | // For disabling the device (especially Bus Master DMA) at\r | |
| 127 | // ExitBootServices().\r | |
| 128 | //\r | |
| 129 | EFI_EVENT ExitBootEvent;\r | |
| 4b738c76 HT |
130 | } ATA_ATAPI_PASS_THRU_INSTANCE;\r |
| 131 | \r | |
| 132 | //\r | |
| 133 | // Task for Non-blocking mode.\r | |
| 134 | //\r | |
| 135 | struct _ATA_NONBLOCK_TASK {\r | |
| 136 | UINT32 Signature;\r | |
| 137 | LIST_ENTRY Link;\r | |
| 138 | \r | |
| 139 | UINT16 Port;\r | |
| 140 | UINT16 PortMultiplier;\r | |
| 141 | EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet;\r | |
| 142 | BOOLEAN IsStart;\r | |
| 143 | EFI_EVENT Event;\r | |
| 144 | UINT64 RetryTimes;\r | |
| ab82122d TF |
145 | BOOLEAN InfiniteWait;\r |
| 146 | VOID *Map; // Pointer to map.\r | |
| 147 | VOID *TableMap; // Pointer to PRD table map.\r | |
| 4b738c76 | 148 | EFI_ATA_DMA_PRD *MapBaseAddress; // Pointer to range Base address for Map.\r |
| ab82122d | 149 | UINTN PageCount; // The page numbers used by PCIO freebuffer.\r |
| 4b738c76 HT |
150 | };\r |
| 151 | \r | |
| 152 | //\r | |
| 153 | // Timeout value which uses 100ns as a unit.\r | |
| 154 | // It means 3 second span.\r | |
| 155 | //\r | |
| 156 | #define ATA_ATAPI_TIMEOUT EFI_TIMER_PERIOD_SECONDS(3)\r | |
| 157 | \r | |
| 158 | #define IS_ALIGNED(addr, size) (((UINTN) (addr) & (size - 1)) == 0)\r | |
| 159 | \r | |
| 160 | #define ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS(a) \\r | |
| 161 | CR (a, \\r | |
| 162 | ATA_ATAPI_PASS_THRU_INSTANCE, \\r | |
| 163 | AtaPassThru, \\r | |
| 164 | ATA_ATAPI_PASS_THRU_SIGNATURE \\r | |
| 165 | )\r | |
| 166 | \r | |
| 167 | #define EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS(a) \\r | |
| 168 | CR (a, \\r | |
| 169 | ATA_ATAPI_PASS_THRU_INSTANCE, \\r | |
| 170 | ExtScsiPassThru, \\r | |
| 171 | ATA_ATAPI_PASS_THRU_SIGNATURE \\r | |
| 172 | )\r | |
| 173 | \r | |
| 174 | #define ATA_ATAPI_DEVICE_INFO_FROM_THIS(a) \\r | |
| 175 | CR (a, \\r | |
| 176 | EFI_ATA_DEVICE_INFO, \\r | |
| 177 | Link, \\r | |
| 178 | ATA_ATAPI_DEVICE_SIGNATURE \\r | |
| 179 | );\r | |
| 180 | \r | |
| 181 | #define ATA_NON_BLOCK_TASK_FROM_ENTRY(a) \\r | |
| 182 | CR (a, \\r | |
| 183 | ATA_NONBLOCK_TASK, \\r | |
| 184 | Link, \\r | |
| 185 | ATA_NONBLOCKING_TASK_SIGNATURE \\r | |
| 186 | );\r | |
| 187 | \r | |
| 188 | /**\r | |
| 189 | Retrieves a Unicode string that is the user readable name of the driver.\r | |
| 190 | \r | |
| 191 | This function retrieves the user readable name of a driver in the form of a\r | |
| 192 | Unicode string. If the driver specified by This has a user readable name in\r | |
| 193 | the language specified by Language, then a pointer to the driver name is\r | |
| 194 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r | |
| 195 | by This does not support the language specified by Language,\r | |
| 196 | then EFI_UNSUPPORTED is returned.\r | |
| 197 | \r | |
| 198 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
| 199 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
| 200 | \r | |
| 201 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
| 202 | array indicating the language. This is the\r | |
| 203 | language of the driver name that the caller is\r | |
| 204 | requesting, and it must match one of the\r | |
| 205 | languages specified in SupportedLanguages. The\r | |
| 206 | number of languages supported by a driver is up\r | |
| 207 | to the driver writer. Language is specified\r | |
| 208 | in RFC 4646 or ISO 639-2 language code format.\r | |
| 209 | \r | |
| 210 | @param DriverName[out] A pointer to the Unicode string to return.\r | |
| 211 | This Unicode string is the name of the\r | |
| 212 | driver specified by This in the language\r | |
| 213 | specified by Language.\r | |
| 214 | \r | |
| 215 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r | |
| 216 | This and the language specified by Language was\r | |
| 217 | returned in DriverName.\r | |
| 218 | \r | |
| 219 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
| 220 | \r | |
| 221 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
| 222 | \r | |
| 223 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
| 224 | the language specified by Language.\r | |
| 225 | \r | |
| 226 | **/\r | |
| 227 | EFI_STATUS\r | |
| 228 | EFIAPI\r | |
| 229 | AtaAtapiPassThruComponentNameGetDriverName (\r | |
| 230 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
| 231 | IN CHAR8 *Language,\r | |
| 232 | OUT CHAR16 **DriverName\r | |
| 233 | );\r | |
| 234 | \r | |
| 235 | /**\r | |
| 236 | Retrieves a Unicode string that is the user readable name of the controller\r | |
| 237 | that is being managed by a driver.\r | |
| 238 | \r | |
| 239 | This function retrieves the user readable name of the controller specified by\r | |
| 240 | ControllerHandle and ChildHandle in the form of a Unicode string. If the\r | |
| 241 | driver specified by This has a user readable name in the language specified by\r | |
| 242 | Language, then a pointer to the controller name is returned in ControllerName,\r | |
| 243 | and EFI_SUCCESS is returned. If the driver specified by This is not currently\r | |
| 244 | managing the controller specified by ControllerHandle and ChildHandle,\r | |
| 245 | then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r | |
| 246 | support the language specified by Language, then EFI_UNSUPPORTED is returned.\r | |
| 247 | \r | |
| 248 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
| 249 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
| 250 | \r | |
| 251 | @param ControllerHandle[in] The handle of a controller that the driver\r | |
| 252 | specified by This is managing. This handle\r | |
| 253 | specifies the controller whose name is to be\r | |
| 254 | returned.\r | |
| 255 | \r | |
| 256 | @param ChildHandle[in] The handle of the child controller to retrieve\r | |
| 257 | the name of. This is an optional parameter that\r | |
| 258 | may be NULL. It will be NULL for device\r | |
| 259 | drivers. It will also be NULL for a bus drivers\r | |
| 260 | that wish to retrieve the name of the bus\r | |
| 261 | controller. It will not be NULL for a bus\r | |
| 262 | driver that wishes to retrieve the name of a\r | |
| 263 | child controller.\r | |
| 264 | \r | |
| 265 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
| 266 | array indicating the language. This is the\r | |
| 267 | language of the driver name that the caller is\r | |
| 268 | requesting, and it must match one of the\r | |
| 269 | languages specified in SupportedLanguages. The\r | |
| 270 | number of languages supported by a driver is up\r | |
| 271 | to the driver writer. Language is specified in\r | |
| 272 | RFC 4646 or ISO 639-2 language code format.\r | |
| 273 | \r | |
| 274 | @param ControllerName[out] A pointer to the Unicode string to return.\r | |
| 275 | This Unicode string is the name of the\r | |
| 276 | controller specified by ControllerHandle and\r | |
| 277 | ChildHandle in the language specified by\r | |
| 278 | Language from the point of view of the driver\r | |
| 279 | specified by This.\r | |
| 280 | \r | |
| 281 | @retval EFI_SUCCESS The Unicode string for the user readable name in\r | |
| 282 | the language specified by Language for the\r | |
| 283 | driver specified by This was returned in\r | |
| 284 | DriverName.\r | |
| 285 | \r | |
| 286 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r | |
| 287 | \r | |
| 288 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r | |
| 289 | EFI_HANDLE.\r | |
| 290 | \r | |
| 291 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
| 292 | \r | |
| 293 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
| 294 | \r | |
| 295 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r | |
| 296 | managing the controller specified by\r | |
| 297 | ControllerHandle and ChildHandle.\r | |
| 298 | \r | |
| 299 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
| 300 | the language specified by Language.\r | |
| 301 | \r | |
| 302 | **/\r | |
| 303 | EFI_STATUS\r | |
| 304 | EFIAPI\r | |
| 305 | AtaAtapiPassThruComponentNameGetControllerName (\r | |
| 306 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
| 307 | IN EFI_HANDLE ControllerHandle,\r | |
| 308 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
| 309 | IN CHAR8 *Language,\r | |
| 310 | OUT CHAR16 **ControllerName\r | |
| 311 | );\r | |
| 312 | \r | |
| 313 | /**\r | |
| 314 | Tests to see if this driver supports a given controller. If a child device is provided,\r | |
| 315 | it further tests to see if this driver supports creating a handle for the specified child device.\r | |
| 316 | \r | |
| 317 | This function checks to see if the driver specified by This supports the device specified by\r | |
| 318 | ControllerHandle. Drivers will typically use the device path attached to\r | |
| 319 | ControllerHandle and/or the services from the bus I/O abstraction attached to\r | |
| 320 | ControllerHandle to determine if the driver supports ControllerHandle. This function\r | |
| 321 | may be called many times during platform initialization. In order to reduce boot times, the tests\r | |
| 322 | performed by this function must be very small, and take as little time as possible to execute. This\r | |
| 323 | function must not change the state of any hardware devices, and this function must be aware that the\r | |
| 324 | device specified by ControllerHandle may already be managed by the same driver or a\r | |
| 325 | different driver. This function must match its calls to AllocatePages() with FreePages(),\r | |
| 326 | AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().\r | |
| 327 | Because ControllerHandle may have been previously started by the same driver, if a protocol is\r | |
| 328 | already in the opened state, then it must not be closed with CloseProtocol(). This is required\r | |
| 329 | to guarantee the state of ControllerHandle is not modified by this function.\r | |
| 330 | \r | |
| 331 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r | |
| 332 | @param[in] ControllerHandle The handle of the controller to test. This handle\r | |
| 333 | must support a protocol interface that supplies\r | |
| 334 | an I/O abstraction to the driver.\r | |
| 335 | @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r | |
| 336 | parameter is ignored by device drivers, and is optional for bus\r | |
| 337 | drivers. For bus drivers, if this parameter is not NULL, then\r | |
| 338 | the bus driver must determine if the bus controller specified\r | |
| 339 | by ControllerHandle and the child controller specified\r | |
| 340 | by RemainingDevicePath are both supported by this\r | |
| 341 | bus driver.\r | |
| 342 | \r | |
| 343 | @retval EFI_SUCCESS The device specified by ControllerHandle and\r | |
| 344 | RemainingDevicePath is supported by the driver specified by This.\r | |
| 345 | @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and\r | |
| 346 | RemainingDevicePath is already being managed by the driver\r | |
| 347 | specified by This.\r | |
| 348 | @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and\r | |
| 349 | RemainingDevicePath is already being managed by a different\r | |
| 350 | driver or an application that requires exclusive access.\r | |
| 351 | Currently not implemented.\r | |
| 352 | @retval EFI_UNSUPPORTED The device specified by ControllerHandle and\r | |
| 353 | RemainingDevicePath is not supported by the driver specified by This.\r | |
| 354 | **/\r | |
| 355 | EFI_STATUS\r | |
| 356 | EFIAPI\r | |
| 357 | AtaAtapiPassThruSupported (\r | |
| 358 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 359 | IN EFI_HANDLE Controller,\r | |
| 360 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
| 361 | );\r | |
| 362 | \r | |
| 363 | /**\r | |
| 364 | Starts a device controller or a bus controller.\r | |
| 365 | \r | |
| 366 | The Start() function is designed to be invoked from the EFI boot service ConnectController().\r | |
| 367 | As a result, much of the error checking on the parameters to Start() has been moved into this\r | |
| 368 | common boot service. It is legal to call Start() from other locations,\r | |
| 369 | but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r | |
| 370 | 1. ControllerHandle must be a valid EFI_HANDLE.\r | |
| 371 | 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r | |
| 372 | EFI_DEVICE_PATH_PROTOCOL.\r | |
| 373 | 3. Prior to calling Start(), the Supported() function for the driver specified by This must\r | |
| 374 | have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.\r | |
| 375 | \r | |
| 376 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r | |
| 377 | @param[in] ControllerHandle The handle of the controller to start. This handle\r | |
| 378 | must support a protocol interface that supplies\r | |
| 379 | an I/O abstraction to the driver.\r | |
| 380 | @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r | |
| 381 | parameter is ignored by device drivers, and is optional for bus\r | |
| 382 | drivers. For a bus driver, if this parameter is NULL, then handles\r | |
| 383 | for all the children of Controller are created by this driver.\r | |
| 384 | If this parameter is not NULL and the first Device Path Node is\r | |
| 385 | not the End of Device Path Node, then only the handle for the\r | |
| 386 | child device specified by the first Device Path Node of\r | |
| 387 | RemainingDevicePath is created by this driver.\r | |
| 388 | If the first Device Path Node of RemainingDevicePath is\r | |
| 389 | the End of Device Path Node, no child handle is created by this\r | |
| 390 | driver.\r | |
| 391 | \r | |
| 392 | @retval EFI_SUCCESS The device was started.\r | |
| 393 | @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.\r | |
| 394 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
| 395 | @retval Others The driver failded to start the device.\r | |
| 396 | \r | |
| 397 | **/\r | |
| 398 | EFI_STATUS\r | |
| 399 | EFIAPI\r | |
| 400 | AtaAtapiPassThruStart (\r | |
| 401 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 402 | IN EFI_HANDLE Controller,\r | |
| 403 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
| 404 | );\r | |
| 405 | \r | |
| 406 | /**\r | |
| 407 | Stops a device controller or a bus controller.\r | |
| 408 | \r | |
| 409 | The Stop() function is designed to be invoked from the EFI boot service DisconnectController().\r | |
| 410 | As a result, much of the error checking on the parameters to Stop() has been moved\r | |
| 411 | into this common boot service. It is legal to call Stop() from other locations,\r | |
| 412 | but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r | |
| 413 | 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r | |
| 414 | same driver's Start() function.\r | |
| 415 | 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r | |
| 416 | EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r | |
| 417 | Start() function, and the Start() function must have called OpenProtocol() on\r | |
| 418 | ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r | |
| 419 | \r | |
| 420 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r | |
| 421 | @param[in] ControllerHandle A handle to the device being stopped. The handle must\r | |
| 422 | support a bus specific I/O protocol for the driver\r | |
| 423 | to use to stop the device.\r | |
| 424 | @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.\r | |
| 425 | @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r | |
| 426 | if NumberOfChildren is 0.\r | |
| 427 | \r | |
| 428 | @retval EFI_SUCCESS The device was stopped.\r | |
| 429 | @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.\r | |
| 430 | \r | |
| 431 | **/\r | |
| 432 | EFI_STATUS\r | |
| 433 | EFIAPI\r | |
| 434 | AtaAtapiPassThruStop (\r | |
| 435 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 436 | IN EFI_HANDLE Controller,\r | |
| 437 | IN UINTN NumberOfChildren,\r | |
| 438 | IN EFI_HANDLE *ChildHandleBuffer\r | |
| 439 | );\r | |
| 440 | \r | |
| 441 | /**\r | |
| 442 | Traverse the attached ATA devices list to find out the device to access.\r | |
| 443 | \r | |
| 444 | @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.\r | |
| 445 | @param[in] Port The port number of the ATA device to send the command.\r | |
| 446 | @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command.\r | |
| 23a596db | 447 | If there is no port multiplier, then specify 0xFFFF.\r |
| 4b738c76 HT |
448 | @param[in] DeviceType The device type of the ATA device.\r |
| 449 | \r | |
| 450 | @retval The pointer to the data structure of the device info to access.\r | |
| 451 | \r | |
| 452 | **/\r | |
| 453 | LIST_ENTRY *\r | |
| 454 | EFIAPI\r | |
| 455 | SearchDeviceInfoList (\r | |
| 456 | IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance,\r | |
| 457 | IN UINT16 Port,\r | |
| 458 | IN UINT16 PortMultiplier,\r | |
| 459 | IN EFI_ATA_DEVICE_TYPE DeviceType\r | |
| 460 | );\r | |
| 461 | \r | |
| 462 | /**\r | |
| 463 | Allocate device info data structure to contain device info.\r | |
| 464 | And insert the data structure to the tail of device list for tracing.\r | |
| 465 | \r | |
| 466 | @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.\r | |
| 467 | @param[in] Port The port number of the ATA device to send the command.\r | |
| 468 | @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command.\r | |
| 23a596db | 469 | If there is no port multiplier, then specify 0xFFFF.\r |
| 4b738c76 HT |
470 | @param[in] DeviceType The device type of the ATA device.\r |
| 471 | @param[in] IdentifyData The data buffer to store the output of the IDENTIFY cmd.\r | |
| 472 | \r | |
| 473 | @retval EFI_SUCCESS Successfully insert the ata device to the tail of device list.\r | |
| 474 | @retval EFI_OUT_OF_RESOURCES Can not allocate enough resource for use.\r | |
| 475 | \r | |
| 476 | **/\r | |
| 477 | EFI_STATUS\r | |
| 478 | EFIAPI\r | |
| 479 | CreateNewDeviceInfo (\r | |
| 480 | IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance,\r | |
| 481 | IN UINT16 Port,\r | |
| 482 | IN UINT16 PortMultiplier,\r | |
| 483 | IN EFI_ATA_DEVICE_TYPE DeviceType,\r | |
| 484 | IN EFI_IDENTIFY_DATA *IdentifyData\r | |
| 485 | );\r | |
| 486 | \r | |
| 487 | /**\r | |
| 488 | Destroy all attached ATA devices info.\r | |
| 489 | \r | |
| 490 | @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.\r | |
| 491 | \r | |
| 492 | **/\r | |
| 493 | VOID\r | |
| 494 | EFIAPI\r | |
| 495 | DestroyDeviceInfoList (\r | |
| 496 | IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance\r | |
| 497 | );\r | |
| 498 | \r | |
| 499 | /**\r | |
| 500 | Destroy all pending non blocking tasks.\r | |
| 501 | \r | |
| 502 | @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.\r | |
| 503 | @param[in] IsSigEvent Indicate whether signal the task event when remove the\r | |
| 504 | task.\r | |
| 505 | \r | |
| 506 | **/\r | |
| 507 | VOID\r | |
| 508 | EFIAPI\r | |
| 509 | DestroyAsynTaskList (\r | |
| 510 | IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance,\r | |
| 511 | IN BOOLEAN IsSigEvent\r | |
| 512 | );\r | |
| 513 | \r | |
| 514 | /**\r | |
| 515 | Enumerate all attached ATA devices at IDE mode or AHCI mode separately.\r | |
| 516 | \r | |
| 517 | The function is designed to enumerate all attached ATA devices.\r | |
| 518 | \r | |
| 519 | @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.\r | |
| 520 | \r | |
| 521 | @retval EFI_SUCCESS Successfully enumerate attached ATA devices.\r | |
| 522 | @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.\r | |
| 523 | \r | |
| 524 | **/\r | |
| 525 | EFI_STATUS\r | |
| 526 | EFIAPI\r | |
| 527 | EnumerateAttachedDevice (\r | |
| 528 | IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance\r | |
| 529 | );\r | |
| 530 | \r | |
| 531 | /**\r | |
| 532 | Call back funtion when the timer event is signaled.\r | |
| 533 | \r | |
| 534 | @param[in] Event The Event this notify function registered to.\r | |
| 535 | @param[in] Context Pointer to the context data registered to the\r | |
| 536 | Event.\r | |
| 537 | \r | |
| 538 | **/\r | |
| 539 | VOID\r | |
| 540 | EFIAPI\r | |
| 541 | AsyncNonBlockingTransferRoutine (\r | |
| 542 | EFI_EVENT Event,\r | |
| 543 | VOID* Context\r | |
| 544 | );\r | |
| 545 | \r | |
| 546 | /**\r | |
| 547 | Sends an ATA command to an ATA device that is attached to the ATA controller. This function\r | |
| 548 | supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required,\r | |
| 549 | and the non-blocking I/O functionality is optional.\r | |
| 550 | \r | |
| 551 | @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r | |
| 552 | @param[in] Port The port number of the ATA device to send the command.\r | |
| 553 | @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command.\r | |
| 23a596db | 554 | If there is no port multiplier, then specify 0xFFFF.\r |
| 4b738c76 HT |
555 | @param[in, out] Packet A pointer to the ATA command to send to the ATA device specified by Port\r |
| 556 | and PortMultiplierPort.\r | |
| 557 | @param[in] Event If non-blocking I/O is not supported then Event is ignored, and blocking\r | |
| 558 | I/O is performed. If Event is NULL, then blocking I/O is performed. If\r | |
| 559 | Event is not NULL and non blocking I/O is supported, then non-blocking\r | |
| 560 | I/O is performed, and Event will be signaled when the ATA command completes.\r | |
| 561 | \r | |
| 562 | @retval EFI_SUCCESS The ATA command was sent by the host. For bi-directional commands,\r | |
| 563 | InTransferLength bytes were transferred from InDataBuffer. For write and\r | |
| 564 | bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.\r | |
| 565 | @retval EFI_BAD_BUFFER_SIZE The ATA command was not executed. The number of bytes that could be transferred\r | |
| 566 | is returned in InTransferLength. For write and bi-directional commands,\r | |
| 567 | OutTransferLength bytes were transferred by OutDataBuffer.\r | |
| 568 | @retval EFI_NOT_READY The ATA command could not be sent because there are too many ATA commands\r | |
| 569 | already queued. The caller may retry again later.\r | |
| 570 | @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the ATA command.\r | |
| 571 | @retval EFI_INVALID_PARAMETER Port, PortMultiplierPort, or the contents of Acb are invalid. The ATA\r | |
| 572 | command was not sent, so no additional status information is available.\r | |
| 573 | \r | |
| 574 | **/\r | |
| 575 | EFI_STATUS\r | |
| 576 | EFIAPI\r | |
| 577 | AtaPassThruPassThru (\r | |
| 578 | IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r | |
| 579 | IN UINT16 Port,\r | |
| 580 | IN UINT16 PortMultiplierPort,\r | |
| 581 | IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet,\r | |
| 582 | IN EFI_EVENT Event OPTIONAL\r | |
| 583 | );\r | |
| 584 | \r | |
| 585 | /**\r | |
| 586 | Used to retrieve the list of legal port numbers for ATA devices on an ATA controller.\r | |
| 587 | These can either be the list of ports where ATA devices are actually present or the\r | |
| 588 | list of legal port numbers for the ATA controller. Regardless, the caller of this\r | |
| 589 | function must probe the port number returned to see if an ATA device is actually\r | |
| 590 | present at that location on the ATA controller.\r | |
| 591 | \r | |
| 592 | The GetNextPort() function retrieves the port number on an ATA controller. If on input\r | |
| 593 | Port is 0xFFFF, then the port number of the first port on the ATA controller is returned\r | |
| 594 | in Port and EFI_SUCCESS is returned.\r | |
| 595 | \r | |
| 596 | If Port is a port number that was returned on a previous call to GetNextPort(), then the\r | |
| 597 | port number of the next port on the ATA controller is returned in Port, and EFI_SUCCESS\r | |
| 598 | is returned. If Port is not 0xFFFF and Port was not returned on a previous call to\r | |
| 599 | GetNextPort(), then EFI_INVALID_PARAMETER is returned.\r | |
| 600 | \r | |
| 601 | If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is\r | |
| 602 | returned.\r | |
| 603 | \r | |
| 604 | @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r | |
| 605 | @param[in, out] Port On input, a pointer to the port number on the ATA controller.\r | |
| 606 | On output, a pointer to the next port number on the ATA\r | |
| 607 | controller. An input value of 0xFFFF retrieves the first port\r | |
| 608 | number on the ATA controller.\r | |
| 609 | \r | |
| 610 | @retval EFI_SUCCESS The next port number on the ATA controller was returned in Port.\r | |
| 611 | @retval EFI_NOT_FOUND There are no more ports on this ATA controller.\r | |
| 612 | @retval EFI_INVALID_PARAMETER Port is not 0xFFFF and Port was not returned on a previous call\r | |
| 613 | to GetNextPort().\r | |
| 614 | \r | |
| 615 | **/\r | |
| 616 | EFI_STATUS\r | |
| 617 | EFIAPI\r | |
| 618 | AtaPassThruGetNextPort (\r | |
| 619 | IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r | |
| 620 | IN OUT UINT16 *Port\r | |
| 621 | );\r | |
| 622 | \r | |
| 623 | /**\r | |
| 624 | Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA\r | |
| 625 | controller. These can either be the list of port multiplier ports where ATA devices are actually\r | |
| 626 | present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this\r | |
| 627 | function must probe the port number and port multiplier port number returned to see if an ATA\r | |
| 628 | device is actually present.\r | |
| 629 | \r | |
| 630 | The GetNextDevice() function retrieves the port multiplier port number of an ATA device\r | |
| 631 | present on a port of an ATA controller.\r | |
| 632 | \r | |
| 633 | If PortMultiplierPort points to a port multiplier port number value that was returned on a\r | |
| 634 | previous call to GetNextDevice(), then the port multiplier port number of the next ATA device\r | |
| 635 | on the port of the ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is\r | |
| 636 | returned.\r | |
| 637 | \r | |
| 638 | If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first\r | |
| 639 | ATA device on port of the ATA controller is returned in PortMultiplierPort and\r | |
| 640 | EFI_SUCCESS is returned.\r | |
| 641 | \r | |
| 642 | If PortMultiplierPort is not 0xFFFF and the value pointed to by PortMultiplierPort\r | |
| 643 | was not returned on a previous call to GetNextDevice(), then EFI_INVALID_PARAMETER\r | |
| 644 | is returned.\r | |
| 645 | \r | |
| 646 | If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of\r | |
| 647 | the ATA controller, then EFI_NOT_FOUND is returned.\r | |
| 648 | \r | |
| 649 | @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r | |
| 650 | @param[in] Port The port number present on the ATA controller.\r | |
| 651 | @param[in, out] PortMultiplierPort On input, a pointer to the port multiplier port number of an\r | |
| 652 | ATA device present on the ATA controller.\r | |
| 653 | If on input a PortMultiplierPort of 0xFFFF is specified,\r | |
| 654 | then the port multiplier port number of the first ATA device\r | |
| 655 | is returned. On output, a pointer to the port multiplier port\r | |
| 656 | number of the next ATA device present on an ATA controller.\r | |
| 657 | \r | |
| 658 | @retval EFI_SUCCESS The port multiplier port number of the next ATA device on the port\r | |
| 659 | of the ATA controller was returned in PortMultiplierPort.\r | |
| 660 | @retval EFI_NOT_FOUND There are no more ATA devices on this port of the ATA controller.\r | |
| 661 | @retval EFI_INVALID_PARAMETER PortMultiplierPort is not 0xFFFF, and PortMultiplierPort was not\r | |
| 662 | returned on a previous call to GetNextDevice().\r | |
| 663 | \r | |
| 664 | **/\r | |
| 665 | EFI_STATUS\r | |
| 666 | EFIAPI\r | |
| 667 | AtaPassThruGetNextDevice (\r | |
| 668 | IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r | |
| 669 | IN UINT16 Port,\r | |
| 670 | IN OUT UINT16 *PortMultiplierPort\r | |
| 671 | );\r | |
| 672 | \r | |
| 673 | /**\r | |
| 674 | Used to allocate and build a device path node for an ATA device on an ATA controller.\r | |
| 675 | \r | |
| 676 | The BuildDevicePath() function allocates and builds a single device node for the ATA\r | |
| 677 | device specified by Port and PortMultiplierPort. If the ATA device specified by Port and\r | |
| 678 | PortMultiplierPort is not present on the ATA controller, then EFI_NOT_FOUND is returned.\r | |
| 679 | If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned. If there are not enough\r | |
| 680 | resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned.\r | |
| 681 | \r | |
| 682 | Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of\r | |
| 683 | DevicePath are initialized to describe the ATA device specified by Port and PortMultiplierPort,\r | |
| 684 | and EFI_SUCCESS is returned.\r | |
| 685 | \r | |
| 686 | @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r | |
| 687 | @param[in] Port Port specifies the port number of the ATA device for which a\r | |
| 688 | device path node is to be allocated and built.\r | |
| 689 | @param[in] PortMultiplierPort The port multiplier port number of the ATA device for which a\r | |
| 690 | device path node is to be allocated and built. If there is no\r | |
| 23a596db | 691 | port multiplier, then specify 0xFFFF.\r |
| 4b738c76 HT |
692 | @param[in, out] DevicePath A pointer to a single device path node that describes the ATA\r |
| 693 | device specified by Port and PortMultiplierPort. This function\r | |
| 694 | is responsible for allocating the buffer DevicePath with the\r | |
| 695 | boot service AllocatePool(). It is the caller's responsibility\r | |
| 696 | to free DevicePath when the caller is finished with DevicePath.\r | |
| 697 | @retval EFI_SUCCESS The device path node that describes the ATA device specified by\r | |
| 698 | Port and PortMultiplierPort was allocated and returned in DevicePath.\r | |
| 699 | @retval EFI_NOT_FOUND The ATA device specified by Port and PortMultiplierPort does not\r | |
| 700 | exist on the ATA controller.\r | |
| 701 | @retval EFI_INVALID_PARAMETER DevicePath is NULL.\r | |
| 702 | @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.\r | |
| 703 | \r | |
| 704 | **/\r | |
| 705 | EFI_STATUS\r | |
| 706 | EFIAPI\r | |
| 707 | AtaPassThruBuildDevicePath (\r | |
| 708 | IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r | |
| 709 | IN UINT16 Port,\r | |
| 710 | IN UINT16 PortMultiplierPort,\r | |
| 711 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r | |
| 712 | );\r | |
| 713 | \r | |
| 714 | /**\r | |
| 715 | Used to translate a device path node to a port number and port multiplier port number.\r | |
| 716 | \r | |
| 717 | The GetDevice() function determines the port and port multiplier port number associated with\r | |
| 718 | the ATA device described by DevicePath. If DevicePath is a device path node type that the\r | |
| 719 | ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents\r | |
| 720 | DevicePath into a port number and port multiplier port number.\r | |
| 721 | \r | |
| 722 | If this translation is successful, then that port number and port multiplier port number are returned\r | |
| 723 | in Port and PortMultiplierPort, and EFI_SUCCESS is returned.\r | |
| 724 | \r | |
| 725 | If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned.\r | |
| 726 | \r | |
| 727 | If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then\r | |
| 728 | EFI_UNSUPPORTED is returned.\r | |
| 729 | \r | |
| 730 | If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not\r | |
| 731 | a valid translation from DevicePath to a port number and port multiplier port number, then\r | |
| 732 | EFI_NOT_FOUND is returned.\r | |
| 733 | \r | |
| 734 | @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r | |
| 735 | @param[in] DevicePath A pointer to the device path node that describes an ATA device on the\r | |
| 736 | ATA controller.\r | |
| 737 | @param[out] Port On return, points to the port number of an ATA device on the ATA controller.\r | |
| 738 | @param[out] PortMultiplierPort On return, points to the port multiplier port number of an ATA device\r | |
| 739 | on the ATA controller.\r | |
| 740 | \r | |
| 741 | @retval EFI_SUCCESS DevicePath was successfully translated to a port number and port multiplier\r | |
| 742 | port number, and they were returned in Port and PortMultiplierPort.\r | |
| 743 | @retval EFI_INVALID_PARAMETER DevicePath is NULL.\r | |
| 744 | @retval EFI_INVALID_PARAMETER Port is NULL.\r | |
| 745 | @retval EFI_INVALID_PARAMETER PortMultiplierPort is NULL.\r | |
| 746 | @retval EFI_UNSUPPORTED This driver does not support the device path node type in DevicePath.\r | |
| 747 | @retval EFI_NOT_FOUND A valid translation from DevicePath to a port number and port multiplier\r | |
| 748 | port number does not exist.\r | |
| 749 | \r | |
| 750 | **/\r | |
| 751 | EFI_STATUS\r | |
| 752 | EFIAPI\r | |
| 753 | AtaPassThruGetDevice (\r | |
| 754 | IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r | |
| 755 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
| 756 | OUT UINT16 *Port,\r | |
| 757 | OUT UINT16 *PortMultiplierPort\r | |
| 758 | );\r | |
| 759 | \r | |
| 760 | /**\r | |
| 761 | Resets a specific port on the ATA controller. This operation also resets all the ATA devices\r | |
| 762 | connected to the port.\r | |
| 763 | \r | |
| 764 | The ResetChannel() function resets an a specific port on an ATA controller. This operation\r | |
| 765 | resets all the ATA devices connected to that port. If this ATA controller does not support\r | |
| 766 | a reset port operation, then EFI_UNSUPPORTED is returned.\r | |
| 767 | \r | |
| 768 | If a device error occurs while executing that port reset operation, then EFI_DEVICE_ERROR is\r | |
| 769 | returned.\r | |
| 770 | \r | |
| 771 | If a timeout occurs during the execution of the port reset operation, then EFI_TIMEOUT is returned.\r | |
| 772 | \r | |
| 773 | If the port reset operation is completed, then EFI_SUCCESS is returned.\r | |
| 774 | \r | |
| 775 | @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r | |
| 776 | @param[in] Port The port number on the ATA controller.\r | |
| 777 | \r | |
| 778 | @retval EFI_SUCCESS The ATA controller port was reset.\r | |
| 779 | @retval EFI_UNSUPPORTED The ATA controller does not support a port reset operation.\r | |
| 780 | @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA port.\r | |
| 781 | @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA port.\r | |
| 782 | \r | |
| 783 | **/\r | |
| 784 | EFI_STATUS\r | |
| 785 | EFIAPI\r | |
| 786 | AtaPassThruResetPort (\r | |
| 787 | IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r | |
| 788 | IN UINT16 Port\r | |
| 789 | );\r | |
| 790 | \r | |
| 791 | /**\r | |
| 792 | Resets an ATA device that is connected to an ATA controller.\r | |
| 793 | \r | |
| 794 | The ResetDevice() function resets the ATA device specified by Port and PortMultiplierPort.\r | |
| 795 | If this ATA controller does not support a device reset operation, then EFI_UNSUPPORTED is\r | |
| 796 | returned.\r | |
| 797 | \r | |
| 798 | If Port or PortMultiplierPort are not in a valid range for this ATA controller, then\r | |
| 799 | EFI_INVALID_PARAMETER is returned.\r | |
| 800 | \r | |
| 801 | If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR\r | |
| 802 | is returned.\r | |
| 803 | \r | |
| 804 | If a timeout occurs during the execution of the device reset operation, then EFI_TIMEOUT is\r | |
| 805 | returned.\r | |
| 806 | \r | |
| 807 | If the device reset operation is completed, then EFI_SUCCESS is returned.\r | |
| 808 | \r | |
| 809 | @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r | |
| 810 | @param[in] Port Port represents the port number of the ATA device to be reset.\r | |
| 811 | @param[in] PortMultiplierPort The port multiplier port number of the ATA device to reset.\r | |
| 23a596db | 812 | If there is no port multiplier, then specify 0xFFFF.\r |
| 4b738c76 HT |
813 | @retval EFI_SUCCESS The ATA device specified by Port and PortMultiplierPort was reset.\r |
| 814 | @retval EFI_UNSUPPORTED The ATA controller does not support a device reset operation.\r | |
| 815 | @retval EFI_INVALID_PARAMETER Port or PortMultiplierPort are invalid.\r | |
| 816 | @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA device\r | |
| 817 | specified by Port and PortMultiplierPort.\r | |
| 818 | @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA device\r | |
| 819 | specified by Port and PortMultiplierPort.\r | |
| 820 | \r | |
| 821 | **/\r | |
| 822 | EFI_STATUS\r | |
| 823 | EFIAPI\r | |
| 824 | AtaPassThruResetDevice (\r | |
| 825 | IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r | |
| 826 | IN UINT16 Port,\r | |
| 827 | IN UINT16 PortMultiplierPort\r | |
| 828 | );\r | |
| 829 | \r | |
| 830 | /**\r | |
| 831 | Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function\r | |
| 832 | supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the\r | |
| 833 | nonblocking I/O functionality is optional.\r | |
| 834 | \r | |
| 835 | @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r | |
| 836 | @param Target The Target is an array of size TARGET_MAX_BYTES and it represents\r | |
| 837 | the id of the SCSI device to send the SCSI Request Packet. Each\r | |
| 838 | transport driver may choose to utilize a subset of this size to suit the needs\r | |
| 839 | of transport target representation. For example, a Fibre Channel driver\r | |
| 840 | may use only 8 bytes (WWN) to represent an FC target.\r | |
| 841 | @param Lun The LUN of the SCSI device to send the SCSI Request Packet.\r | |
| 842 | @param Packet A pointer to the SCSI Request Packet to send to the SCSI device\r | |
| 843 | specified by Target and Lun.\r | |
| 844 | @param Event If nonblocking I/O is not supported then Event is ignored, and blocking\r | |
| 845 | I/O is performed. If Event is NULL, then blocking I/O is performed. If\r | |
| 846 | Event is not NULL and non blocking I/O is supported, then\r | |
| 847 | nonblocking I/O is performed, and Event will be signaled when the\r | |
| 848 | SCSI Request Packet completes.\r | |
| 849 | \r | |
| 850 | @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional\r | |
| 851 | commands, InTransferLength bytes were transferred from\r | |
| 852 | InDataBuffer. For write and bi-directional commands,\r | |
| 853 | OutTransferLength bytes were transferred by\r | |
| 854 | OutDataBuffer.\r | |
| 855 | @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was not executed. The number of bytes that\r | |
| 856 | could be transferred is returned in InTransferLength. For write\r | |
| 857 | and bi-directional commands, OutTransferLength bytes were\r | |
| 858 | transferred by OutDataBuffer.\r | |
| 859 | @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many\r | |
| 860 | SCSI Request Packets already queued. The caller may retry again later.\r | |
| 861 | @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request\r | |
| 862 | Packet.\r | |
| 863 | @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket are invalid.\r | |
| 864 | @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported\r | |
| 865 | by the host adapter. This includes the case of Bi-directional SCSI\r | |
| 866 | commands not supported by the implementation. The SCSI Request\r | |
| 867 | Packet was not sent, so no additional status information is available.\r | |
| 868 | @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.\r | |
| 869 | \r | |
| 870 | **/\r | |
| 871 | EFI_STATUS\r | |
| 872 | EFIAPI\r | |
| 873 | ExtScsiPassThruPassThru (\r | |
| 874 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
| 875 | IN UINT8 *Target,\r | |
| 876 | IN UINT64 Lun,\r | |
| 877 | IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r | |
| 878 | IN EFI_EVENT Event OPTIONAL\r | |
| 879 | );\r | |
| 880 | \r | |
| 881 | /**\r | |
| 882 | Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These\r | |
| 883 | can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal\r | |
| 884 | Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the\r | |
| 885 | Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI\r | |
| 886 | channel.\r | |
| 887 | \r | |
| 888 | @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r | |
| 889 | @param Target On input, a pointer to the Target ID (an array of size\r | |
| 890 | TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.\r | |
| 891 | On output, a pointer to the Target ID (an array of\r | |
| 892 | TARGET_MAX_BYTES) of the next SCSI device present on a SCSI\r | |
| 893 | channel. An input value of 0xF(all bytes in the array are 0xF) in the\r | |
| 894 | Target array retrieves the Target ID of the first SCSI device present on a\r | |
| 895 | SCSI channel.\r | |
| 896 | @param Lun On input, a pointer to the LUN of a SCSI device present on the SCSI\r | |
| 897 | channel. On output, a pointer to the LUN of the next SCSI device present\r | |
| 898 | on a SCSI channel.\r | |
| 899 | \r | |
| 900 | @retval EFI_SUCCESS The Target ID and LUN of the next SCSI device on the SCSI\r | |
| 901 | channel was returned in Target and Lun.\r | |
| 902 | @retval EFI_INVALID_PARAMETER Target array is not all 0xF, and Target and Lun were\r | |
| 903 | not returned on a previous call to GetNextTargetLun().\r | |
| 904 | @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.\r | |
| 905 | \r | |
| 906 | **/\r | |
| 907 | EFI_STATUS\r | |
| 908 | EFIAPI\r | |
| 909 | ExtScsiPassThruGetNextTargetLun (\r | |
| 910 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
| 911 | IN OUT UINT8 **Target,\r | |
| 912 | IN OUT UINT64 *Lun\r | |
| 913 | );\r | |
| 914 | \r | |
| 915 | /**\r | |
| 916 | Used to allocate and build a device path node for a SCSI device on a SCSI channel.\r | |
| 917 | \r | |
| 918 | @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r | |
| 919 | @param Target The Target is an array of size TARGET_MAX_BYTES and it specifies the\r | |
| 920 | Target ID of the SCSI device for which a device path node is to be\r | |
| 921 | allocated and built. Transport drivers may chose to utilize a subset of\r | |
| 922 | this size to suit the representation of targets. For example, a Fibre\r | |
| 923 | Channel driver may use only 8 bytes (WWN) in the array to represent a\r | |
| 924 | FC target.\r | |
| 925 | @param Lun The LUN of the SCSI device for which a device path node is to be\r | |
| 926 | allocated and built.\r | |
| 927 | @param DevicePath A pointer to a single device path node that describes the SCSI device\r | |
| 928 | specified by Target and Lun. This function is responsible for\r | |
| 929 | allocating the buffer DevicePath with the boot service\r | |
| 930 | AllocatePool(). It is the caller's responsibility to free\r | |
| 931 | DevicePath when the caller is finished with DevicePath.\r | |
| 932 | \r | |
| 933 | @retval EFI_SUCCESS The device path node that describes the SCSI device specified by\r | |
| 934 | Target and Lun was allocated and returned in\r | |
| 935 | DevicePath.\r | |
| 936 | @retval EFI_INVALID_PARAMETER DevicePath is NULL.\r | |
| 937 | @retval EFI_NOT_FOUND The SCSI devices specified by Target and Lun does not exist\r | |
| 938 | on the SCSI channel.\r | |
| 939 | @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.\r | |
| 940 | \r | |
| 941 | **/\r | |
| 942 | EFI_STATUS\r | |
| 943 | EFIAPI\r | |
| 944 | ExtScsiPassThruBuildDevicePath (\r | |
| 945 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
| 946 | IN UINT8 *Target,\r | |
| 947 | IN UINT64 Lun,\r | |
| 948 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r | |
| 949 | );\r | |
| 950 | \r | |
| 951 | /**\r | |
| 952 | Used to translate a device path node to a Target ID and LUN.\r | |
| 953 | \r | |
| 954 | @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r | |
| 955 | @param DevicePath A pointer to a single device path node that describes the SCSI device\r | |
| 956 | on the SCSI channel.\r | |
| 957 | @param Target A pointer to the Target Array which represents the ID of a SCSI device\r | |
| 958 | on the SCSI channel.\r | |
| 959 | @param Lun A pointer to the LUN of a SCSI device on the SCSI channel.\r | |
| 960 | \r | |
| 961 | @retval EFI_SUCCESS DevicePath was successfully translated to a Target ID and\r | |
| 962 | LUN, and they were returned in Target and Lun.\r | |
| 963 | @retval EFI_INVALID_PARAMETER DevicePath or Target or Lun is NULL.\r | |
| 964 | @retval EFI_NOT_FOUND A valid translation from DevicePath to a Target ID and LUN\r | |
| 965 | does not exist.\r | |
| 966 | @retval EFI_UNSUPPORTED This driver does not support the device path node type in\r | |
| 967 | DevicePath.\r | |
| 968 | \r | |
| 969 | **/\r | |
| 970 | EFI_STATUS\r | |
| 971 | EFIAPI\r | |
| 972 | ExtScsiPassThruGetTargetLun (\r | |
| 973 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
| 974 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
| 975 | OUT UINT8 **Target,\r | |
| 976 | OUT UINT64 *Lun\r | |
| 977 | );\r | |
| 978 | \r | |
| 979 | /**\r | |
| 980 | Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.\r | |
| 981 | \r | |
| 982 | @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r | |
| 983 | \r | |
| 984 | @retval EFI_SUCCESS The SCSI channel was reset.\r | |
| 985 | @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI channel.\r | |
| 986 | @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI channel.\r | |
| 987 | @retval EFI_UNSUPPORTED The SCSI channel does not support a channel reset operation.\r | |
| 988 | \r | |
| 989 | **/\r | |
| 990 | EFI_STATUS\r | |
| 991 | EFIAPI\r | |
| 992 | ExtScsiPassThruResetChannel (\r | |
| 993 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This\r | |
| 994 | );\r | |
| 995 | \r | |
| 996 | /**\r | |
| 997 | Resets a SCSI logical unit that is connected to a SCSI channel.\r | |
| 998 | \r | |
| 999 | @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r | |
| 1000 | @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the\r | |
| 1001 | target port ID of the SCSI device containing the SCSI logical unit to\r | |
| 1002 | reset. Transport drivers may chose to utilize a subset of this array to suit\r | |
| 1003 | the representation of their targets.\r | |
| 1004 | @param Lun The LUN of the SCSI device to reset.\r | |
| 1005 | \r | |
| 1006 | @retval EFI_SUCCESS The SCSI device specified by Target and Lun was reset.\r | |
| 1007 | @retval EFI_INVALID_PARAMETER Target or Lun is NULL.\r | |
| 1008 | @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI device\r | |
| 1009 | specified by Target and Lun.\r | |
| 1010 | @retval EFI_UNSUPPORTED The SCSI channel does not support a target reset operation.\r | |
| 1011 | @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI device\r | |
| 1012 | specified by Target and Lun.\r | |
| 1013 | \r | |
| 1014 | **/\r | |
| 1015 | EFI_STATUS\r | |
| 1016 | EFIAPI\r | |
| 1017 | ExtScsiPassThruResetTargetLun (\r | |
| 1018 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
| 1019 | IN UINT8 *Target,\r | |
| 1020 | IN UINT64 Lun\r | |
| 1021 | );\r | |
| 1022 | \r | |
| 1023 | /**\r | |
| 1024 | Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either\r | |
| 1025 | be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs\r | |
| 1026 | for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to\r | |
| 1027 | see if a SCSI device is actually present at that location on the SCSI channel.\r | |
| 1028 | \r | |
| 1029 | @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r | |
| 1030 | @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel.\r | |
| 1031 | On output, a pointer to the Target ID (an array of\r | |
| 1032 | TARGET_MAX_BYTES) of the next SCSI device present on a SCSI\r | |
| 1033 | channel. An input value of 0xF(all bytes in the array are 0xF) in the\r | |
| 1034 | Target array retrieves the Target ID of the first SCSI device present on a\r | |
| 1035 | SCSI channel.\r | |
| 1036 | \r | |
| 1037 | @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI\r | |
| 1038 | channel was returned in Target.\r | |
| 1039 | @retval EFI_INVALID_PARAMETER Target or Lun is NULL.\r | |
| 1040 | @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not\r | |
| 1041 | returned on a previous call to GetNextTarget().\r | |
| 1042 | @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.\r | |
| 1043 | \r | |
| 1044 | **/\r | |
| 1045 | EFI_STATUS\r | |
| 1046 | EFIAPI\r | |
| 1047 | ExtScsiPassThruGetNextTarget (\r | |
| 1048 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
| 1049 | IN OUT UINT8 **Target\r | |
| 1050 | );\r | |
| 1051 | \r | |
| 1052 | /**\r | |
| 1053 | Initialize ATA host controller at IDE mode.\r | |
| 1054 | \r | |
| 1055 | The function is designed to initialize ATA host controller.\r | |
| 1056 | \r | |
| 1057 | @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.\r | |
| 1058 | \r | |
| 1059 | **/\r | |
| 1060 | EFI_STATUS\r | |
| 1061 | EFIAPI\r | |
| 1062 | IdeModeInitialization (\r | |
| 1063 | IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance\r | |
| 1064 | );\r | |
| 1065 | \r | |
| 1066 | /**\r | |
| 1067 | Initialize ATA host controller at AHCI mode.\r | |
| 1068 | \r | |
| 1069 | The function is designed to initialize ATA host controller.\r | |
| 1070 | \r | |
| 1071 | @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.\r | |
| 1072 | \r | |
| 1073 | **/\r | |
| 1074 | EFI_STATUS\r | |
| 1075 | EFIAPI\r | |
| 1076 | AhciModeInitialization (\r | |
| 1077 | IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance\r | |
| 1078 | );\r | |
| 1079 | \r | |
| 1080 | /**\r | |
| 1081 | Start a non data transfer on specific port.\r | |
| 1082 | \r | |
| 1083 | @param[in] PciIo The PCI IO protocol instance.\r | |
| 1084 | @param[in] AhciRegisters The pointer to the EFI_AHCI_REGISTERS.\r | |
| 1085 | @param[in] Port The number of port.\r | |
| 1086 | @param[in] PortMultiplier The timeout value of stop.\r | |
| 1087 | @param[in] AtapiCommand The atapi command will be used for the\r | |
| 1088 | transfer.\r | |
| 1089 | @param[in] AtapiCommandLength The length of the atapi command.\r | |
| 1090 | @param[in] AtaCommandBlock The EFI_ATA_COMMAND_BLOCK data.\r | |
| 1091 | @param[in, out] AtaStatusBlock The EFI_ATA_STATUS_BLOCK data.\r | |
| 1092 | @param[in] Timeout The timeout value of non data transfer, uses 100ns as a unit.\r | |
| 1093 | @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK\r | |
| 1094 | used by non-blocking mode.\r | |
| 1095 | \r | |
| 1096 | @retval EFI_DEVICE_ERROR The non data transfer abort with error occurs.\r | |
| 1097 | @retval EFI_TIMEOUT The operation is time out.\r | |
| 1098 | @retval EFI_UNSUPPORTED The device is not ready for transfer.\r | |
| 1099 | @retval EFI_SUCCESS The non data transfer executes successfully.\r | |
| 1100 | \r | |
| 1101 | **/\r | |
| 1102 | EFI_STATUS\r | |
| 1103 | EFIAPI\r | |
| 1104 | AhciNonDataTransfer (\r | |
| 1105 | IN EFI_PCI_IO_PROTOCOL *PciIo,\r | |
| 1106 | IN EFI_AHCI_REGISTERS *AhciRegisters,\r | |
| 1107 | IN UINT8 Port,\r | |
| 1108 | IN UINT8 PortMultiplier,\r | |
| 1109 | IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand OPTIONAL,\r | |
| 1110 | IN UINT8 AtapiCommandLength,\r | |
| 1111 | IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock,\r | |
| 1112 | IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock,\r | |
| 1113 | IN UINT64 Timeout,\r | |
| 1114 | IN ATA_NONBLOCK_TASK *Task\r | |
| 1115 | );\r | |
| 1116 | \r | |
| 1117 | /**\r | |
| 1118 | Start a DMA data transfer on specific port\r | |
| 1119 | \r | |
| 1120 | @param[in] Instance The ATA_ATAPI_PASS_THRU_INSTANCE protocol instance.\r | |
| 1121 | @param[in] AhciRegisters The pointer to the EFI_AHCI_REGISTERS.\r | |
| 1122 | @param[in] Port The number of port.\r | |
| 1123 | @param[in] PortMultiplier The timeout value of stop.\r | |
| 1124 | @param[in] AtapiCommand The atapi command will be used for the\r | |
| 1125 | transfer.\r | |
| 1126 | @param[in] AtapiCommandLength The length of the atapi command.\r | |
| 1127 | @param[in] Read The transfer direction.\r | |
| 1128 | @param[in] AtaCommandBlock The EFI_ATA_COMMAND_BLOCK data.\r | |
| 1129 | @param[in, out] AtaStatusBlock The EFI_ATA_STATUS_BLOCK data.\r | |
| 1130 | @param[in, out] MemoryAddr The pointer to the data buffer.\r | |
| 1131 | @param[in] DataCount The data count to be transferred.\r | |
| 1132 | @param[in] Timeout The timeout value of non data transfer, uses 100ns as a unit.\r | |
| 1133 | @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK\r | |
| 1134 | used by non-blocking mode.\r | |
| 1135 | \r | |
| 1136 | @retval EFI_DEVICE_ERROR The DMA data transfer abort with error occurs.\r | |
| 1137 | @retval EFI_TIMEOUT The operation is time out.\r | |
| 1138 | @retval EFI_UNSUPPORTED The device is not ready for transfer.\r | |
| 1139 | @retval EFI_SUCCESS The DMA data transfer executes successfully.\r | |
| 1140 | \r | |
| 1141 | **/\r | |
| 1142 | EFI_STATUS\r | |
| 1143 | EFIAPI\r | |
| 1144 | AhciDmaTransfer (\r | |
| 1145 | IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance,\r | |
| 1146 | IN EFI_AHCI_REGISTERS *AhciRegisters,\r | |
| 1147 | IN UINT8 Port,\r | |
| 1148 | IN UINT8 PortMultiplier,\r | |
| 1149 | IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand OPTIONAL,\r | |
| 1150 | IN UINT8 AtapiCommandLength,\r | |
| 1151 | IN BOOLEAN Read,\r | |
| 1152 | IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock,\r | |
| 1153 | IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock,\r | |
| 1154 | IN OUT VOID *MemoryAddr,\r | |
| 1155 | IN UINT32 DataCount,\r | |
| 1156 | IN UINT64 Timeout,\r | |
| 1157 | IN ATA_NONBLOCK_TASK *Task\r | |
| 1158 | );\r | |
| 1159 | \r | |
| 1160 | /**\r | |
| 1161 | Start a PIO data transfer on specific port.\r | |
| 1162 | \r | |
| 1163 | @param[in] PciIo The PCI IO protocol instance.\r | |
| 1164 | @param[in] AhciRegisters The pointer to the EFI_AHCI_REGISTERS.\r | |
| 1165 | @param[in] Port The number of port.\r | |
| 1166 | @param[in] PortMultiplier The timeout value of stop.\r | |
| 1167 | @param[in] AtapiCommand The atapi command will be used for the\r | |
| 1168 | transfer.\r | |
| 1169 | @param[in] AtapiCommandLength The length of the atapi command.\r | |
| 1170 | @param[in] Read The transfer direction.\r | |
| 1171 | @param[in] AtaCommandBlock The EFI_ATA_COMMAND_BLOCK data.\r | |
| 1172 | @param[in, out] AtaStatusBlock The EFI_ATA_STATUS_BLOCK data.\r | |
| 1173 | @param[in, out] MemoryAddr The pointer to the data buffer.\r | |
| 1174 | @param[in] DataCount The data count to be transferred.\r | |
| 1175 | @param[in] Timeout The timeout value of non data transfer, uses 100ns as a unit.\r | |
| 1176 | @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK\r | |
| 1177 | used by non-blocking mode.\r | |
| 1178 | \r | |
| 1179 | @retval EFI_DEVICE_ERROR The PIO data transfer abort with error occurs.\r | |
| 1180 | @retval EFI_TIMEOUT The operation is time out.\r | |
| 1181 | @retval EFI_UNSUPPORTED The device is not ready for transfer.\r | |
| 1182 | @retval EFI_SUCCESS The PIO data transfer executes successfully.\r | |
| 1183 | \r | |
| 1184 | **/\r | |
| 1185 | EFI_STATUS\r | |
| 1186 | EFIAPI\r | |
| 1187 | AhciPioTransfer (\r | |
| 1188 | IN EFI_PCI_IO_PROTOCOL *PciIo,\r | |
| 1189 | IN EFI_AHCI_REGISTERS *AhciRegisters,\r | |
| 1190 | IN UINT8 Port,\r | |
| 1191 | IN UINT8 PortMultiplier,\r | |
| 1192 | IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand OPTIONAL,\r | |
| 1193 | IN UINT8 AtapiCommandLength,\r | |
| 1194 | IN BOOLEAN Read,\r | |
| 1195 | IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock,\r | |
| 1196 | IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock,\r | |
| 1197 | IN OUT VOID *MemoryAddr,\r | |
| 1198 | IN UINT32 DataCount,\r | |
| 1199 | IN UINT64 Timeout,\r | |
| 1200 | IN ATA_NONBLOCK_TASK *Task\r | |
| 1201 | );\r | |
| 1202 | \r | |
| 1203 | /**\r | |
| 1204 | Send ATA command into device with NON_DATA protocol\r | |
| 1205 | \r | |
| 1206 | @param[in] PciIo A pointer to ATA_ATAPI_PASS_THRU_INSTANCE\r | |
| 1207 | data structure.\r | |
| 1208 | @param[in] IdeRegisters A pointer to EFI_IDE_REGISTERS data structure.\r | |
| 1209 | @param[in] AtaCommandBlock A pointer to EFI_ATA_COMMAND_BLOCK data\r | |
| 1210 | structure.\r | |
| 1211 | @param[in, out] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure.\r | |
| 1212 | @param[in] Timeout The time to complete the command, uses 100ns as a unit.\r | |
| 1213 | @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK\r | |
| 1214 | used by non-blocking mode.\r | |
| 1215 | \r | |
| 1216 | @retval EFI_SUCCESS Reading succeed\r | |
| 1217 | @retval EFI_ABORTED Command failed\r | |
| 1218 | @retval EFI_DEVICE_ERROR Device status error.\r | |
| 1219 | \r | |
| 1220 | **/\r | |
| 1221 | EFI_STATUS\r | |
| 1222 | EFIAPI\r | |
| 1223 | AtaNonDataCommandIn (\r | |
| 1224 | IN EFI_PCI_IO_PROTOCOL *PciIo,\r | |
| 1225 | IN EFI_IDE_REGISTERS *IdeRegisters,\r | |
| 1226 | IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock,\r | |
| 1227 | IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock,\r | |
| 1228 | IN UINT64 Timeout,\r | |
| 1229 | IN ATA_NONBLOCK_TASK *Task\r | |
| 1230 | );\r | |
| 1231 | \r | |
| 1232 | /**\r | |
| 1233 | Perform an ATA Udma operation (Read, ReadExt, Write, WriteExt).\r | |
| 1234 | \r | |
| 1235 | @param[in] Instance A pointer to ATA_ATAPI_PASS_THRU_INSTANCE data\r | |
| 1236 | structure.\r | |
| 1237 | @param[in] IdeRegisters A pointer to EFI_IDE_REGISTERS data structure.\r | |
| 1238 | @param[in] Read Flag used to determine the data transfer\r | |
| 1239 | direction. Read equals 1, means data transferred\r | |
| 1240 | from device to host;Read equals 0, means data\r | |
| 1241 | transferred from host to device.\r | |
| 1242 | @param[in] DataBuffer A pointer to the source buffer for the data.\r | |
| 1243 | @param[in] DataLength The length of the data.\r | |
| 1244 | @param[in] AtaCommandBlock A pointer to EFI_ATA_COMMAND_BLOCK data structure.\r | |
| 1245 | @param[in, out] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure.\r | |
| 1246 | @param[in] Timeout The time to complete the command, uses 100ns as a unit.\r | |
| 1247 | @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK\r | |
| 1248 | used by non-blocking mode.\r | |
| 1249 | \r | |
| 1250 | @retval EFI_SUCCESS the operation is successful.\r | |
| 1251 | @retval EFI_OUT_OF_RESOURCES Build PRD table failed\r | |
| 1252 | @retval EFI_UNSUPPORTED Unknown channel or operations command\r | |
| 1253 | @retval EFI_DEVICE_ERROR Ata command execute failed\r | |
| 1254 | \r | |
| 1255 | **/\r | |
| 1256 | EFI_STATUS\r | |
| 1257 | EFIAPI\r | |
| 1258 | AtaUdmaInOut (\r | |
| 1259 | IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance,\r | |
| 1260 | IN EFI_IDE_REGISTERS *IdeRegisters,\r | |
| 1261 | IN BOOLEAN Read,\r | |
| 1262 | IN VOID *DataBuffer,\r | |
| 1263 | IN UINT64 DataLength,\r | |
| 1264 | IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock,\r | |
| 1265 | IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock,\r | |
| 1266 | IN UINT64 Timeout,\r | |
| 1267 | IN ATA_NONBLOCK_TASK *Task\r | |
| 1268 | );\r | |
| 1269 | \r | |
| 1270 | /**\r | |
| 1271 | This function is used to send out ATA commands conforms to the PIO Data In Protocol.\r | |
| 1272 | \r | |
| 1273 | @param[in] PciIo A pointer to ATA_ATAPI_PASS_THRU_INSTANCE data\r | |
| 1274 | structure.\r | |
| 1275 | @param[in] IdeRegisters A pointer to EFI_IDE_REGISTERS data structure.\r | |
| 1276 | @param[in, out] Buffer A pointer to the source buffer for the data.\r | |
| 1277 | @param[in] ByteCount The length of the data.\r | |
| 1278 | @param[in] Read Flag used to determine the data transfer direction.\r | |
| 1279 | Read equals 1, means data transferred from device\r | |
| 1280 | to host;Read equals 0, means data transferred\r | |
| 1281 | from host to device.\r | |
| 1282 | @param[in] AtaCommandBlock A pointer to EFI_ATA_COMMAND_BLOCK data structure.\r | |
| 1283 | @param[in, out] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure.\r | |
| 1284 | @param[in] Timeout The time to complete the command, uses 100ns as a unit.\r | |
| 1285 | @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK\r | |
| 1286 | used by non-blocking mode.\r | |
| 1287 | \r | |
| 1288 | @retval EFI_SUCCESS send out the ATA command and device send required data successfully.\r | |
| 1289 | @retval EFI_DEVICE_ERROR command sent failed.\r | |
| 1290 | \r | |
| 1291 | **/\r | |
| 1292 | EFI_STATUS\r | |
| 1293 | EFIAPI\r | |
| 1294 | AtaPioDataInOut (\r | |
| 1295 | IN EFI_PCI_IO_PROTOCOL *PciIo,\r | |
| 1296 | IN EFI_IDE_REGISTERS *IdeRegisters,\r | |
| 1297 | IN OUT VOID *Buffer,\r | |
| 1298 | IN UINT64 ByteCount,\r | |
| 1299 | IN BOOLEAN Read,\r | |
| 1300 | IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock,\r | |
| 1301 | IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock,\r | |
| 1302 | IN UINT64 Timeout,\r | |
| 1303 | IN ATA_NONBLOCK_TASK *Task\r | |
| 1304 | );\r | |
| 1305 | \r | |
| 1306 | #endif\r | |
| 1307 | \r |