| blob | 6a4556900fdbc6b403f14ceb1385691899134855 |
1 .\" $NetBSD: cpu_reboot.9,v 1.16 2003/04/16 13:35:27 wiz Exp $
2 .\"
3 .\" Copyright (c) 1994 Christopher G. Demetriou
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\" must display the following acknowledgement:
16 .\" This product includes software developed for the
17 .\" NetBSD Project. See http://www.NetBSD.org/ for
18 .\" information about NetBSD.
19 .\" 4. The name of the author may not be used to endorse or promote products
20 .\" derived from this software without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 .\"
33 .\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
34 .\"
35 .Dd September 4, 2009
36 .Dt CPU_REBOOT 9
37 .Os
38 .Sh NAME
39 .Nm cpu_reboot
40 .Nd halt or reboot the system
41 .Sh SYNOPSIS
42 .In sys/reboot.h
43 .Ft void
44 .Fn cpu_reboot "int howto" "char *bootstr"
45 .Sh DESCRIPTION
46 The
47 .Fn cpu_reboot
48 function handles final system shutdown, and either halts or reboots
49 the system.
50 The exact action to be taken is determined by the flags passed in
51 .Fa howto
52 and by whether or not the system has finished autoconfiguration.
53 .Pp
54 If the system has finished autoconfiguration,
55 .Fn cpu_reboot
56 does the following:
57 .Bl -enum -offset indent
58 .It
59 Sets the
60 .Va boothowto
61 system variable (see
62 .Xr boothowto 9 )
63 from the
64 .Fa howto
65 argument.
66 .It
67 If this is the first invocation of
68 .Fn cpu_reboot
69 and the
70 .Dv RB_NOSYNC
71 flag is not set in
72 .Fa howto ,
73 syncs and unmounts the system disks by calling
74 .Xr vfs_shutdown 9
75 and sets the time of day clock by calling
76 .Xr resettodr 9 .
77 .It
78 Disables interrupts.
79 .It
80 If rebooting after a crash (i.e., if
81 .Dv RB_DUMP
82 is set in
83 .Fa howto ,
84 but
85 .Dv RB_HALT
86 is not), saves a system crash dump.
87 .It
88 Runs any shutdown hooks by calling
89 .Xr doshutdownhooks 9 .
90 .It
91 Prints a message indicating that the system is about to be halted
92 or rebooted.
93 .It
94 If
95 .Dv RB_HALT
96 is set in
97 .Fa howto ,
98 halts the system.
99 Otherwise, reboots the system.
100 .El
101 .Pp
102 If the system has not finished autoconfiguration,
103 .Fn cpu_reboot
104 runs any shutdown hooks by calling
105 .Xr doshutdownhooks 9 ,
106 prints a message, and halts the system.
107 .Pp
108 If
109 .Dv RB_STRING
110 is set in
111 .Pa howto ,
112 then the parameter
113 .Fa bootstr
114 is passed to the system boot loader on some ports.
115 .Sh SEE ALSO
116 .Xr boothowto 9 ,
117 .Xr doshutdownhooks 9 ,
118 .Xr dumpsys 9 ,
119 .Xr resettodr 9 ,
120 .Xr vfs_shutdown 9