Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / hypervisor / src / common / include / md.h
CommitLineData
920dae64
AT
1/*
2* ========== Copyright Header Begin ==========================================
3*
4* Hypervisor Software File: md.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 2006 Sun Microsystems, Inc. All rights reserved.
46 * Use is subject to license terms.
47 */
48
49#ifndef _MD_H
50#define _MD_H
51
52#pragma ident "@(#)md.h 1.5 06/12/05 SMI"
53
54#ifdef __cplusplus
55extern "C" {
56#endif
57
58#include <md/md_impl.h>
59
60#ifndef _ASM
61
62#define MDNAME(name) (config.hdnametable.hdname_##name)
63
64#define MDARC(_name) ((_name)|(((uint64_t)MDET_PROP_ARC)<<56))
65#define MDVAL(_name) ((_name)|(((uint64_t)MDET_PROP_VAL)<<56))
66#define MDSTR(_name) ((_name)|(((uint64_t)MDET_PROP_STR)<<56))
67#define MDDAT(_name) ((_name)|(((uint64_t)MDET_PROP_DAT)<<56))
68#define MDNODE(_name) ((_name)|(((uint64_t)MDET_NODE)<<56))
69#define MD_UNKNOWN_NAME (0LL)
70
71#define TR_MAJOR(x) (((x)>>16) & 0xffff)
72#define TR_MINOR(x) ((x) & 0xffff)
73
74uint64_t md_find_name_tag(bin_md_t *mdp, char *namep);
75
76md_element_t *md_next_node_elem(bin_md_t *mdp, md_element_t *,
77 uint64_t token);
78
79md_element_t *md_find_node(bin_md_t *mdp, md_element_t *startp,
80 uint64_t token);
81
82md_element_t *md_find_node_by_arc(bin_md_t *mdp, md_element_t *elemp,
83 uint64_t arc_token, uint64_t node_token,
84 md_element_t **nodep);
85
86int md_node_get_val(bin_md_t *mdp, md_element_t *nodep,
87 uint64_t token, uint64_t *valp);
88
89#ifdef DEBUG /* { */
90void md_dump_node(bin_md_t *mdp, md_element_t *mdep);
91#endif /* } */
92
93void reloc_hvmd_names();
94hvctl_status_t preparse_hvmd(bin_md_t *mdp);
95void accept_hvmd();
96
97#endif /* !_ASM */
98
99
100
101#ifdef __cplusplus
102}
103#endif
104
105#endif /* _MD_H */