mangavalk/lcdproc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen-ize

Browse Source
This commit is contained in:
marschap
2008-12-21 18:34:31 +00:00
parent ca9964e03a
commit 3ed66ed4f3
3 changed files with 324 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/drivers/picolcd.c
+167 -22
View File
@@ -158,7 +158,15 @@ MODULE_EXPORT int supports_multiple = 1;
MODULE_EXPORT char *symbol_prefix = "picoLCD_"; MODULE_EXPORT char *symbol_prefix = "picoLCD_";
/* lcd_logical_driver mandatory functions */ /* lcd_logical_driver mandatory functions */
MODULE_EXPORT int picoLCD_init(Driver *drvthis) {
/**
* Initialize the driver.
* \param drvthis Pointer to driver structure.
* \retval 0 Success.
* \retval <0 Error.
*/
MODULE_EXPORT int picoLCD_init(Driver *drvthis)
{
PrivateData *p; PrivateData *p;
int x; int x;
struct usb_bus *bus; struct usb_bus *bus;
@@ -316,6 +324,10 @@ MODULE_EXPORT int picoLCD_init(Driver *drvthis) {
} }
/**
* Close the driver (do necessary clean-up).
* \param drvthis Pointer to driver structure.
*/
MODULE_EXPORT void picoLCD_close(Driver *drvthis) MODULE_EXPORT void picoLCD_close(Driver *drvthis)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -328,6 +340,12 @@ MODULE_EXPORT void picoLCD_close(Driver *drvthis)
/* lcd_logical_driver Essential output functions */ /* lcd_logical_driver Essential output functions */
/**
* Return the display width in characters.
* \param drvthis Pointer to driver structure.
* \return Number of characters the display is wide.
*/
MODULE_EXPORT int picoLCD_width(Driver *drvthis) MODULE_EXPORT int picoLCD_width(Driver *drvthis)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -336,6 +354,11 @@ MODULE_EXPORT int picoLCD_width(Driver *drvthis)
} }
/**
* Return the display height in characters.
* \param drvthis Pointer to driver structure.
* \return Number of characters the display is high.
*/
MODULE_EXPORT int picoLCD_height(Driver *drvthis) MODULE_EXPORT int picoLCD_height(Driver *drvthis)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -344,6 +367,10 @@ MODULE_EXPORT int picoLCD_height(Driver *drvthis)
} }
/**
* Clear the screen.
* \param drvthis Pointer to driver structure.
*/
MODULE_EXPORT void picoLCD_clear(Driver *drvthis) MODULE_EXPORT void picoLCD_clear(Driver *drvthis)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -355,6 +382,9 @@ MODULE_EXPORT void picoLCD_clear(Driver *drvthis)
} }
/* Flush data on screen to the display.
* \param drvthis Pointer to driver structure.
*/
MODULE_EXPORT void picoLCD_flush(Driver *drvthis) MODULE_EXPORT void picoLCD_flush(Driver *drvthis)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -390,41 +420,57 @@ MODULE_EXPORT void picoLCD_flush(Driver *drvthis)
} }
MODULE_EXPORT void picoLCD_string(Driver *drvthis, int x, int y, unsigned char *str) /**
* Print a string on the screen at position (x,y).
* The upper-left corner is (1,1), the lower-right corner is (p->width, p->height).
* \param drvthis Pointer to driver structure.
* \param x Horizontal character position (column).
* \param y Vertical character position (row).
* \param string String that gets written.
*/
MODULE_EXPORT void picoLCD_string(Driver *drvthis, int x, int y, unsigned char string[])
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
unsigned char *dest; unsigned char *dest;
int len; int len;
debug(RPT_DEBUG, "%s: string start (%s)", drvthis->name, str); debug(RPT_DEBUG, "%s: string start (%s)", drvthis->name, string);
if (y < 1 || y > p->height) if (y < 1 || y > p->height)
return; return;
if (x < 1 || x > p->width) if (x < 1 || x > p->width)
return; return;
len = strlen((char *)str); len = strlen((char *)string);
if (len + x > p->width) { if (len + x > p->width) {
debug(RPT_DEBUG, "%s: string overlength (>%d). Start: %d Length: %d (%s)", debug(RPT_DEBUG, "%s: string overlength (>%d). Start: %d Length: %d (%s)",
drvthis->name, p->width, x, len ,str); drvthis->name, p->width, x, len, string);
len = p->width - x; /* Copy what we can */ len = p->width - x; /* Copy what we can */
} }
x--; y--; /* Convert 1-based to 0-based */ x--; y--; /* Convert 1-based to 0-based */
dest = p->framebuf + (y * p->width + x); dest = p->framebuf + (y * p->width + x);
memcpy(dest, str, len * sizeof(unsigned char)); memcpy(dest, string, len * sizeof(unsigned char));
debug(RPT_DEBUG, "%s: string complete (%s)", drvthis->name, str); debug(RPT_DEBUG, "%s: string complete (%s)", drvthis->name, string);
} }
MODULE_EXPORT void picoLCD_chr(Driver *drvthis, int x, int y, unsigned char chr) /**
* Print a character on the screen at position (x,y).
* The upper-left corner is (1,1), the lower-right corner is (p->width, p->height).
* \param drvthis Pointer to driver structure.
* \param x Horizontal character position (column).
* \param y Vertical character position (row).
* \param c Character that gets written.
*/
MODULE_EXPORT void picoLCD_chr(Driver *drvthis, int x, int y, unsigned char c)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
unsigned char *dest; unsigned char *dest;
debug(RPT_DEBUG, "%s: chr start (%c)", drvthis->name, chr); debug(RPT_DEBUG, "%s: chr start (%c)", drvthis->name, c);
if (y < 1 || y > p->height) if (y < 1 || y > p->height)
return; return;
@@ -433,13 +479,21 @@ MODULE_EXPORT void picoLCD_chr(Driver *drvthis, int x, int y, unsigned char chr)
x--; y--; /* Convert 1-based to 0-based */ x--; y--; /* Convert 1-based to 0-based */
dest = p->framebuf + (y * p->width + x); dest = p->framebuf + (y * p->width + x);
memcpy(dest, &chr, sizeof(unsigned char)); memcpy(dest, &c, sizeof(unsigned char));
debug(RPT_DEBUG, "%s: chr complete (%c)", drvthis->name, chr); debug(RPT_DEBUG, "%s: chr complete (%c)", drvthis->name, c);
} }
/**
* Define a custom character and write it to the LCD.
* \param drvthis Pointer to driver structure.
* \param n Custom character to define [0 - (NUM_CCs-1)].
* \param dat Array of 8 (=cellheight) bytes, each representing a pixel row
* starting from the top to bottom.
* The bits in each byte represent the pixels where the LSB
* (least significant bit) is the rightmost pixel in each pixel row.
*/
MODULE_EXPORT void picoLCD_set_char (Driver *drvthis, int n, unsigned char *dat) MODULE_EXPORT void picoLCD_set_char (Driver *drvthis, int n, unsigned char *dat)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -448,13 +502,26 @@ MODULE_EXPORT void picoLCD_set_char (Driver *drvthis, int n, unsigned char *dat)
} }
/**
* Get total number of custom characters available.
* \param drvthis Pointer to driver structure.
* \return Number of custom characters (always NUM_CCs).
*/
MODULE_EXPORT int picoLCD_get_free_chars (Driver *drvthis) MODULE_EXPORT int picoLCD_get_free_chars (Driver *drvthis)
{ {
return NUM_CCs; return NUM_CCs;
} }
/**
* Draw a vertical bar bottom-up.
* \param drvthis Pointer to driver structure.
* \param x Horizontal character position (column) of the starting point.
* \param y Vertical character position (row) of the starting point.
* \param len Number of characters that the bar is high at 100%
* \param promille Current height level of the bar in promille.
* \param options Options (currently unused).
*/
MODULE_EXPORT void picoLCD_vbar (Driver *drvthis, int x, int y, int len, int promille, int options) MODULE_EXPORT void picoLCD_vbar (Driver *drvthis, int x, int y, int len, int promille, int options)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -484,6 +551,15 @@ MODULE_EXPORT void picoLCD_vbar (Driver *drvthis, int x, int y, int len, int pro
} }
/**
* Draw a horizontal bar to the right.
* \param drvthis Pointer to driver structure.
* \param x Horizontal character position (column) of the starting point.
* \param y Vertical character position (row) of the starting point.
* \param len Number of characters that the bar is long at 100%
* \param promille Current length level of the bar in promille.
* \param options Options (currently unused).
*/
MODULE_EXPORT void picoLCD_hbar (Driver *drvthis, int x, int y, int len, int promille, int options) MODULE_EXPORT void picoLCD_hbar (Driver *drvthis, int x, int y, int len, int promille, int options)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -514,6 +590,12 @@ MODULE_EXPORT void picoLCD_hbar (Driver *drvthis, int x, int y, int len, int pro
} }
/**
* Write a big number to the screen.
* \param drvthis Pointer to driver structure.
* \param x Horizontal character position (column).
* \param num Character to write (0 - 10 with 10 representing ':')
*/
MODULE_EXPORT void picoLCD_num (Driver *drvthis, int x, int num) MODULE_EXPORT void picoLCD_num (Driver *drvthis, int x, int num)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -540,6 +622,15 @@ MODULE_EXPORT void picoLCD_num (Driver *drvthis, int x, int num)
} }
/**
* Place an icon on the screen.
* \param drvthis Pointer to driver structure.
* \param x Horizontal character position (column).
* \param y Vertical character position (row).
* \param icon synbolic value representing the icon.
* \retval 0 Icon has been successfully defined/written.
* \retval <0 Server core shall define/write the icon.
*/
MODULE_EXPORT int picoLCD_icon (Driver *drvthis, int x, int y, int icon) MODULE_EXPORT int picoLCD_icon (Driver *drvthis, int x, int y, int icon)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -582,7 +673,15 @@ MODULE_EXPORT int picoLCD_icon (Driver *drvthis, int x, int y, int icon)
/* lcd_logical_driver Essential input functions */ /* lcd_logical_driver Essential input functions */
MODULE_EXPORT char *picoLCD_get_key(Driver *drvthis) {
/**
* Handle input from keyboard.
* \param drvthis Pointer to driver structure.
* \return String representation of the key;
* \c NULL if nothing available / unmapped key
*/
MODULE_EXPORT char *picoLCD_get_key(Driver *drvthis)
{
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
lcd_packet *keydata; lcd_packet *keydata;
char *keystr = NULL; char *keystr = NULL;
@@ -713,6 +812,14 @@ MODULE_EXPORT char *picoLCD_get_key(Driver *drvthis) {
/* lcd_logical_driver User-defined character functions */ /* lcd_logical_driver User-defined character functions */
/* lcd_logical_driver Hardware functions */ /* lcd_logical_driver Hardware functions */
/**
* Get current display contrast.
* This is only the locally stored contrast, the contrast value
* cannot be retrieved from the device.
* \param drvthis Pointer to driver structure.
* \return Stored contrast in promille.
*/
MODULE_EXPORT int picoLCD_get_contrast(Driver *drvthis) MODULE_EXPORT int picoLCD_get_contrast(Driver *drvthis)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -721,6 +828,11 @@ MODULE_EXPORT int picoLCD_get_contrast(Driver *drvthis)
} }
/**
* Change display contrast.
* \param drvthis Pointer to driver structure.
* \param promille New contrast value in promille.
*/
MODULE_EXPORT void picoLCD_set_contrast(Driver *drvthis, int promille) MODULE_EXPORT void picoLCD_set_contrast(Driver *drvthis, int promille)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -750,12 +862,25 @@ MODULE_EXPORT void picoLCD_set_contrast(Driver *drvthis, int promille)
} }
/* *
* Retrieve brightness.
* \param drvthis Pointer to driver structure.
* \param state Brightness state (on/off) for which we want the value.
* \return Stored brightness in promille.
*/
/*MODULE_EXPORT int picoLCD_get_brightness(Driver *drvthis, int state) /*MODULE_EXPORT int picoLCD_get_brightness(Driver *drvthis, int state)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
}*/ }*/
/**
* Set on/off brightness.
* \param drvthis Pointer to driver structure.
* \param state Brightness state (on/off) for which we want to store the value.
* \param promille New brightness in promille.
*/
MODULE_EXPORT void picoLCD_set_brightness(Driver *drvthis, int state, int promille) MODULE_EXPORT void picoLCD_set_brightness(Driver *drvthis, int state, int promille)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -770,6 +895,11 @@ MODULE_EXPORT void picoLCD_set_brightness(Driver *drvthis, int state, int promil
} }
/**
* Turn the backlight on or off.
* \param drvthis Pointer to driver structure.
* \param state New backlight status.
*/
MODULE_EXPORT void picoLCD_backlight(Driver *drvthis, int state) MODULE_EXPORT void picoLCD_backlight(Driver *drvthis, int state)
{ {
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
@@ -795,14 +925,28 @@ MODULE_EXPORT void picoLCD_backlight(Driver *drvthis, int state)
} }
} }
/*MODULE_EXPORT int picoLCD_output(Driver *drvthis, int state) {
/* *
* Set output port(s).
* \param drvthis Pointer to driver structure.
* \param state Integer with bits representing port states.
*/
/*MODULE_EXPORT int picoLCD_output(Driver *drvthis, int state)
{
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
}*/ }*/
/* lcd_logical_driver Informational functions */ /* lcd_logical_driver Informational functions */
MODULE_EXPORT char *picoLCD_get_info(Driver *drvthis) {
/**
* Provide general information about the LCD/VFD display.
* \param drvthis Pointer to driver structure.
* \return Constant string with information.
*/
MODULE_EXPORT char *picoLCD_get_info(Driver *drvthis)
{
PrivateData *p = drvthis->private_data; PrivateData *p = drvthis->private_data;
return p->info; return p->info;
@@ -811,7 +955,7 @@ MODULE_EXPORT char *picoLCD_get_info(Driver *drvthis) {
/* Private functions */ /* Private functions */
/* /**
* Transcode from picoLCD USB format to LIRC UDP format. * Transcode from picoLCD USB format to LIRC UDP format.
* LIRC UDP packets expect 16-bit intervals, with MSB set for space. * LIRC UDP packets expect 16-bit intervals, with MSB set for space.
* Intervals are measured in jiffies (1/16384 s). * Intervals are measured in jiffies (1/16384 s).
@@ -821,11 +965,12 @@ MODULE_EXPORT char *picoLCD_get_info(Driver *drvthis) {
* in that order for transmission via UDP. * in that order for transmission via UDP.
* One jiffy == 61 us. 537 us == 9j. * One jiffy == 61 us. 537 us == 9j.
* *
* drvthis: driver data (used for debug() and report()). * \param drvthis Pointer to driver structure [used for debug() and report()].
* data, cbdata: buffer of integers to be transcoded. * \param data Buffer of integers to be transcoded.
* result, * \param cbdata Buffer of integers to be transcoded.
* cbresult: buffer to receive the transcoded values. * \param result Buffer to receive the transcoded values.
* @return: number of bytes placed in result buffer. * \param cbresult Buffer to receive the transcoded values.
* \return Number of bytes placed in result buffer.
*/ */
static int ir_transcode(Driver *drvthis, unsigned char *data, unsigned int cbdata, static int ir_transcode(Driver *drvthis, unsigned char *data, unsigned int cbdata,
unsigned char *result, int cbresult) unsigned char *result, int cbresult)
server/drivers/picolcd.h
+2 -2
View File
@@ -82,7 +82,7 @@ MODULE_EXPORT int picoLCD_width(Driver *drvthis);
MODULE_EXPORT int picoLCD_height(Driver *drvthis); MODULE_EXPORT int picoLCD_height(Driver *drvthis);
MODULE_EXPORT void picoLCD_clear(Driver *drvthis); MODULE_EXPORT void picoLCD_clear(Driver *drvthis);
MODULE_EXPORT void picoLCD_flush(Driver *drvthis); MODULE_EXPORT void picoLCD_flush(Driver *drvthis);
MODULE_EXPORT void picoLCD_string(Driver *drvthis, int x, int y, unsigned char *str); MODULE_EXPORT void picoLCD_string(Driver *drvthis, int x, int y, unsigned char string[]);
MODULE_EXPORT void picoLCD_chr(Driver *drvthis, int x, int y, unsigned char c); MODULE_EXPORT void picoLCD_chr(Driver *drvthis, int x, int y, unsigned char c);
MODULE_EXPORT void picoLCD_set_char (Driver *drvthis, int n, unsigned char *dat); MODULE_EXPORT void picoLCD_set_char (Driver *drvthis, int n, unsigned char *dat);
MODULE_EXPORT char *picoLCD_get_key(Driver *drvthis); MODULE_EXPORT char *picoLCD_get_key(Driver *drvthis);
@@ -97,7 +97,7 @@ MODULE_EXPORT int picoLCD_get_contrast(Driver *drvthis);
MODULE_EXPORT void picoLCD_set_contrast(Driver *drvthis, int promille); MODULE_EXPORT void picoLCD_set_contrast(Driver *drvthis, int promille);
//MODULE_EXPORT int picoLCD_get_brightness(Driver *drvthis, int state); //MODULE_EXPORT int picoLCD_get_brightness(Driver *drvthis, int state);
MODULE_EXPORT void picoLCD_set_brightness(Driver *drvthis, int state, int promille); MODULE_EXPORT void picoLCD_set_brightness(Driver *drvthis, int state, int promille);
MODULE_EXPORT void picoLCD_backlight(Driver *drvthis, int promille); MODULE_EXPORT void picoLCD_backlight(Driver *drvthis, int state);
//MODULE_EXPORT void picoLCD_output(Driver *drvthis, int state); //MODULE_EXPORT void picoLCD_output(Driver *drvthis, int state);
MODULE_EXPORT char *picoLCD_get_info(Driver *drvthis); MODULE_EXPORT char *picoLCD_get_info(Driver *drvthis);
server/drivers/pylcd.c
+155 -21
View File
@@ -1,5 +1,12 @@
/** \file server/drivers/pylcd.c /** \file server/drivers/pylcd.c
* LCDd \c pyramid driver for the programmable LC displays from Pyramid. * LCDd \c pyramid driver for the programmable LC displays
* from Pyramid Computer GmbH.
*
* For more information see
* http://www.pyramid.de/en/products/programmable_lcd.php
*
* Contact Thomas Riewe <thomas.riewe@pyramid.de> for further
* information on the LCD.
*/ */
/* /*
@@ -24,13 +31,6 @@
*/ */
/* /*
* This driver controls the programmable LC-Display from
* Pyramid Computer GmbH. For more information see
* http://www.pyramid.de/en/products/programmable_lcd.php
*
* Contact Thomas Riewe <thomas.riewe@pyramid.de> for further
* information on the LCD.
*
* Changes: * Changes:
* 2006-02-20 Stefan Reinauer <stepan@coresystems.de> * 2006-02-20 Stefan Reinauer <stepan@coresystems.de>
* - add support for onboard LEDs via "output" command * - add support for onboard LEDs via "output" command
@@ -295,8 +295,14 @@ set_leds(PrivateData *p)
/* Basic functions */ /* Basic functions */
/**
* Initialize the driver.
* \param drvthis Pointer to driver structure.
* \retval 0 Success.
* \retval <0 Error.
*/
MODULE_EXPORT int MODULE_EXPORT int
pyramid_init (Driver *drvthis, char *args) pyramid_init (Driver *drvthis)
{ {
char buffer[6]=""; char buffer[6]="";
int i; int i;
@@ -397,6 +403,11 @@ pyramid_init (Driver *drvthis, char *args)
return 0; return 0;
}; };
/**
* Close the driver (do necessary clean-up).
* \param drvthis Pointer to driver structure.
*/
MODULE_EXPORT void MODULE_EXPORT void
pyramid_close (Driver *drvthis) pyramid_close (Driver *drvthis)
{ {
@@ -405,6 +416,12 @@ pyramid_close (Driver *drvthis)
close(p->FD); close(p->FD);
}; };
/**
* Return the display width in characters.
* \param drvthis Pointer to driver structure.
* \return Number of characters the display is wide.
*/
MODULE_EXPORT int MODULE_EXPORT int
pyramid_width (Driver *drvthis) pyramid_width (Driver *drvthis)
{ {
@@ -413,6 +430,12 @@ pyramid_width (Driver *drvthis)
return p->width; return p->width;
}; };
/**
* Return the display height in characters.
* \param drvthis Pointer to driver structure.
* \return Number of characters the display is high.
*/
MODULE_EXPORT int MODULE_EXPORT int
pyramid_height (Driver *drvthis) pyramid_height (Driver *drvthis)
{ {
@@ -421,6 +444,11 @@ pyramid_height (Driver *drvthis)
return p->height; return p->height;
}; };
/**
* Clear the screen.
* \param drvthis Pointer to driver structure.
*/
MODULE_EXPORT void MODULE_EXPORT void
pyramid_clear (Driver *drvthis) pyramid_clear (Driver *drvthis)
{ {
@@ -430,9 +458,12 @@ pyramid_clear (Driver *drvthis)
strcpy(p->framebuffer, "D "); strcpy(p->framebuffer, "D ");
}; };
/* flush the content of the framebuffer to the display.
/**
* Flush data on screen to the display.
* p->FB_modified tells if the content was modified. If not, * p->FB_modified tells if the content was modified. If not,
* that means, nothing has to be done * that means, nothing has to be done
* \param drvthis Pointer to driver structure.
*/ */
MODULE_EXPORT void MODULE_EXPORT void
pyramid_flush (Driver *drvthis) pyramid_flush (Driver *drvthis)
@@ -473,8 +504,17 @@ pyramid_flush (Driver *drvthis)
} }
} }
/**
* Print a string on the screen at position (x,y).
* The upper-left corner is (1,1), the lower-right corner is (p->width, p->height).
* \param drvthis Pointer to driver structure.
* \param x Horizontal character position (column).
* \param y Vertical character position (row).
* \param string String that gets written.
*/
MODULE_EXPORT void MODULE_EXPORT void
pyramid_string (Driver *drvthis, int x, int y, char *args) pyramid_string (Driver *drvthis, int x, int y, const char string[])
{ {
int offset; int offset;
int len; int len;
@@ -484,10 +524,19 @@ pyramid_string (Driver *drvthis, int x, int y, char *args)
x = min(p->width, x); x = min(p->width, x);
y = min(p->height, y); y = min(p->height, y);
offset = (x)+p->width*(y-1); offset = (x)+p->width*(y-1);
len = min(strlen(args), p->width*p->height-offset+1); len = min(strlen(string), p->width*p->height-offset+1);
memcpy(&p->framebuffer[offset], args, len); memcpy(&p->framebuffer[offset], string, len);
}; };
/**
* Print a character on the screen at position (x,y).
* The upper-left corner is (1,1), the lower-right corner is (p->width, p->height).
* \param drvthis Pointer to driver structure.
* \param x Horizontal character position (column).
* \param y Vertical character position (row).
* \param c Character that gets written.
*/
MODULE_EXPORT void MODULE_EXPORT void
pyramid_chr (Driver *drvthis, int x, int y, char c) pyramid_chr (Driver *drvthis, int x, int y, char c)
{ {
@@ -502,6 +551,15 @@ pyramid_chr (Driver *drvthis, int x, int y, char c)
/* User defined characters */ /* User defined characters */
/**
* Define a custom character and write it to the LCD.
* \param drvthis Pointer to driver structure.
* \param n Custom character to define [0 - (NUM_CCs-1)].
* \param dat Array of 40(=8*5=cellheight*cellwidth) bytes, each representing a pixel
* starting from the top left to the bottom right.
* \todo
* Convert \c dat to use one byte per pixel-row as e.g. in the \c CFontzPackage driver.
*/
MODULE_EXPORT void pyramid_set_char (Driver *drvthis, int n, char *dat) MODULE_EXPORT void pyramid_set_char (Driver *drvthis, int n, char *dat)
{ {
char tele[10] = "G@ABCDEFGH"; char tele[10] = "G@ABCDEFGH";
@@ -537,6 +595,12 @@ MODULE_EXPORT void pyramid_set_char (Driver *drvthis, int n, char *dat)
real_send_tele(p, tele, 10); real_send_tele(p, tele, 10);
}; };
/**
* Get total number of custom characters available.
* \param drvthis Pointer to driver structure.
* \return Number of custom characters.
*/
MODULE_EXPORT int pyramid_get_free_chars (Driver *drvthis) MODULE_EXPORT int pyramid_get_free_chars (Driver *drvthis)
{ {
PrivateData *p = (PrivateData *) drvthis->private_data; PrivateData *p = (PrivateData *) drvthis->private_data;
@@ -544,12 +608,23 @@ MODULE_EXPORT int pyramid_get_free_chars (Driver *drvthis)
}; };
/**
* Return the width of a character in pixels.
* \param drvthis Pointer to driver structure.
* \return Number of pixel columns a character cell is wide.
*/
MODULE_EXPORT int pyramid_cellwidth (Driver *drvthis) MODULE_EXPORT int pyramid_cellwidth (Driver *drvthis)
{ {
PrivateData *p = (PrivateData *) drvthis->private_data; PrivateData *p = (PrivateData *) drvthis->private_data;
return (p->cellwidth); return (p->cellwidth);
}; };
/**
* Return the height of a character in pixels.
* \param drvthis Pointer to driver structure.
* \return Number of pixel lines a character cell is high.
*/
MODULE_EXPORT int pyramid_cellheight (Driver *drvthis) MODULE_EXPORT int pyramid_cellheight (Driver *drvthis)
{ {
PrivateData *p = (PrivateData *) drvthis->private_data; PrivateData *p = (PrivateData *) drvthis->private_data;
@@ -558,8 +633,11 @@ MODULE_EXPORT int pyramid_cellheight (Driver *drvthis)
// Sets up for vertical bars. Call before pyramid->vbar() /**
* Set up vertical bars.
* \todo
* Get rid of it bay using pixel-row based logic as e.g. in the \c CFontzPackage driver.
*/
static void static void
pyramid_init_vbar (Driver *drvthis) pyramid_init_vbar (Driver *drvthis)
{ {
@@ -647,7 +725,12 @@ pyramid_init_vbar (Driver *drvthis)
} }
} }
// Inits horizontal bars...
/**
* Set up horizontal bars.
* \todo
* Get rid of it bay using pixel-row based logic as e.g. in the \c CFontzPackage driver.
*/
static void static void
pyramid_init_hbar (Driver *drvthis) pyramid_init_hbar (Driver *drvthis)
{ {
@@ -771,9 +854,15 @@ pyramid_init_custom1 (Driver *drvthis)
} }
/**
// Draws a vertical bar... * Draw a vertical bar bottom-up.
* \param drvthis Pointer to driver structure.
* \param x Horizontal character position (column) of the starting point.
* \param y Vertical character position (row) of the starting point.
* \param len Number of characters that the bar is high at 100%
* \param promille Current height level of the bar in promille.
* \param options Options (currently unused).
*/
MODULE_EXPORT void MODULE_EXPORT void
pyramid_vbar (Driver *drvthis, int x, int y, int len, int promille, int options) pyramid_vbar (Driver *drvthis, int x, int y, int len, int promille, int options)
{ {
@@ -784,8 +873,16 @@ pyramid_vbar (Driver *drvthis, int x, int y, int len, int promille, int options)
lib_vbar_static(drvthis, x, y, len, promille, options, p->cellheight, 0); lib_vbar_static(drvthis, x, y, len, promille, options, p->cellheight, 0);
} }
// Draws a horizontal bar to the right.
/**
* Draw a horizontal bar to the right.
* \param drvthis Pointer to driver structure.
* \param x Horizontal character position (column) of the starting point.
* \param y Vertical character position (row) of the starting point.
* \param len Number of characters that the bar is long at 100%
* \param promille Current length level of the bar in promille.
* \param options Options (currently unused).
*/
MODULE_EXPORT void MODULE_EXPORT void
pyramid_hbar (Driver *drvthis, int x, int y, int len, int promille, int options) pyramid_hbar (Driver *drvthis, int x, int y, int len, int promille, int options)
{ {
@@ -797,6 +894,15 @@ pyramid_hbar (Driver *drvthis, int x, int y, int len, int promille, int options)
} }
/**
* Place an icon on the screen.
* \param drvthis Pointer to driver structure.
* \param x Horizontal character position (column).
* \param y Vertical character position (row).
* \param icon synbolic value representing the icon.
* \retval 0 Icon has been successfully defined/written.
* \retval <0 Server core shall define/write the icon.
*/
MODULE_EXPORT int MODULE_EXPORT int
pyramid_icon (Driver *drvthis, int x, int y, int icon) pyramid_icon (Driver *drvthis, int x, int y, int icon)
{ {
@@ -965,6 +1071,7 @@ pyramid_icon (Driver *drvthis, int x, int y, int icon)
return 0; return 0;
} }
/* /*
MODULE_EXPORT void MODULE_EXPORT void
pyramid_num (Driver *drvthis, int x, int num){}; pyramid_num (Driver *drvthis, int x, int num){};
@@ -972,6 +1079,13 @@ MODULE_EXPORT void
pyramid_heartbeat (Driver *drvthis, int state){}; pyramid_heartbeat (Driver *drvthis, int state){};
*/ */
/**
* Set cursor position and state.
* \param drvthis Pointer to driver structure.
* \param x Horizontal cursor position (column).
* \param y Vertical cursor position (row).
* \param state New cursor state.
*/
MODULE_EXPORT void MODULE_EXPORT void
pyramid_cursor (Driver *drvthis, int x, int y, int state) pyramid_cursor (Driver *drvthis, int x, int y, int state)
{ {
@@ -996,6 +1110,7 @@ pyramid_cursor (Driver *drvthis, int x, int y, int state)
p->C_state = state; p->C_state = state;
}; };
/* Hardware functions */ /* Hardware functions */
#if 0 #if 0
@@ -1012,6 +1127,14 @@ MODULE_EXPORT void
pyramid_backlight (Driver *drvthis, int on) pyramid_backlight (Driver *drvthis, int on)
#endif #endif
/**
* Set output port.
* Setting an output port bit lights the associated LED;
* re-setting the bit turns the LED off.
* \param drvthis Pointer to driver structure.
* \param state Integer with bits representing port states.
*/
MODULE_EXPORT void MODULE_EXPORT void
pyramid_output (Driver *drvthis, int state) pyramid_output (Driver *drvthis, int state)
{ {
@@ -1028,8 +1151,15 @@ pyramid_output (Driver *drvthis, int state)
} }
}; };
/* Key functions */ /* Key functions */
/**
* Get key from the device
* \param drvthis Pointer to driver structure.
* \return String representation of the key.
* \c NULL if nothing available / unmapped key.
*/
MODULE_EXPORT const char * MODULE_EXPORT const char *
pyramid_get_key (Driver *drvthis) pyramid_get_key (Driver *drvthis)
{ {
@@ -1127,7 +1257,11 @@ pyramid_get_key (Driver *drvthis)
}; };
/* Returns a string. Server cannot modify this string. */ /**
* Provide some information about this driver.
* \param drvthis Pointer to driver structure.
* \return Constant string with information.
*/
MODULE_EXPORT const char * MODULE_EXPORT const char *
pylcd_get_info (Driver *drvthis) pylcd_get_info (Driver *drvthis)
{ {