dataflash.h

   1 //*---------------------------------------------------------------------------
   2 //*         ATMEL Microcontroller Software Support  -  ROUSSET  -
   3 //*---------------------------------------------------------------------------
   4 //* The software is delivered "AS IS" without warranty or condition of any
   5 //* kind, either express, implied or statutory. This includes without
   6 //* limitation any warranty or condition with respect to merchantability or
   7 //* fitness for any particular purpose, or against the infringements of
   8 //* intellectual property rights of others.
   9 //*---------------------------------------------------------------------------
  10 //* File Name           : AT91_SpiDataFlash.h
  11 //* Object              : Data Flash Atmel Description File
  12 //* Translator          :
  13 //*
  14 //* 1.0 03/04/01 HI     : Creation
  15 //*
  16 //*---------------------------------------------------------------------------
  17
  18 #ifndef _DataFlash_h
  19 #define _DataFlash_h
  20
  21 #define CFG_MAX_DATAFLASH_BANKS         2
  22 #define CFG_DATAFLASH_LOGIC_ADDR_CS0    0xC0000000
  23 #define CFG_DATAFLASH_LOGIC_ADDR_CS3    0xD0000000
  24
  25
  26 typedef struct {
  27         unsigned long base;             /* logical base address for a bank */
  28         unsigned long size;             /* total bank size */
  29         unsigned long page_count;
  30         unsigned long page_size;
  31         unsigned long id;               /* device id */
  32 } dataflash_info_t;
  33
  34 typedef unsigned int AT91S_DataFlashStatus;
  35
  36 /*----------------------------------------------------------------------*/
  37 /* DataFlash Structures                                                 */
  38 /*----------------------------------------------------------------------*/
  39
  40 /*---------------------------------------------*/
  41 /* DataFlash Descriptor Structure Definition   */
  42 /*---------------------------------------------*/
  43 typedef struct _AT91S_DataflashDesc {
  44         unsigned char                   *tx_cmd_pt;
  45         unsigned int                    tx_cmd_size;
  46         unsigned char                   *rx_cmd_pt;
  47         unsigned int                    rx_cmd_size;
  48         unsigned char                   *tx_data_pt;
  49         unsigned int                    tx_data_size;
  50         unsigned char                   *rx_data_pt;
  51         unsigned int                    rx_data_size;
  52         volatile unsigned char  state;
  53         volatile unsigned char  DataFlash_state;
  54         unsigned char                   command[8];
  55 } AT91S_DataflashDesc, *AT91PS_DataflashDesc;
  56
  57 /*---------------------------------------------*/
  58 /* DataFlash device definition structure       */
  59 /*---------------------------------------------*/
  60 typedef struct _AT91S_Dataflash {
  61         int pages_number;                       /* dataflash page number */
  62         int pages_size;                         /* dataflash page size */
  63         int page_offset;                        /* page offset in command */
  64         int byte_mask;                          /* byte mask in command */
  65         int cs;
  66 } AT91S_DataflashFeatures, *AT91PS_DataflashFeatures;
  67
  68
  69 /*---------------------------------------------*/
  70 /* DataFlash Structure Definition              */
  71 /*---------------------------------------------*/
  72 typedef struct _AT91S_DataFlash {
  73         AT91PS_DataflashDesc pDataFlashDesc;    /* dataflash descriptor */
  74         AT91PS_DataflashFeatures pDevice;       /* Pointer on a dataflash features array */
  75 } AT91S_DataFlash, *AT91PS_DataFlash;
  76
  77
  78 typedef struct _AT91S_DATAFLASH_INFO {
  79
  80         AT91S_DataflashDesc     Desc;
  81         AT91S_DataflashFeatures Device; /* Pointer on a dataflash features array */
  82         unsigned long                   logical_address;
  83         unsigned int                    id;                     /* device id */
  84 } AT91S_DATAFLASH_INFO, *AT91PS_DATAFLASH_INFO;
  85
  86
  87 /*-------------------------------------------------------------------------------------------------*/
  88
  89 #define AT45DB161               0x2c
  90 #define AT45DB321               0x34
  91 #define AT45DB642               0x3c
  92 #define AT45DB128               0x10
  93
  94 #define AT91C_DATAFLASH_TIMEOUT         20000   /* For AT91F_DataFlashWaitReady */
  95
  96 /* DataFlash return value */
  97 #define AT91C_DATAFLASH_BUSY                    0x00
  98 #define AT91C_DATAFLASH_OK                              0x01
  99 #define AT91C_DATAFLASH_ERROR                   0x02
 100 #define AT91C_DATAFLASH_MEMORY_OVERFLOW 0x03
 101 #define AT91C_DATAFLASH_BAD_COMMAND             0x04
 102 #define AT91C_DATAFLASH_BAD_ADDRESS             0x05
 103
 104
 105 /* Driver State */
 106 #define IDLE            0x0
 107 #define BUSY            0x1
 108 #define ERROR           0x2
 109
 110 /* DataFlash Driver State */
 111 #define GET_STATUS      0x0F
 112
 113 /*-------------------------------------------------------------------------------------------------*/
 114 /* Command Definition                                                                              */
 115 /*-------------------------------------------------------------------------------------------------*/
 116
 117 /* READ COMMANDS */
 118 #define DB_CONTINUOUS_ARRAY_READ        0xE8    /* Continuous array read */
 119 #define DB_BURST_ARRAY_READ                     0xE8    /* Burst array read */
 120 #define DB_PAGE_READ                            0xD2    /* Main memory page read */
 121 #define DB_BUF1_READ                            0xD4    /* Buffer 1 read */
 122 #define DB_BUF2_READ                            0xD6    /* Buffer 2 read */
 123 #define DB_STATUS                                       0xD7    /* Status Register */
 124
 125 /* PROGRAM and ERASE COMMANDS */
 126 #define DB_BUF1_WRITE                           0x84    /* Buffer 1 write */
 127 #define DB_BUF2_WRITE                           0x87    /* Buffer 2 write */
 128 #define DB_BUF1_PAGE_ERASE_PGM          0x83    /* Buffer 1 to main memory page program with built-In erase */
 129 #define DB_BUF1_PAGE_ERASE_FASTPGM      0x93    /* Buffer 1 to main memory page program with built-In erase, Fast program */
 130 #define DB_BUF2_PAGE_ERASE_PGM          0x86    /* Buffer 2 to main memory page program with built-In erase */
 131 #define DB_BUF2_PAGE_ERASE_FASTPGM      0x96    /* Buffer 1 to main memory page program with built-In erase, Fast program */
 132 #define DB_BUF1_PAGE_PGM                        0x88    /* Buffer 1 to main memory page program without built-In erase */
 133 #define DB_BUF1_PAGE_FASTPGM            0x98    /* Buffer 1 to main memory page program without built-In erase, Fast program */
 134 #define DB_BUF2_PAGE_PGM                        0x89    /* Buffer 2 to main memory page program without built-In erase */
 135 #define DB_BUF2_PAGE_FASTPGM            0x99    /* Buffer 1 to main memory page program without built-In erase, Fast program */
 136 #define DB_PAGE_ERASE                           0x81    /* Page Erase */
 137 #define DB_BLOCK_ERASE                          0x50    /* Block Erase */
 138 #define DB_PAGE_PGM_BUF1                        0x82    /* Main memory page through buffer 1 */
 139 #define DB_PAGE_FASTPGM_BUF1            0x92    /* Main memory page through buffer 1, Fast program */
 140 #define DB_PAGE_PGM_BUF2                        0x85    /* Main memory page through buffer 2 */
 141 #define DB_PAGE_FastPGM_BUF2            0x95    /* Main memory page through buffer 2, Fast program */
 142
 143 /* ADDITIONAL COMMANDS */
 144 #define DB_PAGE_2_BUF1_TRF                      0x53    /* Main memory page to buffer 1 transfert */
 145 #define DB_PAGE_2_BUF2_TRF                      0x55    /* Main memory page to buffer 2 transfert */
 146 #define DB_PAGE_2_BUF1_CMP                      0x60    /* Main memory page to buffer 1 compare */
 147 #define DB_PAGE_2_BUF2_CMP                      0x61    /* Main memory page to buffer 2 compare */
 148 #define DB_AUTO_PAGE_PGM_BUF1           0x58    /* Auto page rewrite throught buffer 1 */
 149 #define DB_AUTO_PAGE_PGM_BUF2           0x59    /* Auto page rewrite throught buffer 2 */
 150
 151 /*-------------------------------------------------------------------------------------------------*/
 152
 153 extern AT91S_DATAFLASH_INFO dataflash_info[CFG_MAX_DATAFLASH_BANKS];
 154
 155 extern void AT91F_SpiInit (void);
 156 extern int AT91F_DataflashProbe (int i, AT91PS_DataflashDesc pDesc);
 157 extern int AT91F_DataFlashRead (AT91PS_DataFlash, unsigned long , unsigned long, char *);
 158 extern AT91S_DataFlashStatus AT91F_DataFlashWrite(AT91PS_DataFlash ,unsigned char *, int, int);
 159 extern int AT91F_DataflashInit (void);
 160 extern void AT91F_DataflashPrintInfo(void);
 161 extern int addr_dataflash (unsigned long addr);
 162 extern int read_dataflash (unsigned long addr, unsigned long size, char *result);
 163 extern int write_dataflash (unsigned long addr_dest, unsigned int addr_src, unsigned int size);
 164
 165
 166 #endif