include/hw/ipmi/ipmi_kcs.h

   1 /*
   2  * QEMU IPMI KCS emulation
   3  *
   4  * Copyright (c) 2015,2017 Corey Minyard, MontaVista Software, LLC
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #ifndef HW_IPMI_KCS_H
  26 #define HW_IPMI_KCS_H
  27
  28 #include "hw/ipmi/ipmi.h"
  29
  30 typedef struct IPMIKCS {
  31     IPMIBmc *bmc;
  32
  33     bool do_wake;
  34
  35     bool obf_irq_set;
  36     bool atn_irq_set;
  37     bool irqs_enabled;
  38
  39     uint8_t outmsg[MAX_IPMI_MSG_SIZE];
  40     uint32_t outpos;
  41     uint32_t outlen;
  42
  43     uint8_t inmsg[MAX_IPMI_MSG_SIZE];
  44     uint32_t inlen;
  45     bool write_end;
  46
  47     uint8_t status_reg;
  48     uint8_t data_out_reg;
  49
  50     int16_t data_in_reg; /* -1 means not written */
  51     int16_t cmd_reg;
  52
  53     /*
  54      * This is a response number that we send with the command to make
  55      * sure that the response matches the command.
  56      */
  57     uint8_t waiting_rsp;
  58
  59     uint32_t io_base;
  60     unsigned long io_length;
  61     MemoryRegion io;
  62     unsigned long size_mask;
  63
  64     void (*raise_irq)(struct IPMIKCS *ik);
  65     void (*lower_irq)(struct IPMIKCS *ik);
  66     void *opaque;
  67
  68     bool use_irq;
  69 } IPMIKCS;
  70
  71 void ipmi_kcs_get_fwinfo(IPMIKCS *ik, IPMIFwInfo *info);
  72 void ipmi_kcs_class_init(IPMIInterfaceClass *iic);
  73 extern const VMStateDescription vmstate_IPMIKCS;
  74 int ipmi_kcs_vmstate_post_load(void *opaque, int version);
  75
  76 #endif /* HW_IPMI_KCS_H */