aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gdisp/ED060SC4/board_ED060SC4_template.h
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/ED060SC4/board_ED060SC4_template.h
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/ED060SC4/board_ED060SC4_template.h')
-rw-r--r--drivers/gdisp/ED060SC4/board_ED060SC4_template.h92
1 files changed, 1 insertions, 91 deletions
diff --git a/drivers/gdisp/ED060SC4/board_ED060SC4_template.h b/drivers/gdisp/ED060SC4/board_ED060SC4_template.h
index 6d71a986..69683cd0 100644
--- a/drivers/gdisp/ED060SC4/board_ED060SC4_template.h
+++ b/drivers/gdisp/ED060SC4/board_ED060SC4_template.h
@@ -5,18 +5,10 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/gdisp/ST7565/board_ST7565_template.h
- * @brief GDISP Graphic Driver subsystem board interface for the ST7565 display.
- *
- * @addtogroup GDISP
- * @{
- */
-
#ifndef _GDISP_LLD_BOARD_H
#define _GDISP_LLD_BOARD_H
-/**
+/*
* @brief Optional parameters that can be put in this file.
* @note The values listed below are the defaults.
*
@@ -54,149 +46,67 @@
* #define EINK_WRITECOUNT 4
*/
-/**
- * @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 Delay for display waveforms. Should be an accurate microsecond delay.
- *
- * @param[in] us The number of microseconds
- */
static void eink_delay(int us) {
(void) us;
}
-/**
- * @brief Turn the E-ink panel Vdd supply (+3.3V) on or off.
- *
- * @param[in] g The GDisplay structure
- * @param[in] on On or off
- */
static inline void setpower_vdd(GDisplay *g, bool_t on) {
(void) g;
(void) on;
}
-/**
- * @brief Turn the E-ink panel negative supplies (-15V, -20V) on or off.
- *
- * @param[in] g The GDisplay structure
- * @param[in] on On or off
- */
static inline void setpower_vneg(GDisplay *g, bool_t on) {
(void) g;
(void) on;
}
-/**
- * @brief Turn the E-ink panel positive supplies (-15V, -20V) on or off.
- *
- * @param[in] g The GDisplay structure
- * @param[in] on On or off
- */
static inline void setpower_vpos(GDisplay *g, bool_t on) {
(void) g;
(void) on;
}
-/**
- * @brief Set the state of the LE (source driver Latch Enable) pin.
- *
- * @param[in] g The GDisplay structure
- * @param[in] on On or off
- */
static inline void setpin_le(GDisplay *g, bool_t on) {
(void) g;
(void) on;
}
-/**
- * @brief Set the state of the OE (source driver Output Enable) pin.
- *
- * @param[in] g The GDisplay structure
- * @param[in] on On or off
- */
static inline void setpin_oe(GDisplay *g, bool_t on) {
(void) g;
(void) on;
}
-/**
- * @brief Set the state of the CL (source driver Clock) pin.
- *
- * @param[in] g The GDisplay structure
- * @param[in] on On or off
- */
static inline void setpin_cl(GDisplay *g, bool_t on) {
(void) g;
(void) on;
}
-/**
- * @brief Set the state of the SPH (source driver Start Pulse Horizontal) pin.
- *
- * @param[in] g The GDisplay structure
- * @param[in] on On or off
- */
static inline void setpin_sph(GDisplay *g, bool_t on) {
(void) g;
(void) on;
}
-/**
- * @brief Set the state of the D0-D7 (source driver Data) pins.
- *
- * @param[in] g The GDisplay structure
- * @param[in] value The byte to write
- */
static inline void setpins_data(GDisplay *g, uint8_t value) {
(void) g;
(void) value;
}
-/**
- * @brief Set the state of the CKV (gate driver Clock Vertical) pin.
- *
- * @param[in] g The GDisplay structure
- * @param[in] on On or off
- */
static inline void setpin_ckv(GDisplay *g, bool_t on) {
(void) g;
(void) on;
}
-/**
- * @brief Set the state of the GMODE (gate driver Gate Mode) pin.
- *
- * @param[in] g The GDisplay structure
- * @param[in] on On or off
- */
static inline void setpin_gmode(GDisplay *g, bool_t on) {
(void) g;
(void) on;
}
-/**
- * @brief Set the state of the SPV (gate driver Start Pulse Vertical) pin.
- *
- * @param[in] g The GDisplay structure
- * @param[in] on On or off
- */
static inline void setpin_spv(GDisplay *g, bool_t on) {
(void) g;
(void) on;
}
#endif /* _GDISP_LLD_BOARD_H */
-/** @} */