1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Synopsys DesignWare PCIe host controller driver 4 * 5 * Copyright (C) 2013 Samsung Electronics Co., Ltd. 6 * https://www.samsung.com 7 * 8 * Author: Jingoo Han <jg1.han@samsung.com> 9 */ 10 11 #ifndef _PCIE_DESIGNWARE_H 12 #define _PCIE_DESIGNWARE_H 13 14 #include <linux/bitfield.h> 15 #include <linux/dma-mapping.h> 16 #include <linux/irq.h> 17 #include <linux/msi.h> 18 #include <linux/pci.h> 19 20 #include <linux/pci-epc.h> 21 #include <linux/pci-epf.h> 22 23 /* Parameters for the waiting for link up routine */ 24 #define LINK_WAIT_MAX_RETRIES 10 25 #define LINK_WAIT_USLEEP_MIN 90000 26 #define LINK_WAIT_USLEEP_MAX 100000 27 28 /* Parameters for the waiting for iATU enabled routine */ 29 #define LINK_WAIT_MAX_IATU_RETRIES 5 30 #define LINK_WAIT_IATU 9 31 32 /* Synopsys-specific PCIe configuration registers */ 33 #define PCIE_PORT_AFR 0x70C 34 #define PORT_AFR_N_FTS_MASK GENMASK(15, 8) 35 #define PORT_AFR_N_FTS(n) FIELD_PREP(PORT_AFR_N_FTS_MASK, n) 36 #define PORT_AFR_CC_N_FTS_MASK GENMASK(23, 16) 37 #define PORT_AFR_CC_N_FTS(n) FIELD_PREP(PORT_AFR_CC_N_FTS_MASK, n) 38 #define PORT_AFR_ENTER_ASPM BIT(30) 39 #define PORT_AFR_L0S_ENTRANCE_LAT_SHIFT 24 40 #define PORT_AFR_L0S_ENTRANCE_LAT_MASK GENMASK(26, 24) 41 #define PORT_AFR_L1_ENTRANCE_LAT_SHIFT 27 42 #define PORT_AFR_L1_ENTRANCE_LAT_MASK GENMASK(29, 27) 43 44 #define PCIE_PORT_LINK_CONTROL 0x710 45 #define PORT_LINK_DLL_LINK_EN BIT(5) 46 #define PORT_LINK_FAST_LINK_MODE BIT(7) 47 #define PORT_LINK_MODE_MASK GENMASK(21, 16) 48 #define PORT_LINK_MODE(n) FIELD_PREP(PORT_LINK_MODE_MASK, n) 49 #define PORT_LINK_MODE_1_LANES PORT_LINK_MODE(0x1) 50 #define PORT_LINK_MODE_2_LANES PORT_LINK_MODE(0x3) 51 #define PORT_LINK_MODE_4_LANES PORT_LINK_MODE(0x7) 52 #define PORT_LINK_MODE_8_LANES PORT_LINK_MODE(0xf) 53 54 #define PCIE_PORT_DEBUG0 0x728 55 #define PORT_LOGIC_LTSSM_STATE_MASK 0x1f 56 #define PORT_LOGIC_LTSSM_STATE_L0 0x11 57 #define PCIE_PORT_DEBUG1 0x72C 58 #define PCIE_PORT_DEBUG1_LINK_UP BIT(4) 59 #define PCIE_PORT_DEBUG1_LINK_IN_TRAINING BIT(29) 60 61 #define PCIE_LINK_WIDTH_SPEED_CONTROL 0x80C 62 #define PORT_LOGIC_N_FTS_MASK GENMASK(7, 0) 63 #define PORT_LOGIC_SPEED_CHANGE BIT(17) 64 #define PORT_LOGIC_LINK_WIDTH_MASK GENMASK(12, 8) 65 #define PORT_LOGIC_LINK_WIDTH(n) FIELD_PREP(PORT_LOGIC_LINK_WIDTH_MASK, n) 66 #define PORT_LOGIC_LINK_WIDTH_1_LANES PORT_LOGIC_LINK_WIDTH(0x1) 67 #define PORT_LOGIC_LINK_WIDTH_2_LANES PORT_LOGIC_LINK_WIDTH(0x2) 68 #define PORT_LOGIC_LINK_WIDTH_4_LANES PORT_LOGIC_LINK_WIDTH(0x4) 69 #define PORT_LOGIC_LINK_WIDTH_8_LANES PORT_LOGIC_LINK_WIDTH(0x8) 70 71 #define PCIE_MSI_ADDR_LO 0x820 72 #define PCIE_MSI_ADDR_HI 0x824 73 #define PCIE_MSI_INTR0_ENABLE 0x828 74 #define PCIE_MSI_INTR0_MASK 0x82C 75 #define PCIE_MSI_INTR0_STATUS 0x830 76 77 #define PCIE_PORT_MULTI_LANE_CTRL 0x8C0 78 #define PORT_MLTI_UPCFG_SUPPORT BIT(7) 79 80 #define PCIE_ATU_VIEWPORT 0x900 81 #define PCIE_ATU_REGION_INBOUND BIT(31) 82 #define PCIE_ATU_REGION_OUTBOUND 0 83 #define PCIE_ATU_REGION_INDEX2 0x2 84 #define PCIE_ATU_REGION_INDEX1 0x1 85 #define PCIE_ATU_REGION_INDEX0 0x0 86 #define PCIE_ATU_CR1 0x904 87 #define PCIE_ATU_TYPE_MEM 0x0 88 #define PCIE_ATU_TYPE_IO 0x2 89 #define PCIE_ATU_TYPE_CFG0 0x4 90 #define PCIE_ATU_TYPE_CFG1 0x5 91 #define PCIE_ATU_FUNC_NUM(pf) ((pf) << 20) 92 #define PCIE_ATU_CR2 0x908 93 #define PCIE_ATU_ENABLE BIT(31) 94 #define PCIE_ATU_BAR_MODE_ENABLE BIT(30) 95 #define PCIE_ATU_FUNC_NUM_MATCH_EN BIT(19) 96 #define PCIE_ATU_LOWER_BASE 0x90C 97 #define PCIE_ATU_UPPER_BASE 0x910 98 #define PCIE_ATU_LIMIT 0x914 99 #define PCIE_ATU_LOWER_TARGET 0x918 100 #define PCIE_ATU_BUS(x) FIELD_PREP(GENMASK(31, 24), x) 101 #define PCIE_ATU_DEV(x) FIELD_PREP(GENMASK(23, 19), x) 102 #define PCIE_ATU_FUNC(x) FIELD_PREP(GENMASK(18, 16), x) 103 #define PCIE_ATU_UPPER_TARGET 0x91C 104 105 #define PCIE_MISC_CONTROL_1_OFF 0x8BC 106 #define PCIE_DBI_RO_WR_EN BIT(0) 107 108 #define PCIE_MSIX_DOORBELL 0x948 109 #define PCIE_MSIX_DOORBELL_PF_SHIFT 24 110 111 #define PCIE_PL_CHK_REG_CONTROL_STATUS 0xB20 112 #define PCIE_PL_CHK_REG_CHK_REG_START BIT(0) 113 #define PCIE_PL_CHK_REG_CHK_REG_CONTINUOUS BIT(1) 114 #define PCIE_PL_CHK_REG_CHK_REG_COMPARISON_ERROR BIT(16) 115 #define PCIE_PL_CHK_REG_CHK_REG_LOGIC_ERROR BIT(17) 116 #define PCIE_PL_CHK_REG_CHK_REG_COMPLETE BIT(18) 117 118 #define PCIE_PL_CHK_REG_ERR_ADDR 0xB28 119 120 /* 121 * iATU Unroll-specific register definitions 122 * From 4.80 core version the address translation will be made by unroll 123 */ 124 #define PCIE_ATU_UNR_REGION_CTRL1 0x00 125 #define PCIE_ATU_UNR_REGION_CTRL2 0x04 126 #define PCIE_ATU_UNR_LOWER_BASE 0x08 127 #define PCIE_ATU_UNR_UPPER_BASE 0x0C 128 #define PCIE_ATU_UNR_LOWER_LIMIT 0x10 129 #define PCIE_ATU_UNR_LOWER_TARGET 0x14 130 #define PCIE_ATU_UNR_UPPER_TARGET 0x18 131 #define PCIE_ATU_UNR_UPPER_LIMIT 0x20 132 133 /* 134 * The default address offset between dbi_base and atu_base. Root controller 135 * drivers are not required to initialize atu_base if the offset matches this 136 * default; the driver core automatically derives atu_base from dbi_base using 137 * this offset, if atu_base not set. 138 */ 139 #define DEFAULT_DBI_ATU_OFFSET (0x3 << 20) 140 141 /* Register address builder */ 142 #define PCIE_GET_ATU_OUTB_UNR_REG_OFFSET(region) \ 143 ((region) << 9) 144 145 #define PCIE_GET_ATU_INB_UNR_REG_OFFSET(region) \ 146 (((region) << 9) | BIT(8)) 147 148 #define MAX_MSI_IRQS 256 149 #define MAX_MSI_IRQS_PER_CTRL 32 150 #define MAX_MSI_CTRLS (MAX_MSI_IRQS / MAX_MSI_IRQS_PER_CTRL) 151 #define MSI_REG_CTRL_BLOCK_SIZE 12 152 #define MSI_DEF_NUM_VECTORS 32 153 154 /* Maximum number of inbound/outbound iATUs */ 155 #define MAX_IATU_IN 256 156 #define MAX_IATU_OUT 256 157 158 struct pcie_port; 159 struct dw_pcie; 160 struct dw_pcie_ep; 161 162 enum dw_pcie_region_type { 163 DW_PCIE_REGION_UNKNOWN, 164 DW_PCIE_REGION_INBOUND, 165 DW_PCIE_REGION_OUTBOUND, 166 }; 167 168 enum dw_pcie_device_mode { 169 DW_PCIE_UNKNOWN_TYPE, 170 DW_PCIE_EP_TYPE, 171 DW_PCIE_LEG_EP_TYPE, 172 DW_PCIE_RC_TYPE, 173 }; 174 175 struct dw_pcie_host_ops { 176 int (*host_init)(struct pcie_port *pp); 177 void (*set_num_vectors)(struct pcie_port *pp); 178 int (*msi_host_init)(struct pcie_port *pp); 179 }; 180 181 struct pcie_port { 182 u64 cfg0_base; 183 void __iomem *va_cfg0_base; 184 u32 cfg0_size; 185 resource_size_t io_base; 186 phys_addr_t io_bus_addr; 187 u32 io_size; 188 int irq; 189 const struct dw_pcie_host_ops *ops; 190 int msi_irq; 191 struct irq_domain *irq_domain; 192 struct irq_domain *msi_domain; 193 u16 msi_msg; 194 dma_addr_t msi_data; 195 struct irq_chip *msi_irq_chip; 196 u32 num_vectors; 197 u32 irq_mask[MAX_MSI_CTRLS]; 198 struct pci_host_bridge *bridge; 199 raw_spinlock_t lock; 200 DECLARE_BITMAP(msi_irq_in_use, MAX_MSI_IRQS); 201 }; 202 203 enum dw_pcie_as_type { 204 DW_PCIE_AS_UNKNOWN, 205 DW_PCIE_AS_MEM, 206 DW_PCIE_AS_IO, 207 }; 208 209 struct dw_pcie_ep_ops { 210 void (*ep_init)(struct dw_pcie_ep *ep); 211 int (*raise_irq)(struct dw_pcie_ep *ep, u8 func_no, 212 enum pci_epc_irq_type type, u16 interrupt_num); 213 const struct pci_epc_features* (*get_features)(struct dw_pcie_ep *ep); 214 /* 215 * Provide a method to implement the different func config space 216 * access for different platform, if different func have different 217 * offset, return the offset of func. if use write a register way 218 * return a 0, and implement code in callback function of platform 219 * driver. 220 */ 221 unsigned int (*func_conf_select)(struct dw_pcie_ep *ep, u8 func_no); 222 }; 223 224 struct dw_pcie_ep_func { 225 struct list_head list; 226 u8 func_no; 227 u8 msi_cap; /* MSI capability offset */ 228 u8 msix_cap; /* MSI-X capability offset */ 229 }; 230 231 struct dw_pcie_ep { 232 struct pci_epc *epc; 233 struct list_head func_list; 234 const struct dw_pcie_ep_ops *ops; 235 phys_addr_t phys_base; 236 size_t addr_size; 237 size_t page_size; 238 u8 bar_to_atu[PCI_STD_NUM_BARS]; 239 phys_addr_t *outbound_addr; 240 unsigned long *ib_window_map; 241 unsigned long *ob_window_map; 242 u32 num_ib_windows; 243 u32 num_ob_windows; 244 void __iomem *msi_mem; 245 phys_addr_t msi_mem_phys; 246 struct pci_epf_bar *epf_bar[PCI_STD_NUM_BARS]; 247 }; 248 249 struct dw_pcie_ops { 250 u64 (*cpu_addr_fixup)(struct dw_pcie *pcie, u64 cpu_addr); 251 u32 (*read_dbi)(struct dw_pcie *pcie, void __iomem *base, u32 reg, 252 size_t size); 253 void (*write_dbi)(struct dw_pcie *pcie, void __iomem *base, u32 reg, 254 size_t size, u32 val); 255 void (*write_dbi2)(struct dw_pcie *pcie, void __iomem *base, u32 reg, 256 size_t size, u32 val); 257 int (*link_up)(struct dw_pcie *pcie); 258 int (*start_link)(struct dw_pcie *pcie); 259 void (*stop_link)(struct dw_pcie *pcie); 260 }; 261 262 struct dw_pcie { 263 struct device *dev; 264 void __iomem *dbi_base; 265 void __iomem *dbi_base2; 266 /* Used when iatu_unroll_enabled is true */ 267 void __iomem *atu_base; 268 u32 num_viewport; 269 u8 iatu_unroll_enabled; 270 struct pcie_port pp; 271 struct dw_pcie_ep ep; 272 const struct dw_pcie_ops *ops; 273 unsigned int version; 274 int num_lanes; 275 int link_gen; 276 u8 n_fts[2]; 277 }; 278 279 #define to_dw_pcie_from_pp(port) container_of((port), struct dw_pcie, pp) 280 281 #define to_dw_pcie_from_ep(endpoint) \ 282 container_of((endpoint), struct dw_pcie, ep) 283 284 u8 dw_pcie_find_capability(struct dw_pcie *pci, u8 cap); 285 u16 dw_pcie_find_ext_capability(struct dw_pcie *pci, u8 cap); 286 287 int dw_pcie_read(void __iomem *addr, int size, u32 *val); 288 int dw_pcie_write(void __iomem *addr, int size, u32 val); 289 290 u32 dw_pcie_read_dbi(struct dw_pcie *pci, u32 reg, size_t size); 291 void dw_pcie_write_dbi(struct dw_pcie *pci, u32 reg, size_t size, u32 val); 292 void dw_pcie_write_dbi2(struct dw_pcie *pci, u32 reg, size_t size, u32 val); 293 int dw_pcie_link_up(struct dw_pcie *pci); 294 void dw_pcie_upconfig_setup(struct dw_pcie *pci); 295 int dw_pcie_wait_for_link(struct dw_pcie *pci); 296 void dw_pcie_prog_outbound_atu(struct dw_pcie *pci, int index, 297 int type, u64 cpu_addr, u64 pci_addr, 298 u32 size); 299 void dw_pcie_prog_ep_outbound_atu(struct dw_pcie *pci, u8 func_no, int index, 300 int type, u64 cpu_addr, u64 pci_addr, 301 u32 size); 302 int dw_pcie_prog_inbound_atu(struct dw_pcie *pci, u8 func_no, int index, 303 int bar, u64 cpu_addr, 304 enum dw_pcie_as_type as_type); 305 void dw_pcie_disable_atu(struct dw_pcie *pci, int index, 306 enum dw_pcie_region_type type); 307 void dw_pcie_setup(struct dw_pcie *pci); 308 309 static inline void dw_pcie_writel_dbi(struct dw_pcie *pci, u32 reg, u32 val) 310 { 311 dw_pcie_write_dbi(pci, reg, 0x4, val); 312 } 313 314 static inline u32 dw_pcie_readl_dbi(struct dw_pcie *pci, u32 reg) 315 { 316 return dw_pcie_read_dbi(pci, reg, 0x4); 317 } 318 319 static inline void dw_pcie_writew_dbi(struct dw_pcie *pci, u32 reg, u16 val) 320 { 321 dw_pcie_write_dbi(pci, reg, 0x2, val); 322 } 323 324 static inline u16 dw_pcie_readw_dbi(struct dw_pcie *pci, u32 reg) 325 { 326 return dw_pcie_read_dbi(pci, reg, 0x2); 327 } 328 329 static inline void dw_pcie_writeb_dbi(struct dw_pcie *pci, u32 reg, u8 val) 330 { 331 dw_pcie_write_dbi(pci, reg, 0x1, val); 332 } 333 334 static inline u8 dw_pcie_readb_dbi(struct dw_pcie *pci, u32 reg) 335 { 336 return dw_pcie_read_dbi(pci, reg, 0x1); 337 } 338 339 static inline void dw_pcie_writel_dbi2(struct dw_pcie *pci, u32 reg, u32 val) 340 { 341 dw_pcie_write_dbi2(pci, reg, 0x4, val); 342 } 343 344 static inline void dw_pcie_dbi_ro_wr_en(struct dw_pcie *pci) 345 { 346 u32 reg; 347 u32 val; 348 349 reg = PCIE_MISC_CONTROL_1_OFF; 350 val = dw_pcie_readl_dbi(pci, reg); 351 val |= PCIE_DBI_RO_WR_EN; 352 dw_pcie_writel_dbi(pci, reg, val); 353 } 354 355 static inline void dw_pcie_dbi_ro_wr_dis(struct dw_pcie *pci) 356 { 357 u32 reg; 358 u32 val; 359 360 reg = PCIE_MISC_CONTROL_1_OFF; 361 val = dw_pcie_readl_dbi(pci, reg); 362 val &= ~PCIE_DBI_RO_WR_EN; 363 dw_pcie_writel_dbi(pci, reg, val); 364 } 365 366 #ifdef CONFIG_PCIE_DW_HOST 367 irqreturn_t dw_handle_msi_irq(struct pcie_port *pp); 368 void dw_pcie_msi_init(struct pcie_port *pp); 369 void dw_pcie_free_msi(struct pcie_port *pp); 370 void dw_pcie_setup_rc(struct pcie_port *pp); 371 int dw_pcie_host_init(struct pcie_port *pp); 372 void dw_pcie_host_deinit(struct pcie_port *pp); 373 int dw_pcie_allocate_domains(struct pcie_port *pp); 374 void __iomem *dw_pcie_own_conf_map_bus(struct pci_bus *bus, unsigned int devfn, 375 int where); 376 #else 377 static inline irqreturn_t dw_handle_msi_irq(struct pcie_port *pp) 378 { 379 return IRQ_NONE; 380 } 381 382 static inline void dw_pcie_msi_init(struct pcie_port *pp) 383 { 384 } 385 386 static inline void dw_pcie_free_msi(struct pcie_port *pp) 387 { 388 } 389 390 static inline void dw_pcie_setup_rc(struct pcie_port *pp) 391 { 392 } 393 394 static inline int dw_pcie_host_init(struct pcie_port *pp) 395 { 396 return 0; 397 } 398 399 static inline void dw_pcie_host_deinit(struct pcie_port *pp) 400 { 401 } 402 403 static inline int dw_pcie_allocate_domains(struct pcie_port *pp) 404 { 405 return 0; 406 } 407 static inline void __iomem *dw_pcie_own_conf_map_bus(struct pci_bus *bus, 408 unsigned int devfn, 409 int where) 410 { 411 return NULL; 412 } 413 #endif 414 415 #ifdef CONFIG_PCIE_DW_EP 416 void dw_pcie_ep_linkup(struct dw_pcie_ep *ep); 417 int dw_pcie_ep_init(struct dw_pcie_ep *ep); 418 int dw_pcie_ep_init_complete(struct dw_pcie_ep *ep); 419 void dw_pcie_ep_init_notify(struct dw_pcie_ep *ep); 420 void dw_pcie_ep_exit(struct dw_pcie_ep *ep); 421 int dw_pcie_ep_raise_legacy_irq(struct dw_pcie_ep *ep, u8 func_no); 422 int dw_pcie_ep_raise_msi_irq(struct dw_pcie_ep *ep, u8 func_no, 423 u8 interrupt_num); 424 int dw_pcie_ep_raise_msix_irq(struct dw_pcie_ep *ep, u8 func_no, 425 u16 interrupt_num); 426 int dw_pcie_ep_raise_msix_irq_doorbell(struct dw_pcie_ep *ep, u8 func_no, 427 u16 interrupt_num); 428 void dw_pcie_ep_reset_bar(struct dw_pcie *pci, enum pci_barno bar); 429 struct dw_pcie_ep_func * 430 dw_pcie_ep_get_func_from_ep(struct dw_pcie_ep *ep, u8 func_no); 431 #else 432 static inline void dw_pcie_ep_linkup(struct dw_pcie_ep *ep) 433 { 434 } 435 436 static inline int dw_pcie_ep_init(struct dw_pcie_ep *ep) 437 { 438 return 0; 439 } 440 441 static inline int dw_pcie_ep_init_complete(struct dw_pcie_ep *ep) 442 { 443 return 0; 444 } 445 446 static inline void dw_pcie_ep_init_notify(struct dw_pcie_ep *ep) 447 { 448 } 449 450 static inline void dw_pcie_ep_exit(struct dw_pcie_ep *ep) 451 { 452 } 453 454 static inline int dw_pcie_ep_raise_legacy_irq(struct dw_pcie_ep *ep, u8 func_no) 455 { 456 return 0; 457 } 458 459 static inline int dw_pcie_ep_raise_msi_irq(struct dw_pcie_ep *ep, u8 func_no, 460 u8 interrupt_num) 461 { 462 return 0; 463 } 464 465 static inline int dw_pcie_ep_raise_msix_irq(struct dw_pcie_ep *ep, u8 func_no, 466 u16 interrupt_num) 467 { 468 return 0; 469 } 470 471 static inline int dw_pcie_ep_raise_msix_irq_doorbell(struct dw_pcie_ep *ep, 472 u8 func_no, 473 u16 interrupt_num) 474 { 475 return 0; 476 } 477 478 static inline void dw_pcie_ep_reset_bar(struct dw_pcie *pci, enum pci_barno bar) 479 { 480 } 481 482 static inline struct dw_pcie_ep_func * 483 dw_pcie_ep_get_func_from_ep(struct dw_pcie_ep *ep, u8 func_no) 484 { 485 return NULL; 486 } 487 #endif 488 #endif /* _PCIE_DESIGNWARE_H */ 489