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_msiq px_msiq_t; 60 61 extern int px_lib_dev_init(dev_info_t *dip, devhandle_t *dev_hdl); 62 extern int px_lib_dev_fini(dev_info_t *dip); 63 extern int px_lib_map_vconfig(dev_info_t *dip, ddi_map_req_t *mp, 64 pci_config_offset_t off, pci_regspec_t *rp, caddr_t *addrp); 65 extern void px_lib_map_attr_check(ddi_map_req_t *mp); 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 #ifdef FMA 83 extern void px_fill_rc_status(px_fault_t *px_fault_p, 84 pciex_rc_error_regs_t *rc_status); 85 #endif 86 87 extern int px_lib_iommu_map(dev_info_t *dip, tsbid_t tsbid, pages_t pages, 88 io_attributes_t io_attributes, void *addr, size_t pfn_index, int flag); 89 extern int px_lib_iommu_demap(dev_info_t *dip, tsbid_t tsbid, pages_t pages); 90 extern int px_lib_iommu_getmap(dev_info_t *dip, tsbid_t tsbid, 91 io_attributes_t *attributes_p, r_addr_t *r_addr_p); 92 extern int px_lib_dma_bypass_rngchk(ddi_dma_attr_t *attrp, uint64_t *lo_p, 93 uint64_t *hi_p); 94 extern int px_lib_iommu_getbypass(dev_info_t *dip, r_addr_t ra, 95 io_attributes_t io_attributes, io_addr_t *io_addr_p); 96 extern int px_lib_dma_sync(dev_info_t *dip, dev_info_t *rdip, 97 ddi_dma_handle_t handle, off_t off, size_t len, uint_t cache_flags); 98 99 /* 100 * MSIQ Functions: 101 */ 102 extern int px_lib_msiq_init(dev_info_t *dip); 103 extern int px_lib_msiq_fini(dev_info_t *dip); 104 extern int px_lib_msiq_info(dev_info_t *dip, msiqid_t msiq_id, 105 r_addr_t *ra_p, uint_t *msiq_rec_cnt_p); 106 extern int px_lib_msiq_getvalid(dev_info_t *dip, msiqid_t msiq_id, 107 pci_msiq_valid_state_t *msiq_valid_state); 108 extern int px_lib_msiq_setvalid(dev_info_t *dip, msiqid_t msiq_id, 109 pci_msiq_valid_state_t msiq_valid_state); 110 extern int px_lib_msiq_getstate(dev_info_t *dip, msiqid_t msiq_id, 111 pci_msiq_state_t *msiq_state); 112 extern int px_lib_msiq_setstate(dev_info_t *dip, msiqid_t msiq_id, 113 pci_msiq_state_t msiq_state); 114 extern int px_lib_msiq_gethead(dev_info_t *dip, msiqid_t msiq_id, 115 msiqhead_t *msiq_head); 116 extern int px_lib_msiq_sethead(dev_info_t *dip, msiqid_t msiq_id, 117 msiqhead_t msiq_head); 118 extern int px_lib_msiq_gettail(dev_info_t *dip, msiqid_t msiq_id, 119 msiqtail_t *msiq_tail); 120 extern void px_lib_get_msiq_rec(dev_info_t *dip, px_msiq_t *msiq_p, 121 msiq_rec_t *msiq_rec_p); 122 123 /* 124 * MSI Functions: 125 */ 126 extern int px_lib_msi_init(dev_info_t *dip); 127 extern int px_lib_msi_getmsiq(dev_info_t *dip, msinum_t msi_num, 128 msiqid_t *msiq_id); 129 extern int px_lib_msi_setmsiq(dev_info_t *dip, msinum_t msi_num, 130 msiqid_t msiq_id, msi_type_t msitype); 131 extern int px_lib_msi_getvalid(dev_info_t *dip, msinum_t msi_num, 132 pci_msi_valid_state_t *msi_valid_state); 133 extern int px_lib_msi_setvalid(dev_info_t *dip, msinum_t msi_num, 134 pci_msi_valid_state_t msi_valid_state); 135 extern int px_lib_msi_getstate(dev_info_t *dip, msinum_t msi_num, 136 pci_msi_state_t *msi_state); 137 extern int px_lib_msi_setstate(dev_info_t *dip, msinum_t msi_num, 138 pci_msi_state_t msi_state); 139 140 /* 141 * MSG Functions: 142 */ 143 extern int px_lib_msg_getmsiq(dev_info_t *dip, pcie_msg_type_t msg_type, 144 msiqid_t *msiq_id); 145 extern int px_lib_msg_setmsiq(dev_info_t *dip, pcie_msg_type_t msg_type, 146 msiqid_t msiq_id); 147 extern int px_lib_msg_getvalid(dev_info_t *dip, pcie_msg_type_t msg_type, 148 pcie_msg_valid_state_t *msg_valid_state); 149 extern int px_lib_msg_setvalid(dev_info_t *dip, pcie_msg_type_t msg_type, 150 pcie_msg_valid_state_t msg_valid_state); 151 152 /* 153 * CPR Suspend/Resume Functions: 154 */ 155 extern int px_lib_suspend(dev_info_t *dip); 156 extern void px_lib_resume(dev_info_t *dip); 157 158 /* 159 * PCI tool Functions: 160 */ 161 extern int px_lib_tools_dev_reg_ops(dev_info_t *dip, void *arg, 162 int cmd, int mode); 163 extern int px_lib_tools_bus_reg_ops(dev_info_t *dip, void *arg, int cmd, 164 int mode); 165 extern int px_lib_tools_intr_admn(dev_info_t *dip, void *arg, int cmd, 166 int mode); 167 168 /* 169 * PPM interface 170 */ 171 extern int px_lib_pmctl(int cmd, px_t *px_p); 172 173 /* 174 * Misc Functions: 175 */ 176 extern uint64_t px_lib_get_cb(dev_info_t *dip); 177 extern void px_lib_set_cb(dev_info_t *dip, uint64_t val); 178 extern uint_t px_lup_softintr(caddr_t arg); 179 extern uint_t px_pmeq_intr(caddr_t arg); 180 181 /* 182 * Peek and poke access ddi_ctlops helper functions 183 */ 184 extern int px_lib_ctlops_poke(dev_info_t *dip, dev_info_t *rdip, 185 peekpoke_ctlops_t *in_args); 186 extern int px_lib_ctlops_peek(dev_info_t *dip, dev_info_t *rdip, 187 peekpoke_ctlops_t *in_args, void *result); 188 189 /* 190 * Error handling functions 191 */ 192 #define PX_INTR_PAYLOAD_SIZE 8 /* 64 bit words */ 193 typedef struct px_fault { 194 dev_info_t *px_fh_dip; 195 sysino_t px_fh_sysino; 196 uint_t (*px_err_func)(caddr_t px_fault); 197 devino_t px_intr_ino; 198 uint64_t px_intr_payload[PX_INTR_PAYLOAD_SIZE]; 199 } px_fault_t; 200 201 extern int px_err_add_intr(px_fault_t *px_fault_p); 202 extern void px_err_rem_intr(px_fault_t *px_fault_p); 203 extern uint32_t px_fab_get(px_t *px_p, pcie_req_id_t bdf, 204 uint16_t offset); 205 extern void px_fab_set(px_t *px_p, pcie_req_id_t bdf, uint16_t offset, 206 uint32_t val); 207 208 /* 209 * CPR callback 210 */ 211 extern void px_cpr_add_callb(px_t *); 212 extern void px_cpr_rem_callb(px_t *); 213 214 #ifdef __cplusplus 215 } 216 #endif 217 218 #endif /* _SYS_PX_LIB_H */ 219