4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
32 * \brief Function library for dataflash AT45DB family (implementation).
34 * \author Daniele Basile <asterix@develer.com>
35 * \author Francesco Sacchi <batt@develer.com>
38 #include "dataflash.h"
40 #include "cfg/cfg_dataflash.h"
41 #include <cfg/macros.h>
42 #include <cfg/debug.h>
43 #include <cfg/module.h>
45 // Define logging setting (for cfg/log.h module).
46 #define LOG_LEVEL DATAFLASH_LOG_LEVEL
47 #define LOG_FORMAT DATAFLASH_LOG_FORMAT
50 #include <drv/timer.h>
52 #include <fs/battfs.h>
56 #include <cpu/power.h> /* cpu_relax() */
61 * Array used to describe dataflash memory devices currently supported.
63 static const DataflashInfo mem_info[] =
71 .read_cmd = DFO_READ_FLASH_MEM_BYTE_B,
79 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
87 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
95 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
97 /* Add other memories here */
100 STATIC_ASSERT(countof(mem_info) == DFT_CNT);
103 * Macro that toggle CS of dataflash.
104 * \note This is equivalent to fd->setCS(false) immediately followed by fd->setCS(true).
106 INLINE void CS_TOGGLE(DataFlash *fd)
113 * Send a generic command to dataflash memory.
114 * This function send only 4 byte: opcode, page address and
117 static void send_cmd(DataFlash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, DataFlashOpcode opcode)
121 * Make sure to toggle CS signal in order,
122 * and reset dataflash command decoder.
128 * To send one command to data flash memory, we send 4 byte.
129 * First byte is opcode command, second and third byte are
130 * page address, in last byte we write a byte page address.
131 * (see datasheet for more detail).
133 * \note Generally a default memory page size is more than 256 byte.
134 * In this case we need for addressing a byte in one page more than
135 * 8 bit, so we put in fourth byte low part of address byte, and
136 * hight part of address byte in third byte togheter low par of page
144 kfile_putc(opcode, fd->channel);
149 kfile_putc((uint8_t)(page_addr >> (16 - mem_info[fd->dev].page_bits)), fd->channel);
150 kfile_putc((uint8_t)((page_addr << (mem_info[fd->dev].page_bits - 8)) + (byte_addr >> 8)), fd->channel);
153 * Send byte page address.
155 kfile_putc((uint8_t)byte_addr, fd->channel);
159 * Reset dataflash memory function.
161 * If \a fd->setReset function is not NULL,
162 * this function resets data flash memory
163 * with one pulse reset long about 10usec.
166 static void dataflash_reset(DataFlash *fd)
173 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
175 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
181 * Read status register of dataflah memory.
183 static uint8_t dataflash_stat(DataFlash *fd)
186 * Make sure to toggle CS signal
187 * and reset dataflash command decoder.
190 kfile_putc(DFO_READ_STATUS, fd->channel);
191 return kfile_getc(fd->channel);
196 * Send one command to data flash memory, and
197 * return status register value.
200 static uint8_t dataflash_cmd(DataFlash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, DataFlashOpcode opcode)
204 send_cmd(fd, page_addr, byte_addr, opcode);
209 * We chech data flash memory state, and wait until busy-flag
212 while (!(dataflash_stat(fd) & BUSY_BIT))
215 stat = dataflash_stat(fd);
217 kfile_flush(fd->channel); // Flush channel
219 * Data flash has completed a bus cycle, so disable CS.
227 * Read \a len bytes from main data flash memory or buffer data
228 * flash memory, and put it in \a *block.
230 static void dataflash_readBlock(DataFlash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, uint8_t *block, dataflash_size_t len)
232 DataFlashOpcode opcode = mem_info[fd->dev].read_cmd;
233 send_cmd(fd, page_addr, byte_addr, opcode);
235 if (opcode == DFO_READ_FLASH_MEM_BYTE_B)
238 * Send 24 don't care bits.
240 uint8_t dummy[] = { 0, 0, 0 };
241 kfile_write(fd->channel, dummy, sizeof(dummy));
244 kfile_putc(0, fd->channel); //Send 8 don't care bit.
245 kfile_read(fd->channel, block, len); //Read len bytes ad put in block buffer.
246 kfile_flush(fd->channel); // Flush channel
252 * Write \a len bytes in dataflash memory buffer.
254 * \note Is not possible to write directly in dataflash main memory.
255 * To perform a write in main memory you must first write in dataflash buffer
256 * memory and then send a command to write the page in main memory.
258 static void dataflash_writeBlock(DataFlash *fd, dataflash_offset_t offset, const uint8_t *block, dataflash_size_t len)
260 ASSERT(offset + len <= mem_info[fd->dev].page_size);
262 send_cmd(fd, 0x00, offset, DFO_WRITE_BUFF1);
264 kfile_write(fd->channel, block, len); //Write len bytes.
265 kfile_flush(fd->channel); // Flush channel
272 * Load selected page from dataflash memory to buffer.
274 static void dataflash_loadPage(DataFlash *fd, dataflash_page_t page_addr)
276 dataflash_cmd(fd, page_addr, 0x00, DFO_MOV_MEM_TO_BUFF1);
279 /* Battfs disk interface section */
281 static size_t dataflash_disk_page_read(struct BattFsSuper *d, pgcnt_t page, pgaddr_t addr, void *buf, size_t len)
283 DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
284 dataflash_readBlock(fd, page, addr, buf, len);
288 static bool dataflash_disk_page_load(struct BattFsSuper *d, pgcnt_t page)
290 DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
291 dataflash_loadPage(fd, page);
295 static size_t dataflash_disk_buffer_write(struct BattFsSuper *d, pgaddr_t addr, const void *buf, size_t len)
297 DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
298 dataflash_writeBlock(fd, addr, buf, len);
302 static size_t dataflash_disk_buffer_read(struct BattFsSuper *d, pgaddr_t addr, void *buf, size_t len)
304 DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
305 ASSERT(addr + len <= mem_info[fd->dev].page_size);
309 kfile_putc(DFO_READ_BUFF1, fd->channel);
311 uint32_t byte_addr = addr;
313 kfile_putc((byte_addr >> 16) & 0xff, fd->channel);
314 kfile_putc((byte_addr >> 8) & 0xff, fd->channel);
315 kfile_putc(byte_addr & 0xff, fd->channel);
317 /* Send additional don't care byte to start read operation */
318 kfile_putc(0, fd->channel);
320 kfile_read(fd->channel, buf, len); //Read len bytes ad put in buffer.
321 kfile_flush(fd->channel); // Flush channel
326 static bool dataflash_disk_page_save(struct BattFsSuper *d, pgcnt_t page)
328 DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
329 dataflash_cmd(fd, page, 0x00, DFO_WRITE_BUFF1_TO_MEM);
333 static bool dataflash_disk_page_erase(struct BattFsSuper *d, pgcnt_t page)
335 DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
336 dataflash_cmd(fd, page, 0x00, DFO_ERASE_PAGE);
340 static int dataflash_close(struct KFile *_fd);
342 static bool dataflash_disk_close(struct BattFsSuper *d)
344 DataFlash *fd = DATAFLASH_CAST((KFile *)d->disk_ctx);
345 return dataflash_close(&fd->fd) == 0;
348 bool dataflash_diskInit(struct BattFsSuper *d, DataFlash *fd, pgcnt_t *page_array)
352 d->read = dataflash_disk_page_read;
353 d->load = dataflash_disk_page_load;
354 d->bufferWrite = dataflash_disk_buffer_write;
355 d->bufferRead = dataflash_disk_buffer_read;
356 d->save = dataflash_disk_page_save;
357 d->erase = dataflash_disk_page_erase;
358 d->close = dataflash_disk_close;
360 d->page_size = mem_info[fd->dev].page_size;
361 d->page_count = mem_info[fd->dev].page_cnt;
363 d->page_array = page_array;
364 return d->page_array && fd;
368 /* Kfile interface section */
371 * Flush select page (stored in buffer) in data flash main memory page.
373 static int dataflash_flush(KFile *_fd)
375 DataFlash *fd = DATAFLASH_CAST(_fd);
378 dataflash_cmd(fd, fd->current_page, 0x00, DFO_WRITE_BUFF1_TO_MEM_E);
380 fd->page_dirty = false;
382 LOG_INFO("Flushing page {%ld}\n", fd->current_page);
391 static int dataflash_close(struct KFile *_fd)
393 dataflash_flush(_fd);
394 LOG_INFO("Close.\n");
399 * Reopen dataflash file \a fd.
401 static KFile *dataflash_reopen(KFile *_fd)
403 DataFlash *fd = DATAFLASH_CAST(_fd);
404 dataflash_close(_fd);
406 fd->current_page = 0;
409 /* Load selected page from dataflash memory */
410 dataflash_loadPage(fd, fd->current_page);
412 LOG_INFO("Reopen.\n");
418 * Read in \a buf \a size bytes from dataflash memmory.
420 * \note For reading data flash memory, we
421 * check flag page_dirty, if is true (that mean
422 * we have written a byte in buffer memory) we
423 * flush current page in main memory and
424 * then read from memory, else we read byte
425 * directly from data flash main memory.
427 * \return the number of bytes read.
429 static size_t dataflash_read(struct KFile *_fd, void *buf, size_t size)
431 DataFlash *fd = DATAFLASH_CAST(_fd);
433 dataflash_offset_t byte_addr;
434 dataflash_page_t page_addr;
435 uint8_t *data = (uint8_t *)buf;
438 ASSERT(fd->fd.seek_pos + (kfile_off_t)size <= fd->fd.size);
439 size = MIN((kfile_off_t)size, fd->fd.size - fd->fd.seek_pos);
441 LOG_INFO("Reading at pos[%lu]\n", fd->fd.seek_pos);
444 * We select page and offest from absolute address.
446 page_addr = fd->fd.seek_pos / mem_info[fd->dev].page_size;
447 byte_addr = fd->fd.seek_pos % mem_info[fd->dev].page_size;
449 LOG_INFO("[page-{%ld}, byte-{%ld}]\n", page_addr, byte_addr);
452 * Flush current page in main memory if
453 * we had been written a byte in memory
455 dataflash_flush(&fd->fd);
458 * Read byte in main page data flash memory.
460 dataflash_readBlock(fd, page_addr, byte_addr, data, size);
462 fd->fd.seek_pos += size;
463 LOG_INFO("Read %ld bytes\n", (long int)size);
469 * Write \a _buf in dataflash memory
471 * \note For writing \a _buf in dataflash memory, we must
472 * first write in buffer data flash memory. At the end of write,
473 * we can put page in dataflash main memory.
474 * If we write in two contiguous pages, we put in main memory current
475 * page and then reload the page which we want to write.
477 * \return the number of bytes write.
479 static size_t dataflash_write(struct KFile *_fd, const void *_buf, size_t size)
481 DataFlash *fd = DATAFLASH_CAST(_fd);
483 dataflash_offset_t offset;
484 dataflash_page_t new_page;
485 size_t total_write = 0;
487 const uint8_t *data = (const uint8_t *) _buf;
489 ASSERT(fd->fd.seek_pos + (kfile_off_t)size <= fd->fd.size);
490 size = MIN((kfile_off_t)size, fd->fd.size - fd->fd.seek_pos);
492 LOG_INFO("Writing at pos[%lu]\n", fd->fd.seek_pos);
497 * We select page and offest from absolute address.
499 new_page = fd->fd.seek_pos / mem_info[fd->dev].page_size;
500 offset = fd->fd.seek_pos % mem_info[fd->dev].page_size;
503 size_t wr_len = MIN((dataflash_size_t)size, mem_info[fd->dev].page_size - offset);
505 LOG_INFO("[page-{%ld}, byte-{%ld}]\n",new_page, offset);
507 if (new_page != fd->current_page)
509 /* Flush current page in main memory*/
510 dataflash_flush(&fd->fd);
511 /* Load select page memory from data flash memory*/
512 dataflash_loadPage(fd, new_page);
514 fd->current_page = new_page;
515 LOG_INFO(" >> Load page: {%ld}\n", new_page);
518 * Write byte in current page, and set true
521 dataflash_writeBlock(fd, offset, data, wr_len);
522 fd->page_dirty = true;
525 fd->fd.seek_pos += wr_len;
527 total_write += wr_len;
530 LOG_INFO("written %lu bytes\n", (long unsigned)total_write);
534 MOD_DEFINE(dataflash);
537 * Dataflash init function.
538 * This function initialize \a fd with SPI channel \a ch and test if data flash memory
539 * density is the same specified by device \a dev.
540 * \a setCS is a callback used to set/reset CS line.
541 * \a setReset is a callback used to set/reset the dataflash (can be NULL if reset is unconnected)
542 * \return true if ok, false if memory density read from dataflash is not compliant with the
545 bool dataflash_init(DataFlash *fd, KFile *ch, DataflashType dev, dataflash_setCS_t *setCS, dataflash_setReset_t *setReset)
549 MOD_CHECK(hw_dataflash);
554 ASSERT(dev < DFT_CNT);
556 memset(fd, 0, sizeof(*fd));
557 DB(fd->fd._type = KFT_DATAFLASH);
560 fd->setReset = setReset;
563 // Setup data flash programming functions.
564 fd->fd.reopen = dataflash_reopen;
565 fd->fd.close = dataflash_close;
566 fd->fd.read = dataflash_read;
567 fd->fd.write = dataflash_write;
568 fd->fd.seek = kfile_genericSeek;
569 fd->fd.flush = dataflash_flush;
572 stat = dataflash_stat(fd);
575 * 2,3,4,5 bits of 1 byte status register
576 * indicate a device density of dataflash memory
577 * (see datasheet for more detail.)
579 if (GET_ID_DESITY_DEVICE(stat) != mem_info[fd->dev].density_id)
582 fd->current_page = 0;
584 fd->fd.size = mem_info[fd->dev].page_size * mem_info[fd->dev].page_cnt;
586 /* Load selected page from dataflash memory */
587 dataflash_loadPage(fd, fd->current_page);