libraries/AP_Logger/AP_Logger_W25NXX.cpp

   1 /*
   2   logging to a DataFlash block based storage device on SPI
   3 */
   4
   5
   6 #include <AP_HAL/AP_HAL.h>
   7
   8 #include "AP_Logger_W25NXX.h"
   9
  10 #if HAL_LOGGING_FLASH_W25NXX_ENABLED
  11
  12 #include <stdio.h>
  13
  14 extern const AP_HAL::HAL& hal;
  15
  16 #define JEDEC_WRITE_ENABLE           0x06
  17 #define JEDEC_WRITE_DISABLE          0x04
  18 #define JEDEC_READ_STATUS            0x05
  19 #define JEDEC_WRITE_STATUS           0x01
  20 #define JEDEC_READ_DATA              0x03
  21 #define JEDEC_PAGE_DATA_READ         0x13
  22 #define JEDEC_FAST_READ              0x0b
  23 #define JEDEC_DEVICE_ID              0x9F
  24 #define JEDEC_PAGE_WRITE             0x02
  25 #define JEDEC_PROGRAM_EXECUTE        0x10
  26
  27 #define JEDEC_DEVICE_RESET           0xFF
  28 #define JEDEC_BLOCK_ERASE            0xD8 // 128K erase
  29
  30 #define JEDEC_STATUS_BUSY            0x01
  31 #define JEDEC_STATUS_WRITEPROTECT    0x02
  32
  33 #define W25NXX_STATUS_REG           0xC0
  34 #define W25NXX_PROT_REG             0xA0
  35 #define W25NXX_CONF_REG             0xB0
  36 #define W25NXX_STATUS_EFAIL         0x04
  37 #define W25NXX_STATUS_PFAIL         0x08
  38
  39 #define W25NXX_PROT_SRP1_ENABLE          (1 << 0)
  40 #define W25NXX_PROT_WP_E_ENABLE          (1 << 1)
  41 #define W25NXX_PROT_TB_ENABLE            (1 << 2)
  42 #define W25NXX_PROT_PB0_ENABLE           (1 << 3)
  43 #define W25NXX_PROT_PB1_ENABLE           (1 << 4)
  44 #define W25NXX_PROT_PB2_ENABLE           (1 << 5)
  45 #define W25NXX_PROT_PB3_ENABLE           (1 << 6)
  46 #define W25NXX_PROT_SRP2_ENABLE          (1 << 7)
  47
  48 #define W25NXX_CONFIG_ECC_ENABLE         (1 << 4)
  49 #define W25NXX_CONFIG_BUFFER_READ_MODE   (1 << 3)
  50
  51 #define W25NXX_TIMEOUT_PAGE_READ_US        60   // tREmax = 60us (ECC enabled)
  52 #define W25NXX_TIMEOUT_PAGE_PROGRAM_US     700  // tPPmax = 700us
  53 #define W25NXX_TIMEOUT_BLOCK_ERASE_MS      10   // tBEmax = 10ms
  54 #define W25NXX_TIMEOUT_RESET_MS            500  // tRSTmax = 500ms
  55
  56 #define W25N01G_NUM_BLOCKS                  1024
  57 #define W25N02K_NUM_BLOCKS                  2048
  58
  59 #define JEDEC_ID_WINBOND_W25N01GV      0xEFAA21
  60 #define JEDEC_ID_WINBOND_W25N02KV      0xEFAA22
  61
  62 void AP_Logger_W25NXX::Init()
  63 {
  64     dev = hal.spi->get_device("dataflash");
  65     if (!dev) {
  66         AP_HAL::panic("PANIC: AP_Logger W25NXX device not found");
  67         return;
  68     }
  69
  70     dev_sem = dev->get_semaphore();
  71
  72     if (!getSectorCount()) {
  73         flash_died = true;
  74         return;
  75     }
  76
  77     flash_died = false;
  78
  79     // reset the device
  80     WaitReady();
  81     {
  82         WITH_SEMAPHORE(dev_sem);
  83         uint8_t b = JEDEC_DEVICE_RESET;
  84         dev->transfer(&b, 1, nullptr, 0);
  85     }
  86     hal.scheduler->delay(W25NXX_TIMEOUT_RESET_MS);
  87
  88     // disable write protection
  89     WriteStatusReg(W25NXX_PROT_REG, 0);
  90     // enable ECC and buffer mode
  91     WriteStatusReg(W25NXX_CONF_REG, W25NXX_CONFIG_ECC_ENABLE|W25NXX_CONFIG_BUFFER_READ_MODE);
  92
  93     printf("W25NXX status: SR-1=0x%x, SR-2=0x%x, SR-3=0x%x\n",
  94         ReadStatusRegBits(W25NXX_PROT_REG),
  95         ReadStatusRegBits(W25NXX_CONF_REG),
  96         ReadStatusRegBits(W25NXX_STATUS_REG));
  97
  98     AP_Logger_Block::Init();
  99 }
 100
 101 /*
 102   wait for busy flag to be cleared
 103  */
 104 void AP_Logger_W25NXX::WaitReady()
 105 {
 106     if (flash_died) {
 107         return;
 108     }
 109
 110     uint32_t t = AP_HAL::millis();
 111     while (Busy()) {
 112         hal.scheduler->delay_microseconds(100);
 113         if (AP_HAL::millis() - t > 5000) {
 114             printf("DataFlash: flash_died\n");
 115             flash_died = true;
 116             break;
 117         }
 118     }
 119 }
 120
 121 bool AP_Logger_W25NXX::getSectorCount(void)
 122 {
 123     WaitReady();
 124
 125     WITH_SEMAPHORE(dev_sem);
 126
 127     // Read manufacturer ID
 128     uint8_t cmd = JEDEC_DEVICE_ID;
 129     uint8_t buf[4]; // buffer not yet allocated
 130     dev->transfer(&cmd, 1, buf, 4);
 131
 132     uint32_t id = buf[1] << 16 | buf[2] << 8 | buf[3];
 133
 134     switch (id) {
 135     case JEDEC_ID_WINBOND_W25N01GV:
 136         df_PageSize = 2048;
 137         df_PagePerBlock = 64;
 138         df_PagePerSector = 64; // make sectors equivalent to block
 139         flash_blockNum = W25N01G_NUM_BLOCKS;
 140         break;
 141     case JEDEC_ID_WINBOND_W25N02KV:
 142         df_PageSize = 2048;
 143         df_PagePerBlock = 64;
 144         df_PagePerSector = 64; // make sectors equivalent to block
 145         flash_blockNum = W25N02K_NUM_BLOCKS;
 146         break;
 147
 148     default:
 149         hal.scheduler->delay(2000);
 150         printf("Unknown SPI Flash 0x%08x\n", id);
 151         return false;
 152     }
 153
 154     df_NumPages = flash_blockNum * df_PagePerBlock;
 155
 156     printf("SPI Flash 0x%08x found pages=%u\n", id, df_NumPages);
 157     return true;
 158 }
 159
 160 // Read the status register bits
 161 uint8_t AP_Logger_W25NXX::ReadStatusRegBits(uint8_t bits)
 162 {
 163     WITH_SEMAPHORE(dev_sem);
 164     uint8_t cmd[2] { JEDEC_READ_STATUS, bits };
 165     uint8_t status;
 166     dev->transfer(cmd, 2, &status, 1);
 167     return status;
 168 }
 169
 170 void AP_Logger_W25NXX::WriteStatusReg(uint8_t reg, uint8_t bits)
 171 {
 172     WaitReady();
 173     WITH_SEMAPHORE(dev_sem);
 174     uint8_t cmd[3] = {JEDEC_WRITE_STATUS, reg, bits};
 175     dev->transfer(cmd, 3, nullptr, 0);
 176 }
 177
 178 bool AP_Logger_W25NXX::Busy()
 179 {
 180     uint8_t status = ReadStatusRegBits(W25NXX_STATUS_REG);
 181
 182     if ((status & W25NXX_STATUS_PFAIL) != 0) {
 183         printf("Program failure!\n");
 184     }
 185     if ((status & W25NXX_STATUS_EFAIL) != 0) {
 186         printf("Erase failure!\n");
 187     }
 188
 189     return (status & JEDEC_STATUS_BUSY) != 0;
 190 }
 191
 192 /*
 193   send a command with an address
 194 */
 195 void AP_Logger_W25NXX::send_command_addr(uint8_t command, uint32_t PageAdr)
 196 {
 197     uint8_t cmd[4];
 198     cmd[0] = command;
 199     cmd[1] = (PageAdr >>  16) & 0xff;
 200     cmd[2] = (PageAdr >>  8) & 0xff;
 201     cmd[3] = (PageAdr >>  0) & 0xff;
 202
 203     dev->transfer(cmd, 4, nullptr, 0);
 204 }
 205
 206 void AP_Logger_W25NXX::PageToBuffer(uint32_t pageNum)
 207 {
 208     if (pageNum == 0 || pageNum > df_NumPages+1) {
 209         printf("Invalid page read %u\n", pageNum);
 210         memset(buffer, 0xFF, df_PageSize);
 211         df_Read_PageAdr = pageNum;
 212         return;
 213     }
 214
 215     // we already just read this page
 216     if (pageNum == df_Read_PageAdr && read_cache_valid) {
 217         return;
 218     }
 219
 220     df_Read_PageAdr = pageNum;
 221
 222     WaitReady();
 223
 224     uint32_t PageAdr = (pageNum-1);
 225
 226     {
 227         WITH_SEMAPHORE(dev_sem);
 228         // read page into internal buffer
 229         send_command_addr(JEDEC_PAGE_DATA_READ, PageAdr);
 230     }
 231
 232     // read from internal buffer into our buffer
 233     WaitReady();
 234     {
 235         WITH_SEMAPHORE(dev_sem);
 236         dev->set_chip_select(true);
 237         uint8_t cmd[4];
 238         cmd[0] = JEDEC_READ_DATA;
 239         cmd[1] = (0 >>  8) & 0xff; // column address zero
 240         cmd[2] = (0 >>  0) & 0xff; // column address zero
 241         cmd[3] = 0; // dummy
 242         dev->transfer(cmd, 4, nullptr, 0);
 243         dev->transfer(nullptr, 0, buffer, df_PageSize);
 244         dev->set_chip_select(false);
 245
 246         read_cache_valid = true;
 247     }
 248 }
 249
 250 void AP_Logger_W25NXX::BufferToPage(uint32_t pageNum)
 251 {
 252     if (pageNum == 0 || pageNum > df_NumPages+1) {
 253         printf("Invalid page write %u\n", pageNum);
 254         return;
 255     }
 256
 257     // just wrote the cached page
 258     if (pageNum != df_Read_PageAdr) {
 259         read_cache_valid = false;
 260     }
 261
 262     WriteEnable();
 263
 264     uint32_t PageAdr = (pageNum-1);
 265     {
 266         WITH_SEMAPHORE(dev_sem);
 267
 268         // write our buffer into internal buffer
 269         dev->set_chip_select(true);
 270
 271         uint8_t cmd[3];
 272         cmd[0] = JEDEC_PAGE_WRITE;
 273         cmd[1] = (0 >>  8) & 0xff; // column address zero
 274         cmd[2] = (0 >>  0) & 0xff; // column address zero
 275
 276         dev->transfer(cmd, 3, nullptr, 0);
 277         dev->transfer(buffer, df_PageSize, nullptr, 0);
 278         dev->set_chip_select(false);
 279     }
 280
 281     // write from internal buffer into page
 282     {
 283         WITH_SEMAPHORE(dev_sem);
 284         send_command_addr(JEDEC_PROGRAM_EXECUTE, PageAdr);
 285     }
 286 }
 287
 288 /*
 289   erase one sector (sizes varies with hw)
 290 */
 291 void AP_Logger_W25NXX::SectorErase(uint32_t blockNum)
 292 {
 293     WriteEnable();
 294     WITH_SEMAPHORE(dev_sem);
 295
 296     uint32_t PageAdr = blockNum  * df_PagePerBlock;
 297     send_command_addr(JEDEC_BLOCK_ERASE, PageAdr);
 298 }
 299
 300 /*
 301   erase one 4k sector
 302 */
 303 void AP_Logger_W25NXX::Sector4kErase(uint32_t sectorNum)
 304 {
 305     SectorErase(sectorNum);
 306 }
 307
 308 void AP_Logger_W25NXX::StartErase()
 309 {
 310     WriteEnable();
 311
 312     WITH_SEMAPHORE(dev_sem);
 313
 314     // just erase the first block, others will follow in InErase
 315     send_command_addr(JEDEC_BLOCK_ERASE, 0);
 316
 317     erase_block = 1;
 318     erase_start_ms = AP_HAL::millis();
 319     printf("Dataflash: erase started\n");
 320 }
 321
 322 bool AP_Logger_W25NXX::InErase()
 323 {
 324     if (erase_start_ms && !Busy()) {
 325         if (erase_block < flash_blockNum) {
 326             SectorErase(erase_block++);
 327         } else {
 328             printf("Dataflash: erase done (%u ms)\n", AP_HAL::millis() - erase_start_ms);
 329             erase_start_ms = 0;
 330             erase_block = 0;
 331         }
 332     }
 333     return erase_start_ms != 0;
 334 }
 335
 336 void AP_Logger_W25NXX::WriteEnable(void)
 337 {
 338     WaitReady();
 339     WITH_SEMAPHORE(dev_sem);
 340     uint8_t b = JEDEC_WRITE_ENABLE;
 341     dev->transfer(&b, 1, nullptr, 0);
 342 }
 343
 344 #endif // HAL_LOGGING_FLASH_W25NXX_ENABLED