Maxim Integrated / MAX30001EVSYSKIT

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

HSP/Devices/S25FS256/S25FS512.h@1:957e5bad16c2, 2018-06-27 (annotated)

Committer:
Emre.Eken
Date:
Wed Jun 27 14:17:34 2018 +0300
Revision:
1:957e5bad16c2
first rev

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Emre.Eken 1:957e5bad16c2 1 /*******************************************************************************
Emre.Eken 1:957e5bad16c2 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
Emre.Eken 1:957e5bad16c2 3 *
Emre.Eken 1:957e5bad16c2 4 * Permission is hereby granted, free of charge, to any person obtaining a
Emre.Eken 1:957e5bad16c2 5 * copy of this software and associated documentation files (the "Software"),
Emre.Eken 1:957e5bad16c2 6 * to deal in the Software without restriction, including without limitation
Emre.Eken 1:957e5bad16c2 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
Emre.Eken 1:957e5bad16c2 8 * and/or sell copies of the Software, and to permit persons to whom the
Emre.Eken 1:957e5bad16c2 9 * Software is furnished to do so, subject to the following conditions:
Emre.Eken 1:957e5bad16c2 10 *
Emre.Eken 1:957e5bad16c2 11 * The above copyright notice and this permission notice shall be included
Emre.Eken 1:957e5bad16c2 12 * in all copies or substantial portions of the Software.
Emre.Eken 1:957e5bad16c2 13 *
Emre.Eken 1:957e5bad16c2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Emre.Eken 1:957e5bad16c2 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Emre.Eken 1:957e5bad16c2 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Emre.Eken 1:957e5bad16c2 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
Emre.Eken 1:957e5bad16c2 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Emre.Eken 1:957e5bad16c2 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Emre.Eken 1:957e5bad16c2 20 * OTHER DEALINGS IN THE SOFTWARE.
Emre.Eken 1:957e5bad16c2 21 *
Emre.Eken 1:957e5bad16c2 22 * Except as contained in this notice, the name of Maxim Integrated
Emre.Eken 1:957e5bad16c2 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
Emre.Eken 1:957e5bad16c2 24 * Products, Inc. Branding Policy.
Emre.Eken 1:957e5bad16c2 25 *
Emre.Eken 1:957e5bad16c2 26 * The mere transfer of this software does not imply any licenses
Emre.Eken 1:957e5bad16c2 27 * of trade secrets, proprietary technology, copyrights, patents,
Emre.Eken 1:957e5bad16c2 28 * trademarks, maskwork rights, or any other form of intellectual
Emre.Eken 1:957e5bad16c2 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
Emre.Eken 1:957e5bad16c2 30 * ownership rights.
Emre.Eken 1:957e5bad16c2 31 *******************************************************************************
Emre.Eken 1:957e5bad16c2 32 */
Emre.Eken 1:957e5bad16c2 33 #ifndef S25FS512_H_
Emre.Eken 1:957e5bad16c2 34 #define S25FS512_H_
Emre.Eken 1:957e5bad16c2 35
Emre.Eken 1:957e5bad16c2 36 #include "mbed.h"
Emre.Eken 1:957e5bad16c2 37 #include "QuadSpiInterface.h"
Emre.Eken 1:957e5bad16c2 38
Emre.Eken 1:957e5bad16c2 39 class S25FS512 {
Emre.Eken 1:957e5bad16c2 40 public:
Emre.Eken 1:957e5bad16c2 41 S25FS512(QuadSpiInterface *_quadSpiInterface);
Emre.Eken 1:957e5bad16c2 42 ~S25FS512(void);
Emre.Eken 1:957e5bad16c2 43
Emre.Eken 1:957e5bad16c2 44 QuadSpiInterface *quadSpiInterface;
Emre.Eken 1:957e5bad16c2 45
Emre.Eken 1:957e5bad16c2 46 /** Initialize the driver
Emre.Eken 1:957e5bad16c2 47 */
Emre.Eken 1:957e5bad16c2 48 int init(void);
Emre.Eken 1:957e5bad16c2 49
Emre.Eken 1:957e5bad16c2 50 /** Detect the presence of the flash device
Emre.Eken 1:957e5bad16c2 51 */
Emre.Eken 1:957e5bad16c2 52 uint8_t detect(void);
Emre.Eken 1:957e5bad16c2 53
Emre.Eken 1:957e5bad16c2 54 /** Read the identification of the flash
Emre.Eken 1:957e5bad16c2 55 */
Emre.Eken 1:957e5bad16c2 56 int8_t readIdentification(uint8_t *dataArray, uint8_t length);
Emre.Eken 1:957e5bad16c2 57
Emre.Eken 1:957e5bad16c2 58 /** Bulk erase the flash device
Emre.Eken 1:957e5bad16c2 59 */
Emre.Eken 1:957e5bad16c2 60 int8_t bulkErase_Helper(void);
Emre.Eken 1:957e5bad16c2 61
Emre.Eken 1:957e5bad16c2 62 /** Erase Parameter Sectors
Emre.Eken 1:957e5bad16c2 63 */
Emre.Eken 1:957e5bad16c2 64 int8_t parameterSectorErase_Helper(uint32_t address);
Emre.Eken 1:957e5bad16c2 65
Emre.Eken 1:957e5bad16c2 66 /** Write a Page
Emre.Eken 1:957e5bad16c2 67 */
Emre.Eken 1:957e5bad16c2 68 int8_t writePage_Helper(uint32_t pageNumber, uint8_t *buffer,
Emre.Eken 1:957e5bad16c2 69 uint32_t offset);
Emre.Eken 1:957e5bad16c2 70
Emre.Eken 1:957e5bad16c2 71 /** Read a Page
Emre.Eken 1:957e5bad16c2 72 * @param
Emre.Eken 1:957e5bad16c2 73 */
Emre.Eken 1:957e5bad16c2 74 int8_t readPages_Helper(uint32_t startPageNumber, uint32_t endPageNumber,
Emre.Eken 1:957e5bad16c2 75 uint8_t *buffer, uint32_t offset);
Emre.Eken 1:957e5bad16c2 76
Emre.Eken 1:957e5bad16c2 77 /** Erase a Sector
Emre.Eken 1:957e5bad16c2 78 @param address Address of sector to erase
Emre.Eken 1:957e5bad16c2 79 */
Emre.Eken 1:957e5bad16c2 80
Emre.Eken 1:957e5bad16c2 81 int8_t sectorErase_Helper(uint32_t address);
Emre.Eken 1:957e5bad16c2 82 /** Scans through byte pointer for a page worth of data to see if the page is all FFs
Emre.Eken 1:957e5bad16c2 83 @param ptr Byte pointer to buffer to scan
Emre.Eken 1:957e5bad16c2 84 @return Returns a 1 if the page is empty, 0 if it is not all FFs
Emre.Eken 1:957e5bad16c2 85 */
Emre.Eken 1:957e5bad16c2 86 uint32_t isPageEmpty(uint8_t *ptr);
Emre.Eken 1:957e5bad16c2 87
Emre.Eken 1:957e5bad16c2 88 /** Issue a software reset to the flash device
Emre.Eken 1:957e5bad16c2 89 */
Emre.Eken 1:957e5bad16c2 90
Emre.Eken 1:957e5bad16c2 91 uint8_t reset(void);
Emre.Eken 1:957e5bad16c2 92 /** Enable a hardware reset
Emre.Eken 1:957e5bad16c2 93 */
Emre.Eken 1:957e5bad16c2 94
Emre.Eken 1:957e5bad16c2 95 uint8_t enableHWReset(void);
Emre.Eken 1:957e5bad16c2 96 /** Read the id byte of this device
Emre.Eken 1:957e5bad16c2 97 */
Emre.Eken 1:957e5bad16c2 98
Emre.Eken 1:957e5bad16c2 99 void readID(uint8_t *id);
Emre.Eken 1:957e5bad16c2 100
Emre.Eken 1:957e5bad16c2 101 private:
Emre.Eken 1:957e5bad16c2 102 int8_t reg_write_read_multiple_quad_last(uint8_t *dataIn, uint8_t numberIn, uint8_t *dataOut, uint8_t numberOut, uint8_t last);
Emre.Eken 1:957e5bad16c2 103 int8_t reg_write_read_multiple_quad(uint8_t *dataIn, uint8_t numberIn, uint8_t *dataOut, uint8_t numberOut);
Emre.Eken 1:957e5bad16c2 104 int8_t reg_write_read_multiple_4Wire(uint8_t *bufferOut, uint8_t numberOut, uint8_t *bufferIn, uint8_t numberIn);
Emre.Eken 1:957e5bad16c2 105 uint8_t spiWriteRead (uint8_t writeNumber,uint8_t *writeData, uint8_t readNumber, uint8_t *readData);
Emre.Eken 1:957e5bad16c2 106 uint8_t spiWriteRead4Wire(uint8_t writeNumber,uint8_t *writeData, uint8_t readNumber, uint8_t *readData);
Emre.Eken 1:957e5bad16c2 107
Emre.Eken 1:957e5bad16c2 108 int8_t writeAnyRegister(uint32_t address, uint8_t data);
Emre.Eken 1:957e5bad16c2 109 int8_t writeAnyRegister4Wire(uint32_t address, uint8_t data);
Emre.Eken 1:957e5bad16c2 110 int8_t writeRegisters(void);
Emre.Eken 1:957e5bad16c2 111 uint8_t wren(void);
Emre.Eken 1:957e5bad16c2 112 int setQuadMode(void);
Emre.Eken 1:957e5bad16c2 113 int wren4Wire(void);
Emre.Eken 1:957e5bad16c2 114 // int8_t setQuadMode();
Emre.Eken 1:957e5bad16c2 115 int8_t readAnyRegister(uint32_t address, uint8_t *data, uint32_t length);
Emre.Eken 1:957e5bad16c2 116 int8_t bulkErase(void);
Emre.Eken 1:957e5bad16c2 117 int8_t pageProgram(uint32_t address, uint8_t *buffer);
Emre.Eken 1:957e5bad16c2 118 int8_t quadIoRead_Pages(uint32_t address, uint8_t *buffer, uint32_t numberOfPages);
Emre.Eken 1:957e5bad16c2 119 int8_t checkBusy(void);
Emre.Eken 1:957e5bad16c2 120 void waitTillNotBusy(void);
Emre.Eken 1:957e5bad16c2 121 int8_t sectorErase(uint32_t address);
Emre.Eken 1:957e5bad16c2 122 int8_t parameterSectorErase(uint32_t address);
Emre.Eken 1:957e5bad16c2 123 void wait_1mS(void);
Emre.Eken 1:957e5bad16c2 124 void wait_100uS(void);
Emre.Eken 1:957e5bad16c2 125 void wait_10mS(void);
Emre.Eken 1:957e5bad16c2 126 };
Emre.Eken 1:957e5bad16c2 127 #endif /* S25FS512_H_ */
Emre.Eken 1:957e5bad16c2 128