WebSVN – HelenOS – Diff – /uspace/trunk/pci/libpci/pci.h


/*
 *  The PCI Library
 *
 *  Copyright (c) 1997--2005 Martin Mares <mj@ucw.cz>
 *
 *  May 8, 2006 - Modified and ported to HelenOS by Jakub Jermar.
 *
 *  Can be freely distributed and used under the terms of the GNU GPL.
 */
 
#ifndef _PCI_LIB_H
#define _PCI_LIB_H
 
#include "header.h"
#include "types.h"
 
#define PCI_LIB_VERSION 0x020200
 
/*
 *  PCI Access Structure
 */
 
struct pci_methods;
 
enum pci_access_type {
    /* Known access methods, remember to update access.c as well */
    PCI_ACCESS_I386_TYPE1,  /* i386 ports, type 1 (params: none) */
    PCI_ACCESS_I386_TYPE2,  /* i386 ports, type 2 (params: none) */
    PCI_ACCESS_MAX
};
 
struct pci_access {
    /* Options you can change: */
    unsigned int method;    /* Access method */
    char *method_params[PCI_ACCESS_MAX];    /* Parameters for the methods */
    int writeable;      /* Open in read/write mode */
    int buscentric;     /* Bus-centric view of the world */
    int numeric_ids;    /* Don't resolve device IDs to names */
    int debugging;      /* Turn on debugging messages */
 
    /* Functions you can override: */
    void (*error) (char *msg, ...); /* Write error message and quit */
    void (*warning) (char *msg, ...);   /* Write a warning message */
    void (*debug) (char *msg, ...); /* Write a debugging message */
 
    struct pci_dev *devices;    /* Devices found on this bus */
 
    /* Fields used internally: */
    struct pci_methods *methods;
    struct id_entry **id_hash;  /* names.c */
    struct id_bucket *current_id_bucket;
 
 
 
 
};
 
/* Initialize PCI access */
struct pci_access *pci_alloc(void);
void pci_init(struct pci_access *);
void pci_cleanup(struct pci_access *);
 
/* Scanning of devices */
void pci_scan_bus(struct pci_access *acc);
struct pci_dev *pci_get_dev(struct pci_access *acc, int domain, int bus, int dev, int func);    /* Raw access to specified device */
void pci_free_dev(struct pci_dev *);
 
/*
 *  Devices
 */
 
struct pci_dev {
    struct pci_dev *next;   /* Next device in the chain */
    u16 domain;     /* PCI domain (host bridge) */
    u8 bus, dev, func;  /* Bus inside domain, device and function */
 
    /* These fields are set by pci_fill_info() */
    int known_fields;   /* Set of info fields already known */
    u16 vendor_id, device_id;   /* Identity of the device */
    int irq;        /* IRQ number */
    pciaddr_t base_addr[6]; /* Base addresses */
    pciaddr_t size[6];  /* Region sizes */
    pciaddr_t rom_base_addr;    /* Expansion ROM base address */
    pciaddr_t rom_size; /* Expansion ROM size */
 
    /* Fields used internally: */
    struct pci_access *access;
    struct pci_methods *methods;
    u8 *cache;      /* Cached config registers */
    int cache_len;
    int hdrtype;        /* Cached low 7 bits of header type, -1 if unknown */
    void *aux;      /* Auxillary data */
};
 
#define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
#define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
 
u8 pci_read_byte(struct pci_dev *, int pos);    /* Access to configuration space */
u16 pci_read_word(struct pci_dev *, int pos);
u32 pci_read_long(struct pci_dev *, int pos);
int pci_read_block(struct pci_dev *, int pos, u8 * buf, int len);
int pci_write_byte(struct pci_dev *, int pos, u8 data);
int pci_write_word(struct pci_dev *, int pos, u16 data);
int pci_write_long(struct pci_dev *, int pos, u32 data);
int pci_write_block(struct pci_dev *, int pos, u8 * buf, int len);
 
