[ repository copy of sys/pci/pci_ioctl.h to sys/sys/pciio.h happened in the

background ]

Rename sys/pci/pci_ioctl.h to sys/sys/pciio.h to make it easier for
userland programs to use this interface.  Reformat the file, and add a
BSD-style copyright to it.

Add a new man page for pci(4).  The PCIOCGETCONF, PCIOCREAD, and PCIOCWRITE
ioctls are documented, but the PCIOCATTACHED ioctl is not documented
because it is not implemented.

Change includes of <pci/pci_ioctl.h> to <sys/pciio.h> or remove them
altogether.  In many cases, pci_ioctl.h was unused.

Reviewed by:	steve

1 files changed, 82 insertions, 95 deletions

diff --git a/sys/sys/pciio.h b/sys/sys/pciio.h
index d460846..0034799 100644
--- a/sys/sys/pciio.h
+++ b/sys/sys/pciio.h
@@ -1,122 +1,109 @@
-#ifndef _PCI_IOCTL_H
-#define	_PCI_IOCTL_H	1
+/*-
+ * Copyright (c) 1997, Stefan Esser <se@FreeBSD.ORG>
+ * Copyright (c) 1997, 1998, 1999, Kenneth D. Merry <ken@FreeBSD.ORG>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice unmodified, this list of conditions, and the following
+ *    disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ *	$FreeBSD$
+ *
+ */
 
-#include <sys/ioccom.h>
+#ifndef _SYS_PCIIO_H_
+#define	_SYS_PCIIO_H_
 
+#include <sys/ioccom.h>
 
