/*
   * AGPGART backend specific includes. Not for userspace consumption.
   *
   * Copyright (C) 2004 Silicon Graphics, Inc.
   * Copyright (C) 2002-2003 Dave Jones
   * 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_BACKEND_H
  #define _AGP_BACKEND_H 1

  #include <linux/list.h>

  enum chipset_type {
  	NOT_SUPPORTED,
  	SUPPORTED,
  };
  
  struct agp_version {
  	u16 major;
  	u16 minor;
  };
  
  struct agp_kern_info {
  	struct agp_version version;
  	struct pci_dev *device;
  	enum chipset_type chipset;
  	unsigned long mode;
  	unsigned long aper_base;
  	size_t aper_size;
  	int max_memory;		/* In pages */
  	int current_memory;

  	bool cant_use_aperture;

  	unsigned long page_mask;

  	const struct vm_operations_struct *vm_ops;

  };
  
  /*
   * The agp_memory structure has information about the block of agp memory
   * allocated.  A caller may manipulate the next and prev pointers to link
   * each allocated item into a list.  These pointers are ignored by the backend.
   * Everything else should never be written to, but the caller may read any of
   * the items to determine the status of this block of agp memory.
   */
  
  struct agp_bridge_data;
  
  struct agp_memory {
  	struct agp_memory *next;
  	struct agp_memory *prev;
  	struct agp_bridge_data *bridge;

  	struct page **pages;

  	size_t page_count;
  	int key;
  	int num_scratch_pages;
  	off_t pg_start;
  	u32 type;
  	u32 physical;

  	bool is_bound;
  	bool is_flushed;

  	/* list of agp_memory mapped to the aperture */
  	struct list_head mapped_list;

  	/* DMA-mapped addresses */
  	struct scatterlist *sg_list;
  	int num_sg;

  };
  
  #define AGP_NORMAL_MEMORY 0

  #define AGP_USER_TYPES (1 << 16)
  #define AGP_USER_MEMORY (AGP_USER_TYPES)
  #define AGP_USER_CACHED_MEMORY (AGP_USER_TYPES + 1)

  extern struct agp_bridge_data *agp_bridge;
  extern struct list_head agp_bridges;
  
  extern struct agp_bridge_data *(*agp_find_bridge)(struct pci_dev *);
  
  extern void agp_free_memory(struct agp_memory *);
  extern struct agp_memory *agp_allocate_memory(struct agp_bridge_data *, size_t, u32);
  extern int agp_copy_info(struct agp_bridge_data *, struct agp_kern_info *);
  extern int agp_bind_memory(struct agp_memory *, off_t);
  extern int agp_unbind_memory(struct agp_memory *);
  extern void agp_enable(struct agp_bridge_data *, u32);
  extern struct agp_bridge_data *agp_backend_acquire(struct pci_dev *);
  extern void agp_backend_release(struct agp_bridge_data *);

  #endif				/* _AGP_BACKEND_H */