bios_table: pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() values
Document the pre-conditions that lead to failures and their associated
error codes.
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ia78e3a26e077b97f7ae1dd7dc113ded64e8f55b0
diff --git a/include/libpldm/bios_table.h b/include/libpldm/bios_table.h
index 128dac4..f6056da 100644
--- a/include/libpldm/bios_table.h
+++ b/include/libpldm/bios_table.h
@@ -309,7 +309,10 @@
* PossibleValuesStringHandles
* @param[in] pv_num - Number of PossibleValuesStringHandles the buffer can
* store
- * @return Number of PossibleValuesStringHandles decoded
+ * @return PLDM_SUCCESS on success, otherwise PLDM_ERROR_INVALID_DATA if entry or pv_hdls are NULL,
+ * or entry is not of type PLDM_BIOS_ENUMERATION, or the number of possible values is not
+ * equal to pv_num. An appropriate value for pv_num can be determined using @ref
+ * pldm_bios_table_attr_entry_enum_decode_pv_num_check
*/
int pldm_bios_table_attr_entry_enum_decode_pv_hdls_check(
const struct pldm_bios_attr_table_entry *entry, uint16_t *pv_hdls,