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 AT45DB081D Flash memory.
36 * \version $Id: dflash.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/dflash.h>
54 * Send a generic command to data flash memory.
55 * This function send only 4 byte, for opcode, page address and
58 static void send_cmd(dflashAddr_t page_addr, dflashAddr_t byte_addr, DFlashOpcode opcode)
62 * Make sure to toggle CS signal in order,
63 * and reset dflash command decoder.
66 * #define CS_TOGGLE() \
74 * To send one command to data flash memory, we send 4 byte.
75 * First byte is opcode command, second and third byte are
76 * page address, in last byte we write a byte page address.
77 * (see datasheet for more detail).
79 * \note Generaly a defaul memory page size is more than 256 byte.
80 * In this case we need for addressing a byte in one page more than
81 * 8 bit, so we put in fourth byte low part of address byte, and
82 * hight part of address byte in third byte togheter low par of page
97 spi_sendRecv((uint8_t)(page_addr >> (16 - DFLASH_PAGE_ADDRESS_BIT)));
98 spi_sendRecv((uint8_t)((page_addr << (DFLASH_PAGE_ADDRESS_BIT - 8)) + (byte_addr >> 8)));
102 * Send byte page address.
104 spi_sendRecv((uint8_t)byte_addr);
111 * Reset dataflash memory function.
113 * This function reset data flash memory
114 * with one pulse reset long about 10usec.
117 static void dflash_reset(void)
121 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
124 timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
128 * dflash init function.
129 * This function initialize a micro pin and
130 * SPI driver, and test if data flash memory
131 * density is the same wich define in dflash.h.
134 static bool dflash_pin_init(void)
141 WRITE_ENABLE(); //pilot wp pin.
148 stat = dflash_stat();
153 * 2,3,4,5 bit of 1 byte status register
154 * indicate a device density of dflash memory
155 * (see datasheet for more detail.)
157 GET_ID_DESITY_DEVICE(stat);
159 if(stat == DFLASH_ID_DEVICE_DENSITY)
168 * Read status register of dataflah memory.
171 static uint8_t dflash_stat(void)
176 * Make sure to toggle CS signal in order,
177 * and reset dflash command decoder.
182 stat = spi_sendRecv(DFO_READ_STATUS);
183 stat = spi_sendRecv(0x00);
190 * Send one command to data flash memory, and
191 * return status register value.
194 static uint8_t dflash_cmd(dflashAddr_t page_addr, dflashAddr_t byte_addr, DFlashOpcode opcode)
197 send_cmd(page_addr, byte_addr, opcode);
203 * We chech data flash memory state, and wait until busy-flag
206 while(!(dflash_stat() & BUSY_BIT));
208 return (dflash_stat());
213 * Read one byte from main data flash memory or buffer data
216 static uint8_t dflash_read_byte(dflashAddr_t page_addr, dflashAddr_t byte_addr, DFlashOpcode opcode)
220 send_cmd(page_addr, byte_addr, opcode);
222 #if CONFIG_DATA_FLASH == AT45DB041B
223 if(opcode == DFO_READ_FLASH_MEM_BYTE)
226 * Send 24 don't care bit.
237 spi_sendRecv(0x00); //Send 8 don't care bit.
238 data = spi_sendRecv(0x00); //Read byte.
245 * Read \a len bytes from main data flash memory or buffer data
246 * flash memory, and put it in \a *block.
248 static void dflash_read_block(dflashAddr_t page_addr, dflashAddr_t byte_addr, DFlashOpcode opcode, uint8_t *block, dflashSize_t len)
251 send_cmd(page_addr, byte_addr, opcode);
253 if(opcode == DFO_READ_FLASH_MEM_BYTE)
256 * Send 24 don't care bit.
265 spi_sendRecv(0x00); //Send 8 don't care bit.
266 spi_read(block, len); //Read len bytes ad put in block buffer.
275 * Write \a len bytes in buffer buffer data flash memory.
277 * \note Isn't possible to write bytes directly in main memory data
278 * flash. To perform write in main memory you must before write in buffer
279 * data flash memory, an then send command to write page in main memory.
281 static void dflash_write_block(dflashAddr_t byte_addr, DFlashOpcode opcode, uint8_t *block, dflashSize_t len)
284 send_cmd(0x00, byte_addr, opcode);
286 spi_write(block, len); //Write len bytes.
292 /* Kfile interface section */
295 * Open data flash file \a fd
296 * \a name and \a mode are unused, cause flash memory is
297 * threated like one file.
299 static bool dflash_open(struct _KFile *fd, UNUSED_ARG(const char *, name), UNUSED_ARG(int, mode))
306 static bool dflash_close(UNUSED_ARG(struct _KFile *,fd))
311 * Move \a fd file seek position of \a offset bytes
312 * from current position.
314 static int32_t dflash_seek(struct _KFile *fd, int32_t offset, KSeekMode whence)
319 * Read from file \a fd \a size bytes and put it in buffer \a buf
320 * \return the number of bytes read.
322 static size_t dflash_read(struct _KFile *fd, void *buf, size_t size)
327 * Init data flash memory interface.
329 void dflash_init(struct _KFile *fd)
331 // Set up data flash programming functions.
332 fd->open = dflash_open;
333 fd->close = dflash_close;
334 fd->read = dflash_read;
335 fd->write = dflash_write;
336 fd->seek = dflash_seek;
338 // Init data flash memory and micro pin.
339 ASSERT(dflash_pin_init());