int pci_fill_info(struct pci_dev *, int flags); /* Fill in device information */
 
#define PCI_FILL_IDENT      1
#define PCI_FILL_IRQ        2
#define PCI_FILL_BASES      4
#define PCI_FILL_ROM_BASE   8
#define PCI_FILL_SIZES      16
#define PCI_FILL_RESCAN     0x10000
 
void pci_setup_cache(struct pci_dev *, u8 * cache, int len);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/*
 *  Conversion of PCI ID's to names (according to the pci.ids file)
 *
 *  Call pci_lookup_name() to identify different types of ID's:
 *
 *  VENDOR              (vendorID) -> vendor
 *  DEVICE              (vendorID, deviceID) -> device
 *  VENDOR | DEVICE         (vendorID, deviceID) -> combined vendor and device
 *  SUBSYSTEM | VENDOR      (subvendorID) -> subsystem vendor
 *  SUBSYSTEM | DEVICE      (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
 *  SUBSYSTEM | VENDOR | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
 *  SUBSYSTEM | ...         (-1, -1, subvendorID, subdevID) -> generic subsystem
 *  CLASS               (classID) -> class
 *  PROGIF              (classID, progif) -> programming interface
 */
 
char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags,
              ...);
 
int pci_load_name_list(struct pci_access *a);   /* Called automatically by pci_lookup_*() when needed; returns success */
void pci_free_name_list(struct pci_access *a);  /* Called automatically by pci_cleanup() */
 
enum pci_lookup_mode {
    PCI_LOOKUP_VENDOR = 1,  /* Vendor name (args: vendorID) */
    PCI_LOOKUP_DEVICE = 2,  /* Device name (args: vendorID, deviceID) */
    PCI_LOOKUP_CLASS = 4,   /* Device class (args: classID) */
    PCI_LOOKUP_SUBSYSTEM = 8,
    PCI_LOOKUP_PROGIF = 16, /* Programming interface (args: classID, prog_if) */
    PCI_LOOKUP_NUMERIC = 0x10000,   /* Want only formatted numbers; default if access->numeric_ids is set */
    PCI_LOOKUP_NO_NUMBERS = 0x20000 /* Return NULL if not found in the database; default is to print numerically */
};
 
#endif
 

Subversion Repositories HelenOS

(root)/uspace/trunk/pci/libpci/pci.h – Rev 1324 → 1343

