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