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 15379 2007-03-28 15:46:09Z asterix $
37 * \author Daniele Basile <asterix@develer.com>
41 #include <appconfig.h>
44 #include <cfg/macros.h>
45 #include <cfg/debug.h>
46 #include <cfg/module.h>
47 #include <drv/timer.h>
49 #include <drv/dataflash.h>
55 * Global variable for store current and previous data
56 * flash memory page address during operation of writing.
58 static dataflash_t previous_page = 0;
59 static bool page_modified = false;
63 * Send a generic command to data flash memory.
64 * This function send only 4 byte, for opcode, page address and
67 static void send_cmd(dataflash_t page_addr, dataflashOffset_t byte_addr, DataFlashOpcode opcode)
71 * Make sure to toggle CS signal in order,
72 * and reset dataflash command decoder.
74 * \note This is equivalent to CS_DISABLE() immediately followed by CS_ENABLE()
80 * To send one command to data flash memory, we send 4 byte.
81 * First byte is opcode command, second and third byte are
82 * page address, in last byte we write a byte page address.
83 * (see datasheet for more detail).
85 * \note Generaly a defaul memory page size is more than 256 byte.
86 * In this case we need for addressing a byte in one page more than
87 * 8 bit, so we put in fourth byte low part of address byte, and
88 * hight part of address byte in third byte togheter low par of page
101 spi_sendRecv((uint8_t)(page_addr >> (16 - DATAFLASH_PAGE_ADDRESS_BIT)));
102 spi_sendRecv((uint8_t)((page_addr << (DATAFLASH_PAGE_ADDRESS_BIT - 8)) + (byte_addr >> 8)));
105 * Send byte page address.
107 spi_sendRecv((uint8_t)byte_addr);
113 * Reset dataflash memory function.
115 * This function reset data flash memory
116 * with one pulse reset long about 10usec.
119 static void dataflash_reset(void)
123 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
126 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
130 * dataflash init function.
131 * This function initialize a micro pin and
132 * SPI driver, and test if data flash memory
133 * density is the same wich define in dataflash.h.
135 MOD_DEFINE(dataflash);
136 static bool dataflash_pin_init(void)
143 WRITE_ENABLE(); //pilot wp pin.
150 stat = dataflash_stat();
155 * 2,3,4,5 bits of 1 byte status register
156 * indicate a device density of dataflash memory
157 * (see datasheet for more detail.)
159 GET_ID_DESITY_DEVICE(stat);
161 if(stat == DATAFLASH_ID_DEVICE_DENSITY)
170 * Read status register of dataflah memory.
173 static uint8_t dataflash_stat(void)
178 * Make sure to toggle CS signal in order,
179 * and reset dataflash command decoder.
183 stat = spi_sendRecv(DFO_READ_STATUS);
184 stat = spi_sendRecv(0x00);
191 * Send one command to data flash memory, and
192 * return status register value.
195 static uint8_t dataflash_cmd(dataflash_t page_addr, dataflashOffset_t byte_addr, DataFlashOpcode opcode)
198 send_cmd(page_addr, byte_addr, opcode);
203 * We chech data flash memory state, and wait until busy-flag
206 while(!(dataflash_stat() & BUSY_BIT));
208 return (dataflash_stat());
213 * Read one byte from main data flash memory or buffer data
216 static uint8_t dataflash_read_byte(dataflash_t page_addr, dataflashOffset_t byte_addr, DataFlashOpcode opcode)
220 send_cmd(page_addr, byte_addr, opcode);
222 #if CONFIG_DATA_FLASH == DATAFLASH_AT45DB041B
223 if(opcode == DFO_READ_FLASH_MEM_BYTE)
226 * Send 24 don't care bit.
235 spi_sendRecv(0x00); //Send 8 don't care bit.
236 data = spi_sendRecv(0x00); //Read byte.
243 * Read \a len bytes from main data flash memory or buffer data
244 * flash memory, and put it in \a *block.
246 static void dataflash_read_block(dataflash_t page_addr, dataflashOffset_t byte_addr, DataFlashOpcode opcode, uint8_t *block, dataflashSize_t len)
249 send_cmd(page_addr, byte_addr, opcode);
251 if(opcode == DFO_READ_FLASH_MEM_BYTE)
254 * Send 24 don't care bit.
262 spi_sendRecv(0x00); //Send 8 don't care bit.
263 spi_read(block, len); //Read len bytes ad put in block buffer.
272 * Write \a len bytes in buffer buffer data flash memory.
274 * \note Isn't possible to write bytes directly in main memory data
275 * flash. To perform write in main memory you must before write in buffer
276 * data flash memory, an then send command to write page in main memory.
278 static void dataflash_write_block(dataflashOffset_t byte_addr, DataFlashOpcode opcode, uint8_t *block, dataflashSize_t len)
281 send_cmd(0x00, byte_addr, opcode);
283 spi_write(block, len); //Write len bytes.
291 * Load selct page from dataflash memory to buffer.
293 static void dataflash_loadPage(dataflash_t page_addr)
295 dataflash_cmd(page_addr, 0x00, DFO_MOV_MEM_TO_BUFF1);
301 * Flush select page (stored in buffer) in data flash main memory page.
303 void dataflash_flush(void)
307 dataflash_cmd(previous_page, 0x00, DFO_WRITE_BUFF1_TO_MEM_E);
310 page_modified = false;
312 kprintf("\n::=> Flush page:... <%ld>\n", previous_page);
316 /* Kfile interface section */
319 * Open data flash file \a fd
320 * \a name and \a mode are unused, cause flash memory is
321 * threated like one file.
323 static bool dataflash_open(struct _KFile *fd, UNUSED_ARG(const char *, name), UNUSED_ARG(int, mode))
325 MOD_CHECK(dataflash);
329 fd->size = (dataflashAddr_t)DATAFLASH_PAGE_SIZE * (dataflashAddr_t)DATAFLASH_NUM_PAGE;
331 /* Load select page memory from data flash memory*/
332 dataflash_loadPage(previous_page);
334 kprintf("dataflash file opened\n");
341 static bool dataflash_close(UNUSED_ARG(struct _KFile *,fd))
344 kprintf("dataflash file closed\n");
349 * Move \a fd file seek position of \a offset bytes
350 * from current position.
352 static int32_t dataflash_seek(struct _KFile *fd, int32_t offset, KSeekMode whence)
362 seek_pos = fd->size - 1;
365 seek_pos = fd->seek_pos;
374 if (seek_pos + offset > fd->size)
380 fd->seek_pos = seek_pos + offset;
381 kprintf("Flash seek to [%u]\n", fd->seek_pos);
387 * Read from file \a fd \a size bytes and put it in buffer \a buf
388 * \return the number of bytes read.
390 static size_t dataflash_read(struct _KFile *fd, void *buf, size_t size)
392 dataflashOffset_t byte_addr;
393 dataflashAddr_t page_addr;
394 uin8_t *data = (uint8_t *)buf;
397 ASSERT(fd->seek_pos + size <= fd->size);
398 size = MIN((uint32_t)size, fd->size - fd->seek_pos);
400 kprintf("Reading at pos[%u]\n", fd->seek_pos);
403 * We select from absolute address page address
404 * and byte address in page.
406 page_addr = fd->seek_pos / (dataflashAddr_t)DATAFLASH_PAGE_SIZE;
407 byte_addr = fd->seek_pos % (dataflashAddr_t)DATAFLASH_PAGE_SIZE;
410 kprintf(" [page-<%ld>, byte-<%ld>]", page_addr, byte_addr);
413 * Flush current page in main memory if
414 * we had been written a byte in memory
419 * Read byte in main page data flash memory.
421 dataflash_read_block(page_addr, byte_addr, DFO_READ_FLASH_MEM_BYTE, data, size);
423 fd->seek_pos += size;
424 kprintf(" ::=> Read data: %02x\n",data);
430 * Write program memory.
431 * Write \a size bytes from buffer \a _buf to file \a fd
432 * \note Write operations are buffered.
434 static size_t dataflash_write(struct _KFile *fd, const void *_buf, size_t size)
437 dataflashOffset_t byte_addr;
438 dataflashAddr_t current_page;
440 uint8_t *data = (uint8_t *) _buf;
442 ASSERT(fd->seek_pos + size <= fd->size);
443 size = MIN((uint32_t)size, fd->size - fd->seek_pos);
445 kprintf("Writing at pos[%u]\n", fd->seek_pos);
450 * We select from absolute address page address
451 * and byte address in page.
453 current_page = fd->seek_pos / (dataflashAddr_t)DATAFLASH_PAGE_SIZE;
454 byte_addr = fd->seek_pos % (dataflashAddr_t)DATAFLASH_PAGE_SIZE;
457 size_t wr_len = MIN(size, DATAFLASH_PAGE_SIZE - byte_addr);
459 kprintf(" [page-<%ld>, byte-<%ld>]",current_page, byte_addr);
461 if (current_page != previous_page)
463 /* Flush current page in main memory*/
465 /* Load select page memory from data flash memory*/
466 dataflash_loadPage(current_page);
468 previous_page = current_page;
469 kprintf(" >> Load page: <%ld> ",current_page);
472 * Write byte in current page, and set true
473 * page_modified flag.
475 dataflash_write_byte(byte_addr, DFO_WRITE_BUFF1, data);
476 page_modified = true;
480 fd->seek_pos += wr_len;
482 total_write += wr_len;
485 kprintf("written %u bytes\n", total_write);
490 * Init data flash memory interface.
492 void dataflash_init(struct _KFile *fd)
494 // Set up data flash programming functions.
495 fd->open = dataflash_open;
496 fd->close = dataflash_close;
497 fd->read = dataflash_read;
498 fd->write = dataflash_write;
499 fd->seek = dataflash_seek;
501 // Init data flash memory and micro pin.
502 ASSERT(dataflash_pin_init());
506 * Test function for dataflash.
508 * This function test check low level driver for
509 * AT45xx (see dataflash.h for more info) data flash memory.
510 * We write a string in memory in some page ad read it.
512 void dataflash_test(void)
518 uint8_t test_buf[] = "0123456789 Develer s.r.l.";
521 kprintf("\n======= Data Flash test function =========================================\n");
522 kprintf("\nThe string test is: %s\n\n", test_buf);
524 fd.open(&fd, NULL, 0);
529 if (fd.seek(&fd, 0, SEEK_SET) != 0)
530 goto dataflash_test_end;
532 // Test flash write to address 0 (page 0)
533 if (!fd->write(&fd, test_buf, sizeof(test_buf)))
534 goto dataflash_test_end;
537 if (fd.seek(&fd, 0, SEEK_SET) != 0)
538 goto dataflash_test_end;
540 // Test flash read to address 0 (page 0)
541 if (!fd->read(&fd, cmp_buf, sizeof(test_buf)))
542 goto dataflash_test_end;
544 // Compare if are egual.
545 if ((memcmp(cmp_buf,test_buf, sizeof(test_buf)) == 0)
546 goto dataflash_test_end;
550 // Go to middle address memory.
551 fd.seek(&fd, (((dataflashAddr_t)DFLASH_PAGE_SIZE * (dataflashAddr_t)DFLASH_NUM_PAGE) / 2), SEEK_CUR);
553 // Test flash write at the middle of memory
554 if (!fd->write(&fd, test_buf, sizeof(test_buf)))
555 goto dataflash_test_end;
557 // Go to middle address memory.
558 fd.seek(&fd, (((dataflashAddr_t)DFLASH_PAGE_SIZE * (dataflashAddr_t)DFLASH_NUM_PAGE) / 2), SEEK_CUR);
560 // Test flash read at the middle of memory
561 if (!fd->read(&fd, cmp_buf, sizeof(test_buf)))
562 goto dataflash_test_end;
564 // Compare if are egual.
565 if ((memcmp(cmp_buf,test_buf, sizeof(test_buf)) == 0)
566 goto dataflash_test_end;
570 // Go to end of data flash.
571 fd.seek(&fd, ((dataflashAddr_t)DFLASH_PAGE_SIZE * (dataflashAddr_t)DFLASH_NUM_PAGE) - sizeof(test_buf), SEEK_END);
573 // Test flash write at the end of memory
574 if (!fd->write(&fd, test_buf, sizeof(test_buf)))
575 goto dataflash_test_end;
577 // Go to end of data flash.
578 fd.seek(&fd, ((dataflashAddr_t)DFLASH_PAGE_SIZE * (dataflashAddr_t)DFLASH_NUM_PAGE) - sizeof(test_buf), SEEK_END);
580 // Test flash read at the end of memory
581 if (!fd->read(&fd, cmp_buf, sizeof(test_buf)))
582 goto dataflash_test_end;
584 // Compare if are egual.
585 if ((memcmp(cmp_buf,test_buf, sizeof(test_buf)) == 0)
586 goto dataflash_test_end;
590 kprintf("\n====== Test end ===========================================================\n");