-#define PCI_MAXNAMELEN	16	/* max no. of characters in a device name */
+#define PCI_MAXNAMELEN	16
 
 typedef enum {
-    PCI_GETCONF_LAST_DEVICE,
-    PCI_GETCONF_LIST_CHANGED,
-    PCI_GETCONF_MORE_DEVS,
-    PCI_GETCONF_ERROR
+	PCI_GETCONF_LAST_DEVICE,
+	PCI_GETCONF_LIST_CHANGED,
+	PCI_GETCONF_MORE_DEVS,
+	PCI_GETCONF_ERROR
 } pci_getconf_status;
 
 typedef enum {
-    PCI_GETCONF_NO_MATCH	= 0x00,
-    PCI_GETCONF_MATCH_BUS	= 0x01,
-    PCI_GETCONF_MATCH_DEV	= 0x02,
-    PCI_GETCONF_MATCH_FUNC	= 0x04,
-    PCI_GETCONF_MATCH_NAME	= 0x08,
-    PCI_GETCONF_MATCH_UNIT	= 0x10,
-    PCI_GETCONF_MATCH_VENDOR	= 0x20,
-    PCI_GETCONF_MATCH_DEVICE	= 0x40,
-    PCI_GETCONF_MATCH_CLASS	= 0x80
+	PCI_GETCONF_NO_MATCH		= 0x00,
+	PCI_GETCONF_MATCH_BUS		= 0x01,
+	PCI_GETCONF_MATCH_DEV		= 0x02,
+	PCI_GETCONF_MATCH_FUNC		= 0x04,
+	PCI_GETCONF_MATCH_NAME		= 0x08,
+	PCI_GETCONF_MATCH_UNIT		= 0x10,
+	PCI_GETCONF_MATCH_VENDOR	= 0x20,
+	PCI_GETCONF_MATCH_DEVICE	= 0x40,
+	PCI_GETCONF_MATCH_CLASS		= 0x80
 } pci_getconf_flags;
 
 struct pcisel {
-    u_int8_t		pc_bus;		/* bus number */
-    u_int8_t		pc_dev;		/* device on this bus */
-    u_int8_t		pc_func;	/* function on this device */
+	u_int8_t	pc_bus;		/* bus number */
+	u_int8_t	pc_dev;		/* device on this bus */
+	u_int8_t	pc_func;	/* function on this device */
 };
 
 struct	pci_conf {
-    struct pcisel	pc_sel;		/* bus+slot+function */
-    u_int8_t		pc_hdr;		/* PCI header type */
-    u_int16_t		pc_subvendor;	/* card vendor ID */
-    u_int16_t		pc_subdevice;	/* card device ID, assigned by 
+	struct pcisel	pc_sel;		/* bus+slot+function */
+	u_int8_t	pc_hdr;		/* PCI header type */
+	u_int16_t	pc_subvendor;	/* card vendor ID */
+	u_int16_t	pc_subdevice;	/* card device ID, assigned by 
 					   card vendor */
-    u_int16_t		pc_vendor;	/* chip vendor ID */
-    u_int16_t		pc_device;	/* chip device ID, assigned by 
+	u_int16_t	pc_vendor;	/* chip vendor ID */
+	u_int16_t	pc_device;	/* chip device ID, assigned by 
 					   chip vendor */
-    u_int8_t		pc_class;	/* chip PCI class */
-    u_int8_t		pc_subclass;	/* chip PCI subclass */
-    u_int8_t		pc_progif;	/* chip PCI programming interface */
-    u_int8_t		pc_revid;	/* chip revision ID */
-    char		pd_name[PCI_MAXNAMELEN + 1];  /* Name of peripheral 
-						         device */
-    u_long		pd_unit;	/* Unit number */
+	u_int8_t	pc_class;	/* chip PCI class */
+	u_int8_t	pc_subclass;	/* chip PCI subclass */
+	u_int8_t	pc_progif;	/* chip PCI programming interface */
+	u_int8_t	pc_revid;	/* chip revision ID */
+	char		pd_name[PCI_MAXNAMELEN + 1];  /* device name */
+	u_long		pd_unit;	/* device unit number */
 };
 
 struct pci_match_conf {
-    struct pcisel	pc_sel;		/* bus+slot+function */
-    char		pd_name[PCI_MAXNAMELEN + 1];  /* Name of peripheral 
-							 device */
-    u_long		pd_unit;	/* Unit number */
-    u_int16_t		pc_vendor;	/* PCI Vendor ID */
-    u_int16_t		pc_device;	/* PCI Device ID */
-    u_int8_t		pc_class;	/* PCI class */
-    pci_getconf_flags	flags;		/* Matching expression */
+	struct pcisel		pc_sel;		/* bus+slot+function */
+	char			pd_name[PCI_MAXNAMELEN + 1];  /* device name */
+	u_long			pd_unit;	/* Unit number */
+	u_int16_t		pc_vendor;	/* PCI Vendor ID */
+	u_int16_t		pc_device;	/* PCI Device ID */
+	u_int8_t		pc_class;	/* PCI class */
+	pci_getconf_flags	flags;		/* Matching expression */
 };
 
 struct	pci_conf_io {
-    u_int32_t		  pat_buf_len;	/* 
-					 * Length of buffer passed in from
-					 * user space.
-					 */
-    u_int32_t		  num_patterns; /* 
-					 * Number of pci_match_conf structures 
-					 * passed in by the user.
-					 */
-    struct pci_match_conf *patterns;	/*
-					 * Patterns passed in by the user.
-					 */
-    u_int32_t		  match_buf_len;/*
-					 * Length of match buffer passed
-					 * in by the user.
-					 */
-    u_int32_t		  num_matches;	/*
-					 * Number of matches returned by
-					 * the kernel.
-					 */
-    struct pci_conf	  *matches;	/*
-					 * PCI device matches returned by
-					 * the kernel.
-					 */
-    u_int32_t		  offset;	/*
-					 * Passed in by the user code to
-					 * indicate where the kernel should
-					 * start traversing the device list.
-					 * The value passed out by the kernel
-					 * points to the record immediately
-					 * after the last one returned.
-					 * i.e. this value may be passed back
-					 * unchanged by the user for a
-					 * subsequent call.
-					 */
-    u_int32_t		  generation;	/*
-					 * PCI configuration generation.
-					 * This only needs to be set if the
-					 * offset is set.  The kernel will
-					 * compare its current generation
-					 * number to the generation passed 
-					 * in by the user to determine
-					 * whether the PCI device list has 
-					 * changed since the user last
-					 * called the GETCONF ioctl.
-					 */
-    pci_getconf_status	  status;	/* 
-					 * Status passed back from the
-					 * kernel.
-					 */
+	u_int32_t		pat_buf_len;	/* pattern buffer length */
+	u_int32_t		num_patterns;	/* number of patterns */
+	struct pci_match_conf	*patterns;	/* pattern buffer */
+	u_int32_t		match_buf_len;	/* match buffer length */
+	u_int32_t		num_matches;	/* number of matches returned */
+	struct pci_conf		*matches;	/* match buffer */
+	u_int32_t		offset;		/* offset into device list */
+	u_int32_t		generation;	/* device list generation */
+	pci_getconf_status	status;		/* request status */
 };
 
 struct pci_io {
-    struct pcisel	pi_sel;		/* device to operate on */
-    int			pi_reg;		/* configuration register to examine */
-    int			pi_width;	/* width (in bytes) of read or write */
-    u_int32_t		pi_data;	/* data to write or result of read */
+	struct pcisel	pi_sel;		/* device to operate on */
+	int		pi_reg;		/* configuration register to examine */
+	int		pi_width;	/* width (in bytes) of read or write */
+	u_int32_t	pi_data;	/* data to write or result of read */
 };
 	
 
@@ -125,4 +112,4 @@ struct pci_io {
 #define	PCIOCWRITE	_IOWR('p', 3, struct pci_io)
 #define	PCIOCATTACHED	_IOWR('p', 4, struct pci_io)
 
-#endif /* _PCI_IOCTL_H */
+#endif /* !_SYS_PCIIO_H_ */