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