Linux 6.9-rc1
[linux-2.6-microblaze.git] / drivers / gpu / drm / amd / amdgpu / atom.h
1 /*
2  * Copyright 2008 Advanced Micro Devices, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Author: Stanislaw Skowronek
23  */
24
25 #ifndef ATOM_H
26 #define ATOM_H
27
28 #include <linux/types.h>
29
30 struct drm_device;
31
32 #define ATOM_BIOS_MAGIC         0xAA55
33 #define ATOM_ATI_MAGIC_PTR      0x30
34 #define ATOM_ATI_MAGIC          " 761295520"
35 #define ATOM_ROM_TABLE_PTR      0x48
36
37 #define ATOM_ROM_MAGIC          "ATOM"
38 #define ATOM_ROM_MAGIC_PTR      4
39
40 #define ATOM_ROM_MSG_PTR        0x10
41 #define ATOM_ROM_CMD_PTR        0x1E
42 #define ATOM_ROM_DATA_PTR       0x20
43
44 #define ATOM_CMD_INIT           0
45 #define ATOM_CMD_SETSCLK        0x0A
46 #define ATOM_CMD_SETMCLK        0x0B
47 #define ATOM_CMD_SETPCLK        0x0C
48 #define ATOM_CMD_SPDFANCNTL     0x39
49
50 #define ATOM_DATA_FWI_PTR       0xC
51 #define ATOM_DATA_IIO_PTR       0x32
52
53 #define ATOM_FWI_DEFSCLK_PTR    8
54 #define ATOM_FWI_DEFMCLK_PTR    0xC
55 #define ATOM_FWI_MAXSCLK_PTR    0x24
56 #define ATOM_FWI_MAXMCLK_PTR    0x28
57
58 #define ATOM_CT_SIZE_PTR        0
59 #define ATOM_CT_WS_PTR          4
60 #define ATOM_CT_PS_PTR          5
61 #define ATOM_CT_PS_MASK         0x7F
62 #define ATOM_CT_CODE_PTR        6
63
64 #define ATOM_OP_CNT             127
65 #define ATOM_OP_EOT             91
66
67 #define ATOM_CASE_MAGIC         0x63
68 #define ATOM_CASE_END           0x5A5A
69
70 #define ATOM_ARG_REG            0
71 #define ATOM_ARG_PS             1
72 #define ATOM_ARG_WS             2
73 #define ATOM_ARG_FB             3
74 #define ATOM_ARG_ID             4
75 #define ATOM_ARG_IMM            5
76 #define ATOM_ARG_PLL            6
77 #define ATOM_ARG_MC             7
78
79 #define ATOM_SRC_DWORD          0
80 #define ATOM_SRC_WORD0          1
81 #define ATOM_SRC_WORD8          2
82 #define ATOM_SRC_WORD16         3
83 #define ATOM_SRC_BYTE0          4
84 #define ATOM_SRC_BYTE8          5
85 #define ATOM_SRC_BYTE16         6
86 #define ATOM_SRC_BYTE24         7
87
88 #define ATOM_WS_QUOTIENT        0x40
89 #define ATOM_WS_REMAINDER       0x41
90 #define ATOM_WS_DATAPTR         0x42
91 #define ATOM_WS_SHIFT           0x43
92 #define ATOM_WS_OR_MASK         0x44
93 #define ATOM_WS_AND_MASK        0x45
94 #define ATOM_WS_FB_WINDOW       0x46
95 #define ATOM_WS_ATTRIBUTES      0x47
96 #define ATOM_WS_REGPTR          0x48
97
98 #define ATOM_IIO_NOP            0
99 #define ATOM_IIO_START          1
100 #define ATOM_IIO_READ           2
101 #define ATOM_IIO_WRITE          3
102 #define ATOM_IIO_CLEAR          4
103 #define ATOM_IIO_SET            5
104 #define ATOM_IIO_MOVE_INDEX     6
105 #define ATOM_IIO_MOVE_ATTR      7
106 #define ATOM_IIO_MOVE_DATA      8
107 #define ATOM_IIO_END            9
108
109 #define ATOM_IO_MM              0
110 #define ATOM_IO_PCI             1
111 #define ATOM_IO_SYSIO           2
112 #define ATOM_IO_IIO             0x80
113
114 #define STRLEN_NORMAL           32
115 #define STRLEN_LONG             64
116 #define STRLEN_VERYLONG         254
117
118 struct card_info {
119         struct drm_device *dev;
120         void (*reg_write)(struct card_info *info,
121                           u32 reg, uint32_t val);   /*  filled by driver */
122         uint32_t (*reg_read)(struct card_info *info, uint32_t reg);          /*  filled by driver */
123         void (*mc_write)(struct card_info *info,
124                          u32 reg, uint32_t val);   /*  filled by driver */
125         uint32_t (*mc_read)(struct card_info *info, uint32_t reg);          /*  filled by driver */
126         void (*pll_write)(struct card_info *info,
127                           u32 reg, uint32_t val);   /*  filled by driver */
128         uint32_t (*pll_read)(struct card_info *info, uint32_t reg);          /*  filled by driver */
129 };
130
131 struct atom_context {
132         struct card_info *card;
133         struct mutex mutex;
134         void *bios;
135         uint32_t cmd_table, data_table;
136         uint16_t *iio;
137
138         uint16_t data_block;
139         uint32_t fb_base;
140         uint32_t divmul[2];
141         uint16_t io_attr;
142         uint16_t reg_block;
143         uint8_t shift;
144         int cs_equal, cs_above;
145         int io_mode;
146         uint32_t *scratch;
147         int scratch_size_bytes;
148
149         uint8_t name[STRLEN_LONG];
150         uint8_t vbios_pn[STRLEN_LONG];
151         uint32_t version;
152         uint8_t vbios_ver_str[STRLEN_NORMAL];
153         uint8_t date[STRLEN_NORMAL];
154 };
155
156 extern int amdgpu_atom_debug;
157
158 struct atom_context *amdgpu_atom_parse(struct card_info *card, void *bios);
159 int amdgpu_atom_execute_table(struct atom_context *ctx, int index, uint32_t *params, int params_size);
160 int amdgpu_atom_asic_init(struct atom_context *ctx);
161 void amdgpu_atom_destroy(struct atom_context *ctx);
162 bool amdgpu_atom_parse_data_header(struct atom_context *ctx, int index, uint16_t *size,
163                             uint8_t *frev, uint8_t *crev, uint16_t *data_start);
164 bool amdgpu_atom_parse_cmd_header(struct atom_context *ctx, int index,
165                            uint8_t *frev, uint8_t *crev);
166 #include "atom-types.h"
167 #include "atombios.h"
168 #include "ObjectID.h"
169
170 #endif