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