blob: 923f99df4f1c2e572249532fd874f4ea3fccee2f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * AGPGART
3 * Copyright (C) 2004 Silicon Graphics, Inc.
4 * Copyright (C) 2002-2004 Dave Jones
5 * Copyright (C) 1999 Jeff Hartmann
6 * Copyright (C) 1999 Precision Insight, Inc.
7 * Copyright (C) 1999 Xi Graphics, Inc.
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included
17 * in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
Dave Jones6a92a4e2006-02-28 00:54:25 -050022 * JEFF HARTMANN, OR ANY OTHER CONTRIBUTORS BE LIABLE FOR ANY CLAIM,
23 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 *
27 */
28
29#ifndef _AGP_BACKEND_PRIV_H
30#define _AGP_BACKEND_PRIV_H 1
31
32#include <asm/agp.h> /* for flush_agp_cache() */
33
34#define PFX "agpgart: "
35
36//#define AGP_DEBUG 1
37#ifdef AGP_DEBUG
Harvey Harrisonbf9d8922008-04-30 00:55:10 -070038#define DBG(x,y...) printk (KERN_DEBUG PFX "%s: " x "\n", __func__ , ## y)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#else
40#define DBG(x,y...) do { } while (0)
41#endif
42
43extern struct agp_bridge_data *agp_bridge;
44
45enum aper_size_type {
46 U8_APER_SIZE,
47 U16_APER_SIZE,
48 U32_APER_SIZE,
49 LVL2_APER_SIZE,
50 FIXED_APER_SIZE
51};
52
53struct gatt_mask {
54 unsigned long mask;
55 u32 type;
Dave Jones6a92a4e2006-02-28 00:54:25 -050056 /* totally device specific, for integrated chipsets that
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 * might have different types of memory masks. For other
58 * devices this will probably be ignored */
59};
60
Dave Airliea2721e92007-10-15 10:19:16 +100061#define AGP_PAGE_DESTROY_UNMAP 1
62#define AGP_PAGE_DESTROY_FREE 2
63
Linus Torvalds1da177e2005-04-16 15:20:36 -070064struct aper_size_info_8 {
65 int size;
66 int num_entries;
67 int page_order;
68 u8 size_value;
69};
70
71struct aper_size_info_16 {
72 int size;
73 int num_entries;
74 int page_order;
75 u16 size_value;
76};
77
78struct aper_size_info_32 {
79 int size;
80 int num_entries;
81 int page_order;
82 u32 size_value;
83};
84
85struct aper_size_info_lvl2 {
86 int size;
87 int num_entries;
88 u32 size_value;
89};
90
91struct aper_size_info_fixed {
92 int size;
93 int num_entries;
94 int page_order;
95};
96
97struct agp_bridge_driver {
98 struct module *owner;
Dave Jonese5524f32007-02-22 18:41:28 -050099 const void *aperture_sizes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 int num_aperture_sizes;
101 enum aper_size_type size_type;
Joe Perchesc7258012008-03-26 14:10:02 -0700102 bool cant_use_aperture;
103 bool needs_scratch_page;
Dave Jonese5524f32007-02-22 18:41:28 -0500104 const struct gatt_mask *masks;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 int (*fetch_size)(void);
106 int (*configure)(void);
107 void (*agp_enable)(struct agp_bridge_data *, u32);
108 void (*cleanup)(void);
109 void (*tlb_flush)(struct agp_memory *);
David Woodhouse2a4ceb62009-07-27 10:27:29 +0100110 unsigned long (*mask_memory)(struct agp_bridge_data *, dma_addr_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 void (*cache_flush)(void);
112 int (*create_gatt_table)(struct agp_bridge_data *);
113 int (*free_gatt_table)(struct agp_bridge_data *);
114 int (*insert_memory)(struct agp_memory *, off_t, int);
115 int (*remove_memory)(struct agp_memory *, off_t, int);
116 struct agp_memory *(*alloc_by_type) (size_t, int);
117 void (*free_by_type)(struct agp_memory *);
Dave Airlie07613ba2009-06-12 14:11:41 +1000118 struct page *(*agp_alloc_page)(struct agp_bridge_data *);
Shaohua Li37acee12008-08-21 10:46:11 +0800119 int (*agp_alloc_pages)(struct agp_bridge_data *, struct agp_memory *, size_t);
Dave Airlie07613ba2009-06-12 14:11:41 +1000120 void (*agp_destroy_page)(struct page *, int flags);
Shaohua Libd079282008-08-21 10:46:17 +0800121 void (*agp_destroy_pages)(struct agp_memory *);
Dave Airliea13af4b2007-10-29 15:14:03 +1000122 int (*agp_type_to_mask_type) (struct agp_bridge_data *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123};
124
125struct agp_bridge_data {
Alexey Dobriyan8eb79252006-08-20 18:48:13 +0400126 const struct agp_version *version;
Dave Jonese5524f32007-02-22 18:41:28 -0500127 const struct agp_bridge_driver *driver;
Alexey Dobriyanf0f37e22009-09-27 22:29:37 +0400128 const struct vm_operations_struct *vm_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 void *previous_size;
130 void *current_size;
131 void *dev_private_data;
132 struct pci_dev *dev;
133 u32 __iomem *gatt_table;
134 u32 *gatt_table_real;
135 unsigned long scratch_page;
David Woodhousec2980d82009-07-29 08:39:26 +0100136 struct page *scratch_page_page;
Zhenyu Wangff663cf2009-07-23 17:25:49 +0100137 dma_addr_t scratch_page_dma;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 unsigned long gart_bus_addr;
139 unsigned long gatt_bus_addr;
140 u32 mode;
141 enum chipset_type type;
142 unsigned long *key_list;
143 atomic_t current_memory_agp;
144 atomic_t agp_in_use;
145 int max_memory_agp; /* in number of pages */
146 int aperture_size_idx;
147 int capndx;
148 int flags;
149 char major_version;
150 char minor_version;
151 struct list_head list;
Matthew Garrettb0825482005-07-29 14:03:39 -0700152 u32 apbase_config;
Keith Packarda8c84df2008-07-31 15:48:07 +1000153 /* list of agp_memory mapped to the aperture */
154 struct list_head mapped_list;
155 spinlock_t mapped_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156};
157
158#define KB(x) ((x) * 1024)
159#define MB(x) (KB (KB (x)))
160#define GB(x) (MB (KB (x)))
161
162#define A_SIZE_8(x) ((struct aper_size_info_8 *) x)
163#define A_SIZE_16(x) ((struct aper_size_info_16 *) x)
164#define A_SIZE_32(x) ((struct aper_size_info_32 *) x)
165#define A_SIZE_LVL2(x) ((struct aper_size_info_lvl2 *) x)
166#define A_SIZE_FIX(x) ((struct aper_size_info_fixed *) x)
167#define A_IDX8(bridge) (A_SIZE_8((bridge)->driver->aperture_sizes) + i)
168#define A_IDX16(bridge) (A_SIZE_16((bridge)->driver->aperture_sizes) + i)
169#define A_IDX32(bridge) (A_SIZE_32((bridge)->driver->aperture_sizes) + i)
170#define MAXKEY (4096 * 32)
171
172#define PGE_EMPTY(b, p) (!(p) || (p) == (unsigned long) (b)->scratch_page)
173
174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175struct agp_device_ids {
176 unsigned short device_id; /* first, to make table easier to read */
177 enum chipset_type chipset;
178 const char *chipset_name;
179 int (*chipset_setup) (struct pci_dev *pdev); /* used to override generic */
180};
181
182/* Driver registration */
183struct agp_bridge_data *agp_alloc_bridge(void);
184void agp_put_bridge(struct agp_bridge_data *bridge);
185int agp_add_bridge(struct agp_bridge_data *bridge);
186void agp_remove_bridge(struct agp_bridge_data *bridge);
187
188/* Frontend routines. */
189int agp_frontend_initialize(void);
190void agp_frontend_cleanup(void);
191
192/* Generic routines. */
193void agp_generic_enable(struct agp_bridge_data *bridge, u32 mode);
194int agp_generic_create_gatt_table(struct agp_bridge_data *bridge);
195int agp_generic_free_gatt_table(struct agp_bridge_data *bridge);
196struct agp_memory *agp_create_memory(int scratch_pages);
197int agp_generic_insert_memory(struct agp_memory *mem, off_t pg_start, int type);
198int agp_generic_remove_memory(struct agp_memory *mem, off_t pg_start, int type);
199struct agp_memory *agp_generic_alloc_by_type(size_t page_count, int type);
200void agp_generic_free_by_type(struct agp_memory *curr);
Dave Airlie07613ba2009-06-12 14:11:41 +1000201struct page *agp_generic_alloc_page(struct agp_bridge_data *bridge);
Shaohua Li37acee12008-08-21 10:46:11 +0800202int agp_generic_alloc_pages(struct agp_bridge_data *agp_bridge,
203 struct agp_memory *memory, size_t page_count);
Dave Airlie07613ba2009-06-12 14:11:41 +1000204void agp_generic_destroy_page(struct page *page, int flags);
Shaohua Libd079282008-08-21 10:46:17 +0800205void agp_generic_destroy_pages(struct agp_memory *memory);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206void agp_free_key(int key);
207int agp_num_entries(void);
208u32 agp_collect_device_status(struct agp_bridge_data *bridge, u32 mode, u32 command);
Joe Perchesc7258012008-03-26 14:10:02 -0700209void agp_device_command(u32 command, bool agp_v3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210int agp_3_5_enable(struct agp_bridge_data *bridge);
211void global_cache_flush(void);
212void get_agp_version(struct agp_bridge_data *bridge);
213unsigned long agp_generic_mask_memory(struct agp_bridge_data *bridge,
David Woodhouse2a4ceb62009-07-27 10:27:29 +0100214 dma_addr_t phys, int type);
Thomas Hellstroma030ce42007-01-23 10:33:43 +0100215int agp_generic_type_to_mask_type(struct agp_bridge_data *bridge,
216 int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217struct agp_bridge_data *agp_generic_find_bridge(struct pci_dev *pdev);
218
Thomas Hellstroma030ce42007-01-23 10:33:43 +0100219/* generic functions for user-populated AGP memory types */
220struct agp_memory *agp_generic_alloc_user(size_t page_count, int type);
221void agp_alloc_page_array(size_t size, struct agp_memory *mem);
222void agp_free_page_array(struct agp_memory *mem);
223
224
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225/* generic routines for agp>=3 */
226int agp3_generic_fetch_size(void);
227void agp3_generic_tlbflush(struct agp_memory *mem);
228int agp3_generic_configure(void);
229void agp3_generic_cleanup(void);
230
231/* aperture sizes have been standardised since v3 */
232#define AGP_GENERIC_SIZES_ENTRIES 11
Dave Jonese5524f32007-02-22 18:41:28 -0500233extern const struct aper_size_info_16 agp3_generic_sizes[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235extern int agp_off;
236extern int agp_try_unsupported_boot;
237
Zwane Mwaikambo0316fe82007-01-29 21:20:31 -0800238long compat_agp_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
239
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300240/* Chipset independent registers (from AGP Spec) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241#define AGP_APBASE 0x10
242
243#define AGPSTAT 0x4
244#define AGPCMD 0x8
245#define AGPNISTAT 0xc
246#define AGPCTRL 0x10
247#define AGPAPSIZE 0x14
248#define AGPNEPG 0x16
249#define AGPGARTLO 0x18
250#define AGPGARTHI 0x1c
251#define AGPNICMD 0x20
252
253#define AGP_MAJOR_VERSION_SHIFT (20)
254#define AGP_MINOR_VERSION_SHIFT (16)
255
256#define AGPSTAT_RQ_DEPTH (0xff000000)
257#define AGPSTAT_RQ_DEPTH_SHIFT 24
258
259#define AGPSTAT_CAL_MASK (1<<12|1<<11|1<<10)
260#define AGPSTAT_ARQSZ (1<<15|1<<14|1<<13)
261#define AGPSTAT_ARQSZ_SHIFT 13
262
263#define AGPSTAT_SBA (1<<9)
264#define AGPSTAT_AGP_ENABLE (1<<8)
265#define AGPSTAT_FW (1<<4)
266#define AGPSTAT_MODE_3_0 (1<<3)
267
268#define AGPSTAT2_1X (1<<0)
269#define AGPSTAT2_2X (1<<1)
270#define AGPSTAT2_4X (1<<2)
271
272#define AGPSTAT3_RSVD (1<<2)
273#define AGPSTAT3_8X (1<<1)
274#define AGPSTAT3_4X (1)
275
276#define AGPCTRL_APERENB (1<<8)
277#define AGPCTRL_GTLBEN (1<<7)
278
279#define AGP2_RESERVED_MASK 0x00fffcc8
280#define AGP3_RESERVED_MASK 0x00ff00c4
281
282#define AGP_ERRATA_FASTWRITES 1<<0
283#define AGP_ERRATA_SBA 1<<1
284#define AGP_ERRATA_1X 1<<2
285
286#endif /* _AGP_BACKEND_PRIV_H */