xref: /freebsd/usr.sbin/ppp/cbcp.h (revision 55141f2c8991b2a6adbf30bb0fe3e6cbc303f06d)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 1998 Brian Somers <brian@Awfulhak.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 struct mbuf;
30 struct physical;
31 struct datalink;
32 
33 /* fsm states */
34 #define CBCP_CLOSED	(0)	/* Not in use */
35 #define CBCP_STOPPED	(1)	/* Waiting for a REQ */
36 #define CBCP_REQSENT	(2)	/* Waiting for a RESP */
37 #define CBCP_RESPSENT	(3)	/* Waiting for an ACK */
38 #define CBCP_ACKSENT	(4)	/* Waiting for an LCP Term REQ */
39 
40 struct cbcpcfg {
41   u_char delay;
42   char phone[SCRIPT_LEN];
43   long fsmretry;
44 };
45 
46 struct cbcp {
47   unsigned required : 1;	/* Are we gonna call back ? */
48   struct physical *p;		/* On this physical link */
49   struct {
50     u_char type;		/* cbcp_data::type (none/me/him/list) */
51     u_char delay;		/* How long to delay */
52     char phone[SCRIPT_LEN];	/* What to dial */
53 
54     int state;			/* Our FSM state */
55     u_char id;			/* Our FSM ID */
56     u_char restart;		/* FSM Send again ? */
57     struct pppTimer timer;	/* Resend last option */
58   } fsm;
59 };
60 
61 extern void cbcp_Init(struct cbcp *, struct physical *);
62 extern void cbcp_Up(struct cbcp *);
63 extern struct mbuf *cbcp_Input(struct bundle *, struct link *, struct mbuf *);
64 extern void cbcp_Down(struct cbcp *);
65 extern void cbcp_ReceiveTerminateReq(struct physical *);
66