drivers/staging/unisys/common-spar/include/vmcallinterface.h

   1 /* Copyright (C) 2010 - 2013 UNISYS CORPORATION
   2  * All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or (at
   7  * your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  12  * NON INFRINGEMENT.  See the GNU General Public License for more
  13  * details.
  14  */
  15
  16 #ifndef __IOMONINTF_H__
  17 #define __IOMONINTF_H__
  18
  19 /*
  20 * This file contains all structures needed to support the VMCALLs for IO
  21 * Virtualization.  The VMCALLs are provided by Monitor and used by IO code
  22 * running on IO Partitions.
  23 */
  24
  25 #ifdef __GNUC__
  26 #include "iovmcall_gnuc.h"
  27 #endif  /*  */
  28 #include "diagchannel.h"
  29
  30 #ifdef VMCALL_IO_CONTROLVM_ADDR
  31 #undef VMCALL_IO_CONTROLVM_ADDR
  32 #endif  /*  */
  33
  34 /* define subsystem number for AppOS, used in uislib driver  */
  35 #define MDS_APPOS 0x4000000000000000L   /* subsystem = 62 - AppOS */
  36 enum vmcall_monitor_interface_method_tuple { /* VMCALL identification tuples  */
  37             /* Note: when a new VMCALL is added:
  38              * - the 1st 2 hex digits correspond to one of the
  39              *   VMCALL_MONITOR_INTERFACE types and
  40              * - the next 2 hex digits are the nth relative instance of within a
  41              *   type
  42              * E.G. for VMCALL_VIRTPART_RECYCLE_PART,
  43              * - the 0x02 identifies it as a VMCALL_VIRTPART type and
  44              * - the 0x01 identifies it as the 1st instance of a VMCALL_VIRTPART
  45              *   type of VMCALL
  46              */
  47
  48         VMCALL_IO_CONTROLVM_ADDR = 0x0501,      /* used by all Guests, not just
  49                                                  * IO */
  50         VMCALL_IO_DIAG_ADDR = 0x0508,
  51         VMCALL_IO_VISORSERIAL_ADDR = 0x0509,
  52         VMCALL_QUERY_GUEST_VIRTUAL_TIME_OFFSET = 0x0708, /* Allow caller to
  53                                                           * query virtual time
  54                                                           * offset */
  55         VMCALL_CHANNEL_VERSION_MISMATCH = 0x0709,
  56         VMCALL_POST_CODE_LOGEVENT = 0x070B,     /* LOGEVENT Post Code (RDX) with
  57                                                  * specified subsystem mask (RCX
  58                                                  * - monitor_subsystems.h) and
  59                                                  * severity (RDX) */
  60         VMCALL_GENERIC_SURRENDER_QUANTUM_FOREVER = 0x0802, /* Yield the
  61                                                             * remainder & all
  62                                                             * future quantums of
  63                                                             * the caller */
  64         VMCALL_MEASUREMENT_DO_NOTHING = 0x0901,
  65         VMCALL_UPDATE_PHYSICAL_TIME = 0x0a02    /* Allow
  66                                                  * ULTRA_SERVICE_CAPABILITY_TIME
  67                                                  * capable guest to make
  68                                                  * VMCALL */
  69 };
  70
  71 #define VMCALL_SUCCESS 0
  72 #define VMCALL_SUCCESSFUL(result)       (result == 0)
  73
  74 #ifdef __GNUC__
  75 #define unisys_vmcall(tuple, reg_ebx, reg_ecx) \
  76         __unisys_vmcall_gnuc(tuple, reg_ebx, reg_ecx)
  77 #define unisys_extended_vmcall(tuple, reg_ebx, reg_ecx, reg_edx) \
  78         __unisys_extended_vmcall_gnuc(tuple, reg_ebx, reg_ecx, reg_edx)
  79 #define ISSUE_IO_VMCALL(method, param, result) \
  80         (result = unisys_vmcall(method, (param) & 0xFFFFFFFF,   \
  81                                 (param) >> 32))
  82 #define ISSUE_IO_EXTENDED_VMCALL(method, param1, param2,        \
  83                                  param3, result)                        \
  84         (result = unisys_extended_vmcall(method, param1,        \
  85                                          param2, param3))
  86
  87     /* The following uses VMCALL_POST_CODE_LOGEVENT interface but is currently
  88      * not used much */
  89 #define ISSUE_IO_VMCALL_POSTCODE_SEVERITY(postcode, severity)           \
  90 do {                                                                    \
  91         u32 _tempresult = VMCALL_SUCCESS;                               \
  92         ISSUE_IO_EXTENDED_VMCALL(VMCALL_POST_CODE_LOGEVENT, severity,   \
  93                                  MDS_APPOS, postcode, _tempresult);     \
  94 } while (0)
  95 #endif
  96
  97 /* Structures for IO VMCALLs */
  98
  99 /* ///////////// BEGIN PRAGMA PACK PUSH 1 ///////////////////////// */
 100 /* ///////////// ONLY STRUCT TYPE SHOULD BE BELOW */
 101 #pragma pack(push, 1)
 102 struct phys_info {
 103         u64 pi_pfn;
 104         u16 pi_off;
 105         u16 pi_len;
 106 };
 107
 108 #pragma pack(pop)
 109 /* ///////////// END PRAGMA PACK PUSH 1 /////////////////////////// */
 110
 111 /* ///////////// BEGIN PRAGMA PACK PUSH 1 ///////////////////////// */
 112 /* ///////////// ONLY STRUCT TYPE SHOULD BE BELOW */
 113 #pragma pack(push, 1)
 114 /* Parameters to VMCALL_IO_CONTROLVM_ADDR interface */
 115 struct vmcall_io_controlvm_addr_params {
 116             /* The Guest-relative physical address of the ControlVm channel.
 117             * This VMCall fills this in with the appropriate address. */
 118         u64 address;    /* contents provided by this VMCALL (OUT) */
 119             /* the size of the ControlVm channel in bytes This VMCall fills this
 120             * in with the appropriate address. */
 121         u32 channel_bytes;      /* contents provided by this VMCALL (OUT) */
 122         u8 unused[4];           /* Unused Bytes in the 64-Bit Aligned Struct */
 123 };
 124
 125 #pragma pack(pop)
 126 /* ///////////// END PRAGMA PACK PUSH 1 /////////////////////////// */
 127
 128 /* ///////////// BEGIN PRAGMA PACK PUSH 1 ///////////////////////// */
 129 /* ///////////// ONLY STRUCT TYPE SHOULD BE BELOW */
 130 #pragma pack(push, 1)
 131 /* Parameters to VMCALL_IO_DIAG_ADDR interface */
 132 struct vmcall_io_diag_addr_params {
 133             /* The Guest-relative physical address of the diagnostic channel.
 134             * This VMCall fills this in with the appropriate address. */
 135         u64 address;    /* contents provided by this VMCALL (OUT) */
 136 };
 137
 138 #pragma pack(pop)
 139 /* ///////////// END PRAGMA PACK PUSH 1 /////////////////////////// */
 140
 141 /* ///////////// BEGIN PRAGMA PACK PUSH 1 ///////////////////////// */
 142 /* ///////////// ONLY STRUCT TYPE SHOULD BE BELOW */
 143 #pragma pack(push, 1)
 144 /* Parameters to VMCALL_IO_VISORSERIAL_ADDR interface */
 145 struct vmcall_io_visorserial_addr_params {
 146             /* The Guest-relative physical address of the serial console
 147             * channel.  This VMCall fills this in with the appropriate
 148             * address. */
 149         u64 address;    /* contents provided by this VMCALL (OUT) */
 150 };
 151
 152 #pragma pack(pop)
 153 /* ///////////// END PRAGMA PACK PUSH 1 /////////////////////////// */
 154
 155 /* Parameters to VMCALL_CHANNEL_MISMATCH interface */
 156 struct vmcall_channel_version_mismatch_params {
 157         u8 chname[32];  /* Null terminated string giving name of channel
 158                                  * (IN) */
 159         u8 item_name[32];       /* Null terminated string giving name of
 160                                  * mismatched item (IN) */
 161         u32 line_no;            /* line# where invoked. (IN) */
 162         u8 file_name[36];       /* source code where invoked - Null terminated
 163                                  * string (IN) */
 164 };
 165
 166 #endif /* __IOMONINTF_H__ */