bertos/cpu/arm/drv/flash_lpc2.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  * \author Francesco Sacchi <batt@develer.com>
  34  * \author Daniele Basile <asterix@develer.com>
  35  *
  36  * \brief NPX lpc23xx embedded flash read/write driver.
  37  *
  38  * notest:arm
  39  */
  40
  41 #include "flash_lpc2.h"
  42 #include "cfg/cfg_emb_flash.h"
  43
  44 // Define log settings for cfg/log.h
  45 #define LOG_LEVEL    CONFIG_FLASH_EMB_LOG_LEVEL
  46 #define LOG_FORMAT   CONFIG_FLASH_EMB_LOG_FORMAT
  47 #include <cfg/log.h>
  48 #include <cfg/macros.h>
  49
  50 #include <cpu/irq.h>
  51 #include <cpu/attr.h>
  52 #include <cpu/power.h>
  53 #include <cpu/types.h>
  54
  55 #include <io/kblock.h>
  56 #include <io/arm.h>
  57
  58 #include <drv/timer.h>
  59 #include <drv/flash.h>
  60
  61 #include <struct/bitarray.h>
  62
  63 #include <string.h>
  64
  65 /* Embedded flash programming defines. */
  66 #define IAP_ADDRESS 0x7ffffff1
  67
  68 typedef enum IapCommands
  69 {
  70         PREPARE_SECTOR_FOR_WRITE = 50,
  71         COPY_RAM_TO_FLASH = 51,
  72         ERASE_SECTOR = 52,
  73         BLANK_CHECK_SECTOR = 53,
  74         READ_PART_ID = 54,
  75         READ_BOOT_VER = 55,
  76         COMPARE = 56,
  77         REINVOKE_ISP = 57,
  78 } IapCommands;
  79
  80 #if CPU_ARM_LPC2378
  81         #define FLASH_MEM_SIZE         (504 * 1024L)
  82         #define FLASH_PAGE_SIZE_BYTES          4096
  83         #define FLASH_REAL_PAGE_CNT              28
  84 #else
  85         #error Unknown CPU
  86 #endif
  87
  88 #define CMD_SUCCESS 0
  89
  90 struct FlashHardware
  91 {
  92         uint8_t status;
  93 };
  94
  95 #define FLASH_PAGE_CNT  FLASH_MEM_SIZE / FLASH_PAGE_SIZE_BYTES
  96
  97 ALLOC_BITARRAY(page_dirty, FLASH_PAGE_CNT);
  98
  99 uint8_t erase_group[] = {
 100
 101         4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
 102         4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
 103
 104         4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
 105         4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
 106
 107         32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
 108         32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
 109
 110         32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
 111         32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
 112
 113         32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
 114         32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
 115
 116         32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
 117         4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
 118
 119         4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
 120         4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
 121 };
 122
 123 typedef struct IapCmd
 124 {
 125         uint32_t cmd;
 126         uint32_t param[4];
 127 } IapCmd;
 128
 129 typedef struct IapRes
 130 {
 131         uint32_t status;
 132         uint32_t res[2];
 133 } IapRes;
 134
 135 typedef void (*iap_callback_t)(IapCmd *, IapRes *);
 136
 137 iap_callback_t iap = (iap_callback_t)IAP_ADDRESS;
 138
 139 static size_t sector_size(uint32_t page)
 140 {
 141         if (page < 8)
 142                 return 4096;
 143         else if (page < 22)
 144                 return 32768;
 145         else if (page < 28)
 146                 return 4096;
 147
 148         ASSERT(0);
 149         return 0;
 150 }
 151
 152 static size_t sector_addr(uint32_t page)
 153 {
 154         if (page < 8)
 155                 return page * 4096;
 156         else if (page < 22)
 157                 return (page - 8) * 32768 + 4096 * 8;
 158         else if (page < 28)
 159                 return (page - 22) * 4096 + 32768 * 14 + 4096 * 8;
 160
 161         ASSERT(0);
 162         return 0;
 163 }
 164
 165
 166 static uint32_t addr_to_sector(size_t addr)
 167 {
 168         if (addr < 4096 * 8)
 169                 return addr / 4096;
 170         else if (addr < 4096 * 8 + 32768L * 14)
 171                 return ((addr - 4096 * 8) / 32768) + 8;
 172         else if (addr < 4096 * 8 + 32768L * 14 + 4096 * 6)
 173                 return ((addr - 4096 * 8 - 32768L * 14) / 4096) + 22;
 174
 175         ASSERT(0);
 176         return 0;
 177 }
 178
 179 static size_t lpc2_flash_readDirect(struct KBlock *blk, block_idx_t idx, void *buf, size_t offset, size_t size)
 180 {
 181         ASSERT(offset == 0);
 182         ASSERT(size == blk->blk_size);
 183
 184         memcpy(buf, (void *)(idx * blk->blk_size), size);
 185         return size;
 186 }
 187
 188 static size_t lpc2_flash_writeDirect(struct KBlock *blk, block_idx_t idx, const void *_buf, size_t offset, size_t size)
 189 {
 190         ASSERT(offset == 0);
 191         ASSERT(FLASH_PAGE_SIZE_BYTES == size);
 192
 193         Flash *fls = FLASH_CAST(blk);
 194         if (!(fls->blk.priv.flags & KB_WRITE_ONCE))
 195                 ASSERT(sector_size(idx) <= FLASH_PAGE_SIZE_BYTES);
 196
 197         const uint8_t *buf = (const uint8_t *)_buf;
 198         cpu_flags_t flags;
 199
 200         //Compute page address of current page.
 201         uint32_t addr = idx * blk->blk_size;
 202         uint32_t sector = addr_to_sector(addr);
 203         // Compute the first page index in the sector to manage the status
 204         int idx_sector = sector_addr(sector) /  blk->blk_size;
 205
 206         LOG_INFO("Writing page[%ld]sector[%ld]idx[%d]\n", idx, sector, idx_sector);
 207         IRQ_SAVE_DISABLE(flags);
 208
 209         IapCmd cmd;
 210         IapRes res;
 211         cmd.cmd = PREPARE_SECTOR_FOR_WRITE;
 212         cmd.param[0] = cmd.param[1] = sector;
 213         iap(&cmd, &res);
 214
 215         if (res.status != CMD_SUCCESS)
 216                 goto flash_error;
 217
 218         if ((fls->blk.priv.flags & KB_WRITE_ONCE) &&
 219                         bitarray_blockFull(idx_sector, erase_group[sector], page_dirty, FLASH_PAGE_CNT))
 220         {
 221                 kputs("blocchi pieni\n");
 222                 ASSERT(0);
 223                 goto flash_error;
 224         }
 225
 226         bool erase = false;
 227         if ((fls->blk.priv.flags & KB_WRITE_ONCE) &&
 228                         bitarray_blockEmpty(idx_sector, erase_group[sector], page_dirty, FLASH_PAGE_CNT))
 229                 erase = true;
 230
 231         if (!(fls->blk.priv.flags & KB_WRITE_ONCE))
 232                 erase = true;
 233
 234         if (erase)
 235         {
 236                 cmd.cmd = ERASE_SECTOR;
 237                 cmd.param[0] = cmd.param[1] = sector;
 238                 cmd.param[2] = CPU_FREQ / 1000;
 239                 iap(&cmd, &res);
 240
 241                 if (res.status != CMD_SUCCESS)
 242                         goto flash_error;
 243         }
 244
 245         LOG_INFO("Writing page [%ld], addr [%ld] in sector[%ld]\n", idx, addr, sector);
 246         cmd.cmd = PREPARE_SECTOR_FOR_WRITE;
 247         cmd.param[0] = cmd.param[1] = sector;
 248         iap(&cmd, &res);
 249
 250         if (res.status != CMD_SUCCESS)
 251                 goto flash_error;
 252
 253         if (fls->blk.priv.flags & KB_WRITE_ONCE)
 254         {
 255                 if (bitarray_check(idx, page_dirty, FLASH_PAGE_CNT))
 256                 {
 257                         ASSERT(0);
 258                         goto flash_error;
 259                 }
 260                 else
 261                         bitarray_set(idx, page_dirty, FLASH_PAGE_CNT);
 262         }
 263
 264         cmd.cmd = COPY_RAM_TO_FLASH;
 265         cmd.param[0] = addr;
 266         cmd.param[1] = (uint32_t)buf;
 267         cmd.param[2] = FLASH_PAGE_SIZE_BYTES;
 268         cmd.param[3] = CPU_FREQ / 1000;
 269         iap(&cmd, &res);
 270
 271         if (res.status != CMD_SUCCESS)
 272                 goto flash_error;
 273
 274         IRQ_RESTORE(flags);
 275         LOG_INFO("Done\n");
 276
 277         return blk->blk_size;
 278
 279 flash_error:
 280         LOG_ERR("%ld\n", res.status);
 281         fls->hw->status |= FLASH_WR_ERR;
 282         return 0;
 283 }
 284
 285 static int lpc2_flash_close(UNUSED_ARG(struct KBlock, *blk))
 286 {
 287         memset(page_dirty, 0, sizeof(page_dirty));
 288         return 0;
 289 }
 290
 291
 292 static int lpc2_flash_error(struct KBlock *blk)
 293 {
 294         Flash *fls = FLASH_CAST(blk);
 295         return fls->hw->status;
 296 }
 297
 298 static void lpc2_flash_clearerror(struct KBlock *blk)
 299 {
 300         Flash *fls = FLASH_CAST(blk);
 301         fls->hw->status = 0;
 302 }
 303
 304 static const KBlockVTable flash_lpc2_buffered_vt =
 305 {
 306         .readDirect = lpc2_flash_readDirect,
 307         .writeDirect = lpc2_flash_writeDirect,
 308
 309         .readBuf = kblock_swReadBuf,
 310         .writeBuf = kblock_swWriteBuf,
 311         .load = kblock_swLoad,
 312         .store = kblock_swStore,
 313
 314         .close = lpc2_flash_close,
 315
 316         .error = lpc2_flash_error,
 317         .clearerr = lpc2_flash_clearerror,
 318 };
 319
 320 static const KBlockVTable flash_lpc2_unbuffered_vt =
 321 {
 322         .readDirect = lpc2_flash_readDirect,
 323         .writeDirect = lpc2_flash_writeDirect,
 324
 325         .close = lpc2_flash_close,
 326
 327         .error = lpc2_flash_error,
 328         .clearerr = lpc2_flash_clearerror,
 329 };
 330
 331 static struct FlashHardware flash_lpc2_hw;
 332 static uint8_t flash_buf[FLASH_PAGE_SIZE_BYTES];
 333
 334 static void common_init(Flash *fls)
 335 {
 336         memset(fls, 0, sizeof(*fls));
 337         DB(fls->blk.priv.type = KBT_FLASH);
 338
 339         fls->hw = &flash_lpc2_hw;
 340
 341         fls->blk.blk_size = FLASH_PAGE_SIZE_BYTES;
 342         fls->blk.blk_cnt = FLASH_MEM_SIZE / FLASH_PAGE_SIZE_BYTES;
 343 }
 344
 345 void flash_hw_init(Flash *fls, int flags)
 346 {
 347         common_init(fls);
 348         fls->blk.priv.vt = &flash_lpc2_buffered_vt;
 349         fls->blk.priv.flags |= KB_BUFFERED | KB_PARTIAL_WRITE | flags;
 350         fls->blk.priv.buf = flash_buf;
 351
 352         /* Load the first block in the cache */
 353         void *flash_start = 0x0;
 354         memcpy(fls->blk.priv.buf, flash_start, fls->blk.blk_size);
 355 }
 356
 357 void flash_hw_initUnbuffered(Flash *fls, int flags)
 358 {
 359         common_init(fls);
 360         fls->blk.priv.vt = &flash_lpc2_unbuffered_vt;
 361         fls->blk.priv.flags |= flags;
 362 }