xref: /netbsd-src/sys/external/bsd/drm2/dist/drm/amd/display/dmub/inc/dmub_fw_meta.h (revision 41ec02673d281bbb3d38e6c78504ce6e30c228c1)
1 /*	$NetBSD: dmub_fw_meta.h,v 1.2 2021/12/18 23:45:06 riastradh Exp $	*/
2 
3 /*
4  * Copyright 2019 Advanced Micro Devices, Inc.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22  * OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * Authors: AMD
25  *
26  */
27 #ifndef _DMUB_META_H_
28 #define _DMUB_META_H_
29 
30 #include "dmub_types.h"
31 
32 #pragma pack(push, 1)
33 
34 /* Magic value for identifying dmub_fw_meta_info */
35 #define DMUB_FW_META_MAGIC 0x444D5542
36 
37 /* Offset from the end of the file to the dmub_fw_meta_info */
38 #define DMUB_FW_META_OFFSET 0x24
39 
40 /**
41  * struct dmub_fw_meta_info - metadata associated with fw binary
42  *
43  * NOTE: This should be considered a stable API. Fields should
44  *       not be repurposed or reordered. New fields should be
45  *       added instead to extend the structure.
46  *
47  * @magic_value: magic value identifying DMUB firmware meta info
48  * @fw_region_size: size of the firmware state region
49  * @trace_buffer_size: size of the tracebuffer region
50  */
51 struct dmub_fw_meta_info {
52 	uint32_t magic_value;
53 	uint32_t fw_region_size;
54 	uint32_t trace_buffer_size;
55 };
56 
57 /* Ensure that the structure remains 64 bytes. */
58 union dmub_fw_meta {
59 	struct dmub_fw_meta_info info;
60 	uint8_t reserved[64];
61 };
62 
63 #pragma pack(pop)
64 
65 #endif /* _DMUB_META_H_ */
66