xref: /netbsd-src/sys/external/bsd/drm2/dist/drm/amd/amdgpu/atom.h (revision 2b73d18af7a98bc9907041875c671f63165f1d3e)
1 /*	$NetBSD: atom.h,v 1.4 2021/12/19 12:21:29 riastradh Exp $	*/
2 
3 /*
4  * Copyright 2008 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  * Author: Stanislaw Skowronek
25  */
26 
27 #ifndef ATOM_H
28 #define ATOM_H
29 
30 #include <linux/types.h>
31 #include <linux/mutex.h>
32 
33 struct drm_device;
34 
35 #define ATOM_BIOS_MAGIC		0xAA55
36 #define ATOM_ATI_MAGIC_PTR	0x30
37 #define ATOM_ATI_MAGIC		" 761295520"
38 #define ATOM_ROM_TABLE_PTR	0x48
39 #define ATOM_ROM_PART_NUMBER_PTR	0x6E
40 
41 #define ATOM_ROM_MAGIC		"ATOM"
42 #define ATOM_ROM_MAGIC_PTR	4
43 
44 #define ATOM_ROM_MSG_PTR	0x10
45 #define ATOM_ROM_CMD_PTR	0x1E
46 #define ATOM_ROM_DATA_PTR	0x20
47 
48 #define ATOM_CMD_INIT		0
49 #define ATOM_CMD_SETSCLK	0x0A
50 #define ATOM_CMD_SETMCLK	0x0B
51 #define ATOM_CMD_SETPCLK	0x0C
52 #define ATOM_CMD_SPDFANCNTL	0x39
53 
54 #define ATOM_DATA_FWI_PTR	0xC
55 #define ATOM_DATA_IIO_PTR	0x32
56 
57 #define ATOM_FWI_DEFSCLK_PTR	8
58 #define ATOM_FWI_DEFMCLK_PTR	0xC
59 #define ATOM_FWI_MAXSCLK_PTR	0x24
60 #define ATOM_FWI_MAXMCLK_PTR	0x28
61 
62 #define ATOM_CT_SIZE_PTR	0
63 #define ATOM_CT_WS_PTR		4
64 #define ATOM_CT_PS_PTR		5
65 #define ATOM_CT_PS_MASK		0x7F
66 #define ATOM_CT_CODE_PTR	6
67 
68 #define ATOM_OP_CNT		127
69 #define ATOM_OP_EOT		91
70 
71 #define ATOM_CASE_MAGIC		0x63
72 #define ATOM_CASE_END		0x5A5A
73 
74 #define ATOM_ARG_REG		0
75 #define ATOM_ARG_PS		1
76 #define ATOM_ARG_WS		2
77 #define ATOM_ARG_FB		3
78 #define ATOM_ARG_ID		4
79 #define ATOM_ARG_IMM		5
80 #define ATOM_ARG_PLL		6
81 #define ATOM_ARG_MC		7
82 
83 #define ATOM_SRC_DWORD		0
84 #define ATOM_SRC_WORD0		1
85 #define ATOM_SRC_WORD8		2
86 #define ATOM_SRC_WORD16		3
87 #define ATOM_SRC_BYTE0		4
88 #define ATOM_SRC_BYTE8		5
89 #define ATOM_SRC_BYTE16		6
90 #define ATOM_SRC_BYTE24		7
91 
92 #define ATOM_WS_QUOTIENT	0x40
93 #define ATOM_WS_REMAINDER	0x41
94 #define ATOM_WS_DATAPTR		0x42
95 #define ATOM_WS_SHIFT		0x43
96 #define ATOM_WS_OR_MASK		0x44
97 #define ATOM_WS_AND_MASK	0x45
98 #define ATOM_WS_FB_WINDOW	0x46
99 #define ATOM_WS_ATTRIBUTES	0x47
100 #define ATOM_WS_REGPTR		0x48
101 
102 #define ATOM_IIO_NOP		0
103 #define ATOM_IIO_START		1
104 #define ATOM_IIO_READ		2
105 #define ATOM_IIO_WRITE		3
106 #define ATOM_IIO_CLEAR		4
107 #define ATOM_IIO_SET		5
108 #define ATOM_IIO_MOVE_INDEX	6
109 #define ATOM_IIO_MOVE_ATTR	7
110 #define ATOM_IIO_MOVE_DATA	8
111 #define ATOM_IIO_END		9
112 
113 #define ATOM_IO_MM		0
114 #define ATOM_IO_PCI		1
115 #define ATOM_IO_SYSIO		2
116 #define ATOM_IO_IIO		0x80
117 
118 struct card_info {
119 	struct drm_device *dev;
120 	void (* reg_write)(struct card_info *, uint32_t, uint32_t);   /*  filled by driver */
121 	uint32_t (* reg_read)(struct card_info *, uint32_t);          /*  filled by driver */
122 	void (* ioreg_write)(struct card_info *, uint32_t, uint32_t);   /*  filled by driver */
123 	uint32_t (* ioreg_read)(struct card_info *, uint32_t);          /*  filled by driver */
124 	void (* mc_write)(struct card_info *, uint32_t, uint32_t);   /*  filled by driver */
125 	uint32_t (* mc_read)(struct card_info *, uint32_t);          /*  filled by driver */
126 	void (* pll_write)(struct card_info *, uint32_t, uint32_t);   /*  filled by driver */
127 	uint32_t (* pll_read)(struct card_info *, uint32_t);          /*  filled by driver */
128 };
129 
130 struct atom_context {
131 	struct card_info *card;
132 	struct mutex mutex;
133 	void *bios;
134 	uint32_t cmd_table, data_table;
135 	uint16_t *iio;
136 
137 	uint16_t data_block;
138 	uint32_t fb_base;
139 	uint32_t divmul[2];
140 	uint16_t io_attr;
141 	uint16_t reg_block;
142 	uint8_t shift;
143 	int cs_equal, cs_above;
144 	int io_mode;
145 	uint32_t *scratch;
146 	int scratch_size_bytes;
147 	char vbios_version[20];
148 };
149 
150 extern int amdgpu_atom_debug;
151 
152 struct atom_context *amdgpu_atom_parse(struct card_info *, void *);
153 int amdgpu_atom_execute_table(struct atom_context *, int, uint32_t *);
154 int amdgpu_atom_asic_init(struct atom_context *);
155 void amdgpu_atom_destroy(struct atom_context *);
156 bool amdgpu_atom_parse_data_header(struct atom_context *ctx, int index, uint16_t *size,
157 			    uint8_t *frev, uint8_t *crev, uint16_t *data_start);
158 bool amdgpu_atom_parse_cmd_header(struct atom_context *ctx, int index,
159 			   uint8_t *frev, uint8_t *crev);
160 #include "atom-types.h"
161 #include "atombios.h"
162 #include "ObjectID.h"
163 
164 #endif
165