[mirror_edk2.git] / MdeModulePkg / Universal / Network / UefiPxeBcDxe / PxeBcMtftp.h

/** @file\r
\r
Copyright (c) 2007, Intel Corporation\r
All rights reserved. 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
  PxeBcMtftp.h\r
\r
Abstract:\r
\r
  Mtftp routines for PxeBc\r
\r
\r
**/\r
\r
#ifndef __EFI_PXEBC_MTFTP_H__\r
#define __EFI_PXEBC_MTFTP_H__\r
\r
enum {\r
  PXE_MTFTP_OPTION_BLKSIZE_INDEX,\r
  PXE_MTFTP_OPTION_TIMEOUT_INDEX,\r
  PXE_MTFTP_OPTION_TSIZE_INDEX,\r
  PXE_MTFTP_OPTION_MULTICAST_INDEX,\r
  PXE_MTFTP_OPTION_MAXIMUM_INDEX\r
};\r
\r
\r
/**\r
  This function is to get size of a file by Tftp.\r
\r
  @param  Private        Pointer to PxeBc private data\r
  @param  Config         Pointer to Mtftp configuration data\r
  @param  Filename       Pointer to file name\r
  @param  BlockSize      Pointer to block size\r
  @param  BufferSize     Pointer to buffer size\r
\r
  @return EFI_SUCCESS\r
  @return EFI_NOT_FOUND\r
  @return EFI_DEVICE_ERROR\r
\r
**/\r
EFI_STATUS\r
PxeBcTftpGetFileSize (\r
  IN PXEBC_PRIVATE_DATA         *Private,\r
  IN EFI_MTFTP4_CONFIG_DATA     *Config,\r
  IN UINT8                      *Filename,\r
  IN UINTN                      *BlockSize,\r
  IN OUT UINT64                 *BufferSize\r
  )\r
;\r
\r
\r
/**\r
  This function is to get data of a file by Tftp.\r
\r
  @param  Private        Pointer to PxeBc private data\r
  @param  Config         Pointer to Mtftp configuration data\r
  @param  Filename       Pointer to file name\r
  @param  BlockSize      Pointer to block size\r
  @param  BufferPtr      Pointer to buffer\r
  @param  BufferSize     Pointer to buffer size\r
  @param  DontUseBuffer  Indicate whether with a receive buffer\r
\r
  @return EFI_SUCCESS\r
  @return EFI_DEVICE_ERROR\r
\r
**/\r
EFI_STATUS\r
PxeBcTftpReadFile (\r
  IN PXEBC_PRIVATE_DATA         *Private,\r
  IN EFI_MTFTP4_CONFIG_DATA     *Config,\r
  IN UINT8                      *Filename,\r
  IN UINTN                      *BlockSize,\r
  IN UINT8                      *BufferPtr,\r
  IN OUT UINT64                 *BufferSize,\r
  IN BOOLEAN                    DontUseBuffer\r
  )\r
;\r
\r
\r
/**\r
  This function is put data of a file by Tftp.\r
\r
  @param  Private        Pointer to PxeBc private data\r
  @param  Config         Pointer to Mtftp configuration data\r
  @param  Filename       Pointer to file name\r
  @param  Overwrite      Indicate whether with overwrite attribute\r
  @param  BlockSize      Pointer to block size\r
  @param  BufferPtr      Pointer to buffer\r
  @param  BufferSize     Pointer to buffer size\r
\r
  @return EFI_SUCCESS\r
  @return EFI_DEVICE_ERROR\r
\r
**/\r
EFI_STATUS\r
PxeBcTftpWriteFile (\r
  IN PXEBC_PRIVATE_DATA         *Private,\r
  IN EFI_MTFTP4_CONFIG_DATA     *Config,\r
  IN UINT8                      *Filename,\r
  IN BOOLEAN                    Overwrite,\r
  IN UINTN                      *BlockSize,\r
  IN UINT8                      *BufferPtr,\r
  IN OUT UINT64                 *BufferSize\r
  )\r
;\r
\r
\r
/**\r
  This function is to get data of a directory by Tftp.\r
\r
  @param  Private        Pointer to PxeBc private data\r
  @param  Config         Pointer to Mtftp configuration data\r
  @param  Filename       Pointer to file name\r
  @param  BlockSize      Pointer to block size\r
  @param  BufferPtr      Pointer to buffer\r
  @param  BufferSize     Pointer to buffer size\r
  @param  DontUseBuffer  Indicate whether with a receive buffer\r
\r
  @return EFI_SUCCES\r
  @return EFI_DEVICE_ERROR\r
\r
**/\r
EFI_STATUS\r
PxeBcTftpReadDirectory (\r
  IN PXEBC_PRIVATE_DATA            *Private,\r
  IN EFI_MTFTP4_CONFIG_DATA        *Config,\r
  IN UINT8                         *Filename,\r
  IN UINTN                         *BlockSize,\r
  IN UINT8                         *BufferPtr,\r
  IN OUT UINT64                    *BufferSize,\r
  IN BOOLEAN                       DontUseBuffer\r
  )\r
