bertos/drv/dataflash.c

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
  30  * -->
  31  *
  32  * \brief Function library for dataflash AT45DB family (implementation).
  33  *
  34  * \version $Id: dataflash.c 21658 2008-06-05 16:42:54Z asterix $
  35  * \author Daniele Basile <asterix@develer.com>
  36  * \author Francesco Sacchi <batt@develer.com>
  37  */
  38
  39 #include "dataflash.h"
  40
  41 #include "cfg/cfg_dataflash.h"
  42 #include <cfg/macros.h>
  43 #include <cfg/debug.h>
  44 #include <cfg/module.h>
  45
  46 // Define logging setting (for cfg/log.h module).
  47 #define LOG_LEVEL   DATAFLASH_LOG_LEVEL
  48 #define LOG_FORMAT  DATAFLASH_LOG_FORMAT
  49 #include <cfg/log.h>
  50
  51 #include <drv/timer.h>
  52
  53 #include <fs/battfs.h>
  54
  55 #include <kern/kfile.h>
  56
  57 #include <cpu/power.h> /* cpu_relax() */
  58
  59 #include <string.h>
  60
  61 /**
  62  * Array used to describe dataflash memory devices currently supported.
  63  */
  64 static const DataflashInfo mem_info[] =
  65 {
  66         {
  67                 /* AT45DB041B */
  68                 .density_id = 0x07,
  69                 .page_size = 264,
  70                 .page_bits = 9,
  71                 .page_cnt = 2048,
  72                 .read_cmd = DFO_READ_FLASH_MEM_BYTE_B,
  73         },
  74         {
  75                 /* AT45DB081D */
  76                 .density_id = 0x09,
  77                 .page_size = 264,
  78                 .page_bits = 9,
  79                 .page_cnt = 4096,
  80                 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
  81         },
  82         {
  83                 /* AT45DB161D */
  84                 .density_id = 0x0B,
  85                 .page_size = 528,
  86                 .page_bits = 10,
  87                 .page_cnt = 4096,
  88                 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
  89         },
  90         {
  91                 /* AT45DB642D */
  92                 .density_id = 0x0F,
  93                 .page_size = 1056,
  94                 .page_bits = 11,
  95                 .page_cnt = 8192,
  96                 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
  97         },
  98         /* Add other memories here */
  99 };
 100
 101 STATIC_ASSERT(countof(mem_info) == DFT_CNT);
 102
 103 /**
 104  * Macro that toggle CS of dataflash.
 105  * \note This is equivalent to fd->setCS(false) immediately followed by fd->setCS(true).
 106  */
 107 INLINE void CS_TOGGLE(DataFlash *fd)
 108 {
 109         fd->setCS(false);
 110         fd->setCS(true);
 111 }
 112
 113 /**
 114  * Send a generic command to dataflash memory.
 115  * This function send only 4 byte: opcode, page address and
 116  * byte address.
 117  */
 118 static void send_cmd(DataFlash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, DataFlashOpcode opcode)
 119 {
 120
 121         /*
 122          * Make sure to toggle CS signal in order,
 123          * and reset dataflash command decoder.
 124          */
 125         CS_TOGGLE(fd);
 126
 127
 128         /*
 129          * To send one command to data flash memory, we send 4 byte.
 130          * First byte is opcode command, second and third byte are
 131          * page address, in last byte we write a byte page address.
 132          * (see datasheet for more detail).
 133          *
 134          * \note Generally a default memory page size is more than 256 byte.
 135          *  In this case we need for addressing a byte in one page more than
 136          *  8 bit, so we put in fourth byte low part of address byte, and
 137          *  hight part of address byte in third byte togheter low par of page
 138          *  address.
 139          *
 140          */
 141
 142         /*
 143          * Send opcode.
 144          */
 145         kfile_putc(opcode, fd->channel);
 146
 147         /*
 148          *  Send page address.
 149          */
 150         kfile_putc((uint8_t)(page_addr >> (16 - mem_info[fd->dev].page_bits)), fd->channel);
 151         kfile_putc((uint8_t)((page_addr << (mem_info[fd->dev].page_bits - 8)) + (byte_addr >> 8)), fd->channel);
 152
 153         /*
 154          * Send byte page address.
 155          */
 156         kfile_putc((uint8_t)byte_addr, fd->channel);
 157 }
 158
 159 /**
 160  * Reset dataflash memory function.
 161  *
 162  * If \a fd->setReset function is not NULL,
 163  * this function resets data flash memory
 164  * with one pulse reset long about 10usec.
 165  *
 166  */
 167 static void dataflash_reset(DataFlash *fd)
 168 {
 169         fd->setCS(false);
 170
 171         if (fd->setReset)
 172         {
 173                 fd->setReset(true);
 174                 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
 175                 fd->setReset(false);
 176                 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
 177         }
 178 }
 179
 180
 181 /**
 182  * Read status register of dataflah memory.
 183  */
 184 static uint8_t dataflash_stat(DataFlash *fd)
 185 {
 186         /*
 187          * Make sure to toggle CS signal
 188          * and reset dataflash command decoder.
 189          */
 190         CS_TOGGLE(fd);
 191         kfile_putc(DFO_READ_STATUS, fd->channel);
 192         return kfile_getc(fd->channel);
 193 }
 194
 195
 196 /**
 197  * Send one command to data flash memory, and
 198  * return status register value.
 199  *
 200  */
 201 static uint8_t dataflash_cmd(DataFlash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, DataFlashOpcode opcode)
 202 {
 203         uint8_t stat;
 204
 205         send_cmd(fd, page_addr, byte_addr, opcode);
 206
 207         CS_TOGGLE(fd);
 208
 209         /*
 210          * We chech data flash memory state, and wait until busy-flag
 211          * is high.
 212          */
 213         while (!(dataflash_stat(fd) & BUSY_BIT))
 214                 cpu_relax();
 215
 216         stat = dataflash_stat(fd);
 217
 218         kfile_flush(fd->channel); // Flush channel
 219         /*
 220          * Data flash has completed a bus cycle, so disable CS.
 221          */
 222         fd->setCS(false);
 223
 224         return stat;
 225 }
 226
 227 /**
 228  * Read \a len bytes from main data flash memory or buffer data
 229  * flash memory, and put it in \a *block.
 230  */
 231 static void dataflash_readBlock(DataFlash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, uint8_t *block, dataflash_size_t len)
 232 {
 233         DataFlashOpcode opcode = mem_info[fd->dev].read_cmd;
 234         send_cmd(fd, page_addr, byte_addr, opcode);
 235
 236         if (opcode == DFO_READ_FLASH_MEM_BYTE_B)
 237         {
 238                 /*
 239                  * Send 24 don't care bits.
 240                  */
 241                 uint8_t dummy[] = { 0, 0, 0 };
 242                 kfile_write(fd->channel, dummy, sizeof(dummy));
 243         }
 244
 245         kfile_putc(0, fd->channel); //Send 8 don't care bit.
 246         kfile_read(fd->channel, block, len); //Read len bytes ad put in block buffer.
 247         kfile_flush(fd->channel); // Flush channel
 248         fd->setCS(false);
 249 }
 250
 251
 252 /**
 253  * Write \a len bytes in dataflash memory buffer.
 254  *
 255  * \note Is not possible to write directly in dataflash main memory.
 256  * To perform a write in main memory you must first write in dataflash buffer
 257  * memory and then send a command to write the page in main memory.
 258  */
 259 static void dataflash_writeBlock(DataFlash *fd, dataflash_offset_t offset, const uint8_t *block, dataflash_size_t len)
 260 {
 261         ASSERT(offset + len <= mem_info[fd->dev].page_size);
 262
 263         send_cmd(fd, 0x00, offset, DFO_WRITE_BUFF1);
 264
 265         kfile_write(fd->channel, block, len); //Write len bytes.
 266         kfile_flush(fd->channel); // Flush channel
 267
 268         fd->setCS(false);
 269 }
 270
 271
 272 /**
 273  * Load selected page from dataflash memory to buffer.
 274  */
 275 static void dataflash_loadPage(DataFlash *fd, dataflash_page_t page_addr)
 276 {
 277         dataflash_cmd(fd, page_addr, 0x00, DFO_MOV_MEM_TO_BUFF1);
 278 }
 279
 280 /* Battfs disk interface section */
 281
 282 static size_t dataflash_disk_page_read(struct BattFsSuper *d, pgcnt_t page, pgaddr_t addr, void *buf, size_t len)
 283 {
 284         DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
 285         dataflash_readBlock(fd, page, addr, buf, len);
 286         return len;
 287 }
 288
 289 static bool dataflash_disk_page_load(struct BattFsSuper *d, pgcnt_t page)
 290 {
 291         DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
 292         dataflash_loadPage(fd, page);
 293         return true;
 294 }
 295
 296 static size_t dataflash_disk_buffer_write(struct BattFsSuper *d, pgaddr_t addr, const void *buf, size_t len)
 297 {
 298         DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
 299         dataflash_writeBlock(fd, addr, buf, len);
 300         return true;
 301 }
 302
 303 static size_t dataflash_disk_buffer_read(struct BattFsSuper *d, pgaddr_t addr, void *buf, size_t len)
 304 {
 305         DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
 306         ASSERT(addr + len <= mem_info[fd->dev].page_size);
 307
 308         CS_TOGGLE(fd);
 309
 310         kfile_putc(DFO_READ_BUFF1, fd->channel);
 311
 312         uint32_t byte_addr = addr;
 313
 314         kfile_putc((byte_addr >> 16) & 0xff, fd->channel);
 315         kfile_putc((byte_addr >> 8) & 0xff, fd->channel);
 316         kfile_putc(byte_addr & 0xff, fd->channel);
 317
 318         /* Send additional don't care byte to start read operation */
 319         kfile_putc(0, fd->channel);
 320
 321         kfile_read(fd->channel, buf, len); //Read len bytes ad put in buffer.
 322         kfile_flush(fd->channel); // Flush channel
 323         fd->setCS(false);
 324         return len;
 325 }
 326
 327 static bool dataflash_disk_page_save(struct BattFsSuper *d, pgcnt_t page)
 328 {
 329         DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
 330         dataflash_cmd(fd, page, 0x00, DFO_WRITE_BUFF1_TO_MEM);
 331         return true;
 332 }
 333
 334 static bool dataflash_disk_page_erase(struct BattFsSuper *d, pgcnt_t page)
 335 {
 336         DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
 337         dataflash_cmd(fd, page, 0x00, DFO_ERASE_PAGE);
 338         return true;
 339 }
 340
 341 static int dataflash_close(struct KFile *_fd);
 342
 343 static bool dataflash_disk_close(struct BattFsSuper *d)
 344 {
 345         DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
 346         return dataflash_close(&fd->fd) == 0;
 347 }
 348
 349 bool dataflash_diskInit(struct BattFsSuper *d, DataFlash *fd, pgcnt_t *page_array)
 350 {
 351         ASSERT(d);
 352         ASSERT(fd);
 353         d->read = dataflash_disk_page_read;
 354         d->load = dataflash_disk_page_load;
 355         d->bufferWrite = dataflash_disk_buffer_write;
 356         d->bufferRead = dataflash_disk_buffer_read;
 357         d->save = dataflash_disk_page_save;
 358         d->erase = dataflash_disk_page_erase;
 359         d->close = dataflash_disk_close;
 360         d->disk_ctx = fd;
 361         d->page_size = mem_info[fd->dev].page_size;
 362         d->page_count = mem_info[fd->dev].page_cnt;
 363         ASSERT(page_array);
 364         d->page_array = page_array;
 365         return d->page_array && fd;
 366 }
 367
 368 /* Kfile interface section */
 369
 370 /**
 371  * Flush select page (stored in buffer) in data flash main memory page.
 372  */
 373 static int dataflash_flush(KFile *_fd)
 374 {
 375         DataFlash *fd = DATAFLASH_CAST(_fd);
 376         if (fd->page_dirty)
 377         {
 378                 dataflash_cmd(fd, fd->current_page, 0x00, DFO_WRITE_BUFF1_TO_MEM_E);
 379
 380                 fd->page_dirty = false;
 381
 382                 LOG_INFO("Flushing page {%ld}\n", fd->current_page);
 383         }
 384         return 0;
 385 }
 386
 387
 388 /**
 389  * Close file \a fd.
 390  */
 391 static int dataflash_close(struct KFile *_fd)
 392 {
 393         dataflash_flush(_fd);
 394         LOG_INFO("Close.\n");
 395         return 0;
 396 }
 397
 398 /**
 399  * Reopen dataflash file \a fd.
 400  */
 401 static KFile *dataflash_reopen(KFile *_fd)
 402 {
 403         DataFlash *fd = DATAFLASH_CAST(_fd);
 404         dataflash_close(_fd);
 405
 406         fd->current_page = 0;
 407         fd->fd.seek_pos = 0;
 408
 409         /* Load selected page from dataflash memory */
 410         dataflash_loadPage(fd, fd->current_page);
 411
 412         LOG_INFO("Reopen.\n");
 413         return &fd->fd;
 414 }
 415
 416
 417 /**
 418  * Read in \a buf \a size bytes from dataflash memmory.
 419  *
 420  * \note For reading data flash memory, we
 421  * check flag page_dirty, if is true (that mean
 422  * we have written a byte in buffer memory) we
 423  * flush current page in main memory and
 424  * then read from memory, else we read byte
 425  * directly from data flash main memory.
 426  *
 427  * \return the number of bytes read.
 428  */
 429 static size_t dataflash_read(struct KFile *_fd, void *buf, size_t size)
 430 {
 431         DataFlash *fd = DATAFLASH_CAST(_fd);
 432
 433         dataflash_offset_t byte_addr;
 434         dataflash_page_t page_addr;
 435         uint8_t *data = (uint8_t *)buf;
 436
 437
 438         ASSERT(fd->fd.seek_pos + (kfile_off_t)size <= fd->fd.size);
 439         size = MIN((kfile_off_t)size, fd->fd.size - fd->fd.seek_pos);
 440
 441         LOG_INFO("Reading at pos[%lu]\n", fd->fd.seek_pos);
 442
 443         /*
 444          * We select page and offest from absolute address.
 445          */
 446         page_addr = fd->fd.seek_pos / mem_info[fd->dev].page_size;
 447         byte_addr = fd->fd.seek_pos % mem_info[fd->dev].page_size;
 448
 449         LOG_INFO("[page-{%ld}, byte-{%ld}]\n", page_addr, byte_addr);
 450
 451         /*
 452          * Flush current page in main memory if
 453          * we had been written a byte in memory
 454          */
 455         dataflash_flush(&fd->fd);
 456
 457         /*
 458          * Read byte in main page data flash memory.
 459          */
 460         dataflash_readBlock(fd, page_addr, byte_addr, data, size);
 461
 462         fd->fd.seek_pos += size;
 463         LOG_INFO("Read %ld bytes\n", (long int)size);
 464
 465         return size;
 466 }
 467
 468 /**
 469  * Write \a _buf in dataflash memory
 470  *
 471  * \note For writing \a _buf in dataflash memory, we must
 472  * first write in buffer data flash memory. At the end of write,
 473  * we can put page in dataflash main memory.
 474  * If we write in two contiguous pages, we put in main memory current
 475  * page and then reload the page which we want to write.
 476  *
 477  * \return the number of bytes write.
 478  */
 479 static size_t dataflash_write(struct KFile *_fd, const void *_buf, size_t size)
 480 {
 481         DataFlash *fd = DATAFLASH_CAST(_fd);
 482
 483         dataflash_offset_t offset;
 484         dataflash_page_t new_page;
 485         size_t total_write = 0;
 486
 487         const uint8_t *data = (const uint8_t *) _buf;
 488
 489         ASSERT(fd->fd.seek_pos + (kfile_off_t)size <= fd->fd.size);
 490         size = MIN((kfile_off_t)size, fd->fd.size - fd->fd.seek_pos);
 491
 492         LOG_INFO("Writing at pos[%lu]\n", fd->fd.seek_pos);
 493
 494         while (size)
 495         {
 496                 /*
 497                 * We select page and offest from absolute address.
 498                 */
 499                 new_page = fd->fd.seek_pos / mem_info[fd->dev].page_size;
 500                 offset = fd->fd.seek_pos % mem_info[fd->dev].page_size;
 501
 502
 503                 size_t wr_len = MIN((dataflash_size_t)size, mem_info[fd->dev].page_size - offset);
 504
 505                 LOG_INFO("[page-{%ld}, byte-{%ld}]\n",new_page, offset);
 506
 507                 if (new_page != fd->current_page)
 508                 {
 509                         /* Flush current page in main memory*/
 510                         dataflash_flush(&fd->fd);
 511                         /* Load select page memory from data flash memory*/
 512                         dataflash_loadPage(fd, new_page);
 513
 514                         fd->current_page = new_page;
 515                         LOG_INFO(" >> Load page: {%ld}\n", new_page);
 516                 }
 517                 /*
 518                 * Write byte in current page, and set true
 519                 * page_dirty flag.
 520                 */
 521                 dataflash_writeBlock(fd, offset, data, wr_len);
 522                 fd->page_dirty = true;
 523
 524                 data += wr_len;
 525                 fd->fd.seek_pos += wr_len;
 526                 size -= wr_len;
 527                 total_write += wr_len;
 528         }
 529
 530         LOG_INFO("written %lu bytes\n", (long unsigned)total_write);
 531         return total_write;
 532 }
 533
 534 MOD_DEFINE(dataflash);
 535
 536 /**
 537  * Dataflash init function.
 538  * This function initialize \a fd with SPI channel \a ch and test if data flash memory
 539  * density is the same specified by device \a dev.
 540  * \a setCS is a callback used to set/reset CS line.
 541  * \a setReset is a callback used to set/reset the dataflash (can be NULL if reset is unconnected)
 542  * \return true if ok, false if memory density read from dataflash is not compliant with the
 543  * configured one.
 544  */
 545 bool dataflash_init(DataFlash *fd, KFile *ch, DataflashType dev, dataflash_setCS_t *setCS, dataflash_setReset_t *setReset)
 546 {
 547         uint8_t stat;
 548
 549         MOD_CHECK(hw_dataflash);
 550
 551         ASSERT(fd);
 552         ASSERT(ch);
 553         ASSERT(setCS);
 554         ASSERT(dev < DFT_CNT);
 555
 556         memset(fd, 0, sizeof(*fd));
 557         DB(fd->fd._type = KFT_DATAFLASH);
 558         fd->dev = dev;
 559         fd->channel = ch;
 560         fd->setReset = setReset;
 561         fd->setCS = setCS;
 562
 563         // Setup data flash programming functions.
 564         fd->fd.reopen = dataflash_reopen;
 565         fd->fd.close = dataflash_close;
 566         fd->fd.read = dataflash_read;
 567         fd->fd.write = dataflash_write;
 568         fd->fd.seek = kfile_genericSeek;
 569         fd->fd.flush = dataflash_flush;
 570
 571         dataflash_reset(fd);
 572         stat = dataflash_stat(fd);
 573
 574         /*
 575          * 2,3,4,5 bits of 1 byte status register
 576          * indicate a device density of dataflash memory
 577          * (see datasheet for more detail.)
 578          */
 579         if (GET_ID_DESITY_DEVICE(stat) != mem_info[fd->dev].density_id)
 580                 return false;
 581
 582         fd->current_page = 0;
 583         fd->fd.seek_pos = 0;
 584         fd->fd.size = mem_info[fd->dev].page_size * mem_info[fd->dev].page_cnt;
 585
 586         /* Load selected page from dataflash memory */
 587         dataflash_loadPage(fd, fd->current_page);
 588         MOD_INIT(dataflash);
 589         return true;
 590 }