Diff: W25X40BV.h

Revision:

4:b422cdc9d751

Parent:

3:6e3c0b23dc6e

Child:

6:11e271d4fbc5

--- a/W25X40BV.h	Mon Mar 26 04:30:32 2012 +0000
+++ b/W25X40BV.h	Sun Feb 28 15:22:40 2016 +0000
@@ -1,9 +1,11 @@
-// W25X40BV.h
+/** W25X40BV.h
+*/
 
 #ifndef W25X40BV_H
 #define W25X40BV_H
 
 #include "mbed.h"
+#include "SWSPI.h"
 
 #define SPI_FREQ        1000000
 #define SPI_MODE        0
@@ -14,11 +16,14 @@
 #define R_INST          0x03
 #define W_INST          0x02
 #define C_ERASE_INST    0x60
+#define P_ERASE_INST    0x81
+#define B4K_ERASE_INST  0x20
+#define B32K_ERASE_INST     0x52
 
 #define DUMMY_ADDR      0x00
 #define WAIT_TIME       1
 
-#define ADDR_BMASK2     0x00ff0000
+#define ADDR_BMASK2     0x001f0000
 #define ADDR_BMASK1     0x0000ff00
 #define ADDR_BMASK0     0x000000ff
 
@@ -26,28 +31,60 @@
 #define ADDR_BSHIFT1    8
 #define ADDR_BSHIFT0    0
 
-class W25X40BV: public SPI {
+/**
+W25X40BV
+*/
+class W25X40BV: public SWSPI {
 public:
     W25X40BV(PinName mosi, PinName miso, PinName sclk, PinName cs);
     
-    int readByte(int addr);                                 // takes a 24-bit (3 bytes) address and returns the data (1 byte) at that location
-    int readByte(int a2, int a1, int a0);                   // takes the address in 3 separate bytes A[23,16], A[15,8], A[7,0]
-    void readStream(int addr, char* buf, int count);        // takes a 24-bit address, reads count bytes, and stores results in buf
+    //! takes a 24-bit (3 bytes) address and returns the data (1 byte) at that location
+    uint32_t readByte(uint32_t addr);
+    //! takes the address in 3 separate bytes A[23,16], A[15,8], A[7,0]
+    uint32_t readByte(uint32_t a2, uint32_t a1,uint32_t a0);
+    //! takes a 24-bit address, reads count bytes, and stores results in buf
+    void readStream(uint32_t addr, uint8_t* buf, uint32_t count);
+
+    //! takes a 24-bit (3 bytes) address and a byte of data to write at that location
+    void writeByte(uint32_t addr, uint32_t data);
+    //! takes the address in 3 separate bytes A[23,16], A[15,8], A[7,0]
+    void writeByte(uint32_t a2, uint32_t a1, uint32_t a0, uint32_t data);
+    /** write count bytes of data from buf to memory, starting at addr
+    * addr is expected to be 256 byte alignment: 0x000000,0x000100,...,0x01FF00
+    * even if not, it works anyway. but should care count and 256byte edge: 
+    * if count=3 while addr=0x????FE, 3rd byte will be written in 0x????00
+    * @param addr 24 bit address
+    * @param buf data buffer
+    * @param count data count in byte
+    */
+    void writeStream(uint32_t addr, uint8_t* buf, uint32_t count);
     
-    void writeByte(int addr, int data);                     // takes a 24-bit (3 bytes) address and a byte of data to write at that location
-    void writeByte(int a2, int a1, int a0, int data);       // takes the address in 3 separate bytes A[23,16], A[15,8], A[7,0]
-    void writeStream(int addr, char* buf, int count);       // write count bytes of data from buf to memory, starting at addr  
+    //! erase a page data(256bytes) on chip
+    void pageErase(uint8_t page);
+
+    /** erase a block data(4Kbytes) on chip
+    * @param block block number 0x0000 - 0x001F
+    * block number will be left-shifted by 4 bits: 0x0000 - 0x01F0
+    * and a dummy address byte (0x00) will be added
+    */
+    void block4Erase(uint16_t block);
     
-    void chipErase();                                       // erase all data on chip
+    /** erase a block data(32Kbytes) on chip
+    * @param block number 0x00 - 0x03
+    * block number will be left-shifted by 3 bits: 0x00 - 0x18
+    * and two dummy address bytes (0x0000) will be added
+    */
+    void block32Erase(uint8_t block);
+    void chipErase();                                       //! erase all data on chip
     
 private:
-    void writeEnable();                                     // write enable
-    void writeDisable();                                    // write disable
-    void chipEnable();                                      // chip enable
-    void chipDisable();                                     // chip disable
+    void writeEnable();                                     //! write enable
+    void writeDisable();                                    //! write disable
+    void chipEnable();                                      //! chip enable
+    void chipDisable();                                     //! chip disable
     
-   // SPI _spi;
+   //! SPI _spi;
     DigitalOut _cs;
 };
 
-#endif
\ No newline at end of file
+#endif