summaryrefslogtreecommitdiff
path: root/arch/arm/mach-tegra/nvrm/core/common/chiplib_interface.h
blob: 9b27133fd7d254d7f986e328adacafaf78f0b0d3 (plain)
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
/*
 * Copyright (c) 2006-2009 NVIDIA Corporation.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * Neither the name of the NVIDIA Corporation nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef INCLUDED_CHIPLIB_INTERFACE_H
#define INCLUDED_CHIPLIB_INTERFACE_H

#include "nvcommon.h"

// IIfaceObject and bootstrapping logic
typedef enum
{
    IID_QUERY_IFACE         = 0,
    IID_CHIP_IFACE          = 1,
    IID_INTERRUPT_IFACE     = 8,
    IID_BUSMEM_IFACE        = 16,
    IID_LAST_IFACE          = 0xFFFF
} IID_TYPE;

struct IIfaceObjectRec;

typedef struct IIfaceObjectVtableRec
{
    void *Unused1;
    void *Unused2;

    // IIfaceObject interface
    void (*AddRef)(struct IIfaceObjectRec *pThis);
    void (*Release)(struct IIfaceObjectRec *pThis);
    struct IIfaceObjectRec *(*QueryIface)(struct IIfaceObjectRec *pThis,
        IID_TYPE id);
} IIfaceObjectVtable;

typedef struct IIfaceObjectRec
{
    IIfaceObjectVtable *pVtable;
} IIfaceObject;

typedef IIfaceObject *(*QueryIfaceFn)(IID_TYPE id);
#define QUERY_PROC_NAME "QueryIface"

// IChip
typedef enum
{
    ELEVEL_UNKNOWN    = 0,
    ELEVEL_HW         = 1,
    ELEVEL_RTL        = 2,
    ELEVEL_CMODEL     = 3
} ELEVEL;

struct IChipRec;

typedef struct IChipVtableRec
{
    void *Unused1;
    void *Unused2;

    // IIfaceObject interface
    void (*AddRef)(struct IChipRec *pThis);
    void (*Release)(struct IChipRec *pThis);
    IIfaceObject *(*QueryIface)(struct IChipRec *pThis, IID_TYPE id);

    void *Unused3;

    // IChip interface
    int (*Startup)(struct IChipRec *pThis, IIfaceObject* system, char** argv,
        int argc);
    void (*Shutdown)(struct IChipRec *pThis);
    int (*AllocSysMem)(struct IChipRec *pThis, int numBytes, NvU32* physAddr);
    void (*FreeSysMem)(struct IChipRec *pThis, NvU32 physAddr);
    void (*ClockSimulator)(struct IChipRec *pThis, NvS32 numClocks);
    void (*Delay)(struct IChipRec *pThis, NvU32 numMicroSeconds);
    int (*EscapeWrite)(struct IChipRec *pThis, char* path, NvU32 index,
        NvU32 size, NvU32 value);
    int (*EscapeRead)(struct IChipRec *pThis, char* path, NvU32 index,
        NvU32 size, NvU32* value);
    int (*FindPCIDevice)(struct IChipRec *pThis, NvU16 vendorId,
        NvU16 deviceId, int index, NvU32* address);
    int (*FindPCIClassCode)(struct IChipRec *pThis, NvU32 classCode, int index,
        NvU32* address);
    int (*GetSimulatorTime)(struct IChipRec *pThis, NvU64* simTime);
    double (*GetSimulatorTimeUnitsNS)(struct IChipRec *pThis);
    int (*GetPCIBaseAddress)(struct IChipRec *pThis, NvU32 cfgAddr, int index,
        NvU32* pAddress, NvU32* pSize);
    ELEVEL (*GetChipLevel)(struct IChipRec *pThis);
} IChipVtable;

typedef struct IChipRec
{
    IChipVtable *pVtable;
} IChip;

// IBusMem
typedef enum
{
    BUSMEM_HANDLED      = 0,
    BUSMEM_NOTHANDLED   = 1,
} BusMemRet;

struct IBusMemRec;

typedef struct IBusMemVtableRec
{
    void *Unused1;
    void *Unused2;

    // IIfaceObject interface
    void (*AddRef)(struct IBusMemRec *pThis);
    void (*Release)(struct IBusMemRec *pThis);
    IIfaceObject *(*QueryIface)(struct IBusMemRec *pThis, IID_TYPE id);

    void *Unused3;

    // IBusMem interface
    BusMemRet (*BusMemWrBlk)(struct IBusMemRec *pThis, NvU64 address,
        const void *appdata, NvU32 count);
    BusMemRet (*BusMemRdBlk)(struct IBusMemRec *pThis, NvU64 address,
        void *appdata, NvU32 count);
    BusMemRet (*BusMemCpBlk)(struct IBusMemRec *pThis, NvU64 dest,
        NvU64 source, NvU32 count);
    BusMemRet (*BusMemSetBlk)(struct IBusMemRec *pThis, NvU64 address,
        NvU32 size, void* data, NvU32 data_size);
} IBusMemVtable;

typedef struct IBusMemRec
{
    IBusMemVtable *pVtable;
} IBusMem;

struct IInterruptRec;

typedef struct IInterruptVtableRec
{
    void *Unused1;
    void *Unused2;

    // IIfaceObject interface
    void (*AddRef)(struct IInterruptRec *pThis);
    void (*Release)(struct IInterruptRec *pThis);
    IIfaceObject *(*QueryIface)(struct IInterruptRec *pThis, IID_TYPE id);

    void *Unused3;

    // IInterrupt interface
    void (*HandleInterrupt)( struct IInterruptRec *pThis );

} IInterruptVtable;

typedef struct IInterruptRec
{
    IInterruptVtable *pVtable;
} IInterrupt;

#endif // INCLUDED_CHIPLIB_INTERFACE_H