git.saurik.com Git - apple/xnu.git/blob - osfmk/man/processor

1 <h2>processor_control</h2>

2 <hr>

4 <strong>Function</strong> - Perform caller-specified operation on target processor. (Protected Interface.)

5 <h3>SYNOPSIS</h3>

6 <pre>

7 <strong>kern_return_t processor_control</strong>

8 <strong>(processor_t</strong> <var>processor</var>,

9 <strong>processor_info_t</strong> <var>cmd</var>,

10 <strong>mach_msg_type_number_t*</strong> <var>count</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 <dt> <var>cmd</var>

19 <dd>

20 [pointer to in array of natural-sized units]

21 An array containing the

22 command to be applied to the processor.

23 <dt> <var>count</var>

24 <dd>

25 [in scalar]

26 The size of the <var>cmd</var> array (in natural-sized units).

27 </dl>

28 <h3>DESCRIPTION</h3>

30 The <strong>processor_control</strong> function allows privileged software

31 to control a

32 processor in a multi-processor that so allows it. The interpretation

33 of <var>cmd</var> is machine

34 dependent.

35 <h3>NOTES</h3>

37 These operations are machine dependent. They may do nothing.

38 <h3>RETURN VALUES</h3>

39 <dl>

40 <dt> <strong>KERN_FAILURE</strong>

41 <dd>

42 The operation was not performed. A likely reason is that it

43 is not supported on this processor.

44 </dl>

45 <h3>RELATED INFORMATION</h3>

47 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>.