include/hw/rtc/m48t59.h

   1 /*
   2  * QEMU M48T59 and M48T08 NVRAM emulation
   3  *
   4  * Copyright (c) 2003-2005, 2007 Jocelyn Mayer
   5  * Copyright (c) 2013 Hervé Poussineau
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23  * THE SOFTWARE.
  24  */
  25
  26 #ifndef HW_RTC_M48T59_H
  27 #define HW_RTC_M48T59_H
  28
  29 #include "exec/hwaddr.h"
  30 #include "qom/object.h"
  31
  32 #define TYPE_NVRAM "nvram"
  33
  34 typedef struct NvramClass NvramClass;
  35 DECLARE_CLASS_CHECKERS(NvramClass, NVRAM,
  36                        TYPE_NVRAM)
  37 #define NVRAM(obj) \
  38     INTERFACE_CHECK(Nvram, (obj), TYPE_NVRAM)
  39
  40 typedef struct Nvram Nvram;
  41
  42 struct NvramClass {
  43     InterfaceClass parent;
  44
  45     uint32_t (*read)(Nvram *obj, uint32_t addr);
  46     void (*write)(Nvram *obj, uint32_t addr, uint32_t val);
  47     void (*toggle_lock)(Nvram *obj, int lock);
  48 };
  49
  50 Nvram *m48t59_init_isa(ISABus *bus, uint32_t io_base, uint16_t size,
  51                        int base_year, int type);
  52 Nvram *m48t59_init(qemu_irq IRQ, hwaddr mem_base,
  53                    uint32_t io_base, uint16_t size, int base_year,
  54                    int type);
  55
  56 #endif /* HW_M48T59_H */