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