Skip to content

Commit 71722b2

Browse files
committed
include: drivers: espi: doxygen comments for espi_evt_data_pvt
follow up to commit 5e3f1db that introduced espi_evt_data_pvt without full doxygen comments for it. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 82ea32b commit 71722b2

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

include/zephyr/drivers/espi.h

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,11 +415,17 @@ struct espi_evt_data_acpi {
415415
};
416416

417417
/**
418-
* @brief Bit field definition of evt_data in struct espi_event for PVT.
418+
* @brief Event data format for Private Channel (PVT) events.
419+
*
420+
* Event data (@ref espi_event.evt_data) for Private Channel (PVT) events, allowing to manipulate
421+
* the raw event data as a bit field.
419422
*/
420423
struct espi_evt_data_pvt {
424+
/** Event type identifier */
421425
uint32_t type: 8;
426+
/** Event data payload */
422427
uint32_t data: 8;
428+
/** Reserved field for future use */
423429
uint32_t reserved: 16;
424430
};
425431

0 commit comments

Comments
 (0)