From 3c7ac9c2cf17d7a275ecb6261cc1e48bcf4a5597 Mon Sep 17 00:00:00 2001 From: mobyfab Date: Fri, 31 Aug 2012 20:09:22 +0200 Subject: [PATCH] updated comments, cleaning --- drivers/gdisp/SSD1963/gdisp_lld.c | 4 ++-- drivers/gdisp/SSD1963/gdisp_lld_board.h | 0 drivers/gdisp/SSD1963/gdisp_lld_config.h | 4 ++-- drivers/gdisp/SSD1963/gdisp_lld_panel.h | 9 ++++++++ drivers/gdisp/SSD1963/readme.txt | 29 +++--------------------- drivers/gdisp/SSD1963/ssd1963.h | 11 ++++++++- 6 files changed, 26 insertions(+), 31 deletions(-) delete mode 100644 drivers/gdisp/SSD1963/gdisp_lld_board.h diff --git a/drivers/gdisp/SSD1963/gdisp_lld.c b/drivers/gdisp/SSD1963/gdisp_lld.c index 4908ee22..e22f2ca1 100644 --- a/drivers/gdisp/SSD1963/gdisp_lld.c +++ b/drivers/gdisp/SSD1963/gdisp_lld.c @@ -19,8 +19,8 @@ */ /** - * @file templates/gdisp_lld.c - * @brief GDISP Graphics Driver subsystem low level driver source template. + * @file SSD1963/gdisp_lld.c + * @brief GDISP Graphics Driver subsystem low level driver source. * * @addtogroup GDISP * @{ diff --git a/drivers/gdisp/SSD1963/gdisp_lld_board.h b/drivers/gdisp/SSD1963/gdisp_lld_board.h deleted file mode 100644 index e69de29b..00000000 diff --git a/drivers/gdisp/SSD1963/gdisp_lld_config.h b/drivers/gdisp/SSD1963/gdisp_lld_config.h index 486ab1f2..f6c69d92 100644 --- a/drivers/gdisp/SSD1963/gdisp_lld_config.h +++ b/drivers/gdisp/SSD1963/gdisp_lld_config.h @@ -19,8 +19,8 @@ */ /** - * @file templates/gdisp_lld_config.h - * @brief GDISP Graphic Driver subsystem low level driver header template. + * @file SSD1963/gdisp_lld_config.h + * @brief GDISP Graphic Driver subsystem low level driver header. * * @addtogroup GDISP * @{ diff --git a/drivers/gdisp/SSD1963/gdisp_lld_panel.h b/drivers/gdisp/SSD1963/gdisp_lld_panel.h index f4a8595b..b2838250 100644 --- a/drivers/gdisp/SSD1963/gdisp_lld_panel.h +++ b/drivers/gdisp/SSD1963/gdisp_lld_panel.h @@ -18,6 +18,14 @@ along with this program. If not, see . */ +/** + * @file SSD1963/gdisp_lld_panel.h + * @brief TFT LCD panel properties. + * + * @addtogroup GDISP + * @{ + */ + #ifndef _GDISP_LLD_PANEL_H #define _GDISP_LLD_PANEL_H @@ -42,3 +50,4 @@ #define LCD_FPR ((SCREEN_PCLK * 1048576)/100000000) #endif +/** @} */ \ No newline at end of file diff --git a/drivers/gdisp/SSD1963/readme.txt b/drivers/gdisp/SSD1963/readme.txt index 2496fc51..7803cda0 100644 --- a/drivers/gdisp/SSD1963/readme.txt +++ b/drivers/gdisp/SSD1963/readme.txt @@ -1,35 +1,12 @@ -To use this driver template - 1. Copy this entire directory (including the directory itself) - into halext/drivers - 2. Rename the directory to match your hardware. - 3. Customise each file in the directory including the .mk file - and this file. An example for this file is below... - 4. Keep any board specific code in a file you create called - gdisp_lld_board_yourboardname.h and adjust gdisp.c to match. - This enables someone porting to a new board to add another - suitable boad definition without worrying about the rest of - the driver. See the gdispNokia6610 driver as an example. - ------------------------------------------------------------------- To use this driver: 1. Add in your halconf.h: a) #define HAL_USE_GDISP TRUE b) Any optional high level driver defines (see gdisp.h) eg: GDISP_NEED_MULTITHREAD c) One (only) of: - #define LCD_USE_GPIO - #define LCD_USE_SPI + #define LCD_USE_GPIO (Work in progress) #define LCD_USE_FSMC - d) All of the following (with appropriate values): - #define SCREEN_WIDTH 128 - #define SCREEN_HEIGHT 128 - e) If you are not using a known board then create a gdisp_lld_board.h file - and ensure it is on your include path. - Use the gdisp_lld_board_example.h file as a basis. - Currently known boards are: - XXXXXXXXX - + d) Edit gdisp_lld_panel.h with your panel properties 2. To your makefile add the following lines: - include $(CHIBIOS)/os/halext/halext.mk - include $(CHIBIOS)/os/halext/drivers/gdispXXXXX/gdisp_lld.mk + include $(LCDLIB)/drivers/gdisp/SSD1963/gdisp_lld.mk \ No newline at end of file diff --git a/drivers/gdisp/SSD1963/ssd1963.h b/drivers/gdisp/SSD1963/ssd1963.h index 0faa7c4e..794658e2 100644 --- a/drivers/gdisp/SSD1963/ssd1963.h +++ b/drivers/gdisp/SSD1963/ssd1963.h @@ -18,6 +18,14 @@ along with this program. If not, see . */ +/** + * @file SSD1963/ssd1963.h + * @brief SSD1963 specific data. + * + * @addtogroup GDISP + * @{ + */ + #ifndef SSD1963_H #define SSD1963_H @@ -135,4 +143,5 @@ #define SSD1963_PDI_9BIT 6 #define SSD1963_GET_PIXEL_DATA_INTERFACE 0x00F1 -#endif \ No newline at end of file +#endif +/** @} */ \ No newline at end of file