drivers/mtd/dataflash.c

   1 /* LowLevel function for ATMEL DataFlash support
   2  * Author : Hamid Ikdoumi (Atmel)
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 of
   7  * the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  17  * MA 02111-1307 USA
  18  *
  19  */
  20 #include <common.h>
  21 #include <config.h>
  22 #include <asm/hardware.h>
  23 #include <dataflash.h>
  24
  25 static AT91S_DataFlash DataFlashInst;
  26
  27 extern void AT91F_SpiInit (void);
  28 extern int AT91F_DataflashProbe (int i, AT91PS_DataflashDesc pDesc);
  29 extern int AT91F_DataFlashRead (AT91PS_DataFlash pDataFlash,
  30                                 unsigned long addr,
  31                                 unsigned long size, char *buffer);
  32 extern int AT91F_DataFlashWrite( AT91PS_DataFlash pDataFlash,
  33                                 unsigned char *src,
  34                                 int dest,
  35                                 int size );
  36
  37 int AT91F_DataflashInit (void)
  38 {
  39         int i, j;
  40         int dfcode;
  41         int part;
  42         int last_part;
  43         int found[CONFIG_SYS_MAX_DATAFLASH_BANKS];
  44         unsigned char protected;
  45
  46         AT91F_SpiInit ();
  47
  48         for (i = 0; i < CONFIG_SYS_MAX_DATAFLASH_BANKS; i++) {
  49                 found[i] = 0;
  50                 dataflash_info[i].Desc.state = IDLE;
  51                 dataflash_info[i].id = 0;
  52                 dataflash_info[i].Device.pages_number = 0;
  53                 dfcode = AT91F_DataflashProbe (cs[i].cs,
  54                                 &dataflash_info[i].Desc);
  55
  56                 switch (dfcode) {
  57                 case AT45DB021:
  58                         dataflash_info[i].Device.pages_number = 1024;
  59                         dataflash_info[i].Device.pages_size = 264;
  60                         dataflash_info[i].Device.page_offset = 9;
  61                         dataflash_info[i].Device.byte_mask = 0x300;
  62                         dataflash_info[i].Device.cs = cs[i].cs;
  63                         dataflash_info[i].Desc.DataFlash_state = IDLE;
  64                         dataflash_info[i].logical_address = cs[i].addr;
  65                         dataflash_info[i].id = dfcode;
  66                         found[i] += dfcode;;
  67                         break;
  68
  69                 case AT45DB081:
  70                         dataflash_info[i].Device.pages_number = 4096;
  71                         dataflash_info[i].Device.pages_size = 264;
  72                         dataflash_info[i].Device.page_offset = 9;
  73                         dataflash_info[i].Device.byte_mask = 0x300;
  74                         dataflash_info[i].Device.cs = cs[i].cs;
  75                         dataflash_info[i].Desc.DataFlash_state = IDLE;
  76                         dataflash_info[i].logical_address = cs[i].addr;
  77                         dataflash_info[i].id = dfcode;
  78                         found[i] += dfcode;;
  79                         break;
  80
  81                 case AT45DB161:
  82                         dataflash_info[i].Device.pages_number = 4096;
  83                         dataflash_info[i].Device.pages_size = 528;
  84                         dataflash_info[i].Device.page_offset = 10;
  85                         dataflash_info[i].Device.byte_mask = 0x300;
  86                         dataflash_info[i].Device.cs = cs[i].cs;
  87                         dataflash_info[i].Desc.DataFlash_state = IDLE;
  88                         dataflash_info[i].logical_address = cs[i].addr;
  89                         dataflash_info[i].id = dfcode;
  90                         found[i] += dfcode;;
  91                         break;
  92
  93                 case AT45DB321:
  94                         dataflash_info[i].Device.pages_number = 8192;
  95                         dataflash_info[i].Device.pages_size = 528;
  96                         dataflash_info[i].Device.page_offset = 10;
  97                         dataflash_info[i].Device.byte_mask = 0x300;
  98                         dataflash_info[i].Device.cs = cs[i].cs;
  99                         dataflash_info[i].Desc.DataFlash_state = IDLE;
 100                         dataflash_info[i].logical_address = cs[i].addr;
 101                         dataflash_info[i].id = dfcode;
 102                         found[i] += dfcode;;
 103                         break;
 104
 105                 case AT45DB642:
 106                         dataflash_info[i].Device.pages_number = 8192;
 107                         dataflash_info[i].Device.pages_size = 1056;
 108                         dataflash_info[i].Device.page_offset = 11;
 109                         dataflash_info[i].Device.byte_mask = 0x700;
 110                         dataflash_info[i].Device.cs = cs[i].cs;
 111                         dataflash_info[i].Desc.DataFlash_state = IDLE;
 112                         dataflash_info[i].logical_address = cs[i].addr;
 113                         dataflash_info[i].id = dfcode;
 114                         found[i] += dfcode;;
 115                         break;
 116
 117                 case AT45DB128:
 118                         dataflash_info[i].Device.pages_number = 16384;
 119                         dataflash_info[i].Device.pages_size = 1056;
 120                         dataflash_info[i].Device.page_offset = 11;
 121                         dataflash_info[i].Device.byte_mask = 0x700;
 122                         dataflash_info[i].Device.cs = cs[i].cs;
 123                         dataflash_info[i].Desc.DataFlash_state = IDLE;
 124                         dataflash_info[i].logical_address = cs[i].addr;
 125                         dataflash_info[i].id = dfcode;
 126                         found[i] += dfcode;;
 127                         break;
 128
 129                 default:
 130                         dfcode = 0;
 131                         break;
 132                 }
 133                 /* set the last area end to the dataflash size*/
 134                 area_list[NB_DATAFLASH_AREA -1].end =
 135                                 (dataflash_info[i].Device.pages_number *
 136                                 dataflash_info[i].Device.pages_size)-1;
 137
 138                 part = 0;
 139                 last_part = 0;
 140                 /* set the area addresses */
 141                 for(j = 0; j<NB_DATAFLASH_AREA; j++) {
 142                         if(found[i]!=0) {
 143                                 dataflash_info[i].Device.area_list[j].start =
 144                                         area_list[part].start +
 145                                         dataflash_info[i].logical_address;
 146                                 if(area_list[part].end == 0xffffffff) {
 147                                         dataflash_info[i].Device.area_list[j].end =
 148                                                 dataflash_info[i].end_address +
 149                                                 dataflash_info  [i].logical_address;
 150                                         last_part = 1;
 151                                 } else {
 152                                         dataflash_info[i].Device.area_list[j].end =
 153                                                 area_list[part].end +
 154                                                 dataflash_info[i].logical_address;
 155                                 }
 156                                 protected = area_list[part].protected;
 157                                 /* Set the environment according to the label...*/
 158                                 if(protected == FLAG_PROTECT_INVALID) {
 159                                         dataflash_info[i].Device.area_list[j].protected =
 160                                                 FLAG_PROTECT_INVALID;
 161                                 } else {
 162                                         dataflash_info[i].Device.area_list[j].protected =
 163                                                 protected;
 164                                 }
 165                                 strcpy((char*)(dataflash_info[i].Device.area_list[j].label),
 166                                                 (const char *)area_list[part].label);
 167                         }
 168                         part++;
 169                 }
 170         }
 171         return found[0];
 172 }
 173
 174 void AT91F_DataflashSetEnv (void)
 175 {
 176         int i, j;
 177         int part;
 178         unsigned char env;
 179         unsigned char s[32];    /* Will fit a long int in hex */
 180         unsigned long start;
 181
 182         for (i = 0, part= 0; i < CONFIG_SYS_MAX_DATAFLASH_BANKS; i++) {
 183                 for(j = 0; j<NB_DATAFLASH_AREA; j++) {
 184                         env = area_list[part].setenv;
 185                         /* Set the environment according to the label...*/
 186                         if((env & FLAG_SETENV) == FLAG_SETENV) {
 187                                 start =
 188                                 dataflash_info[i].Device.area_list[j].start;
 189                                 sprintf((char*) s,"%lX",start);
 190                                 setenv((char*) area_list[part].label,(char*) s);
 191                         }
 192                         part++;
 193                 }
 194         }
 195 }
 196
 197 void dataflash_print_info (void)
 198 {
 199         int i, j;
 200
 201         for (i = 0; i < CONFIG_SYS_MAX_DATAFLASH_BANKS; i++) {
 202                 if (dataflash_info[i].id != 0) {
 203                         printf("DataFlash:");
 204                         switch (dataflash_info[i].id) {
 205                         case AT45DB021:
 206                                 printf("AT45DB021\n");
 207                                 break;
 208                         case AT45DB161:
 209                                 printf("AT45DB161\n");
 210                                 break;
 211
 212                         case AT45DB321:
 213                                 printf("AT45DB321\n");
 214                                 break;
 215
 216                         case AT45DB642:
 217                                 printf("AT45DB642\n");
 218                                 break;
 219                         case AT45DB128:
 220                                 printf("AT45DB128\n");
 221                                 break;
 222                         }
 223
 224                         printf("Nb pages: %6d\n"
 225                                 "Page Size: %6d\n"
 226                                 "Size=%8d bytes\n"
 227                                 "Logical address: 0x%08X\n",
 228                                 (unsigned int) dataflash_info[i].Device.pages_number,
 229                                 (unsigned int) dataflash_info[i].Device.pages_size,
 230                                 (unsigned int) dataflash_info[i].Device.pages_number *
 231                                 dataflash_info[i].Device.pages_size,
 232                                 (unsigned int) dataflash_info[i].logical_address);
 233                         for (j=0; j< NB_DATAFLASH_AREA; j++) {
 234                                 switch(dataflash_info[i].Device.area_list[j].protected) {
 235                                 case    FLAG_PROTECT_SET:
 236                                 case    FLAG_PROTECT_CLEAR:
 237                                         printf("Area %i:\t%08lX to %08lX %s", j,
 238                                                 dataflash_info[i].Device.area_list[j].start,
 239                                                 dataflash_info[i].Device.area_list[j].end,
 240                                                 (dataflash_info[i].Device.area_list[j].protected==FLAG_PROTECT_SET) ? "(RO)" : "    ");
 241                                                 printf(" %s\n", dataflash_info[i].Device.area_list[j].label);
 242                                         break;
 243                                 case    FLAG_PROTECT_INVALID:
 244                                         break;
 245                                 }
 246                         }
 247                 }
 248         }
 249 }
 250
 251 /*---------------------------------------------------------------------------*/
 252 /* Function Name       : AT91F_DataflashSelect                               */
 253 /* Object              : Select the correct device                           */
 254 /*---------------------------------------------------------------------------*/
 255 AT91PS_DataFlash AT91F_DataflashSelect (AT91PS_DataFlash pFlash,
 256                                 unsigned long *addr)
 257 {
 258         char addr_valid = 0;
 259         int i;
 260
 261         for (i = 0; i < CONFIG_SYS_MAX_DATAFLASH_BANKS; i++)
 262                 if ( dataflash_info[i].id
 263                         && ((((int) *addr) & 0xFF000000) ==
 264                         dataflash_info[i].logical_address)) {
 265                         addr_valid = 1;
 266                         break;
 267                 }
 268         if (!addr_valid) {
 269                 pFlash = (AT91PS_DataFlash) 0;
 270                 return pFlash;
 271         }
 272         pFlash->pDataFlashDesc = &(dataflash_info[i].Desc);
 273         pFlash->pDevice = &(dataflash_info[i].Device);
 274         *addr -= dataflash_info[i].logical_address;
 275         return (pFlash);
 276 }
 277
 278 /*---------------------------------------------------------------------------*/
 279 /* Function Name       : addr_dataflash                                      */
 280 /* Object              : Test if address is valid                            */
 281 /*---------------------------------------------------------------------------*/
 282 int addr_dataflash (unsigned long addr)
 283 {
 284         int addr_valid = 0;
 285         int i;
 286
 287         for (i = 0; i < CONFIG_SYS_MAX_DATAFLASH_BANKS; i++) {
 288                 if ((((int) addr) & 0xFF000000) ==
 289                         dataflash_info[i].logical_address) {
 290                         addr_valid = 1;
 291                         break;
 292                 }
 293         }
 294
 295         return addr_valid;
 296 }
 297
 298 /*---------------------------------------------------------------------------*/
 299 /* Function Name       : size_dataflash                                      */
 300 /* Object              : Test if address is valid regarding the size         */
 301 /*---------------------------------------------------------------------------*/
 302 int size_dataflash (AT91PS_DataFlash pdataFlash, unsigned long addr,
 303                         unsigned long size)
 304 {
 305         /* is outside the dataflash */
 306         if (((int)addr & 0x0FFFFFFF) > (pdataFlash->pDevice->pages_size *
 307                 pdataFlash->pDevice->pages_number)) return 0;
 308         /* is too large for the dataflash */
 309         if (size > ((pdataFlash->pDevice->pages_size *
 310                 pdataFlash->pDevice->pages_number) -
 311                 ((int)addr & 0x0FFFFFFF))) return 0;
 312
 313         return 1;
 314 }
 315
 316 /*---------------------------------------------------------------------------*/
 317 /* Function Name       : prot_dataflash                                      */
 318 /* Object              : Test if destination area is protected               */
 319 /*---------------------------------------------------------------------------*/
 320 int prot_dataflash (AT91PS_DataFlash pdataFlash, unsigned long addr)
 321 {
 322         int area;
 323
 324         /* find area */
 325         for (area=0; area < NB_DATAFLASH_AREA; area++) {
 326                 if ((addr >= pdataFlash->pDevice->area_list[area].start) &&
 327                         (addr < pdataFlash->pDevice->area_list[area].end))
 328                         break;
 329         }
 330         if (area == NB_DATAFLASH_AREA)
 331                 return -1;
 332
 333         /*test protection value*/
 334         if (pdataFlash->pDevice->area_list[area].protected == FLAG_PROTECT_SET)
 335                 return 0;
 336         if (pdataFlash->pDevice->area_list[area].protected == FLAG_PROTECT_INVALID)
 337                 return 0;
 338
 339         return 1;
 340 }
 341
 342 /*--------------------------------------------------------------------------*/
 343 /* Function Name       : dataflash_real_protect                             */
 344 /* Object              : protect/unprotect area                             */
 345 /*--------------------------------------------------------------------------*/
 346 int dataflash_real_protect (int flag, unsigned long start_addr,
 347                                 unsigned long end_addr)
 348 {
 349         int i,j, area1, area2, addr_valid = 0;
 350
 351         /* find dataflash */
 352         for (i = 0; i < CONFIG_SYS_MAX_DATAFLASH_BANKS; i++) {
 353                 if ((((int) start_addr) & 0xF0000000) ==
 354                         dataflash_info[i].logical_address) {
 355                                 addr_valid = 1;
 356                                 break;
 357                 }
 358         }
 359         if (!addr_valid) {
 360                 return -1;
 361         }
 362         /* find start area */
 363         for (area1=0; area1 < NB_DATAFLASH_AREA; area1++) {
 364                 if (start_addr == dataflash_info[i].Device.area_list[area1].start)
 365                         break;
 366         }
 367         if (area1 == NB_DATAFLASH_AREA) return -1;
 368         /* find end area */
 369         for (area2=0; area2 < NB_DATAFLASH_AREA; area2++) {
 370                 if (end_addr == dataflash_info[i].Device.area_list[area2].end)
 371                         break;
 372         }
 373         if (area2 == NB_DATAFLASH_AREA)
 374                 return -1;
 375
 376         /*set protection value*/
 377         for(j = area1; j < area2+1 ; j++)
 378                 if(dataflash_info[i].Device.area_list[j].protected
 379                                 != FLAG_PROTECT_INVALID) {
 380                         if (flag == 0) {
 381                                 dataflash_info[i].Device.area_list[j].protected
 382                                         = FLAG_PROTECT_CLEAR;
 383                         } else {
 384                                 dataflash_info[i].Device.area_list[j].protected
 385                                         = FLAG_PROTECT_SET;
 386                         }
 387                 }
 388
 389         return (area2-area1+1);
 390 }
 391
 392 /*---------------------------------------------------------------------------*/
 393 /* Function Name       : read_dataflash                                      */
 394 /* Object              : dataflash memory read                               */
 395 /*---------------------------------------------------------------------------*/
 396 int read_dataflash (unsigned long addr, unsigned long size, char *result)
 397 {
 398         unsigned long AddrToRead = addr;
 399         AT91PS_DataFlash pFlash = &DataFlashInst;
 400
 401         pFlash = AT91F_DataflashSelect (pFlash, &AddrToRead);
 402
 403         if (pFlash == 0)
 404                 return ERR_UNKNOWN_FLASH_TYPE;
 405
 406         if (size_dataflash(pFlash,addr,size) == 0)
 407                 return ERR_INVAL;
 408
 409         return (AT91F_DataFlashRead (pFlash, AddrToRead, size, result));
 410 }
 411
 412 /*---------------------------------------------------------------------------*/
 413 /* Function Name       : write_dataflash                                     */
 414 /* Object              : write a block in dataflash                          */
 415 /*---------------------------------------------------------------------------*/
 416 int write_dataflash (unsigned long addr_dest, unsigned long addr_src,
 417                         unsigned long size)
 418 {
 419         unsigned long AddrToWrite = addr_dest;
 420         AT91PS_DataFlash pFlash = &DataFlashInst;
 421
 422         pFlash = AT91F_DataflashSelect (pFlash, &AddrToWrite);
 423
 424         if (pFlash == 0)
 425                 return ERR_UNKNOWN_FLASH_TYPE;
 426
 427         if (size_dataflash(pFlash,addr_dest,size) == 0)
 428                 return ERR_INVAL;
 429
 430         if (prot_dataflash(pFlash,addr_dest) == 0)
 431                 return ERR_PROTECTED;
 432
 433         if (AddrToWrite == -1)
 434                 return -1;
 435
 436         return AT91F_DataFlashWrite (pFlash, (uchar *)addr_src,
 437                                                 AddrToWrite, size);
 438 }
 439
 440 void dataflash_perror (int err)
 441 {
 442         switch (err) {
 443         case ERR_OK:
 444                 break;
 445         case ERR_TIMOUT:
 446                 printf("Timeout writing to DataFlash\n");
 447                 break;
 448         case ERR_PROTECTED:
 449                 printf("Can't write to protected/invalid DataFlash sectors\n");
 450                 break;
 451         case ERR_INVAL:
 452                 printf("Outside available DataFlash\n");
 453                 break;
 454         case ERR_UNKNOWN_FLASH_TYPE:
 455                 printf("Unknown Type of DataFlash\n");
 456                 break;
 457         case ERR_PROG_ERROR:
 458                 printf("General DataFlash Programming Error\n");
 459                 break;
 460         default:
 461                 printf("%s[%d] FIXME: rc=%d\n", __FILE__, __LINE__, err);
 462                 break;
 463         }
 464 }