projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 0591696e FT |
1 | /** @file\r |
| 2 | UfsHcDxe driver is used to provide platform-dependent info, mainly UFS host controller\r | |
| 3 | MMIO base, to upper layer UFS drivers.\r | |
| 4 | \r | |
| d1102dba | 5 | Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| 0591696e FT |
6 | This program and the accompanying materials\r |
| 7 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 8 | which accompanies this distribution. The full text of the license may be found at\r | |
| 9 | http://opensource.org/licenses/bsd-license.php.\r | |
| 10 | \r | |
| 11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 13 | \r | |
| 14 | **/\r | |
| 15 | \r | |
| 16 | #ifndef _EFI_UFS_HOST_CONTROLLER_H_\r | |
| 17 | #define _EFI_UFS_HOST_CONTROLLER_H_\r | |
| 18 | \r | |
| 19 | #include <Uefi.h>\r | |
| 20 | \r | |
| 21 | #include <IndustryStandard/Pci.h>\r | |
| 095f0779 | 22 | #include <IndustryStandard/Acpi.h>\r |
| 0591696e FT |
23 | \r |
| 24 | #include <Protocol/ComponentName.h>\r | |
| 25 | #include <Protocol/ComponentName2.h>\r | |
| 26 | #include <Protocol/DriverBinding.h>\r | |
| 27 | #include <Protocol/LoadedImage.h>\r | |
| 28 | #include <Protocol/DevicePath.h>\r | |
| 29 | #include <Protocol/PciIo.h>\r | |
| 30 | #include <Protocol/UfsHostController.h>\r | |
| 31 | \r | |
| 32 | #include <Library/BaseLib.h>\r | |
| 33 | #include <Library/DebugLib.h>\r | |
| 34 | #include <Library/UefiLib.h>\r | |
| 0591696e FT |
35 | #include <Library/MemoryAllocationLib.h>\r |
| 36 | #include <Library/UefiBootServicesTableLib.h>\r | |
| 37 | #include <Library/UefiDriverEntryPoint.h>\r | |
| 38 | \r | |
| 39 | extern EFI_DRIVER_BINDING_PROTOCOL gUfsHcDriverBinding;\r | |
| 40 | extern EFI_COMPONENT_NAME_PROTOCOL gUfsHcComponentName;\r | |
| 41 | extern EFI_COMPONENT_NAME2_PROTOCOL gUfsHcComponentName2;\r | |
| 42 | \r | |
| 43 | //\r | |
| 44 | // Unique signature for private data structure.\r | |
| 45 | //\r | |
| 46 | #define UFS_HC_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('U','F','S','H')\r | |
| 47 | \r | |
| 48 | typedef struct _UFS_HOST_CONTROLLER_PRIVATE_DATA UFS_HOST_CONTROLLER_PRIVATE_DATA;\r | |
| 49 | \r | |
| 50 | //\r | |
| c36ea72e | 51 | // Ufs host controller private data structure.\r |
| 0591696e FT |
52 | //\r |
| 53 | struct _UFS_HOST_CONTROLLER_PRIVATE_DATA {\r | |
| 54 | UINT32 Signature;\r | |
| 0591696e FT |
55 | \r |
| 56 | EDKII_UFS_HOST_CONTROLLER_PROTOCOL UfsHc;\r | |
| d1102dba | 57 | EFI_PCI_IO_PROTOCOL *PciIo;\r |
| 095f0779 | 58 | UINT8 BarIndex;\r |
| 0591696e FT |
59 | UINT64 PciAttributes;\r |
| 60 | };\r | |
| 61 | \r | |
| 62 | #define UFS_HOST_CONTROLLER_PRIVATE_DATA_FROM_UFSHC(a) \\r | |
| 63 | CR (a, \\r | |
| 64 | UFS_HOST_CONTROLLER_PRIVATE_DATA, \\r | |
| 65 | UfsHc, \\r | |
| 66 | UFS_HC_PRIVATE_DATA_SIGNATURE \\r | |
| 67 | )\r | |
| 68 | \r | |
| 69 | /**\r | |
| 70 | Retrieves a Unicode string that is the user readable name of the driver.\r | |
| 71 | \r | |
| 72 | This function retrieves the user readable name of a driver in the form of a\r | |
| 73 | Unicode string. If the driver specified by This has a user readable name in\r | |
| 74 | the language specified by Language, then a pointer to the driver name is\r | |
| 75 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r | |
| 76 | by This does not support the language specified by Language,\r | |
| 77 | then EFI_UNSUPPORTED is returned.\r | |
| 78 | \r | |
| 79 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
| 80 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
| 81 | \r | |
| 82 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
| 83 | array indicating the language. This is the\r | |
| 84 | language of the driver name that the caller is\r | |
| 85 | requesting, and it must match one of the\r | |
| 86 | languages specified in SupportedLanguages. The\r | |
| 87 | number of languages supported by a driver is up\r | |
| 88 | to the driver writer. Language is specified\r | |
| 89 | in RFC 4646 or ISO 639-2 language code format.\r | |
| 90 | \r | |
| 91 | @param DriverName[out] A pointer to the Unicode string to return.\r | |
| 92 | This Unicode string is the name of the\r | |
| 93 | driver specified by This in the language\r | |
| 94 | specified by Language.\r | |
| 95 | \r | |
| 96 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r | |
| 97 | This and the language specified by Language was\r | |
| 98 | returned in DriverName.\r | |
| 99 | \r | |
| 100 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
| 101 | \r | |
| 102 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
| 103 | \r | |
| 104 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
| 105 | the language specified by Language.\r | |
| 106 | \r | |
| 107 | **/\r | |
| 108 | EFI_STATUS\r | |
| 109 | EFIAPI\r | |
| 110 | UfsHcComponentNameGetDriverName (\r | |
| 111 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
| 112 | IN CHAR8 *Language,\r | |
| 113 | OUT CHAR16 **DriverName\r | |
| 114 | );\r | |
| 115 | \r | |
| 116 | /**\r | |
| 117 | Retrieves a Unicode string that is the user readable name of the controller\r | |
| 118 | that is being managed by a driver.\r | |
| 119 | \r | |
| 120 | This function retrieves the user readable name of the controller specified by\r | |
| 121 | ControllerHandle and ChildHandle in the form of a Unicode string. If the\r | |
| 122 | driver specified by This has a user readable name in the language specified by\r | |
| 123 | Language, then a pointer to the controller name is returned in ControllerName,\r | |
| 124 | and EFI_SUCCESS is returned. If the driver specified by This is not currently\r | |
| 125 | managing the controller specified by ControllerHandle and ChildHandle,\r | |
| 126 | then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r | |
| 127 | support the language specified by Language, then EFI_UNSUPPORTED is returned.\r | |
| 128 | \r | |
| 129 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
| 130 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
| 131 | \r | |
| 132 | @param ControllerHandle[in] The handle of a controller that the driver\r | |
| 133 | specified by This is managing. This handle\r | |
| 134 | specifies the controller whose name is to be\r | |
| 135 | returned.\r | |
| 136 | \r | |
| 137 | @param ChildHandle[in] The handle of the child controller to retrieve\r | |
| 138 | the name of. This is an optional parameter that\r | |
| 139 | may be NULL. It will be NULL for device\r | |
| 140 | drivers. It will also be NULL for a bus drivers\r | |
| 141 | that wish to retrieve the name of the bus\r | |
| 142 | controller. It will not be NULL for a bus\r | |
| 143 | driver that wishes to retrieve the name of a\r | |
| 144 | child controller.\r | |
| 145 | \r | |
| 146 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
| 147 | array indicating the language. This is the\r | |
| 148 | language of the driver name that the caller is\r | |
| 149 | requesting, and it must match one of the\r | |
| 150 | languages specified in SupportedLanguages. The\r | |
| 151 | number of languages supported by a driver is up\r | |
| 152 | to the driver writer. Language is specified in\r | |
| 153 | RFC 4646 or ISO 639-2 language code format.\r | |
| 154 | \r | |
| 155 | @param ControllerName[out] A pointer to the Unicode string to return.\r | |
| 156 | This Unicode string is the name of the\r | |
| 157 | controller specified by ControllerHandle and\r | |
| 158 | ChildHandle in the language specified by\r | |
| 159 | Language from the point of view of the driver\r | |
| 160 | specified by This.\r | |
| 161 | \r | |
| 162 | @retval EFI_SUCCESS The Unicode string for the user readable name in\r | |
| 163 | the language specified by Language for the\r | |
| 164 | driver specified by This was returned in\r | |
| 165 | DriverName.\r | |
| 166 | \r | |
| 167 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r | |
| 168 | \r | |
| 169 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r | |
| 170 | EFI_HANDLE.\r | |
| 171 | \r | |
| 172 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
| 173 | \r | |
| 174 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
| 175 | \r | |
| 176 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r | |
| 177 | managing the controller specified by\r | |
| 178 | ControllerHandle and ChildHandle.\r | |
| 179 | \r | |
| 180 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
| 181 | the language specified by Language.\r | |
| 182 | \r | |
| 183 | **/\r | |
| 184 | EFI_STATUS\r | |
| 185 | EFIAPI\r | |
| 186 | UfsHcComponentNameGetControllerName (\r | |
| 187 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
| 188 | IN EFI_HANDLE ControllerHandle,\r | |
| 189 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
| 190 | IN CHAR8 *Language,\r | |
| 191 | OUT CHAR16 **ControllerName\r | |
| 192 | );\r | |
| 193 | \r | |
| 194 | /**\r | |
| 195 | Tests to see if this driver supports a given controller. If a child device is provided,\r | |
| 196 | it further tests to see if this driver supports creating a handle for the specified child device.\r | |
| 197 | \r | |
| 198 | This function checks to see if the driver specified by This supports the device specified by\r | |
| 199 | ControllerHandle. Drivers will typically use the device path attached to\r | |
| 200 | ControllerHandle and/or the services from the bus I/O abstraction attached to\r | |
| 201 | ControllerHandle to determine if the driver supports ControllerHandle. This function\r | |
| 202 | may be called many times during platform initialization. In order to reduce boot times, the tests\r | |
| 203 | performed by this function must be very small, and take as little time as possible to execute. This\r | |
| 204 | function must not change the state of any hardware devices, and this function must be aware that the\r | |
| 205 | device specified by ControllerHandle may already be managed by the same driver or a\r | |
| 206 | different driver. This function must match its calls to AllocatePages() with FreePages(),\r | |
| 207 | AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().\r | |
| 208 | Since ControllerHandle may have been previously started by the same driver, if a protocol is\r | |
| 209 | already in the opened state, then it must not be closed with CloseProtocol(). This is required\r | |
| 210 | to guarantee the state of ControllerHandle is not modified by this function.\r | |
| 211 | \r | |
| 212 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r | |
| 213 | @param[in] ControllerHandle The handle of the controller to test. This handle\r | |
| 214 | must support a protocol interface that supplies\r | |
| 215 | an I/O abstraction to the driver.\r | |
| 216 | @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r | |
| 217 | parameter is ignored by device drivers, and is optional for bus\r | |
| 218 | drivers. For bus drivers, if this parameter is not NULL, then\r | |
| 219 | the bus driver must determine if the bus controller specified\r | |
| 220 | by ControllerHandle and the child controller specified\r | |
| 221 | by RemainingDevicePath are both supported by this\r | |
| 222 | bus driver.\r | |
| 223 | \r | |
| 224 | @retval EFI_SUCCESS The device specified by ControllerHandle and\r | |
| 225 | RemainingDevicePath is supported by the driver specified by This.\r | |
| 226 | @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and\r | |
| 227 | RemainingDevicePath is already being managed by the driver\r | |
| 228 | specified by This.\r | |
| 229 | @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and\r | |
| 230 | RemainingDevicePath is already being managed by a different\r | |
| 231 | driver or an application that requires exclusive access.\r | |
| 232 | Currently not implemented.\r | |
| 233 | @retval EFI_UNSUPPORTED The device specified by ControllerHandle and\r | |
| 234 | RemainingDevicePath is not supported by the driver specified by This.\r | |
| 235 | **/\r | |
| 236 | EFI_STATUS\r | |
| 237 | EFIAPI\r | |
| 238 | UfsHcDriverBindingSupported (\r | |
| 239 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 240 | IN EFI_HANDLE Controller,\r | |
| 241 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
| 242 | );\r | |
| 243 | \r | |
| 244 | /**\r | |
| 245 | Starts a device controller or a bus controller.\r | |
| 246 | \r | |
| 247 | The Start() function is designed to be invoked from the EFI boot service ConnectController().\r | |
| 248 | As a result, much of the error checking on the parameters to Start() has been moved into this\r | |
| 249 | common boot service. It is legal to call Start() from other locations,\r | |
| 250 | but the following calling restrictions must be followed or the system behavior will not be deterministic.\r | |
| 251 | 1. ControllerHandle must be a valid EFI_HANDLE.\r | |
| 252 | 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r | |
| 253 | EFI_DEVICE_PATH_PROTOCOL.\r | |
| 254 | 3. Prior to calling Start(), the Supported() function for the driver specified by This must\r | |
| 255 | have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.\r | |
| 256 | \r | |
| 257 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r | |
| 258 | @param[in] ControllerHandle The handle of the controller to start. This handle\r | |
| 259 | must support a protocol interface that supplies\r | |
| 260 | an I/O abstraction to the driver.\r | |
| 261 | @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r | |
| 262 | parameter is ignored by device drivers, and is optional for bus\r | |
| 263 | drivers. For a bus driver, if this parameter is NULL, then handles\r | |
| 264 | for all the children of Controller are created by this driver.\r | |
| 265 | If this parameter is not NULL and the first Device Path Node is\r | |
| 266 | not the End of Device Path Node, then only the handle for the\r | |
| 267 | child device specified by the first Device Path Node of\r | |
| 268 | RemainingDevicePath is created by this driver.\r | |
| 269 | If the first Device Path Node of RemainingDevicePath is\r | |
| 270 | the End of Device Path Node, no child handle is created by this\r | |
| 271 | driver.\r | |
| 272 | \r | |
| 273 | @retval EFI_SUCCESS The device was started.\r | |
| 274 | @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.\r | |
| 275 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
| 276 | @retval Others The driver failded to start the device.\r | |
| 277 | \r | |
| 278 | **/\r | |
| 279 | EFI_STATUS\r | |
| 280 | EFIAPI\r | |
| 281 | UfsHcDriverBindingStart (\r | |
| 282 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 283 | IN EFI_HANDLE Controller,\r | |
| 284 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
| 285 | );\r | |
| 286 | \r | |
| 287 | /**\r | |
| 288 | Stops a device controller or a bus controller.\r | |
| 289 | \r | |
| 290 | The Stop() function is designed to be invoked from the EFI boot service DisconnectController().\r | |
| 291 | As a result, much of the error checking on the parameters to Stop() has been moved\r | |
| 292 | into this common boot service. It is legal to call Stop() from other locations,\r | |
| 293 | but the following calling restrictions must be followed or the system behavior will not be deterministic.\r | |
| 294 | 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r | |
| 295 | same driver's Start() function.\r | |
| 296 | 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r | |
| 297 | EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r | |
| 298 | Start() function, and the Start() function must have called OpenProtocol() on\r | |
| 299 | ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r | |
| 300 | \r | |
| 301 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r | |
| 302 | @param[in] ControllerHandle A handle to the device being stopped. The handle must\r | |
| 303 | support a bus specific I/O protocol for the driver\r | |
| 304 | to use to stop the device.\r | |
| 305 | @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.\r | |
| 306 | @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r | |
| 307 | if NumberOfChildren is 0.\r | |
| 308 | \r | |
| 309 | @retval EFI_SUCCESS The device was stopped.\r | |
| 310 | @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.\r | |
| 311 | \r | |
| 312 | **/\r | |
| 313 | EFI_STATUS\r | |
| 314 | EFIAPI\r | |
| 315 | UfsHcDriverBindingStop (\r | |
| 316 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 317 | IN EFI_HANDLE Controller,\r | |
| 318 | IN UINTN NumberOfChildren,\r | |
| 319 | IN EFI_HANDLE *ChildHandleBuffer\r | |
| 320 | );\r | |
| 321 | \r | |
| 322 | /**\r | |
| 323 | Get the MMIO base of the UFS host controller.\r | |
| 324 | \r | |
| 325 | @param[in] This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.\r | |
| 326 | @param[out] MmioBar The MMIO base address of UFS host controller.\r | |
| 327 | \r | |
| 328 | @retval EFI_SUCCESS The operation succeeds.\r | |
| 329 | @retval others The operation fails.\r | |
| 330 | **/\r | |
| 331 | EFI_STATUS\r | |
| 332 | EFIAPI\r | |
| 333 | UfsHcGetMmioBar (\r | |
| 334 | IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This,\r | |
| 335 | OUT UINTN *MmioBar\r | |
| 336 | );\r | |
| 337 | \r | |
| d1102dba | 338 | /**\r |
| 0591696e | 339 | Provides the UFS controller-specific addresses needed to access system memory.\r |
| d1102dba | 340 | \r |
| 0591696e FT |
341 | @param This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.\r |
| 342 | @param Operation Indicates if the bus master is going to read or write to system memory.\r | |
| 343 | @param HostAddress The system memory address to map to the UFS controller.\r | |
| 344 | @param NumberOfBytes On input the number of bytes to map. On output the number of bytes\r | |
| d1102dba | 345 | that were mapped.\r |
| 0591696e | 346 | @param DeviceAddress The resulting map address for the bus master UFS controller to use to\r |
| d1102dba | 347 | access the hosts HostAddress.\r |
| 0591696e | 348 | @param Mapping A resulting value to pass to Unmap().\r |
| d1102dba | 349 | \r |
| 0591696e | 350 | @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.\r |
| d1102dba | 351 | @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.\r |
| 0591696e FT |
352 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r |
| 353 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
| 354 | @retval EFI_DEVICE_ERROR The system hardware could not map the requested address.\r | |
| d1102dba | 355 | \r |
| 0591696e FT |
356 | **/\r |
| 357 | EFI_STATUS\r | |
| 358 | EFIAPI\r | |
| 359 | UfsHcMap (\r | |
| 360 | IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This,\r | |
| 361 | IN EDKII_UFS_HOST_CONTROLLER_OPERATION Operation,\r | |
| 362 | IN VOID *HostAddress,\r | |
| 363 | IN OUT UINTN *NumberOfBytes,\r | |
| 364 | OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,\r | |
| 365 | OUT VOID **Mapping\r | |
| 366 | );\r | |
| 367 | \r | |
| d1102dba | 368 | /**\r |
| 0591696e | 369 | Completes the Map() operation and releases any corresponding resources.\r |
| d1102dba LG |
370 | \r |
| 371 | @param This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.\r | |
| 0591696e | 372 | @param Mapping The mapping value returned from Map().\r |
| d1102dba | 373 | \r |
| 0591696e FT |
374 | @retval EFI_SUCCESS The range was unmapped.\r |
| 375 | @retval EFI_DEVICE_ERROR The data was not committed to the target system memory.\r | |
| d1102dba | 376 | \r |
| 0591696e FT |
377 | **/\r |
| 378 | EFI_STATUS\r | |
| 379 | EFIAPI\r | |
| 380 | UfsHcUnmap (\r | |
| 381 | IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This,\r | |
| 382 | IN VOID *Mapping\r | |
| 383 | );\r | |
| 384 | \r | |
| d1102dba | 385 | /**\r |
| 0591696e | 386 | Allocates pages that are suitable for an EfiUfsHcOperationBusMasterCommonBuffer\r |
| d1102dba LG |
387 | mapping.\r |
| 388 | \r | |
| 0591696e FT |
389 | @param This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.\r |
| 390 | @param Type This parameter is not used and must be ignored.\r | |
| 391 | @param MemoryType The type of memory to allocate, EfiBootServicesData or\r | |
| d1102dba LG |
392 | EfiRuntimeServicesData.\r |
| 393 | @param Pages The number of pages to allocate.\r | |
| 0591696e | 394 | @param HostAddress A pointer to store the base system memory address of the\r |
| d1102dba | 395 | allocated range.\r |
| 0591696e | 396 | @param Attributes The requested bit mask of attributes for the allocated range.\r |
| d1102dba | 397 | \r |
| 0591696e FT |
398 | @retval EFI_SUCCESS The requested memory pages were allocated.\r |
| 399 | @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are\r | |
| d1102dba | 400 | MEMORY_WRITE_COMBINE and MEMORY_CACHED.\r |
| 0591696e | 401 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r |
| d1102dba LG |
402 | @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.\r |
| 403 | \r | |
| 0591696e FT |
404 | **/\r |
| 405 | EFI_STATUS\r | |
| 406 | EFIAPI\r | |
| 407 | UfsHcAllocateBuffer (\r | |
| 408 | IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This,\r | |
| 409 | IN EFI_ALLOCATE_TYPE Type,\r | |
| 410 | IN EFI_MEMORY_TYPE MemoryType,\r | |
| 411 | IN UINTN Pages,\r | |
| 412 | OUT VOID **HostAddress,\r | |
| 413 | IN UINT64 Attributes\r | |
| 414 | );\r | |
| 415 | \r | |
| d1102dba | 416 | /**\r |
| 0591696e | 417 | Frees memory that was allocated with AllocateBuffer().\r |
| d1102dba LG |
418 | \r |
| 419 | @param This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.\r | |
| 420 | @param Pages The number of pages to free.\r | |
| 421 | @param HostAddress The base system memory address of the allocated range.\r | |
| 422 | \r | |
| 0591696e FT |
423 | @retval EFI_SUCCESS The requested memory pages were freed.\r |
| 424 | @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages\r | |
| 425 | was not allocated with AllocateBuffer().\r | |
| d1102dba | 426 | \r |
| 0591696e FT |
427 | **/\r |
| 428 | EFI_STATUS\r | |
| 429 | EFIAPI\r | |
| 430 | UfsHcFreeBuffer (\r | |
| 431 | IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This,\r | |
| 432 | IN UINTN Pages,\r | |
| 433 | IN VOID *HostAddress\r | |
| 434 | );\r | |
| 435 | \r | |
| d1102dba | 436 | /**\r |
| 0591696e | 437 | Flushes all posted write transactions from the UFS bus to attached UFS device.\r |
| d1102dba LG |
438 | \r |
| 439 | @param This A pointer to the EFI_UFS_HOST_CONTROLLER_PROTOCOL instance.\r | |
| 440 | \r | |
| 0591696e | 441 | @retval EFI_SUCCESS The posted write transactions were flushed from the UFS bus\r |
| d1102dba | 442 | to attached UFS device.\r |
| 0591696e | 443 | @retval EFI_DEVICE_ERROR The posted write transactions were not flushed from the UFS\r |
| d1102dba LG |
444 | bus to attached UFS device due to a hardware error.\r |
| 445 | \r | |
| 0591696e FT |
446 | **/\r |
| 447 | EFI_STATUS\r | |
| 448 | EFIAPI\r | |
| 449 | UfsHcFlush (\r | |
| 450 | IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This\r | |
| 451 | );\r | |
| 452 | \r | |
| d1102dba | 453 | /**\r |
| 095f0779 FT |
454 | Enable a UFS bus driver to access UFS MMIO registers in the UFS Host Controller memory space.\r |
| 455 | \r | |
| 456 | @param This A pointer to the EDKII_UFS_HOST_CONTROLLER_PROTOCOL instance.\r | |
| 457 | @param Width Signifies the width of the memory operations.\r | |
| 458 | @param Offset The offset within the UFS Host Controller MMIO space to start the\r | |
| 459 | memory operation.\r | |
| 460 | @param Count The number of memory operations to perform.\r | |
| 461 | @param Buffer For read operations, the destination buffer to store the results.\r | |
| 462 | For write operations, the source buffer to write data from.\r | |
| 463 | \r | |
| 464 | @retval EFI_SUCCESS The data was read from or written to the UFS host controller.\r | |
| 465 | @retval EFI_UNSUPPORTED The address range specified by Offset, Width, and Count is not\r | |
| 466 | valid for the UFS Host Controller memory space.\r | |
| 467 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
| 468 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r | |
| 469 | \r | |
| 470 | **/\r | |
| 471 | EFI_STATUS\r | |
| 472 | EFIAPI\r | |
| 473 | UfsHcMmioRead (\r | |
| 474 | IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This,\r | |
| 475 | IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL_WIDTH Width,\r | |
| 476 | IN UINT64 Offset,\r | |
| 477 | IN UINTN Count,\r | |
| 478 | IN OUT VOID *Buffer\r | |
| 479 | );\r | |
| 480 | \r | |
| d1102dba | 481 | /**\r |
| 095f0779 FT |
482 | Enable a UFS bus driver to access UFS MMIO registers in the UFS Host Controller memory space.\r |
| 483 | \r | |
| 484 | @param This A pointer to the EDKII_UFS_HOST_CONTROLLER_PROTOCOL instance.\r | |
| 485 | @param Width Signifies the width of the memory operations.\r | |
| 486 | @param Offset The offset within the UFS Host Controller MMIO space to start the\r | |
| 487 | memory operation.\r | |
| 488 | @param Count The number of memory operations to perform.\r | |
| 489 | @param Buffer For read operations, the destination buffer to store the results.\r | |
| 490 | For write operations, the source buffer to write data from.\r | |
| 491 | \r | |
| 492 | @retval EFI_SUCCESS The data was read from or written to the UFS host controller.\r | |
| 493 | @retval EFI_UNSUPPORTED The address range specified by Offset, Width, and Count is not\r | |
| 494 | valid for the UFS Host Controller memory space.\r | |
| 495 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
| 496 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r | |
| 497 | \r | |
| 498 | **/\r | |
| 499 | EFI_STATUS\r | |
| 500 | EFIAPI\r | |
| 501 | UfsHcMmioWrite (\r | |
| 502 | IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL *This,\r | |
| 503 | IN EDKII_UFS_HOST_CONTROLLER_PROTOCOL_WIDTH Width,\r | |
| 504 | IN UINT64 Offset,\r | |
| 505 | IN UINTN Count,\r | |
| 506 | IN OUT VOID *Buffer\r | |
| 507 | );\r | |
| 508 | \r | |
| 0591696e | 509 | #endif\r |