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