Home | History | Annotate | Line # | Download | only in pci
pcivar.h revision 1.48
      1 /*	$NetBSD: pcivar.h,v 1.48 2001/09/13 21:49:40 thorpej Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1996, 1997 Christopher G. Demetriou.  All rights reserved.
      5  * Copyright (c) 1994 Charles M. Hannum.  All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. All advertising materials mentioning features or use of this software
     16  *    must display the following acknowledgement:
     17  *	This product includes software developed by Charles M. Hannum.
     18  * 4. The name of the author may not be used to endorse or promote products
     19  *    derived from this software without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 
     33 #ifndef _DEV_PCI_PCIVAR_H_
     34 #define	_DEV_PCI_PCIVAR_H_
     35 
     36 /*
     37  * Definitions for PCI autoconfiguration.
     38  *
     39  * This file describes types and functions which are used for PCI
     40  * configuration.  Some of this information is machine-specific, and is
     41  * provided by pci_machdep.h.
     42  */
     43 
     44 #include <sys/device.h>
     45 #include <machine/bus.h>
     46 #include <dev/pci/pcireg.h>
     47 
     48 /*
     49  * Structures and definitions needed by the machine-dependent header.
     50  */
     51 typedef u_int32_t pcireg_t;		/* configuration space register XXX */
     52 struct pcibus_attach_args;
     53 
     54 #ifdef _KERNEL
     55 /*
     56  * Machine-dependent definitions.
     57  */
     58 #include <machine/pci_machdep.h>
     59 
     60 /*
     61  * PCI bus attach arguments.
     62  */
     63 struct pcibus_attach_args {
     64 	char		*pba_busname;	/* XXX should be common */
     65 	bus_space_tag_t pba_iot;	/* pci i/o space tag */
     66 	bus_space_tag_t pba_memt;	/* pci mem space tag */
     67 	bus_dma_tag_t pba_dmat;		/* DMA tag */
     68 	pci_chipset_tag_t pba_pc;
     69 	int		pba_flags;	/* flags; see below */
     70 
     71 	int		pba_bus;	/* PCI bus number */
     72 
     73 	/*
     74 	 * Interrupt swizzling information.  These fields
     75 	 * are only used by secondary busses.
     76 	 */
     77 	u_int		pba_intrswiz;	/* how to swizzle pins */
     78 	pcitag_t	pba_intrtag;	/* intr. appears to come from here */
     79 };
     80 
     81 /*
     82  * PCI device attach arguments.
     83  */
     84 struct pci_attach_args {
     85 	bus_space_tag_t pa_iot;		/* pci i/o space tag */
     86 	bus_space_tag_t pa_memt;	/* pci mem space tag */
     87 	bus_dma_tag_t pa_dmat;		/* DMA tag */
     88 	pci_chipset_tag_t pa_pc;
     89 	int		pa_flags;	/* flags; see below */
     90 
     91 	u_int		pa_bus;
     92 	u_int		pa_device;
     93 	u_int		pa_function;
     94 	pcitag_t	pa_tag;
     95 	pcireg_t	pa_id, pa_class;
     96 
     97 	/*
     98 	 * Interrupt information.
     99 	 *
    100 	 * "Intrline" is used on systems whose firmware puts
    101 	 * the right routing data into the line register in
    102 	 * configuration space.  The rest are used on systems
    103 	 * that do not.
    104 	 */
    105 	u_int		pa_intrswiz;	/* how to swizzle pins if ppb */
    106 	pcitag_t	pa_intrtag;	/* intr. appears to come from here */
    107 	pci_intr_pin_t	pa_intrpin;	/* intr. appears on this pin */
    108 	pci_intr_line_t	pa_intrline;	/* intr. routing information */
    109 };
    110 
    111 /*
    112  * Flags given in the bus and device attachment args.
    113  */
    114 #define	PCI_FLAGS_IO_ENABLED	0x01		/* I/O space is enabled */
    115 #define	PCI_FLAGS_MEM_ENABLED	0x02		/* memory space is enabled */
    116 #define	PCI_FLAGS_MRL_OKAY	0x04		/* Memory Read Line okay */
    117 #define	PCI_FLAGS_MRM_OKAY	0x08		/* Memory Read Multiple okay */
    118 #define	PCI_FLAGS_MWI_OKAY	0x10		/* Memory Write and Invalidate
    119 						   okay */
    120 
    121 /*
    122  * PCI device 'quirks'.
    123  *
    124  * In general strange behaviour which can be handled by a driver (e.g.
    125  * a bridge's inability to pass a type of access correctly) should be.
    126  * The quirks table should only contain information which impacts
    127  * the operation of the MI PCI code and which can't be pushed lower
    128  * (e.g. because it's unacceptable to require a driver to be present
    129  * for the information to be known).
    130  */
    131 struct pci_quirkdata {
    132 	pci_vendor_id_t		vendor;		/* Vendor ID */
    133 	pci_product_id_t	product;	/* Product ID */
    134 	int			quirks;		/* quirks; see below */
    135 };
    136 #define	PCI_QUIRK_MULTIFUNCTION		1
    137 
    138 #include "locators.h"
    139 
    140 struct pci_softc {
    141 	struct device sc_dev;
    142 	bus_space_tag_t sc_iot, sc_memt;
    143 	bus_dma_tag_t sc_dmat;
    144 	pci_chipset_tag_t sc_pc;
    145 	int sc_bus, sc_maxndevs;
    146 	u_int sc_intrswiz;
    147 	pcitag_t sc_intrtag;
    148 	int sc_flags;
    149 };
    150 
    151 extern struct cfdriver pci_cd;
    152 
    153 /*
    154  * Locators devices that attach to 'pcibus', as specified to config.
    155  */
    156 #define	pcibuscf_bus		cf_loc[PCIBUSCF_BUS]
    157 #define	PCIBUS_UNK_BUS		PCIBUSCF_BUS_DEFAULT	/* wildcarded 'bus' */
    158 
    159 /*
    160  * Locators for PCI devices, as specified to config.
    161  */
    162 #define	pcicf_dev		cf_loc[PCICF_DEV]
    163 #define	PCI_UNK_DEV		PCICF_DEV_DEFAULT	/* wildcarded 'dev' */
    164 
    165 #define	pcicf_function		cf_loc[PCICF_FUNCTION]
    166 #define	PCI_UNK_FUNCTION	PCICF_FUNCTION_DEFAULT /* wildcarded 'function' */
    167 
    168 /*
    169  * Configuration space access and utility functions.  (Note that most,
    170  * e.g. make_tag, conf_read, conf_write are declared by pci_machdep.h.)
    171  */
    172 pcireg_t pci_mapreg_type __P((pci_chipset_tag_t, pcitag_t, int));
    173 int	pci_mapreg_info __P((pci_chipset_tag_t, pcitag_t, int, pcireg_t,
    174 	    bus_addr_t *, bus_size_t *, int *));
    175 int	pci_mapreg_map __P((struct pci_attach_args *, int, pcireg_t, int,
    176 	    bus_space_tag_t *, bus_space_handle_t *, bus_addr_t *,
    177 	    bus_size_t *));
    178 
    179 int pci_get_capability __P((pci_chipset_tag_t, pcitag_t, int,
    180 			    int *, pcireg_t *));
    181 
    182 /*
    183  * Helper functions for autoconfiguration.
    184  */
    185 void	pci_devinfo __P((pcireg_t, pcireg_t, int, char *));
    186 void	pci_conf_print __P((pci_chipset_tag_t, pcitag_t,
    187 	    void (*)(pci_chipset_tag_t, pcitag_t, const pcireg_t *)));
    188 const struct pci_quirkdata *
    189 	pci_lookup_quirkdata __P((pci_vendor_id_t, pci_product_id_t));
    190 
    191 /*
    192  * Helper functions for user access to the PCI bus.
    193  */
    194 struct proc;
    195 int	pci_devioctl __P((pci_chipset_tag_t, pcitag_t, u_long, caddr_t,
    196 	    int flag, struct proc *));
    197 
    198 /*
    199  * Misc.
    200  */
    201 char   *pci_findvendor __P((pcireg_t));
    202 int	pci_find_device(struct pci_attach_args *pa,
    203 			int (*match)(struct pci_attach_args *));
    204 
    205 #endif /* _KERNEL */
    206 
    207 #endif /* _DEV_PCI_PCIVAR_H_ */
    208