[linux.git] / include / net / lapb.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LAPB_H
#define _LAPB_H 
#include <linux/lapb.h>
#include <linux/refcount.h>

#define	LAPB_HEADER_LEN	20		/* LAPB over Ethernet + a bit more */

#define	LAPB_ACK_PENDING_CONDITION	0x01
#define	LAPB_REJECT_CONDITION		0x02
#define	LAPB_PEER_RX_BUSY_CONDITION	0x04

/* Control field templates */
#define	LAPB_I		0x00	/* Information frames */
#define	LAPB_S		0x01	/* Supervisory frames */
#define	LAPB_U		0x03	/* Unnumbered frames */

#define	LAPB_RR		0x01	/* Receiver ready */
#define	LAPB_RNR	0x05	/* Receiver not ready */
#define	LAPB_REJ	0x09	/* Reject */

#define	LAPB_SABM	0x2F	/* Set Asynchronous Balanced Mode */
#define	LAPB_SABME	0x6F	/* Set Asynchronous Balanced Mode Extended */
#define	LAPB_DISC	0x43	/* Disconnect */
#define	LAPB_DM		0x0F	/* Disconnected mode */
#define	LAPB_UA		0x63	/* Unnumbered acknowledge */
#define	LAPB_FRMR	0x87	/* Frame reject */

#define LAPB_ILLEGAL	0x100	/* Impossible to be a real frame type */

#define	LAPB_SPF	0x10	/* Poll/final bit for standard LAPB */
#define	LAPB_EPF	0x01	/* Poll/final bit for extended LAPB */

#define	LAPB_FRMR_W	0x01	/* Control field invalid	*/
#define	LAPB_FRMR_X	0x02	/* I field invalid		*/
#define	LAPB_FRMR_Y	0x04	/* I field too long		*/
#define	LAPB_FRMR_Z	0x08	/* Invalid N(R)			*/

#define	LAPB_POLLOFF	0
#define	LAPB_POLLON	1

/* LAPB C-bit */
#define LAPB_COMMAND	1
#define LAPB_RESPONSE	2

#define	LAPB_ADDR_A	0x03
#define	LAPB_ADDR_B	0x01
#define	LAPB_ADDR_C	0x0F
#define	LAPB_ADDR_D	0x07

/* Define Link State constants. */
enum {
	LAPB_STATE_0,	/* Disconnected State		*/
	LAPB_STATE_1,	/* Awaiting Connection State	*/
	LAPB_STATE_2,	/* Awaiting Disconnection State	*/
	LAPB_STATE_3,	/* Data Transfer State		*/
	LAPB_STATE_4	/* Frame Reject State		*/
};

#define	LAPB_DEFAULT_MODE		(LAPB_STANDARD | LAPB_SLP | LAPB_DTE)
#define	LAPB_DEFAULT_WINDOW		7		/* Window=7 */
#define	LAPB_DEFAULT_T1			(5 * HZ)	/* T1=5s    */
#define	LAPB_DEFAULT_T2			(1 * HZ)	/* T2=1s    */
#define	LAPB_DEFAULT_N2			20		/* N2=20    */

#define	LAPB_SMODULUS	8
#define	LAPB_EMODULUS	128

/*
 *	Information about the current frame.
 */
struct lapb_frame {
	unsigned short		type;		/* Parsed type		*/
	unsigned short		nr, ns;		/* N(R), N(S)		*/
	unsigned char		cr;		/* Command/Response	*/
	unsigned char		pf;		/* Poll/Final		*/
	unsigned char		control[2];	/* Original control data*/
};

/*
 *	The per LAPB connection control structure.
 */
struct lapb_cb {
	struct list_head	node;
	struct net_device	*dev;

	/* Link status fields */
	unsigned int		mode;
	unsigned char		state;
	unsigned short		vs, vr, va;
	unsigned char		condition;
	unsigned short		n2, n2count;
	unsigned short		t1, t2;
	struct timer_list	t1timer, t2timer;
	bool			t1timer_stop, t2timer_stop;

	/* Internal control information */
	struct sk_buff_head	write_queue;
	struct sk_buff_head	ack_queue;
	unsigned char		window;
	const struct lapb_register_struct *callbacks;

	/* FRMR control information */
	struct lapb_frame	frmr_data;
	unsigned char		frmr_type;

	spinlock_t		lock;
	refcount_t		refcnt;
};

/* lapb_iface.c */
void lapb_connect_confirmation(struct lapb_cb *lapb, int);
void lapb_connect_indication(struct lapb_cb *lapb, int);
void lapb_disconnect_confirmation(struct lapb_cb *lapb, int);
void lapb_disconnect_indication(struct lapb_cb *lapb, int);
int lapb_data_indication(struct lapb_cb *lapb, struct sk_buff *);
int lapb_data_transmit(struct lapb_cb *lapb, struct sk_buff *);

/* lapb_in.c */
void lapb_data_input(struct lapb_cb *lapb, struct sk_buff *);

