From b2a72ec74f0c9bd673569b791ea9306a3d38d076 Mon Sep 17 00:00:00 2001 From: Kedareswara rao Appana Date: Mon, 25 Aug 2014 11:06:16 +0530 Subject: [PATCH] doxygen: update doxygen for the scutimer driver. This patch updates the doxygen for the scutimer driver. Signed-off-by: Kedareswara rao Appana --- .../drivers/scutimer/doc/html/api/Thumbs.db | Bin 4607 -> 0 bytes .../scutimer/doc/html/api/annotated.html | 41 +- .../scutimer/doc/html/api/classes.html | 39 + .../drivers/scutimer/doc/html/api/doxygen.png | Bin 1280 -> 0 bytes .../doc/html/api/driver_api_doxygen.css | 334 ------ .../drivers/scutimer/doc/html/api/files.html | 44 +- .../scutimer/doc/html/api/functions.html | 75 +- .../scutimer/doc/html/api/functions_vars.html | 75 +- .../scutimer/doc/html/api/globals.html | 223 +++- .../scutimer/doc/html/api/globals_defs.html | 182 +++- .../scutimer/doc/html/api/globals_func.html | 94 +- .../scutimer/doc/html/api/globals_vars.html | 63 +- .../drivers/scutimer/doc/html/api/index.html | 82 +- .../html/api/struct_x_scu_timer-members.html | 49 +- .../doc/html/api/struct_x_scu_timer.html | 159 ++- .../struct_x_scu_timer___config-members.html | 47 +- .../html/api/struct_x_scu_timer___config.html | 127 ++- .../drivers/scutimer/doc/html/api/tabs.css | 15 +- .../scutimer/doc/html/api/xscutimer_8c.html | 353 +++---- .../scutimer/doc/html/api/xscutimer_8h.html | 617 +++++++++++ .../doc/html/api/xscutimer__g_8c.html | 97 +- .../doc/html/api/xscutimer__hw_8h.html | 971 ++++++++---------- .../doc/html/api/xscutimer__selftest_8c.html | 131 +-- .../doc/html/api/xscutimer__sinit_8c.html | 115 +-- 24 files changed, 2204 insertions(+), 1729 deletions(-) delete mode 100755 XilinxProcessorIPLib/drivers/scutimer/doc/html/api/Thumbs.db create mode 100755 XilinxProcessorIPLib/drivers/scutimer/doc/html/api/classes.html delete mode 100755 XilinxProcessorIPLib/drivers/scutimer/doc/html/api/doxygen.png delete mode 100755 XilinxProcessorIPLib/drivers/scutimer/doc/html/api/driver_api_doxygen.css create mode 100755 XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer_8h.html diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/Thumbs.db b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/Thumbs.db deleted file mode 100755 index 0bd260813b613bab25a88bb07fc731727c7abc10..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 4607 zcmeH|2T&917RQ$wAdmo3Gz0Ed3QWJzdh$W`|X^a^WX3Lo(}O$T&qV+ z0^b=5U;?(b*#XwSb@7F)QMeHCPAW#ra5H1iH2pj}F0stNmUXUFid?5TF z0w97QJ3)4VAV7pbkRZY!yFo-iL_vP-F@IO@e;?B|qHE9e=Xxl=$H|9D78Jl)S)e%( zbmh5Bj16o+?*SsuMn4-cO@oV|V+giE>j5=`$dBNF+3S$`ApodPhirA5FyUGVOt_m%%jeYr5}r}SabqhcpVU_fC3oUY-H5LY&1NU#^y)E~mA0=ggKzHMzHQqUmK2=*Xppd8 z5Zp;AIO~<@CS)eTdwD*o+r4nYgMev0y@zmzvA&qAvVwLwC^$Hj*xITgD;IUSM!p2 z%il=NAGawt`(7Jd;4o)oDjJ%1i)6qI%8g#&~E+`Yp1HF|Ku7ZwTw?s<-;=F;k$V@Orw$SU}<}|-v*p6_7GD(=5O918#7xYd$Us01oBP9 z>UmxN>1$s~e5qGEliVo6THd*rPSu>*6*yG*_OT#R$uENV0I!YmSB+~UWN*mI!Yf}% zKx!VPKs1+&t>5)p22M}yESDs}lOLDk8!Ls+5v!~5NXTc=$LI6U`QoM{pGiiakjqy* z(EmP8Z!zS8WS`p<#1me+O6g}SQZ_oi(So(gIxt9C4!HLI;dya|b<@(6-pHPmyRS1L z$>mj514{+Drto|+!FIgCX{gtDx7Xmekm{(N$L>sSrPj(TOi@2-x@b@3bzOVO?L5P5 zj}<|URD=n@akDKE5xSo@oGF#zMJ`{4P@dHTIEpAbl$!1{+{g0adZt5xjW3BiL;EbM z|MY!WNzh^wak>2@Q_h9=CGl5U9yUoyuSS>!o8oQ9W7HL3_w}T+Az^!o0p8wqYxm*x z(}RqiK`W@#q1{fpmQRlAio~>M+jq7<$Sh*fjUZry04X!Ed&9d!Z36`H?>fGa^WP zB80z%EH$zWBz~O|OYXXqaE!NqHc7jbCf4h&7o0Klp54OJ{ImBIkI2@7Ki2$8+t`uR zT>Ey+Qg6JIQZde4{53MLN^FLdj-;)2j2EvX4J(qH^Y%7l#j7Z`mjcAKw%ayrX@zOA z=zOxaelmGuD&-N%NTKJQSuT3ABeK!EJ8Tb>?8mk)UAUR0Gg3$DDwcqZCR|9mvfzl{ zRr>H$@8CFLDf`=v**CQ%_v%-j!{=c-ez4H~E_M#x;hOles1`4onAY@$80?mf={T*j zuq>U%exayi(JawY>!fR&-%X7`1&D!+Bdt|=sd~})txQ2t{UXJORVi0LYLuhuDtd-k zJ$y4cad#CW9WrNC(Nw_EM1O|e*+k*QK>$5UNb{7{+v zYlQ=@GkS7KDNM7TJGKwL@N?vy-)Wzre|;bph@$AVBec1B(u%5WFg8jn50CO^=6 z7**aGG)8R}+`D2-l^PA2Yw)qI{G%5xf)k5~MhTT9ytpBAsr&2HnIMWUxQ zF^1!Qu5%OnWmhD9Oi(oxK!G%WUq0aFTy=uwZtt{#?r)LTp9$Z!Azf_uR+!Bpa5F!j z@L49c8*;5_GH18kOY3;YaF3;Yc8KiYTpu0W)AAXM0e%}JzMM%@>$O|rUg>em4y{q? z4IjSLtx_>}tK%`NYnp@7NkR`(;*2}bp)#DUgT|DLkngof%M|iykA2OrloTUx+#L6X zZHx+0JgSHvHsB)xdYHIGxR#L_dDCgh6wnu2 z38lGJI19KY82ah#ev=|pvtSatO)7)Q)ZulGFR{C#%7kaR%&TMgTB8c{7g|n)M&@v` z66fQJwbH&sXJTK|tRJVebW`VJy-WvIXNpMvwQWYlBF^E0CMt?sZza0@)x$IG<&mG( z&!76{yAaw|dNnD1r=$P+5tUX-;yZ^E`l7{r2a+;2iX6SA5$7Ll9b6dntY|&Ap{|Ds zW25Yhr08z0$fAAo88@RZtumdT4`6;CVs}8o4_daD7P1!Zcr;V%(xknpk8z*9;b=yM zn3%1oM@We U115$R1~q!e&e7vv_7CsC@B1`V8UO$Q diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/annotated.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/annotated.html index 7e3a5943..a2105683 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/annotated.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/annotated.html @@ -2,27 +2,38 @@ - Class List + Xilinx Driver scutimer v2_0: Class List - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
+ + + +

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
XScuTimer
XScuTimer_Config
-Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. +
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/classes.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/classes.html new file mode 100755 index 00000000..80a0bb15 --- /dev/null +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/classes.html @@ -0,0 +1,39 @@ + + + + + Xilinx Driver scutimer v2_0: Alphabetical List + + + +

Xilinx Processor IP Library

+Software Drivers +
+ + + +
+

Class Index

X
+ +
  X  
