[mirror_edk2.git] / NetworkPkg / Mtftp6Dxe / Mtftp6Support.h

/** @file\r
  Mtftp6 support functions declaration.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __EFI_MTFTP6_SUPPORT_H__\r
#define __EFI_MTFTP6_SUPPORT_H__\r
\r
//\r
// The structure representing a range of block numbers, [Start, End].\r
// It is used to remember the holes in the MTFTP block space. If all\r
// the holes are filled in, then the download or upload has completed.\r
//\r
typedef struct {\r
  LIST_ENTRY    Link;\r
  INTN          Start;\r
  INTN          End;\r
  INTN          Round;\r
  INTN          Bound;\r
} MTFTP6_BLOCK_RANGE;\r
\r
/**\r
  Initialize the block range for either RRQ or WRQ. RRQ and WRQ have\r
  different requirements for Start and End. For example, during startup,\r
  WRQ initializes its whole valid block range to [0, 0xffff]. This\r
  is because the server will send an ACK0 to inform the user to start the\r
  upload. When the client receives an ACK0, it will remove 0 from the range,\r
  get the next block number, which is 1, then upload the BLOCK1. For RRQ\r
  without option negotiation, the server will directly send us the BLOCK1\r
  in response to the client's RRQ. When BLOCK1 is received, the client will\r
  remove it from the block range and send an ACK. It also works if there\r
  is option negotiation.\r
\r
  @param[in]  Head                   The block range head to initialize.\r
  @param[in]  Start                  The Start block number.\r
  @param[in]  End                    The last block number.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory for initial block range.\r
  @retval EFI_SUCCESS            The initial block range is created.\r
\r
**/\r
EFI_STATUS\r
Mtftp6InitBlockRange (\r
  IN LIST_ENTRY  *Head,\r
  IN UINT16      Start,\r
  IN UINT16      End\r
  );\r
\r
/**\r
  Get the first valid block number on the range list.\r
\r
  @param[in]  Head                   The block range head.\r
\r
  @retval     ==-1                   If the block range is empty.\r
  @retval     >-1                    The first valid block number.\r
\r
**/\r
INTN\r
Mtftp6GetNextBlockNum (\r
  IN LIST_ENTRY  *Head\r
  );\r
\r
/**\r
  Set the last block number of the block range list. It\r
  removes all the blocks after the Last. MTFTP initialize the\r
  block range to the maximum possible range, such as [0, 0xffff]\r
  for WRQ. When it gets the last block number, it calls\r
  this function to set the last block number.\r
\r
  @param[in]  Head                   The block range list.\r
  @param[in]  Last                   The last block number.\r
\r
**/\r
VOID\r
Mtftp6SetLastBlockNum (\r
  IN LIST_ENTRY  *Head,\r
  IN UINT16      Last\r
  );\r
\r
/**\r
  Remove the block number from the block range list.\r
\r
  @param[in]  Head                   The block range list to remove from.\r
  @param[in]  Num                    The block number to remove.\r
  @param[in]  Completed              Whether Num is the last block number.\r
  @param[out] BlockCounter           The continuous block counter instead of the value after roll-over.\r
\r
  @retval EFI_NOT_FOUND          The block number isn't in the block range list.\r
  @retval EFI_SUCCESS            The block number has been removed from the list.\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate resources.\r
\r
**/\r
EFI_STATUS\r
Mtftp6RemoveBlockNum (\r
  IN LIST_ENTRY  *Head,\r
  IN UINT16      Num,\r
  IN BOOLEAN     Completed,\r
  OUT UINT64     *BlockCounter\r
  );\r
\r
/**\r
  Build and transmit the request packet for the Mtftp6 instance.\r
\r
  @param[in]  Instance               The pointer to the Mtftp6 instance.\r
  @param[in]  Operation              The operation code of this packet.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory for the request.\r
  @retval EFI_SUCCESS            The request was built and sent.\r
  @retval Others                 Failed to transmit the packet.\r
\r
**/\r
EFI_STATUS\r
Mtftp6SendRequest (\r
  IN MTFTP6_INSTANCE  *Instance,\r
  IN UINT16           Operation\r
  );\r
