]> bbs.cooldavid.org Git - net-next-2.6.git/blame - drivers/net/igb/e1000_mbx.c
igb: add function to handle mailbox lock
[net-next-2.6.git] / drivers / net / igb / e1000_mbx.c
CommitLineData
4ae196df
AD
1/*******************************************************************************
2
3 Intel(R) Gigabit Ethernet Linux driver
4 Copyright(c) 2007-2009 Intel Corporation.
5
6 This program is free software; you can redistribute it and/or modify it
7 under the terms and conditions of the GNU General Public License,
8 version 2, as published by the Free Software Foundation.
9
10 This program is distributed in the hope it will be useful, but WITHOUT
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 more details.
14
15 You should have received a copy of the GNU General Public License along with
16 this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18
19 The full GNU General Public License is included in this distribution in
20 the file called "COPYING".
21
22 Contact Information:
23 e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
24 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25
26*******************************************************************************/
27
28#include "e1000_mbx.h"
29
30/**
31 * igb_read_mbx - Reads a message from the mailbox
32 * @hw: pointer to the HW structure
33 * @msg: The message buffer
34 * @size: Length of buffer
35 * @mbx_id: id of mailbox to read
36 *
37 * returns SUCCESS if it successfuly read message from buffer
38 **/
39s32 igb_read_mbx(struct e1000_hw *hw, u32 *msg, u16 size, u16 mbx_id)
40{
41 struct e1000_mbx_info *mbx = &hw->mbx;
42 s32 ret_val = -E1000_ERR_MBX;
43
44 /* limit read to size of mailbox */
45 if (size > mbx->size)
46 size = mbx->size;
47
48 if (mbx->ops.read)
49 ret_val = mbx->ops.read(hw, msg, size, mbx_id);
50
51 return ret_val;
52}
53
54/**
55 * igb_write_mbx - Write a message to the mailbox
56 * @hw: pointer to the HW structure
57 * @msg: The message buffer
58 * @size: Length of buffer
59 * @mbx_id: id of mailbox to write
60 *
61 * returns SUCCESS if it successfully copied message into the buffer
62 **/
63s32 igb_write_mbx(struct e1000_hw *hw, u32 *msg, u16 size, u16 mbx_id)
64{
65 struct e1000_mbx_info *mbx = &hw->mbx;
66 s32 ret_val = 0;
67
68 if (size > mbx->size)
69 ret_val = -E1000_ERR_MBX;
70
71 else if (mbx->ops.write)
72 ret_val = mbx->ops.write(hw, msg, size, mbx_id);
73
74 return ret_val;
75}
76
77/**
78 * igb_check_for_msg - checks to see if someone sent us mail
79 * @hw: pointer to the HW structure
80 * @mbx_id: id of mailbox to check
81 *
82 * returns SUCCESS if the Status bit was found or else ERR_MBX
83 **/
84s32 igb_check_for_msg(struct e1000_hw *hw, u16 mbx_id)
85{
86 struct e1000_mbx_info *mbx = &hw->mbx;
87 s32 ret_val = -E1000_ERR_MBX;
88
89 if (mbx->ops.check_for_msg)
90 ret_val = mbx->ops.check_for_msg(hw, mbx_id);
91
92 return ret_val;
93}
94
95/**
96 * igb_check_for_ack - checks to see if someone sent us ACK
97 * @hw: pointer to the HW structure
98 * @mbx_id: id of mailbox to check
99 *
100 * returns SUCCESS if the Status bit was found or else ERR_MBX
101 **/
102s32 igb_check_for_ack(struct e1000_hw *hw, u16 mbx_id)
103{
104 struct e1000_mbx_info *mbx = &hw->mbx;
105 s32 ret_val = -E1000_ERR_MBX;
106
107 if (mbx->ops.check_for_ack)
108 ret_val = mbx->ops.check_for_ack(hw, mbx_id);
109
110 return ret_val;
111}
112
113/**
114 * igb_check_for_rst - checks to see if other side has reset
115 * @hw: pointer to the HW structure
116 * @mbx_id: id of mailbox to check
117 *
118 * returns SUCCESS if the Status bit was found or else ERR_MBX
119 **/
120s32 igb_check_for_rst(struct e1000_hw *hw, u16 mbx_id)
121{
122 struct e1000_mbx_info *mbx = &hw->mbx;
123 s32 ret_val = -E1000_ERR_MBX;
124
125 if (mbx->ops.check_for_rst)
126 ret_val = mbx->ops.check_for_rst(hw, mbx_id);
127
128 return ret_val;
129}
130
131/**
132 * igb_poll_for_msg - Wait for message notification
133 * @hw: pointer to the HW structure
134 * @mbx_id: id of mailbox to write
135 *
136 * returns SUCCESS if it successfully received a message notification
137 **/
138static s32 igb_poll_for_msg(struct e1000_hw *hw, u16 mbx_id)
139{
140 struct e1000_mbx_info *mbx = &hw->mbx;
141 int countdown = mbx->timeout;
142
3935358e 143 if (!countdown || !mbx->ops.check_for_msg)
4ae196df
AD
144 goto out;
145
146 while (mbx->ops.check_for_msg(hw, mbx_id)) {
3935358e 147 countdown--;
4ae196df
AD
148 if (!countdown)
149 break;
4ae196df
AD
150 udelay(mbx->usec_delay);
151 }
152out:
153 return countdown ? 0 : -E1000_ERR_MBX;
154}
155
156/**
157 * igb_poll_for_ack - Wait for message acknowledgement
158 * @hw: pointer to the HW structure
159 * @mbx_id: id of mailbox to write
160 *
161 * returns SUCCESS if it successfully received a message acknowledgement
162 **/
163static s32 igb_poll_for_ack(struct e1000_hw *hw, u16 mbx_id)
164{
165 struct e1000_mbx_info *mbx = &hw->mbx;
166 int countdown = mbx->timeout;
167
3935358e 168 if (!countdown || !mbx->ops.check_for_ack)
4ae196df
AD
169 goto out;
170
171 while (mbx->ops.check_for_ack(hw, mbx_id)) {
3935358e 172 countdown--;
4ae196df
AD
173 if (!countdown)
174 break;
4ae196df
AD
175 udelay(mbx->usec_delay);
176 }
177out:
178 return countdown ? 0 : -E1000_ERR_MBX;
179}
180
181/**
182 * igb_read_posted_mbx - Wait for message notification and receive message
183 * @hw: pointer to the HW structure
184 * @msg: The message buffer
185 * @size: Length of buffer
186 * @mbx_id: id of mailbox to write
187 *
188 * returns SUCCESS if it successfully received a message notification and
189 * copied it into the receive buffer.
190 **/
ff6f63dd 191static s32 igb_read_posted_mbx(struct e1000_hw *hw, u32 *msg, u16 size, u16 mbx_id)
4ae196df
AD
192{
193 struct e1000_mbx_info *mbx = &hw->mbx;
194 s32 ret_val = -E1000_ERR_MBX;
195
196 if (!mbx->ops.read)
197 goto out;
198
199 ret_val = igb_poll_for_msg(hw, mbx_id);
200
201 if (!ret_val)
202 ret_val = mbx->ops.read(hw, msg, size, mbx_id);
203out:
204 return ret_val;
205}
206
207/**
208 * igb_write_posted_mbx - Write a message to the mailbox, wait for ack
209 * @hw: pointer to the HW structure
210 * @msg: The message buffer
211 * @size: Length of buffer
212 * @mbx_id: id of mailbox to write
213 *
214 * returns SUCCESS if it successfully copied message into the buffer and
215 * received an ack to that message within delay * timeout period
216 **/
ff6f63dd 217static s32 igb_write_posted_mbx(struct e1000_hw *hw, u32 *msg, u16 size, u16 mbx_id)
4ae196df
AD
218{
219 struct e1000_mbx_info *mbx = &hw->mbx;
220 s32 ret_val = 0;
221
222 if (!mbx->ops.write)
223 goto out;
224
225 /* send msg*/
226 ret_val = mbx->ops.write(hw, msg, size, mbx_id);
227
228 /* if msg sent wait until we receive an ack */
229 if (!ret_val)
230 ret_val = igb_poll_for_ack(hw, mbx_id);
231out:
232 return ret_val;
233}
234
4ae196df
AD
235static s32 igb_check_for_bit_pf(struct e1000_hw *hw, u32 mask)
236{
237 u32 mbvficr = rd32(E1000_MBVFICR);
238 s32 ret_val = -E1000_ERR_MBX;
239
240 if (mbvficr & mask) {
241 ret_val = 0;
242 wr32(E1000_MBVFICR, mask);
243 }
244
245 return ret_val;
246}
247
248/**
249 * igb_check_for_msg_pf - checks to see if the VF has sent mail
250 * @hw: pointer to the HW structure
251 * @vf_number: the VF index
252 *
253 * returns SUCCESS if the VF has set the Status bit or else ERR_MBX
254 **/
255static s32 igb_check_for_msg_pf(struct e1000_hw *hw, u16 vf_number)
256{
257 s32 ret_val = -E1000_ERR_MBX;
258
259 if (!igb_check_for_bit_pf(hw, E1000_MBVFICR_VFREQ_VF1 << vf_number)) {
260 ret_val = 0;
261 hw->mbx.stats.reqs++;
262 }
263
264 return ret_val;
265}
266
267/**
268 * igb_check_for_ack_pf - checks to see if the VF has ACKed
269 * @hw: pointer to the HW structure
270 * @vf_number: the VF index
271 *
272 * returns SUCCESS if the VF has set the Status bit or else ERR_MBX
273 **/
274static s32 igb_check_for_ack_pf(struct e1000_hw *hw, u16 vf_number)
275{
276 s32 ret_val = -E1000_ERR_MBX;
277
278 if (!igb_check_for_bit_pf(hw, E1000_MBVFICR_VFACK_VF1 << vf_number)) {
279 ret_val = 0;
280 hw->mbx.stats.acks++;
281 }
282
283 return ret_val;
284}
285
286/**
287 * igb_check_for_rst_pf - checks to see if the VF has reset
288 * @hw: pointer to the HW structure
289 * @vf_number: the VF index
290 *
291 * returns SUCCESS if the VF has set the Status bit or else ERR_MBX
292 **/
293static s32 igb_check_for_rst_pf(struct e1000_hw *hw, u16 vf_number)
294{
295 u32 vflre = rd32(E1000_VFLRE);
296 s32 ret_val = -E1000_ERR_MBX;
297
298 if (vflre & (1 << vf_number)) {
299 ret_val = 0;
300 wr32(E1000_VFLRE, (1 << vf_number));
301 hw->mbx.stats.rsts++;
302 }
303
304 return ret_val;
305}
306
0acb6fde
AD
307/**
308 * igb_obtain_mbx_lock_pf - obtain mailbox lock
309 * @hw: pointer to the HW structure
310 * @vf_number: the VF index
311 *
312 * return SUCCESS if we obtained the mailbox lock
313 **/
314static s32 igb_obtain_mbx_lock_pf(struct e1000_hw *hw, u16 vf_number)
315{
316 s32 ret_val = -E1000_ERR_MBX;
317 u32 p2v_mailbox;
318
319
320 /* Take ownership of the buffer */
321 wr32(E1000_P2VMAILBOX(vf_number), E1000_P2VMAILBOX_PFU);
322
323 /* reserve mailbox for vf use */
324 p2v_mailbox = rd32(E1000_P2VMAILBOX(vf_number));
325 if (p2v_mailbox & E1000_P2VMAILBOX_PFU)
326 ret_val = 0;
327
328 return ret_val;
329}
330
4ae196df
AD
331/**
332 * igb_write_mbx_pf - Places a message in the mailbox
333 * @hw: pointer to the HW structure
334 * @msg: The message buffer
335 * @size: Length of buffer
336 * @vf_number: the VF index
337 *
338 * returns SUCCESS if it successfully copied message into the buffer
339 **/
340static s32 igb_write_mbx_pf(struct e1000_hw *hw, u32 *msg, u16 size,
341 u16 vf_number)
342{
0acb6fde 343 s32 ret_val;
4ae196df
AD
344 u16 i;
345
0acb6fde
AD
346 /* lock the mailbox to prevent pf/vf race condition */
347 ret_val = igb_obtain_mbx_lock_pf(hw, vf_number);
348 if (ret_val)
4ae196df 349 goto out_no_write;
4ae196df 350
0acb6fde 351 /* flush msg and acks as we are overwriting the message buffer */
4ae196df 352 igb_check_for_msg_pf(hw, vf_number);
0acb6fde 353 igb_check_for_ack_pf(hw, vf_number);
4ae196df
AD
354
355 /* copy the caller specified message to the mailbox memory buffer */
356 for (i = 0; i < size; i++)
357 array_wr32(E1000_VMBMEM(vf_number), i, msg[i]);
358
359 /* Interrupt VF to tell it a message has been sent and release buffer*/
360 wr32(E1000_P2VMAILBOX(vf_number), E1000_P2VMAILBOX_STS);
361
362 /* update stats */
363 hw->mbx.stats.msgs_tx++;
364
365out_no_write:
366 return ret_val;
367
368}
369
370/**
371 * igb_read_mbx_pf - Read a message from the mailbox
372 * @hw: pointer to the HW structure
373 * @msg: The message buffer
374 * @size: Length of buffer
375 * @vf_number: the VF index
376 *
377 * This function copies a message from the mailbox buffer to the caller's
378 * memory buffer. The presumption is that the caller knows that there was
379 * a message due to a VF request so no polling for message is needed.
380 **/
381static s32 igb_read_mbx_pf(struct e1000_hw *hw, u32 *msg, u16 size,
382 u16 vf_number)
383{
0acb6fde 384 s32 ret_val;
4ae196df
AD
385 u16 i;
386
0acb6fde
AD
387 /* lock the mailbox to prevent pf/vf race condition */
388 ret_val = igb_obtain_mbx_lock_pf(hw, vf_number);
389 if (ret_val)
4ae196df 390 goto out_no_read;
4ae196df
AD
391
392 /* copy the message to the mailbox memory buffer */
393 for (i = 0; i < size; i++)
394 msg[i] = array_rd32(E1000_VMBMEM(vf_number), i);
395
396 /* Acknowledge the message and release buffer */
397 wr32(E1000_P2VMAILBOX(vf_number), E1000_P2VMAILBOX_ACK);
398
399 /* update stats */
400 hw->mbx.stats.msgs_rx++;
401
4ae196df
AD
402out_no_read:
403 return ret_val;
404}
405
406/**
407 * e1000_init_mbx_params_pf - set initial values for pf mailbox
408 * @hw: pointer to the HW structure
409 *
410 * Initializes the hw->mbx struct to correct values for pf mailbox
411 */
412s32 igb_init_mbx_params_pf(struct e1000_hw *hw)
413{
414 struct e1000_mbx_info *mbx = &hw->mbx;
415
416 if (hw->mac.type == e1000_82576) {
417 mbx->timeout = 0;
418 mbx->usec_delay = 0;
419
420 mbx->size = E1000_VFMAILBOX_SIZE;
421
422 mbx->ops.read = igb_read_mbx_pf;
423 mbx->ops.write = igb_write_mbx_pf;
424 mbx->ops.read_posted = igb_read_posted_mbx;
425 mbx->ops.write_posted = igb_write_posted_mbx;
426 mbx->ops.check_for_msg = igb_check_for_msg_pf;
427 mbx->ops.check_for_ack = igb_check_for_ack_pf;
428 mbx->ops.check_for_rst = igb_check_for_rst_pf;
429
430 mbx->stats.msgs_tx = 0;
431 mbx->stats.msgs_rx = 0;
432 mbx->stats.reqs = 0;
433 mbx->stats.acks = 0;
434 mbx->stats.rsts = 0;
435 }
436
437 return 0;
438}
439