From: Dan Williams <dan.j.williams@intel.com> To: "Alastair D'Silva" <alastair@d-silva.org> Cc: "Aneesh Kumar K . V" <aneesh.kumar@linux.ibm.com>, "Benjamin Herrenschmidt" <benh@kernel.crashing.org>, "Paul Mackerras" <paulus@samba.org>, "Michael Ellerman" <mpe@ellerman.id.au>, "Frederic Barrat" <fbarrat@linux.ibm.com>, "Andrew Donnellan" <ajd@linux.ibm.com>, "Arnd Bergmann" <arnd@arndb.de>, "Greg Kroah-Hartman" <gregkh@linuxfoundation.org>, "Andrew Morton" <akpm@linux-foundation.org>, "Mauro Carvalho Chehab" <mchehab+samsung@kernel.org>, "David S. Miller" <davem@davemloft.net>, "Rob Herring" <robh@kernel.org>, "Anton Blanchard" <anton@ozlabs.org>, "Krzysztof Kozlowski" <krzk@kernel.org>, "Mahesh Salgaonkar" <mahesh@linux.vnet.ibm.com>, "Madhavan Srinivasan" <maddy@linux.vnet.ibm.com>, "Cédric Le Goater" <clg@kaod.org>, "Anju T Sudhakar" <anju@linux.vnet.ibm.com>, "Hari Bathini" <hbathini@linux.ibm.com>, "Thomas Gleixner" <tglx@linutronix.de>, "Greg Kurz" <groug@kaod.org>, "Nicholas Piggin" <npiggin@gmail.com>, "Masahiro Yamada" <yamada.masahiro@socionext.com>, "Alexey Kardashevskiy" <aik@ozlabs.ru>, "Linux Kernel Mailing List" <linux-kernel@vger.kernel.org>, linuxppc-dev <linuxppc-dev@lists.ozlabs.org>, linux-nvdimm <linux-nvdimm@lists.01.org>, "Linux MM" <linux-mm@kvack.org> Subject: Re: [PATCH v4 05/25] ocxl: Address kernel doc errors & warnings Date: Wed, 1 Apr 2020 01:49:04 -0700 [thread overview] Message-ID: <CAPcyv4jd2mjiTo7NSm_Q=SbCB6EmPvqvDN4u85j2ufUZ0meGig@mail.gmail.com> (raw) In-Reply-To: <20200327071202.2159885-6-alastair@d-silva.org> On Sun, Mar 29, 2020 at 10:23 PM Alastair D'Silva <alastair@d-silva.org> wrote: > > This patch addresses warnings and errors from the kernel doc scripts for > the OpenCAPI driver. > > It also makes minor tweaks to make the docs more consistent. > > Signed-off-by: Alastair D'Silva <alastair@d-silva.org> > Acked-by: Andrew Donnellan <ajd@linux.ibm.com> > --- > drivers/misc/ocxl/config.c | 24 ++++---- > drivers/misc/ocxl/ocxl_internal.h | 9 +-- > include/misc/ocxl.h | 96 ++++++++++++------------------- > 3 files changed, 55 insertions(+), 74 deletions(-) Looks good. > > diff --git a/drivers/misc/ocxl/config.c b/drivers/misc/ocxl/config.c > index c8e19bfb5ef9..a62e3d7db2bf 100644 > --- a/drivers/misc/ocxl/config.c > +++ b/drivers/misc/ocxl/config.c > @@ -273,16 +273,16 @@ static int read_afu_info(struct pci_dev *dev, struct ocxl_fn_config *fn, > } > > /** > - * Read the template version from the AFU > - * dev: the device for the AFU > - * fn: the AFU offsets > - * len: outputs the template length > - * version: outputs the major<<8,minor version > + * read_template_version() - Read the template version from the AFU > + * @dev: the device for the AFU > + * @fn: the AFU offsets > + * @len: outputs the template length > + * @version: outputs the major<<8,minor version > * > * Returns 0 on success, negative on failure > */ > static int read_template_version(struct pci_dev *dev, struct ocxl_fn_config *fn, > - u16 *len, u16 *version) > + u16 *len, u16 *version) > { > u32 val32; > u8 major, minor; > @@ -476,16 +476,16 @@ static int validate_afu(struct pci_dev *dev, struct ocxl_afu_config *afu) > } > > /** > - * Populate AFU metadata regarding LPC memory > - * dev: the device for the AFU > - * fn: the AFU offsets > - * afu: the AFU struct to populate the LPC metadata into > + * read_afu_lpc_memory_info() - Populate AFU metadata regarding LPC memory > + * @dev: the device for the AFU > + * @fn: the AFU offsets > + * @afu: the AFU struct to populate the LPC metadata into > * > * Returns 0 on success, negative on failure > */ > static int read_afu_lpc_memory_info(struct pci_dev *dev, > - struct ocxl_fn_config *fn, > - struct ocxl_afu_config *afu) > + struct ocxl_fn_config *fn, > + struct ocxl_afu_config *afu) > { > int rc; > u32 val32; > diff --git a/drivers/misc/ocxl/ocxl_internal.h b/drivers/misc/ocxl/ocxl_internal.h > index 345bf843a38e..198e4e4bc51d 100644 > --- a/drivers/misc/ocxl/ocxl_internal.h > +++ b/drivers/misc/ocxl/ocxl_internal.h > @@ -122,11 +122,12 @@ int ocxl_config_check_afu_index(struct pci_dev *dev, > struct ocxl_fn_config *fn, int afu_idx); > > /** > - * Update values within a Process Element > + * ocxl_link_update_pe() - Update values within a Process Element > + * @link_handle: the link handle associated with the process element > + * @pasid: the PASID for the AFU context > + * @tid: the new thread id for the process element > * > - * link_handle: the link handle associated with the process element > - * pasid: the PASID for the AFU context > - * tid: the new thread id for the process element > + * Returns 0 on success > */ > int ocxl_link_update_pe(void *link_handle, int pasid, __u16 tid); > > diff --git a/include/misc/ocxl.h b/include/misc/ocxl.h > index 0a762e387418..357ef1aadbc0 100644 > --- a/include/misc/ocxl.h > +++ b/include/misc/ocxl.h > @@ -62,8 +62,7 @@ struct ocxl_context; > // Device detection & initialisation > > /** > - * Open an OpenCAPI function on an OpenCAPI device > - * > + * ocxl_function_open() - Open an OpenCAPI function on an OpenCAPI device > * @dev: The PCI device that contains the function > * > * Returns an opaque pointer to the function, or an error pointer (check with IS_ERR) > @@ -71,8 +70,7 @@ struct ocxl_context; > struct ocxl_fn *ocxl_function_open(struct pci_dev *dev); > > /** > - * Get the list of AFUs associated with a PCI function device > - * > + * ocxl_function_afu_list() - Get the list of AFUs associated with a PCI function device > * Returns a list of struct ocxl_afu * > * > * @fn: The OpenCAPI function containing the AFUs > @@ -80,8 +78,7 @@ struct ocxl_fn *ocxl_function_open(struct pci_dev *dev); > struct list_head *ocxl_function_afu_list(struct ocxl_fn *fn); > > /** > - * Fetch an AFU instance from an OpenCAPI function > - * > + * ocxl_function_fetch_afu() - Fetch an AFU instance from an OpenCAPI function > * @fn: The OpenCAPI function to get the AFU from > * @afu_idx: The index of the AFU to get > * > @@ -92,23 +89,20 @@ struct list_head *ocxl_function_afu_list(struct ocxl_fn *fn); > struct ocxl_afu *ocxl_function_fetch_afu(struct ocxl_fn *fn, u8 afu_idx); > > /** > - * Take a reference to an AFU > - * > + * ocxl_afu_get() - Take a reference to an AFU > * @afu: The AFU to increment the reference count on > */ > void ocxl_afu_get(struct ocxl_afu *afu); > > /** > - * Release a reference to an AFU > - * > + * ocxl_afu_put() - Release a reference to an AFU > * @afu: The AFU to decrement the reference count on > */ > void ocxl_afu_put(struct ocxl_afu *afu); > > > /** > - * Get the configuration information for an OpenCAPI function > - * > + * ocxl_function_config() - Get the configuration information for an OpenCAPI function > * @fn: The OpenCAPI function to get the config for > * > * Returns the function config, or NULL on error > @@ -116,8 +110,7 @@ void ocxl_afu_put(struct ocxl_afu *afu); > const struct ocxl_fn_config *ocxl_function_config(struct ocxl_fn *fn); > > /** > - * Close an OpenCAPI function > - * > + * ocxl_function_close() - Close an OpenCAPI function > * This will free any AFUs previously retrieved from the function, and > * detach and associated contexts. The contexts must by freed by the caller. > * > @@ -129,8 +122,7 @@ void ocxl_function_close(struct ocxl_fn *fn); > // Context allocation > > /** > - * Allocate an OpenCAPI context > - * > + * ocxl_context_alloc() - Allocate an OpenCAPI context > * @context: The OpenCAPI context to allocate, must be freed with ocxl_context_free > * @afu: The AFU the context belongs to > * @mapping: The mapping to unmap when the context is closed (may be NULL) > @@ -139,14 +131,13 @@ int ocxl_context_alloc(struct ocxl_context **context, struct ocxl_afu *afu, > struct address_space *mapping); > > /** > - * Free an OpenCAPI context > - * > + * ocxl_context_free() - Free an OpenCAPI context > * @ctx: The OpenCAPI context to free > */ > void ocxl_context_free(struct ocxl_context *ctx); > > /** > - * Grant access to an MM to an OpenCAPI context > + * ocxl_context_attach() - Grant access to an MM to an OpenCAPI context > * @ctx: The OpenCAPI context to attach > * @amr: The value of the AMR register to restrict access > * @mm: The mm to attach to the context > @@ -157,7 +148,7 @@ int ocxl_context_attach(struct ocxl_context *ctx, u64 amr, > struct mm_struct *mm); > > /** > - * Detach an MM from an OpenCAPI context > + * ocxl_context_detach() - Detach an MM from an OpenCAPI context > * @ctx: The OpenCAPI context to attach > * > * Returns 0 on success, negative on failure > @@ -167,7 +158,7 @@ int ocxl_context_detach(struct ocxl_context *ctx); > // AFU IRQs > > /** > - * Allocate an IRQ associated with an AFU context > + * ocxl_afu_irq_alloc() - Allocate an IRQ associated with an AFU context > * @ctx: the AFU context > * @irq_id: out, the IRQ ID > * > @@ -176,7 +167,7 @@ int ocxl_context_detach(struct ocxl_context *ctx); > int ocxl_afu_irq_alloc(struct ocxl_context *ctx, int *irq_id); > > /** > - * Frees an IRQ associated with an AFU context > + * ocxl_afu_irq_free() - Frees an IRQ associated with an AFU context > * @ctx: the AFU context > * @irq_id: the IRQ ID > * > @@ -185,7 +176,7 @@ int ocxl_afu_irq_alloc(struct ocxl_context *ctx, int *irq_id); > int ocxl_afu_irq_free(struct ocxl_context *ctx, int irq_id); > > /** > - * Gets the address of the trigger page for an IRQ > + * ocxl_afu_irq_get_addr() - Gets the address of the trigger page for an IRQ > * This can then be provided to an AFU which will write to that > * page to trigger the IRQ. > * @ctx: The AFU context that the IRQ is associated with > @@ -196,7 +187,7 @@ int ocxl_afu_irq_free(struct ocxl_context *ctx, int irq_id); > u64 ocxl_afu_irq_get_addr(struct ocxl_context *ctx, int irq_id); > > /** > - * Provide a callback to be called when an IRQ is triggered > + * ocxl_irq_set_handler() - Provide a callback to be called when an IRQ is triggered > * @ctx: The AFU context that the IRQ is associated with > * @irq_id: The IRQ ID > * @handler: the callback to be called when the IRQ is triggered > @@ -213,8 +204,7 @@ int ocxl_irq_set_handler(struct ocxl_context *ctx, int irq_id, > // AFU Metadata > > /** > - * Get a pointer to the config for an AFU > - * > + * ocxl_afu_config() - Get a pointer to the config for an AFU > * @afu: a pointer to the AFU to get the config for > * > * Returns a pointer to the AFU config > @@ -222,27 +212,24 @@ int ocxl_irq_set_handler(struct ocxl_context *ctx, int irq_id, > struct ocxl_afu_config *ocxl_afu_config(struct ocxl_afu *afu); > > /** > - * Assign opaque hardware specific information to an OpenCAPI AFU. > - * > - * @dev: The PCI device associated with the OpenCAPI device > + * ocxl_afu_set_private() - Assign opaque hardware specific information to an OpenCAPI AFU. > + * @afu: The OpenCAPI AFU > * @private: the opaque hardware specific information to assign to the driver > */ > void ocxl_afu_set_private(struct ocxl_afu *afu, void *private); > > /** > - * Fetch the hardware specific information associated with an external OpenCAPI > - * AFU. This may be consumed by an external OpenCAPI driver. > - * > - * @afu: The AFU > + * ocxl_afu_get_private() - Fetch the hardware specific information associated with > + * an external OpenCAPI AFU. This may be consumed by an external OpenCAPI driver. > + * @afu: The OpenCAPI AFU > * > * Returns the opaque pointer associated with the device, or NULL if not set > */ > -void *ocxl_afu_get_private(struct ocxl_afu *dev); > +void *ocxl_afu_get_private(struct ocxl_afu *afu); > > // Global MMIO > /** > - * Read a 32 bit value from global MMIO > - * > + * ocxl_global_mmio_read32() - Read a 32 bit value from global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -251,11 +238,10 @@ void *ocxl_afu_get_private(struct ocxl_afu *dev); > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_read32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 *val); > + enum ocxl_endian endian, u32 *val); > > /** > - * Read a 64 bit value from global MMIO > - * > + * ocxl_global_mmio_read64() - Read a 64 bit value from global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -264,11 +250,10 @@ int ocxl_global_mmio_read32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_read64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 *val); > + enum ocxl_endian endian, u64 *val); > > /** > - * Write a 32 bit value to global MMIO > - * > + * ocxl_global_mmio_write32() - Write a 32 bit value to global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -277,11 +262,10 @@ int ocxl_global_mmio_read64(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_write32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 val); > + enum ocxl_endian endian, u32 val); > > /** > - * Write a 64 bit value to global MMIO > - * > + * ocxl_global_mmio_write64() - Write a 64 bit value to global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -290,11 +274,10 @@ int ocxl_global_mmio_write32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_write64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 val); > + enum ocxl_endian endian, u64 val); > > /** > - * Set bits in a 32 bit global MMIO register > - * > + * ocxl_global_mmio_set32() - Set bits in a 32 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -303,11 +286,10 @@ int ocxl_global_mmio_write64(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_set32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 mask); > + enum ocxl_endian endian, u32 mask); > > /** > - * Set bits in a 64 bit global MMIO register > - * > + * ocxl_global_mmio_set64() - Set bits in a 64 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -316,11 +298,10 @@ int ocxl_global_mmio_set32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_set64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 mask); > + enum ocxl_endian endian, u64 mask); > > /** > - * Set bits in a 32 bit global MMIO register > - * > + * ocxl_global_mmio_clear32() - Set bits in a 32 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -329,11 +310,10 @@ int ocxl_global_mmio_set64(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_clear32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 mask); > + enum ocxl_endian endian, u32 mask); > > /** > - * Set bits in a 64 bit global MMIO register > - * > + * ocxl_global_mmio_clear64() - Set bits in a 64 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -342,7 +322,7 @@ int ocxl_global_mmio_clear32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_clear64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 mask); > + enum ocxl_endian endian, u64 mask); > > // Functions left here are for compatibility with the cxlflash driver > > -- > 2.24.1 > _______________________________________________ Linux-nvdimm mailing list -- linux-nvdimm@lists.01.org To unsubscribe send an email to linux-nvdimm-leave@lists.01.org
WARNING: multiple messages have this Message-ID
From: Dan Williams <dan.j.williams@intel.com> To: "Alastair D'Silva" <alastair@d-silva.org> Cc: "Aneesh Kumar K . V" <aneesh.kumar@linux.ibm.com>, "Oliver O'Halloran" <oohall@gmail.com>, "Benjamin Herrenschmidt" <benh@kernel.crashing.org>, "Paul Mackerras" <paulus@samba.org>, "Michael Ellerman" <mpe@ellerman.id.au>, "Frederic Barrat" <fbarrat@linux.ibm.com>, "Andrew Donnellan" <ajd@linux.ibm.com>, "Arnd Bergmann" <arnd@arndb.de>, "Greg Kroah-Hartman" <gregkh@linuxfoundation.org>, "Vishal Verma" <vishal.l.verma@intel.com>, "Dave Jiang" <dave.jiang@intel.com>, "Ira Weiny" <ira.weiny@intel.com>, "Andrew Morton" <akpm@linux-foundation.org>, "Mauro Carvalho Chehab" <mchehab+samsung@kernel.org>, "David S. Miller" <davem@davemloft.net>, "Rob Herring" <robh@kernel.org>, "Anton Blanchard" <anton@ozlabs.org>, "Krzysztof Kozlowski" <krzk@kernel.org>, "Mahesh Salgaonkar" <mahesh@linux.vnet.ibm.com>, "Madhavan Srinivasan" <maddy@linux.vnet.ibm.com>, "Cédric Le Goater" <clg@kaod.org>, "Anju T Sudhakar" <anju@linux.vnet.ibm.com>, "Hari Bathini" <hbathini@linux.ibm.com>, "Thomas Gleixner" <tglx@linutronix.de>, "Greg Kurz" <groug@kaod.org>, "Nicholas Piggin" <npiggin@gmail.com>, "Masahiro Yamada" <yamada.masahiro@socionext.com>, "Alexey Kardashevskiy" <aik@ozlabs.ru>, "Linux Kernel Mailing List" <linux-kernel@vger.kernel.org>, linuxppc-dev <linuxppc-dev@lists.ozlabs.org>, linux-nvdimm <linux-nvdimm@lists.01.org>, "Linux MM" <linux-mm@kvack.org> Subject: Re: [PATCH v4 05/25] ocxl: Address kernel doc errors & warnings Date: Wed, 1 Apr 2020 01:49:04 -0700 [thread overview] Message-ID: <CAPcyv4jd2mjiTo7NSm_Q=SbCB6EmPvqvDN4u85j2ufUZ0meGig@mail.gmail.com> (raw) In-Reply-To: <20200327071202.2159885-6-alastair@d-silva.org> On Sun, Mar 29, 2020 at 10:23 PM Alastair D'Silva <alastair@d-silva.org> wrote: > > This patch addresses warnings and errors from the kernel doc scripts for > the OpenCAPI driver. > > It also makes minor tweaks to make the docs more consistent. > > Signed-off-by: Alastair D'Silva <alastair@d-silva.org> > Acked-by: Andrew Donnellan <ajd@linux.ibm.com> > --- > drivers/misc/ocxl/config.c | 24 ++++---- > drivers/misc/ocxl/ocxl_internal.h | 9 +-- > include/misc/ocxl.h | 96 ++++++++++++------------------- > 3 files changed, 55 insertions(+), 74 deletions(-) Looks good. > > diff --git a/drivers/misc/ocxl/config.c b/drivers/misc/ocxl/config.c > index c8e19bfb5ef9..a62e3d7db2bf 100644 > --- a/drivers/misc/ocxl/config.c > +++ b/drivers/misc/ocxl/config.c > @@ -273,16 +273,16 @@ static int read_afu_info(struct pci_dev *dev, struct ocxl_fn_config *fn, > } > > /** > - * Read the template version from the AFU > - * dev: the device for the AFU > - * fn: the AFU offsets > - * len: outputs the template length > - * version: outputs the major<<8,minor version > + * read_template_version() - Read the template version from the AFU > + * @dev: the device for the AFU > + * @fn: the AFU offsets > + * @len: outputs the template length > + * @version: outputs the major<<8,minor version > * > * Returns 0 on success, negative on failure > */ > static int read_template_version(struct pci_dev *dev, struct ocxl_fn_config *fn, > - u16 *len, u16 *version) > + u16 *len, u16 *version) > { > u32 val32; > u8 major, minor; > @@ -476,16 +476,16 @@ static int validate_afu(struct pci_dev *dev, struct ocxl_afu_config *afu) > } > > /** > - * Populate AFU metadata regarding LPC memory > - * dev: the device for the AFU > - * fn: the AFU offsets > - * afu: the AFU struct to populate the LPC metadata into > + * read_afu_lpc_memory_info() - Populate AFU metadata regarding LPC memory > + * @dev: the device for the AFU > + * @fn: the AFU offsets > + * @afu: the AFU struct to populate the LPC metadata into > * > * Returns 0 on success, negative on failure > */ > static int read_afu_lpc_memory_info(struct pci_dev *dev, > - struct ocxl_fn_config *fn, > - struct ocxl_afu_config *afu) > + struct ocxl_fn_config *fn, > + struct ocxl_afu_config *afu) > { > int rc; > u32 val32; > diff --git a/drivers/misc/ocxl/ocxl_internal.h b/drivers/misc/ocxl/ocxl_internal.h > index 345bf843a38e..198e4e4bc51d 100644 > --- a/drivers/misc/ocxl/ocxl_internal.h > +++ b/drivers/misc/ocxl/ocxl_internal.h > @@ -122,11 +122,12 @@ int ocxl_config_check_afu_index(struct pci_dev *dev, > struct ocxl_fn_config *fn, int afu_idx); > > /** > - * Update values within a Process Element > + * ocxl_link_update_pe() - Update values within a Process Element > + * @link_handle: the link handle associated with the process element > + * @pasid: the PASID for the AFU context > + * @tid: the new thread id for the process element > * > - * link_handle: the link handle associated with the process element > - * pasid: the PASID for the AFU context > - * tid: the new thread id for the process element > + * Returns 0 on success > */ > int ocxl_link_update_pe(void *link_handle, int pasid, __u16 tid); > > diff --git a/include/misc/ocxl.h b/include/misc/ocxl.h > index 0a762e387418..357ef1aadbc0 100644 > --- a/include/misc/ocxl.h > +++ b/include/misc/ocxl.h > @@ -62,8 +62,7 @@ struct ocxl_context; > // Device detection & initialisation > > /** > - * Open an OpenCAPI function on an OpenCAPI device > - * > + * ocxl_function_open() - Open an OpenCAPI function on an OpenCAPI device > * @dev: The PCI device that contains the function > * > * Returns an opaque pointer to the function, or an error pointer (check with IS_ERR) > @@ -71,8 +70,7 @@ struct ocxl_context; > struct ocxl_fn *ocxl_function_open(struct pci_dev *dev); > > /** > - * Get the list of AFUs associated with a PCI function device > - * > + * ocxl_function_afu_list() - Get the list of AFUs associated with a PCI function device > * Returns a list of struct ocxl_afu * > * > * @fn: The OpenCAPI function containing the AFUs > @@ -80,8 +78,7 @@ struct ocxl_fn *ocxl_function_open(struct pci_dev *dev); > struct list_head *ocxl_function_afu_list(struct ocxl_fn *fn); > > /** > - * Fetch an AFU instance from an OpenCAPI function > - * > + * ocxl_function_fetch_afu() - Fetch an AFU instance from an OpenCAPI function > * @fn: The OpenCAPI function to get the AFU from > * @afu_idx: The index of the AFU to get > * > @@ -92,23 +89,20 @@ struct list_head *ocxl_function_afu_list(struct ocxl_fn *fn); > struct ocxl_afu *ocxl_function_fetch_afu(struct ocxl_fn *fn, u8 afu_idx); > > /** > - * Take a reference to an AFU > - * > + * ocxl_afu_get() - Take a reference to an AFU > * @afu: The AFU to increment the reference count on > */ > void ocxl_afu_get(struct ocxl_afu *afu); > > /** > - * Release a reference to an AFU > - * > + * ocxl_afu_put() - Release a reference to an AFU > * @afu: The AFU to decrement the reference count on > */ > void ocxl_afu_put(struct ocxl_afu *afu); > > > /** > - * Get the configuration information for an OpenCAPI function > - * > + * ocxl_function_config() - Get the configuration information for an OpenCAPI function > * @fn: The OpenCAPI function to get the config for > * > * Returns the function config, or NULL on error > @@ -116,8 +110,7 @@ void ocxl_afu_put(struct ocxl_afu *afu); > const struct ocxl_fn_config *ocxl_function_config(struct ocxl_fn *fn); > > /** > - * Close an OpenCAPI function > - * > + * ocxl_function_close() - Close an OpenCAPI function > * This will free any AFUs previously retrieved from the function, and > * detach and associated contexts. The contexts must by freed by the caller. > * > @@ -129,8 +122,7 @@ void ocxl_function_close(struct ocxl_fn *fn); > // Context allocation > > /** > - * Allocate an OpenCAPI context > - * > + * ocxl_context_alloc() - Allocate an OpenCAPI context > * @context: The OpenCAPI context to allocate, must be freed with ocxl_context_free > * @afu: The AFU the context belongs to > * @mapping: The mapping to unmap when the context is closed (may be NULL) > @@ -139,14 +131,13 @@ int ocxl_context_alloc(struct ocxl_context **context, struct ocxl_afu *afu, > struct address_space *mapping); > > /** > - * Free an OpenCAPI context > - * > + * ocxl_context_free() - Free an OpenCAPI context > * @ctx: The OpenCAPI context to free > */ > void ocxl_context_free(struct ocxl_context *ctx); > > /** > - * Grant access to an MM to an OpenCAPI context > + * ocxl_context_attach() - Grant access to an MM to an OpenCAPI context > * @ctx: The OpenCAPI context to attach > * @amr: The value of the AMR register to restrict access > * @mm: The mm to attach to the context > @@ -157,7 +148,7 @@ int ocxl_context_attach(struct ocxl_context *ctx, u64 amr, > struct mm_struct *mm); > > /** > - * Detach an MM from an OpenCAPI context > + * ocxl_context_detach() - Detach an MM from an OpenCAPI context > * @ctx: The OpenCAPI context to attach > * > * Returns 0 on success, negative on failure > @@ -167,7 +158,7 @@ int ocxl_context_detach(struct ocxl_context *ctx); > // AFU IRQs > > /** > - * Allocate an IRQ associated with an AFU context > + * ocxl_afu_irq_alloc() - Allocate an IRQ associated with an AFU context > * @ctx: the AFU context > * @irq_id: out, the IRQ ID > * > @@ -176,7 +167,7 @@ int ocxl_context_detach(struct ocxl_context *ctx); > int ocxl_afu_irq_alloc(struct ocxl_context *ctx, int *irq_id); > > /** > - * Frees an IRQ associated with an AFU context > + * ocxl_afu_irq_free() - Frees an IRQ associated with an AFU context > * @ctx: the AFU context > * @irq_id: the IRQ ID > * > @@ -185,7 +176,7 @@ int ocxl_afu_irq_alloc(struct ocxl_context *ctx, int *irq_id); > int ocxl_afu_irq_free(struct ocxl_context *ctx, int irq_id); > > /** > - * Gets the address of the trigger page for an IRQ > + * ocxl_afu_irq_get_addr() - Gets the address of the trigger page for an IRQ > * This can then be provided to an AFU which will write to that > * page to trigger the IRQ. > * @ctx: The AFU context that the IRQ is associated with > @@ -196,7 +187,7 @@ int ocxl_afu_irq_free(struct ocxl_context *ctx, int irq_id); > u64 ocxl_afu_irq_get_addr(struct ocxl_context *ctx, int irq_id); > > /** > - * Provide a callback to be called when an IRQ is triggered > + * ocxl_irq_set_handler() - Provide a callback to be called when an IRQ is triggered > * @ctx: The AFU context that the IRQ is associated with > * @irq_id: The IRQ ID > * @handler: the callback to be called when the IRQ is triggered > @@ -213,8 +204,7 @@ int ocxl_irq_set_handler(struct ocxl_context *ctx, int irq_id, > // AFU Metadata > > /** > - * Get a pointer to the config for an AFU > - * > + * ocxl_afu_config() - Get a pointer to the config for an AFU > * @afu: a pointer to the AFU to get the config for > * > * Returns a pointer to the AFU config > @@ -222,27 +212,24 @@ int ocxl_irq_set_handler(struct ocxl_context *ctx, int irq_id, > struct ocxl_afu_config *ocxl_afu_config(struct ocxl_afu *afu); > > /** > - * Assign opaque hardware specific information to an OpenCAPI AFU. > - * > - * @dev: The PCI device associated with the OpenCAPI device > + * ocxl_afu_set_private() - Assign opaque hardware specific information to an OpenCAPI AFU. > + * @afu: The OpenCAPI AFU > * @private: the opaque hardware specific information to assign to the driver > */ > void ocxl_afu_set_private(struct ocxl_afu *afu, void *private); > > /** > - * Fetch the hardware specific information associated with an external OpenCAPI > - * AFU. This may be consumed by an external OpenCAPI driver. > - * > - * @afu: The AFU > + * ocxl_afu_get_private() - Fetch the hardware specific information associated with > + * an external OpenCAPI AFU. This may be consumed by an external OpenCAPI driver. > + * @afu: The OpenCAPI AFU > * > * Returns the opaque pointer associated with the device, or NULL if not set > */ > -void *ocxl_afu_get_private(struct ocxl_afu *dev); > +void *ocxl_afu_get_private(struct ocxl_afu *afu); > > // Global MMIO > /** > - * Read a 32 bit value from global MMIO > - * > + * ocxl_global_mmio_read32() - Read a 32 bit value from global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -251,11 +238,10 @@ void *ocxl_afu_get_private(struct ocxl_afu *dev); > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_read32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 *val); > + enum ocxl_endian endian, u32 *val); > > /** > - * Read a 64 bit value from global MMIO > - * > + * ocxl_global_mmio_read64() - Read a 64 bit value from global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -264,11 +250,10 @@ int ocxl_global_mmio_read32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_read64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 *val); > + enum ocxl_endian endian, u64 *val); > > /** > - * Write a 32 bit value to global MMIO > - * > + * ocxl_global_mmio_write32() - Write a 32 bit value to global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -277,11 +262,10 @@ int ocxl_global_mmio_read64(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_write32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 val); > + enum ocxl_endian endian, u32 val); > > /** > - * Write a 64 bit value to global MMIO > - * > + * ocxl_global_mmio_write64() - Write a 64 bit value to global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -290,11 +274,10 @@ int ocxl_global_mmio_write32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_write64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 val); > + enum ocxl_endian endian, u64 val); > > /** > - * Set bits in a 32 bit global MMIO register > - * > + * ocxl_global_mmio_set32() - Set bits in a 32 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -303,11 +286,10 @@ int ocxl_global_mmio_write64(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_set32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 mask); > + enum ocxl_endian endian, u32 mask); > > /** > - * Set bits in a 64 bit global MMIO register > - * > + * ocxl_global_mmio_set64() - Set bits in a 64 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -316,11 +298,10 @@ int ocxl_global_mmio_set32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_set64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 mask); > + enum ocxl_endian endian, u64 mask); > > /** > - * Set bits in a 32 bit global MMIO register > - * > + * ocxl_global_mmio_clear32() - Set bits in a 32 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -329,11 +310,10 @@ int ocxl_global_mmio_set64(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_clear32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 mask); > + enum ocxl_endian endian, u32 mask); > > /** > - * Set bits in a 64 bit global MMIO register > - * > + * ocxl_global_mmio_clear64() - Set bits in a 64 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -342,7 +322,7 @@ int ocxl_global_mmio_clear32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_clear64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 mask); > + enum ocxl_endian endian, u64 mask); > > // Functions left here are for compatibility with the cxlflash driver > > -- > 2.24.1 >
WARNING: multiple messages have this Message-ID
From: Dan Williams <dan.j.williams@intel.com> To: "Alastair D'Silva" <alastair@d-silva.org> Cc: "Madhavan Srinivasan" <maddy@linux.vnet.ibm.com>, "Alexey Kardashevskiy" <aik@ozlabs.ru>, "Masahiro Yamada" <yamada.masahiro@socionext.com>, "Oliver O'Halloran" <oohall@gmail.com>, "Mauro Carvalho Chehab" <mchehab+samsung@kernel.org>, "Ira Weiny" <ira.weiny@intel.com>, "Rob Herring" <robh@kernel.org>, "Dave Jiang" <dave.jiang@intel.com>, linux-nvdimm <linux-nvdimm@lists.01.org>, "Aneesh Kumar K . V" <aneesh.kumar@linux.ibm.com>, "Krzysztof Kozlowski" <krzk@kernel.org>, "Anju T Sudhakar" <anju@linux.vnet.ibm.com>, "Mahesh Salgaonkar" <mahesh@linux.vnet.ibm.com>, "Andrew Donnellan" <ajd@linux.ibm.com>, "Arnd Bergmann" <arnd@arndb.de>, "Greg Kurz" <groug@kaod.org>, "Nicholas Piggin" <npiggin@gmail.com>, "Cédric Le Goater" <clg@kaod.org>, "Thomas Gleixner" <tglx@linutronix.de>, "Hari Bathini" <hbathini@linux.ibm.com>, "Linux MM" <linux-mm@kvack.org>, "Greg Kroah-Hartman" <gregkh@linuxfoundation.org>, "Linux Kernel Mailing List" <linux-kernel@vger.kernel.org>, "Vishal Verma" <vishal.l.verma@intel.com>, "Frederic Barrat" <fbarrat@linux.ibm.com>, "Paul Mackerras" <paulus@samba.org>, "Andrew Morton" <akpm@linux-foundation.org>, linuxppc-dev <linuxppc-dev@lists.ozlabs.org>, "David S. Miller" <davem@davemloft.net> Subject: Re: [PATCH v4 05/25] ocxl: Address kernel doc errors & warnings Date: Wed, 1 Apr 2020 01:49:04 -0700 [thread overview] Message-ID: <CAPcyv4jd2mjiTo7NSm_Q=SbCB6EmPvqvDN4u85j2ufUZ0meGig@mail.gmail.com> (raw) In-Reply-To: <20200327071202.2159885-6-alastair@d-silva.org> On Sun, Mar 29, 2020 at 10:23 PM Alastair D'Silva <alastair@d-silva.org> wrote: > > This patch addresses warnings and errors from the kernel doc scripts for > the OpenCAPI driver. > > It also makes minor tweaks to make the docs more consistent. > > Signed-off-by: Alastair D'Silva <alastair@d-silva.org> > Acked-by: Andrew Donnellan <ajd@linux.ibm.com> > --- > drivers/misc/ocxl/config.c | 24 ++++---- > drivers/misc/ocxl/ocxl_internal.h | 9 +-- > include/misc/ocxl.h | 96 ++++++++++++------------------- > 3 files changed, 55 insertions(+), 74 deletions(-) Looks good. > > diff --git a/drivers/misc/ocxl/config.c b/drivers/misc/ocxl/config.c > index c8e19bfb5ef9..a62e3d7db2bf 100644 > --- a/drivers/misc/ocxl/config.c > +++ b/drivers/misc/ocxl/config.c > @@ -273,16 +273,16 @@ static int read_afu_info(struct pci_dev *dev, struct ocxl_fn_config *fn, > } > > /** > - * Read the template version from the AFU > - * dev: the device for the AFU > - * fn: the AFU offsets > - * len: outputs the template length > - * version: outputs the major<<8,minor version > + * read_template_version() - Read the template version from the AFU > + * @dev: the device for the AFU > + * @fn: the AFU offsets > + * @len: outputs the template length > + * @version: outputs the major<<8,minor version > * > * Returns 0 on success, negative on failure > */ > static int read_template_version(struct pci_dev *dev, struct ocxl_fn_config *fn, > - u16 *len, u16 *version) > + u16 *len, u16 *version) > { > u32 val32; > u8 major, minor; > @@ -476,16 +476,16 @@ static int validate_afu(struct pci_dev *dev, struct ocxl_afu_config *afu) > } > > /** > - * Populate AFU metadata regarding LPC memory > - * dev: the device for the AFU > - * fn: the AFU offsets > - * afu: the AFU struct to populate the LPC metadata into > + * read_afu_lpc_memory_info() - Populate AFU metadata regarding LPC memory > + * @dev: the device for the AFU > + * @fn: the AFU offsets > + * @afu: the AFU struct to populate the LPC metadata into > * > * Returns 0 on success, negative on failure > */ > static int read_afu_lpc_memory_info(struct pci_dev *dev, > - struct ocxl_fn_config *fn, > - struct ocxl_afu_config *afu) > + struct ocxl_fn_config *fn, > + struct ocxl_afu_config *afu) > { > int rc; > u32 val32; > diff --git a/drivers/misc/ocxl/ocxl_internal.h b/drivers/misc/ocxl/ocxl_internal.h > index 345bf843a38e..198e4e4bc51d 100644 > --- a/drivers/misc/ocxl/ocxl_internal.h > +++ b/drivers/misc/ocxl/ocxl_internal.h > @@ -122,11 +122,12 @@ int ocxl_config_check_afu_index(struct pci_dev *dev, > struct ocxl_fn_config *fn, int afu_idx); > > /** > - * Update values within a Process Element > + * ocxl_link_update_pe() - Update values within a Process Element > + * @link_handle: the link handle associated with the process element > + * @pasid: the PASID for the AFU context > + * @tid: the new thread id for the process element > * > - * link_handle: the link handle associated with the process element > - * pasid: the PASID for the AFU context > - * tid: the new thread id for the process element > + * Returns 0 on success > */ > int ocxl_link_update_pe(void *link_handle, int pasid, __u16 tid); > > diff --git a/include/misc/ocxl.h b/include/misc/ocxl.h > index 0a762e387418..357ef1aadbc0 100644 > --- a/include/misc/ocxl.h > +++ b/include/misc/ocxl.h > @@ -62,8 +62,7 @@ struct ocxl_context; > // Device detection & initialisation > > /** > - * Open an OpenCAPI function on an OpenCAPI device > - * > + * ocxl_function_open() - Open an OpenCAPI function on an OpenCAPI device > * @dev: The PCI device that contains the function > * > * Returns an opaque pointer to the function, or an error pointer (check with IS_ERR) > @@ -71,8 +70,7 @@ struct ocxl_context; > struct ocxl_fn *ocxl_function_open(struct pci_dev *dev); > > /** > - * Get the list of AFUs associated with a PCI function device > - * > + * ocxl_function_afu_list() - Get the list of AFUs associated with a PCI function device > * Returns a list of struct ocxl_afu * > * > * @fn: The OpenCAPI function containing the AFUs > @@ -80,8 +78,7 @@ struct ocxl_fn *ocxl_function_open(struct pci_dev *dev); > struct list_head *ocxl_function_afu_list(struct ocxl_fn *fn); > > /** > - * Fetch an AFU instance from an OpenCAPI function > - * > + * ocxl_function_fetch_afu() - Fetch an AFU instance from an OpenCAPI function > * @fn: The OpenCAPI function to get the AFU from > * @afu_idx: The index of the AFU to get > * > @@ -92,23 +89,20 @@ struct list_head *ocxl_function_afu_list(struct ocxl_fn *fn); > struct ocxl_afu *ocxl_function_fetch_afu(struct ocxl_fn *fn, u8 afu_idx); > > /** > - * Take a reference to an AFU > - * > + * ocxl_afu_get() - Take a reference to an AFU > * @afu: The AFU to increment the reference count on > */ > void ocxl_afu_get(struct ocxl_afu *afu); > > /** > - * Release a reference to an AFU > - * > + * ocxl_afu_put() - Release a reference to an AFU > * @afu: The AFU to decrement the reference count on > */ > void ocxl_afu_put(struct ocxl_afu *afu); > > > /** > - * Get the configuration information for an OpenCAPI function > - * > + * ocxl_function_config() - Get the configuration information for an OpenCAPI function > * @fn: The OpenCAPI function to get the config for > * > * Returns the function config, or NULL on error > @@ -116,8 +110,7 @@ void ocxl_afu_put(struct ocxl_afu *afu); > const struct ocxl_fn_config *ocxl_function_config(struct ocxl_fn *fn); > > /** > - * Close an OpenCAPI function > - * > + * ocxl_function_close() - Close an OpenCAPI function > * This will free any AFUs previously retrieved from the function, and > * detach and associated contexts. The contexts must by freed by the caller. > * > @@ -129,8 +122,7 @@ void ocxl_function_close(struct ocxl_fn *fn); > // Context allocation > > /** > - * Allocate an OpenCAPI context > - * > + * ocxl_context_alloc() - Allocate an OpenCAPI context > * @context: The OpenCAPI context to allocate, must be freed with ocxl_context_free > * @afu: The AFU the context belongs to > * @mapping: The mapping to unmap when the context is closed (may be NULL) > @@ -139,14 +131,13 @@ int ocxl_context_alloc(struct ocxl_context **context, struct ocxl_afu *afu, > struct address_space *mapping); > > /** > - * Free an OpenCAPI context > - * > + * ocxl_context_free() - Free an OpenCAPI context > * @ctx: The OpenCAPI context to free > */ > void ocxl_context_free(struct ocxl_context *ctx); > > /** > - * Grant access to an MM to an OpenCAPI context > + * ocxl_context_attach() - Grant access to an MM to an OpenCAPI context > * @ctx: The OpenCAPI context to attach > * @amr: The value of the AMR register to restrict access > * @mm: The mm to attach to the context > @@ -157,7 +148,7 @@ int ocxl_context_attach(struct ocxl_context *ctx, u64 amr, > struct mm_struct *mm); > > /** > - * Detach an MM from an OpenCAPI context > + * ocxl_context_detach() - Detach an MM from an OpenCAPI context > * @ctx: The OpenCAPI context to attach > * > * Returns 0 on success, negative on failure > @@ -167,7 +158,7 @@ int ocxl_context_detach(struct ocxl_context *ctx); > // AFU IRQs > > /** > - * Allocate an IRQ associated with an AFU context > + * ocxl_afu_irq_alloc() - Allocate an IRQ associated with an AFU context > * @ctx: the AFU context > * @irq_id: out, the IRQ ID > * > @@ -176,7 +167,7 @@ int ocxl_context_detach(struct ocxl_context *ctx); > int ocxl_afu_irq_alloc(struct ocxl_context *ctx, int *irq_id); > > /** > - * Frees an IRQ associated with an AFU context > + * ocxl_afu_irq_free() - Frees an IRQ associated with an AFU context > * @ctx: the AFU context > * @irq_id: the IRQ ID > * > @@ -185,7 +176,7 @@ int ocxl_afu_irq_alloc(struct ocxl_context *ctx, int *irq_id); > int ocxl_afu_irq_free(struct ocxl_context *ctx, int irq_id); > > /** > - * Gets the address of the trigger page for an IRQ > + * ocxl_afu_irq_get_addr() - Gets the address of the trigger page for an IRQ > * This can then be provided to an AFU which will write to that > * page to trigger the IRQ. > * @ctx: The AFU context that the IRQ is associated with > @@ -196,7 +187,7 @@ int ocxl_afu_irq_free(struct ocxl_context *ctx, int irq_id); > u64 ocxl_afu_irq_get_addr(struct ocxl_context *ctx, int irq_id); > > /** > - * Provide a callback to be called when an IRQ is triggered > + * ocxl_irq_set_handler() - Provide a callback to be called when an IRQ is triggered > * @ctx: The AFU context that the IRQ is associated with > * @irq_id: The IRQ ID > * @handler: the callback to be called when the IRQ is triggered > @@ -213,8 +204,7 @@ int ocxl_irq_set_handler(struct ocxl_context *ctx, int irq_id, > // AFU Metadata > > /** > - * Get a pointer to the config for an AFU > - * > + * ocxl_afu_config() - Get a pointer to the config for an AFU > * @afu: a pointer to the AFU to get the config for > * > * Returns a pointer to the AFU config > @@ -222,27 +212,24 @@ int ocxl_irq_set_handler(struct ocxl_context *ctx, int irq_id, > struct ocxl_afu_config *ocxl_afu_config(struct ocxl_afu *afu); > > /** > - * Assign opaque hardware specific information to an OpenCAPI AFU. > - * > - * @dev: The PCI device associated with the OpenCAPI device > + * ocxl_afu_set_private() - Assign opaque hardware specific information to an OpenCAPI AFU. > + * @afu: The OpenCAPI AFU > * @private: the opaque hardware specific information to assign to the driver > */ > void ocxl_afu_set_private(struct ocxl_afu *afu, void *private); > > /** > - * Fetch the hardware specific information associated with an external OpenCAPI > - * AFU. This may be consumed by an external OpenCAPI driver. > - * > - * @afu: The AFU > + * ocxl_afu_get_private() - Fetch the hardware specific information associated with > + * an external OpenCAPI AFU. This may be consumed by an external OpenCAPI driver. > + * @afu: The OpenCAPI AFU > * > * Returns the opaque pointer associated with the device, or NULL if not set > */ > -void *ocxl_afu_get_private(struct ocxl_afu *dev); > +void *ocxl_afu_get_private(struct ocxl_afu *afu); > > // Global MMIO > /** > - * Read a 32 bit value from global MMIO > - * > + * ocxl_global_mmio_read32() - Read a 32 bit value from global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -251,11 +238,10 @@ void *ocxl_afu_get_private(struct ocxl_afu *dev); > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_read32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 *val); > + enum ocxl_endian endian, u32 *val); > > /** > - * Read a 64 bit value from global MMIO > - * > + * ocxl_global_mmio_read64() - Read a 64 bit value from global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -264,11 +250,10 @@ int ocxl_global_mmio_read32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_read64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 *val); > + enum ocxl_endian endian, u64 *val); > > /** > - * Write a 32 bit value to global MMIO > - * > + * ocxl_global_mmio_write32() - Write a 32 bit value to global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -277,11 +262,10 @@ int ocxl_global_mmio_read64(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_write32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 val); > + enum ocxl_endian endian, u32 val); > > /** > - * Write a 64 bit value to global MMIO > - * > + * ocxl_global_mmio_write64() - Write a 64 bit value to global MMIO > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -290,11 +274,10 @@ int ocxl_global_mmio_write32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_write64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 val); > + enum ocxl_endian endian, u64 val); > > /** > - * Set bits in a 32 bit global MMIO register > - * > + * ocxl_global_mmio_set32() - Set bits in a 32 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -303,11 +286,10 @@ int ocxl_global_mmio_write64(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_set32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 mask); > + enum ocxl_endian endian, u32 mask); > > /** > - * Set bits in a 64 bit global MMIO register > - * > + * ocxl_global_mmio_set64() - Set bits in a 64 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -316,11 +298,10 @@ int ocxl_global_mmio_set32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_set64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 mask); > + enum ocxl_endian endian, u64 mask); > > /** > - * Set bits in a 32 bit global MMIO register > - * > + * ocxl_global_mmio_clear32() - Set bits in a 32 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -329,11 +310,10 @@ int ocxl_global_mmio_set64(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_clear32(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u32 mask); > + enum ocxl_endian endian, u32 mask); > > /** > - * Set bits in a 64 bit global MMIO register > - * > + * ocxl_global_mmio_clear64() - Set bits in a 64 bit global MMIO register > * @afu: The AFU > * @offset: The Offset from the start of MMIO > * @endian: the endianness that the MMIO data is in > @@ -342,7 +322,7 @@ int ocxl_global_mmio_clear32(struct ocxl_afu *afu, size_t offset, > * Returns 0 for success, negative on error > */ > int ocxl_global_mmio_clear64(struct ocxl_afu *afu, size_t offset, > - enum ocxl_endian endian, u64 mask); > + enum ocxl_endian endian, u64 mask); > > // Functions left here are for compatibility with the cxlflash driver > > -- > 2.24.1 >
next prev parent reply other threads:[~2020-04-01 8:49 UTC|newest] Thread overview: 179+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-03-27 7:11 [PATCH v4 00/25] Add support for OpenCAPI Persistent Memory devices Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` [PATCH v4 01/25] powerpc/powernv: Add OPAL calls for LPC memory alloc/release Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-01 8:48 ` Dan Williams 2020-04-01 8:48 ` Dan Williams 2020-04-01 8:48 ` Dan Williams 2020-04-01 22:51 ` Alastair D'Silva 2020-04-01 22:51 ` Alastair D'Silva 2020-04-01 22:51 ` Alastair D'Silva 2020-03-27 7:11 ` [PATCH v4 02/25] mm/memory_hotplug: Allow check_hotplug_memory_addressable to be called from drivers Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-01 8:48 ` Dan Williams 2020-04-01 8:48 ` Dan Williams 2020-04-01 8:48 ` Dan Williams 2020-04-02 4:33 ` Alastair D'Silva 2020-04-02 4:33 ` Alastair D'Silva 2020-04-02 4:33 ` Alastair D'Silva 2020-03-27 7:11 ` [PATCH v4 03/25] powerpc/powernv: Map & release OpenCAPI LPC memory Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-01 8:48 ` Dan Williams 2020-04-01 8:48 ` Dan Williams 2020-04-01 8:48 ` Dan Williams 2020-04-02 4:36 ` Alastair D'Silva 2020-04-02 4:36 ` Alastair D'Silva 2020-04-02 4:36 ` Alastair D'Silva 2020-04-02 10:41 ` Benjamin Herrenschmidt 2020-04-02 10:41 ` Benjamin Herrenschmidt 2020-04-03 4:27 ` Michael Ellerman 2020-04-03 4:27 ` Michael Ellerman 2020-04-03 4:27 ` Michael Ellerman 2020-03-27 7:11 ` [PATCH v4 04/25] ocxl: Remove unnecessary externs Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-01 8:48 ` Dan Williams 2020-04-01 8:48 ` Dan Williams 2020-04-01 8:48 ` Dan Williams 2020-03-27 7:11 ` [PATCH v4 05/25] ocxl: Address kernel doc errors & warnings Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-01 8:49 ` Dan Williams [this message] 2020-04-01 8:49 ` Dan Williams 2020-04-01 8:49 ` Dan Williams 2020-03-27 7:11 ` [PATCH v4 06/25] ocxl: Tally up the LPC memory on a link & allow it to be mapped Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-01 8:48 ` Dan Williams 2020-04-01 8:48 ` Dan Williams 2020-04-01 8:48 ` Dan Williams 2020-04-02 6:21 ` Andrew Donnellan 2020-04-02 6:21 ` Andrew Donnellan 2020-04-02 6:21 ` Andrew Donnellan 2020-03-27 7:11 ` [PATCH v4 07/25] ocxl: Add functions to map/unmap LPC memory Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-01 8:49 ` Dan Williams 2020-04-01 8:49 ` Dan Williams 2020-04-01 8:49 ` Dan Williams 2020-04-03 3:50 ` Alastair D'Silva 2020-04-03 3:50 ` Alastair D'Silva 2020-04-03 3:50 ` Alastair D'Silva 2020-03-27 7:11 ` [PATCH v4 08/25] ocxl: Emit a log message showing how much LPC memory was detected Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-01 8:49 ` Dan Williams 2020-04-01 8:49 ` Dan Williams 2020-04-01 8:49 ` Dan Williams 2020-04-02 1:29 ` Joe Perches 2020-04-02 1:29 ` Joe Perches 2020-04-02 1:29 ` Joe Perches 2020-04-03 3:52 ` Alastair D'Silva 2020-04-03 3:52 ` Alastair D'Silva 2020-04-03 3:52 ` Alastair D'Silva 2020-03-27 7:11 ` [PATCH v4 09/25] ocxl: Save the device serial number in ocxl_fn Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` [PATCH v4 10/25] nvdimm: Add driver for OpenCAPI Persistent Memory Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-29 2:56 ` Matthew Wilcox 2020-03-29 2:56 ` Matthew Wilcox 2020-03-29 2:56 ` Matthew Wilcox 2020-03-29 2:59 ` Matthew Wilcox 2020-03-29 2:59 ` Matthew Wilcox 2020-03-29 2:59 ` Matthew Wilcox 2020-04-01 8:49 ` Dan Williams 2020-04-01 8:49 ` Dan Williams 2020-04-01 8:49 ` Dan Williams 2020-04-01 19:35 ` Dan Williams 2020-04-01 19:35 ` Dan Williams 2020-04-01 19:35 ` Dan Williams 2020-03-27 7:11 ` [PATCH v4 11/25] powerpc: Enable the OpenCAPI Persistent Memory driver for powernv_defconfig Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-01 20:26 ` Dan Williams 2020-04-01 20:26 ` Dan Williams 2020-04-01 20:26 ` Dan Williams 2020-03-27 7:11 ` [PATCH v4 12/25] nvdimm/ocxl: Add register addresses & status values to the header Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-01 20:27 ` Dan Williams 2020-04-01 20:27 ` Dan Williams 2020-04-01 20:27 ` Dan Williams 2020-03-27 7:11 ` [PATCH v4 13/25] nvdimm/ocxl: Read the capability registers & wait for device ready Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-02 0:20 ` Dan Williams 2020-04-02 0:20 ` Dan Williams 2020-04-02 0:20 ` Dan Williams 2020-03-27 7:11 ` [PATCH v4 14/25] nvdimm/ocxl: Add support for Admin commands Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-02 6:41 ` Dan Williams 2020-04-02 6:41 ` Dan Williams 2020-04-02 6:41 ` Dan Williams 2020-03-27 7:11 ` [PATCH v4 15/25] nvdimm/ocxl: Register a character device for userspace to interact with Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-02 0:27 ` Dan Williams 2020-04-02 0:27 ` Dan Williams 2020-04-02 0:27 ` Dan Williams 2020-03-27 7:11 ` [PATCH v4 16/25] nvdimm/ocxl: Implement the Read Error Log command Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-03 0:54 ` Dan Williams 2020-04-03 0:54 ` Dan Williams 2020-04-03 0:54 ` Dan Williams 2020-03-27 7:11 ` [PATCH v4 17/25] nvdimm/ocxl: Add controller dump IOCTLs Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` [PATCH v4 18/25] nvdimm/ocxl: Add an IOCTL to report controller statistics Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` [PATCH v4 19/25] nvdimm/ocxl: Forward events to userspace Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-04-02 2:08 ` Dan Williams 2020-04-02 2:08 ` Dan Williams 2020-04-02 2:08 ` Dan Williams 2020-03-27 7:11 ` [PATCH v4 20/25] nvdimm/ocxl: Add an IOCTL to request controller health & perf data Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` [PATCH v4 21/25] nvdimm/ocxl: Implement the heartbeat command Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` [PATCH v4 22/25] nvdimm/ocxl: Add debug IOCTLs Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:11 ` Alastair D'Silva 2020-03-27 7:12 ` [PATCH v4 23/25] nvdimm/ocxl: Expose SMART data via ndctl Alastair D'Silva 2020-03-27 7:12 ` Alastair D'Silva 2020-03-27 7:12 ` Alastair D'Silva 2020-03-27 7:12 ` [PATCH v4 24/25] nvdimm/ocxl: Expose the serial number & firmware version in sysfs Alastair D'Silva 2020-03-27 7:12 ` Alastair D'Silva 2020-03-27 7:12 ` Alastair D'Silva 2020-03-27 7:12 ` [PATCH v4 25/25] MAINTAINERS: Add myself & nvdimm/ocxl to ocxl Alastair D'Silva 2020-03-27 7:12 ` Alastair D'Silva 2020-03-27 7:12 ` Alastair D'Silva 2020-04-01 8:47 ` [PATCH v4 00/25] Add support for OpenCAPI Persistent Memory devices Dan Williams 2020-04-01 8:47 ` Dan Williams 2020-04-01 8:47 ` Dan Williams 2020-04-01 22:44 ` Alastair D'Silva 2020-04-01 22:44 ` Alastair D'Silva 2020-04-01 22:44 ` Alastair D'Silva 2020-04-02 3:42 ` Michael Ellerman 2020-04-02 3:42 ` Michael Ellerman 2020-04-02 3:42 ` Michael Ellerman 2020-04-02 3:50 ` Oliver O'Halloran 2020-04-02 3:50 ` Oliver O'Halloran 2020-04-02 3:50 ` Oliver O'Halloran 2020-04-02 10:06 ` Michael Ellerman 2020-04-02 10:06 ` Michael Ellerman 2020-04-02 10:06 ` Michael Ellerman 2020-04-02 11:10 ` Greg Kurz 2020-04-02 11:10 ` Greg Kurz 2020-04-02 11:10 ` Greg Kurz
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to='CAPcyv4jd2mjiTo7NSm_Q=SbCB6EmPvqvDN4u85j2ufUZ0meGig@mail.gmail.com' \ --to=dan.j.williams@intel.com \ --cc=aik@ozlabs.ru \ --cc=ajd@linux.ibm.com \ --cc=akpm@linux-foundation.org \ --cc=alastair@d-silva.org \ --cc=aneesh.kumar@linux.ibm.com \ --cc=anju@linux.vnet.ibm.com \ --cc=anton@ozlabs.org \ --cc=arnd@arndb.de \ --cc=benh@kernel.crashing.org \ --cc=clg@kaod.org \ --cc=davem@davemloft.net \ --cc=fbarrat@linux.ibm.com \ --cc=gregkh@linuxfoundation.org \ --cc=groug@kaod.org \ --cc=hbathini@linux.ibm.com \ --cc=krzk@kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-mm@kvack.org \ --cc=linux-nvdimm@lists.01.org \ --cc=linuxppc-dev@lists.ozlabs.org \ --cc=maddy@linux.vnet.ibm.com \ --cc=mahesh@linux.vnet.ibm.com \ --cc=mchehab+samsung@kernel.org \ --cc=mpe@ellerman.id.au \ --cc=npiggin@gmail.com \ --cc=paulus@samba.org \ --cc=robh@kernel.org \ --cc=tglx@linutronix.de \ --cc=yamada.masahiro@socionext.com \ --subject='Re: [PATCH v4 05/25] ocxl: Address kernel doc errors & warnings' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.