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 AT45DBXX Data Flash memory.
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>
41 #include "dataflash.h"
43 #include <cfg/macros.h>
44 #include <cfg/debug.h>
45 #include <cfg/module.h>
47 #include <drv/timer.h>
49 #include <kern/kfile.h>
52 #include <kern/proc.h>
58 * Array used to describe dataflash memory devices currently supported.
60 static const DataflashInfo mem_info[] =
68 .read_cmd = DFO_READ_FLASH_MEM_BYTE_B,
76 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
84 .read_cmd = DFO_READ_FLASH_MEM_BYTE_D,
86 /* Add other memories here */
89 STATIC_ASSERT(countof(mem_info) == DFT_CNT);
92 * Macro that toggle CS of dataflash.
93 * \note This is equivalent to fd->setCS(false) immediately followed by fd->setCS(true).
95 INLINE void CS_TOGGLE(KFileDataflash *fd)
102 * Send a generic command to dataflash memory.
103 * This function send only 4 byte: opcode, page address and
106 static void send_cmd(KFileDataflash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, DataFlashOpcode opcode)
110 * Make sure to toggle CS signal in order,
111 * and reset dataflash command decoder.
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).
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
133 kfile_putc(opcode, fd->channel);
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);
142 * Send byte page address.
144 kfile_putc((uint8_t)byte_addr, fd->channel);
148 * Reset dataflash memory function.
150 * If \a fd->setReset function is not NULL,
151 * this function resets data flash memory
152 * with one pulse reset long about 10usec.
155 static void dataflash_reset(KFileDataflash *fd)
162 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
164 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
170 * Read status register of dataflah memory.
172 static uint8_t dataflash_stat(KFileDataflash *fd)
175 * Make sure to toggle CS signal
176 * and reset dataflash command decoder.
180 kfile_putc(DFO_READ_STATUS, fd->channel);
182 return kfile_getc(fd->channel);
187 * Send one command to data flash memory, and
188 * return status register value.
191 static uint8_t dataflash_cmd(KFileDataflash *fd, dataflash_page_t page_addr, dataflash_offset_t byte_addr, DataFlashOpcode opcode)
195 send_cmd(fd, page_addr, byte_addr, opcode);
200 * We chech data flash memory state, and wait until busy-flag
203 while (!(dataflash_stat(fd) & BUSY_BIT))
210 stat = dataflash_stat(fd);
212 kfile_flush(fd->channel); // Flush channel
214 * Data flash has completed a bus cycle, so disable CS.
222 * Read \a len bytes from main data flash memory or buffer data
223 * flash memory, and put it in \a *block.
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)
227 send_cmd(fd, page_addr, byte_addr, opcode);
229 if (opcode == DFO_READ_FLASH_MEM_BYTE_B)
232 * Send 24 don't care bits.
234 uint8_t dummy[] = { 0, 0, 0 };
235 kfile_write(fd->channel, dummy, sizeof(dummy));
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
246 * Write \a len bytes in dataflash memory buffer.
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.
252 static void dataflash_writeBlock(KFileDataflash *fd, dataflash_offset_t offset, DataFlashOpcode opcode, const uint8_t *block, dataflash_size_t len)
254 ASSERT(offset + len <= mem_info[fd->dev].page_size);
256 send_cmd(fd, 0x00, offset, opcode);
258 kfile_write(fd->channel, block, len); //Write len bytes.
259 kfile_flush(fd->channel); // Flush channel
266 * Load selct page from dataflash memory to buffer.
268 static void dataflash_loadPage(KFileDataflash *fd, dataflash_page_t page_addr)
270 dataflash_cmd(fd, page_addr, 0x00, DFO_MOV_MEM_TO_BUFF1);
274 * Flush select page (stored in buffer) in data flash main memory page.
276 static int dataflash_flush(KFile *_fd)
278 KFileDataflash *fd = KFILEDATAFLASH(_fd);
281 dataflash_cmd(fd, fd->current_page, 0x00, DFO_WRITE_BUFF1_TO_MEM_E);
283 fd->page_dirty = false;
285 kprintf("Flushing page <%ld>\n", fd->current_page);
290 /* Kfile interface section */
295 static int dataflash_close(struct KFile *_fd)
297 dataflash_flush(_fd);
303 * Reopen dataflash file \a fd.
305 static KFile *dataflash_reopen(KFile *_fd)
307 KFileDataflash *fd = KFILEDATAFLASH(_fd);
308 dataflash_close(_fd);
310 fd->current_page = 0;
313 /* Load selected page from dataflash memory */
314 dataflash_loadPage(fd, fd->current_page);
322 * Read in \a buf \a size bytes from dataflash memmory.
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.
331 * \return the number of bytes read.
333 static size_t dataflash_read(struct KFile *_fd, void *buf, size_t size)
335 KFileDataflash *fd = KFILEDATAFLASH(_fd);
337 dataflash_offset_t byte_addr;
338 dataflash_page_t page_addr;
339 uint8_t *data = (uint8_t *)buf;
342 ASSERT(fd->fd.seek_pos + size <= fd->fd.size);
343 size = MIN((uint32_t)size, fd->fd.size - fd->fd.seek_pos);
345 kprintf("Reading at pos[%lu]\n", fd->fd.seek_pos);
348 * We select page and offest from absolute address.
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;
353 kprintf("[page-<%ld>, byte-<%ld>]", page_addr, byte_addr);
356 * Flush current page in main memory if
357 * we had been written a byte in memory
359 dataflash_flush(&fd->fd);
362 * Read byte in main page data flash memory.
364 dataflash_readBlock(fd, page_addr, byte_addr, mem_info[fd->dev].read_cmd, data, size);
366 fd->fd.seek_pos += size;
367 kprintf("Read %ld bytes\n", size);
373 * Write \a _buf in dataflash memory
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.
381 * \return the number of bytes write.
383 static size_t dataflash_write(struct KFile *_fd, const void *_buf, size_t size)
385 KFileDataflash *fd = KFILEDATAFLASH(_fd);
387 dataflash_offset_t offset;
388 dataflash_page_t new_page;
389 size_t total_write = 0;
391 const uint8_t *data = (const uint8_t *) _buf;
393 ASSERT(fd->fd.seek_pos + size <= fd->fd.size);
394 size = MIN((uint32_t)size, fd->fd.size - fd->fd.seek_pos);
396 kprintf("Writing at pos[%lu]\n", fd->fd.seek_pos);
401 * We select page and offest from absolute address.
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;
407 size_t wr_len = MIN(size, mem_info[fd->dev].page_size - offset);
409 kprintf(" [page-<%ld>, byte-<%ld>]",new_page, offset);
411 if (new_page != fd->current_page)
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);
418 fd->current_page = new_page;
419 kprintf(" >> Load page: <%ld> ", new_page);
422 * Write byte in current page, and set true
425 dataflash_writeBlock(fd, offset, DFO_WRITE_BUFF1, data, wr_len);
426 fd->page_dirty = true;
429 fd->fd.seek_pos += wr_len;
431 total_write += wr_len;
434 kprintf("written %lu bytes\n", total_write);
438 MOD_DEFINE(dataflash);
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
449 bool dataflash_init(KFileDataflash *fd, KFile *ch, DataflashType dev, dataflash_setCS_t *setCS, dataflash_setReset_t *setReset)
453 MOD_CHECK(hw_dataflash);
458 ASSERT(dev < DFT_CNT);
460 memset(fd, 0, sizeof(*fd));
461 DB(fd->fd._type = KFT_DATAFLASH);
464 fd->setReset = setReset;
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;
477 stat = dataflash_stat(fd);
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.)
484 if (GET_ID_DESITY_DEVICE(stat) != mem_info[fd->dev].density_id)
487 fd->current_page = 0;
489 fd->fd.size = mem_info[fd->dev].page_size * mem_info[fd->dev].page_cnt;
491 /* Load selected page from dataflash memory */
492 dataflash_loadPage(fd, fd->current_page);