summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVisa Hankala <visa@cvs.openbsd.org>2020-10-10 09:00:16 +0000
committerVisa Hankala <visa@cvs.openbsd.org>2020-10-10 09:00:16 +0000
commit806a43e022e36c353e9cd07e710ae2b3f9d957f9 (patch)
tree19baf2fe0fb8344f752ffde4cb2ded02f65d64ea
parentcb9b1be14607aa3cd5f9c3f7114fa4fcf84c3555 (diff)
Add a manual page for octboot(4).
-rw-r--r--share/man/man4/man4.octeon/Makefile4
-rw-r--r--share/man/man4/man4.octeon/octboot.462
2 files changed, 64 insertions, 2 deletions
diff --git a/share/man/man4/man4.octeon/Makefile b/share/man/man4/man4.octeon/Makefile
index 245d606e3d7..e55ef16265b 100644
--- a/share/man/man4/man4.octeon/Makefile
+++ b/share/man/man4/man4.octeon/Makefile
@@ -1,6 +1,6 @@
-# $OpenBSD: Makefile,v 1.22 2019/11/05 14:27:59 visa Exp $
+# $OpenBSD: Makefile,v 1.23 2020/10/10 09:00:15 visa Exp $
-MAN= amdcf.4 cnmac.4 octcf.4 octcib.4 octcit.4 octciu.4 \
+MAN= amdcf.4 cnmac.4 octboot.4 octcf.4 octcib.4 octcit.4 octciu.4 \
octcrypto.4 octgmx.4 octgpio.4 octiic.4 octmmc.4 octpcie.4 octpip.4 \
octrng.4 octrtc.4 octsctl.4 octsmi.4 octuctl.4 octxctl.4 \
ogx.4 ogxnexus.4
diff --git a/share/man/man4/man4.octeon/octboot.4 b/share/man/man4/man4.octeon/octboot.4
new file mode 100644
index 00000000000..e0101514e56
--- /dev/null
+++ b/share/man/man4/man4.octeon/octboot.4
@@ -0,0 +1,62 @@
+.\" $OpenBSD: octboot.4,v 1.1 2020/10/10 09:00:15 visa Exp $
+.\"
+.\" Copyright (c) 2020 Visa Hankala
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: October 10 2020 $
+.Dt OCTBOOT 4 octeon
+.Os
+.Sh NAME
+.Nm octboot
+.Nd kernel boot interface
+.Sh SYNOPSIS
+.Cd "pseudo-device octboot 1"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides an
+.Xr ioctl 2
+interface for booting into another kernel from the currently running kernel.
+.Sh IOCTL INTERFACE
+.Nm
+provides the following
+.Xr ioctl 2
+commands, available through
+.In machine/octboot.h :
+.Bl -tag -width xxxx
+.It Dv OBIOC_GETROOTDEV Fa "char rootdev[PATH_MAX]"
+Get the name of the current root device.
+.It Dv OBIOC_KEXEC "struct octboot_kexec_args *args"
+Boot into the given kernel image.
+.Bd -literal
+struct octboot_kexec_args {
+ char *kimg;
+ size_t klen;
+ char *argv[OCTBOOT_MAX_ARGS];
+};
+.Ed
+.El
+.Sh FILES
+.Bl -tag -width /dev/octboot -compact
+.It Pa /dev/octboot
+boot interface device.
+.El
+.Sh SEE ALSO
+.Xr ioctl 2 ,
+.Xr intro 4
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 6.6 .