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/)
33 * \brief Function library for dataflash AT45DB family (implementation).
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>
41 #include "dataflash.h"
43 #include "cfg/cfg_dataflash.h"
44 #include <cfg/macros.h>
45 #include <cfg/debug.h>
46 #include <cfg/module.h>
48 // Define logging setting (for cfg/log.h module).
49 #define LOG_LEVEL DATAFLASH_LOG_LEVEL
50 #define LOG_VERBOSITY DATAFLASH_LOG_VERBOSITY
53 #include <drv/timer.h>
55 #include <kern/kfile.h>
58 #include <kern/proc.h>
64 * Array used to describe dataflash memory devices currently supported.
66 static const DataflashInfo mem_info[] =
74 .read_cmd = DFO_READ_FLASH_MEM_BYTE_B,
82 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
90 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
98 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
100 /* Add other memories here */
103 STATIC_ASSERT(countof(mem_info) == DFT_CNT);
106 * Macro that toggle CS of dataflash.
107 * \note This is equivalent to fd->setCS(false) immediately followed by fd->setCS(true).
109 INLINE void CS_TOGGLE(KFileDataflash *fd)
116 * Send a generic command to dataflash memory.
117 * This function send only 4 byte: opcode, page address and
120 static void send_cmd(KFileDataflash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, DataFlashOpcode opcode)
124 * Make sure to toggle CS signal in order,
125 * and reset dataflash command decoder.
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).
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
147 kfile_putc(opcode, fd->channel);
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);
156 * Send byte page address.
158 kfile_putc((uint8_t)byte_addr, fd->channel);
162 * Reset dataflash memory function.
164 * If \a fd->setReset function is not NULL,
165 * this function resets data flash memory
166 * with one pulse reset long about 10usec.
169 static void dataflash_reset(KFileDataflash *fd)
176 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
178 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
184 * Read status register of dataflah memory.
186 static uint8_t dataflash_stat(KFileDataflash *fd)
189 * Make sure to toggle CS signal
190 * and reset dataflash command decoder.
193 kfile_putc(DFO_READ_STATUS, fd->channel);
194 return kfile_getc(fd->channel);
199 * Send one command to data flash memory, and
200 * return status register value.
203 static uint8_t dataflash_cmd(KFileDataflash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, DataFlashOpcode opcode)
207 send_cmd(fd, page_addr, byte_addr, opcode);
212 * We chech data flash memory state, and wait until busy-flag
215 while (!(dataflash_stat(fd) & BUSY_BIT))
222 stat = dataflash_stat(fd);
224 kfile_flush(fd->channel); // Flush channel
226 * Data flash has completed a bus cycle, so disable CS.
234 * Read \a len bytes from main data flash memory or buffer data
235 * flash memory, and put it in \a *block.
237 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)
239 send_cmd(fd, page_addr, byte_addr, opcode);
241 if (opcode == DFO_READ_FLASH_MEM_BYTE_B)
244 * Send 24 don't care bits.
246 uint8_t dummy[] = { 0, 0, 0 };
247 kfile_write(fd->channel, dummy, sizeof(dummy));
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
258 * Write \a len bytes in dataflash memory buffer.
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.
264 static void dataflash_writeBlock(KFileDataflash *fd, dataflash_offset_t offset, DataFlashOpcode opcode, const uint8_t *block, dataflash_size_t len)
266 ASSERT(offset + len <= mem_info[fd->dev].page_size);
268 send_cmd(fd, 0x00, offset, opcode);
270 kfile_write(fd->channel, block, len); //Write len bytes.
271 kfile_flush(fd->channel); // Flush channel
278 * Load selct page from dataflash memory to buffer.
280 static void dataflash_loadPage(KFileDataflash *fd, dataflash_page_t page_addr)
282 dataflash_cmd(fd, page_addr, 0x00, DFO_MOV_MEM_TO_BUFF1);
286 * Flush select page (stored in buffer) in data flash main memory page.
288 static int dataflash_flush(KFile *_fd)
290 KFileDataflash *fd = KFILEDATAFLASH(_fd);
293 dataflash_cmd(fd, fd->current_page, 0x00, DFO_WRITE_BUFF1_TO_MEM_E);
295 fd->page_dirty = false;
297 LOG_INFO("Flushing page {%ld}\n", fd->current_page);
302 /* Kfile interface section */
307 static int dataflash_close(struct KFile *_fd)
309 dataflash_flush(_fd);
310 LOG_INFO("Close.\n");
315 * Reopen dataflash file \a fd.
317 static KFile *dataflash_reopen(KFile *_fd)
319 KFileDataflash *fd = KFILEDATAFLASH(_fd);
320 dataflash_close(_fd);
322 fd->current_page = 0;
325 /* Load selected page from dataflash memory */
326 dataflash_loadPage(fd, fd->current_page);
328 LOG_INFO("Reopen.\n");
334 * Read in \a buf \a size bytes from dataflash memmory.
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.
343 * \return the number of bytes read.
345 static size_t dataflash_read(struct KFile *_fd, void *buf, size_t size)
347 KFileDataflash *fd = KFILEDATAFLASH(_fd);
349 dataflash_offset_t byte_addr;
350 dataflash_page_t page_addr;
351 uint8_t *data = (uint8_t *)buf;
354 ASSERT(fd->fd.seek_pos + size <= fd->fd.size);
355 size = MIN((kfile_size_t)size, fd->fd.size - fd->fd.seek_pos);
357 LOG_INFO("Reading at pos[%lu]\n", fd->fd.seek_pos);
360 * We select page and offest from absolute address.
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;
365 LOG_INFO("[page-{%ld}, byte-{%ld}]\n", page_addr, byte_addr);
368 * Flush current page in main memory if
369 * we had been written a byte in memory
371 dataflash_flush(&fd->fd);
374 * Read byte in main page data flash memory.
376 dataflash_readBlock(fd, page_addr, byte_addr, mem_info[fd->dev].read_cmd, data, size);
378 fd->fd.seek_pos += size;
379 LOG_INFO("Read %ld bytes\n", size);
385 * Write \a _buf in dataflash memory
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.
393 * \return the number of bytes write.
395 static size_t dataflash_write(struct KFile *_fd, const void *_buf, size_t size)
397 KFileDataflash *fd = KFILEDATAFLASH(_fd);
399 dataflash_offset_t offset;
400 dataflash_page_t new_page;
401 size_t total_write = 0;
403 const uint8_t *data = (const uint8_t *) _buf;
405 ASSERT(fd->fd.seek_pos + size <= fd->fd.size);
406 size = MIN((kfile_size_t)size, fd->fd.size - fd->fd.seek_pos);
408 LOG_INFO("Writing at pos[%lu]\n", fd->fd.seek_pos);
413 * We select page and offest from absolute address.
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;
419 size_t wr_len = MIN((dataflash_size_t)size, mem_info[fd->dev].page_size - offset);
421 LOG_INFO("[page-{%ld}, byte-{%ld}]\n",new_page, offset);
423 if (new_page != fd->current_page)
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);
430 fd->current_page = new_page;
431 LOG_INFO(" >> Load page: {%ld}\n", new_page);
434 * Write byte in current page, and set true
437 dataflash_writeBlock(fd, offset, DFO_WRITE_BUFF1, data, wr_len);
438 fd->page_dirty = true;
441 fd->fd.seek_pos += wr_len;
443 total_write += wr_len;
446 LOG_INFO("written %lu bytes\n", total_write);
450 MOD_DEFINE(dataflash);
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
461 bool dataflash_init(KFileDataflash *fd, KFile *ch, DataflashType dev, dataflash_setCS_t *setCS, dataflash_setReset_t *setReset)
465 MOD_CHECK(hw_dataflash);
470 ASSERT(dev < DFT_CNT);
472 memset(fd, 0, sizeof(*fd));
473 DB(fd->fd._type = KFT_DATAFLASH);
476 fd->setReset = setReset;
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;
488 stat = dataflash_stat(fd);
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.)
495 if (GET_ID_DESITY_DEVICE(stat) != mem_info[fd->dev].density_id)
498 fd->current_page = 0;
500 fd->fd.size = mem_info[fd->dev].page_size * mem_info[fd->dev].page_cnt;
502 /* Load selected page from dataflash memory */
503 dataflash_loadPage(fd, fd->current_page);