Doxygen-ize

This commit is contained in:
marschap
2008-12-21 14:58:51 +00:00
parent 175e4c7b4f
commit b54a4e3706
13 changed files with 274 additions and 47 deletions
+28 -2
View File
@@ -93,7 +93,13 @@ static const unsigned char EnMask[] = { EN1, EN2, EN3, STRB, LF, INIT, SEL };
#define ALLEXT (STRB|LF|INIT|SEL)
// The above bits are on the control port of LPT
// initialisation function
/**
* Initialize the driver.
* \param drvthis Pointer to driver structure.
* \retval 0 Success.
* \retval -1 Error.
*/
int
hd_init_4bit(Driver *drvthis)
{
@@ -169,7 +175,14 @@ hd_init_4bit(Driver *drvthis)
return 0;
}
// lcdstat_HD44780_senddata
/**
* Send data or commands to the display.
* \param p Pointer to driver's private data structure.
* \param displayID ID of the display (or 0 for all) to send data to.
* \param flags Defines whether to end a command or data.
* \param ch The value to send.
*/
void
lcdstat_HD44780_senddata(PrivateData *p, unsigned char displayID, unsigned char flags, unsigned char ch)
{
@@ -226,6 +239,12 @@ lcdstat_HD44780_senddata(PrivateData *p, unsigned char displayID, unsigned char
}
}
/**
* Turn display backlight on or off.
* \param p Pointer to driver's private data structure.
* \param state New backlight status.
*/
void lcdstat_HD44780_backlight(PrivateData *p, unsigned char state)
{
p->backlight_bit = ((!p->have_backlight||state)?0:BL);
@@ -233,6 +252,13 @@ void lcdstat_HD44780_backlight(PrivateData *p, unsigned char state)
port_out(p->port, p->backlight_bit);
}
/**
* Read keypress.
* \param p Pointer to driver's private data structure.
* \param YData ???
* \return Bitmap of the pressed keys.
*/
unsigned char lcdstat_HD44780_readkeypad(PrivateData *p, unsigned int YData)
{
unsigned char readval;