kernel: Remove some bogus checks before returning anyway.
[dragonfly.git] / sys / dev / drm / savage / savage_bci.c
1 /* savage_bci.c -- BCI support for Savage
2  *
3  * Copyright 2004  Felix Kuehling
4  * All Rights Reserved.
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, sub license,
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 (including the
14  * next paragraph) shall be included in all copies or substantial portions
15  * of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20  * NON-INFRINGEMENT. IN NO EVENT SHALL FELIX KUEHLING BE LIABLE FOR
21  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
22  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24  */
25
26 #include "dev/drm/drmP.h"
27 #include "dev/drm/savage_drm.h"
28 #include "savage_drv.h"
29
30 /* Need a long timeout for shadow status updates can take a while
31  * and so can waiting for events when the queue is full. */
32 #define SAVAGE_DEFAULT_USEC_TIMEOUT     1000000 /* 1s */
33 #define SAVAGE_EVENT_USEC_TIMEOUT       5000000 /* 5s */
34 #define SAVAGE_FREELIST_DEBUG           0
35
36 static int savage_do_cleanup_bci(struct drm_device *dev);
37
38 static int
39 savage_bci_wait_fifo_shadow(drm_savage_private_t *dev_priv, unsigned int n)
40 {
41         uint32_t mask = dev_priv->status_used_mask;
42         uint32_t threshold = dev_priv->bci_threshold_hi;
43         uint32_t status;
44         int i;
45
46 #if SAVAGE_BCI_DEBUG
47         if (n > dev_priv->cob_size + SAVAGE_BCI_FIFO_SIZE - threshold)
48                 DRM_ERROR("Trying to emit %d words "
49                           "(more than guaranteed space in COB)\n", n);
50 #endif
51
52         for (i = 0; i < SAVAGE_DEFAULT_USEC_TIMEOUT; i++) {
53                 DRM_MEMORYBARRIER();
54                 status = dev_priv->status_ptr[0];
55                 if ((status & mask) < threshold)
56                         return 0;
57                 DRM_UDELAY(1);
58         }
59
60 #if SAVAGE_BCI_DEBUG
61         DRM_ERROR("failed!\n");
62         DRM_INFO("   status=0x%08x, threshold=0x%08x\n", status, threshold);
63 #endif
64         return -EBUSY;
65 }
66
67 static int
68 savage_bci_wait_fifo_s3d(drm_savage_private_t *dev_priv, unsigned int n)
69 {
70         uint32_t maxUsed = dev_priv->cob_size + SAVAGE_BCI_FIFO_SIZE - n;
71         uint32_t status;
72         int i;
73
74         for (i = 0; i < SAVAGE_DEFAULT_USEC_TIMEOUT; i++) {
75                 status = SAVAGE_READ(SAVAGE_STATUS_WORD0);
76                 if ((status & SAVAGE_FIFO_USED_MASK_S3D) <= maxUsed)
77                         return 0;
78                 DRM_UDELAY(1);
79         }
80
81 #if SAVAGE_BCI_DEBUG
82         DRM_ERROR("failed!\n");
83         DRM_INFO("   status=0x%08x\n", status);
84 #endif
85         return -EBUSY;
86 }
87
88 static int
89 savage_bci_wait_fifo_s4(drm_savage_private_t *dev_priv, unsigned int n)
90 {
91         uint32_t maxUsed = dev_priv->cob_size + SAVAGE_BCI_FIFO_SIZE - n;
92         uint32_t status;
93         int i;
94
95         for (i = 0; i < SAVAGE_DEFAULT_USEC_TIMEOUT; i++) {
96                 status = SAVAGE_READ(SAVAGE_ALT_STATUS_WORD0);
97                 if ((status & SAVAGE_FIFO_USED_MASK_S4) <= maxUsed)
98                         return 0;
99                 DRM_UDELAY(1);
100         }
101
102 #if SAVAGE_BCI_DEBUG
103         DRM_ERROR("failed!\n");
104         DRM_INFO("   status=0x%08x\n", status);
105 #endif
106         return -EBUSY;
107 }
108
109 /*
110  * Waiting for events.
111  *
112  * The BIOSresets the event tag to 0 on mode changes. Therefore we
113  * never emit 0 to the event tag. If we find a 0 event tag we know the
114  * BIOS stomped on it and return success assuming that the BIOS waited
115  * for engine idle.
116  *
117  * Note: if the Xserver uses the event tag it has to follow the same
118  * rule. Otherwise there may be glitches every 2^16 events.
119  */
120 static int
121 savage_bci_wait_event_shadow(drm_savage_private_t *dev_priv, uint16_t e)
122 {
123         uint32_t status;
124         int i;
125
126         for (i = 0; i < SAVAGE_EVENT_USEC_TIMEOUT; i++) {
127                 DRM_MEMORYBARRIER();
128                 status = dev_priv->status_ptr[1];
129                 if ((((status & 0xffff) - e) & 0xffff) <= 0x7fff ||
130                     (status & 0xffff) == 0)
131                         return 0;
132                 DRM_UDELAY(1);
133         }
134
135 #if SAVAGE_BCI_DEBUG
136         DRM_ERROR("failed!\n");
137         DRM_INFO("   status=0x%08x, e=0x%04x\n", status, e);
138 #endif
139
140         return -EBUSY;
141 }
142
143 static int
144 savage_bci_wait_event_reg(drm_savage_private_t *dev_priv, uint16_t e)
145 {
146         uint32_t status;
147         int i;
148
149         for (i = 0; i < SAVAGE_EVENT_USEC_TIMEOUT; i++) {
150                 status = SAVAGE_READ(SAVAGE_STATUS_WORD1);
151                 if ((((status & 0xffff) - e) & 0xffff) <= 0x7fff ||
152                     (status & 0xffff) == 0)
153                         return 0;
154                 DRM_UDELAY(1);
155         }
156
157 #if SAVAGE_BCI_DEBUG
158         DRM_ERROR("failed!\n");
159         DRM_INFO("   status=0x%08x, e=0x%04x\n", status, e);
160 #endif
161
162         return -EBUSY;
163 }
164
165 uint16_t savage_bci_emit_event(drm_savage_private_t *dev_priv,
166                                unsigned int flags)
167 {
168         uint16_t count;
169         BCI_LOCALS;
170
171         if (dev_priv->status_ptr) {
172                 /* coordinate with Xserver */
173                 count = dev_priv->status_ptr[1023];
174                 if (count < dev_priv->event_counter)
175                         dev_priv->event_wrap++;
176         } else {
177                 count = dev_priv->event_counter;
178         }
179         count = (count + 1) & 0xffff;
180         if (count == 0) {
181                 count++; /* See the comment above savage_wait_event_*. */
182                 dev_priv->event_wrap++;
183         }
184         dev_priv->event_counter = count;
185         if (dev_priv->status_ptr)
186                 dev_priv->status_ptr[1023] = (uint32_t)count;
187
188         if ((flags & (SAVAGE_WAIT_2D | SAVAGE_WAIT_3D))) {
189                 unsigned int wait_cmd = BCI_CMD_WAIT;
190                 if ((flags & SAVAGE_WAIT_2D))
191                         wait_cmd |= BCI_CMD_WAIT_2D;
192                 if ((flags & SAVAGE_WAIT_3D))
193                         wait_cmd |= BCI_CMD_WAIT_3D;
194                 BEGIN_BCI(2);
195                 BCI_WRITE(wait_cmd);
196         } else {
197                 BEGIN_BCI(1);
198         }
199         BCI_WRITE(BCI_CMD_UPDATE_EVENT_TAG | (uint32_t)count);
200
201         return count;
202 }
203
204 /*
205  * Freelist management
206  */
207 static int savage_freelist_init(struct drm_device *dev)
208 {
209         drm_savage_private_t *dev_priv = dev->dev_private;
210         struct drm_device_dma *dma = dev->dma;
211         struct drm_buf *buf;
212         drm_savage_buf_priv_t *entry;
213         int i;
214         DRM_DEBUG("count=%d\n", dma->buf_count);
215
216         dev_priv->head.next = &dev_priv->tail;
217         dev_priv->head.prev = NULL;
218         dev_priv->head.buf = NULL;
219
220         dev_priv->tail.next = NULL;
221         dev_priv->tail.prev = &dev_priv->head;
222         dev_priv->tail.buf = NULL;
223
224         for (i = 0; i < dma->buf_count; i++) {
225                 buf = dma->buflist[i];
226                 entry = buf->dev_private;
227
228                 SET_AGE(&entry->age, 0, 0);
229                 entry->buf = buf;
230
231                 entry->next = dev_priv->head.next;
232                 entry->prev = &dev_priv->head;
233                 dev_priv->head.next->prev = entry;
234                 dev_priv->head.next = entry;
235         }
236
237         return 0;
238 }
239
240 static struct drm_buf *savage_freelist_get(struct drm_device *dev)
241 {
242         drm_savage_private_t *dev_priv = dev->dev_private;
243         drm_savage_buf_priv_t *tail = dev_priv->tail.prev;
244         uint16_t event;
245         unsigned int wrap;
246         DRM_DEBUG("\n");
247
248         UPDATE_EVENT_COUNTER();
249         if (dev_priv->status_ptr)
250                 event = dev_priv->status_ptr[1] & 0xffff;
251         else
252                 event = SAVAGE_READ(SAVAGE_STATUS_WORD1) & 0xffff;
253         wrap = dev_priv->event_wrap;
254         if (event > dev_priv->event_counter)
255                 wrap--; /* hardware hasn't passed the last wrap yet */
256
257         DRM_DEBUG("   tail=0x%04x %d\n", tail->age.event, tail->age.wrap);
258         DRM_DEBUG("   head=0x%04x %d\n", event, wrap);
259
260         if (tail->buf && (TEST_AGE(&tail->age, event, wrap) || event == 0)) {
261                 drm_savage_buf_priv_t *next = tail->next;
262                 drm_savage_buf_priv_t *prev = tail->prev;
263                 prev->next = next;
264                 next->prev = prev;
265                 tail->next = tail->prev = NULL;
266                 return tail->buf;
267         }
268
269         DRM_DEBUG("returning NULL, tail->buf=%p!\n", tail->buf);
270         return NULL;
271 }
272
273 void savage_freelist_put(struct drm_device *dev, struct drm_buf *buf)
274 {
275         drm_savage_private_t *dev_priv = dev->dev_private;
276         drm_savage_buf_priv_t *entry = buf->dev_private, *prev, *next;
277
278         DRM_DEBUG("age=0x%04x wrap=%d\n", entry->age.event, entry->age.wrap);
279
280         if (entry->next != NULL || entry->prev != NULL) {
281                 DRM_ERROR("entry already on freelist.\n");
282                 return;
283         }
284
285         prev = &dev_priv->head;
286         next = prev->next;
287         prev->next = entry;
288         next->prev = entry;
289         entry->prev = prev;
290         entry->next = next;
291 }
292
293 /*
294  * Command DMA
295  */
296 static int savage_dma_init(drm_savage_private_t *dev_priv)
297 {
298         unsigned int i;
299
300         dev_priv->nr_dma_pages = dev_priv->cmd_dma->size /
301                 (SAVAGE_DMA_PAGE_SIZE*4);
302         dev_priv->dma_pages = drm_alloc(sizeof(drm_savage_dma_page_t) *
303                                         dev_priv->nr_dma_pages, DRM_MEM_DRIVER);
304         if (dev_priv->dma_pages == NULL)
305                 return -ENOMEM;
306
307         for (i = 0; i < dev_priv->nr_dma_pages; ++i) {
308                 SET_AGE(&dev_priv->dma_pages[i].age, 0, 0);
309                 dev_priv->dma_pages[i].used = 0;
310                 dev_priv->dma_pages[i].flushed = 0;
311         }
312         SET_AGE(&dev_priv->last_dma_age, 0, 0);
313
314         dev_priv->first_dma_page = 0;
315         dev_priv->current_dma_page = 0;
316
317         return 0;
318 }
319
320 void savage_dma_reset(drm_savage_private_t *dev_priv)
321 {
322         uint16_t event;
323         unsigned int wrap, i;
324         event = savage_bci_emit_event(dev_priv, 0);
325         wrap = dev_priv->event_wrap;
326         for (i = 0; i < dev_priv->nr_dma_pages; ++i) {
327                 SET_AGE(&dev_priv->dma_pages[i].age, event, wrap);
328                 dev_priv->dma_pages[i].used = 0;
329                 dev_priv->dma_pages[i].flushed = 0;
330         }
331         SET_AGE(&dev_priv->last_dma_age, event, wrap);
332         dev_priv->first_dma_page = dev_priv->current_dma_page = 0;
333 }
334
335 void savage_dma_wait(drm_savage_private_t *dev_priv, unsigned int page)
336 {
337         uint16_t event;
338         unsigned int wrap;
339
340         /* Faked DMA buffer pages don't age. */
341         if (dev_priv->cmd_dma == &dev_priv->fake_dma)
342                 return;
343
344         UPDATE_EVENT_COUNTER();
345         if (dev_priv->status_ptr)
346                 event = dev_priv->status_ptr[1] & 0xffff;
347         else
348                 event = SAVAGE_READ(SAVAGE_STATUS_WORD1) & 0xffff;
349         wrap = dev_priv->event_wrap;
350         if (event > dev_priv->event_counter)
351                 wrap--; /* hardware hasn't passed the last wrap yet */
352
353         if (dev_priv->dma_pages[page].age.wrap > wrap ||
354             (dev_priv->dma_pages[page].age.wrap == wrap &&
355              dev_priv->dma_pages[page].age.event > event)) {
356                 if (dev_priv->wait_evnt(dev_priv,
357                                         dev_priv->dma_pages[page].age.event)
358                     < 0)
359                         DRM_ERROR("wait_evnt failed!\n");
360         }
361 }
362
363 uint32_t *savage_dma_alloc(drm_savage_private_t *dev_priv, unsigned int n)
364 {
365         unsigned int cur = dev_priv->current_dma_page;
366         unsigned int rest = SAVAGE_DMA_PAGE_SIZE -
367                 dev_priv->dma_pages[cur].used;
368         unsigned int nr_pages = (n - rest + SAVAGE_DMA_PAGE_SIZE - 1) /
369                 SAVAGE_DMA_PAGE_SIZE;
370         uint32_t *dma_ptr;
371         unsigned int i;
372
373         DRM_DEBUG("cur=%u, cur->used=%u, n=%u, rest=%u, nr_pages=%u\n",
374                   cur, dev_priv->dma_pages[cur].used, n, rest, nr_pages);
375
376         if (cur + nr_pages < dev_priv->nr_dma_pages) {
377                 dma_ptr = (uint32_t *)dev_priv->cmd_dma->handle +
378                     cur * SAVAGE_DMA_PAGE_SIZE + dev_priv->dma_pages[cur].used;
379                 if (n < rest)
380                         rest = n;
381                 dev_priv->dma_pages[cur].used += rest;
382                 n -= rest;
383                 cur++;
384         } else {
385                 dev_priv->dma_flush(dev_priv);
386                 nr_pages =
387                     (n + SAVAGE_DMA_PAGE_SIZE - 1) / SAVAGE_DMA_PAGE_SIZE;
388                 for (i = cur; i < dev_priv->nr_dma_pages; ++i) {
389                         dev_priv->dma_pages[i].age = dev_priv->last_dma_age;
390                         dev_priv->dma_pages[i].used = 0;
391                         dev_priv->dma_pages[i].flushed = 0;
392                 }
393                 dma_ptr = (uint32_t *)dev_priv->cmd_dma->handle;
394                 dev_priv->first_dma_page = cur = 0;
395         }
396         for (i = cur; nr_pages > 0; ++i, --nr_pages) {
397 #if SAVAGE_DMA_DEBUG
398                 if (dev_priv->dma_pages[i].used) {
399                         DRM_ERROR("unflushed page %u: used=%u\n",
400                                   i, dev_priv->dma_pages[i].used);
401                 }
402 #endif
403                 if (n > SAVAGE_DMA_PAGE_SIZE)
404                         dev_priv->dma_pages[i].used = SAVAGE_DMA_PAGE_SIZE;
405                 else
406                         dev_priv->dma_pages[i].used = n;
407                 n -= SAVAGE_DMA_PAGE_SIZE;
408         }
409         dev_priv->current_dma_page = --i;
410
411         DRM_DEBUG("cur=%u, cur->used=%u, n=%u\n",
412                   i, dev_priv->dma_pages[i].used, n);
413
414         savage_dma_wait(dev_priv, dev_priv->current_dma_page);
415
416         return dma_ptr;
417 }
418
419 static void savage_dma_flush(drm_savage_private_t *dev_priv)
420 {
421         unsigned int first = dev_priv->first_dma_page;
422         unsigned int cur = dev_priv->current_dma_page;
423         uint16_t event;
424         unsigned int wrap, pad, align, len, i;
425         unsigned long phys_addr;
426         BCI_LOCALS;
427
428         if (first == cur &&
429             dev_priv->dma_pages[cur].used == dev_priv->dma_pages[cur].flushed)
430                 return;
431
432         /* pad length to multiples of 2 entries
433          * align start of next DMA block to multiles of 8 entries */
434         pad = -dev_priv->dma_pages[cur].used & 1;
435         align = -(dev_priv->dma_pages[cur].used + pad) & 7;
436
437         DRM_DEBUG("first=%u, cur=%u, first->flushed=%u, cur->used=%u, "
438                   "pad=%u, align=%u\n",
439                   first, cur, dev_priv->dma_pages[first].flushed,
440                   dev_priv->dma_pages[cur].used, pad, align);
441
442         /* pad with noops */
443         if (pad) {
444                 uint32_t *dma_ptr = (uint32_t *)dev_priv->cmd_dma->handle +
445                     cur * SAVAGE_DMA_PAGE_SIZE + dev_priv->dma_pages[cur].used;
446                 dev_priv->dma_pages[cur].used += pad;
447                 while (pad != 0) {
448                         *dma_ptr++ = BCI_CMD_WAIT;
449                         pad--;
450                 }
451         }
452
453         DRM_MEMORYBARRIER();
454
455         /* do flush ... */
456         phys_addr = dev_priv->cmd_dma->offset +
457                 (first * SAVAGE_DMA_PAGE_SIZE +
458                  dev_priv->dma_pages[first].flushed) * 4;
459         len = (cur - first) * SAVAGE_DMA_PAGE_SIZE +
460             dev_priv->dma_pages[cur].used - dev_priv->dma_pages[first].flushed;
461
462         DRM_DEBUG("phys_addr=%lx, len=%u\n",
463                   phys_addr | dev_priv->dma_type, len);
464
465         BEGIN_BCI(3);
466         BCI_SET_REGISTERS(SAVAGE_DMABUFADDR, 1);
467         BCI_WRITE(phys_addr | dev_priv->dma_type);
468         BCI_DMA(len);
469
470         /* fix alignment of the start of the next block */
471         dev_priv->dma_pages[cur].used += align;
472
473         /* age DMA pages */
474         event = savage_bci_emit_event(dev_priv, 0);
475         wrap = dev_priv->event_wrap;
476         for (i = first; i < cur; ++i) {
477                 SET_AGE(&dev_priv->dma_pages[i].age, event, wrap);
478                 dev_priv->dma_pages[i].used = 0;
479                 dev_priv->dma_pages[i].flushed = 0;
480         }
481         /* age the current page only when it's full */
482         if (dev_priv->dma_pages[cur].used == SAVAGE_DMA_PAGE_SIZE) {
483                 SET_AGE(&dev_priv->dma_pages[cur].age, event, wrap);
484                 dev_priv->dma_pages[cur].used = 0;
485                 dev_priv->dma_pages[cur].flushed = 0;
486                 /* advance to next page */
487                 cur++;
488                 if (cur == dev_priv->nr_dma_pages)
489                         cur = 0;
490                 dev_priv->first_dma_page = dev_priv->current_dma_page = cur;
491         } else {
492                 dev_priv->first_dma_page = cur;
493                 dev_priv->dma_pages[cur].flushed = dev_priv->dma_pages[i].used;
494         }
495         SET_AGE(&dev_priv->last_dma_age, event, wrap);
496
497         DRM_DEBUG("first=cur=%u, cur->used=%u, cur->flushed=%u\n", cur,
498                   dev_priv->dma_pages[cur].used,
499                   dev_priv->dma_pages[cur].flushed);
500 }
501
502 static void savage_fake_dma_flush(drm_savage_private_t *dev_priv)
503 {
504         unsigned int i, j;
505         BCI_LOCALS;
506
507         if (dev_priv->first_dma_page == dev_priv->current_dma_page &&
508             dev_priv->dma_pages[dev_priv->current_dma_page].used == 0)
509                 return;
510
511         DRM_DEBUG("first=%u, cur=%u, cur->used=%u\n",
512                   dev_priv->first_dma_page, dev_priv->current_dma_page,
513                   dev_priv->dma_pages[dev_priv->current_dma_page].used);
514
515         for (i = dev_priv->first_dma_page;
516              i <= dev_priv->current_dma_page && dev_priv->dma_pages[i].used;
517              ++i) {
518                 uint32_t *dma_ptr = (uint32_t *)dev_priv->cmd_dma->handle +
519                         i * SAVAGE_DMA_PAGE_SIZE;
520 #if SAVAGE_DMA_DEBUG
521                 /* Sanity check: all pages except the last one must be full. */
522                 if (i < dev_priv->current_dma_page &&
523                     dev_priv->dma_pages[i].used != SAVAGE_DMA_PAGE_SIZE) {
524                         DRM_ERROR("partial DMA page %u: used=%u",
525                                   i, dev_priv->dma_pages[i].used);
526                 }
527 #endif
528                 BEGIN_BCI(dev_priv->dma_pages[i].used);
529                 for (j = 0; j < dev_priv->dma_pages[i].used; ++j) {
530                         BCI_WRITE(dma_ptr[j]);
531                 }
532                 dev_priv->dma_pages[i].used = 0;
533         }
534
535         /* reset to first page */
536         dev_priv->first_dma_page = dev_priv->current_dma_page = 0;
537 }
538
539 int savage_driver_load(struct drm_device *dev, unsigned long chipset)
540 {
541         drm_savage_private_t *dev_priv;
542
543         dev_priv = drm_alloc(sizeof(drm_savage_private_t), DRM_MEM_DRIVER);
544         if (dev_priv == NULL)
545                 return -ENOMEM;
546
547         memset(dev_priv, 0, sizeof(drm_savage_private_t));
548         dev->dev_private = (void *)dev_priv;
549
550         dev_priv->chipset = (enum savage_family)chipset;
551
552         return 0;
553 }
554
555 /*
556  * Initalize mappings. On Savage4 and SavageIX the alignment
557  * and size of the aperture is not suitable for automatic MTRR setup
558  * in drm_addmap. Therefore we add them manually before the maps are
559  * initialized, and tear them down on last close.
560  */
561 int savage_driver_firstopen(struct drm_device *dev)
562 {
563         drm_savage_private_t *dev_priv = dev->dev_private;
564         unsigned long mmio_base, fb_base, fb_size, aperture_base;
565         /* fb_rsrc and aper_rsrc aren't really used currently, but still exist
566          * in case we decide we need information on the BAR for BSD in the
567          * future.
568          */
569         unsigned int fb_rsrc, aper_rsrc;
570         int ret = 0;
571
572         dev_priv->mtrr[0].handle = -1;
573         dev_priv->mtrr[1].handle = -1;
574         dev_priv->mtrr[2].handle = -1;
575         if (S3_SAVAGE3D_SERIES(dev_priv->chipset)) {
576                 fb_rsrc = 0;
577                 fb_base = drm_get_resource_start(dev, 0);
578                 fb_size = SAVAGE_FB_SIZE_S3;
579                 mmio_base = fb_base + SAVAGE_FB_SIZE_S3;
580                 aper_rsrc = 0;
581                 aperture_base = fb_base + SAVAGE_APERTURE_OFFSET;
582                 /* this should always be true */
583                 if (drm_get_resource_len(dev, 0) == 0x08000000) {
584                         /* Don't make MMIO write-cobining! We need 3
585                          * MTRRs. */
586                         dev_priv->mtrr[0].base = fb_base;
587                         dev_priv->mtrr[0].size = 0x01000000;
588                         dev_priv->mtrr[0].handle =
589                             drm_mtrr_add(dev_priv->mtrr[0].base,
590                                          dev_priv->mtrr[0].size, DRM_MTRR_WC);
591                         dev_priv->mtrr[1].base = fb_base + 0x02000000;
592                         dev_priv->mtrr[1].size = 0x02000000;
593                         dev_priv->mtrr[1].handle =
594                             drm_mtrr_add(dev_priv->mtrr[1].base,
595                                          dev_priv->mtrr[1].size, DRM_MTRR_WC);
596                         dev_priv->mtrr[2].base = fb_base + 0x04000000;
597                         dev_priv->mtrr[2].size = 0x04000000;
598                         dev_priv->mtrr[2].handle =
599                             drm_mtrr_add(dev_priv->mtrr[2].base,
600                                          dev_priv->mtrr[2].size, DRM_MTRR_WC);
601                 } else {
602                         DRM_ERROR("strange pci_resource_len %08lx\n",
603                                   drm_get_resource_len(dev, 0));
604                 }
605         } else if (dev_priv->chipset != S3_SUPERSAVAGE &&
606                    dev_priv->chipset != S3_SAVAGE2000) {
607                 mmio_base = drm_get_resource_start(dev, 0);
608                 fb_rsrc = 1;
609                 fb_base = drm_get_resource_start(dev, 1);
610                 fb_size = SAVAGE_FB_SIZE_S4;
611                 aper_rsrc = 1;
612                 aperture_base = fb_base + SAVAGE_APERTURE_OFFSET;
613                 /* this should always be true */
614                 if (drm_get_resource_len(dev, 1) == 0x08000000) {
615                         /* Can use one MTRR to cover both fb and
616                          * aperture. */
617                         dev_priv->mtrr[0].base = fb_base;
618                         dev_priv->mtrr[0].size = 0x08000000;
619                         dev_priv->mtrr[0].handle =
620                             drm_mtrr_add(dev_priv->mtrr[0].base,
621                                          dev_priv->mtrr[0].size, DRM_MTRR_WC);
622                 } else {
623                         DRM_ERROR("strange pci_resource_len %08lx\n",
624                                   drm_get_resource_len(dev, 1));
625                 }
626         } else {
627                 mmio_base = drm_get_resource_start(dev, 0);
628                 fb_rsrc = 1;
629                 fb_base = drm_get_resource_start(dev, 1);
630                 fb_size = drm_get_resource_len(dev, 1);
631                 aper_rsrc = 2;
632                 aperture_base = drm_get_resource_start(dev, 2);
633                 /* Automatic MTRR setup will do the right thing. */
634         }
635
636         ret = drm_addmap(dev, mmio_base, SAVAGE_MMIO_SIZE, _DRM_REGISTERS,
637                          _DRM_READ_ONLY, &dev_priv->mmio);
638         if (ret)
639                 return ret;
640
641         ret = drm_addmap(dev, fb_base, fb_size, _DRM_FRAME_BUFFER,
642                          _DRM_WRITE_COMBINING, &dev_priv->fb);
643         if (ret)
644                 return ret;
645
646         ret = drm_addmap(dev, aperture_base, SAVAGE_APERTURE_SIZE,
647                          _DRM_FRAME_BUFFER, _DRM_WRITE_COMBINING,
648                          &dev_priv->aperture);
649
650         return ret;
651 }
652
653 /*
654  * Delete MTRRs and free device-private data.
655  */
656 void savage_driver_lastclose(struct drm_device *dev)
657 {
658         drm_savage_private_t *dev_priv = dev->dev_private;
659         int i;
660
661         for (i = 0; i < 3; ++i)
662                 if (dev_priv->mtrr[i].handle >= 0)
663                         drm_mtrr_del(dev_priv->mtrr[i].handle,
664                                      dev_priv->mtrr[i].base,
665                                      dev_priv->mtrr[i].size, DRM_MTRR_WC);
666 }
667
668 int savage_driver_unload(struct drm_device *dev)
669 {
670         drm_savage_private_t *dev_priv = dev->dev_private;
671
672         drm_free(dev_priv, sizeof(drm_savage_private_t), DRM_MEM_DRIVER);
673
674         return 0;
675 }
676
677 static int savage_do_init_bci(struct drm_device *dev, drm_savage_init_t *init)
678 {
679         drm_savage_private_t *dev_priv = dev->dev_private;
680
681         if (init->fb_bpp != 16 && init->fb_bpp != 32) {
682                 DRM_ERROR("invalid frame buffer bpp %d!\n", init->fb_bpp);
683                 return -EINVAL;
684         }
685         if (init->depth_bpp != 16 && init->depth_bpp != 32) {
686                 DRM_ERROR("invalid depth buffer bpp %d!\n", init->fb_bpp);
687                 return -EINVAL;
688         }
689         if (init->dma_type != SAVAGE_DMA_AGP &&
690             init->dma_type != SAVAGE_DMA_PCI) {
691                 DRM_ERROR("invalid dma memory type %d!\n", init->dma_type);
692                 return -EINVAL;
693         }
694
695         dev_priv->cob_size = init->cob_size;
696         dev_priv->bci_threshold_lo = init->bci_threshold_lo;
697         dev_priv->bci_threshold_hi = init->bci_threshold_hi;
698         dev_priv->dma_type = init->dma_type;
699
700         dev_priv->fb_bpp = init->fb_bpp;
701         dev_priv->front_offset = init->front_offset;
702         dev_priv->front_pitch = init->front_pitch;
703         dev_priv->back_offset = init->back_offset;
704         dev_priv->back_pitch = init->back_pitch;
705         dev_priv->depth_bpp = init->depth_bpp;
706         dev_priv->depth_offset = init->depth_offset;
707         dev_priv->depth_pitch = init->depth_pitch;
708
709         dev_priv->texture_offset = init->texture_offset;
710         dev_priv->texture_size = init->texture_size;
711
712         dev_priv->sarea = drm_getsarea(dev);
713         if (!dev_priv->sarea) {
714                 DRM_ERROR("could not find sarea!\n");
715                 savage_do_cleanup_bci(dev);
716                 return -EINVAL;
717         }
718         if (init->status_offset != 0) {
719                 dev_priv->status = drm_core_findmap(dev, init->status_offset);
720                 if (!dev_priv->status) {
721                         DRM_ERROR("could not find shadow status region!\n");
722                         savage_do_cleanup_bci(dev);
723                         return -EINVAL;
724                 }
725         } else {
726                 dev_priv->status = NULL;
727         }
728         if (dev_priv->dma_type == SAVAGE_DMA_AGP && init->buffers_offset) {
729                 dev->agp_buffer_token = init->buffers_offset;
730                 dev->agp_buffer_map = drm_core_findmap(dev,
731                                                        init->buffers_offset);
732                 if (!dev->agp_buffer_map) {
733                         DRM_ERROR("could not find DMA buffer region!\n");
734                         savage_do_cleanup_bci(dev);
735                         return -EINVAL;
736                 }
737                 drm_core_ioremap(dev->agp_buffer_map, dev);
738                 if (!dev->agp_buffer_map) {
739                         DRM_ERROR("failed to ioremap DMA buffer region!\n");
740                         savage_do_cleanup_bci(dev);
741                         return -ENOMEM;
742                 }
743         }
744         if (init->agp_textures_offset) {
745                 dev_priv->agp_textures =
746                         drm_core_findmap(dev, init->agp_textures_offset);
747                 if (!dev_priv->agp_textures) {
748                         DRM_ERROR("could not find agp texture region!\n");
749                         savage_do_cleanup_bci(dev);
750                         return -EINVAL;
751                 }
752         } else {
753                 dev_priv->agp_textures = NULL;
754         }
755
756         if (init->cmd_dma_offset) {
757                 if (S3_SAVAGE3D_SERIES(dev_priv->chipset)) {
758                         DRM_ERROR("command DMA not supported on "
759                                   "Savage3D/MX/IX.\n");
760                         savage_do_cleanup_bci(dev);
761                         return -EINVAL;
762                 }
763                 if (dev->dma && dev->dma->buflist) {
764                         DRM_ERROR("command and vertex DMA not supported "
765                                   "at the same time.\n");
766                         savage_do_cleanup_bci(dev);
767                         return -EINVAL;
768                 }
769                 dev_priv->cmd_dma = drm_core_findmap(dev, init->cmd_dma_offset);
770                 if (!dev_priv->cmd_dma) {
771                         DRM_ERROR("could not find command DMA region!\n");
772                         savage_do_cleanup_bci(dev);
773                         return -EINVAL;
774                 }
775                 if (dev_priv->dma_type == SAVAGE_DMA_AGP) {
776                         if (dev_priv->cmd_dma->type != _DRM_AGP) {
777                                 DRM_ERROR("AGP command DMA region is not a "
778                                           "_DRM_AGP map!\n");
779                                 savage_do_cleanup_bci(dev);
780                                 return -EINVAL;
781                         }
782                         drm_core_ioremap(dev_priv->cmd_dma, dev);
783                         if (!dev_priv->cmd_dma->handle) {
784                                 DRM_ERROR("failed to ioremap command "
785                                           "DMA region!\n");
786                                 savage_do_cleanup_bci(dev);
787                                 return -ENOMEM;
788                         }
789                 } else if (dev_priv->cmd_dma->type != _DRM_CONSISTENT) {
790                         DRM_ERROR("PCI command DMA region is not a "
791                                   "_DRM_CONSISTENT map!\n");
792                         savage_do_cleanup_bci(dev);
793                         return -EINVAL;
794                 }
795         } else {
796                 dev_priv->cmd_dma = NULL;
797         }
798
799         dev_priv->dma_flush = savage_dma_flush;
800         if (!dev_priv->cmd_dma) {
801                 DRM_DEBUG("falling back to faked command DMA.\n");
802                 dev_priv->fake_dma.offset = 0;
803                 dev_priv->fake_dma.size = SAVAGE_FAKE_DMA_SIZE;
804                 dev_priv->fake_dma.type = _DRM_SHM;
805                 dev_priv->fake_dma.handle = drm_alloc(SAVAGE_FAKE_DMA_SIZE,
806                                                       DRM_MEM_DRIVER);
807                 if (!dev_priv->fake_dma.handle) {
808                         DRM_ERROR("could not allocate faked DMA buffer!\n");
809                         savage_do_cleanup_bci(dev);
810                         return -ENOMEM;
811                 }
812                 dev_priv->cmd_dma = &dev_priv->fake_dma;
813                 dev_priv->dma_flush = savage_fake_dma_flush;
814         }
815
816         dev_priv->sarea_priv =
817                 (drm_savage_sarea_t *)((uint8_t *)dev_priv->sarea->handle +
818                                        init->sarea_priv_offset);
819
820         /* setup bitmap descriptors */
821         {
822                 unsigned int color_tile_format;
823                 unsigned int depth_tile_format;
824                 unsigned int front_stride, back_stride, depth_stride;
825                 if (dev_priv->chipset <= S3_SAVAGE4) {
826                         color_tile_format = dev_priv->fb_bpp == 16 ?
827                                 SAVAGE_BD_TILE_16BPP : SAVAGE_BD_TILE_32BPP;
828                         depth_tile_format = dev_priv->depth_bpp == 16 ?
829                                 SAVAGE_BD_TILE_16BPP : SAVAGE_BD_TILE_32BPP;
830                 } else {
831                         color_tile_format = SAVAGE_BD_TILE_DEST;
832                         depth_tile_format = SAVAGE_BD_TILE_DEST;
833                 }
834                 front_stride = dev_priv->front_pitch / (dev_priv->fb_bpp / 8);
835                 back_stride = dev_priv->back_pitch / (dev_priv->fb_bpp / 8);
836                 depth_stride =
837                     dev_priv->depth_pitch / (dev_priv->depth_bpp / 8);
838
839                 dev_priv->front_bd = front_stride | SAVAGE_BD_BW_DISABLE |
840                         (dev_priv->fb_bpp << SAVAGE_BD_BPP_SHIFT) |
841                         (color_tile_format << SAVAGE_BD_TILE_SHIFT);
842
843                 dev_priv-> back_bd =  back_stride | SAVAGE_BD_BW_DISABLE |
844                         (dev_priv->fb_bpp << SAVAGE_BD_BPP_SHIFT) |
845                         (color_tile_format << SAVAGE_BD_TILE_SHIFT);
846
847                 dev_priv->depth_bd = depth_stride | SAVAGE_BD_BW_DISABLE |
848                         (dev_priv->depth_bpp << SAVAGE_BD_BPP_SHIFT) |
849                         (depth_tile_format << SAVAGE_BD_TILE_SHIFT);
850         }
851
852         /* setup status and bci ptr */
853         dev_priv->event_counter = 0;
854         dev_priv->event_wrap = 0;
855         dev_priv->bci_ptr = (volatile uint32_t *)
856             ((uint8_t *)dev_priv->mmio->handle + SAVAGE_BCI_OFFSET);
857         if (S3_SAVAGE3D_SERIES(dev_priv->chipset)) {
858                 dev_priv->status_used_mask = SAVAGE_FIFO_USED_MASK_S3D;
859         } else {
860                 dev_priv->status_used_mask = SAVAGE_FIFO_USED_MASK_S4;
861         }
862         if (dev_priv->status != NULL) {
863                 dev_priv->status_ptr =
864                         (volatile uint32_t *)dev_priv->status->handle;
865                 dev_priv->wait_fifo = savage_bci_wait_fifo_shadow;
866                 dev_priv->wait_evnt = savage_bci_wait_event_shadow;
867                 dev_priv->status_ptr[1023] = dev_priv->event_counter;
868         } else {
869                 dev_priv->status_ptr = NULL;
870                 if (S3_SAVAGE3D_SERIES(dev_priv->chipset)) {
871                         dev_priv->wait_fifo = savage_bci_wait_fifo_s3d;
872                 } else {
873                         dev_priv->wait_fifo = savage_bci_wait_fifo_s4;
874                 }
875                 dev_priv->wait_evnt = savage_bci_wait_event_reg;
876         }
877
878         /* cliprect functions */
879         if (S3_SAVAGE3D_SERIES(dev_priv->chipset))
880                 dev_priv->emit_clip_rect = savage_emit_clip_rect_s3d;
881         else
882                 dev_priv->emit_clip_rect = savage_emit_clip_rect_s4;
883
884         if (savage_freelist_init(dev) < 0) {
885                 DRM_ERROR("could not initialize freelist\n");
886                 savage_do_cleanup_bci(dev);
887                 return -ENOMEM;
888         }
889
890         if (savage_dma_init(dev_priv) < 0) {
891                 DRM_ERROR("could not initialize command DMA\n");
892                 savage_do_cleanup_bci(dev);
893                 return -ENOMEM;
894         }
895
896         return 0;
897 }
898
899 static int savage_do_cleanup_bci(struct drm_device *dev)
900 {
901         drm_savage_private_t *dev_priv = dev->dev_private;
902
903         if (dev_priv->cmd_dma == &dev_priv->fake_dma) {
904                 if (dev_priv->fake_dma.handle)
905                         drm_free(dev_priv->fake_dma.handle,
906                                  SAVAGE_FAKE_DMA_SIZE, DRM_MEM_DRIVER);
907         } else if (dev_priv->cmd_dma && dev_priv->cmd_dma->handle &&
908                    dev_priv->cmd_dma->type == _DRM_AGP &&
909                    dev_priv->dma_type == SAVAGE_DMA_AGP)
910                 drm_core_ioremapfree(dev_priv->cmd_dma, dev);
911
912         if (dev_priv->dma_type == SAVAGE_DMA_AGP &&
913             dev->agp_buffer_map && dev->agp_buffer_map->handle) {
914                 drm_core_ioremapfree(dev->agp_buffer_map, dev);
915                 /* make sure the next instance (which may be running
916                  * in PCI mode) doesn't try to use an old
917                  * agp_buffer_map. */
918                 dev->agp_buffer_map = NULL;
919         }
920
921         if (dev_priv->dma_pages)
922                 drm_free(dev_priv->dma_pages,
923                          sizeof(drm_savage_dma_page_t)*dev_priv->nr_dma_pages,
924                          DRM_MEM_DRIVER);
925
926         return 0;
927 }
928
929 static int savage_bci_init(struct drm_device *dev, void *data, struct drm_file *file_priv)
930 {
931         drm_savage_init_t *init = data;
932
933         LOCK_TEST_WITH_RETURN(dev, file_priv);
934
935         switch (init->func) {
936         case SAVAGE_INIT_BCI:
937                 return savage_do_init_bci(dev, init);
938         case SAVAGE_CLEANUP_BCI:
939                 return savage_do_cleanup_bci(dev);
940         }
941
942         return -EINVAL;
943 }
944
945 static int savage_bci_event_emit(struct drm_device *dev, void *data, struct drm_file *file_priv)
946 {
947         drm_savage_private_t *dev_priv = dev->dev_private;
948         drm_savage_event_emit_t *event = data;
949
950         DRM_DEBUG("\n");
951
952         LOCK_TEST_WITH_RETURN(dev, file_priv);
953
954         event->count = savage_bci_emit_event(dev_priv, event->flags);
955         event->count |= dev_priv->event_wrap << 16;
956
957         return 0;
958 }
959
960 static int savage_bci_event_wait(struct drm_device *dev, void *data, struct drm_file *file_priv)
961 {
962         drm_savage_private_t *dev_priv = dev->dev_private;
963         drm_savage_event_wait_t *event = data;
964         unsigned int event_e, hw_e;
965         unsigned int event_w, hw_w;
966
967         DRM_DEBUG("\n");
968
969         UPDATE_EVENT_COUNTER();
970         if (dev_priv->status_ptr)
971                 hw_e = dev_priv->status_ptr[1] & 0xffff;
972         else
973                 hw_e = SAVAGE_READ(SAVAGE_STATUS_WORD1) & 0xffff;
974         hw_w = dev_priv->event_wrap;
975         if (hw_e > dev_priv->event_counter)
976                 hw_w--; /* hardware hasn't passed the last wrap yet */
977
978         event_e = event->count & 0xffff;
979         event_w = event->count >> 16;
980
981         /* Don't need to wait if
982          * - event counter wrapped since the event was emitted or
983          * - the hardware has advanced up to or over the event to wait for.
984          */
985         if (event_w < hw_w || (event_w == hw_w && event_e <= hw_e))
986                 return 0;
987         else
988                 return dev_priv->wait_evnt(dev_priv, event_e);
989 }
990
991 /*
992  * DMA buffer management
993  */
994
995 static int savage_bci_get_buffers(struct drm_device *dev,
996                                   struct drm_file *file_priv,
997                                   struct drm_dma *d)
998 {
999         struct drm_buf *buf;
1000         int i;
1001
1002         for (i = d->granted_count; i < d->request_count; i++) {
1003                 buf = savage_freelist_get(dev);
1004                 if (!buf)
1005                         return -EAGAIN;
1006
1007                 buf->file_priv = file_priv;
1008
1009                 if (DRM_COPY_TO_USER(&d->request_indices[i],
1010                                      &buf->idx, sizeof(buf->idx)))
1011                         return -EFAULT;
1012                 if (DRM_COPY_TO_USER(&d->request_sizes[i],
1013                                      &buf->total, sizeof(buf->total)))
1014                         return -EFAULT;
1015
1016                 d->granted_count++;
1017         }
1018         return 0;
1019 }
1020
1021 int savage_bci_buffers(struct drm_device *dev, void *data, struct drm_file *file_priv)
1022 {
1023         struct drm_device_dma *dma = dev->dma;
1024         struct drm_dma *d = data;
1025         int ret = 0;
1026
1027         LOCK_TEST_WITH_RETURN(dev, file_priv);
1028
1029         /* Please don't send us buffers.
1030          */
1031         if (d->send_count != 0) {
1032                 DRM_ERROR("Process %d trying to send %d buffers via drmDMA\n",
1033                           DRM_CURRENTPID, d->send_count);
1034                 return -EINVAL;
1035         }
1036
1037         /* We'll send you buffers.
1038          */
1039         if (d->request_count < 0 || d->request_count > dma->buf_count) {
1040                 DRM_ERROR("Process %d trying to get %d buffers (of %d max)\n",
1041                           DRM_CURRENTPID, d->request_count, dma->buf_count);
1042                 return -EINVAL;
1043         }
1044
1045         d->granted_count = 0;
1046
1047         if (d->request_count) {
1048                 ret = savage_bci_get_buffers(dev, file_priv, d);
1049         }
1050
1051         return ret;
1052 }
1053
1054 void savage_reclaim_buffers(struct drm_device *dev, struct drm_file *file_priv)
1055 {
1056         struct drm_device_dma *dma = dev->dma;
1057         drm_savage_private_t *dev_priv = dev->dev_private;
1058         int i;
1059
1060         if (!dma)
1061                 return;
1062         if (!dev_priv)
1063                 return;
1064         if (!dma->buflist)
1065                 return;
1066
1067         for (i = 0; i < dma->buf_count; i++) {
1068                 struct drm_buf *buf = dma->buflist[i];
1069                 drm_savage_buf_priv_t *buf_priv = buf->dev_private;
1070
1071                 if (buf->file_priv == file_priv && buf_priv &&
1072                     buf_priv->next == NULL && buf_priv->prev == NULL) {
1073                         uint16_t event;
1074                         DRM_DEBUG("reclaimed from client\n");
1075                         event = savage_bci_emit_event(dev_priv, SAVAGE_WAIT_3D);
1076                         SET_AGE(&buf_priv->age, event, dev_priv->event_wrap);
1077                         savage_freelist_put(dev, buf);
1078                 }
1079         }
1080
1081         drm_core_reclaim_buffers(dev, file_priv);
1082 }
1083
1084 struct drm_ioctl_desc savage_ioctls[] = {
1085         DRM_IOCTL_DEF(DRM_SAVAGE_BCI_INIT, savage_bci_init, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
1086         DRM_IOCTL_DEF(DRM_SAVAGE_BCI_CMDBUF, savage_bci_cmdbuf, DRM_AUTH),
1087         DRM_IOCTL_DEF(DRM_SAVAGE_BCI_EVENT_EMIT, savage_bci_event_emit, DRM_AUTH),
1088         DRM_IOCTL_DEF(DRM_SAVAGE_BCI_EVENT_WAIT, savage_bci_event_wait, DRM_AUTH),
1089 };
1090
1091 int savage_max_ioctl = DRM_ARRAY_SIZE(savage_ioctls);