aboutsummaryrefslogtreecommitdiffstats
path: root/include/boardobj/boardobj.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/boardobj/boardobj.h')
-rw-r--r--include/boardobj/boardobj.h104
1 files changed, 104 insertions, 0 deletions
diff --git a/include/boardobj/boardobj.h b/include/boardobj/boardobj.h
new file mode 100644
index 0000000..b1be9bd
--- /dev/null
+++ b/include/boardobj/boardobj.h
@@ -0,0 +1,104 @@
1/*
2* Copyright (c) 2016-2018, NVIDIA CORPORATION. All rights reserved.
3*
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20 * DEALINGS IN THE SOFTWARE.
21*/
22
23#ifndef NVGPU_BOARDOBJ_H
24#define NVGPU_BOARDOBJ_H
25
26#include <nvgpu/list.h>
27#include <nvgpu/pmuif/nvgpu_gpmu_cmdif.h>
28
29#include "ctrl/ctrlboardobj.h"
30
31struct boardobj;
32struct nvgpu_list_node;
33
34/*
35* check whether the specified BOARDOBJ object implements the queried
36* type/class enumeration.
37*/
38typedef bool boardobj_implements(struct gk20a *g, struct boardobj *pboardobj,
39 u8 type);
40
41/*
42* Fills out the appropriate the nv_pmu_xxxx_device_desc_<xyz> driver->PMU
43* description structure, describing this BOARDOBJ board device to the PMU.
44*
45*/
46typedef int boardobj_pmudatainit(struct gk20a *g, struct boardobj *pboardobj,
47 struct nv_pmu_boardobj *pmudata);
48
49/*
50* Constructor for the base Board Object. Called by each device-specific
51* implementation of the BOARDOBJ interface to initialize the board object.
52*/
53typedef int boardobj_construct(struct gk20a *g, struct boardobj **pboardobj,
54 u16 size, void *args);
55
56/*
57* Destructor for the base board object. Called by each device-Specific
58* implementation of the BOARDOBJ interface to destroy the board object.
59* This has to be explicitly set by each device that extends from the
60* board object.
61*/
62typedef int boardobj_destruct(struct boardobj *pboardobj);
63
64/*
65* Base Class for all physical or logical device on the PCB.
66* Contains fields common to all devices on the board. Specific types of
67* devices may extend this object adding any details specific to that
68* device or device-type.
69*/
70
71struct boardobj {
72 struct gk20a *g;
73
74 u8 type; /*type of the device*/
75 u8 idx; /*index of boardobj within in its group*/
76 /* true if allocated in constructor. destructor should free */
77 u8 allocated;
78 u32 type_mask; /*mask of types this boardobjimplements*/
79 boardobj_implements *implements;
80 boardobj_destruct *destruct;
81 /*
82 * Access interface apis which will be overridden by the devices
83 * that inherit from BOARDOBJ
84 */
85 boardobj_pmudatainit *pmudatainit;
86 struct nvgpu_list_node node;
87};
88
89boardobj_construct boardobj_construct_super;
90boardobj_destruct boardobj_destruct_super;
91boardobj_implements boardobj_implements_super;
92boardobj_pmudatainit boardobj_pmudatainit_super;
93
94#define BOARDOBJ_GET_TYPE(pobj) (((struct boardobj *)(pobj))->type)
95#define BOARDOBJ_GET_IDX(pobj) (((struct boardobj *)(pobj))->idx)
96
97static inline struct boardobj *
98boardobj_from_node(struct nvgpu_list_node *node)
99{
100 return (struct boardobj *)
101 ((uintptr_t)node - offsetof(struct boardobj, node));
102};
103
104#endif /* NVGPU_BOARDOBJ_H */