Re: [PATCH v4 05/25] ocxl: Address kernel doc errors & warnings
On Sun, Mar 29, 2020 at 10:23 PM Alastair D'Silva 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 > Acked-by: Andrew Donnellan > --- > 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 increm
[PATCH v4 05/25] ocxl: Address kernel doc errors & warnings
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 Acked-by: Andrew Donnellan --- 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(-) 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