+		XScuTimer   XScuTimer_Config   
X
+
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/doxygen.png b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/doxygen.png deleted file mode 100755 index d8021941e6c836bb05e83ed25dfaddc81912c980..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1280 zcmaJ>ZA?>F7(Vx-ms?upS`b@hdRtmn6o^%HU>M$hfGrBvQnk$LE?p^P!kn&ikhyq! zY2(FDtPXHSsr8ekTL96Bi%aRiwbe1)9HN7TF?E|PZe}sTZ5g}%Up&b29$!M_f=;UuUj_~ict%VUD&}wa|7J%WA+iPu0_*&*JvboE*x!mtn z?x+G<=Qc+bX{xKNuCi2BIvcjfstS10X7d_r5szPf{V z8NN|dy?Mb)$*)20OoR907`7mf^hPx4JIge7fLd}IC$2r z0SNkkAPL;1Qua+uSS02;9l4&? zn79g^7@tk%=QF^5Km!93ha2>IiGF&wOR=de@G=;E)w(L`pQ;t)wQX7b_p(C;k0j-u zhnCoxqpHWr6a~#E$Fbw_84gWg`+znj=@4NvatZJiPljhi=eLjzLhP+J)a-?B{?r1` z1G(CnB*VPf%P{lO3P;IQq)p_Ow=GiVL?nX>(VY69VJSM^`orc&$1I@S`$#w z8jLpx7Z-?@5;*+EYeYW{{VAxD+fzBxAc!s^azuGc_gxI%zap}&1NHWy-5!e<5V88e2A9e$rdNB>tS+DLPZKZCRBJ@sQMiMLgV|{G$V6D zJ2x&N2)fmkAdE#j_4_eQVFMc$$MEipda;9A;yVF_jESMt=n(`b-_De)LBek=d1CRw zT!hP1s|1$5LE&Xo$yh<0IUD}hv1cCS@MJ;n$nFDph{9e0VG{r6Rww(-x9+ zsa|gCNjj%EdLYXAmtII*SJ5`@_H5bm{YdrBZ1RJ`jlff~R=WYEQAC-MepGM{mE}E~ zn#z+g_TpmlczJONri@%?hOX}&N;)OwRXC5QDJ2{h9e zd0N}s+vm81E7Sg%Smu4+Y~HGg0B2Ly{x5_V8;>wK3{ZShoN(;M4QBiad#%qDCHPL) zU64B`W(-uudK3g4i$(fm%`8_!^DoX)mXvByNK284@$KXB{Pnh$f+%gbw(roNn S`K7h|)&QoWGQ+1jn*9%)IMrqV diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/driver_api_doxygen.css b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/driver_api_doxygen.css deleted file mode 100755 index 8b5d35bb..00000000 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/driver_api_doxygen.css +++ /dev/null @@ -1,334 +0,0 @@ -BODY { - background-color: #FFFFFF; - font-family: Verdana, Arial, Helvetica, Sans-serif; -} - -H1 { - margin-bottom: 0em; - font-size: 2.00em; - font-style: normal; - color: #990033; -} - -H2 { - font-size: 1.05em; - font-style: normal; - color: #666666; -} - -H3 { - font-size: 1.00em; - font-style: normal; - color: #000000; -} - -H4 { - font-size: .90em; - font-style: italic; - color: #000000; -} - -H5 { - font-size: .90em; - font-style: italic; - color: #000000; -} - -H6 { - font-size: .90em; - font-style: italic; - color: #000000; -} - -OL { -} - -UL { -} - -LI { -} - -P { - color: #000000; -} - -P.Caution { - color: #990033; -} - -P.Code { - font-family: Courier New, Courier, Mono; - color: #003399; -} - -P.HeadingDBox { - font-weight: bold; -} - -P.HeadingGlossary { - font-weight: bold; -} - -P.LinkGlossary { - margin-bottom: .50em; -} - -P.Note { -} - -P.SysInOut { - font-family: Courier New, Courier, Mono; -} - -P.TableFootnote { - font-size: .80em; - margin-bottom: .70em; -} - -P.TableHeading { - font-weight: bold; - color: #FFFFFF; -} - -P.TableTitle { - font-style: italic; - font-weight: bold; -} - -SPAN.aEmphasis { - font-style: italic; -} - -SPAN.aFilename { - font-family: Courier New, Courier, Mono; -} - - -SPAN.aGUISysIn { - font-family: Verdana, Arial, Helvetica, Sans-serif; - font-weight: bold; -} - -SPAN.aReference { - font-style: italic; -} - -SPAN.aSysIn { - font-family: Courier New, Courier, Monospace; - font-weight: bold; -} - -SPAN.aSysOut { - font-family: Courier New, Courier, Monospace; -} - -SPAN.aSymbol { - font-family: Symbol; -} - -CAPTION { font-weight: bold } -DIV.qindex { - width: 100%; - background-color: #eeeeff; - border: 1px solid #B0B0B0; - text-align: center; - margin: 2px; - padding: 2px; -} -A.qindex { - text-decoration: none; - font-weight: bold; - color: #1A419D; - padding: 2px; -} -A.qindex:visited { - text-decoration: none; - font-weight: bold; - color: #1A419D - padding: 2px; -} -A.qindex:hover { - text-decoration: none; - background-color: #ddddff; - padding: 2px; -} -A.qindexHL { - text-decoration: none; - font-weight: bold; - background-color: #6666cc; - color: #ffffff; - padding: 2 6px; - border: 1px double #9295C2; - } -A.qindexHL:hover { - text-decoration: none; - background-color: #6666cc; - color: #ffffff; - padding: 2px 6px; -} -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 { text-decoration: none; font-weight: normal; color: #1A419D} -A.codeRef { font-weight: normal; color: #1A419D} -A:hover { text-decoration: none; background-color: #f2f2ff } -DL.el { margin-left: -1cm } -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.fragment { - border: 1px solid #CCCCCC; - background-color: #f5f5f5; - padding: 6px; -} -DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } -TD.md { background-color: #F4F4FB; font-weight: bold; } -TD.mdname1 { background-color: #F4F4FB; font-weight: bold; color: #602020; } -TD.mdname { background-color: #F4F4FB; font-weight: bold; color: #602020; width: 600px; } -DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold } -DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller } -BODY { - background: white; - color: black; - margin-right: 20px; - margin-left: 20px; -} -TD.indexkey { - background-color: #eeeeff; - 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: #eeeeff; - 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 } -.mdTable { - border: 1px solid #868686; - background-color: #F4F4FB; -} -.mdRow { - padding: 8px 10px; -} -.mdescLeft { - font-size: smaller; - font-family: Verdana, Arial, Helvetica, sans-serif; - background-color: #FAFAFA; - padding-left: 8px; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; -} -.mdescRight { - font-size: smaller; - font-family: Verdana, Arial, Helvetica, sans-serif; - font-style: italic; - background-color: #FAFAFA; - padding-left: 4px; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; - padding-bottom: 0px; - padding-right: 8px; -} -.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-style: solid; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-family: Verdana, Arial, Helvetica, sans-serif; - font-size: 12px; -} -.memItemRight { - 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-style: solid; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-family: Verdana, Arial, Helvetica, sans-serif; - font-size: 13px; -} -.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: #eeeeff; -} -TD.tiny { font-size: 75%; -} -a { - color: #252E78; -} -a:visited { - color: #3D2185; -} diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/files.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/files.html index 62072578..08a11ee4 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/files.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/files.html @@ -2,30 +2,42 @@ - File Index + Xilinx Driver scutimer v2_0: File Index - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-

File List

Here is a list of all documented files with brief descriptions: + + + +
+

File List

Here is a list of all files with brief descriptions:
+
xscutimer.c
xscutimer.h
xscutimer_g.c
xscutimer_hw.h
xscutimer_selftest.c
xscutimer_sinit.c
-Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. + +

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/functions.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/functions.html index b6f9f0e3..f7751f17 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/functions.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/functions.html @@ -2,38 +2,57 @@ - Class Members + Xilinx Driver scutimer v2_0: Class Members - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-
- + + + -Here is a list of all documented class members with links to the class documentation for each member: -

-

+
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/functions_vars.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/functions_vars.html index cc51ebe3..c95e2c2d 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/functions_vars.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/functions_vars.html @@ -2,38 +2,57 @@ - Class Members - Variables + Xilinx Driver scutimer v2_0: Class Members - Variables - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-
- + + + -  -

-

+
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals.html index a29e42d1..d79cebf4 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals.html @@ -2,62 +2,181 @@ - Class Members + Xilinx Driver scutimer v2_0: Class Members - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-
- + + + -Here is a list of all documented file members with links to the documentation: -

-

+
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_defs.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_defs.html index 569a1b28..9049752f 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_defs.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_defs.html @@ -2,54 +2,150 @@ - Class Members + Xilinx Driver scutimer v2_0: Class Members - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-
- + + + +
  -

-

+
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_func.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_func.html index cbdda1aa..bb186b18 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_func.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_func.html @@ -2,42 +2,72 @@ - Class Members + Xilinx Driver scutimer v2_0: Class Members - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-
- + + + -  -

-

+
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_vars.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_vars.html index 637944bb..d6464520 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_vars.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_vars.html @@ -2,36 +2,47 @@ - Class Members + Xilinx Driver scutimer v2_0: Class Members - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-
- + + + -  -

-

+
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/index.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/index.html index 36bb93f2..c4375a34 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/index.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/index.html @@ -2,52 +2,60 @@ - xscutimer v2_0 + Xilinx Driver scutimer v2_0: scutimer v2_0 - +

Xilinx Processor IP Library

Software Drivers
- -
-
-

xscutimer v2_0

-

-The timer driver supports the Cortex A9 private timer.

-The timer driver supports the following features:

    -
  • Normal mode and Auto reload mode
  • Interrupts (Interrupt handler is not provided in this driver. Application has to register it's own handler)
-

- Initialization and Configuration

-The device driver enables higher layer software (e.g., an application) to communicate with the Timer.

-XScuTimer_CfgInitialize() API is used to initialize the Timer. The user needs to first call the XScuTimer_LookupConfig() API which returns the Configuration structure pointer which is passed as a parameter to the XScuTimer_CfgInitialize() API.

- Interrupts

-The Timer hardware supports interrupts.

-This driver does not provide a Interrupt Service Routine (ISR) for the device. It is the responsibility of the application to provide one if needed. Refer to the interrupt example provided with this driver for details on using the Timer in interrupt mode.

- Virtual Memory

-This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.

- Threads

-This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.

- Asserts

-Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.

- Building the driver

-The XScuTimer driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.

-
-
-

-NOTE: The timer is not a part of the snoop control unit as indicated by the prefix "scu" in the name of the driver. It is an independent module in APU.

+ + +

+
+

scutimer v2_0

The timer driver supports the Cortex A9 private timer.

+

The timer driver supports the following features:

+
    +
  • Normal mode and Auto reload mode
    • +
  • Interrupts (Interrupt handler is not provided in this driver. Application has to register it's own handler)
    • +
+

Initialization and Configuration

+

The device driver enables higher layer software (e.g., an application) to communicate with the Timer.

+

XScuTimer_CfgInitialize() API is used to initialize the Timer. The user needs to first call the XScuTimer_LookupConfig() API which returns the Configuration structure pointer which is passed as a parameter to the XScuTimer_CfgInitialize() API.

+

Interrupts

+

The Timer hardware supports interrupts.

+

This driver does not provide a Interrupt Service Routine (ISR) for the device. It is the responsibility of the application to provide one if needed. Refer to the interrupt example provided with this driver for details on using the Timer in interrupt mode.

+

Virtual Memory

+

This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.

+

Threads

+

This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.

+

Asserts

+

Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.

+

Building the driver

+

The XScuTimer driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.

+


+
+

+

NOTE: The timer is not a part of the snoop control unit as indicated by the prefix "scu" in the name of the driver. It is an independent module in APU.

- MODIFICATION HISTORY:

-

 Ver   Who Date     Changes
+ MODIFICATION HISTORY:
 Ver   Who Date     Changes
  ----- --- -------- ---------------------------------------------
  1.00a nm  03/10/10 First release
  1.02a sg  07/17/12 Included xil_assert.h for CR 667947. This is an issue
 		     when the xstatus.h in the common driver overwrites
 		     the xstatus.h of the standalone BSP during the
 		     libgen.
- 2.0   hk      03/07/14 Version number revised.
-
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. +
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer-members.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer-members.html index 0685ec6f..449b6742 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer-members.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer-members.html @@ -2,27 +2,38 @@ - Member List + Xilinx Driver scutimer v2_0: Member List - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-

XScuTimer Member List

This is the complete list of members for XScuTimer, including all inherited members.

- - - -
ConfigXScuTimer
IsReadyXScuTimer
IsStartedXScuTimer
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. + + +

+
+

XScuTimer Member List

This is the complete list of members for XScuTimer, including all inherited members. + + + +
ConfigXScuTimer
IsReadyXScuTimer
IsStartedXScuTimer
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer.html index aee95e03..e221c696 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer.html @@ -2,110 +2,93 @@ - XScuTimer Struct Reference + Xilinx Driver scutimer v2_0: XScuTimer Struct Reference - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-

XScuTimer Struct Reference

#include <xscutimer.h> -

-List of all members.

Detailed Description

-The XScuTimer driver instance data. The user is required to allocate a variable of this type for every timer device in the system. A pointer to a variable of this type is then passed to the driver API functions. -

+ + +

+
+

XScuTimer Struct Reference

+

#include <xscutimer.h>

+ +

List of all members.

- - - - - - - - + + + +

Public Attributes

XScuTimer_Config Config
u32 IsReady
u32 IsStarted

Public Attributes

XScuTimer_Config Config
u32 IsReady
u32 IsStarted
-

Member Data Documentation

-

- - - - -
- +

Detailed Description

+

The XScuTimer driver instance data. The user is required to allocate a variable of this type for every timer device in the system. A pointer to a variable of this type is then passed to the driver API functions.

+

Member Data Documentation

+ +
+
+
- +
XScuTimer_Config XScuTimer::Config XScuTimer_Config XScuTimer::Config
-
- - - - - -
-   - + +
+

Hardware Configuration

-

-Hardware Configuration

-

- - - - -
- + + + +
+
+
- +
u32 XScuTimer::IsReady u32 XScuTimer::IsReady
-
- - - - - -
-   - + +
+

Device is initialized and ready

-

-Device is initialized and ready

-

- - - - -
- + + + +
+
+
- +
u32 XScuTimer::IsStarted u32 XScuTimer::IsStarted
-
- - - - - -
-   - + +
+

Device timer is running

+ +
+ +
The documentation for this struct was generated from the following file: + +

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + -

-Device timer is running

-

The documentation for this struct was generated from the following file:
    -
  • xscutimer.h
-Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer___config-members.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer___config-members.html index c9d88278..c81239da 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer___config-members.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer___config-members.html @@ -2,26 +2,37 @@ - Member List + Xilinx Driver scutimer v2_0: Member List - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-

XScuTimer_Config Member List

This is the complete list of members for XScuTimer_Config, including all inherited members.

- - -
BaseAddrXScuTimer_Config
DeviceIdXScuTimer_Config
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. + + +

+
+

XScuTimer_Config Member List

This is the complete list of members for XScuTimer_Config, including all inherited members. + + +
BaseAddrXScuTimer_Config
DeviceIdXScuTimer_Config
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer___config.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer___config.html index 32a14f3a..7acff2fb 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer___config.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer___config.html @@ -2,85 +2,78 @@ - XScuTimer_Config Struct Reference + Xilinx Driver scutimer v2_0: XScuTimer_Config Struct Reference - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-

XScuTimer_Config Struct Reference

#include <xscutimer.h> -

-List of all members.

Detailed Description

-This typedef contains configuration information for the device. -

+ + +

+
+

XScuTimer_Config Struct Reference

+

#include <xscutimer.h>

+ +

List of all members.

- - - - - - + + +

Public Attributes

u16 DeviceId
u32 BaseAddr

Public Attributes

u16 DeviceId
u32 BaseAddr
-

Member Data Documentation

-

- - - - -
- +

Detailed Description

+

This typedef contains configuration information for the device.

+

Member Data Documentation

+ +
+
+
- +
u32 XScuTimer_Config::BaseAddr u32 XScuTimer_Config::BaseAddr
-
- - - - - -
-   - + +
+

Base address of the device

-

-Base address of the device

-

- - - - -
- + + + +
+
+
- +
u16 XScuTimer_Config::DeviceId u16 XScuTimer_Config::DeviceId
-
- - - - - -
-   - + +
+

Unique ID of device

+ +
+ +
The documentation for this struct was generated from the following file: + +

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + -

-Unique ID of device

-

The documentation for this struct was generated from the following file:
    -
  • xscutimer.h
-Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/tabs.css b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/tabs.css index a61552a6..a4441634 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/tabs.css +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/tabs.css @@ -32,7 +32,7 @@ DIV.tabs A float : left; background : url("tab_r.gif") no-repeat right top; border-bottom : 1px solid #84B0C7; - font-size : x-small; + font-size : 80%; font-weight : bold; text-decoration : none; } @@ -57,7 +57,7 @@ DIV.tabs SPAN white-space : nowrap; } -DIV.tabs INPUT +DIV.tabs #MSearchBox { float : right; display : inline; @@ -66,7 +66,7 @@ DIV.tabs INPUT DIV.tabs TD { - font-size : x-small; + font-size : 80%; font-weight : bold; text-decoration : none; } @@ -82,21 +82,24 @@ DIV.tabs A:hover SPAN background-position: 0% -150px; } -DIV.tabs LI#current A +DIV.tabs LI.current A { background-position: 100% -150px; border-width : 0px; } -DIV.tabs LI#current SPAN +DIV.tabs LI.current SPAN { background-position: 0% -150px; padding-bottom : 6px; } -DIV.nav +DIV.navpath { background : none; border : none; border-bottom : 1px solid #84B0C7; + text-align : center; + margin : 2px; + padding : 2px; } diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer_8c.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer_8c.html index 9c4aa2a2..90d1aff5 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer_8c.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer_8c.html @@ -2,257 +2,216 @@ - xscutimer.c File Reference + Xilinx Driver scutimer v2_0: xscutimer.c File Reference - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-

xscutimer.c File Reference

Detailed Description

-Contains the implementation of interface functions of the SCU Timer driver. See xscutimer.h for a description of the driver.

+ + +

+
+

xscutimer.c File Reference

#include "xscutimer.h"
+ + + + + + + +

Functions

int XScuTimer_CfgInitialize (XScuTimer *InstancePtr, XScuTimer_Config *ConfigPtr, u32 EffectiveAddress)
void XScuTimer_Start (XScuTimer *InstancePtr)
void XScuTimer_Stop (XScuTimer *InstancePtr)
void XScuTimer_SetPrescaler (XScuTimer *InstancePtr, u8 PrescalerValue)
u8 XScuTimer_GetPrescaler (XScuTimer *InstancePtr)
+

Detailed Description

+

Contains the implementation of interface functions of the SCU Timer driver. See xscutimer.h for a description of the driver.

- MODIFICATION HISTORY:

-

 Ver   Who Date     Changes
+ MODIFICATION HISTORY:
 Ver   Who Date     Changes
  ----- --- -------- ---------------------------------------------
  1.00a nm  03/10/10 First release
-
-

-#include "xscutimer.h"
- - - - - - - - - - - - - -

Functions

int XScuTimer_CfgInitialize (XScuTimer *InstancePtr, XScuTimer_Config *ConfigPtr, u32 EffectiveAddress)
void XScuTimer_Start (XScuTimer *InstancePtr)
void XScuTimer_Stop (XScuTimer *InstancePtr)
void XScuTimer_SetPrescaler (XScuTimer *InstancePtr, u8 PrescalerValue)
u8 XScuTimer_GetPrescaler (XScuTimer *InstancePtr)
-

Function Documentation

-

- - - - -
- +

Function Documentation

+ +
+
+
- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +
int XScuTimer_CfgInitialize ( XScuTimer *  InstancePtr, int XScuTimer_CfgInitialize (XScuTimer *  InstancePtr,
XScuTimer_Config *  ConfigPtr, XScuTimer_Config *  ConfigPtr,
u32  EffectiveAddressu32  EffectiveAddress 
) )
-
- - - - - -
-   - - -

-Initialize a specific timer instance/driver. This function must be called before other functions of the driver are called.

-

Parameters:
+ +
+

Initialize a specific timer instance/driver. This function must be called before other functions of the driver are called.

+
Parameters:
InstancePtr is a pointer to the XScuTimer instance.
ConfigPtr points to the XScuTimer configuration structure.
EffectiveAddress is the base address for the device. It could be a virtual address if address translation is supported in the system, otherwise it is the physical address.
+
-
Returns:
    -
  • XST_SUCCESS if initialization was successful.
  • XST_DEVICE_IS_STARTED if the device has already been started.
+
Returns:
    +
  • XST_SUCCESS if initialization was successful.
    • +
  • XST_DEVICE_IS_STARTED if the device has already been started.
    • +
-
Note:
None.
-
-

- - - - -
- +
Note:
None.
+ + + + +
+
+
- - - - - - + + + + + +
u8 XScuTimer_GetPrescaler ( XScuTimer *  InstancePtr  ) u8 XScuTimer_GetPrescaler (XScuTimer *  InstancePtr ) 
-
- - - - - -
-   - - -

-This function returns the current prescaler value.

-

Parameters:
+ +
+

This function returns the current prescaler value.

+
Parameters:
InstancePtr is a pointer to the XScuTimer instance.
+
-
Returns:
The prescaler value.
-
Note:
None.
-
-

- - - - -
- +
Returns:
The prescaler value.
+
Note:
None.
+ + + + +
+
+
- - - - + + + + - - - - + + + + - - - + + +
void XScuTimer_SetPrescaler ( XScuTimer *  InstancePtr, void XScuTimer_SetPrescaler (XScuTimer *  InstancePtr,
u8  PrescalerValueu8  PrescalerValue 
) )
-
- - - - - -
-   - - -

-This function sets the prescaler bits in the timer control register.

-

Parameters:
+ +
+

This function sets the prescaler bits in the timer control register.

+
Parameters:
InstancePtr is a pointer to the XScuTimer instance.
PrescalerValue is a 8 bit value that sets the prescaler to use.
+
-
Returns:
None
-
Note:
None
-
-

- - - - -
- +
Returns:
None
+
Note:
None
+ + + + +
+
+
- - - - - - + + + + + +
void XScuTimer_Start ( XScuTimer *  InstancePtr  ) void XScuTimer_Start (XScuTimer *  InstancePtr ) 
-
- - - - - -
-   - - -

-Start the timer.

-

Parameters:
+ +
+

Start the timer.

+
Parameters:
InstancePtr is a pointer to the XScuTimer instance.
+
-
Returns:
None.
-
Note:
None.
-
-

- - - - -
- +
Returns:
None.
+
Note:
None.
+ + + + +
+
+
- - - - - - + + + + + +
void XScuTimer_Stop ( XScuTimer *  InstancePtr  ) void XScuTimer_Stop (XScuTimer *  InstancePtr ) 
-
- - - - - -
-   - - -

-Stop the timer.

-

Parameters:
+ +
+

Stop the timer.

+
Parameters:
InstancePtr is a pointer to the XScuTimer instance.
+
-
Returns:
None.
-
Note:
None.
-
-Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. +

Returns:
None.
+
Note:
None.
+ +
+
+
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer_8h.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer_8h.html new file mode 100755 index 00000000..f50519e8 --- /dev/null +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer_8h.html @@ -0,0 +1,617 @@ + + + + + Xilinx Driver scutimer v2_0: xscutimer.h File Reference + + + +

Xilinx Processor IP Library

+Software Drivers +
+ + + +
+

xscutimer.h File Reference

#include "xstatus.h"
+#include "xscutimer_hw.h"
+ + + + + + + + + + + + + + + + + + + + + + + + +

Classes

struct  XScuTimer_Config
struct  XScuTimer

Defines

#define XSCUTIMER_H
#define XScuTimer_IsExpired(InstancePtr)
#define XScuTimer_RestartTimer(InstancePtr)
#define XScuTimer_LoadTimer(InstancePtr, Value)
#define XScuTimer_GetCounterValue(InstancePtr)
#define XScuTimer_EnableAutoReload(InstancePtr)
#define XScuTimer_DisableAutoReload(InstancePtr)
#define XScuTimer_EnableInterrupt(InstancePtr)
#define XScuTimer_DisableInterrupt(InstancePtr)
#define XScuTimer_GetInterruptStatus(InstancePtr)
#define XScuTimer_ClearInterruptStatus(InstancePtr)

Functions

XScuTimer_Config * XScuTimer_LookupConfig (u16 DeviceId)
int XScuTimer_SelfTest (XScuTimer *InstancePtr)
int XScuTimer_CfgInitialize (XScuTimer *InstancePtr, XScuTimer_Config *ConfigPtr, u32 EffectiveAddress)
void XScuTimer_Start (XScuTimer *InstancePtr)
void XScuTimer_Stop (XScuTimer *InstancePtr)
void XScuTimer_SetPrescaler (XScuTimer *InstancePtr, u8 PrescalerValue)
u8 XScuTimer_GetPrescaler (XScuTimer *InstancePtr)
+

Detailed Description

+

Define Documentation

+ +
+
+ + + + + + + + + +
#define XScuTimer_ClearInterruptStatus(InstancePtr  ) 
+
+
+Value:
XScuTimer_WriteReg((InstancePtr)->Config.BaseAddr,              \
+                XSCUTIMER_ISR_OFFSET, XSCUTIMER_ISR_EVENT_FLAG_MASK)
+

This function clears the interrupt status.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
None.
+
Note:
C-style signature: void XScuTimer_ClearInterruptStatus(XScuTimer *InstancePtr)
+ +
+
+ +
+
+ + + + + + + + + +
#define XScuTimer_DisableAutoReload(InstancePtr  ) 
+
+
+Value:
XScuTimer_WriteReg((InstancePtr)->Config.BaseAddr,              \
+                        XSCUTIMER_CONTROL_OFFSET,                       \
+                        (XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr, \
+                                XSCUTIMER_CONTROL_OFFSET) &             \
+                                ~(XSCUTIMER_CONTROL_AUTO_RELOAD_MASK)))
+

Disable auto-reload mode.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
None.
+
Note:
C-style signature: void XScuTimer_DisableAutoReload(XScuTimer *InstancePtr)
+ +
+
+ +
+
+ + + + + + + + + +
#define XScuTimer_DisableInterrupt(InstancePtr  ) 
+
+
+Value:
XScuTimer_WriteReg((InstancePtr)->Config.BaseAddr,              \
+                        XSCUTIMER_CONTROL_OFFSET,                       \
+                        (XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr, \
+                                XSCUTIMER_CONTROL_OFFSET) &             \
+                                ~(XSCUTIMER_CONTROL_IRQ_ENABLE_MASK)))
+

Disable the Timer interrupt.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
None.
+
Note:
C-style signature: void XScuTimer_DisableInterrupt(XScuTimer *InstancePtr)
+ +
+
+ +
+
+ + + + + + + + + +
#define XScuTimer_EnableAutoReload(InstancePtr  ) 
+
+
+Value:
XScuTimer_WriteReg((InstancePtr)->Config.BaseAddr,              \
+                        XSCUTIMER_CONTROL_OFFSET,                       \
+                        (XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr, \
+                                XSCUTIMER_CONTROL_OFFSET) |              \
+                                XSCUTIMER_CONTROL_AUTO_RELOAD_MASK))
+

Enable auto-reload mode.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
None.
+
Note:
C-style signature: void XScuTimer_EnableAutoReload(XScuTimer *InstancePtr)
+ +
+
+ +
+
+ + + + + + + + + +
#define XScuTimer_EnableInterrupt(InstancePtr  ) 
+
+
+Value:
XScuTimer_WriteReg((InstancePtr)->Config.BaseAddr,              \
+                        XSCUTIMER_CONTROL_OFFSET,                       \
+                        (XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr, \
+                                        XSCUTIMER_CONTROL_OFFSET) |     \
+                                        XSCUTIMER_CONTROL_IRQ_ENABLE_MASK))
+

Enable the Timer interrupt.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
None.
+
Note:
C-style signature: void XScuTimer_EnableInterrupt(XScuTimer *InstancePtr)
+ +
+
+ +
+
+ + + + + + + + + +
#define XScuTimer_GetCounterValue(InstancePtr  ) 
+
+
+Value:
XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr,               \
+                                XSCUTIMER_COUNTER_OFFSET)
+

