bertos/drv/flash.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 2005 Develer S.r.l. (http://www.develer.com/)
  30 * -->
  31 *
  32 *
  33 * \brief Embedded flash for cpu.
  34 *
  35 * \author Francesco Sacchi <batt@develer.com>
  36 * \author Daniele Basile <asterix@develer.com>
  37 *
  38 * $WIZ$ module_name = "flash"
  39 * $WIZ$ module_depends = "kfile"
  40 */
  41
  42 #ifndef DRV_FLASH_H
  43 #define DRV_FLASH_H
  44
  45 #include <cfg/macros.h>
  46 #include <cfg/module.h>
  47
  48
  49 #include CPU_HEADER(flash)
  50
  51 /**
  52 * EmbFlash KFile context structure.
  53 */
  54 typedef struct Flash
  55 {
  56         /**
  57          * File descriptor.
  58          */
  59         KFile fd;
  60
  61         /**
  62          * Flag for checking if current page is modified.
  63          */
  64         bool page_dirty;
  65
  66         /**
  67          * Current buffered page.
  68          */
  69         page_t curr_page;
  70
  71         /**
  72          * Temporary buffer cointaing data block to
  73          * write on flash.
  74          */
  75         uint8_t page_buf[FLASH_PAGE_SIZE];
  76 } Flash;
  77
  78 /**
  79 * ID for FLASH
  80 */
  81 #define KFT_FLASH MAKE_ID('F', 'L', 'A', 'S')
  82
  83 /**
  84 * Convert + ASSERT from generic KFile to Flash.
  85 */
  86 INLINE Flash * FLASH_CAST(KFile *fd)
  87 {
  88         ASSERT(fd->_type == KFT_FLASH);
  89         return (Flash *)fd;
  90 }
  91
  92
  93 MOD_DEFINE(flash);
  94
  95 /**
  96  *
  97  * Initialize PWM hw.
  98  */
  99 INLINE void flash_init(Flash *fd)
 100 {
 101         flash_hw_init(fd);
 102
 103         MOD_INIT(flash);
 104 }
 105
 106
 107
 108 #endif /* DRV_FLASH_H */
 109