packages/devs/flash/mips/atlas/v2_0/src/flash_unlock_block.c

   1 //==========================================================================
   2 //
   3 //      flash_unlock_block.c
   4 //
   5 //      Flash programming
   6 //
   7 //==========================================================================
   8 //####ECOSGPLCOPYRIGHTBEGIN####
   9 // -------------------------------------------
  10 // This file is part of eCos, the Embedded Configurable Operating System.
  11 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
  12 //
  13 // eCos is free software; you can redistribute it and/or modify it under
  14 // the terms of the GNU General Public License as published by the Free
  15 // Software Foundation; either version 2 or (at your option) any later version.
  16 //
  17 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 // for more details.
  21 //
  22 // You should have received a copy of the GNU General Public License along
  23 // with eCos; if not, write to the Free Software Foundation, Inc.,
  24 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  25 //
  26 // As a special exception, if other files instantiate templates or use macros
  27 // or inline functions from this file, or you compile this file and link it
  28 // with other works to produce a work based on this file, this file does not
  29 // by itself cause the resulting work to be covered by the GNU General Public
  30 // License. However the source code for this file must still be made available
  31 // in accordance with section (3) of the GNU General Public License.
  32 //
  33 // This exception does not invalidate any other reasons why a work based on
  34 // this file might be covered by the GNU General Public License.
  35 //
  36 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  37 // at http://sources.redhat.com/ecos/ecos-license/
  38 // -------------------------------------------
  39 //####ECOSGPLCOPYRIGHTEND####
  40 //==========================================================================
  41 //#####DESCRIPTIONBEGIN####
  42 //
  43 // Author(s):    gthomas
  44 // Contributors: gthomas
  45 // Date:         2000-09-10
  46 // Purpose:
  47 // Description:
  48 //
  49 //####DESCRIPTIONEND####
  50 //
  51 //==========================================================================
  52
  53 #include "flash.h"
  54
  55 #include <cyg/hal/hal_arch.h>
  56
  57
  58 //
  59 // The difficulty with this operation is that the hardware does not support
  60 // unlocking single blocks.  However, the logical layer would like this to
  61 // be the case, so this routine emulates it.  The hardware can clear all of
  62 // the locks in the device at once.  This routine will use that approach and
  63 // then reset the regions which are known to be locked.
  64 //
  65
  66 #define MAX_FLASH_BLOCKS 128
  67
  68 int
  69 flash_unlock_block(volatile unsigned long *block, int block_size, int blocks)
  70         __attribute__ ((section (".2ram.flash_unlock_block")));
  71 int
  72 flash_unlock_block(volatile unsigned long *block, int block_size, int blocks)
  73 {
  74     volatile unsigned long *ROM, *bp;
  75     unsigned long stat;
  76     int timeout = 5000000;
  77     unsigned char is_locked[MAX_FLASH_BLOCKS];
  78     int i;
  79
  80     FLASH_WRITE_ENABLE();
  81
  82     block = (volatile unsigned long *)CYGARC_UNCACHED_ADDRESS((unsigned long)block);
  83     ROM = (volatile unsigned long *)((unsigned long)block & FLASH_BASE_MASK);
  84
  85     // Clear any error conditions
  86     ROM[0] = FLASH_Clear_Status;
  87
  88     // Get current block lock state.  This needs to access each block on
  89     // the device so currently locked blocks can be re-locked.
  90     bp = ROM;
  91     for (i = 0;  i < (blocks/2);  i++) {
  92         if (bp == block) {
  93             is_locked[i] = 0;
  94         } else {
  95             *bp = FLASH_Read_Query;
  96             is_locked[i] = bp[2];
  97         }
  98         bp += block_size / sizeof(*bp);
  99     }
 100
 101     // Clears all lock bits
 102     block[0] = FLASH_Clear_Locks;
 103     block[0] = FLASH_Clear_Locks_Confirm;  // Confirmation
 104     timeout = 5000000;
 105     while(((stat = ROM[0]) & FLASH_Status_Ready) != FLASH_Status_Ready) {
 106         if (--timeout == 0) break;
 107     }
 108
 109     // Restore the lock state
 110     bp = ROM;
 111     for (i = 0;  i < (blocks/2);  i++) {
 112         if (is_locked[i]) {
 113             *bp = FLASH_Set_Lock;
 114             *bp = FLASH_Set_Lock_Confirm;  // Confirmation
 115             timeout = 5000000;
 116             while(((stat = ROM[0]) & FLASH_Status_Ready) != FLASH_Status_Ready) {
 117                 if (--timeout == 0) break;
 118             }
 119         }
 120         bp += block_size / sizeof(*bp);
 121     }
 122
 123     // Restore ROM to "normal" mode
 124     ROM[0] = FLASH_Reset;
 125
 126     FLASH_WRITE_DISABLE();
 127
 128     return stat;
 129 }