Returns the current timer counter register value. It can be called at any time.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
Contents of the timer counter register.
+
Note:
C-style signature: u32 XScuTimer_GetCounterValue(XScuTimer *InstancePtr)
+ +
+
+ +
+
+ + + + + + + + + +
#define XScuTimer_GetInterruptStatus(InstancePtr  ) 
+
+
+Value:
XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr,               \
+                        XSCUTIMER_ISR_OFFSET)
+

This function reads the interrupt status.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
None.
+
Note:
C-style signature: void XScuTimer_GetInterruptStatus(XScuTimer *InstancePtr)
+ +
+
+ +
+
+ + + + +
#define XSCUTIMER_H
+
+
+ +
+
+ +
+
+ + + + + + + + + +
#define XScuTimer_IsExpired(InstancePtr  ) 
+
+
+Value:
((XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr, \
+                                XSCUTIMER_ISR_OFFSET) & \
+                                XSCUTIMER_ISR_EVENT_FLAG_MASK) == \
+                                XSCUTIMER_ISR_EVENT_FLAG_MASK)
+

Check if the timer has expired.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
    +
  • TRUE if the timer has expired.
    • +
  • FALSE if the timer has not expired.
    • +
+
+
Note:
C-style signature: int XScuTimer_IsExpired(XScuTimer *InstancePtr)
+ +
+
+ +
+
+ + + + + + + + + + + + + + +
#define XScuTimer_LoadTimer(InstancePtr,
Value  ) 
+
+
+Value:
XScuTimer_WriteReg((InstancePtr)->Config.BaseAddr,              \
+                        XSCUTIMER_LOAD_OFFSET, Value)
+

