Th3maz1ng/W800_Smart_Watch
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Mise à jour de 'src/W800 SDK v1.00.08/app/app_drivers/lcd/lcd.h'

Browse Source 
Corrected a few comments
This commit is contained in:
Th3maz1ng 2023-01-23 13:35:31 +01:00
parent e19741593e
commit efe0578ed9
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/W800 SDK v1.00.08/app/app_drivers/lcd/lcd.h
View File

@ -6,7 +6,7 @@
/* Used SOC : W800 or W801 */ /* Used SOC : W800 or W801 */
#define W800 #define W800
/* Display drive controller */ /* Display controller IC */
#define ILI9341 0 #define ILI9341 0
#define ST7789V 1 #define ST7789V 1
#define GC9A01 2 #define GC9A01 2
@ -69,7 +69,7 @@ typedef struct LCDConfig
* @brief Initializes the LCDConfig object to known values * @brief Initializes the LCDConfig object to known values
* Must be called before using any other LCD Driver API functions * Must be called before using any other LCD Driver API functions
* *
* @param LCDConfig a pointer a user allocated LCDConfig_t structure * @param LCDConfig a pointer to a user allocated LCDConfig_t structure
*/ */
void lcd_config_init(LCDConfig_t * const LCDConfig); void lcd_config_init(LCDConfig_t * const LCDConfig);
@ -78,7 +78,7 @@ void lcd_config_init(LCDConfig_t * const LCDConfig);
* Usually called once the DMA engine is done with the transfer. * Usually called once the DMA engine is done with the transfer.
* /!\ MUST BE CALLED BEFORE lcd_init FUNCTION * /!\ MUST BE CALLED BEFORE lcd_init FUNCTION
* *
* @param LCDConfig a pointer a user allocated LCDConfig_t structure * @param LCDConfig a pointer to a user allocated LCDConfig_t structure
* @param drawFinishedCb the function to register of the form : void myFunc(void *arg) * @param drawFinishedCb the function to register of the form : void myFunc(void *arg)
* @param arg a pointer to an optional argument passed to the callback function * @param arg a pointer to an optional argument passed to the callback function
*/ */
@ -87,14 +87,14 @@ void lcd_register_draw_finished_cb(LCDConfig_t * const LCDConfig, DrawFinishedCb
/** /**
* @brief Initializes IOs using the configured LCDConfig object and the LCD display * @brief Initializes IOs using the configured LCDConfig object and the LCD display
* *
* @param LCDConfig a pointer a user allocated LCDConfig_t structure * @param LCDConfig a pointer to a user allocated LCDConfig_t structure
*/ */
void lcd_init(LCDConfig_t * const LCDConfig); void lcd_init(LCDConfig_t * const LCDConfig);
/** /**
* @brief Writes the frame to display's internal RAM * @brief Writes the frame to display's internal RAM
* *
* @param LCDConfig a pointer a user allocated LCDConfig_t structure * @param LCDConfig a pointer to a user allocated LCDConfig_t structure
* @param x * @param x
* @param y * @param y
* @param width * @param width
@ -104,9 +104,9 @@ void lcd_init(LCDConfig_t * const LCDConfig);
void lcd_draw_rect_frame(LCDConfig_t * const LCDConfig, uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint8_t *data); void lcd_draw_rect_frame(LCDConfig_t * const LCDConfig, uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint8_t *data);
/** /**
* @brief Sets the backlight to the specified brightness value * @brief Sets the backlight to the specified brightness value (0 to 255)
* *
* @param LCDConfig a pointer a user allocated LCDConfig_t structure * @param LCDConfig a pointer to a user allocated LCDConfig_t structure
* @param brightness a value from 0 (backlight off) to 255 backlight fully on. * @param brightness a value from 0 (backlight off) to 255 backlight fully on.
*/ */
void lcd_set_backlight(LCDConfig_t * const LCDConfig, uint8_t brightness); void lcd_set_backlight(LCDConfig_t * const LCDConfig, uint8_t brightness);
@ -114,14 +114,14 @@ void lcd_set_backlight(LCDConfig_t * const LCDConfig, uint8_t brightness);
/** /**
* @brief Issues a hardware reset of the lcd display * @brief Issues a hardware reset of the lcd display
* *
* @param LCDConfig a pointer a user allocated LCDConfig_t structure * @param LCDConfig a pointer to a user allocated LCDConfig_t structure
*/ */
void lcd_hardware_reset(LCDConfig_t * const LCDConfig); void lcd_hardware_reset(LCDConfig_t * const LCDConfig);
/** /**
* @brief Turns the LCD on or off, /!\ not the same as sleep mode ! * @brief Turns the LCD on or off, /!\ not the same as sleep mode !
* *
* @param LCDConfig a pointer a user allocated LCDConfig_t structure * @param LCDConfig a pointer to a user allocated LCDConfig_t structure
* @param state true to turn the LCD on or false to turn it off * @param state true to turn the LCD on or false to turn it off
*/ */
void lcd_on(LCDConfig_t * const LCDConfig, bool state); void lcd_on(LCDConfig_t * const LCDConfig, bool state);
@ -130,7 +130,7 @@ void lcd_on(LCDConfig_t * const LCDConfig, bool state);
* @brief Puts the LCD in power down mode (sleep) or power up mode (active) * @brief Puts the LCD in power down mode (sleep) or power up mode (active)
* Sleep mode puts the LCD in it's lowest power state * Sleep mode puts the LCD in it's lowest power state
* *
* @param LCDConfig a pointer a user allocated LCDConfig_t structure * @param LCDConfig a pointer to a user allocated LCDConfig_t structure
* @param state true to put the LCD in sleep mode or false to put it in active mode * @param state true to put the LCD in sleep mode or false to put it in active mode
*/ */
void lcd_sleep(LCDConfig_t * const LCDConfig, bool state); void lcd_sleep(LCDConfig_t * const LCDConfig, bool state);
@ -138,7 +138,7 @@ void lcd_sleep(LCDConfig_t * const LCDConfig, bool state);
/** /**
* @brief Sets the LCD orientation. * @brief Sets the LCD orientation.
* *
* @param LCDConfig a pointer a user allocated LCDConfig_t structure * @param LCDConfig a pointer to a user allocated LCDConfig_t structure
* @param orientation the value of the orientation to set * @param orientation the value of the orientation to set
*/ */
void lcd_orientation(LCDConfig_t * const LCDConfig, LCDOrientation_t orientation); void lcd_orientation(LCDConfig_t * const LCDConfig, LCDOrientation_t orientation);