xref: /netbsd-src/share/man/man9/cpu_rootconf.9 (revision ba65fde2d7fefa7d39838fa5fa855e62bd606b5e)
1.\"     $NetBSD: cpu_rootconf.9,v 1.8 2012/07/29 18:51:48 wiz Exp $
2.\"
3.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Gregory McGarry.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd July 29, 2012
31.Dt CPU_ROOTCONF 9
32.Os
33.Sh NAME
34.Nm cpu_rootconf ,
35.Nm rootconf ,
36.Nm setroot
37.Nd root file system setup
38.Sh SYNOPSIS
39.In sys/types.h
40.In sys/systm.h
41.Ft void
42.Fn cpu_rootconf "void"
43.Ft void
44.Fn rootconf "void"
45.Ft void
46.Fn setroot "device_t bootdv" "int bootpartition"
47.Sh DESCRIPTION
48The
49.Fn cpu_rootconf
50is a machine-dependent interface invoked during system bootstrap to
51determine the root file system device and initialize machine-dependent
52file system state.
53.Fn cpu_rootconf
54provides the global variables
55.Fa booted_device ,
56.Fa booted_partition ,
57.Fa booted_startblk ,
58and
59.Fa booted_nblks
60and invokes the machine-independent function
61.Fa rootconf
62which
63.Fa rootconf
64then calls the function
65.Fa setroot
66to record the boot/root device and the boot partition information
67for use in machine-independent code.
68.Pp
69For disk boot, if
70.Fa booted_nblks
71is not 0, then
72.Fa booted_startblk
73and
74.Fa booted_nblks
75are supposed to specify a disk wedge that is used as the root device.
76Otherwise the
77.Fa booted_partition
78is used.
79.Sh SEE ALSO
80.Xr dk 4 ,
81.Xr boot 8 ,
82.Xr boothowto 9
83