mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
171 lines
15 KiB
HTML
171 lines
15 KiB
HTML
<!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"/>
|
|
<title>ArduinoLibs: EEPROM24.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body onload='searchBox.OnSelectItem(0);'>
|
|
<!-- Generated by Doxygen 1.7.4 -->
|
|
<script type="text/javascript"><!--
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
--></script>
|
|
<div id="top">
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">ArduinoLibs</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li id="searchli">
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">EEPROM24.h</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
|
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2012 Southern Storm Software, Pty Ltd.</span>
|
|
<a name="l00003"></a>00003 <span class="comment"> *</span>
|
|
<a name="l00004"></a>00004 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span>
|
|
<a name="l00005"></a>00005 <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span>
|
|
<a name="l00006"></a>00006 <span class="comment"> * to deal in the Software without restriction, including without limitation</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span>
|
|
<a name="l00010"></a>00010 <span class="comment"> *</span>
|
|
<a name="l00011"></a>00011 <span class="comment"> * The above copyright notice and this permission notice shall be included</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> * in all copies or substantial portions of the Software.</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> *</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS</span>
|
|
<a name="l00015"></a>00015 <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
|
|
<a name="l00016"></a>00016 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
|
|
<a name="l00018"></a>00018 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span>
|
|
<a name="l00019"></a>00019 <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span>
|
|
<a name="l00020"></a>00020 <span class="comment"> * DEALINGS IN THE SOFTWARE.</span>
|
|
<a name="l00021"></a>00021 <span class="comment"> */</span>
|
|
<a name="l00022"></a>00022
|
|
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef EEPROM24_h</span>
|
|
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM24_h</span>
|
|
<a name="l00025"></a>00025 <span class="preprocessor"></span>
|
|
<a name="l00026"></a>00026 <span class="preprocessor">#include <inttypes.h></span>
|
|
<a name="l00027"></a>00027 <span class="preprocessor">#include <stddef.h></span>
|
|
<a name="l00028"></a>00028
|
|
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="classI2CMaster.html" title="Abstract base class for I2C master implementations.">I2CMaster</a>;
|
|
<a name="l00030"></a>00030
|
|
<a name="l00031"></a>00031 <span class="comment">// Block select modes.</span>
|
|
<a name="l00032"></a>00032 <span class="preprocessor">#define EE_BSEL_NONE 0</span>
|
|
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define EE_BSEL_8BIT_ADDR 1</span>
|
|
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define EE_BSEL_17BIT_ADDR 2</span>
|
|
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#define EE_BSEL_17BIT_ADDR_ALT 3</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span>
|
|
<a name="l00037"></a>00037 <span class="comment">// Create an EEPROM descriptor from byte size, page size, and block select mode.</span>
|
|
<a name="l00038"></a>00038 <span class="preprocessor">#define _EE24(byteSize, pageSize, mode) \</span>
|
|
<a name="l00039"></a>00039 <span class="preprocessor"> (((byteSize) / (pageSize)) | (((unsigned long)(pageSize)) << 16) | \</span>
|
|
<a name="l00040"></a>00040 <span class="preprocessor"> (((unsigned long)(mode)) << 28))</span>
|
|
<a name="l00041"></a>00041 <span class="preprocessor"></span>
|
|
<a name="l00042"></a>00042 <span class="comment">// Type descriptors for the 24LCXX range of EEPROM's.</span>
|
|
<a name="l00043"></a>00043 <span class="preprocessor">#define EEPROM_24LC00 _EE24(16UL, 1, EE_BSEL_8BIT_ADDR)</span>
|
|
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC01 _EE24(128UL, 8, EE_BSEL_8BIT_ADDR)</span>
|
|
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC014 _EE24(128UL, 16, EE_BSEL_8BIT_ADDR)</span>
|
|
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC02 _EE24(256UL, 8, EE_BSEL_8BIT_ADDR)</span>
|
|
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC024 _EE24(256UL, 16, EE_BSEL_8BIT_ADDR)</span>
|
|
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC025 _EE24(256UL, 16, EE_BSEL_8BIT_ADDR)</span>
|
|
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC04 _EE24(512UL, 16, EE_BSEL_8BIT_ADDR)</span>
|
|
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC08 _EE24(1024UL, 16, EE_BSEL_8BIT_ADDR)</span>
|
|
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC16 _EE24(2048UL, 16, EE_BSEL_8BIT_ADDR)</span>
|
|
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC32 _EE24(4096UL, 32, EE_BSEL_NONE)</span>
|
|
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC64 _EE24(8192UL, 32, EE_BSEL_NONE)</span>
|
|
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC128 _EE24(16384UL, 32, EE_BSEL_NONE)</span>
|
|
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC256 _EE24(32768UL, 64, EE_BSEL_NONE)</span>
|
|
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC512 _EE24(65536UL, 128, EE_BSEL_NONE)</span>
|
|
<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC1025 _EE24(131072UL, 128, EE_BSEL_17BIT_ADDR_ALT)</span>
|
|
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor">#define EEPROM_24LC1026 _EE24(131072UL, 128, EE_BSEL_17BIT_ADDR)</span>
|
|
<a name="l00059"></a>00059 <span class="preprocessor"></span>
|
|
<a name="l00060"></a><a class="code" href="classEEPROM24.html">00060</a> <span class="keyword">class </span><a class="code" href="classEEPROM24.html" title="Reading and writing EEPROM's from the 24LCXX family.">EEPROM24</a>
|
|
<a name="l00061"></a>00061 {
|
|
<a name="l00062"></a>00062 <span class="keyword">public</span>:
|
|
<a name="l00063"></a>00063 <a class="code" href="classEEPROM24.html#ae8547f6ff7711496e1959ee24a142995" title="Constructs a new EEPROM access object on bus for an EEPROM of the specified type.">EEPROM24</a>(<a class="code" href="classI2CMaster.html" title="Abstract base class for I2C master implementations.">I2CMaster</a> &bus, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> type, uint8_t bank = 0);
|
|
<a name="l00064"></a>00064
|
|
<a name="l00065"></a><a class="code" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c">00065</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classEEPROM24.html#aa544875cef9bd05bf71d6c19be06cf7c" title="Returns the size of the EEPROM in bytes.">size</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _size; }
|
|
<a name="l00066"></a><a class="code" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a">00066</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classEEPROM24.html#af33b23e2614f3966bbaf2554890c032a" title="Returns the size of a single EEPROM page in bytes.">pageSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _pageSize; }
|
|
<a name="l00067"></a>00067
|
|
<a name="l00068"></a>00068 <span class="keywordtype">bool</span> <a class="code" href="classEEPROM24.html#af8b70971d882b06de3fc6644a8ece3cf" title="Returns true if the EEPROM is available on the I2C bus; false otherwise.">available</a>();
|
|
<a name="l00069"></a>00069
|
|
<a name="l00070"></a>00070 uint8_t <a class="code" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address.">read</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address);
|
|
<a name="l00071"></a>00071 <span class="keywordtype">size_t</span> <a class="code" href="classEEPROM24.html#a960971377d4decb122ff38d12603e586" title="Reads a single byte from the EEPROM at address.">read</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address, <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> length);
|
|
<a name="l00072"></a>00072
|
|
<a name="l00073"></a>00073 <span class="keywordtype">bool</span> <a class="code" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM.">write</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address, uint8_t value);
|
|
<a name="l00074"></a>00074 <span class="keywordtype">size_t</span> <a class="code" href="classEEPROM24.html#a9e017772e3459ee4ab987e27d78937f8" title="Writes a byte value to address in the EEPROM.">write</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> length);
|
|
<a name="l00075"></a>00075
|
|
<a name="l00076"></a>00076 <span class="keyword">private</span>:
|
|
<a name="l00077"></a>00077 <a class="code" href="classI2CMaster.html" title="Abstract base class for I2C master implementations.">I2CMaster</a> *_bus;
|
|
<a name="l00078"></a>00078 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _size;
|
|
<a name="l00079"></a>00079 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _pageSize;
|
|
<a name="l00080"></a>00080 uint8_t _mode;
|
|
<a name="l00081"></a>00081 uint8_t i2cAddress;
|
|
<a name="l00082"></a>00082
|
|
<a name="l00083"></a>00083 <span class="keywordtype">void</span> writeAddress(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> address);
|
|
<a name="l00084"></a>00084 <span class="keywordtype">bool</span> waitForWrite();
|
|
<a name="l00085"></a>00085 };
|
|
<a name="l00086"></a>00086
|
|
<a name="l00087"></a>00087 <span class="preprocessor">#endif</span>
|
|
</pre></div></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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<hr class="footer"/><address class="footer"><small>Generated on Wed Jun 13 2012 15:22:29 for ArduinoLibs by 
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
|
</body>
|
|
</html>
|