bertos/cpu/avr/drv/flash_avr.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 2007 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Self programming routines (interface).
  34  *
  35  * \version $Id$
  36  * \author Francesco Sacchi <batt@develer.com>
  37  * \author Daniele Basile <asterix@develer.com>
  38  */
  39
  40 #ifndef DRV_FLASH_AVR_H
  41 #define DRV_FLASH_AVR_H
  42
  43 #include <cfg/compiler.h>
  44 #include <kern/kfile.h>
  45
  46
  47 /**
  48  * Definition of type for avr flash module.
  49  */
  50 typedef uint16_t avr_page_t;
  51
  52
  53 /**
  54  * FlashAvr KFile context structure.
  55  */
  56 typedef struct KFileFlashAvr
  57 {
  58         KFile fd;               ///< File descriptor.
  59
  60         /**
  61         * Current buffered page.
  62         */
  63         avr_page_t curr_page;
  64
  65
  66 } KFileFlashAvr;
  67
  68
  69
  70 /**
  71  * ID for FlashAvr
  72  */
  73 #define KFT_FLASHAVR MAKE_ID('F', 'L', 'A', 'V')
  74
  75 /**
  76  * Convert + ASSERT from generic KFile to KFileFlashAvr.
  77  */
  78 INLINE KFileFlashAvr * KFILEFLASHAVR(KFile *fd)
  79 {
  80         ASSERT(fd->_type == KFT_FLASHAVR);
  81         return (KFileFlashAvr *)fd;
  82 }
  83
  84
  85 void flash_avr_init(struct KFileFlashAvr *fd);
  86
  87
  88
  89 #endif /* DRV_FLASH_AVR_H */