aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gdisp/gdispNokia6610/gdisp_lld_board_example.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/gdisp/gdispNokia6610/gdisp_lld_board_example.h')
-rw-r--r--drivers/gdisp/gdispNokia6610/gdisp_lld_board_example.h97
1 files changed, 97 insertions, 0 deletions
diff --git a/drivers/gdisp/gdispNokia6610/gdisp_lld_board_example.h b/drivers/gdisp/gdispNokia6610/gdisp_lld_board_example.h
new file mode 100644
index 00000000..0e2b806e
--- /dev/null
+++ b/drivers/gdisp/gdispNokia6610/gdisp_lld_board_example.h
@@ -0,0 +1,97 @@
+/*
+ ChibiOS/RT - Copyright (C) 2012
+ Joel Bodenmann aka Tectu <joel@unormal.org>
+
+ This file is part of ChibiOS-LCD-Driver.
+
+ ChibiOS-LCD-Driver is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS-LCD-Driver is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @file gdispNokia6610/gdisp_lld_board_example.h
+ * @brief GDISP Graphic Driver subsystem board interface for the Nokia6610 display.
+ *
+ * @addtogroup GDISP
+ * @{
+ */
+
+#ifndef _GDISP_LLD_BOARD_H
+#define _GDISP_LLD_BOARD_H
+
+/**
+ * @brief Initialise the board for the display.
+ * @notes Performs the following functions:
+ * 1. initialise the spi port used by your display
+ * 2. initialise the reset pin (initial state not-in-reset)
+ * 3. initialise the chip select pin (initial state not-active)
+ * 4. initialise the backlight pin (initial state back-light off)
+ *
+ * @notapi
+ */
+static __inline void GDISP_LLD(init_board)(void) {
+ /* Code here */
+}
+
+/**
+ * @brief Set or clear the lcd reset pin.
+ *
+ * @param[in] state TRUE = lcd in reset, FALSE = normal operation
+ *
+ * @notapi
+ */
+static __inline void GDISP_LLD(setpin_reset)(bool_t state) {
+ /* Code here */
+}
+
+/**
+ * @brief Set or clear the lcd back-light pin.
+ *
+ * @param[in] state TRUE = lcd back-light on, FALSE = lcd back-light off
+ *
+ * @notapi
+ */
+static __inline void GDISP_LLD(setpin_backlight)(bool_t state) {
+ /* Code here */
+}
+
+/**
+ * @brief Send a 9 bit command/data to the lcd.
+ * @note The chip select may need to be asserted/de-asserted
+ * around the actual spi write
+ *
+ * @param[in] data The data to send
+ *
+ * @notapi
+ */
+static __inline void GDISP_LLD(write_spi)(uint16_t data) {
+ /* Code here */
+}
+
+#if GDISP_HARDWARE_READPIXEL || GDISP_HARDWARE_SCROLL || defined(__DOXYGEN__)
+/**
+ * @brief Read data from the lcd.
+ *
+ * @return The data from the lcd
+ * @note The chip select may need to be asserted/de-asserted
+ * around the actual spi read
+ *
+ * @notapi
+ */
+static __inline uint16_t GDISP_LLD(read_spi)(void) {
+ /* Code here */
+}
+#endif
+
+#endif /* _GDISP_LLD_BOARD_H */
+/** @} */