Commit 71722b2d authored by Benjamin Cabé's avatar Benjamin Cabé Committed by Benjamin Cabé
Browse files

include: drivers: espi: doxygen comments for espi_evt_data_pvt

follow up to commit 5e3f1dba that introduced espi_evt_data_pvt without
full doxygen comments for it.

Signed-off-by: default avatarBenjamin Cabé <benjamin@zephyrproject.org>
parent 82ea32bd
Loading
Loading
Loading
Loading
+7 −1
Changes for include/zephyr/drivers/espi.h: 7 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -415,11 +415,17 @@ struct espi_evt_data_acpi {
};

/**
 * @brief Bit field definition of evt_data in struct espi_event for PVT.
 * @brief Event data format for Private Channel (PVT) events.
 *
 * Event data (@ref espi_event.evt_data) for Private Channel (PVT) events, allowing to manipulate
 * the raw event data as a bit field.
 */
struct espi_evt_data_pvt {
	/** Event type identifier */
	uint32_t type: 8;
	/** Event data payload */
	uint32_t data: 8;
	/** Reserved field for future use */
	uint32_t reserved: 16;
};