bertos/cpu/arm/drv/flash_at91.c

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2009 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \author Daniele Basile <asterix@develer.com>
  34  *
  35  * \brief At91sam7 Internal flash read/write driver.
  36  *
  37  *
  38  */
  39
  40 #include "flash_at91.h"
  41
  42 #include "cfg/cfg_emb_flash.h"
  43 #include <cfg/macros.h>
  44
  45 // Define log settings for cfg/log.h
  46 #define LOG_LEVEL    CONFIG_FLASH_EMB_LOG_LEVEL
  47 #define LOG_FORMAT   CONFIG_FLASH_EMB_LOG_FORMAT
  48 #include <cfg/log.h>
  49
  50 #include <cpu/irq.h>
  51 #include <cpu/attr.h>
  52 #include <cpu/power.h>
  53
  54 #include <io/kfile.h>
  55 #include <io/kblock.h>
  56 #include <io/arm.h>
  57
  58 #include <drv/timer.h>
  59 #include <drv/flash.h>
  60
  61 #include <string.h>
  62
  63 struct FlashHardware
  64 {
  65         uint8_t status;
  66 };
  67
  68
  69 /**
  70  * Really send the flash write command.
  71  *
  72  * \note This function has to be placed in RAM because
  73  *       executing code from flash while a writing process
  74  *       is in progress is forbidden.
  75  */
  76 RAM_FUNC NOINLINE static void write_page(uint32_t page)
  77 {
  78         // Send the 'write page' command
  79         MC_FCR = MC_KEY | MC_FCMD_WP | (MC_PAGEN_MASK & (page << 8));
  80
  81         // Wait for the end of command
  82         while(!(MC_FSR & BV(MC_FRDY)))
  83         {
  84                 //NOP;
  85         }
  86 }
  87
  88
  89 /**
  90  * Send write command.
  91  *
  92  * After WR command cpu write bufferd page into flash memory.
  93  *
  94  */
  95 INLINE void flash_sendWRcmd(uint32_t page)
  96 {
  97         cpu_flags_t flags;
  98
  99         LOG_INFO("Writing page %ld...\n", page);
 100
 101         IRQ_SAVE_DISABLE(flags);
 102         write_page(page);
 103
 104         IRQ_RESTORE(flags);
 105         LOG_INFO("Done\n");
 106 }
 107
 108 /**
 109  * Return true if no error are occurred after flash memory
 110  * read or write operation, otherwise return error code.
 111  */
 112 static bool flash_getStatus(struct KBlock *blk)
 113 {
 114         Flash *fls = FLASH_CAST(blk);
 115         /*
 116          * This bit is set to one if an invalid command and/or a bad keywords was/were
 117          * written in the Flash Command Register.
 118          */
 119         if(MC_FSR & BV(MC_PROGE))
 120         {
 121                 fls->hw->status |= FLASH_WR_ERR;
 122                 LOG_ERR("flash not erased..\n");
 123                 return false;
 124         }
 125
 126         /*
 127          * This bit is set to one if we programming of at least one locked lock
 128          * region.
 129          */
 130         if(MC_FSR & BV(MC_LOCKE))
 131         {
 132                 fls->hw->status |= FLASH_WR_PROTECT;
 133                 LOG_ERR("wr protect..\n");
 134                 return false;
 135         }
 136
 137         return true;
 138 }
 139
 140 static size_t at91_flash_readDirect(struct KBlock *blk, block_idx_t idx, void *buf, size_t offset, size_t size)
 141 {
 142         memcpy(buf, (void *)(idx * blk->blk_size +  FLASH_BASE + offset), size);
 143         return size;
 144 }
 145
 146 static size_t at91_flash_writeDirect(struct KBlock *blk, block_idx_t idx, const void *_buf, size_t offset, size_t size)
 147 {
 148         ASSERT(offset == 0);
 149         ASSERT(size == blk->blk_size);
 150
 151         uint32_t *addr = (uint32_t *)(idx * blk->blk_size +  FLASH_BASE);
 152         const uint8_t *buf = (const uint8_t *)_buf;
 153
 154         while (size)
 155         {
 156                 uint32_t data = (*(buf + 3) << 24) |
 157                                                 (*(buf + 2) << 16) |
 158                                                 (*(buf + 1) << 8)  |
 159                                                 *buf;
 160                 *addr = data;
 161
 162                 size -= 4;
 163                 buf += 4;
 164                 addr++;
 165         }
 166
 167         flash_sendWRcmd(idx);
 168
 169         if (!flash_getStatus(blk))
 170                 return 0;
 171
 172         return blk->blk_size;
 173 }
 174
 175
 176 static int at91_flash_error(struct KBlock *blk)
 177 {
 178         Flash *fls = FLASH_CAST(blk);
 179         return fls->hw->status;
 180 }
 181
 182 static void at91_flash_clearerror(struct KBlock *blk)
 183 {
 184         Flash *fls = FLASH_CAST(blk);
 185         fls->hw->status = 0;
 186 }
 187
 188 static const KBlockVTable flash_at91_buffered_vt =
 189 {
 190         .readDirect = at91_flash_readDirect,
 191         .writeDirect = at91_flash_writeDirect,
 192
 193         .readBuf = kblock_swReadBuf,
 194         .writeBuf = kblock_swWriteBuf,
 195         .load = kblock_swLoad,
 196         .store = kblock_swStore,
 197
 198         .error = at91_flash_error,
 199         .clearerr = at91_flash_clearerror,
 200 };
 201
 202 static const KBlockVTable flash_at91_unbuffered_vt =
 203 {
 204         .readDirect = at91_flash_readDirect,
 205         .writeDirect = at91_flash_writeDirect,
 206
 207         .error = at91_flash_error,
 208         .clearerr = at91_flash_clearerror,
 209 };
 210
 211 static struct FlashHardware flash_at91_hw;
 212 static uint8_t flash_buf[FLASH_PAGE_SIZE_BYTES];
 213
 214 static void common_init(Flash *fls)
 215 {
 216         memset(fls, 0, sizeof(*fls));
 217         DB(fls->blk.priv.type = KBT_FLASH);
 218
 219         fls->hw = &flash_at91_hw;
 220
 221         fls->blk.blk_size = FLASH_PAGE_SIZE_BYTES;
 222         fls->blk.blk_cnt = FLASH_MEM_SIZE / FLASH_PAGE_SIZE_BYTES;
 223 }
 224
 225 void flash_hw_init(Flash *fls, UNUSED_ARG(int, flags))
 226 {
 227         common_init(fls);
 228         fls->blk.priv.vt = &flash_at91_buffered_vt;
 229         fls->blk.priv.flags |= KB_BUFFERED | KB_PARTIAL_WRITE;
 230         fls->blk.priv.buf = flash_buf;
 231
 232         /* Load the first block in the cache */
 233         memcpy(fls->blk.priv.buf, (void *)(FLASH_BASE), fls->blk.blk_size);
 234 }
 235
 236 void flash_hw_initUnbuffered(Flash *fls, UNUSED_ARG(int, flags))
 237 {
 238         common_init(fls);
 239         fls->blk.priv.vt = &flash_at91_unbuffered_vt;
 240 }
 241