Write to the timer load register. This will also update the timer counter register with the new value. This macro can be used to change the time-out value.

+
Parameters:
+ + + +
InstancePtr is a pointer to the XScuTimer instance.
Value is the count to be loaded in to the load register.
+
+
+
Returns:
None.
+
Note:
C-style signature: void XScuTimer_LoadTimer(XScuTimer *InstancePtr, u32 Value)
+ +
+
+ +
+
+ + + + + + + + + +
#define XScuTimer_RestartTimer(InstancePtr  ) 
+
+
+Value:
XScuTimer_LoadTimer(InstancePtr,                                \
+                XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr, \
+                                        XSCUTIMER_LOAD_OFFSET))
+

Re-start the timer. This macro will read the timer load register and writes the same value to load register to update the counter register.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
None.
+
Note:
C-style signature: void XScuTimer_RestartTimer(XScuTimer *InstancePtr)
+ +
+
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int XScuTimer_CfgInitialize (XScuTimer *  InstancePtr,
XScuTimer_Config *  ConfigPtr,
u32  EffectiveAddress 
)
+
+
+

Initialize a specific timer instance/driver. This function must be called before other functions of the driver are called.

+
Parameters:
+ + + + +
InstancePtr is a pointer to the XScuTimer instance.
ConfigPtr points to the XScuTimer configuration structure.
EffectiveAddress is the base address for the device. It could be a virtual address if address translation is supported in the system, otherwise it is the physical address.
+
+
+
Returns:
    +
  • XST_SUCCESS if initialization was successful.
    • +
  • XST_DEVICE_IS_STARTED if the device has already been started.
    • +