Rev 1324		Rev 1343
1	/*	1	/*
2	* The PCI Library	2	* The PCI Library
3	*	3	*
4	* Copyright (c) 1997--2005 Martin Mares <mj@ucw.cz>	4	* Copyright (c) 1997--2005 Martin Mares <mj@ucw.cz>
5	*	5	*
6	* May 8, 2006 - Modified and ported to HelenOS by Jakub Jermar.	6	* May 8, 2006 - Modified and ported to HelenOS by Jakub Jermar.
7	*	7	*
8	* Can be freely distributed and used under the terms of the GNU GPL.	8	* Can be freely distributed and used under the terms of the GNU GPL.
9	*/	9	*/
10		10
11	#ifndef _PCI_LIB_H	11	#ifndef _PCI_LIB_H
12	#define _PCI_LIB_H	12	#define _PCI_LIB_H
13		13
14	#include "header.h"	14	#include "header.h"
15	#include "types.h"	15	#include "types.h"
16		16
17	#define PCI_LIB_VERSION 0x020200	17	#define PCI_LIB_VERSION 0x020200
18		18
19	/*	19	/*
20	* PCI Access Structure	20	* PCI Access Structure
21	*/	21	*/
22		22
23	struct pci_methods;	23	struct pci_methods;
24		24
25	enum pci_access_type {	25	enum pci_access_type {
26	/* Known access methods, remember to update access.c as well */	26	/* Known access methods, remember to update access.c as well */
27	PCI_ACCESS_I386_TYPE1, /* i386 ports, type 1 (params: none) */	27	PCI_ACCESS_I386_TYPE1, /* i386 ports, type 1 (params: none) */
28	PCI_ACCESS_I386_TYPE2, /* i386 ports, type 2 (params: none) */	28	PCI_ACCESS_I386_TYPE2, /* i386 ports, type 2 (params: none) */
29	PCI_ACCESS_MAX	29	PCI_ACCESS_MAX
30	};	30	};
31		31
32	struct pci_access {	32	struct pci_access {
33	/* Options you can change: */	33	/* Options you can change: */
34	unsigned int method; /* Access method */	34	unsigned int method; /* Access method */
35	char method_params[PCI_ACCESS_MAX]; / Parameters for the methods */	35	char method_params[PCI_ACCESS_MAX]; / Parameters for the methods */
36	int writeable; /* Open in read/write mode */	36	int writeable; /* Open in read/write mode */
37	int buscentric; /* Bus-centric view of the world */	37	int buscentric; /* Bus-centric view of the world */
38	int numeric_ids; /* Don't resolve device IDs to names */	38	int numeric_ids; /* Don't resolve device IDs to names */
39	int debugging; /* Turn on debugging messages */	39	int debugging; /* Turn on debugging messages */
40		40
41	/* Functions you can override: */	41	/* Functions you can override: */
42	void (error) (char msg, ...); /* Write error message and quit */	42	void (error) (char msg, ...); /* Write error message and quit */
43	void (warning) (char msg, ...); /* Write a warning message */	43	void (warning) (char msg, ...); /* Write a warning message */
44	void (debug) (char msg, ...); /* Write a debugging message */	44	void (debug) (char msg, ...); /* Write a debugging message */
45		45
46	struct pci_dev devices; / Devices found on this bus */	46	struct pci_dev devices; / Devices found on this bus */
47		47
48	/* Fields used internally: */	48	/* Fields used internally: */
49	struct pci_methods *methods;	49	struct pci_methods *methods;
50	struct id_entry *id_hash; / names.c */	50	struct id_entry *id_hash; / names.c */
51	struct id_bucket *current_id_bucket;	51	struct id_bucket *current_id_bucket;
52	int fd; /* proc: fd */	-
53	int fd_rw; /* proc: fd opened read-write */	-
54	struct pci_dev cached_dev; / proc: device the fd is for */	-
55	int fd_pos; /* proc: current position */	-
56	};	52	};
57		53
58	/* Initialize PCI access */	54	/* Initialize PCI access */
59	struct pci_access *pci_alloc(void);	55	struct pci_access *pci_alloc(void);
60	void pci_init(struct pci_access *);	56	void pci_init(struct pci_access *);
61	void pci_cleanup(struct pci_access *);	57	void pci_cleanup(struct pci_access *);
62		58
63	/* Scanning of devices */	59	/* Scanning of devices */
64	void pci_scan_bus(struct pci_access *acc);	60	void pci_scan_bus(struct pci_access *acc);
65	struct pci_dev pci_get_dev(struct pci_access acc, int domain, int bus, int dev, int func); /* Raw access to specified device */	61	struct pci_dev pci_get_dev(struct pci_access acc, int domain, int bus, int dev, int func); /* Raw access to specified device */
66	void pci_free_dev(struct pci_dev *);	62	void pci_free_dev(struct pci_dev *);
67		63
68	/*	64	/*
69	* Devices	65	* Devices
70	*/	66	*/
71		67
72	struct pci_dev {	68	struct pci_dev {
73	struct pci_dev next; / Next device in the chain */	69	struct pci_dev next; / Next device in the chain */
74	u16 domain; /* PCI domain (host bridge) */	70	u16 domain; /* PCI domain (host bridge) */
75	u8 bus, dev, func; /* Bus inside domain, device and function */	71	u8 bus, dev, func; /* Bus inside domain, device and function */
76		72
77	/* These fields are set by pci_fill_info() */	73	/* These fields are set by pci_fill_info() */
78	int known_fields; /* Set of info fields already known */	74	int known_fields; /* Set of info fields already known */
79	u16 vendor_id, device_id; /* Identity of the device */	75	u16 vendor_id, device_id; /* Identity of the device */
80	int irq; /* IRQ number */	76	int irq; /* IRQ number */
81	pciaddr_t base_addr[6]; /* Base addresses */	77	pciaddr_t base_addr[6]; /* Base addresses */
82	pciaddr_t size[6]; /* Region sizes */	78	pciaddr_t size[6]; /* Region sizes */
83	pciaddr_t rom_base_addr; /* Expansion ROM base address */	79	pciaddr_t rom_base_addr; /* Expansion ROM base address */
84	pciaddr_t rom_size; /* Expansion ROM size */	80	pciaddr_t rom_size; /* Expansion ROM size */
85		81
86	/* Fields used internally: */	82	/* Fields used internally: */
87	struct pci_access *access;	83	struct pci_access *access;
88	struct pci_methods *methods;	84	struct pci_methods *methods;
89	u8 cache; / Cached config registers */	85	u8 cache; / Cached config registers */
90	int cache_len;	86	int cache_len;
91	int hdrtype; /* Cached low 7 bits of header type, -1 if unknown */	87	int hdrtype; /* Cached low 7 bits of header type, -1 if unknown */
92	void aux; / Auxillary data */	88	void aux; / Auxillary data */
93	};	89	};
94		90
95	#define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)	91	#define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
96	#define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)	92	#define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
97		93
98	u8 pci_read_byte(struct pci_dev , int pos); / Access to configuration space */	94	u8 pci_read_byte(struct pci_dev , int pos); / Access to configuration space */
99	u16 pci_read_word(struct pci_dev *, int pos);	95	u16 pci_read_word(struct pci_dev *, int pos);
100	u32 pci_read_long(struct pci_dev *, int pos);	96	u32 pci_read_long(struct pci_dev *, int pos);
101	int pci_read_block(struct pci_dev , int pos, u8 buf, int len);	97	int pci_read_block(struct pci_dev , int pos, u8 buf, int len);
102	int pci_write_byte(struct pci_dev *, int pos, u8 data);	98	int pci_write_byte(struct pci_dev *, int pos, u8 data);
103	int pci_write_word(struct pci_dev *, int pos, u16 data);	99	int pci_write_word(struct pci_dev *, int pos, u16 data);
104	int pci_write_long(struct pci_dev *, int pos, u32 data);	100	int pci_write_long(struct pci_dev *, int pos, u32 data);
105	int pci_write_block(struct pci_dev , int pos, u8 buf, int len);	101	int pci_write_block(struct pci_dev , int pos, u8 buf, int len);
106		102
107	int pci_fill_info(struct pci_dev , int flags); / Fill in device information */	103	int pci_fill_info(struct pci_dev , int flags); / Fill in device information */
108		104
109	#define PCI_FILL_IDENT 1	105	#define PCI_FILL_IDENT 1
110	#define PCI_FILL_IRQ 2	106	#define PCI_FILL_IRQ 2
111	#define PCI_FILL_BASES 4	107	#define PCI_FILL_BASES 4
112	#define PCI_FILL_ROM_BASE 8	108	#define PCI_FILL_ROM_BASE 8
113	#define PCI_FILL_SIZES 16	109	#define PCI_FILL_SIZES 16
114	#define PCI_FILL_RESCAN 0x10000	110	#define PCI_FILL_RESCAN 0x10000
115		111
116	void pci_setup_cache(struct pci_dev , u8 cache, int len);	112	void pci_setup_cache(struct pci_dev , u8 cache, int len);
117		113
118	/*	-
119	* Filters	-
120	*/	-
121		-
122	struct pci_filter {	-
123	int domain, bus, slot, func; /* -1 = ANY */	-
124	int vendor, device;	-
125	};	-
126		-
127	void pci_filter_init(struct pci_access , struct pci_filter );	-
128	char pci_filter_parse_slot(struct pci_filter , char *);	-
129	char pci_filter_parse_id(struct pci_filter , char *);	-
130	int pci_filter_match(struct pci_filter , struct pci_dev );	-
131		-
132	/*	114	/*
133	* Conversion of PCI ID's to names (according to the pci.ids file)	115	* Conversion of PCI ID's to names (according to the pci.ids file)
134	*	116	*
135	* Call pci_lookup_name() to identify different types of ID's:	117	* Call pci_lookup_name() to identify different types of ID's:
136	*	118	*
137	* VENDOR (vendorID) -> vendor	119	* VENDOR (vendorID) -> vendor
138	* DEVICE (vendorID, deviceID) -> device	120	* DEVICE (vendorID, deviceID) -> device
139	* VENDOR \| DEVICE (vendorID, deviceID) -> combined vendor and device	121	* VENDOR \| DEVICE (vendorID, deviceID) -> combined vendor and device
140	* SUBSYSTEM \| VENDOR (subvendorID) -> subsystem vendor	122	* SUBSYSTEM \| VENDOR (subvendorID) -> subsystem vendor
141	* SUBSYSTEM \| DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device	123	* SUBSYSTEM \| DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
142	* SUBSYSTEM \| VENDOR \| DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d	124	* SUBSYSTEM \| VENDOR \| DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
143	* SUBSYSTEM \| ... (-1, -1, subvendorID, subdevID) -> generic subsystem	125	* SUBSYSTEM \| ... (-1, -1, subvendorID, subdevID) -> generic subsystem
144	* CLASS (classID) -> class	126	* CLASS (classID) -> class
145	* PROGIF (classID, progif) -> programming interface	127	* PROGIF (classID, progif) -> programming interface
146	*/	128	*/
147		129
148	char pci_lookup_name(struct pci_access a, char *buf, int size, int flags,	130	char pci_lookup_name(struct pci_access a, char *buf, int size, int flags,
149	...);	131	...);
150		132
151	int pci_load_name_list(struct pci_access a); / Called automatically by pci_lookup_() when needed; returns success /	133	int pci_load_name_list(struct pci_access a); / Called automatically by pci_lookup_() when needed; returns success /
152	void pci_free_name_list(struct pci_access a); / Called automatically by pci_cleanup() */	134	void pci_free_name_list(struct pci_access a); / Called automatically by pci_cleanup() */
153		135
154	enum pci_lookup_mode {	136	enum pci_lookup_mode {
155	PCI_LOOKUP_VENDOR = 1, /* Vendor name (args: vendorID) */	137	PCI_LOOKUP_VENDOR = 1, /* Vendor name (args: vendorID) */
156	PCI_LOOKUP_DEVICE = 2, /* Device name (args: vendorID, deviceID) */	138	PCI_LOOKUP_DEVICE = 2, /* Device name (args: vendorID, deviceID) */
157	PCI_LOOKUP_CLASS = 4, /* Device class (args: classID) */	139	PCI_LOOKUP_CLASS = 4, /* Device class (args: classID) */
158	PCI_LOOKUP_SUBSYSTEM = 8,	140	PCI_LOOKUP_SUBSYSTEM = 8,
159	PCI_LOOKUP_PROGIF = 16, /* Programming interface (args: classID, prog_if) */	141	PCI_LOOKUP_PROGIF = 16, /* Programming interface (args: classID, prog_if) */
160	PCI_LOOKUP_NUMERIC = 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */	142	PCI_LOOKUP_NUMERIC = 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */
161	PCI_LOOKUP_NO_NUMBERS = 0x20000 /* Return NULL if not found in the database; default is to print numerically */	143	PCI_LOOKUP_NO_NUMBERS = 0x20000 /* Return NULL if not found in the database; default is to print numerically */
162	};	144	};
163		145
164	#endif	146	#endif
165		147