/* lapb_out.c */
void lapb_kick(struct lapb_cb *lapb);
void lapb_transmit_buffer(struct lapb_cb *lapb, struct sk_buff *, int);
void lapb_establish_data_link(struct lapb_cb *lapb);
void lapb_enquiry_response(struct lapb_cb *lapb);
void lapb_timeout_response(struct lapb_cb *lapb);
void lapb_check_iframes_acked(struct lapb_cb *lapb, unsigned short);
void lapb_check_need_response(struct lapb_cb *lapb, int, int);

/* lapb_subr.c */
void lapb_clear_queues(struct lapb_cb *lapb);
void lapb_frames_acked(struct lapb_cb *lapb, unsigned short);
void lapb_requeue_frames(struct lapb_cb *lapb);
int lapb_validate_nr(struct lapb_cb *lapb, unsigned short);
int lapb_decode(struct lapb_cb *lapb, struct sk_buff *, struct lapb_frame *);
void lapb_send_control(struct lapb_cb *lapb, int, int, int);
void lapb_transmit_frmr(struct lapb_cb *lapb);

/* lapb_timer.c */
void lapb_start_t1timer(struct lapb_cb *lapb);
void lapb_start_t2timer(struct lapb_cb *lapb);
void lapb_stop_t1timer(struct lapb_cb *lapb);
void lapb_stop_t2timer(struct lapb_cb *lapb);
int lapb_t1timer_running(struct lapb_cb *lapb);

/*
 * Debug levels.
 *	0 = Off
 *	1 = State Changes
 *	2 = Packets I/O and State Changes
 *	3 = Hex dumps, Packets I/O and State Changes.
 */
#define	LAPB_DEBUG	0