+
+
Note:
None.
+ +
+
+ +
+
+ + + + + + + + + +
u8 XScuTimer_GetPrescaler (XScuTimer *  InstancePtr ) 
+
+
+

This function returns the current prescaler value.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
The prescaler value.
+
Note:
None.
+ +
+
+ +
+
+ + + + + + + + + +
XScuTimer_Config* XScuTimer_LookupConfig (u16  DeviceId ) 
+
+
+

Lookup the device configuration based on the unique device ID. The table contains the configuration info for each device in the system.

+
Parameters:
+ + +
DeviceId is the unique device ID of the device being looked up.
+
+
+
Returns:
A pointer to the configuration table entry corresponding to the given device ID, or NULL if no match is found.
+
Note:
None.
+ +
+
+ +
+
+ + + + + + + + + +
int XScuTimer_SelfTest (XScuTimer *  InstancePtr ) 
+
+
+

Run a self-test on the timer. This test clears the timer enable bit in the control register, writes to the timer load register and verifies the value read back matches the value written and restores the control register and the timer load register.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
    +
  • XST_SUCCESS if self-test was successful.
    • +
  • XST_FAILURE if self test was not successful.
    • +
+
+
Note:
None.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void XScuTimer_SetPrescaler (XScuTimer *  InstancePtr,
u8  PrescalerValue 
)
+
+
+

This function sets the prescaler bits in the timer control register.

