1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
|
/** \file server/drivers/debug.c
* \c debug driver for LCDd.
* This driver does does nothing more than writing a debug message when
* any one of the driver's functions is called.
*/
/*-
* Copyright (C) 2008, Peter Marschall
* 2010, Markus Dolze
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <stdlib.h>
#include <string.h>
#include "lcd.h"
#include "debug.h"
#include "shared/report.h"
#define DEFAULT_WIDTH LCD_DEFAULT_WIDTH
#define DEFAULT_HEIGHT LCD_DEFAULT_HEIGHT
#define DEFAULT_CELLWIDTH LCD_DEFAULT_CELLWIDTH
#define DEFAULT_CELLHEIGHT LCD_DEFAULT_CELLHEIGHT
#define DEFAULT_CONTRAST 500
#define DEFAULT_BRIGHTNESS 750
#define DEFAULT_OFFBRIGHTNESS 250
/** private data for the \c debug driver */
typedef struct debug_private_data {
char *framebuf; /**< frame buffer */
int width; /**< display width in characters */
int height; /**< display height in characters */
int cellwidth; /**< character cell width */
int cellheight; /**< character cell height */
int contrast; /**< current contrast */
int brightness; /**< current brightness (for backlight on) */
int offbrightness; /**< current brightness (for backlight off) */
} PrivateData;
/* Vars for the server core */
MODULE_EXPORT char *api_version = API_VERSION;
MODULE_EXPORT int stay_in_foreground = 1;
MODULE_EXPORT int supports_multiple = 0;
MODULE_EXPORT char *symbol_prefix = "debug_";
/**
* Initialize the driver. (Required)
* \param drvthis Pointer to driver structure.
* \retval 0 Success.
* \retval <0 Error.
*/
MODULE_EXPORT int
debug_init(Driver *drvthis)
{
PrivateData *p;
report(RPT_INFO, "%s()", __FUNCTION__);
/* Allocate and store private data */
p = (PrivateData *) calloc(1, sizeof(PrivateData));
if (p == NULL)
return -1;
if (drvthis->store_private_ptr(drvthis, p))
return -1;
p->width = DEFAULT_WIDTH;
p->height = DEFAULT_HEIGHT;
p->cellwidth = DEFAULT_CELLWIDTH;
p->cellheight = DEFAULT_CELLHEIGHT;
p->contrast = DEFAULT_CONTRAST;
p->brightness = DEFAULT_BRIGHTNESS;
p->offbrightness = DEFAULT_OFFBRIGHTNESS;
p->framebuf = malloc(p->width * p->height);
if (p->framebuf == NULL) {
report(RPT_INFO, "%s: unable to allocate framebuffer", drvthis->name);
return -1;
}
debug_clear(drvthis);
return 0;
}
/**
* Close the driver (do necessary clean-up). (Required)
* \param drvthis Pointer to driver structure.
*/
MODULE_EXPORT void
debug_close(Driver *drvthis)
{
PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s()", __FUNCTION__);
if (p != NULL) {
if (p->framebuf != NULL)
free(p->framebuf);
p->framebuf = NULL;
free(p);
}
drvthis->store_private_ptr(drvthis, NULL);
}
/**
* Return the display width in characters. (Required for output)
* \param drvthis Pointer to driver structure.
* \return Number of characters the display is wide.
*/
MODULE_EXPORT int
debug_width(Driver *drvthis)
{
PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s()", __FUNCTION__);
return p->width;
}
/**
* Return the display height in characters. (Required for output)
* \param drvthis Pointer to driver structure.
* \return Number of characters the display is high.
*/
MODULE_EXPORT int
debug_height(Driver *drvthis)
{
PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s()", __FUNCTION__);
return p->height;
}
/**
* Return the width of a character in pixels. (Optional)
* \param drvthis Pointer to driver structure.
* \return Number of pixel columns a character cell is wide.
*/
MODULE_EXPORT int
debug_cellwidth(Driver *drvthis)
{
PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s()", __FUNCTION__);
return p->cellwidth;
}
/**
* Return the height of a character in pixels. (Optional)
* \param drvthis Pointer to driver structure.
* \return Number of pixel lines a character cell is high.
*/
MODULE_EXPORT int
debug_cellheight(Driver *drvthis)
{
PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s()", __FUNCTION__);
return p->cellheight;
}
/**
* Clear the screen. (Required for output)
* \param drvthis Pointer to driver structure.
*/
MODULE_EXPORT void
debug_clear(Driver *drvthis)
{
PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s()", __FUNCTION__);
memset(p->framebuf, ' ', p->width * p->height);
}
/**
* Flush data on screen to the display. (Optional)
* \param drvthis Pointer to driver structure.
*
* \note Character 0x00 may be a valid character in the frame buffer! Avoid
* using string handling functions here (strcpy and friends).
*
* \note \n Note to driver developers: Drivers may write to the screen directly
* with chr() and string() functions. However, it makes sound to have these
* functions write to an internal frame buffer first and update the screen on
* call to flush(), maybe with some partial/incremental update algorithm.
* Some drivers have a second buffer to hold the actual screen content to be
* able to compare it with the current frame buffer (double buffering). The
* debug driver provides a simple single frame buffer implementation.
*
* DO NOT COPY THESE NOTES!
*/
MODULE_EXPORT void
debug_flush(Driver *drvthis)
{
PrivateData *p = drvthis->private_data;
int i, j;
char out[LCD_MAX_WIDTH];
report(RPT_INFO, "%s()", __FUNCTION__);
/* Heading line */
for (i = 0; i < p->width; i++) {
out[i] = '-';
}
out[p->width] = 0;
//report(RPT_DEBUG, "+%s+", out);
/* Output each framebuffer line */
for (i = 0; i < p->height; i++) {
for (j = 0; j < p->width; j++) {
out[j] = p->framebuf[j + (i * p->width)];
}
out[p->width] = 0;
//report(RPT_DEBUG, "|%s|", out);
}
/* Trailing line */
for (i = 0; i < p->width; i++) {
out[i] = '-';
}
out[p->width] = 0;
//report(RPT_DEBUG, "+%s+", out);
}
/**
* Print a string on the screen at position (x,y). (Required for output)
* 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.
*
* \see debug_flush
*/
MODULE_EXPORT void
debug_string(Driver *drvthis, int x, int y, const char string[])
{
PrivateData *p = drvthis->private_data;
int i;
report(RPT_INFO, "%s(%i,%i,%.40s)", __FUNCTION__, x, y, string);
y--; /* Convert 1-based coords to 0-based... */
x--;
if ((y < 0) || (y >= p->height))
return;
for (i = 0; (string[i] != '\0') && (x < p->width); i++, x++) {
if (x >= 0) /* no write left of left border */
p->framebuf[(y * p->width) + x] = string[i];
}
}
/**
* Print a character on the screen at position (x,y). (Required for output)
* 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.
*
* \note Keep in mind that character 0x00 may be a valid character on your
* display and it is used by the bignum library. Avoid using string handling
* functions here!
*
* \see debug_flush
*/
MODULE_EXPORT void
debug_chr(Driver *drvthis, int x, int y, char c)
{
PrivateData *p = drvthis->private_data;
report(RPT_DEBUG, "%s(%i,%i,%c)", __FUNCTION__, x, y, c);
x--;
y--;
if ((x >= 0) && (y >= 0) && (x < p->width) && (y < p->height))
p->framebuf[(y * p->width) + x] = c;
}
/**
* Draw a vertical bar bottom-up. (Optional)
* \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
debug_vbar(Driver *drvthis, int x, int y, int len, int promille, int options)
{
//PrivateData *p = drvthis->private_data;
int pos;
report(RPT_INFO, "%s(%i,%i,%i,%i,%i)", __FUNCTION__, x, y, len, promille, options);
for (pos = 0; pos < len; pos++) {
if (2 * pos < ((long)promille * len / 500 + 1)) {
debug_chr(drvthis, x, y - pos, '|');
}
else {
; /* print nothing */
}
}
}
/**
* Draw a horizontal bar to the right. (Optional)
* \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
debug_hbar(Driver *drvthis, int x, int y, int len, int promille, int options)
{
//PrivateData *p = drvthis->private_data;
int pos;
report(RPT_INFO, "%s(%i,%i,%i,%i,%i)", __FUNCTION__, x, y, len, promille, options);
for (pos = 0; pos < len; pos++) {
if (2 * pos < ((long)promille * len / 500 + 1)) {
debug_chr(drvthis, x + pos, y, '-');
}
else {
; /* print nothing */
}
}
}
/**
* Write a big number to the screen. (Optional)
* \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
debug_num(Driver *drvthis, int x, int num)
{
//PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s(%i,%i)", __FUNCTION__, x, num);
}
/**
* Place an icon on the screen. (Optional)
* \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
debug_icon(Driver *drvthis, int x, int y, int icon)
{
//PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s(%i,%i,%i)", __FUNCTION__, x, y, icon);
return -1; /* let the core do all the icon stuff */
}
/**
* Set cursor position and state. (Optional)
* \param drvthis Pointer to driver structure.
* \param x Horizontal cursor position (column).
* \param y Vertical cursor position (row).
* \param type Appearance of the cursor
*/
MODULE_EXPORT void
debug_cursor(Driver *drvthis, int x, int y, int type)
{
report(RPT_INFO, "%s (%i,%i,%i)", __FUNCTION__, x, y, type);
}
/**
* Define a custom character and write it to the LCD. (Optional)
* \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
debug_set_char(Driver *drvthis, int n, char *dat)
{
//PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s(%i,data)", __FUNCTION__, n);
}
/**
* Get total number of custom characters available. (Optional)
* \param drvthis Pointer to driver structure.
* \return Number of custom characters.
*/
MODULE_EXPORT int
debug_get_free_chars(Driver *drvthis)
{
report(RPT_INFO, "%s()", __FUNCTION__);
return 0;
}
/**
* Get current LCD contrast. (Optional)
* This is only the locally stored contrast, the contrast value
* cannot be retrieved from the LCD.
* \param drvthis Pointer to driver structure.
* \return Stored contrast in promille.
*/
MODULE_EXPORT int
debug_get_contrast(Driver *drvthis)
{
PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s()", __FUNCTION__);
return p->contrast;
}
/**
* Change LCD contrast. (Optional)
* \param drvthis Pointer to driver structure.
* \param promille New contrast value in promille.
*/
MODULE_EXPORT void
debug_set_contrast(Driver *drvthis, int promille)
{
PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s(%i)", __FUNCTION__, promille);
p->contrast = promille;
}
/**
* Retrieve brightness. (Optional)
* \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
debug_get_brightness(Driver *drvthis, int state)
{
PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s(%i)", __FUNCTION__, state);
return (state == BACKLIGHT_ON) ? p->brightness : p->offbrightness;
}
/**
* Set on/off brightness. (Optional)
* \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
debug_set_brightness(Driver *drvthis, int state, int promille)
{
PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s(%i,%i)", __FUNCTION__, state, promille);
/* Check it */
if (promille < 0 || promille > 1000)
return;
/* store the software value since there is not get */
if (state == BACKLIGHT_ON) {
p->brightness = promille;
}
else {
p->offbrightness = promille;
}
debug_backlight(drvthis, state);
}
/**
* Turn the backlight on or off. (Optional)
* \param drvthis Pointer to driver structure.
* \param on New backlight status.
*/
MODULE_EXPORT void
debug_backlight(Driver *drvthis, int on)
{
//PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s(%i)", __FUNCTION__, on);
}
/**
* Send out-of-band data to the device. (Optional)
* \param drvthis Pointer to driver structure.
* \param value Integer. Meaning is specific to the device
*/
MODULE_EXPORT void
debug_output(Driver *drvthis, int value)
{
//PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s(%i)", __FUNCTION__, value);
}
/**
* Handle input from keyboard. (Required for input drivers)
* \param drvthis Pointer to driver structure.
* \return String representation of the key;
* \c NULL if nothing available / unmapped key
*/
MODULE_EXPORT const char *
debug_get_key(Driver *drvthis)
{
//PrivateData *p = drvthis->private_data;
report(RPT_INFO, "%s()", __FUNCTION__);
return NULL;
}
/**
* Provide some information about this driver. (Optional)
* \param drvthis Pointer to driver structure.
* \return Constant string with information.
*/
MODULE_EXPORT const char *
debug_get_info(Driver *drvthis)
{
//PrivateData *p = drvthis->private_data;
static char *info_string = "debug driver";
report(RPT_INFO, "%s()", __FUNCTION__);
return info_string;
}
|