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