Small patch to improve readablity of HD44780_backlight

Thomas Mohaupt <[email protected]> Sun, 29 Jan 2012 12:49:05 +0100
Newsgroups gmane.comp.sysutils.lcdproc
Message-ID <CABJvhenravu4kyMwK+eAJ1bdwSEFjy0ENWuN2nnG5bnBAahUmg@mail.gmail.com>
Hi,

while write a hd44780 subdriver I stumble over

  MODULE_EXPORT void HD44780_backlight(Driver *drvthis, int on)

IMHO the parameter name "on" may lead to missinterpretation.

Attached is a small patch to rename it to "state" - (as already done
in some subdrivers.)

Regards,
ThoMo

_______________________________________________
LCDproc mailing list
[email protected]
http://lists.omnipotent.net/mailman/listinfo/lcdproc
hd44780_backlight_better_readablity.patch (text/x-patch, 1.8 KB)
diff -urN -X lcdproc-org/diff_ignore lcdproc-org/server/drivers/hd44780.c lcdproc/server/drivers/hd44780.c
--- lcdproc-org/server/drivers/hd44780.c	2011-12-03 21:10:41.000000000 +0100
+++ lcdproc/server/drivers/hd44780.c	2012-01-29 12:31:13.819648295 +0100
@@ -878,21 +878,21 @@
 /**
  * Turn the LCD backlight on or off.
  * \param drvthis  Pointer to driver structure.
- * \param on       New backlight status.
+ * \param state    New backlight status.
  */
 MODULE_EXPORT void
-HD44780_backlight(Driver *drvthis, int on)
+HD44780_backlight(Driver *drvthis, int state)
 {
 	PrivateData *p = (PrivateData *) drvthis->private_data;
 
 	/* Immediately return if no backlight is available or no change is necessary */
-	if (!p->have_backlight || p->backlightstate == on)
+	if (!p->have_backlight || p->backlightstate == state)
 		return;
 
 	if (p->hd44780_functions->backlight != NULL)
-		p->hd44780_functions->backlight(p, on);
+		p->hd44780_functions->backlight(p, state);
 
-	p->backlightstate = on;
+	p->backlightstate = state;
 }
 
 
diff -urN -X lcdproc-org/diff_ignore lcdproc-org/server/drivers/hd44780.h lcdproc/server/drivers/hd44780.h
--- lcdproc-org/server/drivers/hd44780.h	2011-03-28 20:17:58.000000000 +0200
+++ lcdproc/server/drivers/hd44780.h	2012-01-29 12:30:20.539181498 +0100
@@ -40,7 +40,7 @@
 MODULE_EXPORT void HD44780_set_contrast(Driver *drvthis, int promille);
 MODULE_EXPORT int  HD44780_get_brightness(Driver *drvthis, int state);
 MODULE_EXPORT void HD44780_set_brightness(Driver *drvthis, int state, int promille);
-MODULE_EXPORT void HD44780_backlight(Driver *drvthis, int on);
+MODULE_EXPORT void HD44780_backlight(Driver *drvthis, int state);
 MODULE_EXPORT void HD44780_output(Driver *drvthis, int state);
 
 MODULE_EXPORT const char *HD44780_get_key(Driver *drvthis);