include/asm-sparc64/hypervisor.h

   1 #ifndef _SPARC64_HYPERVISOR_H
   2 #define _SPARC64_HYPERVISOR_H
   3
   4 /* Sun4v hypervisor interfaces and defines.
   5  *
   6  * Hypervisor calls are made via traps to software traps number 0x80
   7  * and above.  Registers %o0 to %o5 serve as argument, status, and
   8  * return value registers.
   9  *
  10  * There are two kinds of these traps.  First there are the normal
  11  * "fast traps" which use software trap 0x80 and encode the function
  12  * to invoke by number in register %o5.  Argument and return value
  13  * handling is as follows:
  14  *
  15  * -----------------------------------------------
  16  * |  %o5  | function number |     undefined     |
  17  * |  %o0  |   argument 0    |   return status   |
  18  * |  %o1  |   argument 1    |   return value 1  |
  19  * |  %o2  |   argument 2    |   return value 2  |
  20  * |  %o3  |   argument 3    |   return value 3  |
  21  * |  %o4  |   argument 4    |   return value 4  |
  22  * -----------------------------------------------
  23  *
  24  * The second type are "hyper-fast traps" which encode the function
  25  * number in the software trap number itself.  So these use trap
  26  * numbers > 0x80.  The register usage for hyper-fast traps is as
  27  * follows:
  28  *
  29  * -----------------------------------------------
  30  * |  %o0  |   argument 0    |   return status   |
  31  * |  %o1  |   argument 1    |   return value 1  |
  32  * |  %o2  |   argument 2    |   return value 2  |
  33  * |  %o3  |   argument 3    |   return value 3  |
  34  * |  %o4  |   argument 4    |   return value 4  |
  35  * -----------------------------------------------
  36  *
  37  * Registers providing explicit arguments to the hypervisor calls
  38  * are volatile across the call.  Upon return their values are
  39  * undefined unless explicitly specified as containing a particular
  40  * return value by the specific call.  The return status is always
  41  * returned in register %o0, zero indicates a successful execution of
  42  * the hypervisor call and other values indicate an error status as
  43  * defined below.  So, for example, if a hyper-fast trap takes
  44  * arguments 0, 1, and 2, then %o0, %o1, and %o2 are volatile across
  45  * the call and %o3, %o4, and %o5 would be preserved.
  46  *
  47  * If the hypervisor trap is invalid, or the fast trap function number
  48  * is invalid, HV_EBADTRAP will be returned in %o0.  Also, all 64-bits
  49  * of the argument and return values are significant.
  50  */
  51
  52 /* Trap numbers.  */
  53 #define HV_FAST_TRAP            0x80
  54 #define HV_MMU_MAP_ADDR_TRAP    0x83
  55 #define HV_MMU_UNMAP_ADDR_TRAP  0x84
  56 #define HV_TTRACE_ADDENTRY_TRAP 0x85
  57 #define HV_CORE_TRAP            0xff
  58
  59 /* Error codes.  */
  60 #define HV_EOK                          0  /* Successful return            */
  61 #define HV_ENOCPU                       1  /* Invalid CPU id               */
  62 #define HV_ENORADDR                     2  /* Invalid real address         */
  63 #define HV_ENOINTR                      3  /* Invalid interrupt id         */
  64 #define HV_EBADPGSZ                     4  /* Invalid pagesize encoding    */
  65 #define HV_EBADTSB                      5  /* Invalid TSB description      */
  66 #define HV_EINVAL                       6  /* Invalid argument             */
  67 #define HV_EBADTRAP                     7  /* Invalid function number      */
  68 #define HV_EBADALIGN                    8  /* Invalid address alignment    */
  69 #define HV_EWOULDBLOCK                  9  /* Cannot complete w/o blocking */
  70 #define HV_ENOACCESS                    10 /* No access to resource        */
  71 #define HV_EIO                          11 /* I/O error                    */
  72 #define HV_ECPUERROR                    12 /* CPU in error state           */
  73 #define HV_ENOTSUPPORTED                13 /* Function not supported       */
  74 #define HV_ENOMAP                       14 /* No mapping found             */
  75 #define HV_ETOOMANY                     15 /* Too many items specified     */
  76
  77 /* mach_exit()
  78  * TRAP:        HV_FAST_TRAP
  79  * FUNCTION:    HV_FAST_MACH_EXIT
  80  * ARG0:        exit code
  81  * ERRORS:      This service does not return.
  82  *
  83  * Stop all CPUs in the virtual domain and place them into the stopped
  84  * state.  The 64-bit exit code may be passed to a service entity as
  85  * the domain's exit status.  On systems without a service entity, the
  86  * domain will undergo a reset, and the boot firmware will be
  87  * reloaded.
  88  *
  89  * This function will never return to the guest that invokes it.
  90  *
  91  * Note: By convention an exit code of zero denotes a successful exit by
  92  *       the guest code.  A non-zero exit code denotes a guest specific
  93  *       error indication.
  94  *
  95  */
  96 #define HV_FAST_MACH_EXIT               0x00
  97
  98 /* Domain services.  */
  99
 100 /* mach_desc()
 101  * TRAP:        HV_FAST_TRAP
 102  * FUNCTION:    HV_FAST_MACH_DESC
 103  * ARG0:        buffer
 104  * ARG1:        length
 105  * RET0:        status
 106  * RET1:        length
 107  * ERRORS:      HV_EBADALIGN    Buffer is badly aligned
 108  *              HV_ENORADDR     Buffer is to an illegal real address.
 109  *              HV_EINVAL       Buffer length is too small for complete
 110  *                              machine description.
 111  *
 112  * Copy the most current machine description into the buffer indicated
 113  * by the real address in ARG0.  The buffer provided must be 16 byte
 114  * aligned.  Upon success or HV_EINVAL, this service returns the
 115  * actual size of the machine description in the RET1 return value.
 116  *
 117  * Note: A method of determining the appropriate buffer size for the
 118  *       machine description is to first call this service with a buffer
 119  *       length of 0 bytes.
 120  */
 121 #define HV_FAST_MACH_DESC               0x01
 122
 123 /* mach_exit()
 124  * TRAP:        HV_FAST_TRAP
 125  * FUNCTION:    HV_FAST_MACH_SIR
 126  * ERRORS:      This service does not return.
 127  *
 128  * Perform a software initiated reset of the virtual machine domain.
 129  * All CPUs are captured as soon as possible, all hardware devices are
 130  * returned to the entry default state, and the domain is restarted at
 131  * the SIR (trap type 0x04) real trap table (RTBA) entry point on one
 132  * of the CPUs.  The single CPU restarted is selected as determined by
 133  * platform specific policy.  Memory is preserved across this
 134  * operation.
 135  */
 136 #define HV_FAST_MACH_SIR                0x02
 137
 138 /* mach_set_soft_state()
 139  * TRAP:        HV_FAST_TRAP
 140  * FUNCTION:    HV_FAST_MACH_SET_SOFT_STATE
 141  * ARG0:        software state
 142  * ARG1:        software state description pointer
 143  * RET0:        status
 144  * ERRORS:      EINVAL          software state not valid or software state
 145  *                              description is not NULL terminated
 146  *              ENORADDR        software state description pointer is not a
 147  *                              valid real address
 148  *              EBADALIGNED     software state description is not correctly
 149  *                              aligned
 150  *
 151  * This allows the guest to report it's soft state to the hypervisor.  There
 152  * are two primary components to this state.  The first part states whether
 153  * the guest software is running or not.  The second containts optional
 154  * details specific to the software.
 155  *
 156  * The software state argument is defined below in HV_SOFT_STATE_*, and
 157  * indicates whether the guest is operating normally or in a transitional
 158  * state.
 159  *
 160  * The software state description argument is a real address of a data buffer
 161  * of size 32-bytes aligned on a 32-byte boundary.  It is treated as a NULL
 162  * terminated 7-bit ASCII string of up to 31 characters not including the
 163  * NULL termination.
 164  */
 165 #define HV_FAST_MACH_SET_SOFT_STATE     0x03
 166 #define  HV_SOFT_STATE_NORMAL            0x01
 167 #define  HV_SOFT_STATE_TRANSITION        0x02
 168
 169 /* mach_get_soft_state()
 170  * TRAP:        HV_FAST_TRAP
 171  * FUNCTION:    HV_FAST_MACH_GET_SOFT_STATE
 172  * ARG0:        software state description pointer
 173  * RET0:        status
 174  * RET1:        software state
 175  * ERRORS:      ENORADDR        software state description pointer is not a
 176  *                              valid real address
 177  *              EBADALIGNED     software state description is not correctly
 178  *                              aligned
 179  *
 180  * Retrieve the current value of the guest's software state.  The rules
 181  * for the software state pointer are the same as for mach_set_soft_state()
 182  * above.
 183  */
 184 #define HV_FAST_MACH_GET_SOFT_STATE     0x04
 185
 186 /* CPU services.
 187  *
 188  * CPUs represent devices that can execute software threads.  A single
 189  * chip that contains multiple cores or strands is represented as
 190  * multiple CPUs with unique CPU identifiers.  CPUs are exported to
 191  * OBP via the machine description (and to the OS via the OBP device
 192  * tree).  CPUs are always in one of three states: stopped, running,
 193  * or error.
 194  *
 195  * A CPU ID is a pre-assigned 16-bit value that uniquely identifies a
 196  * CPU within a logical domain.  Operations that are to be performed
 197  * on multiple CPUs specify them via a CPU list.  A CPU list is an
 198  * array in real memory, of which each 16-bit word is a CPU ID.  CPU
 199  * lists are passed through the API as two arguments.  The first is
 200  * the number of entries (16-bit words) in the CPU list, and the
 201  * second is the (real address) pointer to the CPU ID list.
 202  */
 203
 204 /* cpu_start()
 205  * TRAP:        HV_FAST_TRAP
 206  * FUNCTION:    HV_FAST_CPU_START
 207  * ARG0:        CPU ID
 208  * ARG1:        PC
 209  * ARG1:        RTBA
 210  * ARG1:        target ARG0
 211  * RET0:        status
 212  * ERRORS:      ENOCPU          Invalid CPU ID
 213  *              EINVAL          Target CPU ID is not in the stopped state
 214  *              ENORADDR        Invalid PC or RTBA real address
 215  *              EBADALIGN       Unaligned PC or unaligned RTBA
 216  *              EWOULDBLOCK     Starting resources are not available
 217  *
 218  * Start CPU with given CPU ID with PC in %pc and with a real trap
 219  * base address value of RTBA.  The indicated CPU must be in the
 220  * stopped state.  The supplied RTBA must be aligned on a 256 byte
 221  * boundary.  On successful completion, the specified CPU will be in
 222  * the running state and will be supplied with "target ARG0" in %o0
 223  * and RTBA in %tba.
 224  */
 225 #define HV_FAST_CPU_START               0x10
 226
 227 /* cpu_stop()
 228  * TRAP:        HV_FAST_TRAP
 229  * FUNCTION:    HV_FAST_CPU_STOP
 230  * ARG0:        CPU ID
 231  * RET0:        status
 232  * ERRORS:      ENOCPU          Invalid CPU ID
 233  *              EINVAL          Target CPU ID is the current cpu
 234  *              EINVAL          Target CPU ID is not in the running state
 235  *              EWOULDBLOCK     Stopping resources are not available
 236  *              ENOTSUPPORTED   Not supported on this platform
 237  *
 238  * The specified CPU is stopped.  The indicated CPU must be in the
 239  * running state.  On completion, it will be in the stopped state.  It
 240  * is not legal to stop the current CPU.
 241  *
 242  * Note: As this service cannot be used to stop the current cpu, this service
 243  *       may not be used to stop the last running CPU in a domain.  To stop
 244  *       and exit a running domain, a guest must use the mach_exit() service.
 245  */
 246 #define HV_FAST_CPU_STOP                0x11
 247
 248 /* cpu_yield()
 249  * TRAP:        HV_FAST_TRAP
 250  * FUNCTION:    HV_FAST_CPU_YIELD
 251  * RET0:        status
 252  * ERRORS:      No possible error.
 253  *
 254  * Suspend execution on the current CPU.  Execution will resume when
 255  * an interrupt (device, %stick_compare, or cross-call) is targeted to
 256  * the CPU.  On some CPUs, this API may be used by the hypervisor to
 257  * save power by disabling hardware strands.
 258  */
 259 #define HV_FAST_CPU_YIELD               0x12
 260
 261
 262 /* cpu_qconf()
 263  * TRAP:        HV_FAST_TRAP
 264  * FUNCTION:    HV_FAST_CPU_QCONF
 265  * ARG0:        queue
 266  * ARG1:        base real address
 267  * ARG2:        number of entries
 268  * RET0:        status
 269  * ERRORS:      ENORADDR        Invalid base real address
 270  *              EINVAL          Invalid queue or number of entries is less
 271  *                              than 2 or too large.
 272  *              EBADALIGN       Base real address is not correctly aligned
 273  *                              for size.
 274  *
 275  * Configure the given queue to be placed at the given base real
 276  * address, with the given number of entries.  The number of entries
 277  * must be a power of 2.  The base real address must be aligned
 278  * exactly to match the queue size.  Each queue entry is 64 bytes
 279  * long, so for example a 32 entry queue must be aligned on a 2048
 280  * byte real address boundary.
 281  *
 282  * The specified queue is unconfigured if the number of entries is given
 283  * as zero.
 284  *
 285  * For the current version of this API service, the argument queue is defined
 286  * as follows:
 287  *
 288  *      queue           description
 289  *      -----           -------------------------
 290  *      0x3c            cpu mondo queue
 291  *      0x3d            device mondo queue
 292  *      0x3e            resumable error queue
 293  *      0x3f            non-resumable error queue
 294  *
 295  * Note: The maximum number of entries for each queue for a specific cpu may
 296  *       be determined from the machine description.
 297  */
 298 #define HV_FAST_CPU_QCONF               0x14
 299 #define  HV_CPU_QUEUE_CPU_MONDO          0x3c
 300 #define  HV_CPU_QUEUE_DEVICE_MONDO       0x3d
 301 #define  HV_CPU_QUEUE_RES_ERROR          0x3e
 302 #define  HV_CPU_QUEUE_NONRES_ERROR       0x3f
 303
 304 /* cpu_qinfo()
 305  * TRAP:        HV_FAST_TRAP
 306  * FUNCTION:    HV_FAST_CPU_QINFO
 307  * ARG0:        queue
 308  * RET0:        status
 309  * RET1:        base real address
 310  * RET1:        number of entries
 311  * ERRORS:      EINVAL          Invalid queue
 312  *
 313  * Return the configuration info for the given queue.  The base real
 314  * address and number of entries of the defined queue are returned.
 315  * The queue argument values are the same as for cpu_qconf() above.
 316  *
 317  * If the specified queue is a valid queue number, but no queue has
 318  * been defined, the number of entries will be set to zero and the
 319  * base real address returned is undefined.
 320  */
 321 #define HV_FAST_CPU_QINFO               0x15
 322
 323 /* cpu_mondo_send()
 324  * TRAP:        HV_FAST_TRAP
 325  * FUNCTION:    HV_FAST_CPU_MONDO_SEND
 326  * ARG0-1:      CPU list
 327  * ARG2:        data real address
 328  * RET0:        status
 329  * ERRORS:      EBADALIGN       Mondo data is not 64-byte aligned or CPU list
 330  *                              is not 2-byte aligned.
 331  *              ENORADDR        Invalid data mondo address, or invalid cpu list
 332  *                              address.
 333  *              ENOCPU          Invalid cpu in CPU list
 334  *              EWOULDBLOCK     Some or all of the listed CPUs did not receive
 335  *                              the mondo
 336  *              EINVAL          CPU list includes caller's CPU ID
 337  *
 338  * Send a mondo interrupt to the CPUs in the given CPU list with the
 339  * 64-bytes at the given data real address.  The data must be 64-byte
 340  * aligned.  The mondo data will be delivered to the cpu_mondo queues
 341  * of the recipient CPUs.
 342  *
 343  * In all cases, error or not, the CPUs in the CPU list to which the
 344  * mondo has been successfully delivered will be indicated by having
 345  * their entry in CPU list updated with the value 0xffff.
 346  */
 347 #define HV_FAST_CPU_MONDO_SEND          0x42
 348
 349 /* cpu_myid()
 350  * TRAP:        HV_FAST_TRAP
 351  * FUNCTION:    HV_FAST_CPU_MYID
 352  * RET0:        status
 353  * RET1:        CPU ID
 354  * ERRORS:      No errors defined.
 355  *
 356  * Return the hypervisor ID handle for the current CPU.  Use by a
 357  * virtual CPU to discover it's own identity.
 358  */
 359 #define HV_FAST_CPU_MYID                0x16
 360
 361 /* cpu_state()
 362  * TRAP:        HV_FAST_TRAP
 363  * FUNCTION:    HV_FAST_CPU_STATE
 364  * ARG0:        CPU ID
 365  * RET0:        status
 366  * RET1:        state
 367  * ERRORS:      ENOCPU          Invalid CPU ID
 368  *
 369  * Retrieve the current state of the CPU with the given CPU ID.
 370  */
 371 #define HV_FAST_CPU_STATE               0x17
 372 #define  HV_CPU_STATE_STOPPED            0x01
 373 #define  HV_CPU_STATE_RUNNING            0x02
 374 #define  HV_CPU_STATE_ERROR              0x03
 375
 376 /* cpu_set_rtba()
 377  * TRAP:        HV_FAST_TRAP
 378  * FUNCTION:    HV_FAST_CPU_SET_RTBA
 379  * ARG0:        RTBA
 380  * RET0:        status
 381  * RET1:        previous RTBA
 382  * ERRORS:      ENORADDR        Invalid RTBA real address
 383  *              EBADALIGN       RTBA is incorrectly aligned for a trap table
 384  *
 385  * Set the real trap base address of the local cpu to the given RTBA.
 386  * The supplied RTBA must be aligned on a 256 byte boundary.  Upon
 387  * success the previous value of the RTBA is returned in RET1.
 388  *
 389  * Note: This service does not affect %tba
 390  */
 391 #define HV_FAST_CPU_SET_RTBA            0x18
 392
 393 /* cpu_set_rtba()
 394  * TRAP:        HV_FAST_TRAP
 395  * FUNCTION:    HV_FAST_CPU_GET_RTBA
 396  * RET0:        status
 397  * RET1:        previous RTBA
 398  * ERRORS:      No possible error.
 399  *
 400  * Returns the current value of RTBA in RET1.
 401  */
 402 #define HV_FAST_CPU_GET_RTBA            0x19
 403
 404 /* MMU services.
 405  *
 406  * Layout of a TSB description for mmu_tsb_ctx{,non}0() calls.
 407  */
 408 #ifndef __ASSEMBLY__
 409 struct hv_tsb_descr {
 410         unsigned short          pgsz_idx;
 411         unsigned short          assoc;
 412         unsigned int            num_ttes;       /* in TTEs */
 413         unsigned int            ctx_idx;
 414         unsigned int            pgsz_mask;
 415         unsigned long           tsb_base;
 416         unsigned long           resv;
 417 };
 418 #endif
 419 #define HV_TSB_DESCR_PGSZ_IDX_OFFSET    0x00
 420 #define HV_TSB_DESCR_ASSOC_OFFSET       0x02
 421 #define HV_TSB_DESCR_NUM_TTES_OFFSET    0x04
 422 #define HV_TSB_DESCR_CTX_IDX_OFFSET     0x08
 423 #define HV_TSB_DESCR_PGSZ_MASK_OFFSET   0x0c
 424 #define HV_TSB_DESCR_TSB_BASE_OFFSET    0x10
 425 #define HV_TSB_DESCR_RESV_OFFSET        0x18
 426
 427 /* Page size bitmask.  */
 428 #define HV_PGSZ_MASK_8K                 (1 << 0)
 429 #define HV_PGSZ_MASK_64K                (1 << 1)
 430 #define HV_PGSZ_MASK_512K               (1 << 2)
 431 #define HV_PGSZ_MASK_4MB                (1 << 3)
 432 #define HV_PGSZ_MASK_32MB               (1 << 4)
 433 #define HV_PGSZ_MASK_256MB              (1 << 5)
 434 #define HV_PGSZ_MASK_2GB                (1 << 6)
 435 #define HV_PGSZ_MASK_16GB               (1 << 7)
 436
 437 /* Page size index.  The value given in the TSB descriptor must correspond
 438  * to the smallest page size specified in the pgsz_mask page size bitmask.
 439  */
 440 #define HV_PGSZ_IDX_8K                  0
 441 #define HV_PGSZ_IDX_64K                 1
 442 #define HV_PGSZ_IDX_512K                2
 443 #define HV_PGSZ_IDX_4MB                 3
 444 #define HV_PGSZ_IDX_32MB                4
 445 #define HV_PGSZ_IDX_256MB               5
 446 #define HV_PGSZ_IDX_2GB                 6
 447 #define HV_PGSZ_IDX_16GB                7
 448
 449 /* MMU fault status area.
 450  *
 451  * MMU related faults have their status and fault address information
 452  * placed into a memory region made available by privileged code.  Each
 453  * virtual processor must make a mmu_fault_area_conf() call to tell the
 454  * hypervisor where that processor's fault status should be stored.
 455  *
 456  * The fault status block is a multiple of 64-bytes and must be aligned
 457  * on a 64-byte boundary.
 458  */
 459 #ifndef __ASSEMBLY__
 460 struct hv_fault_status {
 461         unsigned long           i_fault_type;
 462         unsigned long           i_fault_addr;
 463         unsigned long           i_fault_ctx;
 464         unsigned long           i_reserved[5];
 465         unsigned long           d_fault_type;
 466         unsigned long           d_fault_addr;
 467         unsigned long           d_fault_ctx;
 468         unsigned long           d_reserved[5];
 469 };
 470 #endif
 471 #define HV_FAULT_I_TYPE_OFFSET  0x00
 472 #define HV_FAULT_I_ADDR_OFFSET  0x08
 473 #define HV_FAULT_I_CTX_OFFSET   0x10
 474 #define HV_FAULT_D_TYPE_OFFSET  0x40
 475 #define HV_FAULT_D_ADDR_OFFSET  0x48
 476 #define HV_FAULT_D_CTX_OFFSET   0x50
 477
 478 #define HV_FAULT_TYPE_FAST_MISS 1
 479 #define HV_FAULT_TYPE_FAST_PROT 2
 480 #define HV_FAULT_TYPE_MMU_MISS  3
 481 #define HV_FAULT_TYPE_INV_RA    4
 482 #define HV_FAULT_TYPE_PRIV_VIOL 5
 483 #define HV_FAULT_TYPE_PROT_VIOL 6
 484 #define HV_FAULT_TYPE_NFO       7
 485 #define HV_FAULT_TYPE_NFO_SEFF  8
 486 #define HV_FAULT_TYPE_INV_VA    9
 487 #define HV_FAULT_TYPE_INV_ASI   10
 488 #define HV_FAULT_TYPE_NC_ATOMIC 11
 489 #define HV_FAULT_TYPE_PRIV_ACT  12
 490 #define HV_FAULT_TYPE_RESV1     13
 491 #define HV_FAULT_TYPE_UNALIGNED 14
 492 #define HV_FAULT_TYPE_INV_PGSZ  15
 493 /* Values 16 --> -2 are reserved.  */
 494 #define HV_FAULT_TYPE_MULTIPLE  -1
 495
 496 /* Flags argument for mmu_{map,unmap}_addr(), mmu_demap_{page,context,all}(),
 497  * and mmu_{map,unmap}_perm_addr().
 498  */
 499 #define HV_MMU_DMMU                     0x01
 500 #define HV_MMU_IMMU                     0x02
 501 #define HV_MMU_ALL                      (HV_MMU_DMMU | HV_MMU_IMMU)
 502
 503 /* mmu_map_addr()
 504  * TRAP:        HV_MMU_MAP_ADDR_TRAP
 505  * ARG0:        virtual address
 506  * ARG1:        mmu context
 507  * ARG2:        TTE
 508  * ARG3:        flags (HV_MMU_{IMMU,DMMU})
 509  * ERRORS:      EINVAL          Invalid virtual address, mmu context, or flags
 510  *              EBADPGSZ        Invalid page size value
 511  *              ENORADDR        Invalid real address in TTE
 512  *
 513  * Create a non-permanent mapping using the given TTE, virtual
 514  * address, and mmu context.  The flags argument determines which
 515  * (data, or instruction, or both) TLB the mapping gets loaded into.
 516  *
 517  * The behavior is undefined if the valid bit is clear in the TTE.
 518  *
 519  * Note: This API call is for privileged code to specify temporary translation
 520  *       mappings without the need to create and manage a TSB.
 521  */
 522
 523 /* mmu_unmap_addr()
 524  * TRAP:        HV_MMU_UNMAP_ADDR_TRAP
 525  * ARG0:        virtual address
 526  * ARG1:        mmu context
 527  * ARG2:        flags (HV_MMU_{IMMU,DMMU})
 528  * ERRORS:      EINVAL          Invalid virtual address, mmu context, or flags
 529  *
 530  * Demaps the given virtual address in the given mmu context on this
 531  * CPU.  This function is intended to be used to demap pages mapped
 532  * with mmu_map_addr.  This service is equivalent to invoking
 533  * mmu_demap_page() with only the current CPU in the CPU list. The
 534  * flags argument determines which (data, or instruction, or both) TLB
 535  * the mapping gets unmapped from.
 536  *
 537  * Attempting to perform an unmap operation for a previously defined
 538  * permanent mapping will have undefined results.
 539  */
 540
 541 /* mmu_tsb_ctx0()
 542  * TRAP:        HV_FAST_TRAP
 543  * FUNCTION:    HV_FAST_MMU_TSB_CTX0
 544  * ARG0:        number of TSB descriptions
 545  * ARG1:        TSB descriptions pointer
 546  * RET0:        status
 547  * ERRORS:      ENORADDR                Invalid TSB descriptions pointer or
 548  *                                      TSB base within a descriptor
 549  *              EBADALIGN               TSB descriptions pointer is not aligned
 550  *                                      to an 8-byte boundary, or TSB base
 551  *                                      within a descriptor is not aligned for
 552  *                                      the given TSB size
 553  *              EBADPGSZ                Invalid page size in a TSB descriptor
 554  *              EBADTSB                 Invalid associativity or size in a TSB
 555  *                                      descriptor
 556  *              EINVAL                  Invalid number of TSB descriptions, or
 557  *                                      invalid context index in a TSB
 558  *                                      descriptor, or index page size not
 559  *                                      equal to smallest page size in page
 560  *                                      size bitmask field.
 561  *
 562  * Configures the TSBs for the current CPU for virtual addresses with
 563  * context zero.  The TSB descriptions pointer is a pointer to an
 564  * array of the given number of TSB descriptions.
 565  *
 566  * Note: The maximum number of TSBs available to a virtual CPU is given by the
 567  *       mmu-max-#tsbs property of the cpu's corresponding "cpu" node in the
 568  *       machine description.
 569  */
 570 #define HV_FAST_MMU_TSB_CTX0            0x20
 571
 572 /* mmu_tsb_ctxnon0()
 573  * TRAP:        HV_FAST_TRAP
 574  * FUNCTION:    HV_FAST_MMU_TSB_CTXNON0
 575  * ARG0:        number of TSB descriptions
 576  * ARG1:        TSB descriptions pointer
 577  * RET0:        status
 578  * ERRORS:      Same as for mmu_tsb_ctx0() above.
 579  *
 580  * Configures the TSBs for the current CPU for virtual addresses with
 581  * non-zero contexts.  The TSB descriptions pointer is a pointer to an
 582  * array of the given number of TSB descriptions.
 583  *
 584  * Note: A maximum of 16 TSBs may be specified in the TSB description list.
 585  */
 586 #define HV_FAST_MMU_TSB_CTXNON0         0x21
 587
 588 /* mmu_demap_page()
 589  * TRAP:        HV_FAST_TRAP
 590  * FUNCTION:    HV_FAST_MMU_DEMAP_PAGE
 591  * ARG0:        reserved, must be zero
 592  * ARG1:        reserved, must be zero
 593  * ARG2:        virtual address
 594  * ARG3:        mmu context
 595  * ARG4:        flags (HV_MMU_{IMMU,DMMU})
 596  * RET0:        status
 597  * ERRORS:      EINVAL                  Invalid virutal address, context, or
 598  *                                      flags value
 599  *              ENOTSUPPORTED           ARG0 or ARG1 is non-zero
 600  *
 601  * Demaps any page mapping of the given virtual address in the given
 602  * mmu context for the current virtual CPU.  Any virtually tagged
 603  * caches are guaranteed to be kept consistent.  The flags argument
 604  * determines which TLB (instruction, or data, or both) participate in
 605  * the operation.
 606  *
 607  * ARG0 and ARG1 are both reserved and must be set to zero.
 608  */
 609 #define HV_FAST_MMU_DEMAP_PAGE          0x22
 610
 611 /* mmu_demap_ctx()
 612  * TRAP:        HV_FAST_TRAP
 613  * FUNCTION:    HV_FAST_MMU_DEMAP_CTX
 614  * ARG0:        reserved, must be zero
 615  * ARG1:        reserved, must be zero
 616  * ARG2:        mmu context
 617  * ARG3:        flags (HV_MMU_{IMMU,DMMU})
 618  * RET0:        status
 619  * ERRORS:      EINVAL                  Invalid context or flags value
 620  *              ENOTSUPPORTED           ARG0 or ARG1 is non-zero
 621  *
 622  * Demaps all non-permanent virtual page mappings previously specified
 623  * for the given context for the current virtual CPU.  Any virtual
 624  * tagged caches are guaranteed to be kept consistent.  The flags
 625  * argument determines which TLB (instruction, or data, or both)
 626  * participate in the operation.
 627  *
 628  * ARG0 and ARG1 are both reserved and must be set to zero.
 629  */
 630 #define HV_FAST_MMU_DEMAP_CTX           0x23
 631
 632 /* mmu_demap_all()
 633  * TRAP:        HV_FAST_TRAP
 634  * FUNCTION:    HV_FAST_MMU_DEMAP_ALL
 635  * ARG0:        reserved, must be zero
 636  * ARG1:        reserved, must be zero
 637  * ARG2:        flags (HV_MMU_{IMMU,DMMU})
 638  * RET0:        status
 639  * ERRORS:      EINVAL                  Invalid flags value
 640  *              ENOTSUPPORTED           ARG0 or ARG1 is non-zero
 641  *
 642  * Demaps all non-permanent virtual page mappings previously specified
 643  * for the current virtual CPU.  Any virtual tagged caches are
 644  * guaranteed to be kept consistent.  The flags argument determines
 645  * which TLB (instruction, or data, or both) participate in the
 646  * operation.
 647  *
 648  * ARG0 and ARG1 are both reserved and must be set to zero.
 649  */
 650 #define HV_FAST_MMU_DEMAP_ALL           0x24
 651
 652 /* mmu_map_perm_addr()
 653  * TRAP:        HV_FAST_TRAP
 654  * FUNCTION:    HV_FAST_MMU_MAP_PERM_ADDR
 655  * ARG0:        virtual address
 656  * ARG1:        reserved, must be zero
 657  * ARG2:        TTE
 658  * ARG3:        flags (HV_MMU_{IMMU,DMMU})
 659  * RET0:        status
 660  * ERRORS:      EINVAL                  Invalid virutal address or flags value
 661  *              EBADPGSZ                Invalid page size value
 662  *              ENORADDR                Invalid real address in TTE
 663  *              ETOOMANY                Too many mappings (max of 8 reached)
 664  *
 665  * Create a permanent mapping using the given TTE and virtual address
 666  * for context 0 on the calling virtual CPU.  A maximum of 8 such
 667  * permanent mappings may be specified by privileged code.  Mappings
 668  * may be removed with mmu_unmap_perm_addr().
 669  *
 670  * The behavior is undefined if a TTE with the valid bit clear is given.
 671  *
 672  * Note: This call is used to specify address space mappings for which
 673  *       privileged code does not expect to receive misses.  For example,
 674  *       this mechanism can be used to map kernel nucleus code and data.
 675  */
 676 #define HV_FAST_MMU_MAP_PERM_ADDR       0x25
 677
 678 /* mmu_fault_area_conf()
 679  * TRAP:        HV_FAST_TRAP
 680  * FUNCTION:    HV_FAST_MMU_FAULT_AREA_CONF
 681  * ARG0:        real address
 682  * RET0:        status
 683  * RET1:        previous mmu fault area real address
 684  * ERRORS:      ENORADDR                Invalid real address
 685  *              EBADALIGN               Invalid alignment for fault area
 686  *
 687  * Configure the MMU fault status area for the calling CPU.  A 64-byte
 688  * aligned real address specifies where MMU fault status information
 689  * is placed.  The return value is the previously specified area, or 0
 690  * for the first invocation.  Specifying a fault area at real address
 691  * 0 is not allowed.
 692  */
 693 #define HV_FAST_MMU_FAULT_AREA_CONF     0x26
 694
 695 /* mmu_enable()
 696  * TRAP:        HV_FAST_TRAP
 697  * FUNCTION:    HV_FAST_MMU_ENABLE
 698  * ARG0:        enable flag
 699  * ARG1:        return target address
 700  * RET0:        status
 701  * ERRORS:      ENORADDR                Invalid real address when disabling
 702  *                                      translation.
 703  *              EBADALIGN               The return target address is not
 704  *                                      aligned to an instruction.
 705  *              EINVAL                  The enable flag request the current
 706  *                                      operating mode (e.g. disable if already
 707  *                                      disabled)
 708  *
 709  * Enable or disable virtual address translation for the calling CPU
 710  * within the virtual machine domain.  If the enable flag is zero,
 711  * translation is disabled, any non-zero value will enable
 712  * translation.
 713  *
 714  * When this function returns, the newly selected translation mode
 715  * will be active.  If the mmu is being enabled, then the return
 716  * target address is a virtual address else it is a real address.
 717  *
 718  * Upon successful completion, control will be returned to the given
 719  * return target address (ie. the cpu will jump to that address).  On
 720  * failure, the previous mmu mode remains and the trap simply returns
 721  * as normal with the appropriate error code in RET0.
 722  */
 723 #define HV_FAST_MMU_ENABLE              0x27
 724
 725 /* mmu_unmap_perm_addr()
 726  * TRAP:        HV_FAST_TRAP
 727  * FUNCTION:    HV_FAST_MMU_UNMAP_PERM_ADDR
 728  * ARG0:        virtual address
 729  * ARG1:        reserved, must be zero
 730  * ARG2:        flags (HV_MMU_{IMMU,DMMU})
 731  * RET0:        status
 732  * ERRORS:      EINVAL                  Invalid virutal address or flags value
 733  *              ENOMAP                  Specified mapping was not found
 734  *
 735  * Demaps any permanent page mapping (established via
 736  * mmu_map_perm_addr()) at the given virtual address for context 0 on
 737  * the current virtual CPU.  Any virtual tagged caches are guaranteed
 738  * to be kept consistent.
 739  */
 740 #define HV_FAST_MMU_UNMAP_PERM_ADDR     0x28
 741
 742 /* mmu_tsb_ctx0_info()
 743  * TRAP:        HV_FAST_TRAP
 744  * FUNCTION:    HV_FAST_MMU_TSB_CTX0_INFO
 745  * ARG0:        max TSBs
 746  * ARG1:        buffer pointer
 747  * RET0:        status
 748  * RET1:        number of TSBs
 749  * ERRORS:      EINVAL                  Supplied buffer is too small
 750  *              EBADALIGN               The buffer pointer is badly aligned
 751  *              ENORADDR                Invalid real address for buffer pointer
 752  *
 753  * Return the TSB configuration as previous defined by mmu_tsb_ctx0()
 754  * into the provided buffer.  The size of the buffer is given in ARG1
 755  * in terms of the number of TSB description entries.
 756  *
 757  * Upon return, RET1 always contains the number of TSB descriptions
 758  * previously configured.  If zero TSBs were configured, EOK is
 759  * returned with RET1 containing 0.
 760  */
 761 #define HV_FAST_MMU_TSB_CTX0_INFO       0x29
 762
 763 /* mmu_tsb_ctxnon0_info()
 764  * TRAP:        HV_FAST_TRAP
 765  * FUNCTION:    HV_FAST_MMU_TSB_CTXNON0_INFO
 766  * ARG0:        max TSBs
 767  * ARG1:        buffer pointer
 768  * RET0:        status
 769  * RET1:        number of TSBs
 770  * ERRORS:      EINVAL                  Supplied buffer is too small
 771  *              EBADALIGN               The buffer pointer is badly aligned
 772  *              ENORADDR                Invalid real address for buffer pointer
 773  *
 774  * Return the TSB configuration as previous defined by
 775  * mmu_tsb_ctxnon0() into the provided buffer.  The size of the buffer
 776  * is given in ARG1 in terms of the number of TSB description entries.
 777  *
 778  * Upon return, RET1 always contains the number of TSB descriptions
 779  * previously configured.  If zero TSBs were configured, EOK is
 780  * returned with RET1 containing 0.
 781  */
 782 #define HV_FAST_MMU_TSB_CTXNON0_INFO    0x2a
 783
 784 /* mmu_fault_area_info()
 785  * TRAP:        HV_FAST_TRAP
 786  * FUNCTION:    HV_FAST_MMU_FAULT_AREA_INFO
 787  * RET0:        status
 788  * RET1:        fault area real address
 789  * ERRORS:      No errors defined.
 790  *
 791  * Return the currently defined MMU fault status area for the current
 792  * CPU.  The real address of the fault status area is returned in
 793  * RET1, or 0 is returned in RET1 if no fault status area is defined.
 794  *
 795  * Note: mmu_fault_area_conf() may be called with the return value (RET1)
 796  *       from this service if there is a need to save and restore the fault
 797  *       area for a cpu.
 798  */
 799 #define HV_FAST_MMU_FAULT_AREA_INFO     0x2b
 800
 801 /* Cache and Memory services. */
 802
 803 /* mem_scrub()
 804  * TRAP:        HV_FAST_TRAP
 805  * FUNCTION:    HV_FAST_MEM_SCRUB
 806  * ARG0:        real address
 807  * ARG1:        length
 808  * RET0:        status
 809  * RET1:        length scrubbed
 810  * ERRORS:      ENORADDR        Invalid real address
 811  *              EBADALIGN       Start address or length are not correctly
 812  *                              aligned
 813  *              EINVAL          Length is zero
 814  *
 815  * Zero the memory contents in the range real address to real address
 816  * plus length minus 1.  Also, valid ECC will be generated for that
 817  * memory address range.  Scrubbing is started at the given real
 818  * address, but may not scrub the entire given length.  The actual
 819  * length scrubbed will be returned in RET1.
 820  *
 821  * The real address and length must be aligned on an 8K boundary, or
 822  * contain the start address and length from a sun4v error report.
 823  *
 824  * Note: There are two uses for this function.  The first use is to block clear
 825  *       and initialize memory and the second is to scrub an u ncorrectable
 826  *       error reported via a resumable or non-resumable trap.  The second
 827  *       use requires the arguments to be equal to the real address and length
 828  *       provided in a sun4v memory error report.
 829  */
 830 #define HV_FAST_MEM_SCRUB               0x31
 831
 832 /* mem_sync()
 833  * TRAP:        HV_FAST_TRAP
 834  * FUNCTION:    HV_FAST_MEM_SYNC
 835  * ARG0:        real address
 836  * ARG1:        length
 837  * RET0:        status
 838  * RET1:        length synced
 839  * ERRORS:      ENORADDR        Invalid real address
 840  *              EBADALIGN       Start address or length are not correctly
 841  *                              aligned
 842  *              EINVAL          Length is zero
 843  *
 844  * Force the next access within the real address to real address plus
 845  * length minus 1 to be fetches from main system memory.  Less than
 846  * the given length may be synced, the actual amount synced is
 847  * returned in RET1.  The real address and length must be aligned on
 848  * an 8K boundary.
 849  */
 850 #define HV_FAST_MEM_SYNC                0x32
 851
 852 /* Time of day services.
 853  *
 854  * The hypervisor maintains the time of day on a per-domain basis.
 855  * Changing the time of day in one domain does not affect the time of
 856  * day on any other domain.
 857  *
 858  * Time is described by a single unsigned 64-bit word which is the
 859  * number of seconds since the UNIX Epoch (00:00:00 UTC, January 1,
 860  * 1970).
 861  */
 862
 863 /* tod_get()
 864  * TRAP:        HV_FAST_TRAP
 865  * FUNCTION:    HV_FAST_TOD_GET
 866  * RET0:        status
 867  * RET1:        TOD
 868  * ERRORS:      EWOULDBLOCK     TOD resource is temporarily unavailable
 869  *              ENOTSUPPORTED   If TOD not supported on this platform
 870  *
 871  * Return the current time of day.  May block if TOD access is
 872  * temporarily not possible.
 873  */
 874 #define HV_FAST_TOD_GET                 0x50
 875
 876 /* tod_set()
 877  * TRAP:        HV_FAST_TRAP
 878  * FUNCTION:    HV_FAST_TOD_SET
 879  * ARG0:        TOD
 880  * RET0:        status
 881  * ERRORS:      EWOULDBLOCK     TOD resource is temporarily unavailable
 882  *              ENOTSUPPORTED   If TOD not supported on this platform
 883  *
 884  * The current time of day is set to the value specified in ARG0.  May
 885  * block if TOD access is temporarily not possible.
 886  */
 887 #define HV_FAST_TOD_SET                 0x51
 888
 889 /* Console services */
 890
 891 /* con_getchar()
 892  * TRAP:        HV_FAST_TRAP
 893  * FUNCTION:    HV_FAST_CONS_GETCHAR
 894  * RET0:        status
 895  * RET1:        character
 896  * ERRORS:      EWOULDBLOCK     No character available.
 897  *
 898  * Returns a character from the console device.  If no character is
 899  * available then an EWOULDBLOCK error is returned.  If a character is
 900  * available, then the returned status is EOK and the character value
 901  * is in RET1.
 902  *
 903  * A virtual BREAK is represented by the 64-bit value -1.
 904  *
 905  * A virtual HUP signal is represented by the 64-bit value -2.
 906  */
 907 #define HV_FAST_CONS_GETCHAR            0x60
 908
 909 /* con_putchar()
 910  * TRAP:        HV_FAST_TRAP
 911  * FUNCTION:    HV_FAST_CONS_PUTCHAR
 912  * ARG0:        character
 913  * RET0:        status
 914  * ERRORS:      EINVAL          Illegal character
 915  *              EWOULDBLOCK     Output buffer currently full, would block
 916  *
 917  * Send a character to the console device.  Only character values
 918  * between 0 and 255 may be used.  Values outside this range are
 919  * invalid except for the 64-bit value -1 which is used to send a
 920  * virtual BREAK.
 921  */
 922 #define HV_FAST_CONS_PUTCHAR            0x61
 923
 924 /* Trap trace services.
 925  *
 926  * The hypervisor provides a trap tracing capability for privileged
 927  * code running on each virtual CPU.  Privileged code provides a
 928  * round-robin trap trace queue within which the hypervisor writes
 929  * 64-byte entries detailing hyperprivileged traps taken n behalf of
 930  * privileged code.  This is provided as a debugging capability for
 931  * privileged code.
 932  *
 933  * The trap trace control structure is 64-bytes long and placed at the
 934  * start (offset 0) of the trap trace buffer, and is described as
 935  * follows:
 936  */
 937 #ifndef __ASSEMBLY__
 938 struct hv_trap_trace_control {
 939         unsigned long           head_offset;
 940         unsigned long           tail_offset;
 941         unsigned long           __reserved[0x30 / sizeof(unsigned long)];
 942 };
 943 #endif
 944 #define HV_TRAP_TRACE_CTRL_HEAD_OFFSET  0x00
 945 #define HV_TRAP_TRACE_CTRL_TAIL_OFFSET  0x08
 946
 947 /* The head offset is the offset of the most recently completed entry
 948  * in the trap-trace buffer.  The tail offset is the offset of the
 949  * next entry to be written.  The control structure is owned and
 950  * modified by the hypervisor.  A guest may not modify the control
 951  * structure contents.  Attempts to do so will result in undefined
 952  * behavior for the guest.
 953  *
 954  * Each trap trace buffer entry is layed out as follows:
 955  */
 956 #ifndef __ASSEMBLY__
 957 struct hv_trap_trace_entry {
 958         unsigned char   type;           /* Hypervisor or guest entry?   */
 959         unsigned char   hpstate;        /* Hyper-privileged state       */
 960         unsigned char   tl;             /* Trap level                   */
 961         unsigned char   gl;             /* Global register level        */
 962         unsigned short  tt;             /* Trap type                    */
 963         unsigned short  tag;            /* Extended trap identifier     */
 964         unsigned long   tstate;         /* Trap state                   */
 965         unsigned long   tick;           /* Tick                         */
 966         unsigned long   tpc;            /* Trap PC                      */
 967         unsigned long   f1;             /* Entry specific               */
 968         unsigned long   f2;             /* Entry specific               */
 969         unsigned long   f3;             /* Entry specific               */
 970         unsigned long   f4;             /* Entry specific               */
 971 };
 972 #endif
 973 #define HV_TRAP_TRACE_ENTRY_TYPE        0x00
 974 #define HV_TRAP_TRACE_ENTRY_HPSTATE     0x01
 975 #define HV_TRAP_TRACE_ENTRY_TL          0x02
 976 #define HV_TRAP_TRACE_ENTRY_GL          0x03
 977 #define HV_TRAP_TRACE_ENTRY_TT          0x04
 978 #define HV_TRAP_TRACE_ENTRY_TAG         0x06
 979 #define HV_TRAP_TRACE_ENTRY_TSTATE      0x08
 980 #define HV_TRAP_TRACE_ENTRY_TICK        0x10
 981 #define HV_TRAP_TRACE_ENTRY_TPC         0x18
 982 #define HV_TRAP_TRACE_ENTRY_F1          0x20
 983 #define HV_TRAP_TRACE_ENTRY_F2          0x28
 984 #define HV_TRAP_TRACE_ENTRY_F3          0x30
 985 #define HV_TRAP_TRACE_ENTRY_F4          0x38
 986
 987 /* The type field is encoded as follows.  */
 988 #define HV_TRAP_TYPE_UNDEF              0x00 /* Entry content undefined     */
 989 #define HV_TRAP_TYPE_HV                 0x01 /* Hypervisor trap entry       */
 990 #define HV_TRAP_TYPE_GUEST              0xff /* Added via ttrace_addentry() */
 991
 992 /* ttrace_buf_conf()
 993  * TRAP:        HV_FAST_TRAP
 994  * FUNCTION:    HV_FAST_TTRACE_BUF_CONF
 995  * ARG0:        real address
 996  * ARG1:        number of entries
 997  * RET0:        status
 998  * RET1:        number of entries
 999  * ERRORS:      ENORADDR        Invalid real address
1000  *              EINVAL          Size is too small
1001  *              EBADALIGN       Real address not aligned on 64-byte boundary
1002  *
1003  * Requests hypervisor trap tracing and declares a virtual CPU's trap
1004  * trace buffer to the hypervisor.  The real address supplies the real
1005  * base address of the trap trace queue and must be 64-byte aligned.
1006  * Specifying a value of 0 for the number of entries disables trap
1007  * tracing for the calling virtual CPU.  The buffer allocated must be
1008  * sized for a power of two number of 64-byte trap trace entries plus
1009  * an initial 64-byte control structure.
1010  *
1011  * This may be invoked any number of times so that a virtual CPU may
1012  * relocate a trap trace buffer or create "snapshots" of information.
1013  *
1014  * If the real address is illegal or badly aligned, then trap tracing
1015  * is disabled and an error is returned.
1016  *
1017  * Upon failure with EINVAL, this service call returns in RET1 the
1018  * minimum number of buffer entries required.  Upon other failures
1019  * RET1 is undefined.
1020  */
1021 #define HV_FAST_TTRACE_BUF_CONF         0x90
1022
1023 /* ttrace_buf_info()
1024  * TRAP:        HV_FAST_TRAP
1025  * FUNCTION:    HV_FAST_TTRACE_BUF_INFO
1026  * RET0:        status
1027  * RET1:        real address
1028  * RET2:        size
1029  * ERRORS:      None defined.
1030  *
1031  * Returns the size and location of the previously declared trap-trace
1032  * buffer.  In the event that no buffer was previously defined, or the
1033  * buffer is disabled, this call will return a size of zero bytes.
1034  */
1035 #define HV_FAST_TTRACE_BUF_INFO         0x91
1036
1037 /* ttrace_enable()
1038  * TRAP:        HV_FAST_TRAP
1039  * FUNCTION:    HV_FAST_TTRACE_ENABLE
1040  * ARG0:        enable
1041  * RET0:        status
1042  * RET1:        previous enable state
1043  * ERRORS:      EINVAL          No trap trace buffer currently defined
1044  *
1045  * Enable or disable trap tracing, and return the previous enabled
1046  * state in RET1.  Future systems may define various flags for the
1047  * enable argument (ARG0), for the moment a guest should pass
1048  * "(uint64_t) -1" to enable, and "(uint64_t) 0" to disable all
1049  * tracing - which will ensure future compatability.
1050  */
1051 #define HV_FAST_TTRACE_ENABLE           0x92
1052
1053 /* ttrace_freeze()
1054  * TRAP:        HV_FAST_TRAP
1055  * FUNCTION:    HV_FAST_TTRACE_FREEZE
1056  * ARG0:        freeze
1057  * RET0:        status
1058  * RET1:        previous freeze state
1059  * ERRORS:      EINVAL          No trap trace buffer currently defined
1060  *
1061  * Freeze or unfreeze trap tracing, returning the previous freeze
1062  * state in RET1.  A guest should pass a non-zero value to freeze and
1063  * a zero value to unfreeze all tracing.  The returned previous state
1064  * is 0 for not frozen and 1 for frozen.
1065  */
1066 #define HV_FAST_TTRACE_FREEZE           0x93
1067
1068 /* ttrace_addentry()
1069  * TRAP:        HV_TTRACE_ADDENTRY_TRAP
1070  * ARG0:        tag (16-bits)
1071  * ARG1:        data word 0
1072  * ARG2:        data word 1
1073  * ARG3:        data word 2
1074  * ARG4:        data word 3
1075  * RET0:        status
1076  * ERRORS:      EINVAL          No trap trace buffer currently defined
1077  *
1078  * Add an entry to the trap trace buffer.  Upon return only ARG0/RET0
1079  * is modified - none of the other registers holding arguments are
1080  * volatile across this hypervisor service.
1081  */
1082
1083 /* Core dump services.
1084  *
1085  * Since the hypervisor viraulizes and thus obscures a lot of the
1086  * physical machine layout and state, traditional OS crash dumps can
1087  * be difficult to diagnose especially when the problem is a
1088  * configuration error of some sort.
1089  *
1090  * The dump services provide an opaque buffer into which the
1091  * hypervisor can place it's internal state in order to assist in
1092  * debugging such situations.  The contents are opaque and extremely
1093  * platform and hypervisor implementation specific.  The guest, during
1094  * a core dump, requests that the hypervisor update any information in
1095  * the dump buffer in preparation to being dumped as part of the
1096  * domain's memory image.
1097  */
1098
1099 /* dump_buf_update()
1100  * TRAP:        HV_FAST_TRAP
1101  * FUNCTION:    HV_FAST_DUMP_BUF_UPDATE
1102  * ARG0:        real address
1103  * ARG1:        size
1104  * RET0:        status
1105  * RET1:        required size of dump buffer
1106  * ERRORS:      ENORADDR        Invalid real address
1107  *              EBADALIGN       Real address is not aligned on a 64-byte
1108  *                              boundary
1109  *              EINVAL          Size is non-zero but less than minimum size
1110  *                              required
1111  *              ENOTSUPPORTED   Operation not supported on current logical
1112  *                              domain
1113  *
1114  * Declare a domain dump buffer to the hypervisor.  The real address
1115  * provided for the domain dump buffer must be 64-byte aligned.  The
1116  * size specifies the size of the dump buffer and may be larger than
1117  * the minimum size specified in the machine description.  The
1118  * hypervisor will fill the dump buffer with opaque data.
1119  *
1120  * Note: A guest may elect to include dump buffer contents as part of a crash
1121  *       dump to assist with debugging.  This function may be called any number
1122  *       of times so that a guest may relocate a dump buffer, or create
1123  *       "snapshots" of any dump-buffer information.  Each call to
1124  *       dump_buf_update() atomically declares the new dump buffer to the
1125  *       hypervisor.
1126  *
1127  * A specified size of 0 unconfigures the dump buffer.  If the real
1128  * address is illegal or badly aligned, then any currently active dump
1129  * buffer is disabled and an error is returned.
1130  *
1131  * In the event that the call fails with EINVAL, RET1 contains the
1132  * minimum size requires by the hypervisor for a valid dump buffer.
1133  */
1134 #define HV_FAST_DUMP_BUF_UPDATE         0x94
1135
1136 /* dump_buf_info()
1137  * TRAP:        HV_FAST_TRAP
1138  * FUNCTION:    HV_FAST_DUMP_BUF_INFO
1139  * RET0:        status
1140  * RET1:        real address of current dump buffer
1141  * RET2:        size of current dump buffer
1142  * ERRORS:      No errors defined.
1143  *
1144  * Return the currently configures dump buffer description.  A
1145  * returned size of 0 bytes indicates an undefined dump buffer.  In
1146  * this case the return address in RET1 is undefined.
1147  */
1148 #define HV_FAST_DUMP_BUF_INFO           0x95
1149
1150 /* Device interrupt services.
1151  *
1152  * Device interrupts are allocated to system bus bridges by the hypervisor,
1153  * and described to OBP in the machine description.  OBP then describes
1154  * these interrupts to the OS via properties in the device tree.
1155  *
1156  * Terminology:
1157  *
1158  *      cpuid           Unique opaque value which represents a target cpu.
1159  *
1160  *      devhandle       Device handle.  It uniquely identifies a device, and
1161  *                      consistes of the lower 28-bits of the hi-cell of the
1162  *                      first entry of the device's "reg" property in the
1163  *                      OBP device tree.
1164  *
1165  *      devino          Device interrupt number.  Specifies the relative
1166  *                      interrupt number within the device.  The unique
1167  *                      combination of devhandle and devino are used to
1168  *                      identify a specific device interrupt.
1169  *
1170  *                      Note: The devino value is the same as the values in the
1171  *                            "interrupts" property or "interrupt-map" property
1172  *                            in the OBP device tree for that device.
1173  *
1174  *      sysino          System interrupt number.  A 64-bit unsigned interger
1175  *                      representing a unique interrupt within a virtual
1176  *                      machine.
1177  *
1178  *      intr_state      A flag representing the interrupt state for a given
1179  *                      sysino.  The state values are defined below.
1180  *
1181  *      intr_enabled    A flag representing the 'enabled' state for a given
1182  *                      sysino.  The enable values are defined below.
1183  */
1184
1185 #define HV_INTR_STATE_IDLE              0 /* Nothing pending */
1186 #define HV_INTR_STATE_RECEIVED          1 /* Interrupt received by hardware */
1187 #define HV_INTR_STATE_DELIVERED         2 /* Interrupt delivered to queue */
1188
1189 #define HV_INTR_DISABLED                0 /* sysino not enabled */
1190 #define HV_INTR_ENABLED                 1 /* sysino enabled */
1191
1192 /* intr_devino_to_sysino()
1193  * TRAP:        HV_FAST_TRAP
1194  * FUNCTION:    HV_FAST_INTR_DEVINO2SYSINO
1195  * ARG0:        devhandle
1196  * ARG1:        devino
1197  * RET0:        status
1198  * RET1:        sysino
1199  * ERRORS:      EINVAL          Invalid devhandle/devino
1200  *
1201  * Converts a device specific interrupt number of the given
1202  * devhandle/devino into a system specific ino (sysino).
1203  */
1204 #define HV_FAST_INTR_DEVINO2SYSINO      0xa0
1205
1206 #ifndef __ASSEMBLY__
1207 extern unsigned long sun4v_devino_to_sysino(unsigned long devhandle,
1208                                             unsigned long devino);
1209 #endif
1210
1211 /* intr_getenabled()
1212  * TRAP:        HV_FAST_TRAP
1213  * FUNCTION:    HV_FAST_INTR_GETENABLED
1214  * ARG0:        sysino
1215  * RET0:        status
1216  * RET1:        intr_enabled (HV_INTR_{DISABLED,ENABLED})
1217  * ERRORS:      EINVAL          Invalid sysino
1218  *
1219  * Returns interrupt enabled state in RET1 for the interrupt defined
1220  * by the given sysino.
1221  */
1222 #define HV_FAST_INTR_GETENABLED         0xa1
1223
1224 #ifndef __ASSEMBLY__
1225 extern unsigned long sun4v_intr_getenabled(unsigned long sysino);
1226 #endif
1227
1228 /* intr_setenabled()
1229  * TRAP:        HV_FAST_TRAP
1230  * FUNCTION:    HV_FAST_INTR_SETENABLED
1231  * ARG0:        sysino
1232  * ARG1:        intr_enabled (HV_INTR_{DISABLED,ENABLED})
1233  * RET0:        status
1234  * ERRORS:      EINVAL          Invalid sysino or intr_enabled value
1235  *
1236  * Set the 'enabled' state of the interrupt sysino.
1237  */
1238 #define HV_FAST_INTR_SETENABLED         0xa2
1239
1240 #ifndef __ASSEMBLY__
1241 extern unsigned long sun4v_intr_setenabled(unsigned long sysino, unsigned long intr_enabled);
1242 #endif
1243
1244 /* intr_getstate()
1245  * TRAP:        HV_FAST_TRAP
1246  * FUNCTION:    HV_FAST_INTR_GETSTATE
1247  * ARG0:        sysino
1248  * RET0:        status
1249  * RET1:        intr_state (HV_INTR_STATE_*)
1250  * ERRORS:      EINVAL          Invalid sysino
1251  *
1252  * Returns current state of the interrupt defined by the given sysino.
1253  */
1254 #define HV_FAST_INTR_GETSTATE           0xa3
1255
1256 #ifndef __ASSEMBLY__
1257 extern unsigned long sun4v_intr_getstate(unsigned long sysino);
1258 #endif
1259
1260 /* intr_setstate()
1261  * TRAP:        HV_FAST_TRAP
1262  * FUNCTION:    HV_FAST_INTR_SETSTATE
1263  * ARG0:        sysino
1264  * ARG1:        intr_state (HV_INTR_STATE_*)
1265  * RET0:        status
1266  * ERRORS:      EINVAL          Invalid sysino or intr_state value
1267  *
1268  * Sets the current state of the interrupt described by the given sysino
1269  * value.
1270  *
1271  * Note: Setting the state to HV_INTR_STATE_IDLE clears any pending
1272  *       interrupt for sysino.
1273  */
1274 #define HV_FAST_INTR_SETSTATE           0xa4
1275
1276 #ifndef __ASSEMBLY__
1277 extern unsigned long sun4v_intr_setstate(unsigned long sysino, unsigned long intr_state);
1278 #endif
1279
1280 /* intr_gettarget()
1281  * TRAP:        HV_FAST_TRAP
1282  * FUNCTION:    HV_FAST_INTR_GETTARGET
1283  * ARG0:        sysino
1284  * RET0:        status
1285  * RET1:        cpuid
1286  * ERRORS:      EINVAL          Invalid sysino
1287  *
1288  * Returns CPU that is the current target of the interrupt defined by
1289  * the given sysino.  The CPU value returned is undefined if the target
1290  * has not been set via intr_settarget().
1291  */
1292 #define HV_FAST_INTR_GETTARGET          0xa5
1293
1294 #ifndef __ASSEMBLY__
1295 extern unsigned long sun4v_intr_gettarget(unsigned long sysino);
1296 #endif
1297
1298 /* intr_settarget()
1299  * TRAP:        HV_FAST_TRAP
1300  * FUNCTION:    HV_FAST_INTR_SETTARGET
1301  * ARG0:        sysino
1302  * ARG1:        cpuid
1303  * RET0:        status
1304  * ERRORS:      EINVAL          Invalid sysino
1305  *              ENOCPU          Invalid cpuid
1306  *
1307  * Set the target CPU for the interrupt defined by the given sysino.
1308  */
1309 #define HV_FAST_INTR_SETTARGET          0xa6
1310
1311 #ifndef __ASSEMBLY__
1312 extern unsigned long sun4v_intr_settarget(unsigned long sysino, unsigned long cpuid);
1313 #endif
1314
1315 /* PCI IO services.
1316  *
1317  * See the terminology descriptions in the device interrupt services
1318  * section above as those apply here too.  Here are terminology
1319  * definitions specific to these PCI IO services:
1320  *
1321  *      tsbnum          TSB number.  Indentifies which io-tsb is used.
1322  *                      For this version of the specification, tsbnum
1323  *                      must be zero.
1324  *
1325  *      tsbindex        TSB index.  Identifies which entry in the TSB
1326  *                      is used.  The first entry is zero.
1327  *
1328  *      tsbid           A 64-bit aligned data structure which contains
1329  *                      a tsbnum and a tsbindex.  Bits 63:32 contain the
1330  *                      tsbnum and bits 31:00 contain the tsbindex.
1331  *
1332  *                      Use the HV_PCI_TSBID() macro to construct such
1333  *                      values.
1334  *
1335  *      io_attributes   IO attributes for IOMMU mappings.  One of more
1336  *                      of the attritbute bits are stores in a 64-bit
1337  *                      value.  The values are defined below.
1338  *
1339  *      r_addr          64-bit real address
1340  *
1341  *      pci_device      PCI device address.  A PCI device address identifies
1342  *                      a specific device on a specific PCI bus segment.
1343  *                      A PCI device address ia a 32-bit unsigned integer
1344  *                      with the following format:
1345  *
1346  *                              00000000.bbbbbbbb.dddddfff.00000000
1347  *
1348  *                      Use the HV_PCI_DEVICE_BUILD() macro to construct
1349  *                      such values.
1350  *
1351  *      pci_config_offset
1352  *                      PCI configureation space offset.  For conventional
1353  *                      PCI a value between 0 and 255.  For extended
1354  *                      configuration space, a value between 0 and 4095.
1355  *
1356  *                      Note: For PCI configuration space accesses, the offset
1357  *                            must be aligned to the access size.
1358  *
1359  *      error_flag      A return value which specifies if the action succeeded
1360  *                      or failed.  0 means no error, non-0 means some error
1361  *                      occurred while performing the service.
1362  *
1363  *      io_sync_direction
1364  *                      Direction definition for pci_dma_sync(), defined
1365  *                      below in HV_PCI_SYNC_*.
1366  *
1367  *      io_page_list    A list of io_page_addresses, an io_page_address is
1368  *                      a real address.
1369  *
1370  *      io_page_list_p  A pointer to an io_page_list.
1371  *
1372  *      "size based byte swap" - Some functions do size based byte swapping
1373  *                               which allows sw to access pointers and
1374  *                               counters in native form when the processor
1375  *                               operates in a different endianness than the
1376  *                               IO bus.  Size-based byte swapping converts a
1377  *                               multi-byte field between big-endian and
1378  *                               little-endian format.
1379  */
1380
1381 #define HV_PCI_MAP_ATTR_READ            0x01
1382 #define HV_PCI_MAP_ATTR_WRITE           0x02
1383
1384 #define HV_PCI_DEVICE_BUILD(b,d,f)      \
1385         ((((b) & 0xff) << 16) | \
1386          (((d) & 0x1f) << 11) | \
1387          (((f) & 0x07) <<  8))
1388
1389 #define HV_PCI_TSBID(__tsb_num, __tsb_index) \
1390         ((((u64)(__tsb_num)) << 32UL) | ((u64)(__tsb_index)))
1391
1392 #define HV_PCI_SYNC_FOR_DEVICE          0x01
1393 #define HV_PCI_SYNC_FOR_CPU             0x02
1394
1395 /* pci_iommu_map()
1396  * TRAP:        HV_FAST_TRAP
1397  * FUNCTION:    HV_FAST_PCI_IOMMU_MAP
1398  * ARG0:        devhandle
1399  * ARG1:        tsbid
1400  * ARG2:        #ttes
1401  * ARG3:        io_attributes
1402  * ARG4:        io_page_list_p
1403  * RET0:        status
1404  * RET1:        #ttes mapped
1405  * ERRORS:      EINVAL          Invalid devhandle/tsbnum/tsbindex/io_attributes
1406  *              EBADALIGN       Improperly aligned real address
1407  *              ENORADDR        Invalid real address
1408  *
1409  * Create IOMMU mappings in the sun4v device defined by the given
1410  * devhandle.  The mappings are created in the TSB defined by the
1411  * tsbnum component of the given tsbid.  The first mapping is created
1412  * in the TSB i ndex defined by the tsbindex component of the given tsbid.
1413  * The call creates up to #ttes mappings, the first one at tsbnum, tsbindex,
1414  * the second at tsbnum, tsbindex + 1, etc.
1415  *
1416  * All mappings are created with the attributes defined by the io_attributes
1417  * argument.  The page mapping addresses are described in the io_page_list
1418  * defined by the given io_page_list_p, which is a pointer to the io_page_list.
1419  * The first entry in the io_page_list is the address for the first iotte, the
1420  * 2nd for the 2nd iotte, and so on.
1421  *
1422  * Each io_page_address in the io_page_list must be appropriately aligned.
1423  * #ttes must be greater than zero.  For this version of the spec, the tsbnum
1424  * component of the given tsbid must be zero.
1425  *
1426  * Returns the actual number of mappings creates, which may be less than
1427  * or equal to the argument #ttes.  If the function returns a value which
1428  * is less than the #ttes, the caller may continus to call the function with
1429  * an updated tsbid, #ttes, io_page_list_p arguments until all pages are
1430  * mapped.
1431  *
1432  * Note: This function does not imply an iotte cache flush.  The guest must
1433  *       demap an entry before re-mapping it.
1434  */
1435 #define HV_FAST_PCI_IOMMU_MAP           0xb0
1436
1437 /* pci_iommu_demap()
1438  * TRAP:        HV_FAST_TRAP
1439  * FUNCTION:    HV_FAST_PCI_IOMMU_DEMAP
1440  * ARG0:        devhandle
1441  * ARG1:        tsbid
1442  * ARG2:        #ttes
1443  * RET0:        status
1444  * RET1:        #ttes demapped
1445  * ERRORS:      EINVAL          Invalid devhandle/tsbnum/tsbindex
1446  *
1447  * Demap and flush IOMMU mappings in the device defined by the given
1448  * devhandle.  Demaps up to #ttes entries in the TSB defined by the tsbnum
1449  * component of the given tsbid, starting at the TSB index defined by the
1450  * tsbindex component of the given tsbid.
1451  *
1452  * For this version of the spec, the tsbnum of the given tsbid must be zero.
1453  * #ttes must be greater than zero.
1454  *
1455  * Returns the actual number of ttes demapped, which may be less than or equal
1456  * to the argument #ttes.  If #ttes demapped is less than #ttes, the caller
1457  * may continue to call this function with updated tsbid and #ttes arguments
1458  * until all pages are demapped.
1459  *
1460  * Note: Entries do not have to be mapped to be demapped.  A demap of an
1461  *       unmapped page will flush the entry from the tte cache.
1462  */
1463 #define HV_FAST_PCI_IOMMU_DEMAP         0xb1
1464
1465 /* pci_iommu_getmap()
1466  * TRAP:        HV_FAST_TRAP
1467  * FUNCTION:    HV_FAST_PCI_IOMMU_GETMAP
1468  * ARG0:        devhandle
1469  * ARG1:        tsbid
1470  * RET0:        status
1471  * RET1:        io_attributes
1472  * RET2:        real address
1473  * ERRORS:      EINVAL          Invalid devhandle/tsbnum/tsbindex
1474  *              ENOMAP          Mapping is not valid, no translation exists
1475  *
1476  * Read and return the mapping in the device described by the given devhandle
1477  * and tsbid.  If successful, the io_attributes shall be returned in RET1
1478  * and the page address of the mapping shall be returned in RET2.
1479  *
1480  * For this version of the spec, the tsbnum component of the given tsbid
1481  * must be zero.
1482  */
1483 #define HV_FAST_PCI_IOMMU_GETMAP        0xb2
1484
1485 /* pci_iommu_getbypass()
1486  * TRAP:        HV_FAST_TRAP
1487  * FUNCTION:    HV_FAST_PCI_IOMMU_GETBYPASS
1488  * ARG0:        devhandle
1489  * ARG1:        real address
1490  * ARG2:        io_attributes
1491  * RET0:        status
1492  * RET1:        io_addr
1493  * ERRORS:      EINVAL          Invalid devhandle/io_attributes
1494  *              ENORADDR        Invalid real address
1495  *              ENOTSUPPORTED   Function not supported in this implementation.
1496  *
1497  * Create a "special" mapping in the device described by the given devhandle,
1498  * for the given real address and attributes.  Return the IO address in RET1
1499  * if successful.
1500  */
1501 #define HV_FAST_PCI_IOMMU_GETBYPASS     0xb3
1502
1503 /* pci_config_get()
1504  * TRAP:        HV_FAST_TRAP
1505  * FUNCTION:    HV_FAST_PCI_CONFIG_GET
1506  * ARG0:        devhandle
1507  * ARG1:        pci_device
1508  * ARG2:        pci_config_offset
1509  * ARG3:        size
1510  * RET0:        status
1511  * RET1:        error_flag
1512  * RET2:        data
1513  * ERRORS:      EINVAL          Invalid devhandle/pci_device/offset/size
1514  *              EBADALIGN       pci_config_offset not size aligned
1515  *              ENOACCESS       Access to this offset is not permitted
1516  *
1517  * Read PCI configuration space for the adapter described by the given
1518  * devhandle.  Read size (1, 2, or 4) bytes of data from the given
1519  * pci_device, at pci_config_offset from the beginning of the device's
1520  * configuration space.  If there was no error, RET1 is set to zero and
1521  * RET2 is set to the data read.  Insignificant bits in RET2 are not
1522  * guarenteed to have any specific value and therefore must be ignored.
1523  *
1524  * The data returned in RET2 is size based byte swapped.
1525  *
1526  * If an error occurs during the read, set RET1 to a non-zero value.  The
1527  * given pci_config_offset must be 'size' aligned.
1528  */
1529 #define HV_FAST_PCI_CONFIG_GET          0xb4
1530
1531 /* pci_config_put()
1532  * TRAP:        HV_FAST_TRAP
1533  * FUNCTION:    HV_FAST_PCI_CONFIG_PUT
1534  * ARG0:        devhandle
1535  * ARG1:        pci_device
1536  * ARG2:        pci_config_offset
1537  * ARG3:        size
1538  * ARG4:        data
1539  * RET0:        status
1540  * RET1:        error_flag
1541  * ERRORS:      EINVAL          Invalid devhandle/pci_device/offset/size
1542  *              EBADALIGN       pci_config_offset not size aligned
1543  *              ENOACCESS       Access to this offset is not permitted
1544  *
1545  * Write PCI configuration space for the adapter described by the given
1546  * devhandle.  Write size (1, 2, or 4) bytes of data in a single operation,
1547  * at pci_config_offset from the beginning of the device's configuration
1548  * space.  The data argument contains the data to be written to configuration
1549  * space.  Prior to writing, the data is size based byte swapped.
1550  *
1551  * If an error occurs during the write access, do not generate an error
1552  * report, do set RET1 to a non-zero value.  Otherwise RET1 is zero.
1553  * The given pci_config_offset must be 'size' aligned.
1554  *
1555  * This function is permitted to read from offset zero in the configuration
1556  * space described by the given pci_device if necessary to ensure that the
1557  * write access to config space completes.
1558  */
1559 #define HV_FAST_PCI_CONFIG_PUT          0xb5
1560
1561 /* pci_peek()
1562  * TRAP:        HV_FAST_TRAP
1563  * FUNCTION:    HV_FAST_PCI_PEEK
1564  * ARG0:        devhandle
1565  * ARG1:        real address
1566  * ARG2:        size
1567  * RET0:        status
1568  * RET1:        error_flag
1569  * RET2:        data
1570  * ERRORS:      EINVAL          Invalid devhandle or size
1571  *              EBADALIGN       Improperly aligned real address
1572  *              ENORADDR        Bad real address
1573  *              ENOACCESS       Guest access prohibited
1574  *
1575  * Attempt to read the IO address given by the given devhandle, real address,
1576  * and size.  Size must be 1, 2, 4, or 8.  The read is performed as a single
1577  * access operation using the given size.  If an error occurs when reading
1578  * from the given location, do not generate an error report, but return a
1579  * non-zero value in RET1.  If the read was successful, return zero in RET1
1580  * and return the actual data read in RET2.  The data returned is size based
1581  * byte swapped.
1582  *
1583  * Non-significant bits in RET2 are not guarenteed to have any specific value
1584  * and therefore must be ignored.  If RET1 is returned as non-zero, the data
1585  * value is not guarenteed to have any specific value and should be ignored.
1586  *
1587  * The caller must have permission to read from the given devhandle, real
1588  * address, which must be an IO address.  The argument real address must be a
1589  * size aligned address.
1590  *
1591  * The hypervisor implementation of this function must block access to any
1592  * IO address that the guest does not have explicit permission to access.
1593  */
1594 #define HV_FAST_PCI_PEEK                0xb6
1595
1596 /* pci_poke()
1597  * TRAP:        HV_FAST_TRAP
1598  * FUNCTION:    HV_FAST_PCI_POKE
1599  * ARG0:        devhandle
1600  * ARG1:        real address
1601  * ARG2:        size
1602  * ARG3:        data
1603  * ARG4:        pci_device
1604  * RET0:        status
1605  * RET1:        error_flag
1606  * ERRORS:      EINVAL          Invalid devhandle, size, or pci_device
1607  *              EBADALIGN       Improperly aligned real address
1608  *              ENORADDR        Bad real address
1609  *              ENOACCESS       Guest access prohibited
1610  *              ENOTSUPPORTED   Function is not supported by implementation
1611  *
1612  * Attempt to write data to the IO address given by the given devhandle,
1613  * real address, and size.  Size must be 1, 2, 4, or 8.  The write is
1614  * performed as a single access operation using the given size. Prior to
1615  * writing the data is size based swapped.
1616  *
1617  * If an error occurs when writing to the given location, do not generate an
1618  * error report, but return a non-zero value in RET1.  If the write was
1619  * successful, return zero in RET1.
1620  *
1621  * pci_device describes the configuration address of the device being
1622  * written to.  The implementation may safely read from offset 0 with
1623  * the configuration space of the device described by devhandle and
1624  * pci_device in order to guarantee that the write portion of the operation
1625  * completes
1626  *
1627  * Any error that occurs due to the read shall be reported using the normal
1628  * error reporting mechanisms .. the read error is not suppressed.
1629  *
1630  * The caller must have permission to write to the given devhandle, real
1631  * address, which must be an IO address.  The argument real address must be a
1632  * size aligned address.  The caller must have permission to read from
1633  * the given devhandle, pci_device cofiguration space offset 0.
1634  *
1635  * The hypervisor implementation of this function must block access to any
1636  * IO address that the guest does not have explicit permission to access.
1637  */
1638 #define HV_FAST_PCI_POKE                0xb7
1639
1640 /* pci_dma_sync()
1641  * TRAP:        HV_FAST_TRAP
1642  * FUNCTION:    HV_FAST_PCI_DMA_SYNC
1643  * ARG0:        devhandle
1644  * ARG1:        real address
1645  * ARG2:        size
1646  * ARG3:        io_sync_direction
1647  * RET0:        status
1648  * RET1:        #synced
1649  * ERRORS:      EINVAL          Invalid devhandle or io_sync_direction
1650  *              ENORADDR        Bad real address
1651  *
1652  * Synchronize a memory region described by the given real address and size,
1653  * for the device defined by the given devhandle using the direction(s)
1654  * defined by the given io_sync_direction.  The argument size is the size of
1655  * the memory region in bytes.
1656  *
1657  * Return the actual number of bytes synchronized in the return value #synced,
1658  * which may be less than or equal to the argument size.  If the return
1659  * value #synced is less than size, the caller must continue to call this
1660  * function with updated real address and size arguments until the entire
1661  * memory region is synchronized.
1662  */
1663 #define HV_FAST_PCI_DMA_SYNC            0xb8
1664
1665 /* PCI MSI services.  */
1666
1667 #define HV_MSITYPE_MSI32                0x00
1668 #define HV_MSITYPE_MSI64                0x01
1669
1670 #define HV_MSIQSTATE_IDLE               0x00
1671 #define HV_MSIQSTATE_ERROR              0x01
1672
1673 #define HV_MSIQ_INVALID                 0x00
1674 #define HV_MSIQ_VALID                   0x01
1675
1676 #define HV_MSISTATE_IDLE                0x00
1677 #define HV_MSISTATE_DELIVERED           0x01
1678
1679 #define HV_MSIVALID_INVALID             0x00
1680 #define HV_MSIVALID_VALID               0x01
1681
1682 #define HV_PCIE_MSGTYPE_PME_MSG         0x18
1683 #define HV_PCIE_MSGTYPE_PME_ACK_MSG     0x1b
1684 #define HV_PCIE_MSGTYPE_CORR_MSG        0x30
1685 #define HV_PCIE_MSGTYPE_NONFATAL_MSG    0x31
1686 #define HV_PCIE_MSGTYPE_FATAL_MSG       0x33
1687
1688 #define HV_MSG_INVALID                  0x00
1689 #define HV_MSG_VALID                    0x01
1690
1691 /* pci_msiq_conf()
1692  * TRAP:        HV_FAST_TRAP
1693  * FUNCTION:    HV_FAST_PCI_MSIQ_CONF
1694  * ARG0:        devhandle
1695  * ARG1:        msiqid
1696  * ARG2:        real address
1697  * ARG3:        number of entries
1698  * RET0:        status
1699  * ERRORS:      EINVAL          Invalid devhandle, msiqid or nentries
1700  *              EBADALIGN       Improperly aligned real address
1701  *              ENORADDR        Bad real address
1702  *
1703  * Configure the MSI queue given by the devhandle and msiqid arguments,
1704  * and to be placed at the given real address and be of the given
1705  * number of entries.  The real address must be aligned exactly to match
1706  * the queue size.  Each queue entry is 64-bytes long, so f.e. a 32 entry
1707  * queue must be aligned on a 2048 byte real address boundary.  The MSI-EQ
1708  * Head and Tail are initialized so that the MSI-EQ is 'empty'.
1709  *
1710  * Implementation Note: Certain implementations have fixed sized queues.  In
1711  *                      that case, number of entries must contain the correct
1712  *                      value.
1713  */
1714 #define HV_FAST_PCI_MSIQ_CONF           0xc0
1715
1716 /* pci_msiq_info()
1717  * TRAP:        HV_FAST_TRAP
1718  * FUNCTION:    HV_FAST_PCI_MSIQ_INFO
1719  * ARG0:        devhandle
1720  * ARG1:        msiqid
1721  * RET0:        status
1722  * RET1:        real address
1723  * RET2:        number of entries
1724  * ERRORS:      EINVAL          Invalid devhandle or msiqid
1725  *
1726  * Return the configuration information for the MSI queue described
1727  * by the given devhandle and msiqid.  The base address of the queue
1728  * is returned in ARG1 and the number of entries is returned in ARG2.
1729  * If the queue is unconfigured, the real address is undefined and the
1730  * number of entries will be returned as zero.
1731  */
1732 #define HV_FAST_PCI_MSIQ_INFO           0xc1
1733
1734 /* pci_msiq_getvalid()
1735  * TRAP:        HV_FAST_TRAP
1736  * FUNCTION:    HV_FAST_PCI_MSIQ_GETVALID
1737  * ARG0:        devhandle
1738  * ARG1:        msiqid
1739  * RET0:        status
1740  * RET1:        msiqvalid       (HV_MSIQ_VALID or HV_MSIQ_INVALID)
1741  * ERRORS:      EINVAL          Invalid devhandle or msiqid
1742  *
1743  * Get the valid state of the MSI-EQ described by the given devhandle and
1744  * msiqid.
1745  */
1746 #define HV_FAST_PCI_MSIQ_GETVALID       0xc2
1747
1748 /* pci_msiq_setvalid()
1749  * TRAP:        HV_FAST_TRAP
1750  * FUNCTION:    HV_FAST_PCI_MSIQ_SETVALID
1751  * ARG0:        devhandle
1752  * ARG1:        msiqid
1753  * ARG2:        msiqvalid       (HV_MSIQ_VALID or HV_MSIQ_INVALID)
1754  * RET0:        status
1755  * ERRORS:      EINVAL          Invalid devhandle or msiqid or msiqvalid
1756  *                              value or MSI EQ is uninitialized
1757  *
1758  * Set the valid state of the MSI-EQ described by the given devhandle and
1759  * msiqid to the given msiqvalid.
1760  */
1761 #define HV_FAST_PCI_MSIQ_SETVALID       0xc3
1762
1763 /* pci_msiq_getstate()
1764  * TRAP:        HV_FAST_TRAP
1765  * FUNCTION:    HV_FAST_PCI_MSIQ_GETSTATE
1766  * ARG0:        devhandle
1767  * ARG1:        msiqid
1768  * RET0:        status
1769  * RET1:        msiqstate       (HV_MSIQSTATE_IDLE or HV_MSIQSTATE_ERROR)
1770  * ERRORS:      EINVAL          Invalid devhandle or msiqid
1771  *
1772  * Get the state of the MSI-EQ described by the given devhandle and
1773  * msiqid.
1774  */
1775 #define HV_FAST_PCI_MSIQ_GETSTATE       0xc4
1776
1777 /* pci_msiq_getvalid()
1778  * TRAP:        HV_FAST_TRAP
1779  * FUNCTION:    HV_FAST_PCI_MSIQ_GETVALID
1780  * ARG0:        devhandle
1781  * ARG1:        msiqid
1782  * ARG2:        msiqstate       (HV_MSIQSTATE_IDLE or HV_MSIQSTATE_ERROR)
1783  * RET0:        status
1784  * ERRORS:      EINVAL          Invalid devhandle or msiqid or msiqstate
1785  *                              value or MSI EQ is uninitialized
1786  *
1787  * Set the state of the MSI-EQ described by the given devhandle and
1788  * msiqid to the given msiqvalid.
1789  */
1790 #define HV_FAST_PCI_MSIQ_SETSTATE       0xc5
1791
1792 /* pci_msiq_gethead()
1793  * TRAP:        HV_FAST_TRAP
1794  * FUNCTION:    HV_FAST_PCI_MSIQ_GETHEAD
1795  * ARG0:        devhandle
1796  * ARG1:        msiqid
1797  * RET0:        status
1798  * RET1:        msiqhead
1799  * ERRORS:      EINVAL          Invalid devhandle or msiqid
1800  *
1801  * Get the current MSI EQ queue head for the MSI-EQ described by the
1802  * given devhandle and msiqid.
1803  */
1804 #define HV_FAST_PCI_MSIQ_GETHEAD        0xc6
1805
1806 /* pci_msiq_sethead()
1807  * TRAP:        HV_FAST_TRAP
1808  * FUNCTION:    HV_FAST_PCI_MSIQ_SETHEAD
1809  * ARG0:        devhandle
1810  * ARG1:        msiqid
1811  * ARG2:        msiqhead
1812  * RET0:        status
1813  * ERRORS:      EINVAL          Invalid devhandle or msiqid or msiqhead,
1814  *                              or MSI EQ is uninitialized
1815  *
1816  * Set the current MSI EQ queue head for the MSI-EQ described by the
1817  * given devhandle and msiqid.
1818  */
1819 #define HV_FAST_PCI_MSIQ_SETHEAD        0xc7
1820
1821 /* pci_msiq_gettail()
1822  * TRAP:        HV_FAST_TRAP
1823  * FUNCTION:    HV_FAST_PCI_MSIQ_GETTAIL
1824  * ARG0:        devhandle
1825  * ARG1:        msiqid
1826  * RET0:        status
1827  * RET1:        msiqtail
1828  * ERRORS:      EINVAL          Invalid devhandle or msiqid
1829  *
1830  * Get the current MSI EQ queue tail for the MSI-EQ described by the
1831  * given devhandle and msiqid.
1832  */
1833 #define HV_FAST_PCI_MSIQ_GETTAIL        0xc8
1834
1835 /* pci_msi_getvalid()
1836  * TRAP:        HV_FAST_TRAP
1837  * FUNCTION:    HV_FAST_PCI_MSI_GETVALID
1838  * ARG0:        devhandle
1839  * ARG1:        msinum
1840  * RET0:        status
1841  * RET1:        msivalidstate
1842  * ERRORS:      EINVAL          Invalid devhandle or msinum
1843  *
1844  * Get the current valid/enabled state for the MSI defined by the
1845  * given devhandle and msinum.
1846  */
1847 #define HV_FAST_PCI_MSI_GETVALID        0xc9
1848
1849 /* pci_msi_setvalid()
1850  * TRAP:        HV_FAST_TRAP
1851  * FUNCTION:    HV_FAST_PCI_MSI_SETVALID
1852  * ARG0:        devhandle
1853  * ARG1:        msinum
1854  * ARG2:        msivalidstate
1855  * RET0:        status
1856  * ERRORS:      EINVAL          Invalid devhandle or msinum or msivalidstate
1857  *
1858  * Set the current valid/enabled state for the MSI defined by the
1859  * given devhandle and msinum.
1860  */
1861 #define HV_FAST_PCI_MSI_SETVALID        0xca
1862
1863 /* pci_msi_getmsiq()
1864  * TRAP:        HV_FAST_TRAP
1865  * FUNCTION:    HV_FAST_PCI_MSI_GETMSIQ
1866  * ARG0:        devhandle
1867  * ARG1:        msinum
1868  * RET0:        status
1869  * RET1:        msiqid
1870  * ERRORS:      EINVAL          Invalid devhandle or msinum or MSI is unbound
1871  *
1872  * Get the MSI EQ that the MSI defined by the given devhandle and
1873  * msinum is bound to.
1874  */
1875 #define HV_FAST_PCI_MSI_GETMSIQ         0xcb
1876
1877 /* pci_msi_setmsiq()
1878  * TRAP:        HV_FAST_TRAP
1879  * FUNCTION:    HV_FAST_PCI_MSI_SETMSIQ
1880  * ARG0:        devhandle
1881  * ARG1:        msinum
1882  * ARG2:        msitype
1883  * ARG3:        msiqid
1884  * RET0:        status
1885  * ERRORS:      EINVAL          Invalid devhandle or msinum or msiqid
1886  *
1887  * Set the MSI EQ that the MSI defined by the given devhandle and
1888  * msinum is bound to.
1889  */
1890 #define HV_FAST_PCI_MSI_SETMSIQ         0xcc
1891
1892 /* pci_msi_getstate()
1893  * TRAP:        HV_FAST_TRAP
1894  * FUNCTION:    HV_FAST_PCI_MSI_GETSTATE
1895  * ARG0:        devhandle
1896  * ARG1:        msinum
1897  * RET0:        status
1898  * RET1:        msistate
1899  * ERRORS:      EINVAL          Invalid devhandle or msinum
1900  *
1901  * Get the state of the MSI defined by the given devhandle and msinum.
1902  * If not initialized, return HV_MSISTATE_IDLE.
1903  */
1904 #define HV_FAST_PCI_MSI_GETSTATE        0xcd
1905
1906 /* pci_msi_setstate()
1907  * TRAP:        HV_FAST_TRAP
1908  * FUNCTION:    HV_FAST_PCI_MSI_SETSTATE
1909  * ARG0:        devhandle
1910  * ARG1:        msinum
1911  * ARG2:        msistate
1912  * RET0:        status
1913  * ERRORS:      EINVAL          Invalid devhandle or msinum or msistate
1914  *
1915  * Set the state of the MSI defined by the given devhandle and msinum.
1916  */
1917 #define HV_FAST_PCI_MSI_SETSTATE        0xce
1918
1919 /* pci_msg_getmsiq()
1920  * TRAP:        HV_FAST_TRAP
1921  * FUNCTION:    HV_FAST_PCI_MSG_GETMSIQ
1922  * ARG0:        devhandle
1923  * ARG1:        msgtype
1924  * RET0:        status
1925  * RET1:        msiqid
1926  * ERRORS:      EINVAL          Invalid devhandle or msgtype
1927  *
1928  * Get the MSI EQ of the MSG defined by the given devhandle and msgtype.
1929  */
1930 #define HV_FAST_PCI_MSG_GETMSIQ         0xd0
1931
1932 /* pci_msg_setmsiq()
1933  * TRAP:        HV_FAST_TRAP
1934  * FUNCTION:    HV_FAST_PCI_MSG_SETMSIQ
1935  * ARG0:        devhandle
1936  * ARG1:        msgtype
1937  * ARG2:        msiqid
1938  * RET0:        status
1939  * ERRORS:      EINVAL          Invalid devhandle, msgtype, or msiqid
1940  *
1941  * Set the MSI EQ of the MSG defined by the given devhandle and msgtype.
1942  */
1943 #define HV_FAST_PCI_MSG_SETMSIQ         0xd1
1944
1945 /* pci_msg_getvalid()
1946  * TRAP:        HV_FAST_TRAP
1947  * FUNCTION:    HV_FAST_PCI_MSG_GETVALID
1948  * ARG0:        devhandle
1949  * ARG1:        msgtype
1950  * RET0:        status
1951  * RET1:        msgvalidstate
1952  * ERRORS:      EINVAL          Invalid devhandle or msgtype
1953  *
1954  * Get the valid/enabled state of the MSG defined by the given
1955  * devhandle and msgtype.
1956  */
1957 #define HV_FAST_PCI_MSG_GETVALID        0xd2
1958
1959 /* pci_msg_setvalid()
1960  * TRAP:        HV_FAST_TRAP
1961  * FUNCTION:    HV_FAST_PCI_MSG_SETVALID
1962  * ARG0:        devhandle
1963  * ARG1:        msgtype
1964  * ARG2:        msgvalidstate
1965  * RET0:        status
1966  * ERRORS:      EINVAL          Invalid devhandle or msgtype or msgvalidstate
1967  *
1968  * Set the valid/enabled state of the MSG defined by the given
1969  * devhandle and msgtype.
1970  */
1971 #define HV_FAST_PCI_MSG_SETVALID        0xd3
1972
1973 /* Performance counter services.  */
1974
1975 #define HV_PERF_JBUS_PERF_CTRL_REG      0x00
1976 #define HV_PERF_JBUS_PERF_CNT_REG       0x01
1977 #define HV_PERF_DRAM_PERF_CTRL_REG_0    0x02
1978 #define HV_PERF_DRAM_PERF_CNT_REG_0     0x03
1979 #define HV_PERF_DRAM_PERF_CTRL_REG_1    0x04
1980 #define HV_PERF_DRAM_PERF_CNT_REG_1     0x05
1981 #define HV_PERF_DRAM_PERF_CTRL_REG_2    0x06
1982 #define HV_PERF_DRAM_PERF_CNT_REG_2     0x07
1983 #define HV_PERF_DRAM_PERF_CTRL_REG_3    0x08
1984 #define HV_PERF_DRAM_PERF_CNT_REG_3     0x09
1985
1986 /* get_perfreg()
1987  * TRAP:        HV_FAST_TRAP
1988  * FUNCTION:    HV_FAST_GET_PERFREG
1989  * ARG0:        performance reg number
1990  * RET0:        status
1991  * RET1:        performance reg value
1992  * ERRORS:      EINVAL          Invalid performance register number
1993  *              ENOACCESS       No access allowed to performance counters
1994  *
1995  * Read the value of the given DRAM/JBUS performance counter/control register.
1996  */
1997 #define HV_FAST_GET_PERFREG             0x100
1998
1999 /* set_perfreg()
2000  * TRAP:        HV_FAST_TRAP
2001  * FUNCTION:    HV_FAST_SET_PERFREG
2002  * ARG0:        performance reg number
2003  * ARG1:        performance reg value
2004  * RET0:        status
2005  * ERRORS:      EINVAL          Invalid performance register number
2006  *              ENOACCESS       No access allowed to performance counters
2007  *
2008  * Write the given performance reg value to the given DRAM/JBUS
2009  * performance counter/control register.
2010  */
2011 #define HV_FAST_SET_PERFREG             0x101
2012
2013 /* MMU statistics services.
2014  *
2015  * The hypervisor maintains MMU statistics and privileged code provides
2016  * a buffer where these statistics can be collected.  It is continually
2017  * updated once configured.  The layout is as follows:
2018  */
2019 #ifndef __ASSEMBLY__
2020 struct hv_mmu_statistics {
2021         unsigned long immu_tsb_hits_ctx0_8k_tte;
2022         unsigned long immu_tsb_ticks_ctx0_8k_tte;
2023         unsigned long immu_tsb_hits_ctx0_64k_tte;
2024         unsigned long immu_tsb_ticks_ctx0_64k_tte;
2025         unsigned long __reserved1[2];
2026         unsigned long immu_tsb_hits_ctx0_4mb_tte;
2027         unsigned long immu_tsb_ticks_ctx0_4mb_tte;
2028         unsigned long __reserved2[2];
2029         unsigned long immu_tsb_hits_ctx0_256mb_tte;
2030         unsigned long immu_tsb_ticks_ctx0_256mb_tte;
2031         unsigned long __reserved3[4];
2032         unsigned long immu_tsb_hits_ctxnon0_8k_tte;
2033         unsigned long immu_tsb_ticks_ctxnon0_8k_tte;
2034         unsigned long immu_tsb_hits_ctxnon0_64k_tte;
2035         unsigned long immu_tsb_ticks_ctxnon0_64k_tte;
2036         unsigned long __reserved4[2];
2037         unsigned long immu_tsb_hits_ctxnon0_4mb_tte;
2038         unsigned long immu_tsb_ticks_ctxnon0_4mb_tte;
2039         unsigned long __reserved5[2];
2040         unsigned long immu_tsb_hits_ctxnon0_256mb_tte;
2041         unsigned long immu_tsb_ticks_ctxnon0_256mb_tte;
2042         unsigned long __reserved6[4];
2043         unsigned long dmmu_tsb_hits_ctx0_8k_tte;
2044         unsigned long dmmu_tsb_ticks_ctx0_8k_tte;
2045         unsigned long dmmu_tsb_hits_ctx0_64k_tte;
2046         unsigned long dmmu_tsb_ticks_ctx0_64k_tte;
2047         unsigned long __reserved7[2];
2048         unsigned long dmmu_tsb_hits_ctx0_4mb_tte;
2049         unsigned long dmmu_tsb_ticks_ctx0_4mb_tte;
2050         unsigned long __reserved8[2];
2051         unsigned long dmmu_tsb_hits_ctx0_256mb_tte;
2052         unsigned long dmmu_tsb_ticks_ctx0_256mb_tte;
2053         unsigned long __reserved9[4];
2054         unsigned long dmmu_tsb_hits_ctxnon0_8k_tte;
2055         unsigned long dmmu_tsb_ticks_ctxnon0_8k_tte;
2056         unsigned long dmmu_tsb_hits_ctxnon0_64k_tte;
2057         unsigned long dmmu_tsb_ticks_ctxnon0_64k_tte;
2058         unsigned long __reserved10[2];
2059         unsigned long dmmu_tsb_hits_ctxnon0_4mb_tte;
2060         unsigned long dmmu_tsb_ticks_ctxnon0_4mb_tte;
2061         unsigned long __reserved11[2];
2062         unsigned long dmmu_tsb_hits_ctxnon0_256mb_tte;
2063         unsigned long dmmu_tsb_ticks_ctxnon0_256mb_tte;
2064         unsigned long __reserved12[4];
2065 };
2066 #endif
2067
2068 /* mmustat_conf()
2069  * TRAP:        HV_FAST_TRAP
2070  * FUNCTION:    HV_FAST_MMUSTAT_CONF
2071  * ARG0:        real address
2072  * RET0:        status
2073  * RET1:        real address
2074  * ERRORS:      ENORADDR        Invalid real address
2075  *              EBADALIGN       Real address not aligned on 64-byte boundary
2076  *              EBADTRAP        API not supported on this processor
2077  *
2078  * Enable MMU statistic gathering using the buffer at the given real
2079  * address on the current virtual CPU.  The new buffer real address
2080  * is given in ARG1, and the previously specified buffer real address
2081  * is returned in RET1, or is returned as zero for the first invocation.
2082  *
2083  * If the passed in real address argument is zero, this will disable
2084  * MMU statistic collection on the current virtual CPU.  If an error is
2085  * returned then no statistics are collected.
2086  *
2087  * The buffer contents should be initialized to all zeros before being
2088  * given to the hypervisor or else the statistics will be meaningless.
2089  */
2090 #define HV_FAST_MMUSTAT_CONF            0x102
2091
2092 /* mmustat_info()
2093  * TRAP:        HV_FAST_TRAP
2094  * FUNCTION:    HV_FAST_MMUSTAT_INFO
2095  * RET0:        status
2096  * RET1:        real address
2097  * ERRORS:      EBADTRAP        API not supported on this processor
2098  *
2099  * Return the current state and real address of the currently configured
2100  * MMU statistics buffer on the current virtual CPU.
2101  */
2102 #define HV_FAST_MMUSTAT_INFO            0x103
2103
2104 /* Function numbers for HV_CORE_TRAP.  */
2105 #define HV_CORE_VER                     0x00
2106 #define HV_CORE_PUTCHAR                 0x01
2107 #define HV_CORE_EXIT                    0x02
2108
2109 #endif /* !(_SPARC64_HYPERVISOR_H) */