drv/dataflash.c

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  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.
  28  *
  29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  *  \brief Function library for AT45DBXX Data Flash memory.
  34  *
  35  *
  36  * \version $Id: dataflash.c 15379 2007-03-28 15:46:09Z asterix $
  37  * \author Daniele Basile <asterix@develer.com>
  38  */
  39
  40
  41 #include <appconfig.h>
  42
  43 #include <avr/io.h>
  44 #include <cfg/macros.h>
  45 #include <cfg/debug.h>
  46 #include <cfg/module.h>
  47 #include <drv/timer.h>
  48 #include <drv/spi.h>
  49 #include <drv/dataflash.h>
  50
  51 #include "hw_spi.h"
  52
  53
  54 /**
  55  * Global variable for store current and previous data
  56  * flash memory page address during operation of writing.
  57  */
  58 static dataflash_t previous_page = 0;
  59 static bool page_modified = false;
  60
  61
  62 /**
  63  * Send a generic command to data flash memory.
  64  * This function send only 4 byte, for opcode, page address and
  65  * byte address.
  66  */
  67 static void send_cmd(dataflash_t page_addr, dataflashOffset_t byte_addr, DataFlashOpcode opcode)
  68 {
  69
  70         /*
  71          * Make sure to toggle CS signal in order,
  72          * and reset dataflash command decoder.
  73          *
  74          * \note This is equivalent to CS_DISABLE() immediately followed by CS_ENABLE()
  75          */
  76         CS_TOGGLE();
  77
  78
  79         /*
  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).
  84          *
  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
  89          *  address.
  90          *
  91          */
  92
  93         /*
  94          * Send opcode.
  95          */
  96         spi_sendRecv(opcode);
  97
  98         /*
  99          *  Send page address.
 100          */
 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)));
 103
 104         /*
 105          * Send byte page address.
 106          */
 107         spi_sendRecv((uint8_t)byte_addr);
 108
 109
 110 }
 111
 112 /**
 113  * Reset dataflash memory function.
 114  *
 115  * This function reset data flash memory
 116  * with one pulse reset long about 10usec.
 117  *
 118  */
 119 static void dataflash_reset(void)
 120 {
 121         CS_ENABLE();
 122         RESET_ENABLE();
 123         timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
 124         CS_DISABLE();
 125         RESET_DISABLE();
 126         timer_delayHp(us_to_hptime(RESET_PULSE_WIDTH));
 127 }
 128
 129 /**
 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.
 134  */
 135 MOD_DEFINE(dataflash);
 136 static bool dataflash_pin_init(void)
 137 {
 138         uint8_t stat;
 139
 140         MOD_CHECK(spi);
 141
 142         RESET_DISABLE();
 143         WRITE_ENABLE(); //pilot wp pin.
 144
 145         RESET_OUT();
 146         WP_OUT();
 147
 148         dataflash_reset();
 149
 150         stat = dataflash_stat();
 151
 152         MOD_INIT(dataflash);
 153
 154         /*
 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.)
 158          */
 159         GET_ID_DESITY_DEVICE(stat);
 160
 161         if(stat == DATAFLASH_ID_DEVICE_DENSITY)
 162                 return true;
 163         else
 164                 return false;
 165
 166 }
 167
 168
 169 /**
 170  * Read status register of dataflah memory.
 171  *
 172  */
 173 static uint8_t dataflash_stat(void)
 174 {
 175         uint8_t stat;
 176
 177         /*
 178          * Make sure to toggle CS signal in order,
 179          * and reset dataflash command decoder.
 180          */
 181         CS_TOGGLE();
 182
 183         stat = spi_sendRecv(DFO_READ_STATUS);
 184         stat = spi_sendRecv(0x00);
 185
 186         /*
 187          * Note: this function could be call one more time
 188          * to check register status (es. check if memory has been
 189          * teminate one operation), and so we don't disable CS to
 190          * allow fast reading of register status.
 191          */
 192         return stat;
 193 }
 194
 195
 196 /**
 197  * Send one command to data flash memory, and
 198  * return status register value.
 199  *
 200  */
 201 static uint8_t dataflash_cmd(dataflash_t page_addr, dataflashOffset_t byte_addr, DataFlashOpcode opcode)
 202 {
 203
 204         uint8_t stat;
 205
 206         send_cmd(page_addr, byte_addr, opcode);
 207
 208         CS_TOGGLE();
 209
 210         /*
 211          * We chech data flash memory state, and wait until busy-flag
 212          * is hight.
 213          */
 214         while(!(dataflash_stat() & BUSY_BIT));
 215
 216         stat = dataflash_stat();
 217
 218         /*
 219          * Data flash has been terminate a sent command, and so
 220          * disable CS.
 221          */
 222         CS_DISABLE();
 223
 224         return (stat);
 225
 226 }
 227
 228 /**
 229  * Read one byte from main data flash memory or buffer data
 230  * flash memory.
 231  */
 232 static uint8_t dataflash_read_byte(dataflash_t page_addr, dataflashOffset_t byte_addr, DataFlashOpcode opcode)
 233 {
 234         uint8_t data;
 235
 236         send_cmd(page_addr, byte_addr, opcode);
 237
 238 #if CONFIG_DATA_FLASH == DATAFLASH_AT45DB041B
 239         if(opcode == DFO_READ_FLASH_MEM_BYTE)
 240         {
 241                 /*
 242                  * Send 24 don't care bit.
 243                  */
 244                 spi_sendRecv(0x00);
 245                 spi_sendRecv(0x00);
 246                 spi_sendRecv(0x00);
 247
 248         }
 249 #endif
 250
 251         spi_sendRecv(0x00);         //Send 8 don't care bit.
 252         data = spi_sendRecv(0x00);  //Read byte.
 253
 254         CS_DISABLE();
 255
 256         return data;
 257 }
 258
 259 /**
 260  * Read \a len bytes from main data flash memory or buffer data
 261  * flash memory, and put it in \a *block.
 262  */
 263 static void dataflash_read_block(dataflash_t page_addr, dataflashOffset_t byte_addr, DataFlashOpcode opcode, uint8_t *block, dataflashSize_t len)
 264 {
 265
 266         send_cmd(page_addr, byte_addr, opcode);
 267
 268         if(opcode == DFO_READ_FLASH_MEM_BYTE)
 269         {
 270                 /*
 271                  * Send 24 don't care bit.
 272                  */
 273                 spi_sendRecv(0x00);
 274                 spi_sendRecv(0x00);
 275                 spi_sendRecv(0x00);
 276
 277         }
 278
 279         spi_sendRecv(0x00);   //Send 8 don't care bit.
 280         spi_read(block, len); //Read len bytes ad put in block buffer.
 281
 282
 283         CS_DISABLE();
 284
 285 }
 286
 287
 288 /**
 289  * Write \a len bytes in buffer buffer data flash memory.
 290  *
 291  * \note Isn't possible to write bytes directly in main memory data
 292  * flash. To perform write in main memory you must before write in buffer
 293  * data flash memory, an then send command to write page in main memory.
 294  */
 295 static void dataflash_write_block(dataflashOffset_t byte_addr, DataFlashOpcode opcode, uint8_t *block, dataflashSize_t len)
 296 {
 297
 298         send_cmd(0x00, byte_addr, opcode);
 299
 300         spi_write(block, len); //Write len bytes.
 301
 302         CS_DISABLE();
 303
 304 }
 305
 306
 307 /**
 308  * Load selct page from dataflash memory to buffer.
 309  */
 310 static void dataflash_loadPage(dataflash_t page_addr)
 311 {
 312         dataflash_cmd(page_addr, 0x00, DFO_MOV_MEM_TO_BUFF1);
 313 }
 314
 315 /**
 316  * Flush select page (stored in buffer) in data flash main memory page.
 317  */
 318 void dataflash_flush(void)
 319 {
 320         if (page_modified)
 321         {
 322                 dataflash_cmd(previous_page, 0x00, DFO_WRITE_BUFF1_TO_MEM_E);
 323
 324                 page_modified = false;
 325
 326                 kprintf("\n::=> Flush page:... <%ld>\n", previous_page);
 327         }
 328 }
 329
 330 /* Kfile interface section */
 331
 332 /**
 333  * Open data flash file \a fd
 334  * \a name and \a mode are unused, cause flash memory is
 335  * threated like one file.
 336  */
 337 static bool dataflash_open(struct _KFile *fd, UNUSED_ARG(const char *, name), UNUSED_ARG(int, mode))
 338 {
 339         MOD_CHECK(dataflash);
 340
 341         previous_page = 0;
 342         fd->seek_pos = 0;
 343         fd->size = (dataflashAddr_t)DATAFLASH_PAGE_SIZE *       (dataflashAddr_t)DATAFLASH_NUM_PAGE;
 344
 345         /* Load select page memory from data flash memory*/
 346         dataflash_loadPage(previous_page);
 347
 348         kprintf("dataflash file opened\n");
 349         return true;
 350 }
 351
 352 /**
 353  * Close file \a fd
 354  */
 355 static bool dataflash_close(UNUSED_ARG(struct _KFile *,fd))
 356 {
 357         dataflash_flush();
 358         kprintf("dataflash file closed\n");
 359         return true;
 360 }
 361
 362 /**
 363  * Move \a fd file seek position of \a offset bytes
 364  * from current position.
 365  */
 366 static int32_t dataflash_seek(struct _KFile *fd, int32_t offset, KSeekMode whence)
 367 {
 368         uint32_t seek_pos;
 369
 370         switch(whence)
 371         {
 372                 case KSM_SEEK_SET:
 373                         seek_pos = 0;
 374                         break;
 375                 case KSM_SEEK_END:
 376                         seek_pos = fd->size - 1;
 377                         break;
 378                 case KSM_SEEK_CUR:
 379                         seek_pos = fd->seek_pos;
 380                         break;
 381                 default:
 382                         ASSERT(0);
 383                         return -1;
 384                         break;
 385         }
 386
 387         /* Bound check */
 388         if (seek_pos + offset > fd->size)
 389         {
 390                 ASSERT(0);
 391                 return -1;
 392         }
 393
 394         fd->seek_pos = seek_pos + offset;
 395         kprintf("Flash seek to [%u]\n", fd->seek_pos);
 396
 397         return fd->seek_pos;
 398 }
 399
 400 /**
 401  * Read from file \a fd \a size bytes and put it in buffer \a buf
 402  * \return the number of bytes read.
 403  */
 404 static size_t dataflash_read(struct _KFile *fd, void *buf, size_t size)
 405 {
 406         dataflashOffset_t byte_addr;
 407         dataflashAddr_t page_addr;
 408         uin8_t *data = (uint8_t *)buf;
 409
 410
 411         ASSERT(fd->seek_pos + size <= fd->size);
 412         size = MIN((uint32_t)size, fd->size - fd->seek_pos);
 413
 414         kprintf("Reading at pos[%u]\n", fd->seek_pos);
 415
 416         /*
 417          * We select from absolute address page address
 418          * and byte address in page.
 419          */
 420         page_addr = fd->seek_pos / (dataflashAddr_t)DATAFLASH_PAGE_SIZE;
 421         byte_addr = fd->seek_pos % (dataflashAddr_t)DATAFLASH_PAGE_SIZE;
 422
 423
 424         kprintf(" [page-<%ld>, byte-<%ld>]", page_addr, byte_addr);
 425
 426         /*
 427          * Flush current page in main memory if
 428          * we had been written a byte in memory
 429          */
 430         dataflash_flush();
 431
 432         /*
 433          * Read byte in main page data flash memory.
 434          */
 435         dataflash_read_block(page_addr, byte_addr, DFO_READ_FLASH_MEM_BYTE, data, size);
 436
 437         fd->seek_pos += size;
 438         kprintf(" ::=> Read data: %02x\n",data);
 439
 440         return size;
 441 }
 442
 443 /**
 444  * Write program memory.
 445  * Write \a size bytes from buffer \a _buf to file \a fd
 446  * \note Write operations are buffered.
 447  */
 448 static size_t dataflash_write(struct _KFile *fd, const void *_buf, size_t size)
 449 {
 450
 451         dataflashOffset_t byte_addr;
 452         dataflashAddr_t current_page;
 453
 454         uint8_t *data = (uint8_t *) _buf;
 455
 456         ASSERT(fd->seek_pos + size <= fd->size);
 457         size = MIN((uint32_t)size, fd->size - fd->seek_pos);
 458
 459         kprintf("Writing at pos[%u]\n", fd->seek_pos);
 460
 461         while (size)
 462         {
 463                 /*
 464                 * We select from absolute address page address
 465                 * and byte address in page.
 466                 */
 467                 current_page = fd->seek_pos / (dataflashAddr_t)DATAFLASH_PAGE_SIZE;
 468                 byte_addr = fd->seek_pos % (dataflashAddr_t)DATAFLASH_PAGE_SIZE;
 469
 470
 471                 size_t wr_len = MIN(size, DATAFLASH_PAGE_SIZE - byte_addr);
 472
 473                 kprintf(" [page-<%ld>, byte-<%ld>]",current_page, byte_addr);
 474
 475                 if (current_page != previous_page)
 476                 {
 477                         /* Flush current page in main memory*/
 478                         dataflash_flush();
 479                         /* Load select page memory from data flash memory*/
 480                         dataflash_loadPage(current_page);
 481
 482                         previous_page = current_page;
 483                         kprintf(" >> Load page: <%ld> ",current_page);
 484                 }
 485                 /*
 486                 * Write byte in current page, and set true
 487                 * page_modified flag.
 488                 */
 489                 dataflash_write_byte(byte_addr, DFO_WRITE_BUFF1, data);
 490                 page_modified = true;
 491
 492
 493                 data += wr_len;
 494                 fd->seek_pos += wr_len;
 495                 size -= wr_len;
 496                 total_write += wr_len;
 497         }
 498
 499         kprintf("written %u bytes\n", total_write);
 500         return total_write;
 501 }
 502
 503 /**
 504  * Init data flash memory interface.
 505  */
 506 void dataflash_init(struct _KFile *fd)
 507 {
 508         // Set up data flash programming functions.
 509         fd->open = dataflash_open;
 510         fd->close = dataflash_close;
 511         fd->read = dataflash_read;
 512         fd->write = dataflash_write;
 513         fd->seek = dataflash_seek;
 514
 515         // Init data flash memory and micro pin.
 516         ASSERT(dataflash_pin_init());
 517 }
 518
 519 /**
 520  * Test function for dataflash.
 521  *
 522  * This function test check low level driver for
 523  * AT45xx (see dataflash.h for more info) data flash memory.
 524  * We write a string in memory in some page ad read it.
 525  */
 526 void dataflash_test(void)
 527 {
 528         KFile fd;
 529
 530         dataflash_init(&fd);
 531
 532         uint8_t test_buf[] = "0123456789 Develer s.r.l.";
 533         uint8_t cmp_buf[];
 534
 535         kprintf("\n======= Data Flash test function =========================================\n");
 536         kprintf("\nThe string test is: %s\n\n", test_buf);
 537
 538         fd.open(&fd, NULL, 0);
 539
 540         /*  TEST 1 */
 541
 542         // Seek to addr 0
 543         if (fd.seek(&fd, 0, SEEK_SET) != 0)
 544                 goto dataflash_test_end;
 545
 546         // Test flash write to address 0 (page 0)
 547         if (!fd->write(&fd, test_buf, sizeof(test_buf)))
 548                 goto dataflash_test_end;
 549
 550         // Seek to addr 0
 551         if (fd.seek(&fd, 0, SEEK_SET) != 0)
 552                 goto dataflash_test_end;
 553
 554         // Test flash read to address 0 (page 0)
 555         if (!fd->read(&fd, cmp_buf, sizeof(test_buf)))
 556                 goto dataflash_test_end;
 557
 558         // Compare if are egual.
 559         if ((memcmp(cmp_buf,test_buf, sizeof(test_buf)) == 0)
 560                 goto dataflash_test_end;
 561
 562         /*  TEST 2 */
 563
 564         // Go to middle address memory.
 565         fd.seek(&fd, (((dataflashAddr_t)DFLASH_PAGE_SIZE * (dataflashAddr_t)DFLASH_NUM_PAGE) / 2), SEEK_CUR);
 566
 567         // Test flash write at the middle of memory
 568         if (!fd->write(&fd, test_buf, sizeof(test_buf)))
 569                 goto dataflash_test_end;
 570
 571         // Go to middle address memory.
 572         fd.seek(&fd, (((dataflashAddr_t)DFLASH_PAGE_SIZE * (dataflashAddr_t)DFLASH_NUM_PAGE) / 2), SEEK_CUR);
 573
 574         // Test flash read  at the middle of memory
 575         if (!fd->read(&fd, cmp_buf, sizeof(test_buf)))
 576                 goto dataflash_test_end;
 577
 578         // Compare if are egual.
 579         if ((memcmp(cmp_buf,test_buf, sizeof(test_buf)) == 0)
 580                 goto dataflash_test_end;
 581
 582         /*  TEST 3 */
 583
 584         // Go to end of data flash.
 585         fd.seek(&fd, ((dataflashAddr_t)DFLASH_PAGE_SIZE * (dataflashAddr_t)DFLASH_NUM_PAGE) - sizeof(test_buf), SEEK_END);
 586
 587         // Test flash write at the end of memory
 588         if (!fd->write(&fd, test_buf, sizeof(test_buf)))
 589                 goto dataflash_test_end;
 590
 591         // Go to end of data flash.
 592         fd.seek(&fd, ((dataflashAddr_t)DFLASH_PAGE_SIZE * (dataflashAddr_t)DFLASH_NUM_PAGE) - sizeof(test_buf), SEEK_END);
 593
 594         // Test flash read at the end of memory
 595         if (!fd->read(&fd, cmp_buf, sizeof(test_buf)))
 596                 goto dataflash_test_end;
 597
 598         // Compare if are egual.
 599         if ((memcmp(cmp_buf,test_buf, sizeof(test_buf)) == 0)
 600                 goto dataflash_test_end;
 601
 602         kprintf("\n");
 603
 604         kprintf("\n====== Test end ===========================================================\n");
 605         fd.close(&fd);
 606         return true;
 607
 608 dataflash_test_end:
 609         fd.close(&fd);
 610         return false;
 611
 612 }