#define lapb_dbg(level, fmt, ...)			\
do {							\
	if (level < LAPB_DEBUG)				\
		pr_debug(fmt, ##__VA_ARGS__);		\
} while (0)

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef _LAPB_H
	3	#define _LAPB_H
	4	#include <linux/lapb.h>
0408c58b	5	#include <linux/refcount.h>
1da177e4 LT	6
	7	#define LAPB_HEADER_LEN 20 /* LAPB over Ethernet + a bit more */
	8
	9	#define LAPB_ACK_PENDING_CONDITION 0x01
	10	#define LAPB_REJECT_CONDITION 0x02
	11	#define LAPB_PEER_RX_BUSY_CONDITION 0x04
	12
	13	/* Control field templates */
	14	#define LAPB_I 0x00 /* Information frames */
	15	#define LAPB_S 0x01 /* Supervisory frames */
	16	#define LAPB_U 0x03 /* Unnumbered frames */
	17
	18	#define LAPB_RR 0x01 /* Receiver ready */
	19	#define LAPB_RNR 0x05 /* Receiver not ready */
	20	#define LAPB_REJ 0x09 /* Reject */
	21
	22	#define LAPB_SABM 0x2F /* Set Asynchronous Balanced Mode */
	23	#define LAPB_SABME 0x6F /* Set Asynchronous Balanced Mode Extended */
	24	#define LAPB_DISC 0x43 /* Disconnect */
	25	#define LAPB_DM 0x0F /* Disconnected mode */
	26	#define LAPB_UA 0x63 /* Unnumbered acknowledge */
	27	#define LAPB_FRMR 0x87 /* Frame reject */
	28
	29	#define LAPB_ILLEGAL 0x100 /* Impossible to be a real frame type */
	30
	31	#define LAPB_SPF 0x10 /* Poll/final bit for standard LAPB */
	32	#define LAPB_EPF 0x01 /* Poll/final bit for extended LAPB */
	33
	34	#define LAPB_FRMR_W 0x01 /* Control field invalid */
	35	#define LAPB_FRMR_X 0x02 /* I field invalid */
	36	#define LAPB_FRMR_Y 0x04 /* I field too long */
	37	#define LAPB_FRMR_Z 0x08 /* Invalid N(R) */
	38
	39	#define LAPB_POLLOFF 0
	40	#define LAPB_POLLON 1
	41
	42	/* LAPB C-bit */
	43	#define LAPB_COMMAND 1
	44	#define LAPB_RESPONSE 2
	45
	46	#define LAPB_ADDR_A 0x03
	47	#define LAPB_ADDR_B 0x01
	48	#define LAPB_ADDR_C 0x0F
	49	#define LAPB_ADDR_D 0x07
	50
	51	/* Define Link State constants. */
	52	enum {
	53	LAPB_STATE_0, /* Disconnected State */
	54	LAPB_STATE_1, /* Awaiting Connection State */
	55	LAPB_STATE_2, /* Awaiting Disconnection State */
	56	LAPB_STATE_3, /* Data Transfer State */
	57	LAPB_STATE_4 /* Frame Reject State */
	58	};
	59
	60	#define LAPB_DEFAULT_MODE (LAPB_STANDARD \| LAPB_SLP \| LAPB_DTE)
	61	#define LAPB_DEFAULT_WINDOW 7 /* Window=7 */
	62	#define LAPB_DEFAULT_T1 (5 * HZ) /* T1=5s */
	63	#define LAPB_DEFAULT_T2 (1 * HZ) /* T2=1s */
	64	#define LAPB_DEFAULT_N2 20 /* N2=20 */
	65
	66	#define LAPB_SMODULUS 8
	67	#define LAPB_EMODULUS 128
	68
	69	/*
70	* Information about the current frame.
71	*/
72	struct lapb_frame {
73	unsigned short type; /* Parsed type */
74	unsigned short nr, ns; /* N(R), N(S) */
75	unsigned char cr; /* Command/Response */
76	unsigned char pf; /* Poll/Final */
77	unsigned char control[2]; /* Original control data*/
78	};
79
80	/*
81	* The per LAPB connection control structure.
82	*/
83	struct lapb_cb {
84	struct list_head node;
85	struct net_device *dev;
86
87	/* Link status fields */
88	unsigned int mode;
89	unsigned char state;
90	unsigned short vs, vr, va;
91	unsigned char condition;
92	unsigned short n2, n2count;
93	unsigned short t1, t2;
94	struct timer_list t1timer, t2timer;
b491e6a7	95	bool t1timer_stop, t2timer_stop;
1da177e4 LT	96
	97	/* Internal control information */
	98	struct sk_buff_head write_queue;
	99	struct sk_buff_head ack_queue;
	100	unsigned char window;
d97a077a	101	const struct lapb_register_struct *callbacks;
1da177e4 LT	102
	103	/* FRMR control information */
	104	struct lapb_frame frmr_data;
	105	unsigned char frmr_type;
	106
b491e6a7	107	spinlock_t lock;
0408c58b	108	refcount_t refcnt;
1da177e4 LT	109	};
	110
	111	/* lapb_iface.c */
cb7d3d71 JP	112	void lapb_connect_confirmation(struct lapb_cb *lapb, int);
	113	void lapb_connect_indication(struct lapb_cb *lapb, int);
	114	void lapb_disconnect_confirmation(struct lapb_cb *lapb, int);
	115	void lapb_disconnect_indication(struct lapb_cb *lapb, int);
	116	int lapb_data_indication(struct lapb_cb lapb, struct sk_buff );
	117	int lapb_data_transmit(struct lapb_cb lapb, struct sk_buff );
1da177e4 LT	118
1da177e4 LT	119	/* lapb_in.c */
cb7d3d71	120	void lapb_data_input(struct lapb_cb lapb, struct sk_buff );
1da177e4 LT	121
1da177e4 LT	122	/* lapb_out.c */
cb7d3d71 JP	123	void lapb_kick(struct lapb_cb *lapb);
	124	void lapb_transmit_buffer(struct lapb_cb lapb, struct sk_buff , int);
	125	void lapb_establish_data_link(struct lapb_cb *lapb);
	126	void lapb_enquiry_response(struct lapb_cb *lapb);
	127	void lapb_timeout_response(struct lapb_cb *lapb);
	128	void lapb_check_iframes_acked(struct lapb_cb *lapb, unsigned short);
	129	void lapb_check_need_response(struct lapb_cb *lapb, int, int);
1da177e4 LT	130
1da177e4 LT	131	/* lapb_subr.c */
cb7d3d71 JP	132	void lapb_clear_queues(struct lapb_cb *lapb);
	133	void lapb_frames_acked(struct lapb_cb *lapb, unsigned short);
	134	void lapb_requeue_frames(struct lapb_cb *lapb);
	135	int lapb_validate_nr(struct lapb_cb *lapb, unsigned short);
	136	int lapb_decode(struct lapb_cb lapb, struct sk_buff , struct lapb_frame *);
	137	void lapb_send_control(struct lapb_cb *lapb, int, int, int);
	138	void lapb_transmit_frmr(struct lapb_cb *lapb);
1da177e4 LT	139
1da177e4 LT	140	/* lapb_timer.c */
cb7d3d71 JP	141	void lapb_start_t1timer(struct lapb_cb *lapb);
	142	void lapb_start_t2timer(struct lapb_cb *lapb);
	143	void lapb_stop_t1timer(struct lapb_cb *lapb);
	144	void lapb_stop_t2timer(struct lapb_cb *lapb);
	145	int lapb_t1timer_running(struct lapb_cb *lapb);
1da177e4 LT	146
	147	/*
	148	* Debug levels.
	149	* 0 = Off
	150	* 1 = State Changes
	151	* 2 = Packets I/O and State Changes
	152	* 3 = Hex dumps, Packets I/O and State Changes.
	153	*/
	154	#define LAPB_DEBUG 0
	155
a508da6c JP	156	#define lapb_dbg(level, fmt, ...) \
	157	do { \
	158	if (level < LAPB_DEBUG) \
	159	pr_debug(fmt, ##__VA_ARGS__); \
	160	} while (0)
	161
1da177e4	162	#endif