projects / mirror_edk2.git / blame
| 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 HT |
5 | \r |
| 6 | This program and the accompanying materials\r | |
| 7 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 8 | which accompanies this distribution. The full text of the license may be found at\r | |
| 9 | http://opensource.org/licenses/bsd-license.php.\r | |
| 10 | \r | |
| 11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 13 | \r | |
| 14 | **/\r | |
| 15 | \r | |
| 16 | #ifndef __EFI_PXEBC_MTFTP_H__\r | |
| 17 | #define __EFI_PXEBC_MTFTP_H__\r | |
| 18 | \r | |
| 19 | #define PXE_MTFTP_OPTION_BLKSIZE_INDEX 0\r | |
| 20 | #define PXE_MTFTP_OPTION_TIMEOUT_INDEX 1\r | |
| 21 | #define PXE_MTFTP_OPTION_TSIZE_INDEX 2\r | |
| 22 | #define PXE_MTFTP_OPTION_MULTICAST_INDEX 3\r | |
| 160b082e JW |
23 | #define PXE_MTFTP_OPTION_WINDOWSIZE_INDEX 4\r |
| 24 | #define PXE_MTFTP_OPTION_MAXIMUM_INDEX 5\r | |
| c960bdc2 | 25 | #define PXE_MTFTP_OPTBUF_MAXNUM_INDEX 128\r |
| a3bcde70 HT |
26 | \r |
| 27 | #define PXE_MTFTP_ERROR_STRING_LENGTH 127 // refer to definition of struct EFI_PXE_BASE_CODE_TFTP_ERROR.\r | |
| 28 | #define PXE_MTFTP_DEFAULT_BLOCK_SIZE 512 // refer to rfc-1350.\r | |
| 29 | \r | |
| 30 | \r | |
| 31 | /**\r | |
| 32 | This function is wrapper to get the file size using TFTP.\r | |
| 33 | \r | |
| 34 | @param[in] Private Pointer to PxeBc private data.\r | |
| 35 | @param[in] Config Pointer to configure data.\r | |
| 36 | @param[in] Filename Pointer to boot file name.\r | |
| 37 | @param[in] BlockSize Pointer to required block size.\r | |
| e8601e97 | 38 | @param[in] WindowSize Pointer to required window size.\r |
| a3bcde70 HT |
39 | @param[in, out] BufferSize Pointer to buffer size.\r |
| 40 | \r | |
| 41 | @retval EFI_SUCCESS Successfully obtained the size of file.\r | |
| 42 | @retval EFI_NOT_FOUND Parse the tftp ptions failed.\r | |
| 43 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r | |
| 44 | @retval Others Did not obtain the size of the file.\r | |
| 45 | \r | |
| 46 | **/\r | |
| 47 | EFI_STATUS\r | |
| 48 | PxeBcTftpGetFileSize (\r | |
| 49 | IN PXEBC_PRIVATE_DATA *Private,\r | |
| 50 | IN VOID *Config,\r | |
| 51 | IN UINT8 *Filename,\r | |
| 52 | IN UINTN *BlockSize,\r | |
| 160b082e | 53 | IN UINTN *WindowSize,\r |
| a3bcde70 HT |
54 | IN OUT UINT64 *BufferSize\r |
| 55 | );\r | |
| 56 | \r | |
| 57 | \r | |
| 58 | /**\r | |
| 59 | This function is a wrapper to get a file using TFTP.\r | |
| 60 | \r | |
| 61 | @param[in] Private Pointer to PxeBc private data.\r | |
| 62 | @param[in] Config Pointer to config data.\r | |
| 63 | @param[in] Filename Pointer to boot file name.\r | |
| 64 | @param[in] BlockSize Pointer to required block size.\r | |
| e8601e97 | 65 | @param[in] WindowSize Pointer to required window size.\r |
| a3bcde70 HT |
66 | @param[in] BufferPtr Pointer to buffer.\r |
| 67 | @param[in, out] BufferSize Pointer to buffer size.\r | |
| 68 | @param[in] DontUseBuffer Indicates whether to use a receive buffer.\r | |
| 69 | \r | |
| 70 | @retval EFI_SUCCESS Successfully read the data from the special file.\r | |
| 71 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r | |
| 72 | @retval Others Read data from file failed.\r | |
| 73 | \r | |
| 74 | **/\r | |
| 75 | EFI_STATUS\r | |
| 76 | PxeBcTftpReadFile (\r | |
| 77 | IN PXEBC_PRIVATE_DATA *Private,\r | |
| 78 | IN VOID *Config,\r | |
| 79 | IN UINT8 *Filename,\r | |
| 80 | IN UINTN *BlockSize,\r | |
| 160b082e | 81 | IN UINTN *WindowSize,\r |
| a3bcde70 HT |
82 | IN UINT8 *BufferPtr,\r |
| 83 | IN OUT UINT64 *BufferSize,\r | |
| 84 | IN BOOLEAN DontUseBuffer\r | |
| 85 | );\r | |
| 86 | \r | |
| 87 | \r | |
| 88 | /**\r | |
| 89 | This function is a wrapper to put file with TFTP.\r | |
| 90 | \r | |
| 91 | @param[in] Private Pointer to PxeBc private data.\r | |
| 92 | @param[in] Config Pointer to config data.\r | |
| 93 | @param[in] Filename Pointer to boot file name.\r | |
| 94 | @param[in] Overwrite Indicates whether to use an overwrite attribute.\r | |
| 95 | @param[in] BlockSize Pointer to required block size.\r | |
| 96 | @param[in] BufferPtr Pointer to buffer.\r | |
| 97 | @param[in, out] BufferSize Pointer to buffer size.\r | |
| 98 | \r | |
| 99 | @retval EFI_SUCCESS Successfully wrote the data into the special file.\r | |
| 100 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r | |
| 101 | @retval other Write data into file failed.\r | |
| 102 | \r | |
| 103 | **/\r | |
| 104 | EFI_STATUS\r | |
| 105 | PxeBcTftpWriteFile (\r | |
| 106 | IN PXEBC_PRIVATE_DATA *Private,\r | |
| 107 | IN VOID *Config,\r | |
| 108 | IN UINT8 *Filename,\r | |
| 109 | IN BOOLEAN Overwrite,\r | |
| 110 | IN UINTN *BlockSize,\r | |
| 111 | IN UINT8 *BufferPtr,\r | |
| 112 | IN OUT UINT64 *BufferSize\r | |
| 113 | );\r | |
| 114 | \r | |
| 115 | \r | |
| 116 | /**\r | |
| 117 | This function is a wrapper to get the data (file) from a directory using TFTP.\r | |
| 118 | \r | |
| 119 | @param[in] Private Pointer to PxeBc private data.\r | |
| 120 | @param[in] Config Pointer to config data.\r | |
| 121 | @param[in] Filename Pointer to boot file name.\r | |
| 122 | @param[in] BlockSize Pointer to required block size.\r | |
| e8601e97 | 123 | @param[in] WindowSize Pointer to required window size.\r |
| a3bcde70 HT |
124 | @param[in] BufferPtr Pointer to buffer.\r |
| 125 | @param[in, out] BufferSize Pointer to buffer size.\r | |
| 126 | @param[in] DontUseBuffer Indicates whether with a receive buffer.\r | |
| 127 | \r | |
| 128 | @retval EFI_SUCCES Successfully obtained the data from the file included in directory.\r | |
| 129 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r | |
| 130 | @retval Others Operation failed.\r | |
| 131 | \r | |
| 132 | **/\r | |
| 133 | EFI_STATUS\r | |
| 134 | PxeBcTftpReadDirectory (\r | |
| 135 | IN PXEBC_PRIVATE_DATA *Private,\r | |
| 136 | IN VOID *Config,\r | |
| 137 | IN UINT8 *Filename,\r | |
| 138 | IN UINTN *BlockSize,\r | |
| 160b082e | 139 | IN UINTN *WindowSize,\r |
| a3bcde70 HT |
140 | IN UINT8 *BufferPtr,\r |
| 141 | IN OUT UINT64 *BufferSize,\r | |
| 142 | IN BOOLEAN DontUseBuffer\r | |
| 143 | );\r | |
| 144 | #endif\r |