\r
/**\r
  Build and send an error packet.\r
\r
  @param[in]  Instance               The pointer to the Mtftp6 instance.\r
  @param[in]  ErrCode                The error code in the packet.\r
  @param[in]  ErrInfo                The error message in the packet.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory for the error packet.\r
  @retval EFI_SUCCESS            The error packet was transmitted.\r
  @retval Others                 Failed to transmit the packet.\r
\r
**/\r
EFI_STATUS\r
Mtftp6SendError (\r
  IN MTFTP6_INSTANCE  *Instance,\r
  IN UINT16           ErrCode,\r
  IN UINT8            *ErrInfo\r
  );\r
\r
/**\r
  Send the packet for the Mtftp6 instance.\r
\r
  @param[in]  Instance               The pointer to the Mtftp6 instance.\r
  @param[in]  Packet                 The pointer to the packet to be sent.\r
\r
  @retval EFI_SUCCESS            The packet was sent out\r
  @retval Others                 Failed to transmit the packet.\r
\r
**/\r
EFI_STATUS\r
Mtftp6TransmitPacket (\r
  IN MTFTP6_INSTANCE  *Instance,\r
  IN NET_BUF          *Packet\r
  );\r
\r
/**\r
  Check packet for GetInfo callback routine.\r
\r
  @param[in]  This                   The pointer to the Mtftp6 protocol.\r
  @param[in]  Token                  The pointer to the Mtftp6 token.\r
  @param[in]  PacketLen              The length of the packet\r
  @param[in]  Packet                 The pointer to the received packet.\r
\r
  @retval EFI_SUCCESS            The check process passed successfully.\r
  @retval EFI_ABORTED            Abort the Mtftp6 operation.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Mtftp6CheckPacket (\r
  IN EFI_MTFTP6_PROTOCOL  *This,\r
  IN EFI_MTFTP6_TOKEN     *Token,\r
  IN UINT16               PacketLen,\r
  IN EFI_MTFTP6_PACKET    *Packet\r
  );\r
\r
/**\r
  The dummy configure routine for create a new Udp6 Io.\r
\r
  @param[in]  UdpIo                  The pointer to the Udp6 Io.\r
  @param[in]  Context                The pointer to the context.\r
\r
  @retval EFI_SUCCESS                The value is always returned.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Mtftp6ConfigDummyUdpIo (\r
  IN UDP_IO  *UdpIo,\r
  IN VOID    *Context\r
  );\r
\r
/**\r
  The configure routine for the Mtftp6 instance to transmit/receive.\r
\r
  @param[in]  UdpIo                  The pointer to the Udp6 Io.\r
  @param[in]  ServerIp               The pointer to the server address.\r
  @param[in]  ServerPort             The pointer to the server port.\r
  @param[in]  LocalIp                The pointer to the local address.\r
  @param[in]  LocalPort              The pointer to the local port.\r
\r
  @retval EFI_SUCCESS            Configure the Udp6 Io for Mtftp6 successfully.\r
  @retval EFI_NO_MAPPING         The corresponding Ip6 instance has not been\r
                                 configured yet.\r
\r
**/\r
EFI_STATUS\r
Mtftp6ConfigUdpIo (\r
  IN UDP_IO            *UdpIo,\r
  IN EFI_IPv6_ADDRESS  *ServerIp,\r
  IN UINT16            ServerPort,\r
  IN EFI_IPv6_ADDRESS  *LocalIp,\r
  IN UINT16            LocalPort\r
  );\r
\r
/**\r
  Clean up the current Mtftp6 operation.\r
\r
  @param[in]  Instance               The pointer to the Mtftp6 instance.\r
  @param[in]  Result                 The result to be returned to the user.\r
\r
**/\r
VOID\r
Mtftp6OperationClean (\r
  IN MTFTP6_INSTANCE  *Instance,\r
  IN EFI_STATUS       Result\r
  );\r
