ucode.h revision 347700
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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 * $FreeBSD: stable/11/sys/x86/include/ucode.h 347700 2019-05-16 14:42:16Z markj $
31 */
32
33#ifndef _MACHINE_UCODE_H_
34#define	_MACHINE_UCODE_H_
35
36struct ucode_intel_header {
37	uint32_t	header_version;
38	int32_t		update_revision;
39	uint32_t	dat;
40	uint32_t	processor_signature;
41	uint32_t	checksum;
42	uint32_t	loader_revision;
43	uint32_t	processor_flags;
44#define	UCODE_INTEL_DEFAULT_DATA_SIZE		2000
45	uint32_t	data_size;
46	uint32_t	total_size;
47	uint32_t	reserved[3];
48};
49
50struct ucode_intel_extsig_table {
51	uint32_t	signature_count;
52	uint32_t	signature_table_checksum;
53	uint32_t	reserved[3];
54	struct ucode_intel_extsig {
55		uint32_t	processor_signature;
56		uint32_t	processor_flags;
57		uint32_t	checksum;
58	} entries[0];
59};
60
61int	ucode_intel_load(void *data, bool unsafe,
62	    uint64_t *nrevp, uint64_t *orevp);
63size_t	ucode_load_bsp(uintptr_t free);
64void	ucode_load_ap(int cpu);
65void	ucode_reload(void);
66void *	ucode_update(void *data);
67
68#endif /* _MACHINE_UCODE_H_ */
69