Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / obp / tools / promif / include / v9 / sys / prom_isa.h
CommitLineData
920dae64
AT
1/*
2* ========== Copyright Header Begin ==========================================
3*
4* Hypervisor Software File: prom_isa.h
5*
6* Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
7*
8* - Do no alter or remove copyright notices
9*
10* - Redistribution and use of this software in source and binary forms, with
11* or without modification, are permitted provided that the following
12* conditions are met:
13*
14* - Redistribution of source code must retain the above copyright notice,
15* this list of conditions and the following disclaimer.
16*
17* - Redistribution in binary form must reproduce the above copyright notice,
18* this list of conditions and the following disclaimer in the
19* documentation and/or other materials provided with the distribution.
20*
21* Neither the name of Sun Microsystems, Inc. or the names of contributors
22* may be used to endorse or promote products derived from this software
23* without specific prior written permission.
24*
25* This software is provided "AS IS," without a warranty of any kind.
26* ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
27* INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
28* PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
29* MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
30* ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
31* DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN
32* OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR
33* FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
34* DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
35* ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
36* SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
37*
38* You acknowledge that this software is not designed, licensed or
39* intended for use in the design, construction, operation or maintenance of
40* any nuclear facility.
41*
42* ========== Copyright Header End ============================================
43*/
44/*
45 * Copyright (c) 2000, 2003 Sun Microsystems, Inc. All rights reserved.
46 * Use is subject to license terms.
47 */
48
49#ifndef _SYS_PROM_ISA_H
50#define _SYS_PROM_ISA_H
51
52#pragma ident "@(#)prom_isa.h 1.1 00/08/07 SMI"
53
54#include <sys/obpdefs.h>
55
56/*
57 * This file contains external ISA-specific promif interface definitions.
58 *
59 * This version of the file contains definitions for both a 32-bit client
60 * program or a 64-bit client program calling the 64-bit cell-sized SPARC
61 * v9 firmware client interface handler.
62 *
63 * On SPARC v9 machines, a 32-bit client program must provide
64 * a function to manage the conversion of the 32-bit stack to
65 * a 64-bit stack, before calling the firmware's client interface
66 * handler.
67 */
68
69#ifdef __cplusplus
70extern "C" {
71#endif
72
73typedef unsigned long long cell_t;
74
75#define p1275_ptr2cell(p) ((cell_t)((uintptr_t)((void *)(p))))
76#define p1275_int2cell(i) ((cell_t)((int)(i)))
77#define p1275_uint2cell(u) ((cell_t)((unsigned int)(u)))
78#define p1275_size2cell(u) ((cell_t)((size_t)(u)))
79#define p1275_phandle2cell(ph) ((cell_t)((unsigned int)((phandle_t)(ph))))
80#define p1275_dnode2cell(d) ((cell_t)((unsigned int)((dnode_t)(d))))
81#define p1275_ihandle2cell(ih) ((cell_t)((unsigned int)((ihandle_t)(ih))))
82#define p1275_ull2cell_high(ll) (0LL)
83#define p1275_ull2cell_low(ll) ((cell_t)(ll))
84#define p1275_uintptr2cell(i) ((cell_t)((uintptr_t)(i)))
85
86#define p1275_cell2ptr(p) ((void *)((cell_t)(p)))
87#define p1275_cell2int(i) ((int)((cell_t)(i)))
88#define p1275_cell2uint(u) ((unsigned int)((cell_t)(u)))
89#define p1275_cell2size(u) ((size_t)((cell_t)(u)))
90#define p1275_cell2phandle(ph) ((phandle_t)((cell_t)(ph)))
91#define p1275_cell2dnode(d) ((dnode_t)((cell_t)(d)))
92#define p1275_cell2ihandle(ih) ((ihandle_t)((cell_t)(ih)))
93#define p1275_cells2ull(h, l) ((unsigned long long)(cell_t)(l))
94#define p1275_cell2uintptr(i) ((uintptr_t)((cell_t)(i)))
95
96/*
97 * Define default cif handlers.
98 */
99#define p1275_cif_init p1275_sparc_cif_init
100#define p1275_cif_handler p1275_sparc_cif_handler
101
102extern void *p1275_sparc_cif_init(void *);
103extern int p1275_cif_handler(void *);
104
105/*
106 * ISA dependent utility functions/macros
107 */
108#define prom_decode_int(v) (v)
109
110#ifdef __cplusplus
111}
112#endif
113
114#endif /* _SYS_PROM_ISA_H */