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