[apple/xnu.git] / bsd / net / ndrv.h

/*
 * Copyright (c) 2008 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) 1997, 1998 Apple Computer, Inc. All Rights Reserved */
/*
 *	@(#)ndrv.h	1.1 (MacOSX) 6/10/43
 * Justin Walker - 970604
 */
#include <net/dlil.h>

#ifndef _NET_NDRV_H
#define _NET_NDRV_H
#include <sys/appleapiopts.h>


struct sockaddr_ndrv
{
    unsigned char snd_len;
	unsigned char snd_family;
	unsigned char snd_name[IFNAMSIZ]; /* from if.h */
};

/*
 * Support for user-mode protocol handlers
 */

#define NDRV_DEMUXTYPE_ETHERTYPE	4
#define	NDRV_DEMUXTYPE_SAP			5
#define NDRV_DEMUXTYPE_SNAP			6

#define	NDRVPROTO_NDRV				0

/*
 * Struct: ndrv_demux_desc
 * Purpose:
 *   To uniquely identify a packet based on its low-level framing information.
 *
 * Fields:
 *		type		:	type of protocol in data field, must be understood by
 *						the interface family of the interface the socket is bound to
 *		length		: 	length of protocol data in "data" field
 *		data		:	union of framing-specific data, in network byte order
 *		ether_type	:	ethernet type in network byte order, assuming
 *						ethernet type II framing
 *		sap			:	first 3 bytes of sap header, network byte order
 *		snap		:	first 5 bytes of snap header, network byte order
 *		other		:	up to 28 bytes of protocol data for different protocol type
 *
 * Examples:
 * 1) 802.1x uses ether_type 0x888e, so the descriptor would be set as:
 *    struct ndrv_demux_desc desc;
 *    desc.type = NDRV_DEMUXTYPE_ETHERTYPE
 *	  desc.length = sizeof(unsigned short);
 *    desc.ether_type = htons(0x888e);
 * 2) AppleTalk uses SNAP 0x080007809B
 *    struct ndrv_demux_desc desc;
 *    desc.type = NDRV_DEMUXTYPE_SNAP;
 *    desc.length = 5;
 *    desc.data.snap[0] = 08;
 *    desc.data.snap[1] = 00;
 *    desc.data.snap[2] = 07;
 *    desc.data.snap[3] = 80;
 *    desc.data.snap[4] = 9B;
 */
struct ndrv_demux_desc
{
    u_int16_t	type;
    u_int16_t	length;
    union
    {
        u_int16_t	ether_type;
        u_int8_t	sap[3];
        u_int8_t	snap[5];
        u_int8_t	other[28];
    } data;
};

#define NDRV_PROTOCOL_DESC_VERS	1

/*
 * Struct: ndrv_protocol_desc
 * Purpose:
 *   Used to "bind" an NDRV socket so that packets that match
 *   given protocol demux descriptions can be received:
 * Field:
 *	version		:	must be NDRV_PROTOCOL_DESC_VERS
 *	protocol_family	:	unique identifier for this protocol
 *	demux_count	:	number of demux_list descriptors in demux_list; maximum of 10
 *	demux_list	:	pointer to array of demux descriptors
 */
struct ndrv_protocol_desc
{
    u_int32_t				version;
    u_int32_t				protocol_family;
    u_int32_t				demux_count;
    struct ndrv_demux_desc		*demux_list;
};

#ifdef KERNEL_PRIVATE
/* LP64 version of ndrv_protocol_desc.  all pointers 
 * grow when we're dealing with a 64-bit process.
 * WARNING - keep in sync with ndrv_protocol_desc
 */
struct ndrv_protocol_desc64 {
    u_int32_t				version;
    u_int32_t				protocol_family;
    u_int32_t				demux_count;
    user64_addr_t			demux_list __attribute__((aligned(8)));
};

struct ndrv_protocol_desc32 {
    u_int32_t				version;
    u_int32_t				protocol_family;
    u_int32_t				demux_count;
    user32_addr_t			demux_list;
};
#endif /* KERNEL_PRIVATE */

#define SOL_NDRVPROTO		NDRVPROTO_NDRV	/* Use this socket level */
#define NDRV_DELDMXSPEC		0x02			/* Delete the registered protocol */
#define NDRV_SETDMXSPEC		0x04			/* Set the protocol spec */
#define	NDRV_ADDMULTICAST	0x05			/* Add a physical multicast address */
#define NDRV_DELMULTICAST	0x06			/* Delete a phyiscal multicast */

