summaryrefslogtreecommitdiffstats
path: root/drivers/gpu/nvgpu/include/nvgpu/pmuif/gpmuifboardobj.h
blob: 8da314692b41003e32b45c6710a556751893c789 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/*
* Copyright (c) 2016-2017, NVIDIA CORPORATION.  All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms and conditions of the GNU General Public License,
* version 2, as published by the Free Software Foundation.
*
* This program is distributed in the hope it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
* more details.
*/
#ifndef _GPMUIFBOARDOBJ_H_
#define _GPMUIFBOARDOBJ_H_

#include <nvgpu/flcnif_cmn.h>
#include "ctrl/ctrlboardobj.h"

/*
 * Base structure describing a BOARDOBJ for communication between Kernel and
 * PMU.
 */
struct nv_pmu_boardobj {
	u8 type;
};

/*
 * Base structure describing a BOARDOBJ for Query interface between Kernel and
 * PMU.
 */
struct nv_pmu_boardobj_query {
	u8 type;
};

/*
 * Virtual base structure describing a BOARDOBJGRP interface between Kernel and
 * PMU.
 */
struct nv_pmu_boardobjgrp_super {
	u8 type;
	u8 class_id;
	u8 obj_slots;
	u8 rsvd;
};

struct nv_pmu_boardobjgrp {
	struct nv_pmu_boardobjgrp_super super;
	u32 obj_mask;
};

struct nv_pmu_boardobjgrp_e32 {
	struct nv_pmu_boardobjgrp_super super;
	struct ctrl_boardobjgrp_mask_e32 obj_mask;
};

struct nv_pmu_boardobjgrp_e255 {
	struct nv_pmu_boardobjgrp_super super;
	struct ctrl_boardobjgrp_mask_e255 obj_mask;
};

struct nv_pmu_boardobj_cmd_grp_payload {
	struct pmu_allocation_v3 dmem_buf;
	struct flcn_mem_desc_v0 fb;
	u8 hdr_size;
	u8 entry_size;
};

struct nv_pmu_boardobj_cmd_grp {
	u8 cmd_type;
	u8 pad[2];
	u8 class_id;
	struct nv_pmu_boardobj_cmd_grp_payload grp;
};

#define NV_PMU_BOARDOBJ_GRP_ALLOC_OFFSET                                       \
	(NV_OFFSETOF(NV_PMU_BOARDOBJ_CMD_GRP, grp))

struct nv_pmu_boardobj_cmd {
	union {
		u8 cmd_type;
		struct nv_pmu_boardobj_cmd_grp grp;
		struct nv_pmu_boardobj_cmd_grp grp_set;
		struct nv_pmu_boardobj_cmd_grp grp_get_status;
	};
};

struct nv_pmu_boardobj_msg_grp {
	u8 msg_type;
	bool b_success;
	flcn_status flcn_status;
	u8 class_id;
};

struct nv_pmu_boardobj_msg {
	union {
		u8 msg_type;
		struct nv_pmu_boardobj_msg_grp grp;
		struct nv_pmu_boardobj_msg_grp grp_set;
		struct nv_pmu_boardobj_msg_grp grp_get_status;
	};
};

