Donatien Garnier / NetServicesSource

NetServices Stack source

Dependents:   HelloWorld ServoInterfaceBoardExample1 4180_Lab4

lwip/netif/ppp/fsm.h@0:632c9925f013, 2010-06-11 (annotated)

Committer:
donatien
Date:
Fri Jun 11 16:05:15 2010 +0000
Revision:
0:632c9925f013

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


donatien

0:632c9925f013


     1

/*****************************************************************************





donatien

0:632c9925f013


     2

* fsm.h - Network Control Protocol Finite State Machine header file.





donatien

0:632c9925f013


     3

*





donatien

0:632c9925f013


     4

* Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.





donatien

0:632c9925f013


     5

* Copyright (c) 1997 Global Election Systems Inc.





donatien

0:632c9925f013


     6

*





donatien

0:632c9925f013


     7

* The authors hereby grant permission to use, copy, modify, distribute,





donatien

0:632c9925f013


     8

* and license this software and its documentation for any purpose, provided





donatien

0:632c9925f013


     9

* that existing copyright notices are retained in all copies and that this





donatien

0:632c9925f013


    10

* notice and the following disclaimer are included verbatim in any 





donatien

0:632c9925f013


    11

* distributions. No written agreement, license, or royalty fee is required





donatien

0:632c9925f013


    12

* for any of the authorized uses.





donatien

0:632c9925f013


    13

*





donatien

0:632c9925f013


    14

* THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS *AS IS* AND ANY EXPRESS OR





donatien

0:632c9925f013


    15

* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES





donatien

0:632c9925f013


    16

* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 





donatien

0:632c9925f013


    17

* IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,





donatien

0:632c9925f013


    18

* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT





donatien

0:632c9925f013


    19

* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,





donatien

0:632c9925f013


    20

* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY





donatien

0:632c9925f013


    21

* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT





donatien

0:632c9925f013


    22

* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF





donatien

0:632c9925f013


    23

* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.





donatien

0:632c9925f013


    24

*





donatien

0:632c9925f013


    25

******************************************************************************





donatien

0:632c9925f013


    26

* REVISION HISTORY





donatien

0:632c9925f013


    27

*





donatien

0:632c9925f013


    28

* 03-01-01 Marc Boucher <marc@mbsi.ca>





donatien

0:632c9925f013


    29

*   Ported to lwIP.





donatien

0:632c9925f013


    30

* 97-11-05 Guy Lancaster <glanca@gesn.com>, Global Election Systems Inc.





donatien

0:632c9925f013


    31

*   Original based on BSD code.





donatien

0:632c9925f013


    32

*****************************************************************************/





donatien

0:632c9925f013


    33

/*





donatien

0:632c9925f013


    34

 * fsm.h - {Link, IP} Control Protocol Finite State Machine definitions.





donatien

0:632c9925f013


    35

 *





donatien

0:632c9925f013


    36

 * Copyright (c) 1989 Carnegie Mellon University.





donatien

0:632c9925f013


    37

 * All rights reserved.





donatien

0:632c9925f013


    38

 *





donatien

0:632c9925f013


    39

 * Redistribution and use in source and binary forms are permitted





donatien

0:632c9925f013


    40

 * provided that the above copyright notice and this paragraph are





donatien

0:632c9925f013


    41

 * duplicated in all such forms and that any documentation,





donatien

0:632c9925f013


    42

 * advertising materials, and other materials related to such





donatien

0:632c9925f013


    43

 * distribution and use acknowledge that the software was developed





donatien

0:632c9925f013


    44

 * by Carnegie Mellon University.  The name of the





donatien

0:632c9925f013


    45

 * University may not be used to endorse or promote products derived





donatien

0:632c9925f013


    46

 * from this software without specific prior written permission.





donatien

0:632c9925f013


    47

 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR





donatien

0:632c9925f013


    48

 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED





donatien

0:632c9925f013


    49

 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.





donatien

0:632c9925f013


    50

 *





donatien

0:632c9925f013


    51

 * $Id: fsm.h,v 1.5 2009/12/31 17:08:08 goldsimon Exp $





donatien

0:632c9925f013


    52

 */





donatien

0:632c9925f013


    53







donatien

0:632c9925f013


    54

#ifndef FSM_H





donatien

0:632c9925f013


    55

