From 8f7b0919fd05e40bb0443230ab24b939ecb784df Mon Sep 17 00:00:00 2001 From: jzlv Date: Tue, 27 Apr 2021 12:29:58 +0800 Subject: [PATCH] [fix] fix docs --- .../doctrees/Linux_quick_start_ubuntu.doctree | Bin 18830 -> 18874 bytes .../doctrees/Windows_quick_start_cdk.doctree | Bin 40319 -> 40347 bytes .../Windows_quick_start_eclipse.doctree | Bin 41249 -> 41277 bytes .../build/doctrees/api_guide.doctree | Bin 104783 -> 105458 bytes .../doctrees/blink_demo_introduce.doctree | Bin 7397 -> 7425 bytes .../breath_pwm_demo_introduce.doctree | Bin 11902 -> 11930 bytes .../doctrees/connecting_hardware.doctree | Bin 20760 -> 20788 bytes .../build/doctrees/environment.pickle | Bin 65200 -> 65284 bytes .../build/doctrees/get_started.doctree | Bin 8776 -> 8804 bytes .../build/doctrees/index.doctree | Bin 7579 -> 7607 bytes .../uart_loopback_demo_introduce.doctree | Bin 15966 -> 15994 bytes .../build/html/Linux_quick_start_ubuntu.html | 4 +-- .../_sources/Linux_quick_start_ubuntu.rst.txt | 4 +-- .../build/html/_sources/api_guide.rst.txt | 32 +++++++++++------- .../build/html/api_guide.html | 32 +++++++++++------- .../build/html/searchindex.js | 2 +- .../source/Linux_quick_start_ubuntu.rst | 4 +-- docs/development_guide/source/api_guide.rst | 32 +++++++++++------- 18 files changed, 64 insertions(+), 46 deletions(-) diff --git a/docs/development_guide/build/doctrees/Linux_quick_start_ubuntu.doctree b/docs/development_guide/build/doctrees/Linux_quick_start_ubuntu.doctree index d86d49e10dab35adaf3f3918dada8397e9f24fa2..41825734cd5c8fb54fcb67134e233555eb1eabc7 100644 GIT binary patch delta 153 zcmeC1%(!bZBTED8)b$%#Vi;92U94i9@=Mdw5_9r>5|hG%W0G>>bCXNsi&L`Wi&Aq^ z6N^(fXE45FWr<~EV3_Q{D>?ZF$3AA=qO{2d9NpLiTQ*B_ZD3?{oP3IV3oB5aLfvFR XKB>twc`C7p6-}1p;@h0Wr(+EOpC2*( delta 98 zcmdlrnXzv&BTED8)aH#WF^n9(ZdNfxsRj9)TNvN5GDc3m!*OeJAV(LR)jYX@k8iU# n*CIwn+sW^^w=mXC{=g$OnUAlCBZED5N`_bjlJI6ezBSeW=?NpN diff --git a/docs/development_guide/build/doctrees/Windows_quick_start_cdk.doctree b/docs/development_guide/build/doctrees/Windows_quick_start_cdk.doctree index d9dfcf5e1c5f971fb6251a1848d1117368840b9c..75fa287f7cb219ac6f479202196e656e1b8ed812 100644 GIT binary patch delta 57 zcmeyri)r?5CYA=)sS`G`^f0PqxLCzF<(H5|hG%W0G>>bCXNsi&L`Wi&Aq^ N6N^(fw=m9~4**}171;m) delta 29 lcmdmch-u*=CYA=)sbU*hDi}Ee+^k}XQVa4oFJPQI9{`?B3c~;Z diff --git a/docs/development_guide/build/doctrees/api_guide.doctree b/docs/development_guide/build/doctrees/api_guide.doctree index 5e19e84c892f006ced0130ea4197cbc622068dae..ec7afbae1089edf55b4a03295d9d853316c219f0 100644 GIT binary patch delta 4966 zcmeHK`CC*+7WH(~uTfA$0W|_Pic3@k5toEPqkzE-#6}Pi6$03T8;IC0K{lgNT+;Phox2byFK%+DNLHd{X>YQ`8s$13dPHvMP zD3V>Cu1H^E7Xk0MkavgoOE-@il{hXvJTYlV)bONn3FDK^37I3uCQLMqGbLu4a^?Pisy*!neOPD-3)&Sb02ZK^#Rxa$C`cA_cMJlqMl4>qL3gV`ra5zhDQ%>U1?w`|u}006J*>*)^t4fwxmto7EPC_A#7U#m(?lxG`$k9i4Gv3)j!g)O=xa6Rw!K(MrfW4h=r!^km9&^7 z)TxDACaR>x()^bp2)ZmEF+L+097b-|^ZW0rsu4f&x ze_^VAL}991?B7kp=Y{WyzniAEX`27PrjdXa7fwo|8RnK9Q+{yNJCxXvo3ua$14 zwj9&CKFhe+j;+crmu~anJJmyXwmD}F?y$(*3h6E{;vSgrrgw6s}*JOmU;w5oX zeF4}puVreQat{^@G++gVWoXDEi+++C2|m1JWGD8tqA|OF#eo@%k0F?OY)wJ1JZq~L^r0f~IY*I~e4u13@ILdE zQxM3V8JHsPK$M*JeIi)YP7ii_`*k+7)Yh33b5!<7!-S8$tg5)pl2>-@i4v$+5pzQ} zZ)+M`|F6v$!78@9%M*6~0VJ@v(sV?zA4`Yulw0o(wU#$~cP7Ty6dJfE3>oswJ@G&$ z^DOVk8tx;>EaF75ssp{4@qh!nvu~a>SwLfIpt2t_r6~f+uYt15&Pr1Sw5$eNxj$2y zCZJ*~v;rTq+Xqr$X3+JJEZF7*WmJ@!vi%^j&T2&yKm3Rk2#BU<@g`p)kwJlAIdULsZ&*cED$*i$Bmi{ z%Q{Xyo{JgkBs4qm4Q9z@CxW4$Eo>G!sjcHxaTIget%?#XU|*hkDlHV;{c3+lPl-+O zwkBc$d-c;g{UVDYl{vyqF8le84og_^*+k4@&gb@Ht$g~N8?c_;I)4Ql+3{aXu$kpv zxP>ij?8OxR{`19QSWAhiXw4!oeT{AMqf0G-?^&ZO2lP9H>z$2RRYh~&R~w~LG1joM zYnHmM2BMVV+6Zh@i^;jR8vA6!Z%v^u6T%M8YB9#&*XR#e$5j>H%(Ie7N5nXz+R??z z8`4pM%&A4JB_3hEH-=)L>VM;n%{V5<{4o+Z!AfsFMg=RmbyPYnEdQ*w+;DrZ{@(&= z)P&{V?rE8*)9l0@6OO4~qV8_SFEZ}6h5nq-1vF8!48DI-|EqN@vJ9%)q`xf2*-g}g z^}UDc`m(MMuIjG{ys#P%#AP=9p$WgRs}GHQUAsLBv$pt(N16Ct4cg`LXxxyOJ#)el*r7AHbKI|px)<>wm&$Il8F4Q;|c158G(A-dauxJ$) zs+C4CnE1@D!N3`HbptmfsVSsghxgB=tSABXiQ^VVTQkQ*%j?| z`T$|z?W%4_#k(cuY0-nWdcvgf*RcH0J*j&uV{@CQ})f)l-yj36oxKpZ|HLwB5& zW{O}P2>mRF$01_6M~}$g;VYjxYb40 z4?#Hf8Npq9(Ull5Nb)FBpARg~7nVqq6s9|_hEI?D%GbzQa!8aou>(hp)fVl6(e z59KF^3Zz?rqBvZW_6tRU1=u(YGqGRs8IC5vL3(clWa*&bFIf2W5s;L(OWWL}oE!8uBS5`TlOM(%{s8cf5p@L2&V-HSI!ARVaeiHuXk=H0o?^mQ) zT97WJp*|fmA&(4Wp;ID9VGyL#LcG&f9LU`{rXoUfM6_NgtxDzl?u^oIH2wm$&EQ9m z?^u4kNauy+Me<8Ve_Aw-_uC}_w5O^JOWd0itZ`e6geOIg#}MhVQ1pI7!7td|sa+b< zq$@%&_zi(beXev>kmKGU6@CS8#J@0T?*yb+lDJ6Dsc25Y8GHksQ8$pdd~ZjkVw{K> zpfg$g%m~azBXQ|YhW@7TywTmVcfK<7TJ8#@swUPKS(aLqzLOCJ+@qo?_+F|KA_I9% zLmTq@7_KyXDnDf(P{cIsk{$~3!x~bN9tpr?0UBo^z+(QE09wjvzi5*3kgm~bDIy;p?5#asv^|e=_Vh9j z{WbPlzJ@I*A)g;u4pfSg#^E%#EDqPnT9!G37E-mY5jwpFWaE8Yj rTg}C~nloy=4JVfZd>$)^r%-80ftOq9VXw7G;jTv=_x9BIbM*NyVS2zN delta 4613 zcmds4d0bXi8uq!sy(-Eoh`~pQYp4mLBS9L35Dbe5DufDB8J}68BI=-s5Tphwc+lg5 zJD660c-5N=uDRfn&^qX#xPWVfsF_XVoOAET_H%yC|HB{L?>x_Qp7%ZHzGt~jig;;{ zXuQ~DHOh=b(0R1K=j7SbW+uwXxG_s80y#X_xu@%VS2rj2H`K-HPRWtmM#|DOu=d=^k4dYLytN$viRn%9<2zLWI#>W+BbWVx_OqC%x6Rklaq00pQ17)Ng{EbZ_3%f8Q8m7%UPN# zn=s$fg)t)yj252_qpom?rgCx_ny;6plx{@=EauBcj@f^7kER!fYHR`77PU zUm2I!!nH(iB13a0aJv#zpean{yUI@npJ?7 z`NEG3TN4e)%hzNA0e=N07KReaM!v#;ext5Jipzw;`5v$U-<1as4Dw;?%qC zD6)C|HnB5DQ`%6Gn#AHIvSNb;OvvU9t0Zv2>aNty8P+7IAcE(*wZH~2CCbMA=q@L0 z3NV(;x$2-PPn>+W?FlSN!X`U%efutQcKb_mVWAAkzD**}*%1lo$c4||VKzf|UKR#` zlwmXp+!Y8Hne1vd#$b|H5-hktdr!ut%LP}iaU^A>rEr(yc29sbf?HnhrbR9L2_wlD zd!E3HY?b3BF9TQRVofd`nnY6f7L)yDI{B@AGeADyV@_XlX0b2q4;9=sUr$9rkldui zK?>o0le??FGY{OB#v0mXdxnwRgXM@Ip@-t7h!)hvTE29sGf2b%o&5OlU69Cw=H$VV zI0TW& zv!vjRCGn1C(|a--38eYtAu*8)(q9nZRJAyhQ)^$K`kYP@XK||Z1?t-AT+Ajj&%{e= zTsJeqXYJvc-O?Q1!H^h!COFrdG@N}?tXq{+rxX#N^F!pR6{CP@){(vd{Uk0_Mtj7c&HD9=CqmTwP<{m0p-j7FLD{(+w~DQDvHt0_xTmy~*mT z9Y~d5|JD~sBa6SQlhS$DTyt%@a=%|9WpSWd^BVo5Hdj-BD3d0n2`cY{IZP&+4~AkvH771`d$YJ4bPdB;GB@F?qev0DHr1mWx8WkW-WV^bf)azf#Z!^!ANmVlw?rsLrM$4IAEa-&&u}Z%{m7$B_@1nI z{Db&Uj;0dJKeVytKKT>XWaY2%l1dD>(sH(V8jMOZBFwPJr*~C@c``c{`l9$50)RDcRv(;->b-$ioAr*ceL%se#MNt<@CiR0+$4W+=Z%=nwHvPCez(2GE#paG)_= zkS06_z19V%#ZCfa`%yP@c<{}EHgrWAKod-HQWQ8B(Z;28!zmb1@9wA*jX9Uz#wD1+ zlCJB{{^gp%ng8lZE6iZce_7E6GmL@>9c+$xmKY7OfgLS2$5Kh+Hs#jDC&^X`x4a%{&evSn#WP8y<3RGb|Gga>NH@OkP+f3t%H zt+PWiT$D+@Fu+6_%=LY3)X1A1k!^%m=^$rJgA2`b#wG+(*FJcRAlk1lzC)<;tS^F% zr7+%0w&68LYd?aC68{PWNZ}f+O@BT+Z!nP#9)ub(k`w)@+aUPT@WCh(qc|{%1M0hX z!9?Z5A=qdnMH`&?O!RldMnRmcBGlCxJ!p+P0uahGdzst~ccRmVBMV8&{o$||q+~AK zXR9uRy^-m(a3sQ{c^b%5@}u4!h!z)c#FAEd8ea8H59EmpIXJKdtfy-|;f_>#!4vV4 z+JX79eOw9gLJvr3hDbcgMX$rs80j?E8zD%dm2q&TWt_XV z8}GBd73FSPQj!|S#*UAlo)2NgP{`A8z)5O07CQQSD8`VgWEi1XrJ zPRZ@4h)A}_!wzI4UJ1;dqTCrOg)e4li-RfEeZA+ zvJbV&qdCX`ZqUj!IIyn|YtW*3Y&W{ayX|z)a`2hYa=4=u%*O`cF7-&kUffrHPGLJK z9?-@GI4J(i^`Z25ieZU6EM#8;o7X4O$W*wC4V<0U#ww|B74LKKB@Q}M^F^3Jljp)* zS+)rNK%>I)sesgENJGtDNr$UYE0C=PJ!o?}eA$-olfljn^#b5XcV!?E&-s>XO$UFB zIS}a9kKr!}M*M4{7spI#_e?Bc2ivktjAf7NO!x`U1@h3tL3uq3$4ptRH|N5hJ>m#@ z)7|TlNO$F79;VaYs~FBM2d((URhXx%1v~sdC~@r6i4Eq86?;H$WVi~{Dokt%U6RmF zv(L7JCW($)#{=b~NtfMTm)o<0E?d*puEwuA+Foa4*Fi^H{a&G?C@OR(+KYSGcMzY@ w#ADW?QCHPoceSIgO5sUDSKD5*)1iY`ts(Gw)awMJb^~tEbi_@% diff --git a/docs/development_guide/build/doctrees/blink_demo_introduce.doctree b/docs/development_guide/build/doctrees/blink_demo_introduce.doctree index 77e84bd9bbc5860a9bd50261a4bb53f7584cb6f7..a106140a40bce994525b6eef336ef92cf740197f 100644 GIT binary patch delta 55 zcmaEA*=WVmz&iEYMiwtdl~fn27^nQww6w&We4oUm@ZgxFocP@2()i+(?D(S8oYchP K)Xiax{n7wEycC-N delta 27 icmZp)dTPniz&iETMiwtd4o^3$n4;8z{LMv-{n7x5B?*N9 diff --git a/docs/development_guide/build/doctrees/breath_pwm_demo_introduce.doctree b/docs/development_guide/build/doctrees/breath_pwm_demo_introduce.doctree index affc528826d2a571a2718be36f1403ba58f48a10..c38711ee298b730d00ae0c1841da1f8d32a8ad7e 100644 GIT binary patch delta 55 zcmewtGb@&*fpu#CMiwtdl`I#l7^nQww6w&We4oUm@ZgxFocP@2()i+(?D(S8oYchP K)Xiax8oB^O?i5@A delta 27 icmbOg`!9y2fpu!}Miwtd4nH@mn4;8z{LMv-8oB_C?+Hc# diff --git a/docs/development_guide/build/doctrees/connecting_hardware.doctree b/docs/development_guide/build/doctrees/connecting_hardware.doctree index 2a759b95dc518f71218d8e30b24311a3136eb49f..73ffc7057633e0f9da3b590d4674cf700b44b7d1 100644 GIT binary patch delta 57 zcmbQSh;hpzMwSNFshS&Eq#0FGT&!Z8@=Mdw5_9r>5|hG%W0G>>bCXNsi&L`Wi&Aq^ N6N^(ft22J|2LL&l6utle delta 29 lcmdn8h;hauMwSNFsk|Fmq!~Fp+^k}XQVa4oJ2QUt2LO$X38(-7 diff --git a/docs/development_guide/build/doctrees/environment.pickle b/docs/development_guide/build/doctrees/environment.pickle index e696055c9e91c4e2fc31b543357c8226305fe923..2e5745f78ae2f2c83d259f9560ac4626f44fca94 100644 GIT binary patch delta 3409 zcma)8e^k@g74MfHN(@;bKq>@MLZ~2~@b1u3&`iYTacZC%^5PN&Bfy1n~ezF$o9Pye~^ ze%|N4`|i8<`@QeIJRAP_ci|BaNB-ufFQPKNwrs`5QipT%W{cfXX=$vh+1O||w_2U% z&ZY;=9X7ko(rNPz8GSv8>6Jgg^p&CNlxStMt;^imW$Ea$HNn>@iJ-ig1Os}VQekOt zF*iF~nrwcEy_yUPeX5`XpFSSm(MKhFB3s&;Y!CT8aaKoLo6XwQ($;L=V(Dn=wseqV z`Xga3PuOj@tyz8AFtuq#$)ClYGAfyPUG&Ll)!_x=E*X`tTqN$0(Y?z`#Q_A|xZFlI=e z)zA0bfvO01%<96uVn4i;o-BCbgY;hs9#VE^v>@z+^@}bEJ}T3oF5>{KTWo~=c0DQ2 zj1*vdmJwPPyC6Tq2F@PtiuhfLH>mI^ z8=ZE$jcD)65a5|Bv7{=y0TnI8)G5hWjthZ?H01r3D~e@oMhjDuO7dcUCz}QD8Z9YX z{x~<8D72ztAipT;Mnwx%N0sFIiU7#nt{|S0ZHythm5*{0N41i?z3OwCt`8lcE%kw8 zEEcM=qsWocdVvBB9Lb4bn--P%*aVp@f0irWH8dv41oz6VprPQzMB(k^+`7s+7B^p8 zNjI0wbt{$R;!kO4feGTMrV&Z(0#Fjo`dipN8?FfvSQl7-A`xD$Jp%`Gc%0AvjK+B| z$3S#-kD#I<2kZNo!m_jRfhQ4YVREaIL~NvaLx90Py{Ux*j4jn1Sc8#|HPFb>41+9b zq+uYyOnqz(fCZo;Z8j%o_V`s~UNZw4h&dEV2DdBH1!|vhBbx$}h))3{uQ(Pgw)!f4Zpq~f2+T(wN8;eizSjm>B z|HWr)yV-UcVjkk>f!4kAiTHaSG-=)I<4$9qV@`QSxBS7&R_Ugaqfa3LDj3=J#eq*IH8$rH0+%pGU zZx%Mtt&rAKMWA_LYus;}z$`VNC`?WY>AkPfbFA*91EHjQ<1b|ux z?O90>J5mEf^?ZHrNVPzLhMXUzKjKh*Jb7&FH9lh+Kfn~}Uwtm|WEh&l`O$eK@6?U} z`L3Fr`}^-?OS0?qH32S6IcQr*D${0H3FzM;iXe92Ciyl^R3pu?F@=*L`aPoe+w z2HK2`(EMo)ywl5%d-7A7E_EMIm#!{>RD4d;g%kKEzkP+KOxe^dr{0O-oqgHbt4H=z!gi z4tOQe0q-L^;AKPyJQf}B8lnRpfev0cb-l6>bK_<{+{}fWd2llaZnoadmb=+%H(Ttc zDXG6PDF^@sH-AaxOE+uj3q<%P-Ze_y(Oa51^m?M`8-(BReSY!15Q;xfD0M7^;*SMN z4Tn%g>~TP;;~`XmOX5BV;rQc(E_*+O;?E6Ajf7DAB}AzYgD3?aj6a$v_g9&7(T~H! zNcq?k0TSy&GlGvCDaemPsHGBhE`*YU91o%7qm4yL9PIu!sda8k`50#;13L0(QFp@q5*{o#U>Q#C`wS& rqPPo16^dLGYf&sjp+ixMq8x=9MUi$Pl?kY>N1;ct8HEO_zq9-wxrN^q delta 3295 zcmZWreNa?Y6z}n2yDYdU?J7CD3A+kN$ReBHgMgVIi=au9<3xZ!uuo(OSanKShm2TR zWZ`V;D3y&`;}m_}oU%_UO+)h|BM8hy)6mM8w1|T0o_pWEh4!Cw&+q*1Iq%$a-aGeg z`zP>?;lQA+!OtFS3d&H-eqin+6-DJXcMxN9Wv_584w#}^zFeH#6}r)KWP%T z%cw_RA-Y0kcwy0_uq1k3JSNoWiFJ*&t}jk3wU*g8B~33cEB3fqa>#@tQ&6}r86pk3 z@L7zNjY*(1=)-4^HqL<$qxCQtt+~t14uw&|FiN?#AZZ3Dj7A{|8VvfV`?#OX@kjgi zn&DN0PB253K?i*Xb-1*jWkh2oLyJML~ z+9^gK-Y1n`(fwOA=wjv}I5eXMnh#$q*P{1Z~u%KK^OJ1>^4hi1l0ii)O>h zDQW|$hJ6;NpoTpb&8T62#f7M0Z^Z{u!$XMqs9{gVa@4S&q60M-Y7JDgyMn501(lvH zo>&pPDGpHKQmwU@mKKrBgct$(#c|M|t{^+6uSPH)!YhKvP~vt5$nK&hTzklbv%ma|54M zAQu-~r9I)KWa&1h|C%?EXe=3$J(y)sld;i@i8`~!t3ytG7H(Xbny0wJ?;Zg1YM(Qu1&q8pe}rt82MZz2-T-rS+nU%zuQ| z@Qto0ayG}xtRyS9k?-rzE8zREDphM~RWL4AB(zWh3s$Pgfg%ZXdcsIbv7I@C<4`c{ zJD?&RC6fa1@n|4-uA{lc{ip+X=}{Ql7fIHyHw#qZb)*@SPs^V18L-D2Pgbla&wvd_-qTY1H2g07X%7JQY2npMKgYQ>V|Hc*7)|*@jsgXiW z+?E(1@w#Ll4m+>T41?vzBS^P%y=){o^&j(y2@OFk5J_*`#g!XP z>GD3n+AW7F*+4oyN4VpQJAdKI3%h^jO3NPl3eq}}oh|&FWY6=1+;U)FGY`IazZAUs z&=|7sfSb{PVDU>Mz|EKGSA?Oe4@r4uzVa)#WVZJCoR+_S%?FmfdD#aRl1n}?_i(=t zq`k9+=W^yq8ncq9_qTH8tq)QaP+6)2^|4Q(-_Bpw8^==Vmucr8eClyp3l7v!Qm-L5 zPGmC!S=eKbQ4#OoOzckPn~N;C2If5^8sv2 zK?mES1$^r@oqLg`Z}Ugg;_$SDvO#T8u_tcYl!V|i@%RT1EbL3 zD5SY-q@QUNnlTEQMT^Ge|A0{H3qOkg2~eutkD9}7 z`dWua{L+u(e-+g2lpkg0ZXWTdAC>H-j`>kDz0`?Ol(L}Eu`bEvB~SjJT$dyt`<%pK zw`fK1zsc*?dGJS(Htp-5$ijLr;A%I2vuce#gWygTUXb}>$_ z&-W6CFF!p8{X>_l+AC2zAZ6H~z9u33Alxn;ylB*i()Z)4*9?1x6NE-MF?mn2$n_ cA{)g@6bagiRH{*(hGGqhnJ5;({(tiS1ENBw3jhEB diff --git a/docs/development_guide/build/doctrees/get_started.doctree b/docs/development_guide/build/doctrees/get_started.doctree index 44cda4cda642cb0755af528c1ac9af92564bd9b6..f5316f529aa11b38d38884b81a72fe5499b73435 100644 GIT binary patch delta 55 zcmX@%^2CLufpu!+MwS3Zl^7SR7^nQww6w&We4oUm@ZgxFocP@2()i+(?D(S8oYchP K)Xg!BZxjGC^%TAU delta 27 icmaFja>9kBfpx0wMwS3Z4hJ`@n4;8z{LK}NZxjHB=n1F* diff --git a/docs/development_guide/build/doctrees/index.doctree b/docs/development_guide/build/doctrees/index.doctree index ad154ebe842e1123f5d12a0b5a3f3ce2045a3248..508bd62b3c74bbdaa6cf66787f111505afe85cde 100644 GIT binary patch delta 55 zcmbPjz1^CnfpzMdjVyPVRKi@WVx00z)6x=i@_iDM!h>Uya^iE7OXG`Evg3b4fpzMHjVyPVIIP^PVv14=@;9?EZ6 delta 27 icmexWbFYS_fpu!|MwT!}jzBl7n4;8z{LOWYe{2Ang9@Vn diff --git a/docs/development_guide/build/html/Linux_quick_start_ubuntu.html b/docs/development_guide/build/html/Linux_quick_start_ubuntu.html index 5e98c5a0..f885d5f4 100644 --- a/docs/development_guide/build/html/Linux_quick_start_ubuntu.html +++ b/docs/development_guide/build/html/Linux_quick_start_ubuntu.html @@ -215,7 +215,7 @@ $ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz $ mkdir -p riscv64-elf-20210120 $ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120 -$ sudo cp ~/riscv64-elf-20210120 /usr/bin +$ sudo cp -rf ~/riscv64-elf-20210120 /usr/bin $ echo "export PATH=\"$PATH:/usr/bin/riscv64-elf-20210120/bin\"" >> ~/.bashrc $ source ~/.bashrc @@ -235,7 +235,7 @@ $ sudo apt install make $ cd ~ $ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz $ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz -$ sudo cp ~/cmake-3.19.3-Linux-x86_64 /usr/bin +$ sudo cp -rf ~/cmake-3.19.3-Linux-x86_64 /usr/bin $ echo "export PATH=\"$PATH:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\"" >> ~/.bashrc $ source ~/.bashrc diff --git a/docs/development_guide/build/html/_sources/Linux_quick_start_ubuntu.rst.txt b/docs/development_guide/build/html/_sources/Linux_quick_start_ubuntu.rst.txt index 8f7f344e..b10e8a9d 100644 --- a/docs/development_guide/build/html/_sources/Linux_quick_start_ubuntu.rst.txt +++ b/docs/development_guide/build/html/_sources/Linux_quick_start_ubuntu.rst.txt @@ -23,7 +23,7 @@ Linux 环境开发指南 $ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz $ mkdir -p riscv64-elf-20210120 $ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120 - $ sudo cp ~/riscv64-elf-20210120 /usr/bin + $ sudo cp -rf ~/riscv64-elf-20210120 /usr/bin $ echo "export PATH=\"$PATH:/usr/bin/riscv64-elf-20210120/bin\"" >> ~/.bashrc $ source ~/.bashrc @@ -39,7 +39,7 @@ Linux 环境开发指南 $ cd ~ $ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz $ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz - $ sudo cp ~/cmake-3.19.3-Linux-x86_64 /usr/bin + $ sudo cp -rf ~/cmake-3.19.3-Linux-x86_64 /usr/bin $ echo "export PATH=\"$PATH:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\"" >> ~/.bashrc $ source ~/.bashrc diff --git a/docs/development_guide/build/html/_sources/api_guide.rst.txt b/docs/development_guide/build/html/_sources/api_guide.rst.txt index 8fbae716..6e78c854 100644 --- a/docs/development_guide/build/html/_sources/api_guide.rst.txt +++ b/docs/development_guide/build/html/_sources/api_guide.rst.txt @@ -207,13 +207,21 @@ API 分层模型 .. code-block:: C - #define DEVICE_CTRL_SET_INT 0x01 /* 设置中断 */ - #define DEVICE_CTRL_CLR_INT 0x02 /* 清中断 */ - #define DEVICE_CTRL_GET_INT 0x03 /* 获取中断状态 */ - #define DEVICE_CTRL_RESUME 0x04 /* 恢复设备 */ - #define DEVICE_CTRL_SUSPEND 0x05 /* 挂起设备 */ - #define DEVICE_CTRL_CONFIG 0x06 /* 配置设备 */ - #define DEVICE_CTRL_GET_CONFIG 0x07 /* 获取设备配置 */ + #define DEVICE_CTRL_SET_INT 0x01 /* set interrupt */ + #define DEVICE_CTRL_CLR_INT 0x02 /* clear interrupt */ + #define DEVICE_CTRL_GET_INT 0x03 /* get interrupt status*/ + #define DEVICE_CTRL_RESUME 0x04 /* resume device */ + #define DEVICE_CTRL_SUSPEND 0x05 /* suspend device */ + #define DEVICE_CTRL_CONFIG 0x06 /* config device */ + #define DEVICE_CTRL_GET_CONFIG 0x07 /* get device configuration */ + #define DEVICE_CTRL_ATTACH_TX_DMA 0x08 + #define DEVICE_CTRL_ATTACH_RX_DMA 0x09 + #define DEVICE_CTRL_TX_DMA_SUSPEND 0x0a + #define DEVICE_CTRL_RX_DMA_SUSPEND 0x0b + #define DEVICE_CTRL_TX_DMA_RESUME 0x0c + #define DEVICE_CTRL_RX_DMA_RESUME 0x0d + #define DEVICE_CTRL_RESVD1 0x0E + #define DEVICE_CTRL_RESVD2 0x0F **device_write** ^^^^^^^^^^^^^^^^ @@ -371,7 +379,7 @@ GPIO 全称 General Purpose Input Output(通用输入 / 输出),博流系 bl mcu sdk 的引脚配置方式分为两种。 -- GPIO 复用功能通过专门的 **pinmux table** ,用户只需要修改 table 中的相关引脚和工功能,程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。 +- GPIO 复用功能通过专门的 **pinmux table** ,用户只需要修改 table 中的相关引脚的功能,程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。 - 通过标准的 GPIO 设备接口配置引脚,缺点是只能配置普通的输入输出和中断功能,复用功能建议还是使用 table 进行配置。 GPIO 设备接口 @@ -514,7 +522,7 @@ UART 设备结构体定义 - parity 校验位 - fifo_threshold fifo 阈值,不同 mcu 最大值不同 - tx_dma 附加的发送 dma 句柄 -- rx_dma 附加的发送 dma 句柄 +- rx_dma 附加的接收 dma 句柄 databits 提供以下类型 @@ -679,8 +687,6 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。 #define DEVICE_CTRL_UART_GET_TX_FIFO 0x10 #define DEVICE_CTRL_UART_GET_RX_FIFO 0x11 - #define DEVICE_CTRL_UART_ATTACH_TX_DMA 0x12 - #define DEVICE_CTRL_UART_ATTACH_RX_DMA 0x13 ``args`` 根据不同的 ``cmd`` 传入不同,具体如下: @@ -693,9 +699,9 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。 +---------------------------------------+--------------------------------------+ | DEVICE_CTRL_CONFIG | uart_param_cfg_t | +---------------------------------------+--------------------------------------+ -| DEVICE_CTRL_UART_ATTACH_TX_DMA | dma句柄 | +| DEVICE_CTRL_ATTACH_TX_DMA | dma句柄 | +---------------------------------------+--------------------------------------+ -| DEVICE_CTRL_UART_ATTACH_RX_DMA | dma句柄 | +| DEVICE_CTRL_ATTACH_RX_DMA | dma句柄 | +---------------------------------------+--------------------------------------+ | DEVICE_CTRL_UART_GET_TX_FIFO | 缓存变量 | +---------------------------------------+--------------------------------------+ diff --git a/docs/development_guide/build/html/api_guide.html b/docs/development_guide/build/html/api_guide.html index 3f0a7e3b..e156e856 100644 --- a/docs/development_guide/build/html/api_guide.html +++ b/docs/development_guide/build/html/api_guide.html @@ -406,13 +406,21 @@
  • return 不同的控制命令返回的意义不同。

  • cmd 提供了以下标准命令,除此之外,不同外设还具有自己的命令

    -
    #define DEVICE_CTRL_SET_INT     0x01    /* 设置中断 */
    -#define DEVICE_CTRL_CLR_INT     0x02    /* 清中断 */
    -#define DEVICE_CTRL_GET_INT     0x03    /* 获取中断状态 */
    -#define DEVICE_CTRL_RESUME      0x04    /* 恢复设备 */
    -#define DEVICE_CTRL_SUSPEND     0x05    /* 挂起设备 */
    -#define DEVICE_CTRL_CONFIG      0x06    /* 配置设备 */
    -#define DEVICE_CTRL_GET_CONFIG  0x07    /* 获取设备配置 */
    +
    #define DEVICE_CTRL_SET_INT             0x01    /* set interrupt */
    +#define DEVICE_CTRL_CLR_INT             0x02    /* clear interrupt */
    +#define DEVICE_CTRL_GET_INT             0x03    /* get interrupt status*/
    +#define DEVICE_CTRL_RESUME              0x04    /* resume device */
    +#define DEVICE_CTRL_SUSPEND             0x05    /* suspend device */
    +#define DEVICE_CTRL_CONFIG              0x06    /* config device */
    +#define DEVICE_CTRL_GET_CONFIG          0x07    /* get device configuration */
    +#define DEVICE_CTRL_ATTACH_TX_DMA       0x08
    +#define DEVICE_CTRL_ATTACH_RX_DMA       0x09
    +#define DEVICE_CTRL_TX_DMA_SUSPEND      0x0a
    +#define DEVICE_CTRL_RX_DMA_SUSPEND      0x0b
    +#define DEVICE_CTRL_TX_DMA_RESUME       0x0c
    +#define DEVICE_CTRL_RX_DMA_RESUME       0x0d
    +#define DEVICE_CTRL_RESVD1              0x0E
    +#define DEVICE_CTRL_RESVD2              0x0F
     
    @@ -554,7 +562,7 @@

    bl mcu sdk 的引脚配置方式分为两种。

      -
    • GPIO 复用功能通过专门的 pinmux table ,用户只需要修改 table 中的相关引脚和工功能,程序会自动配置这些引脚。pinmux table 位于 bsp/board/xxx_board 目录下 pinmux_config.h 文件。

    • +
    • GPIO 复用功能通过专门的 pinmux table ,用户只需要修改 table 中的相关引脚的功能,程序会自动配置这些引脚。pinmux table 位于 bsp/board/xxx_board 目录下 pinmux_config.h 文件。

    • 通过标准的 GPIO 设备接口配置引脚,缺点是只能配置普通的输入输出和中断功能,复用功能建议还是使用 table 进行配置。

    @@ -683,7 +691,7 @@
  • parity 校验位

  • fifo_threshold fifo 阈值,不同 mcu 最大值不同

  • tx_dma 附加的发送 dma 句柄

  • -
  • rx_dma 附加的发送 dma 句柄

  • +
  • rx_dma 附加的接收 dma 句柄

  • databits 提供以下类型

    typedef enum
    @@ -827,8 +835,6 @@
     

    串口设备除了标准的控制命令,还具有自己特殊的控制命令。

    #define DEVICE_CTRL_UART_GET_TX_FIFO        0x10
     #define DEVICE_CTRL_UART_GET_RX_FIFO        0x11
    -#define DEVICE_CTRL_UART_ATTACH_TX_DMA      0x12
    -#define DEVICE_CTRL_UART_ATTACH_RX_DMA      0x13
     

    args 根据不同的 cmd 传入不同,具体如下:

    @@ -852,10 +858,10 @@

    DEVICE_CTRL_CONFIG

    uart_param_cfg_t

    -

    DEVICE_CTRL_UART_ATTACH_TX_DMA

    +

    DEVICE_CTRL_ATTACH_TX_DMA

    dma句柄

    -

    DEVICE_CTRL_UART_ATTACH_RX_DMA

    +

    DEVICE_CTRL_ATTACH_RX_DMA

    dma句柄

    DEVICE_CTRL_UART_GET_TX_FIFO

    diff --git a/docs/development_guide/build/html/searchindex.js b/docs/development_guide/build/html/searchindex.js index 175ae822..f5f7dae3 100644 --- a/docs/development_guide/build/html/searchindex.js +++ b/docs/development_guide/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["Linux_quick_start_ubuntu","Windows_quick_start_cdk","Windows_quick_start_eclipse","api_guide","blink_demo_introduce","breath_pwm_demo_introduce","connecting_hardware","get_started","index","uart_loopback_demo_introduce"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["Linux_quick_start_ubuntu.rst","Windows_quick_start_cdk.rst","Windows_quick_start_eclipse.rst","api_guide.rst","blink_demo_introduce.rst","breath_pwm_demo_introduce.rst","connecting_hardware.rst","get_started.rst","index.rst","uart_loopback_demo_introduce.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x001":3,"0x002":3,"0x004":3,"0x008":3,"0x01":3,"0x010":3,"0x02":3,"0x020":3,"0x03":3,"0x04":3,"0x05":3,"0x06":3,"0x07":3,"0x10":3,"0x1000":3,"0x11":3,"0x12":3,"0x13":3,"0x2000":3,"0x3000":3,"10":3,"11":3,"12":3,"13":3,"18":7,"19":0,"2000000":[0,3],"20210120":0,"3v3":6,"case":2,"char":3,"const":3,"do":6,"enum":3,"export":0,"if":[3,5,9],"import":2,"int":3,"null":3,"return":3,"void":[3,9],adc:3,add:1,api:8,app:[0,2],appli:2,applic:2,apt:0,arg:[3,9],asynchron:3,bashrc:0,baudrat:3,bflb_mcu_prefer:2,bflb_platform_init:9,bin:[0,1,2],bit:3,bl702:[0,1,2,7,8],bl702_iot:6,bl706:[2,6],bl706_avb:7,bl706_iot:[0,2,4,5,7,9],bl70x:[6,8],bl70x_flash:1,bl70x_flasher:1,bl:3,bl_clean:2,bl_make:2,bl_mcu_sdk:[3,5],ble:8,board:[0,2,3,5,6,9],boot:[0,6],boot_rom:0,borad:2,bouffalo:[2,6,7],bouffalolab:[0,1,2],bsp:[3,5,9],bsp_using_uart0:3,bsp_using_uart1:3,bsp_using_uart2:3,bsp_using_uart3:3,bsp_using_uart4:3,buffer:3,build:[0,1,2],callback:3,cancel:2,cbfun:3,cd:0,cdk:[7,8],cdk_flashload:1,cdkproj:1,ck:[1,7],ck_link:6,clean:1,clone:[0,1,2],close:3,cmd:3,code:3,com:[0,1,2,6],command:2,config_gpio14_func:9,config_gpio15_func:9,config_gpio22_func:5,connect:6,consol:2,control:3,core:8,cp:0,cpu:1,csky:1,ctrl:3,cube:6,data:3,databit:3,debug:[1,2],debug_log:9,debugg:[1,7],defin:[3,5,9],demo:2,dev:[0,2,3,6,9],devic:[3,5,9],device_class_adc:3,device_class_camera:3,device_class_dma:3,device_class_gpio:3,device_class_i2:3,device_class_i2c:3,device_class_non:3,device_class_pwm:3,device_class_sdio:3,device_class_sec_hash:3,device_class_spi:3,device_class_tim:3,device_class_typ:3,device_class_uart:3,device_class_usb:3,device_contorl:5,device_control:[5,9],device_ctrl_clr_int:3,device_ctrl_config:[3,5],device_ctrl_get_config:3,device_ctrl_get_int:3,device_ctrl_resum:3,device_ctrl_set_int:[3,9],device_ctrl_suspend:3,device_ctrl_uart_attach_rx_dma:3,device_ctrl_uart_attach_tx_dma:3,device_ctrl_uart_get_rx_fifo:3,device_ctrl_uart_get_tx_fifo:3,device_find:[5,9],device_oflag_dma_rx:3,device_oflag_dma_tx:3,device_oflag_int_rx:3,device_oflag_int_tx:3,device_oflag_rdonli:3,device_oflag_rdwr:[3,5],device_oflag_stream_rx:3,device_oflag_stream_tx:3,device_oflag_wronli:3,device_open:5,device_set_callback:9,device_status_typ:3,device_writ:9,dlist_t:3,dma:3,download:[0,1,2],e24:8,echo:0,eclips:[7,8],edit:2,elf:[0,1,2],els:9,enabl:3,endif:3,epf:2,even:3,event:3,exampl:[0,1,2,4,5,9],exe:[1,2],exist:2,fifo:3,fifo_threshold:3,file:[0,2],find:[5,9],finish:2,finsh:2,flag:3,flash:1,flashdownload:1,gdb:2,gener:[2,3],git:[0,1,2],gite:[0,1,2],gnd:[2,6],gpio22:[4,5],gpio29:[4,5],gpio30:[4,5],gpio31:[4,5],gpio:[2,4,8],gpio_async_falling_triger_int_mod:3,gpio_async_high_level_int_mod:3,gpio_async_low_level_int_mod:3,gpio_async_rising_triger_int_mod:3,gpio_blink:[2,4],gpio_fun_uart0_rx:9,gpio_fun_uart0_tx:9,gpio_fun_unus:5,gpio_input_mod:3,gpio_input_pd_mod:3,gpio_input_pp_mod:3,gpio_output_mod:3,gpio_output_pd_mod:3,gpio_output_pp_mod:[3,4],gpio_pin_14:9,gpio_pin_15:9,gpio_pin_22:4,gpio_pin_29:4,gpio_pin_30:4,gpio_pin_31:4,gpio_set_mod:4,gpio_sync_falling_triger_int_mod:3,gpio_sync_high_level_int_mod:3,gpio_sync_low_level_int_mod:3,gpio_sync_rising_triger_int_mod:3,gpio_writ:4,gz:0,hal:3,handl:3,hd1:[6,9],hd3:6,hellowd:[0,1,2],helloworld:[0,1,2],help:1,http:[0,1,2],id:3,ifdef:3,ifndef:3,index:3,input:3,instal:0,interfac:0,into:2,iot:[2,6,8],is:3,jlink:[6,7],jlink_bl_mcu_sdk:2,jtag:[6,7,8],jtag_tck:6,jtag_tdi:6,jtag_tdo:6,jtag_tm:6,keil:8,lab:[2,6,7],launch:2,led:[4,5],led_breath:5,length:3,link:[1,2,7],linux:[7,8],list:3,loader:1,log:2,lts:7,main:[0,2],make:2,mcu:[0,1,2,3,6,7],mdk:8,media:0,mini:[0,6],mkdir:0,mode:3,name:3,name_max:3,next:2,no:3,node:3,occ:1,odd:3,of:3,oflag:3,ok:1,one:3,open:3,or:[6,7],org:0,ostrac:1,out:2,output:3,over:2,pane:1,parent:3,pariti:3,path:0,pc:[2,6,7],peripher:1,peripheral_clock_adc:3,peripheral_clock_dac:3,peripheral_clock_i2:3,peripheral_clock_i2c:3,peripheral_clock_spi:3,peripheral_clock_typ:3,peripheral_clock_uart:3,peripheral_config:3,picocom:0,pin:3,pinmux:3,pinmux_config:[3,5,9],pos:3,prefer:2,printf:9,profil:1,project:[1,2],purpos:3,pwm0_index:5,pwm:[5,8,9],pwm_breath_l:5,pwm_cfg:5,pwm_regist:5,read:3,receiv:3,recurs:[0,1,2],refresh:6,regist:1,risc:[2,8],riscv64:0,rom:6,rst:[0,1,2,6],rto:3,rx0:6,rx:9,rx_dma:3,rxd0:2,rxd:6,sdk:[0,1,2,3],segger:2,serial:1,set:1,set_callback:9,setup:1,sifiv:8,sipe:7,size:[3,9],sky:1,sourc:0,spi:3,start:1,state:9,statu:3,std:3,step:2,stop:[1,3],stopbit:3,struct:[3,5,9],structur:3,success:1,sudo:0,system:1,system_clock_bclk:3,system_clock_fclk:3,system_clock_root_clock:3,system_clock_typ:3,system_clock_xclk:3,tabl:3,tar:0,target:2,tck:6,tdi:6,tdo:6,tms:6,to:6,tool:1,transmitt:3,ttl:[0,1,2,6,7],ttyusb0:0,two:3,tx0:6,tx:9,tx_dma:3,txd0:2,txd:6,type:[1,2,3,6],typedef:3,uart0:[3,6],uart0_config:3,uart0_index:3,uart1_config:3,uart1_index:3,uart2_index:3,uart3_index:3,uart4_index:3,uart:[0,8,9],uart_data_len_5:3,uart_data_len_6:3,uart_data_len_7:3,uart_data_len_8:3,uart_databits_t:3,uart_devic:3,uart_device_t:3,uart_echo:9,uart_event_rto:[3,9],uart_event_rx_end:3,uart_event_rx_fifo:[3,9],uart_event_tx_end:3,uart_event_tx_fifo:3,uart_event_typ:3,uart_event_unknown:3,uart_index_typ:3,uart_irq_callback:9,uart_it_typ:3,uart_max_index:3,uart_par_even:3,uart_par_non:3,uart_par_odd:3,uart_param_cfg_t:3,uart_parity_t:3,uart_rto_it:9,uart_rx_fifo_it:9,uart_stop_on:3,uart_stop_one_d_f:3,uart_stop_two:3,uart_stopbits_t:3,uartx_devic:3,ubuntu:7,uint16_t:3,uint32_t:[3,9],uint8_t:[3,9],univers:3,updat:0,upload:0,usb:[0,1,2,6,7],usr:0,v11:7,v3:0,valu:3,vdd33:6,vdd:6,vi:0,view:1,viewer:1,vref:6,vtref:6,welcom:2,wget:0,window:[7,8],workspac:2,write:3,x86_64:0,xxx:2,xxx_board:3,xxx_clock_config:3,xxx_close:3,xxx_control:3,xxx_devic:3,xxx_device_t:3,xxx_open:3,xxx_read:3,xxx_regist:3,xxx_write:3,zigbe:8,zxvf:0},titles:["4. Linux \u73af\u5883\u5f00\u53d1\u6307\u5357","2. Windows \u4e0b\u4f7f\u7528 CDK (\u7c7b MDK Keil)\u5f00\u53d1\u6307\u5357","3. Windows \u4e0b\u4f7f\u7528 Eclipse \u5f00\u53d1\u6307\u5357","1. API \u5206\u5c42\u6a21\u578b","1. \u6d41\u6c34\u706f\u793a\u4f8b","2. \u547c\u5438\u706f\u793a\u4f8b","5. \u786c\u4ef6\u8fde\u63a5","1. \u5f00\u53d1\u524d\u7684\u51c6\u5907","BL MCU SDK \u5f00\u53d1\u6307\u5357","3. \u4e32\u53e3\u81ea\u6536\u53d1\u793a\u4f8b"],titleterms:{api:3,bl702_avb:6,bl706_iot:6,bl:8,bl_mcu_sdk:[0,1,2],cdk:1,ck:6,cmake:0,device_clos:3,device_control:3,device_find:3,device_open:3,device_read:3,device_regist:3,device_set_callback:3,device_unregist:3,device_writ:3,eclips:2,gpio:3,gpio_attach_irq:3,gpio_irq_en:3,gpio_read:3,gpio_set_mod:3,gpio_toggl:3,gpio_writ:3,hello:[0,1,2],keil:1,link:6,linux:0,make:0,mcu:8,mdk:1,peripheral_clock_get:3,pwm:3,risc:0,sdk:8,system_clock_get:3,uart:3,uart_regist:3,window:[1,2],world:[0,1,2]}}) \ No newline at end of file +Search.setIndex({docnames:["Linux_quick_start_ubuntu","Windows_quick_start_cdk","Windows_quick_start_eclipse","api_guide","blink_demo_introduce","breath_pwm_demo_introduce","connecting_hardware","get_started","index","uart_loopback_demo_introduce"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["Linux_quick_start_ubuntu.rst","Windows_quick_start_cdk.rst","Windows_quick_start_eclipse.rst","api_guide.rst","blink_demo_introduce.rst","breath_pwm_demo_introduce.rst","connecting_hardware.rst","get_started.rst","index.rst","uart_loopback_demo_introduce.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x001":3,"0x002":3,"0x004":3,"0x008":3,"0x01":3,"0x010":3,"0x02":3,"0x020":3,"0x03":3,"0x04":3,"0x05":3,"0x06":3,"0x07":3,"0x08":3,"0x09":3,"0x0a":3,"0x0b":3,"0x0c":3,"0x0d":3,"0x0e":3,"0x0f":3,"0x10":3,"0x1000":3,"0x11":3,"0x2000":3,"0x3000":3,"10":3,"11":3,"12":3,"13":3,"18":7,"19":0,"2000000":[0,3],"20210120":0,"3v3":6,"case":2,"char":3,"const":3,"do":6,"enum":3,"export":0,"if":[3,5,9],"import":2,"int":3,"null":3,"return":3,"void":[3,9],adc:3,add:1,api:8,app:[0,2],appli:2,applic:2,apt:0,arg:[3,9],asynchron:3,bashrc:0,baudrat:3,bflb_mcu_prefer:2,bflb_platform_init:9,bin:[0,1,2],bit:3,bl702:[0,1,2,7,8],bl702_iot:6,bl706:[2,6],bl706_avb:7,bl706_iot:[0,2,4,5,7,9],bl70x:[6,8],bl70x_flash:1,bl70x_flasher:1,bl:3,bl_clean:2,bl_make:2,bl_mcu_sdk:[3,5],ble:8,board:[0,2,3,5,6,9],boot:[0,6],boot_rom:0,borad:2,bouffalo:[2,6,7],bouffalolab:[0,1,2],bsp:[3,5,9],bsp_using_uart0:3,bsp_using_uart1:3,bsp_using_uart2:3,bsp_using_uart3:3,bsp_using_uart4:3,buffer:3,build:[0,1,2],callback:3,cancel:2,cbfun:3,cd:0,cdk:[7,8],cdk_flashload:1,cdkproj:1,ck:[1,7],ck_link:6,clean:1,clear:3,clone:[0,1,2],close:3,cmd:3,code:3,com:[0,1,2,6],command:2,config:3,config_gpio14_func:9,config_gpio15_func:9,config_gpio22_func:5,configur:3,connect:6,consol:2,control:3,core:8,cp:0,cpu:1,csky:1,ctrl:3,cube:6,data:3,databit:3,debug:[1,2],debug_log:9,debugg:[1,7],defin:[3,5,9],demo:2,dev:[0,2,3,6,9],devic:[3,5,9],device_class_adc:3,device_class_camera:3,device_class_dma:3,device_class_gpio:3,device_class_i2:3,device_class_i2c:3,device_class_non:3,device_class_pwm:3,device_class_sdio:3,device_class_sec_hash:3,device_class_spi:3,device_class_tim:3,device_class_typ:3,device_class_uart:3,device_class_usb:3,device_contorl:5,device_control:[5,9],device_ctrl_attach_rx_dma:3,device_ctrl_attach_tx_dma:3,device_ctrl_clr_int:3,device_ctrl_config:[3,5],device_ctrl_get_config:3,device_ctrl_get_int:3,device_ctrl_resum:3,device_ctrl_resvd1:3,device_ctrl_resvd2:3,device_ctrl_rx_dma_resum:3,device_ctrl_rx_dma_suspend:3,device_ctrl_set_int:[3,9],device_ctrl_suspend:3,device_ctrl_tx_dma_resum:3,device_ctrl_tx_dma_suspend:3,device_ctrl_uart_get_rx_fifo:3,device_ctrl_uart_get_tx_fifo:3,device_find:[5,9],device_oflag_dma_rx:3,device_oflag_dma_tx:3,device_oflag_int_rx:3,device_oflag_int_tx:3,device_oflag_rdonli:3,device_oflag_rdwr:[3,5],device_oflag_stream_rx:3,device_oflag_stream_tx:3,device_oflag_wronli:3,device_open:5,device_set_callback:9,device_status_typ:3,device_writ:9,dlist_t:3,dma:3,download:[0,1,2],e24:8,echo:0,eclips:[7,8],edit:2,elf:[0,1,2],els:9,enabl:3,endif:3,epf:2,even:3,event:3,exampl:[0,1,2,4,5,9],exe:[1,2],exist:2,fifo:3,fifo_threshold:3,file:[0,2],find:[5,9],finish:2,finsh:2,flag:3,flash:1,flashdownload:1,gdb:2,gener:[2,3],get:3,git:[0,1,2],gite:[0,1,2],gnd:[2,6],gpio22:[4,5],gpio29:[4,5],gpio30:[4,5],gpio31:[4,5],gpio:[2,4,8],gpio_async_falling_triger_int_mod:3,gpio_async_high_level_int_mod:3,gpio_async_low_level_int_mod:3,gpio_async_rising_triger_int_mod:3,gpio_blink:[2,4],gpio_fun_uart0_rx:9,gpio_fun_uart0_tx:9,gpio_fun_unus:5,gpio_input_mod:3,gpio_input_pd_mod:3,gpio_input_pp_mod:3,gpio_output_mod:3,gpio_output_pd_mod:3,gpio_output_pp_mod:[3,4],gpio_pin_14:9,gpio_pin_15:9,gpio_pin_22:4,gpio_pin_29:4,gpio_pin_30:4,gpio_pin_31:4,gpio_set_mod:4,gpio_sync_falling_triger_int_mod:3,gpio_sync_high_level_int_mod:3,gpio_sync_low_level_int_mod:3,gpio_sync_rising_triger_int_mod:3,gpio_writ:4,gz:0,hal:3,handl:3,hd1:[6,9],hd3:6,hellowd:[0,1,2],helloworld:[0,1,2],help:1,http:[0,1,2],id:3,ifdef:3,ifndef:3,index:3,input:3,instal:0,interfac:0,interrupt:3,into:2,iot:[2,6,8],is:3,jlink:[6,7],jlink_bl_mcu_sdk:2,jtag:[6,7,8],jtag_tck:6,jtag_tdi:6,jtag_tdo:6,jtag_tm:6,keil:8,lab:[2,6,7],launch:2,led:[4,5],led_breath:5,length:3,link:[1,2,7],linux:[7,8],list:3,loader:1,log:2,lts:7,main:[0,2],make:2,mcu:[0,1,2,3,6,7],mdk:8,media:0,mini:[0,6],mkdir:0,mode:3,name:3,name_max:3,next:2,no:3,node:3,occ:1,odd:3,of:3,oflag:3,ok:1,one:3,open:3,or:[6,7],org:0,ostrac:1,out:2,output:3,over:2,pane:1,parent:3,pariti:3,path:0,pc:[2,6,7],peripher:1,peripheral_clock_adc:3,peripheral_clock_dac:3,peripheral_clock_i2:3,peripheral_clock_i2c:3,peripheral_clock_spi:3,peripheral_clock_typ:3,peripheral_clock_uart:3,peripheral_config:3,picocom:0,pin:3,pinmux:3,pinmux_config:[3,5,9],pos:3,prefer:2,printf:9,profil:1,project:[1,2],purpos:3,pwm0_index:5,pwm:[5,8,9],pwm_breath_l:5,pwm_cfg:5,pwm_regist:5,read:3,receiv:3,recurs:[0,1,2],refresh:6,regist:1,resum:3,rf:0,risc:[2,8],riscv64:0,rom:6,rst:[0,1,2,6],rto:3,rx0:6,rx:9,rx_dma:3,rxd0:2,rxd:6,sdk:[0,1,2,3],segger:2,serial:1,set:[1,3],set_callback:9,setup:1,sifiv:8,sipe:7,size:[3,9],sky:1,sourc:0,spi:3,start:1,state:9,statu:3,std:3,step:2,stop:[1,3],stopbit:3,struct:[3,5,9],structur:3,success:1,sudo:0,suspend:3,system:1,system_clock_bclk:3,system_clock_fclk:3,system_clock_root_clock:3,system_clock_typ:3,system_clock_xclk:3,tabl:3,tar:0,target:2,tck:6,tdi:6,tdo:6,tms:6,to:6,tool:1,transmitt:3,ttl:[0,1,2,6,7],ttyusb0:0,two:3,tx0:6,tx:9,tx_dma:3,txd0:2,txd:6,type:[1,2,3,6],typedef:3,uart0:[3,6],uart0_config:3,uart0_index:3,uart1_config:3,uart1_index:3,uart2_index:3,uart3_index:3,uart4_index:3,uart:[0,8,9],uart_data_len_5:3,uart_data_len_6:3,uart_data_len_7:3,uart_data_len_8:3,uart_databits_t:3,uart_devic:3,uart_device_t:3,uart_echo:9,uart_event_rto:[3,9],uart_event_rx_end:3,uart_event_rx_fifo:[3,9],uart_event_tx_end:3,uart_event_tx_fifo:3,uart_event_typ:3,uart_event_unknown:3,uart_index_typ:3,uart_irq_callback:9,uart_it_typ:3,uart_max_index:3,uart_par_even:3,uart_par_non:3,uart_par_odd:3,uart_param_cfg_t:3,uart_parity_t:3,uart_rto_it:9,uart_rx_fifo_it:9,uart_stop_on:3,uart_stop_one_d_f:3,uart_stop_two:3,uart_stopbits_t:3,uartx_devic:3,ubuntu:7,uint16_t:3,uint32_t:[3,9],uint8_t:[3,9],univers:3,updat:0,upload:0,usb:[0,1,2,6,7],usr:0,v11:7,v3:0,valu:3,vdd33:6,vdd:6,vi:0,view:1,viewer:1,vref:6,vtref:6,welcom:2,wget:0,window:[7,8],workspac:2,write:3,x86_64:0,xxx:2,xxx_board:3,xxx_clock_config:3,xxx_close:3,xxx_control:3,xxx_devic:3,xxx_device_t:3,xxx_open:3,xxx_read:3,xxx_regist:3,xxx_write:3,zigbe:8,zxvf:0},titles:["4. Linux \u73af\u5883\u5f00\u53d1\u6307\u5357","2. Windows \u4e0b\u4f7f\u7528 CDK (\u7c7b MDK Keil)\u5f00\u53d1\u6307\u5357","3. Windows \u4e0b\u4f7f\u7528 Eclipse \u5f00\u53d1\u6307\u5357","1. API \u5206\u5c42\u6a21\u578b","1. \u6d41\u6c34\u706f\u793a\u4f8b","2. \u547c\u5438\u706f\u793a\u4f8b","5. \u786c\u4ef6\u8fde\u63a5","1. \u5f00\u53d1\u524d\u7684\u51c6\u5907","BL MCU SDK \u5f00\u53d1\u6307\u5357","3. \u4e32\u53e3\u81ea\u6536\u53d1\u793a\u4f8b"],titleterms:{api:3,bl702_avb:6,bl706_iot:6,bl:8,bl_mcu_sdk:[0,1,2],cdk:1,ck:6,cmake:0,device_clos:3,device_control:3,device_find:3,device_open:3,device_read:3,device_regist:3,device_set_callback:3,device_unregist:3,device_writ:3,eclips:2,gpio:3,gpio_attach_irq:3,gpio_irq_en:3,gpio_read:3,gpio_set_mod:3,gpio_toggl:3,gpio_writ:3,hello:[0,1,2],keil:1,link:6,linux:0,make:0,mcu:8,mdk:1,peripheral_clock_get:3,pwm:3,risc:0,sdk:8,system_clock_get:3,uart:3,uart_regist:3,window:[1,2],world:[0,1,2]}}) \ No newline at end of file diff --git a/docs/development_guide/source/Linux_quick_start_ubuntu.rst b/docs/development_guide/source/Linux_quick_start_ubuntu.rst index 8f7f344e..b10e8a9d 100644 --- a/docs/development_guide/source/Linux_quick_start_ubuntu.rst +++ b/docs/development_guide/source/Linux_quick_start_ubuntu.rst @@ -23,7 +23,7 @@ Linux 环境开发指南 $ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz $ mkdir -p riscv64-elf-20210120 $ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120 - $ sudo cp ~/riscv64-elf-20210120 /usr/bin + $ sudo cp -rf ~/riscv64-elf-20210120 /usr/bin $ echo "export PATH=\"$PATH:/usr/bin/riscv64-elf-20210120/bin\"" >> ~/.bashrc $ source ~/.bashrc @@ -39,7 +39,7 @@ Linux 环境开发指南 $ cd ~ $ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz $ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz - $ sudo cp ~/cmake-3.19.3-Linux-x86_64 /usr/bin + $ sudo cp -rf ~/cmake-3.19.3-Linux-x86_64 /usr/bin $ echo "export PATH=\"$PATH:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\"" >> ~/.bashrc $ source ~/.bashrc diff --git a/docs/development_guide/source/api_guide.rst b/docs/development_guide/source/api_guide.rst index 8fbae716..6e78c854 100644 --- a/docs/development_guide/source/api_guide.rst +++ b/docs/development_guide/source/api_guide.rst @@ -207,13 +207,21 @@ API 分层模型 .. code-block:: C - #define DEVICE_CTRL_SET_INT 0x01 /* 设置中断 */ - #define DEVICE_CTRL_CLR_INT 0x02 /* 清中断 */ - #define DEVICE_CTRL_GET_INT 0x03 /* 获取中断状态 */ - #define DEVICE_CTRL_RESUME 0x04 /* 恢复设备 */ - #define DEVICE_CTRL_SUSPEND 0x05 /* 挂起设备 */ - #define DEVICE_CTRL_CONFIG 0x06 /* 配置设备 */ - #define DEVICE_CTRL_GET_CONFIG 0x07 /* 获取设备配置 */ + #define DEVICE_CTRL_SET_INT 0x01 /* set interrupt */ + #define DEVICE_CTRL_CLR_INT 0x02 /* clear interrupt */ + #define DEVICE_CTRL_GET_INT 0x03 /* get interrupt status*/ + #define DEVICE_CTRL_RESUME 0x04 /* resume device */ + #define DEVICE_CTRL_SUSPEND 0x05 /* suspend device */ + #define DEVICE_CTRL_CONFIG 0x06 /* config device */ + #define DEVICE_CTRL_GET_CONFIG 0x07 /* get device configuration */ + #define DEVICE_CTRL_ATTACH_TX_DMA 0x08 + #define DEVICE_CTRL_ATTACH_RX_DMA 0x09 + #define DEVICE_CTRL_TX_DMA_SUSPEND 0x0a + #define DEVICE_CTRL_RX_DMA_SUSPEND 0x0b + #define DEVICE_CTRL_TX_DMA_RESUME 0x0c + #define DEVICE_CTRL_RX_DMA_RESUME 0x0d + #define DEVICE_CTRL_RESVD1 0x0E + #define DEVICE_CTRL_RESVD2 0x0F **device_write** ^^^^^^^^^^^^^^^^ @@ -371,7 +379,7 @@ GPIO 全称 General Purpose Input Output(通用输入 / 输出),博流系 bl mcu sdk 的引脚配置方式分为两种。 -- GPIO 复用功能通过专门的 **pinmux table** ,用户只需要修改 table 中的相关引脚和工功能,程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。 +- GPIO 复用功能通过专门的 **pinmux table** ,用户只需要修改 table 中的相关引脚的功能,程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。 - 通过标准的 GPIO 设备接口配置引脚,缺点是只能配置普通的输入输出和中断功能,复用功能建议还是使用 table 进行配置。 GPIO 设备接口 @@ -514,7 +522,7 @@ UART 设备结构体定义 - parity 校验位 - fifo_threshold fifo 阈值,不同 mcu 最大值不同 - tx_dma 附加的发送 dma 句柄 -- rx_dma 附加的发送 dma 句柄 +- rx_dma 附加的接收 dma 句柄 databits 提供以下类型 @@ -679,8 +687,6 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。 #define DEVICE_CTRL_UART_GET_TX_FIFO 0x10 #define DEVICE_CTRL_UART_GET_RX_FIFO 0x11 - #define DEVICE_CTRL_UART_ATTACH_TX_DMA 0x12 - #define DEVICE_CTRL_UART_ATTACH_RX_DMA 0x13 ``args`` 根据不同的 ``cmd`` 传入不同,具体如下: @@ -693,9 +699,9 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。 +---------------------------------------+--------------------------------------+ | DEVICE_CTRL_CONFIG | uart_param_cfg_t | +---------------------------------------+--------------------------------------+ -| DEVICE_CTRL_UART_ATTACH_TX_DMA | dma句柄 | +| DEVICE_CTRL_ATTACH_TX_DMA | dma句柄 | +---------------------------------------+--------------------------------------+ -| DEVICE_CTRL_UART_ATTACH_RX_DMA | dma句柄 | +| DEVICE_CTRL_ATTACH_RX_DMA | dma句柄 | +---------------------------------------+--------------------------------------+ | DEVICE_CTRL_UART_GET_TX_FIFO | 缓存变量 | +---------------------------------------+--------------------------------------+