License cleanup: add SPDX GPL-2.0 license identifier to files with no license
Many source files in the tree are missing licensing information, which
makes it harder for compliance tools to determine the correct license.
By default all files without license information are under the default
license of the kernel, which is GPL version 2.
Update the files which contain no license information with the 'GPL-2.0'
SPDX license identifier. The SPDX identifier is a legally binding
shorthand, which can be used instead of the full boiler plate text.
This patch is based on work done by Thomas Gleixner and Kate Stewart and
Philippe Ombredanne.
How this work was done:
Patches were generated and checked against linux-4.14-rc6 for a subset of
the use cases:
- file had no licensing information it it.
- file was a */uapi/* one with no licensing information in it,
- file was a */uapi/* one with existing licensing information,
Further patches will be generated in subsequent months to fix up cases
where non-standard license headers were used, and references to license
had to be inferred by heuristics based on keywords.
The analysis to determine which SPDX License Identifier to be applied to
a file was done in a spreadsheet of side by side results from of the
output of two independent scanners (ScanCode & Windriver) producing SPDX
tag:value files created by Philippe Ombredanne. Philippe prepared the
base worksheet, and did an initial spot review of a few 1000 files.
The 4.13 kernel was the starting point of the analysis with 60,537 files
assessed. Kate Stewart did a file by file comparison of the scanner
results in the spreadsheet to determine which SPDX license identifier(s)
to be applied to the file. She confirmed any determination that was not
immediately clear with lawyers working with the Linux Foundation.
Criteria used to select files for SPDX license identifier tagging was:
- Files considered eligible had to be source code files.
- Make and config files were included as candidates if they contained >5
lines of source
- File already had some variant of a license header in it (even if <5
lines).
All documentation files were explicitly excluded.
The following heuristics were used to determine which SPDX license
identifiers to apply.
- when both scanners couldn't find any license traces, file was
considered to have no license information in it, and the top level
COPYING file license applied.
For non */uapi/* files that summary was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 11139
and resulted in the first patch in this series.
If that file was a */uapi/* path one, it was "GPL-2.0 WITH
Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 WITH Linux-syscall-note 930
and resulted in the second patch in this series.
- if a file had some form of licensing information in it, and was one
of the */uapi/* ones, it was denoted with the Linux-syscall-note if
any GPL family license was found in the file or had no licensing in
it (per prior point). Results summary:
SPDX license identifier # files
---------------------------------------------------|------
GPL-2.0 WITH Linux-syscall-note 270
GPL-2.0+ WITH Linux-syscall-note 169
((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21
((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17
LGPL-2.1+ WITH Linux-syscall-note 15
GPL-1.0+ WITH Linux-syscall-note 14
((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5
LGPL-2.0+ WITH Linux-syscall-note 4
LGPL-2.1 WITH Linux-syscall-note 3
((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3
((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1
and that resulted in the third patch in this series.
- when the two scanners agreed on the detected license(s), that became
the concluded license(s).
- when there was disagreement between the two scanners (one detected a
license but the other didn't, or they both detected different
licenses) a manual inspection of the file occurred.
- In most cases a manual inspection of the information in the file
resulted in a clear resolution of the license that should apply (and
which scanner probably needed to revisit its heuristics).
- When it was not immediately clear, the license identifier was
confirmed with lawyers working with the Linux Foundation.
- If there was any question as to the appropriate license identifier,
the file was flagged for further research and to be revisited later
in time.
In total, over 70 hours of logged manual review was done on the
spreadsheet to determine the SPDX license identifiers to apply to the
source files by Kate, Philippe, Thomas and, in some cases, confirmation
by lawyers working with the Linux Foundation.
Kate also obtained a third independent scan of the 4.13 code base from
FOSSology, and compared selected files where the other two scanners
disagreed against that SPDX file, to see if there was new insights. The
Windriver scanner is based on an older version of FOSSology in part, so
they are related.
Thomas did random spot checks in about 500 files from the spreadsheets
for the uapi headers and agreed with SPDX license identifier in the
files he inspected. For the non-uapi files Thomas did random spot checks
in about 15000 files.
In initial set of patches against 4.14-rc6, 3 files were found to have
copy/paste license identifier errors, and have been fixed to reflect the
correct identifier.
Additionally Philippe spent 10 hours this week doing a detailed manual
inspection and review of the 12,461 patched files from the initial patch
version early this week with:
- a full scancode scan run, collecting the matched texts, detected
license ids and scores
- reviewing anything where there was a license detected (about 500+
files) to ensure that the applied SPDX license was correct
- reviewing anything where there was no detection but the patch license
was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied
SPDX license was correct
This produced a worksheet with 20 files needing minor correction. This
worksheet was then exported into 3 different .csv files for the
different types of files to be modified.
These .csv files were then reviewed by Greg. Thomas wrote a script to
parse the csv files and add the proper SPDX tag to the file, in the
format that the file expected. This script was further refined by Greg
based on the output to detect more types of files automatically and to
distinguish between header and source .c files (which need different
comment types.) Finally Greg ran the script using the .csv files to
generate the patches.
Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org>
Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2017-11-01 14:07:57 +00:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2006-10-04 09:16:59 +00:00
|
|
|
#ifndef LINUX_MSI_H
|
|
|
|
|
#define LINUX_MSI_H
|
|
|
|
|
|
2011-10-06 18:08:18 +00:00
|
|
|
#include <linux/kobject.h>
|
2007-04-05 07:19:10 +00:00
|
|
|
#include <linux/list.h>
|
2020-10-24 21:35:11 +00:00
|
|
|
#include <asm/msi.h>
|
|
|
|
|
|
|
|
|
|
/* Dummy shadow structures if an architecture does not define them */
|
|
|
|
|
#ifndef arch_msi_msg_addr_lo
|
|
|
|
|
typedef struct arch_msi_msg_addr_lo {
|
|
|
|
|
u32 address_lo;
|
|
|
|
|
} __attribute__ ((packed)) arch_msi_msg_addr_lo_t;
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#ifndef arch_msi_msg_addr_hi
|
|
|
|
|
typedef struct arch_msi_msg_addr_hi {
|
|
|
|
|
u32 address_hi;
|
|
|
|
|
} __attribute__ ((packed)) arch_msi_msg_addr_hi_t;
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#ifndef arch_msi_msg_data
|
|
|
|
|
typedef struct arch_msi_msg_data {
|
|
|
|
|
u32 data;
|
|
|
|
|
} __attribute__ ((packed)) arch_msi_msg_data_t;
|
|
|
|
|
#endif
|
2007-04-05 07:19:10 +00:00
|
|
|
|
2020-10-24 21:35:11 +00:00
|
|
|
/**
|
|
|
|
|
* msi_msg - Representation of a MSI message
|
|
|
|
|
* @address_lo: Low 32 bits of msi message address
|
|
|
|
|
* @arch_addrlo: Architecture specific shadow of @address_lo
|
|
|
|
|
* @address_hi: High 32 bits of msi message address
|
|
|
|
|
* (only used when device supports it)
|
|
|
|
|
* @arch_addrhi: Architecture specific shadow of @address_hi
|
|
|
|
|
* @data: MSI message data (usually 16 bits)
|
|
|
|
|
* @arch_data: Architecture specific shadow of @data
|
|
|
|
|
*/
|
2006-10-04 09:16:59 +00:00
|
|
|
struct msi_msg {
|
2020-10-24 21:35:11 +00:00
|
|
|
union {
|
|
|
|
|
u32 address_lo;
|
|
|
|
|
arch_msi_msg_addr_lo_t arch_addr_lo;
|
|
|
|
|
};
|
|
|
|
|
union {
|
|
|
|
|
u32 address_hi;
|
|
|
|
|
arch_msi_msg_addr_hi_t arch_addr_hi;
|
|
|
|
|
};
|
|
|
|
|
union {
|
|
|
|
|
u32 data;
|
|
|
|
|
arch_msi_msg_data_t arch_data;
|
|
|
|
|
};
|
2006-10-04 09:16:59 +00:00
|
|
|
};
|
|
|
|
|
|
2014-10-27 02:44:36 +00:00
|
|
|
extern int pci_msi_ignore_mask;
|
2007-01-18 04:50:05 +00:00
|
|
|
/* Helper functions */
|
2010-09-28 14:46:51 +00:00
|
|
|
struct irq_data;
|
2010-09-28 17:09:51 +00:00
|
|
|
struct msi_desc;
|
2015-07-09 08:00:45 +00:00
|
|
|
struct pci_dev;
|
2015-07-28 13:46:16 +00:00
|
|
|
struct platform_msi_priv_data;
|
2013-04-18 16:55:46 +00:00
|
|
|
void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
|
2017-02-14 21:53:12 +00:00
|
|
|
#ifdef CONFIG_GENERIC_MSI_IRQ
|
2013-04-18 16:55:46 +00:00
|
|
|
void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
|
2017-02-14 21:53:12 +00:00
|
|
|
#else
|
|
|
|
|
static inline void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
#endif
|
2014-11-09 15:10:33 +00:00
|
|
|
|
2015-07-28 13:46:16 +00:00
|
|
|
typedef void (*irq_write_msi_msg_t)(struct msi_desc *desc,
|
|
|
|
|
struct msi_msg *msg);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* platform_msi_desc - Platform device specific msi descriptor data
|
|
|
|
|
* @msi_priv_data: Pointer to platform private data
|
|
|
|
|
* @msi_index: The index of the MSI descriptor for multi MSI
|
|
|
|
|
*/
|
|
|
|
|
struct platform_msi_desc {
|
|
|
|
|
struct platform_msi_priv_data *msi_priv_data;
|
|
|
|
|
u16 msi_index;
|
|
|
|
|
};
|
|
|
|
|
|
2016-01-06 22:03:20 +00:00
|
|
|
/**
|
|
|
|
|
* fsl_mc_msi_desc - FSL-MC device specific msi descriptor data
|
|
|
|
|
* @msi_index: The index of the MSI descriptor
|
|
|
|
|
*/
|
|
|
|
|
struct fsl_mc_msi_desc {
|
|
|
|
|
u16 msi_index;
|
|
|
|
|
};
|
|
|
|
|
|
2019-04-30 10:12:28 +00:00
|
|
|
/**
|
|
|
|
|
* ti_sci_inta_msi_desc - TISCI based INTA specific msi descriptor data
|
|
|
|
|
* @dev_index: TISCI device index
|
|
|
|
|
*/
|
|
|
|
|
struct ti_sci_inta_msi_desc {
|
|
|
|
|
u16 dev_index;
|
|
|
|
|
};
|
|
|
|
|
|
2015-07-09 08:00:46 +00:00
|
|
|
/**
|
|
|
|
|
* struct msi_desc - Descriptor structure for MSI based interrupts
|
|
|
|
|
* @list: List head for management
|
|
|
|
|
* @irq: The base interrupt number
|
|
|
|
|
* @nvec_used: The number of vectors used
|
|
|
|
|
* @dev: Pointer to the device which uses this descriptor
|
|
|
|
|
* @msg: The last set MSI message cached for reuse
|
2016-07-04 08:39:26 +00:00
|
|
|
* @affinity: Optional pointer to a cpu affinity mask for this descriptor
|
2015-07-09 08:00:46 +00:00
|
|
|
*
|
2019-05-23 22:30:51 +00:00
|
|
|
* @write_msi_msg: Callback that may be called when the MSI message
|
|
|
|
|
* address or data changes
|
|
|
|
|
* @write_msi_msg_data: Data parameter for the callback.
|
|
|
|
|
*
|
2021-07-29 21:51:53 +00:00
|
|
|
* @msi_mask: [PCI MSI] MSI cached mask bits
|
|
|
|
|
* @msix_ctrl: [PCI MSI-X] MSI-X cached per vector control bits
|
2015-07-09 08:00:46 +00:00
|
|
|
* @is_msix: [PCI MSI/X] True if MSI-X
|
|
|
|
|
* @multiple: [PCI MSI/X] log2 num of messages allocated
|
|
|
|
|
* @multi_cap: [PCI MSI/X] log2 num of messages supported
|
|
|
|
|
* @maskbit: [PCI MSI/X] Mask-Pending bit supported?
|
|
|
|
|
* @is_64: [PCI MSI/X] Address size: 0=32bit 1=64bit
|
|
|
|
|
* @entry_nr: [PCI MSI/X] Entry which is described by this descriptor
|
|
|
|
|
* @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq
|
|
|
|
|
* @mask_pos: [PCI MSI] Mask register position
|
|
|
|
|
* @mask_base: [PCI MSI-X] Mask register base address
|
2015-07-28 13:46:16 +00:00
|
|
|
* @platform: [platform] Platform device specific msi descriptor data
|
2017-07-19 11:42:25 +00:00
|
|
|
* @fsl_mc: [fsl-mc] FSL MC device specific msi descriptor data
|
2019-04-30 10:12:28 +00:00
|
|
|
* @inta: [INTA] TISCI based INTA specific msi descriptor data
|
2015-07-09 08:00:46 +00:00
|
|
|
*/
|
2006-10-04 09:16:59 +00:00
|
|
|
struct msi_desc {
|
2015-07-09 08:00:46 +00:00
|
|
|
/* Shared device/bus type independent data */
|
|
|
|
|
struct list_head list;
|
|
|
|
|
unsigned int irq;
|
|
|
|
|
unsigned int nvec_used;
|
|
|
|
|
struct device *dev;
|
|
|
|
|
struct msi_msg msg;
|
2018-12-04 15:51:20 +00:00
|
|
|
struct irq_affinity_desc *affinity;
|
2019-05-01 13:58:18 +00:00
|
|
|
#ifdef CONFIG_IRQ_MSI_IOMMU
|
|
|
|
|
const void *iommu_cookie;
|
|
|
|
|
#endif
|
2006-10-04 09:16:59 +00:00
|
|
|
|
2019-05-23 22:30:51 +00:00
|
|
|
void (*write_msi_msg)(struct msi_desc *entry, void *data);
|
|
|
|
|
void *write_msi_msg_data;
|
|
|
|
|
|
2009-03-17 12:54:08 +00:00
|
|
|
union {
|
2015-07-09 08:00:46 +00:00
|
|
|
/* PCI MSI/X specific data */
|
|
|
|
|
struct {
|
2021-07-29 21:51:53 +00:00
|
|
|
union {
|
|
|
|
|
u32 msi_mask;
|
|
|
|
|
u32 msix_ctrl;
|
|
|
|
|
};
|
2015-07-09 08:00:46 +00:00
|
|
|
struct {
|
2019-02-08 16:54:38 +00:00
|
|
|
u8 is_msix : 1;
|
|
|
|
|
u8 multiple : 3;
|
|
|
|
|
u8 multi_cap : 3;
|
|
|
|
|
u8 maskbit : 1;
|
|
|
|
|
u8 is_64 : 1;
|
2019-05-23 22:30:51 +00:00
|
|
|
u8 is_virtual : 1;
|
2019-02-08 16:54:38 +00:00
|
|
|
u16 entry_nr;
|
2015-07-09 08:00:46 +00:00
|
|
|
unsigned default_irq;
|
|
|
|
|
} msi_attrib;
|
|
|
|
|
union {
|
|
|
|
|
u8 mask_pos;
|
|
|
|
|
void __iomem *mask_base;
|
|
|
|
|
};
|
|
|
|
|
};
|
2006-10-04 09:16:59 +00:00
|
|
|
|
2015-07-09 08:00:46 +00:00
|
|
|
/*
|
|
|
|
|
* Non PCI variants add their data structure here. New
|
|
|
|
|
* entries need to use a named structure. We want
|
|
|
|
|
* proper name spaces for this. The PCI part is
|
|
|
|
|
* anonymous for now as it would require an immediate
|
|
|
|
|
* tree wide cleanup.
|
|
|
|
|
*/
|
2015-07-28 13:46:16 +00:00
|
|
|
struct platform_msi_desc platform;
|
2016-01-06 22:03:20 +00:00
|
|
|
struct fsl_mc_msi_desc fsl_mc;
|
2019-04-30 10:12:28 +00:00
|
|
|
struct ti_sci_inta_msi_desc inta;
|
2015-07-09 08:00:46 +00:00
|
|
|
};
|
2006-10-04 09:16:59 +00:00
|
|
|
};
|
|
|
|
|
|
2014-11-15 14:24:03 +00:00
|
|
|
/* Helpers to hide struct msi_desc implementation details */
|
2015-07-09 08:00:45 +00:00
|
|
|
#define msi_desc_to_dev(desc) ((desc)->dev)
|
2015-07-09 08:00:44 +00:00
|
|
|
#define dev_to_msi_list(dev) (&(dev)->msi_list)
|
2014-11-15 14:24:03 +00:00
|
|
|
#define first_msi_entry(dev) \
|
|
|
|
|
list_first_entry(dev_to_msi_list((dev)), struct msi_desc, list)
|
|
|
|
|
#define for_each_msi_entry(desc, dev) \
|
|
|
|
|
list_for_each_entry((desc), dev_to_msi_list((dev)), list)
|
2018-10-11 09:12:34 +00:00
|
|
|
#define for_each_msi_entry_safe(desc, tmp, dev) \
|
|
|
|
|
list_for_each_entry_safe((desc), (tmp), dev_to_msi_list((dev)), list)
|
2021-01-23 12:27:59 +00:00
|
|
|
#define for_each_msi_vector(desc, __irq, dev) \
|
|
|
|
|
for_each_msi_entry((desc), (dev)) \
|
|
|
|
|
if ((desc)->irq) \
|
|
|
|
|
for (__irq = (desc)->irq; \
|
|
|
|
|
__irq < ((desc)->irq + (desc)->nvec_used); \
|
|
|
|
|
__irq++)
|
2014-11-15 14:24:03 +00:00
|
|
|
|
2019-05-01 13:58:18 +00:00
|
|
|
#ifdef CONFIG_IRQ_MSI_IOMMU
|
|
|
|
|
static inline const void *msi_desc_get_iommu_cookie(struct msi_desc *desc)
|
|
|
|
|
{
|
|
|
|
|
return desc->iommu_cookie;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static inline void msi_desc_set_iommu_cookie(struct msi_desc *desc,
|
|
|
|
|
const void *iommu_cookie)
|
|
|
|
|
{
|
|
|
|
|
desc->iommu_cookie = iommu_cookie;
|
|
|
|
|
}
|
|
|
|
|
#else
|
|
|
|
|
static inline const void *msi_desc_get_iommu_cookie(struct msi_desc *desc)
|
|
|
|
|
{
|
|
|
|
|
return NULL;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static inline void msi_desc_set_iommu_cookie(struct msi_desc *desc,
|
|
|
|
|
const void *iommu_cookie)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
2014-11-15 14:24:03 +00:00
|
|
|
#ifdef CONFIG_PCI_MSI
|
|
|
|
|
#define first_pci_msi_entry(pdev) first_msi_entry(&(pdev)->dev)
|
|
|
|
|
#define for_each_pci_msi_entry(desc, pdev) \
|
|
|
|
|
for_each_msi_entry((desc), &(pdev)->dev)
|
|
|
|
|
|
2015-07-09 08:00:45 +00:00
|
|
|
struct pci_dev *msi_desc_to_pci_dev(struct msi_desc *desc);
|
2015-07-09 08:00:36 +00:00
|
|
|
void *msi_desc_to_pci_sysdata(struct msi_desc *desc);
|
2017-02-14 21:53:12 +00:00
|
|
|
void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg);
|
2015-07-09 08:00:36 +00:00
|
|
|
#else /* CONFIG_PCI_MSI */
|
|
|
|
|
static inline void *msi_desc_to_pci_sysdata(struct msi_desc *desc)
|
|
|
|
|
{
|
|
|
|
|
return NULL;
|
|
|
|
|
}
|
2017-02-14 21:53:12 +00:00
|
|
|
static inline void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg)
|
|
|
|
|
{
|
|
|
|
|
}
|
2014-11-15 14:24:03 +00:00
|
|
|
#endif /* CONFIG_PCI_MSI */
|
|
|
|
|
|
2016-09-14 14:18:47 +00:00
|
|
|
struct msi_desc *alloc_msi_entry(struct device *dev, int nvec,
|
2018-12-04 15:51:20 +00:00
|
|
|
const struct irq_affinity_desc *affinity);
|
2015-07-09 08:00:47 +00:00
|
|
|
void free_msi_entry(struct msi_desc *entry);
|
2014-11-09 15:10:33 +00:00
|
|
|
void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
|
2014-11-09 15:10:34 +00:00
|
|
|
void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
|
|
|
|
|
|
2014-11-23 10:55:58 +00:00
|
|
|
void pci_msi_mask_irq(struct irq_data *data);
|
|
|
|
|
void pci_msi_unmask_irq(struct irq_data *data);
|
|
|
|
|
|
2006-10-04 09:16:59 +00:00
|
|
|
/*
|
2020-08-26 11:17:02 +00:00
|
|
|
* The arch hooks to setup up msi irqs. Default functions are implemented
|
|
|
|
|
* as weak symbols so that they /can/ be overriden by architecture specific
|
2021-03-30 15:11:39 +00:00
|
|
|
* code if needed. These hooks can only be enabled by the architecture.
|
2020-08-26 11:17:02 +00:00
|
|
|
*
|
|
|
|
|
* If CONFIG_PCI_MSI_ARCH_FALLBACKS is not selected they are replaced by
|
|
|
|
|
* stubs with warnings.
|
2006-10-04 09:16:59 +00:00
|
|
|
*/
|
2020-08-26 11:17:02 +00:00
|
|
|
#ifdef CONFIG_PCI_MSI_ARCH_FALLBACKS
|
2007-01-28 19:56:37 +00:00
|
|
|
int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
|
2006-10-04 09:16:59 +00:00
|
|
|
void arch_teardown_msi_irq(unsigned int irq);
|
2013-04-18 16:55:46 +00:00
|
|
|
int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
|
|
|
|
|
void arch_teardown_msi_irqs(struct pci_dev *dev);
|
2020-08-26 11:17:02 +00:00
|
|
|
#else
|
|
|
|
|
static inline int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type)
|
|
|
|
|
{
|
|
|
|
|
WARN_ON_ONCE(1);
|
|
|
|
|
return -ENODEV;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static inline void arch_teardown_msi_irqs(struct pci_dev *dev)
|
|
|
|
|
{
|
|
|
|
|
WARN_ON_ONCE(1);
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* The restore hooks are still available as they are useful even
|
|
|
|
|
* for fully irq domain based setups. Courtesy to XEN/X86.
|
|
|
|
|
*/
|
|
|
|
|
void arch_restore_msi_irqs(struct pci_dev *dev);
|
2013-12-04 05:09:16 +00:00
|
|
|
void default_restore_msi_irqs(struct pci_dev *dev);
|
2006-10-04 09:16:59 +00:00
|
|
|
|
2014-11-12 10:39:03 +00:00
|
|
|
#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
|
2014-11-15 14:24:04 +00:00
|
|
|
|
2014-11-15 14:24:05 +00:00
|
|
|
#include <linux/irqhandler.h>
|
2014-11-15 14:24:04 +00:00
|
|
|
|
2014-11-12 10:39:03 +00:00
|
|
|
struct irq_domain;
|
platform-msi: Allow creation of a MSI-based stacked irq domain
We almost have all the needed bits requiredable to create a irq domain
on top of a MSI domain.
For this, we enable a few things:
- the virq is stored in the msi_desc
- device, msi_alloc_info and domain-specific data
are stored in the platform_priv_data structure
- we introduce a new API for platform-msi:
/* Create a MSI-based domain */
struct irq_domain *
platform_msi_create_device_domain(struct device *dev,
unsigned int nvec,
irq_write_msi_msg_t write_msi_msg,
const struct irq_domain_ops *ops,
void *host_data);
/* Allocate MSIs in an MSI domain */
int platform_msi_domain_alloc(struct irq_domain *domain,
unsigned int virq,
unsigned int nr_irqs);
/* Free MSIs from an MSI domain */
void platform_msi_domain_free(struct irq_domain *domain,
unsigned int virq,
unsigned int nvec);
/* Obtain the host data passed to platform_msi_create_device_domain */
void *platform_msi_get_host_data(struct irq_domain *domain);
platform_msi_create_device_domain() is a hybrid of irqdomain creation
and interrupt allocation, creating a domain backed by the MSIs associated
to a device. IRQs can then be allocated in that domain using
platform_msi_domain_alloc().
This now allows a wired irq to MSI bridge to be created.
Signed-off-by: Marc Zyngier <marc.zyngier@arm.com>
2015-11-23 08:26:07 +00:00
|
|
|
struct irq_domain_ops;
|
2014-11-12 10:39:03 +00:00
|
|
|
struct irq_chip;
|
|
|
|
|
struct device_node;
|
2015-10-13 11:51:44 +00:00
|
|
|
struct fwnode_handle;
|
2014-11-12 10:39:03 +00:00
|
|
|
struct msi_domain_info;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* struct msi_domain_ops - MSI interrupt domain callbacks
|
|
|
|
|
* @get_hwirq: Retrieve the resulting hw irq number
|
|
|
|
|
* @msi_init: Domain specific init function for MSI interrupts
|
|
|
|
|
* @msi_free: Domain specific function to free a MSI interrupts
|
2014-11-15 14:24:04 +00:00
|
|
|
* @msi_check: Callback for verification of the domain/info/dev data
|
|
|
|
|
* @msi_prepare: Prepare the allocation of the interrupts in the domain
|
2015-12-21 13:13:08 +00:00
|
|
|
* @msi_finish: Optional callback to finalize the allocation
|
2014-11-15 14:24:04 +00:00
|
|
|
* @set_desc: Set the msi descriptor for an interrupt
|
|
|
|
|
* @handle_error: Optional error handler if the allocation fails
|
2020-08-26 11:16:57 +00:00
|
|
|
* @domain_alloc_irqs: Optional function to override the default allocation
|
|
|
|
|
* function.
|
|
|
|
|
* @domain_free_irqs: Optional function to override the default free
|
|
|
|
|
* function.
|
2014-11-15 14:24:04 +00:00
|
|
|
*
|
|
|
|
|
* @get_hwirq, @msi_init and @msi_free are callbacks used by
|
|
|
|
|
* msi_create_irq_domain() and related interfaces
|
|
|
|
|
*
|
|
|
|
|
* @msi_check, @msi_prepare, @msi_finish, @set_desc and @handle_error
|
2015-12-21 13:13:08 +00:00
|
|
|
* are callbacks used by msi_domain_alloc_irqs() and related
|
2014-11-15 14:24:04 +00:00
|
|
|
* interfaces which are based on msi_desc.
|
2020-08-26 11:16:57 +00:00
|
|
|
*
|
|
|
|
|
* @domain_alloc_irqs, @domain_free_irqs can be used to override the
|
|
|
|
|
* default allocation/free functions (__msi_domain_alloc/free_irqs). This
|
|
|
|
|
* is initially for a wrapper around XENs seperate MSI universe which can't
|
|
|
|
|
* be wrapped into the regular irq domains concepts by mere mortals. This
|
|
|
|
|
* allows to universally use msi_domain_alloc/free_irqs without having to
|
|
|
|
|
* special case XEN all over the place.
|
|
|
|
|
*
|
|
|
|
|
* Contrary to other operations @domain_alloc_irqs and @domain_free_irqs
|
|
|
|
|
* are set to the default implementation if NULL and even when
|
|
|
|
|
* MSI_FLAG_USE_DEF_DOM_OPS is not set to avoid breaking existing users and
|
|
|
|
|
* because these callbacks are obviously mandatory.
|
|
|
|
|
*
|
|
|
|
|
* This is NOT meant to be abused, but it can be useful to build wrappers
|
|
|
|
|
* for specialized MSI irq domains which need extra work before and after
|
|
|
|
|
* calling __msi_domain_alloc_irqs()/__msi_domain_free_irqs().
|
2014-11-12 10:39:03 +00:00
|
|
|
*/
|
|
|
|
|
struct msi_domain_ops {
|
2014-11-15 14:24:05 +00:00
|
|
|
irq_hw_number_t (*get_hwirq)(struct msi_domain_info *info,
|
|
|
|
|
msi_alloc_info_t *arg);
|
2014-11-12 10:39:03 +00:00
|
|
|
int (*msi_init)(struct irq_domain *domain,
|
|
|
|
|
struct msi_domain_info *info,
|
|
|
|
|
unsigned int virq, irq_hw_number_t hwirq,
|
2014-11-15 14:24:05 +00:00
|
|
|
msi_alloc_info_t *arg);
|
2014-11-12 10:39:03 +00:00
|
|
|
void (*msi_free)(struct irq_domain *domain,
|
|
|
|
|
struct msi_domain_info *info,
|
|
|
|
|
unsigned int virq);
|
2014-11-15 14:24:04 +00:00
|
|
|
int (*msi_check)(struct irq_domain *domain,
|
|
|
|
|
struct msi_domain_info *info,
|
|
|
|
|
struct device *dev);
|
|
|
|
|
int (*msi_prepare)(struct irq_domain *domain,
|
|
|
|
|
struct device *dev, int nvec,
|
|
|
|
|
msi_alloc_info_t *arg);
|
|
|
|
|
void (*msi_finish)(msi_alloc_info_t *arg, int retval);
|
|
|
|
|
void (*set_desc)(msi_alloc_info_t *arg,
|
|
|
|
|
struct msi_desc *desc);
|
|
|
|
|
int (*handle_error)(struct irq_domain *domain,
|
|
|
|
|
struct msi_desc *desc, int error);
|
2020-08-26 11:16:57 +00:00
|
|
|
int (*domain_alloc_irqs)(struct irq_domain *domain,
|
|
|
|
|
struct device *dev, int nvec);
|
|
|
|
|
void (*domain_free_irqs)(struct irq_domain *domain,
|
|
|
|
|
struct device *dev);
|
2014-11-12 10:39:03 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* struct msi_domain_info - MSI interrupt domain data
|
2014-11-15 14:24:05 +00:00
|
|
|
* @flags: Flags to decribe features and capabilities
|
|
|
|
|
* @ops: The callback data structure
|
|
|
|
|
* @chip: Optional: associated interrupt chip
|
|
|
|
|
* @chip_data: Optional: associated interrupt chip data
|
|
|
|
|
* @handler: Optional: associated interrupt flow handler
|
|
|
|
|
* @handler_data: Optional: associated interrupt flow handler data
|
|
|
|
|
* @handler_name: Optional: associated interrupt flow handler name
|
|
|
|
|
* @data: Optional: domain specific data
|
2014-11-12 10:39:03 +00:00
|
|
|
*/
|
|
|
|
|
struct msi_domain_info {
|
2014-11-15 14:24:05 +00:00
|
|
|
u32 flags;
|
2014-11-12 10:39:03 +00:00
|
|
|
struct msi_domain_ops *ops;
|
|
|
|
|
struct irq_chip *chip;
|
2014-11-15 14:24:05 +00:00
|
|
|
void *chip_data;
|
|
|
|
|
irq_flow_handler_t handler;
|
|
|
|
|
void *handler_data;
|
|
|
|
|
const char *handler_name;
|
2014-11-12 10:39:03 +00:00
|
|
|
void *data;
|
|
|
|
|
};
|
|
|
|
|
|
2014-11-15 14:24:05 +00:00
|
|
|
/* Flags for msi_domain_info */
|
|
|
|
|
enum {
|
|
|
|
|
/*
|
|
|
|
|
* Init non implemented ops callbacks with default MSI domain
|
|
|
|
|
* callbacks.
|
|
|
|
|
*/
|
|
|
|
|
MSI_FLAG_USE_DEF_DOM_OPS = (1 << 0),
|
|
|
|
|
/*
|
|
|
|
|
* Init non implemented chip callbacks with default MSI chip
|
|
|
|
|
* callbacks.
|
|
|
|
|
*/
|
|
|
|
|
MSI_FLAG_USE_DEF_CHIP_OPS = (1 << 1),
|
|
|
|
|
/* Support multiple PCI MSI interrupts */
|
2016-07-04 08:39:22 +00:00
|
|
|
MSI_FLAG_MULTI_PCI_MSI = (1 << 2),
|
2014-11-15 14:24:05 +00:00
|
|
|
/* Support PCI MSIX interrupts */
|
2016-07-04 08:39:22 +00:00
|
|
|
MSI_FLAG_PCI_MSIX = (1 << 3),
|
2016-07-13 16:18:33 +00:00
|
|
|
/* Needs early activate, required for PCI */
|
|
|
|
|
MSI_FLAG_ACTIVATE_EARLY = (1 << 4),
|
2017-09-13 21:29:13 +00:00
|
|
|
/*
|
|
|
|
|
* Must reactivate when irq is started even when
|
|
|
|
|
* MSI_FLAG_ACTIVATE_EARLY has been set.
|
|
|
|
|
*/
|
|
|
|
|
MSI_FLAG_MUST_REACTIVATE = (1 << 5),
|
genirq/msi: Allow level-triggered MSIs to be exposed by MSI providers
So far, MSIs have been used to signal edge-triggered interrupts, as
a write is a good model for an edge (you can't "unwrite" something).
On the other hand, routing zillions of wires in an SoC because you
need level interrupts is a bit extreme.
People have come up with a variety of schemes to support this, which
involves sending two messages: one to signal the interrupt, and one
to clear it. Since the kernel cannot represent this, we've ended up
with side-band mechanisms that are pretty awful.
Instead, let's acknoledge the requirement, and ensure that, under the
right circumstances, the irq_compose_msg and irq_write_msg can take
as a parameter an array of two messages instead of a pointer to a
single one. We also add some checking that the compose method only
clobbers the second message if the MSI domain has been created with
the MSI_FLAG_LEVEL_CAPABLE flags.
Signed-off-by: Marc Zyngier <marc.zyngier@arm.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Cc: Rob Herring <robh@kernel.org>
Cc: Jason Cooper <jason@lakedaemon.net>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Cc: Miquel Raynal <miquel.raynal@bootlin.com>
Link: https://lkml.kernel.org/r/20180508121438.11301-2-marc.zyngier@arm.com
2018-05-08 12:14:30 +00:00
|
|
|
/* Is level-triggered capable, using two messages */
|
|
|
|
|
MSI_FLAG_LEVEL_CAPABLE = (1 << 6),
|
2014-11-15 14:24:05 +00:00
|
|
|
};
|
|
|
|
|
|
2014-11-12 10:39:03 +00:00
|
|
|
int msi_domain_set_affinity(struct irq_data *data, const struct cpumask *mask,
|
|
|
|
|
bool force);
|
|
|
|
|
|
2015-10-13 11:51:44 +00:00
|
|
|
struct irq_domain *msi_create_irq_domain(struct fwnode_handle *fwnode,
|
2014-11-12 10:39:03 +00:00
|
|
|
struct msi_domain_info *info,
|
|
|
|
|
struct irq_domain *parent);
|
2020-08-26 11:16:57 +00:00
|
|
|
int __msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev,
|
|
|
|
|
int nvec);
|
2014-11-15 14:24:04 +00:00
|
|
|
int msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev,
|
|
|
|
|
int nvec);
|
2020-08-26 11:16:57 +00:00
|
|
|
void __msi_domain_free_irqs(struct irq_domain *domain, struct device *dev);
|
2014-11-15 14:24:04 +00:00
|
|
|
void msi_domain_free_irqs(struct irq_domain *domain, struct device *dev);
|
2014-11-12 10:39:03 +00:00
|
|
|
struct msi_domain_info *msi_get_domain_info(struct irq_domain *domain);
|
|
|
|
|
|
2015-10-13 11:51:44 +00:00
|
|
|
struct irq_domain *platform_msi_create_irq_domain(struct fwnode_handle *fwnode,
|
2015-07-28 13:46:16 +00:00
|
|
|
struct msi_domain_info *info,
|
|
|
|
|
struct irq_domain *parent);
|
|
|
|
|
int platform_msi_domain_alloc_irqs(struct device *dev, unsigned int nvec,
|
|
|
|
|
irq_write_msi_msg_t write_msi_msg);
|
|
|
|
|
void platform_msi_domain_free_irqs(struct device *dev);
|
2015-11-23 08:26:05 +00:00
|
|
|
|
|
|
|
|
/* When an MSI domain is used as an intermediate domain */
|
|
|
|
|
int msi_domain_prepare_irqs(struct irq_domain *domain, struct device *dev,
|
|
|
|
|
int nvec, msi_alloc_info_t *args);
|
2015-11-23 08:26:06 +00:00
|
|
|
int msi_domain_populate_irqs(struct irq_domain *domain, struct device *dev,
|
|
|
|
|
int virq, int nvec, msi_alloc_info_t *args);
|
platform-msi: Allow creation of a MSI-based stacked irq domain
We almost have all the needed bits requiredable to create a irq domain
on top of a MSI domain.
For this, we enable a few things:
- the virq is stored in the msi_desc
- device, msi_alloc_info and domain-specific data
are stored in the platform_priv_data structure
- we introduce a new API for platform-msi:
/* Create a MSI-based domain */
struct irq_domain *
platform_msi_create_device_domain(struct device *dev,
unsigned int nvec,
irq_write_msi_msg_t write_msi_msg,
const struct irq_domain_ops *ops,
void *host_data);
/* Allocate MSIs in an MSI domain */
int platform_msi_domain_alloc(struct irq_domain *domain,
unsigned int virq,
unsigned int nr_irqs);
/* Free MSIs from an MSI domain */
void platform_msi_domain_free(struct irq_domain *domain,
unsigned int virq,
unsigned int nvec);
/* Obtain the host data passed to platform_msi_create_device_domain */
void *platform_msi_get_host_data(struct irq_domain *domain);
platform_msi_create_device_domain() is a hybrid of irqdomain creation
and interrupt allocation, creating a domain backed by the MSIs associated
to a device. IRQs can then be allocated in that domain using
platform_msi_domain_alloc().
This now allows a wired irq to MSI bridge to be created.
Signed-off-by: Marc Zyngier <marc.zyngier@arm.com>
2015-11-23 08:26:07 +00:00
|
|
|
struct irq_domain *
|
2018-10-01 14:13:45 +00:00
|
|
|
__platform_msi_create_device_domain(struct device *dev,
|
|
|
|
|
unsigned int nvec,
|
|
|
|
|
bool is_tree,
|
|
|
|
|
irq_write_msi_msg_t write_msi_msg,
|
|
|
|
|
const struct irq_domain_ops *ops,
|
|
|
|
|
void *host_data);
|
|
|
|
|
|
|
|
|
|
#define platform_msi_create_device_domain(dev, nvec, write, ops, data) \
|
|
|
|
|
__platform_msi_create_device_domain(dev, nvec, false, write, ops, data)
|
|
|
|
|
#define platform_msi_create_device_tree_domain(dev, nvec, write, ops, data) \
|
|
|
|
|
__platform_msi_create_device_domain(dev, nvec, true, write, ops, data)
|
|
|
|
|
|
platform-msi: Allow creation of a MSI-based stacked irq domain
We almost have all the needed bits requiredable to create a irq domain
on top of a MSI domain.
For this, we enable a few things:
- the virq is stored in the msi_desc
- device, msi_alloc_info and domain-specific data
are stored in the platform_priv_data structure
- we introduce a new API for platform-msi:
/* Create a MSI-based domain */
struct irq_domain *
platform_msi_create_device_domain(struct device *dev,
unsigned int nvec,
irq_write_msi_msg_t write_msi_msg,
const struct irq_domain_ops *ops,
void *host_data);
/* Allocate MSIs in an MSI domain */
int platform_msi_domain_alloc(struct irq_domain *domain,
unsigned int virq,
unsigned int nr_irqs);
/* Free MSIs from an MSI domain */
void platform_msi_domain_free(struct irq_domain *domain,
unsigned int virq,
unsigned int nvec);
/* Obtain the host data passed to platform_msi_create_device_domain */
void *platform_msi_get_host_data(struct irq_domain *domain);
platform_msi_create_device_domain() is a hybrid of irqdomain creation
and interrupt allocation, creating a domain backed by the MSIs associated
to a device. IRQs can then be allocated in that domain using
platform_msi_domain_alloc().
This now allows a wired irq to MSI bridge to be created.
Signed-off-by: Marc Zyngier <marc.zyngier@arm.com>
2015-11-23 08:26:07 +00:00
|
|
|
int platform_msi_domain_alloc(struct irq_domain *domain, unsigned int virq,
|
|
|
|
|
unsigned int nr_irqs);
|
|
|
|
|
void platform_msi_domain_free(struct irq_domain *domain, unsigned int virq,
|
|
|
|
|
unsigned int nvec);
|
|
|
|
|
void *platform_msi_get_host_data(struct irq_domain *domain);
|
2014-11-12 10:39:03 +00:00
|
|
|
#endif /* CONFIG_GENERIC_MSI_IRQ_DOMAIN */
|
|
|
|
|
|
2014-11-11 13:02:18 +00:00
|
|
|
#ifdef CONFIG_PCI_MSI_IRQ_DOMAIN
|
|
|
|
|
void pci_msi_domain_write_msg(struct irq_data *irq_data, struct msi_msg *msg);
|
2015-10-13 11:51:44 +00:00
|
|
|
struct irq_domain *pci_msi_create_irq_domain(struct fwnode_handle *fwnode,
|
2014-11-11 13:02:18 +00:00
|
|
|
struct msi_domain_info *info,
|
|
|
|
|
struct irq_domain *parent);
|
|
|
|
|
int pci_msi_domain_check_cap(struct irq_domain *domain,
|
|
|
|
|
struct msi_domain_info *info, struct device *dev);
|
2015-10-08 22:10:49 +00:00
|
|
|
u32 pci_msi_domain_get_msi_rid(struct irq_domain *domain, struct pci_dev *pdev);
|
2015-10-02 13:43:06 +00:00
|
|
|
struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev);
|
2020-08-26 11:16:53 +00:00
|
|
|
bool pci_dev_has_special_msi_domain(struct pci_dev *pdev);
|
2015-10-02 13:43:06 +00:00
|
|
|
#else
|
|
|
|
|
static inline struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev)
|
|
|
|
|
{
|
|
|
|
|
return NULL;
|
|
|
|
|
}
|
2014-11-11 13:02:18 +00:00
|
|
|
#endif /* CONFIG_PCI_MSI_IRQ_DOMAIN */
|
|
|
|
|
|
2006-10-04 09:16:59 +00:00
|
|
|
#endif /* LINUX_MSI_H */
|