xref: /freebsd/sys/x86/include/ucode.h (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2018 The FreeBSD Foundation
5  *
6  * This software was developed by Mark Johnston under sponsorship from
7  * the FreeBSD Foundation.
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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #ifndef _MACHINE_UCODE_H_
32 #define	_MACHINE_UCODE_H_
33 
34 #ifdef _KERNEL
35 #include <sys/types.h>
36 #else
37 #include <stdbool.h>
38 #endif
39 
40 struct ucode_intel_header {
41 	uint32_t	header_version;
42 	int32_t		update_revision;
43 	uint32_t	dat;
44 	uint32_t	processor_signature;
45 	uint32_t	checksum;
46 	uint32_t	loader_revision;
47 	uint32_t	processor_flags;
48 #define	UCODE_INTEL_DEFAULT_DATA_SIZE		2000
49 	uint32_t	data_size;
50 	uint32_t	total_size;
51 	uint32_t	reserved[3];
52 };
53 
54 struct ucode_intel_extsig_table {
55 	uint32_t	signature_count;
56 	uint32_t	signature_table_checksum;
57 	uint32_t	reserved[3];
58 	struct ucode_intel_extsig {
59 		uint32_t	processor_signature;
60 		uint32_t	processor_flags;
61 		uint32_t	checksum;
62 	} entries[0];
63 };
64 
65 const void *ucode_amd_find(const char *path, uint32_t signature,
66 	    uint32_t revision, const uint8_t *fw_data, size_t fw_size,
67 	    size_t *selected_sizep);
68 int	ucode_intel_load(const void *data, bool unsafe,
69 	    uint64_t *nrevp, uint64_t *orevp);
70 int	ucode_amd_load(const void *data, bool unsafe,
71 	    uint64_t *nrevp, uint64_t *orevp);
72 size_t	ucode_load_bsp(uintptr_t free);
73 void	ucode_load_ap(int cpu);
74 void	ucode_reload(void);
75 void *	ucode_update(void *data);
76 
77 #endif /* _MACHINE_UCODE_H_ */
78