tftp.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (C) 1998 W. Eric Norum <eric@norum.ca>
 * Copyright (C) 2022 embedded brains GmbH & Co. KG
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef _RTEMS_TFTP_H
#define _RTEMS_TFTP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <rtems/fs.h>
 
int rtems_tftpfs_initialize(
  rtems_filesystem_mount_table_entry_t *mt_entry,
  const void *data
);
 
/*
 * The functions below use of the TFTP client library standalone
 * - i.e. without going through the file system.
 */
 
#define TFTP_RFC1350_BLOCK_SIZE 512
 
#define TFTP_RFC1350_WINDOW_SIZE 1
 
#define TFTP_DEFAULT_BLOCK_SIZE 1456
 
#define TFTP_DEFAULT_WINDOW_SIZE 8
 
typedef struct tftp_options {
  uint16_t block_size;
 
  uint16_t window_size;
} tftp_options;
 
typedef struct tftp_net_config {
  uint16_t retransmissions;
 
  uint16_t server_port;
 
  uint32_t timeout;
 
  uint32_t first_timeout;
 
  tftp_options options;
} tftp_net_config;
 
void tftp_initialize_net_config(
  tftp_net_config *config
);
 
int tftp_open(
  const char  *hostname,
  const char  *path,
  bool   is_for_reading,
  const tftp_net_config *config,
  void **tftp_handle
);
 
ssize_t tftp_read(
  void   *tftp_handle,
  void   *buffer,
  size_t  count
);
 
ssize_t tftp_write(
  void       *tftp_handle,
  const void *buffer,
  size_t      count
);
 
int tftp_close(
  void *tftp_handle
);
 
#ifdef __cplusplus
}
#endif
 
#endif