From b2de4519590d06267445e1b711678511cc706e7c Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 21 Jun 2009 04:48:05 +0000 Subject: [PATCH] Add new temp LUFA project logo to the manual. --- LUFA/ManPages/LUFA.gif | Bin 0 -> 5474 bytes LUFA/ManPages/LUFAPoweredProjects.txt | 2 +- LUFA/ManPages/MainPage.txt | 14 ++++++++--- LUFA/ManPages/SchedulerOverview.txt | 35 ++++++++++++++++++++++++++ 4 files changed, 46 insertions(+), 5 deletions(-) create mode 100644 LUFA/ManPages/LUFA.gif create mode 100644 LUFA/ManPages/SchedulerOverview.txt diff --git a/LUFA/ManPages/LUFA.gif b/LUFA/ManPages/LUFA.gif new file mode 100644 index 0000000000000000000000000000000000000000..885f5b00053263c9e4e28956a2eb0c8e4983a586 GIT binary patch literal 5474 zcmZ?wbhEHblx9j~_|Cv^p#Px9)r1 zy6<)4f#Zz_PB$L7+b!ba_3>_okt;e9);a~6mj=ahV#{U^!ypQPM>ntK09+Jnal51u4F zc#{0!Ny>w#sSlo{J$RD-;7P`Vr4(Vp5;7zmiy>g-ot14kDe7g zdRF-8S<$2CC6Aw%K7L;I){`^(P^H-hEUw1u!-SgsQ`-@lYFJ5)L zc-8shRo9DG-7jAEzIfI5;&uOv*Arg6p7`?3gqLq7y?itI<(nxl-%fk=cKWL~GhV%& z`ReVgS8r#(dN=#^+c~e^&3XN9-kZ1c-n^Ut`rU%p?-#v!xA5(|MQ`3Oe)E3GoA*oK zykGYA!;&{2mcIS4{N0BYZ$GSj`(f4F53ApOSo8M7+IJtw8$>(S3&kA41n{L9zlpTC{_{O#12uP45IJ^kg|i7($ye))Fl%eT{CzMlE= z?aY^NXTN?w_x1aQuiq|y{eJ1&_bcDNU;Xy|+P5E$VU-y3gy8q+ngC9R1{rvUd$FD~} ze?9*B>&eew&wl-S{_FRPU%y}e`u*zH@7KTny!id+`_G%-f8PH7^Zw7D zH-G-T{qyJD9}xS)pFbb}{{8gl@8>`NKK}dn`S0H^fB$~{`}f=5e_#Io`}+6aw}1b> z|NZ;p-@hOK{{8&-@7KTozyJUL^Z)->PlUTZo1GY*y9UzT?`2zSaEOmn7e$pHnxlW_!I*_Ir@RV#A8hukN1SzW!cXnCHHa-a9tjbN&@{ zi0QI(`{Uyil)dM@iRh9zJi|EqTC}&iQ)SOWACcdWlY!9bR6wZQXxMdxNN zx!ZU=vi)uokDJEA3XYe>?W{s+D;~DV>=I{`>=azmCwkfQ0DJz47=yWNhefXV$zGOK zXsg!~U7pxL1fMR?PHu z@}m+Nkc!$O8kageXE2Oqo&2H9r}om_ z=ZmB-y9ykitJSEvaE9{4$^|pk7Fs@^=qR@3oDh@Gs+Y^$xC&g%KGjarEN0;`oYN6G zr9#Q^_XVaGMT{%{FYxV^Hqx53_?=_aq$P98A~YQr%(?J-!x1-*L&|KOiw`xhZt^k8p1N``^TNeP z=1nztsWQc8&aO#|1aIwH+jsrriM6|4{nZMn7;p-7`6NT7kq>o}v)Lc5bOjJ^k4 z1LiRwJ1%s9hl}UZ!Pk}6LOb}EFW=BAu}x?5F2SCMHyuK~)E(tI<~biOk$e&)U^n;3 z>N$*&7iJ5cWS{j%@YJi7Izp$7>z98pHVau>y2JR#qjc6wN3FCSzaG%OyXSxG<~1cc zeKD)IsSE#kaP7t4Q|A>VFRcB(Ozgq`#urv`A=SCJ4n_4C-t6>YXOt|Md}K?tUo}f< zRZzRj*L#=#-trZ4OMYiL$-d#$o7JayFXTIZd=r=?Cmg+4sd!`3=l8d{PUU`he&_G2 zPRz=UnN-W_MQC$4PYK^u}r*Y3E-+~iwZeE+0_*5bG-R{Dvr-ECLT`yn1kimP0 zcYxjeg8Gt6dgnH#&u95s%yZ++Og%fV{_WzG?voe0|8>6>AHPyp_rp8}(-Nit36>PG z&q9tr9OYk5ITg>uc&9|?L#N9{J@?DnH)ekNzEj~PGoP@;0uIR%23>~_@-DAsig;Qz zN|$(9v1oa$_Lwg7Ph+jh*W~kmEe<(;cynI)@8{SF|2LQ&QrdN#^{f;}!!#swBcRO*9-s4zYI}`SL<9- zrM6PAr0Dr1>61??ublL2t}$r&(6gfOi{{~U&-B7|DRRXI3PuijnaQ%;8kYH~=kg^> zta)-Z96K~FPAj^i@Qo{)OYUW$qZ)grdCk+JCbb~TJj3SV(*a(gzxoZ_Iv955tUO%s z%I(>kq5$nfN(!4#%4qeuEO@Dy;pXQh+mhw7@PXtiukDR3OPbP|^d>X}eN8*x|5vB( zlGI&SNppYuM+HlmnP0ta*>!GL$RZZOCMJb|4PmVsdMC?}%D_fK_?d?nkyil2`7&udR@KCG(fjZSS|srX@+ zilk}B1O^SmIe9f@dyQx7PrV|pF^emu^A?Zh%`@9B_MI}@@2~yx)RxmS|2MVBS8dR& zwsYudJj1w%qwa>8_zj2UZeoRJRM(cwkP>>`#J*eX;fJCf)q?MrZC#!ysq_p-;E`TMf1E= zoeuhiMQkgMd%42#U);6r2Xg%Mzi96|ZwbfIek-RpJ=vVAhjIG`TmE_~`uW~r;@w*LXwr1NjAD%O2I|B!OvAHVCb zbRPR34xU_EG~q$()e338hTaSFd6hT}#jIm5xakz@v0bii{LNBfP;PW`I{!5Nu z{tJn|^y}#NxV_>H3@txfn0C603MhOi z`FO=uYN_fH@tY@B%`2=~^ncy*5X(nd?+?sUy0y-4=}w&&h4LGb_vE>?Y1I&v;fTwq-xRQjgvXnOK*6ll^`i3ogn1Im*1!{gGVm zlU|Lv);`laF84aW?z#~*^?=_ATY-rUtHra^*#b*jd6QCaxb3Vw@4ahlWk>GmwXqFm z?jE`=3FS$w45uz{dQ_AVbNS^q%O@u@^-r_=pF9-){=>b;O)rEt@f!2&{OF!kd}!+B zrDn!A_AUE0t44cAWkBocbSr1t{^ZyH<))NpvCsA9JdhWQXQ0*%pd8MoGYqy=f z!u?FooSb=lVxIDeO4g^9f0(QG zZf+8|*p#NBUeKXc+^Qj>Ec;nZ{BKH>Z$qK*!q!v&8C!S?D@+vX6%9Ew%3@qO1l?z} z)Xz{m{aokVG#N&N;OWbK`NY#jIT#+K3--;BnXp5ky_}&(Lnu0dfkTa9wgcbW4c&Wg zbniRS-QU1CmqUF@xc<9s&8wTb!b7^$)Z2J3cAY)gI(NC^;~=5Pgznd=3?%}bcW(6F z`_X&v1{<4skNcsvi=lSmH`4mH$#|HDo=lgC3>UmmA+vskz=CoTww*4S`3?Wmw$f4N?+0 zI;M$jWctZ2clyHwMMi#`1D!lfEI%rQ@|vb!VQIDaTos=#@NawYS<}RhkRCz9{$qjt zoF7>xoK)x#P*R@A{Y*_U^#GrGBfrmtS<@`tWEprX%ek}E7_>jsFgfzq6$IuVnDH-w zS583V@`fqj!i2&%^h-WseC8nZ=L1{eO2rC;Zuvs4qKesZER07p1z!Gt(6nI*=NwI5 z%}yEB3%u*tBYS=dEa7BW)+tck&?{BM5s)c(?gFFCAx?8+p1&#wehMt0716aS!RNS zEP-bmm@X+!i8SJowqmennDhStU#3F*%n7Y+k%C7)Oq2>@x%y$A1qb%hIZrrJdpx30Nw{ z#Oi!Y@b?04sSAp34SZ^e)BU}Ct1JZ`PMA~kGJ$C!|4N3r=Bcc&r|@}yShS{Kn$&+G z*5Uy62~sO3S*@HBwQ`!&%B+{l0SdfpIt9Ni;8ve7;Ia$l9g-WP8NADfsZ$BtsZc_b66s9kpJa}@I_T}^BIUy;eLY9 z9nQ6@x2$EoxWKAP;PHjEr!P*|a9JvC%ywj!z*KA$HdU5%N&x|FUg3Q`ZP5~S{C-6R>z?Zs; z@9_rS6%*KP{yVI&Q({pWF z&MDD5CrdMlSMPWsxWjbCYQ1msEPgF=J1uP_W$(RUL*eS3F9R8-GHh3PxJG&r%T)oP z3kz6Rt(G&;63~6Mt>oa+<|QO{d&lMp`xFwn^d0s-S7bVU za$8-LmBWKwOG3z-d<6YRp0gIZXuVf>&%x(A z7p`8VE63w)z3SlUhqI@=SbbfY<=6pcwKuL@57;(k3f(A}{^s>QMaKQ6Z)C+T9R6yx z<->qu;u&gO72;^(rRQc|4(2Q-f(Q5GJ{+Lr?!mHs|76QU&)mj z%oWhwTX9BK(qPwRr9Gz}&VF-po9K+gVm;eV2{Nv4II(xL@&^TW`Gf;^Co|X`;9e0e zv}^*Cj1j}~3oDfrkIwaxOHvF6j^%i&hh#+XCi6}zG`o9wkiHFfkQ)q zvG0!oQv#!x0QZ3$A>KQRGi!v5d(O2Aop+wRHc4}f%WRo_H+R4N%$=3SP`g3ka*vAE zW8NAECcz8mUpg^}ePEtxaPrE_Lwo<6)=)gd_4ly0!$p>f>(Bh(xN7Gg{-#xFq6_vi zAKbfviOF%#MfV`fqYUh74vbsg7%(<4C~jbx)o@Am;t^S=bDD+c^w-K**9yp=mbr9l zd*>|wpVbRYY>sg$UUA!Gf3JbVZ~>!G!I6iXu1FkUDrDd>Un^9!N0Gf(h_m+UkJr17 zN1iyrIPd*T{&}klS~}I=*qpKtxX!eZb=vP66J&2rvb{Mamno9rD$7LfssI+%0!D!e zSBixg*fuaIDqLT=;eetcn`XexHL^Qb8(dIX$mMdm$@$uYr4V0h@mVliC8tYrc$v9~jsY7?g73zxOhTI50{sU{qsZ aiCn<3bOF!9x%W8cJ>c5+;JmB=gEatgm(@i8 literal 0 HcmV?d00001 diff --git a/LUFA/ManPages/LUFAPoweredProjects.txt b/LUFA/ManPages/LUFAPoweredProjects.txt index 1f9a317e6a..eb86d611f9 100644 --- a/LUFA/ManPages/LUFAPoweredProjects.txt +++ b/LUFA/ManPages/LUFAPoweredProjects.txt @@ -22,6 +22,7 @@ * - Teensy and Teensy++, two other AVR USB development boards: http://www.pjrc.com/teensy/index.html * - USBFoo, an AT90USB162 based development board: http://shop.kernelconcepts.de/product_info.php?products_id=102 * - USB10 AKA "The Ferret", a AT90USB162 development board: http://www.soc-machines.com + * - Benito #7, a no-frills USB board: http://www.dorkbotpdx.org/blog/feurig/benito_7_the_next_big_thing * * \section Sec_LUFAProjects Projects Using LUFA (Hobbyist) * @@ -29,7 +30,6 @@ * can be incorporated into many different applications. * * - Stripe Snoop, a Magnetic Card reader: http://www.ossguy.com/ss_usb/ - * - Benito #7, an AVR Programmer: http://www.dorkbotpdx.org/blog/feurig/benito_7_the_next_big_thing * - Bicycle POV: http://www.code.google.com/p/bicycleledpov/ * - USB Interface for Playstation Portable Devices: http://forums.ps2dev.org/viewtopic.php?t=11001 * - USB to Serial Bridge, via SPI and I2C: http://www.tty1.net/userial/ diff --git a/LUFA/ManPages/MainPage.txt b/LUFA/ManPages/MainPage.txt index a9cfa76414..23fa08b4cd 100644 --- a/LUFA/ManPages/MainPage.txt +++ b/LUFA/ManPages/MainPage.txt @@ -5,11 +5,15 @@ */ /** - * \mainpage General Information + * \mainpage * - * Lightweight USB Framework for AVRs Library, written by Dean Camera. + * \n + * \image html LUFA.gif "The Lightweight USB Framework for AVRs" + * \n * - * Originally based on the AT90USBKEY from Atmel, it is an open-source USB library for the USB-enabled AVR + * For author and donation information, see \ref Page_Donating. + * + * Originally based on the AT90USBKEY from Atmel, LUFA is an open-source USB library for the USB-enabled AVR * microcontrollers, released under the MIT license. It now supports a large number of USB AVR models and boards. * * The library is currently in a stable release, suitable for download and incorporation into user projects for @@ -19,7 +23,6 @@ * library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package, * from the the WinAVR website. * - * \section Sec_Demos Demos, Projects and Bootloaders * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. * If this directory is missing, please re-download the project from the project homepage. * @@ -34,4 +37,7 @@ * Subsections: * - \subpage Page_Licence Project License * - \subpage Page_Donating Donating to Support this Project + * + * + * Logo design by Pavla Dlab */ diff --git a/LUFA/ManPages/SchedulerOverview.txt b/LUFA/ManPages/SchedulerOverview.txt new file mode 100644 index 0000000000..3aa151750a --- /dev/null +++ b/LUFA/ManPages/SchedulerOverview.txt @@ -0,0 +1,35 @@ +/** \file + * + * This file contains special DoxyGen information for the generation of the main page and other special + * documentation pages. It is not a project source file. + */ + +/** \page Page_SchedulerOverview LUFA Scheduler Overview + * + * THE LUFA SCHEDULER IS NOW DEPRECATED AND WILL BE REMOVED IN A FUTURE RELEASE. EXISTING CODE SHOULD CONVERT + * TO STANDARD LOOPS AS SHOWN IN THE CURRENT LIBRARY DEMOS. + * + * + * The LUFA library comes with a small, basic round-robbin scheduler which allows for small "tasks" to be executed + * continuously in sequence, and enabled/disabled at runtime. Unlike a conventional, complex RTOS scheduler, the + * LUFA scheduler is very simple in design and operation and is essentially a loop conditionally executing a series + * of functions. + * + * Each LUFA scheduler task should be written similar to an ISR; it should execute quickly (so that no one task + * hogs the processor, preventing another from running before some sort of timeout is exceeded). Unlike normal RTOS + * tasks, each LUFA scheduler task is a regular function, and thus must be designed to be called, and designed to + * return to the calling scheduler function repeatedly. Data which must be preserved between task calls should be + * declared as global or (preferably) as a static local variable inside the task. + * + * The scheduler consists of a task list, listing all the tasks which can be executed by the scheduler. Once started, + * each task is then called one after another, unless the task is stopped by another running task or interrupt. + * + * + * If desired, the LUFA scheduler does not need to be used in a LUFA powered application. A more conventional + * approach to application design can be used, or a proper scheduling RTOS inserted in the place of the LUFA scheduler. + * In the case of the former the USB task must be run manually repeatedly to maintain USB communications, and in the + * case of the latter a proper RTOS task must be set up to do the same. + * + * + * For more information on the LUFA scheduler, see the Scheduler.h file documentation. + */