]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/net/ndrv.h
xnu-1699.22.81.tar.gz
[apple/xnu.git] / bsd / net / ndrv.h
index 7140ed56c43506b8a39e3639709db0b2d696c1c7..7e9fc970083be34f22ec1c523e3bbabc29fd2df9 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2008 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * 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.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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 OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * 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_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /* Copyright (c) 1997, 1998 Apple Computer, Inc. All Rights Reserved */
 /*
@@ -28,6 +34,7 @@
 
 #ifndef _NET_NDRV_H
 #define _NET_NDRV_H
+#include <sys/appleapiopts.h>
 
 
 struct sockaddr_ndrv
@@ -41,9 +48,9 @@ struct sockaddr_ndrv
  * Support for user-mode protocol handlers
  */
 
-#define NDRV_DEMUXTYPE_ETHERTYPE       DLIL_DESC_ETYPE2
-#define        NDRV_DEMUXTYPE_SAP                      DLIL_DESC_SAP
-#define NDRV_DEMUXTYPE_SNAP                    DLIL_DESC_SNAP
+#define NDRV_DEMUXTYPE_ETHERTYPE       4
+#define        NDRV_DEMUXTYPE_SAP                      5
+#define NDRV_DEMUXTYPE_SNAP                    6
 
 #define        NDRVPROTO_NDRV                          0
 
@@ -100,28 +107,66 @@ struct ndrv_demux_desc
  *   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
- *             demux_list              :       pointer to array of demux descriptors
+ *     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;
+    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 */
-/*             NDRV_DMXSPEC            0x01                       Obsolete */
 #define NDRV_DELDMXSPEC                0x02                    /* Delete the registered protocol */
-/*             NDRV_DMXSPECCNT         0x03                       Obsolete */
 #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 */
 
-#if KERNEL
-/* Additional Kernel APIs */
-struct ifnet*  ndrv_get_ifp(caddr_t ndrv_pcb);
-#endif
+/*
+ * 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.
+ */
 
 #endif /* _NET_NDRV_H */