xnu-3789.70.16.tar.gz

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

diff --git a/bsd/net/kpi_protocol.h b/bsd/net/kpi_protocol.h
index 5ea4188daf2de035f36076a0c01586c309a442ce..b2546d4e39de38a578d14d04fbb4af4a574c2cbd 100644 (file)
--- a/bsd/net/kpi_protocol.h
+++ b/bsd/net/kpi_protocol.h
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2008-2016 Apple Inc. All rights reserved.

  *
  *

- * @APPLE_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 Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @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,
  * 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.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ * 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@

  */
 /*!
        @header kpi_protocol.h
  */
 /*!
        @header kpi_protocol.h


@@ -33,14 +39,13 @@
 #include <sys/kernel_types.h>
 #include <net/kpi_interface.h>
 
 #include <sys/kernel_types.h>
 #include <net/kpi_interface.h>
 

-

 __BEGIN_DECLS
 
 __BEGIN_DECLS
 

-/****************************************************************************/
-/* Protocol input/inject                                                                                                       */
-/****************************************************************************/
+/******************************************************************************/
+/* Protocol input/inject                                                      */
+/******************************************************************************/

 
 

-#ifdef KERNEL_PRIVATE
+#ifdef BSD_KERNEL_PRIVATE

 /*!
        @typedef protocol_input_handler
        @discussion protocol_input_handler is called to input a packet. If
 /*!
        @typedef protocol_input_handler
        @discussion protocol_input_handler is called to input a packet. If


@@ -68,10 +73,12 @@ typedef void (*proto_input_detached_handler)(protocol_family_t protocol);
        @param protocol The protocol family these functions will receive
                packets for.
        @param input The function called when a packet is input.
        @param protocol The protocol family these functions will receive
                packets for.
        @param input The function called when a packet is input.

+       @param chains Input function supports packet chains.

        @result A errno error on failure.
  */
        @result A errno error on failure.
  */

-errno_t        proto_register_input(protocol_family_t protocol, proto_input_handler input,
-                                                        proto_input_detached_handler detached);
+extern errno_t proto_register_input(protocol_family_t protocol,
+    proto_input_handler input, proto_input_detached_handler detached,
+    int chains);

 
 /*!
        @function proto_unregister_input
 
 /*!
        @function proto_unregister_input


@@ -83,13 +90,9 @@ errno_t      proto_register_input(protocol_family_t protocol, proto_input_handler inp
                to unload until the proto_detached_handler is called.
        @param protocol The protocol family these functions will receive
                packets for.
                to unload until the proto_detached_handler is called.
        @param protocol The protocol family these functions will receive
                packets for.

-       @param input The function called when a packet is input.
-       @param inject The function to called when a packet is injected (not
-               on the normal input path).
-       @result A errno error on failure.

  */
  */

-void   proto_unregister_input(protocol_family_t protocol);
-#endif
+extern void proto_unregister_input(protocol_family_t protocol);
+#endif /* BSD_KERNEL_PRIVATE */

 
 /*!
        @function proto_input
 
 /*!
        @function proto_input


@@ -100,7 +103,7 @@ void        proto_unregister_input(protocol_family_t protocol);
        @result A errno error on failure. Unless proto_input returns zero,
                the caller is responsible for freeing the mbuf.
  */
        @result A errno error on failure. Unless proto_input returns zero,
                the caller is responsible for freeing the mbuf.
  */

-errno_t        proto_input(protocol_family_t protocol, mbuf_t packet);
+extern errno_t proto_input(protocol_family_t protocol, mbuf_t packet);

 
 /*!
        @function proto_inject
 
 /*!
        @function proto_inject


@@ -112,12 +115,12 @@ errno_t   proto_input(protocol_family_t protocol, mbuf_t packet);
        @result A errno error on failure. Unless proto_inject returns zero,
                the caller is responsible for freeing the mbuf.
  */
        @result A errno error on failure. Unless proto_inject returns zero,
                the caller is responsible for freeing the mbuf.
  */

-errno_t        proto_inject(protocol_family_t protocol, mbuf_t packet);
+extern errno_t proto_inject(protocol_family_t protocol, mbuf_t packet);

 
 
 
 

