xnu-1504.3.12.tar.gz

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

diff --git a/osfmk/man/processor_info.html b/osfmk/man/processor_info.html
index ed7828020f89a26cab5caa9e6ea88d7136e071f2..b74e57491e91d766a0b5d67f3562c20dda42c0ff 100755 (executable)
--- a/osfmk/man/processor_info.html
+++ b/osfmk/man/processor_info.html
@@ -1 +1,62 @@
-<h2>processor_info</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return information about a processor.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t       processor_info</strong>\r                <strong>(processor_t</strong>   <var>processor</var>,\r          <strong>processor_flavor_t</strong>     <var>flavor</var>,\r             <strong>host_t</strong> <var>host</var>,\r               <strong>processor_info_t</strong>       <var>processor_info</var>,\r             <strong>mach_msg_type_number_t</strong> <var>processor_info_count</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>processor</var> \r<dd>\r[in processor send right]\rA processor port for which information is\rdesired.\r<dt> <var>flavor</var> \r<dd>\r[in scalar]\rThe type of information requested.\r<dl>\r<dt> <strong>PROCESSOR_BASIC_INFO</strong>\r<dd>\rBasic information, slot number, running status, etc.  The\rreturned structure is <strong>processor_basic_info</strong>.\r</dl>\r<dt> <var>host</var> \r<dd>\r[out host-name send right]\rThe host on which the processor resides. \rThis is the host name port.\r<dt> <var>processor_info</var> \r<dd>\r[out structure]\rInformation about the processor.\r<dt> <var>processor_info_count</var> \r<dd>\r[in/out scalar]\rOn input, the maximum size of the buffer; on output, the \rsize returned (in natural-sized units).\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>processor_info</strong> function returns selected information\rfor a processor, as specified by <var>flavor</var>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\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_control.html">processor_control</a>,\r<a href="host_processors.html">host_processors</a>.\r<p>\rData Structures:\r<a href="processor_basic_info.html">processor_basic_info</a>.\r
\ No newline at end of file
+<h2>processor_info</h2>
+<hr>
+<p>
+<strong>Function</strong> - Return information about a processor.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t  processor_info</strong>
+               <strong>(processor_t</strong>   <var>processor</var>,
+               <strong>processor_flavor_t</strong>     <var>flavor</var>,
+               <strong>host_t</strong> <var>host</var>,
+               <strong>processor_info_t</strong>       <var>processor_info</var>,
+               <strong>mach_msg_type_number_t</strong> <var>processor_info_count</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<dt> <var>processor</var> 
+<dd>
+[in processor send right]
+A processor port for which information is
+desired.
+<dt> <var>flavor</var> 
+<dd>
+[in scalar]
+The type of information requested.
+<dl>
+<dt> <strong>PROCESSOR_BASIC_INFO</strong>
+<dd>
+Basic information, slot number, running status, etc.  The
+returned structure is <strong>processor_basic_info</strong>.
+</dl>
+<dt> <var>host</var> 
+<dd>
+[out host-name send right]
+The host on which the processor resides. 
+This is the host name port.
+<dt> <var>processor_info</var> 
+<dd>
+[out structure]
+Information about the processor.
+<dt> <var>processor_info_count</var> 
+<dd>
+[in/out scalar]
+On input, the maximum size of the buffer; on output, the 
+size returned (in natural-sized units).
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>processor_info</strong> function returns selected information
+for a processor, as specified by <var>flavor</var>.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<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_control.html">processor_control</a>,
+<a href="host_processors.html">host_processors</a>.
+<p>
+Data Structures:
+<a href="processor_basic_info.html">processor_basic_info</a>.