Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / hypervisor / src / common / include / resource.h
CommitLineData
920dae64
AT
1/*
2* ========== Copyright Header Begin ==========================================
3*
4* Hypervisor Software File: resource.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 2007 Sun Microsystems, Inc. All rights reserved.
46 * Use is subject to license terms.
47 */
48
49#ifndef _RESOURCE_H
50#define _RESOURCE_H
51
52#pragma ident "@(#)resource.h 1.3 07/02/12 SMI"
53
54#ifdef __cplusplus
55extern "C" {
56#endif
57
58#ifndef _ASM
59
60/*
61 * Simple struct to bury in each resource structure
62 * so we can re-use common functions in the
63 * reconfigure framework.
64 */
65
66typedef struct {
67 uint8_t flags;
68} resource_t;
69
70
71/*
72 * The bits below look like uniq values, but are in fact
73 * bitwise flags. The parse-commit phase for an HV MD update
74 * Will set bits according to how a resource is to be
75 * (re)configured.
76 *
77 * All configured resources start being marked in the unconfig state
78 * so by default they will be unconfigured.
79 * unconfigured resources are marked in the noop state.
80 * The new HV MD state is parsed and as each MD node is found and
81 * read in, unconfigured resources get marked to the config state
82 * configured resources are either marked as noop, rebind or
83 * modified based on what (if anything) has changed.
84 * At the end of the parse process we now know what action if
85 * any needs to happen to each resource, so in the commit
86 * phase we call the appropriate resource specific function
87 * to take the action we need to take for the reconfig.
88 */
89
90
91#define RESF_Noop 0x0
92#define RESF_Unconfig 0x1
93#define RESF_Config 0x2
94#define RESF_Rebind 0x3
95#define RESF_Modify 0x4
96
97/*
98 * Simple macro to help with resource configuration prototypes
99 */
100
101#define RES_PROTO(_name) \
102 void res_##_name##_prep(); \
103 hvctl_status_t res_##_name##_parse(bin_md_t *, \
104 hvctl_res_error_t *fail_codep, \
105 md_element_t **failnodepp, int *fail_res_id); \
106 hvctl_status_t res_##_name##_postparse(hvctl_res_error_t *, \
107 int *fail_res_id); \
108 void res_##_name##_commit(int flags);
109
110
111#endif
112
113#ifdef __cplusplus
114}
115#endif
116
117#endif /* _RESOURCE_H */