#define FSM_H





donatien

0:632c9925f013


    56







donatien

0:632c9925f013


    57

/*





donatien

0:632c9925f013


    58

 * LCP Packet header = Code, id, length.





donatien

0:632c9925f013


    59

 */





donatien

0:632c9925f013


    60

#define HEADERLEN (sizeof (u_char) + sizeof (u_char) + sizeof (u_short))





donatien

0:632c9925f013


    61







donatien

0:632c9925f013


    62







donatien

0:632c9925f013


    63

/*





donatien

0:632c9925f013


    64

 *  CP (LCP, IPCP, etc.) codes.





donatien

0:632c9925f013


    65

 */





donatien

0:632c9925f013


    66

#define CONFREQ     1 /* Configuration Request */





donatien

0:632c9925f013


    67

#define CONFACK     2 /* Configuration Ack */





donatien

0:632c9925f013


    68

#define CONFNAK     3 /* Configuration Nak */





donatien

0:632c9925f013


    69

#define CONFREJ     4 /* Configuration Reject */





donatien

0:632c9925f013


    70

#define TERMREQ     5 /* Termination Request */





donatien

0:632c9925f013


    71

#define TERMACK     6 /* Termination Ack */





donatien

0:632c9925f013


    72

#define CODEREJ     7 /* Code Reject */





donatien

0:632c9925f013


    73







donatien

0:632c9925f013


    74







donatien

0:632c9925f013


    75

/*





donatien

0:632c9925f013


    76

 * Each FSM is described by an fsm structure and fsm callbacks.





donatien

0:632c9925f013


    77

 */





donatien

0:632c9925f013


    78

typedef struct fsm {





donatien

0:632c9925f013


    79

  int unit;                        /* Interface unit number */





donatien

0:632c9925f013


    80

  u_short protocol;                /* Data Link Layer Protocol field value */





donatien

0:632c9925f013


    81

  int state;                       /* State */





donatien

0:632c9925f013


    82

  int flags;                       /* Contains option bits */





donatien

0:632c9925f013


    83

  u_char id;                       /* Current id */





donatien

0:632c9925f013


    84

  u_char reqid;                    /* Current request id */





donatien

0:632c9925f013


    85

  u_char seen_ack;                 /* Have received valid Ack/Nak/Rej to Req */





donatien

0:632c9925f013


    86

  int timeouttime;                 /* Timeout time in milliseconds */





donatien

0:632c9925f013


    87

  int maxconfreqtransmits;         /* Maximum Configure-Request transmissions */





donatien

0:632c9925f013


    88

  int retransmits;                 /* Number of retransmissions left */





donatien

0:632c9925f013


    89

  int maxtermtransmits;            /* Maximum Terminate-Request transmissions */





donatien

0:632c9925f013


    90

  int nakloops;                    /* Number of nak loops since last ack */





donatien

0:632c9925f013


    91

  int maxnakloops;                 /* Maximum number of nak loops tolerated */





donatien

0:632c9925f013


    92

  struct fsm_callbacks* callbacks; /* Callback routines */





donatien

0:632c9925f013


    93

  char* term_reason;               /* Reason for closing protocol */





donatien

0:632c9925f013


    94

  int term_reason_len;             /* Length of term_reason */





donatien

0:632c9925f013


    95

} fsm;





donatien

0:632c9925f013


    96







donatien

0:632c9925f013


    97







donatien

0:632c9925f013


    98

