1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/* ----------------------------------------------------------------------------
* ATMEL Microcontroller Software Support
* ----------------------------------------------------------------------------
* Copyright (c) 2008, Atmel Corporation
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
*
* Atmel's name may not be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ----------------------------------------------------------------------------
*/
//------------------------------------------------------------------------------
/// \unit
/// !Purpose
///
/// Type and methods for manipulating NandFlash models.
///
/// !Usage
///
/// -# Find the model of a NandFlash using its device ID with the
/// NandFlashModel_Find function.
///
/// -# Retrieve parameters of a NandFlash model using the following functions:
/// - NandFlashModel_GetDeviceId
/// - NandFlashModel_GetDeviceSizeInBlocks
/// - NandFlashModel_GetDeviceSizeInPages
/// - NandFlashModel_GetDeviceSizeInBytes
/// - NandFlashModel_GetBlockSizeInPages
/// - NandFlashModel_GetBlockSizeInBytes
/// - NandFlashModel_GetPageDataSize
/// - NandFlashModel_GetPageSpareSize
/// - NandFlashModel_GetDataBusWidth
/// - NandFlashModel_UsesSmallBlocksRead
/// - NandFlashModel_UsesSmallBlocksWrite
//------------------------------------------------------------------------------
#ifndef NANDFLASHMODEL_H
#define NANDFLASHMODEL_H
//------------------------------------------------------------------------------
// Forward declarations
//------------------------------------------------------------------------------
struct NandSpareScheme;
//------------------------------------------------------------------------------
// Definitions
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
/// \page "NandFlashModel options"
/// This page lists the possible options for a NandFlash chip.
///
/// !Options
/// - NandFlashModel_DATABUS8
/// - NandFlashModel_DATABUS16
/// - NandFlashModel_COPYBACK
/// Indicates the Nand uses an 8-bit databus.
#define NandFlashModel_DATABUS8 (0 << 0)
/// Indicates the Nand uses a 16-bit databus.
#define NandFlashModel_DATABUS16 (1 << 0)
/// The Nand supports the copy-back function (internal page-to-page copy).
#define NandFlashModel_COPYBACK (1 << 1)
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
// Types
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
/// Describes a particular model of NandFlash device.
//------------------------------------------------------------------------------
struct NandFlashModel {
/// Identifier for the device.
unsigned char deviceId;
/// Special options for the NandFlash.
unsigned char options;
/// Size of the data area of a page, in bytes.
unsigned short pageSizeInBytes;
/// Size of the device in MB.
unsigned short deviceSizeInMegaBytes;
/// Size of one block in kilobytes.
unsigned short blockSizeInKBytes;
/// Spare area placement scheme
const struct NandSpareScheme *scheme;
};
//------------------------------------------------------------------------------
// Exported functions
//------------------------------------------------------------------------------
extern unsigned char NandFlashModel_Find(
const struct NandFlashModel *modelList,
unsigned int size,
unsigned int id,
struct NandFlashModel *model);
extern unsigned char NandFlashModel_TranslateAccess(
const struct NandFlashModel *model,
unsigned int address,
unsigned int size,
unsigned short *block,
unsigned short *page,
unsigned short *offset);
extern const struct NandSpareScheme * NandFlashModel_GetScheme(
const struct NandFlashModel *model);
extern unsigned char NandFlashModel_GetDeviceId(
const struct NandFlashModel *model);
extern unsigned short NandFlashModel_GetDeviceSizeInBlocks(
const struct NandFlashModel *model);
extern unsigned int NandFlashModel_GetDeviceSizeInPages(
const struct NandFlashModel *model);
extern unsigned long long NandFlashModel_GetDeviceSizeInBytes(
const struct NandFlashModel *model);
extern unsigned int NandFlashModel_GetDeviceSizeInMBytes(
const struct NandFlashModel *model);
extern unsigned short NandFlashModel_GetBlockSizeInPages(
const struct NandFlashModel *model);
extern unsigned int NandFlashModel_GetBlockSizeInBytes(
const struct NandFlashModel *model);
extern unsigned short NandFlashModel_GetPageDataSize(
const struct NandFlashModel *model);
extern unsigned char NandFlashModel_GetPageSpareSize(
const struct NandFlashModel *model);
extern unsigned char NandFlashModel_GetDataBusWidth(
const struct NandFlashModel *model);
extern unsigned char NandFlashModel_HasSmallBlocks(
const struct NandFlashModel *model);
extern unsigned char NandFlashModel_SupportsCopyBack(
const struct NandFlashModel *model);
#endif //#ifndef NANDFLASHMODEL_H
|
