src/ftpfs/tftp_driver.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplTFTPFS
0007  *
0008  * @brief This header file provides private interfaces of the
0009  *   TFTP client library.
0010  *
0011  * This file declares the private functions of the Trivial File
0012  * Transfer Protocol (TFTP) client library.
0013  */
0014
0015 /*
0016  * Copyright (C) 2022 embedded brains GmbH & Co. KG
0017  *
0018  * Redistribution and use in source and binary forms, with or without
0019  * modification, are permitted provided that the following conditions
0020  * are met:
0021  * 1. Redistributions of source code must retain the above copyright
0022  *    notice, this list of conditions and the following disclaimer.
0023  * 2. Redistributions in binary form must reproduce the above copyright
0024  *    notice, this list of conditions and the following disclaimer in the
0025  *    documentation and/or other materials provided with the distribution.
0026  *
0027  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0028  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0029  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0030  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0031  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0032  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0033  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0034  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0035  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0036  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0037  * POSSIBILITY OF SUCH DAMAGE.
0038  */
0039
0040 #ifndef _TFTP_DRIVER_H
0041 #define _TFTP_DRIVER_H
0042
0043 /* Remove for C++ code */
0044 #ifdef __cplusplus
0045 extern "C" {
0046 #endif
0047
0048 /**
0049  * @defgroup RTEMSImplTFTPFS Trivial File Transfer Protocol (TFTP) file system
0050  *
0051  * @ingroup FileSystemTypesAndMount
0052  *
0053  * @brief The TFTP file system provides the ability to read files from and
0054  *   to write files to remote servers using the Trivial File Transfer
0055  *   Protocol (TFTP).
0056  *
0057  * The file `spec/build/cpukit/libtftpfs.yml` specifies how the RTEMS
0058  * WAF build system has to compile, link and install `libtftpfs`.
0059  *
0060  * There also exists a @ref RTEMSTestSuiteTestsTFTPFS
0061  * "TFTP file system test suite".
0062  *
0063  * @{
0064  */
0065
0066 /**
0067  * @brief Free the resources associated with a TFTP client connection.
0068  *
0069  * This directive releases any resources allocated at the client side.
0070  * The connection is not closed which implies that the server will not
0071  * be informed and data is likely lost.  According to RFC 1350 the
0072  * server will recognize the defect connection by timeouts.
0073  * This directive is internally used when the TFTP file system is unmounted.
0074  *
0075  * @param tftp_handle is the reference returned by a call to tftp_open().
0076  *   If this parameter is @c NULL, the directive call is a no-op.
0077  */
0078 void _Tftp_Destroy(
0079   void *tftp_handle
0080 );
0081
0082 /* Only non-private to ease unit testing */
0083 ssize_t _Tftpfs_Parse_options(
0084   const char *option_str,
0085   tftp_net_config *tftp_config,
0086   uint32_t *flags
0087 );
0088
0089 /** @} */
0090
0091 /* Remove for C++ code */
0092 #ifdef __cplusplus
0093 }
0094 #endif
0095
0096 #endif /* _TFTP_DRIVER_H */