commit dac449a43a114cbf85238ca2c64cd9543b69aa1e Author: sebastian Date: Sat May 16 14:10:42 2009 +0200 imported project in hg diff --git a/button.bmp b/button.bmp new file mode 100755 index 0000000..e21276b Binary files /dev/null and b/button.bmp differ diff --git a/button.h b/button.h new file mode 100755 index 0000000..6f738d1 --- /dev/null +++ b/button.h @@ -0,0 +1,36 @@ +#include + +const uint8_t bitmap[] PROGMEM = { + 0x00,0x00,0x00,0x00, + 0x80,0xFF,0xFF,0x01, + 0x60,0x00,0x00,0x06, + 0x10,0x00,0x00,0x08, + 0x08,0x00,0x00,0x10, + 0x04,0x00,0x00,0x20, + 0x04,0x00,0x00,0x20, + 0x02,0x00,0x00,0x40, + 0x02,0x00,0x00,0x40, + 0x02,0x80,0x01,0x40, + 0x02,0xC0,0x03,0x40, + 0x02,0xE0,0x07,0x40, + 0x02,0xF0,0x0F,0x40, + 0x02,0xF8,0x1F,0x40, + 0x02,0xFC,0x3F,0x40, + 0x02,0xFE,0x7F,0x40, + 0x02,0xFF,0xFF,0x40, + 0x82,0xFF,0xFF,0x41, + 0xC2,0xFF,0xFF,0x43, + 0xE2,0xFF,0xFF,0x47, + 0xF2,0xFF,0xFF,0x4F, + 0xFA,0xFF,0xFF,0x5F, + 0x02,0x00,0x00,0x40, + 0x02,0x00,0x00,0x40, + 0x02,0x00,0x00,0x40, + 0x04,0x00,0x00,0x20, + 0x04,0x00,0x00,0x20, + 0x08,0x00,0x00,0x10, + 0x10,0x00,0x00,0x08, + 0x60,0x00,0x00,0x06, + 0x80,0xFF,0xFF,0x01, + 0x00,0x00,0x00,0x00}; + diff --git a/doc/html/Debug_2include_2lc7981_8d.html b/doc/html/Debug_2include_2lc7981_8d.html new file mode 100644 index 0000000..2033099 --- /dev/null +++ b/doc/html/Debug_2include_2lc7981_8d.html @@ -0,0 +1,25 @@ + + +glcd: Debug/include/lc7981.d File Reference + + + + + +
+

Debug/include/lc7981.d File Reference

+ +
+
+
Generated on Fri May 15 21:22:13 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/Debug_2main_8d.html b/doc/html/Debug_2main_8d.html new file mode 100644 index 0000000..405461a --- /dev/null +++ b/doc/html/Debug_2main_8d.html @@ -0,0 +1,25 @@ + + +glcd: Debug/main.d File Reference + + + + + +
+

Debug/main.d File Reference

+ +
+
+
Generated on Fri May 15 21:22:13 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/Release_2include_2lc7981_8d.html b/doc/html/Release_2include_2lc7981_8d.html new file mode 100644 index 0000000..f533b70 --- /dev/null +++ b/doc/html/Release_2include_2lc7981_8d.html @@ -0,0 +1,25 @@ + + +glcd: Release/include/lc7981.d File Reference + + + + + +
+

Release/include/lc7981.d File Reference

+ +
+
+
Generated on Fri May 15 21:22:13 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/Release_2main_8d.html b/doc/html/Release_2main_8d.html new file mode 100644 index 0000000..361d12e --- /dev/null +++ b/doc/html/Release_2main_8d.html @@ -0,0 +1,25 @@ + + +glcd: Release/main.d File Reference + + + + + +
+

Release/main.d File Reference

+ +
+
+
Generated on Fri May 15 21:22:13 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/button_8h-source.html b/doc/html/button_8h-source.html new file mode 100644 index 0000000..e7a6f6c --- /dev/null +++ b/doc/html/button_8h-source.html @@ -0,0 +1,56 @@ + + +glcd: button.h Source File + + + + + +
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/button_8h.html b/doc/html/button_8h.html new file mode 100644 index 0000000..c98d3b1 --- /dev/null +++ b/doc/html/button_8h.html @@ -0,0 +1,47 @@ + + +glcd: button.h File Reference + + + + + +
+

button.h File Reference

#include <avr/pgmspace.h>
+ +

+Go to the source code of this file. + + + + +

Variables

const uint8_t bitmap[] PROGMEM
+

Variable Documentation

+ +
+
+ + + + +
const uint8_t bitmap [] PROGMEM
+
+
+ +

+ +

+

+

