aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--drivers/tdisp/HD44780/tdisp_lld.c1
-rw-r--r--drivers/tdisp/HD44780/tdisp_lld_board_example.h1
-rw-r--r--include/tdisp/lld/tdisp_lld.h1
-rw-r--r--include/tdisp/tdisp.h61
-rw-r--r--src/tdisp/tdisp.c5
5 files changed, 65 insertions, 4 deletions
diff --git a/drivers/tdisp/HD44780/tdisp_lld.c b/drivers/tdisp/HD44780/tdisp_lld.c
index b830a7ca..0cbd414b 100644
--- a/drivers/tdisp/HD44780/tdisp_lld.c
+++ b/drivers/tdisp/HD44780/tdisp_lld.c
@@ -84,4 +84,5 @@ bool_t TDISP_LLD(init)(void) {
}
#endif /* GFX_USE_TDISP */
+/** @} */
diff --git a/drivers/tdisp/HD44780/tdisp_lld_board_example.h b/drivers/tdisp/HD44780/tdisp_lld_board_example.h
index e07116d8..de9e0b0b 100644
--- a/drivers/tdisp/HD44780/tdisp_lld_board_example.h
+++ b/drivers/tdisp/HD44780/tdisp_lld_board_example.h
@@ -60,4 +60,5 @@ void write_bus(uint8_t data) {
}
#endif /* _TDISP_LLD_BOARD_H */
+/** @} */
diff --git a/include/tdisp/lld/tdisp_lld.h b/include/tdisp/lld/tdisp_lld.h
index d548f107..a8f2e4b1 100644
--- a/include/tdisp/lld/tdisp_lld.h
+++ b/include/tdisp/lld/tdisp_lld.h
@@ -48,4 +48,5 @@ extern void write_data(uint8_t data);
#endif /* GFX_USE_TDISP */
#endif /* _TDISP_LLD_H */
+/** @} */
diff --git a/include/tdisp/tdisp.h b/include/tdisp/tdisp.h
index 9984ef62..9d19e0cb 100644
--- a/include/tdisp/tdisp.h
+++ b/include/tdisp/tdisp.h
@@ -41,16 +41,73 @@
/* Include the low level driver information */
#include "tdisp/lld/tdisp_lld.h"
+/**
+ * @brief TDISP driver initialisation
+ * @note This function is not implicitly invoked by @p halInit().
+ * It must be called manually.
+ *
+ * @return TRUE if success, FALSE otherwise
+ *
+ * @init
+ */
bool_t tdispInit(void);
+
+/**
+ * @brief Clears the display
+ */
void tdispClear(void);
+
+/**
+ * @brief Sets the cursor to it's home position ( 0/0 )
+ */
void tdispHome(void);
+
+/**
+ * @brief Set cursor to a certain position
+ *
+ * @param[in] col The column
+ * @param[in] row The row
+ */
void tdispGotoXY(coord_t col, coord_t row);
+
+/**
+ * @brief Draws a single character at the current cursor position
+ *
+ * @param[in] c The character to be drawn
+ */
void tdispDrawChar(char c);
+
+/**
+ * @brief Draws a string at the current cursor position
+ *
+ * @param[in] s The string to be drawn
+ */
void tdispDrawString(char *s);
-void tdispDrawCharLocation(coord_t x, coord_t y, char c);
-void tdispDrawStringLocation(coord_t x, coord_t y, char *s);
+
+/**
+ * @brief Draws a single character at a given position
+ * @note This function manipulates the cursor position and it will not be
+ * reset to it's original state
+ *
+ * @param[in] col The column
+ * @param[in] row The row
+ * @param[in] c The character to be drawn
+ */
+void tdispDrawCharLocation(coord_t col, coord_t row, char c);
+
+/**
+ * @brief Draws a string at a given position
+ * @note This function manipulates the cursor position and it will not be
+ * reset to it's original state
+ *
+ * @param[in] col The column
+ * @param[in] row The row
+ * @param[in] s The string to be drawn
+ */
+void tdispDrawStringLocation(coord_t col, coord_t row, char *s);
#endif /* GFX_USE_TDISP */
#endif /* _TDISP_H */
+/** @} */
diff --git a/src/tdisp/tdisp.c b/src/tdisp/tdisp.c
index 73db93a1..fe794140 100644
--- a/src/tdisp/tdisp.c
+++ b/src/tdisp/tdisp.c
@@ -64,15 +64,16 @@ void tdispDrawString(char *s) {
tdispDrawChar(c);
}
-void tdispDrawCharLocation(coord_t x, coord_t y, char c) {
+void tdispDrawCharLocation(coord_t col, coord_t row, char c) {
tdispGotoXY(x, y);
tdispDrawChar(c);
}
-void tdispDrawStringLocation(coord_t x, coord_t y, char *s) {
+void tdispDrawStringLocation(coord_t col, coord_t row, char *s) {
tdispGotoXY(x, y);
tdispDrawString(s);
}
#endif /* GFX_USE_TDISP */
+/** @} */