Skip to content

Commit 0cae9b2

Browse files
will-v-piwill-v-pi
committed
Update documentation
From SDK 2.1.0, with PR 2099 and commit ba7aa3f cherry picked on top
1 parent c5541f8 commit 0cae9b2

File tree

1,650 files changed

+14777
-37620
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,650 files changed

+14777
-37620
lines changed

‎web/docs/SEGGER__RTT_8h_source.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<div class="logo">
4141
<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
4242
<span style="display: inline-block; margin-top: 10px;">
43-
v2.0.0
43+
v2.1.0
4444
</span>
4545
</div>
4646
<div class="navigation-footer">

‎web/docs/SEGGER__RTT__Conf_8h_source.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<div class="logo">
4141
<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
4242
<span style="display: inline-block; margin-top: 10px;">
43-
v2.0.0
43+
v2.1.0
4444
</span>
4545
</div>
4646
<div class="navigation-footer">

‎web/docs/accessctrl_8h_source.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<div class="logo">
4141
<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
4242
<span style="display: inline-block; margin-top: 10px;">
43-
v2.0.0
43+
v2.1.0
4444
</span>
4545
</div>
4646
<div class="navigation-footer">

‎web/docs/address__mapped_8h.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<div class="logo">
4141
<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
4242
<span style="display: inline-block; margin-top: 10px;">
43-
v2.0.0
43+
v2.1.0
4444
</span>
4545
</div>
4646
<div class="navigation-footer">
@@ -261,4 +261,4 @@
261261

262262
<script src="main.js"></script>
263263
</body>
264-
</html>
264+
</html>

‎web/docs/address__mapped_8h_source.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<div class="logo">
4141
<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
4242
<span style="display: inline-block; margin-top: 10px;">
43-
v2.0.0
43+
v2.1.0
4444
</span>
4545
</div>
4646
<div class="navigation-footer">

‎web/docs/annotated.html‎

Lines changed: 150 additions & 156 deletions
Large diffs are not rendered by default.

‎web/docs/aon__timer_8h.html‎

