xref: /xnu-11215.41.3/bsd/netinet/udp.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1 /*
2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /*
29  * Copyright (c) 1982, 1986, 1993
30  *	The Regents of the University of California.  All rights reserved.
31  *
32  * Redistribution and use in source and binary forms, with or without
33  * modification, are permitted provided that the following conditions
34  * are met:
35  * 1. Redistributions of source code must retain the above copyright
36  *    notice, this list of conditions and the following disclaimer.
37  * 2. Redistributions in binary form must reproduce the above copyright
38  *    notice, this list of conditions and the following disclaimer in the
39  *    documentation and/or other materials provided with the distribution.
40  * 3. All advertising materials mentioning features or use of this software
41  *    must display the following acknowledgement:
42  *	This product includes software developed by the University of
43  *	California, Berkeley and its contributors.
44  * 4. Neither the name of the University nor the names of its contributors
45  *    may be used to endorse or promote products derived from this software
46  *    without specific prior written permission.
47  *
48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58  * SUCH DAMAGE.
59  *
60  *	@(#)udp.h	8.1 (Berkeley) 6/10/93
61  */
62 
63 #ifndef _NETINET_UDP_H_
64 #define _NETINET_UDP_H_
65 
66 #ifndef DRIVERKIT
67 #include <sys/appleapiopts.h>
68 #include <sys/types.h>          /* u_short */
69 #else
70 #include <sys/_types.h>
71 #include <sys/_types/_u_char.h>
72 #include <sys/_types/_u_short.h>
73 #endif /* DRIVERKIT */
74 
75 /*
76  * Udp protocol header.
77  * Per RFC 768, September, 1981.
78  */
79 struct udphdr {
80 	u_short uh_sport;               /* source port */
81 	u_short uh_dport;               /* destination port */
82 	u_short uh_ulen;                /* udp length */
83 	u_short uh_sum;                 /* udp checksum */
84 };
85 
86 /*
87  * User-settable options (used with setsockopt).
88  */
89 #define UDP_NOCKSUM     0x01    /* don't checksum outbound payloads */
90 #ifdef PRIVATE
91 #define UDP_KEEPALIVE_OFFLOAD   0x02 /* Send keep-alive at a given interval */
92 #endif /* PRIVATE */
93 
94 #ifdef PRIVATE
95 /*
96  * This is a mechanism to offload keep-alive or heartbeat messages
97  * to the Wifi driver when the host processor is sleeping. The application
98  * will give a small amount of data that can be placed in the message. The
99  * application will also specify an interval at which these messages
100  * should be sent.
101  *
102  * The purpose of these messages is to detect loss of connectivity in
103  * peer-to-peer communication without keeping the host processor awake.
104  *
105  * The application will pass this data to the kernel using setsockopt. It
106  * can set the interval to 0 to disable keepalive offload.
107  */
108 #define UDP_KEEPALIVE_OFFLOAD_DATA_SIZE 32
109 
110 /* Maximum keep alive interval in seconds */
111 #define UDP_KEEPALIVE_INTERVAL_MAX_SECONDS      65536
112 
113 struct udp_keepalive_offload {
114 	u_char ka_data[UDP_KEEPALIVE_OFFLOAD_DATA_SIZE];
115 	u_int16_t ka_interval;          /* interval in seconds */
116 	u_int8_t ka_data_len;           /* valid length of ka_data */
117 	u_int8_t ka_type;               /* type of application */
118 #define UDP_KEEPALIVE_OFFLOAD_TYPE_AIRPLAY      0x1
119 };
120 
121 #endif /* PRIVATE */
122 #endif /* _NETINET_UDP_H */
123