* ========== Copyright Header Begin ==========================================
* Hypervisor Software File: hypervisor.h
* Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
* - Do no alter or remove copyright notices
* - Redistribution and use of this software in source and binary forms, with
* or without modification, are permitted provided that the following
* - Redistribution of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - Redistribution in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* Neither the name of Sun Microsystems, Inc. or the names of contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
* This software is provided "AS IS," without a warranty of any kind.
* ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
* INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
* PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
* MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
* ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
* DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN
* OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR
* FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
* DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
* ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
* SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
* You acknowledge that this software is not designed, licensed or
* intended for use in the design, construction, operation or maintenance of
* ========== Copyright Header End ============================================
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
#pragma ident "@(#)hypervisor.h 1.49 07/05/03 SMI"
#include <platform/hypervisor.h>
* Common Hypervisor definitions
* Hypervisor software trap numbers
#define MMU_MAP_ADDR 0x83
#define MMU_UNMAP_ADDR 0x84
#define TTRACE_ADDENTRY 0x85
* Hypervisor function numbers for CORE_TRAP
#define API_SET_VERSION 0x00
#define API_GET_VERSION 0x03
* Hypervisor function numbers for FAST_TRAP
* CPU/Memory APIs (Core API group)
#define MACH_SET_WATCHDOG 0x05
#define CPU_GET_STATE 0x17
#define CPU_SET_RTBA 0x18
#define CPU_GET_RTBA 0x19
#define MMU_TSB_CTX0 0x20
#define MMU_TSB_CTXNON0 0x21
#define MMU_DEMAP_PAGE 0x22
#define MMU_DEMAP_CTX 0x23
#define MMU_DEMAP_ALL 0x24
#define MMU_MAP_PERM_ADDR 0x25
#define MMU_FAULT_AREA_CONF 0x26
#define MMU_UNMAP_PERM_ADDR 0x28
#define MMU_TSB_CTX0_INFO 0x29
#define MMU_TSB_CTXNON0_INFO 0x2a
#define MMU_FAULT_AREA_INFO 0x2b
#define CPU_MONDO_SEND 0x42
#define CONS_GETCHAR 0x60
#define CONS_PUTCHAR 0x61
#define SOFT_STATE_SET 0x70
#define SOFT_STATE_GET 0x71
#define TTRACE_BUF_CONF 0x90
#define TTRACE_BUF_INFO 0x91
#define TTRACE_ENABLE 0x92
#define TTRACE_FREEZE 0x93
#define DUMP_BUF_UPDATE 0x94
#define DUMP_BUF_INFO 0x95
#define INTR_DEVINO2SYSINO 0xa0
#define INTR_GETENABLED 0xa1
#define INTR_SETENABLED 0xa2
#define INTR_GETSTATE 0xa3
#define INTR_SETSTATE 0xa4
#define INTR_GETTARGET 0xa5
#define INTR_SETTARGET 0xa6
#define VINTR_GETCOOKIE 0xa7
#define VINTR_SETCOOKIE 0xa8
#define VINTR_GETVALID 0xa9
#define VINTR_SETVALID 0xaa
#define VINTR_GETSTATE 0xab
#define VINTR_SETSTATE 0xac
#define VINTR_GETTARGET 0xad
#define VINTR_SETTARGET 0xae
* vPCI APIs (PCIe API group)
#define VPCI_IOMMU_MAP 0xb0
#define VPCI_IOMMU_UNMAP 0xb1
#define VPCI_IOMMU_GETMAP 0xb2
#define VPCI_IOMMU_GETBYPASS 0xb3
#define VPCI_CONFIG_GET 0xb4
#define VPCI_CONFIG_PUT 0xb5
#define VPCI_IO_PEEK 0xb6
#define VPCI_IO_POKE 0xb7
#define VPCI_DMA_SYNC 0xb8
#define MSIQ_GETVALID 0xc2
#define MSIQ_SETVALID 0xc3
#define MSIQ_GETSTATE 0xc4
#define MSIQ_SETSTATE 0xc5
#define MSIQ_GETHEAD 0xc6
#define MSIQ_SETHEAD 0xc7
#define MSIQ_GETTAIL 0xc8
#define MSI_GETVALID 0xc9
#define MSI_SETVALID 0xca
#define MSI_GETSTATE 0xcd
#define MSI_SETSTATE 0xce
#define MSI_MSG_GETMSIQ 0xd0
#define MSI_MSG_SETMSIQ 0xd1
#define MSI_MSG_GETVALID 0xd2
#define MSI_MSG_SETVALID 0xd3
#define LDC_TX_QCONF 0xe0
#define LDC_TX_QINFO 0xe1
#define LDC_TX_GET_STATE 0xe2
#define LDC_TX_SET_QTAIL 0xe3
#define LDC_RX_QCONF 0xe4
#define LDC_RX_QINFO 0xe5
#define LDC_RX_GET_STATE 0xe6
#define LDC_RX_SET_QHEAD 0xe7
#define LDC_SET_MAP_TABLE 0xea
#define LDC_GET_MAP_TABLE 0xeb
* Greatlakes platform service channels (SVC API group)
#define SVC_GETSTATUS 0x82
#define SVC_SETSTATUS 0x83
#define SVC_CLRSTATUS 0x84
/* ----------------------------------- */
* Simulation-only APIs (Core API group)
#ifdef DEBUG /* Not yet FWARCd */
#define MMU_PERM_ADDR_INFO 0xfd
* Diagnostic hcalls (Diag and Test API group)
#define DIAG_RA2PA 0x200 /* diagnostic partitions only */
#define DIAG_HEXEC 0x201 /* diagnostic partitions only */
/* ----------------------------------- */
* Hypervisor manifest constants
* hcalls: API_SET_VERSION/API_GET_VERSION
#define API_GROUP_SUN4V 0x000
#define API_GROUP_CORE 0x001
#define API_GROUP_INTR 0x002
#define API_GROUP_SOFTSTATE 0x003
#define API_GROUP_PCI 0x100
#define API_GROUP_LDC 0x101
#define API_GROUP_SVC 0x102
#define API_GROUP_NCS 0x103
#define API_GROUP_RNG 0x104
#define API_GROUP_NIAGARA 0x200
#define API_GROUP_FIRE 0x201
#define API_GROUP_NIAGARA2 0x202
#define API_GROUP_NIAGARA2PIU 0x203
#define API_GROUP_NIAGARA2NIU 0x204
#define API_GROUP_DIAG 0x300
#define SUN4V_VERSION_INITIAL 1
#define CPU_STATE_INVALID 0x0
#define CPU_STATE_STOPPED 0x1 /* cpu not started */
#define CPU_STATE_RUNNING 0x2 /* cpu running guest code */
#define CPU_STATE_ERROR 0x3 /* cpu is in the error state */
#define CPU_STATE_SUSPENDED 0x4 /* cpu in suspend loop */
#define CPU_STATE_UNCONFIGURED 0x5 /* cpu unconfigured from guest */
#define CPU_STATE_STOPPING 0x6 /* cpu transitioning to stopped state */
#define CPU_STATE_STARTING 0x7 /* cpu transitioning to running state */
#define CPU_STATE_LAST_PUBLIC CPU_STATE_ERROR /* last state defined by API */
/* MMU map flags (MMU_MAP_ADDR/MMU_MAP_PERM_ADDR/etc) */
#define NPERMMAPPINGS 8 /* MMU_MAP_PERM_ADDR */
#define MMU_FAULT_AREA_SIZE 0x80 /* MMU_FAULT_AREA */
#define MMU_FAULT_AREA_ALIGNMENT 64
* TSB description area (MMU_TSB_*)
#define TSBD_SHIFT 5 /* log2(TSBD_BYTES) */
#define TSBD_IDXPGSZ_OFF 0 /* 2 bytes */
#define TSBD_ASSOC_OFF 2 /* 2 bytes */
#define TSBD_SIZE_OFF 4 /* 4 bytes */
#define TSBD_CTX_INDEX 8 /* 4 bytes */
#define TSBD_PGSZS_OFF 12 /* 4 bytes */
#define TSBD_BASE_OFF 16 /* 8 bytes */
#define TSBD_RSVD_OFF 24 /* 8 bytes */
#define TSBD_CTX_IDX_SHARE -1
* Permanent mapping table
#define PERMMAPINFO_BYTES 32 /* size of each entry in the list */
#define PERMMAPINFO_VA 0 /* permanent mapping virtual address */
#define PERMMAPINFO_CTX 8 /* permanent mapping context */
#define PERMMAPINFO_TTE 16 /* permanent mapping's TTE */
#define PERMMAPINFO_FLAGS 24 /* permanent mapping flags for this cpu */
#define CPULIST_ENTRYDONE -1 /* item in list was completed */
#define CPULIST_ENTRYSIZE 2 /* each item is 16 bits */
#define CPULIST_ENTRYSIZE_SHIFT 1 /* cpulist index to offset */
#define CPULIST_ALIGNMENT CPULIST_ENTRYSIZE
#define MEMSYNC_ALIGNMENT 0x2000
#define MACH_DESC_ALIGNMENT 0x10 /* 16-byte alignment */
* Hypervisor call status codes
#define EOK 0 /* No error */
#define ENOCPU 1 /* Invalid CPU id */
#define ENORADDR 2 /* Invalid real address */
#define ENOINTR 3 /* Invalid interrupt id */
#define EBADPGSZ 4 /* Invalid page size encoding */
#define EBADTSB 5 /* Invalid TSB description */
#define EINVAL 6 /* Invalid argument */
#define EBADTRAP 7 /* Invalid function number */
#define EBADALIGN 8 /* Invalid address alignment */
#define EWOULDBLOCK 9 /* Call would block */
#define ENOACCESS 10 /* No access to resource */
#define EIO 11 /* I/O error */
#define ECPUERROR 12 /* CPU is in error state */
#define ENOTSUPPORTED 13 /* Function or request is not supported */
#define ENOMAP 14 /* No mapping found */
#define ETOOMANY 15 /* Hard resource limit exceeded */
#define ECHANNEL 16 /* Illegal LDC channel */
* Hypervisor call return values
/* CONS_GETCHAR and CONS_PUTCHAR special character values (64-bit) */
#define CONS_HUP -2 /* CONS_GETCHAR only */
* Traptrace header data structure offsets
* TTRACE_HEADER_LAST_OFF is analogous to sun4u's TRAPTR_LAST_OFFSET
* TTRACE_HEADER_OFFSET is analogous to sun4u's TRAPTR_OFFSET
#define TTRACE_HEADER_LAST_OFF (0 * 8) /* 64-bits, last_offset (#bytes) */
#define TTRACE_HEADER_OFFSET (1 * 8) /* 64-bits, next offset (#bytes) */
* Traptrace record data structure offsets
#define TTRACE_ENTRY_TYPE ((0 * 8) + 0) /* 8-bits */
#define TTRACE_ENTRY_HPSTATE ((0 * 8) + 1) /* 8-bits */
#define TTRACE_ENTRY_TL ((0 * 8) + 2) /* 8-bits */
#define TTRACE_ENTRY_GL ((0 * 8) + 3) /* 8-bits */
#define TTRACE_ENTRY_TT ((0 * 8) + 4) /* 16-bits */
#define TTRACE_ENTRY_TAG ((0 * 8) + 6) /* 16-bits */
#define TTRACE_ENTRY_TSTATE (1 * 8) /* 64-bits */
#define TTRACE_ENTRY_TICK (2 * 8) /* 64-bits */
#define TTRACE_ENTRY_TPC (3 * 8) /* 64-bits */
#define TTRACE_ENTRY_F1 (4 * 8) /* 64-bits of entry-specific data */
#define TTRACE_ENTRY_F2 (5 * 8) /* 64-bits of entry-specific data */
#define TTRACE_ENTRY_F3 (6 * 8) /* 64-bits of entry-specific data */
#define TTRACE_ENTRY_F4 (7 * 8) /* 64-bits of entry-specific data */
#define TTRACE_RECORD_SIZE (8 * 8) /* sizeof record data struct */
#define TTRACE_RECORD_SZ_SHIFT 6 /* log2(TTRACE_RECORD_SIZE) */
#define TTRACE_MINIMUM_ENTRIES 2 /* Control struct plus one record. */
#define TTRACE_ALIGNMENT (TTRACE_RECORD_SIZE)
* Definition of TTRACE_ENTRY_TYPE
* All values not specified are reserved.
#define TTRACE_TYPE_UNDEF 0 /* entry data undefined */
#define TTRACE_TYPE_HV 1 /* entry recorded by HV */
#define TTRACE_TYPE_GUEST 255 /* guest entry, via TTRACE_ADDENTRY */
* TTRACE_ENTRY_TAG values defined for hypervisor trace entries.
* The number space of this field is specific to the record's type.
* Tag values used by the hypervisor are distinct from those
* defined and used by guest software.
#define TTRACE_TAG_HVCONF 0xffff /* continuation entry recorded by HV */
#define INSTRUCTION_SIZE 4
#define INSTRUCTION_ALIGNMENT INSTRUCTION_SIZE
#define DUMPBUF_ALIGNMENT 64
#define MONDO_DATA_SIZE 64
#define MONDO_DATA_ALIGNMENT MONDO_DATA_SIZE
#define MIN_QUEUE_ENTRIES 2
* LDC flags and other arguments
#define LDC_QENTRY_SIZE_SHIFT 6
#define LDC_QENTRY_SIZE (1<<LDC_QENTRY_SIZE_SHIFT)
#define LDC_CHANNEL_DOWN 0
#define LDC_CHANNEL_RESET 2
/* Map table constants */
#define LDC_MTE_SIZE (1<<LDC_MTE_SHIFT)
/* Map permissions bits */
#define LDC_MAP_IOR_BIT 3
#define LDC_MAP_IOW_BIT 4
#define LDC_MAP_COPY_IN_BIT 5
#define LDC_MAP_COPY_OUT_BIT 6
#define LDC_MAP_R (1<<LDC_MAP_R_BIT)
#define LDC_MAP_W (1<<LDC_MAP_W_BIT)
#define LDC_MAP_X (1<<LDC_MAP_X_BIT)
#define LDC_MAP_IOR (1<<LDC_MAP_IOR_BIT)
#define LDC_MAP_IOW (1<<LDC_MAP_IOW_BIT)
#define LDC_MAP_COPY_IN (1<<LDC_MAP_COPY_IN_BIT)
#define LDC_MAP_COPY_OUT (1<<LDC_MAP_COPY_OUT_BIT)
#define LDC_MAPIN_MASK (LDC_MAP_R|LDC_MAP_W|LDC_MAP_X|LDC_MAP_IOR|LDC_MAP_IOW)
* NOTE: Implementation - copy flags are tested against permissions
* using: (perms & 1<<(flags+LDC_MAP_COPY_IN_BIT))
* So take care that COPY_* flags are consistent
#define LDC_COPY_IN 0x0 /* Copy data into guest from others exprtd pg */
#define LDC_COPY_OUT 0x1 /* Copy data out of guest to others exprtd pg */
#define SIS_TRANSITION 0x2
#define SOFT_STATE_ALIGNMENT 0x20 /* 32 byte alignment */
#define SOFT_STATE_SIZE 0x20 /* 32 bytes */
#endif /* _HYPERVISOR_H */
projects / OpenSPARC-T2-SAM / blob