/** @file\r
Support functions declaration for UEFI HTTP boot driver.\r
\r
-Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under \r
the terms and conditions of the BSD License that accompanies this distribution. \r
The full text of the license may be found at\r
IN CHAR8 *FieldValue\r
);\r
\r
+///\r
+/// HTTP_IO_CALLBACK_EVENT\r
+///\r
+typedef enum {\r
+ HttpIoRequest,\r
+ HttpIoResponse\r
+} HTTP_IO_CALLBACK_EVENT;\r
+\r
+/**\r
+ HttpIo Callback function which will be invoked when specified HTTP_IO_CALLBACK_EVENT happened.\r
+\r
+ @param[in] EventType Indicate the Event type that occurs in the current callback.\r
+ @param[in] Message HTTP message which will be send to, or just received from HTTP server.\r
+ @param[in] Context The Callback Context pointer.\r
+ \r
+ @retval EFI_SUCCESS Tells the HttpIo to continue the HTTP process.\r
+ @retval Others Tells the HttpIo to abort the current HTTP process.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI * HTTP_IO_CALLBACK) (\r
+ IN HTTP_IO_CALLBACK_EVENT EventType,\r
+ IN EFI_HTTP_MESSAGE *Message,\r
+ IN VOID *Context\r
+ );\r
+\r
//\r
// HTTP_IO configuration data for IPv4\r
//\r
\r
EFI_HTTP_PROTOCOL *Http;\r
\r
+ HTTP_IO_CALLBACK Callback;\r
+ VOID *Context;\r
+\r
EFI_HTTP_TOKEN ReqToken;\r
EFI_HTTP_MESSAGE ReqMessage;\r
EFI_HTTP_TOKEN RspToken;\r
\r
BOOLEAN IsTxDone;\r
BOOLEAN IsRxDone;\r
+\r
+ EFI_EVENT TimeoutEvent;\r
} HTTP_IO;\r
\r
//\r
@param[in] Controller The handle of the controller.\r
@param[in] IpVersion IP_VERSION_4 or IP_VERSION_6.\r
@param[in] ConfigData The HTTP_IO configuration data.\r
+ @param[in] Callback Callback function which will be invoked when specified\r
+ HTTP_IO_CALLBACK_EVENT happened.\r
+ @param[in] Context The Context data which will be passed to the Callback function.\r
@param[out] HttpIo The HTTP_IO.\r
\r
@retval EFI_SUCCESS The HTTP_IO is created and configured.\r
IN EFI_HANDLE Controller,\r
IN UINT8 IpVersion,\r
IN HTTP_IO_CONFIG_DATA *ConfigData,\r
+ IN HTTP_IO_CALLBACK Callback,\r
+ IN VOID *Context,\r
OUT HTTP_IO *HttpIo\r
);\r
\r
OUT HTTP_IO_RESPONSE_DATA *ResponseData\r
);\r
\r
+/**\r
+ This function checks the HTTP(S) URI scheme.\r
+\r
+ @param[in] Uri The pointer to the URI string.\r
+ \r
+ @retval EFI_SUCCESS The URI scheme is valid.\r
+ @retval EFI_INVALID_PARAMETER The URI scheme is not HTTP or HTTPS.\r
+ @retval EFI_ACCESS_DENIED HTTP is disabled and the URI is HTTP.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootCheckUriScheme (\r
+ IN CHAR8 *Uri\r
+ );\r
+\r
+/**\r
+ Get the URI address string from the input device path.\r
+\r
+ Caller need to free the buffer in the UriAddress pointer.\r
+ \r
+ @param[in] FilePath Pointer to the device path which contains a URI device path node.\r
+ @param[out] UriAddress The URI address string extract from the device path.\r
+ \r
+ @retval EFI_SUCCESS The URI string is returned.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootParseFilePath (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r
+ OUT CHAR8 **UriAddress\r
+ );\r
+\r
+/**\r
+ This function returns the image type according to server replied HTTP message\r
+ and also the image's URI info.\r
+\r
+ @param[in] Uri The pointer to the image's URI string.\r
+ @param[in] UriParser URI Parse result returned by NetHttpParseUrl(). \r
+ @param[in] HeaderCount Number of HTTP header structures in Headers list. \r
+ @param[in] Headers Array containing list of HTTP headers.\r
+ @param[out] ImageType The image type of the downloaded file.\r
+ \r
+ @retval EFI_SUCCESS The image type is returned in ImageType.\r
+ @retval EFI_INVALID_PARAMETER ImageType, Uri or UriParser is NULL.\r
+ @retval EFI_INVALID_PARAMETER HeaderCount is not zero, and Headers is NULL.\r
+ @retval EFI_NOT_FOUND Failed to identify the image type.\r
+ @retval Others Unexpect error happened.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootCheckImageType (\r
+ IN CHAR8 *Uri,\r
+ IN VOID *UriParser,\r
+ IN UINTN HeaderCount,\r
+ IN EFI_HTTP_HEADER *Headers,\r
+ OUT HTTP_BOOT_IMAGE_TYPE *ImageType\r
+ );\r
+\r
+/**\r
+ This function register the RAM disk info to the system.\r
+ \r
+ @param[in] Private The pointer to the driver's private data.\r
+ @param[in] BufferSize The size of Buffer in bytes.\r
+ @param[in] Buffer The base address of the RAM disk.\r
+ @param[in] ImageType The image type of the file in Buffer.\r
+\r
+ @retval EFI_SUCCESS The RAM disk has been registered.\r
+ @retval EFI_NOT_FOUND No RAM disk protocol instances were found.\r
+ @retval EFI_UNSUPPORTED The ImageType is not supported.\r
+ @retval Others Unexpected error happened.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootRegisterRamDisk (\r
+ IN HTTP_BOOT_PRIVATE_DATA *Private,\r
+ IN UINTN BufferSize,\r
+ IN VOID *Buffer,\r
+ IN HTTP_BOOT_IMAGE_TYPE ImageType\r
+ );\r
+\r
+/**\r
+ Indicate if the HTTP status code indicates a redirection.\r
+ \r
+ @param[in] StatusCode HTTP status code from server.\r
+\r
+ @return TRUE if it's redirection.\r
+\r
+**/\r
+BOOLEAN\r
+HttpBootIsHttpRedirectStatusCode (\r
+ IN EFI_HTTP_STATUS_CODE StatusCode\r
+ );\r
#endif\r