?lang_form? ?lang_select? ?lang_submit? ?lang_endform?

library

?curdirlinks? -

Blame information for rev 6

Line No.	Rev	Author	Line
1	6	kaklik	`/** \mainpage Procyon AVRlib`
2
3			`<b>C-Language Function Library for Atmel AVR Processors - Written by Pascal Stang</b><br>`
4			`(Content supplied by other authors where noted)`
5
6			`Procyon AVRlib \ref mainpage_footnote_one "[1]" is a library of easy-to-use`
7			`C functions for a variety of common and uncommon tasks using AVR processors.`
8			`The goal of AVRlib is to allow programmers to work quickly towards their end`
9			`goal by reducing the time needed to write basic support functions and code.`
10			`Most AVRlib header (*.h) files have lengthy descriptions of how to use the`
11			`supplied library functions. All code (*.c) files are heavily commented with`
12			`additional information.`
13
14			`Documentation is still being improved and refined on many libraries. When`
15			`getting familiar with a library, look first in this help document and at any`
16			`example code that is available in the avrlib/examples directory. Then look`
17			`inside the [libname].h and [libname]conf.h files, and then the [libname].c`
18			`file for more details and documentation.`
19
20			`Significant example code is included with AVRlib and can be found in the`
21			`avrlib/examples directory. The example code is organized as a set of`
22			`demo applications each of which strives to illustrate how to use a certain`
23			`AVRlib function library. Effort is made to keep the example code heavily`
24			`(and thoughtfully) commented.`
25
26			`The latest version of Procyon AVRlib (including this documentation) is`
27			`available from http://hubbard.engr.scu.edu/embedded/avr/avrlib`
28
29			`Additional Pages:`
30			`- \subpage relnotes (a.k.a. What's New)`
31			`- \subpage install`
32
33			`\section sublibraries AVRlib Sub-Libraries`
34
35			`The following is a list of sub-libraries in AVRlib.`
36
37			`\par General Use:`
38
39			`- Byte Buffering (circular)`
40			`- Bit Buffering (linear)`
41			`- Printf and other formatted print functions`
42			`- VT100 Terminal Output`
43			`- Command Line Interface`
44			`- FAT16/32 File System (support is read-only for now)`
45			`- STX/ETX Packet Protocol`
46			`- Fixed-Point Math Library (basic operations only)`
47
48			`\par AVR Built-In Peripheral Support`
49
50			`- Timer(s)`
51			`- Uart(s)`
52			`- A/D Converter`
53			`- I2C Master/Slave`
54			`- SPI Interface`
55
56			`\par Device Drivers for External Hardware:`
57
58			`- Character LCD Modules (HD44780-based)`
59			`- I2c EEPROM Memories`
60			`- SPI EEPROM Memories`
61			`- MMC/SD Memory Cards (SPI-mode)`
62			`- Quadrature Encoders`
63			`- RC-Servos (up to 8 channels)`
64			`- STA013 MP3 Decoder Chip`
65			`- GPS Receivers (via serial port)`
66			`- NMEA-0813 Protocol`
67			`- Trimble TSIP Protocol`
68			`- Graphic LCD Modules`
69			`- KS0108/HD61202 Controller`
70			`- T6963 Controller`
71			`- LCD Fonts and Symbols`
72
73			`\par AVR Software-Emulated Devices and Interfaces`
74
75			`- I2c Master (Bit-Bang)`
76			`- UART (software-based, timer interrupt driven)`
77			`- Pulse Output (arbitrary-frequency continuous/counted square wave)`
78			`- Intel-type Memory Bus (Address & Data Buses + nRD,nWR)`
79
80			`\par Network Support`
81
82			`- Device Drivers`
83			`- Realtek RTL8019AS Ethernet Driver (10mb)`
84			`- ASIX AX88796L Ethernet Driver (10/100mb)`
85			`- Crystal CS8900 Ethernet Driver (10mb)`
86			`- PrismII 802.11b WLAN Driver`
87			`- Network Protocols`
88			`- ARP`
89			`- IP`
90			`- ICMP`
91			`- UDP`
92			`- DHCP`
93			`- Network Stack`
94
95			`\anchor mainpage_footnote_one`
96			`<b>[1]</b> The name "AVRlib" bears an unfortunate resemblance to "AVR libc"`
97			`even though the two libraries are different and should not be confused. AVR libc is`
98			`the Standard C Library for AVR-Series Processors and provides functions we`
99			`typically think of as being standard C like printf, stdio calls, math functions,`
100			`plus some AVR-specific functions. Procyon AVRlib provides additional higher-level`
101			`functions designed to help designers accomplish typical embedded systems tasks.`
102
103			`*/`