xref: /titanic_44/usr/src/uts/sun4/io/px/px_lib.h (revision 7c478bd95313f5f23a4c958a745db2134aa03244)
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, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_SYS_PX_LIB_H
28 #define	_SYS_PX_LIB_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #ifdef	__cplusplus
33 extern "C" {
34 #endif
35 
36 /*
37  * Include all data structures and definitions in this file that are
38  * required between the common and hardware specific code.
39  */
40 
41 #define	DIP_TO_HANDLE(dip)	((px_t *)DIP_TO_STATE(dip))->px_dev_hdl
42 
43 /*
44  * The following macros define	the mmu page size and related operations.
45  */
46 #define	MMU_PAGE_SHIFT		13
47 #define	MMU_PAGE_SIZE		(1 << MMU_PAGE_SHIFT)
48 #define	MMU_PAGE_MASK		~(MMU_PAGE_SIZE - 1)
49 #define	MMU_PAGE_OFFSET		(MMU_PAGE_SIZE - 1)
50 #define	MMU_PTOB(x)		(((uint64_t)(x)) << MMU_PAGE_SHIFT)
51 #define	MMU_BTOP(x)		((x) >> MMU_PAGE_SHIFT)
52 #define	MMU_BTOPR(x)		MMU_BTOP((x) + MMU_PAGE_OFFSET)
53 
54 /* MMU map flags */
55 #define	MMU_MAP_MP		0
56 #define	MMU_MAP_BUF		1
57 
58 typedef struct px px_t;
59 typedef struct px_common px_common_t;
60 typedef struct px_msiq px_msiq_t;
61 
62 extern int px_lib_dev_init(dev_info_t *dip, devhandle_t *dev_hdl);
63 extern int px_lib_dev_fini(dev_info_t *dip);
64 extern int px_lib_map_vconfig(dev_info_t *dip, ddi_map_req_t *mp,
65     pci_config_offset_t off, pci_regspec_t *rp, caddr_t *addrp);
66 extern int px_lib_intr_devino_to_sysino(dev_info_t *dip, devino_t devino,
67     sysino_t *sysino);
68 extern int px_lib_intr_getvalid(dev_info_t *dip, sysino_t sysino,
69     intr_valid_state_t *intr_valid_state);
70 extern int px_lib_intr_setvalid(dev_info_t *dip, sysino_t sysino,
71     intr_valid_state_t intr_valid_state);
72 extern int px_lib_intr_getstate(dev_info_t *dip, sysino_t sysino,
73     intr_state_t *intr_state);
74 extern int px_lib_intr_setstate(dev_info_t *dip, sysino_t sysino,
75     intr_state_t intr_state);
76 extern int px_lib_intr_gettarget(dev_info_t *dip, sysino_t sysino,
77     cpuid_t *cpuid);
78 extern int px_lib_intr_settarget(dev_info_t *dip, sysino_t sysino,
79     cpuid_t cpuid);
80 extern int px_lib_intr_reset(dev_info_t *dip);
81 
82 extern int px_lib_iommu_map(dev_info_t *dip, tsbid_t tsbid, pages_t pages,
83     io_attributes_t io_attributes, void *addr, size_t pfn_index, int flag);
84 extern int px_lib_iommu_demap(dev_info_t *dip, tsbid_t tsbid, pages_t pages);
85 extern int px_lib_iommu_getmap(dev_info_t *dip, tsbid_t tsbid,
86     io_attributes_t *attributes_p, r_addr_t *r_addr_p);
87 extern int px_lib_dma_bypass_rngchk(ddi_dma_attr_t *attrp, uint64_t *lo_p,
88     uint64_t *hi_p);
89 extern int px_lib_iommu_getbypass(dev_info_t *dip, r_addr_t ra,
90     io_attributes_t io_attributes, io_addr_t *io_addr_p);
91 extern int px_lib_dma_sync(dev_info_t *dip, dev_info_t *rdip,
92     ddi_dma_handle_t handle, off_t off, size_t len, uint_t cache_flags);
93 
94 /*
95  * MSIQ Functions:
96  */
97 extern int px_lib_msiq_init(dev_info_t *dip);
98 extern int px_lib_msiq_fini(dev_info_t *dip);
99 extern int px_lib_msiq_info(dev_info_t *dip, msiqid_t msiq_id,
100     r_addr_t *ra_p, uint_t *msiq_rec_cnt_p);
101 extern int px_lib_msiq_getvalid(dev_info_t *dip, msiqid_t msiq_id,
102     pci_msiq_valid_state_t *msiq_valid_state);
103 extern int px_lib_msiq_setvalid(dev_info_t *dip, msiqid_t msiq_id,
104     pci_msiq_valid_state_t msiq_valid_state);
105 extern int px_lib_msiq_getstate(dev_info_t *dip, msiqid_t msiq_id,
106     pci_msiq_state_t *msiq_state);
107 extern int px_lib_msiq_setstate(dev_info_t *dip, msiqid_t msiq_id,
108     pci_msiq_state_t msiq_state);
109 extern int px_lib_msiq_gethead(dev_info_t *dip, msiqid_t msiq_id,
110     msiqhead_t *msiq_head);
111 extern int px_lib_msiq_sethead(dev_info_t *dip, msiqid_t msiq_id,
112     msiqhead_t msiq_head);
113 extern int px_lib_msiq_gettail(dev_info_t *dip, msiqid_t msiq_id,
114     msiqtail_t *msiq_tail);
115 extern void px_lib_get_msiq_rec(dev_info_t *dip, px_msiq_t *msiq_p,
116     msiq_rec_t *msiq_rec_p);
117 
118 /*
119  * MSI Functions:
120  */
121 extern int px_lib_msi_init(dev_info_t *dip);
122 extern int px_lib_msi_getmsiq(dev_info_t *dip, msinum_t msi_num,
123     msiqid_t *msiq_id);
124 extern int px_lib_msi_setmsiq(dev_info_t *dip, msinum_t msi_num,
125     msiqid_t msiq_id, msi_type_t msitype);
126 extern int px_lib_msi_getvalid(dev_info_t *dip, msinum_t msi_num,
127     pci_msi_valid_state_t *msi_valid_state);
128 extern int px_lib_msi_setvalid(dev_info_t *dip, msinum_t msi_num,
129     pci_msi_valid_state_t msi_valid_state);
130 extern int px_lib_msi_getstate(dev_info_t *dip, msinum_t msi_num,
131     pci_msi_state_t *msi_state);
132 extern int px_lib_msi_setstate(dev_info_t *dip, msinum_t msi_num,
133     pci_msi_state_t msi_state);
134 
135 /*
136  * MSG Functions:
137  */
138 extern int px_lib_msg_getmsiq(dev_info_t *dip, pcie_msg_type_t msg_type,
139     msiqid_t *msiq_id);
140 extern int px_lib_msg_setmsiq(dev_info_t *dip, pcie_msg_type_t msg_type,
141     msiqid_t msiq_id);
142 extern int px_lib_msg_getvalid(dev_info_t *dip, pcie_msg_type_t msg_type,
143     pcie_msg_valid_state_t *msg_valid_state);
144 extern int px_lib_msg_setvalid(dev_info_t *dip, pcie_msg_type_t msg_type,
145     pcie_msg_valid_state_t msg_valid_state);
146 
147 /*
148  * CPR Suspend/Resume Functions:
149  */
150 extern int px_lib_suspend(dev_info_t *dip);
151 extern void px_lib_resume(dev_info_t *dip);
152 
153 /*
154  * PCI tool Functions:
155  */
156 extern int px_lib_tools_dev_reg_ops(dev_info_t *dip, void *arg,
157     int cmd, int mode);
158 extern int px_lib_tools_bus_reg_ops(dev_info_t *dip, void *arg, int cmd,
159     int mode);
160 extern int px_lib_tools_intr_admn(dev_info_t *dip, void *arg, int cmd,
161     int mode);
162 
163 /*
164  * PPM interface
165  */
166 extern int px_lib_pmctl(int cmd, px_t *px_p);
167 
168 /*
169  * Misc Functions:
170  */
171 extern uint64_t px_lib_get_cb(caddr_t csr);
172 extern void px_lib_set_cb(caddr_t csr, uint64_t val);
173 
174 /*
175  * Peek and poke access ddi_ctlops helper functions
176  */
177 extern int px_lib_ctlops_poke(dev_info_t *dip, dev_info_t *rdip,
178     peekpoke_ctlops_t *in_args);
179 extern int px_lib_ctlops_peek(dev_info_t *dip, dev_info_t *rdip,
180     peekpoke_ctlops_t *in_args, void *result);
181 
182 #ifdef	__cplusplus
183 }
184 #endif
185 
186 #endif	/* _SYS_PX_LIB_H */
187