2 * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice unmodified, this list of conditions, and the following
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include "opt_bus.h" /* XXX trim includes */
31 #include "opt_compat.h"
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/malloc.h>
36 #include <sys/module.h>
37 #include <sys/linker.h>
38 #include <sys/fcntl.h>
40 #include <sys/kernel.h>
42 #include <sys/queue.h>
43 #include <sys/types.h>
47 #include <vm/vm_extern.h>
50 #include <machine/bus.h>
52 #include <machine/resource.h>
54 #include <sys/pciio.h>
55 #include <dev/pci/pcireg.h>
56 #include <dev/pci/pcivar.h>
62 * This is the user interface to PCI configuration space.
65 static d_open_t pci_open;
66 static d_close_t pci_close;
67 static int pci_conf_match(struct pci_match_conf *matches, int num_matches,
68 struct pci_conf *match_buf);
69 static d_ioctl_t pci_ioctl;
71 struct cdevsw pcicdev = {
72 .d_version = D_VERSION,
73 .d_flags = D_NEEDGIANT,
81 pci_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
85 if (oflags & FWRITE) {
86 error = securelevel_gt(td->td_ucred, 0);
95 pci_close(struct cdev *dev, int flag, int devtype, struct thread *td)
101 * Match a single pci_conf structure against an array of pci_match_conf
102 * structures. The first argument, 'matches', is an array of num_matches
103 * pci_match_conf structures. match_buf is a pointer to the pci_conf
104 * structure that will be compared to every entry in the matches array.
105 * This function returns 1 on failure, 0 on success.
108 pci_conf_match(struct pci_match_conf *matches, int num_matches,
109 struct pci_conf *match_buf)
113 if ((matches == NULL) || (match_buf == NULL) || (num_matches <= 0))
116 for (i = 0; i < num_matches; i++) {
118 * I'm not sure why someone would do this...but...
120 if (matches[i].flags == PCI_GETCONF_NO_MATCH)
124 * Look at each of the match flags. If it's set, do the
125 * comparison. If the comparison fails, we don't have a
126 * match, go on to the next item if there is one.
128 if (((matches[i].flags & PCI_GETCONF_MATCH_DOMAIN) != 0)
129 && (match_buf->pc_sel.pc_domain !=
130 matches[i].pc_sel.pc_domain))
133 if (((matches[i].flags & PCI_GETCONF_MATCH_BUS) != 0)
134 && (match_buf->pc_sel.pc_bus != matches[i].pc_sel.pc_bus))
137 if (((matches[i].flags & PCI_GETCONF_MATCH_DEV) != 0)
138 && (match_buf->pc_sel.pc_dev != matches[i].pc_sel.pc_dev))
141 if (((matches[i].flags & PCI_GETCONF_MATCH_FUNC) != 0)
142 && (match_buf->pc_sel.pc_func != matches[i].pc_sel.pc_func))
145 if (((matches[i].flags & PCI_GETCONF_MATCH_VENDOR) != 0)
146 && (match_buf->pc_vendor != matches[i].pc_vendor))
149 if (((matches[i].flags & PCI_GETCONF_MATCH_DEVICE) != 0)
150 && (match_buf->pc_device != matches[i].pc_device))
153 if (((matches[i].flags & PCI_GETCONF_MATCH_CLASS) != 0)
154 && (match_buf->pc_class != matches[i].pc_class))
157 if (((matches[i].flags & PCI_GETCONF_MATCH_UNIT) != 0)
158 && (match_buf->pd_unit != matches[i].pd_unit))
161 if (((matches[i].flags & PCI_GETCONF_MATCH_NAME) != 0)
162 && (strncmp(matches[i].pd_name, match_buf->pd_name,
163 sizeof(match_buf->pd_name)) != 0))
172 #if defined(COMPAT_FREEBSD4) || defined(COMPAT_FREEBSD5) || \
173 defined(COMPAT_FREEBSD6)
177 PCI_GETCONF_NO_MATCH_OLD = 0x00,
178 PCI_GETCONF_MATCH_BUS_OLD = 0x01,
179 PCI_GETCONF_MATCH_DEV_OLD = 0x02,
180 PCI_GETCONF_MATCH_FUNC_OLD = 0x04,
181 PCI_GETCONF_MATCH_NAME_OLD = 0x08,
182 PCI_GETCONF_MATCH_UNIT_OLD = 0x10,
183 PCI_GETCONF_MATCH_VENDOR_OLD = 0x20,
184 PCI_GETCONF_MATCH_DEVICE_OLD = 0x40,
185 PCI_GETCONF_MATCH_CLASS_OLD = 0x80
186 } pci_getconf_flags_old;
189 u_int8_t pc_bus; /* bus number */
190 u_int8_t pc_dev; /* device on this bus */
191 u_int8_t pc_func; /* function on this device */
194 struct pci_conf_old {
195 struct pcisel_old pc_sel; /* bus+slot+function */
196 u_int8_t pc_hdr; /* PCI header type */
197 u_int16_t pc_subvendor; /* card vendor ID */
198 u_int16_t pc_subdevice; /* card device ID, assigned by
200 u_int16_t pc_vendor; /* chip vendor ID */
201 u_int16_t pc_device; /* chip device ID, assigned by
203 u_int8_t pc_class; /* chip PCI class */
204 u_int8_t pc_subclass; /* chip PCI subclass */
205 u_int8_t pc_progif; /* chip PCI programming interface */
206 u_int8_t pc_revid; /* chip revision ID */
207 char pd_name[PCI_MAXNAMELEN + 1]; /* device name */
208 u_long pd_unit; /* device unit number */
211 struct pci_match_conf_old {
212 struct pcisel_old pc_sel; /* bus+slot+function */
213 char pd_name[PCI_MAXNAMELEN + 1]; /* device name */
214 u_long pd_unit; /* Unit number */
215 u_int16_t pc_vendor; /* PCI Vendor ID */
216 u_int16_t pc_device; /* PCI Device ID */
217 u_int8_t pc_class; /* PCI class */
218 pci_getconf_flags_old flags; /* Matching expression */
222 struct pcisel_old pi_sel; /* device to operate on */
223 int pi_reg; /* configuration register to examine */
224 int pi_width; /* width (in bytes) of read or write */
225 u_int32_t pi_data; /* data to write or result of read */
228 #define PCIOCGETCONF_OLD _IOWR('p', 1, struct pci_conf_io)
229 #define PCIOCREAD_OLD _IOWR('p', 2, struct pci_io_old)
230 #define PCIOCWRITE_OLD _IOWR('p', 3, struct pci_io_old)
232 static int pci_conf_match_old(struct pci_match_conf_old *matches,
233 int num_matches, struct pci_conf *match_buf);
236 pci_conf_match_old(struct pci_match_conf_old *matches, int num_matches,
237 struct pci_conf *match_buf)
241 if ((matches == NULL) || (match_buf == NULL) || (num_matches <= 0))
244 for (i = 0; i < num_matches; i++) {
245 if (match_buf->pc_sel.pc_domain != 0)
249 * I'm not sure why someone would do this...but...
251 if (matches[i].flags == PCI_GETCONF_NO_MATCH_OLD)
255 * Look at each of the match flags. If it's set, do the
256 * comparison. If the comparison fails, we don't have a
257 * match, go on to the next item if there is one.
259 if (((matches[i].flags & PCI_GETCONF_MATCH_BUS_OLD) != 0)
260 && (match_buf->pc_sel.pc_bus != matches[i].pc_sel.pc_bus))
263 if (((matches[i].flags & PCI_GETCONF_MATCH_DEV_OLD) != 0)
264 && (match_buf->pc_sel.pc_dev != matches[i].pc_sel.pc_dev))
267 if (((matches[i].flags & PCI_GETCONF_MATCH_FUNC_OLD) != 0)
268 && (match_buf->pc_sel.pc_func != matches[i].pc_sel.pc_func))
271 if (((matches[i].flags & PCI_GETCONF_MATCH_VENDOR_OLD) != 0)
272 && (match_buf->pc_vendor != matches[i].pc_vendor))
275 if (((matches[i].flags & PCI_GETCONF_MATCH_DEVICE_OLD) != 0)
276 && (match_buf->pc_device != matches[i].pc_device))
279 if (((matches[i].flags & PCI_GETCONF_MATCH_CLASS_OLD) != 0)
280 && (match_buf->pc_class != matches[i].pc_class))
283 if (((matches[i].flags & PCI_GETCONF_MATCH_UNIT_OLD) != 0)
284 && (match_buf->pd_unit != matches[i].pd_unit))
287 if (((matches[i].flags & PCI_GETCONF_MATCH_NAME_OLD) != 0)
288 && (strncmp(matches[i].pd_name, match_buf->pd_name,
289 sizeof(match_buf->pd_name)) != 0))
301 pci_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, struct thread *td)
303 device_t pcidev, brdev;
306 struct devlist *devlist_head;
307 struct pci_conf_io *cio;
308 struct pci_devinfo *dinfo;
310 struct pci_bar_io *bio;
311 struct pci_match_conf *pattern_buf;
312 struct resource_list_entry *rle;
314 size_t confsz, iolen, pbufsz;
315 int error, ionum, i, num_patterns;
317 struct pci_conf_old conf_old;
318 struct pci_io iodata;
319 struct pci_io_old *io_old;
320 struct pci_match_conf_old *pattern_buf_old;
323 pattern_buf_old = NULL;
325 if (!(flag & FWRITE) && cmd != PCIOCGETBAR &&
326 cmd != PCIOCGETCONF && cmd != PCIOCGETCONF_OLD)
329 if (!(flag & FWRITE) && cmd != PCIOCGETBAR && cmd != PCIOCGETCONF)
335 case PCIOCGETCONF_OLD:
339 cio = (struct pci_conf_io *)data;
345 cio->num_matches = 0;
348 * If the user specified an offset into the device list,
349 * but the list has changed since they last called this
350 * ioctl, tell them that the list has changed. They will
351 * have to get the list from the beginning.
353 if ((cio->offset != 0)
354 && (cio->generation != pci_generation)){
355 cio->status = PCI_GETCONF_LIST_CHANGED;
361 * Check to see whether the user has asked for an offset
362 * past the end of our list.
364 if (cio->offset >= pci_numdevs) {
365 cio->status = PCI_GETCONF_LAST_DEVICE;
370 /* get the head of the device queue */
371 devlist_head = &pci_devq;
374 * Determine how much room we have for pci_conf structures.
375 * Round the user's buffer size down to the nearest
376 * multiple of sizeof(struct pci_conf) in case the user
377 * didn't specify a multiple of that size.
380 if (cmd == PCIOCGETCONF_OLD)
381 confsz = sizeof(struct pci_conf_old);
384 confsz = sizeof(struct pci_conf);
385 iolen = min(cio->match_buf_len - (cio->match_buf_len % confsz),
386 pci_numdevs * confsz);
389 * Since we know that iolen is a multiple of the size of
390 * the pciconf union, it's okay to do this.
392 ionum = iolen / confsz;
395 * If this test is true, the user wants the pci_conf
396 * structures returned to match the supplied entries.
398 if ((cio->num_patterns > 0) && (cio->num_patterns < pci_numdevs)
399 && (cio->pat_buf_len > 0)) {
401 * pat_buf_len needs to be:
402 * num_patterns * sizeof(struct pci_match_conf)
403 * While it is certainly possible the user just
404 * allocated a large buffer, but set the number of
405 * matches correctly, it is far more likely that
406 * their kernel doesn't match the userland utility
407 * they're using. It's also possible that the user
408 * forgot to initialize some variables. Yes, this
409 * may be overly picky, but I hazard to guess that
410 * it's far more likely to just catch folks that
411 * updated their kernel but not their userland.
414 if (cmd == PCIOCGETCONF_OLD)
415 pbufsz = sizeof(struct pci_match_conf_old);
418 pbufsz = sizeof(struct pci_match_conf);
419 if (cio->num_patterns * pbufsz != cio->pat_buf_len) {
420 /* The user made a mistake, return an error. */
421 cio->status = PCI_GETCONF_ERROR;
427 * Allocate a buffer to hold the patterns.
430 if (cmd == PCIOCGETCONF_OLD) {
431 pattern_buf_old = malloc(cio->pat_buf_len,
433 error = copyin(cio->patterns,
434 pattern_buf_old, cio->pat_buf_len);
438 pattern_buf = malloc(cio->pat_buf_len, M_TEMP,
440 error = copyin(cio->patterns, pattern_buf,
447 num_patterns = cio->num_patterns;
448 } else if ((cio->num_patterns > 0)
449 || (cio->pat_buf_len > 0)) {
451 * The user made a mistake, spit out an error.
453 cio->status = PCI_GETCONF_ERROR;
459 * Go through the list of devices and copy out the devices
460 * that match the user's criteria.
462 for (cio->num_matches = 0, error = 0, i = 0,
463 dinfo = STAILQ_FIRST(devlist_head);
464 (dinfo != NULL) && (cio->num_matches < ionum)
465 && (error == 0) && (i < pci_numdevs) && (dinfo != NULL);
466 dinfo = STAILQ_NEXT(dinfo, pci_links), i++) {
471 /* Populate pd_name and pd_unit */
474 name = device_get_name(dinfo->cfg.dev);
476 strncpy(dinfo->conf.pd_name, name,
477 sizeof(dinfo->conf.pd_name));
478 dinfo->conf.pd_name[PCI_MAXNAMELEN] = 0;
479 dinfo->conf.pd_unit =
480 device_get_unit(dinfo->cfg.dev);
482 dinfo->conf.pd_name[0] = '\0';
483 dinfo->conf.pd_unit = 0;
487 if ((cmd == PCIOCGETCONF_OLD &&
488 (pattern_buf_old == NULL ||
489 pci_conf_match_old(pattern_buf_old, num_patterns,
490 &dinfo->conf) == 0)) ||
491 (cmd == PCIOCGETCONF &&
492 (pattern_buf == NULL ||
493 pci_conf_match(pattern_buf, num_patterns,
494 &dinfo->conf) == 0))) {
496 if (pattern_buf == NULL ||
497 pci_conf_match(pattern_buf, num_patterns,
498 &dinfo->conf) == 0) {
501 * If we've filled up the user's buffer,
502 * break out at this point. Since we've
503 * got a match here, we'll pick right back
504 * up at the matching entry. We can also
505 * tell the user that there are more matches
508 if (cio->num_matches >= ionum)
512 if (cmd == PCIOCGETCONF_OLD) {
513 conf_old.pc_sel.pc_bus =
514 dinfo->conf.pc_sel.pc_bus;
515 conf_old.pc_sel.pc_dev =
516 dinfo->conf.pc_sel.pc_dev;
517 conf_old.pc_sel.pc_func =
518 dinfo->conf.pc_sel.pc_func;
519 conf_old.pc_hdr = dinfo->conf.pc_hdr;
520 conf_old.pc_subvendor =
521 dinfo->conf.pc_subvendor;
522 conf_old.pc_subdevice =
523 dinfo->conf.pc_subdevice;
525 dinfo->conf.pc_vendor;
527 dinfo->conf.pc_device;
529 dinfo->conf.pc_class;
530 conf_old.pc_subclass =
531 dinfo->conf.pc_subclass;
533 dinfo->conf.pc_progif;
535 dinfo->conf.pc_revid;
536 strncpy(conf_old.pd_name,
538 sizeof(conf_old.pd_name));
539 conf_old.pd_name[PCI_MAXNAMELEN] = 0;
542 confdata = &conf_old;
545 confdata = &dinfo->conf;
546 /* Only if we can copy it out do we count it. */
547 if (!(error = copyout(confdata,
548 (caddr_t)cio->matches +
549 confsz * cio->num_matches, confsz)))
555 * Set the pointer into the list, so if the user is getting
556 * n records at a time, where n < pci_numdevs,
561 * Set the generation, the user will need this if they make
562 * another ioctl call with offset != 0.
564 cio->generation = pci_generation;
567 * If this is the last device, inform the user so he won't
568 * bother asking for more devices. If dinfo isn't NULL, we
569 * know that there are more matches in the list because of
570 * the way the traversal is done.
573 cio->status = PCI_GETCONF_LAST_DEVICE;
575 cio->status = PCI_GETCONF_MORE_DEVS;
578 if (pattern_buf != NULL)
579 free(pattern_buf, M_TEMP);
581 if (pattern_buf_old != NULL)
582 free(pattern_buf_old, M_TEMP);
590 io_old = (struct pci_io_old *)data;
591 iodata.pi_sel.pc_domain = 0;
592 iodata.pi_sel.pc_bus = io_old->pi_sel.pc_bus;
593 iodata.pi_sel.pc_dev = io_old->pi_sel.pc_dev;
594 iodata.pi_sel.pc_func = io_old->pi_sel.pc_func;
595 iodata.pi_reg = io_old->pi_reg;
596 iodata.pi_width = io_old->pi_width;
597 iodata.pi_data = io_old->pi_data;
598 data = (caddr_t)&iodata;
603 io = (struct pci_io *)data;
604 switch(io->pi_width) {
608 /* Make sure register is not negative and aligned. */
609 if (io->pi_reg < 0 ||
610 io->pi_reg & (io->pi_width - 1)) {
615 * Assume that the user-level bus number is
616 * in fact the physical PCI bus number.
617 * Look up the grandparent, i.e. the bridge device,
618 * so that we can issue configuration space cycles.
620 pcidev = pci_find_dbsf(io->pi_sel.pc_domain,
621 io->pi_sel.pc_bus, io->pi_sel.pc_dev,
624 brdev = device_get_parent(
625 device_get_parent(pcidev));
628 if (cmd == PCIOCWRITE || cmd == PCIOCWRITE_OLD)
630 if (cmd == PCIOCWRITE)
632 PCIB_WRITE_CONFIG(brdev,
640 else if (cmd == PCIOCREAD_OLD)
642 PCIB_READ_CONFIG(brdev,
651 PCIB_READ_CONFIG(brdev,
659 #ifdef COMPAT_FREEBSD4
660 if (cmd == PCIOCREAD_OLD) {
661 io_old->pi_data = -1;
675 bio = (struct pci_bar_io *)data;
678 * Assume that the user-level bus number is
679 * in fact the physical PCI bus number.
681 pcidev = pci_find_dbsf(bio->pbi_sel.pc_domain,
682 bio->pbi_sel.pc_bus, bio->pbi_sel.pc_dev,
683 bio->pbi_sel.pc_func);
684 if (pcidev == NULL) {
688 dinfo = device_get_ivars(pcidev);
691 * Look for a resource list entry matching the requested BAR.
693 * XXX: This will not find BARs that are not initialized, but
696 rle = resource_list_find(&dinfo->resources, SYS_RES_MEMORY,
699 rle = resource_list_find(&dinfo->resources,
700 SYS_RES_IOPORT, bio->pbi_reg);
701 if (rle == NULL || rle->res == NULL) {
707 * Ok, we have a resource for this BAR. Read the lower
708 * 32 bits to get any flags.
710 value = pci_read_config(pcidev, bio->pbi_reg, 4);
711 if (PCI_BAR_MEM(value)) {
712 if (rle->type != SYS_RES_MEMORY) {
716 value &= ~PCIM_BAR_MEM_BASE;
718 if (rle->type != SYS_RES_IOPORT) {
722 value &= ~PCIM_BAR_IO_BASE;
724 bio->pbi_base = rman_get_start(rle->res) | value;
725 bio->pbi_length = rman_get_size(rle->res);
728 * Check the command register to determine if this BAR
731 value = pci_read_config(pcidev, PCIR_COMMAND, 2);
732 if (rle->type == SYS_RES_MEMORY)
733 bio->pbi_enabled = (value & PCIM_CMD_MEMEN) != 0;
735 bio->pbi_enabled = (value & PCIM_CMD_PORTEN) != 0;