;\r
\r
#endif\r
\r
Commit	Line	Data
30368135	1	/** @file\r
	2	\r
	3	Copyright (c) 2007, Intel Corporation\r
	4	All rights reserved. This program and the accompanying materials\r
	5	are licensed and made available under the terms and conditions of the BSD License\r
	6	which accompanies this distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php\r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	11	\r
	12	Module Name:\r
	13	\r
	14	PxeBcMtftp.h\r
	15	\r
	16	Abstract:\r
	17	\r
	18	Mtftp routines for PxeBc\r
	19	\r
	20	\r
	21	**/\r
	22	\r
	23	#ifndef __EFI_PXEBC_MTFTP_H__\r
	24	#define __EFI_PXEBC_MTFTP_H__\r
	25	\r
	26	enum {\r
	27	PXE_MTFTP_OPTION_BLKSIZE_INDEX,\r
	28	PXE_MTFTP_OPTION_TIMEOUT_INDEX,\r
	29	PXE_MTFTP_OPTION_TSIZE_INDEX,\r
	30	PXE_MTFTP_OPTION_MULTICAST_INDEX,\r
	31	PXE_MTFTP_OPTION_MAXIMUM_INDEX\r
	32	};\r
	33	\r
	34	\r
	35	/**\r
	36	This function is to get size of a file by Tftp.\r
	37	\r
	38	@param Private Pointer to PxeBc private data\r
	39	@param Config Pointer to Mtftp configuration data\r
	40	@param Filename Pointer to file name\r
	41	@param BlockSize Pointer to block size\r
	42	@param BufferSize Pointer to buffer size\r
	43	\r
	44	@return EFI_SUCCESS\r
	45	@return EFI_NOT_FOUND\r
	46	@return EFI_DEVICE_ERROR\r
	47	\r
	48	**/\r
	49	EFI_STATUS\r
	50	PxeBcTftpGetFileSize (\r
	51	IN PXEBC_PRIVATE_DATA *Private,\r
	52	IN EFI_MTFTP4_CONFIG_DATA *Config,\r
	53	IN UINT8 *Filename,\r
	54	IN UINTN *BlockSize,\r
	55	IN OUT UINT64 *BufferSize\r
	56	)\r
	57	;\r
	58	\r
	59	\r
	60	/**\r
	61	This function is to get data of a file by Tftp.\r
	62	\r
	63	@param Private Pointer to PxeBc private data\r
	64	@param Config Pointer to Mtftp configuration data\r
65	@param Filename Pointer to file name\r
66	@param BlockSize Pointer to block size\r
67	@param BufferPtr Pointer to buffer\r
68	@param BufferSize Pointer to buffer size\r
69	@param DontUseBuffer Indicate whether with a receive buffer\r
70	\r
71	@return EFI_SUCCESS\r
72	@return EFI_DEVICE_ERROR\r
73	\r
74	**/\r
75	EFI_STATUS\r
76	PxeBcTftpReadFile (\r
77	IN PXEBC_PRIVATE_DATA *Private,\r
78	IN EFI_MTFTP4_CONFIG_DATA *Config,\r
79	IN UINT8 *Filename,\r
80	IN UINTN *BlockSize,\r
81	IN UINT8 *BufferPtr,\r
82	IN OUT UINT64 *BufferSize,\r
83	IN BOOLEAN DontUseBuffer\r
84	)\r
85	;\r
86	\r
87	\r
88	/**\r
89	This function is put data of a file by Tftp.\r
90	\r
91	@param Private Pointer to PxeBc private data\r
92	@param Config Pointer to Mtftp configuration data\r
93	@param Filename Pointer to file name\r
94	@param Overwrite Indicate whether with overwrite attribute\r
95	@param BlockSize Pointer to block size\r
96	@param BufferPtr Pointer to buffer\r
97	@param BufferSize Pointer to buffer size\r
98	\r
99	@return EFI_SUCCESS\r
100	@return EFI_DEVICE_ERROR\r
101	\r
102	**/\r
103	EFI_STATUS\r
104	PxeBcTftpWriteFile (\r
105	IN PXEBC_PRIVATE_DATA *Private,\r
106	IN EFI_MTFTP4_CONFIG_DATA *Config,\r
107	IN UINT8 *Filename,\r
108	IN BOOLEAN Overwrite,\r
109	IN UINTN *BlockSize,\r
110	IN UINT8 *BufferPtr,\r
111	IN OUT UINT64 *BufferSize\r
112	)\r
113	;\r
114	\r
115	\r
116	/**\r
117	This function is to get data of a directory by Tftp.\r
118	\r
119	@param Private Pointer to PxeBc private data\r
120	@param Config Pointer to Mtftp configuration data\r
121	@param Filename Pointer to file name\r
122	@param BlockSize Pointer to block size\r
123	@param BufferPtr Pointer to buffer\r
124	@param BufferSize Pointer to buffer size\r
125	@param DontUseBuffer Indicate whether with a receive buffer\r
126	\r
127	@return EFI_SUCCES\r
128	@return EFI_DEVICE_ERROR\r
129	\r
130	**/\r
131	EFI_STATUS\r
132	PxeBcTftpReadDirectory (\r
133	IN PXEBC_PRIVATE_DATA *Private,\r
134	IN EFI_MTFTP4_CONFIG_DATA *Config,\r
135	IN UINT8 *Filename,\r
136	IN UINTN *BlockSize,\r
137	IN UINT8 *BufferPtr,\r
138	IN OUT UINT64 *BufferSize,\r
139	IN BOOLEAN DontUseBuffer\r
140	)\r
141	;\r
142	\r
143	#endif\r
144	\r