bertos/drv/flash25.h

   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 serial Flash memory.
  34  *
  35  *
  36  * \version $Id$
  37  * \author Daniele Basile <asterix@develer.com>
  38  */
  39
  40
  41 #ifndef DRV_FLASH25_H
  42 #define DRV_FLASH25_H
  43
  44 #include <cfg/compiler.h>
  45 #include "cfg/cfg_flash25.h"
  46
  47 #include <kern/kfile.h>
  48
  49 /**
  50  * Type definition for serial flash memory.
  51  */
  52 typedef uint32_t flash25Addr_t;
  53 typedef uint32_t flash25Size_t;
  54 typedef uint8_t flash25Offset_t;
  55
  56 /**
  57  * Flash25 KFile context structure.
  58  */
  59 typedef struct KFileFlash25
  60 {
  61         KFile fd;                       ///< File descriptor.
  62         KFile *channel;                 ///< Dataflash comm channel (usually SPI).
  63 } KFileFlash25;
  64
  65 /**
  66  * ID for dataflash.
  67  */
  68 #define KFT_FLASH25 MAKE_ID('F', 'L', '2', '5')
  69
  70
  71 /**
  72  * Convert + ASSERT from generic KFile to KFileFlash25.
  73  */
  74 INLINE KFileFlash25 * KFILEFLASH25(KFile *fd)
  75 {
  76         ASSERT(fd->_type == KFT_FLASH25);
  77         return (KFileFlash25 *)fd;
  78 }
  79
  80 /**
  81  * Memory definition.
  82  *
  83  * \note Below are defined valid serial flash memory support to
  84  * this drive. Every time we call flash25_init() function we check
  85  * if memory defined are right (see flash25.c form more detail).
  86  * \{
  87  */
  88 #define FLASH25_AT25F2048         1
  89
  90 #if CONFIG_FLASH25 == FLASH25_AT25F2048
  91         #define FLASH25_MANUFACTURER_ID    0x1F  // ATMEL
  92         #define FLASH25_DEVICE_ID          0x63  // Device ID
  93         #define FLASH25_PAGE_SIZE          256   // Page size in byte
  94         #define FLASH25_NUM_SECTOR         4     // Number of section in serial memory
  95         #define FLASH25_SECTOR_SIZE        65536UL // Section size in byte
  96         #define FLASH25_MEM_SIZE           FLASH25_NUM_SECTOR * FLASH25_SECTOR_SIZE
  97         #define FLASH25_NUM_PAGE           FLASH25_MEM_SIZE / FLASH25_PAGE_SIZE
  98 #elif
  99         #error Nothing memory defined in CONFIG_FLASH25 are support.
 100 #endif
 101
 102 #define RDY_BIT     0x1 // Statuts of write cycle
 103 /* \} */
 104
 105 /**
 106  * Serial flash opcode commands.
 107  */
 108 typedef enum {
 109         FLASH25_WREN            = 0x6,  ///< Set write enable latch
 110         FLASH25_WRDI            = 0x4,  ///< Reset enable write latch
 111         FLASH25_RDSR            = 0x5,  ///< Read status register
 112         FLASH25_WRSR            = 0x1,  ///< Write status register
 113         FLASH25_READ            = 0x3,  ///< Read data from memory array
 114         FLASH25_PROGRAM         = 0x2,  ///< Program data into memory array
 115         FLASH25_SECTORE_ERASE   = 0x52, ///< Erase one sector in memory array
 116         FLASH25_CHIP_ERASE      = 0x62, ///< Erase all sector in memory array
 117         FLASH25_RDID            = 0x15 ///< Read Manufacturer and product ID
 118 } Flash25Opcode;
 119
 120 /**
 121  * Serial flash sector memory address.
 122  */
 123 #if CONFIG_FLASH25 != FLASH25_AT25F2048
 124         #error Nothing memory defined in CONFIG_FLASH25 are support.
 125 #endif
 126
 127 typedef enum {
 128         FLASH25_SECT1            = 0x0,      ///< Sector 1 (0x0 -0xFFFF)
 129         FLASH25_SECT2            = 0x10000,  ///< Sector 2 (0x10000 -0x1FFFF)
 130         FLASH25_SECT3            = 0x20000,  ///< Sector 3 (0x20000 -0x2FFFF)
 131         FLASH25_SECT4            = 0x30000,  ///< Sector 4 (0x30000 -0x3FFFF)
 132 } Flash25Sector;
 133
 134 void flash25_init(KFileFlash25 *fd, KFile *ch);
 135 void flash25_chipErase(KFileFlash25 *fd);
 136 void flash25_sectorErase(KFileFlash25 *fd, Flash25Sector sector);
 137 bool flash25_test(KFile *channel);
 138
 139 #endif /* DRV_FLASH25_H */
 140