typedef struct fsm_callbacks {





donatien

0:632c9925f013


    99

  void (*resetci)(fsm*);                            /* Reset our Configuration Information */





donatien

0:632c9925f013


   100

  int  (*cilen)(fsm*);                              /* Length of our Configuration Information */





donatien

0:632c9925f013


   101

  void (*addci)(fsm*, u_char*, int*);               /* Add our Configuration Information */





donatien

0:632c9925f013


   102

  int  (*ackci)(fsm*, u_char*, int);                /* ACK our Configuration Information */





donatien

0:632c9925f013


   103

  int  (*nakci)(fsm*, u_char*, int);                /* NAK our Configuration Information */





donatien

0:632c9925f013


   104

  int  (*rejci)(fsm*, u_char*, int);                /* Reject our Configuration Information */





donatien

0:632c9925f013


   105

  int  (*reqci)(fsm*, u_char*, int*, int);          /* Request peer's Configuration Information */





donatien

0:632c9925f013


   106

  void (*up)(fsm*);                                 /* Called when fsm reaches LS_OPENED state */





donatien

0:632c9925f013


   107

  void (*down)(fsm*);                               /* Called when fsm leaves LS_OPENED state */





donatien

0:632c9925f013


   108

  void (*starting)(fsm*);                           /* Called when we want the lower layer */





donatien

0:632c9925f013


   109

  void (*finished)(fsm*);                           /* Called when we don't want the lower layer */





donatien

0:632c9925f013


   110

  void (*protreject)(int);                          /* Called when Protocol-Reject received */





donatien

0:632c9925f013


   111

  void (*retransmit)(fsm*);                         /* Retransmission is necessary */





donatien

0:632c9925f013


   112

  int  (*extcode)(fsm*, int, u_char, u_char*, int); /* Called when unknown code received */





donatien

0:632c9925f013


   113

  char *proto_name;                                 /* String name for protocol (for messages) */





donatien

0:632c9925f013


   114

} fsm_callbacks;





donatien

0:632c9925f013


   115







donatien

0:632c9925f013


   116







donatien

0:632c9925f013


   117

/*





donatien

0:632c9925f013


   118

 * Link states.





donatien

0:632c9925f013


   119

 */





donatien

0:632c9925f013


   120

#define LS_INITIAL  0 /* Down, hasn't been opened */





donatien

0:632c9925f013


   121

#define LS_STARTING 1 /* Down, been opened */





donatien

0:632c9925f013


   122

#define LS_CLOSED   2 /* Up, hasn't been opened */





donatien

0:632c9925f013


   123

#define LS_STOPPED  3 /* Open, waiting for down event */





donatien

0:632c9925f013


   124

#define LS_CLOSING  4 /* Terminating the connection, not open */





donatien

0:632c9925f013


   125

#define LS_STOPPING 5 /* Terminating, but open */





donatien

0:632c9925f013


   126

#define LS_REQSENT  6 /* We've sent a Config Request */





donatien

0:632c9925f013


   127

#define LS_ACKRCVD  7 /* We've received a Config Ack */





donatien

0:632c9925f013


   128

#define LS_ACKSENT  8 /* We've sent a Config Ack */





donatien

0:632c9925f013


   129

#define LS_OPENED   9 /* Connection available */





donatien

0:632c9925f013


   130







donatien

0:632c9925f013


   131

/*





donatien

0:632c9925f013


   132

 * Flags - indicate options controlling FSM operation





donatien

0:632c9925f013


   133

 */





donatien

0:632c9925f013


   134

#define OPT_PASSIVE 1 /* Don't die if we don't get a response */





donatien

0:632c9925f013


   135

#define OPT_RESTART 2 /* Treat 2nd OPEN as DOWN, UP */





donatien

0:632c9925f013


   136

#define OPT_SILENT  4 /* Wait for peer to speak first */





donatien

0:632c9925f013


   137







donatien

0:632c9925f013


   138







donatien

0:632c9925f013


   139

/*





donatien

0:632c9925f013


   140

 * Prototypes





donatien

0:632c9925f013


   141

 */





donatien

0:632c9925f013


   142

void fsm_init (fsm*);





donatien

0:632c9925f013


   143

void fsm_lowerup (fsm*);





donatien

0:632c9925f013


   144

void fsm_lowerdown (fsm*);





donatien

0:632c9925f013


   145

void fsm_open (fsm*);





donatien

0:632c9925f013


   146

void fsm_close (fsm*, char*);





donatien

0:632c9925f013


   147

void fsm_input (fsm*, u_char*, int);





donatien

0:632c9925f013


   148

void fsm_protreject (fsm*);





donatien

0:632c9925f013


   149

void fsm_sdata (fsm*, u_char, u_char, u_char*, int);





donatien

0:632c9925f013


   150







donatien

0:632c9925f013


   151







donatien

0:632c9925f013


   152

/*





donatien

0:632c9925f013


   153

 * Variables





donatien

0:632c9925f013


   154

 */





donatien

0:632c9925f013


   155

extern int peer_mru[]; /* currently negotiated peer MRU (per unit) */





donatien

0:632c9925f013


   156







donatien

0:632c9925f013


   157

#endif /* FSM_H */