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

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