+
Parameters:
+ + + +
InstancePtr is a pointer to the XScuTimer instance.
PrescalerValue is a 8 bit value that sets the prescaler to use.
+
+
+
Returns:
None
+
Note:
None
+ +
+
+ +
+
+ + + + + + + + + +
void XScuTimer_Start (XScuTimer *  InstancePtr ) 
+
+
+

Start the timer.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
None.
+
Note:
None.
+ +
+
+ +
+
+ + + + + + + + + +
void XScuTimer_Stop (XScuTimer *  InstancePtr ) 
+
+
+

Stop the timer.

+
Parameters:
+ + +
InstancePtr is a pointer to the XScuTimer instance.
+
+
+
Returns:
None.
+
Note:
None.
+ +
+
+
+

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__g_8c.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__g_8c.html index 3c02827d..4a63c0df 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__g_8c.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__g_8c.html @@ -2,70 +2,67 @@ - xscutimer_g.c File Reference + Xilinx Driver scutimer v2_0: xscutimer_g.c File Reference - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-

xscutimer_g.c File Reference

Detailed Description

-This file contains a table that specifies the configuration of the SCU Timer in the system.

+ + +

+
+

xscutimer_g.c File Reference

#include "xscutimer.h"
+#include "xparameters.h"
+ + + +

Variables

XScuTimer_Config XScuTimer_ConfigTable [XPAR_XSCUTIMER_NUM_INSTANCES]
+

Detailed Description

+

This file contains a table that specifies the configuration of the SCU Timer in the system.

- MODIFICATION HISTORY:

-

 Ver   Who Date     Changes
+ MODIFICATION HISTORY:
 Ver   Who Date     Changes
  ----- --- -------- ---------------------------------------------
  1.00a nm  03/10/10 First release
-
-

-#include "xscutimer.h"
-#include "xparameters.h"
- - - - - -

Variables

XScuTimer_Config XScuTimer_ConfigTable [XPAR_XSCUTIMER_NUM_INSTANCES]
-

Variable Documentation

-

- - - - -
- +

Variable Documentation

+ +
+
+
- +
XScuTimer_Config XScuTimer_ConfigTable[XPAR_XSCUTIMER_NUM_INSTANCES] XScuTimer_Config XScuTimer_ConfigTable[XPAR_XSCUTIMER_NUM_INSTANCES]
-
- - - - - -
-   - - -

+ +

Initial value:
 {
         {
                 XPAR_XSCUTIMER_0_DEVICE_ID,
                 XPAR_XSCUTIMER_0_BASEADDR
         }
 }
-
This table contains configuration information for each timer device in the system.
-Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. +

This table contains configuration information for each timer device in the system.

+ +
+ + +

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__hw_8h.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__hw_8h.html index 44d99013..e151cf69 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__hw_8h.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__hw_8h.html @@ -2,30 +2,71 @@ - xscutimer_hw.h File Reference + Xilinx Driver scutimer v2_0: xscutimer_hw.h File Reference - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-

xscutimer_hw.h File Reference

Detailed Description

-This file contains the hardware interface to the Timer.

+ + +

+
+

xscutimer_hw.h File Reference

#include "xil_types.h"
+#include "xil_io.h"
+#include "xil_assert.h"
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Defines

#define XSCUTIMER_HW_H
#define XScuTimer_SetLoadReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_LOAD_OFFSET, Value)
#define XScuTimer_GetLoadReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_LOAD_OFFSET)
#define XScuTimer_SetCounterReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_COUNTER_OFFSET, Value)
#define XScuTimer_GetCounterReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_COUNTER_OFFSET)
#define XScuTimer_SetControlReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_CONTROL_OFFSET, Value)
#define XScuTimer_GetControlReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_CONTROL_OFFSET)
#define XScuTimer_SetIntrReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_ISR_OFFSET, Value)
#define XScuTimer_GetIntrReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_ISR_OFFSET)
#define XScuTimer_ReadReg(BaseAddr, RegOffset)   Xil_In32((BaseAddr) + (RegOffset))
#define XScuTimer_WriteReg(BaseAddr, RegOffset, Data)   Xil_Out32((BaseAddr) + (RegOffset), (Data))
Register Map

Offsets of registers from the start of the device

+

#define XSCUTIMER_LOAD_OFFSET   0x00
#define XSCUTIMER_COUNTER_OFFSET   0x04
#define XSCUTIMER_CONTROL_OFFSET   0x08
#define XSCUTIMER_ISR_OFFSET   0x0C
Timer Control register

This register bits control the prescaler, Intr enable, auto-reload and timer enable.

+

#define XSCUTIMER_CONTROL_PRESCALER_MASK   0x0000FF00
#define XSCUTIMER_CONTROL_PRESCALER_SHIFT   8
#define XSCUTIMER_CONTROL_IRQ_ENABLE_MASK   0x00000004
#define XSCUTIMER_CONTROL_AUTO_RELOAD_MASK   0x00000002
#define XSCUTIMER_CONTROL_ENABLE_MASK   0x00000001
Interrupt Status register

This register indicates the Timer counter register has reached zero.

+

#define XSCUTIMER_ISR_EVENT_FLAG_MASK   0x00000001
+

Detailed Description

+

This file contains the hardware interface to the Timer.

- MODIFICATION HISTORY:

-

 Ver   Who Date     Changes
+ MODIFICATION HISTORY:
 Ver   Who Date     Changes
  ----- --- -------- ---------------------------------------------
  1.00a nm  03/10/10 First release
  1.01a sdm 02/02/12 Added low level macros to read/write load, counter, control
@@ -34,656 +75,474 @@ This file contains the hardware interface to the Timer.

 		     when the xstatus.h in the common driver overwrites
 		     the xstatus.h of the standalone BSP during the
 		     libgen.
-
-

-#include "xil_types.h"
-#include "xil_io.h"
-#include "xil_assert.h"
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Register Map

Offsets of registers from the start of the device

#define XSCUTIMER_LOAD_OFFSET   0x00
#define XSCUTIMER_COUNTER_OFFSET   0x04
#define XSCUTIMER_CONTROL_OFFSET   0x08
#define XSCUTIMER_ISR_OFFSET   0x0C

Timer Control register

This register bits control the prescaler, Intr enable, auto-reload and timer enable.

#define XSCUTIMER_CONTROL_PRESCALER_MASK   0x0000FF00
-#define XSCUTIMER_CONTROL_PRESCALER_SHIFT   8
#define XSCUTIMER_CONTROL_IRQ_ENABLE_MASK   0x00000004
#define XSCUTIMER_CONTROL_AUTO_RELOAD_MASK   0x00000002
#define XSCUTIMER_CONTROL_ENABLE_MASK   0x00000001

Interrupt Status register

This register indicates the Timer counter register has reached zero.

#define XSCUTIMER_ISR_EVENT_FLAG_MASK   0x00000001

Defines

#define XScuTimer_SetLoadReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_LOAD_OFFSET, Value)
#define XScuTimer_GetLoadReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_LOAD_OFFSET)
#define XScuTimer_SetCounterReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_COUNTER_OFFSET, Value)
#define XScuTimer_GetCounterReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_COUNTER_OFFSET)
#define XScuTimer_SetControlReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_CONTROL_OFFSET, Value)
#define XScuTimer_GetControlReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_CONTROL_OFFSET)
#define XScuTimer_SetIntrReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_ISR_OFFSET, Value)
#define XScuTimer_GetIntrReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_ISR_OFFSET)
#define XScuTimer_ReadReg(BaseAddr, RegOffset)   Xil_In32((BaseAddr) + (RegOffset))
#define XScuTimer_WriteReg(BaseAddr, RegOffset, Data)   Xil_Out32((BaseAddr) + (RegOffset), (Data))
-

Define Documentation

-

- - - - -
- +

Define Documentation

+ +
+
+
- +
#define XSCUTIMER_CONTROL_AUTO_RELOAD_MASK   0x00000002 #define XSCUTIMER_CONTROL_AUTO_RELOAD_MASK   0x00000002
-
- - - - - -
-   - + +
+

Auto-reload

-

-Auto-reload

-

- - - - -
- + + + +
+
+
- +
#define XSCUTIMER_CONTROL_ENABLE_MASK   0x00000001 #define XSCUTIMER_CONTROL_ENABLE_MASK   0x00000001
-
- - - - - -
-   - + +
+

Timer enable

-

-Timer enable

-

