GitHub-Mirror/Star64_linux
2
0
Fork 0
mirror of https://github.com/Fishwaldo/Star64_linux.git synced 2025-06-26 00:21:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

genirq: Fix kernel-doc warnings in pm.c, msi.c and ipi.c

Browse source 
Fix all kernel-doc warnings in these 3 files and do some simple editing
(capitalize acronyms, capitalize Linux).

kernel/irq/pm.c:235: warning: expecting prototype for irq_pm_syscore_ops(). Prototype was for irq_pm_syscore_resume() instead
kernel/irq/msi.c:530: warning: expecting prototype for __msi_domain_free_irqs(). Prototype was for msi_domain_free_irqs() instead
kernel/irq/msi.c:31: warning: No description found for return value of 'alloc_msi_entry'
kernel/irq/msi.c:103: warning: No description found for return value of 'msi_domain_set_affinity'
kernel/irq/msi.c:288: warning: No description found for return value of 'msi_create_irq_domain'
kernel/irq/msi.c:499: warning: No description found for return value of 'msi_domain_alloc_irqs'
kernel/irq/msi.c:545: warning: No description found for return value of 'msi_get_domain_info'
kernel/irq/ipi.c:264: warning: expecting prototype for ipi_send_mask(). Prototype was for __ipi_send_mask() instead
kernel/irq/ipi.c:25: warning: No description found for return value of 'irq_reserve_ipi'
kernel/irq/ipi.c:116: warning: No description found for return value of 'irq_destroy_ipi'
kernel/irq/ipi.c:163: warning: No description found for return value of 'ipi_get_hwirq'
kernel/irq/ipi.c:222: warning: No description found for return value of '__ipi_send_single'
kernel/irq/ipi.c:308: warning: No description found for return value of 'ipi_send_single'
kernel/irq/ipi.c:329: warning: No description found for return value of 'ipi_send_mask'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/20210810234835.12547-1-rdunlap@infradead.org
This commit is contained in:
Randy Dunlap 2021-08-10 16:48:35 -07:00 • committed by Thomas Gleixner
parent 290fdc4b7e
commit 3b35e7e6da
3 changed files with 29 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

32
kernel/irq/ipi.c
View file

