Commit 3591538a authored by Alastair D'Silva's avatar Alastair D'Silva Committed by Michael Ellerman

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: default avatarAlastair D'Silva <alastair@d-silva.org>
Acked-by: default avatarAndrew Donnellan <ajd@linux.ibm.com>
Signed-off-by: default avatarMichael Ellerman <mpe@ellerman.id.au>
Link: https://lore.kernel.org/r/20200415012343.919255-3-alastair@d-silva.org
parent c75d42e4
......@@ -344,16 +344,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;
......@@ -547,16 +547,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;
......
......@@ -128,11 +128,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);
......
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment