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