]> git.saurik.com Git - apple/xnu.git/blame - osfmk/man/bootstrap_ports.html
xnu-344.tar.gz
[apple/xnu.git] / osfmk / man / bootstrap_ports.html
CommitLineData
9bccf70c 1<h2>bootstrap_ports</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return send rights to the system's control ports.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t bootstrap_ports</strong>\r <strong>(mach_port_t</strong> <var>bootstrap</var>,\r <strong>bootstrap</strong> <var>host_control</var>,\r <strong>host_control</strong> <var>device_master</var>,\r <strong>device_master</strong> <var>root_wired_ledger</var>,\r <strong>root_wired_ledger</strong> <var>root_paged_ledger</var>,\r <strong>bootstrap</strong> <var>security</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>bootstrap</var> \r<dd>\r[in bootstrap send right]\rThe bootstrap port obtained from \*Ltask_get_special_ports()\*O.\r<p>\r<dt> <var>host_priv</var> \r<dd>\r[out host-control send right]\rThe control port for the host.\r<p>\r<dt> <var>device_master</var> \r<dd>\r[out device-master send right]\rThe device master port.\r<p>\r<dt> <var>root_wired_ledger</var> \r<dd>\r[out ledger send right]\rThe root wired kernel memory ledger port.\r<p>\r<dt> <var>root_paged_ledger</var> \r<dd>\r[out ledger send right]\rThe root default memory managed space ledger \rport.\r<p>\r<dt> <var>security</var> \r<dd>\r[out security send right]\rThe host security port, used for setting task \ridentity.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>bootstrap_ports</strong> function returns a send right to\rthe host control, root\rledger, host security and device master ports. The kernel will respond\rto this message on the <strong>TASK_BOOTSTRAP_PORT</strong> given to the system bootstrap\rtask (task 1) with the system privileged ports. It is the \rresponsibility of the bootstrap task to manage the distribution\rof these rights to other servers.\r<p>\rAn OS personality can serve as a server on the TASK_BOOTSTRAP_PORT\rfor tasks or servers that it manages, and can regulate or interpose on\rthe ports in any way it deems necessary.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="device_open.html"><strong>device_open</strong></a>,\r<a href="host_get_clock_control.html"><strong>host_get_clock_control</strong></a>,\r<a href="host_get_clock_service.html"><strong>host_get_clock_service</strong></a>,\r<a href="host_processor_set_priv.html"><strong>host_processor_set_priv</strong></a>,\r<a href="host_processors.html"><strong>host_processors</strong></a>,\r<a href="ledger_create.html"><strong>ledger_create</strong></a>,\r<a href="task_set_security_token.html"><strong>task_set_security_token</strong></a>.\r