Linux Audio

Check our new training course

Loading...
v5.9
  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * PCIe host controller driver for Mobiveil PCIe Host controller
  4 *
  5 * Copyright (c) 2018 Mobiveil Inc.
  6 * Copyright 2019-2020 NXP
  7 *
  8 * Author: Subrahmanya Lingappa <l.subrahmanya@mobiveil.co.in>
  9 *	   Hou Zhiqiang <Zhiqiang.Hou@nxp.com>
 10 */
 11
 12#include <linux/init.h>
 13#include <linux/interrupt.h>
 14#include <linux/irq.h>
 15#include <linux/irqchip/chained_irq.h>
 16#include <linux/irqdomain.h>
 17#include <linux/kernel.h>
 18#include <linux/module.h>
 19#include <linux/msi.h>
 20#include <linux/of_address.h>
 21#include <linux/of_irq.h>
 22#include <linux/of_platform.h>
 23#include <linux/of_pci.h>
 24#include <linux/pci.h>
 25#include <linux/platform_device.h>
 26#include <linux/slab.h>
 27
 28#include "pcie-mobiveil.h"
 29
 30static bool mobiveil_pcie_valid_device(struct pci_bus *bus, unsigned int devfn)
 31{
 32	/* Only one device down on each root port */
 33	if (pci_is_root_bus(bus) && (devfn > 0))
 34		return false;
 35
 36	/*
 37	 * Do not read more than one device on the bus directly
 38	 * attached to RC
 39	 */
 40	if ((bus->primary == to_pci_host_bridge(bus->bridge)->busnr) && (PCI_SLOT(devfn) > 0))
 41		return false;
 42
 43	return true;
 44}
 45
 46/*
 47 * mobiveil_pcie_map_bus - routine to get the configuration base of either
 48 * root port or endpoint
 49 */
 50static void __iomem *mobiveil_pcie_map_bus(struct pci_bus *bus,
 51					   unsigned int devfn, int where)
 52{
 53	struct mobiveil_pcie *pcie = bus->sysdata;
 54	struct mobiveil_root_port *rp = &pcie->rp;
 55	u32 value;
 56
 57	if (!mobiveil_pcie_valid_device(bus, devfn))
 58		return NULL;
 59
 60	/* RC config access */
 61	if (pci_is_root_bus(bus))
 62		return pcie->csr_axi_slave_base + where;
 63
 64	/*
 65	 * EP config access (in Config/APIO space)
 66	 * Program PEX Address base (31..16 bits) with appropriate value
 67	 * (BDF) in PAB_AXI_AMAP_PEX_WIN_L0 Register.
 68	 * Relies on pci_lock serialization
 69	 */
 70	value = bus->number << PAB_BUS_SHIFT |
 71		PCI_SLOT(devfn) << PAB_DEVICE_SHIFT |
 72		PCI_FUNC(devfn) << PAB_FUNCTION_SHIFT;
 73
 74	mobiveil_csr_writel(pcie, value, PAB_AXI_AMAP_PEX_WIN_L(WIN_NUM_0));
 75
 76	return rp->config_axi_slave_base + where;
 77}
 78
 79static struct pci_ops mobiveil_pcie_ops = {
 80	.map_bus = mobiveil_pcie_map_bus,
 81	.read = pci_generic_config_read,
 82	.write = pci_generic_config_write,
 83};
 84
 85static void mobiveil_pcie_isr(struct irq_desc *desc)
 86{
 87	struct irq_chip *chip = irq_desc_get_chip(desc);
 88	struct mobiveil_pcie *pcie = irq_desc_get_handler_data(desc);
 89	struct device *dev = &pcie->pdev->dev;
 90	struct mobiveil_root_port *rp = &pcie->rp;
 91	struct mobiveil_msi *msi = &rp->msi;
 92	u32 msi_data, msi_addr_lo, msi_addr_hi;
 93	u32 intr_status, msi_status;
 94	unsigned long shifted_status;
 95	u32 bit, virq, val, mask;
 96
 97	/*
 98	 * The core provides a single interrupt for both INTx/MSI messages.
 99	 * So we'll read both INTx and MSI status
100	 */
101
102	chained_irq_enter(chip, desc);
103
104	/* read INTx status */
105	val = mobiveil_csr_readl(pcie, PAB_INTP_AMBA_MISC_STAT);
106	mask = mobiveil_csr_readl(pcie, PAB_INTP_AMBA_MISC_ENB);
107	intr_status = val & mask;
108
109	/* Handle INTx */
110	if (intr_status & PAB_INTP_INTX_MASK) {
111		shifted_status = mobiveil_csr_readl(pcie,
112						    PAB_INTP_AMBA_MISC_STAT);
113		shifted_status &= PAB_INTP_INTX_MASK;
114		shifted_status >>= PAB_INTX_START;
115		do {
116			for_each_set_bit(bit, &shifted_status, PCI_NUM_INTX) {
117				virq = irq_find_mapping(rp->intx_domain,
118							bit + 1);
119				if (virq)
120					generic_handle_irq(virq);
121				else
122					dev_err_ratelimited(dev, "unexpected IRQ, INT%d\n",
123							    bit);
124
125				/* clear interrupt handled */
126				mobiveil_csr_writel(pcie,
127						    1 << (PAB_INTX_START + bit),
128						    PAB_INTP_AMBA_MISC_STAT);
129			}
130
131			shifted_status = mobiveil_csr_readl(pcie,
132							    PAB_INTP_AMBA_MISC_STAT);
133			shifted_status &= PAB_INTP_INTX_MASK;
134			shifted_status >>= PAB_INTX_START;
135		} while (shifted_status != 0);
136	}
137
138	/* read extra MSI status register */
139	msi_status = readl_relaxed(pcie->apb_csr_base + MSI_STATUS_OFFSET);
140
141	/* handle MSI interrupts */
142	while (msi_status & 1) {
143		msi_data = readl_relaxed(pcie->apb_csr_base + MSI_DATA_OFFSET);
144
145		/*
146		 * MSI_STATUS_OFFSET register gets updated to zero
147		 * once we pop not only the MSI data but also address
148		 * from MSI hardware FIFO. So keeping these following
149		 * two dummy reads.
150		 */
151		msi_addr_lo = readl_relaxed(pcie->apb_csr_base +
152					    MSI_ADDR_L_OFFSET);
153		msi_addr_hi = readl_relaxed(pcie->apb_csr_base +
154					    MSI_ADDR_H_OFFSET);
155		dev_dbg(dev, "MSI registers, data: %08x, addr: %08x:%08x\n",
156			msi_data, msi_addr_hi, msi_addr_lo);
157
158		virq = irq_find_mapping(msi->dev_domain, msi_data);
159		if (virq)
160			generic_handle_irq(virq);
161
162		msi_status = readl_relaxed(pcie->apb_csr_base +
163					   MSI_STATUS_OFFSET);
164	}
165
166	/* Clear the interrupt status */
167	mobiveil_csr_writel(pcie, intr_status, PAB_INTP_AMBA_MISC_STAT);
168	chained_irq_exit(chip, desc);
169}
170
171static int mobiveil_pcie_parse_dt(struct mobiveil_pcie *pcie)
172{
173	struct device *dev = &pcie->pdev->dev;
174	struct platform_device *pdev = pcie->pdev;
175	struct device_node *node = dev->of_node;
176	struct mobiveil_root_port *rp = &pcie->rp;
177	struct resource *res;
178
179	/* map config resource */
180	res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
181					   "config_axi_slave");
182	rp->config_axi_slave_base = devm_pci_remap_cfg_resource(dev, res);
183	if (IS_ERR(rp->config_axi_slave_base))
184		return PTR_ERR(rp->config_axi_slave_base);
185	rp->ob_io_res = res;
186
187	/* map csr resource */
188	res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
189					   "csr_axi_slave");
190	pcie->csr_axi_slave_base = devm_pci_remap_cfg_resource(dev, res);
191	if (IS_ERR(pcie->csr_axi_slave_base))
192		return PTR_ERR(pcie->csr_axi_slave_base);
193	pcie->pcie_reg_base = res->start;
194
195	/* read the number of windows requested */
196	if (of_property_read_u32(node, "apio-wins", &pcie->apio_wins))
197		pcie->apio_wins = MAX_PIO_WINDOWS;
198
199	if (of_property_read_u32(node, "ppio-wins", &pcie->ppio_wins))
200		pcie->ppio_wins = MAX_PIO_WINDOWS;
201
202	return 0;
203}
204
205static void mobiveil_pcie_enable_msi(struct mobiveil_pcie *pcie)
206{
207	phys_addr_t msg_addr = pcie->pcie_reg_base;
208	struct mobiveil_msi *msi = &pcie->rp.msi;
209
210	msi->num_of_vectors = PCI_NUM_MSI;
211	msi->msi_pages_phys = (phys_addr_t)msg_addr;
212
213	writel_relaxed(lower_32_bits(msg_addr),
214		       pcie->apb_csr_base + MSI_BASE_LO_OFFSET);
215	writel_relaxed(upper_32_bits(msg_addr),
216		       pcie->apb_csr_base + MSI_BASE_HI_OFFSET);
217	writel_relaxed(4096, pcie->apb_csr_base + MSI_SIZE_OFFSET);
218	writel_relaxed(1, pcie->apb_csr_base + MSI_ENABLE_OFFSET);
219}
220
221int mobiveil_host_init(struct mobiveil_pcie *pcie, bool reinit)
222{
223	struct mobiveil_root_port *rp = &pcie->rp;
224	struct pci_host_bridge *bridge = rp->bridge;
225	u32 value, pab_ctrl, type;
226	struct resource_entry *win;
227
228	pcie->ib_wins_configured = 0;
229	pcie->ob_wins_configured = 0;
230
231	if (!reinit) {
232		/* setup bus numbers */
233		value = mobiveil_csr_readl(pcie, PCI_PRIMARY_BUS);
234		value &= 0xff000000;
235		value |= 0x00ff0100;
236		mobiveil_csr_writel(pcie, value, PCI_PRIMARY_BUS);
237	}
238
239	/*
240	 * program Bus Master Enable Bit in Command Register in PAB Config
241	 * Space
242	 */
243	value = mobiveil_csr_readl(pcie, PCI_COMMAND);
244	value |= PCI_COMMAND_IO | PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER;
245	mobiveil_csr_writel(pcie, value, PCI_COMMAND);
246
247	/*
248	 * program PIO Enable Bit to 1 (and PEX PIO Enable to 1) in PAB_CTRL
249	 * register
250	 */
251	pab_ctrl = mobiveil_csr_readl(pcie, PAB_CTRL);
252	pab_ctrl |= (1 << AMBA_PIO_ENABLE_SHIFT) | (1 << PEX_PIO_ENABLE_SHIFT);
253	mobiveil_csr_writel(pcie, pab_ctrl, PAB_CTRL);
254
255	/*
256	 * program PIO Enable Bit to 1 and Config Window Enable Bit to 1 in
257	 * PAB_AXI_PIO_CTRL Register
258	 */
259	value = mobiveil_csr_readl(pcie, PAB_AXI_PIO_CTRL);
260	value |= APIO_EN_MASK;
261	mobiveil_csr_writel(pcie, value, PAB_AXI_PIO_CTRL);
262
263	/* Enable PCIe PIO master */
264	value = mobiveil_csr_readl(pcie, PAB_PEX_PIO_CTRL);
265	value |= 1 << PIO_ENABLE_SHIFT;
266	mobiveil_csr_writel(pcie, value, PAB_PEX_PIO_CTRL);
267
268	/*
269	 * we'll program one outbound window for config reads and
270	 * another default inbound window for all the upstream traffic
271	 * rest of the outbound windows will be configured according to
272	 * the "ranges" field defined in device tree
273	 */
274
275	/* config outbound translation window */
276	program_ob_windows(pcie, WIN_NUM_0, rp->ob_io_res->start, 0,
277			   CFG_WINDOW_TYPE, resource_size(rp->ob_io_res));
278
279	/* memory inbound translation window */
280	program_ib_windows(pcie, WIN_NUM_0, 0, 0, MEM_WINDOW_TYPE, IB_WIN_SIZE);
281
282	/* Get the I/O and memory ranges from DT */
283	resource_list_for_each_entry(win, &bridge->windows) {
284		if (resource_type(win->res) == IORESOURCE_MEM)
285			type = MEM_WINDOW_TYPE;
286		else if (resource_type(win->res) == IORESOURCE_IO)
287			type = IO_WINDOW_TYPE;
288		else
289			continue;
290
291		/* configure outbound translation window */
292		program_ob_windows(pcie, pcie->ob_wins_configured,
293				   win->res->start,
294				   win->res->start - win->offset,
295				   type, resource_size(win->res));
296	}
297
298	/* fixup for PCIe class register */
299	value = mobiveil_csr_readl(pcie, PAB_INTP_AXI_PIO_CLASS);
300	value &= 0xff;
301	value |= (PCI_CLASS_BRIDGE_PCI << 16);
302	mobiveil_csr_writel(pcie, value, PAB_INTP_AXI_PIO_CLASS);
303
304	return 0;
305}
306
307static void mobiveil_mask_intx_irq(struct irq_data *data)
308{
309	struct irq_desc *desc = irq_to_desc(data->irq);
310	struct mobiveil_pcie *pcie;
311	struct mobiveil_root_port *rp;
312	unsigned long flags;
313	u32 mask, shifted_val;
314
315	pcie = irq_desc_get_chip_data(desc);
316	rp = &pcie->rp;
317	mask = 1 << ((data->hwirq + PAB_INTX_START) - 1);
318	raw_spin_lock_irqsave(&rp->intx_mask_lock, flags);
319	shifted_val = mobiveil_csr_readl(pcie, PAB_INTP_AMBA_MISC_ENB);
320	shifted_val &= ~mask;
321	mobiveil_csr_writel(pcie, shifted_val, PAB_INTP_AMBA_MISC_ENB);
322	raw_spin_unlock_irqrestore(&rp->intx_mask_lock, flags);
323}
324
325static void mobiveil_unmask_intx_irq(struct irq_data *data)
326{
327	struct irq_desc *desc = irq_to_desc(data->irq);
328	struct mobiveil_pcie *pcie;
329	struct mobiveil_root_port *rp;
330	unsigned long flags;
331	u32 shifted_val, mask;
332
333	pcie = irq_desc_get_chip_data(desc);
334	rp = &pcie->rp;
335	mask = 1 << ((data->hwirq + PAB_INTX_START) - 1);
336	raw_spin_lock_irqsave(&rp->intx_mask_lock, flags);
337	shifted_val = mobiveil_csr_readl(pcie, PAB_INTP_AMBA_MISC_ENB);
338	shifted_val |= mask;
339	mobiveil_csr_writel(pcie, shifted_val, PAB_INTP_AMBA_MISC_ENB);
340	raw_spin_unlock_irqrestore(&rp->intx_mask_lock, flags);
341}
342
343static struct irq_chip intx_irq_chip = {
344	.name = "mobiveil_pcie:intx",
345	.irq_enable = mobiveil_unmask_intx_irq,
346	.irq_disable = mobiveil_mask_intx_irq,
347	.irq_mask = mobiveil_mask_intx_irq,
348	.irq_unmask = mobiveil_unmask_intx_irq,
349};
350
351/* routine to setup the INTx related data */
352static int mobiveil_pcie_intx_map(struct irq_domain *domain, unsigned int irq,
353				  irq_hw_number_t hwirq)
354{
355	irq_set_chip_and_handler(irq, &intx_irq_chip, handle_level_irq);
356	irq_set_chip_data(irq, domain->host_data);
357
358	return 0;
359}
360
361/* INTx domain operations structure */
362static const struct irq_domain_ops intx_domain_ops = {
363	.map = mobiveil_pcie_intx_map,
364};
365
366static struct irq_chip mobiveil_msi_irq_chip = {
367	.name = "Mobiveil PCIe MSI",
368	.irq_mask = pci_msi_mask_irq,
369	.irq_unmask = pci_msi_unmask_irq,
370};
371
372static struct msi_domain_info mobiveil_msi_domain_info = {
373	.flags	= (MSI_FLAG_USE_DEF_DOM_OPS | MSI_FLAG_USE_DEF_CHIP_OPS |
374		   MSI_FLAG_PCI_MSIX),
375	.chip	= &mobiveil_msi_irq_chip,
376};
377
378static void mobiveil_compose_msi_msg(struct irq_data *data, struct msi_msg *msg)
379{
380	struct mobiveil_pcie *pcie = irq_data_get_irq_chip_data(data);
381	phys_addr_t addr = pcie->pcie_reg_base + (data->hwirq * sizeof(int));
382
383	msg->address_lo = lower_32_bits(addr);
384	msg->address_hi = upper_32_bits(addr);
385	msg->data = data->hwirq;
386
387	dev_dbg(&pcie->pdev->dev, "msi#%d address_hi %#x address_lo %#x\n",
388		(int)data->hwirq, msg->address_hi, msg->address_lo);
389}
390
391static int mobiveil_msi_set_affinity(struct irq_data *irq_data,
392				     const struct cpumask *mask, bool force)
393{
394	return -EINVAL;
395}
396
397static struct irq_chip mobiveil_msi_bottom_irq_chip = {
398	.name			= "Mobiveil MSI",
399	.irq_compose_msi_msg	= mobiveil_compose_msi_msg,
400	.irq_set_affinity	= mobiveil_msi_set_affinity,
401};
402
403static int mobiveil_irq_msi_domain_alloc(struct irq_domain *domain,
404					 unsigned int virq,
405					 unsigned int nr_irqs, void *args)
406{
407	struct mobiveil_pcie *pcie = domain->host_data;
408	struct mobiveil_msi *msi = &pcie->rp.msi;
409	unsigned long bit;
410
411	WARN_ON(nr_irqs != 1);
412	mutex_lock(&msi->lock);
413
414	bit = find_first_zero_bit(msi->msi_irq_in_use, msi->num_of_vectors);
415	if (bit >= msi->num_of_vectors) {
416		mutex_unlock(&msi->lock);
417		return -ENOSPC;
418	}
419
420	set_bit(bit, msi->msi_irq_in_use);
421
422	mutex_unlock(&msi->lock);
423
424	irq_domain_set_info(domain, virq, bit, &mobiveil_msi_bottom_irq_chip,
425			    domain->host_data, handle_level_irq, NULL, NULL);
426	return 0;
427}
428
429static void mobiveil_irq_msi_domain_free(struct irq_domain *domain,
430					 unsigned int virq,
431					 unsigned int nr_irqs)
432{
433	struct irq_data *d = irq_domain_get_irq_data(domain, virq);
434	struct mobiveil_pcie *pcie = irq_data_get_irq_chip_data(d);
435	struct mobiveil_msi *msi = &pcie->rp.msi;
436
437	mutex_lock(&msi->lock);
438
439	if (!test_bit(d->hwirq, msi->msi_irq_in_use))
440		dev_err(&pcie->pdev->dev, "trying to free unused MSI#%lu\n",
441			d->hwirq);
442	else
443		__clear_bit(d->hwirq, msi->msi_irq_in_use);
444
445	mutex_unlock(&msi->lock);
446}
447static const struct irq_domain_ops msi_domain_ops = {
448	.alloc	= mobiveil_irq_msi_domain_alloc,
449	.free	= mobiveil_irq_msi_domain_free,
450};
451
452static int mobiveil_allocate_msi_domains(struct mobiveil_pcie *pcie)
453{
454	struct device *dev = &pcie->pdev->dev;
455	struct fwnode_handle *fwnode = of_node_to_fwnode(dev->of_node);
456	struct mobiveil_msi *msi = &pcie->rp.msi;
457
458	mutex_init(&msi->lock);
459	msi->dev_domain = irq_domain_add_linear(NULL, msi->num_of_vectors,
460						&msi_domain_ops, pcie);
461	if (!msi->dev_domain) {
462		dev_err(dev, "failed to create IRQ domain\n");
463		return -ENOMEM;
464	}
465
466	msi->msi_domain = pci_msi_create_irq_domain(fwnode,
467						    &mobiveil_msi_domain_info,
468						    msi->dev_domain);
469	if (!msi->msi_domain) {
470		dev_err(dev, "failed to create MSI domain\n");
471		irq_domain_remove(msi->dev_domain);
472		return -ENOMEM;
473	}
474
475	return 0;
476}
477
478static int mobiveil_pcie_init_irq_domain(struct mobiveil_pcie *pcie)
479{
480	struct device *dev = &pcie->pdev->dev;
481	struct device_node *node = dev->of_node;
482	struct mobiveil_root_port *rp = &pcie->rp;
483	int ret;
484
485	/* setup INTx */
486	rp->intx_domain = irq_domain_add_linear(node, PCI_NUM_INTX,
487						&intx_domain_ops, pcie);
488
489	if (!rp->intx_domain) {
490		dev_err(dev, "Failed to get a INTx IRQ domain\n");
491		return -ENOMEM;
492	}
493
494	raw_spin_lock_init(&rp->intx_mask_lock);
495
496	/* setup MSI */
497	ret = mobiveil_allocate_msi_domains(pcie);
498	if (ret)
499		return ret;
500
501	return 0;
502}
503
504static int mobiveil_pcie_integrated_interrupt_init(struct mobiveil_pcie *pcie)
505{
506	struct platform_device *pdev = pcie->pdev;
507	struct device *dev = &pdev->dev;
508	struct mobiveil_root_port *rp = &pcie->rp;
509	struct resource *res;
510	int ret;
511
512	/* map MSI config resource */
513	res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "apb_csr");
514	pcie->apb_csr_base = devm_pci_remap_cfg_resource(dev, res);
515	if (IS_ERR(pcie->apb_csr_base))
516		return PTR_ERR(pcie->apb_csr_base);
517
518	/* setup MSI hardware registers */
519	mobiveil_pcie_enable_msi(pcie);
520
521	rp->irq = platform_get_irq(pdev, 0);
522	if (rp->irq < 0)
523		return rp->irq;
524
525	/* initialize the IRQ domains */
526	ret = mobiveil_pcie_init_irq_domain(pcie);
527	if (ret) {
528		dev_err(dev, "Failed creating IRQ Domain\n");
529		return ret;
530	}
531
532	irq_set_chained_handler_and_data(rp->irq, mobiveil_pcie_isr, pcie);
533
534	/* Enable interrupts */
535	mobiveil_csr_writel(pcie, (PAB_INTP_INTX_MASK | PAB_INTP_MSI_MASK),
536			    PAB_INTP_AMBA_MISC_ENB);
537
538
539	return 0;
540}
541
542static int mobiveil_pcie_interrupt_init(struct mobiveil_pcie *pcie)
543{
544	struct mobiveil_root_port *rp = &pcie->rp;
545
546	if (rp->ops->interrupt_init)
547		return rp->ops->interrupt_init(pcie);
548
549	return mobiveil_pcie_integrated_interrupt_init(pcie);
550}
551
552static bool mobiveil_pcie_is_bridge(struct mobiveil_pcie *pcie)
553{
554	u32 header_type;
555
556	header_type = mobiveil_csr_readb(pcie, PCI_HEADER_TYPE);
557	header_type &= 0x7f;
558
559	return header_type == PCI_HEADER_TYPE_BRIDGE;
560}
561
562int mobiveil_pcie_host_probe(struct mobiveil_pcie *pcie)
563{
564	struct mobiveil_root_port *rp = &pcie->rp;
565	struct pci_host_bridge *bridge = rp->bridge;
566	struct device *dev = &pcie->pdev->dev;
567	int ret;
568
569	ret = mobiveil_pcie_parse_dt(pcie);
570	if (ret) {
571		dev_err(dev, "Parsing DT failed, ret: %x\n", ret);
572		return ret;
573	}
574
575	if (!mobiveil_pcie_is_bridge(pcie))
576		return -ENODEV;
577
578	/*
579	 * configure all inbound and outbound windows and prepare the RC for
580	 * config access
581	 */
582	ret = mobiveil_host_init(pcie, false);
583	if (ret) {
584		dev_err(dev, "Failed to initialize host\n");
585		return ret;
586	}
587
588	ret = mobiveil_pcie_interrupt_init(pcie);
589	if (ret) {
590		dev_err(dev, "Interrupt init failed\n");
591		return ret;
592	}
593
594	/* Initialize bridge */
595	bridge->sysdata = pcie;
596	bridge->ops = &mobiveil_pcie_ops;
597
598	ret = mobiveil_bringup_link(pcie);
599	if (ret) {
600		dev_info(dev, "link bring-up failed\n");
601		return ret;
602	}
603
604	return pci_host_probe(bridge);
605}
v6.13.7
  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * PCIe host controller driver for Mobiveil PCIe Host controller
  4 *
  5 * Copyright (c) 2018 Mobiveil Inc.
  6 * Copyright 2019-2020 NXP
  7 *
  8 * Author: Subrahmanya Lingappa <l.subrahmanya@mobiveil.co.in>
  9 *	   Hou Zhiqiang <Zhiqiang.Hou@nxp.com>
 10 */
 11
 12#include <linux/init.h>
 13#include <linux/interrupt.h>
 14#include <linux/irq.h>
 15#include <linux/irqchip/chained_irq.h>
 16#include <linux/irqdomain.h>
 17#include <linux/kernel.h>
 18#include <linux/module.h>
 19#include <linux/msi.h>
 
 
 
 20#include <linux/of_pci.h>
 21#include <linux/pci.h>
 22#include <linux/platform_device.h>
 23#include <linux/slab.h>
 24
 25#include "pcie-mobiveil.h"
 26
 27static bool mobiveil_pcie_valid_device(struct pci_bus *bus, unsigned int devfn)
 28{
 29	/* Only one device down on each root port */
 30	if (pci_is_root_bus(bus) && (devfn > 0))
 31		return false;
 32
 33	/*
 34	 * Do not read more than one device on the bus directly
 35	 * attached to RC
 36	 */
 37	if ((bus->primary == to_pci_host_bridge(bus->bridge)->busnr) && (PCI_SLOT(devfn) > 0))
 38		return false;
 39
 40	return true;
 41}
 42
 43/*
 44 * mobiveil_pcie_map_bus - routine to get the configuration base of either
 45 * root port or endpoint
 46 */
 47static void __iomem *mobiveil_pcie_map_bus(struct pci_bus *bus,
 48					   unsigned int devfn, int where)
 49{
 50	struct mobiveil_pcie *pcie = bus->sysdata;
 51	struct mobiveil_root_port *rp = &pcie->rp;
 52	u32 value;
 53
 54	if (!mobiveil_pcie_valid_device(bus, devfn))
 55		return NULL;
 56
 57	/* RC config access */
 58	if (pci_is_root_bus(bus))
 59		return pcie->csr_axi_slave_base + where;
 60
 61	/*
 62	 * EP config access (in Config/APIO space)
 63	 * Program PEX Address base (31..16 bits) with appropriate value
 64	 * (BDF) in PAB_AXI_AMAP_PEX_WIN_L0 Register.
 65	 * Relies on pci_lock serialization
 66	 */
 67	value = bus->number << PAB_BUS_SHIFT |
 68		PCI_SLOT(devfn) << PAB_DEVICE_SHIFT |
 69		PCI_FUNC(devfn) << PAB_FUNCTION_SHIFT;
 70
 71	mobiveil_csr_writel(pcie, value, PAB_AXI_AMAP_PEX_WIN_L(WIN_NUM_0));
 72
 73	return rp->config_axi_slave_base + where;
 74}
 75
 76static struct pci_ops mobiveil_pcie_ops = {
 77	.map_bus = mobiveil_pcie_map_bus,
 78	.read = pci_generic_config_read,
 79	.write = pci_generic_config_write,
 80};
 81
 82static void mobiveil_pcie_isr(struct irq_desc *desc)
 83{
 84	struct irq_chip *chip = irq_desc_get_chip(desc);
 85	struct mobiveil_pcie *pcie = irq_desc_get_handler_data(desc);
 86	struct device *dev = &pcie->pdev->dev;
 87	struct mobiveil_root_port *rp = &pcie->rp;
 88	struct mobiveil_msi *msi = &rp->msi;
 89	u32 msi_data, msi_addr_lo, msi_addr_hi;
 90	u32 intr_status, msi_status;
 91	unsigned long shifted_status;
 92	u32 bit, val, mask;
 93
 94	/*
 95	 * The core provides a single interrupt for both INTx/MSI messages.
 96	 * So we'll read both INTx and MSI status
 97	 */
 98
 99	chained_irq_enter(chip, desc);
100
101	/* read INTx status */
102	val = mobiveil_csr_readl(pcie, PAB_INTP_AMBA_MISC_STAT);
103	mask = mobiveil_csr_readl(pcie, PAB_INTP_AMBA_MISC_ENB);
104	intr_status = val & mask;
105
106	/* Handle INTx */
107	if (intr_status & PAB_INTP_INTX_MASK) {
108		shifted_status = mobiveil_csr_readl(pcie,
109						    PAB_INTP_AMBA_MISC_STAT);
110		shifted_status &= PAB_INTP_INTX_MASK;
111		shifted_status >>= PAB_INTX_START;
112		do {
113			for_each_set_bit(bit, &shifted_status, PCI_NUM_INTX) {
114				int ret;
115				ret = generic_handle_domain_irq(rp->intx_domain,
116								bit + 1);
117				if (ret)
 
118					dev_err_ratelimited(dev, "unexpected IRQ, INT%d\n",
119							    bit);
120
121				/* clear interrupt handled */
122				mobiveil_csr_writel(pcie,
123						    1 << (PAB_INTX_START + bit),
124						    PAB_INTP_AMBA_MISC_STAT);
125			}
126
127			shifted_status = mobiveil_csr_readl(pcie,
128							    PAB_INTP_AMBA_MISC_STAT);
129			shifted_status &= PAB_INTP_INTX_MASK;
130			shifted_status >>= PAB_INTX_START;
131		} while (shifted_status != 0);
132	}
133
134	/* read extra MSI status register */
135	msi_status = readl_relaxed(pcie->apb_csr_base + MSI_STATUS_OFFSET);
136
137	/* handle MSI interrupts */
138	while (msi_status & 1) {
139		msi_data = readl_relaxed(pcie->apb_csr_base + MSI_DATA_OFFSET);
140
141		/*
142		 * MSI_STATUS_OFFSET register gets updated to zero
143		 * once we pop not only the MSI data but also address
144		 * from MSI hardware FIFO. So keeping these following
145		 * two dummy reads.
146		 */
147		msi_addr_lo = readl_relaxed(pcie->apb_csr_base +
148					    MSI_ADDR_L_OFFSET);
149		msi_addr_hi = readl_relaxed(pcie->apb_csr_base +
150					    MSI_ADDR_H_OFFSET);
151		dev_dbg(dev, "MSI registers, data: %08x, addr: %08x:%08x\n",
152			msi_data, msi_addr_hi, msi_addr_lo);
153
154		generic_handle_domain_irq(msi->dev_domain, msi_data);
 
 
155
156		msi_status = readl_relaxed(pcie->apb_csr_base +
157					   MSI_STATUS_OFFSET);
158	}
159
160	/* Clear the interrupt status */
161	mobiveil_csr_writel(pcie, intr_status, PAB_INTP_AMBA_MISC_STAT);
162	chained_irq_exit(chip, desc);
163}
164
165static int mobiveil_pcie_parse_dt(struct mobiveil_pcie *pcie)
166{
167	struct device *dev = &pcie->pdev->dev;
168	struct platform_device *pdev = pcie->pdev;
169	struct device_node *node = dev->of_node;
170	struct mobiveil_root_port *rp = &pcie->rp;
171	struct resource *res;
172
173	/* map config resource */
174	res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
175					   "config_axi_slave");
176	rp->config_axi_slave_base = devm_pci_remap_cfg_resource(dev, res);
177	if (IS_ERR(rp->config_axi_slave_base))
178		return PTR_ERR(rp->config_axi_slave_base);
179	rp->ob_io_res = res;
180
181	/* map csr resource */
182	res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
183					   "csr_axi_slave");
184	pcie->csr_axi_slave_base = devm_pci_remap_cfg_resource(dev, res);
185	if (IS_ERR(pcie->csr_axi_slave_base))
186		return PTR_ERR(pcie->csr_axi_slave_base);
187	pcie->pcie_reg_base = res->start;
188
189	/* read the number of windows requested */
190	if (of_property_read_u32(node, "apio-wins", &pcie->apio_wins))
191		pcie->apio_wins = MAX_PIO_WINDOWS;
192
193	if (of_property_read_u32(node, "ppio-wins", &pcie->ppio_wins))
194		pcie->ppio_wins = MAX_PIO_WINDOWS;
195
196	return 0;
197}
198
199static void mobiveil_pcie_enable_msi(struct mobiveil_pcie *pcie)
200{
201	phys_addr_t msg_addr = pcie->pcie_reg_base;
202	struct mobiveil_msi *msi = &pcie->rp.msi;
203
204	msi->num_of_vectors = PCI_NUM_MSI;
205	msi->msi_pages_phys = (phys_addr_t)msg_addr;
206
207	writel_relaxed(lower_32_bits(msg_addr),
208		       pcie->apb_csr_base + MSI_BASE_LO_OFFSET);
209	writel_relaxed(upper_32_bits(msg_addr),
210		       pcie->apb_csr_base + MSI_BASE_HI_OFFSET);
211	writel_relaxed(4096, pcie->apb_csr_base + MSI_SIZE_OFFSET);
212	writel_relaxed(1, pcie->apb_csr_base + MSI_ENABLE_OFFSET);
213}
214
215int mobiveil_host_init(struct mobiveil_pcie *pcie, bool reinit)
216{
217	struct mobiveil_root_port *rp = &pcie->rp;
218	struct pci_host_bridge *bridge = rp->bridge;
219	u32 value, pab_ctrl, type;
220	struct resource_entry *win;
221
222	pcie->ib_wins_configured = 0;
223	pcie->ob_wins_configured = 0;
224
225	if (!reinit) {
226		/* setup bus numbers */
227		value = mobiveil_csr_readl(pcie, PCI_PRIMARY_BUS);
228		value &= 0xff000000;
229		value |= 0x00ff0100;
230		mobiveil_csr_writel(pcie, value, PCI_PRIMARY_BUS);
231	}
232
233	/*
234	 * program Bus Master Enable Bit in Command Register in PAB Config
235	 * Space
236	 */
237	value = mobiveil_csr_readl(pcie, PCI_COMMAND);
238	value |= PCI_COMMAND_IO | PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER;
239	mobiveil_csr_writel(pcie, value, PCI_COMMAND);
240
241	/*
242	 * program PIO Enable Bit to 1 (and PEX PIO Enable to 1) in PAB_CTRL
243	 * register
244	 */
245	pab_ctrl = mobiveil_csr_readl(pcie, PAB_CTRL);
246	pab_ctrl |= (1 << AMBA_PIO_ENABLE_SHIFT) | (1 << PEX_PIO_ENABLE_SHIFT);
247	mobiveil_csr_writel(pcie, pab_ctrl, PAB_CTRL);
248
249	/*
250	 * program PIO Enable Bit to 1 and Config Window Enable Bit to 1 in
251	 * PAB_AXI_PIO_CTRL Register
252	 */
253	value = mobiveil_csr_readl(pcie, PAB_AXI_PIO_CTRL);
254	value |= APIO_EN_MASK;
255	mobiveil_csr_writel(pcie, value, PAB_AXI_PIO_CTRL);
256
257	/* Enable PCIe PIO master */
258	value = mobiveil_csr_readl(pcie, PAB_PEX_PIO_CTRL);
259	value |= 1 << PIO_ENABLE_SHIFT;
260	mobiveil_csr_writel(pcie, value, PAB_PEX_PIO_CTRL);
261
262	/*
263	 * we'll program one outbound window for config reads and
264	 * another default inbound window for all the upstream traffic
265	 * rest of the outbound windows will be configured according to
266	 * the "ranges" field defined in device tree
267	 */
268
269	/* config outbound translation window */
270	program_ob_windows(pcie, WIN_NUM_0, rp->ob_io_res->start, 0,
271			   CFG_WINDOW_TYPE, resource_size(rp->ob_io_res));
272
273	/* memory inbound translation window */
274	program_ib_windows(pcie, WIN_NUM_0, 0, 0, MEM_WINDOW_TYPE, IB_WIN_SIZE);
275
276	/* Get the I/O and memory ranges from DT */
277	resource_list_for_each_entry(win, &bridge->windows) {
278		if (resource_type(win->res) == IORESOURCE_MEM)
279			type = MEM_WINDOW_TYPE;
280		else if (resource_type(win->res) == IORESOURCE_IO)
281			type = IO_WINDOW_TYPE;
282		else
283			continue;
284
285		/* configure outbound translation window */
286		program_ob_windows(pcie, pcie->ob_wins_configured,
287				   win->res->start,
288				   win->res->start - win->offset,
289				   type, resource_size(win->res));
290	}
291
292	/* fixup for PCIe class register */
293	value = mobiveil_csr_readl(pcie, PAB_INTP_AXI_PIO_CLASS);
294	value &= 0xff;
295	value |= PCI_CLASS_BRIDGE_PCI_NORMAL << 8;
296	mobiveil_csr_writel(pcie, value, PAB_INTP_AXI_PIO_CLASS);
297
298	return 0;
299}
300
301static void mobiveil_mask_intx_irq(struct irq_data *data)
302{
303	struct mobiveil_pcie *pcie = irq_data_get_irq_chip_data(data);
 
304	struct mobiveil_root_port *rp;
305	unsigned long flags;
306	u32 mask, shifted_val;
307
 
308	rp = &pcie->rp;
309	mask = 1 << ((data->hwirq + PAB_INTX_START) - 1);
310	raw_spin_lock_irqsave(&rp->intx_mask_lock, flags);
311	shifted_val = mobiveil_csr_readl(pcie, PAB_INTP_AMBA_MISC_ENB);
312	shifted_val &= ~mask;
313	mobiveil_csr_writel(pcie, shifted_val, PAB_INTP_AMBA_MISC_ENB);
314	raw_spin_unlock_irqrestore(&rp->intx_mask_lock, flags);
315}
316
317static void mobiveil_unmask_intx_irq(struct irq_data *data)
318{
319	struct mobiveil_pcie *pcie = irq_data_get_irq_chip_data(data);
 
320	struct mobiveil_root_port *rp;
321	unsigned long flags;
322	u32 shifted_val, mask;
323
 
324	rp = &pcie->rp;
325	mask = 1 << ((data->hwirq + PAB_INTX_START) - 1);
326	raw_spin_lock_irqsave(&rp->intx_mask_lock, flags);
327	shifted_val = mobiveil_csr_readl(pcie, PAB_INTP_AMBA_MISC_ENB);
328	shifted_val |= mask;
329	mobiveil_csr_writel(pcie, shifted_val, PAB_INTP_AMBA_MISC_ENB);
330	raw_spin_unlock_irqrestore(&rp->intx_mask_lock, flags);
331}
332
333static struct irq_chip intx_irq_chip = {
334	.name = "mobiveil_pcie:intx",
335	.irq_enable = mobiveil_unmask_intx_irq,
336	.irq_disable = mobiveil_mask_intx_irq,
337	.irq_mask = mobiveil_mask_intx_irq,
338	.irq_unmask = mobiveil_unmask_intx_irq,
339};
340
341/* routine to setup the INTx related data */
342static int mobiveil_pcie_intx_map(struct irq_domain *domain, unsigned int irq,
343				  irq_hw_number_t hwirq)
344{
345	irq_set_chip_and_handler(irq, &intx_irq_chip, handle_level_irq);
346	irq_set_chip_data(irq, domain->host_data);
347
348	return 0;
349}
350
351/* INTx domain operations structure */
352static const struct irq_domain_ops intx_domain_ops = {
353	.map = mobiveil_pcie_intx_map,
354};
355
356static struct irq_chip mobiveil_msi_irq_chip = {
357	.name = "Mobiveil PCIe MSI",
358	.irq_mask = pci_msi_mask_irq,
359	.irq_unmask = pci_msi_unmask_irq,
360};
361
362static struct msi_domain_info mobiveil_msi_domain_info = {
363	.flags	= MSI_FLAG_USE_DEF_DOM_OPS | MSI_FLAG_USE_DEF_CHIP_OPS |
364		  MSI_FLAG_NO_AFFINITY | MSI_FLAG_PCI_MSIX,
365	.chip	= &mobiveil_msi_irq_chip,
366};
367
368static void mobiveil_compose_msi_msg(struct irq_data *data, struct msi_msg *msg)
369{
370	struct mobiveil_pcie *pcie = irq_data_get_irq_chip_data(data);
371	phys_addr_t addr = pcie->pcie_reg_base + (data->hwirq * sizeof(int));
372
373	msg->address_lo = lower_32_bits(addr);
374	msg->address_hi = upper_32_bits(addr);
375	msg->data = data->hwirq;
376
377	dev_dbg(&pcie->pdev->dev, "msi#%d address_hi %#x address_lo %#x\n",
378		(int)data->hwirq, msg->address_hi, msg->address_lo);
379}
380
 
 
 
 
 
 
381static struct irq_chip mobiveil_msi_bottom_irq_chip = {
382	.name			= "Mobiveil MSI",
383	.irq_compose_msi_msg	= mobiveil_compose_msi_msg,
 
384};
385
386static int mobiveil_irq_msi_domain_alloc(struct irq_domain *domain,
387					 unsigned int virq,
388					 unsigned int nr_irqs, void *args)
389{
390	struct mobiveil_pcie *pcie = domain->host_data;
391	struct mobiveil_msi *msi = &pcie->rp.msi;
392	unsigned long bit;
393
394	WARN_ON(nr_irqs != 1);
395	mutex_lock(&msi->lock);
396
397	bit = find_first_zero_bit(msi->msi_irq_in_use, msi->num_of_vectors);
398	if (bit >= msi->num_of_vectors) {
399		mutex_unlock(&msi->lock);
400		return -ENOSPC;
401	}
402
403	set_bit(bit, msi->msi_irq_in_use);
404
405	mutex_unlock(&msi->lock);
406
407	irq_domain_set_info(domain, virq, bit, &mobiveil_msi_bottom_irq_chip,
408			    domain->host_data, handle_level_irq, NULL, NULL);
409	return 0;
410}
411
412static void mobiveil_irq_msi_domain_free(struct irq_domain *domain,
413					 unsigned int virq,
414					 unsigned int nr_irqs)
415{
416	struct irq_data *d = irq_domain_get_irq_data(domain, virq);
417	struct mobiveil_pcie *pcie = irq_data_get_irq_chip_data(d);
418	struct mobiveil_msi *msi = &pcie->rp.msi;
419
420	mutex_lock(&msi->lock);
421
422	if (!test_bit(d->hwirq, msi->msi_irq_in_use))
423		dev_err(&pcie->pdev->dev, "trying to free unused MSI#%lu\n",
424			d->hwirq);
425	else
426		__clear_bit(d->hwirq, msi->msi_irq_in_use);
427
428	mutex_unlock(&msi->lock);
429}
430static const struct irq_domain_ops msi_domain_ops = {
431	.alloc	= mobiveil_irq_msi_domain_alloc,
432	.free	= mobiveil_irq_msi_domain_free,
433};
434
435static int mobiveil_allocate_msi_domains(struct mobiveil_pcie *pcie)
436{
437	struct device *dev = &pcie->pdev->dev;
438	struct fwnode_handle *fwnode = of_node_to_fwnode(dev->of_node);
439	struct mobiveil_msi *msi = &pcie->rp.msi;
440
441	mutex_init(&msi->lock);
442	msi->dev_domain = irq_domain_add_linear(NULL, msi->num_of_vectors,
443						&msi_domain_ops, pcie);
444	if (!msi->dev_domain) {
445		dev_err(dev, "failed to create IRQ domain\n");
446		return -ENOMEM;
447	}
448
449	msi->msi_domain = pci_msi_create_irq_domain(fwnode,
450						    &mobiveil_msi_domain_info,
451						    msi->dev_domain);
452	if (!msi->msi_domain) {
453		dev_err(dev, "failed to create MSI domain\n");
454		irq_domain_remove(msi->dev_domain);
455		return -ENOMEM;
456	}
457
458	return 0;
459}
460
461static int mobiveil_pcie_init_irq_domain(struct mobiveil_pcie *pcie)
462{
463	struct device *dev = &pcie->pdev->dev;
464	struct device_node *node = dev->of_node;
465	struct mobiveil_root_port *rp = &pcie->rp;
 
466
467	/* setup INTx */
468	rp->intx_domain = irq_domain_add_linear(node, PCI_NUM_INTX,
469						&intx_domain_ops, pcie);
470
471	if (!rp->intx_domain) {
472		dev_err(dev, "Failed to get a INTx IRQ domain\n");
473		return -ENOMEM;
474	}
475
476	raw_spin_lock_init(&rp->intx_mask_lock);
477
478	/* setup MSI */
479	return mobiveil_allocate_msi_domains(pcie);
 
 
 
 
480}
481
482static int mobiveil_pcie_integrated_interrupt_init(struct mobiveil_pcie *pcie)
483{
484	struct platform_device *pdev = pcie->pdev;
485	struct device *dev = &pdev->dev;
486	struct mobiveil_root_port *rp = &pcie->rp;
487	struct resource *res;
488	int ret;
489
490	/* map MSI config resource */
491	res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "apb_csr");
492	pcie->apb_csr_base = devm_pci_remap_cfg_resource(dev, res);
493	if (IS_ERR(pcie->apb_csr_base))
494		return PTR_ERR(pcie->apb_csr_base);
495
496	/* setup MSI hardware registers */
497	mobiveil_pcie_enable_msi(pcie);
498
499	rp->irq = platform_get_irq(pdev, 0);
500	if (rp->irq < 0)
501		return rp->irq;
502
503	/* initialize the IRQ domains */
504	ret = mobiveil_pcie_init_irq_domain(pcie);
505	if (ret) {
506		dev_err(dev, "Failed creating IRQ Domain\n");
507		return ret;
508	}
509
510	irq_set_chained_handler_and_data(rp->irq, mobiveil_pcie_isr, pcie);
511
512	/* Enable interrupts */
513	mobiveil_csr_writel(pcie, (PAB_INTP_INTX_MASK | PAB_INTP_MSI_MASK),
514			    PAB_INTP_AMBA_MISC_ENB);
515
516
517	return 0;
518}
519
520static int mobiveil_pcie_interrupt_init(struct mobiveil_pcie *pcie)
521{
522	struct mobiveil_root_port *rp = &pcie->rp;
523
524	if (rp->ops->interrupt_init)
525		return rp->ops->interrupt_init(pcie);
526
527	return mobiveil_pcie_integrated_interrupt_init(pcie);
528}
529
530static bool mobiveil_pcie_is_bridge(struct mobiveil_pcie *pcie)
531{
532	u32 header_type;
533
534	header_type = mobiveil_csr_readb(pcie, PCI_HEADER_TYPE);
535	header_type &= PCI_HEADER_TYPE_MASK;
536
537	return header_type == PCI_HEADER_TYPE_BRIDGE;
538}
539
540int mobiveil_pcie_host_probe(struct mobiveil_pcie *pcie)
541{
542	struct mobiveil_root_port *rp = &pcie->rp;
543	struct pci_host_bridge *bridge = rp->bridge;
544	struct device *dev = &pcie->pdev->dev;
545	int ret;
546
547	ret = mobiveil_pcie_parse_dt(pcie);
548	if (ret) {
549		dev_err(dev, "Parsing DT failed, ret: %x\n", ret);
550		return ret;
551	}
552
553	if (!mobiveil_pcie_is_bridge(pcie))
554		return -ENODEV;
555
556	/*
557	 * configure all inbound and outbound windows and prepare the RC for
558	 * config access
559	 */
560	ret = mobiveil_host_init(pcie, false);
561	if (ret) {
562		dev_err(dev, "Failed to initialize host\n");
563		return ret;
564	}
565
566	ret = mobiveil_pcie_interrupt_init(pcie);
567	if (ret) {
568		dev_err(dev, "Interrupt init failed\n");
569		return ret;
570	}
571
572	/* Initialize bridge */
573	bridge->sysdata = pcie;
574	bridge->ops = &mobiveil_pcie_ops;
575
576	ret = mobiveil_bringup_link(pcie);
577	if (ret) {
578		dev_info(dev, "link bring-up failed\n");
579		return ret;
580	}
581
582	return pci_host_probe(bridge);
583}