Skip to contentSkip to conversation

cxl/mbox: Add missing parameter to docs.

PATCH In review Jonathan Cameron 3 participants 3 messages Jan 30, 2023 CXL

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 cxl/mbox: Add missing parameter to docs.

Kernel-doc should be complete, so add documentation for the status parameter.

---
Fixes ("cxl/mem: Read, trace, and clear events on driver load")

Bad fixes tag is deliberate as patch is currently only in the cxl/pending branch. Feel free to squash this or drop the fixes entirely.

I'm odd and for various reasons run W=1 builds. The resulting warning has been irritating me, hence the fixlet.

---
 drivers/cxl/core/mbox.c | 1 +
 1 file changed, 1 insertion(+)
drivers/cxl/core/mbox.c +1 -0
index a0bd2170af48..03909b6cef55 100644
@@ -913,6 +913,7 @@ static void cxl_mem_get_records_log(struct cxl_dev_state *cxlds,
 /**
  * cxl_mem_get_event_records - Get Event Records from the device
  * @cxlds: The device data for the operation
+ * @status: Event Status register value identifying which events are available.
  *
  * Retrieve all event records available on the device, report them as trace
  * events, and clear them.
Signature · 1 line
2.37.2
maintainer Reviewed-by on v1 1/1
#1 lore raw
Quoted 4 lines · Jonathan Cameron

Kernel-doc should be complete, so add documentation for the status parameter.

Quoted 25 lines

---
Fixes ("cxl/mem: Read, trace, and clear events on driver load")

Bad fixes tag is deliberate as patch is currently only in the cxl/pending branch. Feel free to squash this or drop the fixes entirely.

I'm odd and for various reasons run W=1 builds. The resulting warning has been irritating me, hence the fixlet.

---
  drivers/cxl/core/mbox.c | 1 +
  1 file changed, 1 insertion(+)
drivers/cxl/core/mbox.c +1 -0
index a0bd2170af48..03909b6cef55 100644
@@ -913,6 +913,7 @@ static void cxl_mem_get_records_log(struct cxl_dev_state *cxlds,
  /**
   * cxl_mem_get_event_records - Get Event Records from the device
   * @cxlds: The device data for the operation
+ * @status: Event Status register value identifying which events are available.
   *
   * Retrieve all event records available on the device, report them as trace
   * events, and clear them.
#2 lore raw
In reply to Jonathan Cameron
Quoted 5 lines · Jonathan Cameron

Kernel-doc should be complete, so add documentation for the status parameter.

Quoted 8 lines

---
Fixes ("cxl/mem: Read, trace, and clear events on driver load")

Bad fixes tag is deliberate as patch is currently only in the cxl/pending branch. Feel free to squash this or drop the fixes entirely.

I'm odd and for various reasons run W=1 builds. The resulting warning has been irritating me, hence the fixlet.

I appreciate it, looks good.