summaryrefslogtreecommitdiff
path: root/include/dataflash.h (plain)
blob: 142b55546f3efc21c8cc4235c6e1d2a95eb05616
1/*
2 * (C) Copyright 2003
3 * Data Flash Atmel Description File
4 * Author : Hamid Ikdoumi (Atmel)
5 *
6 * SPDX-License-Identifier: GPL-2.0+
7 */
8
9/* File Name : dataflash.h */
10/* Object : Data Flash Atmel Description File */
11/* Translator : */
12/* */
13/* 1.0 03/04/01 HI : Creation */
14/* 1.2 20/10/02 FB : Adapatation Service and Lib v3 */
15/*----------------------------------------------------------------------*/
16
17#ifndef _DataFlash_h
18#define _DataFlash_h
19
20
21#include "config.h"
22
23/*number of protected area*/
24#define NB_DATAFLASH_AREA 5
25
26#ifdef CONFIG_SYS_NO_FLASH
27
28/*-----------------------------------------------------------------------
29 * return codes from flash_write():
30 */
31# define ERR_OK 0
32# define ERR_TIMOUT 1
33# define ERR_NOT_ERASED 2
34# define ERR_PROTECTED 4
35# define ERR_INVAL 8
36# define ERR_ALIGN 16
37# define ERR_UNKNOWN_FLASH_VENDOR 32
38# define ERR_UNKNOWN_FLASH_TYPE 64
39# define ERR_PROG_ERROR 128
40
41/*-----------------------------------------------------------------------
42 * Protection Flags for flash_protect():
43 */
44# define FLAG_PROTECT_SET 0x01
45# define FLAG_PROTECT_CLEAR 0x02
46# define FLAG_PROTECT_INVALID 0x03
47
48/*-----------------------------------------------------------------------
49 * Set Environment according to label:
50 */
51# define FLAG_SETENV 0x80
52#endif /* CONFIG_SYS_NO_FLASH */
53
54/*define the area structure*/
55typedef struct {
56 unsigned long start;
57 unsigned long end;
58 unsigned char protected;
59 unsigned char setenv;
60 unsigned char label[20];
61} dataflash_protect_t;
62
63typedef unsigned int AT91S_DataFlashStatus;
64
65/*----------------------------------------------------------------------*/
66/* DataFlash Structures */
67/*----------------------------------------------------------------------*/
68
69/*---------------------------------------------*/
70/* DataFlash Descriptor Structure Definition */
71/*---------------------------------------------*/
72typedef struct _AT91S_DataflashDesc {
73 unsigned char *tx_cmd_pt;
74 unsigned int tx_cmd_size;
75 unsigned char *rx_cmd_pt;
76 unsigned int rx_cmd_size;
77 unsigned char *tx_data_pt;
78 unsigned int tx_data_size;
79 unsigned char *rx_data_pt;
80 unsigned int rx_data_size;
81 volatile unsigned char state;
82 volatile unsigned char DataFlash_state;
83 unsigned char command[8];
84} AT91S_DataflashDesc, *AT91PS_DataflashDesc;
85
86/*---------------------------------------------*/
87/* DataFlash device definition structure */
88/*---------------------------------------------*/
89typedef struct _AT91S_Dataflash {
90 int pages_number; /* dataflash page number */
91 int pages_size; /* dataflash page size */
92 int page_offset; /* page offset in command */
93 int byte_mask; /* byte mask in command */
94 int cs;
95 dataflash_protect_t area_list[NB_DATAFLASH_AREA]; /* area protection status */
96} AT91S_DataflashFeatures, *AT91PS_DataflashFeatures;
97
98/*---------------------------------------------*/
99/* DataFlash Structure Definition */
100/*---------------------------------------------*/
101typedef struct _AT91S_DataFlash {
102 AT91PS_DataflashDesc pDataFlashDesc; /* dataflash descriptor */
103 AT91PS_DataflashFeatures pDevice; /* Pointer on a dataflash features array */
104} AT91S_DataFlash, *AT91PS_DataFlash;
105
106
107typedef struct _AT91S_DATAFLASH_INFO {
108
109 AT91S_DataflashDesc Desc;
110 AT91S_DataflashFeatures Device; /* Pointer on a dataflash features array */
111 unsigned long logical_address;
112 unsigned long end_address;
113 unsigned int id; /* device id */
114} AT91S_DATAFLASH_INFO, *AT91PS_DATAFLASH_INFO;
115
116struct dataflash_addr {
117 unsigned long addr;
118 int cs;
119};
120/*-------------------------------------------------------------------------------------------------*/
121#define AT45DB161 0x2c
122#define AT45DB021 0x14
123#define AT45DB081 0x24
124#define AT45DB321 0x34
125#define AT45DB642 0x3c
126#define AT45DB128 0x10
127#define PAGES_PER_BLOCK 8
128
129#define AT91C_DATAFLASH_TIMEOUT 10000 /* For AT91F_DataFlashWaitReady */
130
131/* DataFlash return value */
132#define DATAFLASH_BUSY 0x00
133#define DATAFLASH_OK 0x01
134#define DATAFLASH_ERROR 0x02
135#define DATAFLASH_MEMORY_OVERFLOW 0x03
136#define DATAFLASH_BAD_COMMAND 0x04
137#define DATAFLASH_BAD_ADDRESS 0x05
138
139
140/* Driver State */
141#define IDLE 0x0
142#define BUSY 0x1
143#define ERROR 0x2
144
145/* DataFlash Driver State */
146#define GET_STATUS 0x0F
147
148/*-------------------------------------------------------------------------------------------------*/
149/* Command Definition */
150/*-------------------------------------------------------------------------------------------------*/
151
152/* READ COMMANDS */
153#define DB_CONTINUOUS_ARRAY_READ 0xE8 /* Continuous array read */
154#define DB_BURST_ARRAY_READ 0xE8 /* Burst array read */
155#define DB_PAGE_READ 0xD2 /* Main memory page read */
156#define DB_BUF1_READ 0xD4 /* Buffer 1 read */
157#define DB_BUF2_READ 0xD6 /* Buffer 2 read */
158#define DB_STATUS 0xD7 /* Status Register */
159
160/* PROGRAM and ERASE COMMANDS */
161#define DB_BUF1_WRITE 0x84 /* Buffer 1 write */
162#define DB_BUF2_WRITE 0x87 /* Buffer 2 write */
163#define DB_BUF1_PAGE_ERASE_PGM 0x83 /* Buffer 1 to main memory page program with built-In erase */
164#define DB_BUF1_PAGE_ERASE_FASTPGM 0x93 /* Buffer 1 to main memory page program with built-In erase, Fast program */
165#define DB_BUF2_PAGE_ERASE_PGM 0x86 /* Buffer 2 to main memory page program with built-In erase */
166#define DB_BUF2_PAGE_ERASE_FASTPGM 0x96 /* Buffer 1 to main memory page program with built-In erase, Fast program */
167#define DB_BUF1_PAGE_PGM 0x88 /* Buffer 1 to main memory page program without built-In erase */
168#define DB_BUF1_PAGE_FASTPGM 0x98 /* Buffer 1 to main memory page program without built-In erase, Fast program */
169#define DB_BUF2_PAGE_PGM 0x89 /* Buffer 2 to main memory page program without built-In erase */
170#define DB_BUF2_PAGE_FASTPGM 0x99 /* Buffer 1 to main memory page program without built-In erase, Fast program */
171#define DB_PAGE_ERASE 0x81 /* Page Erase */
172#define DB_BLOCK_ERASE 0x50 /* Block Erase */
173#define DB_PAGE_PGM_BUF1 0x82 /* Main memory page through buffer 1 */
174#define DB_PAGE_FASTPGM_BUF1 0x92 /* Main memory page through buffer 1, Fast program */
175#define DB_PAGE_PGM_BUF2 0x85 /* Main memory page through buffer 2 */
176#define DB_PAGE_FastPGM_BUF2 0x95 /* Main memory page through buffer 2, Fast program */
177
178/* ADDITIONAL COMMANDS */
179#define DB_PAGE_2_BUF1_TRF 0x53 /* Main memory page to buffer 1 transfert */
180#define DB_PAGE_2_BUF2_TRF 0x55 /* Main memory page to buffer 2 transfert */
181#define DB_PAGE_2_BUF1_CMP 0x60 /* Main memory page to buffer 1 compare */
182#define DB_PAGE_2_BUF2_CMP 0x61 /* Main memory page to buffer 2 compare */
183#define DB_AUTO_PAGE_PGM_BUF1 0x58 /* Auto page rewrite throught buffer 1 */
184#define DB_AUTO_PAGE_PGM_BUF2 0x59 /* Auto page rewrite throught buffer 2 */
185
186/*-------------------------------------------------------------------------------------------------*/
187
188extern int size_dataflash (AT91PS_DataFlash pdataFlash, unsigned long addr, unsigned long size);
189extern int prot_dataflash (AT91PS_DataFlash pdataFlash, unsigned long addr);
190extern int addr2ram(ulong addr);
191extern int dataflash_real_protect (int flag, unsigned long start_addr, unsigned long end_addr);
192extern int addr_dataflash (unsigned long addr);
193extern int read_dataflash (unsigned long addr, unsigned long size, char *result);
194extern int write_dataflash(unsigned long addr_dest, unsigned long addr_src,
195 unsigned long size);
196extern int AT91F_DataflashInit(void);
197
198extern void dataflash_print_info (void);
199extern void dataflash_perror (int err);
200extern void AT91F_DataflashSetEnv (void);
201
202extern struct dataflash_addr cs[CONFIG_SYS_MAX_DATAFLASH_BANKS];
203extern dataflash_protect_t area_list[NB_DATAFLASH_AREA];
204extern AT91S_DATAFLASH_INFO dataflash_info[];
205#endif
206
generated by cgit at 2024-05-19 15:36:43 (GMT)