aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gdisp/SSD1289/board_SSD1289_template.h
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2013-10-17 14:57:47 +1000
committerinmarket <andrewh@inmarket.com.au>2013-10-17 14:57:47 +1000
commite1744e59ab70ced14a76ff133c50504f8e2a68af (patch)
tree63842b59f242ed6d4d5ad9a4af8bae6bfa0eedef /drivers/gdisp/SSD1289/board_SSD1289_template.h
parent4c29822a756168779436a5c0b3af0c85ecb7d66d (diff)
downloaduGFX-e1744e59ab70ced14a76ff133c50504f8e2a68af.tar.gz
uGFX-e1744e59ab70ced14a76ff133c50504f8e2a68af.tar.bz2
uGFX-e1744e59ab70ced14a76ff133c50504f8e2a68af.zip
SSD1289 driver updated for multiple display support
Diffstat (limited to 'drivers/gdisp/SSD1289/board_SSD1289_template.h')
-rw-r--r--drivers/gdisp/SSD1289/board_SSD1289_template.h172
1 files changed, 172 insertions, 0 deletions
diff --git a/drivers/gdisp/SSD1289/board_SSD1289_template.h b/drivers/gdisp/SSD1289/board_SSD1289_template.h
new file mode 100644
index 00000000..552c93a0
--- /dev/null
+++ b/drivers/gdisp/SSD1289/board_SSD1289_template.h
@@ -0,0 +1,172 @@
+/*
+ * This file is subject to the terms of the GFX License. If a copy of
+ * the license was not distributed with this file, you can obtain one at:
+ *
+ * http://ugfx.org/license.html
+ */
+
+/**
+ * @file drivers/gdisp/SSD1289/board_SSD1289_template.h
+ * @brief GDISP Graphic Driver subsystem board interface for the SSD1289 display.
+ *
+ * @addtogroup GDISP
+ * @{
+ */
+
+#ifndef _GDISP_LLD_BOARD_H
+#define _GDISP_LLD_BOARD_H
+
+/**
+ * @brief Initialise the board for the display.
+ *
+ * @param[in] g The GDisplay structure
+ * @param[in] display The display number on this controller (0..n)
+ *
+ * @note Set the g->priv 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, unsigned display) {
+}
+
+/**
+ * @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) {
+
+}
+
+/**
+ * @brief Set the lcd back-light level.
+ *
+ * @param[in] g The GDisplay structure
+ * @param[in] percent 0 to 100%
+ *
+ * @notapi
+ */
+static inline void set_backlight(GDisplay *g, uint8_t percent) {
+
+}
+
+/**
+ * @brief Take exclusive control of the bus
+ *
+ * @param[in] g The GDisplay structure
+ *
+ * @notapi
+ */
+static inline void acquire_bus(GDisplay *g) {
+
+}
+
+/**
+ * @brief Release exclusive control of the bus
+ *
+ * @param[in] g The GDisplay structure
+ *
+ * @notapi
+ */
+static inline void release_bus(GDisplay *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) {
+
+}
+
+/**
+ * @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) {
+
+}
+
+/**
+ * @brief Set the bus in read mode
+ *
+ * @param[in] g The GDisplay structure
+ *
+ * @notapi
+ */
+static inline void setreadmode(GDisplay *g) {
+
+}
+
+/**
+ * @brief Set the bus back into write mode
+ *
+ * @param[in] g The GDisplay structure
+ *
+ * @notapi
+ */
+static inline void setwritemode(GDisplay *g) {
+
+}
+
+/**
+ * @brief Read data from the lcd.
+ * @return The data from the lcd
+ *
+ * @param[in] g The GDisplay structure
+ *
+ * @note The chip select may need to be asserted/de-asserted
+ * around the actual spi read
+ *
+ * @notapi
+ */
+static inline uint16_t read_data(GDisplay *g) {
+
+}
+
+/**
+ * The below section you can replace with #error if your interface doesn't support DMA
+ */
+#if defined(GDISP_USE_DMA) || defined(__DOXYGEN__)
+ //#error "GDISP - SSD1289: This interface does not support DMA"
+
+ /**
+ * @brief Transfer data using DMA but don't increment the source address
+ *
+ * @param[in] g The GDisplay structure
+ * @param[in] buffer The source buffer location
+ * @param[in] area The number of pixels to transfer
+ *
+ * @notapi
+ */
+ static inline void dma_with_noinc(GDisplay *g, color_t *buffer, int area) {
+ }
+
+ /**
+ * @brief Transfer data using DMA incrementing the source address
+ *
+ * @param[in] g The GDisplay structure
+ * @param[in] buffer The source buffer location
+ * @param[in] area The number of pixels to transfer
+ *
+ * @notapi
+ */
+ static inline void dma_with_inc(GDisplay *g, color_t *buffer, int area) {
+ }
+#endif
+
+#endif /* _GDISP_LLD_BOARD_H */
+/** @} */