]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/net/ax25.h
Merge branch 'listener_refactor_part_15'
[mirror_ubuntu-jammy-kernel.git] / include / net / ax25.h
CommitLineData
1da177e4
LT
1/*
2 * Declarations of AX.25 type objects.
3 *
4 * Alan Cox (GW4PTS) 10/11/93
5 */
6#ifndef _AX25_H
7#define _AX25_H
8
1da177e4
LT
9#include <linux/ax25.h>
10#include <linux/spinlock.h>
11#include <linux/timer.h>
12#include <linux/list.h>
5a0e3ad6 13#include <linux/slab.h>
60063497 14#include <linux/atomic.h>
3b6a94be 15#include <net/neighbour.h>
1da177e4
LT
16
17#define AX25_T1CLAMPLO 1
18#define AX25_T1CLAMPHI (30 * HZ)
19
20#define AX25_BPQ_HEADER_LEN 16
21#define AX25_KISS_HEADER_LEN 1
22
23#define AX25_HEADER_LEN 17
24#define AX25_ADDR_LEN 7
25#define AX25_DIGI_HEADER_LEN (AX25_MAX_DIGIS * AX25_ADDR_LEN)
26#define AX25_MAX_HEADER_LEN (AX25_HEADER_LEN + AX25_DIGI_HEADER_LEN)
27
28/* AX.25 Protocol IDs */
29#define AX25_P_ROSE 0x01
3bf0ae7b
RB
30#define AX25_P_VJCOMP 0x06 /* Compressed TCP/IP packet */
31 /* Van Jacobsen (RFC 1144) */
32#define AX25_P_VJUNCOMP 0x07 /* Uncompressed TCP/IP packet */
33 /* Van Jacobsen (RFC 1144) */
34#define AX25_P_SEGMENT 0x08 /* Segmentation fragment */
35#define AX25_P_TEXNET 0xc3 /* TEXTNET datagram protocol */
36#define AX25_P_LQ 0xc4 /* Link Quality Protocol */
37#define AX25_P_ATALK 0xca /* Appletalk */
38#define AX25_P_ATALK_ARP 0xcb /* Appletalk ARP */
39#define AX25_P_IP 0xcc /* ARPA Internet Protocol */
f4ab2f72 40#define AX25_P_ARP 0xcd /* ARPA Address Resolution */
3bf0ae7b
RB
41#define AX25_P_FLEXNET 0xce /* FlexNet */
42#define AX25_P_NETROM 0xcf /* NET/ROM */
43#define AX25_P_TEXT 0xF0 /* No layer 3 protocol impl. */
1da177e4
LT
44
45/* AX.25 Segment control values */
46#define AX25_SEG_REM 0x7F
47#define AX25_SEG_FIRST 0x80
48
49#define AX25_CBIT 0x80 /* Command/Response bit */
50#define AX25_EBIT 0x01 /* HDLC Address Extension bit */
51#define AX25_HBIT 0x80 /* Has been repeated bit */
52
53#define AX25_SSSID_SPARE 0x60 /* Unused bits in SSID for standard AX.25 */
54#define AX25_ESSID_SPARE 0x20 /* Unused bits in SSID for extended AX.25 */
55#define AX25_DAMA_FLAG 0x20 /* Well, it is *NOT* unused! (dl1bke 951121 */
56
57#define AX25_COND_ACK_PENDING 0x01
58#define AX25_COND_REJECT 0x02
59#define AX25_COND_PEER_RX_BUSY 0x04
60#define AX25_COND_OWN_RX_BUSY 0x08
61#define AX25_COND_DAMA_MODE 0x10
62
63#ifndef _LINUX_NETDEVICE_H
64#include <linux/netdevice.h>
65#endif
66
67/* Upper sub-layer (LAPB) definitions */
68
69/* Control field templates */
70#define AX25_I 0x00 /* Information frames */
71#define AX25_S 0x01 /* Supervisory frames */
72#define AX25_RR 0x01 /* Receiver ready */
73#define AX25_RNR 0x05 /* Receiver not ready */
74#define AX25_REJ 0x09 /* Reject */
75#define AX25_U 0x03 /* Unnumbered frames */
76#define AX25_SABM 0x2f /* Set Asynchronous Balanced Mode */
77#define AX25_SABME 0x6f /* Set Asynchronous Balanced Mode Extended */
78#define AX25_DISC 0x43 /* Disconnect */
79#define AX25_DM 0x0f /* Disconnected mode */
80#define AX25_UA 0x63 /* Unnumbered acknowledge */
81#define AX25_FRMR 0x87 /* Frame reject */
82#define AX25_UI 0x03 /* Unnumbered information */
83#define AX25_XID 0xaf /* Exchange information */
84#define AX25_TEST 0xe3 /* Test */
85
86#define AX25_PF 0x10 /* Poll/final bit for standard AX.25 */
87#define AX25_EPF 0x01 /* Poll/final bit for extended AX.25 */
88
89#define AX25_ILLEGAL 0x100 /* Impossible to be a real frame type */
90
91#define AX25_POLLOFF 0
92#define AX25_POLLON 1
93
94/* AX25 L2 C-bit */
95#define AX25_COMMAND 1
96#define AX25_RESPONSE 2
97
98/* Define Link State constants. */
99
100enum {
b01ef8ff
RB
101 AX25_STATE_0, /* Listening */
102 AX25_STATE_1, /* SABM sent */
103 AX25_STATE_2, /* DISC sent */
104 AX25_STATE_3, /* Established */
105 AX25_STATE_4 /* Recovery */
1da177e4
LT
106};
107
108#define AX25_MODULUS 8 /* Standard AX.25 modulus */
109#define AX25_EMODULUS 128 /* Extended AX.25 modulus */
110
111enum {
112 AX25_PROTO_STD_SIMPLEX,
113 AX25_PROTO_STD_DUPLEX,
c7c694d1 114#ifdef CONFIG_AX25_DAMA_SLAVE
1da177e4 115 AX25_PROTO_DAMA_SLAVE,
c7c694d1
RB
116#ifdef CONFIG_AX25_DAMA_MASTER
117 AX25_PROTO_DAMA_MASTER,
118#define AX25_PROTO_MAX AX25_PROTO_DAMA_MASTER
119#endif
120#endif
121 __AX25_PROTO_MAX,
122 AX25_PROTO_MAX = __AX25_PROTO_MAX -1
1da177e4
LT
123};
124
125enum {
126 AX25_VALUES_IPDEFMODE, /* 0=DG 1=VC */
127 AX25_VALUES_AXDEFMODE, /* 0=Normal 1=Extended Seq Nos */
128 AX25_VALUES_BACKOFF, /* 0=None 1=Linear 2=Exponential */
129 AX25_VALUES_CONMODE, /* Allow connected modes - 0=No 1=no "PID text" 2=all PIDs */
130 AX25_VALUES_WINDOW, /* Default window size for standard AX.25 */
131 AX25_VALUES_EWINDOW, /* Default window size for extended AX.25 */
132 AX25_VALUES_T1, /* Default T1 timeout value */
133 AX25_VALUES_T2, /* Default T2 timeout value */
134 AX25_VALUES_T3, /* Default T3 timeout value */
135 AX25_VALUES_IDLE, /* Connected mode idle timer */
136 AX25_VALUES_N2, /* Default N2 value */
137 AX25_VALUES_PACLEN, /* AX.25 MTU */
138 AX25_VALUES_PROTOCOL, /* Std AX.25, DAMA Slave, DAMA Master */
139 AX25_VALUES_DS_TIMEOUT, /* DAMA Slave timeout */
140 AX25_MAX_VALUES /* THIS MUST REMAIN THE LAST ENTRY OF THIS LIST */
141};
142
143#define AX25_DEF_IPDEFMODE 0 /* Datagram */
144#define AX25_DEF_AXDEFMODE 0 /* Normal */
145#define AX25_DEF_BACKOFF 1 /* Linear backoff */
146#define AX25_DEF_CONMODE 2 /* Connected mode allowed */
147#define AX25_DEF_WINDOW 2 /* Window=2 */
148#define AX25_DEF_EWINDOW 32 /* Module-128 Window=32 */
e1fdb5b3
RB
149#define AX25_DEF_T1 10000 /* T1=10s */
150#define AX25_DEF_T2 3000 /* T2=3s */
151#define AX25_DEF_T3 300000 /* T3=300s */
1da177e4 152#define AX25_DEF_N2 10 /* N2=10 */
e1fdb5b3 153#define AX25_DEF_IDLE 0 /* Idle=None */
1da177e4
LT
154#define AX25_DEF_PACLEN 256 /* Paclen=256 */
155#define AX25_DEF_PROTOCOL AX25_PROTO_STD_SIMPLEX /* Standard AX.25 */
e1fdb5b3 156#define AX25_DEF_DS_TIMEOUT 180000 /* DAMA timeout 3 minutes */
1da177e4
LT
157
158typedef struct ax25_uid_assoc {
01d7dd0e
RB
159 struct hlist_node uid_node;
160 atomic_t refcount;
d13fda85 161 kuid_t uid;
1da177e4
LT
162 ax25_address call;
163} ax25_uid_assoc;
164
b67bfe0d
SL
165#define ax25_uid_for_each(__ax25, list) \
166 hlist_for_each_entry(__ax25, list, uid_node)
01d7dd0e
RB
167
168#define ax25_uid_hold(ax25) \
169 atomic_inc(&((ax25)->refcount))
170
171static inline void ax25_uid_put(ax25_uid_assoc *assoc)
172{
173 if (atomic_dec_and_test(&assoc->refcount)) {
174 kfree(assoc);
175 }
176}
177
1da177e4
LT
178typedef struct {
179 ax25_address calls[AX25_MAX_DIGIS];
180 unsigned char repeated[AX25_MAX_DIGIS];
181 unsigned char ndigi;
4595f251 182 signed char lastrepeat;
1da177e4
LT
183} ax25_digi;
184
185typedef struct ax25_route {
186 struct ax25_route *next;
006f68b8 187 atomic_t refcount;
1da177e4
LT
188 ax25_address callsign;
189 struct net_device *dev;
190 ax25_digi *digipeat;
191 char ip_mode;
1da177e4
LT
192} ax25_route;
193
006f68b8
RB
194static inline void ax25_hold_route(ax25_route *ax25_rt)
195{
196 atomic_inc(&ax25_rt->refcount);
197}
198
c1d8f804 199void __ax25_put_route(ax25_route *ax25_rt);
006f68b8
RB
200
201static inline void ax25_put_route(ax25_route *ax25_rt)
202{
203 if (atomic_dec_and_test(&ax25_rt->refcount))
204 __ax25_put_route(ax25_rt);
205}
206
1da177e4
LT
207typedef struct {
208 char slave; /* slave_mode? */
209 struct timer_list slave_timer; /* timeout timer */
210 unsigned short slave_timeout; /* when? */
211} ax25_dama_info;
212
213struct ctl_table;
214
215typedef struct ax25_dev {
216 struct ax25_dev *next;
217 struct net_device *dev;
218 struct net_device *forward;
0ca7a4c8 219 struct ctl_table_header *sysheader;
1da177e4
LT
220 int values[AX25_MAX_VALUES];
221#if defined(CONFIG_AX25_DAMA_SLAVE) || defined(CONFIG_AX25_DAMA_MASTER)
222 ax25_dama_info dama;
223#endif
224} ax25_dev;
225
226typedef struct ax25_cb {
227 struct hlist_node ax25_node;
228 ax25_address source_addr, dest_addr;
229 ax25_digi *digipeat;
230 ax25_dev *ax25_dev;
231 unsigned char iamdigi;
232 unsigned char state, modulus, pidincl;
233 unsigned short vs, vr, va;
234 unsigned char condition, backoff;
235 unsigned char n2, n2count;
236 struct timer_list t1timer, t2timer, t3timer, idletimer;
237 unsigned long t1, t2, t3, idle, rtt;
238 unsigned short paclen, fragno, fraglen;
239 struct sk_buff_head write_queue;
240 struct sk_buff_head reseq_queue;
241 struct sk_buff_head ack_queue;
242 struct sk_buff_head frag_queue;
243 unsigned char window;
244 struct timer_list timer, dtimer;
245 struct sock *sk; /* Backlink to socket */
246 atomic_t refcount;
247} ax25_cb;
248
249#define ax25_sk(__sk) ((ax25_cb *)(__sk)->sk_protinfo)
250
b67bfe0d
SL
251#define ax25_for_each(__ax25, list) \
252 hlist_for_each_entry(__ax25, list, ax25_node)
1da177e4
LT
253
254#define ax25_cb_hold(__ax25) \
255 atomic_inc(&((__ax25)->refcount))
256
257static __inline__ void ax25_cb_put(ax25_cb *ax25)
258{
259 if (atomic_dec_and_test(&ax25->refcount)) {
b4558ea9 260 kfree(ax25->digipeat);
1da177e4
LT
261 kfree(ax25);
262 }
263}
264
f852640e 265static inline __be16 ax25_type_trans(struct sk_buff *skb, struct net_device *dev)
56cb5156
ACM
266{
267 skb->dev = dev;
459a98ed 268 skb_reset_mac_header(skb);
56cb5156 269 skb->pkt_type = PACKET_HOST;
56cb5156
ACM
270 return htons(ETH_P_AX25);
271}
272
1da177e4
LT
273/* af_ax25.c */
274extern struct hlist_head ax25_list;
275extern spinlock_t ax25_list_lock;
c1d8f804 276void ax25_cb_add(ax25_cb *);
1da177e4
LT
277struct sock *ax25_find_listener(ax25_address *, int, struct net_device *, int);
278struct sock *ax25_get_socket(ax25_address *, ax25_address *, int);
c1d8f804
JP
279ax25_cb *ax25_find_cb(ax25_address *, ax25_address *, ax25_digi *,
280 struct net_device *);
281void ax25_send_to_raw(ax25_address *, struct sk_buff *, int);
282void ax25_destroy_socket(ax25_cb *);
283ax25_cb * __must_check ax25_create_cb(void);
284void ax25_fillin_cb(ax25_cb *, ax25_dev *);
285struct sock *ax25_make_new(struct sock *, struct ax25_dev *);
1da177e4
LT
286
287/* ax25_addr.c */
15b1c0e8
RB
288extern const ax25_address ax25_bcast;
289extern const ax25_address ax25_defaddr;
290extern const ax25_address null_ax25_address;
c1d8f804
JP
291char *ax2asc(char *buf, const ax25_address *);
292void asc2ax(ax25_address *addr, const char *callsign);
293int ax25cmp(const ax25_address *, const ax25_address *);
294int ax25digicmp(const ax25_digi *, const ax25_digi *);
295const unsigned char *ax25_addr_parse(const unsigned char *, int,
e8cc49bb 296 ax25_address *, ax25_address *, ax25_digi *, int *, int *);
c1d8f804
JP
297int ax25_addr_build(unsigned char *, const ax25_address *,
298 const ax25_address *, const ax25_digi *, int, int);
299int ax25_addr_size(const ax25_digi *);
300void ax25_digi_invert(const ax25_digi *, ax25_digi *);
1da177e4
LT
301
302/* ax25_dev.c */
303extern ax25_dev *ax25_dev_list;
304extern spinlock_t ax25_dev_lock;
305
306static inline ax25_dev *ax25_dev_ax25dev(struct net_device *dev)
307{
308 return dev->ax25_ptr;
309}
310
c1d8f804
JP
311ax25_dev *ax25_addr_ax25dev(ax25_address *);
312void ax25_dev_device_up(struct net_device *);
313void ax25_dev_device_down(struct net_device *);
314int ax25_fwd_ioctl(unsigned int, struct ax25_fwd_struct *);
315struct net_device *ax25_fwd_dev(struct net_device *);
316void ax25_dev_free(void);
1da177e4
LT
317
318/* ax25_ds_in.c */
c1d8f804 319int ax25_ds_frame_in(ax25_cb *, struct sk_buff *, int);
1da177e4
LT
320
321/* ax25_ds_subr.c */
c1d8f804
JP
322void ax25_ds_nr_error_recovery(ax25_cb *);
323void ax25_ds_enquiry_response(ax25_cb *);
324void ax25_ds_establish_data_link(ax25_cb *);
325void ax25_dev_dama_off(ax25_dev *);
326void ax25_dama_on(ax25_cb *);
327void ax25_dama_off(ax25_cb *);
1da177e4
LT
328
329/* ax25_ds_timer.c */
c1d8f804
JP
330void ax25_ds_setup_timer(ax25_dev *);
331void ax25_ds_set_timer(ax25_dev *);
332void ax25_ds_del_timer(ax25_dev *);
333void ax25_ds_timer(ax25_cb *);
334void ax25_ds_t1_timeout(ax25_cb *);
335void ax25_ds_heartbeat_expiry(ax25_cb *);
336void ax25_ds_t3timer_expiry(ax25_cb *);
337void ax25_ds_idletimer_expiry(ax25_cb *);
1da177e4
LT
338
339/* ax25_iface.c */
8d5cf596
RB
340
341struct ax25_protocol {
342 struct ax25_protocol *next;
343 unsigned int pid;
344 int (*func)(struct sk_buff *, ax25_cb *);
345};
346
c1d8f804
JP
347void ax25_register_pid(struct ax25_protocol *ap);
348void ax25_protocol_release(unsigned int);
a4282717
RB
349
350struct ax25_linkfail {
351 struct hlist_node lf_node;
352 void (*func)(ax25_cb *, int);
353};
354
c1d8f804
JP
355void ax25_linkfail_register(struct ax25_linkfail *lf);
356void ax25_linkfail_release(struct ax25_linkfail *lf);
357int __must_check ax25_listen_register(ax25_address *, struct net_device *);
358void ax25_listen_release(ax25_address *, struct net_device *);
359int(*ax25_protocol_function(unsigned int))(struct sk_buff *, ax25_cb *);
360int ax25_listen_mine(ax25_address *, struct net_device *);
361void ax25_link_failed(ax25_cb *, int);
362int ax25_protocol_is_registered(unsigned int);
1da177e4
LT
363
364/* ax25_in.c */
c1d8f804
JP
365int ax25_rx_iframe(ax25_cb *, struct sk_buff *);
366int ax25_kiss_rcv(struct sk_buff *, struct net_device *, struct packet_type *,
367 struct net_device *);
1da177e4
LT
368
369/* ax25_ip.c */
1d5da757 370netdev_tx_t ax25_ip_xmit(struct sk_buff *skb);
3b04ddde 371extern const struct header_ops ax25_header_ops;
1da177e4
LT
372
373/* ax25_out.c */
c1d8f804
JP
374ax25_cb *ax25_send_frame(struct sk_buff *, int, ax25_address *, ax25_address *,
375 ax25_digi *, struct net_device *);
376void ax25_output(ax25_cb *, int, struct sk_buff *);
377void ax25_kick(ax25_cb *);
378void ax25_transmit_buffer(ax25_cb *, struct sk_buff *, int);
379void ax25_queue_xmit(struct sk_buff *skb, struct net_device *dev);
380int ax25_check_iframes_acked(ax25_cb *, unsigned short);
1da177e4
LT
381
382/* ax25_route.c */
c1d8f804
JP
383void ax25_rt_device_down(struct net_device *);
384int ax25_rt_ioctl(unsigned int, void __user *);
54047320 385extern const struct file_operations ax25_route_fops;
c1d8f804
JP
386ax25_route *ax25_get_route(ax25_address *addr, struct net_device *dev);
387int ax25_rt_autobind(ax25_cb *, ax25_address *);
388struct sk_buff *ax25_rt_build_path(struct sk_buff *, ax25_address *,
389 ax25_address *, ax25_digi *);
390void ax25_rt_free(void);
1da177e4 391
1da177e4 392/* ax25_std_in.c */
c1d8f804 393int ax25_std_frame_in(ax25_cb *, struct sk_buff *, int);
1da177e4
LT
394
395/* ax25_std_subr.c */
c1d8f804
JP
396void ax25_std_nr_error_recovery(ax25_cb *);
397void ax25_std_establish_data_link(ax25_cb *);
398void ax25_std_transmit_enquiry(ax25_cb *);
399void ax25_std_enquiry_response(ax25_cb *);
400void ax25_std_timeout_response(ax25_cb *);
1da177e4
LT
401
402/* ax25_std_timer.c */
c1d8f804
JP
403void ax25_std_heartbeat_expiry(ax25_cb *);
404void ax25_std_t1timer_expiry(ax25_cb *);
405void ax25_std_t2timer_expiry(ax25_cb *);
406void ax25_std_t3timer_expiry(ax25_cb *);
407void ax25_std_idletimer_expiry(ax25_cb *);
1da177e4
LT
408
409/* ax25_subr.c */
c1d8f804
JP
410void ax25_clear_queues(ax25_cb *);
411void ax25_frames_acked(ax25_cb *, unsigned short);
412void ax25_requeue_frames(ax25_cb *);
413int ax25_validate_nr(ax25_cb *, unsigned short);
414int ax25_decode(ax25_cb *, struct sk_buff *, int *, int *, int *);
415void ax25_send_control(ax25_cb *, int, int, int);
416void ax25_return_dm(struct net_device *, ax25_address *, ax25_address *,
417 ax25_digi *);
418void ax25_calculate_t1(ax25_cb *);
419void ax25_calculate_rtt(ax25_cb *);
420void ax25_disconnect(ax25_cb *, int);
1da177e4
LT
421
422/* ax25_timer.c */
c1d8f804
JP
423void ax25_setup_timers(ax25_cb *);
424void ax25_start_heartbeat(ax25_cb *);
425void ax25_start_t1timer(ax25_cb *);
426void ax25_start_t2timer(ax25_cb *);
427void ax25_start_t3timer(ax25_cb *);
428void ax25_start_idletimer(ax25_cb *);
429void ax25_stop_heartbeat(ax25_cb *);
430void ax25_stop_t1timer(ax25_cb *);
431void ax25_stop_t2timer(ax25_cb *);
432void ax25_stop_t3timer(ax25_cb *);
433void ax25_stop_idletimer(ax25_cb *);
434int ax25_t1timer_running(ax25_cb *);
435unsigned long ax25_display_timer(struct timer_list *);
1da177e4
LT
436
437/* ax25_uid.c */
438extern int ax25_uid_policy;
c1d8f804
JP
439ax25_uid_assoc *ax25_findbyuid(kuid_t);
440int __must_check ax25_uid_ioctl(int, struct sockaddr_ax25 *);
54047320 441extern const struct file_operations ax25_uid_fops;
c1d8f804 442void ax25_uid_free(void);
1da177e4
LT
443
444/* sysctl_net_ax25.c */
445#ifdef CONFIG_SYSCTL
c1d8f804
JP
446int ax25_register_dev_sysctl(ax25_dev *ax25_dev);
447void ax25_unregister_dev_sysctl(ax25_dev *ax25_dev);
1da177e4 448#else
b9898507
EB
449static inline int ax25_register_dev_sysctl(ax25_dev *ax25_dev) { return 0; }
450static inline void ax25_unregister_dev_sysctl(ax25_dev *ax25_dev) {}
1da177e4
LT
451#endif /* CONFIG_SYSCTL */
452
453#endif