xnu-792.6.76.tar.gz

[apple/xnu.git] / osfmk / man / norma_set_special_port.html

diff --git a/osfmk/man/norma_set_special_port.html b/osfmk/man/norma_set_special_port.html
index 2624fe4326ced1eff40e6d6c91ce2d913f1bb0bf..f2d1f381d0aec0afc04b37d6e9afbc1f27da8713 100755 (executable)
--- a/osfmk/man/norma_set_special_port.html
+++ b/osfmk/man/norma_set_special_port.html
@@ -1 +1,97 @@
-<h2>norma_set_special_port</h2>\r<hr>\r<p>\r<strong>Function</strong> - Set node-specific special port.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   norma_set_special_port</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>int</strong>                                 <var>which_port</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r\r</pre>\r<h4>Macro forms:</h4>\r<pre>\r\r<strong>#include&ltmach/norma_special_ports.h&gt</strong>\r\r<strong>kern_return_t   norma_set_device_port</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r\r<strong>kern_return_t   norma_set_host_port</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r\r<strong>kern_return_t   norma_set_host_priv_port</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>int</strong>                                       <var>node</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r\r<strong>kern_return_t   norma_set_nameserver_port</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r</pre>\r\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>host_priv</var> \r<dd>\r[in host-control send right]\rThe host for which to set the special port. \rCurrently, this must be the per-node host control port.\r<p>\r<dt> <var>node</var> \r<dd>\r[in scalar]\rThe index of the node for which the port is to be set.\r<p>\r<dt> <var>which_port</var> \r<dd>\r[in scalar]\rThe index of the special port to be set.  Valid values are:\r<dl>\r<p>\r<dt> <strong>NORMA_DEVICE_PORT</strong>\r<dd>\r[device-master send right] The device master port for the \rnode.\r<p>\r<dt> <strong>NORMA_HOST_PORT</strong>\r<dd>\r[host-name send right] The host name port for the node.\r<p>\r<dt> <strong>NORMA_HOST_PRIV_PORT</strong>\r<dd>\r[host-control send right] The host control port for the node.\r<p>\r<dt> <strong>NORMA_NAMESERVER_PORT</strong>\r<dd>\r[name-server send right] The registered name server port for \rthe node.\r</dl>\r<p>\r<dt> <var>special_port</var> \r<dd>\r[in norma-special send right]\rSend right to the new special port.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>norma_set_special_port</strong> function sets the special\rport belonging to <var>node</var> on <var>host_priv</var>.\r<p>\rEach node maintains a (small) set of node specific ports.  The device master \rport, host name, and host control ports are maintained by the kernel.\rThe kernel also permits \ra small set of server specified \rnode specific ports; the name server port is an example and is given (by\rconvention) an assigned special port index.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="mach_host_self.html"><strong>mach_host_self</strong></a>,\r<a href="norma_get_special_port.html"><strong>norma_get_special_port</strong></a>.\r
\ No newline at end of file
+<h2>norma_set_special_port</h2>
+<hr>
+<p>
+<strong>Function</strong> - Set node-specific special port.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   norma_set_special_port</strong>
+                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
+                 <strong>int</strong>                                 <var>which_port</var>,
+                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>
+
+</pre>
+<h4>Macro forms:</h4>
+<pre>
+
+<strong>#include&ltmach/norma_special_ports.h&gt</strong>
+
+<strong>kern_return_t   norma_set_device_port</strong>
+                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
+                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>
+
+<strong>kern_return_t   norma_set_host_port</strong>
+                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
+                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>
+
+<strong>kern_return_t   norma_set_host_priv_port</strong>
+                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
+                 <strong>int</strong>                                       <var>node</var>,
+                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>
+
+<strong>kern_return_t   norma_set_nameserver_port</strong>
+                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
+                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>
+</pre>
+
+<h3>PARAMETERS</h3>
+<dl>
+<dt> <var>host_priv</var> 
+<dd>
+[in host-control send right]
+The host for which to set the special port. 
+Currently, this must be the per-node host control port.
+<p>
+<dt> <var>node</var> 
+<dd>
+[in scalar]
+The index of the node for which the port is to be set.
+<p>
+<dt> <var>which_port</var> 
+<dd>
+[in scalar]
+The index of the special port to be set.  Valid values are:
+<dl>
+<p>
+<dt> <strong>NORMA_DEVICE_PORT</strong>
+<dd>
+[device-master send right] The device master port for the 
+node.
+<p>
+<dt> <strong>NORMA_HOST_PORT</strong>
+<dd>
+[host-name send right] The host name port for the node.
+<p>
+<dt> <strong>NORMA_HOST_PRIV_PORT</strong>
+<dd>
+[host-control send right] The host control port for the node.
+<p>
+<dt> <strong>NORMA_NAMESERVER_PORT</strong>
+<dd>
+[name-server send right] The registered name server port for 
+the node.
+</dl>
+<p>
+<dt> <var>special_port</var> 
+<dd>
+[in norma-special send right]
+Send right to the new special port.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>norma_set_special_port</strong> function sets the special
+port belonging to <var>node</var> on <var>host_priv</var>.
+<p>
+Each node maintains a (small) set of node specific ports.  The device master 
+port, host name, and host control ports are maintained by the kernel.
+The kernel also permits 
+a small set of server specified 
+node specific ports; the name server port is an example and is given (by
+convention) an assigned special port index.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="mach_host_self.html"><strong>mach_host_self</strong></a>,
+<a href="norma_get_special_port.html"><strong>norma_get_special_port</strong></a>.