mirror of
				https://github.com/torvalds/linux.git
				synced 2025-11-04 10:40:15 +02:00 
			
		
		
		
	Fix kernel-doc formatting throughout drivers/pci and related include files. No change to functionality intended. Check for warnings: $ find include drivers/pci -type f -path "*pci*.[ch]" | xargs scripts/kernel-doc -none [bhelgaas: squashed to one commit] Link: https://lore.kernel.org/r/20210509030237.368540-1-kw@linux.com Link: https://lore.kernel.org/r/20210703151306.1922450-1-kw@linux.com Link: https://lore.kernel.org/r/20210703151306.1922450-2-kw@linux.com Link: https://lore.kernel.org/r/20210703151306.1922450-3-kw@linux.com Link: https://lore.kernel.org/r/20210703151306.1922450-4-kw@linux.com Link: https://lore.kernel.org/r/20210703151306.1922450-5-kw@linux.com Signed-off-by: Krzysztof Wilczyński <kw@linux.com> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
		
			
				
	
	
		
			131 lines
		
	
	
	
		
			4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			131 lines
		
	
	
	
		
			4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/* SPDX-License-Identifier: GPL-2.0 */
 | 
						|
/*
 | 
						|
 * Copyright (C) 2014-2015 Broadcom Corporation
 | 
						|
 */
 | 
						|
 | 
						|
#ifndef _PCIE_IPROC_H
 | 
						|
#define _PCIE_IPROC_H
 | 
						|
 | 
						|
/**
 | 
						|
 * enum iproc_pcie_type - iProc PCIe interface type
 | 
						|
 * @IPROC_PCIE_PAXB_BCMA: BCMA-based host controllers
 | 
						|
 * @IPROC_PCIE_PAXB:	  PAXB-based host controllers for
 | 
						|
 *			  NS, NSP, Cygnus, NS2, and Pegasus SOCs
 | 
						|
 * @IPROC_PCIE_PAXB_V2:   PAXB-based host controllers for Stingray SoCs
 | 
						|
 * @IPROC_PCIE_PAXC:	  PAXC-based host controllers
 | 
						|
 * @IPROC_PCIE_PAXC_V2:   PAXC-based host controllers (second generation)
 | 
						|
 *
 | 
						|
 * PAXB is the wrapper used in root complex that can be connected to an
 | 
						|
 * external endpoint device.
 | 
						|
 *
 | 
						|
 * PAXC is the wrapper used in root complex dedicated for internal emulated
 | 
						|
 * endpoint devices.
 | 
						|
 */
 | 
						|
enum iproc_pcie_type {
 | 
						|
	IPROC_PCIE_PAXB_BCMA = 0,
 | 
						|
	IPROC_PCIE_PAXB,
 | 
						|
	IPROC_PCIE_PAXB_V2,
 | 
						|
	IPROC_PCIE_PAXC,
 | 
						|
	IPROC_PCIE_PAXC_V2,
 | 
						|
};
 | 
						|
 | 
						|
/**
 | 
						|
 * struct iproc_pcie_ob - iProc PCIe outbound mapping
 | 
						|
 * @axi_offset: offset from the AXI address to the internal address used by
 | 
						|
 * the iProc PCIe core
 | 
						|
 * @nr_windows: total number of supported outbound mapping windows
 | 
						|
 */
 | 
						|
struct iproc_pcie_ob {
 | 
						|
	resource_size_t axi_offset;
 | 
						|
	unsigned int nr_windows;
 | 
						|
};
 | 
						|
 | 
						|
/**
 | 
						|
 * struct iproc_pcie_ib - iProc PCIe inbound mapping
 | 
						|
 * @nr_regions: total number of supported inbound mapping regions
 | 
						|
 */
 | 
						|
struct iproc_pcie_ib {
 | 
						|
	unsigned int nr_regions;
 | 
						|
};
 | 
						|
 | 
						|
struct iproc_pcie_ob_map;
 | 
						|
struct iproc_pcie_ib_map;
 | 
						|
struct iproc_msi;
 | 
						|
 | 
						|
