xref: /xnu-11215/osfmk/man/processor_start.html (revision 186b8fce)
1*e13b1fa5SApple OSS Distributions<h2>processor_start</h2>
2*e13b1fa5SApple OSS Distributions<hr>
3*e13b1fa5SApple OSS Distributions<p>
4*e13b1fa5SApple OSS Distributions<strong>Function</strong> - Start a processor.
5*e13b1fa5SApple OSS Distributions<h3>SYNOPSIS</h3>
6*e13b1fa5SApple OSS Distributions<pre>
7*e13b1fa5SApple OSS Distributions<strong>#include&ltmach/mach_host.h&gt</strong>
8*e13b1fa5SApple OSS Distributions
9*e13b1fa5SApple OSS Distributions<strong>kern_return_t	processor_start</strong>
10*e13b1fa5SApple OSS Distributions		<strong>(processor_t</strong>	<var>processor</var><strong>);</strong>
11*e13b1fa5SApple OSS Distributions</pre>
12*e13b1fa5SApple OSS Distributions<h3>PARAMETERS</h3>
13*e13b1fa5SApple OSS Distributions<dl>
14*e13b1fa5SApple OSS Distributions<dt> <var>processor</var>
15*e13b1fa5SApple OSS Distributions<dd>
16*e13b1fa5SApple OSS Distributions[in processor send right]
17*e13b1fa5SApple OSS DistributionsThe processor to be controlled.
18*e13b1fa5SApple OSS Distributions</dl>
19*e13b1fa5SApple OSS Distributions<h3>DESCRIPTION</h3>
20*e13b1fa5SApple OSS Distributions<p>
21*e13b1fa5SApple OSS DistributionsThe <strong>processor_start</strong> function allows privileged software
22*e13b1fa5SApple OSS Distributionsto start a processor in
23*e13b1fa5SApple OSS Distributionsa multi-processor that so allows it.  A newly started processor
24*e13b1fa5SApple OSS Distributionsis assigned to the
25*e13b1fa5SApple OSS Distributionsdefault processor set.  The interpretation of this operation
26*e13b1fa5SApple OSS Distributionsis machine dependent.
27*e13b1fa5SApple OSS Distributions<h3>NOTES</h3>
28*e13b1fa5SApple OSS Distributions<p>
29*e13b1fa5SApple OSS DistributionsThis operation is machine dependent.  It may do nothing.
30*e13b1fa5SApple OSS Distributions<h3>CAUTIONS</h3>
31*e13b1fa5SApple OSS Distributions<p>
32*e13b1fa5SApple OSS DistributionsThe ability to restart an exited processor is machine dependent.
33*e13b1fa5SApple OSS Distributions<h3>RETURN VALUES</h3>
34*e13b1fa5SApple OSS Distributions<dl>
35*e13b1fa5SApple OSS Distributions<dt> <strong>KERN_FAILURE</strong>
36*e13b1fa5SApple OSS Distributions<dd>
37*e13b1fa5SApple OSS DistributionsThe operation was not performed.  A likely reason is that it
38*e13b1fa5SApple OSS Distributionsis not supported on this processor.
39*e13b1fa5SApple OSS Distributions</dl>
40*e13b1fa5SApple OSS Distributions<h3>RELATED INFORMATION</h3>
41*e13b1fa5SApple OSS Distributions<p>
42*e13b1fa5SApple OSS DistributionsFunctions:
43*e13b1fa5SApple OSS Distributions<a href="processor_control.html">processor_control</a>,
44*e13b1fa5SApple OSS Distributions<a href="processor_exit.html">processor_exit</a>,
45*e13b1fa5SApple OSS Distributions<a href="processor_info.html">processor_info</a>,
46*e13b1fa5SApple OSS Distributions<a href="host_processors.html">host_processors</a>.
47