- - - - -
- + + + +
+
+
- +
#define XSCUTIMER_CONTROL_IRQ_ENABLE_MASK   0x00000004 #define XSCUTIMER_CONTROL_IRQ_ENABLE_MASK   0x00000004
-
- - - - - -
-   - + +
+

Intr enable

-

-Intr enable

-

- - - - -
- + + + +
+
+
- +
#define XSCUTIMER_CONTROL_OFFSET   0x08 #define XSCUTIMER_CONTROL_OFFSET   0x08
-
- - - - - -
-   - + +
+

Timer Control Register

-

-Timer Control Register

-

- - - - -
- + + + +
+
+
- +
#define XSCUTIMER_CONTROL_PRESCALER_MASK   0x0000FF00 #define XSCUTIMER_CONTROL_PRESCALER_MASK   0x0000FF00
-
- - - - - -
-   - + +
+

Prescaler

-

-Prescaler

-

- - - - -
- + + + +
+
+
- +
#define XSCUTIMER_COUNTER_OFFSET   0x04 #define XSCUTIMER_CONTROL_PRESCALER_SHIFT   8
-
- - - - - -
-   - + +
-

-Timer Counter Register

-

- - - - -
- + + + +
+
+
- - - - - - +
#define XScuTimer_GetControlReg ( BaseAddr   )    XScuTimer_ReadReg(BaseAddr, XSCUTIMER_CONTROL_OFFSET)#define XSCUTIMER_COUNTER_OFFSET   0x04
-
- - - - - -
-   - + +
+

Timer Counter Register

-

-Returns the current timer load register value.

-

Parameters:
+
+ + +
+
+ + + + + + + + + +
#define XScuTimer_GetControlReg(BaseAddr  )    XScuTimer_ReadReg(BaseAddr, XSCUTIMER_CONTROL_OFFSET)
+
+
+

Returns the current timer load register value.

+
Parameters:
BaseAddr is the base address of the scu timer.
+
-
Returns:
Contents of the timer load register.
-
Note:
C-style signature: u32 XScuTimer_GetControlReg(u32 BaseAddr)
-
-

- - - - -
- +
Returns:
Contents of the timer load register.
+
Note:
C-style signature: u32 XScuTimer_GetControlReg(u32 BaseAddr)
+ + + + +
+
+
- - - - - - + + + + + +
#define XScuTimer_GetCounterReg ( BaseAddr   )    XScuTimer_ReadReg(BaseAddr, XSCUTIMER_COUNTER_OFFSET)#define XScuTimer_GetCounterReg(BaseAddr  )    XScuTimer_ReadReg(BaseAddr, XSCUTIMER_COUNTER_OFFSET)
-
- - - - - -
-   - - -

-Returns the current timer counter register value.

-

Parameters:
+ +
+

Returns the current timer counter register value.

+
Parameters:
BaseAddr is the base address of the scu timer.
+
-
Returns:
Contents of the timer counter register.
-
Note:
C-style signature: u32 XScuTimer_GetCounterReg(u32 BaseAddr)
-
-

- - - - -
- +
Returns:
Contents of the timer counter register.
+
Note:
C-style signature: u32 XScuTimer_GetCounterReg(u32 BaseAddr)
+ + + + +
+
+
- - - - - - + + + + + +
#define XScuTimer_GetIntrReg ( BaseAddr   )    XScuTimer_ReadReg(BaseAddr, XSCUTIMER_ISR_OFFSET)#define XScuTimer_GetIntrReg(BaseAddr  )    XScuTimer_ReadReg(BaseAddr, XSCUTIMER_ISR_OFFSET)
-
- - - - - -
-   - - -

-Returns the current timer counter register value.

-

Parameters:
+ +
+

Returns the current timer counter register value.

+
Parameters:
BaseAddr is the base address of the scu timer.
+
-
Returns:
Contents of the timer counter register.
-
Note:
C-style signature: u32 XScuTimer_GetIntrReg(u32 BaseAddr)
-
-

- - - - -
- +
Returns:
Contents of the timer counter register.
+
Note:
C-style signature: u32 XScuTimer_GetIntrReg(u32 BaseAddr)
+ + + + +
+
+
- - - - - - + + + + + +
#define XScuTimer_GetLoadReg ( BaseAddr   )    XScuTimer_ReadReg(BaseAddr, XSCUTIMER_LOAD_OFFSET)#define XScuTimer_GetLoadReg(BaseAddr  )    XScuTimer_ReadReg(BaseAddr, XSCUTIMER_LOAD_OFFSET)
-
- - - - - -
-   - - -

-Returns the current timer load register value.

-

Parameters:
+ +
+

Returns the current timer load register value.

+
Parameters:
BaseAddr is the base address of the scu timer.
+
-
Returns:
Contents of the timer load register.
-
Note:
C-style signature: u32 XScuTimer_GetLoadReg(u32 BaseAddr)
-
-

- - - - -
- +
Returns:
Contents of the timer load register.
+
Note:
C-style signature: u32 XScuTimer_GetLoadReg(u32 BaseAddr)
+ + + + +
+
+
- +
#define XSCUTIMER_ISR_EVENT_FLAG_MASK   0x00000001 #define XSCUTIMER_HW_H
-
- - - - - -
-   - + +
-

-Event flag

-

- - - - -
- + + + +
+
+
- +
#define XSCUTIMER_ISR_OFFSET   0x0C #define XSCUTIMER_ISR_EVENT_FLAG_MASK   0x00000001
-
- - - - - -
-   - + +
+

Event flag

-

-Timer Interrupt Status Register

-

- - - - -
- + + + +
+
+
- +
#define XSCUTIMER_LOAD_OFFSET   0x00 #define XSCUTIMER_ISR_OFFSET   0x0C
-
- - - - - -
-   - + +
+

Timer Interrupt Status Register

-

-Timer Load Register

-

- - - - -
- + + + +
+
+
- - - - - - - - - +
#define XScuTimer_ReadReg ( BaseAddr,
RegOffset   )    Xil_In32((BaseAddr) + (RegOffset))#define XSCUTIMER_LOAD_OFFSET   0x00
-
- - - - - -
-   - + +
+

Timer Load Register

-

-Read from the given Timer register.

-

Parameters:
+
+ + +
+
+ + + + + + + + + + + + + + +
#define XScuTimer_ReadReg(BaseAddr,
RegOffset  )    Xil_In32((BaseAddr) + (RegOffset))
+
+
+

Read from the given Timer register.

+
Parameters:
BaseAddr is the base address of the device
RegOffset is the register offset to be read
+
-
Returns:
The 32-bit value of the register
-
Note:
C-style signature: u32 XScuTimer_ReadReg(u32 BaseAddr, u32 RegOffset)
-
-

- - - - -
- +
Returns:
The 32-bit value of the register
+
Note:
C-style signature: u32 XScuTimer_ReadReg(u32 BaseAddr, u32 RegOffset)
+ + + + +
+
+
- - - - - - - - - + + + + + + + + + + +
#define XScuTimer_SetControlReg ( BaseAddr,
Value   )    XScuTimer_WriteReg(BaseAddr, XSCUTIMER_CONTROL_OFFSET, Value)#define XScuTimer_SetControlReg(BaseAddr,
Value  )    XScuTimer_WriteReg(BaseAddr, XSCUTIMER_CONTROL_OFFSET, Value)
-
- - - - - -
-   - - -

-Write to the timer load register. This will also update the timer counter register with the new value. This macro can be used to change the time-out value.

-

Parameters:
+ +
+

Write to the timer load register. This will also update the timer counter register with the new value. This macro can be used to change the time-out value.

+
Parameters:
BaseAddr is the base address of the scu timer.
Value is the count to be loaded in to the load register.
+
-
Returns:
None.
-
Note:
C-style signature: void XScuTimer_SetControlReg(u32 BaseAddr, u32 Value)
-
-

- - - - -
- +
Returns:
None.
+
Note:
C-style signature: void XScuTimer_SetControlReg(u32 BaseAddr, u32 Value)
+ + + + +
+
+
- - - - - - - - - + + + + + + + + + + +
#define XScuTimer_SetCounterReg ( BaseAddr,
Value   )    XScuTimer_WriteReg(BaseAddr, XSCUTIMER_COUNTER_OFFSET, Value)#define XScuTimer_SetCounterReg(BaseAddr,
Value  )    XScuTimer_WriteReg(BaseAddr, XSCUTIMER_COUNTER_OFFSET, Value)
-
- - - - - -
-   - - -

