Skip to content

Commit 234bef8

Browse files
finikorgcarlescufi
authored andcommitted
doc: espi: Make documentation readable
Use @code ... @Endcode for ascii graphics. Signed-off-by: Andrei Emeltchenko <[email protected]>
1 parent 61d6532 commit 234bef8

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

include/zephyr/drivers/espi.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ enum espi_io_mode {
3737
};
3838

3939
/**
40+
* @code
4041
*+----------------------------------------------------------------------+
4142
*| |
4243
*| eSPI host +-------------+ |
@@ -82,7 +83,7 @@ enum espi_io_mode {
8283
*| CH0 | CH1 | CH2 | CH3 |
8384
*| eSPI endpoint | VWIRE | OOB | Flash |
8485
*+-----------------------------------------------------------------------+
85-
*
86+
* @endcode
8687
*/
8788

8889
/**
@@ -480,6 +481,7 @@ __subsystem struct espi_driver_api {
480481
* will be used by eSPI master to determine minimum common capabilities with
481482
* eSPI slave then send via SET_CONFIGURATION command.
482483
*
484+
* @code
483485
* +--------+ +---------+ +------+ +---------+ +---------+
484486
* | eSPI | | eSPI | | eSPI | | eSPI | | eSPI |
485487
* | slave | | driver | | bus | | driver | | host |
@@ -503,6 +505,7 @@ __subsystem struct espi_driver_api {
503505
* | | | accept | |
504506
* | | +------------------>+ |
505507
* + + + + +
508+
* @endcode
506509
*
507510
* @param dev Pointer to the device structure for the driver instance.
508511
* @param cfg the device runtime configuration for the eSPI controller.
@@ -871,6 +874,7 @@ static inline int z_impl_espi_flash_erase(const struct device *dev,
871874
/**
872875
* Callback model
873876
*
877+
* @code
874878
*+-------+ +-------------+ +------+ +---------+
875879
*| App | | eSPI driver | | HW | |eSPI Host|
876880
*+---+---+ +-------+-----+ +---+--+ +----+----+
@@ -926,6 +930,7 @@ static inline int z_impl_espi_flash_erase(const struct device *dev,
926930
* <------------------------------+ | |
927931
* | App executes | | |
928932
* + power mgmt policy | | |
933+
* @endcode
929934
*/
930935

931936
/**

0 commit comments

Comments
 (0)