+++ /dev/null
-/*++\r
-\r
-Copyright (c) 2006 - 2007, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials \r
-are licensed and made available under the terms and conditions of the BSD License \r
-which accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
-\r
-Module Name:\r
-\r
- Mtftp4.h\r
-\r
-Abstract:\r
-\r
- UEFI Multicast Trivial File Tranfer Protocol Definition\r
- \r
---*/\r
-\r
-#ifndef __EFI_MTFTP4_H__\r
-#define __EFI_MTFTP4_H__\r
-\r
-#include EFI_PROTOCOL_DEFINITION(ServiceBinding)\r
-\r
-#define EFI_MTFTP4_SERVICE_BINDING_PROTOCOL_GUID \\r
- { 0x2FE800BE, 0x8F01, 0x4aa6, {0x94, 0x6B, 0xD7, 0x13, 0x88, 0xE1, 0x83, 0x3F} }\r
-\r
-#define EFI_MTFTP4_PROTOCOL_GUID \\r
- { 0x78247c57, 0x63db, 0x4708, {0x99, 0xc2, 0xa8, 0xb4, 0xa9, 0xa6, 0x1f, 0x6b} }\r
-\r
-EFI_FORWARD_DECLARATION (EFI_MTFTP4_PROTOCOL);\r
-EFI_FORWARD_DECLARATION (EFI_MTFTP4_TOKEN);\r
-\r
-extern EFI_GUID gEfiMtftp4ServiceBindingProtocolGuid;\r
-extern EFI_GUID gEfiMtftp4ProtocolGuid;\r
-\r
-\r
-//\r
-//MTFTP4 packet opcode definition\r
-//\r
-#define EFI_MTFTP4_OPCODE_RRQ 1\r
-#define EFI_MTFTP4_OPCODE_WRQ 2\r
-#define EFI_MTFTP4_OPCODE_DATA 3\r
-#define EFI_MTFTP4_OPCODE_ACK 4\r
-#define EFI_MTFTP4_OPCODE_ERROR 5\r
-#define EFI_MTFTP4_OPCODE_OACK 6\r
-#define EFI_MTFTP4_OPCODE_DIR 7\r
-#define EFI_MTFTP4_OPCODE_DATA8 8\r
-#define EFI_MTFTP4_OPCODE_ACK8 9\r
-\r
-//\r
-//MTFTP4 error code definition\r
-//\r
-#define EFI_MTFTP4_ERRORCODE_NOT_DEFINED 0\r
-#define EFI_MTFTP4_ERRORCODE_FILE_NOT_FOUND 1\r
-#define EFI_MTFTP4_ERRORCODE_ACCESS_VIOLATION 2\r
-#define EFI_MTFTP4_ERRORCODE_DISK_FULL 3\r
-#define EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION 4\r
-#define EFI_MTFTP4_ERRORCODE_UNKNOWN_TRANSFER_ID 5\r
-#define EFI_MTFTP4_ERRORCODE_FILE_ALREADY_EXISTS 6\r
-#define EFI_MTFTP4_ERRORCODE_NO_SUCH_USER 7\r
-#define EFI_MTFTP4_ERRORCODE_REQUEST_DENIED 8\r
-\r
-\r
-//\r
-//MTFTP4 pacekt definition\r
-//\r
-#pragma pack(1)\r
-\r
-typedef struct {\r
- UINT16 OpCode;\r
- UINT8 Filename[1];\r
-} EFI_MTFTP4_REQ_HEADER;\r
-\r
-typedef struct {\r
- UINT16 OpCode;\r
- UINT8 Data[1];\r
-} EFI_MTFTP4_OACK_HEADER;\r
-\r
-typedef struct {\r
- UINT16 OpCode;\r
- UINT16 Block;\r
- UINT8 Data[1];\r
-} EFI_MTFTP4_DATA_HEADER;\r
-\r
-typedef struct {\r
- UINT16 OpCode;\r
- UINT16 Block[1];\r
-} EFI_MTFTP4_ACK_HEADER;\r
-\r
-typedef struct {\r
- UINT16 OpCode;\r
- UINT64 Block;\r
- UINT8 Data[1];\r
-} EFI_MTFTP4_DATA8_HEADER;\r
-\r
-typedef struct {\r
- UINT16 OpCode;\r
- UINT64 Block[1];\r
-} EFI_MTFTP4_ACK8_HEADER;\r
-\r
-typedef struct {\r
- UINT16 OpCode;\r
- UINT16 ErrorCode;\r
- UINT8 ErrorMessage[1];\r
-} EFI_MTFTP4_ERROR_HEADER;\r
-\r
-typedef union {\r
- UINT16 OpCode;\r
- EFI_MTFTP4_REQ_HEADER Rrq;\r
- EFI_MTFTP4_REQ_HEADER Wrq;\r
- EFI_MTFTP4_OACK_HEADER Oack;\r
- EFI_MTFTP4_DATA_HEADER Data;\r
- EFI_MTFTP4_ACK_HEADER Ack;\r
- EFI_MTFTP4_DATA8_HEADER Data8;\r
- EFI_MTFTP4_ACK8_HEADER Ack8;\r
- EFI_MTFTP4_ERROR_HEADER Error;\r
-} EFI_MTFTP4_PACKET;\r
-\r
-#pragma pack()\r
-\r
-//\r
-//MTFTP4 option definition\r
-//\r
-typedef struct {\r
- UINT8 *OptionStr;\r
- UINT8 *ValueStr;\r
-} EFI_MTFTP4_OPTION;\r
-\r
-//\r
-//MTFTP4 config data\r
-//\r
-typedef struct {\r
- BOOLEAN UseDefaultSetting;\r
- EFI_IPv4_ADDRESS StationIp;\r
- EFI_IPv4_ADDRESS SubnetMask;\r
- UINT16 LocalPort;\r
- EFI_IPv4_ADDRESS GatewayIp;\r
- EFI_IPv4_ADDRESS ServerIp;\r
- UINT16 InitialServerPort;\r
- UINT16 TryCount;\r
- UINT16 TimeoutValue;\r
-} EFI_MTFTP4_CONFIG_DATA;\r
-\r
-//\r
-//MTFTP4 Mode data\r
-//\r
-typedef struct {\r
- EFI_MTFTP4_CONFIG_DATA ConfigData;\r
- UINT8 SupportedOptionCount; \r
- UINT8 **SupportedOptoins;\r
- UINT8 UnsupportedOptionCount; \r
- UINT8 **UnsupportedOptoins;\r
-} EFI_MTFTP4_MODE_DATA;\r
-\r
-\r
-//\r
-//MTFTP4 override data\r
-//\r
-typedef struct {\r
- EFI_IPv4_ADDRESS GatewayIp;\r
- EFI_IPv4_ADDRESS ServerIp;\r
- UINT16 ServerPort;\r
- UINT16 TryCount;\r
- UINT16 TimeoutValue;\r
-} EFI_MTFTP4_OVERRIDE_DATA;\r
-\r
-\r
-//\r
-//Packet checking function\r
-//\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_CHECK_PACKET)( \r
- IN EFI_MTFTP4_PROTOCOL *This,\r
- IN EFI_MTFTP4_TOKEN *Token,\r
- IN UINT16 PacketLen,\r
- IN EFI_MTFTP4_PACKET *Paket\r
- );\r
-\r
-//\r
-//Timeout callback funtion\r
-//\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_TIMEOUT_CALLBACK) ( \r
- IN EFI_MTFTP4_PROTOCOL *This,\r
- IN EFI_MTFTP4_TOKEN *Token\r
- );\r
-\r
-//\r
-//Packet needed function\r
-//\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_PACKET_NEEDED) ( \r
- IN EFI_MTFTP4_PROTOCOL *This,\r
- IN EFI_MTFTP4_TOKEN *Token,\r
- IN OUT UINT16 *Length,\r
- OUT VOID **Buffer\r
- );\r
-\r
-\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_GET_MODE_DATA) (\r
- IN EFI_MTFTP4_PROTOCOL *This,\r
- OUT EFI_MTFTP4_MODE_DATA *ModeData\r
- );\r
-\r
-\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_CONFIGURE) (\r
- IN EFI_MTFTP4_PROTOCOL *This,\r
- IN EFI_MTFTP4_CONFIG_DATA *MtftpConfigData OPTIONAL\r
- );\r
-\r
-\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_GET_INFO) (\r
- IN EFI_MTFTP4_PROTOCOL *This,\r
- IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData OPTIONAL,\r
- IN UINT8 *Filename,\r
- IN UINT8 *ModeStr OPTIONAL,\r
- IN UINT8 OptionCount,\r
- IN EFI_MTFTP4_OPTION *OptionList,\r
- OUT UINT32 *PacketLength,\r
- OUT EFI_MTFTP4_PACKET **Packet OPTIONAL\r
- );\r
-\r
-\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_PARSE_OPTIONS) (\r
- IN EFI_MTFTP4_PROTOCOL *This,\r
- IN UINT32 PacketLen,\r
- IN EFI_MTFTP4_PACKET *Packet,\r
- OUT UINT32 *OptionCount,\r
- OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL\r
- );\r
-\r
-\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_READ_FILE) (\r
- IN EFI_MTFTP4_PROTOCOL *This,\r
- IN EFI_MTFTP4_TOKEN *Token\r
- );\r
-\r
-\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_WRITE_FILE) (\r
- IN EFI_MTFTP4_PROTOCOL *This,\r
- IN EFI_MTFTP4_TOKEN *Token\r
- );\r
-\r
-\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_READ_DIRECTORY) (\r
- IN EFI_MTFTP4_PROTOCOL *This,\r
- IN EFI_MTFTP4_TOKEN *Token\r
- );\r
-\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_MTFTP4_POLL) (\r
- IN EFI_MTFTP4_PROTOCOL *This\r
-);\r
-\r
-\r
-struct _EFI_MTFTP4_PROTOCOL {\r
- EFI_MTFTP4_GET_MODE_DATA GetModeData;\r
- EFI_MTFTP4_CONFIGURE Configure;\r
- EFI_MTFTP4_GET_INFO GetInfo;\r
- EFI_MTFTP4_PARSE_OPTIONS ParseOptions;\r
- EFI_MTFTP4_READ_FILE ReadFile;\r
- EFI_MTFTP4_WRITE_FILE WriteFile;\r
- EFI_MTFTP4_READ_DIRECTORY ReadDirectory;\r
- EFI_MTFTP4_POLL Poll;\r
-};\r
-\r
-//\r
-//MTFTP4 token data\r
-//\r
-struct _EFI_MTFTP4_TOKEN{\r
- IN OUT EFI_STATUS Status;\r
- IN EFI_EVENT Event;\r
- IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData;\r
- IN UINT8 *Filename;\r
- IN UINT8 *ModeStr;\r
- IN UINT32 OptionCount;\r
- IN EFI_MTFTP4_OPTION *OptionList;\r
- IN OUT UINT64 BufferSize;\r
- IN OUT VOID *Buffer;\r
- IN VOID *Context;\r
- IN EFI_MTFTP4_CHECK_PACKET CheckPacket;\r
- IN EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback;\r
- IN EFI_MTFTP4_PACKET_NEEDED PacketNeeded;\r
-};\r
-\r
-#endif\r
-\r
projects / mirror_edk2.git / blobdiff