thunderbolt: Add comment explaining return value of read_drom_entry_location ()

During review it was pointed out that the return value of
read_drom_entry_location () should be documented because it also returns
TRUE when an entry was not found from the DROM. Caller needs to look for
the location->offset in that case. Add a comment explaining this.

Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>
This commit is contained in:
Mika Westerberg 2018-08-10 08:40:14 +03:00 committed by Richard Hughes
parent 28ac67f98f
commit 314a8c76e5

View File

@ -246,7 +246,9 @@ read_ucode_section_len (guint32 offset,
/*
* reads generic entries from DROM based on type field and fills
* location to point to the entry data if found
* location to point to the entry data if found. Returns TRUE if there
* was no error even if the entry was not found (location->offset is != 0
* when entry was found).
*/
static gboolean
read_drom_entry_location (const FuThunderboltFwObject *fw,