git.rot13.org Git - simavr/blob - simavr/sim/avr_eeprom.h

   1 /*
   2         avr_eeprom.h
   3
   4         Copyright 2008, 2009 Michel Pollet <buserror@gmail.com>
   5
   6         This file is part of simavr.
   7
   8         simavr is free software: you can redistribute it and/or modify
   9         it under the terms of the GNU General Public License as published by
  10         the Free Software Foundation, either version 3 of the License, or
  11         (at your option) any later version.
  12
  13         simavr is distributed in the hope that it will be useful,
  14         but WITHOUT ANY WARRANTY; without even the implied warranty of
  15         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16         GNU General Public License for more details.
  17
  18         You should have received a copy of the GNU General Public License
  19         along with simavr.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef __AVR_EEPROM_H__
  23 #define __AVR_EEPROM_H__
  24
  25 #include "sim_avr.h"
  26
  27 typedef struct avr_eeprom_t {
  28         avr_io_t        io;
  29
  30         uint8_t *       eeprom; // actual bytes
  31         uint16_t        size;   // size for this MCU
  32
  33         uint8_t r_eearh;
  34         uint8_t r_eearl;
  35         uint8_t r_eedr;
  36
  37         // eepm -- eeprom write mode
  38         uint8_t r_eecr; // shortcut, assumes these bits fit in that register
  39         avr_regbit_t    eepm[4];
  40         avr_regbit_t    eempe;  // eeprom master program enable
  41         avr_regbit_t    eepe;   // eeprom program enable
  42         avr_regbit_t    eere;   // eeprom read enable
  43
  44         avr_int_vector_t ready; // EERIE vector
  45 } avr_eeprom_t;
  46
  47 void avr_eeprom_init(avr_t * avr, avr_eeprom_t * port);
  48
  49 typedef struct avr_eeprom_desc_t {
  50         uint8_t *       ee;
  51         uint16_t        offset;
  52         uint32_t        size;
  53 } avr_eeprom_desc_t;
  54
  55 #define AVR_IOCTL_EEPROM_GET    AVR_IOCTL_DEF('e','e','g','p')
  56 #define AVR_IOCTL_EEPROM_SET    AVR_IOCTL_DEF('e','e','s','p')
  57
  58
  59 /*
  60  * the eeprom block seems to be very similar across AVRs,
  61  * so here is a macro to declare a "typical" one in a core.
  62  */
  63
  64 #define AVR_EEPROM_DECLARE(_vector) \
  65         .eeprom = {\
  66                 .size = E2END+1,\
  67                 .r_eearh = EEARH,\
  68                 .r_eearl = EEARL,\
  69                 .r_eedr = EEDR,\
  70                 .r_eecr = EECR,\
  71                 .eepm = { AVR_IO_REGBIT(EECR, EEPM0), AVR_IO_REGBIT(EECR, EEPM1) },\
  72                 .eempe = AVR_IO_REGBIT(EECR, EEMPE),\
  73                 .eepe = AVR_IO_REGBIT(EECR, EEPE),\
  74                 .eere = AVR_IO_REGBIT(EECR, EERE),\
  75                 .ready = {\
  76                         .enable = AVR_IO_REGBIT(EECR, EERIE),\
  77                         .vector = _vector,\
  78                 },\
  79         }
  80
  81 /*
  82  * no EEPM registers in atmega128
  83  */
  84 #define AVR_EEPROM_DECLARE_NOEEPM(_vector)              \
  85         .eeprom = {\
  86                 .size = E2END+1,\
  87                 .r_eearh = EEARH,\
  88                 .r_eearl = EEARL,\
  89                 .r_eedr = EEDR,\
  90                 .r_eecr = EECR,\
  91                 .eepm = { },            \
  92                 .eempe = AVR_IO_REGBIT(EECR, EEMWE),\
  93                 .eepe = AVR_IO_REGBIT(EECR, EEWE),\
  94                 .eere = AVR_IO_REGBIT(EECR, EERE),\
  95                 .ready = {\
  96                         .enable = AVR_IO_REGBIT(EECR, EERIE),\
  97                         .vector = _vector,\
  98                 },\
  99         }
 100
 101
 102 /*
 103  * macro definition without a high address bit register,
 104  * which is not implemented in some tiny AVRs.
 105  */
 106
 107 #define AVR_EEPROM_DECLARE_8BIT(_vector) \
 108         .eeprom = {\
 109                 .size = E2END+1,\
 110                 .r_eearl = EEARL,\
 111                 .r_eedr = EEDR,\
 112                 .r_eecr = EECR,\
 113                 .eepm = { AVR_IO_REGBIT(EECR, EEPM0), AVR_IO_REGBIT(EECR, EEPM1) },\
 114                 .eempe = AVR_IO_REGBIT(EECR, EEMPE),\
 115                 .eepe = AVR_IO_REGBIT(EECR, EEPE),\
 116                 .eere = AVR_IO_REGBIT(EECR, EERE),\
 117                 .ready = {\
 118                         .enable = AVR_IO_REGBIT(EECR, EERIE),\
 119                         .vector = _vector,\
 120                 },\
 121         }
 122
 123 #endif /* __AVR_EEPROM_H__ */