Skip to content

Commit b8b6b0b

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

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

include/zephyr/drivers/espi_saf.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ extern "C" {
2929

3030

3131
/**
32+
* @code
3233
*+----------------------------------------------------------------------+
3334
*| |
3435
*| eSPI host +-------------+ |
@@ -80,6 +81,7 @@ extern "C" {
8081
* | Flash | Slave Attached Flash |
8182
* +---------+ |
8283
* |
84+
* @endcode
8385
*/
8486

8587

@@ -177,6 +179,7 @@ __subsystem struct espi_saf_driver_api {
177179
* will be used by eSPI master to determine minimum common capabilities with
178180
* eSPI slave then send via SET_CONFIGURATION command.
179181
*
182+
* @code
180183
* +--------+ +---------+ +------+ +---------+ +---------+
181184
* | eSPI | | eSPI | | eSPI | | eSPI | | eSPI |
182185
* | slave | | driver | | bus | | driver | | host |
@@ -200,6 +203,7 @@ __subsystem struct espi_saf_driver_api {
200203
* | | | accept | |
201204
* | | +------------------>+ |
202205
* + + + + +
206+
* @endcode
203207
*
204208
* @param dev Pointer to the device structure for the driver instance.
205209
* @param cfg the device runtime configuration for the eSPI controller.
@@ -382,6 +386,7 @@ static inline int z_impl_espi_saf_flash_erase(const struct device *dev,
382386
/**
383387
* Callback model
384388
*
389+
* @code
385390
*+-------+ +-------------+ +------+ +---------+
386391
*| App | | eSPI driver | | HW | |eSPI Host|
387392
*+---+---+ +-------+-----+ +---+--+ +----+----+
@@ -437,6 +442,7 @@ static inline int z_impl_espi_saf_flash_erase(const struct device *dev,
437442
* <------------------------------+ | |
438443
* | App executes | | |
439444
* + power mgmt policy | | |
445+
* @endcode
440446
*/
441447

442448
/**

0 commit comments

Comments
 (0)