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