Darien Figueroa / Mbed 2 deprecated repo3

repo time

Dependencies:   mbed MAX14720 MAX30205 USBDevice

e4a10ed6eb92/HSP/Devices/S25FS256/S25FS512.h@20:6d2af70c92ab, 2021-04-06 (annotated)

Committer:
darienf
Date:
Tue Apr 06 06:41:40 2021 +0000
Revision:
20:6d2af70c92ab
another repo

Who changed what in which revision?

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