Home | History | Annotate | Line # | Download | only in pci
msipic.c revision 1.3
      1  1.3    martin /*	$NetBSD: msipic.c,v 1.3 2015/04/28 06:23:57 martin Exp $	*/
      2  1.1  knakahar 
      3  1.1  knakahar /*
      4  1.1  knakahar  * Copyright (c) 2015 Internet Initiative Japan Inc.
      5  1.1  knakahar  * All rights reserved.
      6  1.1  knakahar  *
      7  1.1  knakahar  * Redistribution and use in source and binary forms, with or without
      8  1.1  knakahar  * modification, are permitted provided that the following conditions
      9  1.1  knakahar  * are met:
     10  1.1  knakahar  * 1. Redistributions of source code must retain the above copyright
     11  1.1  knakahar  *    notice, this list of conditions and the following disclaimer.
     12  1.1  knakahar  * 2. Redistributions in binary form must reproduce the above copyright
     13  1.1  knakahar  *    notice, this list of conditions and the following disclaimer in the
     14  1.1  knakahar  *    documentation and/or other materials provided with the distribution.
     15  1.1  knakahar  *
     16  1.1  knakahar  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     17  1.1  knakahar  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     18  1.1  knakahar  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     19  1.1  knakahar  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     20  1.1  knakahar  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     21  1.1  knakahar  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     22  1.1  knakahar  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     23  1.1  knakahar  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     24  1.1  knakahar  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     25  1.1  knakahar  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     26  1.1  knakahar  * POSSIBILITY OF SUCH DAMAGE.
     27  1.1  knakahar  */
     28  1.1  knakahar 
     29  1.1  knakahar #include <sys/cdefs.h>
     30  1.3    martin __KERNEL_RCSID(0, "$NetBSD: msipic.c,v 1.3 2015/04/28 06:23:57 martin Exp $");
     31  1.1  knakahar 
     32  1.1  knakahar #include <sys/types.h>
     33  1.1  knakahar #include <sys/param.h>
     34  1.1  knakahar #include <sys/systm.h>
     35  1.1  knakahar #include <sys/errno.h>
     36  1.1  knakahar #include <sys/kmem.h>
     37  1.1  knakahar #include <sys/malloc.h>
     38  1.1  knakahar #include <sys/mutex.h>
     39  1.1  knakahar 
     40  1.1  knakahar #include <dev/pci/pcivar.h>
     41  1.1  knakahar 
     42  1.1  knakahar #include <machine/i82489reg.h>
     43  1.1  knakahar #include <machine/i82093reg.h>
     44  1.1  knakahar #include <machine/i82093var.h>
     45  1.1  knakahar #include <machine/pic.h>
     46  1.1  knakahar #include <machine/lock.h>
     47  1.1  knakahar 
     48  1.1  knakahar #include <x86/pci/msipic.h>
     49  1.1  knakahar 
     50  1.1  knakahar #ifdef INTRDEBUG
     51  1.1  knakahar #define MSIPICDEBUG
     52  1.1  knakahar #endif
     53  1.1  knakahar 
     54  1.1  knakahar #ifdef MSIPICDEBUG
     55  1.1  knakahar #define DPRINTF(msg) printf msg
     56  1.1  knakahar #else
     57  1.1  knakahar #define DPRINTF(msg)
     58  1.1  knakahar #endif
     59  1.1  knakahar 
     60  1.1  knakahar #define BUS_SPACE_WRITE_FLUSH(pc, tag) (void)bus_space_read_4(pc, tag, 0)
     61  1.1  knakahar 
     62  1.1  knakahar #define MSIPICNAMEBUF 16
     63  1.1  knakahar 
     64  1.1  knakahar /*
     65  1.1  knakahar  * A Pseudo pic for single MSI/MSI-X device.
     66  1.1  knakahar  * The pic and MSI/MSI-X device are distinbuished by "devid". The "devid"
     67  1.1  knakahar  * is managed by below "dev_seqs".
     68  1.1  knakahar  */
     69  1.1  knakahar struct msipic {
     70  1.1  knakahar 	int mp_bus;
     71  1.1  knakahar 	int mp_dev;
     72  1.1  knakahar 	int mp_fun;
     73  1.1  knakahar 
     74  1.1  knakahar 	int mp_devid; /* The device id for the MSI/MSI-X device. */
     75  1.1  knakahar 	int mp_veccnt; /* The number of MSI/MSI-X vectors. */
     76  1.1  knakahar 
     77  1.1  knakahar 	char mp_pic_name[MSIPICNAMEBUF]; /* The MSI/MSI-X device's name. */
     78  1.1  knakahar 
     79  1.1  knakahar 	struct pci_attach_args mp_pa;
     80  1.1  knakahar 	bus_space_tag_t mp_bstag;
     81  1.1  knakahar 	bus_space_handle_t mp_bshandle;
     82  1.1  knakahar 	bus_size_t mp_bssize;
     83  1.1  knakahar 	struct pic *mp_pic;
     84  1.1  knakahar 
     85  1.1  knakahar 	LIST_ENTRY(msipic) mp_list;
     86  1.1  knakahar };
     87  1.1  knakahar 
     88  1.1  knakahar static kmutex_t msipic_list_lock;
     89  1.1  knakahar 
     90  1.1  knakahar static LIST_HEAD(, msipic) msipic_list =
     91  1.1  knakahar 	LIST_HEAD_INITIALIZER(msipic_list);
     92  1.1  knakahar 
     93  1.1  knakahar /*
     94  1.1  knakahar  * This struct managements "devid" to use the same "devid" for the device
     95  1.1  knakahar  * re-attached. If the device's bus number and device numer and function
     96  1.1  knakahar  * number are equal, it is assumed re-attached.
     97  1.1  knakahar  */
     98  1.1  knakahar struct dev_last_used_seq {
     99  1.1  knakahar 	bool ds_using;
    100  1.1  knakahar 	int ds_bus;
    101  1.1  knakahar 	int ds_dev;
    102  1.1  knakahar 	int ds_fun;
    103  1.1  knakahar };
    104  1.1  knakahar /* The number of MSI/MSI-X devices supported by system. */
    105  1.1  knakahar #define NUM_MSI_DEVS 256
    106  1.1  knakahar /* Record devids to use the same devid when the device is re-attached. */
    107  1.1  knakahar static struct dev_last_used_seq dev_seqs[NUM_MSI_DEVS];
    108  1.1  knakahar 
    109  1.1  knakahar static int msipic_allocate_common_msi_devid(struct pci_attach_args *);
    110  1.1  knakahar static void msipic_release_common_msi_devid(int);
    111  1.1  knakahar 
    112  1.1  knakahar static struct pic *msipic_find_msi_pic_locked(int);
    113  1.1  knakahar static struct pic *msipic_construct_common_msi_pic(struct pci_attach_args *,
    114  1.1  knakahar 						   struct pic *);
    115  1.1  knakahar static void msipic_destruct_common_msi_pic(struct pic *);
    116  1.1  knakahar 
    117  1.1  knakahar static void msi_set_msictl_enablebit(struct pic *, int, int);
    118  1.1  knakahar static void msi_hwmask(struct pic *, int);
    119  1.1  knakahar static void msi_hwunmask(struct pic *, int);
    120  1.1  knakahar static void msi_addroute(struct pic *, struct cpu_info *, int, int, int);
    121  1.1  knakahar static void msi_delroute(struct pic *, struct cpu_info *, int, int, int);
    122  1.1  knakahar 
    123  1.1  knakahar static void msix_set_vecctl_mask(struct pic *, int, int);
    124  1.1  knakahar static void msix_hwmask(struct pic *, int);
    125  1.1  knakahar static void msix_hwunmask(struct pic *, int);
    126  1.1  knakahar static void msix_addroute(struct pic *, struct cpu_info *, int, int, int);
    127  1.1  knakahar static void msix_delroute(struct pic *, struct cpu_info *, int, int, int);
    128  1.1  knakahar 
    129  1.1  knakahar /*
    130  1.1  knakahar  * Return new "devid" for the device attached first.
    131  1.1  knakahar  * Return the same "devid" for the device re-attached after dettached once.
    132  1.1  knakahar  * Return -1 if the number of attached MSI/MSI-X devices is over NUM_MSI_DEVS.
    133  1.1  knakahar  */
    134  1.1  knakahar static int
    135  1.1  knakahar msipic_allocate_common_msi_devid(struct pci_attach_args *pa)
    136  1.1  knakahar {
    137  1.1  knakahar 	pci_chipset_tag_t pc;
    138  1.1  knakahar 	pcitag_t tag;
    139  1.1  knakahar 	int bus, dev, fun, i;
    140  1.1  knakahar 
    141  1.1  knakahar 	KASSERT(mutex_owned(&msipic_list_lock));
    142  1.1  knakahar 
    143  1.1  knakahar 	pc = pa->pa_pc;
    144  1.1  knakahar 	tag = pa->pa_tag;
    145  1.1  knakahar 	pci_decompose_tag(pc, tag, &bus, &dev, &fun);
    146  1.1  knakahar 
    147  1.1  knakahar 	/* if the device was once attached, use same devid */
    148  1.1  knakahar 	for (i = 0; i < NUM_MSI_DEVS; i++) {
    149  1.1  knakahar 		/* skip host bridge */
    150  1.1  knakahar 		if (dev_seqs[i].ds_bus == 0
    151  1.1  knakahar 		    && dev_seqs[i].ds_dev == 0
    152  1.1  knakahar 		    && dev_seqs[i].ds_fun == 0)
    153  1.1  knakahar 			break;
    154  1.1  knakahar 
    155  1.1  knakahar 		if (dev_seqs[i].ds_bus == bus
    156  1.1  knakahar 		    && dev_seqs[i].ds_dev == dev
    157  1.1  knakahar 		    && dev_seqs[i].ds_fun == fun) {
    158  1.1  knakahar 			dev_seqs[i].ds_using = true;
    159  1.1  knakahar 			return i;
    160  1.1  knakahar 		}
    161  1.1  knakahar 	}
    162  1.1  knakahar 
    163  1.1  knakahar 	for (i = 0; i < NUM_MSI_DEVS; i++) {
    164  1.1  knakahar 		if (dev_seqs[i].ds_using == 0) {
    165  1.1  knakahar 			dev_seqs[i].ds_using = true;
    166  1.1  knakahar 			dev_seqs[i].ds_bus = bus;
    167  1.1  knakahar 			dev_seqs[i].ds_dev = dev;
    168  1.1  knakahar 			dev_seqs[i].ds_fun = fun;
    169  1.1  knakahar 			return i;
    170  1.1  knakahar 		}
    171  1.1  knakahar 	}
    172  1.1  knakahar 
    173  1.1  knakahar 	DPRINTF(("too many MSI devices.\n"));
    174  1.1  knakahar 	return -1;
    175  1.1  knakahar }
    176  1.1  knakahar 
    177  1.1  knakahar /*
    178  1.1  knakahar  * Set the "devid" unused, but keep reserving the "devid" to reuse when
    179  1.1  knakahar  * the device is re-attached.
    180  1.1  knakahar  */
    181  1.1  knakahar static void
    182  1.1  knakahar msipic_release_common_msi_devid(int devid)
    183  1.1  knakahar {
    184  1.1  knakahar 
    185  1.1  knakahar 	KASSERT(mutex_owned(&msipic_list_lock));
    186  1.1  knakahar 
    187  1.1  knakahar 	if (devid < 0 || NUM_MSI_DEVS <= devid) {
    188  1.1  knakahar 		DPRINTF(("%s: invalid devid.\n", __func__));
    189  1.1  knakahar 		return;
    190  1.1  knakahar 	}
    191  1.1  knakahar 
    192  1.1  knakahar 	dev_seqs[devid].ds_using = false;
    193  1.1  knakahar 	/* Keep ds_* to reuse the same devid for the same device. */
    194  1.1  knakahar }
    195  1.1  knakahar 
    196  1.1  knakahar static struct pic *
    197  1.1  knakahar msipic_find_msi_pic_locked(int devid)
    198  1.1  knakahar {
    199  1.1  knakahar 	struct msipic *mpp;
    200  1.1  knakahar 
    201  1.1  knakahar 	KASSERT(mutex_owned(&msipic_list_lock));
    202  1.1  knakahar 
    203  1.1  knakahar 	LIST_FOREACH(mpp, &msipic_list, mp_list) {
    204  1.1  knakahar 		if(mpp->mp_devid == devid)
    205  1.1  knakahar 			return mpp->mp_pic;
    206  1.1  knakahar 	}
    207  1.1  knakahar 	return NULL;
    208  1.1  knakahar }
    209  1.1  knakahar 
    210  1.1  knakahar /*
    211  1.1  knakahar  * Return the msi_pic whose device is already registered.
    212  1.1  knakahar  * If the device is not registered yet, return NULL.
    213  1.1  knakahar  */
    214  1.1  knakahar struct pic *
    215  1.1  knakahar msipic_find_msi_pic(int devid)
    216  1.1  knakahar {
    217  1.1  knakahar 	struct pic *msipic;
    218  1.1  knakahar 
    219  1.1  knakahar 	mutex_enter(&msipic_list_lock);
    220  1.1  knakahar 	msipic = msipic_find_msi_pic_locked(devid);
    221  1.1  knakahar 	mutex_exit(&msipic_list_lock);
    222  1.1  knakahar 
    223  1.1  knakahar 	return msipic;
    224  1.1  knakahar }
    225  1.1  knakahar 
    226  1.1  knakahar /*
    227  1.1  knakahar  * A common construct process of MSI and MSI-X.
    228  1.1  knakahar  */
    229  1.1  knakahar static struct pic *
    230  1.1  knakahar msipic_construct_common_msi_pic(struct pci_attach_args *pa,
    231  1.1  knakahar     struct pic *pic_tmpl)
    232  1.1  knakahar {
    233  1.1  knakahar 	struct pic *pic;
    234  1.1  knakahar 	struct msipic *msipic;
    235  1.1  knakahar 	int devid;
    236  1.1  knakahar 
    237  1.1  knakahar 	pic = kmem_alloc(sizeof(*pic), KM_SLEEP);
    238  1.1  knakahar 	if (pic == NULL)
    239  1.1  knakahar 		return NULL;
    240  1.1  knakahar 
    241  1.1  knakahar 	msipic = kmem_zalloc(sizeof(*msipic), KM_SLEEP);
    242  1.1  knakahar 	if (msipic == NULL) {
    243  1.1  knakahar 		kmem_free(pic, sizeof(*pic));
    244  1.1  knakahar 		return NULL;
    245  1.1  knakahar 	}
    246  1.1  knakahar 
    247  1.1  knakahar 	mutex_enter(&msipic_list_lock);
    248  1.1  knakahar 
    249  1.1  knakahar 	devid = msipic_allocate_common_msi_devid(pa);
    250  1.1  knakahar 	if (devid == -1) {
    251  1.1  knakahar 		mutex_exit(&msipic_list_lock);
    252  1.1  knakahar 		kmem_free(pic, sizeof(*pic));
    253  1.1  knakahar 		kmem_free(msipic, sizeof(*msipic));
    254  1.1  knakahar 		return NULL;
    255  1.1  knakahar 	}
    256  1.1  knakahar 
    257  1.1  knakahar 	memcpy(pic, pic_tmpl, sizeof(*pic));
    258  1.1  knakahar 	pic->pic_msipic = msipic;
    259  1.1  knakahar 	msipic->mp_pic = pic;
    260  1.1  knakahar 	pci_decompose_tag(pa->pa_pc, pa->pa_tag,
    261  1.1  knakahar 	    &msipic->mp_bus, &msipic->mp_dev, &msipic->mp_fun);
    262  1.1  knakahar 	memcpy(&msipic->mp_pa, pa, sizeof(msipic->mp_pa));
    263  1.1  knakahar 	msipic->mp_devid = devid;
    264  1.1  knakahar 	/*
    265  1.1  knakahar 	 * pci_msi{,x}_alloc() must be called only once in the device driver.
    266  1.1  knakahar 	 */
    267  1.1  knakahar 	KASSERT(msipic_find_msi_pic_locked(msipic->mp_devid) == NULL);
    268  1.1  knakahar 
    269  1.1  knakahar 	LIST_INSERT_HEAD(&msipic_list, msipic, mp_list);
    270  1.1  knakahar 
    271  1.1  knakahar 	mutex_exit(&msipic_list_lock);
    272  1.1  knakahar 
    273  1.1  knakahar 	return pic;
    274  1.1  knakahar }
    275  1.1  knakahar 
    276  1.1  knakahar static void
    277  1.1  knakahar msipic_destruct_common_msi_pic(struct pic *msi_pic)
    278  1.1  knakahar {
    279  1.1  knakahar 	struct msipic *msipic;
    280  1.1  knakahar 
    281  1.1  knakahar 	if (msi_pic == NULL)
    282  1.1  knakahar 		return;
    283  1.1  knakahar 
    284  1.1  knakahar 	msipic = msi_pic->pic_msipic;
    285  1.1  knakahar 	mutex_enter(&msipic_list_lock);
    286  1.1  knakahar 	LIST_REMOVE(msipic, mp_list);
    287  1.1  knakahar 	msipic_release_common_msi_devid(msipic->mp_devid);
    288  1.1  knakahar 	mutex_exit(&msipic_list_lock);
    289  1.1  knakahar 
    290  1.1  knakahar 	kmem_free(msipic, sizeof(*msipic));
    291  1.1  knakahar 	kmem_free(msi_pic, sizeof(*msi_pic));
    292  1.1  knakahar }
    293  1.1  knakahar 
    294  1.1  knakahar /*
    295  1.1  knakahar  * The pic is MSI/MSI-X pic or not.
    296  1.1  knakahar  */
    297  1.1  knakahar bool
    298  1.1  knakahar msipic_is_msi_pic(struct pic *pic)
    299  1.1  knakahar {
    300  1.1  knakahar 
    301  1.1  knakahar 	return (pic->pic_msipic != NULL);
    302  1.1  knakahar }
    303  1.1  knakahar 
    304  1.1  knakahar /*
    305  1.1  knakahar  * Return the MSI/MSI-X devid which is unique for each devices.
    306  1.1  knakahar  */
    307  1.1  knakahar int
    308  1.1  knakahar msipic_get_devid(struct pic *pic)
    309  1.1  knakahar {
    310  1.1  knakahar 
    311  1.1  knakahar 	KASSERT(msipic_is_msi_pic(pic));
    312  1.1  knakahar 
    313  1.1  knakahar 	return pic->pic_msipic->mp_devid;
    314  1.1  knakahar }
    315  1.1  knakahar 
    316  1.1  knakahar #define MSI_MSICTL_ENABLE 1
    317  1.1  knakahar #define MSI_MSICTL_DISABLE 0
    318  1.1  knakahar static void
    319  1.1  knakahar msi_set_msictl_enablebit(struct pic *pic, int msi_vec, int flag)
    320  1.1  knakahar {
    321  1.1  knakahar 	pci_chipset_tag_t pc;
    322  1.1  knakahar 	struct pci_attach_args *pa;
    323  1.1  knakahar 	pcitag_t tag;
    324  1.1  knakahar 	pcireg_t ctl;
    325  1.3    martin 	int off, err __diagused;
    326  1.1  knakahar 
    327  1.1  knakahar 	pc = NULL;
    328  1.1  knakahar 	pa = &pic->pic_msipic->mp_pa;
    329  1.1  knakahar 	tag = pa->pa_tag;
    330  1.3    martin 	err = pci_get_capability(pc, tag, PCI_CAP_MSI, &off, NULL);
    331  1.3    martin 	KASSERT(err != 0);
    332  1.1  knakahar 
    333  1.1  knakahar 	/*
    334  1.1  knakahar 	 * MSI can establish only one vector at once.
    335  1.1  knakahar 	 * So, use whole device mask bit instead of a vector mask bit.
    336  1.1  knakahar 	 */
    337  1.1  knakahar 	ctl = pci_conf_read(pc, tag, off + PCI_MSI_CTL);
    338  1.1  knakahar 	if (flag == MSI_MSICTL_ENABLE)
    339  1.1  knakahar 		ctl |= PCI_MSI_CTL_MSI_ENABLE;
    340  1.1  knakahar 	else
    341  1.1  knakahar 		ctl &= ~PCI_MSI_CTL_MSI_ENABLE;
    342  1.1  knakahar 
    343  1.1  knakahar 	pci_conf_write(pc, tag, off, ctl);
    344  1.1  knakahar }
    345  1.1  knakahar 
    346  1.1  knakahar static void
    347  1.1  knakahar msi_hwmask(struct pic *pic, int msi_vec)
    348  1.1  knakahar {
    349  1.1  knakahar 
    350  1.1  knakahar 	msi_set_msictl_enablebit(pic, msi_vec, MSI_MSICTL_DISABLE);
    351  1.1  knakahar }
    352  1.1  knakahar 
    353  1.1  knakahar /*
    354  1.1  knakahar  * Do not use pic->hwunmask() immediately after pic->delroute().
    355  1.1  knakahar  * It is required to use pic->addroute() before pic->hwunmask().
    356  1.1  knakahar  */
    357  1.1  knakahar static void
    358  1.1  knakahar msi_hwunmask(struct pic *pic, int msi_vec)
    359  1.1  knakahar {
    360  1.1  knakahar 
    361  1.1  knakahar 	msi_set_msictl_enablebit(pic, msi_vec, MSI_MSICTL_ENABLE);
    362  1.1  knakahar }
    363  1.1  knakahar 
    364  1.1  knakahar static void
    365  1.1  knakahar msi_addroute(struct pic *pic, struct cpu_info *ci,
    366  1.1  knakahar 	     int unused, int idt_vec, int type)
    367  1.1  knakahar {
    368  1.1  knakahar 	pci_chipset_tag_t pc;
    369  1.1  knakahar 	struct pci_attach_args *pa;
    370  1.1  knakahar 	pcitag_t tag;
    371  1.1  knakahar 	pcireg_t addr, data, ctl;
    372  1.3    martin 	int off, err __diagused;
    373  1.1  knakahar 
    374  1.1  knakahar 	pc = NULL;
    375  1.1  knakahar 	pa = &pic->pic_msipic->mp_pa;
    376  1.1  knakahar 	tag = pa->pa_tag;
    377  1.3    martin 	err = pci_get_capability(pc, tag, PCI_CAP_MSI, &off, NULL);
    378  1.3    martin 	KASSERT(err != 0);
    379  1.1  knakahar 
    380  1.1  knakahar 	/*
    381  1.1  knakahar 	 * See Intel 64 and IA-32 Architectures Software Developer's Manual
    382  1.1  knakahar 	 * Volume 3 10.11 Message Signalled Interrupts.
    383  1.1  knakahar 	 */
    384  1.1  knakahar 	/*
    385  1.1  knakahar 	 * "cpuid" for MSI address is local APIC ID. In NetBSD, the ID is
    386  1.1  knakahar 	 * the same as ci->ci_cpuid.
    387  1.1  knakahar 	 */
    388  1.1  knakahar 	addr = LAPIC_MSIADDR_BASE | __SHIFTIN(ci->ci_cpuid,
    389  1.1  knakahar 	    LAPIC_MSIADDR_DSTID_MASK);
    390  1.1  knakahar 	/* If trigger mode is edge, it don't care level for trigger mode. */
    391  1.1  knakahar 	data = __SHIFTIN(idt_vec, LAPIC_MSIDATA_VECTOR_MASK)
    392  1.1  knakahar 		| LAPIC_MSIDATA_TRGMODE_EDGE | LAPIC_MSIDATA_DM_FIXED;
    393  1.1  knakahar 
    394  1.1  knakahar 	ctl = pci_conf_read(pc, tag, off + PCI_MSI_CTL);
    395  1.1  knakahar 	if (ctl & PCI_MSI_CTL_64BIT_ADDR) {
    396  1.1  knakahar 		pci_conf_write(pc, tag, off + PCI_MSI_MADDR64_LO, addr);
    397  1.1  knakahar 		pci_conf_write(pc, tag, off + PCI_MSI_MADDR64_HI, 0);
    398  1.1  knakahar 		pci_conf_write(pc, tag, off + PCI_MSI_MDATA64, data);
    399  1.1  knakahar 	} else {
    400  1.1  knakahar 		pci_conf_write(pc, tag, off + PCI_MSI_MADDR, addr);
    401  1.1  knakahar 		pci_conf_write(pc, tag, off + PCI_MSI_MDATA, data);
    402  1.1  knakahar 	}
    403  1.1  knakahar 	ctl |= PCI_MSI_CTL_MSI_ENABLE;
    404  1.1  knakahar 	pci_conf_write(pc, tag, off + PCI_MSI_CTL, ctl);
    405  1.1  knakahar }
    406  1.1  knakahar 
    407  1.1  knakahar /*
    408  1.1  knakahar  * Do not use pic->hwunmask() immediately after pic->delroute().
    409  1.1  knakahar  * It is required to use pic->addroute() before pic->hwunmask().
    410  1.1  knakahar  */
    411  1.1  knakahar static void
    412  1.1  knakahar msi_delroute(struct pic *pic, struct cpu_info *ci,
    413  1.1  knakahar 	     int msi_vec, int idt_vec, int type)
    414  1.1  knakahar {
    415  1.1  knakahar 
    416  1.1  knakahar 	msi_hwmask(pic, msi_vec);
    417  1.1  knakahar }
    418  1.1  knakahar 
    419  1.1  knakahar /*
    420  1.1  knakahar  * Template for MSI pic.
    421  1.1  knakahar  * .pic_msipic is set later in construct_msi_pic().
    422  1.1  knakahar  */
    423  1.1  knakahar static struct pic msi_pic_tmpl = {
    424  1.1  knakahar 	.pic_type = PIC_MSI,
    425  1.1  knakahar 	.pic_vecbase = 0,
    426  1.1  knakahar 	.pic_apicid = 0,
    427  1.1  knakahar 	.pic_lock = __SIMPLELOCK_UNLOCKED, /* not used for msi_pic */
    428  1.1  knakahar 	.pic_hwmask = msi_hwmask,
    429  1.1  knakahar 	.pic_hwunmask = msi_hwunmask,
    430  1.1  knakahar 	.pic_addroute = msi_addroute,
    431  1.1  knakahar 	.pic_delroute = msi_delroute,
    432  1.1  knakahar 	.pic_edge_stubs = ioapic_edge_stubs,
    433  1.1  knakahar 	.pic_ioapic = NULL,
    434  1.1  knakahar };
    435  1.1  knakahar 
    436  1.1  knakahar /*
    437  1.1  knakahar  * Create pseudo pic for a MSI device.
    438  1.1  knakahar  */
    439  1.1  knakahar struct pic *
    440  1.1  knakahar msipic_construct_msi_pic(struct pci_attach_args *pa)
    441  1.1  knakahar {
    442  1.1  knakahar 	struct pic *msi_pic;
    443  1.1  knakahar 	char pic_name_buf[MSIPICNAMEBUF];
    444  1.1  knakahar 
    445  1.1  knakahar 	msi_pic = msipic_construct_common_msi_pic(pa, &msi_pic_tmpl);
    446  1.1  knakahar 	if (msi_pic == NULL) {
    447  1.1  knakahar 		DPRINTF(("cannot allocate MSI pic.\n"));
    448  1.1  knakahar 		return NULL;
    449  1.1  knakahar 	}
    450  1.1  knakahar 
    451  1.1  knakahar 	memset(pic_name_buf, 0, MSIPICNAMEBUF);
    452  1.1  knakahar 	snprintf(pic_name_buf, MSIPICNAMEBUF, "msi%d",
    453  1.1  knakahar 	    msi_pic->pic_msipic->mp_devid);
    454  1.1  knakahar 	strncpy(msi_pic->pic_msipic->mp_pic_name, pic_name_buf,
    455  1.1  knakahar 	    MSIPICNAMEBUF - 1);
    456  1.1  knakahar 	msi_pic->pic_name = msi_pic->pic_msipic->mp_pic_name;
    457  1.1  knakahar 
    458  1.1  knakahar 	return msi_pic;
    459  1.1  knakahar }
    460  1.1  knakahar 
    461  1.1  knakahar /*
    462  1.1  knakahar  * Delete pseudo pic for a MSI device.
    463  1.1  knakahar  */
    464  1.1  knakahar void
    465  1.1  knakahar msipic_destruct_msi_pic(struct pic *msi_pic)
    466  1.1  knakahar {
    467  1.1  knakahar 
    468  1.1  knakahar 	msipic_destruct_common_msi_pic(msi_pic);
    469  1.1  knakahar }
    470  1.1  knakahar 
    471  1.1  knakahar #define MSIX_VECCTL_HWMASK 1
    472  1.1  knakahar #define MSIX_VECCTL_HWUNMASK 0
    473  1.1  knakahar static void
    474  1.1  knakahar msix_set_vecctl_mask(struct pic *pic, int msix_vec, int flag)
    475  1.1  knakahar {
    476  1.1  knakahar 	bus_space_tag_t bstag;
    477  1.1  knakahar 	bus_space_handle_t bshandle;
    478  1.1  knakahar 	uint64_t entry_base;
    479  1.1  knakahar 	uint32_t vecctl;
    480  1.1  knakahar 
    481  1.1  knakahar 	if (msix_vec < 0) {
    482  1.1  knakahar 		DPRINTF(("%s: invalid MSI-X table index, devid=%d vecid=%d",
    483  1.2  knakahar 			__func__, msipic_get_devid(pic), msix_vec));
    484  1.1  knakahar 		return;
    485  1.1  knakahar 	}
    486  1.1  knakahar 
    487  1.1  knakahar 	entry_base = PCI_MSIX_TABLE_ENTRY_SIZE * msix_vec;
    488  1.1  knakahar 
    489  1.1  knakahar 	bstag = pic->pic_msipic->mp_bstag;
    490  1.1  knakahar 	bshandle = pic->pic_msipic->mp_bshandle;
    491  1.1  knakahar 	vecctl = bus_space_read_4(bstag, bshandle,
    492  1.1  knakahar 	    entry_base + PCI_MSIX_TABLE_ENTRY_VECTCTL);
    493  1.1  knakahar 	if (flag == MSIX_VECCTL_HWMASK)
    494  1.1  knakahar 		vecctl |= PCI_MSIX_VECTCTL_HWMASK_MASK;
    495  1.1  knakahar 	else
    496  1.1  knakahar 		vecctl &= ~PCI_MSIX_VECTCTL_HWMASK_MASK;
    497  1.1  knakahar 
    498  1.1  knakahar 	bus_space_write_4(bstag, bshandle,
    499  1.1  knakahar 	    entry_base + PCI_MSIX_TABLE_ENTRY_VECTCTL, vecctl);
    500  1.1  knakahar 	BUS_SPACE_WRITE_FLUSH(bstag, bshandle);
    501  1.1  knakahar }
    502  1.1  knakahar 
    503  1.1  knakahar static void
    504  1.1  knakahar msix_hwmask(struct pic *pic, int msix_vec)
    505  1.1  knakahar {
    506  1.1  knakahar 
    507  1.1  knakahar 	msix_set_vecctl_mask(pic, msix_vec, MSIX_VECCTL_HWMASK);
    508  1.1  knakahar }
    509  1.1  knakahar 
    510  1.1  knakahar /*
    511  1.1  knakahar  * Do not use pic->hwunmask() immediately after pic->delroute().
    512  1.1  knakahar  * It is required to use pic->addroute() before pic->hwunmask().
    513  1.1  knakahar  */
    514  1.1  knakahar static void
    515  1.1  knakahar msix_hwunmask(struct pic *pic, int msix_vec)
    516  1.1  knakahar {
    517  1.1  knakahar 
    518  1.1  knakahar 	msix_set_vecctl_mask(pic, msix_vec, MSIX_VECCTL_HWUNMASK);
    519  1.1  knakahar }
    520  1.1  knakahar 
    521  1.1  knakahar static void
    522  1.1  knakahar msix_addroute(struct pic *pic, struct cpu_info *ci,
    523  1.1  knakahar 	     int msix_vec, int idt_vec, int type)
    524  1.1  knakahar {
    525  1.1  knakahar 	pci_chipset_tag_t pc;
    526  1.1  knakahar 	struct pci_attach_args *pa;
    527  1.1  knakahar 	pcitag_t tag;
    528  1.1  knakahar 	bus_space_tag_t bstag;
    529  1.1  knakahar 	bus_space_handle_t bshandle;
    530  1.1  knakahar 	uint64_t entry_base;
    531  1.1  knakahar 	pcireg_t addr, data, ctl;
    532  1.3    martin 	int off, err __diagused;
    533  1.1  knakahar 
    534  1.1  knakahar 	if (msix_vec < 0) {
    535  1.1  knakahar 		DPRINTF(("%s: invalid MSI-X table index, devid=%d vecid=%d",
    536  1.2  knakahar 			__func__, msipic_get_devid(pic), msix_vec));
    537  1.1  knakahar 		return;
    538  1.1  knakahar 	}
    539  1.1  knakahar 
    540  1.1  knakahar 	pa = &pic->pic_msipic->mp_pa;
    541  1.1  knakahar 	pc = pa->pa_pc;
    542  1.1  knakahar 	tag = pa->pa_tag;
    543  1.3    martin 	err = pci_get_capability(pc, tag, PCI_CAP_MSIX, &off, NULL);
    544  1.3    martin 	KASSERT(err != 0);
    545  1.1  knakahar 
    546  1.1  knakahar 	entry_base = PCI_MSIX_TABLE_ENTRY_SIZE * msix_vec;
    547  1.1  knakahar 
    548  1.1  knakahar 	/*
    549  1.1  knakahar 	 * See Intel 64 and IA-32 Architectures Software Developer's Manual
    550  1.1  knakahar 	 * Volume 3 10.11 Message Signalled Interrupts.
    551  1.1  knakahar 	 */
    552  1.1  knakahar 	/*
    553  1.1  knakahar 	 * "cpuid" for MSI-X address is local APIC ID. In NetBSD, the ID is
    554  1.1  knakahar 	 * the same as ci->ci_cpuid.
    555  1.1  knakahar 	 */
    556  1.1  knakahar 	addr = LAPIC_MSIADDR_BASE | __SHIFTIN(ci->ci_cpuid,
    557  1.1  knakahar 	    LAPIC_MSIADDR_DSTID_MASK);
    558  1.1  knakahar 	/* If trigger mode is edge, it don't care level for trigger mode. */
    559  1.1  knakahar 	data = __SHIFTIN(idt_vec, LAPIC_MSIDATA_VECTOR_MASK)
    560  1.1  knakahar 		| LAPIC_MSIDATA_TRGMODE_EDGE | LAPIC_MSIDATA_DM_FIXED;
    561  1.1  knakahar 
    562  1.1  knakahar 	bstag = pic->pic_msipic->mp_bstag;
    563  1.1  knakahar 	bshandle = pic->pic_msipic->mp_bshandle;
    564  1.1  knakahar 	bus_space_write_4(bstag, bshandle,
    565  1.1  knakahar 	    entry_base + PCI_MSIX_TABLE_ENTRY_ADDR_LO, addr);
    566  1.1  knakahar 	bus_space_write_4(bstag, bshandle,
    567  1.1  knakahar 	    entry_base + PCI_MSIX_TABLE_ENTRY_ADDR_HI, 0);
    568  1.1  knakahar 	bus_space_write_4(bstag, bshandle,
    569  1.1  knakahar 	    entry_base + PCI_MSIX_TABLE_ENTRY_DATA, data);
    570  1.1  knakahar 	bus_space_write_4(bstag, bshandle,
    571  1.1  knakahar 	    entry_base + PCI_MSIX_TABLE_ENTRY_VECTCTL, 0);
    572  1.1  knakahar 	BUS_SPACE_WRITE_FLUSH(bstag, bshandle);
    573  1.1  knakahar 
    574  1.1  knakahar 	ctl = pci_conf_read(pc, tag, off + PCI_MSIX_CTL);
    575  1.1  knakahar 	ctl |= PCI_MSIX_CTL_ENABLE;
    576  1.1  knakahar 	pci_conf_write(pc, tag, off + PCI_MSIX_CTL, ctl);
    577  1.1  knakahar }
    578  1.1  knakahar 
    579  1.1  knakahar /*
    580  1.1  knakahar  * Do not use pic->hwunmask() immediately after pic->delroute().
    581  1.1  knakahar  * It is required to use pic->addroute() before pic->hwunmask().
    582  1.1  knakahar  */
    583  1.1  knakahar static void
    584  1.1  knakahar msix_delroute(struct pic *pic, struct cpu_info *ci,
    585  1.1  knakahar 	     int msix_vec, int vec, int type)
    586  1.1  knakahar {
    587  1.1  knakahar 
    588  1.1  knakahar 	msix_hwmask(pic, msix_vec);
    589  1.1  knakahar }
    590  1.1  knakahar 
    591  1.1  knakahar /*
    592  1.1  knakahar  * Template for MSI-X pic.
    593  1.1  knakahar  * .pic_msipic is set later in construct_msix_pic().
    594  1.1  knakahar  */
    595  1.1  knakahar static struct pic msix_pic_tmpl = {
    596  1.1  knakahar 	.pic_type = PIC_MSIX,
    597  1.1  knakahar 	.pic_vecbase = 0,
    598  1.1  knakahar 	.pic_apicid = 0,
    599  1.1  knakahar 	.pic_lock = __SIMPLELOCK_UNLOCKED, /* not used for msix_pic */
    600  1.1  knakahar 	.pic_hwmask = msix_hwmask,
    601  1.1  knakahar 	.pic_hwunmask = msix_hwunmask,
    602  1.1  knakahar 	.pic_addroute = msix_addroute,
    603  1.1  knakahar 	.pic_delroute = msix_delroute,
    604  1.1  knakahar 	.pic_edge_stubs = ioapic_edge_stubs,
    605  1.1  knakahar };
    606  1.1  knakahar 
    607  1.1  knakahar struct pic *
    608  1.1  knakahar msipic_construct_msix_pic(struct pci_attach_args *pa)
    609  1.1  knakahar {
    610  1.1  knakahar 	struct pic *msix_pic;
    611  1.1  knakahar 	pci_chipset_tag_t pc;
    612  1.1  knakahar 	pcitag_t tag;
    613  1.1  knakahar 	pcireg_t tbl;
    614  1.1  knakahar 	bus_space_tag_t bstag;
    615  1.1  knakahar 	bus_space_handle_t bshandle;
    616  1.1  knakahar 	bus_size_t bssize;
    617  1.1  knakahar 	size_t table_size;
    618  1.1  knakahar 	uint32_t table_offset;
    619  1.1  knakahar 	u_int memtype;
    620  1.1  knakahar 	int bir, bar, err, off, table_nentry;
    621  1.1  knakahar 	char pic_name_buf[MSIPICNAMEBUF];
    622  1.1  knakahar 
    623  1.1  knakahar 	table_nentry = pci_msix_count(pa);
    624  1.1  knakahar 	if (table_nentry == 0) {
    625  1.1  knakahar 		DPRINTF(("MSI-X table entry is 0.\n"));
    626  1.1  knakahar 		return NULL;
    627  1.1  knakahar 	}
    628  1.1  knakahar 
    629  1.1  knakahar 	pc = pa->pa_pc;
    630  1.1  knakahar 	tag = pa->pa_tag;
    631  1.1  knakahar 	if (pci_get_capability(pc, tag, PCI_CAP_MSIX, &off, NULL) == 0) {
    632  1.1  knakahar 		DPRINTF(("%s: no msix capability", __func__));
    633  1.1  knakahar 		return NULL;
    634  1.1  knakahar 	}
    635  1.1  knakahar 
    636  1.1  knakahar 	msix_pic = msipic_construct_common_msi_pic(pa, &msix_pic_tmpl);
    637  1.1  knakahar 	if (msix_pic == NULL) {
    638  1.1  knakahar 		DPRINTF(("cannot allocate MSI-X pic.\n"));
    639  1.1  knakahar 		return NULL;
    640  1.1  knakahar 	}
    641  1.1  knakahar 
    642  1.1  knakahar 	memset(pic_name_buf, 0, MSIPICNAMEBUF);
    643  1.1  knakahar 	snprintf(pic_name_buf, MSIPICNAMEBUF, "msix%d",
    644  1.1  knakahar 	    msix_pic->pic_msipic->mp_devid);
    645  1.1  knakahar 	strncpy(msix_pic->pic_msipic->mp_pic_name, pic_name_buf,
    646  1.1  knakahar 	    MSIPICNAMEBUF - 1);
    647  1.1  knakahar 	msix_pic->pic_name = msix_pic->pic_msipic->mp_pic_name;
    648  1.1  knakahar 
    649  1.1  knakahar 	tbl = pci_conf_read(pc, tag, off + PCI_MSIX_TBLOFFSET);
    650  1.1  knakahar 	table_offset = tbl & PCI_MSIX_TBLOFFSET_MASK;
    651  1.1  knakahar 	bir = tbl & PCI_MSIX_PBABIR_MASK;
    652  1.1  knakahar 	switch(bir) {
    653  1.1  knakahar 	case 0:
    654  1.1  knakahar 		bar = PCI_BAR0;
    655  1.1  knakahar 		break;
    656  1.1  knakahar 	case 1:
    657  1.1  knakahar 		bar = PCI_BAR1;
    658  1.1  knakahar 		break;
    659  1.1  knakahar 	case 2:
    660  1.1  knakahar 		bar = PCI_BAR2;
    661  1.1  knakahar 		break;
    662  1.1  knakahar 	case 3:
    663  1.1  knakahar 		bar = PCI_BAR3;
    664  1.1  knakahar 		break;
    665  1.1  knakahar 	case 4:
    666  1.1  knakahar 		bar = PCI_BAR4;
    667  1.1  knakahar 		break;
    668  1.1  knakahar 	case 5:
    669  1.1  knakahar 		bar = PCI_BAR5;
    670  1.1  knakahar 		break;
    671  1.1  knakahar 	default:
    672  1.1  knakahar 		aprint_error("detect an illegal device! The device use reserved BIR values.\n");
    673  1.1  knakahar 		msipic_destruct_common_msi_pic(msix_pic);
    674  1.1  knakahar 		return NULL;
    675  1.1  knakahar 	}
    676  1.1  knakahar 	memtype = pci_mapreg_type(pc, tag, bar);
    677  1.1  knakahar 	 /*
    678  1.1  knakahar 	  * PCI_MSIX_TABLE_ENTRY_SIZE consists below
    679  1.1  knakahar 	  *     - Vector Control (32bit)
    680  1.1  knakahar 	  *     - Message Data (32bit)
    681  1.1  knakahar 	  *     - Message Upper Address (32bit)
    682  1.1  knakahar 	  *     - Message Lower Address (32bit)
    683  1.1  knakahar 	  */
    684  1.1  knakahar 	table_size = table_nentry * PCI_MSIX_TABLE_ENTRY_SIZE;
    685  1.1  knakahar 	err = pci_mapreg_submap(pa, bar, memtype, BUS_SPACE_MAP_LINEAR,
    686  1.1  knakahar 	    roundup(table_size, PAGE_SIZE), table_offset,
    687  1.1  knakahar 	    &bstag, &bshandle, NULL, &bssize);
    688  1.1  knakahar 	if (err) {
    689  1.1  knakahar 		DPRINTF(("cannot map msix table.\n"));
    690  1.1  knakahar 		msipic_destruct_common_msi_pic(msix_pic);
    691  1.1  knakahar 		return NULL;
    692  1.1  knakahar 	}
    693  1.1  knakahar 	msix_pic->pic_msipic->mp_bstag = bstag;
    694  1.1  knakahar 	msix_pic->pic_msipic->mp_bshandle = bshandle;
    695  1.1  knakahar 	msix_pic->pic_msipic->mp_bssize = bssize;
    696  1.1  knakahar 
    697  1.1  knakahar 	return msix_pic;
    698  1.1  knakahar }
    699  1.1  knakahar 
    700  1.1  knakahar /*
    701  1.1  knakahar  * Delete pseudo pic for a MSI-X device.
    702  1.1  knakahar  */
    703  1.1  knakahar void
    704  1.1  knakahar msipic_destruct_msix_pic(struct pic *msix_pic)
    705  1.1  knakahar {
    706  1.1  knakahar 	struct msipic *msipic;
    707  1.1  knakahar 
    708  1.1  knakahar 	KASSERT(msipic_is_msi_pic(msix_pic));
    709  1.1  knakahar 	KASSERT(msix_pic->pic_type == PIC_MSIX);
    710  1.1  knakahar 
    711  1.1  knakahar 	msipic = msix_pic->pic_msipic;
    712  1.1  knakahar 	bus_space_unmap(msipic->mp_bstag, msipic->mp_bshandle,
    713  1.1  knakahar 	    msipic->mp_bssize);
    714  1.1  knakahar 
    715  1.1  knakahar 	msipic_destruct_common_msi_pic(msix_pic);
    716  1.1  knakahar }
    717  1.1  knakahar 
    718  1.1  knakahar /*
    719  1.1  knakahar  * Set the number of MSI vectors for pseudo MSI pic.
    720  1.1  knakahar  */
    721  1.1  knakahar int
    722  1.1  knakahar msipic_set_msi_vectors(struct pic *msi_pic, pci_intr_handle_t *pihs,
    723  1.1  knakahar     int count)
    724  1.1  knakahar {
    725  1.1  knakahar 
    726  1.1  knakahar 	KASSERT(msipic_is_msi_pic(msi_pic));
    727  1.1  knakahar 
    728  1.1  knakahar 	msi_pic->pic_msipic->mp_veccnt = count;
    729  1.1  knakahar 	return 0;
    730  1.1  knakahar }
    731  1.1  knakahar 
    732  1.1  knakahar /*
    733  1.1  knakahar  * Initialize the system to use MSI/MSI-X.
    734  1.1  knakahar  */
    735  1.1  knakahar void
    736  1.1  knakahar msipic_init(void)
    737  1.1  knakahar {
    738  1.1  knakahar 
    739  1.1  knakahar 	mutex_init(&msipic_list_lock, MUTEX_DEFAULT, IPL_NONE);
    740  1.1  knakahar }
    741