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 <kern/kfile.h>
  54
  55 #include <cpu/power.h> /* cpu_relax() */
  56
  57 #include <string.h>
  58
  59 /**
  60  * Array used to describe dataflash memory devices currently supported.
  61  */
  62 static const DataflashInfo mem_info[] =
  63 {
  64         {
  65                 /* AT45DB041B */
  66                 .density_id = 0x07,
  67                 .page_size = 264,
  68                 .page_bits = 9,
  69                 .page_cnt = 2048,
  70                 .read_cmd = DFO_READ_FLASH_MEM_BYTE_B,
  71         },
  72         {
  73                 /* AT45DB081D */
  74                 .density_id = 0x09,
  75                 .page_size = 264,
  76                 .page_bits = 9,
  77                 .page_cnt = 4096,
  78                 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
  79         },
  80         {
  81                 /* AT45DB161D */
  82                 .density_id = 0x0B,
  83                 .page_size = 528,
  84                 .page_bits = 10,
  85                 .page_cnt = 4096,
  86                 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
  87         },
  88         {
  89                 /* AT45DB642D */
  90                 .density_id = 0x0F,
  91                 .page_size = 1056,
  92                 .page_bits = 11,
  93                 .page_cnt = 8192,
  94                 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
  95         },
  96         /* Add other memories here */
  97 };
  98
  99 STATIC_ASSERT(countof(mem_info) == DFT_CNT);
 100
 101 /**
 102  * Macro that toggle CS of dataflash.
 103  * \note This is equivalent to fd->setCS(false) immediately followed by fd->setCS(true).
 104  */
 105 INLINE void CS_TOGGLE(DataFlash *fd)
 106 {
 107         fd->setCS(false);
 108         fd->setCS(true);
 109 }
 110
 111 /**
 112  * Send a generic command to dataflash memory.
 113  * This function send only 4 byte: opcode, page address and
 114  * byte address.
 115  */
 116 static void send_cmd(DataFlash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, DataFlashOpcode opcode)
 117 {
 118
 119         /*
 120          * Make sure to toggle CS signal in order,
 121          * and reset dataflash command decoder.
 122          */
 123         CS_TOGGLE(fd);
 124
 125
 126         /*
 127          * To send one command to data flash memory, we send 4 byte.
 128          * First byte is opcode command, second and third byte are
 129          * page address, in last byte we write a byte page address.
 130          * (see datasheet for more detail).
 131          *
 132          * \note Generaly a defaul memory page size is more than 256 byte.
 133          *  In this case we need for addressing a byte in one page more than
 134          *  8 bit, so we put in fourth byte low part of address byte, and
 135          *  hight part of address byte in third byte togheter low par of page
 136          *  address.
 137          *
 138          */
 139
 140         /*
 141          * Send opcode.
 142          */
 143         kfile_putc(opcode, fd->channel);
 144
 145         /*
 146          *  Send page address.
 147          */
 148         kfile_putc((uint8_t)(page_addr >> (16 - mem_info[fd->dev].page_bits)), fd->channel);
 149         kfile_putc((uint8_t)((page_addr << (mem_info[fd->dev].page_bits - 8)) + (byte_addr >> 8)), fd->channel);
 150
 151         /*
 152          * Send byte page address.
 153          */
 154         kfile_putc((uint8_t)byte_addr, fd->channel);
 155 }
 156
 157 /**
 158  * Reset dataflash memory function.
 159  *
 160  * If \a fd->setReset function is not NULL,
 161  * this function resets data flash memory
 162  * with one pulse reset long about 10usec.
 163  *
 164  */
 165 static void dataflash_reset(DataFlash *fd)
 166 {
 167         fd->setCS(false);
 168
 169         if (fd->setReset)
 170         {
 171                 fd->setReset(true);
 172                 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
 173                 fd->setReset(false);
 174                 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
 175         }
 176 }
 177
 178
 179 /**
 180  * Read status register of dataflah memory.
 181  */
 182 static uint8_t dataflash_stat(DataFlash *fd)
 183 {
 184         /*
 185          * Make sure to toggle CS signal
 186          * and reset dataflash command decoder.
 187          */
 188         CS_TOGGLE(fd);
 189         kfile_putc(DFO_READ_STATUS, fd->channel);
 190         return kfile_getc(fd->channel);
 191 }
 192
 193
 194 /**
 195  * Send one command to data flash memory, and
 196  * return status register value.
 197  *
 198  */
 199 static uint8_t dataflash_cmd(DataFlash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, DataFlashOpcode opcode)
 200 {
 201         uint8_t stat;
 202
 203         send_cmd(fd, page_addr, byte_addr, opcode);
 204
 205         CS_TOGGLE(fd);
 206
 207         /*
 208          * We chech data flash memory state, and wait until busy-flag
 209          * is high.
 210          */
 211         while (!(dataflash_stat(fd) & BUSY_BIT))
 212                 cpu_relax();
 213
 214         stat = dataflash_stat(fd);
 215
 216         kfile_flush(fd->channel); // Flush channel
 217         /*
 218          * Data flash has completed a bus cycle, so disable CS.
 219          */
 220         fd->setCS(false);
 221
 222         return stat;
 223 }
 224
 225 /**
 226  * Read \a len bytes from main data flash memory or buffer data
 227  * flash memory, and put it in \a *block.
 228  */
 229 static void dataflash_readBlock(DataFlash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, DataFlashOpcode opcode, uint8_t *block, dataflash_size_t len)
 230 {
 231         send_cmd(fd, page_addr, byte_addr, opcode);
 232
 233         if (opcode == DFO_READ_FLASH_MEM_BYTE_B)
 234         {
 235                 /*
 236                  * Send 24 don't care bits.
 237                  */
 238                 uint8_t dummy[] = { 0, 0, 0 };
 239                 kfile_write(fd->channel, dummy, sizeof(dummy));
 240         }
 241
 242         kfile_putc(0, fd->channel); //Send 8 don't care bit.
 243         kfile_read(fd->channel, block, len); //Read len bytes ad put in block buffer.
 244         kfile_flush(fd->channel); // Flush channel
 245         fd->setCS(false);
 246 }
 247
 248
 249 /**
 250  * Write \a len bytes in dataflash memory buffer.
 251  *
 252  * \note Is not possible to write directly in dataflash main memory.
 253  * To perform a write in main memory you must first write in dataflash buffer
 254  * memory and then send a command to write the page in main memory.
 255  */
 256 static void dataflash_writeBlock(DataFlash *fd, dataflash_offset_t offset, DataFlashOpcode opcode, const uint8_t *block, dataflash_size_t len)
 257 {
 258         ASSERT(offset + len <= mem_info[fd->dev].page_size);
 259
 260         send_cmd(fd, 0x00, offset, opcode);
 261
 262         kfile_write(fd->channel, block, len); //Write len bytes.
 263         kfile_flush(fd->channel); // Flush channel
 264
 265         fd->setCS(false);
 266 }
 267
 268
 269 /**
 270  * Load selct page from dataflash memory to buffer.
 271  */
 272 static void dataflash_loadPage(DataFlash *fd, dataflash_page_t page_addr)
 273 {
 274         dataflash_cmd(fd, page_addr, 0x00, DFO_MOV_MEM_TO_BUFF1);
 275 }
 276
 277 /**
 278  * Flush select page (stored in buffer) in data flash main memory page.
 279  */
 280 static int dataflash_flush(KFile *_fd)
 281 {
 282         DataFlash *fd = DATAFLASH_CAST(_fd);
 283         if (fd->page_dirty)
 284         {
 285                 dataflash_cmd(fd, fd->current_page, 0x00, DFO_WRITE_BUFF1_TO_MEM_E);
 286
 287                 fd->page_dirty = false;
 288
 289                 LOG_INFO("Flushing page {%ld}\n", fd->current_page);
 290         }
 291         return 0;
 292 }
 293
 294 /* Kfile interface section */
 295
 296 /**
 297  * Close file \a fd.
 298  */
 299 static int dataflash_close(struct KFile *_fd)
 300 {
 301         dataflash_flush(_fd);
 302         LOG_INFO("Close.\n");
 303         return 0;
 304 }
 305
 306 /**
 307  * Reopen dataflash file \a fd.
 308  */
 309 static KFile *dataflash_reopen(KFile *_fd)
 310 {
 311         DataFlash *fd = DATAFLASH_CAST(_fd);
 312         dataflash_close(_fd);
 313
 314         fd->current_page = 0;
 315         fd->fd.seek_pos = 0;
 316
 317         /* Load selected page from dataflash memory */
 318         dataflash_loadPage(fd, fd->current_page);
 319
 320         LOG_INFO("Reopen.\n");
 321         return &fd->fd;
 322 }
 323
 324
 325 /**
 326  * Read in \a buf \a size bytes from dataflash memmory.
 327  *
 328  * \note For reading data flash memory, we
 329  * check flag page_dirty, if is true (that mean
 330  * we have written a byte in buffer memory) we
 331  * flush current page in main memory and
 332  * then read from memory, else we read byte
 333  * directly from data flash main memory.
 334  *
 335  * \return the number of bytes read.
 336  */
 337 static size_t dataflash_read(struct KFile *_fd, void *buf, size_t size)
 338 {
 339         DataFlash *fd = DATAFLASH_CAST(_fd);
 340
 341         dataflash_offset_t byte_addr;
 342         dataflash_page_t page_addr;
 343         uint8_t *data = (uint8_t *)buf;
 344
 345
 346         ASSERT(fd->fd.seek_pos + size <= (kfile_off_t)fd->fd.size);
 347         size = MIN((kfile_off_t)size, fd->fd.size - fd->fd.seek_pos);
 348
 349         LOG_INFO("Reading at pos[%lu]\n", fd->fd.seek_pos);
 350
 351         /*
 352          * We select page and offest from absolute address.
 353          */
 354         page_addr = fd->fd.seek_pos / mem_info[fd->dev].page_size;
 355         byte_addr = fd->fd.seek_pos % mem_info[fd->dev].page_size;
 356
 357         LOG_INFO("[page-{%ld}, byte-{%ld}]\n", page_addr, byte_addr);
 358
 359         /*
 360          * Flush current page in main memory if
 361          * we had been written a byte in memory
 362          */
 363         dataflash_flush(&fd->fd);
 364
 365         /*
 366          * Read byte in main page data flash memory.
 367          */
 368         dataflash_readBlock(fd, page_addr, byte_addr, mem_info[fd->dev].read_cmd, data, size);
 369
 370         fd->fd.seek_pos += size;
 371         LOG_INFO("Read %ld bytes\n", size);
 372
 373         return size;
 374 }
 375
 376 /**
 377  * Write \a _buf in dataflash memory
 378  *
 379  * \note For writing \a _buf in dataflash memory, we must
 380  * first write in buffer data flash memory. At the end of write,
 381  * we can put page in dataflash main memory.
 382  * If we write in two contiguous pages, we put in main memory current
 383  * page and then reload the page which we want to write.
 384  *
 385  * \return the number of bytes write.
 386  */
 387 static size_t dataflash_write(struct KFile *_fd, const void *_buf, size_t size)
 388 {
 389         DataFlash *fd = DATAFLASH_CAST(_fd);
 390
 391         dataflash_offset_t offset;
 392         dataflash_page_t new_page;
 393         size_t total_write = 0;
 394
 395         const uint8_t *data = (const uint8_t *) _buf;
 396
 397         ASSERT(fd->fd.seek_pos + size <= (kfile_off_t)fd->fd.size);
 398         size = MIN((kfile_off_t)size, fd->fd.size - fd->fd.seek_pos);
 399
 400         LOG_INFO("Writing at pos[%lu]\n", fd->fd.seek_pos);
 401
 402         while (size)
 403         {
 404                 /*
 405                 * We select page and offest from absolute address.
 406                 */
 407                 new_page = fd->fd.seek_pos / mem_info[fd->dev].page_size;
 408                 offset = fd->fd.seek_pos % mem_info[fd->dev].page_size;
 409
 410
 411                 size_t wr_len = MIN((dataflash_size_t)size, mem_info[fd->dev].page_size - offset);
 412
 413                 LOG_INFO("[page-{%ld}, byte-{%ld}]\n",new_page, offset);
 414
 415                 if (new_page != fd->current_page)
 416                 {
 417                         /* Flush current page in main memory*/
 418                         dataflash_flush(&fd->fd);
 419                         /* Load select page memory from data flash memory*/
 420                         dataflash_loadPage(fd, new_page);
 421
 422                         fd->current_page = new_page;
 423                         LOG_INFO(" >> Load page: {%ld}\n", new_page);
 424                 }
 425                 /*
 426                 * Write byte in current page, and set true
 427                 * page_dirty flag.
 428                 */
 429                 dataflash_writeBlock(fd, offset, DFO_WRITE_BUFF1, data, wr_len);
 430                 fd->page_dirty = true;
 431
 432                 data += wr_len;
 433                 fd->fd.seek_pos += wr_len;
 434                 size -= wr_len;
 435                 total_write += wr_len;
 436         }
 437
 438         LOG_INFO("written %lu bytes\n", total_write);
 439         return total_write;
 440 }
 441
 442 MOD_DEFINE(dataflash);
 443
 444 /**
 445  * Dataflash init function.
 446  * This function initialize \a fd with SPI channel \a ch and test if data flash memory
 447  * density is the same specified by device \a dev.
 448  * \a setCS is a callback used to set/reset CS line.
 449  * \a setReset is a callback used to set/reset the dataflash (can be NULL if reset is unconnected)
 450  * \return true if ok, false if memory density read from dataflash is not compliant with the
 451  * configured one.
 452  */
 453 bool dataflash_init(DataFlash *fd, KFile *ch, DataflashType dev, dataflash_setCS_t *setCS, dataflash_setReset_t *setReset)
 454 {
 455         uint8_t stat;
 456
 457         MOD_CHECK(hw_dataflash);
 458
 459         ASSERT(fd);
 460         ASSERT(ch);
 461         ASSERT(setCS);
 462         ASSERT(dev < DFT_CNT);
 463
 464         memset(fd, 0, sizeof(*fd));
 465         DB(fd->fd._type = KFT_DATAFLASH);
 466         fd->dev = dev;
 467         fd->channel = ch;
 468         fd->setReset = setReset;
 469         fd->setCS = setCS;
 470
 471         // Setup data flash programming functions.
 472         fd->fd.reopen = dataflash_reopen;
 473         fd->fd.close = dataflash_close;
 474         fd->fd.read = dataflash_read;
 475         fd->fd.write = dataflash_write;
 476         fd->fd.seek = kfile_genericSeek;
 477         fd->fd.flush = dataflash_flush;
 478
 479         dataflash_reset(fd);
 480         stat = dataflash_stat(fd);
 481
 482         /*
 483          * 2,3,4,5 bits of 1 byte status register
 484          * indicate a device density of dataflash memory
 485          * (see datasheet for more detail.)
 486          */
 487         if (GET_ID_DESITY_DEVICE(stat) != mem_info[fd->dev].density_id)
 488                 return false;
 489
 490         fd->current_page = 0;
 491         fd->fd.seek_pos = 0;
 492         fd->fd.size = mem_info[fd->dev].page_size * mem_info[fd->dev].page_cnt;
 493
 494         /* Load selected page from dataflash memory */
 495         dataflash_loadPage(fd, fd->current_page);
 496         MOD_INIT(dataflash);
 497         return true;
 498 }