Skip to content
Permalink
Browse files

driver: display: Clarified blanking API

Updated the documentation of display_blanking_on and
display_blanking_off to clarify its usage.

Signed-off-by: Jan Van Winkel <jan.van_winkel@dxplore.eu>
  • Loading branch information...
vanwinkeljan authored and nashif committed Jul 14, 2019
1 parent 4bf7cea commit 42d18990876d53fb25957f514c42ec1381293295
Showing with 15 additions and 0 deletions.
  1. +15 −0 include/drivers/display.h
@@ -289,6 +289,17 @@ static inline void *display_get_framebuffer(const struct device *dev)
/**
* @brief Turn display blanking on
*
* This function blanks the complete display.
* The content of the frame buffer will be retained while blanking is enabled
* and the frame buffer will be accessible for read and write operations.
*
* In case backlight control is supported by the driver the backlight is
* turned off. The backlight configuration is retained and accessible for
* configuration.
*
* In case the driver supports display blanking the initial state of the driver
* would be the same as if this function was called.
*
* @param dev Pointer to device structure
*
* @retval 0 on success else negative errno code.
@@ -304,6 +315,10 @@ static inline int display_blanking_on(const struct device *dev)
/**
* @brief Turn display blanking off
*
* Restore the frame buffer content to the display.
* In case backlight control is supported by the driver the backlight
* configuration is restored.
*
* @param dev Pointer to device structure
*
* @retval 0 on success else negative errno code.

0 comments on commit 42d1899

Please sign in to comment.
You can’t perform that action at this time.