[apple/xnu.git] / bsd / netinet / udp.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1982, 1986, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)udp.h	8.1 (Berkeley) 6/10/93
 */

#ifndef _NETINET_UDP_H_
#define _NETINET_UDP_H_
#include <sys/appleapiopts.h>
#include <sys/types.h>		/* u_short */

/*
 * Udp protocol header.
 * Per RFC 768, September, 1981.
 */
struct udphdr {
	u_short	uh_sport;		/* source port */
	u_short	uh_dport;		/* destination port */
	u_short	uh_ulen;		/* udp length */
	u_short	uh_sum;			/* udp checksum */
};

/*
 * User-settable options (used with setsockopt).
 */
#define	UDP_NOCKSUM	0x01	/* don't checksum outbound payloads */
#ifdef PRIVATE
#define UDP_KEEPALIVE_OFFLOAD	0x02 /* Send keep-alive at a given interval */
#endif /* PRIVATE */

#ifdef PRIVATE
/*
 * This is a mechanism to offload keep-alive or heartbeat messages
 * to the Wifi driver when the host processor is sleeping. The application
 * will give a small amount of data that can be placed in the message. The
 * application will also specify an interval at which these messages
 * should be sent.
 *
 * The purpose of these messages is to detect loss of connectivity in
 * peer-to-peer communication without keeping the host processor awake.
 *
 * The application will pass this data to the kernel using setsockopt. It
 * can set the interval to 0 to disable keepalive offload. 
 */
#define	UDP_KEEPALIVE_OFFLOAD_DATA_SIZE	32

/* Maximum keep alive interval in seconds */
#define UDP_KEEPALIVE_INTERVAL_MAX_SECONDS	65536

struct udp_keepalive_offload {
	u_char ka_data[UDP_KEEPALIVE_OFFLOAD_DATA_SIZE];
	u_int16_t ka_interval;		/* interval in seconds */
	u_int8_t ka_data_len;		/* valid length of ka_data */
	u_int8_t ka_type;		/* type of application */
#define	UDP_KEEPALIVE_OFFLOAD_TYPE_AIRPLAY	0x1
};

#endif /* PRIVATE */
#endif /* _NETINET_UDP_H */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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_
9bccf70c	65	#include <sys/appleapiopts.h>
2d21ac55	66	#include <sys/types.h> /* u_short */
1c79356b A	67
	68	/*
	69	* Udp protocol header.
	70	* Per RFC 768, September, 1981.
	71	*/
	72	struct udphdr {
	73	u_short uh_sport; /* source port */
	74	u_short uh_dport; /* destination port */
	75	u_short uh_ulen; /* udp length */
	76	u_short uh_sum; /* udp checksum */
	77	};
	78
2d21ac55 A	79	/*
	80	* User-settable options (used with setsockopt).
	81	*/
	82	#define UDP_NOCKSUM 0x01 /* don't checksum outbound payloads */
3e170ce0 A	83	#ifdef PRIVATE
	84	#define UDP_KEEPALIVE_OFFLOAD 0x02 /* Send keep-alive at a given interval */
	85	#endif /* PRIVATE */
	86
	87	#ifdef PRIVATE
	88	/*
	89	* This is a mechanism to offload keep-alive or heartbeat messages
	90	* to the Wifi driver when the host processor is sleeping. The application
	91	* will give a small amount of data that can be placed in the message. The
	92	* application will also specify an interval at which these messages
	93	* should be sent.
	94	*
	95	* The purpose of these messages is to detect loss of connectivity in
	96	* peer-to-peer communication without keeping the host processor awake.
	97	*
	98	* The application will pass this data to the kernel using setsockopt. It
	99	* can set the interval to 0 to disable keepalive offload.
	100	*/
	101	#define UDP_KEEPALIVE_OFFLOAD_DATA_SIZE 32
	102
	103	/* Maximum keep alive interval in seconds */
	104	#define UDP_KEEPALIVE_INTERVAL_MAX_SECONDS 65536
	105
	106	struct udp_keepalive_offload {
	107	u_char ka_data[UDP_KEEPALIVE_OFFLOAD_DATA_SIZE];
	108	u_int16_t ka_interval; /* interval in seconds */
	109	u_int8_t ka_data_len; /* valid length of ka_data */
	110	u_int8_t ka_type; /* type of application */
	111	#define UDP_KEEPALIVE_OFFLOAD_TYPE_AIRPLAY 0x1
	112	};
	113
	114	#endif /* PRIVATE */
	115	#endif /* _NETINET_UDP_H */