sys/dev/agp/agp_if.m

   1 #
   2 # Copyright (c) 2000 Doug Rabson
   3 # All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions
   7 # are met:
   8 # 1. Redistributions of source code must retain the above copyright
   9 #    notice, this list of conditions and the following disclaimer.
  10 # 2. Redistributions in binary form must reproduce the above copyright
  11 #    notice, this list of conditions and the following disclaimer in the
  12 #    documentation and/or other materials provided with the distribution.
  13 #
  14 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 # SUCH DAMAGE.
  25 #
  26 # $FreeBSD: src/sys/pci/agp_if.m,v 1.1.2.2 2003/04/12 20:38:37 murray Exp $
  27 #
  28
  29 #include <sys/bus.h>
  30
  31 #
  32 # The AGP interface is used internally to the agp driver to isolate the
  33 # differences between various AGP chipsets into chipset mini drivers. It
  34 # should not be used outside the AGP driver. The kernel api for accessing
  35 # AGP functionality is described in <pci/agpvar.h>
  36 #
  37 INTERFACE agp;
  38
  39 #
  40 # Return the current aperture size.
  41 #
  42 METHOD u_int32_t get_aperture {
  43         device_t        dev;
  44 };
  45
  46 #
  47 # Set the size of the aperture. Return EINVAL on error or 0 on success.
  48 #
  49 METHOD int set_aperture {
  50         device_t        dev;
  51         u_int32_t       aperture;
  52 };
  53
  54 #
  55 # Bind a single page in the AGP aperture to a given physical address.
  56 # The offset is a byte offset within the aperture which must be
  57 # aligned to an AGP page boundary.
  58 #
  59 METHOD int bind_page {
  60         device_t        dev;
  61         vm_offset_t     offset;
  62         vm_offset_t     physical;
  63 };
  64
  65 #
  66 # Unbind a single page in the AGP aperture.
  67 #
  68 METHOD int unbind_page {
  69         device_t        dev;
  70         vm_offset_t     offset;
  71 };
  72
  73 #
  74 # Flush the GATT TLB. This is used after a call to bind_page to
  75 # ensure that any mappings cached in the chipset are discarded.
  76 #
  77 METHOD void flush_tlb {
  78         device_t        dev;
  79 };
  80
  81 #
  82 # Enable the agp hardware with the relavent mode. The mode bits are
  83 # defined in <pci/agpreg.h>
  84 #
  85 METHOD int enable {
  86         device_t        dev;
  87         u_int32_t       mode;
  88 };
  89
  90 #
  91 # Allocate memory of a given type. The type is a chipset-specific
  92 # code which is used by certain integrated agp graphics chips
  93 # (basically just the i810 for now) to access special features of
  94 # the chipset. An opaque handle representing the memory region is
  95 # returned and can be used as an argument to free_memory, bind_memory
  96 # and unbind_memory.
  97 #
  98 # The size is specified in bytes but must be a multiple of the AGP
  99 # page size.
 100 #
 101 METHOD struct agp_memory * alloc_memory {
 102         device_t        dev;
 103         int             type;
 104         vm_size_t       size;
 105 };
 106
 107 #
 108 # Free a memory region previously allocated with alloc_memory. Return
 109 # EBUSY if the memory is bound.
 110 #
 111 METHOD int free_memory {
 112         device_t        dev;
 113         struct agp_memory *mem;
 114 };
 115
 116 #
 117 # Bind a memory region to a specific byte offset within the chipset's
 118 # AGP aperture. This effectively defines a range of contiguous
 119 # physical address which alias the (possibly uncontiguous) pages in
 120 # the memory region.
 121 #
 122 METHOD int bind_memory {
 123         device_t        dev;
 124         struct agp_memory *mem;
 125         vm_offset_t     offset;
 126 };
 127
 128 #
 129 # Unbind a memory region bound with bind_memory.
 130 #
 131 METHOD int unbind_memory {
 132         device_t        dev;
 133         struct agp_memory *handle;
 134 };