packages/devs/flash/arm/iq80310/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, msalter
  45 // Date:         2000-09-10
  46 // Purpose:
  47 // Description:
  48 //
  49 //####DESCRIPTIONEND####
  50 //
  51 //==========================================================================
  52
  53 #include "flash.h"
  54
  55
  56
  57 //
  58 // The difficulty with this operation is that the hardware does not support
  59 // unlocking single blocks.  However, the logical layer would like this to
  60 // be the case, so this routine emulates it.  The hardware can clear all of
  61 // the locks in the device at once.  This routine will use that approach and
  62 // then reset the regions which are known to be locked.
  63 //
  64
  65 #define MAX_FLASH_BLOCKS 128
  66
  67 int
  68 flash_unlock_block(volatile unsigned char *block, int block_size, int blocks)
  69         __attribute__ ((section (".2ram.flash_unlock_block")));
  70 int
  71 flash_unlock_block(volatile unsigned char *block, int block_size, int blocks)
  72 {
  73     volatile unsigned short *ROM, *bp;
  74     unsigned short stat;
  75     int timeout = 5000000;
  76     unsigned short is_locked[MAX_FLASH_BLOCKS];
  77     int i;
  78
  79     ROM = (unsigned short *) FLASH_P2V((unsigned long)block & 0xFF800000);
  80
  81     // Clear any error conditions
  82     ROM[0] = FLASH_Clear_Status;
  83
  84     // Get current block lock state.  This needs to access each block on
  85     // the device so currently locked blocks can be re-locked.
  86     bp = (unsigned short *)((unsigned long)block & 0xFF800000);
  87     for (i = 0;  i < blocks;  i++) {
  88         if (bp == (unsigned short *) block) {
  89             is_locked[i] = 0;
  90         } else {
  91             *(volatile unsigned short *)FLASH_P2V(bp) = FLASH_Read_Query;
  92             is_locked[i] = ((volatile unsigned short *)FLASH_P2V(bp))[2];
  93         }
  94         bp += block_size / sizeof(*bp);
  95     }
  96
  97     // Clears all lock bits
  98     FLASH_P2V(block)[0] = FLASH_Clear_Locks;
  99     FLASH_P2V(block)[0] = FLASH_Clear_Locks_Confirm;  // Confirmation
 100     timeout = 5000000;
 101     while(((stat = ROM[0]) & FLASH_Status_Ready) != FLASH_Status_Ready) {
 102         if (--timeout == 0) goto done;
 103     }
 104
 105     // Restore the lock state
 106     bp = (unsigned short *)((unsigned long)block & 0xFF800000);
 107     for (i = 0;  i < blocks;  i++) {
 108         if (is_locked[i]) {
 109             *FLASH_P2V(bp) = FLASH_Set_Lock;
 110             *FLASH_P2V(bp) = FLASH_Set_Lock_Confirm;  // Confirmation
 111             timeout = 5000000;
 112             while(((stat = ROM[0]) & FLASH_Status_Ready) != FLASH_Status_Ready) {
 113                 if (--timeout == 0) goto done;
 114             }
 115         }
 116         bp += block_size / sizeof(*bp);
 117     }
 118
 119  done:
 120     // Restore ROM to "normal" mode
 121     ROM[0] = FLASH_Reset;
 122
 123     return stat;
 124 }