aboutsummaryrefslogtreecommitdiff
path: root/doc/opal-api/opal-return-cpu-69.rst
blob: 4a9631c8778f462ab8376000b94f69a2b28c4a61 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
OPAL_RETURN_CPU
===============
::

   int64_t opal_return_cpu(void);

When OPAL first starts the host, all secondary CPUs are spinning in OPAL.
To start them, one must call OPAL_START_CPU (you may want to OPAL_REINIT_CPUS
to set the HILE bit first).

In cases where you need OPAL to do something for you across all CPUs, such
as OPAL_REINIT_CPUS, (on some platforms) a firmware update or get the machine
back into a similar state as to when the host OS was started (e.g. for kexec)
you may also need to return control of the CPU to OPAL.


Returns
-------
This call does **not return**. You need to OPAL_START_CPU.