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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
/*
<:copyright-BRCM:2013:DUAL/GPL:standard
Copyright (c) 2013 Broadcom
All Rights Reserved
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2, as published by
the Free Software Foundation (the "GPL").
This program is distributed in the hope that 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.
A copy of the GPL is available at http://www.broadcom.com/licenses/GPLv2.php, or by
writing to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
:>
*/
#ifndef PMCCOMMAND_H
#define PMCCOMMAND_H
#include "pmc_drv.h"
typedef union {
struct {
#ifdef PMC_LITTLE_ENDIAN
uint32_t cmdID:8;
uint32_t error:8;
uint32_t msgID:8;
uint32_t srcPort:8;
#else
uint32_t srcPort:8;
uint32_t msgID:8;
uint32_t error:8;
uint32_t cmdID:8;
#endif
} Bits;
uint32_t Reg32;
} TCommandWord0;
#ifdef PMC_IMPL_3_X
typedef union {
struct {
uint32_t devAddr:16; // [15:00] bus in upper nibble (only values of 0-7 are allowed), device address in lower 12 bits (4096 devices = 0..4095)
uint32_t zoneIdx:10; // [25:16] maximum 1023 registers/zone (0..1022)
uint32_t island:4; // [27:26] maximum 15 power islands (0..15) (island 15 = ALL islands!
uint32_t reserved:2; // [31:28]
} Bits;
uint32_t Reg32;
} TCommandWord1;
#else
typedef union {
struct {
#ifdef PMC_LITTLE_ENDIAN
uint32_t zoneIdx:10;
uint32_t devAddr:10;
uint32_t island:4;
uint32_t logNum:8;
#else
uint32_t logNum:8;
uint32_t island:4;
uint32_t devAddr:10;
uint32_t zoneIdx:10;
#endif
} Bits;
uint32_t Reg32;
} TCommandWord1;
#endif
// Ping, GetNextLogEntry, GetRMON and Sigma
typedef struct {
uint32_t unused[2];
} TCommandNoParams;
typedef struct {
uint32_t params[2];
} TCommandGenericParams;
// PowerZoneOnOff, SetRunState, SetPowerState
typedef struct {
#if defined(PMC_LITTLE_ENDIAN) && defined(PMC_CPU_BIG_ENDIAN)
uint8_t reserved[3];
uint8_t state;
#else
uint8_t state;
uint8_t reserved[3];
#endif
uint32_t unused;
} TCommandStateOnly;
// PowerDevOnOff
typedef struct {
#if defined(PMC_LITTLE_ENDIAN) && defined(PMC_CPU_BIG_ENDIAN)
uint8_t reserved[2];
uint8_t restore;
uint8_t state;
#else
uint8_t state;
uint8_t restore;
uint8_t reserved[2];
#endif
uint32_t unused;
} TCommandPowerDevice;
// PowerOffIsland
typedef struct {
#if defined(PMC_LITTLE_ENDIAN) && defined(PMC_CPU_BIG_ENDIAN)
uint8_t reserved[3];
uint8_t restore;
#else
uint8_t restore;
uint8_t reserved[3];
#endif
uint32_t unused;
} TCommandPowerIsland;
// SetClockLowGear, SetClockHighGear
typedef struct {
#if defined(PMC_LITTLE_ENDIAN) && defined(PMC_CPU_BIG_ENDIAN)
uint8_t reserved[3];
uint8_t clkN;
#else
uint8_t clkN;
uint8_t reserved[3];
#endif
uint32_t unused;
} TCommandSetClockN;
// SetClockGear
typedef struct {
#if defined(PMC_LITTLE_ENDIAN) && defined(PMC_CPU_BIG_ENDIAN)
uint8_t reserved[3];
uint8_t gear;
#else
uint8_t gear;
uint8_t reserved[3];
#endif
uint32_t unused;
} TCommandSetClockGear;
typedef struct {
#if defined(PMC_LITTLE_ENDIAN) && defined(PMC_CPU_BIG_ENDIAN)
uint8_t unused1;
uint8_t numTokens;
uint8_t tokenSize;
uint8_t queueNumber;
uint16_t unused2;
uint8_t high_watermark;
uint8_t low_watermark;
#else
uint8_t queueNumber;
uint8_t tokenSize;
uint8_t numTokens;
uint8_t unused1;
uint8_t low_watermark;
uint8_t high_watermark;
uint16_t unused2;
#endif
} TCommandAllocDQM;
typedef struct {
uint32_t phy_src_addr;
uint32_t dest_addr; // lower 8 bits **may** be log2 window size
} TCommandJumpApp;
typedef struct {
#if defined(PMC_IMPL_3_X) || IS_BCMCHIP(63158)
union {
uint32_t word2;
struct {
uint16_t margin_mv_slow;
uint16_t maximum_mv;
};
};
union {
uint32_t word3;
struct {
uint16_t margin_mv_fast;
uint16_t minimum_mv;
};
};
#else
uint32_t margin_mv_slow;
uint32_t margin_mv_fast;
#endif
} TCommandCloseAVS;
typedef struct {
uint32_t word2;
uint32_t word3;
} TCommandResponse;
typedef struct {
TCommandWord0 word0;
TCommandWord1 word1;
union {
TCommandNoParams cmdNoParams;
TCommandGenericParams cmdGenericParams;
TCommandStateOnly cmdStateOnlyParam;
TCommandPowerDevice cmdPowerDevice;
TCommandPowerIsland cmdPowerIsland;
TCommandSetClockN cmdSetClockN;
TCommandSetClockGear cmdSetClockGear;
TCommandAllocDQM cmdAllocDqm;
TCommandJumpApp cmdJumpApp;
TCommandCloseAVS cmdCloseAVS;
TCommandResponse cmdResponse;
} u;
} TCommand;
// special values to select all devices/zones
#define ALL_DEVICES 0x3ff
#define ALL_ZONES 0x3ff
// used in validate caller to prevent/allow restrictions on island, device and/or zone
#define ANY_ISLAND 998
#define ANY_DEVICE 1024
#define ANY_ZONE 1024
#define NO_ISLAND 999
#define NO_DEVICE 1025
#define NO_ZONE 1025
// error codes
enum {
NO_ERROR = 0,
INVALID_ISLAND,
INVALID_DEVICE,
INVALID_ZONE,
INVALID_STATE,
INVALID_COMMAND,
LOG_EMPTY,
INVALID_PARAM,
BPCM_READ_TIMEOUT,
INVALID_BUS,
INVALID_QUEUE_NUMBER,
QUEUE_NOT_AVAILABLE,
INVALID_TOKEN_SIZE,
INVALID_WATERMARKS,
INSUFFIENT_QSM_MEMORY_AVAILABLE,
INVALID_BOOT_COMMAND,
BPCM_WRITE_TIMEOUT,
CMD_TABLE_FULL,
CMD_TABLE_LOCKED,
};
// command codes
enum {
// low-level commands
cmdReserved = 0,
cmdGetDevPresence,
cmdGetSWStrap,
cmdGetHWRev,
cmdGetNumZones,
cmdPing,
cmdGetNextLogEntry,
cmdGetRMON,
cmdSetClockHighGear,
cmdSetClockLowGear,
cmdSetClockGear,
cmdReadBpcmReg,
cmdReadZoneReg,
cmdWriteBpcmReg,
cmdWriteZoneReg,
// general-purpose high-level commands
cmdSetRunState,
cmdSetPowerState,
cmdShutdownAllowed,
cmdGetSelect0,
cmdGetSelect3,
cmdGetAvsDisableState,
cmdGetPVT,
// specific-purpose high-level commands
cmdPowerDevOnOff,
cmdPowerZoneOnOff,
cmdResetDevice,
cmdResetZone,
cmdAllocateG2UDQM,
cmdQSMAvailable,
cmdRevision,
cmdRegisterCmdHandler,
cmdFindUnusedCommand,
cmdLockCmdTable,
cmdJumpApp,
cmdStall,
cmdCloseAVS,
cmdReadROs,
cmdGetTrackTemp,
cmdSetTrackTemp,
#ifdef PMC_IMPL_3_X
cmdGetIslandStatus,
cmdGetTMON,
cmdSetTemperatureThresholds,
cmdResetTemperatureWarning,
#endif
};
extern void ProcessCommand(TCommand * cmd, TCommand * response);
extern int SendCommand(int cmdID, int devAddr, int zone, int island, uint32_t word2,
uint32_t word3, TCommand *rsp);
#endif // PMCCOMMAND_H
|
