xref: /illumos-gate/usr/src/uts/common/io/pciex/pcieb.h (revision 35a5a3587fd94b666239c157d3722745250ccbd7)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _SYS_PCIEB_H
27 #define	_SYS_PCIEB_H
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 #if defined(DEBUG)
34 #define	PCIEB_DEBUG pcieb_dbg
35 extern void pcieb_dbg(uint_t bit, dev_info_t *dip, char *fmt, ...);
36 #else /* DEBUG */
37 #define	PCIEB_DEBUG 0 &&
38 #endif /* DEBUG */
39 
40 typedef enum {	/* same sequence as pcieb_debug_sym[] */
41 	/*  0 */ DBG_ATTACH,
42 	/*  1 */ DBG_PWR,
43 	/*  2 */ DBG_INTR
44 } pcieb_debug_bit_t;
45 
46 /*
47  * Intel specific register offsets with bit definitions.
48  */
49 #define	PCIEB_PX_CAPABILITY_ID	0x44
50 #define	PCIEB_BRIDGE_CONF		0x40
51 
52 /*
53  * PCI/PCI-E Configuration register specific values.
54  */
55 #define	PX_PMODE	0x4000		/* PCI/PCIX Mode */
56 #define	PX_PFREQ_66	0x200		/* PCI clock frequency */
57 #define	PX_PFREQ_100	0x400
58 #define	PX_PFREQ_133	0x600
59 #define	PX_PMRE		0x80		/* Peer memory read enable */
60 
61 /*
62  * Downstream delayed transaction resource partitioning.
63  */
64 #define	PX_ODTP		0x40		/* Max. of two entries PX and PCI */
65 
66 /*
67  * Maximum upstream delayed transaction.
68  */
69 #define	PX_MDT_44	0x00
70 #define	PX_MDT_11	0x01
71 #define	PX_MDT_22	0x10
72 
73 #define	NUM_LOGICAL_SLOTS	32
74 #define	PCIEB_RANGE_LEN		2
75 #define	PCIEB_32BIT_IO		1
76 #define	PCIEB_32bit_MEM		1
77 #define	PCIEB_MEMGRAIN		0x100000
78 #define	PCIEB_IOGRAIN		0x1000
79 
80 #define	PCIEB_16bit_IOADDR(addr) ((uint16_t)(((uint8_t)(addr) & 0xF0) << 8))
81 #define	PCIEB_LADDR(lo, hi) (((uint16_t)(hi) << 16) | (uint16_t)(lo))
82 #define	PCIEB_32bit_MEMADDR(addr) (PCIEB_LADDR(0, ((uint16_t)(addr) & 0xFFF0)))
83 
84 typedef struct {
85 	dev_info_t		*pcieb_dip;
86 
87 	/* Interrupt support */
88 	ddi_intr_handle_t	*pcieb_htable;		/* Intr Handlers */
89 	int			pcieb_htable_size;	/* htable size */
90 	int			pcieb_intr_count;	/* Num of Intr */
91 	uint_t			pcieb_intr_priority;	/* Intr Priority */
92 	int			pcieb_intr_type;	/* (MSI | FIXED) */
93 	int			pcieb_isr_tab[4];	/* MSI source offset */
94 
95 	int			pcieb_init_flags;
96 	kmutex_t		pcieb_mutex;		/* Soft state mutex */
97 	kmutex_t		pcieb_intr_mutex;	/* Intr handler mutex */
98 	kmutex_t		pcieb_err_mutex;	/* Error mutex */
99 	kmutex_t		pcieb_peek_poke_mutex;  /* Peekpoke mutex */
100 
101 	/* FMA */
102 	boolean_t		pcieb_no_aer_msi;
103 	ddi_iblock_cookie_t	pcieb_fm_ibc;
104 } pcieb_devstate_t;
105 
106 /*
107  * soft state pointer
108  */
109 extern void *pcieb_state;
110 
111 /* soft state flags */
112 #define	PCIEB_SOFT_STATE_CLOSED		0x00
113 #define	PCIEB_SOFT_STATE_OPEN		0x01
114 #define	PCIEB_SOFT_STATE_OPEN_EXCL	0x02
115 
116 /* init flags */
117 #define	PCIEB_INIT_MUTEX		0x01
118 #define	PCIEB_INIT_HTABLE		0x02
119 #define	PCIEB_INIT_ALLOC		0x04
120 #define	PCIEB_INIT_HANDLER		0x08
121 #define	PCIEB_INIT_ENABLE		0x10
122 #define	PCIEB_INIT_BLOCK		0x20
123 #define	PCIEB_INIT_FM			0x40
124 
125 #define	PCIEB_INTR_SRC_UNKNOWN	0x0	/* must be 0 */
126 #define	PCIEB_INTR_SRC_HP	0x1
127 #define	PCIEB_INTR_SRC_PME	0x2
128 #define	PCIEB_INTR_SRC_AER	0x4
129 
130 /*
131  * Need to put vendor ids in a common file and not platform specific files
132  * as is done today. Until then putting this vendor id define here.
133  */
134 #define	NVIDIA_VENDOR_ID	0x10de	/* Nvidia Vendor Id */
135 
136 #ifdef	PCIEB_BCM
137 
138 /* Workaround for address space limitation in Broadcom 5714/5715 */
139 #define	PCIEB_ADDR_LIMIT_LO		0ull
140 #define	PCIEB_ADDR_LIMIT_HI		((1ull << 40) - 1)
141 
142 #endif	/* PCIEB_BCM */
143 
144 /*
145  * The following values are used to initialize the cache line size
146  * and latency timer registers for PCI, PCI-X and PCIe2PCI devices.
147  */
148 #define	PCIEB_CACHE_LINE_SIZE	0x10	/* 64 bytes in # of DWORDs */
149 #define	PCIEB_LATENCY_TIMER	0x40	/* 64 PCI cycles */
150 
151 extern void	pcieb_set_pci_perf_parameters(dev_info_t *dip,
152 		    ddi_acc_handle_t config_handle);
153 extern void	pcieb_plat_attach_workaround(dev_info_t *dip);
154 extern void 	pcieb_plat_intr_attach(pcieb_devstate_t *pcieb);
155 extern void 	pcieb_plat_initchild(dev_info_t *child);
156 extern void 	pcieb_plat_uninitchild(dev_info_t *child);
157 extern int	pcieb_plat_ctlops(dev_info_t *rdip, ddi_ctl_enum_t ctlop,
158     void *arg);
159 extern int 	pcieb_plat_pcishpc_probe(dev_info_t *dip,
160     ddi_acc_handle_t config_handle);
161 extern int	pcieb_plat_peekpoke(dev_info_t *dip, dev_info_t *rdip,
162     ddi_ctl_enum_t ctlop, void *arg, void *result);
163 extern int	pcieb_plat_intr_ops(dev_info_t *dip, dev_info_t *rdip,
164     ddi_intr_op_t intr_op, ddi_intr_handle_impl_t *hdlp, void *result);
165 extern boolean_t	pcieb_plat_msi_supported(dev_info_t *dip);
166 extern boolean_t	pcieb_plat_pwr_disable(dev_info_t *dip);
167 
168 #if defined(__i386) || defined(__amd64)
169 extern void	pcieb_intel_error_workaround(dev_info_t *dip);
170 extern void	pcieb_intel_serr_workaround(dev_info_t *dip, boolean_t mcheck);
171 extern void	pcieb_intel_rber_workaround(dev_info_t *dip);
172 extern void	pcieb_intel_sw_workaround(dev_info_t *dip);
173 extern void	pcieb_intel_mps_workaround(dev_info_t *dip);
174 extern void	pcieb_init_osc(dev_info_t *dip);
175 extern void	pcieb_peekpoke_cb(dev_info_t *, ddi_fm_error_t *);
176 extern int	pcishpc_init(dev_info_t *dip);
177 extern int	pcishpc_uninit(dev_info_t *dip);
178 extern int	pcishpc_intr(dev_info_t *dip);
179 #endif /* defined(__i386) || defined(__amd64) */
180 
181 #ifdef PX_PLX
182 extern void	pcieb_attach_plx_workarounds(pcieb_devstate_t *pcieb);
183 extern int	pcieb_init_plx_workarounds(pcieb_devstate_t *pcieb,
184     dev_info_t *child);
185 #endif /* PX_PLX */
186 
187 #ifdef	__cplusplus
188 }
189 #endif
190 
191 #endif	/* _SYS_PCIEB_H */
192