/*
* Macro generating structures describing classes which implement
* NV_PMU_BOARDOBJGRP via the NV_PMU_BOARDBOBJ_CMD_GRP SET interface.
*
* @para    _eng    Name of implementing engine in which this structure is
* found.
* @param   _class  Class ID of Objects within Board Object Group.
* @param   _slots  Max number of elements this group can contain.
*/
#define NV_PMU_BOARDOBJ_GRP_SET_MAKE(_eng, _class, _slots)                     \
	NV_PMU_MAKE_ALIGNED_STRUCT(                                            \
	nv_pmu_##_eng##_##_class##_boardobjgrp_set_header, one_structure);     \
	NV_PMU_MAKE_ALIGNED_UNION(                                             \
	nv_pmu_##_eng##_##_class##_boardobj_set_union, one_union);             \
	struct nv_pmu_##_eng##_##_class##_boardobj_grp_set {                   \
	union nv_pmu_##_eng##_##_class##_boardobjgrp_set_header_aligned  hdr;        \
	union nv_pmu_##_eng##_##_class##_boardobj_set_union_aligned objects[(_slots)];\
	}

/*
* Macro generating structures describing classes which implement
* NV_PMU_BOARDOBJGRP_E32 via the NV_PMU_BOARDBOBJ_CMD_GRP SET interface.
*
* @para    _eng    Name of implementing engine in which this structure is
* found.
* @param   _class  Class ID of Objects within Board Object Group.
*/
#define NV_PMU_BOARDOBJ_GRP_SET_MAKE_E32(_eng, _class)                         \
	NV_PMU_BOARDOBJ_GRP_SET_MAKE(_eng, _class,                             \
	CTRL_BOARDOBJGRP_E32_MAX_OBJECTS)

/*
* Macro generating structures describing classes which implement
* NV_PMU_BOARDOBJGRP_E255 via the NV_PMU_BOARDBOBJ_CMD_GRP SET interface.
*
* @para    _eng    Name of implementing engine in which this structure is
* found.
* @param   _class  Class ID of Objects within Board Object Group.
*/
#define NV_PMU_BOARDOBJ_GRP_SET_MAKE_E255(_eng, _class)                        \
	NV_PMU_BOARDOBJ_GRP_SET_MAKE(_eng, _class,                             \
	CTRL_BOARDOBJGRP_E255_MAX_OBJECTS)

/*
* Macro generating structures for querying dynamic state for classes which
* implement NV_PMU_BOARDOBJGRP via the NV_PMU_BOARDOBJ_CMD_GRP GET_STATUS
* interface.
*
* @para    _eng    Name of implementing engine in which this structure is
* found.
* @param   _class  Class ID of Objects within Board Object Group.
* @param   _slots  Max number of elements this group can contain.
*/
#define NV_PMU_BOARDOBJ_GRP_GET_STATUS_MAKE(_eng, _class, _slots)              \
	NV_PMU_MAKE_ALIGNED_STRUCT(                                            \
	nv_pmu_##_eng##_##_class##_boardobjgrp_get_status_header, struct);     \
	NV_PMU_MAKE_ALIGNED_UNION(                                             \
	nv_pmu_##_eng##_##_class##_boardobj_get_status_union, union);          \
	struct  nv_pmu_##_eng##_##_class##_boardobj_grp_get_status {           \
	union nv_pmu_##_eng##_##_class##_boardobjgrp_get_status_header_aligned \
	hdr;                                                                   \
	union nv_pmu_##_eng##_##_class##_boardobj_get_status_union_aligned     \
	objects[(_slots)];                                                     \
	}

/*
* Macro generating structures for querying dynamic state for classes which
* implement NV_PMU_BOARDOBJGRP_E32  via the NV_PMU_BOARDOBJ_CMD_GRP GET_STATUS
* interface.
*
* @para    _eng    Name of implementing engine in which this structure is
* found.
* @param   _class  Class ID of Objects within Board Object Group.
*/
#define NV_PMU_BOARDOBJ_GRP_GET_STATUS_MAKE_E32(_eng, _class)                  \
	NV_PMU_BOARDOBJ_GRP_GET_STATUS_MAKE(_eng, _class,                      \
	CTRL_BOARDOBJGRP_E32_MAX_OBJECTS)

/*
* Macro generating structures for querying dynamic state for classes which
* implement NV_PMU_BOARDOBJGRP_E255 via the NV_PMU_BOARDOBJ_CMD_GRP GET_STATUS
* interface.
*
* @para    _eng    Name of implementing engine in which this structure is
* found.
* @param   _class  Class ID of Objects within Board Object Group.
*/
#define NV_PMU_BOARDOBJ_GRP_GET_STATUS_MAKE_E255(_eng, _class)                 \
	NV_PMU_BOARDOBJ_GRP_GET_STATUS_MAKE(_eng, _class,                      \
	CTRL_BOARDOBJGRP_E255_MAX_OBJECTS)


#endif /*  _GPMUIFBOARDOBJ_H_ */