sys/arch/x86/include/pci_machdep_common.h

   1 /*      $NetBSD: pci_machdep_common.h,v 1.9 2012/06/15 13:58:34 yamt Exp $      */
   2
   3 /*
   4  * Copyright (c) 1996 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 _X86_PCI_MACHDEP_COMMON_H_
  34 #define _X86_PCI_MACHDEP_COMMON_H_
  35
  36 /*
  37  * Machine-specific definitions for PCI autoconfiguration.
  38  */
  39 #define __HAVE_PCIIDE_MACHDEP_COMPAT_INTR_ESTABLISH
  40 #ifndef XEN
  41 #define __HAVE_PCIIDE_MACHDEP_COMPAT_INTR_DISESTABLISH
  42 #endif
  43
  44 /*
  45  * i386-specific PCI structure and type definitions.
  46  * NOT TO BE USED DIRECTLY BY MACHINE INDEPENDENT CODE.
  47  *
  48  * Configuration tag; created from a {bus,device,function} triplet by
  49  * pci_make_tag(), and passed to pci_conf_read() and pci_conf_write().
  50  * We could instead always pass the {bus,device,function} triplet to
  51  * the read and write routines, but this would cause extra overhead.
  52  *
  53  * Mode 2 is historical and deprecated by the Revision 2.0 specification.
  54  *
  55  *
  56  * Mode 1 tag:
  57  *       31              24           16 15     11 10  8
  58  *      +---------------------------------------------------------------+
  59  *      |1|      0      |      BUS      |   DEV   |FUNC |       0       |
  60  *      +---------------------------------------------------------------+
  61  */
  62 union x86_pci_tag_u {
  63         uint32_t mode1;
  64         struct {
  65                 uint16_t port;
  66                 uint8_t enable;
  67                 uint8_t forward;
  68         } mode2;
  69 };
  70
  71 extern struct x86_bus_dma_tag pci_bus_dma_tag;
  72 #ifdef _LP64
  73 extern struct x86_bus_dma_tag pci_bus_dma64_tag;
  74 #endif
  75
  76 struct pci_attach_args;
  77 struct pci_chipset_tag;
  78
  79 /*
  80  * Types provided to machine-independent PCI code
  81  */
  82 typedef struct pci_chipset_tag *pci_chipset_tag_t;
  83 typedef union x86_pci_tag_u pcitag_t;
  84
  85 struct pci_chipset_tag {
  86         pci_chipset_tag_t pc_super;
  87         uint64_t pc_present;
  88         const struct pci_overrides *pc_ov;
  89         void *pc_ctx;
  90 };
  91
  92 /*
  93  * i386-specific PCI variables and functions.
  94  * NOT TO BE USED DIRECTLY BY MACHINE INDEPENDENT CODE.
  95  */
  96 int             pci_bus_flags(void);
  97 int             pci_mode_detect(void);
  98 void            pci_mode_set(int);
  99
 100 /*
 101  * Functions provided to machine-independent PCI code.
 102  */
 103 void            pci_attach_hook(device_t, device_t,
 104                     struct pcibus_attach_args *);
 105 int             pci_bus_maxdevs(pci_chipset_tag_t, int);
 106 pcitag_t        pci_make_tag(pci_chipset_tag_t, int, int, int);
 107 void            pci_decompose_tag(pci_chipset_tag_t, pcitag_t,
 108                     int *, int *, int *);
 109 pcireg_t        pci_conf_read(pci_chipset_tag_t, pcitag_t, int);
 110 void            pci_conf_write(pci_chipset_tag_t, pcitag_t, int,
 111                     pcireg_t);
 112 int             pci_intr_map(const struct pci_attach_args *,
 113                     pci_intr_handle_t *);
 114 const char      *pci_intr_string(pci_chipset_tag_t, pci_intr_handle_t);
 115 const struct evcnt *pci_intr_evcnt(pci_chipset_tag_t, pci_intr_handle_t);
 116 void            *pci_intr_establish(pci_chipset_tag_t, pci_intr_handle_t,
 117                     int, int (*)(void *), void *);
 118 void            pci_intr_disestablish(pci_chipset_tag_t, void *);
 119
 120 /* experimental MSI support */
 121 void *pci_msi_establish(struct pci_attach_args *, int, int (*)(void *), void *);
 122 void pci_msi_disestablish(void *);
 123
 124 /*
 125  * ALL OF THE FOLLOWING ARE MACHINE-DEPENDENT, AND SHOULD NOT BE USED
 126  * BY PORTABLE CODE.
 127  */
 128
 129 /* Extract Bus Number for a host bridge or -1 if unknown. */
 130 int             pchb_get_bus_number(pci_chipset_tag_t, pcitag_t);
 131
 132 /*
 133  * Section 6.2.4, `Miscellaneous Functions' of the PCI Specification,
 134  * says that 255 means `unknown' or `no connection' to the interrupt
 135  * controller on a PC.
 136  */
 137 #define X86_PCI_INTERRUPT_LINE_NO_CONNECTION    0xff
 138
 139 void pci_device_foreach(pci_chipset_tag_t, int,
 140                         void (*)(pci_chipset_tag_t, pcitag_t, void*),
 141                         void *);
 142
 143 void pci_device_foreach_min(pci_chipset_tag_t, int, int,
 144                             void (*)(pci_chipset_tag_t, pcitag_t, void*),
 145                             void *);
 146
 147 void pci_bridge_foreach(pci_chipset_tag_t, int, int,
 148         void (*) (pci_chipset_tag_t, pcitag_t, void *), void *);
 149
 150 void pci_ranges_infer(pci_chipset_tag_t, int, int, bus_addr_t *,
 151     bus_size_t *, bus_addr_t *, bus_size_t *);
 152
 153 extern prop_dictionary_t pci_rsrc_dict;
 154 prop_dictionary_t pci_rsrc_filter(prop_dictionary_t,
 155     bool (*)(void *, prop_dictionary_t), void *arg);
 156
 157 #endif /* _X86_PCI_MACHDEP_COMMON_H_ */