bertos/cpu/cortex-m3/drv/flash_lm3s.h

   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 LM3S1968 internal flash memory driver.
  34  *
  35  * \author Andrea Righi <arighi@develer.com>
  36  */
  37
  38 #ifndef FLASH_LM3S_H
  39 #define FLASH_LM3S_H
  40
  41 #include <cpu/types.h>
  42 #include <kern/kfile.h>
  43
  44 /* Flash memory mapping */
  45 #define FLASH_MEM_SIZE          0x40000 //< 256KiB
  46 #define FLASH_PAGE_SIZE_BYTES   0x400   //< 1KiB
  47
  48 /**
  49  * FlashLM3S KFile context structure.
  50  */
  51 typedef struct FlashLM3S
  52 {
  53         /**
  54          * File descriptor.
  55          */
  56         KFile fd;
  57
  58         /**
  59          * Flag for checking if current page is modified.
  60          */
  61         bool page_dirty;
  62
  63         /**
  64          * Current buffered page.
  65          */
  66         uint32_t *curr_page;
  67
  68         /**
  69          * Temporary buffer cointaing data block to
  70          * write on flash.
  71          */
  72         uint32_t page_buf[FLASH_PAGE_SIZE_BYTES / sizeof(uint32_t)];
  73 } FlashLM3S;
  74
  75 /**
  76  * ID for FlashLM3S
  77  */
  78 #define KFT_FLASHLM3S MAKE_ID('F', 'L', '3', 'S')
  79
  80 /**
  81  * Convert + ASSERT from generic KFile to FlashLM3S structure.
  82  */
  83 INLINE FlashLM3S * FLASHLM3S_CAST(KFile *fd)
  84 {
  85         ASSERT(fd->_type == KFT_FLASHLM3S);
  86         return (FlashLM3S *)fd;
  87 }
  88
  89 void flash_lm3sInit(FlashLM3S *fd);
  90
  91 #endif /* FLASH_LM3S_H */