/*
 * SOL_NDRVPROTO - use this for the socket level when calling setsocketopt
 * NDRV_DELDMXSPEC - removes the registered protocol and all related demuxes
 * NDRV_SETDMXSPEC - set the protocol to receive, use struct ndrv_protocol_desc
 *					 as the parameter.
 * NDRV_ADDMULTICAST - Enable reception of a phyiscal multicast address, use
 *                     a sockaddr of the appropriate type for the media in use.
 * NDRV_DELMULTICAST - Disable reception of a phyiscal multicast address, use
 *					   a sockaddr of the appropriate type for the media in use.
 *
 * When adding multicasts, the multicasts are ref counted. If the multicast is
 * already registered in the kernel, the count will be bumped. When deleting
 * the multicast, the count is decremented. If the count reaches zero the
 * multicast is removed. If your process is killed, PF_NDRV will unregister
 * the mulitcasts you've added. You can only delete multicasts you've added
 * on the same socket.
 *
 * If the interface goes away while your socket is open, your protocol is
 * immediately detached and sending/receiving is disabled on the socket.
 * If you need a chance to do something, please file a bug and we can give
 * you a second or two.
 */

/* Max number of descriptions allowed by default */
#define NDRV_DMUX_MAX_DESCR	1024
 
/*
 * sysctl MIB tags at the kern.ipc.nrdv level
 */
#define NRDV_MULTICAST_ADDRS_PER_SOCK 1	/* to toggle NDRV_DMUX_MAX_DESCR value */

#endif	/* _NET_NDRV_H */
Commit	Line	Data
1c79356b	1	/*
b0d623f7	2	* Copyright (c) 2008 Apple Computer, Inc. All rights reserved.
5d5c5d0d	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	/* Copyright (c) 1997, 1998 Apple Computer, Inc. All Rights Reserved */
	29	/*
	30	* @(#)ndrv.h 1.1 (MacOSX) 6/10/43
	31	* Justin Walker - 970604
	32	*/
7b1edb79	33	#include <net/dlil.h>
1c79356b A	34
	35	#ifndef _NET_NDRV_H
	36	#define _NET_NDRV_H
9bccf70c	37	#include <sys/appleapiopts.h>
1c79356b	38
7b1edb79	39
1c79356b	40	struct sockaddr_ndrv
7b1edb79 A	41	{
7b1edb79 A	42	unsigned char snd_len;
1c79356b A	43	unsigned char snd_family;
	44	unsigned char snd_name[IFNAMSIZ]; /* from if.h */
	45	};
	46
	47	/*
7b1edb79	48	* Support for user-mode protocol handlers
1c79356b	49	*/
1c79356b	50
91447636 A	51	#define NDRV_DEMUXTYPE_ETHERTYPE 4
	52	#define NDRV_DEMUXTYPE_SAP 5
	53	#define NDRV_DEMUXTYPE_SNAP 6
1c79356b	54
7b1edb79	55	#define NDRVPROTO_NDRV 0
1c79356b A	56
1c79356b A	57	/*
7b1edb79 A	58	* Struct: ndrv_demux_desc
	59	* Purpose:
	60	* To uniquely identify a packet based on its low-level framing information.
	61	*
	62	* Fields:
	63	* type : type of protocol in data field, must be understood by
	64	* the interface family of the interface the socket is bound to
	65	* length : length of protocol data in "data" field
	66	* data : union of framing-specific data, in network byte order
	67	* ether_type : ethernet type in network byte order, assuming
	68	* ethernet type II framing
	69	* sap : first 3 bytes of sap header, network byte order
	70	* snap : first 5 bytes of snap header, network byte order
	71	* other : up to 28 bytes of protocol data for different protocol type
	72	*
	73	* Examples:
	74	* 1) 802.1x uses ether_type 0x888e, so the descriptor would be set as:
	75	* struct ndrv_demux_desc desc;
	76	* desc.type = NDRV_DEMUXTYPE_ETHERTYPE
	77	* desc.length = sizeof(unsigned short);
	78	* desc.ether_type = htons(0x888e);
	79	* 2) AppleTalk uses SNAP 0x080007809B
	80	* struct ndrv_demux_desc desc;
	81	* desc.type = NDRV_DEMUXTYPE_SNAP;
	82	* desc.length = 5;
	83	* desc.data.snap[0] = 08;
	84	* desc.data.snap[1] = 00;
	85	* desc.data.snap[2] = 07;
	86	* desc.data.snap[3] = 80;
	87	* desc.data.snap[4] = 9B;
1c79356b	88	*/
7b1edb79 A	89	struct ndrv_demux_desc
	90	{
	91	u_int16_t type;
	92	u_int16_t length;
	93	union
	94	{
	95	u_int16_t ether_type;
	96	u_int8_t sap[3];
	97	u_int8_t snap[5];
	98	u_int8_t other[28];
	99	} data;
	100	};
	101
	102	#define NDRV_PROTOCOL_DESC_VERS 1
