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