xref: /titanic_52/usr/src/uts/sun4/io/px/px_lib.h (revision 7aadd8d46c796a3216546b68c6a9d6de40f9d80d)
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 2006 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_PX_LIB_H
27 #define	_SYS_PX_LIB_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #ifdef	__cplusplus
32 extern "C" {
33 #endif
34 
35 /*
36  * Include all data structures and definitions in this file that are
37  * required between the common and hardware specific code.
38  */
39 
40 #define	DIP_TO_HANDLE(dip)	((px_t *)DIP_TO_STATE(dip))->px_dev_hdl
41 
42 /*
43  * The following macros define	the mmu page size and related operations.
44  */
45 #define	MMU_PAGE_SHIFT		13
46 #define	MMU_PAGE_SIZE		(1 << MMU_PAGE_SHIFT)
47 #define	MMU_PAGE_MASK		~(MMU_PAGE_SIZE - 1)
48 #define	MMU_PAGE_OFFSET		(MMU_PAGE_SIZE - 1)
49 #define	MMU_PTOB(x)		(((uint64_t)(x)) << MMU_PAGE_SHIFT)
50 #define	MMU_BTOP(x)		((x) >> MMU_PAGE_SHIFT)
51 #define	MMU_BTOPR(x)		MMU_BTOP((x) + MMU_PAGE_OFFSET)
52 
53 /* MMU map flags */
54 #define	MMU_MAP_MP		0
55 #define	MMU_MAP_BUF		1
56 
57 typedef struct px px_t;
58 typedef struct px_msiq px_msiq_t;
59 
60 extern int px_lib_dev_init(dev_info_t *dip, devhandle_t *dev_hdl);
61 extern int px_lib_dev_fini(dev_info_t *dip);
62 extern int px_lib_map_vconfig(dev_info_t *dip, ddi_map_req_t *mp,
63     pci_config_offset_t off, pci_regspec_t *rp, caddr_t *addrp);
64 extern void px_lib_map_attr_check(ddi_map_req_t *mp);
65 extern int px_lib_intr_devino_to_sysino(dev_info_t *dip, devino_t devino,
66     sysino_t *sysino);
67 extern int px_lib_intr_getvalid(dev_info_t *dip, sysino_t sysino,
68     intr_valid_state_t *intr_valid_state);
69 extern int px_lib_intr_setvalid(dev_info_t *dip, sysino_t sysino,
70     intr_valid_state_t intr_valid_state);
71 extern int px_lib_intr_getstate(dev_info_t *dip, sysino_t sysino,
72     intr_state_t *intr_state);
73 extern int px_lib_intr_setstate(dev_info_t *dip, sysino_t sysino,
74     intr_state_t intr_state);
75 extern int px_lib_intr_gettarget(dev_info_t *dip, sysino_t sysino,
76     cpuid_t *cpuid);
77 extern int px_lib_intr_settarget(dev_info_t *dip, sysino_t sysino,
78     cpuid_t cpuid);
79 extern int px_lib_intr_reset(dev_info_t *dip);
80 
81 #ifdef FMA
82 extern void px_fill_rc_status(px_fault_t *px_fault_p,
83     pciex_rc_error_regs_t *rc_status);
84 #endif
85 
86 extern int px_lib_iommu_map(dev_info_t *dip, tsbid_t tsbid, pages_t pages,
87     io_attributes_t io_attributes, void *addr, size_t pfn_index, int flag);
88 extern int px_lib_iommu_demap(dev_info_t *dip, tsbid_t tsbid, pages_t pages);
89 extern int px_lib_iommu_getmap(dev_info_t *dip, tsbid_t tsbid,
90     io_attributes_t *attributes_p, r_addr_t *r_addr_p);
91 extern int px_lib_dma_bypass_rngchk(ddi_dma_attr_t *attrp, uint64_t *lo_p,
92     uint64_t *hi_p);
93 extern int px_lib_iommu_getbypass(dev_info_t *dip, r_addr_t ra,
94     io_attributes_t io_attributes, io_addr_t *io_addr_p);
95 extern int px_lib_dma_sync(dev_info_t *dip, dev_info_t *rdip,
96     ddi_dma_handle_t handle, off_t off, size_t len, uint_t cache_flags);
97 
98 /*
99  * MSIQ Functions:
100  */
101 extern int px_lib_msiq_init(dev_info_t *dip);
102 extern int px_lib_msiq_fini(dev_info_t *dip);
103 extern int px_lib_msiq_info(dev_info_t *dip, msiqid_t msiq_id,
104     r_addr_t *ra_p, uint_t *msiq_rec_cnt_p);
105 extern int px_lib_msiq_getvalid(dev_info_t *dip, msiqid_t msiq_id,
106     pci_msiq_valid_state_t *msiq_valid_state);
107 extern int px_lib_msiq_setvalid(dev_info_t *dip, msiqid_t msiq_id,
108     pci_msiq_valid_state_t msiq_valid_state);
109 extern int px_lib_msiq_getstate(dev_info_t *dip, msiqid_t msiq_id,
110     pci_msiq_state_t *msiq_state);
111 extern int px_lib_msiq_setstate(dev_info_t *dip, msiqid_t msiq_id,
112     pci_msiq_state_t msiq_state);
113 extern int px_lib_msiq_gethead(dev_info_t *dip, msiqid_t msiq_id,
114     msiqhead_t *msiq_head);
115 extern int px_lib_msiq_sethead(dev_info_t *dip, msiqid_t msiq_id,
116     msiqhead_t msiq_head);
117 extern int px_lib_msiq_gettail(dev_info_t *dip, msiqid_t msiq_id,
118     msiqtail_t *msiq_tail);
119 extern void px_lib_get_msiq_rec(dev_info_t *dip, px_msiq_t *msiq_p,
120     msiq_rec_t *msiq_rec_p);
121 
122 /*
123  * MSI Functions:
124  */
125 extern int px_lib_msi_init(dev_info_t *dip);
126 extern int px_lib_msi_getmsiq(dev_info_t *dip, msinum_t msi_num,
127     msiqid_t *msiq_id);
128 extern int px_lib_msi_setmsiq(dev_info_t *dip, msinum_t msi_num,
129     msiqid_t msiq_id, msi_type_t msitype);
130 extern int px_lib_msi_getvalid(dev_info_t *dip, msinum_t msi_num,
131     pci_msi_valid_state_t *msi_valid_state);
132 extern int px_lib_msi_setvalid(dev_info_t *dip, msinum_t msi_num,
133     pci_msi_valid_state_t msi_valid_state);
134 extern int px_lib_msi_getstate(dev_info_t *dip, msinum_t msi_num,
135     pci_msi_state_t *msi_state);
136 extern int px_lib_msi_setstate(dev_info_t *dip, msinum_t msi_num,
137     pci_msi_state_t msi_state);
138 
139 /*
140  * MSG Functions:
141  */
142 extern int px_lib_msg_getmsiq(dev_info_t *dip, pcie_msg_type_t msg_type,
143     msiqid_t *msiq_id);
144 extern int px_lib_msg_setmsiq(dev_info_t *dip, pcie_msg_type_t msg_type,
145     msiqid_t msiq_id);
146 extern int px_lib_msg_getvalid(dev_info_t *dip, pcie_msg_type_t msg_type,
147     pcie_msg_valid_state_t *msg_valid_state);
148 extern int px_lib_msg_setvalid(dev_info_t *dip, pcie_msg_type_t msg_type,
149     pcie_msg_valid_state_t msg_valid_state);
150 
151 /*
152  * CPR Suspend/Resume Functions:
153  */
154 extern int px_lib_suspend(dev_info_t *dip);
155 extern void px_lib_resume(dev_info_t *dip);
156 
157 /*
158  * PCI tool Functions:
159  */
160 extern int px_lib_tools_dev_reg_ops(dev_info_t *dip, void *arg,
161     int cmd, int mode);
162 extern int px_lib_tools_bus_reg_ops(dev_info_t *dip, void *arg, int cmd,
163     int mode);
164 extern int px_lib_tools_intr_admn(dev_info_t *dip, void *arg, int cmd,
165     int mode);
166 
167 /*
168  * PPM interface
169  */
170 extern int px_lib_pmctl(int cmd, px_t *px_p);
171 
172 /*
173  * Misc Functions:
174  */
175 extern uint64_t px_lib_get_cb(dev_info_t *dip);
176 extern void px_lib_set_cb(dev_info_t *dip, uint64_t val);
177 extern uint_t px_pmeq_intr(caddr_t arg);
178 
179 /*
180  * Peek and poke access ddi_ctlops helper functions
181  */
182 extern int px_lib_ctlops_poke(dev_info_t *dip, dev_info_t *rdip,
183     peekpoke_ctlops_t *in_args);
184 extern int px_lib_ctlops_peek(dev_info_t *dip, dev_info_t *rdip,
185     peekpoke_ctlops_t *in_args, void *result);
186 
187 /*
188  * Error handling functions
189  */
190 #define	PX_INTR_PAYLOAD_SIZE	8	/* 64 bit words */
191 typedef struct px_fault {
192 	dev_info_t	*px_fh_dip;
193 	sysino_t	px_fh_sysino;
194 	uint_t		(*px_err_func)(caddr_t px_fault);
195 	devino_t	px_intr_ino;
196 	uint64_t	px_intr_payload[PX_INTR_PAYLOAD_SIZE];
197 } px_fault_t;
198 
199 extern int px_err_add_intr(px_fault_t *px_fault_p);
200 extern void px_err_rem_intr(px_fault_t *px_fault_p);
201 extern uint32_t px_fab_get(px_t *px_p, pcie_req_id_t bdf,
202     uint16_t offset);
203 extern void px_fab_set(px_t *px_p, pcie_req_id_t bdf, uint16_t offset,
204     uint32_t val);
205 
206 /*
207  * CPR callback
208  */
209 extern void px_cpr_add_callb(px_t *);
210 extern void px_cpr_rem_callb(px_t *);
211 
212 /*
213  * Hotplug functions
214  */
215 extern int px_lib_hotplug_init(dev_info_t *dip, void *regops);
216 extern void px_lib_hotplug_uninit(dev_info_t *dip);
217 
218 #ifdef	__cplusplus
219 }
220 #endif
221 
222 #endif	/* _SYS_PX_LIB_H */
223