/**
 | 
						|
 * struct iproc_pcie - iProc PCIe device
 | 
						|
 * @dev: pointer to device data structure
 | 
						|
 * @type: iProc PCIe interface type
 | 
						|
 * @reg_offsets: register offsets
 | 
						|
 * @base: PCIe host controller I/O register base
 | 
						|
 * @base_addr: PCIe host controller register base physical address
 | 
						|
 * @mem: host bridge memory window resource
 | 
						|
 * @phy: optional PHY device that controls the Serdes
 | 
						|
 * @map_irq: function callback to map interrupts
 | 
						|
 * @ep_is_internal: indicates an internal emulated endpoint device is connected
 | 
						|
 * @iproc_cfg_read: indicates the iProc config read function should be used
 | 
						|
 * @rej_unconfig_pf: indicates the root complex needs to detect and reject
 | 
						|
 * enumeration against unconfigured physical functions emulated in the ASIC
 | 
						|
 * @has_apb_err_disable: indicates the controller can be configured to prevent
 | 
						|
 * unsupported request from being forwarded as an APB bus error
 | 
						|
 * @fix_paxc_cap: indicates the controller has corrupted capability list in its
 | 
						|
 * config space registers and requires SW based fixup
 | 
						|
 *
 | 
						|
 * @need_ob_cfg: indicates SW needs to configure the outbound mapping window
 | 
						|
 * @ob: outbound mapping related parameters
 | 
						|
 * @ob_map: outbound mapping related parameters specific to the controller
 | 
						|
 *
 | 
						|
 * @need_ib_cfg: indicates SW needs to configure the inbound mapping window
 | 
						|
 * @ib: inbound mapping related parameters
 | 
						|
 * @ib_map: outbound mapping region related parameters
 | 
						|
 *
 | 
						|
 * @need_msi_steer: indicates additional configuration of the iProc PCIe
 | 
						|
 * controller is required to steer MSI writes to external interrupt controller
 | 
						|
 * @msi: MSI data
 | 
						|
 */
 | 
						|
struct iproc_pcie {
 | 
						|
	struct device *dev;
 | 
						|
	enum iproc_pcie_type type;
 | 
						|
	u16 *reg_offsets;
 | 
						|
	void __iomem *base;
 | 
						|
	phys_addr_t base_addr;
 | 
						|
	struct resource mem;
 | 
						|
	struct phy *phy;
 | 
						|
	int (*map_irq)(const struct pci_dev *, u8, u8);
 | 
						|
	bool ep_is_internal;
 | 
						|
	bool iproc_cfg_read;
 | 
						|
	bool rej_unconfig_pf;
 | 
						|
	bool has_apb_err_disable;
 | 
						|
	bool fix_paxc_cap;
 | 
						|
 | 
						|
	bool need_ob_cfg;
 | 
						|
	struct iproc_pcie_ob ob;
 | 
						|
	const struct iproc_pcie_ob_map *ob_map;
 | 
						|
 | 
						|
	bool need_ib_cfg;
 | 
						|
	struct iproc_pcie_ib ib;
 | 
						|
	const struct iproc_pcie_ib_map *ib_map;
 | 
						|
 | 
						|
	bool need_msi_steer;
 | 
						|
	struct iproc_msi *msi;
 | 
						|
};
 | 
						|
 | 
						|
int iproc_pcie_setup(struct iproc_pcie *pcie, struct list_head *res);
 | 
						|
int iproc_pcie_remove(struct iproc_pcie *pcie);
 | 
						|
int iproc_pcie_shutdown(struct iproc_pcie *pcie);
 | 
						|
 | 
						|
#ifdef CONFIG_PCIE_IPROC_MSI
 | 
						|
int iproc_msi_init(struct iproc_pcie *pcie, struct device_node *node);
 | 
						|
void iproc_msi_exit(struct iproc_pcie *pcie);
 | 
						|
#else
 | 
						|
static inline int iproc_msi_init(struct iproc_pcie *pcie,
 | 
						|
				 struct device_node *node)
 | 
						|
{
 | 
						|
	return -ENODEV;
 | 
						|
}
 | 
						|
static inline void iproc_msi_exit(struct iproc_pcie *pcie)
 | 
						|
{
 | 
						|
}
 | 
						|
#endif
 | 
						|
 | 
						|
#endif /* _PCIE_IPROC_H */
 |