bertos/cpu/cortex-m3/drv/flash_stm32.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 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief STM32F103xx internal flash memory driver.
  34  *
  35  * \author Daniele Basile <asterix@develer.com>
  36  */
  37
  38 #include "flash_stm32.h"
  39
  40 #include "cfg/cfg_emb_flash.h"
  41
  42 // Define log settings for cfg/log.h
  43 #define LOG_LEVEL    CONFIG_FLASH_EMB_LOG_LEVEL
  44 #define LOG_FORMAT   CONFIG_FLASH_EMB_LOG_FORMAT
  45 #include <cfg/log.h>
  46
  47 #include <drv/timer.h>
  48 #include <drv/flash.h>
  49
  50 #include <cpu/power.h>
  51 #include <cpu/detect.h>
  52
  53 #include <io/stm32.h>
  54
  55 #include <string.h>
  56
  57 #define EMB_FLASH                ((struct stm32_flash*)FLASH_R_BASE)
  58
  59 struct FlashHardware
  60 {
  61         uint8_t status;
  62 };
  63
  64 static bool flash_wait(struct KBlock *blk)
  65 {
  66         Flash *fls = FLASH_CAST(blk);
  67         ticks_t start = timer_clock();
  68         while (true)
  69         {
  70                 if (!(EMB_FLASH->SR & FLASH_FLAG_BSY))
  71                         break;
  72
  73                 if (EMB_FLASH->SR & FLASH_FLAG_PGERR)
  74                 {
  75                         fls->hw->status |= FLASH_NOT_ERASED;
  76                         LOG_ERR("flash not erased..\n");
  77                         return false;
  78                 }
  79
  80                 if (EMB_FLASH->SR & FLASH_FLAG_WRPRTERR)
  81                 {
  82                         fls->hw->status |= FLASH_WR_PROTECT;
  83                         LOG_ERR("wr protect..\n");
  84                         return false;
  85                 }
  86
  87                 if (timer_clock() - start > ms_to_ticks(CONFIG_FLASH_WR_TIMEOUT))
  88                 {
  89                         fls->hw->status |= FLASH_WR_TIMEOUT;
  90                         LOG_ERR("Timeout..\n");
  91                         return false;
  92                 }
  93
  94                 cpu_relax();
  95         }
  96
  97         return true;
  98 }
  99
 100 static bool stm32_erasePage(struct KBlock *blk, uint32_t page_add)
 101 {
 102
 103         EMB_FLASH->CR |= CR_PER_SET;
 104         EMB_FLASH->AR = page_add;
 105         EMB_FLASH->CR |= CR_STRT_SET;
 106
 107         if (!flash_wait(blk))
 108                 return false;
 109
 110         EMB_FLASH->CR &= CR_PER_RESET;
 111
 112         return true;
 113 }
 114
 115 #if 0
 116 // not used for now
 117 static bool stm32_eraseAll(struct KBlock *blk)
 118 {
 119         EMB_FLASH->CR |= CR_MER_SET;
 120         EMB_FLASH->CR |= CR_STRT_SET;
 121
 122         if (!flash_wait(blk))
 123                 return false;
 124
 125         EMB_FLASH->CR &= CR_MER_RESET;
 126
 127         return true;
 128 }
 129 #endif
 130
 131 static int stm32_flash_error(struct KBlock *blk)
 132 {
 133         Flash *fls = FLASH_CAST(blk);
 134         return fls->hw->status;
 135 }
 136
 137 static void stm32_flash_clearerror(struct KBlock *blk)
 138 {
 139         Flash *fls = FLASH_CAST(blk);
 140         fls->hw->status = 0;
 141 }
 142
 143 static size_t stm32_flash_readDirect(struct KBlock *blk, block_idx_t idx, void *buf, size_t offset, size_t size)
 144 {
 145         memcpy(buf, (void *)(idx * blk->blk_size + offset), size);
 146         return size;
 147 }
 148
 149
 150 INLINE bool stm32_writeWord(struct KBlock *blk, uint32_t addr, uint16_t data)
 151 {
 152         ASSERT(!(addr % 2));
 153
 154         EMB_FLASH->CR |= CR_PG_SET;
 155
 156         *(reg16_t *)addr = data;
 157
 158         if (!flash_wait(blk))
 159                 return false;
 160
 161         EMB_FLASH->CR &= CR_PG_RESET;
 162
 163         return true;
 164 }
 165
 166 static size_t stm32_flash_writeDirect(struct KBlock *blk, block_idx_t idx, const void *_buf, size_t offset, size_t size)
 167 {
 168         ASSERT(offset == 0);
 169         ASSERT(size == blk->blk_size);
 170
 171         if (!stm32_erasePage(blk, (idx * blk->blk_size)))
 172                 return 0;
 173
 174         uint32_t addr = idx * blk->blk_size;
 175         const uint8_t *buf = (const uint8_t *)_buf;
 176
 177         while (size)
 178         {
 179                 uint16_t data = (*(buf + 1) << 8) | *buf;
 180                 if (!stm32_writeWord(blk, addr, data))
 181                         return 0;
 182
 183                 buf += 2;
 184                 size -= 2;
 185                 addr += 2;
 186         }
 187
 188         return blk->blk_size;
 189 }
 190
 191 static const KBlockVTable flash_stm32_buffered_vt =
 192 {
 193         .readDirect = stm32_flash_readDirect,
 194         .writeDirect = stm32_flash_writeDirect,
 195
 196         .readBuf = kblock_swReadBuf,
 197         .writeBuf = kblock_swWriteBuf,
 198         .load = kblock_swLoad,
 199         .store = kblock_swStore,
 200
 201         .close = kblock_swClose,
 202
 203         .error = stm32_flash_error,
 204         .clearerr = stm32_flash_clearerror,
 205 };
 206
 207 static const KBlockVTable flash_stm32_unbuffered_vt =
 208 {
 209         .readDirect = stm32_flash_readDirect,
 210         .writeDirect = stm32_flash_writeDirect,
 211
 212         .close = kblock_swClose,
 213
 214         .error = stm32_flash_error,
 215         .clearerr = stm32_flash_clearerror,
 216 };
 217
 218 static struct FlashHardware flash_stm32_hw;
 219 static uint8_t flash_buf[FLASH_PAGE_SIZE];
 220
 221 static void common_init(Flash *fls)
 222 {
 223         memset(fls, 0, sizeof(*fls));
 224         DB(fls->blk.priv.type = KBT_FLASH);
 225
 226         fls->hw = &flash_stm32_hw;
 227
 228         fls->blk.blk_size = FLASH_PAGE_SIZE;
 229         fls->blk.blk_cnt = (F_SIZE * 1024) / FLASH_PAGE_SIZE;
 230
 231         /* Unlock flash memory for the FPEC Access */
 232         EMB_FLASH->KEYR = FLASH_KEY1;
 233         EMB_FLASH->KEYR = FLASH_KEY2;
 234 }
 235
 236
 237 void flash_hw_init(Flash *fls, UNUSED_ARG(int, flags))
 238 {
 239         common_init(fls);
 240         fls->blk.priv.vt = &flash_stm32_buffered_vt;
 241         fls->blk.priv.flags |= KB_BUFFERED | KB_PARTIAL_WRITE;
 242         fls->blk.priv.buf = flash_buf;
 243
 244         /* Load the first block in the cache */
 245         void *flash_start = 0x0;
 246         memcpy(fls->blk.priv.buf, flash_start, fls->blk.blk_size);
 247 }
 248
 249 void flash_hw_initUnbuffered(Flash *fls, UNUSED_ARG(int, flags))
 250 {
 251         common_init(fls);
 252         fls->blk.priv.vt = &flash_stm32_unbuffered_vt;
 253 }