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

make Doxygen happy by giving the private data structure a unique name

Browse Source
This commit is contained in:
marschap
2008-12-21 17:02:04 +00:00
parent 92df94302b
commit 72d5042683
2 changed files with 37 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/drivers/MtxOrb.c
+28 -28
View File
@@ -1,17 +1,16 @@
/** \file server/drivers/MtxOrb.c /** \file server/drivers/MtxOrb.c
* LCDd \c MtxOrb driver for Matrix Orbital character mode displays. * LCDd \c MtxOrb driver for Matrix Orbital character mode displays.
*
* This driver supports the LCD*, LKD*, VFD*, and VKD* series of
* character mode displays by Matrix Orbital (http://www.matrixorbital.com).
*
* Data sheets for the displays this driver supports can be found at
* http://www.matrixorbital.ca/manuals/
*
* \note The GLK series of graphical displays is supported by the \c glk driver.
*/ */
/* This is the LCDproc driver for Matrix Orbital devices /*
(http://www.matrixorbital.com)
For the Matrix Orbital LCD* LKD* VFD* and VKD* displays
Applicable Data Sheets:
- http://www.matrixorbital.ca/manuals/
NOTE: GLK displays have a different driver.
Copyright (C) 1999, William Ferrell and Scott Scriven Copyright (C) 1999, William Ferrell and Scott Scriven
2001, Andre Breiler 2001, Andre Breiler
2001, Philip Pokorny 2001, Philip Pokorny
@@ -118,8 +117,9 @@ typedef enum {
} CGmode; } CGmode;
typedef struct { /** private data for the \c MtxOrb driver */
int fd; /* The LCD file descriptor */ typedef struct MtxOrb_private_data {
int fd; /**< LCD file descriptor */
/* dimensions */ /* dimensions */
int width, height; int width, height;
@@ -132,8 +132,8 @@ typedef struct {
/* defineable characters */ /* defineable characters */
CGmode ccmode; CGmode ccmode;
int output_state; /* static data from MtxOrb_output */ int output_state; /**< current output state */
int contrast; /* static data from set/get_contrast */ int contrast; /**< current contrast */
int brightness; int brightness;
int offbrightness; int offbrightness;
@@ -144,7 +144,7 @@ typedef struct {
int keys; int keys;
int keypad_test_mode; int keypad_test_mode;
char info[255]; /* static data from MtxOrb_get_info */ char info[255]; /**< info string contents */
} PrivateData; } PrivateData;
@@ -184,8 +184,8 @@ MtxOrb_parse_keypad_setting (Driver *drvthis, char *keyname, char default_value)
/** /**
* Initialize the driver. * Initialize the driver.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \retval 0 Success. * \retval 0 Success.
* \retval <0 Error. * \retval <0 Error.
*/ */
MODULE_EXPORT int MODULE_EXPORT int
MtxOrb_init (Driver *drvthis) MtxOrb_init (Driver *drvthis)
@@ -200,7 +200,7 @@ MtxOrb_init (Driver *drvthis)
PrivateData *p; PrivateData *p;
/* Alocate and store private data */ /* Allocate and store private data */
p = (PrivateData *) malloc(sizeof(PrivateData)); p = (PrivateData *) malloc(sizeof(PrivateData));
if (p == NULL) if (p == NULL)
return -1; return -1;
@@ -451,7 +451,7 @@ MtxOrb_close (Driver *drvthis)
/** /**
* Return the display width in characters. * Return the display width in characters.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \return Number of characters the display is wide. * \return Number of characters the display is wide.
*/ */
MODULE_EXPORT int MODULE_EXPORT int
MtxOrb_width (Driver *drvthis) MtxOrb_width (Driver *drvthis)
@@ -465,7 +465,7 @@ MtxOrb_width (Driver *drvthis)
/** /**
* Return the display height in characters. * Return the display height in characters.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \return Number of characters the display is high. * \return Number of characters the display is high.
*/ */
MODULE_EXPORT int MODULE_EXPORT int
MtxOrb_height (Driver *drvthis) MtxOrb_height (Driver *drvthis)
@@ -479,7 +479,7 @@ MtxOrb_height (Driver *drvthis)
/** /**
* Return the width of a character in pixels. * Return the width of a character in pixels.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \return Number of pixel columns a character cell is wide. * \return Number of pixel columns a character cell is wide.
*/ */
MODULE_EXPORT int MODULE_EXPORT int
MtxcOrb_cellwidth (Driver *drvthis) MtxcOrb_cellwidth (Driver *drvthis)
@@ -493,7 +493,7 @@ MtxcOrb_cellwidth (Driver *drvthis)
/** /**
* Return the height of a character in pixels. * Return the height of a character in pixels.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \return Number of pixel lines a character cell is high. * \return Number of pixel lines a character cell is high.
*/ */
MODULE_EXPORT int MODULE_EXPORT int
MtxcOrb_cellheight (Driver *drvthis) MtxcOrb_cellheight (Driver *drvthis)
@@ -649,7 +649,7 @@ MtxOrb_chr (Driver *drvthis, int x, int y, char c)
* This is only the locally stored contrast, the contrast value * This is only the locally stored contrast, the contrast value
* cannot be retrieved from the LCD. * cannot be retrieved from the LCD.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \return Stored contrast in promille. * \return Stored contrast in promille.
*/ */
MODULE_EXPORT int MODULE_EXPORT int
@@ -666,8 +666,8 @@ MtxOrb_get_contrast (Driver *drvthis)
* Whis only works on LCD displays where the * Whis only works on LCD displays where the
* HW supports values from 0 to 255 with 140 looking OK. * HW supports values from 0 to 255 with 140 looking OK.
* Is it better to use the brightness for VFD/VKD displays ? * Is it better to use the brightness for VFD/VKD displays ?
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \param promille New contrast value in promille. * \param promille New contrast value in promille.
*/ */
MODULE_EXPORT void MODULE_EXPORT void
MtxOrb_set_contrast (Driver *drvthis, int promille) MtxOrb_set_contrast (Driver *drvthis, int promille)
@@ -702,7 +702,7 @@ MtxOrb_set_contrast (Driver *drvthis, int promille)
* Retrieve brightness. * Retrieve brightness.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \param state Brightness state (on/off) for which we want the value. * \param state Brightness state (on/off) for which we want the value.
* \return Stored brightness in promille. * \return Stored brightness in promille.
*/ */
MODULE_EXPORT int MODULE_EXPORT int
MtxOrb_get_brightness(Driver *drvthis, int state) MtxOrb_get_brightness(Driver *drvthis, int state)
@@ -907,7 +907,7 @@ MtxOrb_cursor_goto(Driver *drvthis, int x, int y)
/** /**
* Provide general information about the LCD/VFD display. * Provide general information about the LCD/VFD display.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \return Constant string with information. * \return Constant string with information.
*/ */
MODULE_EXPORT const char * MODULE_EXPORT const char *
MtxOrb_get_info (Driver *drvthis) MtxOrb_get_info (Driver *drvthis)
@@ -1172,7 +1172,7 @@ MtxOrb_num (Driver *drvthis, int x, int num)
/** /**
* Get total number of custom characters available. * Get total number of custom characters available.
* \param drvthis Pointer to driver structure. * \param drvthis Pointer to driver structure.
* \return Number of custom characters (always NUM_CCs). * \return Number of custom characters (always NUM_CCs).
*/ */
MODULE_EXPORT int MODULE_EXPORT int
MtxOrb_get_free_chars (Driver *drvthis) MtxOrb_get_free_chars (Driver *drvthis)
server/drivers/sed1330.c
+9 -10
View File
@@ -267,23 +267,22 @@
#define SCR2_L 0x00 #define SCR2_L 0x00
#define SCR2_H 0x06 #define SCR2_H 0x06
typedef struct p {
// display type /** private data for the \c sed1330 driver */
int type; typedef struct sed1330_private_data {
int type; /**< display type */
// wiring scheme variables to be set by sed1330_init() // wiring scheme variables to be set by sed1330_init()
int A0; int A0;
int nRESET; int nRESET;
int nWR; int nWR;
// which lpt port to use int port; /**< LPT port to use */
int port;
unsigned char * framebuf_text; unsigned char *framebuf_text;
unsigned char * lcd_contents_text; unsigned char *lcd_contents_text;
unsigned char * framebuf_graph; unsigned char *framebuf_graph;
unsigned char * lcd_contents_graph; unsigned char *lcd_contents_graph;
int width, height; int width, height;
int cellwidth, cellheight; int cellwidth, cellheight;