1 |
/*********************************************************************
|
2 |
*
|
3 |
* FTP Server Defs for Microchip TCP/IP Stack
|
4 |
*
|
5 |
*********************************************************************
|
6 |
* FileName: ftp.h
|
7 |
* Dependencies: StackTsk.h
|
8 |
* tcp.h
|
9 |
* Processor: PIC18, PIC24F, PIC24H, dsPIC30F, dsPIC33F
|
10 |
* Complier: Microchip C18 v3.02 or higher
|
11 |
* Microchip C30 v2.01 or higher
|
12 |
* Company: Microchip Technology, Inc.
|
13 |
*
|
14 |
* Software License Agreement
|
15 |
*
|
16 |
* Copyright © 2002-2007 Microchip Technology Inc. All rights
|
17 |
* reserved.
|
18 |
*
|
19 |
* Microchip licenses to you the right to use, modify, copy, and
|
20 |
* distribute:
|
21 |
* (i) the Software when embedded on a Microchip microcontroller or
|
22 |
* digital signal controller product (“Device”) which is
|
23 |
* integrated into Licensee’s product; or
|
24 |
* (ii) ONLY the Software driver source files ENC28J60.c and
|
25 |
* ENC28J60.h ported to a non-Microchip device used in
|
26 |
* conjunction with a Microchip ethernet controller for the
|
27 |
* sole purpose of interfacing with the ethernet controller.
|
28 |
*
|
29 |
* You should refer to the license agreement accompanying this
|
30 |
* Software for additional information regarding your rights and
|
31 |
* obligations.
|
32 |
*
|
33 |
* THE SOFTWARE AND DOCUMENTATION ARE PROVIDED “AS IS” WITHOUT
|
34 |
* WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
|
35 |
* LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS FOR A
|
36 |
* PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL
|
37 |
* MICROCHIP BE LIABLE FOR ANY INCIDENTAL, SPECIAL, INDIRECT OR
|
38 |
* CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF
|
39 |
* PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR SERVICES, ANY CLAIMS
|
40 |
* BY THIRD PARTIES (INCLUDING BUT NOT LIMITED TO ANY DEFENSE
|
41 |
* THEREOF), ANY CLAIMS FOR INDEMNITY OR CONTRIBUTION, OR OTHER
|
42 |
* SIMILAR COSTS, WHETHER ASSERTED ON THE BASIS OF CONTRACT, TORT
|
43 |
* (INCLUDING NEGLIGENCE), BREACH OF WARRANTY, OR OTHERWISE.
|
44 |
*
|
45 |
*
|
46 |
* Author Date Comment
|
47 |
*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
48 |
* Nilesh Rajbharti 4/23/01 Original (Rev 1.0)
|
49 |
********************************************************************/
|
50 |
#ifndef __FTP_H
|
51 |
#define __FTP_H
|
52 |
|
53 |
|
54 |
#define FTP_USER_NAME_LEN (10)
|
55 |
|
56 |
|
57 |
/*********************************************************************
|
58 |
* Function: BOOL FTPVerify(char *login, char *password)
|
59 |
*
|
60 |
* PreCondition: None
|
61 |
*
|
62 |
* Input: login - Telnet User login name
|
63 |
* password - Telnet User password
|
64 |
*
|
65 |
* Output: TRUE if login and password verfies
|
66 |
* FALSE if login and password does not match.
|
67 |
*
|
68 |
* Side Effects: None
|
69 |
*
|
70 |
* Overview: Compare given login and password with internal
|
71 |
* values and return TRUE or FALSE.
|
72 |
*
|
73 |
* Note: This is a callback from Telnet Server to
|
74 |
* user application. User application must
|
75 |
* implement this function in his/her source file
|
76 |
* return correct response based on internal
|
77 |
* login and password information.
|
78 |
********************************************************************/
|
79 |
#ifdef __FTP_C
|
80 |
extern BOOL FTPVerify(BYTE *login, BYTE *password);
|
81 |
#endif
|
82 |
|
83 |
|
84 |
/*********************************************************************
|
85 |
* Function: void FTPInit(void)
|
86 |
*
|
87 |
* PreCondition: TCP module is already initialized.
|
88 |
*
|
89 |
* Input: None
|
90 |
*
|
91 |
* Output: None
|
92 |
*
|
93 |
* Side Effects: None
|
94 |
*
|
95 |
* Overview: Initializes internal variables of Telnet
|
96 |
*
|
97 |
* Note:
|
98 |
********************************************************************/
|
99 |
void FTPInit(void);
|
100 |
|
101 |
|
102 |
/*********************************************************************
|
103 |
* Function: void FTPServer(void)
|
104 |
*
|
105 |
* PreCondition: FTPInit() must already be called.
|
106 |
*
|
107 |
* Input: None
|
108 |
*
|
109 |
* Output: Opened Telnet connections are served.
|
110 |
*
|
111 |
* Side Effects: None
|
112 |
*
|
113 |
* Overview:
|
114 |
*
|
115 |
* Note: This function acts as a task (similar to one in
|
116 |
* RTOS). This function performs its task in
|
117 |
* co-operative manner. Main application must call
|
118 |
* this function repeatdly to ensure all open
|
119 |
* or new connections are served on time.
|
120 |
********************************************************************/
|
121 |
BOOL FTPServer(void);
|
122 |
|
123 |
|
124 |
#endif
|