]>
Commit | Line | Data |
---|---|---|
a3bcde70 HT |
1 | /** @file\r |
2 | Functions declaration related with Mtftp for UefiPxeBc Driver.\r | |
3 | \r | |
e8601e97 | 4 | Copyright (c) 2007 - 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_PXEBC_MTFTP_H__\r | |
11 | #define __EFI_PXEBC_MTFTP_H__\r | |
12 | \r | |
13 | #define PXE_MTFTP_OPTION_BLKSIZE_INDEX 0\r | |
14 | #define PXE_MTFTP_OPTION_TIMEOUT_INDEX 1\r | |
15 | #define PXE_MTFTP_OPTION_TSIZE_INDEX 2\r | |
16 | #define PXE_MTFTP_OPTION_MULTICAST_INDEX 3\r | |
160b082e JW |
17 | #define PXE_MTFTP_OPTION_WINDOWSIZE_INDEX 4\r |
18 | #define PXE_MTFTP_OPTION_MAXIMUM_INDEX 5\r | |
c960bdc2 | 19 | #define PXE_MTFTP_OPTBUF_MAXNUM_INDEX 128\r |
a3bcde70 | 20 | \r |
d1050b9d MK |
21 | #define PXE_MTFTP_ERROR_STRING_LENGTH 127 // refer to definition of struct EFI_PXE_BASE_CODE_TFTP_ERROR.\r |
22 | #define PXE_MTFTP_DEFAULT_BLOCK_SIZE 512 // refer to rfc-1350.\r | |
a3bcde70 HT |
23 | \r |
24 | /**\r | |
25 | This function is wrapper to get the file size using TFTP.\r | |
26 | \r | |
27 | @param[in] Private Pointer to PxeBc private data.\r | |
28 | @param[in] Config Pointer to configure data.\r | |
29 | @param[in] Filename Pointer to boot file name.\r | |
30 | @param[in] BlockSize Pointer to required block size.\r | |
e8601e97 | 31 | @param[in] WindowSize Pointer to required window size.\r |
a3bcde70 HT |
32 | @param[in, out] BufferSize Pointer to buffer size.\r |
33 | \r | |
34 | @retval EFI_SUCCESS Successfully obtained the size of file.\r | |
5add2c55 | 35 | @retval EFI_NOT_FOUND Parse the tftp options failed.\r |
a3bcde70 HT |
36 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r |
37 | @retval Others Did not obtain the size of the file.\r | |
38 | \r | |
39 | **/\r | |
40 | EFI_STATUS\r | |
41 | PxeBcTftpGetFileSize (\r | |
d1050b9d MK |
42 | IN PXEBC_PRIVATE_DATA *Private,\r |
43 | IN VOID *Config,\r | |
44 | IN UINT8 *Filename,\r | |
45 | IN UINTN *BlockSize,\r | |
46 | IN UINTN *WindowSize,\r | |
47 | IN OUT UINT64 *BufferSize\r | |
a3bcde70 HT |
48 | );\r |
49 | \r | |
a3bcde70 HT |
50 | /**\r |
51 | This function is a wrapper to get a file using TFTP.\r | |
52 | \r | |
53 | @param[in] Private Pointer to PxeBc private data.\r | |
54 | @param[in] Config Pointer to config data.\r | |
55 | @param[in] Filename Pointer to boot file name.\r | |
56 | @param[in] BlockSize Pointer to required block size.\r | |
e8601e97 | 57 | @param[in] WindowSize Pointer to required window size.\r |
a3bcde70 HT |
58 | @param[in] BufferPtr Pointer to buffer.\r |
59 | @param[in, out] BufferSize Pointer to buffer size.\r | |
60 | @param[in] DontUseBuffer Indicates whether to use a receive buffer.\r | |
61 | \r | |
62 | @retval EFI_SUCCESS Successfully read the data from the special file.\r | |
63 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r | |
64 | @retval Others Read data from file failed.\r | |
65 | \r | |
66 | **/\r | |
67 | EFI_STATUS\r | |
68 | PxeBcTftpReadFile (\r | |
d1050b9d MK |
69 | IN PXEBC_PRIVATE_DATA *Private,\r |
70 | IN VOID *Config,\r | |
71 | IN UINT8 *Filename,\r | |
72 | IN UINTN *BlockSize,\r | |
73 | IN UINTN *WindowSize,\r | |
74 | IN UINT8 *BufferPtr,\r | |
75 | IN OUT UINT64 *BufferSize,\r | |
76 | IN BOOLEAN DontUseBuffer\r | |
a3bcde70 HT |
77 | );\r |
78 | \r | |
a3bcde70 HT |
79 | /**\r |
80 | This function is a wrapper to put file with TFTP.\r | |
81 | \r | |
82 | @param[in] Private Pointer to PxeBc private data.\r | |
83 | @param[in] Config Pointer to config data.\r | |
84 | @param[in] Filename Pointer to boot file name.\r | |
85 | @param[in] Overwrite Indicates whether to use an overwrite attribute.\r | |
86 | @param[in] BlockSize Pointer to required block size.\r | |
87 | @param[in] BufferPtr Pointer to buffer.\r | |
88 | @param[in, out] BufferSize Pointer to buffer size.\r | |
89 | \r | |
90 | @retval EFI_SUCCESS Successfully wrote the data into the special file.\r | |
91 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r | |
92 | @retval other Write data into file failed.\r | |
93 | \r | |
94 | **/\r | |
95 | EFI_STATUS\r | |
96 | PxeBcTftpWriteFile (\r | |
d1050b9d MK |
97 | IN PXEBC_PRIVATE_DATA *Private,\r |
98 | IN VOID *Config,\r | |
99 | IN UINT8 *Filename,\r | |
100 | IN BOOLEAN Overwrite,\r | |
101 | IN UINTN *BlockSize,\r | |
102 | IN UINT8 *BufferPtr,\r | |
103 | IN OUT UINT64 *BufferSize\r | |
a3bcde70 HT |
104 | );\r |
105 | \r | |
a3bcde70 HT |
106 | /**\r |
107 | This function is a wrapper to get the data (file) from a directory using TFTP.\r | |
108 | \r | |
109 | @param[in] Private Pointer to PxeBc private data.\r | |
110 | @param[in] Config Pointer to config data.\r | |
111 | @param[in] Filename Pointer to boot file name.\r | |
112 | @param[in] BlockSize Pointer to required block size.\r | |
e8601e97 | 113 | @param[in] WindowSize Pointer to required window size.\r |
a3bcde70 HT |
114 | @param[in] BufferPtr Pointer to buffer.\r |
115 | @param[in, out] BufferSize Pointer to buffer size.\r | |
116 | @param[in] DontUseBuffer Indicates whether with a receive buffer.\r | |
117 | \r | |
5add2c55 | 118 | @retval EFI_SUCCESS Successfully obtained the data from the file included in directory.\r |
a3bcde70 HT |
119 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r |
120 | @retval Others Operation failed.\r | |
121 | \r | |
122 | **/\r | |
123 | EFI_STATUS\r | |
124 | PxeBcTftpReadDirectory (\r | |
d1050b9d MK |
125 | IN PXEBC_PRIVATE_DATA *Private,\r |
126 | IN VOID *Config,\r | |
127 | IN UINT8 *Filename,\r | |
128 | IN UINTN *BlockSize,\r | |
129 | IN UINTN *WindowSize,\r | |
130 | IN UINT8 *BufferPtr,\r | |
131 | IN OUT UINT64 *BufferSize,\r | |
132 | IN BOOLEAN DontUseBuffer\r | |
a3bcde70 | 133 | );\r |
d1050b9d | 134 | \r |
a3bcde70 | 135 | #endif\r |