├── .gitignore ├── LICENSE.md ├── README.md ├── examples └── ESP_spiram │ └── ESP_spiram.ino ├── library.properties └── src ├── ESP8266Spiram.cpp └── ESP8266Spiram.h /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files 2 | *.slo 3 | *.lo 4 | *.o 5 | *.obj 6 | 7 | # Precompiled Headers 8 | *.gch 9 | *.pch 10 | 11 | # Compiled Dynamic libraries 12 | *.so 13 | *.dylib 14 | *.dll 15 | 16 | # Fortran module files 17 | *.mod 18 | 19 | # Compiled Static libraries 20 | *.lai 21 | *.la 22 | *.a 23 | *.lib 24 | 25 | # Executables 26 | *.exe 27 | *.out 28 | *.app 29 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Arduino IDE ESP8266 - library for SPI Serial SRam 23A1024/23LC1024 by Microchip Technology Inc. 2 | 3 | This Library provides the interface for a 1Mbit SRAM chip 4 | with ESP8266 through SPI connection. 5 | Microchip 23A1024/23LC1024 - [download datasheet here](http://ww1.microchip.com/downloads/en/DeviceDoc/20005142C.pdf) 6 | 7 | Application written by [Giancarlo Bacchio](bacchio.giancarlo@gmail.com) 8 | 9 | 10 | ## Getting the code 11 | 12 | You can install SRam Library for your ESP8266 downloading the code that is hosted at https://github.com/Gianbacchio/ESP8266_Spiram. 13 | 14 | Selecting "Watch" box in the GitHub repository, you will be informed about the latest development updates of this library. 15 | 16 | 17 | ## Installing the code 18 | 19 | The downloaded code in *.zip format can be included as a new library into the IDE, selecting the menù: 20 | 21 | Sketch / include Library / Add .Zip library 22 | 23 | 24 | ## Usage 25 | 26 | The Hardware connection is done using the standard HSPI interface of the ESP8266. 27 | 28 | The chip is connected as per para 3.8 "SPI/SDI and SQI Pin designation" (see datasheet) 29 | 30 | Power supply is 3,3Vcc. 31 | 32 | Pin on RAM chip | functionality | Pin on ESP8266 33 | ----------------|---------------|---------------- 34 | pin1 | C/S | GPIO15 35 | pin2 | MISO | GPIO12 36 | pin3 | N/C | Gnd 37 | pin4 | Vss | Gnd 38 | pin5 | MOSI | GPIO13 39 | pin6 | SCK | GPIO14 40 | pin7 | HOLD | V+ 41 | pin8 | Vcc | V+ 42 | 43 | 44 | ## Examples 45 | 46 | - ESP_spiram.ino : a basic example to understand how the library works. You can write and read a Byte in a given location of the SRAM 47 | 48 | 49 | ## License 50 | 51 | You may copy, distribute and modify the software provided that modifications are described and licensed for free under [LGPL-3](http://www.gnu.org/licenses/lgpl-3.0.html). Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under [LGPL-3](http://www.gnu.org/licenses/lgpl-3.0.html), but applications that use the library don't have to be. 52 | 53 | 54 | -------------------------------------------------------------------------------- /examples/ESP_spiram/ESP_spiram.ino: -------------------------------------------------------------------------------- 1 | /*************************************************************************** 2 | * This is a basic example showing how to use ESP8266Spiram library * 3 | * you can write and read a Byte in a given location of the SRAM * * 4 | * for usage and connections, see: * 5 | * https://github.com/arduino/ESPBee/blob/master/ESP8266_Spiram/README.md * 6 | * * 7 | * written by Giacarlo Bacchio * 8 | ***************************************************************************/ 9 | 10 | #include 11 | #include 12 | 13 | ESP8266Spiram Spiram; 14 | 15 | 16 | void setup() { 17 | Serial.begin(115200); 18 | delay(1000); 19 | Spiram.begin(); 20 | } 21 | 22 | 23 | void loop() { 24 | Spiram.setByteMode(); 25 | uint8_t rRam[5] = {0x01, 0x02, 0x03, 0x04, 0x05}; 26 | uint8_t wRam[5]; 27 | Spiram.write(0x00, rRam, 5); 28 | Spiram.read(0x00, wRam, 5); 29 | for (int i = 0; i < 5; i++) 30 | Serial.println(wRam[i]); 31 | delay(2000); 32 | } 33 | 34 | 35 | 36 | 37 | 38 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=ESP8266Spiram 2 | version=1.0 3 | author=Giancarlo Bacchio 4 | maintainer=Giancarlo 5 | sentence=Arduino IDE ESP8266 - SPI additional RAM Library. 6 | paragraph=ESP8266Spiram 7 | category=Data Processing 8 | url=https://github.com/Gianbacchio/ESP8266_Spiram/tree/master 9 | architectures=* 10 | -------------------------------------------------------------------------------- /src/ESP8266Spiram.cpp: -------------------------------------------------------------------------------- 1 | /*********************************************************************************** 2 | * ESP8266Spiram.h - Library designed to manage SRAM Memory chip 23LC1024 via HSPI * 3 | * Created by Giancarlo Bacchio - August 15, 2015. * 4 | * see datasheet at http://ww1.microchip.com/downloads/en/DeviceDoc/25142A.pdf * 5 | * Released into the public domain. * 6 | ***********************************************************************************/ 7 | 8 | 9 | /* 10 | In this library, the Ram is connected to HSPI using the following pins: 11 | (see SPI Mode, para3.8 pg.13 of 23LC1024 datasheet) 12 | pin1 C/S-->GPIO15 13 | pin2 MISO-->GPIO12 14 | pin3 N/C-->Gnd 15 | pin4 Vss-->Gnd 16 | pin5 MOSI-->GPIO13 17 | pin6 SCK-->GPIO14 18 | pin7 HOLD-->V+ 19 | pin8 Vcc-->V+ 20 | 21 | ************************************************************************************/ 22 | 23 | 24 | 25 | #include "ESP8266Spiram.h" 26 | 27 | ESP8266Spiram Spiram; 28 | 29 | // setup of C/S line as per HSPI default 30 | ESP8266Spiram::ESP8266Spiram() { 31 | Cs=15; // default value for HSPI port 32 | clkSpeed=20e6; // The 23LC1024 supports theorically up to 20MHz 33 | } 34 | 35 | ESP8266Spiram::ESP8266Spiram(int cs, int clockspeedhz) { 36 | Cs = cs; 37 | clkSpeed = clockspeedhz; 38 | } 39 | 40 | // Activate the library setting up ByteMode of operation (see 2.2 pg.5) 41 | void ESP8266Spiram::begin(void) { 42 | 43 | SPI.begin(); 44 | pinMode (Cs, OUTPUT); 45 | digitalWrite(Cs, HIGH); 46 | 47 | digitalWrite(Cs, HIGH); 48 | delay(50); 49 | digitalWrite(Cs, LOW); 50 | delay(50); 51 | digitalWrite(Cs, HIGH); 52 | setByteMode(); 53 | } 54 | 55 | /*********************************************** 56 | * this function Read SRAM * 57 | * - addr: address to start read * 58 | * - *buff: list where read bytes are copied * 59 | * - len: amount of bytes to read * 60 | * (see sequence in figure 2-1) * 61 | ***********************************************/ 62 | 63 | 64 | void ESP8266Spiram::read(uint32_t addr, uint8_t *buff, int len) { 65 | switch (opMode) { 66 | case REG_BM: 67 | readBytes(addr, buff, len); 68 | break; 69 | case REG_SM: 70 | readSeq(addr, buff, len); 71 | break; 72 | default: 73 | readBytes(addr, buff, len); 74 | } 75 | } 76 | 77 | 78 | void ESP8266Spiram::readBytes(uint32_t addr, uint8_t *buff, int len) { 79 | uint32_t instr; 80 | int i=0; 81 | while (len--) { 82 | instr=(READ<<24)|(addr++&0x00ffffff); 83 | beginTrans_(); 84 | transfer32(instr); // code to set Read mode in the SRAM 85 | buff[i++]=transfer8(0); 86 | endTrans_(); 87 | } 88 | } 89 | 90 | void ESP8266Spiram::readSeq(uint32_t addr, uint8_t *buff, int len) { 91 | uint32_t instr; 92 | int i=0; 93 | instr=(READ<<24)|(addr++&0x00ffffff); 94 | beginTrans_(); 95 | transfer32(instr); // code to set Read mode in the SRAM 96 | while (len--) { 97 | buff[i++]=transfer8(0); 98 | } 99 | endTrans_(); 100 | } 101 | 102 | 103 | /************************************** 104 | * this function Write in the SRAM * 105 | * - addr: address to start write * 106 | * - *buff: list of bytes to write * 107 | * - len: amount of bytes to write * 108 | * (see sequence in figure 2-2) * 109 | **************************************/ 110 | 111 | void ESP8266Spiram::write(uint32_t addr, uint8_t *buff, int len) { 112 | switch (opMode) { 113 | case REG_BM: 114 | writeBytes(addr, buff, len); 115 | break; 116 | case REG_SM: 117 | writeSeq(addr, buff, len); 118 | break; 119 | default: 120 | writeBytes(addr, buff, len); 121 | } 122 | } 123 | 124 | void ESP8266Spiram::writeBytes(uint32_t addr, uint8_t *buff, int len) { 125 | uint32_t instr; 126 | int i=0; 127 | while (len--) { 128 | instr=(WRITE<<24)|(addr++&0x00ffffff); 129 | beginTrans_(); 130 | transfer32(instr); // code to set Read mode in the SRAM 131 | transfer8(buff[i++]); 132 | endTrans_(); 133 | } 134 | } 135 | 136 | void ESP8266Spiram::writeSeq(uint32_t addr, uint8_t *buff, int len) { 137 | uint32_t instr; 138 | int i=0; 139 | instr=(WRITE<<24)|(addr++&0x00ffffff); 140 | beginTrans_(); 141 | transfer32(instr); // code to set Read mode in the SRAM 142 | while (len--) { 143 | transfer8(buff[i++]); 144 | } 145 | endTrans_(); 146 | } 147 | 148 | 149 | /************************************************* 150 | * this function Read the configuration register * 151 | *************************************************/ 152 | 153 | uint8_t ESP8266Spiram::readReg_(void) { 154 | beginTrans_(); 155 | transfer8(RDMR); 156 | uint8_t reg=transfer8(0); 157 | endTrans_(); 158 | return reg; 159 | } 160 | 161 | /************************************************** 162 | * this function Write the configuration register * 163 | **************************************************/ 164 | 165 | void ESP8266Spiram::writeReg_(uint8_t reg) { 166 | beginTrans_(); 167 | transfer8(WRMR); 168 | transfer8(reg); 169 | endTrans_(); 170 | } 171 | 172 | /******************************** 173 | * this function reset the SRAM * 174 | ********************************/ 175 | 176 | void ESP8266Spiram::reset_(void) { 177 | beginTrans_(); 178 | SPI.transfer(RSTIO); 179 | endTrans_(); 180 | } 181 | 182 | uint8_t ESP8266Spiram::transfer8(uint8_t data){ 183 | /* FOR DEBUG: 184 | Serial.print("sending: "); 185 | Serial.println(data,BIN); 186 | data = SPI.transfer(data); 187 | Serial.print("receving: "); 188 | Serial.println(data,BIN); 189 | return data;*/ 190 | return SPI.transfer(data); 191 | } 192 | 193 | uint16_t ESP8266Spiram::transfer16(uint16_t data){ 194 | union { 195 | uint16_t val; 196 | struct { 197 | uint8_t lsb; 198 | uint8_t msb; 199 | }; 200 | } in, out; 201 | in.val = data; 202 | 203 | out.msb = transfer8(in.msb); 204 | out.lsb = transfer8(in.lsb); 205 | 206 | return out.val; 207 | } 208 | 209 | uint32_t ESP8266Spiram::transfer32(uint32_t data){ 210 | union { 211 | uint32_t val; 212 | struct { 213 | uint16_t lsb; 214 | uint16_t msb; 215 | }; 216 | } in, out; 217 | in.val = data; 218 | 219 | out.msb = transfer16(in.msb); 220 | out.lsb = transfer16(in.lsb); 221 | 222 | return out.val; 223 | } 224 | 225 | void ESP8266Spiram::setByteMode(void){ 226 | writeReg_(REG_BM); 227 | opMode = getMode(); 228 | } 229 | 230 | void ESP8266Spiram::setPageMode(void){ 231 | writeReg_(REG_PM); 232 | opMode = getMode(); 233 | } 234 | 235 | void ESP8266Spiram::setSeqMode(void){ 236 | writeReg_(REG_SM); 237 | opMode = getMode(); 238 | } 239 | 240 | uint8_t ESP8266Spiram::getMode(void){ 241 | return readReg_(); 242 | } 243 | 244 | void ESP8266Spiram::beginTrans_(void){ 245 | SPI.beginTransaction(SPISettings(clkSpeed, MSBFIRST, SPI_MODE0)); 246 | digitalWrite(Cs, LOW); 247 | } 248 | 249 | void ESP8266Spiram::endTrans_(void){ 250 | digitalWrite(Cs, HIGH); 251 | SPI.endTransaction(); 252 | } 253 | -------------------------------------------------------------------------------- /src/ESP8266Spiram.h: -------------------------------------------------------------------------------- 1 | /*********************************************************************************** 2 | * ESP8266Spiram.h - Library designed to manage SRAM Memory chip 23LC1024 via HSPI * 3 | * Created by Giancarlo Bacchio - August 15, 2015. * 4 | * see datasheet at http://ww1.microchip.com/downloads/en/DeviceDoc/25142A.pdf * 5 | * Released into the public domain. * 6 | ***********************************************************************************/ 7 | 8 | /* 9 | In this library, the Ram is connected to HSPI using the following pins: 10 | (see SPI Mode, para3.8 pg.13 of 23LC1024 datasheet) 11 | pin1 C/S-->GPIO15 12 | pin2 MISO-->GPIO12 13 | pin3 N/C-->Gnd 14 | pin4 Vss-->Gnd 15 | pin5 MOSI-->GPIO13 16 | pin6 SCK-->GPIO14 17 | pin7 HOLD-->V+ 18 | pin8 Vcc-->V+ 19 | 20 | ***********************************************************************************/ 21 | 22 | 23 | #ifndef ESP8266Spiram_h 24 | #define ESP8266Spiram_h 25 | 26 | #include 27 | #include 28 | 29 | //set of variables defined as per table2.1 pg6 30 | const uint8_t READ = 0x03; 31 | const uint8_t WRITE = 0x02; 32 | const uint8_t EDIO = 0x3B; 33 | const uint8_t EQIO = 0x38; 34 | const uint8_t RSTIO = 0xFF; 35 | const uint8_t RDMR = 0x05; 36 | const uint8_t WRMR = 0x01; 37 | 38 | //Mode Register setting as per para 2.2 pg5 39 | const uint8_t REG_BM = 0x00; 40 | const uint8_t REG_PM = 0x80; 41 | const uint8_t REG_SM = 0x40; 42 | 43 | class ESP8266Spiram 44 | { 45 | public: 46 | ESP8266Spiram(); 47 | ESP8266Spiram(int cs, int clockspeedhz); 48 | void begin(void); 49 | void write(uint32_t addr, uint8_t *buff, int len); 50 | void read(uint32_t addr, uint8_t *buff, int len); 51 | void setByteMode(void); 52 | void setPageMode(void); 53 | void setSeqMode(void); 54 | uint8_t getMode(); 55 | private: 56 | void beginTrans_(void); 57 | void endTrans_(void); 58 | void writeReg_(uint8_t reg); 59 | void readBytes(uint32_t addr, uint8_t *buff, int len); 60 | void readSeq(uint32_t addr, uint8_t *buff, int len); 61 | void writeBytes(uint32_t addr, uint8_t *buff, int len); 62 | void writeSeq(uint32_t addr, uint8_t *buff, int len); 63 | void reset_(); 64 | int Cs; 65 | uint32_t clkSpeed; 66 | uint8_t opMode; 67 | uint8_t readReg_(void); 68 | uint8_t transfer8(uint8_t data); 69 | uint16_t transfer16(uint16_t data); 70 | uint32_t transfer32(uint32_t data); 71 | }; 72 | 73 | extern ESP8266Spiram Spiram; 74 | 75 | #endif 76 | --------------------------------------------------------------------------------