?lang_form? ?lang_select? ?lang_submit? ?lang_endform?
{HEADER END}
{BLAME START}

library

?curdirlinks? -

Blame information for rev 6

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: spiflash.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&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
8 <h1>spiflash.h</h1><a href="spiflash_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*! \file spiflash.h \brief SPI Flash Memory Driver (M25Pxx/AT25Fxxx/etc). */</span>
9 00002 <span class="comment">//*****************************************************************************</span>
10 00003 <span class="comment">//</span>
11 00004 <span class="comment">// File Name : 'spiflash.h'</span>
12 00005 <span class="comment">// Title : SPI Flash Memory Driver (M25Pxx/AT25Fxxx/etc)</span>
13 00006 <span class="comment">// Author : Pascal Stang - Copyright (C) 2006</span>
14 00007 <span class="comment">// Created : 2006-04-15</span>
15 00008 <span class="comment">// Revised : 2006-07-02</span>
16 00009 <span class="comment">// Version : 0.1</span>
17 00010 <span class="comment">// Target MCU : AVR processors</span>
18 00011 <span class="comment">// Editor Tabs : 4</span>
19 00012 <span class="comment">//</span>
20 00013 <span class="comment">// NOTE: This code is currently below version 1.0, and therefore is considered</span>
21 00014 <span class="comment">// to be lacking in some functionality or documentation, or may not be fully</span>
22 00015 <span class="comment">// tested. Nonetheless, you can expect most functions to work.</span>
23 00016 <span class="comment">//</span>
24 00017 <span class="comment">//*****************************************************************************</span>
25 00018
26 00019 <span class="preprocessor">#ifndef AVRLIB_SPIFLASH_H</span>
27 00020 <span class="preprocessor"></span><span class="preprocessor">#define AVRLIB_SPIFLASH_H</span>
28 00021 <span class="preprocessor"></span>
29 00022 <span class="preprocessor">#include "<a class="code" href="global_8h.html">global.h</a>"</span>
30 00023
31 00024 <span class="comment">// Compatible with:</span>
32 00025 <span class="comment">// - ST M25Pxx devices</span>
33 00026 <span class="comment">// - Atmel AT25Fxxx devices</span>
34 00027 <span class="comment">// - many more</span>
35 00028
36 00029 <span class="comment">// device commands</span>
37 00030 <span class="preprocessor">#define SPIFLASH_CMD_WREN 0x06 // write enable</span>
38 00031 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_CMD_WRDI 0x04 // write disable</span>
39 00032 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_CMD_RDID 0x9F // read ID register</span>
40 00033 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_CMD_RDSR 0x05 // read status register</span>
41 00034 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_CMD_WRSR 0x01 // write status register</span>
42 00035 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_CMD_READ 0x03 // read</span>
43 00036 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_CMD_FASTREAD 0x0B // high-speed read</span>
44 00037 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_CMD_PAGEPROG 0x02 // page program</span>
45 00038 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_CMD_SECTERASE 0xD8 // sector erase</span>
46 00039 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_CMD_CHIPERASE 0xC7 // chip erase</span>
47 00040 <span class="preprocessor"></span>
48 00041 <span class="comment">// status register bits</span>
49 00042 <span class="preprocessor">#define SPIFLASH_STATUS_BUSY 0x01 // busy, write in progress</span>
50 00043 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_STATUS_WEN 0x02 // write enable</span>
51 00044 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_STATUS_BP0 0x04 // block protect 0</span>
52 00045 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_STATUS_BP1 0x08 // block protect 1</span>
53 00046 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_STATUS_BP2 0x10 // block protect 2</span>
54 00047 <span class="preprocessor"></span><span class="preprocessor">#define SPIFLASH_STATUS_WPEN 0x80 // write protect enabled</span>
55 00048 <span class="preprocessor"></span>
56 00049 <span class="comment">// device constants</span>
57 00050 <span class="preprocessor">#define SPIFLASH_PAGESIZE 256 // 256 bytes/page</span>
58 00051 <span class="preprocessor"></span>
59 00052 <span class="comment">// functions</span>
60 00053
61 00054 <span class="comment">// Initializes spiflash for operation</span>
62 00055 <span class="keywordtype">void</span> spiflashInit(<span class="keywordtype">void</span>);
63 00056
64 00057 <span class="comment">// Get spiflash ID</span>
65 00058 <span class="comment">// NOTE: supported only on some flash memories</span>
66 00059 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> spiflashGetID(<span class="keywordtype">void</span>);
67 00060
68 00061 <span class="comment">// Erase entire flash chip</span>
69 00062 <span class="keywordtype">void</span> spiflashChipErase(<span class="keywordtype">void</span>);
70 00063
71 00064 <span class="comment">// Read flash memory</span>
72 00065 <span class="comment">// - addr may be any value</span>
73 00066 <span class="comment">// - nbytes may be any value</span>
74 00067 <span class="keywordtype">void</span> spiflashRead(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> addr, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> nbytes, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data);
75 00068
76 00069 <span class="comment">// Write flash memory (automatic handling of page writes)</span>
77 00070 <span class="comment">// - memory must be previously erased</span>
78 00071 <span class="comment">// - addr MUST start at a page break</span>
79 00072 <span class="comment">// OR</span>
80 00073 <span class="comment">// - nbytes must be small enough such that page boundary is not crossed</span>
81 00074 <span class="keywordtype">void</span> spiflashWrite(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> addr, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> nbytes, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data);
82 00075
83 00076 <span class="preprocessor">#endif</span>
84 </pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:07 2006 for Procyon AVRlib by&nbsp;
85 <a href="http://www.doxygen.org/index.html">
86 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
87 </body>
88 </html>
{BLAME END}
{FOOTER START}

Powered by WebSVN v2.8.3