perf/x86/intel/pt: Fix kernel-doc comments
authorLucy Mielke <lucymielke@icloud.com>
Mon, 9 Oct 2023 06:54:54 +0000 (08:54 +0200)
committerIngo Molnar <mingo@kernel.org>
Mon, 9 Oct 2023 10:26:22 +0000 (12:26 +0200)
Some parameters or return codes were either wrong or missing,
update them.

Signed-off-by: Lucy Mielke <lucymielke@icloud.com>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Link: https://lore.kernel.org/r/ZSOjQW3e2nJR4bAo@fedora.fritz.box
arch/x86/events/intel/pt.c

index 42a55794004a7a444585d5525fbb8691d295cd72..8e2a12235e62c291e7ca20a4adf93d3cf13cd360 100644 (file)
@@ -736,6 +736,7 @@ static bool topa_table_full(struct topa *topa)
 /**
  * topa_insert_pages() - create a list of ToPA tables
  * @buf:       PT buffer being initialized.
+ * @cpu:       CPU on which to allocate.
  * @gfp:       Allocation flags.
  *
  * This initializes a list of ToPA tables with entries from
@@ -1207,8 +1208,11 @@ static void pt_buffer_fini_topa(struct pt_buffer *buf)
 /**
  * pt_buffer_init_topa() - initialize ToPA table for pt buffer
  * @buf:       PT buffer.
- * @size:      Total size of all regions within this ToPA.
+ * @cpu:       CPU on which to allocate.
+ * @nr_pages:  No. of pages to allocate.
  * @gfp:       Allocation flags.
+ *
+ * Return:     0 on success or error code.
  */
 static int pt_buffer_init_topa(struct pt_buffer *buf, int cpu,
                               unsigned long nr_pages, gfp_t gfp)
@@ -1281,7 +1285,7 @@ out:
 
 /**
  * pt_buffer_setup_aux() - set up topa tables for a PT buffer
- * @cpu:       Cpu on which to allocate, -1 means current.
+ * @event:     Performance event
  * @pages:     Array of pointers to buffer pages passed from perf core.
  * @nr_pages:  Number of pages in the buffer.
  * @snapshot:  If this is a snapshot/overwrite counter.