projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 772db4bb | 1 | /** @file\r |
| dab714aa | 2 | Interface routine for Mtftp4.\r |
| 3 | \r | |
| 75dce340 | 4 | Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r |
| e5eed7d3 | 5 | This program and the accompanying materials\r |
| 772db4bb | 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 | |
| dab714aa | 8 | http://opensource.org/licenses/bsd-license.php<BR>\r |
| 772db4bb | 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 | |
| 772db4bb | 13 | **/\r |
| 14 | \r | |
| 772db4bb | 15 | \r |
| dab714aa | 16 | #include "Mtftp4Impl.h"\r |
| 772db4bb | 17 | \r |
| 18 | \r | |
| 772db4bb | 19 | /**\r |
| 20 | Clean up the MTFTP session to get ready for new operation.\r | |
| 21 | \r | |
| 22 | @param Instance The MTFTP session to clean up\r | |
| 23 | @param Result The result to return to the caller who initiated\r | |
| 24 | the operation.\r | |
| 772db4bb | 25 | **/\r |
| 26 | VOID\r | |
| 27 | Mtftp4CleanOperation (\r | |
| dab714aa | 28 | IN OUT MTFTP4_PROTOCOL *Instance,\r |
| 29 | IN EFI_STATUS Result\r | |
| 772db4bb | 30 | )\r |
| 31 | {\r | |
| e48e37fc | 32 | LIST_ENTRY *Entry;\r |
| 33 | LIST_ENTRY *Next;\r | |
| 772db4bb | 34 | MTFTP4_BLOCK_RANGE *Block;\r |
| 35 | EFI_MTFTP4_TOKEN *Token;\r | |
| 36 | \r | |
| 37 | //\r | |
| 38 | // Free various resources.\r | |
| 39 | //\r | |
| 40 | Token = Instance->Token;\r | |
| 41 | \r | |
| 42 | if (Token != NULL) {\r | |
| 43 | Token->Status = Result;\r | |
| 44 | \r | |
| 45 | if (Token->Event != NULL) {\r | |
| 46 | gBS->SignalEvent (Token->Event);\r | |
| 47 | }\r | |
| 48 | \r | |
| 49 | Instance->Token = NULL;\r | |
| 50 | }\r | |
| 51 | \r | |
| 52 | ASSERT (Instance->UnicastPort != NULL);\r | |
| b45b45b2 | 53 | UdpIoCleanIo (Instance->UnicastPort);\r |
| 772db4bb | 54 | \r |
| 55 | if (Instance->LastPacket != NULL) {\r | |
| 56 | NetbufFree (Instance->LastPacket);\r | |
| 57 | Instance->LastPacket = NULL;\r | |
| 58 | }\r | |
| 59 | \r | |
| 60 | if (Instance->McastUdpPort != NULL) {\r | |
| 216f7970 | 61 | gBS->CloseProtocol (\r |
| 62 | Instance->McastUdpPort->UdpHandle,\r | |
| 63 | &gEfiUdp4ProtocolGuid,\r | |
| 64 | gMtftp4DriverBinding.DriverBindingHandle,\r | |
| 65 | Instance->Handle\r | |
| 66 | );\r | |
| b45b45b2 | 67 | UdpIoFreeIo (Instance->McastUdpPort);\r |
| 772db4bb | 68 | Instance->McastUdpPort = NULL;\r |
| 69 | }\r | |
| 70 | \r | |
| 71 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &Instance->Blocks) {\r | |
| 72 | Block = NET_LIST_USER_STRUCT (Entry, MTFTP4_BLOCK_RANGE, Link);\r | |
| e48e37fc | 73 | RemoveEntryList (Entry);\r |
| 766c7483 | 74 | FreePool (Block);\r |
| 772db4bb | 75 | }\r |
| 76 | \r | |
| e48e37fc | 77 | ZeroMem (&Instance->RequestOption, sizeof (MTFTP4_OPTION));\r |
| 772db4bb | 78 | \r |
| 79 | Instance->Operation = 0;\r | |
| 80 | \r | |
| 81 | Instance->BlkSize = MTFTP4_DEFAULT_BLKSIZE;\r | |
| 82 | Instance->LastBlock = 0;\r | |
| 83 | Instance->ServerIp = 0;\r | |
| 84 | Instance->ListeningPort = 0;\r | |
| 85 | Instance->ConnectedPort = 0;\r | |
| 86 | Instance->Gateway = 0;\r | |
| 87 | Instance->PacketToLive = 0;\r | |
| 88 | Instance->MaxRetry = 0;\r | |
| 89 | Instance->CurRetry = 0;\r | |
| 90 | Instance->Timeout = 0;\r | |
| 91 | Instance->McastIp = 0;\r | |
| 92 | Instance->McastPort = 0;\r | |
| 93 | Instance->Master = TRUE;\r | |
| 94 | }\r | |
| 95 | \r | |
| 96 | \r | |
| 772db4bb | 97 | /**\r |
| dab714aa | 98 | Check packet for GetInfo. \r |
| 99 | \r | |
| 100 | GetInfo is implemented with EfiMtftp4ReadFile. It use Mtftp4GetInfoCheckPacket \r | |
| 101 | to inspect the first packet from server, then abort the session.\r | |
| 772db4bb | 102 | \r |
| 103 | @param This The MTFTP4 protocol instance\r | |
| 104 | @param Token The user's token\r | |
| 105 | @param PacketLen The length of the packet\r | |
| 106 | @param Packet The received packet.\r | |
| 107 | \r | |
| 108 | @retval EFI_ABORTED Abort the ReadFile operation and return.\r | |
| 109 | \r | |
| 110 | **/\r | |
| 772db4bb | 111 | EFI_STATUS\r |
| 6d3ea23f | 112 | EFIAPI\r |
| 772db4bb | 113 | Mtftp4GetInfoCheckPacket (\r |
| 114 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
| 115 | IN EFI_MTFTP4_TOKEN *Token,\r | |
| 116 | IN UINT16 PacketLen,\r | |
| 117 | IN EFI_MTFTP4_PACKET *Packet\r | |
| 118 | )\r | |
| 119 | {\r | |
| 120 | MTFTP4_GETINFO_STATE *State;\r | |
| 121 | EFI_STATUS Status;\r | |
| 122 | UINT16 OpCode;\r | |
| 123 | \r | |
| ea886bef | 124 | State = (MTFTP4_GETINFO_STATE *) Token->Context;\r |
| a5867703 | 125 | OpCode = NTOHS (Packet->OpCode);\r |
| 772db4bb | 126 | \r |
| 127 | //\r | |
| 128 | // Set the GetInfo's return status according to the OpCode.\r | |
| 129 | //\r | |
| 130 | switch (OpCode) {\r | |
| 131 | case EFI_MTFTP4_OPCODE_ERROR:\r | |
| 132 | State->Status = EFI_TFTP_ERROR;\r | |
| 133 | break;\r | |
| 134 | \r | |
| 135 | case EFI_MTFTP4_OPCODE_OACK:\r | |
| 136 | State->Status = EFI_SUCCESS;\r | |
| 137 | break;\r | |
| 138 | \r | |
| 139 | default:\r | |
| 140 | State->Status = EFI_PROTOCOL_ERROR;\r | |
| 141 | }\r | |
| 142 | \r | |
| 143 | //\r | |
| 144 | // Allocate buffer then copy the packet over. Use gBS->AllocatePool\r | |
| e48e37fc | 145 | // in case AllocatePool will implements something tricky.\r |
| 772db4bb | 146 | //\r |
| 147 | Status = gBS->AllocatePool (EfiBootServicesData, PacketLen, (VOID **) State->Packet);\r | |
| 148 | \r | |
| 149 | if (EFI_ERROR (Status)) {\r | |
| 150 | State->Status = EFI_OUT_OF_RESOURCES;\r | |
| 151 | return EFI_ABORTED;\r | |
| 152 | }\r | |
| 153 | \r | |
| 154 | *(State->PacketLen) = PacketLen;\r | |
| e48e37fc | 155 | CopyMem (*(State->Packet), Packet, PacketLen);\r |
| 772db4bb | 156 | \r |
| 157 | return EFI_ABORTED;\r | |
| 158 | }\r | |
| 159 | \r | |
| 160 | \r | |
| 772db4bb | 161 | /**\r |
| dab714aa | 162 | Check whether the override data is valid. \r |
| 163 | \r | |
| 164 | It will first validate whether the server is a valid unicast. If a gateway\r | |
| 165 | is provided in the Override, it also check that it is a unicast on the \r | |
| 166 | connected network.\r | |
| 772db4bb | 167 | \r |
| 168 | @param Instance The MTFTP instance\r | |
| 169 | @param Override The override data to validate.\r | |
| 170 | \r | |
| dab714aa | 171 | @retval TRUE The override data is valid\r |
| 172 | @retval FALSE The override data is invalid\r | |
| 173 | \r | |
| 772db4bb | 174 | **/\r |
| 772db4bb | 175 | BOOLEAN\r |
| 176 | Mtftp4OverrideValid (\r | |
| 177 | IN MTFTP4_PROTOCOL *Instance,\r | |
| 178 | IN EFI_MTFTP4_OVERRIDE_DATA *Override\r | |
| 179 | )\r | |
| 180 | {\r | |
| 181 | EFI_MTFTP4_CONFIG_DATA *Config;\r | |
| 182 | IP4_ADDR Ip;\r | |
| 183 | IP4_ADDR Netmask;\r | |
| 184 | IP4_ADDR Gateway;\r | |
| 185 | \r | |
| e48e37fc | 186 | CopyMem (&Ip, &Override->ServerIp, sizeof (IP4_ADDR));\r |
| f6b7393c | 187 | if (!NetIp4IsUnicast (NTOHL (Ip), 0)) {\r |
| 772db4bb | 188 | return FALSE;\r |
| 189 | }\r | |
| 190 | \r | |
| 191 | Config = &Instance->Config;\r | |
| 192 | \r | |
| e48e37fc | 193 | CopyMem (&Gateway, &Override->GatewayIp, sizeof (IP4_ADDR));\r |
| 772db4bb | 194 | Gateway = NTOHL (Gateway);\r |
| 195 | \r | |
| 196 | if (!Config->UseDefaultSetting && (Gateway != 0)) {\r | |
| e48e37fc | 197 | CopyMem (&Netmask, &Config->SubnetMask, sizeof (IP4_ADDR));\r |
| 198 | CopyMem (&Ip, &Config->StationIp, sizeof (IP4_ADDR));\r | |
| 772db4bb | 199 | \r |
| 200 | Netmask = NTOHL (Netmask);\r | |
| 201 | Ip = NTOHL (Ip);\r | |
| 202 | \r | |
| f6b7393c | 203 | if (!NetIp4IsUnicast (Gateway, Netmask) || !IP4_NET_EQUAL (Gateway, Ip, Netmask)) {\r |
| 772db4bb | 204 | return FALSE;\r |
| 205 | }\r | |
| 206 | }\r | |
| 207 | \r | |
| 208 | return TRUE;\r | |
| 209 | }\r | |
| 210 | \r | |
| 211 | \r | |
| 212 | /**\r | |
| 213 | Poll the UDP to get the IP4 default address, which may be retrieved\r | |
| dab714aa | 214 | by DHCP. \r |
| 215 | \r | |
| 216 | The default time out value is 5 seconds. If IP has retrieved the default address, \r | |
| 217 | the UDP is reconfigured.\r | |
| 772db4bb | 218 | \r |
| 219 | @param Instance The Mtftp instance\r | |
| b45b45b2 | 220 | @param UdpIo The UDP_IO to poll\r |
| 221 | @param UdpCfgData The UDP configure data to reconfigure the UDP_IO\r | |
| 772db4bb | 222 | \r |
| dab714aa | 223 | @retval TRUE The default address is retrieved and UDP is reconfigured.\r |
| 224 | @retval FALSE Some error occured.\r | |
| 772db4bb | 225 | \r |
| 226 | **/\r | |
| 227 | BOOLEAN\r | |
| 228 | Mtftp4GetMapping (\r | |
| 229 | IN MTFTP4_PROTOCOL *Instance,\r | |
| b45b45b2 | 230 | IN UDP_IO *UdpIo,\r |
| 772db4bb | 231 | IN EFI_UDP4_CONFIG_DATA *UdpCfgData\r |
| 232 | )\r | |
| 233 | {\r | |
| 234 | MTFTP4_SERVICE *Service;\r | |
| 235 | EFI_IP4_MODE_DATA Ip4Mode;\r | |
| 236 | EFI_UDP4_PROTOCOL *Udp;\r | |
| 237 | EFI_STATUS Status;\r | |
| 238 | \r | |
| 239 | ASSERT (Instance->Config.UseDefaultSetting);\r | |
| 240 | \r | |
| 241 | Service = Instance->Service;\r | |
| b45b45b2 | 242 | Udp = UdpIo->Protocol.Udp4;\r |
| 772db4bb | 243 | \r |
| 244 | Status = gBS->SetTimer (\r | |
| 245 | Service->TimerToGetMap,\r | |
| 246 | TimerRelative,\r | |
| 247 | MTFTP4_TIME_TO_GETMAP * TICKS_PER_SECOND\r | |
| 248 | );\r | |
| 249 | if (EFI_ERROR (Status)) {\r | |
| 250 | return FALSE;\r | |
| 251 | }\r | |
| 252 | \r | |
| 253 | while (!EFI_ERROR (gBS->CheckEvent (Service->TimerToGetMap))) {\r | |
| 254 | Udp->Poll (Udp);\r | |
| 255 | \r | |
| 256 | if (!EFI_ERROR (Udp->GetModeData (Udp, NULL, &Ip4Mode, NULL, NULL)) &&\r | |
| 257 | Ip4Mode.IsConfigured) {\r | |
| 258 | \r | |
| 259 | Udp->Configure (Udp, NULL);\r | |
| 260 | return (BOOLEAN) (Udp->Configure (Udp, UdpCfgData) == EFI_SUCCESS);\r | |
| 261 | }\r | |
| 262 | }\r | |
| 263 | \r | |
| 264 | return FALSE;\r | |
| 265 | }\r | |
| 266 | \r | |
| 267 | \r | |
| 268 | /**\r | |
| 269 | Configure the UDP port for unicast receiving.\r | |
| 270 | \r | |
| b45b45b2 | 271 | @param UdpIo The UDP_IO instance\r |
| 772db4bb | 272 | @param Instance The MTFTP session\r |
| 273 | \r | |
| 274 | @retval EFI_SUCCESS The UDP port is successfully configured for the\r | |
| 275 | session to unicast receive.\r | |
| 276 | \r | |
| 277 | **/\r | |
| 772db4bb | 278 | EFI_STATUS\r |
| 279 | Mtftp4ConfigUnicastPort (\r | |
| b45b45b2 | 280 | IN UDP_IO *UdpIo,\r |
| 772db4bb | 281 | IN MTFTP4_PROTOCOL *Instance\r |
| 282 | )\r | |
| 283 | {\r | |
| 284 | EFI_MTFTP4_CONFIG_DATA *Config;\r | |
| 285 | EFI_UDP4_CONFIG_DATA UdpConfig;\r | |
| 286 | EFI_STATUS Status;\r | |
| 287 | IP4_ADDR Ip;\r | |
| 288 | \r | |
| 289 | Config = &Instance->Config;\r | |
| 290 | \r | |
| 291 | UdpConfig.AcceptBroadcast = FALSE;\r | |
| 292 | UdpConfig.AcceptPromiscuous = FALSE;\r | |
| 293 | UdpConfig.AcceptAnyPort = FALSE;\r | |
| 294 | UdpConfig.AllowDuplicatePort = FALSE;\r | |
| 295 | UdpConfig.TypeOfService = 0;\r | |
| 296 | UdpConfig.TimeToLive = 64;\r | |
| 297 | UdpConfig.DoNotFragment = FALSE;\r | |
| 298 | UdpConfig.ReceiveTimeout = 0;\r | |
| 299 | UdpConfig.TransmitTimeout = 0;\r | |
| 300 | UdpConfig.UseDefaultAddress = Config->UseDefaultSetting;\r | |
| 301 | UdpConfig.StationAddress = Config->StationIp;\r | |
| 302 | UdpConfig.SubnetMask = Config->SubnetMask;\r | |
| 303 | UdpConfig.StationPort = 0;\r | |
| 304 | UdpConfig.RemotePort = 0;\r | |
| 305 | \r | |
| 306 | Ip = HTONL (Instance->ServerIp);\r | |
| e48e37fc | 307 | CopyMem (&UdpConfig.RemoteAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
| 772db4bb | 308 | \r |
| b45b45b2 | 309 | Status = UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfig);\r |
| 772db4bb | 310 | \r |
| 311 | if ((Status == EFI_NO_MAPPING) && Mtftp4GetMapping (Instance, UdpIo, &UdpConfig)) {\r | |
| 312 | return EFI_SUCCESS;\r | |
| 313 | }\r | |
| 314 | \r | |
| c4a62a12 | 315 | if (!Config->UseDefaultSetting && !EFI_IP4_EQUAL (&mZeroIp4Addr, &Config->GatewayIp)) {\r |
| 316 | //\r | |
| 317 | // The station IP address is manually configured and the Gateway IP is not 0.\r | |
| 318 | // Add the default route for this UDP instance.\r | |
| 319 | //\r | |
| b45b45b2 | 320 | Status = UdpIo->Protocol.Udp4->Routes (\r |
| 321 | UdpIo->Protocol.Udp4,\r | |
| 322 | FALSE,\r | |
| 323 | &mZeroIp4Addr,\r | |
| 324 | &mZeroIp4Addr,\r | |
| 325 | &Config->GatewayIp\r | |
| 326 | );\r | |
| c4a62a12 | 327 | if (EFI_ERROR (Status)) {\r |
| b45b45b2 | 328 | UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, NULL);\r |
| c4a62a12 | 329 | }\r |
| 330 | }\r | |
| 772db4bb | 331 | return Status;\r |
| 332 | }\r | |
| 333 | \r | |
| 334 | \r | |
| 335 | /**\r | |
| 336 | Start the MTFTP session to do the operation, such as read file,\r | |
| 337 | write file, and read directory.\r | |
| 338 | \r | |
| 339 | @param This The MTFTP session\r | |
| 340 | @param Token The token than encapsues the user's request.\r | |
| 341 | @param Operation The operation to do\r | |
| 342 | \r | |
| 343 | @retval EFI_INVALID_PARAMETER Some of the parameters are invalid.\r | |
| 344 | @retval EFI_NOT_STARTED The MTFTP session hasn't been configured.\r | |
| 345 | @retval EFI_ALREADY_STARTED There is pending operation for the session.\r | |
| 346 | @retval EFI_SUCCESS The operation is successfully started.\r | |
| 347 | \r | |
| 348 | **/\r | |
| 772db4bb | 349 | EFI_STATUS\r |
| 350 | Mtftp4Start (\r | |
| 351 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
| 352 | IN EFI_MTFTP4_TOKEN *Token,\r | |
| 353 | IN UINT16 Operation\r | |
| 354 | )\r | |
| 355 | {\r | |
| 356 | MTFTP4_PROTOCOL *Instance;\r | |
| 357 | EFI_MTFTP4_OVERRIDE_DATA *Override;\r | |
| 358 | EFI_MTFTP4_CONFIG_DATA *Config;\r | |
| 359 | EFI_TPL OldTpl;\r | |
| 360 | EFI_STATUS Status;\r | |
| 361 | \r | |
| 362 | //\r | |
| 363 | // Validate the parameters\r | |
| 364 | //\r | |
| 365 | if ((This == NULL) || (Token == NULL) || (Token->Filename == NULL) ||\r | |
| 366 | ((Token->OptionCount != 0) && (Token->OptionList == NULL))) {\r | |
| 367 | return EFI_INVALID_PARAMETER;\r | |
| 368 | }\r | |
| 369 | \r | |
| 370 | //\r | |
| 371 | // User must provide at least one method to collect the data for download.\r | |
| 372 | //\r | |
| 373 | if (((Operation == EFI_MTFTP4_OPCODE_RRQ) || (Operation == EFI_MTFTP4_OPCODE_DIR)) &&\r | |
| 374 | ((Token->Buffer == NULL) && (Token->CheckPacket == NULL))) {\r | |
| 375 | return EFI_INVALID_PARAMETER;\r | |
| 376 | }\r | |
| 377 | \r | |
| 378 | //\r | |
| 379 | // User must provide at least one method to provide the data for upload.\r | |
| 380 | //\r | |
| 381 | if ((Operation == EFI_MTFTP4_OPCODE_WRQ) &&\r | |
| 382 | ((Token->Buffer == NULL) && (Token->PacketNeeded == NULL))) {\r | |
| 383 | return EFI_INVALID_PARAMETER;\r | |
| 384 | }\r | |
| 385 | \r | |
| 386 | Instance = MTFTP4_PROTOCOL_FROM_THIS (This);\r | |
| 387 | \r | |
| 388 | Status = EFI_SUCCESS;\r | |
| e48e37fc | 389 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
| 772db4bb | 390 | \r |
| 391 | if (Instance->State != MTFTP4_STATE_CONFIGED) {\r | |
| 392 | Status = EFI_NOT_STARTED;\r | |
| 393 | }\r | |
| 394 | \r | |
| 395 | if (Instance->Operation != 0) {\r | |
| 396 | Status = EFI_ACCESS_DENIED;\r | |
| 397 | }\r | |
| 398 | \r | |
| 399 | if (EFI_ERROR (Status)) {\r | |
| e48e37fc | 400 | gBS->RestoreTPL (OldTpl);\r |
| 772db4bb | 401 | return Status;\r |
| 402 | }\r | |
| 403 | \r | |
| 404 | //\r | |
| 405 | // Set the Operation now to prevent the application start other\r | |
| 406 | // operations.\r | |
| 407 | //\r | |
| 408 | Instance->Operation = Operation;\r | |
| 409 | Override = Token->OverrideData;\r | |
| 410 | \r | |
| 411 | if ((Override != NULL) && !Mtftp4OverrideValid (Instance, Override)) {\r | |
| 412 | Status = EFI_INVALID_PARAMETER;\r | |
| 413 | goto ON_ERROR;\r | |
| 414 | }\r | |
| 415 | \r | |
| 416 | if (Token->OptionCount != 0) {\r | |
| 417 | Status = Mtftp4ParseOption (\r | |
| 418 | Token->OptionList,\r | |
| 419 | Token->OptionCount,\r | |
| 420 | TRUE,\r | |
| 421 | &Instance->RequestOption\r | |
| 422 | );\r | |
| 423 | \r | |
| 424 | if (EFI_ERROR (Status)) {\r | |
| 425 | goto ON_ERROR;\r | |
| 426 | }\r | |
| 427 | }\r | |
| 428 | \r | |
| 429 | //\r | |
| 430 | // Set the operation parameters from the configuration or override data.\r | |
| 431 | //\r | |
| 432 | Config = &Instance->Config;\r | |
| 433 | Instance->Token = Token;\r | |
| 434 | Instance->BlkSize = MTFTP4_DEFAULT_BLKSIZE;\r | |
| 435 | \r | |
| e48e37fc | 436 | CopyMem (&Instance->ServerIp, &Config->ServerIp, sizeof (IP4_ADDR));\r |
| 772db4bb | 437 | Instance->ServerIp = NTOHL (Instance->ServerIp);\r |
| 438 | \r | |
| 439 | Instance->ListeningPort = Config->InitialServerPort;\r | |
| 440 | Instance->ConnectedPort = 0;\r | |
| 441 | \r | |
| e48e37fc | 442 | CopyMem (&Instance->Gateway, &Config->GatewayIp, sizeof (IP4_ADDR));\r |
| 772db4bb | 443 | Instance->Gateway = NTOHL (Instance->Gateway);\r |
| 444 | \r | |
| 445 | Instance->MaxRetry = Config->TryCount;\r | |
| 446 | Instance->Timeout = Config->TimeoutValue;\r | |
| 447 | Instance->Master = TRUE;\r | |
| 448 | \r | |
| 449 | if (Override != NULL) {\r | |
| e48e37fc | 450 | CopyMem (&Instance->ServerIp, &Override->ServerIp, sizeof (IP4_ADDR));\r |
| 451 | CopyMem (&Instance->Gateway, &Override->GatewayIp, sizeof (IP4_ADDR));\r | |
| 772db4bb | 452 | \r |
| 453 | Instance->ServerIp = NTOHL (Instance->ServerIp);\r | |
| 454 | Instance->Gateway = NTOHL (Instance->Gateway);\r | |
| 455 | \r | |
| 456 | Instance->ListeningPort = Override->ServerPort;\r | |
| 457 | Instance->MaxRetry = Override->TryCount;\r | |
| 458 | Instance->Timeout = Override->TimeoutValue;\r | |
| 459 | }\r | |
| 460 | \r | |
| 461 | if (Instance->ListeningPort == 0) {\r | |
| 462 | Instance->ListeningPort = MTFTP4_DEFAULT_SERVER_PORT;\r | |
| 463 | }\r | |
| 464 | \r | |
| 465 | if (Instance->MaxRetry == 0) {\r | |
| 466 | Instance->MaxRetry = MTFTP4_DEFAULT_RETRY;\r | |
| 467 | }\r | |
| 468 | \r | |
| 469 | if (Instance->Timeout == 0) {\r | |
| 470 | Instance->Timeout = MTFTP4_DEFAULT_TIMEOUT;\r | |
| 471 | }\r | |
| 472 | \r | |
| 473 | //\r | |
| 474 | // Config the unicast UDP child to send initial request\r | |
| 475 | //\r | |
| 476 | Status = Mtftp4ConfigUnicastPort (Instance->UnicastPort, Instance);\r | |
| 477 | \r | |
| 478 | if (EFI_ERROR (Status)) {\r | |
| 479 | goto ON_ERROR;\r | |
| 480 | }\r | |
| 481 | \r | |
| 174f03d2 | 482 | //\r |
| 483 | // Set initial status.\r | |
| 484 | //\r | |
| 485 | Token->Status = EFI_NOT_READY;\r | |
| 486 | \r | |
| 772db4bb | 487 | //\r |
| 488 | // Build and send an initial requests\r | |
| 489 | //\r | |
| 490 | if (Operation == EFI_MTFTP4_OPCODE_WRQ) {\r | |
| 491 | Status = Mtftp4WrqStart (Instance, Operation);\r | |
| 492 | } else {\r | |
| 493 | Status = Mtftp4RrqStart (Instance, Operation);\r | |
| 494 | }\r | |
| 495 | \r | |
| e48e37fc | 496 | gBS->RestoreTPL (OldTpl);\r |
| 772db4bb | 497 | \r |
| 498 | if (EFI_ERROR (Status)) {\r | |
| 499 | goto ON_ERROR;\r | |
| 500 | }\r | |
| 772db4bb | 501 | \r |
| 502 | if (Token->Event != NULL) {\r | |
| 503 | return EFI_SUCCESS;\r | |
| 504 | }\r | |
| 505 | \r | |
| 174f03d2 | 506 | //\r |
| 507 | // Return immediately for asynchronous operation or poll the\r | |
| 508 | // instance for synchronous operation.\r | |
| 509 | //\r | |
| 772db4bb | 510 | while (Token->Status == EFI_NOT_READY) {\r |
| 511 | This->Poll (This);\r | |
| 512 | }\r | |
| 513 | \r | |
| 514 | return Token->Status;\r | |
| 515 | \r | |
| 516 | ON_ERROR:\r | |
| 517 | Mtftp4CleanOperation (Instance, Status);\r | |
| e48e37fc | 518 | gBS->RestoreTPL (OldTpl);\r |
| 772db4bb | 519 | \r |
| 520 | return Status;\r | |
| 521 | }\r | |
| 522 | \r | |
| 523 | \r | |
| 3dc3861a | 524 | /**\r |
| 525 | Reads the current operational settings.\r | |
| 526 | \r | |
| 527 | The GetModeData()function reads the current operational settings of this \r | |
| 528 | EFI MTFTPv4 Protocol driver instance.\r | |
| 529 | \r | |
| 530 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r | |
| 531 | @param ModeData Pointer to storage for the EFI MTFTPv4 Protocol\r | |
| 532 | driver mode data. \r | |
| 533 | \r | |
| 534 | @retval EFI_SUCCESS The configuration data was successfully returned.\r | |
| 535 | @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r | |
| 536 | @retval EFI_INVALID_PARAMETER This is NULL or ModeData is NULL.\r | |
| 537 | \r | |
| 538 | **/\r | |
| 539 | EFI_STATUS\r | |
| 540 | EFIAPI\r | |
| 541 | EfiMtftp4GetModeData (\r | |
| 542 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
| 543 | OUT EFI_MTFTP4_MODE_DATA *ModeData\r | |
| 544 | )\r | |
| 545 | {\r | |
| 546 | MTFTP4_PROTOCOL *Instance;\r | |
| 547 | EFI_TPL OldTpl;\r | |
| 548 | \r | |
| 549 | if ((This == NULL) || (ModeData == NULL)) {\r | |
| 550 | return EFI_INVALID_PARAMETER;\r | |
| 551 | }\r | |
| 552 | \r | |
| 553 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
| 554 | \r | |
| 555 | Instance = MTFTP4_PROTOCOL_FROM_THIS (This);\r | |
| 556 | CopyMem(&ModeData->ConfigData, &Instance->Config, sizeof (Instance->Config));\r | |
| 557 | ModeData->SupportedOptionCount = MTFTP4_SUPPORTED_OPTIONS;\r | |
| 558 | ModeData->SupportedOptoins = (UINT8 **) mMtftp4SupportedOptions;\r | |
| 559 | ModeData->UnsupportedOptionCount = 0;\r | |
| 560 | ModeData->UnsupportedOptoins = NULL;\r | |
| 561 | \r | |
| 562 | gBS->RestoreTPL (OldTpl);\r | |
| 563 | \r | |
| 564 | return EFI_SUCCESS;\r | |
| 565 | }\r | |
| 566 | \r | |
| 567 | \r | |
| 568 | \r | |
| 569 | /**\r | |
| 570 | Initializes, changes, or resets the default operational setting for this \r | |
| 571 | EFI MTFTPv4 Protocol driver instance.\r | |
| 572 | \r | |
| 573 | The Configure() function is used to set and change the configuration data for \r | |
| 574 | this EFI MTFTPv4 Protocol driver instance. The configuration data can be reset \r | |
| 575 | to startup defaults by calling Configure() with MtftpConfigData set to NULL. \r | |
| 576 | Whenever the instance is reset, any pending operation is aborted. By changing \r | |
| 577 | the EFI MTFTPv4 Protocol driver instance configuration data, the client can \r | |
| 578 | connect to different MTFTPv4 servers. The configuration parameters in \r | |
| 579 | MtftpConfigData are used as the default parameters in later MTFTPv4 operations \r | |
| 580 | and can be overridden in later operations.\r | |
| 581 | \r | |
| 582 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance\r | |
| 583 | @param ConfigData MtftpConfigDataPointer to the configuration data \r | |
| 584 | structure\r | |
| 585 | \r | |
| 586 | @retval EFI_SUCCESS The EFI MTFTPv4 Protocol driver was configured \r | |
| 587 | successfully.\r | |
| 588 | @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r | |
| 589 | 1.This is NULL.\r | |
| 590 | 2.MtftpConfigData.UseDefaultSetting is FALSE and \r | |
| 591 | MtftpConfigData.StationIp is not a valid IPv4 \r | |
| 592 | unicast address.\r | |
| 593 | 3.MtftpCofigData.UseDefaultSetting is FALSE and \r | |
| 594 | MtftpConfigData.SubnetMask is invalid.\r | |
| 595 | 4.MtftpCofigData.ServerIp is not a valid IPv4 \r | |
| 596 | unicast address.\r | |
| 597 | 5.MtftpConfigData.UseDefaultSetting is FALSE and \r | |
| 598 | MtftpConfigData.GatewayIp is not a valid IPv4 \r | |
| 599 | unicast address or is not in the same subnet \r | |
| 600 | with station address.\r | |
| 601 | @retval EFI_ACCESS_DENIED The EFI configuration could not be changed at this \r | |
| 602 | time because there is one MTFTP background operation \r | |
| 603 | in progress.\r | |
| 604 | @retval EFI_NO_MAPPING When using a default address, configuration \r | |
| 605 | (DHCP, BOOTP, RARP, etc.) has not finished yet.\r | |
| 606 | @retval EFI_UNSUPPORTED A configuration protocol (DHCP, BOOTP, RARP, etc.) \r | |
| 607 | could not be located when clients choose to use \r | |
| 608 | the default address settings.\r | |
| 609 | @retval EFI_OUT_OF_RESOURCES The EFI MTFTPv4 Protocol driver instance data could \r | |
| 610 | not be allocated.\r | |
| 611 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. \r | |
| 612 | The EFI MTFTPv4 Protocol driver instance is not \r | |
| 613 | configured.\r | |
| 614 | \r | |
| 615 | **/\r | |
| 616 | EFI_STATUS\r | |
| 617 | EFIAPI\r | |
| 618 | EfiMtftp4Configure (\r | |
| 619 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
| 620 | IN EFI_MTFTP4_CONFIG_DATA *ConfigData\r | |
| 621 | )\r | |
| 622 | {\r | |
| 623 | MTFTP4_PROTOCOL *Instance;\r | |
| 624 | EFI_TPL OldTpl;\r | |
| 625 | IP4_ADDR Ip;\r | |
| 626 | IP4_ADDR Netmask;\r | |
| 627 | IP4_ADDR Gateway;\r | |
| 628 | IP4_ADDR ServerIp;\r | |
| 629 | \r | |
| 630 | if (This == NULL) {\r | |
| 631 | return EFI_INVALID_PARAMETER;\r | |
| 632 | }\r | |
| 633 | \r | |
| 634 | Instance = MTFTP4_PROTOCOL_FROM_THIS (This);\r | |
| 635 | \r | |
| 636 | if (ConfigData == NULL) {\r | |
| 637 | //\r | |
| 638 | // Reset the operation if ConfigData is NULL\r | |
| 639 | //\r | |
| 640 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
| 641 | \r | |
| 642 | Mtftp4CleanOperation (Instance, EFI_ABORTED);\r | |
| 643 | ZeroMem (&Instance->Config, sizeof (EFI_MTFTP4_CONFIG_DATA));\r | |
| 644 | Instance->State = MTFTP4_STATE_UNCONFIGED;\r | |
| 645 | \r | |
| 646 | gBS->RestoreTPL (OldTpl);\r | |
| 647 | \r | |
| 648 | } else {\r | |
| 649 | //\r | |
| 650 | // Configure the parameters for new operation.\r | |
| 651 | //\r | |
| 652 | CopyMem (&Ip, &ConfigData->StationIp, sizeof (IP4_ADDR));\r | |
| 653 | CopyMem (&Netmask, &ConfigData->SubnetMask, sizeof (IP4_ADDR));\r | |
| 654 | CopyMem (&Gateway, &ConfigData->GatewayIp, sizeof (IP4_ADDR));\r | |
| 655 | CopyMem (&ServerIp, &ConfigData->ServerIp, sizeof (IP4_ADDR));\r | |
| 656 | \r | |
| 657 | Ip = NTOHL (Ip);\r | |
| 658 | Netmask = NTOHL (Netmask);\r | |
| 659 | Gateway = NTOHL (Gateway);\r | |
| 660 | ServerIp = NTOHL (ServerIp);\r | |
| 661 | \r | |
| f6b7393c | 662 | if (!NetIp4IsUnicast (ServerIp, 0)) {\r |
| 3dc3861a | 663 | return EFI_INVALID_PARAMETER;\r |
| 664 | }\r | |
| 665 | \r | |
| 666 | if (!ConfigData->UseDefaultSetting &&\r | |
| f6b7393c | 667 | ((!IP4_IS_VALID_NETMASK (Netmask) || !NetIp4IsUnicast (Ip, Netmask)))) {\r |
| 3dc3861a | 668 | \r |
| 669 | return EFI_INVALID_PARAMETER;\r | |
| 670 | }\r | |
| 671 | \r | |
| 672 | if ((Gateway != 0) &&\r | |
| f6b7393c | 673 | (!IP4_NET_EQUAL (Gateway, Ip, Netmask) || !NetIp4IsUnicast (Gateway, Netmask))) {\r |
| 3dc3861a | 674 | \r |
| 675 | return EFI_INVALID_PARAMETER;\r | |
| 676 | }\r | |
| 677 | \r | |
| 678 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
| 679 | \r | |
| 680 | if ((Instance->State == MTFTP4_STATE_CONFIGED) && (Instance->Operation != 0)) {\r | |
| 681 | gBS->RestoreTPL (OldTpl);\r | |
| 682 | return EFI_ACCESS_DENIED;\r | |
| 683 | }\r | |
| 684 | \r | |
| 685 | CopyMem(&Instance->Config, ConfigData, sizeof (*ConfigData));;\r | |
| 686 | Instance->State = MTFTP4_STATE_CONFIGED;\r | |
| 687 | \r | |
| 688 | gBS->RestoreTPL (OldTpl);\r | |
| 689 | }\r | |
| 690 | \r | |
| 691 | return EFI_SUCCESS;\r | |
| 692 | }\r | |
| 693 | \r | |
| 694 | \r | |
| 695 | \r | |
| 696 | /**\r | |
| 697 | Parses the options in an MTFTPv4 OACK packet.\r | |
| 698 | \r | |
| 699 | The ParseOptions() function parses the option fields in an MTFTPv4 OACK packet \r | |
| 700 | and returns the number of options that were found and optionally a list of \r | |
| 701 | pointers to the options in the packet.\r | |
| 702 | If one or more of the option fields are not valid, then EFI_PROTOCOL_ERROR is \r | |
| 703 | returned and *OptionCount and *OptionList stop at the last valid option.\r | |
| 704 | The OptionList is allocated by this function, and caller should free it when used.\r | |
| 705 | \r | |
| 706 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r | |
| 707 | @param PacketLen Length of the OACK packet to be parsed.\r | |
| 708 | @param Packet Pointer to the OACK packet to be parsed. \r | |
| 709 | @param OptionCount Pointer to the number of options in following OptionList.\r | |
| 710 | @param OptionList Pointer to EFI_MTFTP4_OPTION storage. Call the \r | |
| 711 | EFI Boot Service FreePool() to release theOptionList\r | |
| 712 | if the options in this OptionList are not needed \r | |
| 713 | any more\r | |
| 714 | \r | |
| 715 | @retval EFI_SUCCESS The OACK packet was valid and the OptionCount and\r | |
| 716 | OptionList parameters have been updated.\r | |
| 717 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
| 718 | 1.PacketLen is 0.\r | |
| 719 | 2.Packet is NULL or Packet is not a valid MTFTPv4 packet.\r | |
| 720 | 3.OptionCount is NULL.\r | |
| 721 | @retval EFI_NOT_FOUND No options were found in the OACK packet.\r | |
| 722 | @retval EFI_OUT_OF_RESOURCES Storage for the OptionList array cannot be allocated.\r | |
| 723 | @retval EFI_PROTOCOL_ERROR One or more of the option fields is invalid.\r | |
| 724 | \r | |
| 725 | **/\r | |
| 726 | EFI_STATUS\r | |
| 727 | EFIAPI\r | |
| 728 | EfiMtftp4ParseOptions (\r | |
| 729 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
| 730 | IN UINT32 PacketLen,\r | |
| 731 | IN EFI_MTFTP4_PACKET *Packet,\r | |
| 732 | OUT UINT32 *OptionCount,\r | |
| 733 | OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL\r | |
| 734 | )\r | |
| 735 | {\r | |
| 736 | EFI_STATUS Status;\r | |
| 737 | \r | |
| 738 | if ((This == NULL) || (PacketLen < MTFTP4_OPCODE_LEN) ||\r | |
| 739 | (Packet == NULL) || (OptionCount == NULL)) {\r | |
| 740 | \r | |
| 741 | return EFI_INVALID_PARAMETER;\r | |
| 742 | }\r | |
| 743 | \r | |
| 744 | Status = Mtftp4ExtractOptions (Packet, PacketLen, OptionCount, OptionList);\r | |
| 745 | \r | |
| 746 | if (EFI_ERROR (Status)) {\r | |
| 747 | return Status;\r | |
| 748 | }\r | |
| 749 | \r | |
| 750 | if (*OptionCount == 0) {\r | |
| 751 | return EFI_NOT_FOUND;\r | |
| 752 | }\r | |
| 753 | \r | |
| 754 | return EFI_SUCCESS;\r | |
| 755 | }\r | |
| 756 | \r | |
| 757 | \r | |
| 772db4bb | 758 | /**\r |
| dab714aa | 759 | Downloads a file from an MTFTPv4 server.\r |
| 760 | \r | |
| 761 | The ReadFile() function is used to initialize and start an MTFTPv4 download \r | |
| 762 | process and optionally wait for completion. When the download operation completes, \r | |
| 763 | whether successfully or not, the Token.Status field is updated by the EFI MTFTPv4 \r | |
| 764 | Protocol driver and then Token.Event is signaled (if it is not NULL).\r | |
| 765 | Data can be downloaded from the MTFTPv4 server into either of the following locations:\r | |
| 766 | 1.A fixed buffer that is pointed to by Token.Buffer\r | |
| 767 | 2.A download service function that is pointed to by Token.CheckPacket\r | |
| 768 | If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket \r | |
| 769 | will be called first. If the call is successful, the packet will be stored in \r | |
| 770 | Token.Buffer.\r | |
| 771 | \r | |
| 772 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance\r | |
| 773 | @param Token Pointer to the token structure to provide the \r | |
| 774 | parameters that are used in this operation.\r | |
| 775 | \r | |
| 776 | @retval EFI_SUCCESS The data file has been transferred successfully.\r | |
| 777 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
| 778 | @retval EFI_BUFFER_TOO_SMALL BufferSize is not large enough to hold the downloaded \r | |
| 779 | data in downloading process.\r | |
| 780 | @retval EFI_ABORTED Current operation is aborted by user.\r | |
| 781 | @retval EFI_ICMP_ERROR An ICMP ERROR packet was received.\r | |
| 782 | @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.\r | |
| 783 | @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received.\r | |
| 784 | @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r | |
| dd29f3ed | 785 | @retval EFI_NO_MEDIA There was a media error.\r |
| 772db4bb | 786 | \r |
| 787 | **/\r | |
| 772db4bb | 788 | EFI_STATUS\r |
| 789 | EFIAPI\r | |
| 790 | EfiMtftp4ReadFile (\r | |
| 791 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
| 792 | IN EFI_MTFTP4_TOKEN *Token\r | |
| 793 | )\r | |
| 794 | {\r | |
| 795 | return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_RRQ);\r | |
| 796 | }\r | |
| 797 | \r | |
| 798 | \r | |
| 799 | /**\r | |
| dab714aa | 800 | Sends a data file to an MTFTPv4 server. May be unsupported in some EFI implementations\r |
| 801 | \r | |
| 802 | The WriteFile() function is used to initialize an uploading operation with the \r | |
| 803 | given option list and optionally wait for completion. If one or more of the \r | |
| 804 | options is not supported by the server, the unsupported options are ignored and \r | |
| 805 | a standard TFTP process starts instead. When the upload process completes, \r | |
| 806 | whether successfully or not, Token.Event is signaled, and the EFI MTFTPv4 Protocol \r | |
| 807 | driver updates Token.Status.\r | |
| 808 | The caller can supply the data to be uploaded in the following two modes:\r | |
| 809 | 1.Through the user-provided buffer\r | |
| 810 | 2.Through a callback function\r | |
| 811 | With the user-provided buffer, the Token.BufferSize field indicates the length\r | |
| 812 | of the buffer, and the driver will upload the data in the buffer. With an \r | |
| 813 | EFI_MTFTP4_PACKET_NEEDED callback function, the driver will call this callback \r | |
| 814 | function to get more data from the user to upload. See the definition of \r | |
| 815 | EFI_MTFTP4_PACKET_NEEDED for more information. These two modes cannot be used at \r | |
| 816 | the same time. The callback function will be ignored if the user provides the buffer.\r | |
| 817 | \r | |
| 818 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r | |
| 819 | @param Token Pointer to the token structure to provide the \r | |
| 820 | parameters that are used in this function\r | |
| 821 | \r | |
| 822 | @retval EFI_SUCCESS The upload session has started.\r | |
| 823 | @retval EFI_UNSUPPORTED The operation is not supported by this implementation.\r | |
| 824 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
| 825 | 1. This is NULL.\r | |
| 826 | 2. Token is NULL.\r | |
| 827 | 3. Token.Filename is NULL.\r | |
| 828 | 4. Token.OptionCount is not zero and\r | |
| 829 | Token.OptionList is NULL.\r | |
| 830 | 5. One or more options in Token.OptionList have wrong\r | |
| 831 | format.\r | |
| 832 | 6. Token.Buffer and Token.PacketNeeded are both\r | |
| 833 | NULL.\r | |
| 834 | 7. One or more IPv4 addresses in Token.OverrideData \r | |
| 835 | are not valid unicast IPv4 addresses if \r | |
| 836 | Token.OverrideData is not NULL.\r | |
| 837 | @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in the\r | |
| 838 | unsupported list of structure EFI_MTFTP4_MODE_DATA.\r | |
| 839 | @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.\r | |
| 840 | @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, \r | |
| 841 | BOOTP, RARP, etc.) is not finished yet.\r | |
| 842 | @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 \r | |
| 843 | session.\r | |
| 844 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
| 845 | @retval EFI_ACCESS_DENIED The previous operation has not completed yet.\r | |
| 846 | @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r | |
| 772db4bb | 847 | \r |
| 848 | **/\r | |
| 772db4bb | 849 | EFI_STATUS\r |
| 850 | EFIAPI\r | |
| 851 | EfiMtftp4WriteFile (\r | |
| 852 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
| 853 | IN EFI_MTFTP4_TOKEN *Token\r | |
| 854 | )\r | |
| 855 | {\r | |
| 856 | return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_WRQ);\r | |
| 857 | }\r | |
| 858 | \r | |
| 859 | \r | |
| 860 | /**\r | |
| dab714aa | 861 | Downloads a data file "directory" from an MTFTPv4 server. \r |
| 862 | May be unsupported in some EFI implementations\r | |
| 863 | \r | |
| 864 | The ReadDirectory() function is used to return a list of files on the MTFTPv4 \r | |
| 865 | server that are logically (or operationally) related to Token.Filename. The \r | |
| 866 | directory request packet that is sent to the server is built with the option \r | |
| 867 | list that was provided by caller, if present.\r | |
| 868 | The file information that the server returns is put into either of the following \r | |
| 869 | locations:\r | |
| 870 | 1.A fixed buffer that is pointed to by Token.Buffer\r | |
| 871 | 2.A download service function that is pointed to by Token.CheckPacket\r | |
| 872 | If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket will \r | |
| 873 | be called first. If the call is successful, the packet will be stored in Token.Buffer.\r | |
| 874 | The returned directory listing in the Token.Buffer or EFI_MTFTP4_PACKET consists \r | |
| 875 | of a list of two or three variable-length ASCII strings, each terminated by a \r | |
| 876 | null character, for each file in the directory. If the multicast option is involved, \r | |
| 877 | the first field of each directory entry is the static multicast IP address and \r | |
| 878 | UDP port number that is associated with the file name. The format of the field \r | |
| 879 | is ip:ip:ip:ip:port. If the multicast option is not involved, this field and its \r | |
| 880 | terminating null character are not present.\r | |
| 881 | The next field of each directory entry is the file name and the last field is \r | |
| 882 | the file information string. The information string contains the file size and \r | |
| 883 | the create/modify timestamp. The format of the information string is filesize \r | |
| 884 | yyyy-mm-dd hh:mm:ss:ffff. The timestamp is Coordinated Universal Time \r | |
| 885 | (UTC; also known as Greenwich Mean Time [GMT]).\r | |
| 886 | The only difference between ReadFile and ReadDirectory is the opcode used.\r | |
| 887 | \r | |
| 888 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance\r | |
| 889 | @param Token Pointer to the token structure to provide the \r | |
| 890 | parameters that are used in this function\r | |
| 891 | \r | |
| 892 | @retval EFI_SUCCESS The MTFTPv4 related file "directory" has been downloaded.\r | |
| 893 | @retval EFI_UNSUPPORTED The operation is not supported by this implementation.\r | |
| 894 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
| 895 | 1. This is NULL.\r | |
| 896 | 2. Token is NULL.\r | |
| 897 | 3. Token.Filename is NULL.\r | |
| 898 | 4. Token.OptionCount is not zero and\r | |
| 899 | Token.OptionList is NULL.\r | |
| 900 | 5. One or more options in Token.OptionList have wrong\r | |
| 901 | format.\r | |
| 902 | 6. Token.Buffer and Token.PacketNeeded are both\r | |
| 903 | NULL.\r | |
| 904 | 7. One or more IPv4 addresses in Token.OverrideData \r | |
| 905 | are not valid unicast IPv4 addresses if \r | |
| 906 | Token.OverrideData is not NULL.\r | |
| 907 | @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in the\r | |
| 908 | unsupported list of structure EFI_MTFTP4_MODE_DATA.\r | |
| 909 | @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.\r | |
| 910 | @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, \r | |
| 911 | BOOTP, RARP, etc.) is not finished yet.\r | |
| 912 | @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 \r | |
| 913 | session.\r | |
| 914 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
| 915 | @retval EFI_ACCESS_DENIED The previous operation has not completed yet.\r | |
| 916 | @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r | |
| 772db4bb | 917 | \r |
| 918 | **/\r | |
| 772db4bb | 919 | EFI_STATUS\r |
| 920 | EFIAPI\r | |
| 921 | EfiMtftp4ReadDirectory (\r | |
| 922 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
| 923 | IN EFI_MTFTP4_TOKEN *Token\r | |
| 924 | )\r | |
| 925 | {\r | |
| 926 | return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_DIR);\r | |
| 927 | }\r | |
| 928 | \r | |
| 929 | \r | |
| 930 | /**\r | |
| dab714aa | 931 | Gets information about a file from an MTFTPv4 server. \r |
| 932 | \r | |
| 933 | The GetInfo() function assembles an MTFTPv4 request packet with options; \r | |
| 934 | sends it to the MTFTPv4 server; and may return an MTFTPv4 OACK, MTFTPv4 ERROR, \r | |
| 935 | or ICMP ERROR packet. Retries occur only if no response packets are received \r | |
| 936 | from the MTFTPv4 server before the timeout expires.\r | |
| 937 | It is implemented with EfiMtftp4ReadFile: build a token, then pass it to \r | |
| 938 | EfiMtftp4ReadFile. In its check packet callback abort the opertions.\r | |
| 939 | \r | |
| 940 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance\r | |
| 941 | @param OverrideData Data that is used to override the existing \r | |
| 942 | parameters. If NULL, the default parameters that \r | |
| 943 | were set in the EFI_MTFTP4_PROTOCOL.Configure() \r | |
| 944 | function are used\r | |
| 4f077902 SZ |
945 | @param Filename Pointer to null-terminated ASCII file name string\r |
| 946 | @param ModeStr Pointer to null-terminated ASCII mode string. If NULL, "octet" \r | |
| dab714aa | 947 | will be used\r |
| 948 | @param OptionCount Number of option/value string pairs in OptionList\r | |
| 949 | @param OptionList Pointer to array of option/value string pairs. \r | |
| 950 | Ignored if OptionCount is zero\r | |
| 951 | @param PacketLength The number of bytes in the returned packet\r | |
| 952 | @param Packet PacketThe pointer to the received packet. This \r | |
| 953 | buffer must be freed by the caller.\r | |
| 954 | \r | |
| 955 | @retval EFI_SUCCESS An MTFTPv4 OACK packet was received and is in \r | |
| 956 | the Buffer.\r | |
| 957 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
| 958 | 1.This is NULL.\r | |
| 959 | 2.Filename is NULL.\r | |
| 960 | 3.OptionCount is not zero and OptionList is NULL.\r | |
| 961 | 4.One or more options in OptionList have wrong format.\r | |
| 962 | 5.PacketLength is NULL.\r | |
| 963 | 6.One or more IPv4 addresses in OverrideData are \r | |
| 964 | not valid unicast IPv4 addresses if OverrideData \r | |
| 965 | is not NULL.\r | |
| 966 | @retval EFI_UNSUPPORTED One or more options in the OptionList are in the\r | |
| 967 | unsupported list of structure EFI_MTFTP4_MODE_DATA\r | |
| 968 | @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.\r | |
| 969 | @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, \r | |
| 970 | BOOTP, RARP, etc.) has not finished yet.\r | |
| 971 | @retval EFI_ACCESS_DENIED The previous operation has not completed yet.\r | |
| 972 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
| 973 | @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received and is in \r | |
| 974 | the Buffer.\r | |
| 975 | @retval EFI_ICMP_ERROR An ICMP ERROR packet was received and the Packet \r | |
| 976 | is set to NULL.\r | |
| 977 | @retval EFI_PROTOCOL_ERROR An unexpected MTFTPv4 packet was received and is \r | |
| 978 | in the Buffer.\r | |
| 979 | @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.\r | |
| 980 | @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r | |
| dd29f3ed | 981 | @retval EFI_NO_MEDIA There was a media error.\r |
| 982 | \r | |
| dab714aa | 983 | **/\r |
| 984 | EFI_STATUS\r | |
| 985 | EFIAPI\r | |
| 986 | EfiMtftp4GetInfo (\r | |
| 987 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
| 988 | IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData OPTIONAL,\r | |
| 989 | IN UINT8 *Filename,\r | |
| 990 | IN UINT8 *ModeStr OPTIONAL,\r | |
| 991 | IN UINT8 OptionCount,\r | |
| 992 | IN EFI_MTFTP4_OPTION *OptionList OPTIONAL,\r | |
| 993 | OUT UINT32 *PacketLength,\r | |
| 994 | OUT EFI_MTFTP4_PACKET **Packet OPTIONAL\r | |
| 995 | )\r | |
| 996 | {\r | |
| 997 | EFI_MTFTP4_TOKEN Token;\r | |
| ea886bef | 998 | MTFTP4_GETINFO_STATE State;\r |
| dab714aa | 999 | EFI_STATUS Status;\r |
| 1000 | \r | |
| 1001 | if ((This == NULL) || (Filename == NULL) || (PacketLength == NULL) ||\r | |
| 1002 | ((OptionCount != 0) && (OptionList == NULL))) {\r | |
| 1003 | return EFI_INVALID_PARAMETER;\r | |
| 1004 | }\r | |
| 1005 | \r | |
| 1006 | if (Packet != NULL) {\r | |
| 1007 | *Packet = NULL;\r | |
| 1008 | }\r | |
| 1009 | \r | |
| 1010 | *PacketLength = 0;\r | |
| ea886bef | 1011 | State.Packet = Packet;\r |
| 1012 | State.PacketLen = PacketLength;\r | |
| 1013 | State.Status = EFI_SUCCESS;\r | |
| dab714aa | 1014 | \r |
| 1015 | //\r | |
| 1016 | // Fill in the Token to issue an synchronous ReadFile operation\r | |
| 1017 | //\r | |
| 1018 | Token.Status = EFI_SUCCESS;\r | |
| 1019 | Token.Event = NULL;\r | |
| 1020 | Token.OverrideData = OverrideData;\r | |
| 1021 | Token.Filename = Filename;\r | |
| 1022 | Token.ModeStr = ModeStr;\r | |
| 1023 | Token.OptionCount = OptionCount;\r | |
| 1024 | Token.OptionList = OptionList;\r | |
| 1025 | Token.BufferSize = 0;\r | |
| 1026 | Token.Buffer = NULL;\r | |
| ea886bef | 1027 | Token.Context = &State;\r |
| dab714aa | 1028 | Token.CheckPacket = Mtftp4GetInfoCheckPacket;\r |
| 1029 | Token.TimeoutCallback = NULL;\r | |
| 1030 | Token.PacketNeeded = NULL;\r | |
| 1031 | \r | |
| 1032 | Status = EfiMtftp4ReadFile (This, &Token);\r | |
| 772db4bb | 1033 | \r |
| dab714aa | 1034 | if (EFI_ABORTED == Status) {\r |
| ea886bef | 1035 | return State.Status;\r |
| dab714aa | 1036 | }\r |
| 1037 | \r | |
| 1038 | return Status;\r | |
| 1039 | }\r | |
| 772db4bb | 1040 | \r |
| dab714aa | 1041 | /**\r |
| 1042 | Polls for incoming data packets and processes outgoing data packets.\r | |
| 1043 | \r | |
| 1044 | The Poll() function can be used by network drivers and applications to increase \r | |
| 1045 | the rate that data packets are moved between the communications device and the \r | |
| 1046 | transmit and receive queues.\r | |
| 1047 | In some systems, the periodic timer event in the managed network driver may not \r | |
| 1048 | poll the underlying communications device fast enough to transmit and/or receive \r | |
| 1049 | all data packets without missing incoming packets or dropping outgoing packets. \r | |
| 1050 | Drivers and applications that are experiencing packet loss should try calling \r | |
| 1051 | the Poll() function more often.\r | |
| 1052 | \r | |
| 1053 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance\r | |
| 1054 | \r | |
| 1055 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r | |
| 1056 | @retval EFI_NOT_STARTED This EFI MTFTPv4 Protocol instance has not been started.\r | |
| 1057 | @retval EFI_NO_MAPPING When using a default address, configuration (DHCP,\r | |
| 1058 | BOOTP, RARP, etc.) is not finished yet.\r | |
| 772db4bb | 1059 | @retval EFI_INVALID_PARAMETER This is NULL.\r |
| dab714aa | 1060 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r |
| 1061 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive \r | |
| 1062 | queue. Consider increasing the polling rate.\r | |
| 772db4bb | 1063 | \r |
| 1064 | **/\r | |
| 772db4bb | 1065 | EFI_STATUS\r |
| 1066 | EFIAPI\r | |
| 1067 | EfiMtftp4Poll (\r | |
| 1068 | IN EFI_MTFTP4_PROTOCOL *This\r | |
| 1069 | )\r | |
| 1070 | {\r | |
| 1071 | MTFTP4_PROTOCOL *Instance;\r | |
| 1072 | EFI_UDP4_PROTOCOL *Udp;\r | |
| 1073 | \r | |
| 1074 | if (This == NULL) {\r | |
| 1075 | return EFI_INVALID_PARAMETER;\r | |
| 1076 | }\r | |
| 1077 | \r | |
| 1078 | Instance = MTFTP4_PROTOCOL_FROM_THIS (This);\r | |
| 1079 | \r | |
| 1080 | if (Instance->State == MTFTP4_STATE_UNCONFIGED) {\r | |
| 1081 | return EFI_NOT_STARTED;\r | |
| 75dce340 | 1082 | } else if (Instance->State == MTFTP4_STATE_DESTROY) {\r |
| 772db4bb | 1083 | return EFI_DEVICE_ERROR;\r |
| 1084 | }\r | |
| 1085 | \r | |
| b45b45b2 | 1086 | Udp = Instance->UnicastPort->Protocol.Udp4;\r |
| 772db4bb | 1087 | return Udp->Poll (Udp);\r |
| 1088 | }\r | |
| 1089 | \r | |
| 1090 | EFI_MTFTP4_PROTOCOL gMtftp4ProtocolTemplate = {\r | |
| 1091 | EfiMtftp4GetModeData,\r | |
| 1092 | EfiMtftp4Configure,\r | |
| 1093 | EfiMtftp4GetInfo,\r | |
| 1094 | EfiMtftp4ParseOptions,\r | |
| 1095 | EfiMtftp4ReadFile,\r | |
| 1096 | EfiMtftp4WriteFile,\r | |
| 1097 | EfiMtftp4ReadDirectory,\r | |
| 1098 | EfiMtftp4Poll\r | |
| 1099 | };\r |