xref: /aosp_15_r20/external/kernel-headers/original/uapi/linux/dccp.h (revision f80ad8b4341604f5951dab671d41019a6d7087ce)
1*f80ad8b4SAndroid Build Coastguard Worker /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2*f80ad8b4SAndroid Build Coastguard Worker #ifndef _UAPI_LINUX_DCCP_H
3*f80ad8b4SAndroid Build Coastguard Worker #define _UAPI_LINUX_DCCP_H
4*f80ad8b4SAndroid Build Coastguard Worker 
5*f80ad8b4SAndroid Build Coastguard Worker #include <linux/types.h>
6*f80ad8b4SAndroid Build Coastguard Worker #include <asm/byteorder.h>
7*f80ad8b4SAndroid Build Coastguard Worker 
8*f80ad8b4SAndroid Build Coastguard Worker /**
9*f80ad8b4SAndroid Build Coastguard Worker  * struct dccp_hdr - generic part of DCCP packet header
10*f80ad8b4SAndroid Build Coastguard Worker  *
11*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_sport - Relevant port on the endpoint that sent this packet
12*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_dport - Relevant port on the other endpoint
13*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_doff - Data Offset from the start of the DCCP header, in 32-bit words
14*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_ccval - Used by the HC-Sender CCID
15*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_cscov - Parts of the packet that are covered by the Checksum field
16*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_checksum - Internet checksum, depends on dccph_cscov
17*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_x - 0 = 24 bit sequence number, 1 = 48
18*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_type - packet type, see DCCP_PKT_ prefixed macros
19*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_seq - sequence number high or low order 24 bits, depends on dccph_x
20*f80ad8b4SAndroid Build Coastguard Worker  */
21*f80ad8b4SAndroid Build Coastguard Worker struct dccp_hdr {
22*f80ad8b4SAndroid Build Coastguard Worker 	__be16	dccph_sport,
23*f80ad8b4SAndroid Build Coastguard Worker 		dccph_dport;
24*f80ad8b4SAndroid Build Coastguard Worker 	__u8	dccph_doff;
25*f80ad8b4SAndroid Build Coastguard Worker #if defined(__LITTLE_ENDIAN_BITFIELD)
26*f80ad8b4SAndroid Build Coastguard Worker 	__u8	dccph_cscov:4,
27*f80ad8b4SAndroid Build Coastguard Worker 		dccph_ccval:4;
28*f80ad8b4SAndroid Build Coastguard Worker #elif defined(__BIG_ENDIAN_BITFIELD)
29*f80ad8b4SAndroid Build Coastguard Worker 	__u8	dccph_ccval:4,
30*f80ad8b4SAndroid Build Coastguard Worker 		dccph_cscov:4;
31*f80ad8b4SAndroid Build Coastguard Worker #else
32*f80ad8b4SAndroid Build Coastguard Worker #error  "Adjust your <asm/byteorder.h> defines"
33*f80ad8b4SAndroid Build Coastguard Worker #endif
34*f80ad8b4SAndroid Build Coastguard Worker 	__sum16	dccph_checksum;
35*f80ad8b4SAndroid Build Coastguard Worker #if defined(__LITTLE_ENDIAN_BITFIELD)
36*f80ad8b4SAndroid Build Coastguard Worker 	__u8	dccph_x:1,
37*f80ad8b4SAndroid Build Coastguard Worker 		dccph_type:4,
38*f80ad8b4SAndroid Build Coastguard Worker 		dccph_reserved:3;
39*f80ad8b4SAndroid Build Coastguard Worker #elif defined(__BIG_ENDIAN_BITFIELD)
40*f80ad8b4SAndroid Build Coastguard Worker 	__u8	dccph_reserved:3,
41*f80ad8b4SAndroid Build Coastguard Worker 		dccph_type:4,
42*f80ad8b4SAndroid Build Coastguard Worker 		dccph_x:1;
43*f80ad8b4SAndroid Build Coastguard Worker #else
44*f80ad8b4SAndroid Build Coastguard Worker #error  "Adjust your <asm/byteorder.h> defines"
45*f80ad8b4SAndroid Build Coastguard Worker #endif
46*f80ad8b4SAndroid Build Coastguard Worker 	__u8	dccph_seq2;
47*f80ad8b4SAndroid Build Coastguard Worker 	__be16	dccph_seq;
48*f80ad8b4SAndroid Build Coastguard Worker };
49*f80ad8b4SAndroid Build Coastguard Worker 
50*f80ad8b4SAndroid Build Coastguard Worker /**
51*f80ad8b4SAndroid Build Coastguard Worker  * struct dccp_hdr_ext - the low bits of a 48 bit seq packet
52*f80ad8b4SAndroid Build Coastguard Worker  *
53*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_seq_low - low 24 bits of a 48 bit seq packet
54*f80ad8b4SAndroid Build Coastguard Worker  */
55*f80ad8b4SAndroid Build Coastguard Worker struct dccp_hdr_ext {
56*f80ad8b4SAndroid Build Coastguard Worker 	__be32	dccph_seq_low;
57*f80ad8b4SAndroid Build Coastguard Worker };
58*f80ad8b4SAndroid Build Coastguard Worker 
59*f80ad8b4SAndroid Build Coastguard Worker /**
60*f80ad8b4SAndroid Build Coastguard Worker  * struct dccp_hdr_request - Connection initiation request header
61*f80ad8b4SAndroid Build Coastguard Worker  *
62*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_req_service - Service to which the client app wants to connect
63*f80ad8b4SAndroid Build Coastguard Worker  */
64*f80ad8b4SAndroid Build Coastguard Worker struct dccp_hdr_request {
65*f80ad8b4SAndroid Build Coastguard Worker 	__be32	dccph_req_service;
66*f80ad8b4SAndroid Build Coastguard Worker };
67*f80ad8b4SAndroid Build Coastguard Worker /**
68*f80ad8b4SAndroid Build Coastguard Worker  * struct dccp_hdr_ack_bits - acknowledgment bits common to most packets
69*f80ad8b4SAndroid Build Coastguard Worker  *
70*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_resp_ack_nr_high - 48 bit ack number high order bits, contains GSR
71*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_resp_ack_nr_low - 48 bit ack number low order bits, contains GSR
72*f80ad8b4SAndroid Build Coastguard Worker  */
73*f80ad8b4SAndroid Build Coastguard Worker struct dccp_hdr_ack_bits {
74*f80ad8b4SAndroid Build Coastguard Worker 	__be16	dccph_reserved1;
75*f80ad8b4SAndroid Build Coastguard Worker 	__be16	dccph_ack_nr_high;
76*f80ad8b4SAndroid Build Coastguard Worker 	__be32	dccph_ack_nr_low;
77*f80ad8b4SAndroid Build Coastguard Worker };
78*f80ad8b4SAndroid Build Coastguard Worker /**
79*f80ad8b4SAndroid Build Coastguard Worker  * struct dccp_hdr_response - Connection initiation response header
80*f80ad8b4SAndroid Build Coastguard Worker  *
81*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_resp_ack - 48 bit Acknowledgment Number Subheader (5.3)
82*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_resp_service - Echoes the Service Code on a received DCCP-Request
83*f80ad8b4SAndroid Build Coastguard Worker  */
84*f80ad8b4SAndroid Build Coastguard Worker struct dccp_hdr_response {
85*f80ad8b4SAndroid Build Coastguard Worker 	struct dccp_hdr_ack_bits	dccph_resp_ack;
86*f80ad8b4SAndroid Build Coastguard Worker 	__be32				dccph_resp_service;
87*f80ad8b4SAndroid Build Coastguard Worker };
88*f80ad8b4SAndroid Build Coastguard Worker 
89*f80ad8b4SAndroid Build Coastguard Worker /**
90*f80ad8b4SAndroid Build Coastguard Worker  * struct dccp_hdr_reset - Unconditionally shut down a connection
91*f80ad8b4SAndroid Build Coastguard Worker  *
92*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_reset_ack - 48 bit Acknowledgment Number Subheader (5.6)
93*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_reset_code - one of %dccp_reset_codes
94*f80ad8b4SAndroid Build Coastguard Worker  * @dccph_reset_data - the Data 1 ... Data 3 fields from 5.6
95*f80ad8b4SAndroid Build Coastguard Worker  */
96*f80ad8b4SAndroid Build Coastguard Worker struct dccp_hdr_reset {
97*f80ad8b4SAndroid Build Coastguard Worker 	struct dccp_hdr_ack_bits	dccph_reset_ack;
98*f80ad8b4SAndroid Build Coastguard Worker 	__u8				dccph_reset_code,
99*f80ad8b4SAndroid Build Coastguard Worker 					dccph_reset_data[3];
100*f80ad8b4SAndroid Build Coastguard Worker };
101*f80ad8b4SAndroid Build Coastguard Worker 
102*f80ad8b4SAndroid Build Coastguard Worker enum dccp_pkt_type {
103*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_PKT_REQUEST = 0,
104*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_PKT_RESPONSE,
105*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_PKT_DATA,
106*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_PKT_ACK,
107*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_PKT_DATAACK,
108*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_PKT_CLOSEREQ,
109*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_PKT_CLOSE,
110*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_PKT_RESET,
111*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_PKT_SYNC,
112*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_PKT_SYNCACK,
113*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_PKT_INVALID,
114*f80ad8b4SAndroid Build Coastguard Worker };
115*f80ad8b4SAndroid Build Coastguard Worker 
116*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_NR_PKT_TYPES DCCP_PKT_INVALID
117*f80ad8b4SAndroid Build Coastguard Worker 
dccp_packet_hdr_len(const __u8 type)118*f80ad8b4SAndroid Build Coastguard Worker static inline unsigned int dccp_packet_hdr_len(const __u8 type)
119*f80ad8b4SAndroid Build Coastguard Worker {
120*f80ad8b4SAndroid Build Coastguard Worker 	if (type == DCCP_PKT_DATA)
121*f80ad8b4SAndroid Build Coastguard Worker 		return 0;
122*f80ad8b4SAndroid Build Coastguard Worker 	if (type == DCCP_PKT_DATAACK	||
123*f80ad8b4SAndroid Build Coastguard Worker 	    type == DCCP_PKT_ACK	||
124*f80ad8b4SAndroid Build Coastguard Worker 	    type == DCCP_PKT_SYNC	||
125*f80ad8b4SAndroid Build Coastguard Worker 	    type == DCCP_PKT_SYNCACK	||
126*f80ad8b4SAndroid Build Coastguard Worker 	    type == DCCP_PKT_CLOSE	||
127*f80ad8b4SAndroid Build Coastguard Worker 	    type == DCCP_PKT_CLOSEREQ)
128*f80ad8b4SAndroid Build Coastguard Worker 		return sizeof(struct dccp_hdr_ack_bits);
129*f80ad8b4SAndroid Build Coastguard Worker 	if (type == DCCP_PKT_REQUEST)
130*f80ad8b4SAndroid Build Coastguard Worker 		return sizeof(struct dccp_hdr_request);
131*f80ad8b4SAndroid Build Coastguard Worker 	if (type == DCCP_PKT_RESPONSE)
132*f80ad8b4SAndroid Build Coastguard Worker 		return sizeof(struct dccp_hdr_response);
133*f80ad8b4SAndroid Build Coastguard Worker 	return sizeof(struct dccp_hdr_reset);
134*f80ad8b4SAndroid Build Coastguard Worker }
135*f80ad8b4SAndroid Build Coastguard Worker enum dccp_reset_codes {
136*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_UNSPECIFIED = 0,
137*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_CLOSED,
138*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_ABORTED,
139*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_NO_CONNECTION,
140*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_PACKET_ERROR,
141*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_OPTION_ERROR,
142*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_MANDATORY_ERROR,
143*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_CONNECTION_REFUSED,
144*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_BAD_SERVICE_CODE,
145*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_TOO_BUSY,
146*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_BAD_INIT_COOKIE,
147*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_RESET_CODE_AGGRESSION_PENALTY,
148*f80ad8b4SAndroid Build Coastguard Worker 
149*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_MAX_RESET_CODES		/* Leave at the end!  */
150*f80ad8b4SAndroid Build Coastguard Worker };
151*f80ad8b4SAndroid Build Coastguard Worker 
152*f80ad8b4SAndroid Build Coastguard Worker /* DCCP options */
153*f80ad8b4SAndroid Build Coastguard Worker enum {
154*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_PADDING = 0,
155*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_MANDATORY = 1,
156*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_MIN_RESERVED = 3,
157*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_MAX_RESERVED = 31,
158*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_CHANGE_L = 32,
159*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_CONFIRM_L = 33,
160*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_CHANGE_R = 34,
161*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_CONFIRM_R = 35,
162*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_NDP_COUNT = 37,
163*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_ACK_VECTOR_0 = 38,
164*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_ACK_VECTOR_1 = 39,
165*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_TIMESTAMP = 41,
166*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_TIMESTAMP_ECHO = 42,
167*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_ELAPSED_TIME = 43,
168*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_MAX = 45,
169*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_MIN_RX_CCID_SPECIFIC = 128,	/* from sender to receiver */
170*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_MAX_RX_CCID_SPECIFIC = 191,
171*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_MIN_TX_CCID_SPECIFIC = 192,	/* from receiver to sender */
172*f80ad8b4SAndroid Build Coastguard Worker 	DCCPO_MAX_TX_CCID_SPECIFIC = 255,
173*f80ad8b4SAndroid Build Coastguard Worker };
174*f80ad8b4SAndroid Build Coastguard Worker /* maximum size of a single TLV-encoded DCCP option (sans type/len bytes) */
175*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SINGLE_OPT_MAXLEN	253
176*f80ad8b4SAndroid Build Coastguard Worker 
177*f80ad8b4SAndroid Build Coastguard Worker /* DCCP CCIDS */
178*f80ad8b4SAndroid Build Coastguard Worker enum {
179*f80ad8b4SAndroid Build Coastguard Worker 	DCCPC_CCID2 = 2,
180*f80ad8b4SAndroid Build Coastguard Worker 	DCCPC_CCID3 = 3,
181*f80ad8b4SAndroid Build Coastguard Worker };
182*f80ad8b4SAndroid Build Coastguard Worker 
183*f80ad8b4SAndroid Build Coastguard Worker /* DCCP features (RFC 4340 section 6.4) */
184*f80ad8b4SAndroid Build Coastguard Worker enum dccp_feature_numbers {
185*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_RESERVED = 0,
186*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_CCID = 1,
187*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_SHORT_SEQNOS = 2,
188*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_SEQUENCE_WINDOW = 3,
189*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_ECN_INCAPABLE = 4,
190*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_ACK_RATIO = 5,
191*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_SEND_ACK_VECTOR = 6,
192*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_SEND_NDP_COUNT = 7,
193*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_MIN_CSUM_COVER = 8,
194*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_DATA_CHECKSUM = 9,
195*f80ad8b4SAndroid Build Coastguard Worker 	/* 10-127 reserved */
196*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_MIN_CCID_SPECIFIC = 128,
197*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_SEND_LEV_RATE = 192,	/* RFC 4342, sec. 8.4 */
198*f80ad8b4SAndroid Build Coastguard Worker 	DCCPF_MAX_CCID_SPECIFIC = 255,
199*f80ad8b4SAndroid Build Coastguard Worker };
200*f80ad8b4SAndroid Build Coastguard Worker 
201*f80ad8b4SAndroid Build Coastguard Worker /* DCCP socket control message types for cmsg */
202*f80ad8b4SAndroid Build Coastguard Worker enum dccp_cmsg_type {
203*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_SCM_PRIORITY = 1,
204*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_SCM_QPOLICY_MAX = 0xFFFF,
205*f80ad8b4SAndroid Build Coastguard Worker 	/* ^-- Up to here reserved exclusively for qpolicy parameters */
206*f80ad8b4SAndroid Build Coastguard Worker 	DCCP_SCM_MAX
207*f80ad8b4SAndroid Build Coastguard Worker };
208*f80ad8b4SAndroid Build Coastguard Worker 
209*f80ad8b4SAndroid Build Coastguard Worker /* DCCP priorities for outgoing/queued packets */
210*f80ad8b4SAndroid Build Coastguard Worker enum dccp_packet_dequeueing_policy {
211*f80ad8b4SAndroid Build Coastguard Worker 	DCCPQ_POLICY_SIMPLE,
212*f80ad8b4SAndroid Build Coastguard Worker 	DCCPQ_POLICY_PRIO,
213*f80ad8b4SAndroid Build Coastguard Worker 	DCCPQ_POLICY_MAX
214*f80ad8b4SAndroid Build Coastguard Worker };
215*f80ad8b4SAndroid Build Coastguard Worker 
216*f80ad8b4SAndroid Build Coastguard Worker /* DCCP socket options */
217*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_PACKET_SIZE	1 /* XXX deprecated, without effect */
218*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_SERVICE		2
219*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_CHANGE_L		3
220*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_CHANGE_R		4
221*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_GET_CUR_MPS	5
222*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_SERVER_TIMEWAIT	6
223*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_SEND_CSCOV		10
224*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_RECV_CSCOV		11
225*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_AVAILABLE_CCIDS	12
226*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_CCID		13
227*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_TX_CCID		14
228*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_RX_CCID		15
229*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_QPOLICY_ID		16
230*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_QPOLICY_TXQLEN	17
231*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_CCID_RX_INFO	128
232*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SOCKOPT_CCID_TX_INFO	192
233*f80ad8b4SAndroid Build Coastguard Worker 
234*f80ad8b4SAndroid Build Coastguard Worker /* maximum number of services provided on the same listening port */
235*f80ad8b4SAndroid Build Coastguard Worker #define DCCP_SERVICE_LIST_MAX_LEN      32
236*f80ad8b4SAndroid Build Coastguard Worker 
237*f80ad8b4SAndroid Build Coastguard Worker 
238*f80ad8b4SAndroid Build Coastguard Worker #endif /* _UAPI_LINUX_DCCP_H */
239