xref: /freebsd/sys/sys/kexec.h (revision e02c57ff374ea3eed69e5f43f19a41fa559b7e2d)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2025 Juniper Networks, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef	_SYS_KEXEC_H_
30 #define	_SYS_KEXEC_H_
31 
32 #include <sys/types.h>
33 
34 struct kexec_segment {
35 	void *buf;
36 	size_t bufsz;
37 	vm_paddr_t mem;
38 	vm_size_t memsz;
39 };
40 
41 /* Flags (aligned with Linux) */
42 #define	KEXEC_ON_CRASH		0x1
43 
44 /* Aligned with Linux's limit */
45 #define	KEXEC_SEGMENT_MAX	16
46 
47 #ifdef	_KERNEL
48 struct kexec_segment_stage {
49 	vm_page_t	first_page;
50 	void		*map_buf;
51 	vm_paddr_t	target;
52 	vm_size_t	size;
53 	vm_pindex_t	pindex;
54 };
55 
56 struct kexec_image {
57 	struct kexec_segment_stage	 segments[KEXEC_SEGMENT_MAX];
58 	vm_paddr_t			 entry;
59 	struct vm_object		*map_obj;	/* Containing object */
60 	vm_offset_t			 map_addr;	/* Mapped in kernel space */
61 	vm_size_t			 map_size;
62 	vm_page_t			 first_md_page;
63 	void				*md_image;
64 };
65 
66 #endif
67 
68 #ifndef _KERNEL
69 
70 __BEGIN_DECLS
71 int	kexec_load(uint64_t, unsigned long, struct kexec_segment *, unsigned long);
72 __END_DECLS
73 
74 #else
75 
76 void	kexec_reboot_md(struct kexec_image *);
77 int	kexec_load_md(struct kexec_image *);
78 
79 #endif
80 
81 #endif
82