xref: /xnu-10002.61.3/osfmk/man/processor_control.html (revision 0f4c859e951fba394238ab619495c4e1d54d0f34)
1*0f4c859eSApple OSS Distributions<h2>processor_control</h2>
2*0f4c859eSApple OSS Distributions<hr>
3*0f4c859eSApple OSS Distributions<p>
4*0f4c859eSApple OSS Distributions<strong>Function</strong> - Perform caller-specified operation on target processor. (Protected Interface.)
5*0f4c859eSApple OSS Distributions<h3>SYNOPSIS</h3>
6*0f4c859eSApple OSS Distributions<pre>
7*0f4c859eSApple OSS Distributions<strong>kern_return_t	processor_control</strong>
8*0f4c859eSApple OSS Distributions		<strong>(processor_t</strong>	<var>processor</var>,
9*0f4c859eSApple OSS Distributions		<strong>processor_info_t</strong>	<var>cmd</var>,
10*0f4c859eSApple OSS Distributions		<strong>mach_msg_type_number_t*</strong>	<var>count</var><strong>);</strong>
11*0f4c859eSApple OSS Distributions</pre>
12*0f4c859eSApple OSS Distributions<h3>PARAMETERS</h3>
13*0f4c859eSApple OSS Distributions<dl>
14*0f4c859eSApple OSS Distributions<dt> <var>processor</var>
15*0f4c859eSApple OSS Distributions<dd>
16*0f4c859eSApple OSS Distributions[in processor send right]
17*0f4c859eSApple OSS DistributionsThe processor to be controlled.
18*0f4c859eSApple OSS Distributions<dt> <var>cmd</var>
19*0f4c859eSApple OSS Distributions<dd>
20*0f4c859eSApple OSS Distributions[pointer to in array of natural-sized units]
21*0f4c859eSApple OSS DistributionsAn array containing the
22*0f4c859eSApple OSS Distributionscommand to be applied to the processor.
23*0f4c859eSApple OSS Distributions<dt> <var>count</var>
24*0f4c859eSApple OSS Distributions<dd>
25*0f4c859eSApple OSS Distributions[in scalar]
26*0f4c859eSApple OSS DistributionsThe size of the <var>cmd</var> array (in natural-sized units).
27*0f4c859eSApple OSS Distributions</dl>
28*0f4c859eSApple OSS Distributions<h3>DESCRIPTION</h3>
29*0f4c859eSApple OSS Distributions<p>
30*0f4c859eSApple OSS DistributionsThe <strong>processor_control</strong> function allows privileged software
31*0f4c859eSApple OSS Distributionsto control a
32*0f4c859eSApple OSS Distributionsprocessor in a multi-processor that so allows it.  The interpretation
33*0f4c859eSApple OSS Distributionsof <var>cmd</var> is machine
34*0f4c859eSApple OSS Distributionsdependent.
35*0f4c859eSApple OSS Distributions<h3>NOTES</h3>
36*0f4c859eSApple OSS Distributions<p>
37*0f4c859eSApple OSS DistributionsThese operations are machine dependent.  They may do nothing.
38*0f4c859eSApple OSS Distributions<h3>RETURN VALUES</h3>
39*0f4c859eSApple OSS Distributions<dl>
40*0f4c859eSApple OSS Distributions<dt> <strong>KERN_FAILURE</strong>
41*0f4c859eSApple OSS Distributions<dd>
42*0f4c859eSApple OSS DistributionsThe operation was not performed.  A likely reason is that it
43*0f4c859eSApple OSS Distributionsis not supported on this processor.
44*0f4c859eSApple OSS Distributions</dl>
45*0f4c859eSApple OSS Distributions<h3>RELATED INFORMATION</h3>
46*0f4c859eSApple OSS Distributions<p>
47*0f4c859eSApple OSS DistributionsFunctions:
48*0f4c859eSApple OSS Distributions<a href="processor_start.html">processor_start</a>,
49*0f4c859eSApple OSS Distributions<a href="processor_exit.html">processor_exit</a>,
50*0f4c859eSApple OSS Distributions<a href="processor_info.html">processor_info</a>,
51*0f4c859eSApple OSS Distributions<a href="host_processors.html">host_processors</a>.
52