MAX32620HSP (MAXREFDES100) RPC Example for Graphical User Interface

Dependencies:   USBDevice

Fork of HSP_Release by Jerry Bradshaw

This is an example program for the MAX32620HSP (MAXREFDES100 Health Sensor Platform). It demonstrates all the features of the platform and works with a companion graphical user interface (GUI) to help evaluate/configure/monitor the board. Go to the MAXREFDES100 product page and click on "design resources" to download the companion software. The GUI connects to the board through an RPC interface on a virtual serial port over the USB interface.

The RPC interface provides access to all the features of the board and is available to interface with other development environments such Matlab. This firmware provides realtime data streaming through the RPC interface over USB, and also provides the ability to log the data to flash for untethered battery operation. The data logging settings are configured through the GUI, and the GUI also provides the interface to download logged data.

Details on the RPC interface can be found here: HSP RPC Interface Documentation

Windows

With this program loaded, the MAX32620HSP will appear on your computer as a serial port. On Mac and Linux, this will happen by default. For Windows, you need to install a driver: HSP serial port windows driver

For more details about this platform and how to use it, see the MAXREFDES100 product page.

Committer:
jbradshaw
Date:
Tue Oct 25 15:22:11 2016 +0000
Revision:
0:e4a10ed6eb92
Child:
1:9490836294ea
tewt

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jbradshaw 0:e4a10ed6eb92 1 /*******************************************************************************
jbradshaw 0:e4a10ed6eb92 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
jbradshaw 0:e4a10ed6eb92 3 *
jbradshaw 0:e4a10ed6eb92 4 * Permission is hereby granted, free of charge, to any person obtaining a
jbradshaw 0:e4a10ed6eb92 5 * copy of this software and associated documentation files (the "Software"),
jbradshaw 0:e4a10ed6eb92 6 * to deal in the Software without restriction, including without limitation
jbradshaw 0:e4a10ed6eb92 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
jbradshaw 0:e4a10ed6eb92 8 * and/or sell copies of the Software, and to permit persons to whom the
jbradshaw 0:e4a10ed6eb92 9 * Software is furnished to do so, subject to the following conditions:
jbradshaw 0:e4a10ed6eb92 10 *
jbradshaw 0:e4a10ed6eb92 11 * The above copyright notice and this permission notice shall be included
jbradshaw 0:e4a10ed6eb92 12 * in all copies or substantial portions of the Software.
jbradshaw 0:e4a10ed6eb92 13 *
jbradshaw 0:e4a10ed6eb92 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
jbradshaw 0:e4a10ed6eb92 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
jbradshaw 0:e4a10ed6eb92 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
jbradshaw 0:e4a10ed6eb92 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
jbradshaw 0:e4a10ed6eb92 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
jbradshaw 0:e4a10ed6eb92 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
jbradshaw 0:e4a10ed6eb92 20 * OTHER DEALINGS IN THE SOFTWARE.
jbradshaw 0:e4a10ed6eb92 21 *
jbradshaw 0:e4a10ed6eb92 22 * Except as contained in this notice, the name of Maxim Integrated
jbradshaw 0:e4a10ed6eb92 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
jbradshaw 0:e4a10ed6eb92 24 * Products, Inc. Branding Policy.
jbradshaw 0:e4a10ed6eb92 25 *
jbradshaw 0:e4a10ed6eb92 26 * The mere transfer of this software does not imply any licenses
jbradshaw 0:e4a10ed6eb92 27 * of trade secrets, proprietary technology, copyrights, patents,
jbradshaw 0:e4a10ed6eb92 28 * trademarks, maskwork rights, or any other form of intellectual
jbradshaw 0:e4a10ed6eb92 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
jbradshaw 0:e4a10ed6eb92 30 * ownership rights.
jbradshaw 0:e4a10ed6eb92 31 *******************************************************************************
jbradshaw 0:e4a10ed6eb92 32 */
jbradshaw 0:e4a10ed6eb92 33
jbradshaw 0:e4a10ed6eb92 34 //
jbradshaw 0:e4a10ed6eb92 35 // Flash Non-Volatile Memory
jbradshaw 0:e4a10ed6eb92 36 // U27 S25FS512
jbradshaw 0:e4a10ed6eb92 37 // Nimitz SPIM1
jbradshaw 0:e4a10ed6eb92 38 //
jbradshaw 0:e4a10ed6eb92 39
jbradshaw 0:e4a10ed6eb92 40 #include "mbed.h"
jbradshaw 0:e4a10ed6eb92 41 #include "S25FS512.h"
jbradshaw 0:e4a10ed6eb92 42 #include "QuadSpiInterface.h"
jbradshaw 0:e4a10ed6eb92 43
jbradshaw 0:e4a10ed6eb92 44 #define IOMUX_IO_ENABLE 1
jbradshaw 0:e4a10ed6eb92 45
jbradshaw 0:e4a10ed6eb92 46 #define S25FS512_SPI_PORT 1
jbradshaw 0:e4a10ed6eb92 47 #define S25FS512_CS_PIN 0
jbradshaw 0:e4a10ed6eb92 48 #define S25FS512_CS_POLARITY 0
jbradshaw 0:e4a10ed6eb92 49 #define S25FS512_CS_ACTIVITY_DELAY 0
jbradshaw 0:e4a10ed6eb92 50 #define S25FS512_CS_INACTIVITY_DELAY 0
jbradshaw 0:e4a10ed6eb92 51 #define S25FS512_CLK_HI 4
jbradshaw 0:e4a10ed6eb92 52 #define S25FS512_CLK_LOW 4
jbradshaw 0:e4a10ed6eb92 53 #define S25FS512_ALT_CLK 0
jbradshaw 0:e4a10ed6eb92 54 #define S25FS512_CLK_POLARITY 0
jbradshaw 0:e4a10ed6eb92 55 #define S25FS512_CLK_PHASE 0
jbradshaw 0:e4a10ed6eb92 56 #define S25FS512_WRITE 1
jbradshaw 0:e4a10ed6eb92 57 #define S25FS512_READ 0
jbradshaw 0:e4a10ed6eb92 58
jbradshaw 0:e4a10ed6eb92 59 #define INT_PORT_B 3
jbradshaw 0:e4a10ed6eb92 60 #define INT_PIN_B 6
jbradshaw 0:e4a10ed6eb92 61
jbradshaw 0:e4a10ed6eb92 62 uint8_t flashBuffer[257 + 10];
jbradshaw 0:e4a10ed6eb92 63
jbradshaw 0:e4a10ed6eb92 64 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 65 S25FS512::S25FS512(QuadSpiInterface *_quadSpiInterface) {
jbradshaw 0:e4a10ed6eb92 66 this->quadSpiInterface = _quadSpiInterface;
jbradshaw 0:e4a10ed6eb92 67 }
jbradshaw 0:e4a10ed6eb92 68
jbradshaw 0:e4a10ed6eb92 69 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 70 S25FS512::~S25FS512(void) {
jbradshaw 0:e4a10ed6eb92 71 }
jbradshaw 0:e4a10ed6eb92 72
jbradshaw 0:e4a10ed6eb92 73 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 74 int S25FS512::init(void) {
jbradshaw 0:e4a10ed6eb92 75 setQuadMode();
jbradshaw 0:e4a10ed6eb92 76 return 0;
jbradshaw 0:e4a10ed6eb92 77 }
jbradshaw 0:e4a10ed6eb92 78
jbradshaw 0:e4a10ed6eb92 79 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 80 int S25FS512::wren4Wire(void) {
jbradshaw 0:e4a10ed6eb92 81 uint8_t cmdArray[8];
jbradshaw 0:e4a10ed6eb92 82 // Send WREN
jbradshaw 0:e4a10ed6eb92 83 cmdArray[0] = 0x06;
jbradshaw 0:e4a10ed6eb92 84 wait_1mS();
jbradshaw 0:e4a10ed6eb92 85 return reg_write_read_multiple_4Wire(cmdArray, 1, flashBuffer, 1);
jbradshaw 0:e4a10ed6eb92 86 }
jbradshaw 0:e4a10ed6eb92 87
jbradshaw 0:e4a10ed6eb92 88 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 89 uint8_t S25FS512::wren(void) {
jbradshaw 0:e4a10ed6eb92 90 uint8_t cmdArray[8];
jbradshaw 0:e4a10ed6eb92 91 // Send WREN
jbradshaw 0:e4a10ed6eb92 92 cmdArray[0] = 0x06;
jbradshaw 0:e4a10ed6eb92 93 wait_1mS();
jbradshaw 0:e4a10ed6eb92 94 return reg_write_read_multiple_quad(cmdArray, 1, flashBuffer, 0);
jbradshaw 0:e4a10ed6eb92 95 }
jbradshaw 0:e4a10ed6eb92 96
jbradshaw 0:e4a10ed6eb92 97 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 98 int8_t S25FS512::reg_write_read_multiple_quad_last(uint8_t *bufferOut,
jbradshaw 0:e4a10ed6eb92 99 uint8_t numberOut,
jbradshaw 0:e4a10ed6eb92 100 uint8_t *bufferIn,
jbradshaw 0:e4a10ed6eb92 101 uint8_t numberIn,
jbradshaw 0:e4a10ed6eb92 102 uint8_t last) {
jbradshaw 0:e4a10ed6eb92 103 int32_t success = 0;
jbradshaw 0:e4a10ed6eb92 104
jbradshaw 0:e4a10ed6eb92 105 success = quadSpiInterface->SPI_Transmit(
jbradshaw 0:e4a10ed6eb92 106 bufferOut, numberOut,
jbradshaw 0:e4a10ed6eb92 107 bufferIn, numberIn, (int)last);
jbradshaw 0:e4a10ed6eb92 108
jbradshaw 0:e4a10ed6eb92 109 if (success != 0) return -1;
jbradshaw 0:e4a10ed6eb92 110 return 0;
jbradshaw 0:e4a10ed6eb92 111 }
jbradshaw 0:e4a10ed6eb92 112
jbradshaw 0:e4a10ed6eb92 113 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 114 int8_t S25FS512::reg_write_read_multiple_4Wire(uint8_t *bufferOut,
jbradshaw 0:e4a10ed6eb92 115 uint8_t numberOut,
jbradshaw 0:e4a10ed6eb92 116 uint8_t *bufferIn,
jbradshaw 0:e4a10ed6eb92 117 uint8_t numberIn) {
jbradshaw 0:e4a10ed6eb92 118 int32_t success = 0;
jbradshaw 0:e4a10ed6eb92 119 success = quadSpiInterface->SPI_Transmit4Wire(bufferOut, numberOut, bufferIn,
jbradshaw 0:e4a10ed6eb92 120 numberIn, (int)1);
jbradshaw 0:e4a10ed6eb92 121
jbradshaw 0:e4a10ed6eb92 122 if (success != 0) return -1;
jbradshaw 0:e4a10ed6eb92 123 return 0;
jbradshaw 0:e4a10ed6eb92 124 }
jbradshaw 0:e4a10ed6eb92 125
jbradshaw 0:e4a10ed6eb92 126 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 127 int8_t S25FS512::reg_write_read_multiple_quad(uint8_t *bufferOut,
jbradshaw 0:e4a10ed6eb92 128 uint8_t numberOut,
jbradshaw 0:e4a10ed6eb92 129 uint8_t *bufferIn,
jbradshaw 0:e4a10ed6eb92 130 uint8_t numberIn) {
jbradshaw 0:e4a10ed6eb92 131 int8_t ret;
jbradshaw 0:e4a10ed6eb92 132 ret = reg_write_read_multiple_quad_last(bufferOut, numberOut, bufferIn,
jbradshaw 0:e4a10ed6eb92 133 numberIn, 1);
jbradshaw 0:e4a10ed6eb92 134 return ret;
jbradshaw 0:e4a10ed6eb92 135 }
jbradshaw 0:e4a10ed6eb92 136
jbradshaw 0:e4a10ed6eb92 137 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 138 void S25FS512::readID(uint8_t *id) {
jbradshaw 0:e4a10ed6eb92 139 uint8_t cmd = 0x9F;
jbradshaw 0:e4a10ed6eb92 140 reg_write_read_multiple_quad(&cmd, 1, id, 4);
jbradshaw 0:e4a10ed6eb92 141 }
jbradshaw 0:e4a10ed6eb92 142
jbradshaw 0:e4a10ed6eb92 143 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 144 int8_t S25FS512::writeAnyRegister(uint32_t address, uint8_t data) {
jbradshaw 0:e4a10ed6eb92 145 uint8_t cmdArray[5];
jbradshaw 0:e4a10ed6eb92 146 cmdArray[0] = 0x71;
jbradshaw 0:e4a10ed6eb92 147 cmdArray[1] = (address >> 16) & 0xFF;
jbradshaw 0:e4a10ed6eb92 148 cmdArray[2] = (address >> 8) & 0xFF;
jbradshaw 0:e4a10ed6eb92 149 cmdArray[3] = (address >> 0) & 0xFF;
jbradshaw 0:e4a10ed6eb92 150 cmdArray[4] = data;
jbradshaw 0:e4a10ed6eb92 151 return reg_write_read_multiple_quad(cmdArray, 5, flashBuffer, 0);
jbradshaw 0:e4a10ed6eb92 152 }
jbradshaw 0:e4a10ed6eb92 153
jbradshaw 0:e4a10ed6eb92 154 int8_t S25FS512::writeAnyRegister4Wire(uint32_t address, uint8_t data) {
jbradshaw 0:e4a10ed6eb92 155 uint8_t cmdArray[5];
jbradshaw 0:e4a10ed6eb92 156 cmdArray[0] = 0x71;
jbradshaw 0:e4a10ed6eb92 157 cmdArray[1] = (address >> 16) & 0xFF;
jbradshaw 0:e4a10ed6eb92 158 cmdArray[2] = (address >> 8) & 0xFF;
jbradshaw 0:e4a10ed6eb92 159 cmdArray[3] = (address >> 0) & 0xFF;
jbradshaw 0:e4a10ed6eb92 160 cmdArray[4] = data;
jbradshaw 0:e4a10ed6eb92 161 return reg_write_read_multiple_4Wire(cmdArray, 5, flashBuffer, 5);
jbradshaw 0:e4a10ed6eb92 162 }
jbradshaw 0:e4a10ed6eb92 163
jbradshaw 0:e4a10ed6eb92 164 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 165 int8_t S25FS512::writeRegisters(void) {
jbradshaw 0:e4a10ed6eb92 166 uint8_t cmdArray[3];
jbradshaw 0:e4a10ed6eb92 167 wait_1mS();
jbradshaw 0:e4a10ed6eb92 168 cmdArray[0] = 0x01;
jbradshaw 0:e4a10ed6eb92 169 cmdArray[1] = 0x00;
jbradshaw 0:e4a10ed6eb92 170 cmdArray[2] = 0x02; // set Quad to 1
jbradshaw 0:e4a10ed6eb92 171 reg_write_read_multiple_quad(cmdArray, 3, flashBuffer, 0);
jbradshaw 0:e4a10ed6eb92 172 return 0;
jbradshaw 0:e4a10ed6eb92 173 }
jbradshaw 0:e4a10ed6eb92 174
jbradshaw 0:e4a10ed6eb92 175 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 176 int8_t S25FS512::readAnyRegister(uint32_t address, uint8_t *data,
jbradshaw 0:e4a10ed6eb92 177 uint32_t length) {
jbradshaw 0:e4a10ed6eb92 178 uint8_t cmdArray[4];
jbradshaw 0:e4a10ed6eb92 179 cmdArray[0] = 0x65;
jbradshaw 0:e4a10ed6eb92 180 cmdArray[1] = (address >> 16) & 0xFF;
jbradshaw 0:e4a10ed6eb92 181 cmdArray[2] = (address >> 8) & 0xFF;
jbradshaw 0:e4a10ed6eb92 182 cmdArray[3] = (address >> 0) & 0xFF;
jbradshaw 0:e4a10ed6eb92 183 return reg_write_read_multiple_quad(cmdArray, 4, data, length);
jbradshaw 0:e4a10ed6eb92 184 }
jbradshaw 0:e4a10ed6eb92 185
jbradshaw 0:e4a10ed6eb92 186 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 187 int8_t S25FS512::bulkErase(void) {
jbradshaw 0:e4a10ed6eb92 188 uint8_t cmdArray[1];
jbradshaw 0:e4a10ed6eb92 189 cmdArray[0] = 0x60;
jbradshaw 0:e4a10ed6eb92 190 return reg_write_read_multiple_quad(cmdArray, 1, flashBuffer, 0);
jbradshaw 0:e4a10ed6eb92 191 }
jbradshaw 0:e4a10ed6eb92 192
jbradshaw 0:e4a10ed6eb92 193 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 194 int8_t S25FS512::pageProgram(uint32_t address, uint8_t *buffer) {
jbradshaw 0:e4a10ed6eb92 195 uint32_t i;
jbradshaw 0:e4a10ed6eb92 196 uint8_t cmdArray[5 + 256];
jbradshaw 0:e4a10ed6eb92 197 uint8_t *ptr;
jbradshaw 0:e4a10ed6eb92 198
jbradshaw 0:e4a10ed6eb92 199 // for (i = 0; i < 256; i++) {
jbradshaw 0:e4a10ed6eb92 200 // dataArray[i] = i;
jbradshaw 0:e4a10ed6eb92 201 //}
jbradshaw 0:e4a10ed6eb92 202 cmdArray[0] = 0x02; // 0x71;
jbradshaw 0:e4a10ed6eb92 203 // cmdArray[1] = (address >> 24) & 0xFF;
jbradshaw 0:e4a10ed6eb92 204 cmdArray[1] = (address >> 16) & 0xFF;
jbradshaw 0:e4a10ed6eb92 205 cmdArray[2] = (address >> 8) & 0xFF;
jbradshaw 0:e4a10ed6eb92 206 cmdArray[3] = (address >> 0) & 0xFF;
jbradshaw 0:e4a10ed6eb92 207 for (i = 0; i < 256; i++) {
jbradshaw 0:e4a10ed6eb92 208 cmdArray[4 + i] = buffer[i];
jbradshaw 0:e4a10ed6eb92 209 }
jbradshaw 0:e4a10ed6eb92 210 // reg_write_read_multiple_quad(cmdArray,256 + 4,flashBuffer,256 + 4);
jbradshaw 0:e4a10ed6eb92 211
jbradshaw 0:e4a10ed6eb92 212 ptr = cmdArray;
jbradshaw 0:e4a10ed6eb92 213 reg_write_read_multiple_quad_last(ptr, 4 + 64, flashBuffer, 0, 0);
jbradshaw 0:e4a10ed6eb92 214 wait_1mS();
jbradshaw 0:e4a10ed6eb92 215 ptr += (4 + 64);
jbradshaw 0:e4a10ed6eb92 216 reg_write_read_multiple_quad_last(ptr, 64, flashBuffer, 0, 0);
jbradshaw 0:e4a10ed6eb92 217 wait_1mS();
jbradshaw 0:e4a10ed6eb92 218 ptr += 64;
jbradshaw 0:e4a10ed6eb92 219 reg_write_read_multiple_quad_last(ptr, 64, flashBuffer, 0, 0);
jbradshaw 0:e4a10ed6eb92 220 wait_1mS();
jbradshaw 0:e4a10ed6eb92 221 ptr += 64;
jbradshaw 0:e4a10ed6eb92 222 reg_write_read_multiple_quad_last(ptr, 64, flashBuffer, 0, 1);
jbradshaw 0:e4a10ed6eb92 223 wait_1mS();
jbradshaw 0:e4a10ed6eb92 224 return 0;
jbradshaw 0:e4a10ed6eb92 225 }
jbradshaw 0:e4a10ed6eb92 226
jbradshaw 0:e4a10ed6eb92 227 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 228 int8_t S25FS512::quadIoRead_Pages(uint32_t address, uint8_t *buffer,
jbradshaw 0:e4a10ed6eb92 229 uint32_t numberOfPages) {
jbradshaw 0:e4a10ed6eb92 230 uint8_t cmdArray[5];
jbradshaw 0:e4a10ed6eb92 231 uint8_t *ptr;
jbradshaw 0:e4a10ed6eb92 232 uint8_t last;
jbradshaw 0:e4a10ed6eb92 233 uint32_t i;
jbradshaw 0:e4a10ed6eb92 234
jbradshaw 0:e4a10ed6eb92 235 cmdArray[0] = 0xEB;
jbradshaw 0:e4a10ed6eb92 236 cmdArray[1] = (address >> 16) & 0xFF;
jbradshaw 0:e4a10ed6eb92 237 cmdArray[2] = (address >> 8) & 0xFF;
jbradshaw 0:e4a10ed6eb92 238 cmdArray[3] = (address >> 0) & 0xFF;
jbradshaw 0:e4a10ed6eb92 239 ptr = buffer;
jbradshaw 0:e4a10ed6eb92 240 last = 0;
jbradshaw 0:e4a10ed6eb92 241 // only send the command
jbradshaw 0:e4a10ed6eb92 242 reg_write_read_multiple_quad_last(cmdArray, 4, ptr, 0, 0);
jbradshaw 0:e4a10ed6eb92 243 wait_1mS();
jbradshaw 0:e4a10ed6eb92 244 reg_write_read_multiple_quad_last(cmdArray, 0, ptr, 5, 0);
jbradshaw 0:e4a10ed6eb92 245 wait_1mS();
jbradshaw 0:e4a10ed6eb92 246 for (i = 0; i < numberOfPages; i++) {
jbradshaw 0:e4a10ed6eb92 247 reg_write_read_multiple_quad_last(cmdArray, 0, ptr, 64, 0);
jbradshaw 0:e4a10ed6eb92 248 wait_1mS();
jbradshaw 0:e4a10ed6eb92 249 ptr += 64;
jbradshaw 0:e4a10ed6eb92 250 reg_write_read_multiple_quad_last(cmdArray, 0, ptr, 64, 0);
jbradshaw 0:e4a10ed6eb92 251 wait_1mS();
jbradshaw 0:e4a10ed6eb92 252 ptr += 64;
jbradshaw 0:e4a10ed6eb92 253 reg_write_read_multiple_quad_last(cmdArray, 0, ptr, 64, 0);
jbradshaw 0:e4a10ed6eb92 254 wait_1mS();
jbradshaw 0:e4a10ed6eb92 255 ptr += 64;
jbradshaw 0:e4a10ed6eb92 256 // check if this is the last page
jbradshaw 0:e4a10ed6eb92 257 if ((i + 1) == numberOfPages) {
jbradshaw 0:e4a10ed6eb92 258 last = 1;
jbradshaw 0:e4a10ed6eb92 259 }
jbradshaw 0:e4a10ed6eb92 260 reg_write_read_multiple_quad_last(cmdArray, 0, ptr, 64, last);
jbradshaw 0:e4a10ed6eb92 261 wait_1mS();
jbradshaw 0:e4a10ed6eb92 262 ptr += 64;
jbradshaw 0:e4a10ed6eb92 263 }
jbradshaw 0:e4a10ed6eb92 264 return 0;
jbradshaw 0:e4a10ed6eb92 265 }
jbradshaw 0:e4a10ed6eb92 266
jbradshaw 0:e4a10ed6eb92 267 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 268 int8_t S25FS512::checkBusy(void) {
jbradshaw 0:e4a10ed6eb92 269 uint8_t cmdArray[5];
jbradshaw 0:e4a10ed6eb92 270 cmdArray[0] = 0x05;
jbradshaw 0:e4a10ed6eb92 271 reg_write_read_multiple_quad(cmdArray, 1, flashBuffer, 2);
jbradshaw 0:e4a10ed6eb92 272 return flashBuffer[1] & 0x1;
jbradshaw 0:e4a10ed6eb92 273 }
jbradshaw 0:e4a10ed6eb92 274
jbradshaw 0:e4a10ed6eb92 275 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 276 void S25FS512::waitTillNotBusy(void) {
jbradshaw 0:e4a10ed6eb92 277 while (checkBusy() == 1) {
jbradshaw 0:e4a10ed6eb92 278 }
jbradshaw 0:e4a10ed6eb92 279 }
jbradshaw 0:e4a10ed6eb92 280
jbradshaw 0:e4a10ed6eb92 281 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 282 int8_t S25FS512::sectorErase(uint32_t address) {
jbradshaw 0:e4a10ed6eb92 283 uint8_t cmdArray[5];
jbradshaw 0:e4a10ed6eb92 284 cmdArray[0] = 0xD8;
jbradshaw 0:e4a10ed6eb92 285 cmdArray[1] = (address >> 16) & 0xFF;
jbradshaw 0:e4a10ed6eb92 286 cmdArray[2] = (address >> 8) & 0xFF;
jbradshaw 0:e4a10ed6eb92 287 cmdArray[3] = (address >> 0) & 0xFF;
jbradshaw 0:e4a10ed6eb92 288 return reg_write_read_multiple_quad(cmdArray, 4, flashBuffer, 0);
jbradshaw 0:e4a10ed6eb92 289 }
jbradshaw 0:e4a10ed6eb92 290
jbradshaw 0:e4a10ed6eb92 291 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 292 int8_t S25FS512::parameterSectorErase(uint32_t address) {
jbradshaw 0:e4a10ed6eb92 293 uint8_t cmdArray[5];
jbradshaw 0:e4a10ed6eb92 294 cmdArray[0] = 0x20;
jbradshaw 0:e4a10ed6eb92 295 cmdArray[1] = (address >> 16) & 0xFF;
jbradshaw 0:e4a10ed6eb92 296 cmdArray[2] = (address >> 8) & 0xFF;
jbradshaw 0:e4a10ed6eb92 297 cmdArray[3] = (address >> 0) & 0xFF;
jbradshaw 0:e4a10ed6eb92 298 reg_write_read_multiple_quad(cmdArray, 4, flashBuffer, 0);
jbradshaw 0:e4a10ed6eb92 299 return 0;
jbradshaw 0:e4a10ed6eb92 300 }
jbradshaw 0:e4a10ed6eb92 301
jbradshaw 0:e4a10ed6eb92 302 #define ONE_MS (32768 / 500)
jbradshaw 0:e4a10ed6eb92 303 #define ONEHUNDRED_US (32768 / 1000)
jbradshaw 0:e4a10ed6eb92 304 #define TEM_MS (32768 / 50)
jbradshaw 0:e4a10ed6eb92 305
jbradshaw 0:e4a10ed6eb92 306 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 307 void S25FS512::wait_1mS(void) {
jbradshaw 0:e4a10ed6eb92 308 wait_ms(1);
jbradshaw 0:e4a10ed6eb92 309 }
jbradshaw 0:e4a10ed6eb92 310
jbradshaw 0:e4a10ed6eb92 311 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 312 void S25FS512::wait_100uS(void) {
jbradshaw 0:e4a10ed6eb92 313 wait_us(100);
jbradshaw 0:e4a10ed6eb92 314 }
jbradshaw 0:e4a10ed6eb92 315
jbradshaw 0:e4a10ed6eb92 316 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 317 void S25FS512::wait_10mS(void) {
jbradshaw 0:e4a10ed6eb92 318 wait_ms(10);
jbradshaw 0:e4a10ed6eb92 319 }
jbradshaw 0:e4a10ed6eb92 320
jbradshaw 0:e4a10ed6eb92 321 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 322 int8_t S25FS512::readIdentification(uint8_t *dataArray, uint8_t length) {
jbradshaw 0:e4a10ed6eb92 323 // 4QIOR = 0x9F
jbradshaw 0:e4a10ed6eb92 324 uint8_t cmdArray[1];
jbradshaw 0:e4a10ed6eb92 325 cmdArray[0] = 0x9F; // read ID command
jbradshaw 0:e4a10ed6eb92 326 return reg_write_read_multiple_quad(cmdArray, 1, dataArray, length);
jbradshaw 0:e4a10ed6eb92 327 }
jbradshaw 0:e4a10ed6eb92 328
jbradshaw 0:e4a10ed6eb92 329 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 330 uint8_t S25FS512::reset(void) {
jbradshaw 0:e4a10ed6eb92 331 uint8_t cmdArray[8];
jbradshaw 0:e4a10ed6eb92 332 wait_1mS();
jbradshaw 0:e4a10ed6eb92 333 cmdArray[0] = 0x66;
jbradshaw 0:e4a10ed6eb92 334 reg_write_read_multiple_quad(cmdArray, 1, flashBuffer, 0);
jbradshaw 0:e4a10ed6eb92 335 wait_1mS();
jbradshaw 0:e4a10ed6eb92 336 cmdArray[0] = 0x99;
jbradshaw 0:e4a10ed6eb92 337 reg_write_read_multiple_quad(cmdArray, 1, flashBuffer, 0);
jbradshaw 0:e4a10ed6eb92 338 return 0;
jbradshaw 0:e4a10ed6eb92 339 }
jbradshaw 0:e4a10ed6eb92 340
jbradshaw 0:e4a10ed6eb92 341 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 342 uint8_t S25FS512::enableHWReset(void) {
jbradshaw 0:e4a10ed6eb92 343 uint8_t data[8];
jbradshaw 0:e4a10ed6eb92 344 wait_1mS();
jbradshaw 0:e4a10ed6eb92 345 // CR2V Configuration Register-2 Volatile
jbradshaw 0:e4a10ed6eb92 346 // bit 5
jbradshaw 0:e4a10ed6eb92 347 readAnyRegister(0x00800003, data, 8);
jbradshaw 0:e4a10ed6eb92 348 writeAnyRegister(0x00800003, 0x64);
jbradshaw 0:e4a10ed6eb92 349 return 0;
jbradshaw 0:e4a10ed6eb92 350 }
jbradshaw 0:e4a10ed6eb92 351
jbradshaw 0:e4a10ed6eb92 352 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 353 uint8_t S25FS512::detect(void) {
jbradshaw 0:e4a10ed6eb92 354 uint8_t array[8];
jbradshaw 0:e4a10ed6eb92 355 uint8_t array2[8];
jbradshaw 0:e4a10ed6eb92 356
jbradshaw 0:e4a10ed6eb92 357 // Send WREN
jbradshaw 0:e4a10ed6eb92 358 wren();
jbradshaw 0:e4a10ed6eb92 359 // Send WREN
jbradshaw 0:e4a10ed6eb92 360 wren();
jbradshaw 0:e4a10ed6eb92 361 // delay
jbradshaw 0:e4a10ed6eb92 362 wait_1mS();
jbradshaw 0:e4a10ed6eb92 363 // Send WREN
jbradshaw 0:e4a10ed6eb92 364 wren();
jbradshaw 0:e4a10ed6eb92 365 // delay
jbradshaw 0:e4a10ed6eb92 366 wait_1mS();
jbradshaw 0:e4a10ed6eb92 367
jbradshaw 0:e4a10ed6eb92 368 // Send write any register cmd
jbradshaw 0:e4a10ed6eb92 369 writeAnyRegister(0x0003, 0x48);
jbradshaw 0:e4a10ed6eb92 370 // delay
jbradshaw 0:e4a10ed6eb92 371 wait_1mS();
jbradshaw 0:e4a10ed6eb92 372 array[0] = 0x9F; // read ID command
jbradshaw 0:e4a10ed6eb92 373 reg_write_read_multiple_quad(array, 1, array2, 7);
jbradshaw 0:e4a10ed6eb92 374 return 0;
jbradshaw 0:e4a10ed6eb92 375 }
jbradshaw 0:e4a10ed6eb92 376
jbradshaw 0:e4a10ed6eb92 377 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 378 int S25FS512::setQuadMode(void) {
jbradshaw 0:e4a10ed6eb92 379 wait_1mS();
jbradshaw 0:e4a10ed6eb92 380 wren4Wire();
jbradshaw 0:e4a10ed6eb92 381 wait_1mS();
jbradshaw 0:e4a10ed6eb92 382 writeAnyRegister4Wire(0x800002, 0x02); // set Quad = 1
jbradshaw 0:e4a10ed6eb92 383 wait_1mS();
jbradshaw 0:e4a10ed6eb92 384 wren4Wire();
jbradshaw 0:e4a10ed6eb92 385 wait_1mS();
jbradshaw 0:e4a10ed6eb92 386 writeAnyRegister4Wire(0x800003, 0x48); // set 8 latency, set QPI 4-4-4
jbradshaw 0:e4a10ed6eb92 387 }
jbradshaw 0:e4a10ed6eb92 388
jbradshaw 0:e4a10ed6eb92 389 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 390 uint32_t S25FS512::isPageEmpty(uint8_t *ptr) {
jbradshaw 0:e4a10ed6eb92 391 int i;
jbradshaw 0:e4a10ed6eb92 392 for (i = 0; i < 256; i++) {
jbradshaw 0:e4a10ed6eb92 393 if (ptr[i] != 0xFF)
jbradshaw 0:e4a10ed6eb92 394 return 0;
jbradshaw 0:e4a10ed6eb92 395 }
jbradshaw 0:e4a10ed6eb92 396 return 1;
jbradshaw 0:e4a10ed6eb92 397 }
jbradshaw 0:e4a10ed6eb92 398
jbradshaw 0:e4a10ed6eb92 399 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 400 int8_t S25FS512::parameterSectorErase_Helper(uint32_t address) {
jbradshaw 0:e4a10ed6eb92 401 waitTillNotBusy();
jbradshaw 0:e4a10ed6eb92 402 wait_100uS();
jbradshaw 0:e4a10ed6eb92 403 wren();
jbradshaw 0:e4a10ed6eb92 404 wait_100uS();
jbradshaw 0:e4a10ed6eb92 405 parameterSectorErase(address);
jbradshaw 0:e4a10ed6eb92 406 wait_100uS();
jbradshaw 0:e4a10ed6eb92 407 waitTillNotBusy();
jbradshaw 0:e4a10ed6eb92 408 wait_100uS();
jbradshaw 0:e4a10ed6eb92 409 return 0;
jbradshaw 0:e4a10ed6eb92 410 }
jbradshaw 0:e4a10ed6eb92 411
jbradshaw 0:e4a10ed6eb92 412 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 413 int8_t S25FS512::sectorErase_Helper(uint32_t address) {
jbradshaw 0:e4a10ed6eb92 414 waitTillNotBusy();
jbradshaw 0:e4a10ed6eb92 415 wait_100uS();
jbradshaw 0:e4a10ed6eb92 416 wren();
jbradshaw 0:e4a10ed6eb92 417 wait_100uS();
jbradshaw 0:e4a10ed6eb92 418 if (address < 0x8000) {
jbradshaw 0:e4a10ed6eb92 419 parameterSectorErase(address);
jbradshaw 0:e4a10ed6eb92 420 } else {
jbradshaw 0:e4a10ed6eb92 421 sectorErase(address);
jbradshaw 0:e4a10ed6eb92 422 }
jbradshaw 0:e4a10ed6eb92 423 wait_100uS();
jbradshaw 0:e4a10ed6eb92 424 waitTillNotBusy();
jbradshaw 0:e4a10ed6eb92 425 wait_100uS();
jbradshaw 0:e4a10ed6eb92 426 return 0;
jbradshaw 0:e4a10ed6eb92 427 }
jbradshaw 0:e4a10ed6eb92 428
jbradshaw 0:e4a10ed6eb92 429 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 430 int8_t S25FS512::bulkErase_Helper(void) {
jbradshaw 0:e4a10ed6eb92 431 waitTillNotBusy();
jbradshaw 0:e4a10ed6eb92 432 wait_100uS();
jbradshaw 0:e4a10ed6eb92 433 wren();
jbradshaw 0:e4a10ed6eb92 434 wait_100uS();
jbradshaw 0:e4a10ed6eb92 435 bulkErase();
jbradshaw 0:e4a10ed6eb92 436 wait_100uS();
jbradshaw 0:e4a10ed6eb92 437 waitTillNotBusy();
jbradshaw 0:e4a10ed6eb92 438 wait_100uS();
jbradshaw 0:e4a10ed6eb92 439 return 0;
jbradshaw 0:e4a10ed6eb92 440 }
jbradshaw 0:e4a10ed6eb92 441
jbradshaw 0:e4a10ed6eb92 442 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 443 // write a page worth of data (256 bytes) from buffer, offset defined where in
jbradshaw 0:e4a10ed6eb92 444 // the buffer to begin write
jbradshaw 0:e4a10ed6eb92 445 int8_t S25FS512::writePage_Helper(uint32_t pageNumber, uint8_t *buffer,
jbradshaw 0:e4a10ed6eb92 446 uint32_t offset) {
jbradshaw 0:e4a10ed6eb92 447 uint8_t *ptr;
jbradshaw 0:e4a10ed6eb92 448 waitTillNotBusy();
jbradshaw 0:e4a10ed6eb92 449 wait_1mS();
jbradshaw 0:e4a10ed6eb92 450 wren();
jbradshaw 0:e4a10ed6eb92 451 ptr = &buffer[offset];
jbradshaw 0:e4a10ed6eb92 452 wait_1mS();
jbradshaw 0:e4a10ed6eb92 453 pageProgram(pageNumber << 8, ptr);
jbradshaw 0:e4a10ed6eb92 454 wait_1mS();
jbradshaw 0:e4a10ed6eb92 455 return 0;
jbradshaw 0:e4a10ed6eb92 456 }
jbradshaw 0:e4a10ed6eb92 457
jbradshaw 0:e4a10ed6eb92 458 //******************************************************************************
jbradshaw 0:e4a10ed6eb92 459 // read pages from flash into buffer, offset defined where in the buffer use
jbradshaw 0:e4a10ed6eb92 460 int8_t S25FS512::readPages_Helper(uint32_t startPageNumber,
jbradshaw 0:e4a10ed6eb92 461 uint32_t endPageNumber, uint8_t *buffer,
jbradshaw 0:e4a10ed6eb92 462 uint32_t offset) {
jbradshaw 0:e4a10ed6eb92 463 uint8_t *ptr;
jbradshaw 0:e4a10ed6eb92 464 uint32_t page;
jbradshaw 0:e4a10ed6eb92 465 ptr = &buffer[offset];
jbradshaw 0:e4a10ed6eb92 466 for (page = startPageNumber; page <= endPageNumber; page++) {
jbradshaw 0:e4a10ed6eb92 467 wait_100uS();
jbradshaw 0:e4a10ed6eb92 468 quadIoRead_Pages((uint32_t)(page << 8), (uint8_t *)ptr, 1);
jbradshaw 0:e4a10ed6eb92 469 ptr += 0x100;
jbradshaw 0:e4a10ed6eb92 470 }
jbradshaw 0:e4a10ed6eb92 471 return 0;
jbradshaw 0:e4a10ed6eb92 472 }