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