1c79356b	103
7b1edb79 A	104	/*
	105	* Struct: ndrv_protocol_desc
	106	* Purpose:
	107	* Used to "bind" an NDRV socket so that packets that match
	108	* given protocol demux descriptions can be received:
	109	* Field:
b0d623f7 A	110	* version : must be NDRV_PROTOCOL_DESC_VERS
b0d623f7 A	111	* protocol_family : unique identifier for this protocol
6d2010ae	112	* demux_count : number of demux_list descriptors in demux_list; maximum of 10
b0d623f7	113	* demux_list : pointer to array of demux descriptors
7b1edb79 A	114	*/
	115	struct ndrv_protocol_desc
	116	{
	117	u_int32_t version;
	118	u_int32_t protocol_family;
	119	u_int32_t demux_count;
b0d623f7	120	struct ndrv_demux_desc *demux_list;
1c79356b A	121	};
1c79356b A	122
2d21ac55 A	123	#ifdef KERNEL_PRIVATE
	124	/* LP64 version of ndrv_protocol_desc. all pointers
	125	* grow when we're dealing with a 64-bit process.
	126	* WARNING - keep in sync with ndrv_protocol_desc
	127	*/
	128	struct ndrv_protocol_desc64 {
	129	u_int32_t version;
	130	u_int32_t protocol_family;
	131	u_int32_t demux_count;
b0d623f7	132	user64_addr_t demux_list __attribute__((aligned(8)));
2d21ac55 A	133	};
2d21ac55 A	134
b0d623f7 A	135	struct ndrv_protocol_desc32 {
	136	u_int32_t version;
	137	u_int32_t protocol_family;
	138	u_int32_t demux_count;
	139	user32_addr_t demux_list;
	140	};
	141	#endif /* KERNEL_PRIVATE */
2d21ac55	142
7b1edb79	143	#define SOL_NDRVPROTO NDRVPROTO_NDRV /* Use this socket level */
7b1edb79	144	#define NDRV_DELDMXSPEC 0x02 /* Delete the registered protocol */
7b1edb79	145	#define NDRV_SETDMXSPEC 0x04 /* Set the protocol spec */
9bccf70c A	146	#define NDRV_ADDMULTICAST 0x05 /* Add a physical multicast address */
9bccf70c A	147	#define NDRV_DELMULTICAST 0x06 /* Delete a phyiscal multicast */
1c79356b	148
9bccf70c A	149	/*
	150	* SOL_NDRVPROTO - use this for the socket level when calling setsocketopt
	151	* NDRV_DELDMXSPEC - removes the registered protocol and all related demuxes
	152	* NDRV_SETDMXSPEC - set the protocol to receive, use struct ndrv_protocol_desc
	153	* as the parameter.
	154	* NDRV_ADDMULTICAST - Enable reception of a phyiscal multicast address, use
	155	* a sockaddr of the appropriate type for the media in use.
	156	* NDRV_DELMULTICAST - Disable reception of a phyiscal multicast address, use
	157	* a sockaddr of the appropriate type for the media in use.
	158	*
	159	* When adding multicasts, the multicasts are ref counted. If the multicast is
	160	* already registered in the kernel, the count will be bumped. When deleting
	161	* the multicast, the count is decremented. If the count reaches zero the
	162	* multicast is removed. If your process is killed, PF_NDRV will unregister
	163	* the mulitcasts you've added. You can only delete multicasts you've added
	164	* on the same socket.
	165	*
	166	* If the interface goes away while your socket is open, your protocol is
	167	* immediately detached and sending/receiving is disabled on the socket.
	168	* If you need a chance to do something, please file a bug and we can give
	169	* you a second or two.
	170	*/
	171
316670eb A	172	/* Max number of descriptions allowed by default */
	173	#define NDRV_DMUX_MAX_DESCR 1024
	174
	175	/*
	176	* sysctl MIB tags at the kern.ipc.nrdv level
	177	*/
	178	#define NRDV_MULTICAST_ADDRS_PER_SOCK 1 /* to toggle NDRV_DMUX_MAX_DESCR value */
	179
1c79356b	180	#endif /* _NET_NDRV_H */