/*
   * AGPGART module version 0.99
   * Copyright (C) 1999 Jeff Hartmann
   * Copyright (C) 1999 Precision Insight, Inc.
   * Copyright (C) 1999 Xi Graphics, Inc.
   *
   * Permission is hereby granted, free of charge, to any person obtaining a
   * copy of this software and associated documentation files (the "Software"),
   * to deal in the Software without restriction, including without limitation
   * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   * and/or sell copies of the Software, and to permit persons to whom the
   * Software is furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice shall be included
   * in all copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
   * JEFF HARTMANN, OR ANY OTHER CONTRIBUTORS BE LIABLE FOR ANY CLAIM, 
   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 
   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
   * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
   *
   */
  #ifndef _AGP_H
  #define _AGP_H 1
  
  #include <linux/mutex.h>
  #include <linux/agp_backend.h>
  #include <uapi/linux/agpgart.h>
  
  #define AGPGART_MINOR 175
  
  struct agp_info {
  	struct agp_version version;	/* version of the driver        */
  	u32 bridge_id;		/* bridge vendor/device         */
  	u32 agp_mode;		/* mode info of bridge          */
  	unsigned long aper_base;/* base of aperture             */
  	size_t aper_size;	/* size of aperture             */
  	size_t pg_total;	/* max pages (swap + system)    */
  	size_t pg_system;	/* max pages (system)           */
  	size_t pg_used;		/* current pages used           */
  };
  
  struct agp_setup {
  	u32 agp_mode;		/* mode info of bridge          */
  };
  
  /*
   * The "prot" down below needs still a "sleep" flag somehow ...
   */
  struct agp_segment {
  	off_t pg_start;		/* starting page to populate    */
  	size_t pg_count;	/* number of pages              */
  	int prot;		/* prot flags for mmap          */
  };
  
  struct agp_segment_priv {
  	off_t pg_start;
  	size_t pg_count;
  	pgprot_t prot;
  };
  
  struct agp_region {
  	pid_t pid;		/* pid of process               */
  	size_t seg_count;	/* number of segments           */
  	struct agp_segment *seg_list;
  };
  
  struct agp_allocate {
  	int key;		/* tag of allocation            */
  	size_t pg_count;	/* number of pages              */
  	u32 type;		/* 0 == normal, other devspec   */
  	u32 physical;           /* device specific (some devices  
  				 * need a phys address of the     
  				 * actual page behind the gatt    
  				 * table)                        */
  };
  
  struct agp_bind {
  	int key;		/* tag of allocation            */
  	off_t pg_start;		/* starting page to populate    */
  };
  
  struct agp_unbind {
  	int key;		/* tag of allocation            */
  	u32 priority;		/* priority for paging out      */
  };
  
  struct agp_client {
  	struct agp_client *next;
  	struct agp_client *prev;
  	pid_t pid;
  	int num_segments;
  	struct agp_segment_priv **segments;
  };
  
  struct agp_controller {
  	struct agp_controller *next;
  	struct agp_controller *prev;
  	pid_t pid;
  	int num_clients;
  	struct agp_memory *pool;
  	struct agp_client *clients;
  };
  
  #define AGP_FF_ALLOW_CLIENT		0
  #define AGP_FF_ALLOW_CONTROLLER 	1
  #define AGP_FF_IS_CLIENT		2
  #define AGP_FF_IS_CONTROLLER		3
  #define AGP_FF_IS_VALID 		4
  
  struct agp_file_private {
  	struct agp_file_private *next;
  	struct agp_file_private *prev;
  	pid_t my_pid;
  	unsigned long access_flags;	/* long req'd for set_bit --RR */
  };
  
  struct agp_front_data {
  	struct mutex agp_mutex;
  	struct agp_controller *current_controller;
  	struct agp_controller *controllers;
  	struct agp_file_private *file_priv_list;
  	bool used_by_controller;
  	bool backend_acquired;
  };
  
  #endif				/* _AGP_H */