[linda] Add missing copyright notices
[people/pcmattman/gpxe.git] / src / drivers / infiniband / linda.h
1 #ifndef _LINDA_H
2 #define _LINDA_H
3
4 /*
5  * Copyright (C) 2008 Michael Brown <mbrown@fensystems.co.uk>.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License as
9  * published by the Free Software Foundation; either version 2 of the
10  * License, or any later version.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  */
21
22 /**
23  * @file
24  *
25  * QLogic Linda Infiniband HCA
26  *
27  */
28
29 #define BITOPS_LITTLE_ENDIAN
30 #include <gpxe/bitops.h>
31 #include "qib_7220_regs.h"
32
33 struct ib_device;
34
35 /** A Linda GPIO register */
36 struct QIB_7220_GPIO_pb {
37         pseudo_bit_t GPIO[16];
38         pseudo_bit_t Reserved[48];
39 };
40 struct QIB_7220_GPIO {
41         PSEUDO_BIT_STRUCT ( struct QIB_7220_GPIO_pb );
42 };
43
44 /** A Linda general scalar register */
45 struct QIB_7220_scalar_pb {
46         pseudo_bit_t Value[64];
47 };
48 struct QIB_7220_scalar {
49         PSEUDO_BIT_STRUCT ( struct QIB_7220_scalar_pb );
50 };
51
52 /** Linda send per-buffer control word */
53 struct QIB_7220_SendPbc_pb {
54         pseudo_bit_t LengthP1_toibc[11];
55         pseudo_bit_t Reserved1[4];
56         pseudo_bit_t LengthP1_trigger[11];
57         pseudo_bit_t Reserved2[3];
58         pseudo_bit_t TestEbp[1];
59         pseudo_bit_t Test[1];
60         pseudo_bit_t Intr[1];
61         pseudo_bit_t Reserved3[31];
62         pseudo_bit_t VL15[1];
63 };
64 struct QIB_7220_SendPbc {
65         PSEUDO_BIT_STRUCT ( struct QIB_7220_SendPbc_pb );
66 };
67
68 /** Linda send buffer availability */
69 struct QIB_7220_SendBufAvail_pb {
70         pseudo_bit_t InUseCheck[144][2];
71         pseudo_bit_t Reserved[32];
72 };
73 struct QIB_7220_SendBufAvail {
74         PSEUDO_BIT_STRUCT ( struct QIB_7220_SendBufAvail_pb );
75 };
76
77 /** DMA alignment for send buffer availability */
78 #define LINDA_SENDBUFAVAIL_ALIGN 64
79
80 /** A Linda eager receive descriptor */
81 struct QIB_7220_RcvEgr_pb {
82         pseudo_bit_t Addr[37];
83         pseudo_bit_t BufSize[3];
84         pseudo_bit_t Reserved[24];
85 };
86 struct QIB_7220_RcvEgr {
87         PSEUDO_BIT_STRUCT ( struct QIB_7220_RcvEgr_pb );
88 };
89
90 /** Linda receive header flags */
91 struct QIB_7220_RcvHdrFlags_pb {
92         pseudo_bit_t PktLen[11];
93         pseudo_bit_t RcvType[3];
94         pseudo_bit_t SoftB[1];
95         pseudo_bit_t SoftA[1];
96         pseudo_bit_t EgrIndex[12];
97         pseudo_bit_t Reserved1[3];
98         pseudo_bit_t UseEgrBfr[1];
99         pseudo_bit_t RcvSeq[4];
100         pseudo_bit_t HdrqOffset[11];
101         pseudo_bit_t Reserved2[8];
102         pseudo_bit_t IBErr[1];
103         pseudo_bit_t MKErr[1];
104         pseudo_bit_t TIDErr[1];
105         pseudo_bit_t KHdrErr[1];
106         pseudo_bit_t MTUErr[1];
107         pseudo_bit_t LenErr[1];
108         pseudo_bit_t ParityErr[1];
109         pseudo_bit_t VCRCErr[1];
110         pseudo_bit_t ICRCErr[1];
111 };
112 struct QIB_7220_RcvHdrFlags {
113         PSEUDO_BIT_STRUCT ( struct QIB_7220_RcvHdrFlags_pb );
114 };
115
116 /** Linda memory BAR size */
117 #define LINDA_BAR0_SIZE 0x400000
118
119 /** Linda I2C SCL line GPIO number */
120 #define LINDA_GPIO_SCL 0
121
122 /** Linda I2C SDA line GPIO number */
123 #define LINDA_GPIO_SDA 1
124
125 /** GUID offset within EEPROM */
126 #define LINDA_EEPROM_GUID_OFFSET 3
127
128 /** GUID size within EEPROM */
129 #define LINDA_EEPROM_GUID_SIZE 8
130
131 /** Board serial number offset within EEPROM */
132 #define LINDA_EEPROM_SERIAL_OFFSET 12
133
134 /** Board serial number size within EEPROM */
135 #define LINDA_EEPROM_SERIAL_SIZE 12
136
137 /** Maximum number of send buffers used
138  *
139  * This is a policy decision.  Must be less than or equal to the total
140  * number of send buffers supported by the hardware (128).
141  */
142 #define LINDA_MAX_SEND_BUFS 32
143
144 /** Linda send buffer size */
145 #define LINDA_SEND_BUF_SIZE 4096
146
147 /** Number of contexts (including kernel context)
148  *
149  * This is a policy decision.  Must be 5, 9 or 17.
150  */
151 #define LINDA_NUM_CONTEXTS 5
152
153 /** PortCfg values for different numbers of contexts */
154 enum linda_portcfg {
155         LINDA_PORTCFG_5CTX = 0,
156         LINDA_PORTCFG_9CTX = 1,
157         LINDA_PORTCFG_17CTX = 2,
158 };
159
160 /** PortCfg values for different numbers of contexts */
161 #define LINDA_EAGER_ARRAY_SIZE_5CTX_0 2048
162 #define LINDA_EAGER_ARRAY_SIZE_5CTX_OTHER 4096
163 #define LINDA_EAGER_ARRAY_SIZE_9CTX_0 2048
164 #define LINDA_EAGER_ARRAY_SIZE_9CTX_OTHER 2048
165 #define LINDA_EAGER_ARRAY_SIZE_17CTX_0 2048
166 #define LINDA_EAGER_ARRAY_SIZE_17CTX_OTHER 1024
167
168 /** Eager buffer required alignment */
169 #define LINDA_EAGER_BUFFER_ALIGN 2048
170
171 /** Eager buffer size encodings */
172 enum linda_eager_buffer_size {
173         LINDA_EAGER_BUFFER_NONE = 0,
174         LINDA_EAGER_BUFFER_2K = 1,
175         LINDA_EAGER_BUFFER_4K = 2,
176         LINDA_EAGER_BUFFER_8K = 3,
177         LINDA_EAGER_BUFFER_16K = 4,
178         LINDA_EAGER_BUFFER_32K = 5,
179         LINDA_EAGER_BUFFER_64K = 6,
180 };
181
182 /** Number of RX headers per context
183  *
184  * This is a policy decision.
185  */
186 #define LINDA_RECV_HEADER_COUNT 8
187
188 /** Maximum size of each RX header
189  *
190  * This is a policy decision.  Must be divisible by 4.
191  */
192 #define LINDA_RECV_HEADER_SIZE 96
193
194 /** Total size of an RX header ring */
195 #define LINDA_RECV_HEADERS_SIZE \
196         ( LINDA_RECV_HEADER_SIZE * LINDA_RECV_HEADER_COUNT )
197
198 /** RX header alignment */
199 #define LINDA_RECV_HEADERS_ALIGN 64
200
201 /** RX payload size
202  *
203  * This is a policy decision.  Must be a valid eager buffer size.
204  */
205 #define LINDA_RECV_PAYLOAD_SIZE 2048
206
207 /** QPN used for Infinipath Packets
208  *
209  * This is a policy decision.  Must have bit 0 clear.  Must not be a
210  * QPN that we will use.
211  */
212 #define LINDA_QP_IDETH 0xdead0
213
214 /** Maximum time for wait for external parallel bus request, in us */
215 #define LINDA_EPB_REQUEST_MAX_WAIT_US 500
216
217 /** Maximum time for wait for external parallel bus transaction, in us */
218 #define LINDA_EPB_XACT_MAX_WAIT_US 500
219
220 /** Linda external parallel bus chip selects */
221 #define LINDA_EPB_CS_SERDES 1
222 #define LINDA_EPB_CS_UC 2
223
224 /** Linda external parallel bus read/write operations */
225 #define LINDA_EPB_WRITE 0
226 #define LINDA_EPB_READ 1
227
228 /** Linda external parallel bus register addresses */
229 #define LINDA_EPB_ADDRESS( _channel, _element, _reg ) \
230         ( (_element) | ( (_channel) << 4 ) | ( (_reg) << 9 ) )
231 #define LINDA_EPB_ADDRESS_CHANNEL( _address )   ( ( (_address) >> 4 ) & 0x1f )
232 #define LINDA_EPB_ADDRESS_ELEMENT( _address )   ( ( (_address) >> 0 ) & 0x0f )
233 #define LINDA_EPB_ADDRESS_REG( _address )       ( ( (_address) >> 9 ) & 0x3f )
234
235 /** Linda external parallel bus locations
236  *
237  * The location is used by the driver to encode both the chip select
238  * and the EPB address.
239  */
240 #define LINDA_EPB_LOC( _cs, _channel, _element, _reg) \
241         ( ( (_cs) << 16 ) | LINDA_EPB_ADDRESS ( _channel, _element, _reg ) )
242 #define LINDA_EPB_LOC_ADDRESS( _loc )   ( (_loc) & 0xffff )
243 #define LINDA_EPB_LOC_CS( _loc )        ( (_loc) >> 16 )
244
245 /** Linda external parallel bus microcontroller register addresses */
246 #define LINDA_EPB_UC_CHANNEL 6
247 #define LINDA_EPB_UC_LOC( _reg ) \
248         LINDA_EPB_LOC ( LINDA_EPB_CS_UC, LINDA_EPB_UC_CHANNEL, 0, (_reg) )
249 #define LINDA_EPB_UC_CTL        LINDA_EPB_UC_LOC ( 0 )
250 #define LINDA_EPB_UC_CTL_WRITE  1
251 #define LINDA_EPB_UC_CTL_READ   2
252 #define LINDA_EPB_UC_ADDR_LO    LINDA_EPB_UC_LOC ( 2 )
253 #define LINDA_EPB_UC_ADDR_HI    LINDA_EPB_UC_LOC ( 3 )
254 #define LINDA_EPB_UC_DATA       LINDA_EPB_UC_LOC ( 4 )
255 #define LINDA_EPB_UC_CHUNK_SIZE 64
256
257 extern uint8_t linda_ib_fw[8192];
258
259 /** Maximum time to wait for "trim done" signal, in ms */
260 #define LINDA_TRIM_DONE_MAX_WAIT_MS 1000
261
262 /** Linda link states */
263 enum linda_link_state {
264         LINDA_LINK_STATE_DOWN = 0,
265         LINDA_LINK_STATE_INIT = 1,
266         LINDA_LINK_STATE_ARM = 2,
267         LINDA_LINK_STATE_ACTIVE = 3,
268         LINDA_LINK_STATE_ACT_DEFER = 4,
269 };
270
271 #endif /* _LINDA_H */