xnu-4903.221.2.tar.gz

[apple/xnu.git] / osfmk / man / processor_control.html

<h2>processor_control</h2>
<hr>
<p>
<strong>Function</strong> - Perform caller-specified operation on target processor. (Protected Interface.)
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t	processor_control</strong>
		<strong>(processor_t</strong>	<var>processor</var>,
		<strong>processor_info_t</strong>	<var>cmd</var>,
		<strong>mach_msg_type_number_t*</strong>	<var>count</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<dt> <var>processor</var> 
<dd>
[in processor send right]
The processor to be controlled.
<dt> <var>cmd</var> 
<dd>
[pointer to in array of natural-sized units]
An array containing the
command to be applied to the processor.
<dt> <var>count</var> 
<dd>
[in scalar]
The size of the <var>cmd</var> array (in natural-sized units).
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>processor_control</strong> function allows privileged software
to control a
processor in a multi-processor that so allows it.  The interpretation
of <var>cmd</var> is machine 
dependent.
<h3>NOTES</h3>
<p>
These operations are machine dependent.  They may do nothing.
<h3>RETURN VALUES</h3>
<dl>
<dt> <strong>KERN_FAILURE</strong>
<dd>
The operation was not performed.  A likely reason is that it
is not supported on this processor.
</dl>
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="processor_start.html">processor_start</a>,
<a href="processor_exit.html">processor_exit</a>,
<a href="processor_info.html">processor_info</a>,
<a href="host_processors.html">host_processors</a>.