@ -14,11 +14,11 @@
/** /**
* irq_reserve_ipi() - Setup an IPI to destination cpumask * irq_reserve_ipi() - Setup an IPI to destination cpumask
* @domain: IPI domain * @domain: IPI domain
* @dest: cpumask of cpus which can receive the IPI * @dest: cpumask of CPUs which can receive the IPI
* *
* Allocate a virq that can be used to send IPI to any CPU in dest mask. * Allocate a virq that can be used to send IPI to any CPU in dest mask.
* *
* On success it'll return linux irq number and error code on failure * Return: Linux IRQ number on success or error code on failure
*/ */
int irq_reserve_ipi(struct irq_domain *domain, int irq_reserve_ipi(struct irq_domain *domain,
const struct cpumask *dest) const struct cpumask *dest)
@ -104,13 +104,13 @@ free_descs:
/** /**
* irq_destroy_ipi() - unreserve an IPI that was previously allocated * irq_destroy_ipi() - unreserve an IPI that was previously allocated
* @irq: linux irq number to be destroyed * @irq: Linux IRQ number to be destroyed
* @dest: cpumask of cpus which should have the IPI removed * @dest: cpumask of CPUs which should have the IPI removed
* *
* The IPIs allocated with irq_reserve_ipi() are returned to the system * The IPIs allocated with irq_reserve_ipi() are returned to the system
* destroying all virqs associated with them. * destroying all virqs associated with them.
* *
* Return 0 on success or error code on failure. * Return: %0 on success or error code on failure.
*/ */
int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest) int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest)
{ {
@ -150,14 +150,14 @@ int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest)
} }
/** /**
* ipi_get_hwirq - Get the hwirq associated with an IPI to a cpu * ipi_get_hwirq - Get the hwirq associated with an IPI to a CPU
* @irq: linux irq number * @irq: Linux IRQ number
* @cpu: the target cpu * @cpu: the target CPU
* *
* When dealing with coprocessors IPI, we need to inform the coprocessor of * When dealing with coprocessors IPI, we need to inform the coprocessor of
* the hwirq it needs to use to receive and send IPIs. * the hwirq it needs to use to receive and send IPIs.
* *
* Returns hwirq value on success and INVALID_HWIRQ on failure. * Return: hwirq value on success or INVALID_HWIRQ on failure.
*/ */
irq_hw_number_t ipi_get_hwirq(unsigned int irq, unsigned int cpu) irq_hw_number_t ipi_get_hwirq(unsigned int irq, unsigned int cpu)
{ {
@ -216,7 +216,7 @@ static int ipi_send_verify(struct irq_chip *chip, struct irq_data *data,
* This function is for architecture or core code to speed up IPI sending. Not * This function is for architecture or core code to speed up IPI sending. Not
* usable from driver code. * usable from driver code.
* *
* Returns zero on success and negative error number on failure. * Return: %0 on success or negative error number on failure.
*/ */
int __ipi_send_single(struct irq_desc *desc, unsigned int cpu) int __ipi_send_single(struct irq_desc *desc, unsigned int cpu)
{ {
@ -250,7 +250,7 @@ int __ipi_send_single(struct irq_desc *desc, unsigned int cpu)
} }
/** /**
* ipi_send_mask - send an IPI to target Linux SMP CPU(s) * __ipi_send_mask - send an IPI to target Linux SMP CPU(s)
* @desc: pointer to irq_desc of the IRQ * @desc: pointer to irq_desc of the IRQ
* @dest: dest CPU(s), must be a subset of the mask passed to * @dest: dest CPU(s), must be a subset of the mask passed to
* irq_reserve_ipi() * irq_reserve_ipi()
@ -258,7 +258,7 @@ int __ipi_send_single(struct irq_desc *desc, unsigned int cpu)
* This function is for architecture or core code to speed up IPI sending. Not * This function is for architecture or core code to speed up IPI sending. Not
* usable from driver code. * usable from driver code.
* *
* Returns zero on success and negative error number on failure. * Return: %0 on success or negative error number on failure.
*/ */
int __ipi_send_mask(struct irq_desc *desc, const struct cpumask *dest) int __ipi_send_mask(struct irq_desc *desc, const struct cpumask *dest)
{ {
@ -298,11 +298,11 @@ int __ipi_send_mask(struct irq_desc *desc, const struct cpumask *dest)
/** /**
* ipi_send_single - Send an IPI to a single CPU * ipi_send_single - Send an IPI to a single CPU
* @virq: linux irq number from irq_reserve_ipi() * @virq: Linux IRQ number from irq_reserve_ipi()
* @cpu: destination CPU, must in the destination mask passed to * @cpu: destination CPU, must in the destination mask passed to
* irq_reserve_ipi() * irq_reserve_ipi()
* *
* Returns zero on success and negative error number on failure. * Return: %0 on success or negative error number on failure.
*/ */
int ipi_send_single(unsigned int virq, unsigned int cpu) int ipi_send_single(unsigned int virq, unsigned int cpu)
{ {
@ -319,11 +319,11 @@ EXPORT_SYMBOL_GPL(ipi_send_single);
/** /**
* ipi_send_mask - Send an IPI to target CPU(s) * ipi_send_mask - Send an IPI to target CPU(s)
* @virq: linux irq number from irq_reserve_ipi() * @virq: Linux IRQ number from irq_reserve_ipi()
* @dest: dest CPU(s), must be a subset of the mask passed to * @dest: dest CPU(s), must be a subset of the mask passed to
* irq_reserve_ipi() * irq_reserve_ipi()
* *
* Returns zero on success and negative error number on failure. * Return: %0 on success or negative error number on failure.
*/ */
int ipi_send_mask(unsigned int virq, const struct cpumask *dest) int ipi_send_mask(unsigned int virq, const struct cpumask *dest)
{ {

19
kernel/irq/msi.c
View file

@ -18,13 +18,15 @@
#include "internals.h" #include "internals.h"
/** /**
* alloc_msi_entry - Allocate an initialize msi_entry * alloc_msi_entry - Allocate an initialized msi_desc
* @dev: Pointer to the device for which this is allocated * @dev: Pointer to the device for which this is allocated
* @nvec: The number of vectors used in this entry * @nvec: The number of vectors used in this entry
* @affinity: Optional pointer to an affinity mask array size of @nvec * @affinity: Optional pointer to an affinity mask array size of @nvec
* *
* If @affinity is not NULL then an affinity array[@nvec] is allocated * If @affinity is not %NULL then an affinity array[@nvec] is allocated
* and the affinity masks and flags from @affinity are copied. * and the affinity masks and flags from @affinity are copied.
*
* Return: pointer to allocated &msi_desc on success or %NULL on failure
*/ */
struct msi_desc *alloc_msi_entry(struct device *dev, int nvec, struct msi_desc *alloc_msi_entry(struct device *dev, int nvec,
const struct irq_affinity_desc *affinity) const struct irq_affinity_desc *affinity)
@ -97,6 +99,8 @@ static void msi_check_level(struct irq_domain *domain, struct msi_msg *msg)
* *
* Intended to be used by MSI interrupt controllers which are * Intended to be used by MSI interrupt controllers which are
* implemented with hierarchical domains. * implemented with hierarchical domains.
*
* Return: IRQ_SET_MASK_* result code
*/ */
int msi_domain_set_affinity(struct irq_data *irq_data, int msi_domain_set_affinity(struct irq_data *irq_data,
const struct cpumask *mask, bool force) const struct cpumask *mask, bool force)
@ -277,10 +281,12 @@ static void msi_domain_update_chip_ops(struct msi_domain_info *info)
} }
/** /**
* msi_create_irq_domain - Create a MSI interrupt domain * msi_create_irq_domain - Create an MSI interrupt domain
* @fwnode: Optional fwnode of the interrupt controller * @fwnode: Optional fwnode of the interrupt controller
* @info: MSI domain info * @info: MSI domain info
* @parent: Parent irq domain * @parent: Parent irq domain
*
* Return: pointer to the created &struct irq_domain or %NULL on failure
*/ */
struct irq_domain *msi_create_irq_domain(struct fwnode_handle *fwnode, struct irq_domain *msi_create_irq_domain(struct fwnode_handle *fwnode,
struct msi_domain_info *info, struct msi_domain_info *info,
@ -492,7 +498,7 @@ cleanup:
* are allocated * are allocated
* @nvec: The number of interrupts to allocate * @nvec: The number of interrupts to allocate
* *
* Returns 0 on success or an error code. * Return: %0 on success or an error code.
*/ */
int msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev, int msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev,
int nvec) int nvec)
@ -521,7 +527,7 @@ void __msi_domain_free_irqs(struct irq_domain *domain, struct device *dev)
} }
/** /**
* __msi_domain_free_irqs - Free interrupts from a MSI interrupt @domain associated tp @dev * msi_domain_free_irqs - Free interrupts from a MSI interrupt @domain associated to @dev
* @domain: The domain to managing the interrupts * @domain: The domain to managing the interrupts
* @dev: Pointer to device struct of the device for which the interrupts * @dev: Pointer to device struct of the device for which the interrupts
* are free * are free
@ -538,8 +544,7 @@ void msi_domain_free_irqs(struct irq_domain *domain, struct device *dev)
* msi_get_domain_info - Get the MSI interrupt domain info for @domain * msi_get_domain_info - Get the MSI interrupt domain info for @domain
* @domain: The interrupt domain to retrieve data from * @domain: The interrupt domain to retrieve data from
* *
* Returns the pointer to the msi_domain_info stored in * Return: the pointer to the msi_domain_info stored in @domain->host_data.
* @domain->host_data.
*/ */
struct msi_domain_info *msi_get_domain_info(struct irq_domain *domain) struct msi_domain_info *msi_get_domain_info(struct irq_domain *domain)
{ {

2
kernel/irq/pm.c
View file

@ -227,7 +227,7 @@ unlock:
} }
/** /**
* irq_pm_syscore_ops - enable interrupt lines early * irq_pm_syscore_resume - enable interrupt lines early
* *
* Enable all interrupt lines with %IRQF_EARLY_RESUME set. * Enable all interrupt lines with %IRQF_EARLY_RESUME set.
*/ */