-Write to the timer counter register.

-

Parameters:
+ +
+

Write to the timer counter register.

+
Parameters:
BaseAddr is the base address of the scu timer.
Value is the count to be loaded in to the counter register.
+
-
Returns:
None.
-
Note:
C-style signature: void XScuTimer_SetCounterReg(u32 BaseAddr, u32 Value)
-
-

- - - - -
- +
Returns:
None.
+
Note:
C-style signature: void XScuTimer_SetCounterReg(u32 BaseAddr, u32 Value)
+ + + + +
+
+
- - - - - - - - - + + + + + + + + + + +
#define XScuTimer_SetIntrReg ( BaseAddr,
Value   )    XScuTimer_WriteReg(BaseAddr, XSCUTIMER_ISR_OFFSET, Value)#define XScuTimer_SetIntrReg(BaseAddr,
Value  )    XScuTimer_WriteReg(BaseAddr, XSCUTIMER_ISR_OFFSET, Value)
-
- - - - - -
-   - - -

-Write to the timer counter register.

-

Parameters:
+ +
+

Write to the timer counter register.

+
Parameters:
BaseAddr is the base address of the scu timer.
Value is the count to be loaded in to the counter register.
+
-
Returns:
None.
-
Note:
C-style signature: void XScuTimer_SetIntrReg(u32 BaseAddr, u32 Value)
-
-

- - - - -
- +
Returns:
None.
+
Note:
C-style signature: void XScuTimer_SetIntrReg(u32 BaseAddr, u32 Value)
+ + + + +
+
+
- - - - - - - - - + + + + + + + + + + +
#define XScuTimer_SetLoadReg ( BaseAddr,
Value   )    XScuTimer_WriteReg(BaseAddr, XSCUTIMER_LOAD_OFFSET, Value)#define XScuTimer_SetLoadReg(BaseAddr,
Value  )    XScuTimer_WriteReg(BaseAddr, XSCUTIMER_LOAD_OFFSET, Value)
-
- - - - - -
-   - - -

-Write to the timer load register. This will also update the timer counter register with the new value. This macro can be used to change the time-out value.

-

Parameters:
+ +
+

Write to the timer load register. This will also update the timer counter register with the new value. This macro can be used to change the time-out value.

+
Parameters:
BaseAddr is the base address of the scu timer.
Value is the count to be loaded in to the load register.
+
-
Returns:
None.
-
Note:
C-style signature: void XScuTimer_SetLoadReg(u32 BaseAddr, u32 Value)
-
-

- - - - -
- +
Returns:
None.
+
Note:
C-style signature: void XScuTimer_SetLoadReg(u32 BaseAddr, u32 Value)
+ + + + +
+
+
- - - - - - - - - - - - + + + + + + + + + + + + + + + +
#define XScuTimer_WriteReg ( BaseAddr,
RegOffset,
Data   )    Xil_Out32((BaseAddr) + (RegOffset), (Data))#define XScuTimer_WriteReg(BaseAddr,
RegOffset,
Data  )    Xil_Out32((BaseAddr) + (RegOffset), (Data))
-
- - - - - -
-   - - -

-Write to the given Timer register.

-

Parameters:
+ +
+

Write to the given Timer register.

+
Parameters:
BaseAddr is the base address of the device
RegOffset is the register offset to be written
Data is the 32-bit value to write to the register
+
-
Returns:
None.
-
Note:
C-style signature: void XScuTimer_WriteReg(u32 BaseAddr, u32 RegOffset, u32 Data)
-
-Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. +

Returns:
None.
+
Note:
C-style signature: void XScuTimer_WriteReg(u32 BaseAddr, u32 RegOffset, u32 Data)
+ +
+ + +

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__selftest_8c.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__selftest_8c.html index 9166b48c..b5d16cea 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__selftest_8c.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__selftest_8c.html @@ -2,78 +2,93 @@ - xscutimer_selftest.c File Reference + Xilinx Driver scutimer v2_0: xscutimer_selftest.c File Reference - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-

xscutimer_selftest.c File Reference

Detailed Description

-Contains diagnostic self-test functions for the XScuTimer driver.

+ + +

+
+

xscutimer_selftest.c File Reference

#include "xscutimer.h"
+ + + + + +

Defines

#define XSCUTIMER_SELFTEST_VALUE   0xA55AF00F

Functions

int XScuTimer_SelfTest (XScuTimer *InstancePtr)
+

Detailed Description

+

Contains diagnostic self-test functions for the XScuTimer driver.

- MODIFICATION HISTORY:

-

 Ver   Who Date     Changes
+ MODIFICATION HISTORY:
 Ver   Who Date     Changes
  ----- --- -------- ---------------------------------------------
  1.00a nm  03/10/10 First release
-
-

-#include "xscutimer.h"
- - - - - -

Functions

int XScuTimer_SelfTest (XScuTimer *InstancePtr)
-

Function Documentation

-

- - - - -
- +

Define Documentation

+ +
+
+
- - - - - - +
int XScuTimer_SelfTest ( XScuTimer *  InstancePtr  ) #define XSCUTIMER_SELFTEST_VALUE   0xA55AF00F
-
- - - - - -
-   - + +
-

-Run a self-test on the timer. This test clears the timer enable bit in the control register, writes to the timer load register and verifies the value read back matches the value written and restores the control register and the timer load register.

-

Parameters:
+
+ +

Function Documentation

+ +
+
+ + + + + + + + + +
int XScuTimer_SelfTest (XScuTimer *  InstancePtr ) 
+
+
+

Run a self-test on the timer. This test clears the timer enable bit in the control register, writes to the timer load register and verifies the value read back matches the value written and restores the control register and the timer load register.

+
Parameters:
InstancePtr is a pointer to the XScuTimer instance.
+
-
Returns:
    -
  • XST_SUCCESS if self-test was successful.
  • XST_FAILURE if self test was not successful.
+
Returns:
    +
  • XST_SUCCESS if self-test was successful.
    • +
  • XST_FAILURE if self test was not successful.
    • +
-
Note:
None.
-
-Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. +

Note:
None.
+ +
+ + +

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ + diff --git a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__sinit_8c.html b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__sinit_8c.html index ce93ab8a..7af74b06 100755 --- a/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__sinit_8c.html +++ b/XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__sinit_8c.html @@ -2,77 +2,74 @@ - xscutimer_sinit.c File Reference + Xilinx Driver scutimer v2_0: xscutimer_sinit.c File Reference - +

Xilinx Processor IP Library

Software Drivers
- -
-
-
-
-

xscutimer_sinit.c File Reference

Detailed Description

-This file contains method for static initialization (compile-time) of the driver.

+ + +

+
+

xscutimer_sinit.c File Reference

#include "xscutimer.h"
+#include "xparameters.h"
+ + + +

Functions

XScuTimer_Config * XScuTimer_LookupConfig (u16 DeviceId)
+

Detailed Description

+

This file contains method for static initialization (compile-time) of the driver.

- MODIFICATION HISTORY:

-

 Ver   Who Date     Changes
+ MODIFICATION HISTORY:
 Ver   Who Date     Changes
  ----- --- -------- ---------------------------------------------
  1.00a nm  03/10/10 First release
-
-

-#include "xscutimer.h"
-#include "xparameters.h"
- - - - - -

Functions

XScuTimer_Config * XScuTimer_LookupConfig (u16 DeviceId)
-

Function Documentation

-

- - - - -
- +

Function Documentation

+ +
+
+
- - - - - - + + + + + +
XScuTimer_Config* XScuTimer_LookupConfig ( u16  DeviceId  ) XScuTimer_Config* XScuTimer_LookupConfig (u16  DeviceId ) 
-
- - - - - -
-   - - -

-Lookup the device configuration based on the unique device ID. The table contains the configuration info for each device in the system.

-

Parameters:
+ +
+

Lookup the device configuration based on the unique device ID. The table contains the configuration info for each device in the system.

+
Parameters:
DeviceId is the unique device ID of the device being looked up.
+
-
Returns:
A pointer to the configuration table entry corresponding to the given device ID, or NULL if no match is found.
-
Note:
None.
-
-Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. +

Returns:
A pointer to the configuration table entry corresponding to the given device ID, or NULL if no match is found.
+
Note:
None.
+ +
+ + +

+Copyright © 1995-2014 Xilinx, Inc. All rights reserved. +

+ +