You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1901 lines
200 KiB
HTML

<!-- HTML header for doxygen 1.8.7-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.6.3"/>
<!--BEGIN PROJECT_NAME--><title>avr-libc: avr-libc: pgmspace.h Source File</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>avr-libc: pgmspace.h Source File</title><!--END !PROJECT_NAME-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
$search
$mathjax
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!--BEGIN TITLEAREA-->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<!--BEGIN PROJECT_LOGO-->
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<td style="padding-left: 0.5em;">
<div id="projectname">avr-libc
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">2.0.0</span><!--END PROJECT_NUMBER-->
</div>
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
</td>
<!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME-->
<!--BEGIN PROJECT_BRIEF-->
<td style="padding-left: 0.5em;">
<div id="projectbrief">$projectbrief</div>
</td>
<!--END PROJECT_BRIEF-->
<!--END !PROJECT_NAME-->
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN SEARCHENGINE-->
<td>$searchbox</td>
<!--END SEARCHENGINE-->
<!--END DISABLE_INDEX-->
</tr>
</tbody>
</table>
<table>
<tr>
<td align="left"><a href="http://www.nongnu.org/avr-libc/"><h2>AVR Libc Home Page</h2></a></td>
<td align="center" colspan=4><img src="avrs.png" alt="AVRs" align="middle" border="0"></td>
<td align="right"><a href="https://savannah.nongnu.org/projects/avr-libc/"><h2>AVR Libc Development Pages</h2></a></td>
</tr>
<tr>
<td align="center" width="20%"><a href="index.html"><h2>Main Page</h2></a></td>
<td align="center" width="20%"><a href="pages.html"><h2>User Manual</h2></a></td>
<td align="center" width="20%"><a href="modules.html"><h2>Library Reference</h2></a></td>
<td align="center" width="20%"><a href="FAQ.html"><h2>FAQ</h2></a></td>
<td align="center" width="20%"><a href="group__demos.html"><h2>Example Projects</h2></a></td>
</tr>
</table>
</div>
<!--END TITLEAREA-->
<!-- end header part -->
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<h1>pgmspace.h</h1><a href="pgmspace_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Copyright (c) 2002-2007 Marek Michalkiewicz</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (c) 2006, Carlos Lamas</span>
<a name="l00003"></a>00003 <span class="comment"> Copyright (c) 2009-2010, Jan Waclawek</span>
<a name="l00004"></a>00004 <span class="comment"> All rights reserved.</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> Redistribution and use in source and binary forms, with or without</span>
<a name="l00007"></a>00007 <span class="comment"> modification, are permitted provided that the following conditions are met:</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> * Redistributions of source code must retain the above copyright</span>
<a name="l00010"></a>00010 <span class="comment"> notice, this list of conditions and the following disclaimer.</span>
<a name="l00011"></a>00011 <span class="comment"> * Redistributions in binary form must reproduce the above copyright</span>
<a name="l00012"></a>00012 <span class="comment"> notice, this list of conditions and the following disclaimer in</span>
<a name="l00013"></a>00013 <span class="comment"> the documentation and/or other materials provided with the</span>
<a name="l00014"></a>00014 <span class="comment"> distribution.</span>
<a name="l00015"></a>00015 <span class="comment"> * Neither the name of the copyright holders nor the names of</span>
<a name="l00016"></a>00016 <span class="comment"> contributors may be used to endorse or promote products derived</span>
<a name="l00017"></a>00017 <span class="comment"> from this software without specific prior written permission.</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment"> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot;</span>
<a name="l00020"></a>00020 <span class="comment"> AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
<a name="l00021"></a>00021 <span class="comment"> IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span>
<a name="l00022"></a>00022 <span class="comment"> ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span>
<a name="l00023"></a>00023 <span class="comment"> LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span>
<a name="l00024"></a>00024 <span class="comment"> CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span>
<a name="l00025"></a>00025 <span class="comment"> SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span>
<a name="l00026"></a>00026 <span class="comment"> INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span>
<a name="l00027"></a>00027 <span class="comment"> CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span>
<a name="l00028"></a>00028 <span class="comment"> ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span>
<a name="l00029"></a>00029 <span class="comment"> POSSIBILITY OF SUCH DAMAGE. */</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="comment">/* $Id$ */</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="comment">/*</span>
<a name="l00034"></a>00034 <span class="comment"> pgmspace.h</span>
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment"> Contributors:</span>
<a name="l00037"></a>00037 <span class="comment"> Created by Marek Michalkiewicz &lt;marekm@linux.org.pl&gt;</span>
<a name="l00038"></a>00038 <span class="comment"> Eric B. Weddington &lt;eric@ecentral.com&gt;</span>
<a name="l00039"></a>00039 <span class="comment"> Wolfgang Haidinger &lt;wh@vmars.tuwien.ac.at&gt; (pgm_read_dword())</span>
<a name="l00040"></a>00040 <span class="comment"> Ivanov Anton &lt;anton@arc.com.ru&gt; (pgm_read_float())</span>
<a name="l00041"></a>00041 <span class="comment"> */</span>
<a name="l00042"></a>00042 <span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment">/** \file */</span><span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment">/** \defgroup avr_pgmspace &lt;avr/pgmspace.h&gt;: Program Space Utilities</span>
<a name="l00045"></a>00045 <span class="comment"> \code</span>
<a name="l00046"></a>00046 <span class="comment"> #include &lt;avr/io.h&gt;</span>
<a name="l00047"></a>00047 <span class="comment"> #include &lt;avr/pgmspace.h&gt;</span>
<a name="l00048"></a>00048 <span class="comment"> \endcode</span>
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment"> The functions in this module provide interfaces for a program to access</span>
<a name="l00051"></a>00051 <span class="comment"> data stored in program space (flash memory) of the device. In order to</span>
<a name="l00052"></a>00052 <span class="comment"> use these functions, the target device must support either the \c LPM or</span>
<a name="l00053"></a>00053 <span class="comment"> \c ELPM instructions.</span>
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment"> \note These functions are an attempt to provide some compatibility with</span>
<a name="l00056"></a>00056 <span class="comment"> header files that come with IAR C, to make porting applications between</span>
<a name="l00057"></a>00057 <span class="comment"> different compilers easier. This is not 100% compatibility though (GCC</span>
<a name="l00058"></a>00058 <span class="comment"> does not have full support for multiple address spaces yet).</span>
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment"> \note If you are working with strings which are completely based in ram,</span>
<a name="l00061"></a>00061 <span class="comment"> use the standard string functions described in \ref avr_string.</span>
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> \note If possible, put your constant tables in the lower 64 KB and use</span>
<a name="l00064"></a>00064 <span class="comment"> pgm_read_byte_near() or pgm_read_word_near() instead of</span>
<a name="l00065"></a>00065 <span class="comment"> pgm_read_byte_far() or pgm_read_word_far() since it is more efficient that</span>
<a name="l00066"></a>00066 <span class="comment"> way, and you can still use the upper 64K for executable code.</span>
<a name="l00067"></a>00067 <span class="comment"> All functions that are suffixed with a \c _P \e require their</span>
<a name="l00068"></a>00068 <span class="comment"> arguments to be in the lower 64 KB of the flash ROM, as they do</span>
<a name="l00069"></a>00069 <span class="comment"> not use ELPM instructions. This is normally not a big concern as</span>
<a name="l00070"></a>00070 <span class="comment"> the linker setup arranges any program space constants declared</span>
<a name="l00071"></a>00071 <span class="comment"> using the macros from this header file so they are placed right after</span>
<a name="l00072"></a>00072 <span class="comment"> the interrupt vectors, and in front of any executable code. However,</span>
<a name="l00073"></a>00073 <span class="comment"> it can become a problem if there are too many of these constants, or</span>
<a name="l00074"></a>00074 <span class="comment"> for bootloaders on devices with more than 64 KB of ROM.</span>
<a name="l00075"></a>00075 <span class="comment"> &lt;em&gt;All these functions will not work in that situation.&lt;/em&gt;</span>
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> \note For &lt;b&gt;Xmega&lt;/b&gt; devices, make sure the NVM controller</span>
<a name="l00078"></a>00078 <span class="comment"> command register (\c NVM.CMD or \c NVM_CMD) is set to 0x00 (NOP)</span>
<a name="l00079"></a>00079 <span class="comment"> before using any of these functions.</span>
<a name="l00080"></a>00080 <span class="comment">*/</span>
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="preprocessor">#ifndef __PGMSPACE_H_</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span><span class="preprocessor">#define __PGMSPACE_H_ 1</span>
<a name="l00084"></a>00084 <span class="preprocessor"></span>
<a name="l00085"></a>00085 <span class="preprocessor">#ifndef __DOXYGEN__</span>
<a name="l00086"></a>00086 <span class="preprocessor"></span><span class="preprocessor">#define __need_size_t</span>
<a name="l00087"></a>00087 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00088"></a>00088 <span class="preprocessor"></span><span class="preprocessor">#include &lt;<a class="code" href="inttypes_8h.html">inttypes.h</a>&gt;</span>
<a name="l00089"></a>00089 <span class="preprocessor">#include &lt;stddef.h&gt;</span>
<a name="l00090"></a>00090 <span class="preprocessor">#include &lt;<a class="code" href="io_8h.html">avr/io.h</a>&gt;</span>
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="preprocessor">#ifndef __DOXYGEN__</span>
<a name="l00093"></a>00093 <span class="preprocessor"></span><span class="preprocessor">#ifndef __ATTR_CONST__</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor">#define __ATTR_CONST__ __attribute__((__const__))</span>
<a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span>
<a name="l00097"></a>00097 <span class="preprocessor">#ifndef __ATTR_PROGMEM__</span>
<a name="l00098"></a>00098 <span class="preprocessor"></span><span class="preprocessor">#define __ATTR_PROGMEM__ __attribute__((__progmem__))</span>
<a name="l00099"></a>00099 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span>
<a name="l00101"></a>00101 <span class="preprocessor">#ifndef __ATTR_PURE__</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span><span class="preprocessor">#define __ATTR_PURE__ __attribute__((__pure__))</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00104"></a>00104 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* !__DOXYGEN__ */</span>
<a name="l00105"></a>00105 <span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment">/**</span>
<a name="l00107"></a>00107 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00108"></a>00108 <span class="comment"> \def PROGMEM</span>
<a name="l00109"></a>00109 <span class="comment"></span>
<a name="l00110"></a>00110 <span class="comment"> Attribute to use in order to declare an object being located in</span>
<a name="l00111"></a>00111 <span class="comment"> flash ROM.</span>
<a name="l00112"></a>00112 <span class="comment"> */</span>
<a name="l00113"></a><a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">00113</a> <span class="preprocessor">#define PROGMEM __ATTR_PROGMEM__</span>
<a name="l00114"></a>00114 <span class="preprocessor"></span>
<a name="l00115"></a>00115 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00116"></a>00116 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
<a name="l00117"></a>00117 <span class="preprocessor">#endif</span>
<a name="l00118"></a>00118 <span class="preprocessor"></span>
<a name="l00119"></a>00119 <span class="preprocessor">#if defined(__DOXYGEN__)</span>
<a name="l00120"></a>00120 <span class="preprocessor"></span><span class="comment">/*</span>
<a name="l00121"></a>00121 <span class="comment"> * Doxygen doesn&#39;t grok the appended attribute syntax of</span>
<a name="l00122"></a>00122 <span class="comment"> * GCC, and confuses the typedefs with function decls, so</span>
<a name="l00123"></a>00123 <span class="comment"> * supply a doxygen-friendly view.</span>
<a name="l00124"></a>00124 <span class="comment"> */</span>
<a name="l00125"></a>00125 <span class="comment"></span>
<a name="l00126"></a>00126 <span class="comment">/**</span>
<a name="l00127"></a>00127 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00128"></a>00128 <span class="comment"> \typedef prog_void</span>
<a name="l00129"></a>00129 <span class="comment"> \note DEPRECATED</span>
<a name="l00130"></a>00130 <span class="comment"></span>
<a name="l00131"></a>00131 <span class="comment"> This typedef is now deprecated because the usage of the __progmem__ </span>
<a name="l00132"></a>00132 <span class="comment"> attribute on a type is not supported in GCC. However, the use of the </span>
<a name="l00133"></a>00133 <span class="comment"> __progmem__ attribute on a variable declaration is supported, and this is </span>
<a name="l00134"></a>00134 <span class="comment"> now the recommended usage.</span>
<a name="l00135"></a>00135 <span class="comment"></span>
<a name="l00136"></a>00136 <span class="comment"> The typedef is only visible if the macro __PROG_TYPES_COMPAT__</span>
<a name="l00137"></a>00137 <span class="comment"> has been defined before including &lt;avr/pgmspace.h&gt; (either by a</span>
<a name="l00138"></a>00138 <span class="comment"> \c \#define directive, or by a -D compiler option.)</span>
<a name="l00139"></a>00139 <span class="comment"></span>
<a name="l00140"></a>00140 <span class="comment"> Type of a &quot;void&quot; object located in flash ROM. Does not make much</span>
<a name="l00141"></a>00141 <span class="comment"> sense by itself, but can be used to declare a &quot;void *&quot; object in</span>
<a name="l00142"></a>00142 <span class="comment"> flash ROM.</span>
<a name="l00143"></a>00143 <span class="comment">*/</span>
<a name="l00144"></a><a class="code" href="group__avr__pgmspace.html#gadb50761b9f19d45449445208778ee420">00144</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">PROGMEM</a> <a class="code" href="group__avr__pgmspace.html#gadb50761b9f19d45449445208778ee420">prog_void</a>;
<a name="l00145"></a>00145 <span class="comment"></span>
<a name="l00146"></a>00146 <span class="comment">/**</span>
<a name="l00147"></a>00147 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00148"></a>00148 <span class="comment"> \typedef prog_char</span>
<a name="l00149"></a>00149 <span class="comment"> \note DEPRECATED</span>
<a name="l00150"></a>00150 <span class="comment"></span>
<a name="l00151"></a>00151 <span class="comment"> This typedef is now deprecated because the usage of the __progmem__ </span>
<a name="l00152"></a>00152 <span class="comment"> attribute on a type is not supported in GCC. However, the use of the </span>
<a name="l00153"></a>00153 <span class="comment"> __progmem__ attribute on a variable declaration is supported, and this is </span>
<a name="l00154"></a>00154 <span class="comment"> now the recommended usage.</span>
<a name="l00155"></a>00155 <span class="comment"></span>
<a name="l00156"></a>00156 <span class="comment"> The typedef is only visible if the macro __PROG_TYPES_COMPAT__</span>
<a name="l00157"></a>00157 <span class="comment"> has been defined before including &lt;avr/pgmspace.h&gt; (either by a</span>
<a name="l00158"></a>00158 <span class="comment"> \c \#define directive, or by a -D compiler option.)</span>
<a name="l00159"></a>00159 <span class="comment"></span>
<a name="l00160"></a>00160 <span class="comment"> Type of a &quot;char&quot; object located in flash ROM.</span>
<a name="l00161"></a>00161 <span class="comment">*/</span>
<a name="l00162"></a><a class="code" href="group__avr__pgmspace.html#gaa475b6b81fd8b34de45695da1da523b6">00162</a> <span class="keyword">typedef</span> <span class="keywordtype">char</span> <a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">PROGMEM</a> <a class="code" href="group__avr__pgmspace.html#gaa475b6b81fd8b34de45695da1da523b6">prog_char</a>;
<a name="l00163"></a>00163 <span class="comment"></span>
<a name="l00164"></a>00164 <span class="comment">/**</span>
<a name="l00165"></a>00165 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00166"></a>00166 <span class="comment"> \typedef prog_uchar</span>
<a name="l00167"></a>00167 <span class="comment"> \note DEPRECATED</span>
<a name="l00168"></a>00168 <span class="comment"></span>
<a name="l00169"></a>00169 <span class="comment"> This typedef is now deprecated because the usage of the __progmem__ </span>
<a name="l00170"></a>00170 <span class="comment"> attribute on a type is not supported in GCC. However, the use of the </span>
<a name="l00171"></a>00171 <span class="comment"> __progmem__ attribute on a variable declaration is supported, and this is </span>
<a name="l00172"></a>00172 <span class="comment"> now the recommended usage.</span>
<a name="l00173"></a>00173 <span class="comment"></span>
<a name="l00174"></a>00174 <span class="comment"> The typedef is only visible if the macro __PROG_TYPES_COMPAT__</span>
<a name="l00175"></a>00175 <span class="comment"> has been defined before including &lt;avr/pgmspace.h&gt; (either by a</span>
<a name="l00176"></a>00176 <span class="comment"> \c \#define directive, or by a -D compiler option.)</span>
<a name="l00177"></a>00177 <span class="comment"></span>
<a name="l00178"></a>00178 <span class="comment"> Type of an &quot;unsigned char&quot; object located in flash ROM.</span>
<a name="l00179"></a>00179 <span class="comment">*/</span>
<a name="l00180"></a><a class="code" href="group__avr__pgmspace.html#ga7d4701843a2019e3ef5a9866dc7586ed">00180</a> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">PROGMEM</a> <a class="code" href="group__avr__pgmspace.html#ga7d4701843a2019e3ef5a9866dc7586ed">prog_uchar</a>;
<a name="l00181"></a>00181 <span class="comment"></span>
<a name="l00182"></a>00182 <span class="comment">/**</span>
<a name="l00183"></a>00183 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00184"></a>00184 <span class="comment"> \typedef prog_int8_t</span>
<a name="l00185"></a>00185 <span class="comment"> \note DEPRECATED</span>
<a name="l00186"></a>00186 <span class="comment"></span>
<a name="l00187"></a>00187 <span class="comment"> This typedef is now deprecated because the usage of the __progmem__ </span>
<a name="l00188"></a>00188 <span class="comment"> attribute on a type is not supported in GCC. However, the use of the </span>
<a name="l00189"></a>00189 <span class="comment"> __progmem__ attribute on a variable declaration is supported, and this is </span>
<a name="l00190"></a>00190 <span class="comment"> now the recommended usage.</span>
<a name="l00191"></a>00191 <span class="comment"></span>
<a name="l00192"></a>00192 <span class="comment"> The typedef is only visible if the macro __PROG_TYPES_COMPAT__</span>
<a name="l00193"></a>00193 <span class="comment"> has been defined before including &lt;avr/pgmspace.h&gt; (either by a</span>
<a name="l00194"></a>00194 <span class="comment"> \c \#define directive, or by a -D compiler option.)</span>
<a name="l00195"></a>00195 <span class="comment"></span>
<a name="l00196"></a>00196 <span class="comment"> Type of an &quot;int8_t&quot; object located in flash ROM.</span>
<a name="l00197"></a>00197 <span class="comment">*/</span>
<a name="l00198"></a><a class="code" href="group__avr__pgmspace.html#ga48c7cb011ea5f82f4b73df40e07dff46">00198</a> <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#gaef44329758059c91c76d334e8fc09700">int8_t</a> <a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">PROGMEM</a> <a class="code" href="group__avr__pgmspace.html#ga48c7cb011ea5f82f4b73df40e07dff46">prog_int8_t</a>;
<a name="l00199"></a>00199 <span class="comment"></span>
<a name="l00200"></a>00200 <span class="comment">/**</span>
<a name="l00201"></a>00201 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00202"></a>00202 <span class="comment"> \typedef prog_uint8_t</span>
<a name="l00203"></a>00203 <span class="comment"> \note DEPRECATED</span>
<a name="l00204"></a>00204 <span class="comment"></span>
<a name="l00205"></a>00205 <span class="comment"> This typedef is now deprecated because the usage of the __progmem__ </span>
<a name="l00206"></a>00206 <span class="comment"> attribute on a type is not supported in GCC. However, the use of the </span>
<a name="l00207"></a>00207 <span class="comment"> __progmem__ attribute on a variable declaration is supported, and this is </span>
<a name="l00208"></a>00208 <span class="comment"> now the recommended usage.</span>
<a name="l00209"></a>00209 <span class="comment"></span>
<a name="l00210"></a>00210 <span class="comment"> The typedef is only visible if the macro __PROG_TYPES_COMPAT__</span>
<a name="l00211"></a>00211 <span class="comment"> has been defined before including &lt;avr/pgmspace.h&gt; (either by a</span>
<a name="l00212"></a>00212 <span class="comment"> \c \#define directive, or by a -D compiler option.)</span>
<a name="l00213"></a>00213 <span class="comment"></span>
<a name="l00214"></a>00214 <span class="comment"> Type of an &quot;uint8_t&quot; object located in flash ROM.</span>
<a name="l00215"></a>00215 <span class="comment">*/</span>
<a name="l00216"></a><a class="code" href="group__avr__pgmspace.html#ga39235a28487ae7790ce5f4c8178c8ed7">00216</a> <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> <a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">PROGMEM</a> <a class="code" href="group__avr__pgmspace.html#ga39235a28487ae7790ce5f4c8178c8ed7">prog_uint8_t</a>;
<a name="l00217"></a>00217 <span class="comment"></span>
<a name="l00218"></a>00218 <span class="comment">/**</span>
<a name="l00219"></a>00219 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00220"></a>00220 <span class="comment"> \typedef prog_int16_t</span>
<a name="l00221"></a>00221 <span class="comment"> \note DEPRECATED</span>
<a name="l00222"></a>00222 <span class="comment"></span>
<a name="l00223"></a>00223 <span class="comment"> This typedef is now deprecated because the usage of the __progmem__ </span>
<a name="l00224"></a>00224 <span class="comment"> attribute on a type is not supported in GCC. However, the use of the </span>
<a name="l00225"></a>00225 <span class="comment"> __progmem__ attribute on a variable declaration is supported, and this is </span>
<a name="l00226"></a>00226 <span class="comment"> now the recommended usage.</span>
<a name="l00227"></a>00227 <span class="comment"></span>
<a name="l00228"></a>00228 <span class="comment"> The typedef is only visible if the macro __PROG_TYPES_COMPAT__</span>
<a name="l00229"></a>00229 <span class="comment"> has been defined before including &lt;avr/pgmspace.h&gt; (either by a</span>
<a name="l00230"></a>00230 <span class="comment"> \c \#define directive, or by a -D compiler option.)</span>
<a name="l00231"></a>00231 <span class="comment"></span>
<a name="l00232"></a>00232 <span class="comment"> Type of an &quot;int16_t&quot; object located in flash ROM.</span>
<a name="l00233"></a>00233 <span class="comment">*/</span>
<a name="l00234"></a><a class="code" href="group__avr__pgmspace.html#gaafc910d0b2c4d76afffa4710b98df6fa">00234</a> <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#ga932e6ccc3d54c58f761c1aead83bd6d7">int16_t</a> <a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">PROGMEM</a> <a class="code" href="group__avr__pgmspace.html#gaafc910d0b2c4d76afffa4710b98df6fa">prog_int16_t</a>;
<a name="l00235"></a>00235 <span class="comment"></span>
<a name="l00236"></a>00236 <span class="comment">/**</span>
<a name="l00237"></a>00237 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00238"></a>00238 <span class="comment"> \typedef prog_uint16_t</span>
<a name="l00239"></a>00239 <span class="comment"> \note DEPRECATED</span>
<a name="l00240"></a>00240 <span class="comment"></span>
<a name="l00241"></a>00241 <span class="comment"> This typedef is now deprecated because the usage of the __progmem__ </span>
<a name="l00242"></a>00242 <span class="comment"> attribute on a type is not supported in GCC. However, the use of the </span>
<a name="l00243"></a>00243 <span class="comment"> __progmem__ attribute on a variable declaration is supported, and this is </span>
<a name="l00244"></a>00244 <span class="comment"> now the recommended usage.</span>
<a name="l00245"></a>00245 <span class="comment"></span>
<a name="l00246"></a>00246 <span class="comment"> The typedef is only visible if the macro __PROG_TYPES_COMPAT__</span>
<a name="l00247"></a>00247 <span class="comment"> has been defined before including &lt;avr/pgmspace.h&gt; (either by a</span>
<a name="l00248"></a>00248 <span class="comment"> \c \#define directive, or by a -D compiler option.)</span>
<a name="l00249"></a>00249 <span class="comment"></span>
<a name="l00250"></a>00250 <span class="comment"> Type of an &quot;uint16_t&quot; object located in flash ROM.</span>
<a name="l00251"></a>00251 <span class="comment">*/</span>
<a name="l00252"></a><a class="code" href="group__avr__pgmspace.html#ga93ec00229866bf6a125384ad08cefa73">00252</a> <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> <a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">PROGMEM</a> <a class="code" href="group__avr__pgmspace.html#ga93ec00229866bf6a125384ad08cefa73">prog_uint16_t</a>;
<a name="l00253"></a>00253 <span class="comment"></span>
<a name="l00254"></a>00254 <span class="comment">/**</span>
<a name="l00255"></a>00255 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00256"></a>00256 <span class="comment"> \typedef prog_int32_t</span>
<a name="l00257"></a>00257 <span class="comment"> \note DEPRECATED</span>
<a name="l00258"></a>00258 <span class="comment"></span>
<a name="l00259"></a>00259 <span class="comment"> This typedef is now deprecated because the usage of the __progmem__ </span>
<a name="l00260"></a>00260 <span class="comment"> attribute on a type is not supported in GCC. However, the use of the </span>
<a name="l00261"></a>00261 <span class="comment"> __progmem__ attribute on a variable declaration is supported, and this is </span>
<a name="l00262"></a>00262 <span class="comment"> now the recommended usage.</span>
<a name="l00263"></a>00263 <span class="comment"></span>
<a name="l00264"></a>00264 <span class="comment"> The typedef is only visible if the macro __PROG_TYPES_COMPAT__</span>
<a name="l00265"></a>00265 <span class="comment"> has been defined before including &lt;avr/pgmspace.h&gt; (either by a</span>
<a name="l00266"></a>00266 <span class="comment"> \c \#define directive, or by a -D compiler option.)</span>
<a name="l00267"></a>00267 <span class="comment"></span>
<a name="l00268"></a>00268 <span class="comment"> Type of an &quot;int32_t&quot; object located in flash ROM.</span>
<a name="l00269"></a>00269 <span class="comment">*/</span>
<a name="l00270"></a><a class="code" href="group__avr__pgmspace.html#gaa839901aa518fb43d361588dd8d2b44b">00270</a> <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#gadb828ef50c2dbb783109824e94cf6c47">int32_t</a> <a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">PROGMEM</a> <a class="code" href="group__avr__pgmspace.html#gaa839901aa518fb43d361588dd8d2b44b">prog_int32_t</a>;
<a name="l00271"></a>00271 <span class="comment"></span>
<a name="l00272"></a>00272 <span class="comment">/**</span>
<a name="l00273"></a>00273 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00274"></a>00274 <span class="comment"> \typedef prog_uint32_t</span>
<a name="l00275"></a>00275 <span class="comment"> \note DEPRECATED</span>
<a name="l00276"></a>00276 <span class="comment"></span>
<a name="l00277"></a>00277 <span class="comment"> This typedef is now deprecated because the usage of the __progmem__ </span>
<a name="l00278"></a>00278 <span class="comment"> attribute on a type is not supported in GCC. However, the use of the </span>
<a name="l00279"></a>00279 <span class="comment"> __progmem__ attribute on a variable declaration is supported, and this is </span>
<a name="l00280"></a>00280 <span class="comment"> now the recommended usage.</span>
<a name="l00281"></a>00281 <span class="comment"></span>
<a name="l00282"></a>00282 <span class="comment"> The typedef is only visible if the macro __PROG_TYPES_COMPAT__</span>
<a name="l00283"></a>00283 <span class="comment"> has been defined before including &lt;avr/pgmspace.h&gt; (either by a</span>
<a name="l00284"></a>00284 <span class="comment"> \c \#define directive, or by a -D compiler option.)</span>
<a name="l00285"></a>00285 <span class="comment"></span>
<a name="l00286"></a>00286 <span class="comment"> Type of an &quot;uint32_t&quot; object located in flash ROM.</span>
<a name="l00287"></a>00287 <span class="comment">*/</span>
<a name="l00288"></a><a class="code" href="group__avr__pgmspace.html#ga31bad0d22ead95a41e725c38ea63eb26">00288</a> <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#ga33594304e786b158f3fb30289278f5af">uint32_t</a> <a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">PROGMEM</a> <a class="code" href="group__avr__pgmspace.html#ga31bad0d22ead95a41e725c38ea63eb26">prog_uint32_t</a>;
<a name="l00289"></a>00289 <span class="comment"></span>
<a name="l00290"></a>00290 <span class="comment">/**</span>
<a name="l00291"></a>00291 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00292"></a>00292 <span class="comment"> \typedef prog_int64_t</span>
<a name="l00293"></a>00293 <span class="comment"> \note DEPRECATED</span>
<a name="l00294"></a>00294 <span class="comment"></span>
<a name="l00295"></a>00295 <span class="comment"> This typedef is now deprecated because the usage of the __progmem__ </span>
<a name="l00296"></a>00296 <span class="comment"> attribute on a type is not supported in GCC. However, the use of the </span>
<a name="l00297"></a>00297 <span class="comment"> __progmem__ attribute on a variable declaration is supported, and this is </span>
<a name="l00298"></a>00298 <span class="comment"> now the recommended usage.</span>
<a name="l00299"></a>00299 <span class="comment"></span>
<a name="l00300"></a>00300 <span class="comment"> The typedef is only visible if the macro __PROG_TYPES_COMPAT__</span>
<a name="l00301"></a>00301 <span class="comment"> has been defined before including &lt;avr/pgmspace.h&gt; (either by a</span>
<a name="l00302"></a>00302 <span class="comment"> \c \#define directive, or by a -D compiler option.)</span>
<a name="l00303"></a>00303 <span class="comment"></span>
<a name="l00304"></a>00304 <span class="comment"> Type of an &quot;int64_t&quot; object located in flash ROM.</span>
<a name="l00305"></a>00305 <span class="comment"></span>
<a name="l00306"></a>00306 <span class="comment"> \note This type is not available when the compiler</span>
<a name="l00307"></a>00307 <span class="comment"> option -mint8 is in effect.</span>
<a name="l00308"></a>00308 <span class="comment">*/</span>
<a name="l00309"></a><a class="code" href="group__avr__pgmspace.html#ga5b1f9927f06d841e9ac07af62e71cfef">00309</a> <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#ga831d6234342279926bb11bad3a37add9">int64_t</a> <a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">PROGMEM</a> <a class="code" href="group__avr__pgmspace.html#ga5b1f9927f06d841e9ac07af62e71cfef">prog_int64_t</a>;
<a name="l00310"></a>00310 <span class="comment"></span>
<a name="l00311"></a>00311 <span class="comment">/**</span>
<a name="l00312"></a>00312 <span class="comment"> \ingroup avr_pgmspace</span>
<a name="l00313"></a>00313 <span class="comment"> \typedef prog_uint64_t</span>
<a name="l00314"></a>00314 <span class="comment"> \note DEPRECATED</span>
<a name="l00315"></a>00315 <span class="comment"></span>
<a name="l00316"></a>00316 <span class="comment"> This typedef is now deprecated because the usage of the __progmem__ </span>
<a name="l00317"></a>00317 <span class="comment"> attribute on a type is not supported in GCC. However, the use of the </span>
<a name="l00318"></a>00318 <span class="comment"> __progmem__ attribute on a variable declaration is supported, and this is </span>
<a name="l00319"></a>00319 <span class="comment"> now the recommended usage.</span>
<a name="l00320"></a>00320 <span class="comment"></span>
<a name="l00321"></a>00321 <span class="comment"> The typedef is only visible if the macro __PROG_TYPES_COMPAT__</span>
<a name="l00322"></a>00322 <span class="comment"> has been defined before including &lt;avr/pgmspace.h&gt; (either by a</span>
<a name="l00323"></a>00323 <span class="comment"> \c \#define directive, or by a -D compiler option.)</span>
<a name="l00324"></a>00324 <span class="comment"></span>
<a name="l00325"></a>00325 <span class="comment"> Type of an &quot;uint64_t&quot; object located in flash ROM.</span>
<a name="l00326"></a>00326 <span class="comment"></span>
<a name="l00327"></a>00327 <span class="comment"> \note This type is not available when the compiler</span>
<a name="l00328"></a>00328 <span class="comment"> option -mint8 is in effect.</span>
<a name="l00329"></a>00329 <span class="comment">*/</span>
<a name="l00330"></a><a class="code" href="group__avr__pgmspace.html#gaa50eebe90a40e0276bcc49ea0482b211">00330</a> <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#gad27ed092432b64ff558d2254c278720f">uint64_t</a> <a class="code" href="group__avr__pgmspace.html#ga75acaba9e781937468d0911423bc0c35">PROGMEM</a> <a class="code" href="group__avr__pgmspace.html#gaa50eebe90a40e0276bcc49ea0482b211">prog_uint64_t</a>;
<a name="l00331"></a>00331 <span class="comment"></span>
<a name="l00332"></a>00332 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l00333"></a>00333 <span class="comment"> \def PGM_P</span>
<a name="l00334"></a>00334 <span class="comment"></span>
<a name="l00335"></a>00335 <span class="comment"> Used to declare a variable that is a pointer to a string in program</span>
<a name="l00336"></a>00336 <span class="comment"> space. */</span>
<a name="l00337"></a>00337
<a name="l00338"></a>00338 <span class="preprocessor">#ifndef PGM_P</span>
<a name="l00339"></a><a class="code" href="group__avr__pgmspace.html#ga963f816fc88a5d8479c285ed4c630229">00339</a> <span class="preprocessor"></span><span class="preprocessor">#define PGM_P const char *</span>
<a name="l00340"></a>00340 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00341"></a>00341 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00342"></a>00342 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l00343"></a>00343 <span class="comment"> \def PGM_VOID_P</span>
<a name="l00344"></a>00344 <span class="comment"></span>
<a name="l00345"></a>00345 <span class="comment"> Used to declare a generic pointer to an object in program space. */</span>
<a name="l00346"></a>00346
<a name="l00347"></a>00347 <span class="preprocessor">#ifndef PGM_VOID_P</span>
<a name="l00348"></a><a class="code" href="group__avr__pgmspace.html#ga84a61d55b7efefabd8419e28f02704f9">00348</a> <span class="preprocessor"></span><span class="preprocessor">#define PGM_VOID_P const void *</span>
<a name="l00349"></a>00349 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00350"></a>00350 <span class="preprocessor"></span>
<a name="l00351"></a>00351 <span class="preprocessor">#elif defined(__PROG_TYPES_COMPAT__) </span><span class="comment">/* !DOXYGEN */</span>
<a name="l00352"></a>00352
<a name="l00353"></a>00353 <span class="keyword">typedef</span> <span class="keywordtype">void</span> prog_void <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__progmem__,deprecated(<span class="stringliteral">&quot;prog_void type is deprecated.&quot;</span>)));
<a name="l00354"></a>00354 <span class="keyword">typedef</span> <span class="keywordtype">char</span> prog_char <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__progmem__,deprecated(<span class="stringliteral">&quot;prog_char type is deprecated.&quot;</span>)));
<a name="l00355"></a>00355 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> prog_uchar <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__progmem__,deprecated(<span class="stringliteral">&quot;prog_uchar type is deprecated.&quot;</span>)));
<a name="l00356"></a>00356 <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#gaef44329758059c91c76d334e8fc09700">int8_t</a> prog_int8_t <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__progmem__,deprecated(<span class="stringliteral">&quot;prog_int8_t type is deprecated.&quot;</span>)));
<a name="l00357"></a>00357 <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> prog_uint8_t <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__progmem__,deprecated(<span class="stringliteral">&quot;prog_uint8_t type is deprecated.&quot;</span>)));
<a name="l00358"></a>00358 <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#ga932e6ccc3d54c58f761c1aead83bd6d7">int16_t</a> prog_int16_t <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__progmem__,deprecated(<span class="stringliteral">&quot;prog_int16_t type is deprecated.&quot;</span>)));
<a name="l00359"></a>00359 <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> prog_uint16_t <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__progmem__,deprecated(<span class="stringliteral">&quot;prog_uint16_t type is deprecated.&quot;</span>)));
<a name="l00360"></a>00360 <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#gadb828ef50c2dbb783109824e94cf6c47">int32_t</a> prog_int32_t <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__progmem__,deprecated(<span class="stringliteral">&quot;prog_int32_t type is deprecated.&quot;</span>)));
<a name="l00361"></a>00361 <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#ga33594304e786b158f3fb30289278f5af">uint32_t</a> prog_uint32_t <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__progmem__,deprecated(<span class="stringliteral">&quot;prog_uint32_t type is deprecated.&quot;</span>)));
<a name="l00362"></a>00362 <span class="preprocessor">#if !__USING_MINT8</span>
<a name="l00363"></a>00363 <span class="preprocessor"></span><span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#ga831d6234342279926bb11bad3a37add9">int64_t</a> prog_int64_t <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__progmem__,deprecated(<span class="stringliteral">&quot;prog_int64_t type is deprecated.&quot;</span>)));
<a name="l00364"></a>00364 <span class="keyword">typedef</span> <a class="code" href="group__avr__stdint.html#gad27ed092432b64ff558d2254c278720f">uint64_t</a> prog_uint64_t <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__progmem__,deprecated(<span class="stringliteral">&quot;prog_uint64_t type is deprecated.&quot;</span>)));
<a name="l00365"></a>00365 <span class="preprocessor">#endif</span>
<a name="l00366"></a>00366 <span class="preprocessor"></span>
<a name="l00367"></a>00367 <span class="preprocessor">#ifndef PGM_P</span>
<a name="l00368"></a>00368 <span class="preprocessor"></span><span class="preprocessor">#define PGM_P const prog_char *</span>
<a name="l00369"></a>00369 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00370"></a>00370 <span class="preprocessor"></span>
<a name="l00371"></a>00371 <span class="preprocessor">#ifndef PGM_VOID_P</span>
<a name="l00372"></a>00372 <span class="preprocessor"></span><span class="preprocessor">#define PGM_VOID_P const prog_void *</span>
<a name="l00373"></a>00373 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00374"></a>00374 <span class="preprocessor"></span>
<a name="l00375"></a>00375 <span class="preprocessor">#else </span><span class="comment">/* !defined(__DOXYGEN__), !defined(__PROG_TYPES_COMPAT__) */</span>
<a name="l00376"></a>00376
<a name="l00377"></a>00377 <span class="preprocessor">#ifndef PGM_P</span>
<a name="l00378"></a>00378 <span class="preprocessor"></span><span class="preprocessor">#define PGM_P const char *</span>
<a name="l00379"></a>00379 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00380"></a>00380 <span class="preprocessor"></span>
<a name="l00381"></a>00381 <span class="preprocessor">#ifndef PGM_VOID_P</span>
<a name="l00382"></a>00382 <span class="preprocessor"></span><span class="preprocessor">#define PGM_VOID_P const void *</span>
<a name="l00383"></a>00383 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00384"></a>00384 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* defined(__DOXYGEN__), defined(__PROG_TYPES_COMPAT__) */</span>
<a name="l00385"></a>00385
<a name="l00386"></a>00386 <span class="comment">/* Although in C, we can get away with just using __c, it does not work in</span>
<a name="l00387"></a>00387 <span class="comment"> C++. We need to use &amp;__c[0] to avoid the compiler puking. Dave Hylands</span>
<a name="l00388"></a>00388 <span class="comment"> explaned it thusly,</span>
<a name="l00389"></a>00389 <span class="comment"></span>
<a name="l00390"></a>00390 <span class="comment"> Let&#39;s suppose that we use PSTR(&quot;Test&quot;). In this case, the type returned</span>
<a name="l00391"></a>00391 <span class="comment"> by __c is a prog_char[5] and not a prog_char *. While these are</span>
<a name="l00392"></a>00392 <span class="comment"> compatible, they aren&#39;t the same thing (especially in C++). The type</span>
<a name="l00393"></a>00393 <span class="comment"> returned by &amp;__c[0] is a prog_char *, which explains why it works</span>
<a name="l00394"></a>00394 <span class="comment"> fine. */</span>
<a name="l00395"></a>00395
<a name="l00396"></a>00396 <span class="preprocessor">#if defined(__DOXYGEN__)</span>
<a name="l00397"></a>00397 <span class="preprocessor"></span><span class="comment">/*</span>
<a name="l00398"></a>00398 <span class="comment"> * The #define below is just a dummy that serves documentation</span>
<a name="l00399"></a>00399 <span class="comment"> * purposes only.</span>
<a name="l00400"></a>00400 <span class="comment"> */</span><span class="comment"></span>
<a name="l00401"></a>00401 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l00402"></a>00402 <span class="comment"> \def PSTR(s)</span>
<a name="l00403"></a>00403 <span class="comment"></span>
<a name="l00404"></a>00404 <span class="comment"> Used to declare a static pointer to a string in program space. */</span>
<a name="l00405"></a><a class="code" href="group__avr__pgmspace.html#ga05ca900ebf7cd121be73c654d9ccb3eb">00405</a> <span class="preprocessor"># define PSTR(s) ((const PROGMEM char *)(s))</span>
<a name="l00406"></a>00406 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* !DOXYGEN */</span>
<a name="l00407"></a>00407 <span class="comment">/* The real thing. */</span>
<a name="l00408"></a>00408 <span class="preprocessor"># define PSTR(s) (__extension__({static const char __c[] PROGMEM = (s); &amp;__c[0];}))</span>
<a name="l00409"></a>00409 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* DOXYGEN */</span>
<a name="l00410"></a>00410
<a name="l00411"></a>00411 <span class="preprocessor">#ifndef __DOXYGEN__ </span><span class="comment">/* Internal macros, not documented. */</span>
<a name="l00412"></a>00412 <span class="preprocessor">#define __LPM_classic__(addr) \</span>
<a name="l00413"></a>00413 <span class="preprocessor">(__extension__({ \</span>
<a name="l00414"></a>00414 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr); \</span>
<a name="l00415"></a>00415 <span class="preprocessor"> uint8_t __result; \</span>
<a name="l00416"></a>00416 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00417"></a>00417 <span class="preprocessor"> ( \</span>
<a name="l00418"></a>00418 <span class="preprocessor"> &quot;lpm&quot; &quot;\n\t&quot; \</span>
<a name="l00419"></a>00419 <span class="preprocessor"> &quot;mov %0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00420"></a>00420 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00421"></a>00421 <span class="preprocessor"> : &quot;z&quot; (__addr16) \</span>
<a name="l00422"></a>00422 <span class="preprocessor"> : &quot;r0&quot; \</span>
<a name="l00423"></a>00423 <span class="preprocessor"> ); \</span>
<a name="l00424"></a>00424 <span class="preprocessor"> __result; \</span>
<a name="l00425"></a>00425 <span class="preprocessor">}))</span>
<a name="l00426"></a>00426 <span class="preprocessor"></span>
<a name="l00427"></a>00427 <span class="preprocessor">#define __LPM_tiny__(addr) \</span>
<a name="l00428"></a>00428 <span class="preprocessor">(__extension__({ \</span>
<a name="l00429"></a>00429 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr) + __AVR_TINY_PM_BASE_ADDRESS__; \</span>
<a name="l00430"></a>00430 <span class="preprocessor"> uint8_t __result; \</span>
<a name="l00431"></a>00431 <span class="preprocessor"> __asm__ \</span>
<a name="l00432"></a>00432 <span class="preprocessor"> ( \</span>
<a name="l00433"></a>00433 <span class="preprocessor"> &quot;ld %0, z&quot; &quot;\n\t&quot; \</span>
<a name="l00434"></a>00434 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00435"></a>00435 <span class="preprocessor"> : &quot;z&quot; (__addr16) \</span>
<a name="l00436"></a>00436 <span class="preprocessor"> ); \</span>
<a name="l00437"></a>00437 <span class="preprocessor"> __result; \</span>
<a name="l00438"></a>00438 <span class="preprocessor">}))</span>
<a name="l00439"></a>00439 <span class="preprocessor"></span>
<a name="l00440"></a>00440 <span class="preprocessor">#define __LPM_enhanced__(addr) \</span>
<a name="l00441"></a>00441 <span class="preprocessor">(__extension__({ \</span>
<a name="l00442"></a>00442 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr); \</span>
<a name="l00443"></a>00443 <span class="preprocessor"> uint8_t __result; \</span>
<a name="l00444"></a>00444 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00445"></a>00445 <span class="preprocessor"> ( \</span>
<a name="l00446"></a>00446 <span class="preprocessor"> &quot;lpm %0, Z&quot; &quot;\n\t&quot; \</span>
<a name="l00447"></a>00447 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00448"></a>00448 <span class="preprocessor"> : &quot;z&quot; (__addr16) \</span>
<a name="l00449"></a>00449 <span class="preprocessor"> ); \</span>
<a name="l00450"></a>00450 <span class="preprocessor"> __result; \</span>
<a name="l00451"></a>00451 <span class="preprocessor">}))</span>
<a name="l00452"></a>00452 <span class="preprocessor"></span>
<a name="l00453"></a>00453 <span class="preprocessor">#define __LPM_word_classic__(addr) \</span>
<a name="l00454"></a>00454 <span class="preprocessor">(__extension__({ \</span>
<a name="l00455"></a>00455 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr); \</span>
<a name="l00456"></a>00456 <span class="preprocessor"> uint16_t __result; \</span>
<a name="l00457"></a>00457 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00458"></a>00458 <span class="preprocessor"> ( \</span>
<a name="l00459"></a>00459 <span class="preprocessor"> &quot;lpm&quot; &quot;\n\t&quot; \</span>
<a name="l00460"></a>00460 <span class="preprocessor"> &quot;mov %A0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00461"></a>00461 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00462"></a>00462 <span class="preprocessor"> &quot;lpm&quot; &quot;\n\t&quot; \</span>
<a name="l00463"></a>00463 <span class="preprocessor"> &quot;mov %B0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00464"></a>00464 <span class="preprocessor"> : &quot;=r&quot; (__result), &quot;=z&quot; (__addr16) \</span>
<a name="l00465"></a>00465 <span class="preprocessor"> : &quot;1&quot; (__addr16) \</span>
<a name="l00466"></a>00466 <span class="preprocessor"> : &quot;r0&quot; \</span>
<a name="l00467"></a>00467 <span class="preprocessor"> ); \</span>
<a name="l00468"></a>00468 <span class="preprocessor"> __result; \</span>
<a name="l00469"></a>00469 <span class="preprocessor">}))</span>
<a name="l00470"></a>00470 <span class="preprocessor"></span>
<a name="l00471"></a>00471 <span class="preprocessor">#define __LPM_word_tiny__(addr) \</span>
<a name="l00472"></a>00472 <span class="preprocessor">(__extension__({ \</span>
<a name="l00473"></a>00473 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr) + __AVR_TINY_PM_BASE_ADDRESS__; \</span>
<a name="l00474"></a>00474 <span class="preprocessor"> uint16_t __result; \</span>
<a name="l00475"></a>00475 <span class="preprocessor"> __asm__ \</span>
<a name="l00476"></a>00476 <span class="preprocessor"> ( \</span>
<a name="l00477"></a>00477 <span class="preprocessor"> &quot;ld %A0, z+&quot; &quot;\n\t&quot; \</span>
<a name="l00478"></a>00478 <span class="preprocessor"> &quot;ld %B0, z&quot; &quot;\n\t&quot; \</span>
<a name="l00479"></a>00479 <span class="preprocessor"> : &quot;=r&quot; (__result), &quot;=z&quot; (__addr16) \</span>
<a name="l00480"></a>00480 <span class="preprocessor"> : &quot;1&quot; (__addr16) \</span>
<a name="l00481"></a>00481 <span class="preprocessor"> ); \</span>
<a name="l00482"></a>00482 <span class="preprocessor"> __result; \</span>
<a name="l00483"></a>00483 <span class="preprocessor">}))</span>
<a name="l00484"></a>00484 <span class="preprocessor"></span>
<a name="l00485"></a>00485 <span class="preprocessor">#define __LPM_word_enhanced__(addr) \</span>
<a name="l00486"></a>00486 <span class="preprocessor">(__extension__({ \</span>
<a name="l00487"></a>00487 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr); \</span>
<a name="l00488"></a>00488 <span class="preprocessor"> uint16_t __result; \</span>
<a name="l00489"></a>00489 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00490"></a>00490 <span class="preprocessor"> ( \</span>
<a name="l00491"></a>00491 <span class="preprocessor"> &quot;lpm %A0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00492"></a>00492 <span class="preprocessor"> &quot;lpm %B0, Z&quot; &quot;\n\t&quot; \</span>
<a name="l00493"></a>00493 <span class="preprocessor"> : &quot;=r&quot; (__result), &quot;=z&quot; (__addr16) \</span>
<a name="l00494"></a>00494 <span class="preprocessor"> : &quot;1&quot; (__addr16) \</span>
<a name="l00495"></a>00495 <span class="preprocessor"> ); \</span>
<a name="l00496"></a>00496 <span class="preprocessor"> __result; \</span>
<a name="l00497"></a>00497 <span class="preprocessor">}))</span>
<a name="l00498"></a>00498 <span class="preprocessor"></span>
<a name="l00499"></a>00499 <span class="preprocessor">#define __LPM_dword_classic__(addr) \</span>
<a name="l00500"></a>00500 <span class="preprocessor">(__extension__({ \</span>
<a name="l00501"></a>00501 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr); \</span>
<a name="l00502"></a>00502 <span class="preprocessor"> uint32_t __result; \</span>
<a name="l00503"></a>00503 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00504"></a>00504 <span class="preprocessor"> ( \</span>
<a name="l00505"></a>00505 <span class="preprocessor"> &quot;lpm&quot; &quot;\n\t&quot; \</span>
<a name="l00506"></a>00506 <span class="preprocessor"> &quot;mov %A0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00507"></a>00507 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00508"></a>00508 <span class="preprocessor"> &quot;lpm&quot; &quot;\n\t&quot; \</span>
<a name="l00509"></a>00509 <span class="preprocessor"> &quot;mov %B0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00510"></a>00510 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00511"></a>00511 <span class="preprocessor"> &quot;lpm&quot; &quot;\n\t&quot; \</span>
<a name="l00512"></a>00512 <span class="preprocessor"> &quot;mov %C0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00513"></a>00513 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00514"></a>00514 <span class="preprocessor"> &quot;lpm&quot; &quot;\n\t&quot; \</span>
<a name="l00515"></a>00515 <span class="preprocessor"> &quot;mov %D0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00516"></a>00516 <span class="preprocessor"> : &quot;=r&quot; (__result), &quot;=z&quot; (__addr16) \</span>
<a name="l00517"></a>00517 <span class="preprocessor"> : &quot;1&quot; (__addr16) \</span>
<a name="l00518"></a>00518 <span class="preprocessor"> : &quot;r0&quot; \</span>
<a name="l00519"></a>00519 <span class="preprocessor"> ); \</span>
<a name="l00520"></a>00520 <span class="preprocessor"> __result; \</span>
<a name="l00521"></a>00521 <span class="preprocessor">}))</span>
<a name="l00522"></a>00522 <span class="preprocessor"></span>
<a name="l00523"></a>00523 <span class="preprocessor">#define __LPM_dword_tiny__(addr) \</span>
<a name="l00524"></a>00524 <span class="preprocessor">(__extension__({ \</span>
<a name="l00525"></a>00525 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr) + __AVR_TINY_PM_BASE_ADDRESS__; \</span>
<a name="l00526"></a>00526 <span class="preprocessor"> uint32_t __result; \</span>
<a name="l00527"></a>00527 <span class="preprocessor"> __asm__ \</span>
<a name="l00528"></a>00528 <span class="preprocessor"> ( \</span>
<a name="l00529"></a>00529 <span class="preprocessor"> &quot;ld %A0, z+&quot; &quot;\n\t&quot; \</span>
<a name="l00530"></a>00530 <span class="preprocessor"> &quot;ld %B0, z+&quot; &quot;\n\t&quot; \</span>
<a name="l00531"></a>00531 <span class="preprocessor"> &quot;ld %C0, z+&quot; &quot;\n\t&quot; \</span>
<a name="l00532"></a>00532 <span class="preprocessor"> &quot;ld %D0, z&quot; &quot;\n\t&quot; \</span>
<a name="l00533"></a>00533 <span class="preprocessor"> : &quot;=r&quot; (__result), &quot;=z&quot; (__addr16) \</span>
<a name="l00534"></a>00534 <span class="preprocessor"> : &quot;1&quot; (__addr16) \</span>
<a name="l00535"></a>00535 <span class="preprocessor"> ); \</span>
<a name="l00536"></a>00536 <span class="preprocessor"> __result; \</span>
<a name="l00537"></a>00537 <span class="preprocessor">}))</span>
<a name="l00538"></a>00538 <span class="preprocessor"></span>
<a name="l00539"></a>00539 <span class="preprocessor">#define __LPM_dword_enhanced__(addr) \</span>
<a name="l00540"></a>00540 <span class="preprocessor">(__extension__({ \</span>
<a name="l00541"></a>00541 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr); \</span>
<a name="l00542"></a>00542 <span class="preprocessor"> uint32_t __result; \</span>
<a name="l00543"></a>00543 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00544"></a>00544 <span class="preprocessor"> ( \</span>
<a name="l00545"></a>00545 <span class="preprocessor"> &quot;lpm %A0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00546"></a>00546 <span class="preprocessor"> &quot;lpm %B0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00547"></a>00547 <span class="preprocessor"> &quot;lpm %C0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00548"></a>00548 <span class="preprocessor"> &quot;lpm %D0, Z&quot; &quot;\n\t&quot; \</span>
<a name="l00549"></a>00549 <span class="preprocessor"> : &quot;=r&quot; (__result), &quot;=z&quot; (__addr16) \</span>
<a name="l00550"></a>00550 <span class="preprocessor"> : &quot;1&quot; (__addr16) \</span>
<a name="l00551"></a>00551 <span class="preprocessor"> ); \</span>
<a name="l00552"></a>00552 <span class="preprocessor"> __result; \</span>
<a name="l00553"></a>00553 <span class="preprocessor">}))</span>
<a name="l00554"></a>00554 <span class="preprocessor"></span>
<a name="l00555"></a>00555 <span class="preprocessor">#define __LPM_float_classic__(addr) \</span>
<a name="l00556"></a>00556 <span class="preprocessor">(__extension__({ \</span>
<a name="l00557"></a>00557 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr); \</span>
<a name="l00558"></a>00558 <span class="preprocessor"> float __result; \</span>
<a name="l00559"></a>00559 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00560"></a>00560 <span class="preprocessor"> ( \</span>
<a name="l00561"></a>00561 <span class="preprocessor"> &quot;lpm&quot; &quot;\n\t&quot; \</span>
<a name="l00562"></a>00562 <span class="preprocessor"> &quot;mov %A0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00563"></a>00563 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00564"></a>00564 <span class="preprocessor"> &quot;lpm&quot; &quot;\n\t&quot; \</span>
<a name="l00565"></a>00565 <span class="preprocessor"> &quot;mov %B0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00566"></a>00566 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00567"></a>00567 <span class="preprocessor"> &quot;lpm&quot; &quot;\n\t&quot; \</span>
<a name="l00568"></a>00568 <span class="preprocessor"> &quot;mov %C0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00569"></a>00569 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00570"></a>00570 <span class="preprocessor"> &quot;lpm&quot; &quot;\n\t&quot; \</span>
<a name="l00571"></a>00571 <span class="preprocessor"> &quot;mov %D0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00572"></a>00572 <span class="preprocessor"> : &quot;=r&quot; (__result), &quot;=z&quot; (__addr16) \</span>
<a name="l00573"></a>00573 <span class="preprocessor"> : &quot;1&quot; (__addr16) \</span>
<a name="l00574"></a>00574 <span class="preprocessor"> : &quot;r0&quot; \</span>
<a name="l00575"></a>00575 <span class="preprocessor"> ); \</span>
<a name="l00576"></a>00576 <span class="preprocessor"> __result; \</span>
<a name="l00577"></a>00577 <span class="preprocessor">}))</span>
<a name="l00578"></a>00578 <span class="preprocessor"></span>
<a name="l00579"></a>00579 <span class="preprocessor">#define __LPM_float_tiny__(addr) \</span>
<a name="l00580"></a>00580 <span class="preprocessor">(__extension__({ \</span>
<a name="l00581"></a>00581 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr) + __AVR_TINY_PM_BASE_ADDRESS__; \</span>
<a name="l00582"></a>00582 <span class="preprocessor"> float __result; \</span>
<a name="l00583"></a>00583 <span class="preprocessor"> __asm__ \</span>
<a name="l00584"></a>00584 <span class="preprocessor"> ( \</span>
<a name="l00585"></a>00585 <span class="preprocessor"> &quot;ld %A0, z+&quot; &quot;\n\t&quot; \</span>
<a name="l00586"></a>00586 <span class="preprocessor"> &quot;ld %B0, z+&quot; &quot;\n\t&quot; \</span>
<a name="l00587"></a>00587 <span class="preprocessor"> &quot;ld %C0, z+&quot; &quot;\n\t&quot; \</span>
<a name="l00588"></a>00588 <span class="preprocessor"> &quot;ld %D0, z&quot; &quot;\n\t&quot; \</span>
<a name="l00589"></a>00589 <span class="preprocessor"> : &quot;=r&quot; (__result), &quot;=z&quot; (__addr16) \</span>
<a name="l00590"></a>00590 <span class="preprocessor"> : &quot;1&quot; (__addr16) \</span>
<a name="l00591"></a>00591 <span class="preprocessor"> ); \</span>
<a name="l00592"></a>00592 <span class="preprocessor"> __result; \</span>
<a name="l00593"></a>00593 <span class="preprocessor">}))</span>
<a name="l00594"></a>00594 <span class="preprocessor"></span>
<a name="l00595"></a>00595 <span class="preprocessor">#define __LPM_float_enhanced__(addr) \</span>
<a name="l00596"></a>00596 <span class="preprocessor">(__extension__({ \</span>
<a name="l00597"></a>00597 <span class="preprocessor"> uint16_t __addr16 = (uint16_t)(addr); \</span>
<a name="l00598"></a>00598 <span class="preprocessor"> float __result; \</span>
<a name="l00599"></a>00599 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00600"></a>00600 <span class="preprocessor"> ( \</span>
<a name="l00601"></a>00601 <span class="preprocessor"> &quot;lpm %A0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00602"></a>00602 <span class="preprocessor"> &quot;lpm %B0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00603"></a>00603 <span class="preprocessor"> &quot;lpm %C0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00604"></a>00604 <span class="preprocessor"> &quot;lpm %D0, Z&quot; &quot;\n\t&quot; \</span>
<a name="l00605"></a>00605 <span class="preprocessor"> : &quot;=r&quot; (__result), &quot;=z&quot; (__addr16) \</span>
<a name="l00606"></a>00606 <span class="preprocessor"> : &quot;1&quot; (__addr16) \</span>
<a name="l00607"></a>00607 <span class="preprocessor"> ); \</span>
<a name="l00608"></a>00608 <span class="preprocessor"> __result; \</span>
<a name="l00609"></a>00609 <span class="preprocessor">}))</span>
<a name="l00610"></a>00610 <span class="preprocessor"></span>
<a name="l00611"></a>00611 <span class="preprocessor">#if defined (__AVR_HAVE_LPMX__)</span>
<a name="l00612"></a>00612 <span class="preprocessor"></span><span class="preprocessor">#define __LPM(addr) __LPM_enhanced__(addr)</span>
<a name="l00613"></a>00613 <span class="preprocessor"></span><span class="preprocessor">#define __LPM_word(addr) __LPM_word_enhanced__(addr)</span>
<a name="l00614"></a>00614 <span class="preprocessor"></span><span class="preprocessor">#define __LPM_dword(addr) __LPM_dword_enhanced__(addr)</span>
<a name="l00615"></a>00615 <span class="preprocessor"></span><span class="preprocessor">#define __LPM_float(addr) __LPM_float_enhanced__(addr)</span>
<a name="l00616"></a>00616 <span class="preprocessor"></span><span class="comment">/*</span>
<a name="l00617"></a>00617 <span class="comment">Macro to read data from program memory for avr tiny parts(tiny 4/5/9/10/20/40).</span>
<a name="l00618"></a>00618 <span class="comment">why:</span>
<a name="l00619"></a>00619 <span class="comment">- LPM instruction is not available in AVR_TINY instruction set.</span>
<a name="l00620"></a>00620 <span class="comment">- Programs are executed starting from address 0x0000 in program memory.</span>
<a name="l00621"></a>00621 <span class="comment">But it must be addressed starting from 0x4000 when accessed via data memory.</span>
<a name="l00622"></a>00622 <span class="comment">Reference: TINY device (ATTiny 4,5,9,10,20 and 40) datasheets</span>
<a name="l00623"></a>00623 <span class="comment">Bug: avrtc-536</span>
<a name="l00624"></a>00624 <span class="comment">*/</span>
<a name="l00625"></a>00625 <span class="preprocessor">#elif defined (__AVR_TINY__)</span>
<a name="l00626"></a>00626 <span class="preprocessor"></span><span class="preprocessor">#define __LPM(addr) __LPM_tiny__(addr)</span>
<a name="l00627"></a>00627 <span class="preprocessor"></span><span class="preprocessor">#define __LPM_word(addr) __LPM_word_tiny__(addr)</span>
<a name="l00628"></a>00628 <span class="preprocessor"></span><span class="preprocessor">#define __LPM_dword(addr) __LPM_dword_tiny__(addr)</span>
<a name="l00629"></a>00629 <span class="preprocessor"></span><span class="preprocessor">#define __LPM_float(addr) __LPM_float_tiny__(addr)</span>
<a name="l00630"></a>00630 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00631"></a>00631 <span class="preprocessor"></span><span class="preprocessor">#define __LPM(addr) __LPM_classic__(addr)</span>
<a name="l00632"></a>00632 <span class="preprocessor"></span><span class="preprocessor">#define __LPM_word(addr) __LPM_word_classic__(addr)</span>
<a name="l00633"></a>00633 <span class="preprocessor"></span><span class="preprocessor">#define __LPM_dword(addr) __LPM_dword_classic__(addr)</span>
<a name="l00634"></a>00634 <span class="preprocessor"></span><span class="preprocessor">#define __LPM_float(addr) __LPM_float_classic__(addr)</span>
<a name="l00635"></a>00635 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00636"></a>00636 <span class="preprocessor"></span>
<a name="l00637"></a>00637 <span class="preprocessor">#endif </span><span class="comment">/* !__DOXYGEN__ */</span>
<a name="l00638"></a>00638 <span class="comment"></span>
<a name="l00639"></a>00639 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l00640"></a>00640 <span class="comment"> \def pgm_read_byte_near(address_short)</span>
<a name="l00641"></a>00641 <span class="comment"> Read a byte from the program space with a 16-bit (near) address. </span>
<a name="l00642"></a>00642 <span class="comment"> \note The address is a byte address.</span>
<a name="l00643"></a>00643 <span class="comment"> The address is in the program space. */</span>
<a name="l00644"></a>00644
<a name="l00645"></a><a class="code" href="group__avr__pgmspace.html#ga88d7dd4863f87530e1a34ece430a587c">00645</a> <span class="preprocessor">#define pgm_read_byte_near(address_short) __LPM((uint16_t)(address_short))</span>
<a name="l00646"></a>00646 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00647"></a>00647 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l00648"></a>00648 <span class="comment"> \def pgm_read_word_near(address_short)</span>
<a name="l00649"></a>00649 <span class="comment"> Read a word from the program space with a 16-bit (near) address. </span>
<a name="l00650"></a>00650 <span class="comment"> \note The address is a byte address. </span>
<a name="l00651"></a>00651 <span class="comment"> The address is in the program space. */</span>
<a name="l00652"></a>00652
<a name="l00653"></a><a class="code" href="group__avr__pgmspace.html#gaf51eeaa847dd2668d2a66b70ecfb7398">00653</a> <span class="preprocessor">#define pgm_read_word_near(address_short) __LPM_word((uint16_t)(address_short))</span>
<a name="l00654"></a>00654 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00655"></a>00655 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l00656"></a>00656 <span class="comment"> \def pgm_read_dword_near(address_short)</span>
<a name="l00657"></a>00657 <span class="comment"> Read a double word from the program space with a 16-bit (near) address. </span>
<a name="l00658"></a>00658 <span class="comment"> \note The address is a byte address. </span>
<a name="l00659"></a>00659 <span class="comment"> The address is in the program space. */</span>
<a name="l00660"></a>00660
<a name="l00661"></a><a class="code" href="group__avr__pgmspace.html#ga7fa92c0a662403a643859e0f33b0a182">00661</a> <span class="preprocessor">#define pgm_read_dword_near(address_short) \</span>
<a name="l00662"></a>00662 <span class="preprocessor"> __LPM_dword((uint16_t)(address_short))</span>
<a name="l00663"></a>00663 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00664"></a>00664 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l00665"></a>00665 <span class="comment"> \def pgm_read_float_near(address_short)</span>
<a name="l00666"></a>00666 <span class="comment"> Read a float from the program space with a 16-bit (near) address. </span>
<a name="l00667"></a>00667 <span class="comment"> \note The address is a byte address. </span>
<a name="l00668"></a>00668 <span class="comment"> The address is in the program space. */</span>
<a name="l00669"></a>00669
<a name="l00670"></a><a class="code" href="group__avr__pgmspace.html#ga066040df814dabc7980cd1422508b46b">00670</a> <span class="preprocessor">#define pgm_read_float_near(address_short) \</span>
<a name="l00671"></a>00671 <span class="preprocessor"> __LPM_float((uint16_t)(address_short))</span>
<a name="l00672"></a>00672 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00673"></a>00673 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l00674"></a>00674 <span class="comment"> \def pgm_read_ptr_near(address_short)</span>
<a name="l00675"></a>00675 <span class="comment"> Read a pointer from the program space with a 16-bit (near) address. </span>
<a name="l00676"></a>00676 <span class="comment"> \note The address is a byte address. </span>
<a name="l00677"></a>00677 <span class="comment"> The address is in the program space. */</span>
<a name="l00678"></a>00678
<a name="l00679"></a><a class="code" href="group__avr__pgmspace.html#gadcfd4df2e156efc1f6a380dfc58a5b81">00679</a> <span class="preprocessor">#define pgm_read_ptr_near(address_short) \</span>
<a name="l00680"></a>00680 <span class="preprocessor"> (void*)__LPM_word((uint16_t)(address_short))</span>
<a name="l00681"></a>00681 <span class="preprocessor"></span>
<a name="l00682"></a>00682 <span class="preprocessor">#if defined(RAMPZ) || defined(__DOXYGEN__)</span>
<a name="l00683"></a>00683 <span class="preprocessor"></span>
<a name="l00684"></a>00684 <span class="comment">/* Only for devices with more than 64K of program memory.</span>
<a name="l00685"></a>00685 <span class="comment"> RAMPZ must be defined (see iom103.h, iom128.h).</span>
<a name="l00686"></a>00686 <span class="comment">*/</span>
<a name="l00687"></a>00687
<a name="l00688"></a>00688 <span class="comment">/* The classic functions are needed for ATmega103. */</span>
<a name="l00689"></a>00689 <span class="preprocessor">#ifndef __DOXYGEN__ </span><span class="comment">/* These are internal macros, avoid &quot;is</span>
<a name="l00690"></a>00690 <span class="comment"> not documented&quot; warnings. */</span>
<a name="l00691"></a>00691 <span class="preprocessor">#define __ELPM_classic__(addr) \</span>
<a name="l00692"></a>00692 <span class="preprocessor">(__extension__({ \</span>
<a name="l00693"></a>00693 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00694"></a>00694 <span class="preprocessor"> uint8_t __result; \</span>
<a name="l00695"></a>00695 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00696"></a>00696 <span class="preprocessor"> ( \</span>
<a name="l00697"></a>00697 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00698"></a>00698 <span class="preprocessor"> &quot;mov r31, %B1&quot; &quot;\n\t&quot; \</span>
<a name="l00699"></a>00699 <span class="preprocessor"> &quot;mov r30, %A1&quot; &quot;\n\t&quot; \</span>
<a name="l00700"></a>00700 <span class="preprocessor"> &quot;elpm&quot; &quot;\n\t&quot; \</span>
<a name="l00701"></a>00701 <span class="preprocessor"> &quot;mov %0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00702"></a>00702 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00703"></a>00703 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00704"></a>00704 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00705"></a>00705 <span class="preprocessor"> : &quot;r0&quot;, &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00706"></a>00706 <span class="preprocessor"> ); \</span>
<a name="l00707"></a>00707 <span class="preprocessor"> __result; \</span>
<a name="l00708"></a>00708 <span class="preprocessor">}))</span>
<a name="l00709"></a>00709 <span class="preprocessor"></span>
<a name="l00710"></a>00710 <span class="preprocessor">#define __ELPM_enhanced__(addr) \</span>
<a name="l00711"></a>00711 <span class="preprocessor">(__extension__({ \</span>
<a name="l00712"></a>00712 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00713"></a>00713 <span class="preprocessor"> uint8_t __result; \</span>
<a name="l00714"></a>00714 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00715"></a>00715 <span class="preprocessor"> ( \</span>
<a name="l00716"></a>00716 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00717"></a>00717 <span class="preprocessor"> &quot;movw r30, %1&quot; &quot;\n\t&quot; \</span>
<a name="l00718"></a>00718 <span class="preprocessor"> &quot;elpm %0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00719"></a>00719 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00720"></a>00720 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00721"></a>00721 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00722"></a>00722 <span class="preprocessor"> : &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00723"></a>00723 <span class="preprocessor"> ); \</span>
<a name="l00724"></a>00724 <span class="preprocessor"> __result; \</span>
<a name="l00725"></a>00725 <span class="preprocessor">}))</span>
<a name="l00726"></a>00726 <span class="preprocessor"></span>
<a name="l00727"></a>00727 <span class="preprocessor">#define __ELPM_xmega__(addr) \</span>
<a name="l00728"></a>00728 <span class="preprocessor">(__extension__({ \</span>
<a name="l00729"></a>00729 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00730"></a>00730 <span class="preprocessor"> uint8_t __result; \</span>
<a name="l00731"></a>00731 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00732"></a>00732 <span class="preprocessor"> ( \</span>
<a name="l00733"></a>00733 <span class="preprocessor"> &quot;in __tmp_reg__, %2&quot; &quot;\n\t&quot; \</span>
<a name="l00734"></a>00734 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00735"></a>00735 <span class="preprocessor"> &quot;movw r30, %1&quot; &quot;\n\t&quot; \</span>
<a name="l00736"></a>00736 <span class="preprocessor"> &quot;elpm %0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00737"></a>00737 <span class="preprocessor"> &quot;out %2, __tmp_reg__&quot; \</span>
<a name="l00738"></a>00738 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00739"></a>00739 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00740"></a>00740 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00741"></a>00741 <span class="preprocessor"> : &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00742"></a>00742 <span class="preprocessor"> ); \</span>
<a name="l00743"></a>00743 <span class="preprocessor"> __result; \</span>
<a name="l00744"></a>00744 <span class="preprocessor">}))</span>
<a name="l00745"></a>00745 <span class="preprocessor"></span>
<a name="l00746"></a>00746 <span class="preprocessor">#define __ELPM_word_classic__(addr) \</span>
<a name="l00747"></a>00747 <span class="preprocessor">(__extension__({ \</span>
<a name="l00748"></a>00748 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00749"></a>00749 <span class="preprocessor"> uint16_t __result; \</span>
<a name="l00750"></a>00750 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00751"></a>00751 <span class="preprocessor"> ( \</span>
<a name="l00752"></a>00752 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00753"></a>00753 <span class="preprocessor"> &quot;mov r31, %B1&quot; &quot;\n\t&quot; \</span>
<a name="l00754"></a>00754 <span class="preprocessor"> &quot;mov r30, %A1&quot; &quot;\n\t&quot; \</span>
<a name="l00755"></a>00755 <span class="preprocessor"> &quot;elpm&quot; &quot;\n\t&quot; \</span>
<a name="l00756"></a>00756 <span class="preprocessor"> &quot;mov %A0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00757"></a>00757 <span class="preprocessor"> &quot;in r0, %2&quot; &quot;\n\t&quot; \</span>
<a name="l00758"></a>00758 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00759"></a>00759 <span class="preprocessor"> &quot;adc r0, __zero_reg__&quot; &quot;\n\t&quot; \</span>
<a name="l00760"></a>00760 <span class="preprocessor"> &quot;out %2, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00761"></a>00761 <span class="preprocessor"> &quot;elpm&quot; &quot;\n\t&quot; \</span>
<a name="l00762"></a>00762 <span class="preprocessor"> &quot;mov %B0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00763"></a>00763 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00764"></a>00764 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00765"></a>00765 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00766"></a>00766 <span class="preprocessor"> : &quot;r0&quot;, &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00767"></a>00767 <span class="preprocessor"> ); \</span>
<a name="l00768"></a>00768 <span class="preprocessor"> __result; \</span>
<a name="l00769"></a>00769 <span class="preprocessor">}))</span>
<a name="l00770"></a>00770 <span class="preprocessor"></span>
<a name="l00771"></a>00771 <span class="preprocessor">#define __ELPM_word_enhanced__(addr) \</span>
<a name="l00772"></a>00772 <span class="preprocessor">(__extension__({ \</span>
<a name="l00773"></a>00773 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00774"></a>00774 <span class="preprocessor"> uint16_t __result; \</span>
<a name="l00775"></a>00775 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00776"></a>00776 <span class="preprocessor"> ( \</span>
<a name="l00777"></a>00777 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00778"></a>00778 <span class="preprocessor"> &quot;movw r30, %1&quot; &quot;\n\t&quot; \</span>
<a name="l00779"></a>00779 <span class="preprocessor"> &quot;elpm %A0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00780"></a>00780 <span class="preprocessor"> &quot;elpm %B0, Z&quot; &quot;\n\t&quot; \</span>
<a name="l00781"></a>00781 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00782"></a>00782 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00783"></a>00783 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00784"></a>00784 <span class="preprocessor"> : &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00785"></a>00785 <span class="preprocessor"> ); \</span>
<a name="l00786"></a>00786 <span class="preprocessor"> __result; \</span>
<a name="l00787"></a>00787 <span class="preprocessor">}))</span>
<a name="l00788"></a>00788 <span class="preprocessor"></span>
<a name="l00789"></a>00789 <span class="preprocessor">#define __ELPM_word_xmega__(addr) \</span>
<a name="l00790"></a>00790 <span class="preprocessor">(__extension__({ \</span>
<a name="l00791"></a>00791 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00792"></a>00792 <span class="preprocessor"> uint16_t __result; \</span>
<a name="l00793"></a>00793 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00794"></a>00794 <span class="preprocessor"> ( \</span>
<a name="l00795"></a>00795 <span class="preprocessor"> &quot;in __tmp_reg__, %2&quot; &quot;\n\t&quot; \</span>
<a name="l00796"></a>00796 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00797"></a>00797 <span class="preprocessor"> &quot;movw r30, %1&quot; &quot;\n\t&quot; \</span>
<a name="l00798"></a>00798 <span class="preprocessor"> &quot;elpm %A0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00799"></a>00799 <span class="preprocessor"> &quot;elpm %B0, Z&quot; &quot;\n\t&quot; \</span>
<a name="l00800"></a>00800 <span class="preprocessor"> &quot;out %2, __tmp_reg__&quot; \</span>
<a name="l00801"></a>00801 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00802"></a>00802 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00803"></a>00803 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00804"></a>00804 <span class="preprocessor"> : &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00805"></a>00805 <span class="preprocessor"> ); \</span>
<a name="l00806"></a>00806 <span class="preprocessor"> __result; \</span>
<a name="l00807"></a>00807 <span class="preprocessor">}))</span>
<a name="l00808"></a>00808 <span class="preprocessor"></span>
<a name="l00809"></a>00809 <span class="preprocessor">#define __ELPM_dword_classic__(addr) \</span>
<a name="l00810"></a>00810 <span class="preprocessor">(__extension__({ \</span>
<a name="l00811"></a>00811 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00812"></a>00812 <span class="preprocessor"> uint32_t __result; \</span>
<a name="l00813"></a>00813 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00814"></a>00814 <span class="preprocessor"> ( \</span>
<a name="l00815"></a>00815 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00816"></a>00816 <span class="preprocessor"> &quot;mov r31, %B1&quot; &quot;\n\t&quot; \</span>
<a name="l00817"></a>00817 <span class="preprocessor"> &quot;mov r30, %A1&quot; &quot;\n\t&quot; \</span>
<a name="l00818"></a>00818 <span class="preprocessor"> &quot;elpm&quot; &quot;\n\t&quot; \</span>
<a name="l00819"></a>00819 <span class="preprocessor"> &quot;mov %A0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00820"></a>00820 <span class="preprocessor"> &quot;in r0, %2&quot; &quot;\n\t&quot; \</span>
<a name="l00821"></a>00821 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00822"></a>00822 <span class="preprocessor"> &quot;adc r0, __zero_reg__&quot; &quot;\n\t&quot; \</span>
<a name="l00823"></a>00823 <span class="preprocessor"> &quot;out %2, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00824"></a>00824 <span class="preprocessor"> &quot;elpm&quot; &quot;\n\t&quot; \</span>
<a name="l00825"></a>00825 <span class="preprocessor"> &quot;mov %B0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00826"></a>00826 <span class="preprocessor"> &quot;in r0, %2&quot; &quot;\n\t&quot; \</span>
<a name="l00827"></a>00827 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00828"></a>00828 <span class="preprocessor"> &quot;adc r0, __zero_reg__&quot; &quot;\n\t&quot; \</span>
<a name="l00829"></a>00829 <span class="preprocessor"> &quot;out %2, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00830"></a>00830 <span class="preprocessor"> &quot;elpm&quot; &quot;\n\t&quot; \</span>
<a name="l00831"></a>00831 <span class="preprocessor"> &quot;mov %C0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00832"></a>00832 <span class="preprocessor"> &quot;in r0, %2&quot; &quot;\n\t&quot; \</span>
<a name="l00833"></a>00833 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00834"></a>00834 <span class="preprocessor"> &quot;adc r0, __zero_reg__&quot; &quot;\n\t&quot; \</span>
<a name="l00835"></a>00835 <span class="preprocessor"> &quot;out %2, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00836"></a>00836 <span class="preprocessor"> &quot;elpm&quot; &quot;\n\t&quot; \</span>
<a name="l00837"></a>00837 <span class="preprocessor"> &quot;mov %D0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00838"></a>00838 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00839"></a>00839 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00840"></a>00840 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00841"></a>00841 <span class="preprocessor"> : &quot;r0&quot;, &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00842"></a>00842 <span class="preprocessor"> ); \</span>
<a name="l00843"></a>00843 <span class="preprocessor"> __result; \</span>
<a name="l00844"></a>00844 <span class="preprocessor">}))</span>
<a name="l00845"></a>00845 <span class="preprocessor"></span>
<a name="l00846"></a>00846 <span class="preprocessor">#define __ELPM_dword_enhanced__(addr) \</span>
<a name="l00847"></a>00847 <span class="preprocessor">(__extension__({ \</span>
<a name="l00848"></a>00848 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00849"></a>00849 <span class="preprocessor"> uint32_t __result; \</span>
<a name="l00850"></a>00850 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00851"></a>00851 <span class="preprocessor"> ( \</span>
<a name="l00852"></a>00852 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00853"></a>00853 <span class="preprocessor"> &quot;movw r30, %1&quot; &quot;\n\t&quot; \</span>
<a name="l00854"></a>00854 <span class="preprocessor"> &quot;elpm %A0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00855"></a>00855 <span class="preprocessor"> &quot;elpm %B0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00856"></a>00856 <span class="preprocessor"> &quot;elpm %C0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00857"></a>00857 <span class="preprocessor"> &quot;elpm %D0, Z&quot; &quot;\n\t&quot; \</span>
<a name="l00858"></a>00858 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00859"></a>00859 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00860"></a>00860 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00861"></a>00861 <span class="preprocessor"> : &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00862"></a>00862 <span class="preprocessor"> ); \</span>
<a name="l00863"></a>00863 <span class="preprocessor"> __result; \</span>
<a name="l00864"></a>00864 <span class="preprocessor">}))</span>
<a name="l00865"></a>00865 <span class="preprocessor"></span>
<a name="l00866"></a>00866 <span class="preprocessor">#define __ELPM_dword_xmega__(addr) \</span>
<a name="l00867"></a>00867 <span class="preprocessor">(__extension__({ \</span>
<a name="l00868"></a>00868 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00869"></a>00869 <span class="preprocessor"> uint32_t __result; \</span>
<a name="l00870"></a>00870 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00871"></a>00871 <span class="preprocessor"> ( \</span>
<a name="l00872"></a>00872 <span class="preprocessor"> &quot;in __tmp_reg__, %2&quot; &quot;\n\t&quot; \</span>
<a name="l00873"></a>00873 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00874"></a>00874 <span class="preprocessor"> &quot;movw r30, %1&quot; &quot;\n\t&quot; \</span>
<a name="l00875"></a>00875 <span class="preprocessor"> &quot;elpm %A0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00876"></a>00876 <span class="preprocessor"> &quot;elpm %B0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00877"></a>00877 <span class="preprocessor"> &quot;elpm %C0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00878"></a>00878 <span class="preprocessor"> &quot;elpm %D0, Z&quot; &quot;\n\t&quot; \</span>
<a name="l00879"></a>00879 <span class="preprocessor"> &quot;out %2, __tmp_reg__&quot; \</span>
<a name="l00880"></a>00880 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00881"></a>00881 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00882"></a>00882 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00883"></a>00883 <span class="preprocessor"> : &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00884"></a>00884 <span class="preprocessor"> ); \</span>
<a name="l00885"></a>00885 <span class="preprocessor"> __result; \</span>
<a name="l00886"></a>00886 <span class="preprocessor">}))</span>
<a name="l00887"></a>00887 <span class="preprocessor"></span>
<a name="l00888"></a>00888 <span class="preprocessor">#define __ELPM_float_classic__(addr) \</span>
<a name="l00889"></a>00889 <span class="preprocessor">(__extension__({ \</span>
<a name="l00890"></a>00890 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00891"></a>00891 <span class="preprocessor"> float __result; \</span>
<a name="l00892"></a>00892 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00893"></a>00893 <span class="preprocessor"> ( \</span>
<a name="l00894"></a>00894 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00895"></a>00895 <span class="preprocessor"> &quot;mov r31, %B1&quot; &quot;\n\t&quot; \</span>
<a name="l00896"></a>00896 <span class="preprocessor"> &quot;mov r30, %A1&quot; &quot;\n\t&quot; \</span>
<a name="l00897"></a>00897 <span class="preprocessor"> &quot;elpm&quot; &quot;\n\t&quot; \</span>
<a name="l00898"></a>00898 <span class="preprocessor"> &quot;mov %A0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00899"></a>00899 <span class="preprocessor"> &quot;in r0, %2&quot; &quot;\n\t&quot; \</span>
<a name="l00900"></a>00900 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00901"></a>00901 <span class="preprocessor"> &quot;adc r0, __zero_reg__&quot; &quot;\n\t&quot; \</span>
<a name="l00902"></a>00902 <span class="preprocessor"> &quot;out %2, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00903"></a>00903 <span class="preprocessor"> &quot;elpm&quot; &quot;\n\t&quot; \</span>
<a name="l00904"></a>00904 <span class="preprocessor"> &quot;mov %B0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00905"></a>00905 <span class="preprocessor"> &quot;in r0, %2&quot; &quot;\n\t&quot; \</span>
<a name="l00906"></a>00906 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00907"></a>00907 <span class="preprocessor"> &quot;adc r0, __zero_reg__&quot; &quot;\n\t&quot; \</span>
<a name="l00908"></a>00908 <span class="preprocessor"> &quot;out %2, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00909"></a>00909 <span class="preprocessor"> &quot;elpm&quot; &quot;\n\t&quot; \</span>
<a name="l00910"></a>00910 <span class="preprocessor"> &quot;mov %C0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00911"></a>00911 <span class="preprocessor"> &quot;in r0, %2&quot; &quot;\n\t&quot; \</span>
<a name="l00912"></a>00912 <span class="preprocessor"> &quot;adiw r30, 1&quot; &quot;\n\t&quot; \</span>
<a name="l00913"></a>00913 <span class="preprocessor"> &quot;adc r0, __zero_reg__&quot; &quot;\n\t&quot; \</span>
<a name="l00914"></a>00914 <span class="preprocessor"> &quot;out %2, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00915"></a>00915 <span class="preprocessor"> &quot;elpm&quot; &quot;\n\t&quot; \</span>
<a name="l00916"></a>00916 <span class="preprocessor"> &quot;mov %D0, r0&quot; &quot;\n\t&quot; \</span>
<a name="l00917"></a>00917 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00918"></a>00918 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00919"></a>00919 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00920"></a>00920 <span class="preprocessor"> : &quot;r0&quot;, &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00921"></a>00921 <span class="preprocessor"> ); \</span>
<a name="l00922"></a>00922 <span class="preprocessor"> __result; \</span>
<a name="l00923"></a>00923 <span class="preprocessor">}))</span>
<a name="l00924"></a>00924 <span class="preprocessor"></span>
<a name="l00925"></a>00925 <span class="preprocessor">#define __ELPM_float_enhanced__(addr) \</span>
<a name="l00926"></a>00926 <span class="preprocessor">(__extension__({ \</span>
<a name="l00927"></a>00927 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00928"></a>00928 <span class="preprocessor"> float __result; \</span>
<a name="l00929"></a>00929 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00930"></a>00930 <span class="preprocessor"> ( \</span>
<a name="l00931"></a>00931 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00932"></a>00932 <span class="preprocessor"> &quot;movw r30, %1&quot; &quot;\n\t&quot; \</span>
<a name="l00933"></a>00933 <span class="preprocessor"> &quot;elpm %A0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00934"></a>00934 <span class="preprocessor"> &quot;elpm %B0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00935"></a>00935 <span class="preprocessor"> &quot;elpm %C0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00936"></a>00936 <span class="preprocessor"> &quot;elpm %D0, Z&quot; &quot;\n\t&quot; \</span>
<a name="l00937"></a>00937 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00938"></a>00938 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00939"></a>00939 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00940"></a>00940 <span class="preprocessor"> : &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00941"></a>00941 <span class="preprocessor"> ); \</span>
<a name="l00942"></a>00942 <span class="preprocessor"> __result; \</span>
<a name="l00943"></a>00943 <span class="preprocessor">}))</span>
<a name="l00944"></a>00944 <span class="preprocessor"></span>
<a name="l00945"></a>00945 <span class="preprocessor">#define __ELPM_float_xmega__(addr) \</span>
<a name="l00946"></a>00946 <span class="preprocessor">(__extension__({ \</span>
<a name="l00947"></a>00947 <span class="preprocessor"> uint32_t __addr32 = (uint32_t)(addr); \</span>
<a name="l00948"></a>00948 <span class="preprocessor"> float __result; \</span>
<a name="l00949"></a>00949 <span class="preprocessor"> __asm__ __volatile__ \</span>
<a name="l00950"></a>00950 <span class="preprocessor"> ( \</span>
<a name="l00951"></a>00951 <span class="preprocessor"> &quot;in __tmp_reg__, %2&quot; &quot;\n\t&quot; \</span>
<a name="l00952"></a>00952 <span class="preprocessor"> &quot;out %2, %C1&quot; &quot;\n\t&quot; \</span>
<a name="l00953"></a>00953 <span class="preprocessor"> &quot;movw r30, %1&quot; &quot;\n\t&quot; \</span>
<a name="l00954"></a>00954 <span class="preprocessor"> &quot;elpm %A0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00955"></a>00955 <span class="preprocessor"> &quot;elpm %B0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00956"></a>00956 <span class="preprocessor"> &quot;elpm %C0, Z+&quot; &quot;\n\t&quot; \</span>
<a name="l00957"></a>00957 <span class="preprocessor"> &quot;elpm %D0, Z&quot; &quot;\n\t&quot; \</span>
<a name="l00958"></a>00958 <span class="preprocessor"> &quot;out %2, __tmp_reg__&quot; \</span>
<a name="l00959"></a>00959 <span class="preprocessor"> : &quot;=r&quot; (__result) \</span>
<a name="l00960"></a>00960 <span class="preprocessor"> : &quot;r&quot; (__addr32), \</span>
<a name="l00961"></a>00961 <span class="preprocessor"> &quot;I&quot; (_SFR_IO_ADDR(RAMPZ)) \</span>
<a name="l00962"></a>00962 <span class="preprocessor"> : &quot;r30&quot;, &quot;r31&quot; \</span>
<a name="l00963"></a>00963 <span class="preprocessor"> ); \</span>
<a name="l00964"></a>00964 <span class="preprocessor"> __result; \</span>
<a name="l00965"></a>00965 <span class="preprocessor">}))</span>
<a name="l00966"></a>00966 <span class="preprocessor"></span>
<a name="l00967"></a>00967 <span class="comment">/*</span>
<a name="l00968"></a>00968 <span class="comment">Check for architectures that implement RAMPD (avrxmega5, avrxmega7)</span>
<a name="l00969"></a>00969 <span class="comment">as they need to save/restore RAMPZ for ELPM macros so it does</span>
<a name="l00970"></a>00970 <span class="comment">not interfere with data accesses.</span>
<a name="l00971"></a>00971 <span class="comment">*/</span>
<a name="l00972"></a>00972 <span class="preprocessor">#if defined (__AVR_HAVE_RAMPD__)</span>
<a name="l00973"></a>00973 <span class="preprocessor"></span>
<a name="l00974"></a>00974 <span class="preprocessor">#define __ELPM(addr) __ELPM_xmega__(addr)</span>
<a name="l00975"></a>00975 <span class="preprocessor"></span><span class="preprocessor">#define __ELPM_word(addr) __ELPM_word_xmega__(addr)</span>
<a name="l00976"></a>00976 <span class="preprocessor"></span><span class="preprocessor">#define __ELPM_dword(addr) __ELPM_dword_xmega__(addr)</span>
<a name="l00977"></a>00977 <span class="preprocessor"></span><span class="preprocessor">#define __ELPM_float(addr) __ELPM_float_xmega__(addr)</span>
<a name="l00978"></a>00978 <span class="preprocessor"></span>
<a name="l00979"></a>00979 <span class="preprocessor">#else</span>
<a name="l00980"></a>00980 <span class="preprocessor"></span>
<a name="l00981"></a>00981 <span class="preprocessor">#if defined (__AVR_HAVE_LPMX__)</span>
<a name="l00982"></a>00982 <span class="preprocessor"></span>
<a name="l00983"></a>00983 <span class="preprocessor">#define __ELPM(addr) __ELPM_enhanced__(addr)</span>
<a name="l00984"></a>00984 <span class="preprocessor"></span><span class="preprocessor">#define __ELPM_word(addr) __ELPM_word_enhanced__(addr)</span>
<a name="l00985"></a>00985 <span class="preprocessor"></span><span class="preprocessor">#define __ELPM_dword(addr) __ELPM_dword_enhanced__(addr)</span>
<a name="l00986"></a>00986 <span class="preprocessor"></span><span class="preprocessor">#define __ELPM_float(addr) __ELPM_float_enhanced__(addr)</span>
<a name="l00987"></a>00987 <span class="preprocessor"></span>
<a name="l00988"></a>00988 <span class="preprocessor">#else</span>
<a name="l00989"></a>00989 <span class="preprocessor"></span>
<a name="l00990"></a>00990 <span class="preprocessor">#define __ELPM(addr) __ELPM_classic__(addr)</span>
<a name="l00991"></a>00991 <span class="preprocessor"></span><span class="preprocessor">#define __ELPM_word(addr) __ELPM_word_classic__(addr)</span>
<a name="l00992"></a>00992 <span class="preprocessor"></span><span class="preprocessor">#define __ELPM_dword(addr) __ELPM_dword_classic__(addr)</span>
<a name="l00993"></a>00993 <span class="preprocessor"></span><span class="preprocessor">#define __ELPM_float(addr) __ELPM_float_classic__(addr)</span>
<a name="l00994"></a>00994 <span class="preprocessor"></span>
<a name="l00995"></a>00995 <span class="preprocessor">#endif </span><span class="comment">/* __AVR_HAVE_LPMX__ */</span>
<a name="l00996"></a>00996
<a name="l00997"></a>00997 <span class="preprocessor">#endif </span><span class="comment">/* __AVR_HAVE_RAMPD__ */</span>
<a name="l00998"></a>00998
<a name="l00999"></a>00999 <span class="preprocessor">#endif </span><span class="comment">/* !__DOXYGEN__ */</span>
<a name="l01000"></a>01000 <span class="comment"></span>
<a name="l01001"></a>01001 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01002"></a>01002 <span class="comment"> \def pgm_read_byte_far(address_long)</span>
<a name="l01003"></a>01003 <span class="comment"> Read a byte from the program space with a 32-bit (far) address. </span>
<a name="l01004"></a>01004 <span class="comment"></span>
<a name="l01005"></a>01005 <span class="comment"> \note The address is a byte address. </span>
<a name="l01006"></a>01006 <span class="comment"> The address is in the program space. */</span>
<a name="l01007"></a>01007
<a name="l01008"></a><a class="code" href="group__avr__pgmspace.html#ga0d4d7f6231716747c52b969d4febdeed">01008</a> <span class="preprocessor">#define pgm_read_byte_far(address_long) __ELPM((uint32_t)(address_long))</span>
<a name="l01009"></a>01009 <span class="preprocessor"></span><span class="comment"></span>
<a name="l01010"></a>01010 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01011"></a>01011 <span class="comment"> \def pgm_read_word_far(address_long)</span>
<a name="l01012"></a>01012 <span class="comment"> Read a word from the program space with a 32-bit (far) address. </span>
<a name="l01013"></a>01013 <span class="comment"></span>
<a name="l01014"></a>01014 <span class="comment"> \note The address is a byte address.</span>
<a name="l01015"></a>01015 <span class="comment"> The address is in the program space. */</span>
<a name="l01016"></a>01016
<a name="l01017"></a><a class="code" href="group__avr__pgmspace.html#gad7082c45c2c96f015c76eff1ad00a99a">01017</a> <span class="preprocessor">#define pgm_read_word_far(address_long) __ELPM_word((uint32_t)(address_long))</span>
<a name="l01018"></a>01018 <span class="preprocessor"></span><span class="comment"></span>
<a name="l01019"></a>01019 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01020"></a>01020 <span class="comment"> \def pgm_read_dword_far(address_long)</span>
<a name="l01021"></a>01021 <span class="comment"> Read a double word from the program space with a 32-bit (far) address. </span>
<a name="l01022"></a>01022 <span class="comment"></span>
<a name="l01023"></a>01023 <span class="comment"> \note The address is a byte address.</span>
<a name="l01024"></a>01024 <span class="comment"> The address is in the program space. */</span>
<a name="l01025"></a>01025
<a name="l01026"></a><a class="code" href="group__avr__pgmspace.html#ga309908c1b7430f0d140edb78fcf8f2b9">01026</a> <span class="preprocessor">#define pgm_read_dword_far(address_long) __ELPM_dword((uint32_t)(address_long))</span>
<a name="l01027"></a>01027 <span class="preprocessor"></span><span class="comment"></span>
<a name="l01028"></a>01028 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01029"></a>01029 <span class="comment"> \def pgm_read_float_far(address_long)</span>
<a name="l01030"></a>01030 <span class="comment"> Read a float from the program space with a 32-bit (far) address. </span>
<a name="l01031"></a>01031 <span class="comment"></span>
<a name="l01032"></a>01032 <span class="comment"> \note The address is a byte address.</span>
<a name="l01033"></a>01033 <span class="comment"> The address is in the program space. */</span>
<a name="l01034"></a>01034
<a name="l01035"></a><a class="code" href="group__avr__pgmspace.html#ga4a5a593aa84062ca08b3f2d564a6f466">01035</a> <span class="preprocessor">#define pgm_read_float_far(address_long) __ELPM_float((uint32_t)(address_long))</span>
<a name="l01036"></a>01036 <span class="preprocessor"></span><span class="comment"></span>
<a name="l01037"></a>01037 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01038"></a>01038 <span class="comment"> \def pgm_read_ptr_far(address_long)</span>
<a name="l01039"></a>01039 <span class="comment"> Read a pointer from the program space with a 32-bit (far) address. </span>
<a name="l01040"></a>01040 <span class="comment"></span>
<a name="l01041"></a>01041 <span class="comment"> \note The address is a byte address.</span>
<a name="l01042"></a>01042 <span class="comment"> The address is in the program space. */</span>
<a name="l01043"></a>01043
<a name="l01044"></a><a class="code" href="group__avr__pgmspace.html#gaa7756dce7bcc8ba46e648981fafebbf2">01044</a> <span class="preprocessor">#define pgm_read_ptr_far(address_long) (void*)__ELPM_word((uint32_t)(address_long))</span>
<a name="l01045"></a>01045 <span class="preprocessor"></span>
<a name="l01046"></a>01046 <span class="preprocessor">#endif </span><span class="comment">/* RAMPZ or __DOXYGEN__ */</span>
<a name="l01047"></a>01047 <span class="comment"></span>
<a name="l01048"></a>01048 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01049"></a>01049 <span class="comment"> \def pgm_read_byte(address_short)</span>
<a name="l01050"></a>01050 <span class="comment"> Read a byte from the program space with a 16-bit (near) address. </span>
<a name="l01051"></a>01051 <span class="comment"></span>
<a name="l01052"></a>01052 <span class="comment"> \note The address is a byte address. </span>
<a name="l01053"></a>01053 <span class="comment"> The address is in the program space. */</span>
<a name="l01054"></a>01054
<a name="l01055"></a><a class="code" href="group__avr__pgmspace.html#ga73084a8bbde259ffae72980354b3f027">01055</a> <span class="preprocessor">#define pgm_read_byte(address_short) pgm_read_byte_near(address_short)</span>
<a name="l01056"></a>01056 <span class="preprocessor"></span><span class="comment"></span>
<a name="l01057"></a>01057 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01058"></a>01058 <span class="comment"> \def pgm_read_word(address_short)</span>
<a name="l01059"></a>01059 <span class="comment"> Read a word from the program space with a 16-bit (near) address. </span>
<a name="l01060"></a>01060 <span class="comment"></span>
<a name="l01061"></a>01061 <span class="comment"> \note The address is a byte address. </span>
<a name="l01062"></a>01062 <span class="comment"> The address is in the program space. */</span>
<a name="l01063"></a>01063
<a name="l01064"></a><a class="code" href="group__avr__pgmspace.html#ga32d8ab354156f4b1ffdb77a275ba6223">01064</a> <span class="preprocessor">#define pgm_read_word(address_short) pgm_read_word_near(address_short)</span>
<a name="l01065"></a>01065 <span class="preprocessor"></span><span class="comment"></span>
<a name="l01066"></a>01066 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01067"></a>01067 <span class="comment"> \def pgm_read_dword(address_short)</span>
<a name="l01068"></a>01068 <span class="comment"> Read a double word from the program space with a 16-bit (near) address. </span>
<a name="l01069"></a>01069 <span class="comment"></span>
<a name="l01070"></a>01070 <span class="comment"> \note The address is a byte address. </span>
<a name="l01071"></a>01071 <span class="comment"> The address is in the program space. */</span>
<a name="l01072"></a>01072
<a name="l01073"></a><a class="code" href="group__avr__pgmspace.html#gabb68859ac5dfa6a09ac048b4037a83b6">01073</a> <span class="preprocessor">#define pgm_read_dword(address_short) pgm_read_dword_near(address_short)</span>
<a name="l01074"></a>01074 <span class="preprocessor"></span><span class="comment"></span>
<a name="l01075"></a>01075 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01076"></a>01076 <span class="comment"> \def pgm_read_float(address_short)</span>
<a name="l01077"></a>01077 <span class="comment"> Read a float from the program space with a 16-bit (near) address. </span>
<a name="l01078"></a>01078 <span class="comment"></span>
<a name="l01079"></a>01079 <span class="comment"> \note The address is a byte address. </span>
<a name="l01080"></a>01080 <span class="comment"> The address is in the program space. */</span>
<a name="l01081"></a>01081
<a name="l01082"></a><a class="code" href="group__avr__pgmspace.html#ga7911bddb066a8a038efc4b7857728fa8">01082</a> <span class="preprocessor">#define pgm_read_float(address_short) pgm_read_float_near(address_short)</span>
<a name="l01083"></a>01083 <span class="preprocessor"></span><span class="comment"></span>
<a name="l01084"></a>01084 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01085"></a>01085 <span class="comment"> \def pgm_read_ptr(address_short)</span>
<a name="l01086"></a>01086 <span class="comment"> Read a pointer from the program space with a 16-bit (near) address. </span>
<a name="l01087"></a>01087 <span class="comment"></span>
<a name="l01088"></a>01088 <span class="comment"> \note The address is a byte address. </span>
<a name="l01089"></a>01089 <span class="comment"> The address is in the program space. */</span>
<a name="l01090"></a>01090
<a name="l01091"></a><a class="code" href="group__avr__pgmspace.html#gac9f61931fd8cf4cf4764744dbaee81b6">01091</a> <span class="preprocessor">#define pgm_read_ptr(address_short) pgm_read_ptr_near(address_short)</span>
<a name="l01092"></a>01092 <span class="preprocessor"></span><span class="comment"></span>
<a name="l01093"></a>01093 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01094"></a>01094 <span class="comment"> \def pgm_get_far_address(var)</span>
<a name="l01095"></a>01095 <span class="comment"></span>
<a name="l01096"></a>01096 <span class="comment"> This macro facilitates the obtention of a 32 bit &quot;far&quot; pointer (only 24 bits</span>
<a name="l01097"></a>01097 <span class="comment"> used) to data even passed the 64KB limit for the 16 bit ordinary pointer. It</span>
<a name="l01098"></a>01098 <span class="comment"> is similar to the &#39;&amp;&#39; operator, with some limitations.</span>
<a name="l01099"></a>01099 <span class="comment"></span>
<a name="l01100"></a>01100 <span class="comment"> Comments:</span>
<a name="l01101"></a>01101 <span class="comment"></span>
<a name="l01102"></a>01102 <span class="comment"> - The overhead is minimal and it&#39;s mainly due to the 32 bit size operation.</span>
<a name="l01103"></a>01103 <span class="comment"></span>
<a name="l01104"></a>01104 <span class="comment"> - 24 bit sizes guarantees the code compatibility for use in future devices.</span>
<a name="l01105"></a>01105 <span class="comment"></span>
<a name="l01106"></a>01106 <span class="comment"> - hh8() is an undocumented feature but seems to give the third significant byte</span>
<a name="l01107"></a>01107 <span class="comment"> of a 32 bit data and accepts symbols, complementing the functionality of hi8()</span>
<a name="l01108"></a>01108 <span class="comment"> and lo8(). There is not an equivalent assembler function to get the high</span>
<a name="l01109"></a>01109 <span class="comment"> significant byte.</span>
<a name="l01110"></a>01110 <span class="comment"></span>
<a name="l01111"></a>01111 <span class="comment"> - &#39;var&#39; has to be resolved at linking time as an existing symbol, i.e, a simple</span>
<a name="l01112"></a>01112 <span class="comment"> type variable name, an array name (not an indexed element of the array, if the</span>
<a name="l01113"></a>01113 <span class="comment"> index is a constant the compiler does not complain but fails to get the address</span>
<a name="l01114"></a>01114 <span class="comment"> if optimization is enabled), a struct name or a struct field name, a function</span>
<a name="l01115"></a>01115 <span class="comment"> identifier, a linker defined identifier,...</span>
<a name="l01116"></a>01116 <span class="comment"></span>
<a name="l01117"></a>01117 <span class="comment"> - The returned value is the identifier&#39;s VMA (virtual memory address) determined</span>
<a name="l01118"></a>01118 <span class="comment"> by the linker and falls in the corresponding memory region. The AVR Harvard</span>
<a name="l01119"></a>01119 <span class="comment"> architecture requires non overlapping VMA areas for the multiple address spaces</span>
<a name="l01120"></a>01120 <span class="comment"> in the processor: Flash ROM, RAM, and EEPROM. Typical offset for this are</span>
<a name="l01121"></a>01121 <span class="comment"> 0x00000000, 0x00800xx0, and 0x00810000 respectively, derived from the linker</span>
<a name="l01122"></a>01122 <span class="comment"> script used and linker options. The value returned can be seen then as a</span>
<a name="l01123"></a>01123 <span class="comment"> universal pointer.</span>
<a name="l01124"></a>01124 <span class="comment">*/</span>
<a name="l01125"></a>01125
<a name="l01126"></a><a class="code" href="group__avr__pgmspace.html#ga8ddf0e398bde8078aa9395ac77c83f0a">01126</a> <span class="preprocessor">#define pgm_get_far_address(var) \</span>
<a name="l01127"></a>01127 <span class="preprocessor">({ \</span>
<a name="l01128"></a>01128 <span class="preprocessor"> uint_farptr_t tmp; \</span>
<a name="l01129"></a>01129 <span class="preprocessor"> \</span>
<a name="l01130"></a>01130 <span class="preprocessor"> __asm__ __volatile__( \</span>
<a name="l01131"></a>01131 <span class="preprocessor"> \</span>
<a name="l01132"></a>01132 <span class="preprocessor"> &quot;ldi %A0, lo8(%1)&quot; &quot;\n\t&quot; \</span>
<a name="l01133"></a>01133 <span class="preprocessor"> &quot;ldi %B0, hi8(%1)&quot; &quot;\n\t&quot; \</span>
<a name="l01134"></a>01134 <span class="preprocessor"> &quot;ldi %C0, hh8(%1)&quot; &quot;\n\t&quot; \</span>
<a name="l01135"></a>01135 <span class="preprocessor"> &quot;clr %D0&quot; &quot;\n\t&quot; \</span>
<a name="l01136"></a>01136 <span class="preprocessor"> : \</span>
<a name="l01137"></a>01137 <span class="preprocessor"> &quot;=d&quot; (tmp) \</span>
<a name="l01138"></a>01138 <span class="preprocessor"> : \</span>
<a name="l01139"></a>01139 <span class="preprocessor"> &quot;p&quot; (&amp;(var)) \</span>
<a name="l01140"></a>01140 <span class="preprocessor"> ); \</span>
<a name="l01141"></a>01141 <span class="preprocessor"> tmp; \</span>
<a name="l01142"></a>01142 <span class="preprocessor">})</span>
<a name="l01143"></a>01143 <span class="preprocessor"></span>
<a name="l01144"></a>01144
<a name="l01145"></a>01145 <span class="comment"></span>
<a name="l01146"></a>01146 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01147"></a>01147 <span class="comment"> \fn const void * memchr_P(const void *s, int val, size_t len)</span>
<a name="l01148"></a>01148 <span class="comment"> \brief Scan flash memory for a character.</span>
<a name="l01149"></a>01149 <span class="comment"></span>
<a name="l01150"></a>01150 <span class="comment"> The memchr_P() function scans the first \p len bytes of the flash</span>
<a name="l01151"></a>01151 <span class="comment"> memory area pointed to by \p s for the character \p val. The first</span>
<a name="l01152"></a>01152 <span class="comment"> byte to match \p val (interpreted as an unsigned character) stops</span>
<a name="l01153"></a>01153 <span class="comment"> the operation.</span>
<a name="l01154"></a>01154 <span class="comment"></span>
<a name="l01155"></a>01155 <span class="comment"> \return The memchr_P() function returns a pointer to the matching</span>
<a name="l01156"></a>01156 <span class="comment"> byte or \c NULL if the character does not occur in the given memory</span>
<a name="l01157"></a>01157 <span class="comment"> area. */</span>
<a name="l01158"></a>01158 <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">void</span> * <a class="code" href="group__avr__pgmspace.html#ga44f0b73a84e00da51ae135affc706b34" title="Scan flash memory for a character.">memchr_P</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *, <span class="keywordtype">int</span> __val, <span class="keywordtype">size_t</span> __len) __ATTR_CONST__;
<a name="l01159"></a>01159 <span class="comment"></span>
<a name="l01160"></a>01160 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01161"></a>01161 <span class="comment"> \fn int memcmp_P(const void *s1, const void *s2, size_t len)</span>
<a name="l01162"></a>01162 <span class="comment"> \brief Compare memory areas</span>
<a name="l01163"></a>01163 <span class="comment"></span>
<a name="l01164"></a>01164 <span class="comment"> The memcmp_P() function compares the first \p len bytes of the memory</span>
<a name="l01165"></a>01165 <span class="comment"> areas \p s1 and flash \p s2. The comparision is performed using unsigned</span>
<a name="l01166"></a>01166 <span class="comment"> char operations.</span>
<a name="l01167"></a>01167 <span class="comment"></span>
<a name="l01168"></a>01168 <span class="comment"> \returns The memcmp_P() function returns an integer less than, equal</span>
<a name="l01169"></a>01169 <span class="comment"> to, or greater than zero if the first \p len bytes of \p s1 is found,</span>
<a name="l01170"></a>01170 <span class="comment"> respectively, to be less than, to match, or be greater than the first</span>
<a name="l01171"></a>01171 <span class="comment"> \p len bytes of \p s2. */</span>
<a name="l01172"></a>01172 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__avr__pgmspace.html#gab1b0b56685303c2452e98914e7e5d6d0" title="Compare memory areas.">memcmp_P</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *, <span class="keyword">const</span> <span class="keywordtype">void</span> *, <span class="keywordtype">size_t</span>) __ATTR_PURE__;
<a name="l01173"></a>01173 <span class="comment"></span>
<a name="l01174"></a>01174 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01175"></a>01175 <span class="comment"> \fn void *memccpy_P (void *dest, const void *src, int val, size_t len)</span>
<a name="l01176"></a>01176 <span class="comment"></span>
<a name="l01177"></a>01177 <span class="comment"> This function is similar to memccpy() except that \p src is pointer</span>
<a name="l01178"></a>01178 <span class="comment"> to a string in program space. */</span>
<a name="l01179"></a>01179 extern <span class="keywordtype">void</span> *<a class="code" href="group__avr__pgmspace.html#ga469016cff9c68b19838ad26e099b0fc3">memccpy_P</a>(<span class="keywordtype">void</span> *, const <span class="keywordtype">void</span> *, <span class="keywordtype">int</span> __val, <span class="keywordtype">size_t</span>);
<a name="l01180"></a>01180 <span class="comment"></span>
<a name="l01181"></a>01181 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01182"></a>01182 <span class="comment"> \fn void *memcpy_P(void *dest, const void *src, size_t n)</span>
<a name="l01183"></a>01183 <span class="comment"></span>
<a name="l01184"></a>01184 <span class="comment"> The memcpy_P() function is similar to memcpy(), except the src string</span>
<a name="l01185"></a>01185 <span class="comment"> resides in program space.</span>
<a name="l01186"></a>01186 <span class="comment"></span>
<a name="l01187"></a>01187 <span class="comment"> \returns The memcpy_P() function returns a pointer to dest. */</span>
<a name="l01188"></a>01188 extern <span class="keywordtype">void</span> *<a class="code" href="group__avr__pgmspace.html#gad92fa2ebe26e65fa424051047d21a0eb">memcpy_P</a>(<span class="keywordtype">void</span> *, const <span class="keywordtype">void</span> *, <span class="keywordtype">size_t</span>);
<a name="l01189"></a>01189 <span class="comment"></span>
<a name="l01190"></a>01190 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01191"></a>01191 <span class="comment"> \fn void *memmem_P(const void *s1, size_t len1, const void *s2, size_t len2)</span>
<a name="l01192"></a>01192 <span class="comment"></span>
<a name="l01193"></a>01193 <span class="comment"> The memmem_P() function is similar to memmem() except that \p s2 is</span>
<a name="l01194"></a>01194 <span class="comment"> pointer to a string in program space. */</span>
<a name="l01195"></a>01195 extern <span class="keywordtype">void</span> *<a class="code" href="group__avr__pgmspace.html#gaee844cc0ac8f736e6599dbaae1fba328">memmem_P</a>(const <span class="keywordtype">void</span> *, <span class="keywordtype">size_t</span>, const <span class="keywordtype">void</span> *, <span class="keywordtype">size_t</span>) __ATTR_PURE__;
<a name="l01196"></a>01196 <span class="comment"></span>
<a name="l01197"></a>01197 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01198"></a>01198 <span class="comment"> \fn const void +memrchr_P(const void *src, int val, size_t len)</span>
<a name="l01199"></a>01199 <span class="comment"></span>
<a name="l01200"></a>01200 <span class="comment"> The memrchr_P() function is like the memchr_P() function, except</span>
<a name="l01201"></a>01201 <span class="comment"> that it searches backwards from the end of the \p len bytes pointed</span>
<a name="l01202"></a>01202 <span class="comment"> to by \p src instead of forwards from the front. (Glibc, GNU extension.)</span>
<a name="l01203"></a>01203 <span class="comment"></span>
<a name="l01204"></a>01204 <span class="comment"> \return The memrchr_P() function returns a pointer to the matching</span>
<a name="l01205"></a>01205 <span class="comment"> byte or \c NULL if the character does not occur in the given memory</span>
<a name="l01206"></a>01206 <span class="comment"> area. */</span>
<a name="l01207"></a>01207 extern const <span class="keywordtype">void</span> * <a class="code" href="group__avr__pgmspace.html#ga8dd5ea616f34e8fdc2ae4fa9452d8a88">memrchr_P</a>(const <span class="keywordtype">void</span> *, <span class="keywordtype">int</span> __val, <span class="keywordtype">size_t</span> __len) __ATTR_CONST__;
<a name="l01208"></a>01208 <span class="comment"></span>
<a name="l01209"></a>01209 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01210"></a>01210 <span class="comment"> \fn char *strcat_P(char *dest, const char *src)</span>
<a name="l01211"></a>01211 <span class="comment"></span>
<a name="l01212"></a>01212 <span class="comment"> The strcat_P() function is similar to strcat() except that the \e src</span>
<a name="l01213"></a>01213 <span class="comment"> string must be located in program space (flash).</span>
<a name="l01214"></a>01214 <span class="comment"></span>
<a name="l01215"></a>01215 <span class="comment"> \returns The strcat() function returns a pointer to the resulting string</span>
<a name="l01216"></a>01216 <span class="comment"> \e dest. */</span>
<a name="l01217"></a>01217 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#ga5c1bae2b20f7d5ec00411c6378b8ed70">strcat_P</a>(<span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *);
<a name="l01218"></a>01218 <span class="comment"></span>
<a name="l01219"></a>01219 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01220"></a>01220 <span class="comment"> \fn const char *strchr_P(const char *s, int val)</span>
<a name="l01221"></a>01221 <span class="comment"> \brief Locate character in program space string.</span>
<a name="l01222"></a>01222 <span class="comment"></span>
<a name="l01223"></a>01223 <span class="comment"> The strchr_P() function locates the first occurrence of \p val</span>
<a name="l01224"></a>01224 <span class="comment"> (converted to a char) in the string pointed to by \p s in program</span>
<a name="l01225"></a>01225 <span class="comment"> space. The terminating null character is considered to be part of</span>
<a name="l01226"></a>01226 <span class="comment"> the string.</span>
<a name="l01227"></a>01227 <span class="comment"></span>
<a name="l01228"></a>01228 <span class="comment"> The strchr_P() function is similar to strchr() except that \p s is</span>
<a name="l01229"></a>01229 <span class="comment"> pointer to a string in program space.</span>
<a name="l01230"></a>01230 <span class="comment"></span>
<a name="l01231"></a>01231 <span class="comment"> \returns The strchr_P() function returns a pointer to the matched</span>
<a name="l01232"></a>01232 <span class="comment"> character or \c NULL if the character is not found. */</span>
<a name="l01233"></a>01233 extern const <span class="keywordtype">char</span> * <a class="code" href="group__avr__pgmspace.html#ga105078f0de82663d9cfe4963e6bc677e" title="Locate character in program space string.">strchr_P</a>(const <span class="keywordtype">char</span> *, <span class="keywordtype">int</span> __val) __ATTR_CONST__;
<a name="l01234"></a>01234 <span class="comment"></span>
<a name="l01235"></a>01235 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01236"></a>01236 <span class="comment"> \fn const char *strchrnul_P(const char *s, int c)</span>
<a name="l01237"></a>01237 <span class="comment"></span>
<a name="l01238"></a>01238 <span class="comment"> The strchrnul_P() function is like strchr_P() except that if \p c is</span>
<a name="l01239"></a>01239 <span class="comment"> not found in \p s, then it returns a pointer to the null byte at the</span>
<a name="l01240"></a>01240 <span class="comment"> end of \p s, rather than \c NULL. (Glibc, GNU extension.)</span>
<a name="l01241"></a>01241 <span class="comment"></span>
<a name="l01242"></a>01242 <span class="comment"> \return The strchrnul_P() function returns a pointer to the matched</span>
<a name="l01243"></a>01243 <span class="comment"> character, or a pointer to the null byte at the end of \p s (i.e.,</span>
<a name="l01244"></a>01244 <span class="comment"> \c s+strlen(s)) if the character is not found. */</span>
<a name="l01245"></a>01245 extern const <span class="keywordtype">char</span> * <a class="code" href="group__avr__pgmspace.html#ga0934ce6517882f4146be5a7db9b23d6b">strchrnul_P</a>(const <span class="keywordtype">char</span> *, <span class="keywordtype">int</span> __val) __ATTR_CONST__;
<a name="l01246"></a>01246 <span class="comment"></span>
<a name="l01247"></a>01247 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01248"></a>01248 <span class="comment"> \fn int strcmp_P(const char *s1, const char *s2)</span>
<a name="l01249"></a>01249 <span class="comment"></span>
<a name="l01250"></a>01250 <span class="comment"> The strcmp_P() function is similar to strcmp() except that \p s2 is</span>
<a name="l01251"></a>01251 <span class="comment"> pointer to a string in program space.</span>
<a name="l01252"></a>01252 <span class="comment"></span>
<a name="l01253"></a>01253 <span class="comment"> \returns The strcmp_P() function returns an integer less than, equal</span>
<a name="l01254"></a>01254 <span class="comment"> to, or greater than zero if \p s1 is found, respectively, to be less</span>
<a name="l01255"></a>01255 <span class="comment"> than, to match, or be greater than \p s2. A consequence of the</span>
<a name="l01256"></a>01256 <span class="comment"> ordering used by strcmp_P() is that if \p s1 is an initial substring</span>
<a name="l01257"></a>01257 <span class="comment"> of \p s2, then \p s1 is considered to be &quot;less than&quot; \p s2. */</span>
<a name="l01258"></a>01258 extern <span class="keywordtype">int</span> <a class="code" href="group__avr__pgmspace.html#gab0c75b8cce460448b747c29231da847c">strcmp_P</a>(const <span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *) __ATTR_PURE__;
<a name="l01259"></a>01259 <span class="comment"></span>
<a name="l01260"></a>01260 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01261"></a>01261 <span class="comment"> \fn char *strcpy_P(char *dest, const char *src)</span>
<a name="l01262"></a>01262 <span class="comment"></span>
<a name="l01263"></a>01263 <span class="comment"> The strcpy_P() function is similar to strcpy() except that src is a</span>
<a name="l01264"></a>01264 <span class="comment"> pointer to a string in program space.</span>
<a name="l01265"></a>01265 <span class="comment"></span>
<a name="l01266"></a>01266 <span class="comment"> \returns The strcpy_P() function returns a pointer to the destination</span>
<a name="l01267"></a>01267 <span class="comment"> string dest. */</span>
<a name="l01268"></a>01268 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#ga5749897c91c479d02054fc02128de482">strcpy_P</a>(<span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *);
<a name="l01269"></a>01269 <span class="comment"></span>
<a name="l01270"></a>01270 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01271"></a>01271 <span class="comment"> \fn int strcasecmp_P(const char *s1, const char *s2)</span>
<a name="l01272"></a>01272 <span class="comment"> \brief Compare two strings ignoring case.</span>
<a name="l01273"></a>01273 <span class="comment"></span>
<a name="l01274"></a>01274 <span class="comment"> The strcasecmp_P() function compares the two strings \p s1 and \p s2,</span>
<a name="l01275"></a>01275 <span class="comment"> ignoring the case of the characters.</span>
<a name="l01276"></a>01276 <span class="comment"></span>
<a name="l01277"></a>01277 <span class="comment"> \param s1 A pointer to a string in the devices SRAM.</span>
<a name="l01278"></a>01278 <span class="comment"> \param s2 A pointer to a string in the devices Flash.</span>
<a name="l01279"></a>01279 <span class="comment"></span>
<a name="l01280"></a>01280 <span class="comment"> \returns The strcasecmp_P() function returns an integer less than,</span>
<a name="l01281"></a>01281 <span class="comment"> equal to, or greater than zero if \p s1 is found, respectively, to</span>
<a name="l01282"></a>01282 <span class="comment"> be less than, to match, or be greater than \p s2. A consequence of</span>
<a name="l01283"></a>01283 <span class="comment"> the ordering used by strcasecmp_P() is that if \p s1 is an initial</span>
<a name="l01284"></a>01284 <span class="comment"> substring of \p s2, then \p s1 is considered to be &quot;less than&quot; \p s2. */</span>
<a name="l01285"></a>01285 extern <span class="keywordtype">int</span> <a class="code" href="group__avr__pgmspace.html#ga4b2a918fb5938763024b3818ee89fbef" title="Compare two strings ignoring case.">strcasecmp_P</a>(const <span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *) __ATTR_PURE__;
<a name="l01286"></a>01286 <span class="comment"></span>
<a name="l01287"></a>01287 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01288"></a>01288 <span class="comment"> \fn char *strcasestr_P(const char *s1, const char *s2)</span>
<a name="l01289"></a>01289 <span class="comment"></span>
<a name="l01290"></a>01290 <span class="comment"> This funtion is similar to strcasestr() except that \p s2 is pointer</span>
<a name="l01291"></a>01291 <span class="comment"> to a string in program space. */</span>
<a name="l01292"></a>01292 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#gabf84fa847bf164ae7eee355a808e76fb">strcasestr_P</a>(const <span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *) __ATTR_PURE__;
<a name="l01293"></a>01293 <span class="comment"></span>
<a name="l01294"></a>01294 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01295"></a>01295 <span class="comment"> \fn size_t strcspn_P(const char *s, const char *reject)</span>
<a name="l01296"></a>01296 <span class="comment"></span>
<a name="l01297"></a>01297 <span class="comment"> The strcspn_P() function calculates the length of the initial segment</span>
<a name="l01298"></a>01298 <span class="comment"> of \p s which consists entirely of characters not in \p reject. This</span>
<a name="l01299"></a>01299 <span class="comment"> function is similar to strcspn() except that \p reject is a pointer</span>
<a name="l01300"></a>01300 <span class="comment"> to a string in program space.</span>
<a name="l01301"></a>01301 <span class="comment"></span>
<a name="l01302"></a>01302 <span class="comment"> \return The strcspn_P() function returns the number of characters in</span>
<a name="l01303"></a>01303 <span class="comment"> the initial segment of \p s which are not in the string \p reject.</span>
<a name="l01304"></a>01304 <span class="comment"> The terminating zero is not considered as a part of string. */</span>
<a name="l01305"></a>01305 extern <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#ga8afa4577f8ce7241a948af61e6991c67">strcspn_P</a>(const <span class="keywordtype">char</span> *__s, const <span class="keywordtype">char</span> * __reject) __ATTR_PURE__;
<a name="l01306"></a>01306 <span class="comment"></span>
<a name="l01307"></a>01307 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01308"></a>01308 <span class="comment"> \fn size_t strlcat_P(char *dst, const char *src, size_t siz)</span>
<a name="l01309"></a>01309 <span class="comment"> \brief Concatenate two strings.</span>
<a name="l01310"></a>01310 <span class="comment"></span>
<a name="l01311"></a>01311 <span class="comment"> The strlcat_P() function is similar to strlcat(), except that the \p src</span>
<a name="l01312"></a>01312 <span class="comment"> string must be located in program space (flash).</span>
<a name="l01313"></a>01313 <span class="comment"></span>
<a name="l01314"></a>01314 <span class="comment"> Appends \p src to string \p dst of size \p siz (unlike strncat(),</span>
<a name="l01315"></a>01315 <span class="comment"> \p siz is the full size of \p dst, not space left). At most \p siz-1</span>
<a name="l01316"></a>01316 <span class="comment"> characters will be copied. Always NULL terminates (unless \p siz &lt;=</span>
<a name="l01317"></a>01317 <span class="comment"> \p strlen(dst)).</span>
<a name="l01318"></a>01318 <span class="comment"></span>
<a name="l01319"></a>01319 <span class="comment"> \returns The strlcat_P() function returns strlen(src) + MIN(siz,</span>
<a name="l01320"></a>01320 <span class="comment"> strlen(initial dst)). If retval &gt;= siz, truncation occurred. */</span>
<a name="l01321"></a>01321 extern <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#ga85328d5e578db3c60f9753cb1769dc96" title="Concatenate two strings.">strlcat_P</a> (<span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span> );
<a name="l01322"></a>01322 <span class="comment"></span>
<a name="l01323"></a>01323 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01324"></a>01324 <span class="comment"> \fn size_t strlcpy_P(char *dst, const char *src, size_t siz)</span>
<a name="l01325"></a>01325 <span class="comment"> \brief Copy a string from progmem to RAM.</span>
<a name="l01326"></a>01326 <span class="comment"></span>
<a name="l01327"></a>01327 <span class="comment"> Copy \p src to string \p dst of size \p siz. At most \p siz-1</span>
<a name="l01328"></a>01328 <span class="comment"> characters will be copied. Always NULL terminates (unless \p siz == 0).</span>
<a name="l01329"></a>01329 <span class="comment"> The strlcpy_P() function is similar to strlcpy() except that the</span>
<a name="l01330"></a>01330 <span class="comment"> \p src is pointer to a string in memory space.</span>
<a name="l01331"></a>01331 <span class="comment"></span>
<a name="l01332"></a>01332 <span class="comment"> \returns The strlcpy_P() function returns strlen(src). If</span>
<a name="l01333"></a>01333 <span class="comment"> retval &gt;= siz, truncation occurred. */</span>
<a name="l01334"></a>01334 extern <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#gab95a4e6a4b527ee389c72bdabb991e08" title="Copy a string from progmem to RAM.">strlcpy_P</a> (<span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span> );
<a name="l01335"></a>01335 <span class="comment"></span>
<a name="l01336"></a>01336 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01337"></a>01337 <span class="comment"> \fn size_t strnlen_P(const char *src, size_t len)</span>
<a name="l01338"></a>01338 <span class="comment"> \brief Determine the length of a fixed-size string.</span>
<a name="l01339"></a>01339 <span class="comment"></span>
<a name="l01340"></a>01340 <span class="comment"> The strnlen_P() function is similar to strnlen(), except that \c src is a</span>
<a name="l01341"></a>01341 <span class="comment"> pointer to a string in program space.</span>
<a name="l01342"></a>01342 <span class="comment"></span>
<a name="l01343"></a>01343 <span class="comment"> \returns The strnlen_P function returns strlen_P(src), if that is less than</span>
<a name="l01344"></a>01344 <span class="comment"> \c len, or \c len if there is no &#39;\\0&#39; character among the first \c len</span>
<a name="l01345"></a>01345 <span class="comment"> characters pointed to by \c src. */</span>
<a name="l01346"></a>01346 extern <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#ga56e4dec5f576bb5feaa30acc4768bbf3" title="Determine the length of a fixed-size string.">strnlen_P</a>(const <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>) __ATTR_CONST__; <span class="comment">/* program memory can&#39;t change */</span>
<a name="l01347"></a>01347 <span class="comment"></span>
<a name="l01348"></a>01348 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01349"></a>01349 <span class="comment"> \fn int strncmp_P(const char *s1, const char *s2, size_t n)</span>
<a name="l01350"></a>01350 <span class="comment"></span>
<a name="l01351"></a>01351 <span class="comment"> The strncmp_P() function is similar to strcmp_P() except it only compares</span>
<a name="l01352"></a>01352 <span class="comment"> the first (at most) n characters of s1 and s2.</span>
<a name="l01353"></a>01353 <span class="comment"></span>
<a name="l01354"></a>01354 <span class="comment"> \returns The strncmp_P() function returns an integer less than, equal to,</span>
<a name="l01355"></a>01355 <span class="comment"> or greater than zero if s1 (or the first n bytes thereof) is found,</span>
<a name="l01356"></a>01356 <span class="comment"> respectively, to be less than, to match, or be greater than s2. */</span>
<a name="l01357"></a>01357 extern <span class="keywordtype">int</span> <a class="code" href="group__avr__pgmspace.html#ga3139220accf77b43102c23b58d249ee9">strncmp_P</a>(const <span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>) __ATTR_PURE__;
<a name="l01358"></a>01358 <span class="comment"></span>
<a name="l01359"></a>01359 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01360"></a>01360 <span class="comment"> \fn int strncasecmp_P(const char *s1, const char *s2, size_t n)</span>
<a name="l01361"></a>01361 <span class="comment"> \brief Compare two strings ignoring case.</span>
<a name="l01362"></a>01362 <span class="comment"></span>
<a name="l01363"></a>01363 <span class="comment"> The strncasecmp_P() function is similar to strcasecmp_P(), except it</span>
<a name="l01364"></a>01364 <span class="comment"> only compares the first \p n characters of \p s1.</span>
<a name="l01365"></a>01365 <span class="comment"></span>
<a name="l01366"></a>01366 <span class="comment"> \param s1 A pointer to a string in the devices SRAM.</span>
<a name="l01367"></a>01367 <span class="comment"> \param s2 A pointer to a string in the devices Flash.</span>
<a name="l01368"></a>01368 <span class="comment"> \param n The maximum number of bytes to compare.</span>
<a name="l01369"></a>01369 <span class="comment"></span>
<a name="l01370"></a>01370 <span class="comment"> \returns The strncasecmp_P() function returns an integer less than,</span>
<a name="l01371"></a>01371 <span class="comment"> equal to, or greater than zero if \p s1 (or the first \p n bytes</span>
<a name="l01372"></a>01372 <span class="comment"> thereof) is found, respectively, to be less than, to match, or be</span>
<a name="l01373"></a>01373 <span class="comment"> greater than \p s2. A consequence of the ordering used by</span>
<a name="l01374"></a>01374 <span class="comment"> strncasecmp_P() is that if \p s1 is an initial substring of \p s2,</span>
<a name="l01375"></a>01375 <span class="comment"> then \p s1 is considered to be &quot;less than&quot; \p s2. */</span>
<a name="l01376"></a>01376 extern <span class="keywordtype">int</span> <a class="code" href="group__avr__pgmspace.html#ga7a9100487dc0a7e5c501966c94e0ecdb" title="Compare two strings ignoring case.">strncasecmp_P</a>(const <span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>) __ATTR_PURE__;
<a name="l01377"></a>01377 <span class="comment"></span>
<a name="l01378"></a>01378 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01379"></a>01379 <span class="comment"> \fn char *strncat_P(char *dest, const char *src, size_t len)</span>
<a name="l01380"></a>01380 <span class="comment"> \brief Concatenate two strings.</span>
<a name="l01381"></a>01381 <span class="comment"></span>
<a name="l01382"></a>01382 <span class="comment"> The strncat_P() function is similar to strncat(), except that the \e src</span>
<a name="l01383"></a>01383 <span class="comment"> string must be located in program space (flash).</span>
<a name="l01384"></a>01384 <span class="comment"></span>
<a name="l01385"></a>01385 <span class="comment"> \returns The strncat_P() function returns a pointer to the resulting string</span>
<a name="l01386"></a>01386 <span class="comment"> dest. */</span>
<a name="l01387"></a>01387 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#ga8641381919448f62d9caa5bd81b84fbf" title="Concatenate two strings.">strncat_P</a>(<span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>);
<a name="l01388"></a>01388 <span class="comment"></span>
<a name="l01389"></a>01389 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01390"></a>01390 <span class="comment"> \fn char *strncpy_P(char *dest, const char *src, size_t n)</span>
<a name="l01391"></a>01391 <span class="comment"></span>
<a name="l01392"></a>01392 <span class="comment"> The strncpy_P() function is similar to strcpy_P() except that not more</span>
<a name="l01393"></a>01393 <span class="comment"> than n bytes of src are copied. Thus, if there is no null byte among the</span>
<a name="l01394"></a>01394 <span class="comment"> first n bytes of src, the result will not be null-terminated.</span>
<a name="l01395"></a>01395 <span class="comment"></span>
<a name="l01396"></a>01396 <span class="comment"> In the case where the length of src is less than that of n, the remainder</span>
<a name="l01397"></a>01397 <span class="comment"> of dest will be padded with nulls.</span>
<a name="l01398"></a>01398 <span class="comment"></span>
<a name="l01399"></a>01399 <span class="comment"> \returns The strncpy_P() function returns a pointer to the destination</span>
<a name="l01400"></a>01400 <span class="comment"> string dest. */</span>
<a name="l01401"></a>01401 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#ga1ed6a0ea90901b8ee8478b86d1b1c99a">strncpy_P</a>(<span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>);
<a name="l01402"></a>01402 <span class="comment"></span>
<a name="l01403"></a>01403 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01404"></a>01404 <span class="comment"> \fn char *strpbrk_P(const char *s, const char *accept)</span>
<a name="l01405"></a>01405 <span class="comment"></span>
<a name="l01406"></a>01406 <span class="comment"> The strpbrk_P() function locates the first occurrence in the string</span>
<a name="l01407"></a>01407 <span class="comment"> \p s of any of the characters in the flash string \p accept. This</span>
<a name="l01408"></a>01408 <span class="comment"> function is similar to strpbrk() except that \p accept is a pointer</span>
<a name="l01409"></a>01409 <span class="comment"> to a string in program space.</span>
<a name="l01410"></a>01410 <span class="comment"></span>
<a name="l01411"></a>01411 <span class="comment"> \return The strpbrk_P() function returns a pointer to the character</span>
<a name="l01412"></a>01412 <span class="comment"> in \p s that matches one of the characters in \p accept, or \c NULL</span>
<a name="l01413"></a>01413 <span class="comment"> if no such character is found. The terminating zero is not considered</span>
<a name="l01414"></a>01414 <span class="comment"> as a part of string: if one or both args are empty, the result will</span>
<a name="l01415"></a>01415 <span class="comment"> \c NULL. */</span>
<a name="l01416"></a>01416 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#gaf5e195114dcded1be939a278122fa91f">strpbrk_P</a>(const <span class="keywordtype">char</span> *__s, const <span class="keywordtype">char</span> * __accept) __ATTR_PURE__;
<a name="l01417"></a>01417 <span class="comment"></span>
<a name="l01418"></a>01418 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01419"></a>01419 <span class="comment"> \fn const char *strrchr_P(const char *s, int val)</span>
<a name="l01420"></a>01420 <span class="comment"> \brief Locate character in string.</span>
<a name="l01421"></a>01421 <span class="comment"></span>
<a name="l01422"></a>01422 <span class="comment"> The strrchr_P() function returns a pointer to the last occurrence of</span>
<a name="l01423"></a>01423 <span class="comment"> the character \p val in the flash string \p s.</span>
<a name="l01424"></a>01424 <span class="comment"></span>
<a name="l01425"></a>01425 <span class="comment"> \return The strrchr_P() function returns a pointer to the matched</span>
<a name="l01426"></a>01426 <span class="comment"> character or \c NULL if the character is not found. */</span>
<a name="l01427"></a>01427 extern const <span class="keywordtype">char</span> * <a class="code" href="group__avr__pgmspace.html#ga75ac2cdafe9afac8c75d4abf8703f2da" title="Locate character in string.">strrchr_P</a>(const <span class="keywordtype">char</span> *, <span class="keywordtype">int</span> __val) __ATTR_CONST__;
<a name="l01428"></a>01428 <span class="comment"></span>
<a name="l01429"></a>01429 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01430"></a>01430 <span class="comment"> \fn char *strsep_P(char **sp, const char *delim)</span>
<a name="l01431"></a>01431 <span class="comment"> \brief Parse a string into tokens.</span>
<a name="l01432"></a>01432 <span class="comment"></span>
<a name="l01433"></a>01433 <span class="comment"> The strsep_P() function locates, in the string referenced by \p *sp,</span>
<a name="l01434"></a>01434 <span class="comment"> the first occurrence of any character in the string \p delim (or the</span>
<a name="l01435"></a>01435 <span class="comment"> terminating &#39;\\0&#39; character) and replaces it with a &#39;\\0&#39;. The</span>
<a name="l01436"></a>01436 <span class="comment"> location of the next character after the delimiter character (or \c</span>
<a name="l01437"></a>01437 <span class="comment"> NULL, if the end of the string was reached) is stored in \p *sp. An</span>
<a name="l01438"></a>01438 <span class="comment"> ``empty&#39;&#39; field, i.e. one caused by two adjacent delimiter</span>
<a name="l01439"></a>01439 <span class="comment"> characters, can be detected by comparing the location referenced by</span>
<a name="l01440"></a>01440 <span class="comment"> the pointer returned in \p *sp to &#39;\\0&#39;. This function is similar to</span>
<a name="l01441"></a>01441 <span class="comment"> strsep() except that \p delim is a pointer to a string in program</span>
<a name="l01442"></a>01442 <span class="comment"> space.</span>
<a name="l01443"></a>01443 <span class="comment"></span>
<a name="l01444"></a>01444 <span class="comment"> \return The strsep_P() function returns a pointer to the original</span>
<a name="l01445"></a>01445 <span class="comment"> value of \p *sp. If \p *sp is initially \c NULL, strsep_P() returns</span>
<a name="l01446"></a>01446 <span class="comment"> \c NULL. */</span>
<a name="l01447"></a>01447 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#ga150a5b9ebbf493789834679bdc734857" title="Parse a string into tokens.">strsep_P</a>(<span class="keywordtype">char</span> **__sp, const <span class="keywordtype">char</span> * __delim);
<a name="l01448"></a>01448 <span class="comment"></span>
<a name="l01449"></a>01449 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01450"></a>01450 <span class="comment"> \fn size_t strspn_P(const char *s, const char *accept)</span>
<a name="l01451"></a>01451 <span class="comment"></span>
<a name="l01452"></a>01452 <span class="comment"> The strspn_P() function calculates the length of the initial segment</span>
<a name="l01453"></a>01453 <span class="comment"> of \p s which consists entirely of characters in \p accept. This</span>
<a name="l01454"></a>01454 <span class="comment"> function is similar to strspn() except that \p accept is a pointer</span>
<a name="l01455"></a>01455 <span class="comment"> to a string in program space.</span>
<a name="l01456"></a>01456 <span class="comment"></span>
<a name="l01457"></a>01457 <span class="comment"> \return The strspn_P() function returns the number of characters in</span>
<a name="l01458"></a>01458 <span class="comment"> the initial segment of \p s which consist only of characters from \p</span>
<a name="l01459"></a>01459 <span class="comment"> accept. The terminating zero is not considered as a part of string. */</span>
<a name="l01460"></a>01460 extern <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#ga9813accb359f237457b8dc97763ccc9f">strspn_P</a>(const <span class="keywordtype">char</span> *__s, const <span class="keywordtype">char</span> * __accept) __ATTR_PURE__;
<a name="l01461"></a>01461 <span class="comment"></span>
<a name="l01462"></a>01462 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01463"></a>01463 <span class="comment"> \fn char *strstr_P(const char *s1, const char *s2)</span>
<a name="l01464"></a>01464 <span class="comment"> \brief Locate a substring.</span>
<a name="l01465"></a>01465 <span class="comment"></span>
<a name="l01466"></a>01466 <span class="comment"> The strstr_P() function finds the first occurrence of the substring</span>
<a name="l01467"></a>01467 <span class="comment"> \p s2 in the string \p s1. The terminating &#39;\\0&#39; characters are not</span>
<a name="l01468"></a>01468 <span class="comment"> compared. The strstr_P() function is similar to strstr() except that</span>
<a name="l01469"></a>01469 <span class="comment"> \p s2 is pointer to a string in program space.</span>
<a name="l01470"></a>01470 <span class="comment"></span>
<a name="l01471"></a>01471 <span class="comment"> \returns The strstr_P() function returns a pointer to the beginning</span>
<a name="l01472"></a>01472 <span class="comment"> of the substring, or NULL if the substring is not found. If \p s2</span>
<a name="l01473"></a>01473 <span class="comment"> points to a string of zero length, the function returns \p s1. */</span>
<a name="l01474"></a>01474 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#gaa0f5fff512c8e23adc06844aa73c557b" title="Locate a substring.">strstr_P</a>(const <span class="keywordtype">char</span> *, const <span class="keywordtype">char</span> *) __ATTR_PURE__;
<a name="l01475"></a>01475 <span class="comment"></span>
<a name="l01476"></a>01476 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01477"></a>01477 <span class="comment"> \fn char *strtok_P(char *s, const char * delim)</span>
<a name="l01478"></a>01478 <span class="comment"> \brief Parses the string into tokens.</span>
<a name="l01479"></a>01479 <span class="comment"></span>
<a name="l01480"></a>01480 <span class="comment"> strtok_P() parses the string \p s into tokens. The first call to</span>
<a name="l01481"></a>01481 <span class="comment"> strtok_P() should have \p s as its first argument. Subsequent calls</span>
<a name="l01482"></a>01482 <span class="comment"> should have the first argument set to NULL. If a token ends with a</span>
<a name="l01483"></a>01483 <span class="comment"> delimiter, this delimiting character is overwritten with a &#39;\\0&#39; and a</span>
<a name="l01484"></a>01484 <span class="comment"> pointer to the next character is saved for the next call to strtok_P().</span>
<a name="l01485"></a>01485 <span class="comment"> The delimiter string \p delim may be different for each call.</span>
<a name="l01486"></a>01486 <span class="comment"></span>
<a name="l01487"></a>01487 <span class="comment"> The strtok_P() function is similar to strtok() except that \p delim</span>
<a name="l01488"></a>01488 <span class="comment"> is pointer to a string in program space.</span>
<a name="l01489"></a>01489 <span class="comment"></span>
<a name="l01490"></a>01490 <span class="comment"> \returns The strtok_P() function returns a pointer to the next token or</span>
<a name="l01491"></a>01491 <span class="comment"> NULL when no more tokens are found.</span>
<a name="l01492"></a>01492 <span class="comment"></span>
<a name="l01493"></a>01493 <span class="comment"> \note strtok_P() is NOT reentrant. For a reentrant version of this</span>
<a name="l01494"></a>01494 <span class="comment"> function see strtok_rP().</span>
<a name="l01495"></a>01495 <span class="comment"> */</span>
<a name="l01496"></a>01496 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#ga9c3f78c82b898b95834b7f1d695eb95e" title="Parses the string into tokens.">strtok_P</a>(<span class="keywordtype">char</span> *__s, const <span class="keywordtype">char</span> * __delim);
<a name="l01497"></a>01497 <span class="comment"></span>
<a name="l01498"></a>01498 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01499"></a>01499 <span class="comment"> \fn char *strtok_rP (char *string, const char *delim, char **last)</span>
<a name="l01500"></a>01500 <span class="comment"> \brief Parses string into tokens.</span>
<a name="l01501"></a>01501 <span class="comment"></span>
<a name="l01502"></a>01502 <span class="comment"> The strtok_rP() function parses \p string into tokens. The first call to</span>
<a name="l01503"></a>01503 <span class="comment"> strtok_rP() should have string as its first argument. Subsequent calls</span>
<a name="l01504"></a>01504 <span class="comment"> should have the first argument set to NULL. If a token ends with a</span>
<a name="l01505"></a>01505 <span class="comment"> delimiter, this delimiting character is overwritten with a &#39;\\0&#39; and a</span>
<a name="l01506"></a>01506 <span class="comment"> pointer to the next character is saved for the next call to strtok_rP().</span>
<a name="l01507"></a>01507 <span class="comment"> The delimiter string \p delim may be different for each call. \p last is</span>
<a name="l01508"></a>01508 <span class="comment"> a user allocated char* pointer. It must be the same while parsing the</span>
<a name="l01509"></a>01509 <span class="comment"> same string. strtok_rP() is a reentrant version of strtok_P().</span>
<a name="l01510"></a>01510 <span class="comment"></span>
<a name="l01511"></a>01511 <span class="comment"> The strtok_rP() function is similar to strtok_r() except that \p delim</span>
<a name="l01512"></a>01512 <span class="comment"> is pointer to a string in program space.</span>
<a name="l01513"></a>01513 <span class="comment"></span>
<a name="l01514"></a>01514 <span class="comment"> \returns The strtok_rP() function returns a pointer to the next token or</span>
<a name="l01515"></a>01515 <span class="comment"> NULL when no more tokens are found. */</span>
<a name="l01516"></a>01516 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#ga48e69ae320350218ad89b18f01df120d" title="Parses string into tokens.">strtok_rP</a>(<span class="keywordtype">char</span> *__s, const <span class="keywordtype">char</span> * __delim, <span class="keywordtype">char</span> **__last);
<a name="l01517"></a>01517 <span class="comment"></span>
<a name="l01518"></a>01518 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01519"></a>01519 <span class="comment"> \fn size_t strlen_PF(uint_farptr_t s)</span>
<a name="l01520"></a>01520 <span class="comment"> \brief Obtain the length of a string</span>
<a name="l01521"></a>01521 <span class="comment"></span>
<a name="l01522"></a>01522 <span class="comment"> The strlen_PF() function is similar to strlen(), except that \e s is a</span>
<a name="l01523"></a>01523 <span class="comment"> far pointer to a string in program space.</span>
<a name="l01524"></a>01524 <span class="comment"></span>
<a name="l01525"></a>01525 <span class="comment"> \param s A far pointer to the string in flash</span>
<a name="l01526"></a>01526 <span class="comment"></span>
<a name="l01527"></a>01527 <span class="comment"> \returns The strlen_PF() function returns the number of characters in</span>
<a name="l01528"></a>01528 <span class="comment"> \e s. The contents of RAMPZ SFR are undefined when the function returns. */</span>
<a name="l01529"></a>01529 extern <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#ga4ce249cbcdb9ff968c76a2d917072da9" title="Obtain the length of a string.">strlen_PF</a>(<a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> src) __ATTR_CONST__; <span class="comment">/* program memory can&#39;t change */</span>
<a name="l01530"></a>01530 <span class="comment"></span>
<a name="l01531"></a>01531 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01532"></a>01532 <span class="comment"> \fn size_t strnlen_PF(uint_farptr_t s, size_t len)</span>
<a name="l01533"></a>01533 <span class="comment"> \brief Determine the length of a fixed-size string</span>
<a name="l01534"></a>01534 <span class="comment"></span>
<a name="l01535"></a>01535 <span class="comment"> The strnlen_PF() function is similar to strnlen(), except that \e s is a</span>
<a name="l01536"></a>01536 <span class="comment"> far pointer to a string in program space.</span>
<a name="l01537"></a>01537 <span class="comment"></span>
<a name="l01538"></a>01538 <span class="comment"> \param s A far pointer to the string in Flash</span>
<a name="l01539"></a>01539 <span class="comment"> \param len The maximum number of length to return</span>
<a name="l01540"></a>01540 <span class="comment"></span>
<a name="l01541"></a>01541 <span class="comment"> \returns The strnlen_PF function returns strlen_P(\e s), if that is less</span>
<a name="l01542"></a>01542 <span class="comment"> than \e len, or \e len if there is no &#39;\\0&#39; character among the first \e</span>
<a name="l01543"></a>01543 <span class="comment"> len characters pointed to by \e s. The contents of RAMPZ SFR are</span>
<a name="l01544"></a>01544 <span class="comment"> undefined when the function returns. */</span>
<a name="l01545"></a>01545 extern <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#ga80d8784b274a123972f1b99a4a0a6a0f" title="Determine the length of a fixed-size string.">strnlen_PF</a>(<a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> src, <span class="keywordtype">size_t</span> len) __ATTR_CONST__; <span class="comment">/* program memory can&#39;t change */</span>
<a name="l01546"></a>01546 <span class="comment"></span>
<a name="l01547"></a>01547 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01548"></a>01548 <span class="comment"> \fn void *memcpy_PF(void *dest, uint_farptr_t src, size_t n)</span>
<a name="l01549"></a>01549 <span class="comment"> \brief Copy a memory block from flash to SRAM</span>
<a name="l01550"></a>01550 <span class="comment"></span>
<a name="l01551"></a>01551 <span class="comment"> The memcpy_PF() function is similar to memcpy(), except the data</span>
<a name="l01552"></a>01552 <span class="comment"> is copied from the program space and is addressed using a far pointer.</span>
<a name="l01553"></a>01553 <span class="comment"></span>
<a name="l01554"></a>01554 <span class="comment"> \param dest A pointer to the destination buffer</span>
<a name="l01555"></a>01555 <span class="comment"> \param src A far pointer to the origin of data in flash memory</span>
<a name="l01556"></a>01556 <span class="comment"> \param n The number of bytes to be copied</span>
<a name="l01557"></a>01557 <span class="comment"></span>
<a name="l01558"></a>01558 <span class="comment"> \returns The memcpy_PF() function returns a pointer to \e dst. The contents</span>
<a name="l01559"></a>01559 <span class="comment"> of RAMPZ SFR are undefined when the function returns. */</span>
<a name="l01560"></a>01560 extern <span class="keywordtype">void</span> *<a class="code" href="group__avr__pgmspace.html#ga13cc6cd0692aeccaac2789350a16412b" title="Copy a memory block from flash to SRAM.">memcpy_PF</a>(<span class="keywordtype">void</span> *dest, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> src, <span class="keywordtype">size_t</span> len);
<a name="l01561"></a>01561 <span class="comment"></span>
<a name="l01562"></a>01562 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01563"></a>01563 <span class="comment"> \fn char *strcpy_PF(char *dst, uint_farptr_t src)</span>
<a name="l01564"></a>01564 <span class="comment"> \brief Duplicate a string</span>
<a name="l01565"></a>01565 <span class="comment"></span>
<a name="l01566"></a>01566 <span class="comment"> The strcpy_PF() function is similar to strcpy() except that \e src is a far</span>
<a name="l01567"></a>01567 <span class="comment"> pointer to a string in program space.</span>
<a name="l01568"></a>01568 <span class="comment"></span>
<a name="l01569"></a>01569 <span class="comment"> \param dst A pointer to the destination string in SRAM</span>
<a name="l01570"></a>01570 <span class="comment"> \param src A far pointer to the source string in Flash</span>
<a name="l01571"></a>01571 <span class="comment"></span>
<a name="l01572"></a>01572 <span class="comment"> \returns The strcpy_PF() function returns a pointer to the destination</span>
<a name="l01573"></a>01573 <span class="comment"> string \e dst. The contents of RAMPZ SFR are undefined when the funcion</span>
<a name="l01574"></a>01574 <span class="comment"> returns. */</span>
<a name="l01575"></a>01575 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#gacd5af73767ca6defbec02736072dfb30" title="Duplicate a string.">strcpy_PF</a>(<span class="keywordtype">char</span> *dest, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> src);
<a name="l01576"></a>01576 <span class="comment"></span>
<a name="l01577"></a>01577 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01578"></a>01578 <span class="comment"> \fn char *strncpy_PF(char *dst, uint_farptr_t src, size_t n)</span>
<a name="l01579"></a>01579 <span class="comment"> \brief Duplicate a string until a limited length</span>
<a name="l01580"></a>01580 <span class="comment"></span>
<a name="l01581"></a>01581 <span class="comment"> The strncpy_PF() function is similar to strcpy_PF() except that not more</span>
<a name="l01582"></a>01582 <span class="comment"> than \e n bytes of \e src are copied. Thus, if there is no null byte among</span>
<a name="l01583"></a>01583 <span class="comment"> the first \e n bytes of \e src, the result will not be null-terminated.</span>
<a name="l01584"></a>01584 <span class="comment"></span>
<a name="l01585"></a>01585 <span class="comment"> In the case where the length of \e src is less than that of \e n, the</span>
<a name="l01586"></a>01586 <span class="comment"> remainder of \e dst will be padded with nulls.</span>
<a name="l01587"></a>01587 <span class="comment"></span>
<a name="l01588"></a>01588 <span class="comment"> \param dst A pointer to the destination string in SRAM</span>
<a name="l01589"></a>01589 <span class="comment"> \param src A far pointer to the source string in Flash</span>
<a name="l01590"></a>01590 <span class="comment"> \param n The maximum number of bytes to copy</span>
<a name="l01591"></a>01591 <span class="comment"></span>
<a name="l01592"></a>01592 <span class="comment"> \returns The strncpy_PF() function returns a pointer to the destination</span>
<a name="l01593"></a>01593 <span class="comment"> string \e dst. The contents of RAMPZ SFR are undefined when the function</span>
<a name="l01594"></a>01594 <span class="comment"> returns. */</span>
<a name="l01595"></a>01595 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#ga4ae01ef4b7da280c394f6d2ca37597b8" title="Duplicate a string until a limited length.">strncpy_PF</a>(<span class="keywordtype">char</span> *dest, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> src, <span class="keywordtype">size_t</span> len);
<a name="l01596"></a>01596 <span class="comment"></span>
<a name="l01597"></a>01597 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01598"></a>01598 <span class="comment"> \fn char *strcat_PF(char *dst, uint_farptr_t src)</span>
<a name="l01599"></a>01599 <span class="comment"> \brief Concatenates two strings</span>
<a name="l01600"></a>01600 <span class="comment"></span>
<a name="l01601"></a>01601 <span class="comment"> The strcat_PF() function is similar to strcat() except that the \e src</span>
<a name="l01602"></a>01602 <span class="comment"> string must be located in program space (flash) and is addressed using</span>
<a name="l01603"></a>01603 <span class="comment"> a far pointer</span>
<a name="l01604"></a>01604 <span class="comment"></span>
<a name="l01605"></a>01605 <span class="comment"> \param dst A pointer to the destination string in SRAM</span>
<a name="l01606"></a>01606 <span class="comment"> \param src A far pointer to the string to be appended in Flash</span>
<a name="l01607"></a>01607 <span class="comment"></span>
<a name="l01608"></a>01608 <span class="comment"> \returns The strcat_PF() function returns a pointer to the resulting</span>
<a name="l01609"></a>01609 <span class="comment"> string \e dst. The contents of RAMPZ SFR are undefined when the function</span>
<a name="l01610"></a>01610 <span class="comment"> returns */</span>
<a name="l01611"></a>01611 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#ga9530b4f628b49635c4085c269da8867a" title="Concatenates two strings.">strcat_PF</a>(<span class="keywordtype">char</span> *dest, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> src);
<a name="l01612"></a>01612 <span class="comment"></span>
<a name="l01613"></a>01613 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01614"></a>01614 <span class="comment"> \fn size_t strlcat_PF(char *dst, uint_farptr_t src, size_t n)</span>
<a name="l01615"></a>01615 <span class="comment"> \brief Concatenate two strings</span>
<a name="l01616"></a>01616 <span class="comment"></span>
<a name="l01617"></a>01617 <span class="comment"> The strlcat_PF() function is similar to strlcat(), except that the \e src</span>
<a name="l01618"></a>01618 <span class="comment"> string must be located in program space (flash) and is addressed using</span>
<a name="l01619"></a>01619 <span class="comment"> a far pointer.</span>
<a name="l01620"></a>01620 <span class="comment"></span>
<a name="l01621"></a>01621 <span class="comment"> Appends src to string dst of size \e n (unlike strncat(), \e n is the</span>
<a name="l01622"></a>01622 <span class="comment"> full size of \e dst, not space left). At most \e n-1 characters</span>
<a name="l01623"></a>01623 <span class="comment"> will be copied. Always NULL terminates (unless \e n &lt;= strlen(\e dst)).</span>
<a name="l01624"></a>01624 <span class="comment"></span>
<a name="l01625"></a>01625 <span class="comment"> \param dst A pointer to the destination string in SRAM</span>
<a name="l01626"></a>01626 <span class="comment"> \param src A far pointer to the source string in Flash</span>
<a name="l01627"></a>01627 <span class="comment"> \param n The total number of bytes allocated to the destination string</span>
<a name="l01628"></a>01628 <span class="comment"></span>
<a name="l01629"></a>01629 <span class="comment"> \returns The strlcat_PF() function returns strlen(\e src) + MIN(\e n,</span>
<a name="l01630"></a>01630 <span class="comment"> strlen(initial \e dst)). If retval &gt;= \e n, truncation occurred. The</span>
<a name="l01631"></a>01631 <span class="comment"> contents of RAMPZ SFR are undefined when the funcion returns. */</span>
<a name="l01632"></a>01632 extern <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#gaf632b479b04d0c98caf94de85dc11f3e" title="Concatenate two strings.">strlcat_PF</a>(<span class="keywordtype">char</span> *dst, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> src, <span class="keywordtype">size_t</span> siz);
<a name="l01633"></a>01633 <span class="comment"></span>
<a name="l01634"></a>01634 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01635"></a>01635 <span class="comment"> \fn char *strncat_PF(char *dst, uint_farptr_t src, size_t n)</span>
<a name="l01636"></a>01636 <span class="comment"> \brief Concatenate two strings</span>
<a name="l01637"></a>01637 <span class="comment"></span>
<a name="l01638"></a>01638 <span class="comment"> The strncat_PF() function is similar to strncat(), except that the \e src</span>
<a name="l01639"></a>01639 <span class="comment"> string must be located in program space (flash) and is addressed using a</span>
<a name="l01640"></a>01640 <span class="comment"> far pointer.</span>
<a name="l01641"></a>01641 <span class="comment"></span>
<a name="l01642"></a>01642 <span class="comment"> \param dst A pointer to the destination string in SRAM</span>
<a name="l01643"></a>01643 <span class="comment"> \param src A far pointer to the source string in Flash</span>
<a name="l01644"></a>01644 <span class="comment"> \param n The maximum number of bytes to append</span>
<a name="l01645"></a>01645 <span class="comment"></span>
<a name="l01646"></a>01646 <span class="comment"> \returns The strncat_PF() function returns a pointer to the resulting</span>
<a name="l01647"></a>01647 <span class="comment"> string \e dst. The contents of RAMPZ SFR are undefined when the function</span>
<a name="l01648"></a>01648 <span class="comment"> returns. */</span>
<a name="l01649"></a>01649 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#ga903fbfd9dcf93630e7a5da710d170da0" title="Concatenate two strings.">strncat_PF</a>(<span class="keywordtype">char</span> *dest, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> src, <span class="keywordtype">size_t</span> len);
<a name="l01650"></a>01650 <span class="comment"></span>
<a name="l01651"></a>01651 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01652"></a>01652 <span class="comment"> \fn int strcmp_PF(const char *s1, uint_farptr_t s2)</span>
<a name="l01653"></a>01653 <span class="comment"> \brief Compares two strings</span>
<a name="l01654"></a>01654 <span class="comment"></span>
<a name="l01655"></a>01655 <span class="comment"> The strcmp_PF() function is similar to strcmp() except that \e s2 is a far</span>
<a name="l01656"></a>01656 <span class="comment"> pointer to a string in program space.</span>
<a name="l01657"></a>01657 <span class="comment"></span>
<a name="l01658"></a>01658 <span class="comment"> \param s1 A pointer to the first string in SRAM</span>
<a name="l01659"></a>01659 <span class="comment"> \param s2 A far pointer to the second string in Flash</span>
<a name="l01660"></a>01660 <span class="comment"></span>
<a name="l01661"></a>01661 <span class="comment"> \returns The strcmp_PF() function returns an integer less than, equal to,</span>
<a name="l01662"></a>01662 <span class="comment"> or greater than zero if \e s1 is found, respectively, to be less than, to</span>
<a name="l01663"></a>01663 <span class="comment"> match, or be greater than \e s2. The contents of RAMPZ SFR are undefined</span>
<a name="l01664"></a>01664 <span class="comment"> when the function returns. */</span>
<a name="l01665"></a>01665 extern <span class="keywordtype">int</span> <a class="code" href="group__avr__pgmspace.html#gad34d5b7d040fcb97939e939f19d88a5f" title="Compares two strings.">strcmp_PF</a>(const <span class="keywordtype">char</span> *s1, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> s2) __ATTR_PURE__;
<a name="l01666"></a>01666 <span class="comment"></span>
<a name="l01667"></a>01667 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01668"></a>01668 <span class="comment"> \fn int strncmp_PF(const char *s1, uint_farptr_t s2, size_t n)</span>
<a name="l01669"></a>01669 <span class="comment"> \brief Compare two strings with limited length</span>
<a name="l01670"></a>01670 <span class="comment"></span>
<a name="l01671"></a>01671 <span class="comment"> The strncmp_PF() function is similar to strcmp_PF() except it only</span>
<a name="l01672"></a>01672 <span class="comment"> compares the first (at most) \e n characters of \e s1 and \e s2.</span>
<a name="l01673"></a>01673 <span class="comment"></span>
<a name="l01674"></a>01674 <span class="comment"> \param s1 A pointer to the first string in SRAM</span>
<a name="l01675"></a>01675 <span class="comment"> \param s2 A far pointer to the second string in Flash</span>
<a name="l01676"></a>01676 <span class="comment"> \param n The maximum number of bytes to compare</span>
<a name="l01677"></a>01677 <span class="comment"></span>
<a name="l01678"></a>01678 <span class="comment"> \returns The strncmp_PF() function returns an integer less than, equal</span>
<a name="l01679"></a>01679 <span class="comment"> to, or greater than zero if \e s1 (or the first \e n bytes thereof) is found,</span>
<a name="l01680"></a>01680 <span class="comment"> respectively, to be less than, to match, or be greater than \e s2. The</span>
<a name="l01681"></a>01681 <span class="comment"> contents of RAMPZ SFR are undefined when the function returns. */</span>
<a name="l01682"></a>01682 extern <span class="keywordtype">int</span> <a class="code" href="group__avr__pgmspace.html#ga31c3d78d72e8dc80e192d4bd6a65529e" title="Compare two strings with limited length.">strncmp_PF</a>(const <span class="keywordtype">char</span> *s1, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> s2, <span class="keywordtype">size_t</span> n) __ATTR_PURE__;
<a name="l01683"></a>01683 <span class="comment"></span>
<a name="l01684"></a>01684 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01685"></a>01685 <span class="comment"> \fn int strcasecmp_PF(const char *s1, uint_farptr_t s2)</span>
<a name="l01686"></a>01686 <span class="comment"> \brief Compare two strings ignoring case</span>
<a name="l01687"></a>01687 <span class="comment"></span>
<a name="l01688"></a>01688 <span class="comment"> The strcasecmp_PF() function compares the two strings \e s1 and \e s2, ignoring</span>
<a name="l01689"></a>01689 <span class="comment"> the case of the characters.</span>
<a name="l01690"></a>01690 <span class="comment"></span>
<a name="l01691"></a>01691 <span class="comment"> \param s1 A pointer to the first string in SRAM</span>
<a name="l01692"></a>01692 <span class="comment"> \param s2 A far pointer to the second string in Flash</span>
<a name="l01693"></a>01693 <span class="comment"></span>
<a name="l01694"></a>01694 <span class="comment"> \returns The strcasecmp_PF() function returns an integer less than, equal</span>
<a name="l01695"></a>01695 <span class="comment"> to, or greater than zero if \e s1 is found, respectively, to be less than, to</span>
<a name="l01696"></a>01696 <span class="comment"> match, or be greater than \e s2. The contents of RAMPZ SFR are undefined</span>
<a name="l01697"></a>01697 <span class="comment"> when the function returns. */</span>
<a name="l01698"></a>01698 extern <span class="keywordtype">int</span> <a class="code" href="group__avr__pgmspace.html#ga319ec42a66ba8333213fa10dbe06a606" title="Compare two strings ignoring case.">strcasecmp_PF</a>(const <span class="keywordtype">char</span> *s1, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> s2) __ATTR_PURE__;
<a name="l01699"></a>01699 <span class="comment"></span>
<a name="l01700"></a>01700 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01701"></a>01701 <span class="comment"> \fn int strncasecmp_PF(const char *s1, uint_farptr_t s2, size_t n)</span>
<a name="l01702"></a>01702 <span class="comment"> \brief Compare two strings ignoring case</span>
<a name="l01703"></a>01703 <span class="comment"></span>
<a name="l01704"></a>01704 <span class="comment"> The strncasecmp_PF() function is similar to strcasecmp_PF(), except it</span>
<a name="l01705"></a>01705 <span class="comment"> only compares the first \e n characters of \e s1 and the string in flash is</span>
<a name="l01706"></a>01706 <span class="comment"> addressed using a far pointer.</span>
<a name="l01707"></a>01707 <span class="comment"></span>
<a name="l01708"></a>01708 <span class="comment"> \param s1 A pointer to a string in SRAM</span>
<a name="l01709"></a>01709 <span class="comment"> \param s2 A far pointer to a string in Flash</span>
<a name="l01710"></a>01710 <span class="comment"> \param n The maximum number of bytes to compare</span>
<a name="l01711"></a>01711 <span class="comment"></span>
<a name="l01712"></a>01712 <span class="comment"> \returns The strncasecmp_PF() function returns an integer less than, equal</span>
<a name="l01713"></a>01713 <span class="comment"> to, or greater than zero if \e s1 (or the first \e n bytes thereof) is found,</span>
<a name="l01714"></a>01714 <span class="comment"> respectively, to be less than, to match, or be greater than \e s2. The</span>
<a name="l01715"></a>01715 <span class="comment"> contents of RAMPZ SFR are undefined when the function returns. */</span>
<a name="l01716"></a>01716 extern <span class="keywordtype">int</span> <a class="code" href="group__avr__pgmspace.html#ga086db857a2372e4c84cc16204ac5292c" title="Compare two strings ignoring case.">strncasecmp_PF</a>(const <span class="keywordtype">char</span> *s1, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> s2, <span class="keywordtype">size_t</span> n) __ATTR_PURE__;
<a name="l01717"></a>01717 <span class="comment"></span>
<a name="l01718"></a>01718 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01719"></a>01719 <span class="comment"> \fn char *strstr_PF(const char *s1, uint_farptr_t s2)</span>
<a name="l01720"></a>01720 <span class="comment"> \brief Locate a substring.</span>
<a name="l01721"></a>01721 <span class="comment"></span>
<a name="l01722"></a>01722 <span class="comment"> The strstr_PF() function finds the first occurrence of the substring \c s2</span>
<a name="l01723"></a>01723 <span class="comment"> in the string \c s1. The terminating &#39;\\0&#39; characters are not</span>
<a name="l01724"></a>01724 <span class="comment"> compared.</span>
<a name="l01725"></a>01725 <span class="comment"> The strstr_PF() function is similar to strstr() except that \c s2 is a</span>
<a name="l01726"></a>01726 <span class="comment"> far pointer to a string in program space.</span>
<a name="l01727"></a>01727 <span class="comment"></span>
<a name="l01728"></a>01728 <span class="comment"> \returns The strstr_PF() function returns a pointer to the beginning of the</span>
<a name="l01729"></a>01729 <span class="comment"> substring, or NULL if the substring is not found.</span>
<a name="l01730"></a>01730 <span class="comment"> If \c s2 points to a string of zero length, the function returns \c s1. The</span>
<a name="l01731"></a>01731 <span class="comment"> contents of RAMPZ SFR are undefined when the function returns. */</span>
<a name="l01732"></a>01732 extern <span class="keywordtype">char</span> *<a class="code" href="group__avr__pgmspace.html#ga0786ca7dc919f41f4586689aa77b04ef" title="Locate a substring.">strstr_PF</a>(const <span class="keywordtype">char</span> *s1, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> s2);
<a name="l01733"></a>01733 <span class="comment"></span>
<a name="l01734"></a>01734 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01735"></a>01735 <span class="comment"> \fn size_t strlcpy_PF(char *dst, uint_farptr_t src, size_t siz)</span>
<a name="l01736"></a>01736 <span class="comment"> \brief Copy a string from progmem to RAM.</span>
<a name="l01737"></a>01737 <span class="comment"></span>
<a name="l01738"></a>01738 <span class="comment"> Copy src to string dst of size siz. At most siz-1 characters will be</span>
<a name="l01739"></a>01739 <span class="comment"> copied. Always NULL terminates (unless siz == 0).</span>
<a name="l01740"></a>01740 <span class="comment"></span>
<a name="l01741"></a>01741 <span class="comment"> \returns The strlcpy_PF() function returns strlen(src). If retval &gt;= siz,</span>
<a name="l01742"></a>01742 <span class="comment"> truncation occurred. The contents of RAMPZ SFR are undefined when the</span>
<a name="l01743"></a>01743 <span class="comment"> function returns. */</span>
<a name="l01744"></a>01744 extern <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#ga6674a08f95d5daedce3079b96be63008" title="Copy a string from progmem to RAM.">strlcpy_PF</a>(<span class="keywordtype">char</span> *dst, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a> src, <span class="keywordtype">size_t</span> siz);
<a name="l01745"></a>01745 <span class="comment"></span>
<a name="l01746"></a>01746 <span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01747"></a>01747 <span class="comment"> \fn int memcmp_PF(const void *s1, uint_farptr_t s2, size_t len)</span>
<a name="l01748"></a>01748 <span class="comment"> \brief Compare memory areas</span>
<a name="l01749"></a>01749 <span class="comment"></span>
<a name="l01750"></a>01750 <span class="comment"> The memcmp_PF() function compares the first \p len bytes of the memory</span>
<a name="l01751"></a>01751 <span class="comment"> areas \p s1 and flash \p s2. The comparision is performed using unsigned</span>
<a name="l01752"></a>01752 <span class="comment"> char operations. It is an equivalent of memcmp_P() function, except</span>
<a name="l01753"></a>01753 <span class="comment"> that it is capable working on all FLASH including the exteded area</span>
<a name="l01754"></a>01754 <span class="comment"> above 64kB.</span>
<a name="l01755"></a>01755 <span class="comment"></span>
<a name="l01756"></a>01756 <span class="comment"> \returns The memcmp_PF() function returns an integer less than, equal</span>
<a name="l01757"></a>01757 <span class="comment"> to, or greater than zero if the first \p len bytes of \p s1 is found,</span>
<a name="l01758"></a>01758 <span class="comment"> respectively, to be less than, to match, or be greater than the first</span>
<a name="l01759"></a>01759 <span class="comment"> \p len bytes of \p s2. */</span>
<a name="l01760"></a>01760 extern <span class="keywordtype">int</span> <a class="code" href="group__avr__pgmspace.html#ga80332272d69f05daab5f177723380175" title="Compare memory areas.">memcmp_PF</a>(const <span class="keywordtype">void</span> *, <a class="code" href="group__avr__inttypes.html#ga72b6692e3f3123903c1a0d9a960c59b1">uint_farptr_t</a>, <span class="keywordtype">size_t</span>) __ATTR_PURE__;
<a name="l01761"></a>01761
<a name="l01762"></a>01762 <span class="preprocessor">#ifdef __DOXYGEN__</span>
<a name="l01763"></a>01763 <span class="preprocessor"></span><span class="comment">/** \ingroup avr_pgmspace</span>
<a name="l01764"></a>01764 <span class="comment"> \fn size_t strlen_P(const char *src)</span>
<a name="l01765"></a>01765 <span class="comment"></span>
<a name="l01766"></a>01766 <span class="comment"> The strlen_P() function is similar to strlen(), except that src is a</span>
<a name="l01767"></a>01767 <span class="comment"> pointer to a string in program space.</span>
<a name="l01768"></a>01768 <span class="comment"></span>
<a name="l01769"></a>01769 <span class="comment"> \returns The strlen_P() function returns the number of characters in src.</span>
<a name="l01770"></a>01770 <span class="comment"></span>
<a name="l01771"></a>01771 <span class="comment"> \note strlen_P() is implemented as an inline function in the avr/pgmspace.h</span>
<a name="l01772"></a>01772 <span class="comment"> header file, which will check if the length of the string is a constant</span>
<a name="l01773"></a>01773 <span class="comment"> and known at compile time. If it is not known at compile time, the macro</span>
<a name="l01774"></a>01774 <span class="comment"> will issue a call to __strlen_P() which will then calculate the length</span>
<a name="l01775"></a>01775 <span class="comment"> of the string as normal.</span>
<a name="l01776"></a>01776 <span class="comment">*/</span>
<a name="l01777"></a>01777 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#gae2fb71ebed915074ec815d9d8f876c52">strlen_P</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> * s);
<a name="l01778"></a>01778 <span class="preprocessor">#else</span>
<a name="l01779"></a>01779 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keywordtype">size_t</span> __strlen_P(<span class="keyword">const</span> <span class="keywordtype">char</span> *) __ATTR_CONST__; <span class="comment">/* internal helper function */</span>
<a name="l01780"></a>01780 <a class="code" href="group__avr__watchdog.html#gadaa6dd28b5d08df35e49b1248d7e5fb0">__attribute__</a>((__always_inline__)) static __inline__ <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#gae2fb71ebed915074ec815d9d8f876c52">strlen_P</a>(const <span class="keywordtype">char</span> * s);
<a name="l01781"></a>01781 static __inline__ <span class="keywordtype">size_t</span> <a class="code" href="group__avr__pgmspace.html#gae2fb71ebed915074ec815d9d8f876c52">strlen_P</a>(const <span class="keywordtype">char</span> *s) {
<a name="l01782"></a>01782 <span class="keywordflow">return</span> __builtin_constant_p(__builtin_strlen(s))
<a name="l01783"></a>01783 ? __builtin_strlen(s) : __strlen_P(s);
<a name="l01784"></a>01784 }
<a name="l01785"></a>01785 <span class="preprocessor">#endif</span>
<a name="l01786"></a>01786 <span class="preprocessor"></span>
<a name="l01787"></a>01787 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l01788"></a>01788 <span class="preprocessor"></span>}
<a name="l01789"></a>01789 <span class="preprocessor">#endif</span>
<a name="l01790"></a>01790 <span class="preprocessor"></span>
<a name="l01791"></a>01791 <span class="preprocessor">#endif </span><span class="comment">/* __PGMSPACE_H_ */</span>
</pre></div></div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<!-- HTML footer for doxygen 1.8.7-->
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
$navpath
<li class="footer">$generatedby
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> 1.6.3 </li>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small>
$generatedby &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
</a> 1.6.3
</small></address>
<!--END !GENERATE_TREEVIEW-->
</body>
</html>