aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gdisp/SSD1963
diff options
context:
space:
mode:
authorJoel Bodenmann <joel@unormal.org>2014-03-28 19:45:08 +0100
committerJoel Bodenmann <joel@unormal.org>2014-03-28 19:45:08 +0100
commit08e1b0ebc7a5b9a960994e16710465dfb67f66ee (patch)
tree72137dac1330a3ebb41b294a8d762b98dc559553 /drivers/gdisp/SSD1963
parent16f86ed2e6980fd0ddfa4cedb6bdaf51881f0e3c (diff)
downloaduGFX-08e1b0ebc7a5b9a960994e16710465dfb67f66ee.tar.gz
uGFX-08e1b0ebc7a5b9a960994e16710465dfb67f66ee.tar.bz2
uGFX-08e1b0ebc7a5b9a960994e16710465dfb67f66ee.zip
Removed the doxygen inside of every driver as doxygen is only meant for highlevel API documentation.
Documenting the drivers interface should be done inside a template driver or the gdisp LLD abstraction.
Diffstat (limited to 'drivers/gdisp/SSD1963')
-rw-r--r--drivers/gdisp/SSD1963/board_SSD1963_template.h94
-rw-r--r--drivers/gdisp/SSD1963/gdisp_lld_SSD1963.c6
-rw-r--r--drivers/gdisp/SSD1963/gdisp_lld_config.h10
-rw-r--r--drivers/gdisp/SSD1963/ssd1963.h2
4 files changed, 0 insertions, 112 deletions
diff --git a/drivers/gdisp/SSD1963/board_SSD1963_template.h b/drivers/gdisp/SSD1963/board_SSD1963_template.h
index 5e1999b8..f9f248e7 100644
--- a/drivers/gdisp/SSD1963/board_SSD1963_template.h
+++ b/drivers/gdisp/SSD1963/board_SSD1963_template.h
@@ -5,47 +5,9 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/gdisp/SSD1963/board_SSD1963_template.h
- * @brief GDISP Graphic Driver subsystem board interface for the SSD1963 display.
- *
- * @addtogroup GDISP
- * @{
- */
-
#ifndef _GDISP_LLD_BOARD_H
#define _GDISP_LLD_BOARD_H
-/**
- * @brief LCD panel specs
- *
- * @note The timings need to follow the datasheet for your particular TFT/LCD screen
- * (the actual screen, not the controller).
- * @note Datasheets normally use a specific set of timings and acronyms, their value refers
- * to the number of pixel clocks. Non-display periods refer to pulses/timings that occur
- * before or after the timings that actually put pixels on the screen. Display periods
- * refer to pulses/timings that directly put pixels on the screen.
- * @note HDP: Horizontal Display Period, normally the width - 1<br>
- * HT: Horizontal Total period (display + non-display)<br>
- * HPS: non-display period between the start of the horizontal sync (LLINE) signal
- * and the first display data<br>
- * LPS: horizontal sync pulse (LLINE) start location in pixel clocks<br>
- * HPW: Horizontal sync Pulse Width<br>
- * VDP: Vertical Display period, normally height - 1<br>
- * VT: Vertical Total period (display + non-display)<br>
- * VPS: non-display period in lines between the start of the frame and the first display
- * data in number of lines<br>
- * FPS: vertical sync pulse (LFRAME) start location in lines.<br>
- * VPW: Vertical sync Pulse Width
- * @note Here's how to convert them:<br>
- * SCREEN_HSYNC_FRONT_PORCH = ( HT - HPS ) - GDISP_SCREEN_WIDTH<br>
- * SCREEN_HSYNC_PULSE = HPW<br>
- * SCREEN_HSYNC_BACK_PORCH = HPS - HPW<br>
- * SCREEN_VSYNC_FRONT_PORCH = ( VT - VPS ) - GDISP_SCREEN_HEIGHT<br>
- * SCREEN_VSYNC_PULSE = VPW<br>
- * SCREEN_VSYNC_BACK_PORCH = VPS - LPS<br>
- */
-
static const LCD_Parameters DisplayTimings[] = {
// You need one of these array elements per display
{
@@ -58,91 +20,35 @@ static const LCD_Parameters DisplayTimings[] = {
},
};
-/**
- * @brief Initialise the board for the display.
- *
- * @param[in] g The GDisplay structure
- *
- * @note Set the g->board member to whatever is appropriate. For multiple
- * displays this might be a pointer to the appropriate register set.
- *
- * @notapi
- */
static inline void init_board(GDisplay *g) {
(void) g;
}
-/**
- * @brief After the initialisation.
- *
- * @param[in] g The GDisplay structure
- *
- * @notapi
- */
static inline void post_init_board(GDisplay *g) {
(void) g;
}
-/**
- * @brief Set or clear the lcd reset pin.
- *
- * @param[in] g The GDisplay structure
- * @param[in] state TRUE = lcd in reset, FALSE = normal operation
- *
- * @notapi
- */
static inline void setpin_reset(GDisplay *g, bool_t state) {
(void) g;
(void) state;
}
-/**
- * @brief Take exclusive control of the bus
- *
- * @param[in] g The GDisplay structure
- *
- * @notapi
- */
static inline void acquire_bus(GDisplay *g) {
(void) g;
}
-/**
- * @brief Release exclusive control of the bus
- *
- * @param[in] g The GDisplay structure
- *
- * @notapi
- */
static inline void release_bus(GDisplay *g) {
(void) g;
}
-/**
- * @brief Send data to the index register.
- *
- * @param[in] g The GDisplay structure
- * @param[in] index The index register to set
- *
- * @notapi
- */
static inline void write_index(GDisplay *g, uint16_t index) {
(void) g;
(void) index;
}
-/**
- * @brief Send data to the lcd.
- *
- * @param[in] g The GDisplay structure
- * @param[in] data The data to send
- *
- * @notapi
- */
static inline void write_data(GDisplay *g, uint16_t data) {
(void) g;
(void) data;
}
#endif /* _GDISP_LLD_BOARD_H */
-/** @} */
diff --git a/drivers/gdisp/SSD1963/gdisp_lld_SSD1963.c b/drivers/gdisp/SSD1963/gdisp_lld_SSD1963.c
index 1e69ef70..74fa3e3e 100644
--- a/drivers/gdisp/SSD1963/gdisp_lld_SSD1963.c
+++ b/drivers/gdisp/SSD1963/gdisp_lld_SSD1963.c
@@ -5,11 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/gdisp/SSD1963/gdisp_lld.c
- * @brief GDISP Graphics Driver subsystem low level driver source.
- */
-
#include "gfx.h"
#if GFX_USE_GDISP
@@ -282,4 +277,3 @@ LLDSPEC bool_t gdisp_lld_init(GDisplay *g) {
#endif
#endif /* GFX_USE_GDISP */
-
diff --git a/drivers/gdisp/SSD1963/gdisp_lld_config.h b/drivers/gdisp/SSD1963/gdisp_lld_config.h
index 8ad94738..f1b61702 100644
--- a/drivers/gdisp/SSD1963/gdisp_lld_config.h
+++ b/drivers/gdisp/SSD1963/gdisp_lld_config.h
@@ -5,14 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/gdisp/SSD1963/gdisp_lld_config.h
- * @brief GDISP Graphic Driver subsystem low level driver header.
- *
- * @addtogroup GDISP
- * @{
- */
-
#ifndef _GDISP_LLD_CONFIG_H
#define _GDISP_LLD_CONFIG_H
@@ -30,5 +22,3 @@
#endif /* GFX_USE_GDISP */
#endif /* _GDISP_LLD_CONFIG_H */
-/** @} */
-
diff --git a/drivers/gdisp/SSD1963/ssd1963.h b/drivers/gdisp/SSD1963/ssd1963.h
index be328775..2d1ac55f 100644
--- a/drivers/gdisp/SSD1963/ssd1963.h
+++ b/drivers/gdisp/SSD1963/ssd1963.h
@@ -9,7 +9,6 @@
#define SSD1963_H
/* SSD1963 commands */
-
#define SSD1963_NOP 0x0000
#define SSD1963_SOFT_RESET 0x0001
#define SSD1963_GET_POWER_MODE 0x000A
@@ -95,4 +94,3 @@
#define SSD1963_GET_PIXEL_DATA_INTERFACE 0x00F1
#endif
-