LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Al Stone <ahs3@redhat.com>
To: linux-acpi@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: Al Stone <ahs3@redhat.com>,
	"Rafael J . Wysocki" <rjw@rjwysocki.net>,
	Len Brown <lenb@kernel.org>
Subject: [PATCH v3 1/3] ACPI: improve function documentation for acpi_parse_entries_array()
Date: Mon, 30 Apr 2018 18:39:05 -0600	[thread overview]
Message-ID: <20180501003907.4322-2-ahs3@redhat.com> (raw)
In-Reply-To: <20180501003907.4322-1-ahs3@redhat.com>

I found the description of the table_size argument to the function
acpi_parse_entries_array() unclear and ambiguous.  This is a minor
documentation change to improve that description so I don't misuse
the argument again in the future, and it is hopefully clearer to
other future users.

Signed-off-by: Al Stone <ahs3@redhat.com>
Cc: Rafael J. Wysocki <rjw@rjwysocki.net>
Cc: Len Brown <lenb@kernel.org>
---
 drivers/acpi/tables.c | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/drivers/acpi/tables.c b/drivers/acpi/tables.c
index 849c4fb19b03..4a3410aa6540 100644
--- a/drivers/acpi/tables.c
+++ b/drivers/acpi/tables.c
@@ -222,7 +222,7 @@ void acpi_table_print_madt_entry(struct acpi_subtable_header *header)
  * acpi_parse_entries_array - for each proc_num find a suitable subtable
  *
  * @id: table id (for debugging purposes)
- * @table_size: single entry size
+ * @table_size: size of the root table
  * @table_header: where does the table start?
  * @proc: array of acpi_subtable_proc struct containing entry id
  *        and associated handler with it
@@ -233,6 +233,11 @@ void acpi_table_print_madt_entry(struct acpi_subtable_header *header)
  * on it. Assumption is that there's only single handler for particular
  * entry id.
  *
+ * The table_size is not the size of the complete ACPI table (the length
+ * field in the header struct), but only the size of the root table; i.e.,
+ * the offset from the very first byte of the complete ACPI table, to the
+ * first byte of the very first subtable.
+ *
  * On success returns sum of all matching entries for all proc handlers.
  * Otherwise, -ENODEV or -EINVAL is returned.
  */
@@ -400,7 +405,7 @@ int __init acpi_table_parse(char *id, acpi_tbl_table_handler handler)
 		return -ENODEV;
 }
 
-/* 
+/*
  * The BIOS is supposed to supply a single APIC/MADT,
  * but some report two.  Provide a knob to use either.
  * (don't you wish instance 0 and 1 were not the same?)
-- 
2.14.3

  reply	other threads:[~2018-05-01  0:39 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-01  0:39 [PATCH v3 0/3] mailbox: ACPI: Remove incorrect error message about parsing PCCT Al Stone
2018-05-01  0:39 ` Al Stone [this message]
2018-05-01  0:39 ` [PATCH v3 2/3] ACPI: ensure acpi_parse_entries_array() does not access non-existent table data Al Stone
2018-05-15 17:19   ` Rafael J. Wysocki
2018-05-15 21:53     ` Al Stone
2018-05-16 15:09       ` Al Stone
2018-05-01  0:39 ` [PATCH v3 3/3] mailbox: ACPI: erroneous error message when parsing the ACPI PCCT Al Stone
2018-05-12 11:49   ` Rafael J. Wysocki
2018-05-14 21:04   ` Prakash, Prashanth
2018-05-14 22:49     ` Al Stone
2018-05-15  8:00       ` Rafael J. Wysocki
2018-05-16 22:01         ` [PATCH v4 3/3] mailbox: ACPI: erroneous error message when parsing the ACPI, PCCT Al Stone
2018-05-17 10:24           ` Rafael J. Wysocki
2018-05-17 19:48             ` Prakash, Prashanth
2018-05-23 11:34               ` Rafael J. Wysocki
2018-05-16 22:03         ` [PATCH v3 3/3] mailbox: ACPI: erroneous error message when parsing the ACPI PCCT Al Stone
2018-05-13  8:30 ` [PATCH v3 0/3] mailbox: ACPI: Remove incorrect error message about parsing PCCT Rafael J. Wysocki

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=20180501003907.4322-2-ahs3@redhat.com \
    --to=ahs3@redhat.com \
    --cc=lenb@kernel.org \
    --cc=linux-acpi@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rjw@rjwysocki.net \
    --subject='Re: [PATCH v3 1/3] ACPI: improve function documentation for acpi_parse_entries_array()' \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).