Line No. | Rev | Author | Line |
---|---|---|---|
1 | 6 | kaklik | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
3 | <title>Procyon AVRlib: spieeprom.h Source File</title> |
||
4 | <link href="dox.css" rel="stylesheet" type="text/css"> |
||
5 | </head><body> |
||
6 | <!-- Generated by Doxygen 1.4.2 --> |
||
7 | <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
||
8 | <h1>spieeprom.h</h1><a href="spieeprom_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*! \file spieeprom.h \brief Interface for standard SPI EEPROM memories. */</span> |
||
9 | 00002 <span class="comment">//*****************************************************************************</span> |
||
10 | 00003 <span class="comment">//</span> |
||
11 | 00004 <span class="comment">// File Name : 'spieeprom.h'</span> |
||
12 | 00005 <span class="comment">// Title : Interface for standard SPI EEPROM memories</span> |
||
13 | 00006 <span class="comment">// Author : Pascal Stang - Copyright (C) 2004</span> |
||
14 | 00007 <span class="comment">// Created : 2004.10.07</span> |
||
15 | 00008 <span class="comment">// Revised : 2004.10.07</span> |
||
16 | 00009 <span class="comment">// Version : 0.1</span> |
||
17 | 00010 <span class="comment">// Target MCU : Atmel AVR series</span> |
||
18 | 00011 <span class="comment">// Editor Tabs : 4</span> |
||
19 | 00012 <span class="comment">//</span><span class="comment"></span> |
||
20 | 00013 <span class="comment">/// \ingroup driver_hw</span> |
||
21 | 00014 <span class="comment">/// \defgroup spieeprom Interface for standard SPI EEPROM memories (spieeprom.c)</span> |
||
22 | 00015 <span class="comment">/// \code #include "spieeprom.h" \endcode</span> |
||
23 | 00016 <span class="comment">/// \par Overview</span> |
||
24 | 00017 <span class="comment">/// This library provides functions for reading and writing standard</span> |
||
25 | 00018 <span class="comment">/// 25Cxxx/25LCxxx SPI EEPROM memories. Memory sizes up to 64Kbytes are</span> |
||
26 | 00019 <span class="comment">/// supported. Future revisions may include page-write support.</span> |
||
27 | 00020 <span class="comment">///</span> |
||
28 | 00021 <span class="comment">/// \Note Library not fully tested!</span> |
||
29 | 00022 <span class="comment"></span><span class="comment">//</span> |
||
30 | 00023 <span class="comment">// This code is distributed under the GNU Public License</span> |
||
31 | 00024 <span class="comment">// which can be found at http://www.gnu.org/licenses/gpl.txt</span> |
||
32 | 00025 <span class="comment">//</span> |
||
33 | 00026 <span class="comment">//*****************************************************************************</span> |
||
34 | 00027 |
||
35 | 00028 <span class="preprocessor">#ifndef SPIEEPROM_H</span> |
||
36 | 00029 <span class="preprocessor"></span><span class="preprocessor">#define SPIEEPROM_H</span> |
||
37 | 00030 <span class="preprocessor"></span> |
||
38 | 00031 <span class="preprocessor">#include "<a class="code" href="global_8h.html">global.h</a>"</span> |
||
39 | 00032 |
||
40 | 00033 <span class="comment">// defines and constants</span> |
||
41 | 00034 <span class="comment">// commands</span> |
||
42 | <a name="l00035"></a><a class="code" href="spieeprom_8h.html#a0">00035</a> <span class="preprocessor">#define SPIEEPROM_CMD_READ 0x03 </span><span class="comment">///< Read byte(s)</span> |
||
43 | <a name="l00036"></a><a class="code" href="spieeprom_8h.html#a1">00036</a> <span class="comment"></span>#define SPIEEPROM_CMD_WRITE 0x02 <span class="comment">///< Write byte(s)</span> |
||
44 | <a name="l00037"></a><a class="code" href="spieeprom_8h.html#a2">00037</a> <span class="comment"></span>#define SPIEEPROM_CMD_WREN 0x06 <span class="comment">///< Write Enable</span> |
||
45 | <a name="l00038"></a><a class="code" href="spieeprom_8h.html#a3">00038</a> <span class="comment"></span>#define SPIEEPROM_CMD_WRDI 0x04 <span class="comment">///< Write Disable</span> |
||
46 | <a name="l00039"></a><a class="code" href="spieeprom_8h.html#a4">00039</a> <span class="comment"></span>#define SPIEEPROM_CMD_RDSR 0x05 <span class="comment">///< Read Status Register</span> |
||
47 | <a name="l00040"></a><a class="code" href="spieeprom_8h.html#a5">00040</a> <span class="comment"></span>#define SPIEEPROM_CMD_WRSR 0x01 <span class="comment">///< Write Status Register</span> |
||
48 | 00041 <span class="comment"></span> |
||
49 | 00042 <span class="comment">// status register bit defines</span> |
||
50 | <a name="l00043"></a><a class="code" href="spieeprom_8h.html#a6">00043</a> <span class="preprocessor">#define SPIEEPROM_STATUS_WIP 0x01 </span><span class="comment">///< Write in progress</span> |
||
51 | <a name="l00044"></a><a class="code" href="spieeprom_8h.html#a7">00044</a> <span class="comment"></span>#define SPIEEPROM_STATUS_WEL 0x01 <span class="comment">///< Write enable</span> |
||
52 | <a name="l00045"></a><a class="code" href="spieeprom_8h.html#a8">00045</a> <span class="comment"></span>#define SPIEEPROM_STATUS_BP0 0x01 <span class="comment">///< Block Proection 0</span> |
||
53 | <a name="l00046"></a><a class="code" href="spieeprom_8h.html#a9">00046</a> <span class="comment"></span>#define SPIEEPROM_STATUS_BP1 0x01 <span class="comment">///< Block Proection 1</span> |
||
54 | <a name="l00047"></a><a class="code" href="spieeprom_8h.html#a10">00047</a> <span class="comment"></span>#define SPIEEPROM_STATUS_WPEN 0x01 <span class="comment">///< Write Protect Enable</span> |
||
55 | 00048 <span class="comment"></span> |
||
56 | 00049 <span class="comment">// functions</span> |
||
57 | 00050 <span class="comment"></span> |
||
58 | 00051 <span class="comment">//! Initialize SPI EEPROM interface</span> |
||
59 | 00052 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="spieeprom_8c.html#a0">spieepromInit</a>(<span class="keywordtype">void</span>); |
||
60 | 00053 <span class="comment"></span> |
||
61 | 00054 <span class="comment">//! In the SPI EEPROM read a byte from memory location [memAddr]</span> |
||
62 | 00055 <span class="comment"></span>u08 <a class="code" href="spieeprom_8c.html#a1">spieepromReadByte</a>(u32 memAddr); |
||
63 | 00056 <span class="comment"></span> |
||
64 | 00057 <span class="comment">//! In the SPI EEPROM write a byte [data] to the memory location [memAddr]</span> |
||
65 | 00058 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="spieeprom_8c.html#a2">spieepromWriteByte</a>(u32 memAddr, u08 data); |
||
66 | 00059 |
||
67 | 00060 <span class="keywordtype">void</span> spieepromWriteEnable(<span class="keywordtype">void</span>); |
||
68 | 00061 <span class="keywordtype">void</span> spieepromWriteDisable(<span class="keywordtype">void</span>); |
||
69 | 00062 u08 spieepromReadStatus(<span class="keywordtype">void</span>); |
||
70 | 00063 |
||
71 | 00064 <span class="preprocessor">#endif</span> |
||
72 | </pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:07 2006 for Procyon AVRlib by |
||
73 | <a href="http://www.doxygen.org/index.html"> |
||
74 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
75 | </body> |
||
76 | </html> |
Powered by WebSVN v2.8.3