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_LIB4U_H 27 #define _SYS_PX_LIB4U_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 #ifdef __cplusplus 32 extern "C" { 33 #endif 34 35 /* 36 * Errors returned. 37 */ 38 #define H_EOK 0 /* Successful return */ 39 #define H_ENOINTR 1 /* Invalid interrupt id */ 40 #define H_EINVAL 2 /* Invalid argument */ 41 #define H_ENOACCESS 3 /* No access to resource */ 42 #define H_EIO 4 /* I/O error */ 43 #define H_ENOTSUPPORTED 5 /* Function not supported */ 44 #define H_ENOMAP 6 /* Mapping is not valid, */ 45 /* no translation exists */ 46 47 /* 48 * Register base definitions. 49 * 50 * The specific numeric values for CSR, XBUS, Configuration, 51 * Interrupt blocks and other register bases. 52 */ 53 typedef enum { 54 PX_REG_CSR = 0, 55 PX_REG_XBC, 56 PX_REG_CFG, 57 PX_REG_IC, 58 PX_REG_MAX 59 } px_reg_bank_t; 60 61 /* 62 * Registers/state/variables that need to be saved and restored during 63 * suspend/resume. 64 * 65 * SUN4U px specific data structure. 66 */ 67 68 /* Control block soft state structure */ 69 typedef struct px_cb_list { 70 px_t *pxp; 71 struct px_cb_list *next; 72 } px_cb_list_t; 73 74 typedef struct px_cb { 75 px_cb_list_t *pxl; /* linked list px */ 76 kmutex_t cb_mutex; /* lock for CB */ 77 sysino_t sysino; /* proxy sysino */ 78 cpuid_t cpuid; /* proxy cpuid */ 79 int attachcnt; /* number of attached px */ 80 uint_t (*px_cb_func)(caddr_t); /* CB intr dispatcher */ 81 } px_cb_t; 82 83 typedef struct pxu { 84 uint32_t chip_id; 85 uint8_t portid; 86 uint16_t tsb_cookie; 87 uint32_t tsb_size; 88 uint64_t *tsb_vaddr; 89 uint64_t tsb_paddr; /* Only used for Oberon */ 90 91 void *msiq_mapped_p; 92 px_cb_t *px_cb_p; 93 94 /* Soft state for suspend/resume */ 95 uint64_t *pec_config_state; 96 uint64_t *mmu_config_state; 97 uint64_t *ib_intr_map; 98 uint64_t *ib_config_state; 99 uint64_t *xcb_config_state; 100 uint64_t *msiq_config_state; 101 102 /* sun4u specific vars */ 103 caddr_t px_address[4]; 104 ddi_acc_handle_t px_ac[4]; 105 106 /* PCItool */ 107 caddr_t pcitool_addr; 108 } pxu_t; 109 110 #define PX2CB(px_p) (((pxu_t *)px_p->px_plat_p)->px_cb_p) 111 112 /* 113 * Event Queue data structure. 114 */ 115 typedef struct eq_rec { 116 uint64_t eq_rec_rsvd0 : 1, /* DW 0 - 63 */ 117 eq_rec_fmt_type : 7, /* DW 0 - 62:56 */ 118 eq_rec_len : 10, /* DW 0 - 55:46 */ 119 eq_rec_addr0 : 14, /* DW 0 - 45:32 */ 120 eq_rec_rid : 16, /* DW 0 - 31:16 */ 121 eq_rec_data0 : 16; /* DW 0 - 15:00 */ 122 uint64_t eq_rec_addr1 : 48, /* DW 1 - 63:16 */ 123 eq_rec_data1 : 16; /* DW 1 - 15:0 */ 124 uint64_t eq_rec_rsvd[6]; /* DW 2-7 */ 125 } eq_rec_t; 126 127 /* 128 * EQ record type 129 * 130 * Upper 4 bits of eq_rec_fmt_type is used 131 * to identify the EQ record type. 132 */ 133 #define EQ_REC_MSG 0x6 /* MSG - 0x3X */ 134 #define EQ_REC_MSI32 0xB /* MSI32 - 0x58 */ 135 #define EQ_REC_MSI64 0xF /* MSI64 - 0x78 */ 136 137 /* EQ State */ 138 #define EQ_IDLE_STATE 0x1 /* IDLE */ 139 #define EQ_ACTIVE_STATE 0x2 /* ACTIVE */ 140 #define EQ_ERROR_STATE 0x4 /* ERROR */ 141 142 #define MMU_INVALID_TTE 0ull 143 #define MMU_TTE_VALID(tte) (((tte) & MMU_TTE_V) == MMU_TTE_V) 144 #define MMU_OBERON_PADDR_MASK 0x7fffffffffff 145 #define MMU_FIRE_PADDR_MASK 0x7ffffffffff 146 147 /* 148 * control register decoding 149 */ 150 /* tsb size: 0=1k 1=2k 2=4k 3=8k 4=16k 5=32k 6=64k 7=128k */ 151 #define MMU_CTL_TO_TSBSIZE(ctl) ((ctl) >> 16) 152 #define MMU_TSBSIZE_TO_TSBENTRIES(s) ((1 << (s)) << (13 - 3)) 153 154 /* 155 * For Fire mmu bypass addresses, bit 43 specifies cacheability. 156 */ 157 #define MMU_FIRE_BYPASS_NONCACHE (1ull << 43) 158 159 /* 160 * For Oberon mmu bypass addresses, bit 47 specifies cacheability. 161 */ 162 #define MMU_OBERON_BYPASS_NONCACHE (1ull << 47) 163 164 /* 165 * The following macros define the address ranges supported for DVMA 166 * and mmu bypass transfers. For Oberon, bit 63 is used for ordering. 167 */ 168 #define MMU_FIRE_BYPASS_BASE 0xFFFC000000000000ull 169 #define MMU_FIRE_BYPASS_END 0xFFFC01FFFFFFFFFFull 170 171 #define MMU_OBERON_BYPASS_BASE 0x7FFC000000000000ull 172 #define MMU_OBERON_BYPASS_END 0x7FFC01FFFFFFFFFFull 173 174 #define MMU_TSB_PA_MASK 0x7FFFFFFFE000 175 176 /* 177 * The following macros are for loading and unloading io tte 178 * entries. 179 */ 180 #define MMU_TTE_SIZE 8 181 #define MMU_TTE_V (1ull << 63) 182 #define MMU_TTE_W (1ull << 1) 183 #define MMU_TTE_RO (1ull << 62) /* Oberon Relaxed Ordering */ 184 185 #define INO_BITS 6 /* INO#s are 6 bits long */ 186 #define INO_MASK 0x3F /* INO#s mask */ 187 188 #define SYSINO_TO_DEVINO(sysino) (sysino & INO_MASK) 189 190 #define FIRE_IGN_MASK 0x1F /* IGN#s mask, 5 bits long for Fire */ 191 #define OBERON_IGN_MASK 0xFF /* IGN#s mask, 8 bits long for Oberon */ 192 193 #define ID_TO_IGN(chip, portid) ((portid) & ((chip) == PX_CHIP_OBERON ? \ 194 OBERON_IGN_MASK : FIRE_IGN_MASK)) 195 196 #define DEVINO_TO_SYSINO(portid, devino) \ 197 (((portid) << INO_BITS) | ((devino) & INO_MASK)) 198 199 /* Interrupt states */ 200 #define INTERRUPT_IDLE_STATE 0 201 #define INTERRUPT_RECEIVED_STATE 1 202 #define INTERRUPT_PENDING_STATE 3 203 204 /* 205 * Defines for link width and max packet size for ACKBAK Latency Threshold Timer 206 * and TxLink Replay Timer Latency Table array sizes 207 * Num Link Width Packet Size 208 * 0 1 128 209 * 1 4 256 210 * 2 8 512 211 * 3 16 1024 212 * 4 - 2048 213 * 5 - 4096 214 */ 215 #define LINK_WIDTH_ARR_SIZE 4 216 #define LINK_MAX_PKT_ARR_SIZE 6 217 218 /* 219 * Defines for registers which have multi-bit fields. 220 */ 221 #define TLU_LINK_CONTROL_ASPM_DISABLED 0x0 222 #define TLU_LINK_CONTROL_ASPM_L0S_EN 0x1 223 #define TLU_LINK_CONTROL_ASPM_L1_EN 0x2 224 #define TLU_LINK_CONTROL_ASPM_L0S_L1_EN 0x3 225 226 #define TLU_CONTROL_CONFIG_DEFAULT 0x1 227 #define TLU_CONTROL_L0S_TIM_DEFAULT 0xdaull 228 #define TLU_CONTROL_MPS_MASK 0x1C 229 #define TLU_CONTROL_MPS_SHIFT 2 230 231 #define LPU_TXLINK_REPLAY_NUMBER_STATUS_RPLAY_NUM_0 0x0 232 #define LPU_TXLINK_REPLAY_NUMBER_STATUS_RPLAY_NUM_1 0x1 233 #define LPU_TXLINK_REPLAY_NUMBER_STATUS_RPLAY_NUM_2 0x2 234 #define LPU_TXLINK_REPLAY_NUMBER_STATUS_RPLAY_NUM_3 0x3 235 236 #define LPU_TXLINK_RETRY_FIFO_POINTER_RTRY_FIFO_TLPTR_DEFAULT 0xFFFFull 237 #define LPU_TXLINK_RETRY_FIFO_POINTER_RTRY_FIFO_HDPTR_DEFAULT 0x0ull 238 239 #define LPU_TXLINK_SEQUENCE_COUNTER_ACK_SEQ_CNTR_DEFAULT 0xFFF 240 #define LPU_TXLINK_SEQUENCE_COUNTER_NXT_TX_SEQ_CNTR_DEFAULT 0x0 241 #define LPU_TXLINK_SEQUENCE_COUNT_FIFO_MAX_ADDR_SEQ_CNT_MAX_ADDR_DEF 0x157 242 243 #define LPU_TXLINK_SEQUENCE_COUNT_FIFO_POINTERS_SEQ_CNT_TLPTR_DEFAULT 0xFFF 244 #define LPU_TXLINK_SEQUENCE_COUNT_FIFO_POINTERS_SEQ_CNT_HDPTR_DEFAULT 0x0 245 246 #define LPU_LTSSM_CONFIG1_LTSSM_8_TO_DEFAULT 0x2 247 #define LPU_LTSSM_CONFIG1_LTSSM_20_TO_DEFAULT 0x5 248 #define LPU_LTSSM_CONFIG2_LTSSM_12_TO_DEFAULT 0x2DC6C0 249 #define LPU_LTSSM_CONFIG3_LTSSM_2_TO_DEFAULT 0x7A120 250 #define LPU_LTSSM_CONFIG4_DATA_RATE_DEFAULT 0x2 251 #define LPU_LTSSM_CONFIG4_N_FTS_DEFAULT 0x8c 252 253 /* LPU LTSSM states */ 254 #define LPU_LTSSM_L0 0x0 255 #define LPU_LTSSM_L1_IDLE 0x15 256 257 /* TLU Control register bits */ 258 #define TLU_REMAIN_DETECT_QUIET 8 259 260 /* PX BDF Shift in a Phyiscal Address - used FMA Fabric only */ 261 #define PX_PA_BDF_SHIFT 12 262 #define PX_BDF_TO_CFGADDR(bdf, offset) (((bdf) << PX_PA_BDF_SHIFT) + (offset)) 263 264 /* 265 * The sequence of the chip_type appearance is significant. 266 * There are code depending on it: PX_CHIP_TYPE(pxu_p) < PX_CHIP_FIRE. 267 */ 268 typedef enum { 269 PX_CHIP_UNIDENTIFIED = 0, 270 PX_CHIP_FIRE = 1, 271 PX_CHIP_OBERON = 2 272 } px_chip_id_t; 273 274 /* 275 * [msb] [lsb] 276 * 0x00 <chip_type> <version#> <module-revision#> 277 */ 278 #define PX_CHIP_ID(t, v, m) (((t) << 16) | ((v) << 8) | (m)) 279 #define PX_CHIP_TYPE(pxu_p) (((pxu_p)->chip_id) >> 16) 280 #define PX_CHIP_REV(pxu_p) (((pxu_p)->chip_id) & 0xFF) 281 #define PX_CHIP_VER(pxu_p) ((((pxu_p)->chip_id) >> 8) & 0xFF) 282 283 /* 284 * Fire hardware specific version definitions. 285 */ 286 #define FIRE_VER_10 PX_CHIP_ID(PX_CHIP_FIRE, 0x01, 0x00) 287 #define FIRE_VER_20 PX_CHIP_ID(PX_CHIP_FIRE, 0x03, 0x00) 288 #define OBERON_VER_10 PX_CHIP_ID(PX_CHIP_OBERON, 0x00, 0x00) 289 #define OBERON_RANGE_PROP_MASK 0x7fff 290 291 /* 292 * HW specific paddr mask. 293 */ 294 extern uint64_t px_paddr_mask; 295 296 extern void hvio_cb_init(caddr_t xbc_csr_base, pxu_t *pxu_p); 297 extern void hvio_ib_init(caddr_t csr_base, pxu_t *pxu_p); 298 extern void hvio_mmu_init(caddr_t csr_base, pxu_t *pxu_p); 299 extern void hvio_pec_init(caddr_t csr_base, pxu_t *pxu_p); 300 301 extern uint64_t hvio_intr_devino_to_sysino(devhandle_t dev_hdl, pxu_t *pxu_p, 302 devino_t devino, sysino_t *sysino); 303 extern uint64_t hvio_intr_getvalid(devhandle_t dev_hdl, sysino_t sysino, 304 intr_valid_state_t *intr_valid_state); 305 extern uint64_t hvio_intr_setvalid(devhandle_t dev_hdl, sysino_t sysino, 306 intr_valid_state_t intr_valid_state); 307 extern uint64_t hvio_intr_getstate(devhandle_t dev_hdl, sysino_t sysino, 308 intr_state_t *intr_state); 309 extern uint64_t hvio_intr_setstate(devhandle_t dev_hdl, sysino_t sysino, 310 intr_state_t intr_state); 311 extern uint64_t hvio_intr_gettarget(devhandle_t dev_hdl, pxu_t *pxu_p, 312 sysino_t sysino, cpuid_t *cpuid); 313 extern uint64_t hvio_intr_settarget(devhandle_t dev_hdl, pxu_t *pxu_p, 314 sysino_t sysino, cpuid_t cpuid); 315 316 extern uint64_t hvio_iommu_map(devhandle_t dev_hdl, pxu_t *pxu_p, tsbid_t tsbid, 317 pages_t pages, io_attributes_t attr, void *addr, size_t pfn_index, 318 int flags); 319 extern uint64_t hvio_iommu_demap(devhandle_t dev_hdl, pxu_t *pxu_p, 320 tsbid_t tsbid, pages_t pages); 321 extern uint64_t hvio_iommu_getmap(devhandle_t dev_hdl, pxu_t *pxu_p, 322 tsbid_t tsbid, io_attributes_t *attr_p, r_addr_t *r_addr_p); 323 extern uint64_t hvio_iommu_getbypass(devhandle_t dev_hdl, pxu_t *pxu_p, 324 r_addr_t ra, io_attributes_t attr, io_addr_t *io_addr_p); 325 extern uint64_t hvio_get_bypass_base(pxu_t *pxu_p); 326 extern uint64_t hvio_get_bypass_end(pxu_t *pxu_p); 327 extern uint64_t px_get_range_prop(px_t *px_p, px_ranges_t *rp, int bank); 328 329 330 /* 331 * MSIQ Functions: 332 */ 333 extern uint64_t hvio_msiq_init(devhandle_t dev_hdl, pxu_t *pxu_p); 334 extern uint64_t hvio_msiq_getvalid(devhandle_t dev_hdl, msiqid_t msiq_id, 335 pci_msiq_valid_state_t *msiq_valid_state); 336 extern uint64_t hvio_msiq_setvalid(devhandle_t dev_hdl, msiqid_t msiq_id, 337 pci_msiq_valid_state_t msiq_valid_state); 338 extern uint64_t hvio_msiq_getstate(devhandle_t dev_hdl, msiqid_t msiq_id, 339 pci_msiq_state_t *msiq_state); 340 extern uint64_t hvio_msiq_setstate(devhandle_t dev_hdl, msiqid_t msiq_id, 341 pci_msiq_state_t msiq_state); 342 extern uint64_t hvio_msiq_gethead(devhandle_t dev_hdl, msiqid_t msiq_id, 343 msiqhead_t *msiq_head); 344 extern uint64_t hvio_msiq_sethead(devhandle_t dev_hdl, msiqid_t msiq_id, 345 msiqhead_t msiq_head); 346 extern uint64_t hvio_msiq_gettail(devhandle_t dev_hdl, msiqid_t msiq_id, 347 msiqtail_t *msiq_tail); 348 349 /* 350 * MSI Functions: 351 */ 352 extern uint64_t hvio_msi_init(devhandle_t dev_hdl, uint64_t addr32, 353 uint64_t addr64); 354 extern uint64_t hvio_msi_getmsiq(devhandle_t dev_hdl, msinum_t msi_num, 355 msiqid_t *msiq_id); 356 extern uint64_t hvio_msi_setmsiq(devhandle_t dev_hdl, msinum_t msi_num, 357 msiqid_t msiq_id); 358 extern uint64_t hvio_msi_getvalid(devhandle_t dev_hdl, msinum_t msi_num, 359 pci_msi_valid_state_t *msi_valid_state); 360 extern uint64_t hvio_msi_setvalid(devhandle_t dev_hdl, msinum_t msi_num, 361 pci_msi_valid_state_t msi_valid_state); 362 extern uint64_t hvio_msi_getstate(devhandle_t dev_hdl, msinum_t msi_num, 363 pci_msi_state_t *msi_state); 364 extern uint64_t hvio_msi_setstate(devhandle_t dev_hdl, msinum_t msi_num, 365 pci_msi_state_t msi_state); 366 367 /* 368 * MSG Functions: 369 */ 370 extern uint64_t hvio_msg_getmsiq(devhandle_t dev_hdl, pcie_msg_type_t msg_type, 371 msiqid_t *msiq_id); 372 extern uint64_t hvio_msg_setmsiq(devhandle_t dev_hdl, pcie_msg_type_t msg_type, 373 msiqid_t msiq_id); 374 extern uint64_t hvio_msg_getvalid(devhandle_t dev_hdl, pcie_msg_type_t msg_type, 375 pcie_msg_valid_state_t *msg_valid_state); 376 extern uint64_t hvio_msg_setvalid(devhandle_t dev_hdl, pcie_msg_type_t msg_type, 377 pcie_msg_valid_state_t msg_valid_state); 378 379 /* 380 * Suspend/Resume Functions: 381 */ 382 extern uint64_t hvio_suspend(devhandle_t dev_hdl, pxu_t *pxu_p); 383 extern void hvio_resume(devhandle_t dev_hdl, 384 devino_t devino, pxu_t *pxu_p); 385 extern uint64_t hvio_cb_suspend(devhandle_t dev_hdl, pxu_t *pxu_p); 386 extern void hvio_cb_resume(devhandle_t pci_dev_hdl, devhandle_t xbus_dev_hdl, 387 devino_t devino, pxu_t *pxu_p); 388 extern int px_send_pme_turnoff(caddr_t csr_base); 389 extern int px_link_wait4l1idle(caddr_t csr_base); 390 extern int px_link_retrain(caddr_t csr_base); 391 extern void px_enable_detect_quiet(caddr_t csr_base); 392 393 extern void px_lib_clr_errs(px_t *px_p); 394 395 /* 396 * Hotplug functions: 397 */ 398 extern int hvio_hotplug_init(dev_info_t *dip, void *arg); 399 extern int hvio_hotplug_uninit(dev_info_t *dip); 400 401 #ifdef __cplusplus 402 } 403 #endif 404 405 #endif /* _SYS_PX_LIB4U_H */ 406