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