From b2de4519590d06267445e1b711678511cc706e7c Mon Sep 17 00:00:00 2001 From: Dean Camera <dean@fourwalledcubicle.com> 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^<DUJEdk#15Io`PEbmPAB&HFAl@4Mc-?{@RP`>p#Px9)r1 zy6<)4f#Zz_PB$L7+<f46^MU)#2Oc*cc;0&8b?brmtp`509{ApR;CK6h|LunXw;u-H zei(H7QPAy2!FL`6+<6#u=V9=jM?rTU1>b!ba_3>_okt;e9);a~6mj=a<lRS6cOOOH zdlYl`aooKpard6Y-+!EN|8dg&$0_%pB;0$Fc>hV#{U^!ypQPM>ntK09+Jnal51u4F zc#{0!Ny>w#sSlo{J$RD-;7P`Vr<o6*W<PqG^XO^r!>4(Vp5;7zmiy>g-ot14kDe7g zdRF-8S<$2CC6Aw%K7L;I<XPF%=T%RiS3i4R^W;VOlNS|FUQ|7KQT^ma&65|kPhQqP zecABrWz*AF&Cg!8K7ZNv{AK&IS1r$9wLN>){`^(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+IJt<z5BS~-N#MuK5cyWY18{p zTi<`$_Tl5EkDs@G__XcAr|lm;?fCF{=ZDX`K78K&@$;UKUv_=`viH-M10TN}{Pg9} zr!R*;e>w8$>(S3&kA41n{L9zlpTC{_{O#12uP45IJ^kg|i7($ye))Fl%eT{CzMlE= z?aY^NXTN?w_x1aQuiq|y{eJ1&_bcDNU;Xy|+P5E<zx}xK?Z?$`KdycIasAtm8{dB1 z{Ql$C_n)`F|G4wx$ITx<Z~gdr`^S$vKYrf*@$>$VU-y3gy8q+ngC9R1{rvUd$FD~} ze?9*B>&eew&wl-S{_FRPU%y}e`u*zH@7KTny!id+<?lbQe*by>`_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)<f|NsB}|Nmcyfq{VmlouE{{xkgNl=0ZG;9xU{ zuvW~84GRyq3n+Wd@z}WNXt#uM)}0d@7a#9eaPE@v+_dE6WR2ieF()@IJzf8N%gH&O zo0pxPZSryMowm)({bxP@v$SRU*~ra{Jtk|#p8E1)>->PlUTZo1GY*y9UzT<E)YjG4 z*C!l)q>?`2zSaEOmn7e$pHnxlW_!I*_Ir@RV#A8hukN1SzW!cXnCHHa-a9tjbN&@{ zi0QI(`{Uyil)dM@iRh9zJi|EqTC}&iQ)S<c968@zTV7sX5xn|a_KMhpm7BRXCmva! zu-BvY;TEkM`caaHvi}`e-ObYQ@$ret+VOpJLf=jjnc+RZFUDi<l!=Ri@1NVd`}_No z$~*tN%{a~a<MWHltK-k_`&%x$g6rAir3t$@vbOR1>OWACcdWlY!9bR6wZQXxMdxNN zx!ZU=vi)uokDJEA3XYe>?W{s+D;~DV>=I{`>=azmCwkfQ0DJz47=yWNhefXV$zGOK zXsg!~U7px<A@hZT*Ui!wk1IvwSkCg=i)B8UD1B{$kK?ZyK@BC$Zx)C->L1fMR?PHu z@}m+Nk<XKQB_DYRweY;F2<rD(CV8)d&2&@atb${j>c!$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^<K z7~mCoq2qF(0OwkBB`KkGZ(n)|tv~8_;+eyz4946YFP6QIWei!9JX>k8p1N``^TNeP z=1nztsWQc8&aO#|1aIwH+jsrriM6|4{nZMn<S>7;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 zPR<?Q>z=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;}!!<T-(Gz{4 z8x7)%E~qIz+PK#B%kBp=a<)4vGc`DspPns#yh4uqjE4Q?!h4KgryS^+`_?P6M~+SP z%i%tjjpZV@=5U=n;jSl}rx0Zo_p-vkzHvf+|FOhG$8#5%e?NGxVi|Lu&-~Ki_g5w= zm%H?HW&||*RehSgfM=<OyQf#sq(@e}UoY0$x!Ks|X^*9dkC^aO<!wzjnuR)88af|I zEIa1e*FAC7l5!!(o)n4CGfwy{Gn#(#Oq$tdnZFn2iG+LlKDn}~wti9{@BOLX*}gux z7lY<K-f}}D;hoovyP8LNUmFQ9gngcS`s1@LaVO?%Te>#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|4Pm<yr_BDxk|BEdnTw=bVEP*A<^HEv zUf26Hb;bXT<KL9FaHPr{T+`|r{$^j~j;94@l9?6noAfU}=DJC+@(~MX*u}-6J^u?z zt>VsdMC?}%D_fK_?d?nky<drJTido}tyT4S)u3i_{nP3R{{z<A-&CJ;bKdf8;yc%t z6m?I$TeW<<{zZ04C4q%nF^}aJDZD96SF?Y-S1?d>il2`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<aVsGYHYbF2El z!(uuf8_(Rb639BJSGiXBV_{0mil^H)9+UX@wC?=Pc!l*()-$PnaL_YlP_^$l^($&^ z;g1x7xmxc31K$3AQ6y6N@Z_YD(`s*voK06h`!ZpNg1FJ=!w>#!ysq_p-;E`TMf1E= zoeuhiMQkgMd%42#U);6r2Xg%<ayO+oTK8OBDJse{`9@0BG`)4qGZ&UT`6(z}&wgC= z;>Mzi96|ZwbfIek-RpJ=vVAhjIG`TmE_~`uW~r;@w*LXwr1NjAD%O2I|B!OvAHVCb zbRPR34xU_EG~q$()e338hTaSFd6hT}#jIm5xakz@v0bii{L<q4>NBfP;PW`I{!5Nu z<Cr)U7WzuNNElme-{tq)w?=FERNq)Xp1Hd>{tJn|^y}#NxV_>H3@txfn0C603MhOi z`FO=uYN_fH@tY@B%`2=~^ncy*5X(nd?+?sUy0y-4=}w&&h4L<fk*_OuteK^1soj2+ zd1tEL%~*j{<L4V>Gb_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_AUE0t44cAWk<Tid1*6aMk~hBW)G&i757CJaqG%j@wYT~*`4#&6}6bK$V@r? zzTYk7q95CWpS-OJIcOxc>BocbSr1t{^ZyH<))NpvCsA9JdhWQXQ0*%pd8MoGYqy=f z!<J{V<jeB!`}!;X@pBlf?_BvU;`K6z?$n}vDuQp#W#4}n_&7cPwJXEo2dS)voI%U# zvo2L_Gc5b*;*lLv)4r+dq+^D}#D+^78~83Z2yc(O^<7}^0T!_pn#aB;tTV1=EA;3$ zGm{T4I?b3R?$~rDv5B{_X<BQ-*Y5(a6WEV@Ybq@A4QZ-8u`!7yvE-wP1&d-yL2Hi4 z!)A`6hL-l~&+Q2U8jWm?obn4=ikV6xokC9^OkoN%>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=Co<O-GhLZhe0;RNh($ z^h}AUe6E$EZnJEfOvUx)vK^t)PCSi{LO%~!O9`=f222#IoG3AKqSVfb5}Yi@uJ*4s ziQ3lUeNH^L!F<BP4BrXr{oI++(n4I9b_iZmV3HDIxIIB=-+zGu1y5gw9|_kVl%CvJ z$1IqCnJxCeK=7G`RXUl~QPUKQAM{8Ya;@AU$Iif~age`4z}R}F*R16+tCAaJIlQ;D z7iF2%^xl{xp2#RRUD4qKpZY~Mfdz`H3Va$9dF?k$y}Be}>Tww*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+p<e=QGSBC(-ZGDGDp!XK zgZBo%Hw)O#I&)+@^1RHH*=ISk_2d*;Mo!@>1&#wehMt0716aS!RNS<IUyZSV<<w+> zEP-bmm@X+!i8SJowqmennDhStU#3F*%n7Y+k%C7)Oq2>@x%y$A<VODf1?{W_lT{D$ zH!AdKo|<Z!CGaDFGkc}XgO$3k6j)6(ocBoDJ4~3*DmZ`X0>1qb%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<M~6js}e#}1oA3xxw9p(sznJL zI=SqGA!EyjdCwm(>;Ia$l9g-WP8NADfsZ$BtsZc_b66s9kpJa}@I_T}^BI<jInLfT zbCuf`M(ytjR|6VFwU$n8@CZM(Nbgn1se*-RWelYOyq_=d3vc9q?ZD$_ut>Uy;eLY9 z9nQ6@x2$EoxWKAP;PHjEr!P*|a9JvC%ywj!z<w<Uxdiro1$<vFtm2-?|G|N8M+4jS zpUQy?_*4ZKFl()^J+l6<!os*+eyPl>*KA$HdU5%N&x|FUg3Q`ZP5~S{C-6R>z?Zs; z@9_rS6%*KP{yVI&Q({<fV2x<wB8k;ro2mrfT&S^b<(|_y=gh;|X1`X29_3hkvx5Bq zbMS{1let(e8#cQwVp6vj@_Dty{<OPS^@6N2hL{DqUp`Ddoyhpi((vl6E!rRE^Gw{d zU6P^BfnT+8dHiaxtZIRdRdWP)E#x}2fUl}#al@v{({jommZ=o3l1^ffO<<ZJy>pWF z&MDD5CrdMlSMPWsxWjbCYQ1msEPgF=J1uP_W$(RUL*eS3F9R8-GHh3PxJG&r%T)oP z3kz6Rt(G&;63~6Mt>oa+<mhdO7BBU?%Kf2o_X9zOfQHuFH|M@%<Ty23@FxRDME0KB zj_X5TtUvG8%3?UL?zGCvfNAmn1vVsB*@|xWQc2)><|QO{d&lMp`xFwn^d0s-S7bVU za$8-LmBWKwO<f+=pXYh(lo3v-KVM<XeSkqB+C|iX%O+az;DX6gO1qT<cYorR`<pFr zh|~GYv9)>G3z-d<F8s;Pr?@?fiADPY1G|j_djaP<ZlOO3><6YRp0gIZXuVf>&%x(A z7p`8VE63w)z3SlUhqI@=SbbfY<=6pcwKuL@57;(k3f(A}{^s>QMaKQ6Z)C+T9R6yx z<MhPY?24^3zb|D=<iD|6hChLm`Hl58LtdK)4C-&JMHx8CvW5Ny%#@zQve{cm$mZxB zLxwn?UD8sF1s~@5><->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}~3oDfrkIwaxO<Aqm<aO9FTj1L%nW!_;GTHI*2U?Zps7;u}Ww&A3US|f0 z0`|KK`{Wn$M_x#OtH^w&K&ag2%;k$`x>HvF6j^%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$mM<E)|S}Y+iGv`n0tGd?M;gf-0Y70 z%^z+!3GlN|RG)U5DdGCT86R%w1e~9-H0bgJ&O8QY)d`HE42)TKG#A%0F70LQaxdWN z`FrP)?Y$?l_ny_>dm$@$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 1f9a317e6..eb86d611f 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 a9cfa7641..23fa08b4c 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 @@ * <b>Subsections:</b> * - \subpage Page_Licence Project License * - \subpage Page_Donating Donating to Support this Project + * + * + * <small><i>Logo design by Pavla Dlab</i></small> */ diff --git a/LUFA/ManPages/SchedulerOverview.txt b/LUFA/ManPages/SchedulerOverview.txt new file mode 100644 index 000000000..3aa151750 --- /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 + * + * <B>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.</b> + * + * + * 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 <b>does not need to be used</b> 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. + */ -- GitLab