xnu-792.6.76.tar.gz

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

diff --git a/osfmk/man/processor_control.html b/osfmk/man/processor_control.html
index faa83aabd4d7321a5d550ae8595ec43d5286216e..034bc2fda65089ab7ad1c88473616054c2754871 100755 (executable)
--- a/osfmk/man/processor_control.html
+++ b/osfmk/man/processor_control.html
@@ -1 +1,51 @@
-<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
\ No newline at end of file
+<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>.