osfmk/man/processor_start.html

   1 <h2>processor_start</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Start a processor.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>#include&ltmach/mach_host.h&gt</strong>
   8
   9 <strong>kern_return_t   processor_start</strong>
  10                 <strong>(processor_t</strong>   <var>processor</var><strong>);</strong>
  11 </pre>
  12 <h3>PARAMETERS</h3>
  13 <dl>
  14 <dt> <var>processor</var>
  15 <dd>
  16 [in processor send right]
  17 The processor to be controlled.
  18 </dl>
  19 <h3>DESCRIPTION</h3>
  20 <p>
  21 The <strong>processor_start</strong> function allows privileged software
  22 to start a processor in
  23 a multi-processor that so allows it.  A newly started processor
  24 is assigned to the
  25 default processor set.  The interpretation of this operation
  26 is machine dependent.
  27 <h3>NOTES</h3>
  28 <p>
  29 This operation is machine dependent.  It may do nothing.
  30 <h3>CAUTIONS</h3>
  31 <p>
  32 The ability to restart an exited processor is machine dependent.
  33 <h3>RETURN VALUES</h3>
  34 <dl>
  35 <dt> <strong>KERN_FAILURE</strong>
  36 <dd>
  37 The operation was not performed.  A likely reason is that it
  38 is not supported on this processor.
  39 </dl>
  40 <h3>RELATED INFORMATION</h3>
  41 <p>
  42 Functions:
  43 <a href="processor_control.html">processor_control</a>,
  44 <a href="processor_exit.html">processor_exit</a>,
  45 <a href="processor_info.html">processor_info</a>,
  46 <a href="host_processors.html">host_processors</a>.