unified MX27, MX25, MX37 trees
[karo-tx-redboot.git] / packages / redboot / v2_0 / include / net / tftp_support.h
1 //==========================================================================
2 //
3 //      net/tftp_support.h
4 //
5 //      Stand-alone TFTP support for RedBoot
6 //
7 //==========================================================================
8 //####ECOSGPLCOPYRIGHTBEGIN####
9 // -------------------------------------------
10 // This file is part of eCos, the Embedded Configurable Operating System.
11 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
12 // Copyright (C) 2002 Gary Thomas
13 //
14 // eCos is free software; you can redistribute it and/or modify it under
15 // the terms of the GNU General Public License as published by the Free
16 // Software Foundation; either version 2 or (at your option) any later version.
17 //
18 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
19 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
21 // for more details.
22 //
23 // You should have received a copy of the GNU General Public License along
24 // with eCos; if not, write to the Free Software Foundation, Inc.,
25 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
26 //
27 // As a special exception, if other files instantiate templates or use macros
28 // or inline functions from this file, or you compile this file and link it
29 // with other works to produce a work based on this file, this file does not
30 // by itself cause the resulting work to be covered by the GNU General Public
31 // License. However the source code for this file must still be made available
32 // in accordance with section (3) of the GNU General Public License.
33 //
34 // This exception does not invalidate any other reasons why a work based on
35 // this file might be covered by the GNU General Public License.
36 //
37 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
38 // at http://sources.redhat.com/ecos/ecos-license/
39 // -------------------------------------------
40 //####ECOSGPLCOPYRIGHTEND####
41 //==========================================================================
42 //#####DESCRIPTIONBEGIN####
43 //
44 // Author(s):    gthomas
45 // Contributors: gthomas
46 // Date:         2000-07-14
47 // Purpose:      
48 // Description:  
49 //              
50 // This code is part of RedBoot (tm).
51 //
52 //####DESCRIPTIONEND####
53 //
54 //==========================================================================
55
56 #ifndef _TFTP_SUPPORT_H_
57 #define _TFTP_SUPPORT_H_
58
59 #include "net.h"
60
61 /*
62  * File transfer modes
63  */
64 #define TFTP_NETASCII   0              // Text files
65 #define TFTP_OCTET      1              // Binary files
66
67 /*
68  * Errors
69  */
70 #define TFTP_ENOTFOUND   1   /* file not found */
71 #define TFTP_EACCESS     2   /* access violation */
72 #define TFTP_ENOSPACE    3   /* disk full or allocation exceeded */
73 #define TFTP_EBADOP      4   /* illegal TFTP operation */
74 #define TFTP_EBADID      5   /* unknown transfer ID */
75 #define TFTP_EEXISTS     6   /* file already exists */
76 #define TFTP_ENOUSER     7   /* no such user */
77 #define TFTP_TIMEOUT     8   /* operation timed out */
78 #define TFTP_NETERR      9   /* some sort of network error */
79 #define TFTP_INVALID    10   /* invalid parameter */
80 #define TFTP_PROTOCOL   11   /* protocol violation */
81 #define TFTP_TOOLARGE   12   /* file is larger than buffer */
82
83 /*
84  * Client support
85  */
86
87 extern int   tftp_stream_open(connection_info_t *info, int *err);
88 extern int   tftp_stream_read(void *buf, int len, int *err);
89 extern void  tftp_stream_close(int *err);
90 extern void  tftp_stream_terminate(bool abort, int (*getc)(void));
91 extern char *tftp_error(int err);
92
93 #define TFTP_TIMEOUT_PERIOD 5
94 #define TFTP_TIMEOUT_MAX   15
95 #define TFTP_RETRIES_MAX    5
96
97 #define TFTP_PORT           69
98
99 extern getc_io_funcs_t tftp_io;
100
101 #endif // _TFTP_SUPPORT_H_