sys/sys/agpio.h

   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/sys/agpio.h,v 1.4 2003/10/23 18:08:56 jhb Exp $
  27  *      $DragonFly: src/sys/sys/agpio.h,v 1.5 2007/09/12 08:31:44 hasso Exp $
  28  */
  29
  30 #ifndef _SYS_AGPIO_H_
  31 #define _SYS_AGPIO_H_
  32
  33 #ifndef _SYS_TYPES_H_
  34 #include <sys/types.h>
  35 #endif
  36
  37 #ifndef _SYS_IOCCOM_H_
  38 #include <sys/ioccom.h>
  39 #endif
  40
  41 /*
  42  * The AGP gatt uses 4k pages irrespective of the host page size.
  43  */
  44 #define AGP_PAGE_SIZE           4096
  45 #define AGP_PAGE_SHIFT          12
  46
  47 /*
  48  * Macros to manipulate AGP mode words.
  49  *
  50  * SBA = Sideband Address Port
  51  * FW  = Fast Writes
  52  */
  53 #define AGP_MODE_GET_RQ(x)              (((x) & 0xff000000U) >> 24)
  54 #define AGP_MODE_GET_ARQSZ(x)           (((x) & 0x0000e000U) >> 13)
  55 #define AGP_MODE_GET_CAL(x)             (((x) & 0x00001c00U) >> 10)
  56 #define AGP_MODE_GET_SBA(x)             (((x) & 0x00000200U) >> 9)
  57 #define AGP_MODE_GET_AGP(x)             (((x) & 0x00000100U) >> 8)
  58 #define AGP_MODE_GET_GART_64(x)         (((x) & 0x00000080U) >> 7)
  59 #define AGP_MODE_GET_OVER_4G(x)         (((x) & 0x00000020U) >> 5)
  60 #define AGP_MODE_GET_FW(x)              (((x) & 0x00000010U) >> 4)
  61 #define AGP_MODE_GET_MODE_3(x)          (((x) & 0x00000008U) >> 3)
  62 #define AGP_MODE_GET_RATE(x)            ((x) & 0x00000007U)
  63 #define AGP_MODE_SET_RQ(x,v)            (((x) & ~0xff000000U) | ((v) << 24))
  64 #define AGP_MODE_SET_ARQSZ(x,v)         (((x) & ~0x0000e000U) | ((v) << 13))
  65 #define AGP_MODE_SET_CAL(x,v)           (((x) & ~0x00001c00U) | ((v) << 10))
  66 #define AGP_MODE_SET_SBA(x,v)           (((x) & ~0x00000200U) | ((v) << 9))
  67 #define AGP_MODE_SET_AGP(x,v)           (((x) & ~0x00000100U) | ((v) << 8))
  68 #define AGP_MODE_SET_GART_64(x,v)       (((x) & ~0x00000080U) | ((v) << 7))
  69 #define AGP_MODE_SET_OVER_4G(x,v)       (((x) & ~0x00000020U) | ((v) << 5))
  70 #define AGP_MODE_SET_FW(x,v)            (((x) & ~0x00000010U) | ((v) << 4))
  71 #define AGP_MODE_SET_MODE_3(x,v)        (((x) & ~0x00000008U) | ((v) << 3))
  72 #define AGP_MODE_SET_RATE(x,v)          (((x) & ~0x00000007U) | (v))
  73 #define AGP_MODE_V2_RATE_1x             0x00000001
  74 #define AGP_MODE_V2_RATE_2x             0x00000002
  75 #define AGP_MODE_V2_RATE_4x             0x00000004
  76 #define AGP_MODE_V3_RATE_4x             0x00000001
  77 #define AGP_MODE_V3_RATE_8x             0x00000002
  78 #define AGP_MODE_V3_RATE_RSVD           0x00000004
  79
  80 /* XXX: Compat */
  81 #define AGP_MODE_GET_4G(x)              AGP_MODE_GET_OVER_4G(x)
  82 #define AGP_MODE_SET_4G(x)              AGP_MODE_SET_OVER_4G(x)
  83 #define AGP_MODE_RATE_1x                AGP_MODE_V2_RATE_1x
  84 #define AGP_MODE_RATE_2x                AGP_MODE_V2_RATE_2x
  85 #define AGP_MODE_RATE_4x                AGP_MODE_V2_RATE_4x
  86
  87 #define AGPIOC_BASE       'A'
  88 #define AGPIOC_INFO       _IOR (AGPIOC_BASE, 0, agp_info)
  89 #define AGPIOC_ACQUIRE    _IO  (AGPIOC_BASE, 1)
  90 #define AGPIOC_RELEASE    _IO  (AGPIOC_BASE, 2)
  91 #define AGPIOC_SETUP      _IOW (AGPIOC_BASE, 3, agp_setup)
  92 #if 0
  93 #define AGPIOC_RESERVE    _IOW (AGPIOC_BASE, 4, agp_region)
  94 #define AGPIOC_PROTECT    _IOW (AGPIOC_BASE, 5, agp_region)
  95 #endif
  96 #define AGPIOC_ALLOCATE   _IOWR(AGPIOC_BASE, 6, agp_allocate)
  97 #define AGPIOC_DEALLOCATE _IOW (AGPIOC_BASE, 7, int)
  98 #define AGPIOC_BIND       _IOW (AGPIOC_BASE, 8, agp_bind)
  99 #define AGPIOC_UNBIND     _IOW (AGPIOC_BASE, 9, agp_unbind)
 100
 101 typedef struct _agp_version {
 102         u_int16_t major;
 103         u_int16_t minor;
 104 } agp_version;
 105
 106 typedef struct _agp_info {
 107         agp_version version;    /* version of the driver        */
 108         u_int32_t bridge_id;    /* bridge vendor/device         */
 109         u_int32_t agp_mode;     /* mode info of bridge          */
 110         off_t aper_base;        /* base of aperture             */
 111         size_t aper_size;       /* size of aperture             */
 112         size_t pg_total;        /* max pages (swap + system)    */
 113         size_t pg_system;       /* max pages (system)           */
 114         size_t pg_used;         /* current pages used           */
 115 } agp_info;
 116
 117 typedef struct _agp_setup {
 118         u_int32_t agp_mode;             /* mode info of bridge          */
 119 } agp_setup;
 120
 121 #if 0
 122 /*
 123  * The "prot" down below needs still a "sleep" flag somehow ...
 124  */
 125 typedef struct _agp_segment {
 126         off_t pg_start;         /* starting page to populate    */
 127         size_t pg_count;        /* number of pages              */
 128         int prot;               /* prot flags for mmap          */
 129 } agp_segment;
 130
 131 typedef struct _agp_region {
 132         pid_t pid;              /* pid of process               */
 133         size_t seg_count;       /* number of segments           */
 134         struct _agp_segment *seg_list;
 135 } agp_region;
 136 #endif
 137
 138 typedef struct _agp_allocate {
 139         int key;                /* tag of allocation            */
 140         size_t pg_count;        /* number of pages              */
 141         u_int32_t type;         /* 0 == normal, other devspec   */
 142         u_int32_t physical;     /* device specific (some devices
 143                                  * need a phys address of the
 144                                  * actual page behind the gatt
 145                                  * table)                        */
 146 } agp_allocate;
 147
 148 typedef struct _agp_bind {
 149         int key;                /* tag of allocation            */
 150         off_t pg_start;         /* starting page to populate    */
 151 } agp_bind;
 152
 153 typedef struct _agp_unbind {
 154         int key;                /* tag of allocation            */
 155         u_int32_t priority;     /* priority for paging out      */
 156 } agp_unbind;
 157
 158 #endif /* !_SYS_AGPIO_H_ */