+
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/doxygen.css b/doc/html/doxygen.css new file mode 100644 index 0000000..74c22a2 --- /dev/null +++ b/doc/html/doxygen.css @@ -0,0 +1,433 @@ +BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { + font-family: Geneva, Arial, Helvetica, sans-serif; +} +BODY,TD { + font-size: 90%; +} +H1 { + text-align: center; + font-size: 160%; +} +H2 { + font-size: 120%; +} +H3 { + font-size: 100%; +} +CAPTION { + font-weight: bold +} +DIV.qindex { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navpath { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navtab { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +TD.navtab { + font-size: 70%; +} +A.qindex { + text-decoration: none; + font-weight: bold; + color: #1A419D; +} +A.qindex:visited { + text-decoration: none; + font-weight: bold; + color: #1A419D +} +A.qindex:hover { + text-decoration: none; + background-color: #ddddff; +} +A.qindexHL { + text-decoration: none; + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} +A.qindexHL:hover { + text-decoration: none; + background-color: #6666cc; + color: #ffffff; +} +A.qindexHL:visited { + text-decoration: none; + background-color: #6666cc; + color: #ffffff +} +A.el { + text-decoration: none; + font-weight: bold +} +A.elRef { + font-weight: bold +} +A.code:link { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.code:visited { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.codeRef:link { + font-weight: normal; + color: #0000FF +} +A.codeRef:visited { + font-weight: normal; + color: #0000FF +} +A:hover { + text-decoration: none; + background-color: #f2f2ff +} +DL.el { + margin-left: -1cm +} +.fragment { + font-family: monospace, fixed; + font-size: 95%; +} +PRE.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + margin-top: 4px; + margin-bottom: 4px; + margin-left: 2px; + margin-right: 8px; + padding-left: 6px; + padding-right: 6px; + padding-top: 4px; + padding-bottom: 4px; +} +DIV.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +DIV.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} +DIV.groupText { + margin-left: 16px; + font-style: italic; + font-size: 90% +} +BODY { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} +TD.indexkey { + background-color: #e8eef2; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TD.indexvalue { + background-color: #e8eef2; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TR.memlist { + background-color: #f0f0f0; +} +P.formulaDsp { + text-align: center; +} +IMG.formulaDsp { +} +IMG.formulaInl { + vertical-align: middle; +} +SPAN.keyword { color: #008000 } +SPAN.keywordtype { color: #604020 } +SPAN.keywordflow { color: #e08000 } +SPAN.comment { color: #800000 } +SPAN.preprocessor { color: #806020 } +SPAN.stringliteral { color: #002080 } +SPAN.charliteral { color: #008080 } +SPAN.vhdldigit { color: #ff00ff } +SPAN.vhdlchar { color: #000000 } +SPAN.vhdlkeyword { color: #700070 } +SPAN.vhdllogic { color: #ff0000 } + +.mdescLeft { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.mdescRight { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.memItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplParams { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + color: #606060; + background-color: #FAFAFA; + font-size: 80%; +} +.search { + color: #003399; + font-weight: bold; +} +FORM.search { + margin-bottom: 0px; + margin-top: 0px; +} +INPUT.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +TD.tiny { + font-size: 75%; +} +a { + color: #1A41A8; +} +a:visited { + color: #2A3798; +} +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} +TH.dirtab { + background: #e8eef2; + font-weight: bold; +} +HR { + height: 1px; + border: none; + border-top: 1px solid black; +} + +/* Style for detailed member documentation */ +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +.memitem { + padding: 4px; + background-color: #eef3f5; + border-width: 1px; + border-style: solid; + border-color: #dedeee; + -moz-border-radius: 8px 8px 8px 8px; +} +.memname { + white-space: nowrap; + font-weight: bold; +} +.memdoc{ + padding-left: 10px; +} +.memproto { + background-color: #d5e1e8; + width: 100%; + border-width: 1px; + border-style: solid; + border-color: #84b0c7; + font-weight: bold; + -moz-border-radius: 8px 8px 8px 8px; +} +.paramkey { + text-align: right; +} +.paramtype { + white-space: nowrap; +} +.paramname { + color: #602020; + font-style: italic; + white-space: nowrap; +} +/* End Styling for detailed member documentation */ + +/* for the tree view */ +.ftvtree { + font-family: sans-serif; + margin:0.5em; +} +.directory { + font-size: 9pt; + font-weight: bold; +} +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} +.directory > h3 { + margin-top: 0; +} +.directory p { + margin: 0px; + white-space: nowrap; +} +.directory div { + display: none; + margin: 0px; +} +.directory img { + vertical-align: -30%; +} + diff --git a/doc/html/doxygen.png b/doc/html/doxygen.png new file mode 100644 index 0000000..f0a274b Binary files /dev/null and b/doc/html/doxygen.png differ diff --git a/doc/html/draw__penguin_8h-source.html b/doc/html/draw__penguin_8h-source.html new file mode 100644 index 0000000..3aca108 --- /dev/null +++ b/doc/html/draw__penguin_8h-source.html @@ -0,0 +1,35 @@ + + +glcd: draw_penguin.h Source File + + + + + +
Generated on Fri May 15 21:07:08 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/files.html b/doc/html/files.html new file mode 100644 index 0000000..4d2c189 --- /dev/null +++ b/doc/html/files.html @@ -0,0 +1,34 @@ + + +glcd: File Index + + + + + +
+

File List

Here is a list of all files with brief descriptions: + + + + +
button.h [code]
main.c
include/lc7981.c
include/lc7981.h [code]
+
+
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/ftv2blank.png b/doc/html/ftv2blank.png new file mode 100644 index 0000000..493c3c0 Binary files /dev/null and b/doc/html/ftv2blank.png differ diff --git a/doc/html/ftv2doc.png b/doc/html/ftv2doc.png new file mode 100644 index 0000000..f72999f Binary files /dev/null and b/doc/html/ftv2doc.png differ diff --git a/doc/html/ftv2folderclosed.png b/doc/html/ftv2folderclosed.png new file mode 100644 index 0000000..d6d0634 Binary files /dev/null and b/doc/html/ftv2folderclosed.png differ diff --git a/doc/html/ftv2folderopen.png b/doc/html/ftv2folderopen.png new file mode 100644 index 0000000..bbe2c91 Binary files /dev/null and b/doc/html/ftv2folderopen.png differ diff --git a/doc/html/ftv2lastnode.png b/doc/html/ftv2lastnode.png new file mode 100644 index 0000000..e7b9ba9 Binary files /dev/null and b/doc/html/ftv2lastnode.png differ diff --git a/doc/html/ftv2link.png b/doc/html/ftv2link.png new file mode 100644 index 0000000..14f3fed Binary files /dev/null and b/doc/html/ftv2link.png differ diff --git a/doc/html/ftv2mlastnode.png b/doc/html/ftv2mlastnode.png new file mode 100644 index 0000000..09ceb6a Binary files /dev/null and b/doc/html/ftv2mlastnode.png differ diff --git a/doc/html/ftv2mnode.png b/doc/html/ftv2mnode.png new file mode 100644 index 0000000..3254c05 Binary files /dev/null and b/doc/html/ftv2mnode.png differ diff --git a/doc/html/ftv2node.png b/doc/html/ftv2node.png new file mode 100644 index 0000000..c9f06a5 Binary files /dev/null and b/doc/html/ftv2node.png differ diff --git a/doc/html/ftv2plastnode.png b/doc/html/ftv2plastnode.png new file mode 100644 index 0000000..0b07e00 Binary files /dev/null and b/doc/html/ftv2plastnode.png differ diff --git a/doc/html/ftv2pnode.png b/doc/html/ftv2pnode.png new file mode 100644 index 0000000..2001b79 Binary files /dev/null and b/doc/html/ftv2pnode.png differ diff --git a/doc/html/ftv2vertline.png b/doc/html/ftv2vertline.png new file mode 100644 index 0000000..b330f3a Binary files /dev/null and b/doc/html/ftv2vertline.png differ diff --git a/doc/html/globals.html b/doc/html/globals.html new file mode 100644 index 0000000..57d249e --- /dev/null +++ b/doc/html/globals.html @@ -0,0 +1,132 @@ + + +glcd: Data Fields + + + + + +
+Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to: +

+

- l -

+

- m -

+

- p -

+
+
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/globals_defs.html b/doc/html/globals_defs.html new file mode 100644 index 0000000..82820c8 --- /dev/null +++ b/doc/html/globals_defs.html @@ -0,0 +1,84 @@ + + +glcd: Data Fields + + + + + +
+  +

+

+
+
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/globals_func.html b/doc/html/globals_func.html new file mode 100644 index 0000000..e64a4ba --- /dev/null +++ b/doc/html/globals_func.html @@ -0,0 +1,69 @@ + + +glcd: Data Fields + + + + + +
+  +

+

+
+
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/globals_vars.html b/doc/html/globals_vars.html new file mode 100644 index 0000000..9dc634c --- /dev/null +++ b/doc/html/globals_vars.html @@ -0,0 +1,46 @@ + + +glcd: Data Fields + + + + + +
+  +

+

+
+
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/index.html b/doc/html/index.html new file mode 100644 index 0000000..0bdf9a6 --- /dev/null +++ b/doc/html/index.html @@ -0,0 +1,24 @@ + + +glcd: Main Page + + + + + +
+

glcd Documentation

+

+

0.1beta

+
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/lc7981_8c.html b/doc/html/lc7981_8c.html new file mode 100644 index 0000000..4963aaf --- /dev/null +++ b/doc/html/lc7981_8c.html @@ -0,0 +1,375 @@ + + +glcd: include/lc7981.c File Reference + + + + + +
+

include/lc7981.c File Reference

#include "lc7981.h"
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Functions

void lcd_init (uint8_t mode)
 lcd_init set the to default values.
void lcd_write_command (uint8_t cmd, uint8_t data)
 Writes a command and a data byte to the lcd.
uint8_t lcd_read_byte ()
 Reads a byte from the display memory.
void lcd_strobe ()
 Generates the strobe signal for writing data.
void lcd_clear ()
 Clears the display by setting the whole memory to 0.
void lcd_write_text (char *txt)
void lcd_gotoxy (uint8_t x, uint8_t y)
 Set the display cursor to a specific location.
void lcd_plot_pixel (uint8_t x, uint8_t y, uint8_t set)
 set or unset a pixel at the specified location
void lcd_plot_bitmap (uint8_t x_off, uint8_t y_off, const uint8_t *bitmap, uint8_t w, uint8_t h)

Variables

uint8_t lcd_mode
 Currently used mode, can be text or graphic.
uint8_t lcd_curline
 Current line. Used for scrolling in text mode.
+

Function Documentation

+ +
+
+ + + + + + + + +
void lcd_clear (  )  [inline]
+
+
+ +

+Clears the display by setting the whole memory to 0. +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void lcd_gotoxy (uint8_t  x,
uint8_t  y 
) [inline]
+
+
+ +

+Set the display cursor to a specific location. +

+Right now this does only work in text mode, since there's no need for it now in graphics mode.
+ If the x and y values are to big, the function does nothing.

+

Parameters:
+ + + +
x the horizontal cursorposition (starts at 0)
y the vertical cursorposition (starts at 0)
+
+ +
+

+ +

+
+ + + + + + + + + +
void lcd_init (uint8_t  mode  ) 
+
+
+ +

+lcd_init set the to default values. +

+

Parameters:
+ + +
mode LCD_TEXT for text mode and LCD_GRAPHIC for graphic mode
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void lcd_plot_bitmap (uint8_t  x_off,
uint8_t  y_off,
const uint8_t *  bitmap,
uint8_t  w,
uint8_t  h 
)
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void lcd_plot_pixel (uint8_t  x,
uint8_t  y,
uint8_t  set 
)
+
+
+ +

+set or unset a pixel at the specified location +

+

Parameters:
+ + + + +
x horizontal position of the pixel (starts at 0)
y horizontal position of the pixel (starts at 0)
set can be PIXEL_ON or PIXEL_OFF
+
+ +
+

+ +

+
+ + + + + + + + +
uint8_t lcd_read_byte (  )  [inline]
+
+
+ +

+Reads a byte from the display memory. +

+lcd_gotoxy can be used to set the location. Important : lcd_gotoxy doesn't work in graphics mode yet.

+

Returns:
the byte which has been read
+
See also:
lcd_gotoxy
+ +
+

+ +

+
+ + + + + + + + +
void lcd_strobe (  )  [inline]
+
+
+ +

+Generates the strobe signal for writing data. +

+This function is meant for internal usage only. +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void lcd_write_command (uint8_t  cmd,
uint8_t  data 
) [inline]
+
+
+ +

+Writes a command and a data byte to the lcd. +

+

Parameters:
+ + + +
cmd the command byte
data the data that is going to be written after the command
+
+ +
+

+ +

+
+ + + + + + + + + +
void lcd_write_text (char *  txt  ) 
+
+
+ +

+ +

+

+

Variable Documentation

+ +
+
+ + + + +
uint8_t lcd_curline
+
+
+ +

+Current line. Used for scrolling in text mode. +

+ +

+

+ +

+
+ + + + +
uint8_t lcd_mode
+
+
+ +

+Currently used mode, can be text or graphic. +

+ +

+

+

+
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/lc7981_8h-source.html b/doc/html/lc7981_8h-source.html new file mode 100644 index 0000000..e932a53 --- /dev/null +++ b/doc/html/lc7981_8h-source.html @@ -0,0 +1,81 @@ + + +glcd: include/lc7981.h Source File + + + + + +
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/lc7981_8h.html b/doc/html/lc7981_8h.html new file mode 100644 index 0000000..7df1c36 --- /dev/null +++ b/doc/html/lc7981_8h.html @@ -0,0 +1,743 @@ + + +glcd: include/lc7981.h File Reference + + + + + +
+

include/lc7981.h File Reference

#include <avr/io.h>
+#include <util/delay.h>
+#include <avr/pgmspace.h>
+ +

+Go to the source code of this file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Defines

#define LC7981_H_   LC7981_H_
#define LCD_CTRL   PORTC
#define LCD_CRTL_DDR   DDRC
#define LCD_RS   PC4
#define LCD_RW   PC2
#define LCD_EN   PC0
#define LCD_DATA   PORTD
#define LCD_DATA_DDR   DDRD
#define lcd_rs_high()   (LCD_CTRL |= (1 << LCD_RS))
#define lcd_rs_low()   (LCD_CTRL &= ~(1 << LCD_RS))
#define lcd_rw_high()   (LCD_CTRL |= (1 << LCD_RW))
#define lcd_rw_low()   (LCD_CTRL &= ~(1 << LCD_RW))
#define lcd_en_high()   (LCD_CTRL |= (1 << LCD_EN))
#define lcd_en_low()   (LCD_CTRL &= ~(1 << LCD_EN))
#define LCD_TEXT   0
#define LCD_TEXT_LINES   10
#define LCD_TEXT_COLUMNS   26
#define LCD_GRAPHIC   1
#define LCD_GRAPHIC_WIDTH   160
#define LCD_GRAPHIC_HEIGHT   80
#define PIXEL_ON   1
#define PIXEL_OFF   0

Functions

void lcd_init (uint8_t mode)
 lcd_init set the to default values.
void lcd_clear ()
 Clears the display by setting the whole memory to 0.
void lcd_write_text (char *txt)
void lcd_gotoxy (uint8_t x, uint8_t y)
 Set the display cursor to a specific location.
void lcd_plot_pixel (uint8_t x, uint8_t y, uint8_t set)
 set or unset a pixel at the specified location
void lcd_plot_bitmap (uint8_t x, uint8_t y, const uint8_t *bitmap, uint8_t w, uint8_t h)
void lcd_strobe ()
 Generates the strobe signal for writing data.
void lcd_write_command (uint8_t cmd, uint8_t data)
 Writes a command and a data byte to the lcd.
uint8_t lcd_read_byte ()
 Reads a byte from the display memory.
+

Define Documentation

+ +
+
+ + + + +
#define LC7981_H_   LC7981_H_
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_CRTL_DDR   DDRC
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_CTRL   PORTC
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_DATA   PORTD
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_DATA_DDR   DDRD
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_EN   PC0
+
+
+ +

+ +

+

+ +

+
+ + + + +  + + + + +
#define lcd_en_high (  )    (LCD_CTRL |= (1 << LCD_EN))
+
+
+ +

+ +

+

+ +

+
+ + + + +  + + + + +
#define lcd_en_low (  )    (LCD_CTRL &= ~(1 << LCD_EN))
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_GRAPHIC   1
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_GRAPHIC_HEIGHT   80
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_GRAPHIC_WIDTH   160
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_RS   PC4
+
+
+ +

+ +

+

+ +

+
+ + + + +  + + + + +
#define lcd_rs_high (  )    (LCD_CTRL |= (1 << LCD_RS))
+
+
+ +

+ +

+

+ +

+
+ + + + +  + + + + +
#define lcd_rs_low (  )    (LCD_CTRL &= ~(1 << LCD_RS))
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_RW   PC2
+
+
+ +

+ +

+

+ +

+
+ + + + +  + + + + +
#define lcd_rw_high (  )    (LCD_CTRL |= (1 << LCD_RW))
+
+
+ +

+ +

+

+ +

+
+ + + + +  + + + + +
#define lcd_rw_low (  )    (LCD_CTRL &= ~(1 << LCD_RW))
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_TEXT   0
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_TEXT_COLUMNS   26
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define LCD_TEXT_LINES   10
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define PIXEL_OFF   0
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define PIXEL_ON   1
+
+
+ +

+ +

+

+

Function Documentation

+ +
+
+ + + + + + + + +
void lcd_clear (  )  [inline]
+
+
+ +

+Clears the display by setting the whole memory to 0. +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void lcd_gotoxy (uint8_t  x,
uint8_t  y 
) [inline]
+
+
+ +

+Set the display cursor to a specific location. +

+Right now this does only work in text mode, since there's no need for it now in graphics mode.
+ If the x and y values are to big, the function does nothing.

+

Parameters:
+ + + +
x the horizontal cursorposition (starts at 0)
y the vertical cursorposition (starts at 0)
+
+ +
+

+ +

+
+ + + + + + + + + +
void lcd_init (uint8_t  mode  ) 
+
+
+ +

+lcd_init set the to default values. +

+

Parameters:
+ + +
mode LCD_TEXT for text mode and LCD_GRAPHIC for graphic mode
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void lcd_plot_bitmap (uint8_t  x,
uint8_t  y,
const uint8_t *  bitmap,
uint8_t  w,
uint8_t  h 
)
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void lcd_plot_pixel (uint8_t  x,
uint8_t  y,
uint8_t  set 
)
+
+
+ +

+set or unset a pixel at the specified location +

+

Parameters:
+ + + + +
x horizontal position of the pixel (starts at 0)
y horizontal position of the pixel (starts at 0)
set can be PIXEL_ON or PIXEL_OFF
+
+ +
+

+ +

+
+ + + + + + + + +
uint8_t lcd_read_byte (  )  [inline]
+
+
+ +

+Reads a byte from the display memory. +

+lcd_gotoxy can be used to set the location. Important : lcd_gotoxy doesn't work in graphics mode yet.

+

Returns:
the byte which has been read
+
See also:
lcd_gotoxy
+ +
+

+ +

+
+ + + + + + + + +
void lcd_strobe (  )  [inline]
+
+
+ +

+Generates the strobe signal for writing data. +

+This function is meant for internal usage only. +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void lcd_write_command (uint8_t  cmd,
uint8_t  data 
) [inline]
+
+
+ +

+Writes a command and a data byte to the lcd. +

+

Parameters:
+ + + +
cmd the command byte
data the data that is going to be written after the command
+
+ +
+

+ +

+
+ + + + + + + + + +
void lcd_write_text (char *  txt  ) 
+
+
+ +

+ +

+

+

+
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/main.html b/doc/html/main.html new file mode 100644 index 0000000..eda9bf0 --- /dev/null +++ b/doc/html/main.html @@ -0,0 +1,24 @@ + + +glcd: Main Page + + + + + +
+

glcd Documentation

+

+

0.1beta

+
Generated on Sat May 16 13:44:09 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/main_8c.html b/doc/html/main_8c.html new file mode 100644 index 0000000..a176483 --- /dev/null +++ b/doc/html/main_8c.html @@ -0,0 +1,53 @@ + + +glcd: main.c File Reference + + + + + +
+

main.c File Reference

#include <avr/io.h>
+#include <stdlib.h>
+#include "include/lc7981.h"
+#include "button.h"
+#include "draw_penguin.h"
+ + + + + +

Functions

int main ()
+

Function Documentation

+ +
+
+ + + + + + + + +
int main (  ) 
+
+
+ +

+ +

+

+

+
Generated on Sat May 16 13:46:33 2009 for glcd by  + +doxygen 1.5.5
+ + diff --git a/doc/html/tab_b.gif b/doc/html/tab_b.gif new file mode 100644 index 0000000..0d62348 Binary files /dev/null and b/doc/html/tab_b.gif differ diff --git a/doc/html/tab_l.gif b/doc/html/tab_l.gif new file mode 100644 index 0000000..9b1e633 Binary files /dev/null and b/doc/html/tab_l.gif differ diff --git a/doc/html/tab_r.gif b/doc/html/tab_r.gif new file mode 100644 index 0000000..ce9dd9f Binary files /dev/null and b/doc/html/tab_r.gif differ diff --git a/doc/html/tabs.css b/doc/html/tabs.css new file mode 100644 index 0000000..95f00a9 --- /dev/null +++ b/doc/html/tabs.css @@ -0,0 +1,102 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; +} diff --git a/doc/html/tree.html b/doc/html/tree.html new file mode 100644 index 0000000..d3336fb --- /dev/null +++ b/doc/html/tree.html @@ -0,0 +1,77 @@ + + + + + + + TreeView + + + + +
+

glcd

+
+

o+File List

+ +

\*Globals

+
+
+ + diff --git a/doc/latex/Debug_2include_2lc7981_8d.tex b/doc/latex/Debug_2include_2lc7981_8d.tex new file mode 100644 index 0000000..0b0667b --- /dev/null +++ b/doc/latex/Debug_2include_2lc7981_8d.tex @@ -0,0 +1,2 @@ +\section{Debug/include/lc7981.d File Reference} +\label{Debug_2include_2lc7981_8d}\index{Debug/include/lc7981.d@{Debug/include/lc7981.d}} diff --git a/doc/latex/Debug_2main_8d.tex b/doc/latex/Debug_2main_8d.tex new file mode 100644 index 0000000..6065e73 --- /dev/null +++ b/doc/latex/Debug_2main_8d.tex @@ -0,0 +1,2 @@ +\section{Debug/main.d File Reference} +\label{Debug_2main_8d}\index{Debug/main.d@{Debug/main.d}} diff --git a/doc/latex/FreeSans.ttf b/doc/latex/FreeSans.ttf new file mode 100644 index 0000000..b550b90 Binary files /dev/null and b/doc/latex/FreeSans.ttf differ diff --git a/doc/latex/Makefile b/doc/latex/Makefile new file mode 100644 index 0000000..8b7c89a --- /dev/null +++ b/doc/latex/Makefile @@ -0,0 +1,19 @@ +all: clean refman.pdf + +pdf: refman.pdf + +refman.pdf: refman.tex + pdflatex refman.tex + makeindex refman.idx + pdflatex refman.tex + latex_count=5 ; \ + while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log && [ $$latex_count -gt 0 ] ;\ + do \ + echo "Rerunning latex...." ;\ + pdflatex refman.tex ;\ + latex_count=`expr $$latex_count - 1` ;\ + done + + +clean: + rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out refman.pdf diff --git a/doc/latex/Release_2include_2lc7981_8d.tex b/doc/latex/Release_2include_2lc7981_8d.tex new file mode 100644 index 0000000..4bc4999 --- /dev/null +++ b/doc/latex/Release_2include_2lc7981_8d.tex @@ -0,0 +1,2 @@ +\section{Release/include/lc7981.d File Reference} +\label{Release_2include_2lc7981_8d}\index{Release/include/lc7981.d@{Release/include/lc7981.d}} diff --git a/doc/latex/Release_2main_8d.tex b/doc/latex/Release_2main_8d.tex new file mode 100644 index 0000000..68b5e2a --- /dev/null +++ b/doc/latex/Release_2main_8d.tex @@ -0,0 +1,2 @@ +\section{Release/main.d File Reference} +\label{Release_2main_8d}\index{Release/main.d@{Release/main.d}} diff --git a/doc/latex/button_8h.tex b/doc/latex/button_8h.tex new file mode 100644 index 0000000..a113f33 --- /dev/null +++ b/doc/latex/button_8h.tex @@ -0,0 +1,16 @@ +\section{button.h File Reference} +\label{button_8h}\index{button.h@{button.h}} +{\tt \#include $<$avr/pgmspace.h$>$}\par +\subsection*{Variables} +\begin{CompactItemize} +\item +const uint8\_\-t bitmap[$\,$] {\bf PROGMEM} +\end{CompactItemize} + + +\subsection{Variable Documentation} +\index{button.h@{button.h}!PROGMEM@{PROGMEM}} +\index{PROGMEM@{PROGMEM}!button.h@{button.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const uint8\_\-t bitmap [$\,$] {\bf PROGMEM}}\label{button_8h_1ca6393a353d3dde5511786a4d7cc139} + + diff --git a/doc/latex/doxygen.sty b/doc/latex/doxygen.sty new file mode 100644 index 0000000..d92a707 --- /dev/null +++ b/doc/latex/doxygen.sty @@ -0,0 +1,78 @@ +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{doxygen} +\RequirePackage{calc} +\RequirePackage{array} +\pagestyle{fancyplain} +\newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}\cleardoublepage}} +\renewcommand{\chaptermark}[1]{\markboth{#1}{}} +\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}} +\lhead[\fancyplain{}{\bfseries\thepage}] + {\fancyplain{}{\bfseries\rightmark}} +\rhead[\fancyplain{}{\bfseries\leftmark}] + {\fancyplain{}{\bfseries\thepage}} +\rfoot[\fancyplain{}{\bfseries\scriptsize Generated on Sat May 16 13:46:33 2009 for glcd by Doxygen }]{} +\lfoot[]{\fancyplain{}{\bfseries\scriptsize Generated on Sat May 16 13:46:33 2009 for glcd by Doxygen }} +\cfoot{} +\newenvironment{Code} +{\footnotesize} +{\normalsize} +\newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})} +\newenvironment{DocInclude} +{\footnotesize} +{\normalsize} +\newenvironment{VerbInclude} +{\footnotesize} +{\normalsize} +\newenvironment{Image} +{\begin{figure}[H]} +{\end{figure}} +\newenvironment{ImageNoCaption}{}{} +\newenvironment{CompactList} +{\begin{list}{}{ + \setlength{\leftmargin}{0.5cm} + \setlength{\itemsep}{0pt} + \setlength{\parsep}{0pt} + \setlength{\topsep}{0pt} + \renewcommand{\makelabel}{\hfill}}} +{\end{list}} +\newenvironment{CompactItemize} +{ + \begin{itemize} + \setlength{\itemsep}{-3pt} + \setlength{\parsep}{0pt} + \setlength{\topsep}{0pt} + \setlength{\partopsep}{0pt} +} +{\end{itemize}} +\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp} +\newlength{\tmplength} +\newenvironment{TabularC}[1] +{ +\setlength{\tmplength} + {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)} + \par\begin{tabular*}{\linewidth} + {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|} +} +{\end{tabular*}\par} +\newcommand{\entrylabel}[1]{ + {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\vspace{1.5\baselineskip}}}} +\newenvironment{Desc} +{\begin{list}{} + { + \settowidth{\labelwidth}{40pt} + \setlength{\leftmargin}{\labelwidth} + \setlength{\parsep}{0pt} + \setlength{\itemsep}{-4pt} + \renewcommand{\makelabel}{\entrylabel} + } +} +{\end{list}} +\newenvironment{Indent} + {\begin{list}{}{\setlength{\leftmargin}{0.5cm}} + \item[]\ignorespaces} + {\unskip\end{list}} +\setlength{\parindent}{0cm} +\setlength{\parskip}{0.2cm} +\addtocounter{secnumdepth}{1} +\sloppy +\usepackage[T1]{fontenc} diff --git a/doc/latex/files.tex b/doc/latex/files.tex new file mode 100644 index 0000000..046322b --- /dev/null +++ b/doc/latex/files.tex @@ -0,0 +1,7 @@ +\section{File List} +Here is a list of all files with brief descriptions:\begin{CompactList} +\item\contentsline{section}{{\bf button.h} }{\pageref{button_8h}}{} +\item\contentsline{section}{{\bf main.c} }{\pageref{main_8c}}{} +\item\contentsline{section}{include/{\bf lc7981.c} }{\pageref{lc7981_8c}}{} +\item\contentsline{section}{include/{\bf lc7981.h} }{\pageref{lc7981_8h}}{} +\end{CompactList} diff --git a/doc/latex/lc7981_8c.tex b/doc/latex/lc7981_8c.tex new file mode 100644 index 0000000..35d104f --- /dev/null +++ b/doc/latex/lc7981_8c.tex @@ -0,0 +1,139 @@ +\section{include/lc7981.c File Reference} +\label{lc7981_8c}\index{include/lc7981.c@{include/lc7981.c}} +{\tt \#include \char`\"{}lc7981.h\char`\"{}}\par +\subsection*{Functions} +\begin{CompactItemize} +\item +void {\bf lcd\_\-init} (uint8\_\-t mode) +\begin{CompactList}\small\item\em lcd\_\-init set the to default values. \item\end{CompactList}\item +void {\bf lcd\_\-write\_\-command} (uint8\_\-t cmd, uint8\_\-t data) +\begin{CompactList}\small\item\em Writes a command and a data byte to the lcd. \item\end{CompactList}\item +uint8\_\-t {\bf lcd\_\-read\_\-byte} () +\begin{CompactList}\small\item\em Reads a byte from the display memory. \item\end{CompactList}\item +void {\bf lcd\_\-strobe} () +\begin{CompactList}\small\item\em Generates the strobe signal for writing data. \item\end{CompactList}\item +void {\bf lcd\_\-clear} () +\begin{CompactList}\small\item\em Clears the display by setting the whole memory to 0. \item\end{CompactList}\item +void {\bf lcd\_\-write\_\-text} (char $\ast$txt) +\item +void {\bf lcd\_\-gotoxy} (uint8\_\-t x, uint8\_\-t y) +\begin{CompactList}\small\item\em Set the display cursor to a specific location. \item\end{CompactList}\item +void {\bf lcd\_\-plot\_\-pixel} (uint8\_\-t x, uint8\_\-t y, uint8\_\-t set) +\begin{CompactList}\small\item\em set or unset a pixel at the specified location \item\end{CompactList}\item +void {\bf lcd\_\-plot\_\-bitmap} (uint8\_\-t x\_\-off, uint8\_\-t y\_\-off, const uint8\_\-t $\ast$bitmap, uint8\_\-t w, uint8\_\-t h) +\end{CompactItemize} +\subsection*{Variables} +\begin{CompactItemize} +\item +uint8\_\-t {\bf lcd\_\-mode} +\begin{CompactList}\small\item\em Currently used mode, can be text or graphic. \item\end{CompactList}\item +uint8\_\-t {\bf lcd\_\-curline} +\begin{CompactList}\small\item\em Current line. Used for scrolling in text mode. \item\end{CompactList}\end{CompactItemize} + + +\subsection{Function Documentation} +\index{lc7981.c@{lc7981.c}!lcd\_\-clear@{lcd\_\-clear}} +\index{lcd\_\-clear@{lcd\_\-clear}!lc7981.c@{lc7981.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-clear ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8c_35c08b1fa742e650f4873939707b893b} + + +Clears the display by setting the whole memory to 0. + +\index{lc7981.c@{lc7981.c}!lcd\_\-gotoxy@{lcd\_\-gotoxy}} +\index{lcd\_\-gotoxy@{lcd\_\-gotoxy}!lc7981.c@{lc7981.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-gotoxy (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y})\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8c_dbf47a5efdf02367ded1ebf8f9edb5fe} + + +Set the display cursor to a specific location. + +Right now this does only work in text mode, since there's no need for it now in graphics mode. \par + If the x and y values are to big, the function does nothing. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em x}]the horizontal cursorposition (starts at 0) \item[{\em y}]the vertical cursorposition (starts at 0) \end{description} +\end{Desc} +\index{lc7981.c@{lc7981.c}!lcd\_\-init@{lcd\_\-init}} +\index{lcd\_\-init@{lcd\_\-init}!lc7981.c@{lc7981.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-init (uint8\_\-t {\em mode})}\label{lc7981_8c_9b18aca098d68e55bd7dd4b83f4f36e9} + + +lcd\_\-init set the to default values. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mode}]LCD\_\-TEXT for text mode and LCD\_\-GRAPHIC for graphic mode \end{description} +\end{Desc} +\index{lc7981.c@{lc7981.c}!lcd\_\-plot\_\-bitmap@{lcd\_\-plot\_\-bitmap}} +\index{lcd\_\-plot\_\-bitmap@{lcd\_\-plot\_\-bitmap}!lc7981.c@{lc7981.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-bitmap (uint8\_\-t {\em x\_\-off}, \/ uint8\_\-t {\em y\_\-off}, \/ const uint8\_\-t $\ast$ {\em bitmap}, \/ uint8\_\-t {\em w}, \/ uint8\_\-t {\em h})}\label{lc7981_8c_f3b584ee8235c6ed4ebefc50f8a95915} + + +\index{lc7981.c@{lc7981.c}!lcd\_\-plot\_\-pixel@{lcd\_\-plot\_\-pixel}} +\index{lcd\_\-plot\_\-pixel@{lcd\_\-plot\_\-pixel}!lc7981.c@{lc7981.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-pixel (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y}, \/ uint8\_\-t {\em set})}\label{lc7981_8c_735111507ed83172f58d5af2953e31c6} + + +set or unset a pixel at the specified location + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em x}]horizontal position of the pixel (starts at 0) \item[{\em y}]horizontal position of the pixel (starts at 0) \item[{\em set}]can be PIXEL\_\-ON or PIXEL\_\-OFF \end{description} +\end{Desc} +\index{lc7981.c@{lc7981.c}!lcd\_\-read\_\-byte@{lcd\_\-read\_\-byte}} +\index{lcd\_\-read\_\-byte@{lcd\_\-read\_\-byte}!lc7981.c@{lc7981.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t lcd\_\-read\_\-byte ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8c_6334333537ad1d0bd51cba1e80f32e74} + + +Reads a byte from the display memory. + +lcd\_\-gotoxy can be used to set the location. Important : lcd\_\-gotoxy doesn't work in graphics mode yet. + +\begin{Desc} +\item[Returns:]the byte which has been read \end{Desc} +\begin{Desc} +\item[See also:]\doxyref{lcd\_\-gotoxy}{p.}{lc7981_8h_dbf47a5efdf02367ded1ebf8f9edb5fe} \end{Desc} +\index{lc7981.c@{lc7981.c}!lcd\_\-strobe@{lcd\_\-strobe}} +\index{lcd\_\-strobe@{lcd\_\-strobe}!lc7981.c@{lc7981.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-strobe ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8c_b4f286d6a313df7a5f692e0b4a9509ad} + + +Generates the strobe signal for writing data. + +This function is meant for internal usage only. \index{lc7981.c@{lc7981.c}!lcd\_\-write\_\-command@{lcd\_\-write\_\-command}} +\index{lcd\_\-write\_\-command@{lcd\_\-write\_\-command}!lc7981.c@{lc7981.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-write\_\-command (uint8\_\-t {\em cmd}, \/ uint8\_\-t {\em data})\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8c_b69146a9179fc5b5deef3fc61cf0208c} + + +Writes a command and a data byte to the lcd. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em cmd}]the command byte \item[{\em data}]the data that is going to be written after the command \end{description} +\end{Desc} +\index{lc7981.c@{lc7981.c}!lcd\_\-write\_\-text@{lcd\_\-write\_\-text}} +\index{lcd\_\-write\_\-text@{lcd\_\-write\_\-text}!lc7981.c@{lc7981.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-write\_\-text (char $\ast$ {\em txt})}\label{lc7981_8c_30251238a49999658455fdb0233757fb} + + + + +\subsection{Variable Documentation} +\index{lc7981.c@{lc7981.c}!lcd\_\-curline@{lcd\_\-curline}} +\index{lcd\_\-curline@{lcd\_\-curline}!lc7981.c@{lc7981.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t {\bf lcd\_\-curline}}\label{lc7981_8c_76f8e26cf50274635b544f68752b2a0f} + + +Current line. Used for scrolling in text mode. + +\index{lc7981.c@{lc7981.c}!lcd\_\-mode@{lcd\_\-mode}} +\index{lcd\_\-mode@{lcd\_\-mode}!lc7981.c@{lc7981.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t {\bf lcd\_\-mode}}\label{lc7981_8c_a29c0577fe01129f48b5b21301d3ea49} + + +Currently used mode, can be text or graphic. + diff --git a/doc/latex/lc7981_8h.tex b/doc/latex/lc7981_8h.tex new file mode 100644 index 0000000..0ab7ae4 --- /dev/null +++ b/doc/latex/lc7981_8h.tex @@ -0,0 +1,277 @@ +\section{include/lc7981.h File Reference} +\label{lc7981_8h}\index{include/lc7981.h@{include/lc7981.h}} +{\tt \#include $<$avr/io.h$>$}\par +{\tt \#include $<$util/delay.h$>$}\par +{\tt \#include $<$avr/pgmspace.h$>$}\par +\subsection*{Defines} +\begin{CompactItemize} +\item +\#define {\bf LC7981\_\-H\_\-}~LC7981\_\-H\_\- +\item +\#define {\bf LCD\_\-CTRL}~PORTC +\item +\#define {\bf LCD\_\-CRTL\_\-DDR}~DDRC +\item +\#define {\bf LCD\_\-RS}~PC4 +\item +\#define {\bf LCD\_\-RW}~PC2 +\item +\#define {\bf LCD\_\-EN}~PC0 +\item +\#define {\bf LCD\_\-DATA}~PORTD +\item +\#define {\bf LCD\_\-DATA\_\-DDR}~DDRD +\item +\#define {\bf lcd\_\-rs\_\-high}()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RS)) +\item +\#define {\bf lcd\_\-rs\_\-low}()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RS)) +\item +\#define {\bf lcd\_\-rw\_\-high}()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RW)) +\item +\#define {\bf lcd\_\-rw\_\-low}()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RW)) +\item +\#define {\bf lcd\_\-en\_\-high}()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-EN)) +\item +\#define {\bf lcd\_\-en\_\-low}()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-EN)) +\item +\#define {\bf LCD\_\-TEXT}~0 +\item +\#define {\bf LCD\_\-TEXT\_\-LINES}~10 +\item +\#define {\bf LCD\_\-TEXT\_\-COLUMNS}~26 +\item +\#define {\bf LCD\_\-GRAPHIC}~1 +\item +\#define {\bf LCD\_\-GRAPHIC\_\-WIDTH}~160 +\item +\#define {\bf LCD\_\-GRAPHIC\_\-HEIGHT}~80 +\item +\#define {\bf PIXEL\_\-ON}~1 +\item +\#define {\bf PIXEL\_\-OFF}~0 +\end{CompactItemize} +\subsection*{Functions} +\begin{CompactItemize} +\item +void {\bf lcd\_\-init} (uint8\_\-t mode) +\begin{CompactList}\small\item\em lcd\_\-init set the to default values. \item\end{CompactList}\item +void {\bf lcd\_\-clear} () +\begin{CompactList}\small\item\em Clears the display by setting the whole memory to 0. \item\end{CompactList}\item +void {\bf lcd\_\-write\_\-text} (char $\ast$txt) +\item +void {\bf lcd\_\-gotoxy} (uint8\_\-t x, uint8\_\-t y) +\begin{CompactList}\small\item\em Set the display cursor to a specific location. \item\end{CompactList}\item +void {\bf lcd\_\-plot\_\-pixel} (uint8\_\-t x, uint8\_\-t y, uint8\_\-t set) +\begin{CompactList}\small\item\em set or unset a pixel at the specified location \item\end{CompactList}\item +void {\bf lcd\_\-plot\_\-bitmap} (uint8\_\-t x, uint8\_\-t y, const uint8\_\-t $\ast$bitmap, uint8\_\-t w, uint8\_\-t h) +\item +void {\bf lcd\_\-strobe} () +\begin{CompactList}\small\item\em Generates the strobe signal for writing data. \item\end{CompactList}\item +void {\bf lcd\_\-write\_\-command} (uint8\_\-t cmd, uint8\_\-t data) +\begin{CompactList}\small\item\em Writes a command and a data byte to the lcd. \item\end{CompactList}\item +uint8\_\-t {\bf lcd\_\-read\_\-byte} () +\begin{CompactList}\small\item\em Reads a byte from the display memory. \item\end{CompactList}\end{CompactItemize} + + +\subsection{Define Documentation} +\index{lc7981.h@{lc7981.h}!LC7981\_\-H\_\-@{LC7981\_\-H\_\-}} +\index{LC7981\_\-H\_\-@{LC7981\_\-H\_\-}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LC7981\_\-H\_\-~LC7981\_\-H\_\-}\label{lc7981_8h_e6ff861bd55f4dc46f25f5f6abfca15f} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-CRTL\_\-DDR@{LCD\_\-CRTL\_\-DDR}} +\index{LCD\_\-CRTL\_\-DDR@{LCD\_\-CRTL\_\-DDR}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-CRTL\_\-DDR~DDRC}\label{lc7981_8h_4b6c8400da9a1ca3d4d83f3ef1f9c34a} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-CTRL@{LCD\_\-CTRL}} +\index{LCD\_\-CTRL@{LCD\_\-CTRL}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-CTRL~PORTC}\label{lc7981_8h_8e945df7ca614325cafa08258e82a63c} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-DATA@{LCD\_\-DATA}} +\index{LCD\_\-DATA@{LCD\_\-DATA}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-DATA~PORTD}\label{lc7981_8h_25e9d818788f36ed74d7c4579f87f2a6} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-DATA\_\-DDR@{LCD\_\-DATA\_\-DDR}} +\index{LCD\_\-DATA\_\-DDR@{LCD\_\-DATA\_\-DDR}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-DATA\_\-DDR~DDRD}\label{lc7981_8h_0c114e723aa4c162c415fb6d4d963dd7} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-EN@{LCD\_\-EN}} +\index{LCD\_\-EN@{LCD\_\-EN}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-EN~PC0}\label{lc7981_8h_1640ffbc0d8ec0f7edb04a2b93918072} + + +\index{lc7981.h@{lc7981.h}!lcd\_\-en\_\-high@{lcd\_\-en\_\-high}} +\index{lcd\_\-en\_\-high@{lcd\_\-en\_\-high}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-en\_\-high()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-EN))}\label{lc7981_8h_e14be306d3620577abc8613d40401b04} + + +\index{lc7981.h@{lc7981.h}!lcd\_\-en\_\-low@{lcd\_\-en\_\-low}} +\index{lcd\_\-en\_\-low@{lcd\_\-en\_\-low}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-en\_\-low()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-EN))}\label{lc7981_8h_d8dcdb36a9410fd96b2c936b7c9355dd} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-GRAPHIC@{LCD\_\-GRAPHIC}} +\index{LCD\_\-GRAPHIC@{LCD\_\-GRAPHIC}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-GRAPHIC~1}\label{lc7981_8h_dfaedf8da8e73d39a98d709b519a3117} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-GRAPHIC\_\-HEIGHT@{LCD\_\-GRAPHIC\_\-HEIGHT}} +\index{LCD\_\-GRAPHIC\_\-HEIGHT@{LCD\_\-GRAPHIC\_\-HEIGHT}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-GRAPHIC\_\-HEIGHT~80}\label{lc7981_8h_70265c4f840ef78872243e91c923af2f} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-GRAPHIC\_\-WIDTH@{LCD\_\-GRAPHIC\_\-WIDTH}} +\index{LCD\_\-GRAPHIC\_\-WIDTH@{LCD\_\-GRAPHIC\_\-WIDTH}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-GRAPHIC\_\-WIDTH~160}\label{lc7981_8h_51e83be6f6929f2a29d5467cd937dfc6} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-RS@{LCD\_\-RS}} +\index{LCD\_\-RS@{LCD\_\-RS}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-RS~PC4}\label{lc7981_8h_4781e073871c6f27f89b9463ad3a4ed1} + + +\index{lc7981.h@{lc7981.h}!lcd\_\-rs\_\-high@{lcd\_\-rs\_\-high}} +\index{lcd\_\-rs\_\-high@{lcd\_\-rs\_\-high}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rs\_\-high()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RS))}\label{lc7981_8h_795b48274d3f80bc744a707b67fd93e9} + + +\index{lc7981.h@{lc7981.h}!lcd\_\-rs\_\-low@{lcd\_\-rs\_\-low}} +\index{lcd\_\-rs\_\-low@{lcd\_\-rs\_\-low}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rs\_\-low()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RS))}\label{lc7981_8h_6edb13d59460246fb4cc32ada1c9f4a8} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-RW@{LCD\_\-RW}} +\index{LCD\_\-RW@{LCD\_\-RW}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-RW~PC2}\label{lc7981_8h_26089a10ddd59a0dc7283c19ccc02533} + + +\index{lc7981.h@{lc7981.h}!lcd\_\-rw\_\-high@{lcd\_\-rw\_\-high}} +\index{lcd\_\-rw\_\-high@{lcd\_\-rw\_\-high}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rw\_\-high()~(LCD\_\-CTRL $|$= (1 $<$$<$ LCD\_\-RW))}\label{lc7981_8h_d0ce3cd9b481370ad4de36eff08440c8} + + +\index{lc7981.h@{lc7981.h}!lcd\_\-rw\_\-low@{lcd\_\-rw\_\-low}} +\index{lcd\_\-rw\_\-low@{lcd\_\-rw\_\-low}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define lcd\_\-rw\_\-low()~(LCD\_\-CTRL \&= $\sim$(1 $<$$<$ LCD\_\-RW))}\label{lc7981_8h_7f5ebe0ca71b1298a7d3423850cc82b1} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-TEXT@{LCD\_\-TEXT}} +\index{LCD\_\-TEXT@{LCD\_\-TEXT}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-TEXT~0}\label{lc7981_8h_90a69d37f5c80f3ded970acf2dacf4c0} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-TEXT\_\-COLUMNS@{LCD\_\-TEXT\_\-COLUMNS}} +\index{LCD\_\-TEXT\_\-COLUMNS@{LCD\_\-TEXT\_\-COLUMNS}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-TEXT\_\-COLUMNS~26}\label{lc7981_8h_82f0a630f3c41b5233f2ceb07c7dd736} + + +\index{lc7981.h@{lc7981.h}!LCD\_\-TEXT\_\-LINES@{LCD\_\-TEXT\_\-LINES}} +\index{LCD\_\-TEXT\_\-LINES@{LCD\_\-TEXT\_\-LINES}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define LCD\_\-TEXT\_\-LINES~10}\label{lc7981_8h_720ef60606ac38ca3a5ab96a9c2b8168} + + +\index{lc7981.h@{lc7981.h}!PIXEL\_\-OFF@{PIXEL\_\-OFF}} +\index{PIXEL\_\-OFF@{PIXEL\_\-OFF}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define PIXEL\_\-OFF~0}\label{lc7981_8h_cda2f1b1cf6310700d0d91643c40e068} + + +\index{lc7981.h@{lc7981.h}!PIXEL\_\-ON@{PIXEL\_\-ON}} +\index{PIXEL\_\-ON@{PIXEL\_\-ON}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define PIXEL\_\-ON~1}\label{lc7981_8h_eb2d212a26da4a5a4d3231b2773023e5} + + + + +\subsection{Function Documentation} +\index{lc7981.h@{lc7981.h}!lcd\_\-clear@{lcd\_\-clear}} +\index{lcd\_\-clear@{lcd\_\-clear}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-clear ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8h_35c08b1fa742e650f4873939707b893b} + + +Clears the display by setting the whole memory to 0. + +\index{lc7981.h@{lc7981.h}!lcd\_\-gotoxy@{lcd\_\-gotoxy}} +\index{lcd\_\-gotoxy@{lcd\_\-gotoxy}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-gotoxy (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y})\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8h_dbf47a5efdf02367ded1ebf8f9edb5fe} + + +Set the display cursor to a specific location. + +Right now this does only work in text mode, since there's no need for it now in graphics mode. \par + If the x and y values are to big, the function does nothing. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em x}]the horizontal cursorposition (starts at 0) \item[{\em y}]the vertical cursorposition (starts at 0) \end{description} +\end{Desc} +\index{lc7981.h@{lc7981.h}!lcd\_\-init@{lcd\_\-init}} +\index{lcd\_\-init@{lcd\_\-init}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-init (uint8\_\-t {\em mode})}\label{lc7981_8h_9b18aca098d68e55bd7dd4b83f4f36e9} + + +lcd\_\-init set the to default values. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mode}]LCD\_\-TEXT for text mode and LCD\_\-GRAPHIC for graphic mode \end{description} +\end{Desc} +\index{lc7981.h@{lc7981.h}!lcd\_\-plot\_\-bitmap@{lcd\_\-plot\_\-bitmap}} +\index{lcd\_\-plot\_\-bitmap@{lcd\_\-plot\_\-bitmap}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-bitmap (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y}, \/ const uint8\_\-t $\ast$ {\em bitmap}, \/ uint8\_\-t {\em w}, \/ uint8\_\-t {\em h})}\label{lc7981_8h_175d691feb304584c8c18e6456e07401} + + +\index{lc7981.h@{lc7981.h}!lcd\_\-plot\_\-pixel@{lcd\_\-plot\_\-pixel}} +\index{lcd\_\-plot\_\-pixel@{lcd\_\-plot\_\-pixel}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-plot\_\-pixel (uint8\_\-t {\em x}, \/ uint8\_\-t {\em y}, \/ uint8\_\-t {\em set})}\label{lc7981_8h_735111507ed83172f58d5af2953e31c6} + + +set or unset a pixel at the specified location + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em x}]horizontal position of the pixel (starts at 0) \item[{\em y}]horizontal position of the pixel (starts at 0) \item[{\em set}]can be PIXEL\_\-ON or PIXEL\_\-OFF \end{description} +\end{Desc} +\index{lc7981.h@{lc7981.h}!lcd\_\-read\_\-byte@{lcd\_\-read\_\-byte}} +\index{lcd\_\-read\_\-byte@{lcd\_\-read\_\-byte}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t lcd\_\-read\_\-byte ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8h_6334333537ad1d0bd51cba1e80f32e74} + + +Reads a byte from the display memory. + +lcd\_\-gotoxy can be used to set the location. Important : lcd\_\-gotoxy doesn't work in graphics mode yet. + +\begin{Desc} +\item[Returns:]the byte which has been read \end{Desc} +\begin{Desc} +\item[See also:]\doxyref{lcd\_\-gotoxy}{p.}{lc7981_8h_dbf47a5efdf02367ded1ebf8f9edb5fe} \end{Desc} +\index{lc7981.h@{lc7981.h}!lcd\_\-strobe@{lcd\_\-strobe}} +\index{lcd\_\-strobe@{lcd\_\-strobe}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-strobe ()\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8h_b4f286d6a313df7a5f692e0b4a9509ad} + + +Generates the strobe signal for writing data. + +This function is meant for internal usage only. \index{lc7981.h@{lc7981.h}!lcd\_\-write\_\-command@{lcd\_\-write\_\-command}} +\index{lcd\_\-write\_\-command@{lcd\_\-write\_\-command}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-write\_\-command (uint8\_\-t {\em cmd}, \/ uint8\_\-t {\em data})\hspace{0.3cm}{\tt [inline]}}\label{lc7981_8h_b69146a9179fc5b5deef3fc61cf0208c} + + +Writes a command and a data byte to the lcd. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em cmd}]the command byte \item[{\em data}]the data that is going to be written after the command \end{description} +\end{Desc} +\index{lc7981.h@{lc7981.h}!lcd\_\-write\_\-text@{lcd\_\-write\_\-text}} +\index{lcd\_\-write\_\-text@{lcd\_\-write\_\-text}!lc7981.h@{lc7981.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void lcd\_\-write\_\-text (char $\ast$ {\em txt})}\label{lc7981_8h_30251238a49999658455fdb0233757fb} + + diff --git a/doc/latex/main_8c.tex b/doc/latex/main_8c.tex new file mode 100644 index 0000000..91c5750 --- /dev/null +++ b/doc/latex/main_8c.tex @@ -0,0 +1,20 @@ +\section{main.c File Reference} +\label{main_8c}\index{main.c@{main.c}} +{\tt \#include $<$avr/io.h$>$}\par +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include \char`\"{}include/lc7981.h\char`\"{}}\par +{\tt \#include \char`\"{}button.h\char`\"{}}\par +{\tt \#include \char`\"{}draw\_\-penguin.h\char`\"{}}\par +\subsection*{Functions} +\begin{CompactItemize} +\item +int {\bf main} () +\end{CompactItemize} + + +\subsection{Function Documentation} +\index{main.c@{main.c}!main@{main}} +\index{main@{main}!main.c@{main.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int main ()}\label{main_8c_e66f6b31b5ad750f1fe042a706a4e3d4} + + diff --git a/doc/latex/refman.tex b/doc/latex/refman.tex new file mode 100644 index 0000000..53129f5 --- /dev/null +++ b/doc/latex/refman.tex @@ -0,0 +1,40 @@ +\documentclass[a4paper]{book} +\usepackage{a4wide} +\usepackage{makeidx} +\usepackage{fancyhdr} +\usepackage{graphicx} +\usepackage{multicol} +\usepackage{float} +\usepackage{textcomp} +\usepackage{alltt} +\usepackage{times} +\usepackage[utf8]{inputenc} +\usepackage{doxygen} +\makeindex +\setcounter{tocdepth}{1} +\renewcommand{\footrulewidth}{0.4pt} +\begin{document} +\begin{titlepage} +\vspace*{7cm} +\begin{center} +{\Large glcd \\[1ex]\large 0.1beta }\\ +\vspace*{1cm} +{\large Generated by Doxygen 1.5.5}\\ +\vspace*{0.5cm} +{\small Sat May 16 13:46:33 2009}\\ +\end{center} +\end{titlepage} +\clearemptydoublepage +\pagenumbering{roman} +\tableofcontents +\clearemptydoublepage +\pagenumbering{arabic} +\chapter{File Index} +\input{files} +\chapter{File Documentation} +\input{button_8h} +\include{lc7981_8c} +\include{lc7981_8h} +\include{main_8c} +\printindex +\end{document} diff --git a/glcd.doxyfile b/glcd.doxyfile new file mode 100644 index 0000000..c634cb3 --- /dev/null +++ b/glcd.doxyfile @@ -0,0 +1,1356 @@ +# Doxyfile 1.5.5 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = glcd + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = 0.1beta + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# and Ukrainian. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST = YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = include . + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentstion. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is enabled by default, which results in a transparent +# background. Warning: Depending on the platform used, enabling this option +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they +# become hard to read). + +DOT_TRANSPARENT = YES + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/include/lc7981.c b/include/lc7981.c new file mode 100644 index 0000000..54972f9 --- /dev/null +++ b/include/lc7981.c @@ -0,0 +1,300 @@ +/* + * lc7981.c + * + * Created on: 01.05.2009 + * Author: sebastian + */ + +#include "lc7981.h" + +uint8_t lcd_mode, //!< Currently used mode, can be text or graphic. + lcd_curline; //!< Current line. Used for scrolling in text mode. + +/** + * lcd_init set the to default values. + * + * @param mode LCD_TEXT for text mode and LCD_GRAPHIC for graphic mode + */ +void lcd_init(uint8_t mode) { + + LCD_DATA_DDR = 0xFF; + LCD_DATA = 0; + LCD_CRTL_DDR = 0xFF; + //|= (1 << LCD_RS) | (1 << LCD_RW) | (1 << LCD_EN) | (1 << LCD_CS) | (1 << LCD_RST); + LCD_CTRL = 0; + + + lcd_en_low(); + lcd_rs_low(); + lcd_rw_low(); + + if(mode == LCD_TEXT) { + + lcd_mode = LCD_TEXT; + + lcd_write_command(0x00,0x3C); + lcd_write_command(0x01,0x75); + lcd_write_command(0x02,LCD_TEXT_COLUMNS - 1); + lcd_write_command(0x03,0x4F); + lcd_write_command(0x04,0x07); + lcd_write_command(0x08,0x00); + lcd_write_command(0x09,0x00); + lcd_write_command(0x0A,0x00); + lcd_write_command(0x0B,0x00); + + } + else { + + lcd_mode = LCD_GRAPHIC; + + lcd_write_command(0x00,0x32); + lcd_write_command(0x01,0x07); + lcd_write_command(0x02,(LCD_GRAPHIC_WIDTH / 8)-1); + lcd_write_command(0x03,0x4F); + lcd_write_command(0x08,0x00); + lcd_write_command(0x09,0x00); + lcd_write_command(0x0A,0x00); + lcd_write_command(0x0B,0x00); + } + + lcd_clear(); +} + +/** + * Writes a command and a data byte to the lcd. + * + * @param cmd the command byte + * @param data the data that is going to be written after the command + */ +inline void lcd_write_command(uint8_t cmd, uint8_t data) { + _delay_us(30); + lcd_rw_low(); + lcd_rs_high(); + LCD_DATA = cmd; + _delay_us(1); + lcd_strobe(); + + lcd_rs_low(); + LCD_DATA = data; + _delay_us(1); + lcd_strobe(); + +} + +/** + * Reads a byte from the display memory. + * lcd_gotoxy can be used to set the location. + * Important : lcd_gotoxy doesn't work in graphics mode yet. + * + * @return the byte which has been read + * @see lcd_gotoxy + */ +inline uint8_t lcd_read_byte() { +uint8_t i,data; + + for(i = 0; i < 2; i++) { + _delay_us(30); + lcd_rw_low(); + lcd_rs_high(); + LCD_DATA = 0x0D; + _delay_us(1); + lcd_en_high(); + + LCD_DATA_DDR = 0x00; + lcd_rs_low(); + lcd_rw_high(); + _delay_us(1); + data = (uint8_t) PIND; + lcd_en_low(); + LCD_DATA_DDR = 0xFF; + } + return data; +} + + +/** + * Generates the strobe signal for writing data. + * This function is meant for internal usage only. + */ +inline void lcd_strobe() { + lcd_en_high(); + _delay_us(1); + lcd_en_low(); + +} + +/** + * Clears the display by setting the whole memory to 0. + */ +inline void lcd_clear() { +uint16_t i; + + if(lcd_mode == LCD_TEXT) { + + lcd_write_command(0x0A,0x00); + lcd_write_command(0x0B,0x00); + + for(i = 1; i <= LCD_TEXT_LINES * LCD_TEXT_COLUMNS; i++) + lcd_write_command(0x0C,' '); + + lcd_write_command(0x0A,0x00); + lcd_write_command(0x0B,0x00); + + lcd_curline = 0; + } + else { + + lcd_write_command(0x0A,0x00); + lcd_write_command(0x0B,0x00); + + for(i = 0; i < ((LCD_GRAPHIC_WIDTH * LCD_GRAPHIC_HEIGHT)/8); i++) + lcd_write_command(0x0C,0x00); + + lcd_write_command(0x0A,0x00); + lcd_write_command(0x0B,0x00); + } + + +} + + + +void lcd_write_text(char *txt) { +uint8_t c,tmp,x,y; + + + if(lcd_mode == LCD_TEXT) { + c = 0; + while(!(*txt == 0)) { + + if(*txt == '\n' || c == LCD_TEXT_COLUMNS) { + if(lcd_curline < LCD_TEXT_LINES - 1) { + lcd_curline++; + c = 0; + lcd_gotoxy(0,lcd_curline); + } + else { + for(y = 1; y < LCD_TEXT_LINES; y++ ) { + for(x = 0; x < LCD_TEXT_COLUMNS; x++) { + lcd_gotoxy(x,y); + tmp = lcd_read_byte(); + lcd_gotoxy(x,y-1); + lcd_write_command(0x0C,tmp); + } + } + for(x = 0; x < LCD_TEXT_COLUMNS; x++) { + lcd_write_command(0x0C,' '); + } + lcd_gotoxy(0,LCD_TEXT_LINES-1); + c = 0; + } + } + + if(*txt != '\n') { + lcd_write_command(0x0C,*txt); + c++; + } + txt++; + } + + } +} + +/** + * Set the display cursor to a specific location. + * Right now this does only work in text mode, + * since there's no need for it now in graphics mode. \n + * If the x and y values are to big, the function does nothing. + * + * @param x the horizontal cursorposition (starts at 0) + * @param y the vertical cursorposition (starts at 0) + * + */ +inline void lcd_gotoxy(uint8_t x, uint8_t y) { +uint16_t pos; + + if(lcd_mode == LCD_TEXT) { + if((x <= LCD_TEXT_COLUMNS - 1) && (y <= LCD_TEXT_LINES - 1)) { + pos = (y * LCD_TEXT_COLUMNS) + x; + + lcd_write_command(0x0A,(uint8_t) pos ); + lcd_write_command(0x0B,(uint8_t) (pos >> 8)); + lcd_curline = y; + } + } +} + +/** + * set or unset a pixel at the specified location + * + * @param x horizontal position of the pixel (starts at 0) + * @param y horizontal position of the pixel (starts at 0) + * @param set can be PIXEL_ON or PIXEL_OFF + */ +void lcd_plot_pixel(uint8_t x, uint8_t y, uint8_t set) { +uint16_t pos; +uint8_t xr; + + if((x <= LCD_GRAPHIC_WIDTH - 1) && (y <= LCD_GRAPHIC_HEIGHT - 1)) { + pos = y * (LCD_GRAPHIC_WIDTH / 8) + x / 8; + xr = x % 8; + lcd_write_command(0x0A,(uint8_t) pos ); + lcd_write_command(0x0B,(uint8_t) (pos >> 8)); + + if(set == PIXEL_ON) { + lcd_write_command(0x0F,xr); + } + else { + lcd_write_command(0x0E,xr); + } + + } +} +/** + * This function will plot a bitmap with the upper left corner to the given coordinates. + */ +void lcd_plot_bitmap(uint8_t x_off, uint8_t y_off, const uint8_t *bitmap, uint8_t w, uint8_t h) { +uint8_t x,y,cur,curs,sr,dr; +uint16_t pos; + + if((x_off <= LCD_GRAPHIC_WIDTH - 1) && (y_off <= LCD_GRAPHIC_HEIGHT - 1) + && (x_off + w <= LCD_GRAPHIC_WIDTH - 1) && (y_off + h <= LCD_GRAPHIC_HEIGHT - 1)) { + for(y = y_off; y < y_off + h; y++) { + cur = 0; + for(x = x_off - (x_off % 8); x_off + w > x; x++) { + dr = x % 8; + + if(dr == 0) { + pos = y * (LCD_GRAPHIC_WIDTH / 8) + x / 8; + lcd_write_command(0x0A,(uint8_t) pos ); + lcd_write_command(0x0B,(uint8_t) (pos >> 8)); + cur = lcd_read_byte(); + } + + if((x - x_off) >= 0) { + sr = (x - x_off) % 8; + if(sr == 0) { + curs = pgm_read_byte(bitmap++); + } + + cur = cur | ((( curs & (1 << sr)) >> sr) << dr); + } + + if(dr == 7) { + pos = y * (LCD_GRAPHIC_WIDTH / 8) + x / 8; + lcd_write_command(0x0A,(uint8_t) pos ); + lcd_write_command(0x0B,(uint8_t) (pos >> 8)); + lcd_write_command(0x0C,cur); + } + } + if(dr != 7) { + pos = y * (LCD_GRAPHIC_WIDTH / 8) + x / 8; + lcd_write_command(0x0A,(uint8_t) pos ); + lcd_write_command(0x0B,(uint8_t) (pos >> 8)); + lcd_write_command(0x0C,cur); + } + + } + + } +} diff --git a/include/lc7981.h b/include/lc7981.h new file mode 100644 index 0000000..0560f2c --- /dev/null +++ b/include/lc7981.h @@ -0,0 +1,61 @@ +/* + * lc7981.h + * + * Created on: 01.05.2009 + * Author: sebastian + */ + +#ifndef LC7981_H_ +#define LC7981_H_ LC7981_H_ + +#include +#include +#include + +#define LCD_CTRL PORTC +#define LCD_CRTL_DDR DDRC +#define LCD_RS PC4 +#define LCD_RW PC2 +#define LCD_EN PC0 + + + +#define LCD_DATA PORTD +#define LCD_DATA_DDR DDRD + +// Macros for (un)setting the control pins +#define lcd_rs_high() (LCD_CTRL |= (1 << LCD_RS)) +#define lcd_rs_low() (LCD_CTRL &= ~(1 << LCD_RS)) + +#define lcd_rw_high() (LCD_CTRL |= (1 << LCD_RW)) +#define lcd_rw_low() (LCD_CTRL &= ~(1 << LCD_RW)) + +#define lcd_en_high() (LCD_CTRL |= (1 << LCD_EN)) +#define lcd_en_low() (LCD_CTRL &= ~(1 << LCD_EN)) + + +#define LCD_TEXT 0 +#define LCD_TEXT_LINES 10 +#define LCD_TEXT_COLUMNS 26 + +#define LCD_GRAPHIC 1 +#define LCD_GRAPHIC_WIDTH 160 +#define LCD_GRAPHIC_HEIGHT 80 +#define PIXEL_ON 1 +#define PIXEL_OFF 0 + +void lcd_init(uint8_t mode); +inline void lcd_clear(); + +void lcd_write_text(char *txt); +inline void lcd_gotoxy(uint8_t x, uint8_t y); + +void lcd_plot_pixel(uint8_t x, uint8_t y, uint8_t set); +void lcd_plot_bitmap(uint8_t x, uint8_t y, const uint8_t *bitmap, uint8_t w, uint8_t h); + + +inline void lcd_strobe(); +inline void lcd_write_command(uint8_t cmd, uint8_t data); +inline uint8_t lcd_read_byte(); + +#endif /* LC7981_H_ */ diff --git a/main.c b/main.c new file mode 100644 index 0000000..bd7da16 --- /dev/null +++ b/main.c @@ -0,0 +1,59 @@ +/* + * main.c + * + * Created on: 01.05.2009 + * Author: sebastian + */ + +#include +#include + +#include "include/lc7981.h" +#include "button.h" +#include "draw_penguin.h" + + +int main() { + uint8_t x,y; + const uint8_t *button; + + lcd_init(LCD_GRAPHIC); + + + + while(1) { + for(y = 1; y <= 32; y++) { + lcd_plot_bitmap(16+y,16,bitmap,32,32); + _delay_ms(500); + lcd_clear(); + } + + for(y = 31; y > 0; y--) { + lcd_plot_bitmap(16+y,16,bitmap,32,32); + _delay_ms(500); + lcd_clear(); + } + } + + + + /*draw_penguin(); */ + + + /*for(i = 0; i <= 8; i++) { + lcd_gotoxy(0,i); + lcd_write_text("Zeile : "); + lcd_write_text(itoa(i,tmp,10)); + lcd_write_text("\n"); + _delay_ms(100); + } + _delay_ms(100); + + + + lcd_write_text("123456789012345678901234567890\n"); + lcd_write_text("Letzte Zeile"); */ + + return 0; + +}