\r
/**\r
  Start the Mtftp6 instance to perform the operation, such as read file,\r
  write file, and read directory.\r
\r
  @param[in]  This                   The MTFTP session\r
  @param[in]  Token                  The token that encapsulates the user's request.\r
  @param[in]  OpCode                 The operation to perform.\r
\r
  @retval EFI_INVALID_PARAMETER  Some of the parameters are invalid.\r
  @retval EFI_NOT_STARTED        The MTFTP session hasn't been configured.\r
  @retval EFI_ALREADY_STARTED    There is pending operation for the session.\r
  @retval EFI_SUCCESS            The operation was successfully started.\r
\r
**/\r
EFI_STATUS\r
Mtftp6OperationStart (\r
  IN EFI_MTFTP6_PROTOCOL  *This,\r
  IN EFI_MTFTP6_TOKEN     *Token,\r
  IN UINT16               OpCode\r
  );\r
\r
/**\r
  The timer ticking routine for the Mtftp6 instance.\r
\r
  @param[in]  Event                  The pointer to the ticking event.\r
  @param[in]  Context                The pointer to the context.\r
\r
**/\r
VOID\r
EFIAPI\r
Mtftp6OnTimerTick (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  );\r
\r
/**\r
  The packet process callback for Mtftp6 upload.\r
\r
  @param[in]  UdpPacket             The pointer to the packet received.\r
  @param[in]  UdpEpt                The pointer to the Udp6 access point.\r
  @param[in]  IoStatus              The status from the Udp6 instance.\r
  @param[in]  Context               The pointer to the context.\r
\r
**/\r
VOID\r
EFIAPI\r
Mtftp6WrqInput (\r
  IN NET_BUF        *UdpPacket,\r
  IN UDP_END_POINT  *UdpEpt,\r
  IN EFI_STATUS     IoStatus,\r
  IN VOID           *Context\r
  );\r
\r
/**\r
  Start the Mtftp6 instance to upload. It will first init some states,\r
  then send the WRQ request packet, and start to receive the packet.\r
\r
  @param[in]  Instance              The pointer to the Mtftp6 instance.\r
  @param[in]  Operation             The operation code of current packet.\r
\r
  @retval EFI_SUCCESS           The Mtftp6 was started to upload.\r
  @retval Others                Failed to start to upload.\r
\r
**/\r
EFI_STATUS\r
Mtftp6WrqStart (\r
  IN MTFTP6_INSTANCE  *Instance,\r
  IN UINT16           Operation\r
  );\r
\r
/**\r
  The packet process callback for Mtftp6 download.\r
\r
  @param[in]  UdpPacket             The pointer to the packet received.\r
  @param[in]  UdpEpt                The pointer to the Udp6 access point.\r
  @param[in]  IoStatus              The status from Udp6 instance.\r
  @param[in]  Context               The pointer to the context.\r
\r
**/\r
VOID\r
EFIAPI\r
Mtftp6RrqInput (\r
  IN NET_BUF        *UdpPacket,\r
  IN UDP_END_POINT  *UdpEpt,\r
  IN EFI_STATUS     IoStatus,\r
  IN VOID           *Context\r
  );\r
\r
/**\r
  Start the Mtftp6 instance to download. It first initializes some\r
  of the internal states then builds and sends an RRQ request packet.\r
  Finally, it starts receive for the downloading.\r
\r
  @param[in]  Instance              The pointer to the Mtftp6 instance.\r
  @param[in]  Operation             The operation code of current packet.\r
\r
  @retval EFI_SUCCESS           The Mtftp6 was started to download.\r
  @retval Others                Failed to start to download.\r
\r
**/\r
EFI_STATUS\r
Mtftp6RrqStart (\r
  IN MTFTP6_INSTANCE  *Instance,\r
  IN UINT16           Operation\r
  );\r
