aboutsummaryrefslogtreecommitdiff
path: root/drivers/staging/slicoss/slicdump.h
blob: 92a9b44bcade273a90aa33e2730839efd1a34286 (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
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
/*
 *
 * Copyright (c) 2000-2002 Alacritech, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY ALACRITECH, INC. ``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 ALACRITECH, INC. 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.
 *
 * NO LICENSE TO ANY ALACRITECH PATENT CLAIM IS GRANTED BY ANY COPYRIGHT
 * LICENSE TO THIS OR OTHER SOFTWARE. THIS SOFTWARE MAY BE COVERED BY
 * ALACRITECH PATENTS INCLUDING BUT NOT LIMITED TO U.S. PATENT NOS. 6,226,680,
 * 6,247,060, 6,334,153, 6,389,479, 6,393,487, 6,427,171, 6,427,173
 * and 6,434,620.
 * THIS SOFTWARE IS NOT SUBJECT TO THE GNU GENERAL PUBLIC LICENSE (GPL).
 *
 * The views and conclusions contained in the software and
 * documentation are those of the authors and should not be
 * interpreted as representing official policies, either
 * expressed or implied, of Alacritech, Inc.
 */
#ifndef _SLIC_DUMP_H_
#define _SLIC_DUMP_H_

#define DEBUG_SUCCESS   0

/***********************************************************************
 *
 * Utility processor register locations
 *
 **********************************************************************/
#define UTILITY_RESET       0x0
#define UTILITY_ISP_ADDR    0x4     /* Interrupt status Pointer */
#define UTILITY_ISR_ADDR    0x8     /* Interrupt status Register */
#define UTILITY_ICR_ADDR    0xc     /* Interrupt Control Register */
#define UTILITY_CPR_ADDR    0x10    /* Command Pointer Register */
#define UTILITY_DPR_ADDR    0x14    /* Data Pointer Register */
#define UTILITY_DMP_TRQ     0x18    /* Dump queue onto ALU for analyser */
#define UTILITY_UPP_ADDR    0x1c    /* Bits 63-32 of cmd/data pointer */

/***********************************************************************
 *
 * INIC status register bits
 *
 ***********************************************************************/
#define SLIC_ISR_CC         0x10000000  /* Command complete - synchronous */
#define SLIC_ISR_ERR        0x01000000  /* Command Error - synchronous */
#define SLIC_ISR_CMD_MASK   0x11000000  /* Command status mask */
#define SLIC_ISR_TPH        0x00080000  /* Transmit processor halted - async */
#define SLIC_ISR_RPH        0x00040000  /* Receive processor halted - async */

/***********************************************************************
 *
 * INIC Control register values
 *
 ***********************************************************************/
#define SLIC_ICR_OFF        0           /* Interrupts disabled */
#define SLIC_ICR_ON         1           /* Interrupts enabled */
#define SLIC_ICR_MASK       2           /* Interrupts masked */

#define WRITE_DREG(reg, value, flush)                           \
{                                                               \
    writel((value), (reg));                                     \
    if ((flush)) {                                               \
	mb();                                                   \
    }                                                           \
}

/************************************************************************
 *
 * Command Format
 *
 * Each command contains a command byte which is defined as follows:
 *
 *  bits:   7-3     2       1-0
 *      ----------------------------------------------
 *      command     Alt. Proc   Processor
 *
 ************************************************************************/

/*
 * Macro to create the command byte given the command, Alt. Proc, and
 * Processor values.  Note that the macro assumes that the values are
 * preshifted.  That is, the values for alt. proc are 0 for transmit and
 * 4 for receive.
 */
#define COMMAND_BYTE(command, alt_proc, proc) ((command) | (alt_proc) | (proc))

/*
 * Command values
 */
#define CMD_HALT        0x0     /* Send a halt to the INIC */
#define CMD_RUN         0x8     /* Start the halted INIC */
#define CMD_STEP        0x10    /* Single step the inic */
#define CMD_BREAK       0x18    /* Set a breakpoint - 8 byte command */
#define CMD_RESET_BREAK 0x20    /* Reset a breakpoint - 8 byte cmd */
#define CMD_DUMP        0x28    /* Dump INIC memory - 8 byte command */
#define CMD_LOAD        0x30    /* Load INIC memory - 8 byte command */
#define CMD_MAP         0x38    /* Map out a ROM instruction - 8 BC */
#define CMD_CAM_OPS     0x38    /* perform ops on specific CAM */
#define CMD_XMT         0x40    /* Transmit frame */
#define CMD_RCV         0x48    /* Receive frame */

/*
 * Alt. Proc values
 *
 * When the proc value is set to the utility processor, the Alt. Proc
 * specifies which processor handles the debugging.
 */
#define ALT_PROC_TRANSMIT   0x0
#define ALT_PROC_RECEIVE    0x4

/*
 * Proc values
 */
#define PROC_INVALID        0x0
#define PROC_NONE           0x0  /* Gigabit use */
#define PROC_TRANSMIT       0x1
#define PROC_RECEIVE        0x2
#define PROC_UTILITY        0x3

/******************************************************************
 *
 * 8 byte command structure definitions
 *
 ******************************************************************/

/*
 * Break and Reset Break command structure
 */
struct BREAK {
    unsigned char     command;    /* Command word defined above */
    unsigned char     resvd;
    ushort    count;      /* Number of executions before break */
    u32   addr;       /* Address of break point */
};

/*
 * Dump and Load command structure
 */
struct dump_cmd {
    unsigned char     cmd;        /* Command word defined above */
    unsigned char     desc;       /* Descriptor values - defined below */
    ushort    count;      /* number of 4 byte words to be transferred */
    u32   addr;       /* start address of dump or load */
};

/*
 * Receive or Transmit a frame.
 */
struct RCV_OR_XMT_FRAME {
    unsigned char     command;    /* Command word defined above */
    unsigned char     MacId;      /* Mac ID of interface - transmit only */
    ushort    count;      /* Length of frame in bytes */
    u32   pad;        /* not used */
};

/*
 * Values of desc field in DUMP_OR_LOAD structure
 */
#define DESC_RFILE          0x0     /* Register file */
#define DESC_SRAM           0x1     /* SRAM */
#define DESC_DRAM           0x2     /* DRAM */
#define DESC_QUEUE          0x3     /* queues */
#define DESC_REG            0x4     /* General registers (pc, status, etc) */
#define DESC_SENSE          0x5     /* Sense register */

/* Descriptor field definitions for CMD_DUMP_CAM */
#define DUMP_CAM_A              0
#define DUMP_CAM_B              1               /* unused at present */
#define DUMP_CAM_C              2
#define DUMP_CAM_D              3
#define SEARCH_CAM_A            4
#define SEARCH_CAM_C            5

/*
 * Map command to replace a command in ROM with a command in WCS
 */
struct MAP {
    unsigned char   command;    /* Command word defined above */
    unsigned char   not_used[3];
    ushort  map_to;     /* Instruction address in WCS */
    ushort  map_out;    /* Instruction address in ROM */
};

/*
 * Misc definitions
 */
#define SLIC_MAX_QUEUE       32 /* Total # of queues on the INIC (0-31)*/
#define SLIC_4MAX_REG       512 /* Total # of 4-port file-registers    */
#define SLIC_1MAX_REG       384 /* Total # of file-registers           */
#define SLIC_GBMAX_REG     1024 /* Total # of Gbit file-registers      */
#define SLIC_NUM_REG         32 /* non-file-registers = NUM_REG in tm-simba.h */
#define SLIC_GB_CAMA_SZE     32
#define SLIC_GB_CAMB_SZE     16
#define SLIC_GB_CAMAB_SZE    32
#define SLIC_GB_CAMC_SZE     16
#define SLIC_GB_CAMD_SZE     16
#define SLIC_GB_CAMCD_SZE    32

/*
 * Coredump header structure
 */
struct CORE_Q {
    u32   queueOff;           /* Offset of queue */
    u32   queuesize;          /* size of queue */
};

#define DRIVER_NAME_SIZE    32

struct sliccore_hdr {
    unsigned char driver_version[DRIVER_NAME_SIZE]; /* Driver version string */
    u32   RcvRegOff;          /* Offset of receive registers */
    u32   RcvRegsize;         /* size of receive registers */
    u32   XmtRegOff;          /* Offset of transmit registers */
    u32   XmtRegsize;         /* size of transmit registers */
    u32   FileRegOff;         /* Offset of register file */
    u32   FileRegsize;        /* size of register file */
    u32   SramOff;            /* Offset of Sram */
    u32   Sramsize;           /* size of Sram */
    u32   DramOff;            /* Offset of Dram */
    u32   Dramsize;           /* size of Dram */
    CORE_Q    queues[SLIC_MAX_QUEUE]; /* size and offsets of queues */
    u32   CamAMOff;           /* Offset of CAM A contents */
    u32   CamASize;           /* Size of Cam A */
    u32   CamBMOff;           /* Offset of CAM B contents */
    u32   CamBSize;           /* Size of Cam B */
    u32   CamCMOff;           /* Offset of CAM C contents */
    u32   CamCSize;           /* Size of Cam C */
    u32   CamDMOff;           /* Offset of CAM D contents */
    u32   CamDSize;           /* Size of Cam D */
};

/*
 * definitions needed for our kernel-mode gdb stub.
 */
/***********************************************************************
 *
 * Definitions & Typedefs
 *
 **********************************************************************/
#define BUFMAX      0x20000 /* 128k - size of input/output buffer */
#define BUFMAXP2    5       /* 2**5 (32) 4K pages */

#define IOCTL_SIMBA_BREAK           _IOW('s', 0, unsigned long)
/* #define IOCTL_SIMBA_INIT            _IOW('s', 1, unsigned long) */
#define IOCTL_SIMBA_KILL_TGT_PROC   _IOW('s', 2, unsigned long)

/***********************************************************************
 *
 * Global variables
 *
 ***********************************************************************/

#define THREADRECEIVE   1   /* bit 0 of StoppedThreads */
#define THREADTRANSMIT  2   /* bit 1 of StoppedThreads */
#define THREADBOTH      3   /* bit 0 and 1.. */

#endif  /*  _SLIC_DUMP_H  */