MSOP_SHUTDOWN(D2psm)

MSOP_SHUTDOWN -- shutdown or reboot the system, or both

Synopsis

   void pfxshutdown(int action)

Description

MSOP_SHUTDOWN is called to shutdown or reboot the system, or both. It handles only the low-level machine state. Any software state involved in the shutdown or reboot process will have been taken care of by the core kernel.

MSOP_SHUTDOWN will always be called on CPU 0 with all other CPUs offline. MSOP_OFFLINE_SELF(D2psm) must always have been called already. Interrupts are disabled on the CPU when MSOP_SHUTDOWN is called. Once MSOP_SHUTDOWN is called, no other MSOPs will be called. MSOP_SHUTDOWN never returns.

Arguments

action

This argument can take one of the following values:

MS_SD_HALT: Put the system in a non-interactive halted state in which no software is active. From this state, a user can reboot or shut off the power.
MS_SD_POWEROFF: Shut off the power to the system. This is like an automatic MS_SD_HALT and power-off. Most hardware does not have this capability.
MS_SD_AUTOBOOT: With no interaction, begin a fresh, default reboot of the system. Depending on the firmware and bootstrap, the user may or may not be able to interrupt this process once it has begun.
MS_SD_BOOTPROMPT: Begin a reboot sequence, but put the system into an interactive state at a firmware or bootstrap prompt from which a user can specify an alternate kernel to boot. The user may or may not be able to specify other parameters as well. The interactive mode may timeout if the user enters no input to the prompt. If it times out, it should proceed with the default boot sequence.

Only values which the PSM previously included as one of the bits set in the MSPARAM_SHUTDOWN_CAPS capabilities bit mask will be used for the action parameter. If the PSM sets the bit, it must be capable of performing the required action. If none of these bits are set, MSOP_SHUTDOWN will never be called; the operating system will emulate a halt instead, probably with an infinite loop.

Return values

None.

Usage

Hardware applicability

All.

Version applicability

psm: 2

References

MSOP_OFFLINE_SELF(D2psm)