-/****************************************************************************/
-/* Protocol plumbing                                                                                                           */
-/****************************************************************************/
+/******************************************************************************/
+/* Protocol plumbing                                                          */
+/******************************************************************************/

 
 /*!
        @typedef proto_plumb_handler
 
 /*!
        @typedef proto_plumb_handler


@@ -125,7 +128,7 @@ errno_t     proto_inject(protocol_family_t protocol, mbuf_t packet);
                interface. A typical protocol plumb function would fill out an
                ifnet_attach_proto_param and call ifnet_attach_protocol.
        @param ifp The interface the protocol should be attached to.
                interface. A typical protocol plumb function would fill out an
                ifnet_attach_proto_param and call ifnet_attach_protocol.
        @param ifp The interface the protocol should be attached to.

-       @param protocol_family The protocol that should be attached to the
+       @param protocol The protocol that should be attached to the

                interface.
        @result
                A non-zero value of the attach failed.
                interface.
        @result
                A non-zero value of the attach failed.


@@ -138,16 +141,16 @@ typedef errno_t (*proto_plumb_handler)(ifnet_t ifp, protocol_family_t protocol);
                from an interface. A typical unplumb function would call
                ifnet_detach_protocol and perform any necessary cleanup.
        @param ifp The interface the protocol should be detached from.
                from an interface. A typical unplumb function would call
                ifnet_detach_protocol and perform any necessary cleanup.
        @param ifp The interface the protocol should be detached from.

-       @param protocol_family The protocol that should be detached from the
+       @param protocol The protocol that should be detached from the

                interface.
  */
 typedef void (*proto_unplumb_handler)(ifnet_t ifp, protocol_family_t protocol);
 
 /*!
        @function proto_register_plumber
                interface.
  */
 typedef void (*proto_unplumb_handler)(ifnet_t ifp, protocol_family_t protocol);
 
 /*!
        @function proto_register_plumber

-       @discussion Allows the caller to specify the functions called when a protocol
-               is attached to an interface belonging to the specified family and when
-               that protocol is detached.
+       @discussion Allows the caller to specify the functions called when a
+               protocol is attached to an interface belonging to the specified
+               family and when that protocol is detached.

        @param proto_fam The protocol family these plumbing functions will
                handle.
        @param if_fam The interface family these plumbing functions will
        @param proto_fam The protocol family these plumbing functions will
                handle.
        @param if_fam The interface family these plumbing functions will


@@ -159,8 +162,9 @@ typedef void (*proto_unplumb_handler)(ifnet_t ifp, protocol_family_t protocol);
                be used to detach the protocol.
        @result A non-zero value of the attach failed.
  */
                be used to detach the protocol.
        @result A non-zero value of the attach failed.
  */

-errno_t        proto_register_plumber(protocol_family_t proto_fam, ifnet_family_t if_fam,
-                                                          proto_plumb_handler plumb, proto_unplumb_handler unplumb);
+extern errno_t proto_register_plumber(protocol_family_t proto_fam,
+    ifnet_family_t if_fam, proto_plumb_handler plumb,
+    proto_unplumb_handler unplumb);

 
 /*!
        @function proto_unregister_plumber
 
 /*!
        @function proto_unregister_plumber


@@ -169,8 +173,43 @@ errno_t    proto_register_plumber(protocol_family_t proto_fam, ifnet_family_t if_fa
                handle.
        @param if_fam The interface family these plumbing functions handle.
  */
                handle.
        @param if_fam The interface family these plumbing functions handle.
  */

-void   proto_unregister_plumber(protocol_family_t proto_fam, ifnet_family_t if_fam);
+extern void proto_unregister_plumber(protocol_family_t proto_fam,
+    ifnet_family_t if_fam);

 
 

+#ifdef BSD_KERNEL_PRIVATE
+/*
+       @function proto_plumb
+       @discussion Plumbs a protocol to an actual interface.  This will find
+               a registered protocol module and call its attach function.
+               The module will typically call dlil_attach_protocol() with the
+               appropriate parameters.
+       @param protocol_family The protocol family.
+       @param ifp The interface to plumb the protocol to.
+       @result 0: No error.
+               ENOENT: No module was registered.
+               Other: Error returned by the attach_proto function
+*/
+extern errno_t proto_plumb(protocol_family_t protocol_family, ifnet_t ifp);
+
+/*
+       @function proto_unplumb
+       @discussion Unplumbs a protocol from an interface.  This will find
+               a registered protocol module and call its detach function.
+               The module will typically call dlil_detach_protocol() with
+               the appropriate parameters.  If no module is found, this
+               function will call dlil_detach_protocol directly().
+       @param protocol_family The protocol family.
+       @param ifp The interface to unplumb the protocol from.
+       @result 0: No error.
+               ENOENT: No module was registered.
+               Other: Error returned by the attach_proto function
+*/
+extern errno_t proto_unplumb(protocol_family_t protocol_family, ifnet_t ifp);
+
+__private_extern__ void
+proto_kpi_init(void);
+
+#endif /* BSD_KERNEL_PRIVATE */

 __END_DECLS
 
 __END_DECLS
 

-#endif
+#endif /* __KPI_PROTOCOL__ */