\r
#endif\r
Commit	Line	Data
a3bcde70 HT	1	/** @file\r
	2	Mtftp6 support functions declaration.\r
	3	\r
2f6693c2	4	Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
a3bcde70	5	\r
ecf98fbc	6	SPDX-License-Identifier: BSD-2-Clause-Patent\r
a3bcde70 HT	7	\r
	8	**/\r
	9	\r
	10	#ifndef __EFI_MTFTP6_SUPPORT_H__\r
	11	#define __EFI_MTFTP6_SUPPORT_H__\r
	12	\r
	13	//\r
	14	// The structure representing a range of block numbers, [Start, End].\r
	15	// It is used to remember the holes in the MTFTP block space. If all\r
	16	// the holes are filled in, then the download or upload has completed.\r
	17	//\r
	18	typedef struct {\r
d1050b9d MK	19	LIST_ENTRY Link;\r
	20	INTN Start;\r
	21	INTN End;\r
	22	INTN Round;\r
	23	INTN Bound;\r
a3bcde70 HT	24	} MTFTP6_BLOCK_RANGE;\r
a3bcde70 HT	25	\r
a3bcde70 HT	26	/**\r
	27	Initialize the block range for either RRQ or WRQ. RRQ and WRQ have\r
	28	different requirements for Start and End. For example, during startup,\r
	29	WRQ initializes its whole valid block range to [0, 0xffff]. This\r
	30	is because the server will send an ACK0 to inform the user to start the\r
	31	upload. When the client receives an ACK0, it will remove 0 from the range,\r
	32	get the next block number, which is 1, then upload the BLOCK1. For RRQ\r
	33	without option negotiation, the server will directly send us the BLOCK1\r
	34	in response to the client's RRQ. When BLOCK1 is received, the client will\r
	35	remove it from the block range and send an ACK. It also works if there\r
	36	is option negotiation.\r
	37	\r
	38	@param[in] Head The block range head to initialize.\r
	39	@param[in] Start The Start block number.\r
	40	@param[in] End The last block number.\r
	41	\r
	42	@retval EFI_OUT_OF_RESOURCES Failed to allocate memory for initial block range.\r
	43	@retval EFI_SUCCESS The initial block range is created.\r
	44	\r
	45	**/\r
	46	EFI_STATUS\r
	47	Mtftp6InitBlockRange (\r
d1050b9d MK	48	IN LIST_ENTRY *Head,\r
	49	IN UINT16 Start,\r
	50	IN UINT16 End\r
a3bcde70 HT	51	);\r
a3bcde70 HT	52	\r
a3bcde70 HT	53	/**\r
	54	Get the first valid block number on the range list.\r
	55	\r
	56	@param[in] Head The block range head.\r
	57	\r
	58	@retval ==-1 If the block range is empty.\r
	59	@retval >-1 The first valid block number.\r
	60	\r
	61	**/\r
	62	INTN\r
	63	Mtftp6GetNextBlockNum (\r
d1050b9d	64	IN LIST_ENTRY *Head\r
a3bcde70 HT	65	);\r
a3bcde70 HT	66	\r
a3bcde70 HT	67	/**\r
	68	Set the last block number of the block range list. It\r
	69	removes all the blocks after the Last. MTFTP initialize the\r
	70	block range to the maximum possible range, such as [0, 0xffff]\r
	71	for WRQ. When it gets the last block number, it calls\r
	72	this function to set the last block number.\r
	73	\r
	74	@param[in] Head The block range list.\r
	75	@param[in] Last The last block number.\r
	76	\r
	77	**/\r
	78	VOID\r
	79	Mtftp6SetLastBlockNum (\r
d1050b9d MK	80	IN LIST_ENTRY *Head,\r
d1050b9d MK	81	IN UINT16 Last\r
a3bcde70 HT	82	);\r
a3bcde70 HT	83	\r
a3bcde70 HT	84	/**\r
	85	Remove the block number from the block range list.\r
	86	\r
	87	@param[in] Head The block range list to remove from.\r
	88	@param[in] Num The block number to remove.\r
2f6693c2 JW	89	@param[in] Completed Whether Num is the last block number.\r
2f6693c2 JW	90	@param[out] BlockCounter The continuous block counter instead of the value after roll-over.\r
a3bcde70 HT	91	\r
	92	@retval EFI_NOT_FOUND The block number isn't in the block range list.\r
	93	@retval EFI_SUCCESS The block number has been removed from the list.\r
	94	@retval EFI_OUT_OF_RESOURCES Failed to allocate resources.\r
	95	\r
	96	**/\r
	97	EFI_STATUS\r
	98	Mtftp6RemoveBlockNum (\r
d1050b9d MK	99	IN LIST_ENTRY *Head,\r
	100	IN UINT16 Num,\r
	101	IN BOOLEAN Completed,\r
	102	OUT UINT64 *BlockCounter\r
a3bcde70 HT	103	);\r
a3bcde70 HT	104	\r
a3bcde70 HT	105	/**\r
	106	Build and transmit the request packet for the Mtftp6 instance.\r
	107	\r
	108	@param[in] Instance The pointer to the Mtftp6 instance.\r
	109	@param[in] Operation The operation code of this packet.\r
	110	\r
	111	@retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the request.\r
	112	@retval EFI_SUCCESS The request was built and sent.\r
	113	@retval Others Failed to transmit the packet.\r
	114	\r
	115	**/\r
	116	EFI_STATUS\r
	117	Mtftp6SendRequest (\r
d1050b9d MK	118	IN MTFTP6_INSTANCE *Instance,\r
d1050b9d MK	119	IN UINT16 Operation\r
a3bcde70 HT	120	);\r
a3bcde70 HT	121	\r
a3bcde70 HT	122	/**\r
	123	Build and send an error packet.\r
	124	\r
	125	@param[in] Instance The pointer to the Mtftp6 instance.\r
	126	@param[in] ErrCode The error code in the packet.\r
	127	@param[in] ErrInfo The error message in the packet.\r
	128	\r
	129	@retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the error packet.\r
	130	@retval EFI_SUCCESS The error packet was transmitted.\r
	131	@retval Others Failed to transmit the packet.\r
	132	\r
	133	**/\r
	134	EFI_STATUS\r
	135	Mtftp6SendError (\r
d1050b9d MK	136	IN MTFTP6_INSTANCE *Instance,\r
	137	IN UINT16 ErrCode,\r
	138	IN UINT8 *ErrInfo\r
a3bcde70 HT	139	);\r
a3bcde70 HT	140	\r
a3bcde70 HT	141	/**\r
	142	Send the packet for the Mtftp6 instance.\r
	143	\r
	144	@param[in] Instance The pointer to the Mtftp6 instance.\r
	145	@param[in] Packet The pointer to the packet to be sent.\r
	146	\r
	147	@retval EFI_SUCCESS The packet was sent out\r
	148	@retval Others Failed to transmit the packet.\r
	149	\r
	150	**/\r
	151	EFI_STATUS\r
	152	Mtftp6TransmitPacket (\r
d1050b9d MK	153	IN MTFTP6_INSTANCE *Instance,\r
d1050b9d MK	154	IN NET_BUF *Packet\r
a3bcde70 HT	155	);\r
a3bcde70 HT	156	\r
a3bcde70 HT	157	/**\r
	158	Check packet for GetInfo callback routine.\r
	159	\r
	160	@param[in] This The pointer to the Mtftp6 protocol.\r
	161	@param[in] Token The pointer to the Mtftp6 token.\r
	162	@param[in] PacketLen The length of the packet\r
	163	@param[in] Packet The pointer to the received packet.\r
	164	\r
	165	@retval EFI_SUCCESS The check process passed successfully.\r
	166	@retval EFI_ABORTED Abort the Mtftp6 operation.\r
	167	\r
	168	**/\r
	169	EFI_STATUS\r
	170	EFIAPI\r
	171	Mtftp6CheckPacket (\r
d1050b9d MK	172	IN EFI_MTFTP6_PROTOCOL *This,\r
	173	IN EFI_MTFTP6_TOKEN *Token,\r
	174	IN UINT16 PacketLen,\r
	175	IN EFI_MTFTP6_PACKET *Packet\r
a3bcde70 HT	176	);\r
a3bcde70 HT	177	\r
a3bcde70 HT	178	/**\r
	179	The dummy configure routine for create a new Udp6 Io.\r
	180	\r
	181	@param[in] UdpIo The pointer to the Udp6 Io.\r
	182	@param[in] Context The pointer to the context.\r
	183	\r
	184	@retval EFI_SUCCESS The value is always returned.\r
	185	\r
	186	**/\r
	187	EFI_STATUS\r
	188	EFIAPI\r
	189	Mtftp6ConfigDummyUdpIo (\r
d1050b9d MK	190	IN UDP_IO *UdpIo,\r
d1050b9d MK	191	IN VOID *Context\r
a3bcde70 HT	192	);\r
a3bcde70 HT	193	\r
a3bcde70 HT	194	/**\r
	195	The configure routine for the Mtftp6 instance to transmit/receive.\r
	196	\r
	197	@param[in] UdpIo The pointer to the Udp6 Io.\r
	198	@param[in] ServerIp The pointer to the server address.\r
	199	@param[in] ServerPort The pointer to the server port.\r
	200	@param[in] LocalIp The pointer to the local address.\r
	201	@param[in] LocalPort The pointer to the local port.\r
	202	\r
	203	@retval EFI_SUCCESS Configure the Udp6 Io for Mtftp6 successfully.\r
	204	@retval EFI_NO_MAPPING The corresponding Ip6 instance has not been\r
	205	configured yet.\r
	206	\r
	207	**/\r
	208	EFI_STATUS\r
	209	Mtftp6ConfigUdpIo (\r
d1050b9d MK	210	IN UDP_IO *UdpIo,\r
	211	IN EFI_IPv6_ADDRESS *ServerIp,\r
	212	IN UINT16 ServerPort,\r
	213	IN EFI_IPv6_ADDRESS *LocalIp,\r
	214	IN UINT16 LocalPort\r
a3bcde70 HT	215	);\r
a3bcde70 HT	216	\r
a3bcde70 HT	217	/**\r
	218	Clean up the current Mtftp6 operation.\r
	219	\r
	220	@param[in] Instance The pointer to the Mtftp6 instance.\r
	221	@param[in] Result The result to be returned to the user.\r
	222	\r
	223	**/\r
	224	VOID\r
	225	Mtftp6OperationClean (\r
d1050b9d MK	226	IN MTFTP6_INSTANCE *Instance,\r
d1050b9d MK	227	IN EFI_STATUS Result\r
a3bcde70 HT	228	);\r
a3bcde70 HT	229	\r
a3bcde70 HT	230	/**\r
	231	Start the Mtftp6 instance to perform the operation, such as read file,\r
	232	write file, and read directory.\r
	233	\r
	234	@param[in] This The MTFTP session\r
	235	@param[in] Token The token that encapsulates the user's request.\r
	236	@param[in] OpCode The operation to perform.\r
	237	\r
	238	@retval EFI_INVALID_PARAMETER Some of the parameters are invalid.\r
	239	@retval EFI_NOT_STARTED The MTFTP session hasn't been configured.\r
	240	@retval EFI_ALREADY_STARTED There is pending operation for the session.\r
	241	@retval EFI_SUCCESS The operation was successfully started.\r
	242	\r
	243	**/\r
	244	EFI_STATUS\r
	245	Mtftp6OperationStart (\r
d1050b9d MK	246	IN EFI_MTFTP6_PROTOCOL *This,\r
	247	IN EFI_MTFTP6_TOKEN *Token,\r
	248	IN UINT16 OpCode\r
a3bcde70 HT	249	);\r
a3bcde70 HT	250	\r
a3bcde70 HT	251	/**\r
	252	The timer ticking routine for the Mtftp6 instance.\r
	253	\r
	254	@param[in] Event The pointer to the ticking event.\r
	255	@param[in] Context The pointer to the context.\r
	256	\r
	257	**/\r
	258	VOID\r
	259	EFIAPI\r
	260	Mtftp6OnTimerTick (\r
d1050b9d MK	261	IN EFI_EVENT Event,\r
d1050b9d MK	262	IN VOID *Context\r
a3bcde70 HT	263	);\r
a3bcde70 HT	264	\r
a3bcde70 HT	265	/**\r
	266	The packet process callback for Mtftp6 upload.\r
	267	\r
	268	@param[in] UdpPacket The pointer to the packet received.\r
	269	@param[in] UdpEpt The pointer to the Udp6 access point.\r
	270	@param[in] IoStatus The status from the Udp6 instance.\r
	271	@param[in] Context The pointer to the context.\r
	272	\r
	273	**/\r
	274	VOID\r
	275	EFIAPI\r
	276	Mtftp6WrqInput (\r
d1050b9d MK	277	IN NET_BUF *UdpPacket,\r
	278	IN UDP_END_POINT *UdpEpt,\r
	279	IN EFI_STATUS IoStatus,\r
	280	IN VOID *Context\r
a3bcde70 HT	281	);\r
a3bcde70 HT	282	\r
a3bcde70 HT	283	/**\r
	284	Start the Mtftp6 instance to upload. It will first init some states,\r
	285	then send the WRQ request packet, and start to receive the packet.\r
	286	\r
	287	@param[in] Instance The pointer to the Mtftp6 instance.\r
	288	@param[in] Operation The operation code of current packet.\r
	289	\r
	290	@retval EFI_SUCCESS The Mtftp6 was started to upload.\r
	291	@retval Others Failed to start to upload.\r
	292	\r
	293	**/\r
	294	EFI_STATUS\r
	295	Mtftp6WrqStart (\r
d1050b9d MK	296	IN MTFTP6_INSTANCE *Instance,\r
d1050b9d MK	297	IN UINT16 Operation\r
a3bcde70 HT	298	);\r
a3bcde70 HT	299	\r
a3bcde70 HT	300	/**\r
	301	The packet process callback for Mtftp6 download.\r
	302	\r
	303	@param[in] UdpPacket The pointer to the packet received.\r
	304	@param[in] UdpEpt The pointer to the Udp6 access point.\r
	305	@param[in] IoStatus The status from Udp6 instance.\r
	306	@param[in] Context The pointer to the context.\r
	307	\r
	308	**/\r
	309	VOID\r
	310	EFIAPI\r
	311	Mtftp6RrqInput (\r
d1050b9d MK	312	IN NET_BUF *UdpPacket,\r
	313	IN UDP_END_POINT *UdpEpt,\r
	314	IN EFI_STATUS IoStatus,\r
	315	IN VOID *Context\r
a3bcde70 HT	316	);\r
a3bcde70 HT	317	\r
a3bcde70 HT	318	/**\r
a3bcde70 HT	319	Start the Mtftp6 instance to download. It first initializes some\r
f6c8bbbe	320	of the internal states then builds and sends an RRQ request packet.\r
a3bcde70 HT	321	Finally, it starts receive for the downloading.\r
	322	\r
	323	@param[in] Instance The pointer to the Mtftp6 instance.\r
	324	@param[in] Operation The operation code of current packet.\r
	325	\r
	326	@retval EFI_SUCCESS The Mtftp6 was started to download.\r
	327	@retval Others Failed to start to download.\r
	328	\r
	329	**/\r
	330	EFI_STATUS\r
	331	Mtftp6RrqStart (\r
d1050b9d MK	332	IN MTFTP6_INSTANCE *Instance,\r
d1050b9d MK	333	IN UINT16 Operation\r
a3bcde70 HT	334	);\r
	335	\r
	336	#endif\r