Lines changed: 51 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<div class="logo">
4141
<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
4242
<span style="display: inline-block; margin-top: 10px;">
43-
v2.0.0
43+
v2.1.0
4444
</span>
4545
</div>
4646
<div class="navigation-footer">
@@ -117,31 +117,31 @@
117117
<div class="dyncontent">
118118
<div class="center"><img src="aon__timer_8h__incl.png" border="0" usemap="#ainclude_2pico_2aon__timer_8h" alt=""/></div>
119119
<map name="ainclude_2pico_2aon__timer_8h" id="ainclude_2pico_2aon__timer_8h">
120-
<area shape="rect" title=" " alt="" coords="633,5,814,32"/>
121-
<area shape="rect" href="pico_8h.html" title=" " alt="" coords="558,155,619,181"/>
122-
<area shape="rect" title=" " alt="" coords="626,80,690,107"/>
123-
<area shape="rect" href="datetime_8h.html" title=" " alt="" coords="714,80,863,107"/>
124-
<area shape="rect" title=" " alt="" coords="888,80,1057,107"/>
125-
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="158,393,259,420"/>
126-
<area shape="rect" title=" " alt="" coords="329,237,443,263"/>
127-
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="467,237,571,263"/>
128-
<area shape="rect" href="platform_8h.html" title=" " alt="" coords="596,237,717,263"/>
129-
<area shape="rect" href="error_8h_source.html" title=" " alt="" coords="741,237,836,263"/>
130-
<area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="5,468,111,495"/>
131-
<area shape="rect" title=" " alt="" coords="74,543,157,569"/>
132-
<area shape="rect" title=" " alt="" coords="211,468,281,495"/>
133-
<area shape="rect" title=" " alt="" coords="306,468,381,495"/>
134-
<area shape="rect" title=" " alt="" coords="173,319,337,345"/>
135-
<area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="362,319,543,345"/>
136-
<area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="567,319,746,345"/>
137-
<area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="770,319,930,345"/>
138-
<area shape="rect" title=" " alt="" coords="954,319,1165,345"/>
139-
<area shape="rect" title=" " alt="" coords="1189,319,1340,345"/>
140-
<area shape="rect" title=" " alt="" coords="357,393,548,420"/>
141-
<area shape="rect" href="rp2__common_2pico__clib__interface_2include_2llvm__libc_2sys_2time_8h_source.html" title=" " alt="" coords="997,155,1087,181"/>
142-
<area shape="rect" title=" " alt="" coords="860,237,1027,263"/>
143-
<area shape="rect" title=" " alt="" coords="1051,237,1230,263"/>
144-
<area shape="rect" title=" " alt="" coords="1255,229,1416,271"/>
120+
<area shape="rect" title=" " alt="" coords="1366,5,1547,32"/>
121+
<area shape="rect" href="pico_8h.html" title=" " alt="" coords="1090,155,1151,181"/>
122+
<area shape="rect" title=" " alt="" coords="1481,155,1545,181"/>
123+
<area shape="rect" href="datetime_8h.html" title=" " alt="" coords="1326,80,1475,107"/>
124+
<area shape="rect" title=" " alt="" coords="1551,80,1720,107"/>
125+
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="598,393,699,420"/>
126+
<area shape="rect" title=" " alt="" coords="1064,237,1177,263"/>
127+
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="1202,237,1306,263"/>
128+
<area shape="rect" href="platform_8h.html" title=" " alt="" coords="543,237,664,263"/>
129+
<area shape="rect" href="error_8h_source.html" title=" " alt="" coords="893,237,988,263"/>
130+
<area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="444,468,549,495"/>
131+
<area shape="rect" title=" " alt="" coords="513,543,595,569"/>
132+
<area shape="rect" title=" " alt="" coords="649,468,720,495"/>
133+
<area shape="rect" title=" " alt="" coords="745,468,819,495"/>
134+
<area shape="rect" title=" " alt="" coords="1172,319,1336,345"/>
135+
<area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="10,319,191,345"/>
136+
<area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="215,319,394,345"/>
137+
<area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="418,319,578,345"/>
138+
<area shape="rect" title=" " alt="" coords="602,319,813,345"/>
139+
<area shape="rect" title=" " alt="" coords="837,319,988,345"/>
140+
<area shape="rect" title=" " alt="" coords="5,393,196,420"/>
141+
<area shape="rect" href="rp2__common_2pico__clib__interface_2include_2llvm__libc_2sys_2time_8h_source.html" title=" " alt="" coords="1366,155,1457,181"/>
142+
<area shape="rect" title=" " alt="" coords="1516,237,1683,263"/>
143+
<area shape="rect" title=" " alt="" coords="1707,237,1886,263"/>
144+
<area shape="rect" title=" " alt="" coords="1331,229,1492,271"/>
145145
</map>
146146
</div>
147147
</div>
@@ -155,29 +155,40 @@
155155
</table><table class="memberdecls">
156156
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
157157
Functions</h2></td></tr>
158-
<tr class="memitem:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="memItemLeft" align="right" valign="top">
159-
void&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_start_with_timeofday</b> (void)</td></tr>
160-
<tr class="memdesc:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the AON timer running using the result from the gettimeofday() function as the current time. <br /></td></tr>
158+
<tr class="memitem:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga32e4d69ae8c5b2048af84cf706b8b997">aon_timer_start_with_timeofday</a> (void)</td></tr>
159+
<tr class="memdesc:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the AON timer running using the result from the gettimeofday() function as the current time. <a href="group__pico__aon__timer.html#ga32e4d69ae8c5b2048af84cf706b8b997">More...</a><br /></td></tr>
161160
<tr class="separator:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="memSeparator" colspan="2">&#160;</td></tr>
162-
<tr class="memitem:ga937223c53432fc9b5fe5252c9712078a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga937223c53432fc9b5fe5252c9712078a">aon_timer_start</a> (const struct timespec *ts)</td></tr>
163-
<tr class="memdesc:ga937223c53432fc9b5fe5252c9712078a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the AON timer running using the specified timespec as the current time. <a href="group__pico__aon__timer.html#ga937223c53432fc9b5fe5252c9712078a">More...</a><br /></td></tr>
164-
<tr class="separator:ga937223c53432fc9b5fe5252c9712078a"><td class="memSeparator" colspan="2">&#160;</td></tr>
161+
<tr class="memitem:ga1d9876f6ebad5960e8d7928b87d6b8ca"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga1d9876f6ebad5960e8d7928b87d6b8ca">aon_timer_start</a> (const struct timespec *ts)</td></tr>
162+
<tr class="memdesc:ga1d9876f6ebad5960e8d7928b87d6b8ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the AON timer running using the specified timespec as the current time. <a href="group__pico__aon__timer.html#ga1d9876f6ebad5960e8d7928b87d6b8ca">More...</a><br /></td></tr>
163+
<tr class="separator:ga1d9876f6ebad5960e8d7928b87d6b8ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
164+
<tr class="memitem:ga25e4ac9d9553d35646af544277ca9e4e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga25e4ac9d9553d35646af544277ca9e4e">aon_timer_start_calendar</a> (const struct tm *tm)</td></tr>
165+
<tr class="memdesc:ga25e4ac9d9553d35646af544277ca9e4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the AON timer running using the specified calendar date/time as the current time. <a href="group__pico__aon__timer.html#ga25e4ac9d9553d35646af544277ca9e4e">More...</a><br /></td></tr>
166+
<tr class="separator:ga25e4ac9d9553d35646af544277ca9e4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
165167
<tr class="memitem:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="memItemLeft" align="right" valign="top">
166168
void&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_stop</b> (void)</td></tr>
167169
<tr class="memdesc:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the AON timer. <br /></td></tr>
168170
<tr class="separator:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
169-
<tr class="memitem:ga271d25359d58cd63ca24ec315dd72c4a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga271d25359d58cd63ca24ec315dd72c4a">aon_timer_set_time</a> (const struct timespec *ts)</td></tr>
170-
<tr class="memdesc:ga271d25359d58cd63ca24ec315dd72c4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update the current time of the AON timer. <a href="group__pico__aon__timer.html#ga271d25359d58cd63ca24ec315dd72c4a">More...</a><br /></td></tr>
171-
<tr class="separator:ga271d25359d58cd63ca24ec315dd72c4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
172-
<tr class="memitem:ga5e61345c450ef3aa217411104ae8f2e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga5e61345c450ef3aa217411104ae8f2e3">aon_timer_get_time</a> (struct timespec *ts)</td></tr>
173-
<tr class="memdesc:ga5e61345c450ef3aa217411104ae8f2e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current time of the AON timer. <a href="group__pico__aon__timer.html#ga5e61345c450ef3aa217411104ae8f2e3">More...</a><br /></td></tr>
174-
<tr class="separator:ga5e61345c450ef3aa217411104ae8f2e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
171+
<tr class="memitem:gaa9503489fbd3c6afc1d4e67e3c3ae1dc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#gaa9503489fbd3c6afc1d4e67e3c3ae1dc">aon_timer_set_time</a> (const struct timespec *ts)</td></tr>
172+
<tr class="memdesc:gaa9503489fbd3c6afc1d4e67e3c3ae1dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current time of the AON timer. <a href="group__pico__aon__timer.html#gaa9503489fbd3c6afc1d4e67e3c3ae1dc">More...</a><br /></td></tr>
173+
<tr class="separator:gaa9503489fbd3c6afc1d4e67e3c3ae1dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
174+
<tr class="memitem:gae3b326fe02569768b09f37080f0d85e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#gae3b326fe02569768b09f37080f0d85e3">aon_timer_set_time_calendar</a> (const struct tm *tm)</td></tr>
175+
<tr class="memdesc:gae3b326fe02569768b09f37080f0d85e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current time of the AON timer to the given calendar date/time. <a href="group__pico__aon__timer.html#gae3b326fe02569768b09f37080f0d85e3">More...</a><br /></td></tr>
176+
<tr class="separator:gae3b326fe02569768b09f37080f0d85e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
177+
<tr class="memitem:ga48246c7cd89f2f599f9d3405d1b62185"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga48246c7cd89f2f599f9d3405d1b62185">aon_timer_get_time</a> (struct timespec *ts)</td></tr>
178+
<tr class="memdesc:ga48246c7cd89f2f599f9d3405d1b62185"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current time of the AON timer. <a href="group__pico__aon__timer.html#ga48246c7cd89f2f599f9d3405d1b62185">More...</a><br /></td></tr>
179+
<tr class="separator:ga48246c7cd89f2f599f9d3405d1b62185"><td class="memSeparator" colspan="2">&#160;</td></tr>
180+
<tr class="memitem:ga5ed3f772e4fcab66dadb7654f1fa47ef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga5ed3f772e4fcab66dadb7654f1fa47ef">aon_timer_get_time_calendar</a> (struct tm *tm)</td></tr>
181+
<tr class="memdesc:ga5ed3f772e4fcab66dadb7654f1fa47ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current time of the AON timer as a calendar date/time. <a href="group__pico__aon__timer.html#ga5ed3f772e4fcab66dadb7654f1fa47ef">More...</a><br /></td></tr>
182+
<tr class="separator:ga5ed3f772e4fcab66dadb7654f1fa47ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
175183
<tr class="memitem:ga6e17d6adde0e3b25c70c04970116ccb8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga6e17d6adde0e3b25c70c04970116ccb8">aon_timer_get_resolution</a> (struct timespec *ts)</td></tr>
176184
<tr class="memdesc:ga6e17d6adde0e3b25c70c04970116ccb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the resolution of the AON timer. <a href="group__pico__aon__timer.html#ga6e17d6adde0e3b25c70c04970116ccb8">More...</a><br /></td></tr>
177185
<tr class="separator:ga6e17d6adde0e3b25c70c04970116ccb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
178186
<tr class="memitem:ga39dab1da58c2f8178024b233e335d059"><td class="memItemLeft" align="right" valign="top">aon_timer_alarm_handler_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga39dab1da58c2f8178024b233e335d059">aon_timer_enable_alarm</a> (const struct timespec *ts, aon_timer_alarm_handler_t handler, bool wakeup_from_low_power)</td></tr>
179-
<tr class="memdesc:ga39dab1da58c2f8178024b233e335d059"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable an AON timer alarm for a specifed time. <a href="group__pico__aon__timer.html#ga39dab1da58c2f8178024b233e335d059">More...</a><br /></td></tr>
187+
<tr class="memdesc:ga39dab1da58c2f8178024b233e335d059"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable an AON timer alarm for a specified time. <a href="group__pico__aon__timer.html#ga39dab1da58c2f8178024b233e335d059">More...</a><br /></td></tr>
180188
<tr class="separator:ga39dab1da58c2f8178024b233e335d059"><td class="memSeparator" colspan="2">&#160;</td></tr>
189+
<tr class="memitem:gabfecbe6df690a2a10194920ba7db8d3f"><td class="memItemLeft" align="right" valign="top">aon_timer_alarm_handler_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#gabfecbe6df690a2a10194920ba7db8d3f">aon_timer_enable_alarm_calendar</a> (const struct tm *tm, aon_timer_alarm_handler_t handler, bool wakeup_from_low_power)</td></tr>
190+
<tr class="memdesc:gabfecbe6df690a2a10194920ba7db8d3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable an AON timer alarm for a specified calendar date/time. <a href="group__pico__aon__timer.html#gabfecbe6df690a2a10194920ba7db8d3f">More...</a><br /></td></tr>
191+
<tr class="separator:gabfecbe6df690a2a10194920ba7db8d3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
181192
<tr class="memitem:ga20cda0289aab2eb5fda914704a1fc2a7"><td class="memItemLeft" align="right" valign="top">
182193
void&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_disable_alarm</b> (void)</td></tr>
183194
<tr class="memdesc:ga20cda0289aab2eb5fda914704a1fc2a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the currently enabled AON timer alarm if any. <br /></td></tr>
@@ -194,4 +205,4 @@
194205

195206
<script src="main.js"></script>
196207
</body>
197-
</html>
208+
</html>

0 commit comments

Comments
 (0)