xref: /openbsd/share/man/man4/man4.octeon/octboot.4 (revision 097a140d)
1.\"	$OpenBSD: octboot.4,v 1.2 2020/10/10 10:11:54 visa Exp $
2.\"
3.\" Copyright (c) 2020 Visa Hankala
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: October 10 2020 $
18.Dt OCTBOOT 4 octeon
19.Os
20.Sh NAME
21.Nm octboot
22.Nd kernel boot interface
23.Sh SYNOPSIS
24.Cd "pseudo-device octboot"
25.Sh DESCRIPTION
26The
27.Nm
28driver provides an
29.Xr ioctl 2
30interface for booting into another kernel from the currently running kernel.
31.Sh IOCTL INTERFACE
32.Nm
33provides the following
34.Xr ioctl 2
35commands, available through
36.In machine/octboot.h :
37.Bl -tag -width xxxx
38.It Dv OBIOC_GETROOTDEV Fa "char rootdev[PATH_MAX]"
39Get the name of the current root device.
40.It Dv OBIOC_KEXEC "struct octboot_kexec_args *args"
41Boot into the given kernel image.
42.Bd -literal
43struct octboot_kexec_args {
44	char		*kimg;
45	size_t		 klen;
46	char		*argv[OCTBOOT_MAX_ARGS];
47};
48.Ed
49.El
50.Sh FILES
51.Bl -tag -width /dev/octboot -compact
52.It Pa /dev/octboot
53boot interface device.
54.El
55.Sh SEE ALSO
56.Xr ioctl 2 ,
57.Xr intro 4
58.Sh HISTORY
59The
60.Nm
61driver first appeared in
62.Ox 6.6 .
63