2 * linux/drivers/message/fusion/mptbase.c
3 * This is the Fusion MPT base driver which supports multiple
4 * (SCSI + LAN) specialized protocol drivers.
5 * For use with LSI Logic PCI chip/adapter(s)
6 * running LSI Logic Fusion MPT (Message Passing Technology) firmware.
8 * Copyright (c) 1999-2005 LSI Logic Corporation
9 * (mailto:mpt_linux_developer@lsil.com)
12 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
14 This program is free software; you can redistribute it and/or modify
15 it under the terms of the GNU General Public License as published by
16 the Free Software Foundation; version 2 of the License.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License for more details.
24 THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
25 CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
26 LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
27 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
28 solely responsible for determining the appropriateness of using and
29 distributing the Program and assumes all risks associated with its
30 exercise of rights under this Agreement, including but not limited to
31 the risks and costs of program errors, damage to or loss of data,
32 programs or equipment, and unavailability or interruption of operations.
34 DISCLAIMER OF LIABILITY
35 NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
36 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
38 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
39 TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
40 USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
41 HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
43 You should have received a copy of the GNU General Public License
44 along with this program; if not, write to the Free Software
45 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
47 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
49 #include <linux/config.h>
50 #include <linux/kernel.h>
51 #include <linux/module.h>
52 #include <linux/errno.h>
53 #include <linux/init.h>
54 #include <linux/slab.h>
55 #include <linux/types.h>
56 #include <linux/pci.h>
57 #include <linux/kdev_t.h>
58 #include <linux/blkdev.h>
59 #include <linux/delay.h>
60 #include <linux/interrupt.h> /* needed for in_interrupt() proto */
61 #include <linux/dma-mapping.h>
67 #include <asm/irq.h> /* needed for __irq_itoa() proto */
72 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
73 #define my_NAME "Fusion MPT base driver"
74 #define my_VERSION MPT_LINUX_VERSION_COMMON
75 #define MYNAM "mptbase"
77 MODULE_AUTHOR(MODULEAUTHOR);
78 MODULE_DESCRIPTION(my_NAME);
79 MODULE_LICENSE("GPL");
85 static int mfcounter = 0;
86 #define PRINT_MF_COUNT 20000
89 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
93 int mpt_lan_index = -1;
94 int mpt_stm_index = -1;
96 struct proc_dir_entry *mpt_proc_root_dir;
98 #define WHOINIT_UNKNOWN 0xAA
100 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
104 /* Adapter link list */
106 /* Callback lookup table */
107 static MPT_CALLBACK MptCallbacks[MPT_MAX_PROTOCOL_DRIVERS];
108 /* Protocol driver class lookup table */
109 static int MptDriverClass[MPT_MAX_PROTOCOL_DRIVERS];
110 /* Event handler lookup table */
111 static MPT_EVHANDLER MptEvHandlers[MPT_MAX_PROTOCOL_DRIVERS];
112 /* Reset handler lookup table */
113 static MPT_RESETHANDLER MptResetHandlers[MPT_MAX_PROTOCOL_DRIVERS];
114 static struct mpt_pci_driver *MptDeviceDriverHandlers[MPT_MAX_PROTOCOL_DRIVERS];
116 static int mpt_base_index = -1;
117 static int last_drv_idx = -1;
119 static DECLARE_WAIT_QUEUE_HEAD(mpt_waitq);
121 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
125 static irqreturn_t mpt_interrupt(int irq, void *bus_id, struct pt_regs *r);
126 static int mpt_base_reply(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
127 static int mpt_handshake_req_reply_wait(MPT_ADAPTER *ioc, int reqBytes,
128 u32 *req, int replyBytes, u16 *u16reply, int maxwait,
130 static int mpt_do_ioc_recovery(MPT_ADAPTER *ioc, u32 reason, int sleepFlag);
131 static void mpt_detect_bound_ports(MPT_ADAPTER *ioc, struct pci_dev *pdev);
132 static void mpt_adapter_disable(MPT_ADAPTER *ioc);
133 static void mpt_adapter_dispose(MPT_ADAPTER *ioc);
135 static void MptDisplayIocCapabilities(MPT_ADAPTER *ioc);
136 static int MakeIocReady(MPT_ADAPTER *ioc, int force, int sleepFlag);
137 static int GetIocFacts(MPT_ADAPTER *ioc, int sleepFlag, int reason);
138 static int GetPortFacts(MPT_ADAPTER *ioc, int portnum, int sleepFlag);
139 static int SendIocInit(MPT_ADAPTER *ioc, int sleepFlag);
140 static int SendPortEnable(MPT_ADAPTER *ioc, int portnum, int sleepFlag);
141 static int mpt_do_upload(MPT_ADAPTER *ioc, int sleepFlag);
142 static int mpt_downloadboot(MPT_ADAPTER *ioc, MpiFwHeader_t *pFwHeader, int sleepFlag);
143 static int mpt_diag_reset(MPT_ADAPTER *ioc, int ignore, int sleepFlag);
144 static int KickStart(MPT_ADAPTER *ioc, int ignore, int sleepFlag);
145 static int SendIocReset(MPT_ADAPTER *ioc, u8 reset_type, int sleepFlag);
146 static int PrimeIocFifos(MPT_ADAPTER *ioc);
147 static int WaitForDoorbellAck(MPT_ADAPTER *ioc, int howlong, int sleepFlag);
148 static int WaitForDoorbellInt(MPT_ADAPTER *ioc, int howlong, int sleepFlag);
149 static int WaitForDoorbellReply(MPT_ADAPTER *ioc, int howlong, int sleepFlag);
150 static int GetLanConfigPages(MPT_ADAPTER *ioc);
151 static int GetFcPortPage0(MPT_ADAPTER *ioc, int portnum);
152 static int GetIoUnitPage2(MPT_ADAPTER *ioc);
153 int mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode);
154 static int mpt_GetScsiPortSettings(MPT_ADAPTER *ioc, int portnum);
155 static int mpt_readScsiDevicePageHeaders(MPT_ADAPTER *ioc, int portnum);
156 static void mpt_read_ioc_pg_1(MPT_ADAPTER *ioc);
157 static void mpt_read_ioc_pg_4(MPT_ADAPTER *ioc);
158 static void mpt_timer_expired(unsigned long data);
159 static int SendEventNotification(MPT_ADAPTER *ioc, u8 EvSwitch);
160 static int SendEventAck(MPT_ADAPTER *ioc, EventNotificationReply_t *evnp);
161 static int mpt_host_page_access_control(MPT_ADAPTER *ioc, u8 access_control_value, int sleepFlag);
162 static int mpt_host_page_alloc(MPT_ADAPTER *ioc, pIOCInit_t ioc_init);
164 #ifdef CONFIG_PROC_FS
165 static int procmpt_summary_read(char *buf, char **start, off_t offset,
166 int request, int *eof, void *data);
167 static int procmpt_version_read(char *buf, char **start, off_t offset,
168 int request, int *eof, void *data);
169 static int procmpt_iocinfo_read(char *buf, char **start, off_t offset,
170 int request, int *eof, void *data);
172 static void mpt_get_fw_exp_ver(char *buf, MPT_ADAPTER *ioc);
174 //int mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
175 static int ProcessEventNotification(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply, int *evHandlers);
176 static void mpt_sp_ioc_info(MPT_ADAPTER *ioc, u32 ioc_status, MPT_FRAME_HDR *mf);
177 static void mpt_fc_log_info(MPT_ADAPTER *ioc, u32 log_info);
178 static void mpt_sp_log_info(MPT_ADAPTER *ioc, u32 log_info);
179 static void mpt_sas_log_info(MPT_ADAPTER *ioc, u32 log_info);
181 /* module entry point */
182 static int __init fusion_init (void);
183 static void __exit fusion_exit (void);
185 #define CHIPREG_READ32(addr) readl_relaxed(addr)
186 #define CHIPREG_READ32_dmasync(addr) readl(addr)
187 #define CHIPREG_WRITE32(addr,val) writel(val, addr)
188 #define CHIPREG_PIO_WRITE32(addr,val) outl(val, (unsigned long)addr)
189 #define CHIPREG_PIO_READ32(addr) inl((unsigned long)addr)
192 pci_disable_io_access(struct pci_dev *pdev)
196 pci_read_config_word(pdev, PCI_COMMAND, &command_reg);
198 pci_write_config_word(pdev, PCI_COMMAND, command_reg);
202 pci_enable_io_access(struct pci_dev *pdev)
206 pci_read_config_word(pdev, PCI_COMMAND, &command_reg);
208 pci_write_config_word(pdev, PCI_COMMAND, command_reg);
212 * Process turbo (context) reply...
215 mpt_turbo_reply(MPT_ADAPTER *ioc, u32 pa)
217 MPT_FRAME_HDR *mf = NULL;
218 MPT_FRAME_HDR *mr = NULL;
222 dmfprintk((MYIOC_s_INFO_FMT "Got TURBO reply req_idx=%08x\n",
225 switch (pa >> MPI_CONTEXT_REPLY_TYPE_SHIFT) {
226 case MPI_CONTEXT_REPLY_TYPE_SCSI_INIT:
227 req_idx = pa & 0x0000FFFF;
228 cb_idx = (pa & 0x00FF0000) >> 16;
229 mf = MPT_INDEX_2_MFPTR(ioc, req_idx);
231 case MPI_CONTEXT_REPLY_TYPE_LAN:
232 cb_idx = mpt_lan_index;
234 * Blind set of mf to NULL here was fatal
235 * after lan_reply says "freeme"
236 * Fix sort of combined with an optimization here;
237 * added explicit check for case where lan_reply
238 * was just returning 1 and doing nothing else.
239 * For this case skip the callback, but set up
240 * proper mf value first here:-)
242 if ((pa & 0x58000000) == 0x58000000) {
243 req_idx = pa & 0x0000FFFF;
244 mf = MPT_INDEX_2_MFPTR(ioc, req_idx);
245 mpt_free_msg_frame(ioc, mf);
250 mr = (MPT_FRAME_HDR *) CAST_U32_TO_PTR(pa);
252 case MPI_CONTEXT_REPLY_TYPE_SCSI_TARGET:
253 cb_idx = mpt_stm_index;
254 mr = (MPT_FRAME_HDR *) CAST_U32_TO_PTR(pa);
261 /* Check for (valid) IO callback! */
262 if (cb_idx < 1 || cb_idx >= MPT_MAX_PROTOCOL_DRIVERS ||
263 MptCallbacks[cb_idx] == NULL) {
264 printk(MYIOC_s_WARN_FMT "%s: Invalid cb_idx (%d)!\n",
265 __FUNCTION__, ioc->name, cb_idx);
269 if (MptCallbacks[cb_idx](ioc, mf, mr))
270 mpt_free_msg_frame(ioc, mf);
276 mpt_reply(MPT_ADAPTER *ioc, u32 pa)
287 /* non-TURBO reply! Hmmm, something may be up...
288 * Newest turbo reply mechanism; get address
289 * via left shift 1 (get rid of MPI_ADDRESS_REPLY_A_BIT)!
292 /* Map DMA address of reply header to cpu address.
293 * pa is 32 bits - but the dma address may be 32 or 64 bits
294 * get offset based only only the low addresses
297 reply_dma_low = (pa <<= 1);
298 mr = (MPT_FRAME_HDR *)((u8 *)ioc->reply_frames +
299 (reply_dma_low - ioc->reply_frames_low_dma));
301 req_idx = le16_to_cpu(mr->u.frame.hwhdr.msgctxu.fld.req_idx);
302 cb_idx = mr->u.frame.hwhdr.msgctxu.fld.cb_idx;
303 mf = MPT_INDEX_2_MFPTR(ioc, req_idx);
305 dmfprintk((MYIOC_s_INFO_FMT "Got non-TURBO reply=%p req_idx=%x cb_idx=%x Function=%x\n",
306 ioc->name, mr, req_idx, cb_idx, mr->u.hdr.Function));
307 DBG_DUMP_REPLY_FRAME(mr)
309 /* Check/log IOC log info
311 ioc_stat = le16_to_cpu(mr->u.reply.IOCStatus);
312 if (ioc_stat & MPI_IOCSTATUS_FLAG_LOG_INFO_AVAILABLE) {
313 u32 log_info = le32_to_cpu(mr->u.reply.IOCLogInfo);
314 if (ioc->bus_type == FC)
315 mpt_fc_log_info(ioc, log_info);
316 else if (ioc->bus_type == SPI)
317 mpt_sp_log_info(ioc, log_info);
318 else if (ioc->bus_type == SAS)
319 mpt_sas_log_info(ioc, log_info);
321 if (ioc_stat & MPI_IOCSTATUS_MASK) {
322 if (ioc->bus_type == SPI &&
323 cb_idx != mpt_stm_index &&
324 cb_idx != mpt_lan_index)
325 mpt_sp_ioc_info(ioc, (u32)ioc_stat, mf);
329 /* Check for (valid) IO callback! */
330 if (cb_idx < 1 || cb_idx >= MPT_MAX_PROTOCOL_DRIVERS ||
331 MptCallbacks[cb_idx] == NULL) {
332 printk(MYIOC_s_WARN_FMT "%s: Invalid cb_idx (%d)!\n",
333 __FUNCTION__, ioc->name, cb_idx);
338 freeme = MptCallbacks[cb_idx](ioc, mf, mr);
341 /* Flush (non-TURBO) reply with a WRITE! */
342 CHIPREG_WRITE32(&ioc->chip->ReplyFifo, pa);
345 mpt_free_msg_frame(ioc, mf);
349 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
351 * mpt_interrupt - MPT adapter (IOC) specific interrupt handler.
352 * @irq: irq number (not used)
353 * @bus_id: bus identifier cookie == pointer to MPT_ADAPTER structure
354 * @r: pt_regs pointer (not used)
356 * This routine is registered via the request_irq() kernel API call,
357 * and handles all interrupts generated from a specific MPT adapter
358 * (also referred to as a IO Controller or IOC).
359 * This routine must clear the interrupt from the adapter and does
360 * so by reading the reply FIFO. Multiple replies may be processed
361 * per single call to this routine.
363 * This routine handles register-level access of the adapter but
364 * dispatches (calls) a protocol-specific callback routine to handle
365 * the protocol-specific details of the MPT request completion.
368 mpt_interrupt(int irq, void *bus_id, struct pt_regs *r)
370 MPT_ADAPTER *ioc = bus_id;
374 * Drain the reply FIFO!
377 pa = CHIPREG_READ32_dmasync(&ioc->chip->ReplyFifo);
378 if (pa == 0xFFFFFFFF)
380 else if (pa & MPI_ADDRESS_REPLY_A_BIT)
383 mpt_turbo_reply(ioc, pa);
389 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
391 * mpt_base_reply - MPT base driver's callback routine; all base driver
392 * "internal" request/reply processing is routed here.
393 * Currently used for EventNotification and EventAck handling.
394 * @ioc: Pointer to MPT_ADAPTER structure
395 * @mf: Pointer to original MPT request frame
396 * @reply: Pointer to MPT reply frame (NULL if TurboReply)
398 * Returns 1 indicating original alloc'd request frame ptr
399 * should be freed, or 0 if it shouldn't.
402 mpt_base_reply(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf, MPT_FRAME_HDR *reply)
407 dmfprintk((MYIOC_s_INFO_FMT "mpt_base_reply() called\n", ioc->name));
409 #if defined(MPT_DEBUG_MSG_FRAME)
410 if (!(reply->u.hdr.MsgFlags & MPI_MSGFLAGS_CONTINUATION_REPLY)) {
411 dmfprintk((KERN_INFO MYNAM ": Original request frame (@%p) header\n", mf));
412 DBG_DUMP_REQUEST_FRAME_HDR(mf)
416 func = reply->u.hdr.Function;
417 dmfprintk((MYIOC_s_INFO_FMT "mpt_base_reply, Function=%02Xh\n",
420 if (func == MPI_FUNCTION_EVENT_NOTIFICATION) {
421 EventNotificationReply_t *pEvReply = (EventNotificationReply_t *) reply;
425 results = ProcessEventNotification(ioc, pEvReply, &evHandlers);
426 if (results != evHandlers) {
427 /* CHECKME! Any special handling needed here? */
428 devtprintk((MYIOC_s_WARN_FMT "Called %d event handlers, sum results = %d\n",
429 ioc->name, evHandlers, results));
433 * Hmmm... It seems that EventNotificationReply is an exception
434 * to the rule of one reply per request.
436 if (pEvReply->MsgFlags & MPI_MSGFLAGS_CONTINUATION_REPLY) {
438 devtprintk((MYIOC_s_WARN_FMT "EVENT_NOTIFICATION reply %p does not return Request frame\n",
439 ioc->name, pEvReply));
441 devtprintk((MYIOC_s_WARN_FMT "EVENT_NOTIFICATION reply %p returns Request frame\n",
442 ioc->name, pEvReply));
445 #ifdef CONFIG_PROC_FS
446 // LogEvent(ioc, pEvReply);
449 } else if (func == MPI_FUNCTION_EVENT_ACK) {
450 dprintk((MYIOC_s_INFO_FMT "mpt_base_reply, EventAck reply received\n",
452 } else if (func == MPI_FUNCTION_CONFIG ||
453 func == MPI_FUNCTION_TOOLBOX) {
457 dcprintk((MYIOC_s_INFO_FMT "config_complete (mf=%p,mr=%p)\n",
458 ioc->name, mf, reply));
460 pCfg = * ((CONFIGPARMS **)((u8 *) mf + ioc->req_sz - sizeof(void *)));
463 /* disable timer and remove from linked list */
464 del_timer(&pCfg->timer);
466 spin_lock_irqsave(&ioc->FreeQlock, flags);
467 list_del(&pCfg->linkage);
468 spin_unlock_irqrestore(&ioc->FreeQlock, flags);
471 * If IOC Status is SUCCESS, save the header
472 * and set the status code to GOOD.
474 pCfg->status = MPT_CONFIG_ERROR;
476 ConfigReply_t *pReply = (ConfigReply_t *)reply;
479 status = le16_to_cpu(pReply->IOCStatus) & MPI_IOCSTATUS_MASK;
480 dcprintk((KERN_NOTICE " IOCStatus=%04xh, IOCLogInfo=%08xh\n",
481 status, le32_to_cpu(pReply->IOCLogInfo)));
483 pCfg->status = status;
484 if (status == MPI_IOCSTATUS_SUCCESS) {
485 if ((pReply->Header.PageType &
486 MPI_CONFIG_PAGETYPE_MASK) ==
487 MPI_CONFIG_PAGETYPE_EXTENDED) {
488 pCfg->cfghdr.ehdr->ExtPageLength =
489 le16_to_cpu(pReply->ExtPageLength);
490 pCfg->cfghdr.ehdr->ExtPageType =
493 pCfg->cfghdr.hdr->PageVersion = pReply->Header.PageVersion;
495 /* If this is a regular header, save PageLength. */
496 /* LMP Do this better so not using a reserved field! */
497 pCfg->cfghdr.hdr->PageLength = pReply->Header.PageLength;
498 pCfg->cfghdr.hdr->PageNumber = pReply->Header.PageNumber;
499 pCfg->cfghdr.hdr->PageType = pReply->Header.PageType;
504 * Wake up the original calling thread
509 } else if (func == MPI_FUNCTION_SAS_IO_UNIT_CONTROL) {
510 /* we should be always getting a reply frame */
511 memcpy(ioc->persist_reply_frame, reply,
512 min(MPT_DEFAULT_FRAME_SIZE,
513 4*reply->u.reply.MsgLength));
514 del_timer(&ioc->persist_timer);
515 ioc->persist_wait_done = 1;
518 printk(MYIOC_s_ERR_FMT "Unexpected msg function (=%02Xh) reply received!\n",
523 * Conditionally tell caller to free the original
524 * EventNotification/EventAck/unexpected request frame!
529 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
531 * mpt_register - Register protocol-specific main callback handler.
532 * @cbfunc: callback function pointer
533 * @dclass: Protocol driver's class (%MPT_DRIVER_CLASS enum value)
535 * This routine is called by a protocol-specific driver (SCSI host,
536 * LAN, SCSI target) to register it's reply callback routine. Each
537 * protocol-specific driver must do this before it will be able to
538 * use any IOC resources, such as obtaining request frames.
540 * NOTES: The SCSI protocol driver currently calls this routine thrice
541 * in order to register separate callbacks; one for "normal" SCSI IO;
542 * one for MptScsiTaskMgmt requests; one for Scan/DV requests.
544 * Returns a positive integer valued "handle" in the
545 * range (and S.O.D. order) {N,...,7,6,5,...,1} if successful.
546 * Any non-positive return value (including zero!) should be considered
547 * an error by the caller.
550 mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass)
557 * Search for empty callback slot in this order: {N,...,7,6,5,...,1}
558 * (slot/handle 0 is reserved!)
560 for (i = MPT_MAX_PROTOCOL_DRIVERS-1; i; i--) {
561 if (MptCallbacks[i] == NULL) {
562 MptCallbacks[i] = cbfunc;
563 MptDriverClass[i] = dclass;
564 MptEvHandlers[i] = NULL;
573 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
575 * mpt_deregister - Deregister a protocol drivers resources.
576 * @cb_idx: previously registered callback handle
578 * Each protocol-specific driver should call this routine when it's
579 * module is unloaded.
582 mpt_deregister(int cb_idx)
584 if ((cb_idx >= 0) && (cb_idx < MPT_MAX_PROTOCOL_DRIVERS)) {
585 MptCallbacks[cb_idx] = NULL;
586 MptDriverClass[cb_idx] = MPTUNKNOWN_DRIVER;
587 MptEvHandlers[cb_idx] = NULL;
593 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
595 * mpt_event_register - Register protocol-specific event callback
597 * @cb_idx: previously registered (via mpt_register) callback handle
598 * @ev_cbfunc: callback function
600 * This routine can be called by one or more protocol-specific drivers
601 * if/when they choose to be notified of MPT events.
603 * Returns 0 for success.
606 mpt_event_register(int cb_idx, MPT_EVHANDLER ev_cbfunc)
608 if (cb_idx < 1 || cb_idx >= MPT_MAX_PROTOCOL_DRIVERS)
611 MptEvHandlers[cb_idx] = ev_cbfunc;
615 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
617 * mpt_event_deregister - Deregister protocol-specific event callback
619 * @cb_idx: previously registered callback handle
621 * Each protocol-specific driver should call this routine
622 * when it does not (or can no longer) handle events,
623 * or when it's module is unloaded.
626 mpt_event_deregister(int cb_idx)
628 if (cb_idx < 1 || cb_idx >= MPT_MAX_PROTOCOL_DRIVERS)
631 MptEvHandlers[cb_idx] = NULL;
634 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
636 * mpt_reset_register - Register protocol-specific IOC reset handler.
637 * @cb_idx: previously registered (via mpt_register) callback handle
638 * @reset_func: reset function
640 * This routine can be called by one or more protocol-specific drivers
641 * if/when they choose to be notified of IOC resets.
643 * Returns 0 for success.
646 mpt_reset_register(int cb_idx, MPT_RESETHANDLER reset_func)
648 if (cb_idx < 1 || cb_idx >= MPT_MAX_PROTOCOL_DRIVERS)
651 MptResetHandlers[cb_idx] = reset_func;
655 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
657 * mpt_reset_deregister - Deregister protocol-specific IOC reset handler.
658 * @cb_idx: previously registered callback handle
660 * Each protocol-specific driver should call this routine
661 * when it does not (or can no longer) handle IOC reset handling,
662 * or when it's module is unloaded.
665 mpt_reset_deregister(int cb_idx)
667 if (cb_idx < 1 || cb_idx >= MPT_MAX_PROTOCOL_DRIVERS)
670 MptResetHandlers[cb_idx] = NULL;
673 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
675 * mpt_device_driver_register - Register device driver hooks
678 mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, int cb_idx)
682 if (cb_idx < 1 || cb_idx >= MPT_MAX_PROTOCOL_DRIVERS) {
686 MptDeviceDriverHandlers[cb_idx] = dd_cbfunc;
688 /* call per pci device probe entry point */
689 list_for_each_entry(ioc, &ioc_list, list) {
690 if(dd_cbfunc->probe) {
691 dd_cbfunc->probe(ioc->pcidev,
692 ioc->pcidev->driver->id_table);
699 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
701 * mpt_device_driver_deregister - DeRegister device driver hooks
704 mpt_device_driver_deregister(int cb_idx)
706 struct mpt_pci_driver *dd_cbfunc;
709 if (cb_idx < 1 || cb_idx >= MPT_MAX_PROTOCOL_DRIVERS)
712 dd_cbfunc = MptDeviceDriverHandlers[cb_idx];
714 list_for_each_entry(ioc, &ioc_list, list) {
715 if (dd_cbfunc->remove)
716 dd_cbfunc->remove(ioc->pcidev);
719 MptDeviceDriverHandlers[cb_idx] = NULL;
723 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
725 * mpt_get_msg_frame - Obtain a MPT request frame from the pool (of 1024)
726 * allocated per MPT adapter.
727 * @handle: Handle of registered MPT protocol driver
728 * @ioc: Pointer to MPT adapter structure
730 * Returns pointer to a MPT request frame or %NULL if none are available
731 * or IOC is not active.
734 mpt_get_msg_frame(int handle, MPT_ADAPTER *ioc)
738 u16 req_idx; /* Request index */
740 /* validate handle and ioc identifier */
744 printk(KERN_WARNING "IOC Not Active! mpt_get_msg_frame returning NULL!\n");
747 /* If interrupts are not attached, do not return a request frame */
751 spin_lock_irqsave(&ioc->FreeQlock, flags);
752 if (!list_empty(&ioc->FreeQ)) {
755 mf = list_entry(ioc->FreeQ.next, MPT_FRAME_HDR,
756 u.frame.linkage.list);
757 list_del(&mf->u.frame.linkage.list);
758 mf->u.frame.linkage.arg1 = 0;
759 mf->u.frame.hwhdr.msgctxu.fld.cb_idx = handle; /* byte */
760 req_offset = (u8 *)mf - (u8 *)ioc->req_frames;
762 req_idx = req_offset / ioc->req_sz;
763 mf->u.frame.hwhdr.msgctxu.fld.req_idx = cpu_to_le16(req_idx);
764 mf->u.frame.hwhdr.msgctxu.fld.rsvd = 0;
765 ioc->RequestNB[req_idx] = ioc->NB_for_64_byte_frame; /* Default, will be changed if necessary in SG generation */
772 spin_unlock_irqrestore(&ioc->FreeQlock, flags);
776 printk(KERN_WARNING "IOC Active. No free Msg Frames! Count 0x%x Max 0x%x\n", ioc->mfcnt, ioc->req_depth);
778 if (mfcounter == PRINT_MF_COUNT)
779 printk(KERN_INFO "MF Count 0x%x Max 0x%x \n", ioc->mfcnt, ioc->req_depth);
782 dmfprintk((KERN_INFO MYNAM ": %s: mpt_get_msg_frame(%d,%d), got mf=%p\n",
783 ioc->name, handle, ioc->id, mf));
787 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
789 * mpt_put_msg_frame - Send a protocol specific MPT request frame
791 * @handle: Handle of registered MPT protocol driver
792 * @ioc: Pointer to MPT adapter structure
793 * @mf: Pointer to MPT request frame
795 * This routine posts a MPT request frame to the request post FIFO of a
796 * specific MPT adapter.
799 mpt_put_msg_frame(int handle, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf)
803 u16 req_idx; /* Request index */
805 /* ensure values are reset properly! */
806 mf->u.frame.hwhdr.msgctxu.fld.cb_idx = handle; /* byte */
807 req_offset = (u8 *)mf - (u8 *)ioc->req_frames;
809 req_idx = req_offset / ioc->req_sz;
810 mf->u.frame.hwhdr.msgctxu.fld.req_idx = cpu_to_le16(req_idx);
811 mf->u.frame.hwhdr.msgctxu.fld.rsvd = 0;
813 #ifdef MPT_DEBUG_MSG_FRAME
815 u32 *m = mf->u.frame.hwhdr.__hdr;
818 printk(KERN_INFO MYNAM ": %s: About to Put msg frame @ %p:\n" KERN_INFO " ",
820 n = ioc->req_sz/4 - 1;
823 for (ii=0; ii<=n; ii++) {
824 if (ii && ((ii%8)==0))
825 printk("\n" KERN_INFO " ");
826 printk(" %08x", le32_to_cpu(m[ii]));
832 mf_dma_addr = (ioc->req_frames_low_dma + req_offset) | ioc->RequestNB[req_idx];
833 dsgprintk((MYIOC_s_INFO_FMT "mf_dma_addr=%x req_idx=%d RequestNB=%x\n", ioc->name, mf_dma_addr, req_idx, ioc->RequestNB[req_idx]));
834 CHIPREG_WRITE32(&ioc->chip->RequestFifo, mf_dma_addr);
837 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
839 * mpt_free_msg_frame - Place MPT request frame back on FreeQ.
840 * @handle: Handle of registered MPT protocol driver
841 * @ioc: Pointer to MPT adapter structure
842 * @mf: Pointer to MPT request frame
844 * This routine places a MPT request frame back on the MPT adapter's
848 mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf)
852 /* Put Request back on FreeQ! */
853 spin_lock_irqsave(&ioc->FreeQlock, flags);
854 mf->u.frame.linkage.arg1 = 0xdeadbeaf; /* signature to know if this mf is freed */
855 list_add_tail(&mf->u.frame.linkage.list, &ioc->FreeQ);
859 spin_unlock_irqrestore(&ioc->FreeQlock, flags);
862 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
864 * mpt_add_sge - Place a simple SGE at address pAddr.
865 * @pAddr: virtual address for SGE
866 * @flagslength: SGE flags and data transfer length
867 * @dma_addr: Physical address
869 * This routine places a MPT request frame back on the MPT adapter's
873 mpt_add_sge(char *pAddr, u32 flagslength, dma_addr_t dma_addr)
875 if (sizeof(dma_addr_t) == sizeof(u64)) {
876 SGESimple64_t *pSge = (SGESimple64_t *) pAddr;
877 u32 tmp = dma_addr & 0xFFFFFFFF;
879 pSge->FlagsLength = cpu_to_le32(flagslength);
880 pSge->Address.Low = cpu_to_le32(tmp);
881 tmp = (u32) ((u64)dma_addr >> 32);
882 pSge->Address.High = cpu_to_le32(tmp);
885 SGESimple32_t *pSge = (SGESimple32_t *) pAddr;
886 pSge->FlagsLength = cpu_to_le32(flagslength);
887 pSge->Address = cpu_to_le32(dma_addr);
891 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
893 * mpt_send_handshake_request - Send MPT request via doorbell
895 * @handle: Handle of registered MPT protocol driver
896 * @ioc: Pointer to MPT adapter structure
897 * @reqBytes: Size of the request in bytes
898 * @req: Pointer to MPT request frame
899 * @sleepFlag: Use schedule if CAN_SLEEP else use udelay.
901 * This routine is used exclusively to send MptScsiTaskMgmt
902 * requests since they are required to be sent via doorbell handshake.
904 * NOTE: It is the callers responsibility to byte-swap fields in the
905 * request which are greater than 1 byte in size.
907 * Returns 0 for success, non-zero for failure.
910 mpt_send_handshake_request(int handle, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag)
916 /* State is known to be good upon entering
917 * this function so issue the bus reset
922 * Emulate what mpt_put_msg_frame() does /wrt to sanity
923 * setting cb_idx/req_idx. But ONLY if this request
924 * is in proper (pre-alloc'd) request buffer range...
926 ii = MFPTR_2_MPT_INDEX(ioc,(MPT_FRAME_HDR*)req);
927 if (reqBytes >= 12 && ii >= 0 && ii < ioc->req_depth) {
928 MPT_FRAME_HDR *mf = (MPT_FRAME_HDR*)req;
929 mf->u.frame.hwhdr.msgctxu.fld.req_idx = cpu_to_le16(ii);
930 mf->u.frame.hwhdr.msgctxu.fld.cb_idx = handle;
933 /* Make sure there are no doorbells */
934 CHIPREG_WRITE32(&ioc->chip->IntStatus, 0);
936 CHIPREG_WRITE32(&ioc->chip->Doorbell,
937 ((MPI_FUNCTION_HANDSHAKE<<MPI_DOORBELL_FUNCTION_SHIFT) |
938 ((reqBytes/4)<<MPI_DOORBELL_ADD_DWORDS_SHIFT)));
940 /* Wait for IOC doorbell int */
941 if ((ii = WaitForDoorbellInt(ioc, 5, sleepFlag)) < 0) {
945 /* Read doorbell and check for active bit */
946 if (!(CHIPREG_READ32(&ioc->chip->Doorbell) & MPI_DOORBELL_ACTIVE))
949 dhsprintk((KERN_INFO MYNAM ": %s: mpt_send_handshake_request start, WaitCnt=%d\n",
952 CHIPREG_WRITE32(&ioc->chip->IntStatus, 0);
954 if ((r = WaitForDoorbellAck(ioc, 5, sleepFlag)) < 0) {
958 /* Send request via doorbell handshake */
959 req_as_bytes = (u8 *) req;
960 for (ii = 0; ii < reqBytes/4; ii++) {
963 word = ((req_as_bytes[(ii*4) + 0] << 0) |
964 (req_as_bytes[(ii*4) + 1] << 8) |
965 (req_as_bytes[(ii*4) + 2] << 16) |
966 (req_as_bytes[(ii*4) + 3] << 24));
967 CHIPREG_WRITE32(&ioc->chip->Doorbell, word);
968 if ((r = WaitForDoorbellAck(ioc, 5, sleepFlag)) < 0) {
974 if (r >= 0 && WaitForDoorbellInt(ioc, 10, sleepFlag) >= 0)
979 /* Make sure there are no doorbells */
980 CHIPREG_WRITE32(&ioc->chip->IntStatus, 0);
985 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
987 * mpt_host_page_access_control - provides mechanism for the host
988 * driver to control the IOC's Host Page Buffer access.
989 * @ioc: Pointer to MPT adapter structure
990 * @access_control_value: define bits below
992 * Access Control Value - bits[15:12]
994 * 1h Enable Access { MPI_DB_HPBAC_ENABLE_ACCESS }
995 * 2h Disable Access { MPI_DB_HPBAC_DISABLE_ACCESS }
996 * 3h Free Buffer { MPI_DB_HPBAC_FREE_BUFFER }
998 * Returns 0 for success, non-zero for failure.
1002 mpt_host_page_access_control(MPT_ADAPTER *ioc, u8 access_control_value, int sleepFlag)
1006 /* return if in use */
1007 if (CHIPREG_READ32(&ioc->chip->Doorbell)
1008 & MPI_DOORBELL_ACTIVE)
1011 CHIPREG_WRITE32(&ioc->chip->IntStatus, 0);
1013 CHIPREG_WRITE32(&ioc->chip->Doorbell,
1014 ((MPI_FUNCTION_HOST_PAGEBUF_ACCESS_CONTROL
1015 <<MPI_DOORBELL_FUNCTION_SHIFT) |
1016 (access_control_value<<12)));
1018 /* Wait for IOC to clear Doorbell Status bit */
1019 if ((r = WaitForDoorbellAck(ioc, 5, sleepFlag)) < 0) {
1025 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1027 * mpt_host_page_alloc - allocate system memory for the fw
1028 * If we already allocated memory in past, then resend the same pointer.
1029 * ioc@: Pointer to pointer to IOC adapter
1030 * ioc_init@: Pointer to ioc init config page
1032 * Returns 0 for success, non-zero for failure.
1035 mpt_host_page_alloc(MPT_ADAPTER *ioc, pIOCInit_t ioc_init)
1039 u32 host_page_buffer_sz=0;
1041 if(!ioc->HostPageBuffer) {
1043 host_page_buffer_sz =
1044 le32_to_cpu(ioc->facts.HostPageBufferSGE.FlagsLength) & 0xFFFFFF;
1046 if(!host_page_buffer_sz)
1047 return 0; /* fw doesn't need any host buffers */
1049 /* spin till we get enough memory */
1050 while(host_page_buffer_sz > 0) {
1052 if((ioc->HostPageBuffer = pci_alloc_consistent(
1054 host_page_buffer_sz,
1055 &ioc->HostPageBuffer_dma)) != NULL) {
1057 dinitprintk((MYIOC_s_INFO_FMT
1058 "host_page_buffer @ %p, dma @ %x, sz=%d bytes\n",
1060 ioc->HostPageBuffer,
1061 ioc->HostPageBuffer_dma,
1062 host_page_buffer_sz));
1063 ioc->alloc_total += host_page_buffer_sz;
1064 ioc->HostPageBuffer_sz = host_page_buffer_sz;
1068 host_page_buffer_sz -= (4*1024);
1072 if(!ioc->HostPageBuffer) {
1073 printk(MYIOC_s_ERR_FMT
1074 "Failed to alloc memory for host_page_buffer!\n",
1079 psge = (char *)&ioc_init->HostPageBufferSGE;
1080 flags_length = MPI_SGE_FLAGS_SIMPLE_ELEMENT |
1081 MPI_SGE_FLAGS_SYSTEM_ADDRESS |
1082 MPI_SGE_FLAGS_32_BIT_ADDRESSING |
1083 MPI_SGE_FLAGS_HOST_TO_IOC |
1084 MPI_SGE_FLAGS_END_OF_BUFFER;
1085 if (sizeof(dma_addr_t) == sizeof(u64)) {
1086 flags_length |= MPI_SGE_FLAGS_64_BIT_ADDRESSING;
1088 flags_length = flags_length << MPI_SGE_FLAGS_SHIFT;
1089 flags_length |= ioc->HostPageBuffer_sz;
1090 mpt_add_sge(psge, flags_length, ioc->HostPageBuffer_dma);
1091 ioc->facts.HostPageBufferSGE = ioc_init->HostPageBufferSGE;
1096 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1098 * mpt_verify_adapter - Given a unique IOC identifier, set pointer to
1099 * the associated MPT adapter structure.
1100 * @iocid: IOC unique identifier (integer)
1101 * @iocpp: Pointer to pointer to IOC adapter
1103 * Returns iocid and sets iocpp.
1106 mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp)
1110 list_for_each_entry(ioc,&ioc_list,list) {
1111 if (ioc->id == iocid) {
1122 mpt_alt_ioc_wait(MPT_ADAPTER *ioc)
1124 int loop_count = 30 * 4; /* Wait 30 seconds */
1125 int status = -1; /* -1 means failed to get board READY */
1128 spin_lock(&ioc->initializing_hba_lock);
1129 if (ioc->initializing_hba_lock_flag == 0) {
1130 ioc->initializing_hba_lock_flag=1;
1131 spin_unlock(&ioc->initializing_hba_lock);
1135 spin_unlock(&ioc->initializing_hba_lock);
1136 set_current_state(TASK_INTERRUPTIBLE);
1137 schedule_timeout(HZ/4);
1138 } while (--loop_count);
1143 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1145 * mpt_bringup_adapter - This is a wrapper function for mpt_do_ioc_recovery
1146 * @ioc: Pointer to MPT adapter structure
1147 * @sleepFlag: Use schedule if CAN_SLEEP else use udelay.
1149 * This routine performs all the steps necessary to bring the IOC
1150 * to a OPERATIONAL state.
1152 * Special Note: This function was added with spin lock's so as to allow
1153 * the dv(domain validation) work thread to succeed on the other channel
1154 * that maybe occuring at the same time when this function is called.
1155 * Without this lock, the dv would fail when message frames were
1156 * requested during hba bringup on the alternate ioc.
1159 mpt_bringup_adapter(MPT_ADAPTER *ioc, int sleepFlag)
1164 if((r=mpt_alt_ioc_wait(ioc->alt_ioc)!=0))
1168 r = mpt_do_ioc_recovery(ioc, MPT_HOSTEVENT_IOC_BRINGUP,
1172 spin_lock(&ioc->alt_ioc->initializing_hba_lock);
1173 ioc->alt_ioc->initializing_hba_lock_flag=0;
1174 spin_unlock(&ioc->alt_ioc->initializing_hba_lock);
1180 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1182 * mpt_attach - Install a PCI intelligent MPT adapter.
1183 * @pdev: Pointer to pci_dev structure
1185 * This routine performs all the steps necessary to bring the IOC of
1186 * a MPT adapter to a OPERATIONAL state. This includes registering
1187 * memory regions, registering the interrupt, and allocating request
1188 * and reply memory pools.
1190 * This routine also pre-fetches the LAN MAC address of a Fibre Channel
1193 * Returns 0 for success, non-zero for failure.
1195 * TODO: Add support for polled controllers
1198 mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id)
1202 unsigned long mem_phys;
1210 static int mpt_ids = 0;
1211 #ifdef CONFIG_PROC_FS
1212 struct proc_dir_entry *dent, *ent;
1215 if (pci_enable_device(pdev))
1218 dinitprintk((KERN_WARNING MYNAM ": mpt_adapter_install\n"));
1220 if (!pci_set_dma_mask(pdev, DMA_64BIT_MASK)) {
1221 dprintk((KERN_INFO MYNAM
1222 ": 64 BIT PCI BUS DMA ADDRESSING SUPPORTED\n"));
1223 } else if (pci_set_dma_mask(pdev, DMA_32BIT_MASK)) {
1224 printk(KERN_WARNING MYNAM ": 32 BIT PCI BUS DMA ADDRESSING NOT SUPPORTED\n");
1228 if (!pci_set_consistent_dma_mask(pdev, DMA_64BIT_MASK))
1229 dprintk((KERN_INFO MYNAM
1230 ": Using 64 bit consistent mask\n"));
1232 dprintk((KERN_INFO MYNAM
1233 ": Not using 64 bit consistent mask\n"));
1235 ioc = kmalloc(sizeof(MPT_ADAPTER), GFP_ATOMIC);
1237 printk(KERN_ERR MYNAM ": ERROR - Insufficient memory to add adapter!\n");
1240 memset(ioc, 0, sizeof(MPT_ADAPTER));
1241 ioc->alloc_total = sizeof(MPT_ADAPTER);
1242 ioc->req_sz = MPT_DEFAULT_FRAME_SIZE; /* avoid div by zero! */
1243 ioc->reply_sz = MPT_REPLY_FRAME_SIZE;
1246 ioc->diagPending = 0;
1247 spin_lock_init(&ioc->diagLock);
1248 spin_lock_init(&ioc->initializing_hba_lock);
1250 /* Initialize the event logging.
1252 ioc->eventTypes = 0; /* None */
1253 ioc->eventContext = 0;
1254 ioc->eventLogSize = 0;
1261 ioc->cached_fw = NULL;
1263 /* Initilize SCSI Config Data structure
1265 memset(&ioc->spi_data, 0, sizeof(SpiCfgData));
1267 /* Initialize the running configQ head.
1269 INIT_LIST_HEAD(&ioc->configQ);
1271 /* Find lookup slot. */
1272 INIT_LIST_HEAD(&ioc->list);
1273 ioc->id = mpt_ids++;
1275 mem_phys = msize = 0;
1277 for (ii=0; ii < DEVICE_COUNT_RESOURCE; ii++) {
1278 if (pci_resource_flags(pdev, ii) & PCI_BASE_ADDRESS_SPACE_IO) {
1279 /* Get I/O space! */
1280 port = pci_resource_start(pdev, ii);
1281 psize = pci_resource_len(pdev,ii);
1284 mem_phys = pci_resource_start(pdev, ii);
1285 msize = pci_resource_len(pdev,ii);
1289 ioc->mem_size = msize;
1291 if (ii == DEVICE_COUNT_RESOURCE) {
1292 printk(KERN_ERR MYNAM ": ERROR - MPT adapter has no memory regions defined!\n");
1297 dinitprintk((KERN_INFO MYNAM ": MPT adapter @ %lx, msize=%dd bytes\n", mem_phys, msize));
1298 dinitprintk((KERN_INFO MYNAM ": (port i/o @ %lx, psize=%dd bytes)\n", port, psize));
1301 /* Get logical ptr for PciMem0 space */
1302 /*mem = ioremap(mem_phys, msize);*/
1303 mem = ioremap(mem_phys, 0x100);
1305 printk(KERN_ERR MYNAM ": ERROR - Unable to map adapter memory!\n");
1310 dinitprintk((KERN_INFO MYNAM ": mem = %p, mem_phys = %lx\n", mem, mem_phys));
1312 dinitprintk((KERN_INFO MYNAM ": facts @ %p, pfacts[0] @ %p\n",
1313 &ioc->facts, &ioc->pfacts[0]));
1315 ioc->mem_phys = mem_phys;
1316 ioc->chip = (SYSIF_REGS __iomem *)mem;
1318 /* Save Port IO values in case we need to do downloadboot */
1320 u8 *pmem = (u8*)port;
1321 ioc->pio_mem_phys = port;
1322 ioc->pio_chip = (SYSIF_REGS __iomem *)pmem;
1325 if (pdev->device == MPI_MANUFACTPAGE_DEVICEID_FC909) {
1326 ioc->prod_name = "LSIFC909";
1329 else if (pdev->device == MPI_MANUFACTPAGE_DEVICEID_FC929) {
1330 ioc->prod_name = "LSIFC929";
1333 else if (pdev->device == MPI_MANUFACTPAGE_DEVICEID_FC919) {
1334 ioc->prod_name = "LSIFC919";
1337 else if (pdev->device == MPI_MANUFACTPAGE_DEVICEID_FC929X) {
1338 pci_read_config_byte(pdev, PCI_CLASS_REVISION, &revision);
1340 if (revision < XL_929) {
1341 ioc->prod_name = "LSIFC929X";
1342 /* 929X Chip Fix. Set Split transactions level
1343 * for PCIX. Set MOST bits to zero.
1345 pci_read_config_byte(pdev, 0x6a, &pcixcmd);
1347 pci_write_config_byte(pdev, 0x6a, pcixcmd);
1349 ioc->prod_name = "LSIFC929XL";
1350 /* 929XL Chip Fix. Set MMRBC to 0x08.
1352 pci_read_config_byte(pdev, 0x6a, &pcixcmd);
1354 pci_write_config_byte(pdev, 0x6a, pcixcmd);
1357 else if (pdev->device == MPI_MANUFACTPAGE_DEVICEID_FC919X) {
1358 ioc->prod_name = "LSIFC919X";
1360 /* 919X Chip Fix. Set Split transactions level
1361 * for PCIX. Set MOST bits to zero.
1363 pci_read_config_byte(pdev, 0x6a, &pcixcmd);
1365 pci_write_config_byte(pdev, 0x6a, pcixcmd);
1367 else if (pdev->device == MPI_MANUFACTPAGE_DEVICEID_FC939X) {
1368 ioc->prod_name = "LSIFC939X";
1370 ioc->errata_flag_1064 = 1;
1372 else if (pdev->device == MPI_MANUFACTPAGE_DEVICEID_FC949X) {
1373 ioc->prod_name = "LSIFC949X";
1375 ioc->errata_flag_1064 = 1;
1377 else if (pdev->device == MPI_MANUFACTPAGE_DEVID_53C1030) {
1378 ioc->prod_name = "LSI53C1030";
1379 ioc->bus_type = SPI;
1380 /* 1030 Chip Fix. Disable Split transactions
1381 * for PCIX. Set MOST bits to zero if Rev < C0( = 8).
1383 pci_read_config_byte(pdev, PCI_CLASS_REVISION, &revision);
1384 if (revision < C0_1030) {
1385 pci_read_config_byte(pdev, 0x6a, &pcixcmd);
1387 pci_write_config_byte(pdev, 0x6a, pcixcmd);
1390 else if (pdev->device == MPI_MANUFACTPAGE_DEVID_1030_53C1035) {
1391 ioc->prod_name = "LSI53C1035";
1392 ioc->bus_type = SPI;
1394 else if (pdev->device == MPI_MANUFACTPAGE_DEVID_SAS1064) {
1395 ioc->prod_name = "LSISAS1064";
1396 ioc->bus_type = SAS;
1397 ioc->errata_flag_1064 = 1;
1399 else if (pdev->device == MPI_MANUFACTPAGE_DEVID_SAS1066) {
1400 ioc->prod_name = "LSISAS1066";
1401 ioc->bus_type = SAS;
1402 ioc->errata_flag_1064 = 1;
1404 else if (pdev->device == MPI_MANUFACTPAGE_DEVID_SAS1068) {
1405 ioc->prod_name = "LSISAS1068";
1406 ioc->bus_type = SAS;
1407 ioc->errata_flag_1064 = 1;
1409 else if (pdev->device == MPI_MANUFACTPAGE_DEVID_SAS1064E) {
1410 ioc->prod_name = "LSISAS1064E";
1411 ioc->bus_type = SAS;
1413 else if (pdev->device == MPI_MANUFACTPAGE_DEVID_SAS1066E) {
1414 ioc->prod_name = "LSISAS1066E";
1415 ioc->bus_type = SAS;
1417 else if (pdev->device == MPI_MANUFACTPAGE_DEVID_SAS1068E) {
1418 ioc->prod_name = "LSISAS1068E";
1419 ioc->bus_type = SAS;
1422 if (ioc->errata_flag_1064)
1423 pci_disable_io_access(pdev);
1425 sprintf(ioc->name, "ioc%d", ioc->id);
1427 spin_lock_init(&ioc->FreeQlock);
1430 CHIPREG_WRITE32(&ioc->chip->IntMask, 0xFFFFFFFF);
1432 CHIPREG_WRITE32(&ioc->chip->IntStatus, 0);
1434 /* Set lookup ptr. */
1435 list_add_tail(&ioc->list, &ioc_list);
1439 r = request_irq(pdev->irq, mpt_interrupt, SA_SHIRQ, ioc->name, ioc);
1443 printk(MYIOC_s_ERR_FMT "Unable to allocate interrupt %d!\n",
1444 ioc->name, pdev->irq);
1446 printk(MYIOC_s_ERR_FMT "Unable to allocate interrupt %s!\n",
1447 ioc->name, __irq_itoa(pdev->irq));
1449 list_del(&ioc->list);
1455 ioc->pci_irq = pdev->irq;
1457 pci_set_master(pdev); /* ?? */
1458 pci_set_drvdata(pdev, ioc);
1461 dprintk((KERN_INFO MYNAM ": %s installed at interrupt %d\n", ioc->name, pdev->irq));
1463 dprintk((KERN_INFO MYNAM ": %s installed at interrupt %s\n", ioc->name, __irq_itoa(pdev->irq)));
1467 /* Check for "bound ports" (929, 929X, 1030, 1035) to reduce redundant resets.
1469 mpt_detect_bound_ports(ioc, pdev);
1471 if ((r = mpt_bringup_adapter(ioc, CAN_SLEEP)) != 0){
1472 printk(KERN_WARNING MYNAM
1473 ": WARNING - %s did not initialize properly! (%d)\n",
1476 list_del(&ioc->list);
1477 free_irq(ioc->pci_irq, ioc);
1480 pci_set_drvdata(pdev, NULL);
1484 /* call per device driver probe entry point */
1485 for(ii=0; ii<MPT_MAX_PROTOCOL_DRIVERS; ii++) {
1486 if(MptDeviceDriverHandlers[ii] &&
1487 MptDeviceDriverHandlers[ii]->probe) {
1488 MptDeviceDriverHandlers[ii]->probe(pdev,id);
1492 #ifdef CONFIG_PROC_FS
1494 * Create "/proc/mpt/iocN" subdirectory entry for each MPT adapter.
1496 dent = proc_mkdir(ioc->name, mpt_proc_root_dir);
1498 ent = create_proc_entry("info", S_IFREG|S_IRUGO, dent);
1500 ent->read_proc = procmpt_iocinfo_read;
1503 ent = create_proc_entry("summary", S_IFREG|S_IRUGO, dent);
1505 ent->read_proc = procmpt_summary_read;
1514 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1516 * mpt_detach - Remove a PCI intelligent MPT adapter.
1517 * @pdev: Pointer to pci_dev structure
1522 mpt_detach(struct pci_dev *pdev)
1524 MPT_ADAPTER *ioc = pci_get_drvdata(pdev);
1528 sprintf(pname, MPT_PROCFS_MPTBASEDIR "/%s/summary", ioc->name);
1529 remove_proc_entry(pname, NULL);
1530 sprintf(pname, MPT_PROCFS_MPTBASEDIR "/%s/info", ioc->name);
1531 remove_proc_entry(pname, NULL);
1532 sprintf(pname, MPT_PROCFS_MPTBASEDIR "/%s", ioc->name);
1533 remove_proc_entry(pname, NULL);
1535 /* call per device driver remove entry point */
1536 for(ii=0; ii<MPT_MAX_PROTOCOL_DRIVERS; ii++) {
1537 if(MptDeviceDriverHandlers[ii] &&
1538 MptDeviceDriverHandlers[ii]->remove) {
1539 MptDeviceDriverHandlers[ii]->remove(pdev);
1543 /* Disable interrupts! */
1544 CHIPREG_WRITE32(&ioc->chip->IntMask, 0xFFFFFFFF);
1547 synchronize_irq(pdev->irq);
1549 /* Clear any lingering interrupt */
1550 CHIPREG_WRITE32(&ioc->chip->IntStatus, 0);
1552 CHIPREG_READ32(&ioc->chip->IntStatus);
1554 mpt_adapter_dispose(ioc);
1556 pci_set_drvdata(pdev, NULL);
1559 /**************************************************************************
1563 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1565 * mpt_suspend - Fusion MPT base driver suspend routine.
1570 mpt_suspend(struct pci_dev *pdev, pm_message_t state)
1573 MPT_ADAPTER *ioc = pci_get_drvdata(pdev);
1575 device_state=pci_choose_state(pdev, state);
1577 printk(MYIOC_s_INFO_FMT
1578 "pci-suspend: pdev=0x%p, slot=%s, Entering operating state [D%d]\n",
1579 ioc->name, pdev, pci_name(pdev), device_state);
1581 pci_save_state(pdev);
1583 /* put ioc into READY_STATE */
1584 if(SendIocReset(ioc, MPI_FUNCTION_IOC_MESSAGE_UNIT_RESET, CAN_SLEEP)) {
1585 printk(MYIOC_s_ERR_FMT
1586 "pci-suspend: IOC msg unit reset failed!\n", ioc->name);
1589 /* disable interrupts */
1590 CHIPREG_WRITE32(&ioc->chip->IntMask, 0xFFFFFFFF);
1593 /* Clear any lingering interrupt */
1594 CHIPREG_WRITE32(&ioc->chip->IntStatus, 0);
1596 pci_disable_device(pdev);
1597 pci_set_power_state(pdev, device_state);
1602 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1604 * mpt_resume - Fusion MPT base driver resume routine.
1609 mpt_resume(struct pci_dev *pdev)
1611 MPT_ADAPTER *ioc = pci_get_drvdata(pdev);
1612 u32 device_state = pdev->current_state;
1616 printk(MYIOC_s_INFO_FMT
1617 "pci-resume: pdev=0x%p, slot=%s, Previous operating state [D%d]\n",
1618 ioc->name, pdev, pci_name(pdev), device_state);
1620 pci_set_power_state(pdev, 0);
1621 pci_restore_state(pdev);
1622 pci_enable_device(pdev);
1624 /* enable interrupts */
1625 CHIPREG_WRITE32(&ioc->chip->IntMask, ~(MPI_HIM_RIM));
1628 /* F/W not running */
1629 if(!CHIPREG_READ32(&ioc->chip->Doorbell)) {
1630 /* enable domain validation flags */
1631 for (ii=0; ii < MPT_MAX_SCSI_DEVICES; ii++) {
1632 ioc->spi_data.dvStatus[ii] |= MPT_SCSICFG_NEED_DV;
1636 printk(MYIOC_s_INFO_FMT
1637 "pci-resume: ioc-state=0x%x,doorbell=0x%x\n",
1639 (mpt_GetIocState(ioc, 1) >> MPI_IOC_STATE_SHIFT),
1640 CHIPREG_READ32(&ioc->chip->Doorbell));
1642 /* bring ioc to operational state */
1643 if ((recovery_state = mpt_do_ioc_recovery(ioc,
1644 MPT_HOSTEVENT_IOC_RECOVER, CAN_SLEEP)) != 0) {
1645 printk(MYIOC_s_INFO_FMT
1646 "pci-resume: Cannot recover, error:[%x]\n",
1647 ioc->name, recovery_state);
1649 printk(MYIOC_s_INFO_FMT
1650 "pci-resume: success\n", ioc->name);
1657 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1659 * mpt_do_ioc_recovery - Initialize or recover MPT adapter.
1660 * @ioc: Pointer to MPT adapter structure
1661 * @reason: Event word / reason
1662 * @sleepFlag: Use schedule if CAN_SLEEP else use udelay.
1664 * This routine performs all the steps necessary to bring the IOC
1665 * to a OPERATIONAL state.
1667 * This routine also pre-fetches the LAN MAC address of a Fibre Channel
1672 * -1 if failed to get board READY
1673 * -2 if READY but IOCFacts Failed
1674 * -3 if READY but PrimeIOCFifos Failed
1675 * -4 if READY but IOCInit Failed
1678 mpt_do_ioc_recovery(MPT_ADAPTER *ioc, u32 reason, int sleepFlag)
1680 int hard_reset_done = 0;
1681 int alt_ioc_ready = 0;
1687 int reset_alt_ioc_active = 0;
1689 printk(KERN_INFO MYNAM ": Initiating %s %s\n",
1690 ioc->name, reason==MPT_HOSTEVENT_IOC_BRINGUP ? "bringup" : "recovery");
1692 /* Disable reply interrupts (also blocks FreeQ) */
1693 CHIPREG_WRITE32(&ioc->chip->IntMask, 0xFFFFFFFF);
1697 if (ioc->alt_ioc->active)
1698 reset_alt_ioc_active = 1;
1700 /* Disable alt-IOC's reply interrupts (and FreeQ) for a bit ... */
1701 CHIPREG_WRITE32(&ioc->alt_ioc->chip->IntMask, 0xFFFFFFFF);
1702 ioc->alt_ioc->active = 0;
1706 if (reason == MPT_HOSTEVENT_IOC_BRINGUP)
1709 if ((hard_reset_done = MakeIocReady(ioc, hard, sleepFlag)) < 0) {
1710 if (hard_reset_done == -4) {
1711 printk(KERN_WARNING MYNAM ": %s Owned by PEER..skipping!\n",
1714 if (reset_alt_ioc_active && ioc->alt_ioc) {
1715 /* (re)Enable alt-IOC! (reply interrupt, FreeQ) */
1716 dprintk((KERN_INFO MYNAM ": alt-%s reply irq re-enabled\n",
1717 ioc->alt_ioc->name));
1718 CHIPREG_WRITE32(&ioc->alt_ioc->chip->IntMask, ~(MPI_HIM_RIM));
1719 ioc->alt_ioc->active = 1;
1723 printk(KERN_WARNING MYNAM ": %s NOT READY WARNING!\n",
1729 /* hard_reset_done = 0 if a soft reset was performed
1730 * and 1 if a hard reset was performed.
1732 if (hard_reset_done && reset_alt_ioc_active && ioc->alt_ioc) {
1733 if ((rc = MakeIocReady(ioc->alt_ioc, 0, sleepFlag)) == 0)
1736 printk(KERN_WARNING MYNAM
1737 ": alt-%s: Not ready WARNING!\n",
1738 ioc->alt_ioc->name);
1741 for (ii=0; ii<5; ii++) {
1742 /* Get IOC facts! Allow 5 retries */
1743 if ((rc = GetIocFacts(ioc, sleepFlag, reason)) == 0)
1749 dinitprintk((MYIOC_s_INFO_FMT "Retry IocFacts failed rc=%x\n", ioc->name, rc));
1751 } else if (reason == MPT_HOSTEVENT_IOC_BRINGUP) {
1752 MptDisplayIocCapabilities(ioc);
1755 if (alt_ioc_ready) {
1756 if ((rc = GetIocFacts(ioc->alt_ioc, sleepFlag, reason)) != 0) {
1757 dinitprintk((MYIOC_s_INFO_FMT "Initial Alt IocFacts failed rc=%x\n", ioc->name, rc));
1758 /* Retry - alt IOC was initialized once
1760 rc = GetIocFacts(ioc->alt_ioc, sleepFlag, reason);
1763 dinitprintk((MYIOC_s_INFO_FMT "Retry Alt IocFacts failed rc=%x\n", ioc->name, rc));
1765 reset_alt_ioc_active = 0;
1766 } else if (reason == MPT_HOSTEVENT_IOC_BRINGUP) {
1767 MptDisplayIocCapabilities(ioc->alt_ioc);
1771 /* Prime reply & request queues!
1772 * (mucho alloc's) Must be done prior to
1773 * init as upper addresses are needed for init.
1774 * If fails, continue with alt-ioc processing
1776 if ((ret == 0) && ((rc = PrimeIocFifos(ioc)) != 0))
1779 /* May need to check/upload firmware & data here!
1780 * If fails, continue with alt-ioc processing
1782 if ((ret == 0) && ((rc = SendIocInit(ioc, sleepFlag)) != 0))
1785 if (alt_ioc_ready && ((rc = PrimeIocFifos(ioc->alt_ioc)) != 0)) {
1786 printk(KERN_WARNING MYNAM ": alt-%s: (%d) FIFO mgmt alloc WARNING!\n",
1787 ioc->alt_ioc->name, rc);
1789 reset_alt_ioc_active = 0;
1792 if (alt_ioc_ready) {
1793 if ((rc = SendIocInit(ioc->alt_ioc, sleepFlag)) != 0) {
1795 reset_alt_ioc_active = 0;
1796 printk(KERN_WARNING MYNAM
1797 ": alt-%s: (%d) init failure WARNING!\n",
1798 ioc->alt_ioc->name, rc);
1802 if (reason == MPT_HOSTEVENT_IOC_BRINGUP){
1803 if (ioc->upload_fw) {
1804 ddlprintk((MYIOC_s_INFO_FMT
1805 "firmware upload required!\n", ioc->name));
1807 /* Controller is not operational, cannot do upload
1810 rc = mpt_do_upload(ioc, sleepFlag);
1812 if (ioc->alt_ioc && ioc->alt_ioc->cached_fw) {
1814 * Maintain only one pointer to FW memory
1815 * so there will not be two attempt to
1816 * downloadboot onboard dual function
1817 * chips (mpt_adapter_disable,
1820 ioc->cached_fw = NULL;
1821 ddlprintk((MYIOC_s_INFO_FMT ": mpt_upload: alt_%s has cached_fw=%p \n",
1822 ioc->name, ioc->alt_ioc->name, ioc->alt_ioc->cached_fw));
1825 printk(KERN_WARNING MYNAM ": firmware upload failure!\n");
1833 /* Enable! (reply interrupt) */
1834 CHIPREG_WRITE32(&ioc->chip->IntMask, ~(MPI_HIM_RIM));
1838 if (reset_alt_ioc_active && ioc->alt_ioc) {
1839 /* (re)Enable alt-IOC! (reply interrupt) */
1840 dinitprintk((KERN_INFO MYNAM ": alt-%s reply irq re-enabled\n",
1841 ioc->alt_ioc->name));
1842 CHIPREG_WRITE32(&ioc->alt_ioc->chip->IntMask, ~(MPI_HIM_RIM));
1843 ioc->alt_ioc->active = 1;
1846 /* Enable MPT base driver management of EventNotification
1847 * and EventAck handling.
1849 if ((ret == 0) && (!ioc->facts.EventState))
1850 (void) SendEventNotification(ioc, 1); /* 1=Enable EventNotification */
1852 if (ioc->alt_ioc && alt_ioc_ready && !ioc->alt_ioc->facts.EventState)
1853 (void) SendEventNotification(ioc->alt_ioc, 1); /* 1=Enable EventNotification */
1855 /* Add additional "reason" check before call to GetLanConfigPages
1856 * (combined with GetIoUnitPage2 call). This prevents a somewhat
1857 * recursive scenario; GetLanConfigPages times out, timer expired
1858 * routine calls HardResetHandler, which calls into here again,
1859 * and we try GetLanConfigPages again...
1861 if ((ret == 0) && (reason == MPT_HOSTEVENT_IOC_BRINGUP)) {
1862 if (ioc->bus_type == SAS) {
1864 /* clear persistency table */
1865 if(ioc->facts.IOCExceptions &
1866 MPI_IOCFACTS_EXCEPT_PERSISTENT_TABLE_FULL) {
1867 ret = mptbase_sas_persist_operation(ioc,
1868 MPI_SAS_OP_CLEAR_NOT_PRESENT);
1875 mpt_findImVolumes(ioc);
1877 } else if (ioc->bus_type == FC) {
1879 * Pre-fetch FC port WWN and stuff...
1880 * (FCPortPage0_t stuff)
1882 for (ii=0; ii < ioc->facts.NumberOfPorts; ii++) {
1883 (void) GetFcPortPage0(ioc, ii);
1886 if ((ioc->pfacts[0].ProtocolFlags & MPI_PORTFACTS_PROTOCOL_LAN) &&
1887 (ioc->lan_cnfg_page0.Header.PageLength == 0)) {
1889 * Pre-fetch the ports LAN MAC address!
1890 * (LANPage1_t stuff)
1892 (void) GetLanConfigPages(ioc);
1895 u8 *a = (u8*)&ioc->lan_cnfg_page1.HardwareAddressLow;
1896 dprintk((MYIOC_s_INFO_FMT "LanAddr = %02X:%02X:%02X:%02X:%02X:%02X\n",
1897 ioc->name, a[5], a[4], a[3], a[2], a[1], a[0] ));
1902 /* Get NVRAM and adapter maximums from SPP 0 and 2
1904 mpt_GetScsiPortSettings(ioc, 0);
1906 /* Get version and length of SDP 1
1908 mpt_readScsiDevicePageHeaders(ioc, 0);
1912 if (ioc->facts.MsgVersion >= MPI_VERSION_01_02)
1913 mpt_findImVolumes(ioc);
1915 /* Check, and possibly reset, the coalescing value
1917 mpt_read_ioc_pg_1(ioc);
1919 mpt_read_ioc_pg_4(ioc);
1922 GetIoUnitPage2(ioc);
1926 * Call each currently registered protocol IOC reset handler
1927 * with post-reset indication.
1928 * NOTE: If we're doing _IOC_BRINGUP, there can be no
1929 * MptResetHandlers[] registered yet.
1931 if (hard_reset_done) {
1933 for (ii=MPT_MAX_PROTOCOL_DRIVERS-1; ii; ii--) {
1934 if ((ret == 0) && MptResetHandlers[ii]) {
1935 dprintk((MYIOC_s_INFO_FMT "Calling IOC post_reset handler #%d\n",
1937 rc += (*(MptResetHandlers[ii]))(ioc, MPT_IOC_POST_RESET);
1941 if (alt_ioc_ready && MptResetHandlers[ii]) {
1942 drsprintk((MYIOC_s_INFO_FMT "Calling alt-%s post_reset handler #%d\n",
1943 ioc->name, ioc->alt_ioc->name, ii));
1944 rc += (*(MptResetHandlers[ii]))(ioc->alt_ioc, MPT_IOC_POST_RESET);
1948 /* FIXME? Examine results here? */
1954 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1956 * mpt_detect_bound_ports - Search for PCI bus/dev_function
1957 * which matches PCI bus/dev_function (+/-1) for newly discovered 929,
1958 * 929X, 1030 or 1035.
1959 * @ioc: Pointer to MPT adapter structure
1960 * @pdev: Pointer to (struct pci_dev) structure
1962 * If match on PCI dev_function +/-1 is found, bind the two MPT adapters
1963 * using alt_ioc pointer fields in their %MPT_ADAPTER structures.
1966 mpt_detect_bound_ports(MPT_ADAPTER *ioc, struct pci_dev *pdev)
1968 struct pci_dev *peer=NULL;
1969 unsigned int slot = PCI_SLOT(pdev->devfn);
1970 unsigned int func = PCI_FUNC(pdev->devfn);
1971 MPT_ADAPTER *ioc_srch;
1973 dprintk((MYIOC_s_INFO_FMT "PCI device %s devfn=%x/%x,"
1974 " searching for devfn match on %x or %x\n",
1975 ioc->name, pci_name(pdev), pdev->bus->number,
1976 pdev->devfn, func-1, func+1));
1978 peer = pci_get_slot(pdev->bus, PCI_DEVFN(slot,func-1));
1980 peer = pci_get_slot(pdev->bus, PCI_DEVFN(slot,func+1));
1985 list_for_each_entry(ioc_srch, &ioc_list, list) {
1986 struct pci_dev *_pcidev = ioc_srch->pcidev;
1987 if (_pcidev == peer) {
1988 /* Paranoia checks */
1989 if (ioc->alt_ioc != NULL) {
1990 printk(KERN_WARNING MYNAM ": Oops, already bound (%s <==> %s)!\n",
1991 ioc->name, ioc->alt_ioc->name);
1993 } else if (ioc_srch->alt_ioc != NULL) {
1994 printk(KERN_WARNING MYNAM ": Oops, already bound (%s <==> %s)!\n",
1995 ioc_srch->name, ioc_srch->alt_ioc->name);
1998 dprintk((KERN_INFO MYNAM ": FOUND! binding %s <==> %s\n",
1999 ioc->name, ioc_srch->name));
2000 ioc_srch->alt_ioc = ioc;
2001 ioc->alt_ioc = ioc_srch;
2007 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
2009 * mpt_adapter_disable - Disable misbehaving MPT adapter.
2010 * @this: Pointer to MPT adapter structure
2013 mpt_adapter_disable(MPT_ADAPTER *ioc)
2018 if (ioc->cached_fw != NULL) {
2019 ddlprintk((KERN_INFO MYNAM ": mpt_adapter_disable: Pushing FW onto adapter\n"));
2020 if ((ret = mpt_downloadboot(ioc, (MpiFwHeader_t *)ioc->cached_fw, NO_SLEEP)) < 0) {
2021 printk(KERN_WARNING MYNAM
2022 ": firmware downloadboot failure (%d)!\n", ret);
2026 /* Disable adapter interrupts! */
2027 CHIPREG_WRITE32(&ioc->chip->IntMask, 0xFFFFFFFF);
2029 /* Clear any lingering interrupt */
2030 CHIPREG_WRITE32(&ioc->chip->IntStatus, 0);
2032 if (ioc->alloc != NULL) {
2034 dexitprintk((KERN_INFO MYNAM ": %s.free @ %p, sz=%d bytes\n",
2035 ioc->name, ioc->alloc, ioc->alloc_sz));
2036 pci_free_consistent(ioc->pcidev, sz,
2037 ioc->alloc, ioc->alloc_dma);
2038 ioc->reply_frames = NULL;
2039 ioc->req_frames = NULL;
2041 ioc->alloc_total -= sz;
2044 if (ioc->sense_buf_pool != NULL) {
2045 sz = (ioc->req_depth * MPT_SENSE_BUFFER_ALLOC);
2046 pci_free_consistent(ioc->pcidev, sz,
2047 ioc->sense_buf_pool, ioc->sense_buf_pool_dma);
2048 ioc->sense_buf_pool = NULL;
2049 ioc->alloc_total -= sz;
2052 if (ioc->events != NULL){
2053 sz = MPTCTL_EVENT_LOG_SIZE * sizeof(MPT_IOCTL_EVENTS);
2056 ioc->alloc_total -= sz;
2059 if (ioc->cached_fw != NULL) {
2060 sz = ioc->facts.FWImageSize;
2061 pci_free_consistent(ioc->pcidev, sz,
2062 ioc->cached_fw, ioc->cached_fw_dma);
2063 ioc->cached_fw = NULL;
2064 ioc->alloc_total -= sz;
2067 kfree(ioc->spi_data.nvram);
2068 kfree(ioc->raid_data.pIocPg3);
2069 ioc->spi_data.nvram = NULL;
2070 ioc->raid_data.pIocPg3 = NULL;
2072 if (ioc->spi_data.pIocPg4 != NULL) {
2073 sz = ioc->spi_data.IocPg4Sz;
2074 pci_free_consistent(ioc->pcidev, sz,
2075 ioc->spi_data.pIocPg4,
2076 ioc->spi_data.IocPg4_dma);
2077 ioc->spi_data.pIocPg4 = NULL;
2078 ioc->alloc_total -= sz;
2081 if (ioc->ReqToChain != NULL) {
2082 kfree(ioc->ReqToChain);
2083 kfree(ioc->RequestNB);
2084 ioc->ReqToChain = NULL;
2087 kfree(ioc->ChainToChain);
2088 ioc->ChainToChain = NULL;
2090 if (ioc->HostPageBuffer != NULL) {
2091 if((ret = mpt_host_page_access_control(ioc,
2092 MPI_DB_HPBAC_FREE_BUFFER, NO_SLEEP)) != 0) {
2093 printk(KERN_ERR MYNAM
2094 ": %s: host page buffers free failed (%d)!\n",
2097 dexitprintk((KERN_INFO MYNAM ": %s HostPageBuffer free @ %p, sz=%d bytes\n",
2098 ioc->name, ioc->HostPageBuffer, ioc->HostPageBuffer_sz));
2099 pci_free_consistent(ioc->pcidev, ioc->HostPageBuffer_sz,
2100 ioc->HostPageBuffer,
2101 ioc->HostPageBuffer_dma);
2102 ioc->HostPageBuffer = NULL;
2103 ioc->HostPageBuffer_sz = 0;
2104 ioc->alloc_total -= ioc->HostPageBuffer_sz;
2108 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
2110 * mpt_adapter_dispose - Free all resources associated with a MPT
2112 * @ioc: Pointer to MPT adapter structure
2114 * This routine unregisters h/w resources and frees all alloc'd memory
2115 * associated with a MPT adapter structure.
2118 mpt_adapter_dispose(MPT_ADAPTER *ioc)
2120 int sz_first, sz_last;
2125 sz_first = ioc->alloc_total;
2127 mpt_adapter_disable(ioc);
2129 if (ioc->pci_irq != -1) {
2130 free_irq(ioc->pci_irq, ioc);
2134 if (ioc->memmap != NULL) {
2135 iounmap(ioc->memmap);
2139 #if defined(CONFIG_MTRR) && 0
2140 if (ioc->mtrr_reg > 0) {
2141 mtrr_del(ioc->mtrr_reg, 0, 0);
2142 dprintk((KERN_INFO MYNAM ": %s: MTRR region de-registered\n", ioc->name));
2146 /* Zap the adapter lookup ptr! */
2147 list_del(&ioc->list);
2149 sz_last = ioc->alloc_total;
2150 dprintk((KERN_INFO MYNAM ": %s: free'd %d of %d bytes\n",
2151 ioc->name, sz_first-sz_last+(int)sizeof(*ioc), sz_first));
2155 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
2157 * MptDisplayIocCapabilities - Disply IOC's capacilities.
2158 * @ioc: Pointer to MPT adapter structure
2161 MptDisplayIocCapabilities(MPT_ADAPTER *ioc)
2165 printk(KERN_INFO "%s: ", ioc->name);
2166 if (ioc->prod_name && strlen(ioc->prod_name) > 3)
2167 printk("%s: ", ioc->prod_name+3);
2168 printk("Capabilities={");
2170 if (ioc->pfacts[0].ProtocolFlags & MPI_PORTFACTS_PROTOCOL_INITIATOR) {
2171 printk("Initiator");
2175 if (ioc->pfacts[0].ProtocolFlags & MPI_PORTFACTS_PROTOCOL_TARGET) {
2176 printk("%sTarget", i ? "," : "");
2180 if (ioc->pfacts[0].ProtocolFlags & MPI_PORTFACTS_PROTOCOL_LAN) {
2181 printk("%sLAN", i ? "," : "");
2187 * This would probably evoke more questions than it's worth
2189 if (ioc->pfacts[0].ProtocolFlags & MPI_PORTFACTS_PROTOCOL_TARGET) {
2190 printk("%sLogBusAddr", i ? "," : "");
2198 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
2200 * MakeIocReady - Get IOC to a READY state, using KickStart if needed.
2201 * @ioc: Pointer to MPT_ADAPTER structure
2202 * @force: Force hard KickStart of IOC
2203 * @sleepFlag: Specifies whether the process can sleep
2206 * 1 - DIAG reset and READY
2207 * 0 - READY initially OR soft reset and READY
2208 * -1 - Any failure on KickStart
2209 * -2 - Msg Unit Reset Failed
2210 * -3 - IO Unit Reset Failed
2211 * -4 - IOC owned by a PEER
2214 MakeIocReady(MPT_ADAPTER *ioc, int force, int sleepFlag)
2219 int hard_reset_done = 0;
2224 /* Get current [raw] IOC state */
2225 ioc_state = mpt_GetIocState(ioc, 0);
2226 dhsprintk((KERN_INFO MYNAM "::MakeIocReady, %s [raw] state=%08x\n", ioc->name, ioc_state));
2229 * Check to see if IOC got left/stuck in doorbell handshake
2230 * grip of death. If so, hard reset the IOC.
2232 if (ioc_state & MPI_DOORBELL_ACTIVE) {
2234 printk(MYIOC_s_WARN_FMT "Unexpected doorbell active!\n",
2238 /* Is it already READY? */
2239 if (!statefault && (ioc_state & MPI_IOC_STATE_MASK) == MPI_IOC_STATE_READY)
2243 * Check to see if IOC is in FAULT state.
2245 if ((ioc_state & MPI_IOC_STATE_MASK) == MPI_IOC_STATE_FAULT) {
2247 printk(MYIOC_s_WARN_FMT "IOC is in FAULT state!!!\n",
2249 printk(KERN_WARNING " FAULT code = %04xh\n",
2250 ioc_state & MPI_DOORBELL_DATA_MASK);
2254 * Hmmm... Did it get left operational?
2256 if ((ioc_state & MPI_IOC_STATE_MASK) == MPI_IOC_STATE_OPERATIONAL) {
2257 dinitprintk((MYIOC_s_INFO_FMT "IOC operational unexpected\n",
2261 * If PCI Peer, exit.
2262 * Else, if no fault conditions are present, issue a MessageUnitReset
2263 * Else, fall through to KickStart case
2265 whoinit = (ioc_state & MPI_DOORBELL_WHO_INIT_MASK) >> MPI_DOORBELL_WHO_INIT_SHIFT;
2266 dinitprintk((KERN_INFO MYNAM
2267 ": whoinit 0x%x statefault %d force %d\n",
2268 whoinit, statefault, force));
2269 if (whoinit == MPI_WHOINIT_PCI_PEER)
2272 if ((statefault == 0 ) && (force == 0)) {
2273 if ((r = SendIocReset(ioc, MPI_FUNCTION_IOC_MESSAGE_UNIT_RESET, sleepFlag)) == 0)
2280 hard_reset_done = KickStart(ioc, statefault||force, sleepFlag);
2281 if (hard_reset_done < 0)
2285 * Loop here waiting for IOC to come READY.
2288 cntdn = ((sleepFlag == CAN_SLEEP) ? HZ : 1000) * 5; /* 5 seconds */
2290 while ((ioc_state = mpt_GetIocState(ioc, 1)) != MPI_IOC_STATE_READY) {
2291 if (ioc_state == MPI_IOC_STATE_OPERATIONAL) {
2293 * BIOS or previous driver load left IOC in OP state.
2294 * Reset messaging FIFOs.
2296 if ((r = SendIocReset(ioc, MPI_FUNCTION_IOC_MESSAGE_UNIT_RESET, sleepFlag)) != 0) {
2297 printk(MYIOC_s_ERR_FMT "IOC msg unit reset failed!\n", ioc->name);
2300 } else if (ioc_state == MPI_IOC_STATE_RESET) {
2302 * Something is wrong. Try to get IOC back
2305 if ((r = SendIocReset(ioc, MPI_FUNCTION_IO_UNIT_RESET, sleepFlag)) != 0) {
2306 printk(MYIOC_s_ERR_FMT "IO unit reset failed!\n", ioc->name);
2313 printk(MYIOC_s_ERR_FMT "Wait IOC_READY state timeout(%d)!\n",
2314 ioc->name, (int)((ii+5)/HZ));
2318 if (sleepFlag == CAN_SLEEP) {
2319 msleep_interruptible(1);
2321 mdelay (1); /* 1 msec delay */
2326 if (statefault < 3) {
2327 printk(MYIOC_s_INFO_FMT "Recovered from %s\n",
2329 statefault==1 ? "stuck handshake" : "IOC FAULT");
2332 return hard_reset_done;
2335 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
2337 * mpt_GetIocState - Get the current state of a MPT adapter.
2338 * @ioc: Pointer to MPT_ADAPTER structure
2339 * @cooked: Request raw or cooked IOC state
2341 * Returns all IOC Doorbell register bits if cooked==0, else just the
2342 * Doorbell bits in MPI_IOC_STATE_MASK.
2345 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked)
2350 s = CHIPREG_READ32(&ioc->chip->Doorbell);
2351 // dprintk((MYIOC_s_INFO_FMT "raw state = %08x\n", ioc->name, s));
2352 sc = s & MPI_IOC_STATE_MASK;
2355 ioc->last_state = sc;
2357 return cooked ? sc : s;
2360 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
2362 * GetIocFacts - Send IOCFacts request to MPT adapter.
2363 * @ioc: Pointer to MPT_ADAPTER structure
2364 * @sleepFlag: Specifies whether the process can sleep
2365 * @reason: If recovery, only update facts.
2367 * Returns 0 for success, non-zero for failure.
2370 GetIocFacts(MPT_ADAPTER *ioc, int sleepFlag, int reason)
2372 IOCFacts_t get_facts;
2373 IOCFactsReply_t *facts;
2381 /* IOC *must* NOT be in RESET state! */
2382 if (ioc->last_state == MPI_IOC_STATE_RESET) {
2383 printk(KERN_ERR MYNAM ": ERROR - Can't get IOCFacts, %s NOT READY! (%08x)\n",
2389 facts = &ioc->facts;
2391 /* Destination (reply area)... */
2392 reply_sz = sizeof(*facts);
2393 memset(facts, 0, reply_sz);
2395 /* Request area (get_facts on the stack right now!) */
2396 req_sz = sizeof(get_facts);
2397 memset(&get_facts, 0, req_sz);
2399 get_facts.Function = MPI_FUNCTION_IOC_FACTS;
2400 /* Assert: All other get_facts fields are zero! */
2402 dinitprintk((MYIOC_s_INFO_FMT
2403 "Sending get IocFacts request req_sz=%d reply_sz=%d\n",
2404 ioc->name, req_sz, reply_sz));
2406 /* No non-zero fields in the get_facts request are greater than
2407 * 1 byte in size, so we can just fire it off as is.
2409 r = mpt_handshake_req_reply_wait(ioc, req_sz, (u32*)&get_facts,
2410 reply_sz, (u16*)facts, 5 /*seconds*/, sleepFlag);
2415 * Now byte swap (GRRR) the necessary fields before any further
2416 * inspection of reply contents.
2418 * But need to do some sanity checks on MsgLength (byte) field
2419 * to make sure we don't zero IOC's req_sz!
2421 /* Did we get a valid reply? */
2422 if (facts->MsgLength > offsetof(IOCFactsReply_t, RequestFrameSize)/sizeof(u32)) {
2423 if (reason == MPT_HOSTEVENT_IOC_BRINGUP) {
2425 * If not been here, done that, save off first WhoInit value
2427 if (ioc->FirstWhoInit == WHOINIT_UNKNOWN)
2428 ioc->FirstWhoInit = facts->WhoInit;
2431 facts->MsgVersion = le16_to_cpu(facts->MsgVersion);
2432 facts->MsgContext = le32_to_cpu(facts->MsgContext);
2433 facts->IOCExceptions = le16_to_cpu(facts->IOCExceptions);
2434 facts->IOCStatus = le16_to_cpu(facts->IOCStatus);
2435 facts->IOCLogInfo = le32_to_cpu(facts->IOCLogInfo);
2436 status = le16_to_cpu(facts->IOCStatus) & MPI_IOCSTATUS_MASK;
2437 /* CHECKME! IOCStatus, IOCLogInfo */
2439 facts->ReplyQueueDepth = le16_to_cpu(facts->ReplyQueueDepth);
2440 facts->RequestFrameSize = le16_to_cpu(facts->RequestFrameSize);
2443 * FC f/w version changed between 1.1 and 1.2
2444 * Old: u16{Major(4),Minor(4),SubMinor(8)}
2445 * New: u32{Major(8),Minor(8),Unit(8),Dev(8)}
2447 if (facts->MsgVersion < 0x0102) {
2449 * Handle old FC f/w style, convert to new...
2451 u16 oldv = le16_to_cpu(facts->Reserved_0101_FWVersion);
2452 facts->FWVersion.Word =
2453 ((oldv<<12) & 0xFF000000) |
2454 ((oldv<<8) & 0x000FFF00);
2456 facts->FWVersion.Word = le32_to_cpu(facts->FWVersion.Word);
2458 facts->ProductID = le16_to_cpu(facts->ProductID);
2459 facts->CurrentHostMfaHighAddr =
2460 le32_to_cpu(facts->CurrentHostMfaHighAddr);
2461 facts->GlobalCredits = le16_to_cpu(facts->GlobalCredits);
2462 facts->CurrentSenseBufferHighAddr =
2463 le32_to_cpu(facts->CurrentSenseBufferHighAddr);
2464 facts->CurReplyFrameSize =
2465 le16_to_cpu(facts->CurReplyFrameSize);
2466 facts->IOCCapabilities = le32_to_cpu(facts->IOCCapabilities);
2469 * Handle NEW (!) IOCFactsReply fields in MPI-1.01.xx
2470 * Older MPI-1.00.xx struct had 13 dwords, and enlarged
2471 * to 14 in MPI-1.01.0x.
2473 if (facts->MsgLength >= (offsetof(IOCFactsReply_t,FWImageSize) + 7)/4 &&
2474 facts->MsgVersion > 0x0100) {
2475 facts->FWImageSize = le32_to_cpu(facts->FWImageSize);
2478 sz = facts->FWImageSize;
2483 facts->FWImageSize = sz;
2485 if (!facts->RequestFrameSize) {
2486 /* Something is wrong! */
2487 printk(MYIOC_s_ERR_FMT "IOC reported invalid 0 request size!\n",
2492 r = sz = facts->BlockSize;
2493 vv = ((63 / (sz * 4)) + 1) & 0x03;
2494 ioc->NB_for_64_byte_frame = vv;
2500 ioc->NBShiftFactor = shiftFactor;
2501 dinitprintk((MYIOC_s_INFO_FMT "NB_for_64_byte_frame=%x NBShiftFactor=%x BlockSize=%x\n",
2502 ioc->name, vv, shiftFactor, r));
2504 if (reason == MPT_HOSTEVENT_IOC_BRINGUP) {
2506 * Set values for this IOC's request & reply frame sizes,
2507 * and request & reply queue depths...
2509 ioc->req_sz = min(MPT_DEFAULT_FRAME_SIZE, facts->RequestFrameSize * 4);
2510 ioc->req_depth = min_t(int, MPT_MAX_REQ_DEPTH, facts->GlobalCredits);
2511 ioc->reply_sz = MPT_REPLY_FRAME_SIZE;
2512 ioc->reply_depth = min_t(int, MPT_DEFAULT_REPLY_DEPTH, facts->ReplyQueueDepth);
2514 dinitprintk((MYIOC_s_INFO_FMT "reply_sz=%3d, reply_depth=%4d\n",
2515 ioc->name, ioc->reply_sz, ioc->reply_depth));
2516 dinitprintk((MYIOC_s_INFO_FMT "req_sz =%3d, req_depth =%4d\n",
2517 ioc->name, ioc->req_sz, ioc->req_depth));
2519 /* Get port facts! */
2520 if ( (r = GetPortFacts(ioc, 0, sleepFlag)) != 0 )
2524 printk(MYIOC_s_ERR_FMT
2525 "Invalid IOC facts reply, msgLength=%d offsetof=%zd!\n",
2526 ioc->name, facts->MsgLength, (offsetof(IOCFactsReply_t,
2527 RequestFrameSize)/sizeof(u32)));
2534 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
2536 * GetPortFacts - Send PortFacts request to MPT adapter.
2537 * @ioc: Pointer to MPT_ADAPTER structure
2538 * @portnum: Port number
2539 * @sleepFlag: Specifies whether the process can sleep
2541 * Returns 0 for success, non-zero for failure.
2544 GetPortFacts(MPT_ADAPTER *ioc, int portnum, int sleepFlag)
2546 PortFacts_t get_pfacts;
2547 PortFactsReply_t *pfacts;
2552 /* IOC *must* NOT be in RESET state! */
2553 if (ioc->last_state == MPI_IOC_STATE_RESET) {
2554 printk(KERN_ERR MYNAM ": ERROR - Can't get PortFacts, %s NOT READY! (%08x)\n",
2560 pfacts = &ioc->pfacts[portnum];
2562 /* Destination (reply area)... */
2563 reply_sz = sizeof(*pfacts);
2564 memset(pfacts, 0, reply_sz);
2566 /* Request area (get_pfacts on the stack right now!) */
2567 req_sz = sizeof(get_pfacts);
2568 memset(&get_pfacts, 0, req_sz);
2570 get_pfacts.Function = MPI_FUNCTION_PORT_FACTS;
2571 get_pfacts.PortNumber = portnum;
2572 /* Assert: All other get_pfacts fields are zero! */
2574 dinitprintk((MYIOC_s_INFO_FMT "Sending get PortFacts(%d) request\n",
2575 ioc->name, portnum));
2577 /* No non-zero fields in the get_pfacts request are greater than
2578 * 1 byte in size, so we can just fire it off as is.
2580 ii = mpt_handshake_req_reply_wait(ioc, req_sz, (u32*)&get_pfacts,
2581 reply_sz, (u16*)pfacts, 5 /*seconds*/, sleepFlag);
2585 /* Did we get a valid reply? */
2587 /* Now byte swap the necessary fields in the response. */
2588 pfacts->MsgContext = le32_to_cpu(pfacts->MsgContext);
2589 pfacts->IOCStatus = le16_to_cpu(pfacts->IOCStatus);
2590 pfacts->IOCLogInfo = le32_to_cpu(pfacts->IOCLogInfo);
2591 pfacts->MaxDevices = le16_to_cpu(pfacts->MaxDevices);
2592 pfacts->PortSCSIID = le16_to_cpu(pfacts->PortSCSIID);
2593 pfacts->ProtocolFlags = le16_to_cpu(pfacts->ProtocolFlags);
2594 pfacts->MaxPostedCmdBuffers = le16_to_cpu(pfacts->MaxPostedCmdBuffers);
2595 pfacts->MaxPersistentIDs = le16_to_cpu(pfacts->MaxPersistentIDs);
2596 pfacts->MaxLanBuckets = le16_to_cpu(pfacts->MaxLanBuckets);
2601 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
2603 * SendIocInit - Send IOCInit request to MPT adapter.
2604 * @ioc: Pointer to MPT_ADAPTER structure
2605 * @sleepFlag: Specifies whether the process can sleep
2607 * Send IOCInit followed by PortEnable to bring IOC to OPERATIONAL state.
2609 * Returns 0 for success, non-zero for failure.
2612 SendIocInit(MPT_ADAPTER *ioc, int sleepFlag)
2615 MPIDefaultReply_t init_reply;
2621 memset(&ioc_init, 0, sizeof(ioc_init));
2622 memset(&init_reply, 0, sizeof(init_reply));
2624 ioc_init.WhoInit = MPI_WHOINIT_HOST_DRIVER;
2625 ioc_init.Function = MPI_FUNCTION_IOC_INIT;
2627 /* If we are in a recovery mode and we uploaded the FW image,
2628 * then this pointer is not NULL. Skip the upload a second time.
2629 * Set this flag if cached_fw set for either IOC.
2631 if (ioc->facts.Flags & MPI_IOCFACTS_FLAGS_FW_DOWNLOAD_BOOT)
2635 ddlprintk((MYIOC_s_INFO_FMT "upload_fw %d facts.Flags=%x\n",
2636 ioc->name, ioc->upload_fw, ioc->facts.Flags));
2638 if(ioc->bus_type == SAS)
2639 ioc_init.MaxDevices = ioc->facts.MaxDevices;
2640 else if(ioc->bus_type == FC)
2641 ioc_init.MaxDevices = MPT_MAX_FC_DEVICES;
2643 ioc_init.MaxDevices = MPT_MAX_SCSI_DEVICES;
2644 ioc_init.MaxBuses = MPT_MAX_BUS;
2645 dinitprintk((MYIOC_s_INFO_FMT "facts.MsgVersion=%x\n",
2646 ioc->name, ioc->facts.MsgVersion));
2647 if (ioc->facts.MsgVersion >= MPI_VERSION_01_05) {
2648 // set MsgVersion and HeaderVersion host driver was built with
2649 ioc_init.MsgVersion = cpu_to_le16(MPI_VERSION);
2650 ioc_init.HeaderVersion = cpu_to_le16(MPI_HEADER_VERSION);
2652 if (ioc->facts.Flags & MPI_IOCFACTS_FLAGS_HOST_PAGE_BUFFER_PERSISTENT) {
2653 ioc_init.HostPageBufferSGE = ioc->facts.HostPageBufferSGE;
2654 } else if(mpt_host_page_alloc(ioc, &ioc_init))
2657 ioc_init.ReplyFrameSize = cpu_to_le16(ioc->reply_sz); /* in BYTES */
2659 if (sizeof(dma_addr_t) == sizeof(u64)) {
2660 /* Save the upper 32-bits of the request
2661 * (reply) and sense buffers.
2663 ioc_init.HostMfaHighAddr = cpu_to_le32((u32)((u64)ioc->alloc_dma >> 32));
2664 ioc_init.SenseBufferHighAddr = cpu_to_le32((u32)((u64)ioc->sense_buf_pool_dma >> 32));
2666 /* Force 32-bit addressing */
2667 ioc_init.HostMfaHighAddr = cpu_to_le32(0);
2668 ioc_init.SenseBufferHighAddr = cpu_to_le32(0);
2671 ioc->facts.CurrentHostMfaHighAddr = ioc_init.HostMfaHighAddr;
2672 ioc->facts.CurrentSenseBufferHighAddr = ioc_init.SenseBufferHighAddr;
2673 ioc->facts.MaxDevices = ioc_init.MaxDevices;
2674 ioc->facts.MaxBuses = ioc_init.MaxBuses;
2676 dhsprintk((MYIOC_s_INFO_FMT "Sending IOCInit (req @ %p)\n",
2677 ioc->name, &ioc_init));
2679 r = mpt_handshake_req_reply_wait(ioc, sizeof(IOCInit_t), (u32*)&ioc_init,
2680 sizeof(MPIDefaultReply_t), (u16*)&init_reply, 10 /*seconds*/, sleepFlag);
2682 printk(MYIOC_s_ERR_FMT "Sending IOCInit failed(%d)!\n",ioc->name, r);
2686 /* No need to byte swap the multibyte fields in the reply
2687 * since we don't even look at it's contents.
2690 dhsprintk((MYIOC_s_INFO_FMT "Sending PortEnable (req @ %p)\n",
2691 ioc->name, &ioc_init));
2693 if ((r = SendPortEnable(ioc, 0, sleepFlag)) != 0) {
2694 printk(MYIOC_s_ERR_FMT "Sending PortEnable failed(%d)!\n",ioc->name, r);
2698 /* YIKES! SUPER IMPORTANT!!!
2699 * Poll IocState until _OPERATIONAL while IOC is doing
2700 * LoopInit and TargetDiscovery!
2703 cntdn = ((sleepFlag == CAN_SLEEP) ? HZ : 1000) * 60; /* 60 seconds */
2704 state = mpt_GetIocState(ioc, 1);
2705 while (state != MPI_IOC_STATE_OPERATIONAL && --cntdn) {
2706 if (sleepFlag == CAN_SLEEP) {
2707 msleep_interruptible(1);
2713 printk(MYIOC_s_ERR_FMT "Wait IOC_OP state timeout(%d)!\n",
2714 ioc->name, (int)((count+5)/HZ));
2718 state = mpt_GetIocState(ioc, 1);
2721 dinitprintk((MYIOC_s_INFO_FMT "INFO - Wait IOC_OPERATIONAL state (cnt=%d)\n",
2727 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
2729 * SendPortEnable - Send PortEnable request to MPT adapter port.
2730 * @ioc: Pointer to MPT_ADAPTER structure
2731 * @portnum: Port number to enable
2732 * @sleepFlag: Specifies whether the process can sleep
2734 * Send PortEnable to bring IOC to OPERATIONAL state.
2736 * Returns 0 for success, non-zero for failure.
2739 SendPortEnable(MPT_ADAPTER *ioc, int portnum, int sleepFlag)
2741 PortEnable_t port_enable;
2742 MPIDefaultReply_t reply_buf;
2747 /* Destination... */
2748 reply_sz = sizeof(MPIDefaultReply_t);
2749 memset(&reply_buf, 0, reply_sz);
2751 req_sz = sizeof(PortEnable_t);
2752 memset(&port_enable, 0, req_sz);
2754 port_enable.Function = MPI_FUNCTION_PORT_ENABLE;
2755 port_enable.PortNumber = portnum;
2756 /* port_enable.ChainOffset = 0; */
2757 /* port_enable.MsgFlags = 0; */
2758 /* port_enable.MsgContext = 0; */
2760 dinitprintk((MYIOC_s_INFO_FMT "Sending Port(%d)Enable (req @ %p)\n",
2761 ioc->name, portnum, &port_enable));
2763 /* RAID FW may take a long time to enable
2765 if ( (ioc->facts.ProductID & MPI_FW_HEADER_PID_PROD_MASK)
2766 > MPI_FW_HEADER_PID_PROD_TARGET_SCSI ) {
2767 rc = mpt_handshake_req_reply_wait(ioc, req_sz, (u32*)&port_enable,
2768 reply_sz, (u16*)&reply_buf, 300 /*seconds*/, sleepFlag);
2770 rc = mpt_handshake_req_reply_wait(ioc, req_sz, (u32*)&port_enable,
2771 reply_sz, (u16*)&reply_buf, 30 /*seconds*/, sleepFlag);
2777 * ioc: Pointer to MPT_ADAPTER structure
2778 * size - total FW bytes
2781 mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size)
2784 return; /* use already allocated memory */
2785 if (ioc->alt_ioc && ioc->alt_ioc->cached_fw) {
2786 ioc->cached_fw = ioc->alt_ioc->cached_fw; /* use alt_ioc's memory */
2787 ioc->cached_fw_dma = ioc->alt_ioc->cached_fw_dma;
2789 if ( (ioc->cached_fw = pci_alloc_consistent(ioc->pcidev, size, &ioc->cached_fw_dma) ) )
2790 ioc->alloc_total += size;
2794 * If alt_img is NULL, delete from ioc structure.
2795 * Else, delete a secondary image in same format.
2798 mpt_free_fw_memory(MPT_ADAPTER *ioc)
2802 sz = ioc->facts.FWImageSize;
2803 dinitprintk((KERN_INFO MYNAM "free_fw_memory: FW Image @ %p[%p], sz=%d[%x] bytes\n",
2804 ioc->cached_fw, (void *)(ulong)ioc->cached_fw_dma, sz, sz));
2805 pci_free_consistent(ioc->pcidev, sz,
2806 ioc->cached_fw, ioc->cached_fw_dma);
2807 ioc->cached_fw = NULL;
2813 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
2815 * mpt_do_upload - Construct and Send FWUpload request to MPT adapter port.
2816 * @ioc: Pointer to MPT_ADAPTER structure
2817 * @sleepFlag: Specifies whether the process can sleep
2819 * Returns 0 for success, >0 for handshake failure
2820 * <0 for fw upload failure.
2822 * Remark: If bound IOC and a successful FWUpload was performed
2823 * on the bound IOC, the second image is discarded
2824 * and memory is free'd. Both channels must upload to prevent
2825 * IOC from running in degraded mode.
2828 mpt_do_upload(MPT_ADAPTER *ioc, int sleepFlag)
2830 u8 request[ioc->req_sz];
2831 u8 reply[sizeof(FWUploadReply_t)];
2832 FWUpload_t *prequest;
2833 FWUploadReply_t *preply;
2834 FWUploadTCSGE_t *ptcsge;
2837 int ii, sz, reply_sz;
2840 /* If the image size is 0, we are done.
2842 if ((sz = ioc->facts.FWImageSize) == 0)
2845 mpt_alloc_fw_memory(ioc, sz);
2847 dinitprintk((KERN_INFO MYNAM ": FW Image @ %p[%p], sz=%d[%x] bytes\n",
2848 ioc->cached_fw, (void *)(ulong)ioc->cached_fw_dma, sz, sz));
2850 if (ioc->cached_fw == NULL) {
2856 prequest = (FWUpload_t *)&request;
2857 preply = (FWUploadReply_t *)&reply;
2859 /* Destination... */
2860 memset(prequest, 0, ioc->req_sz);
2862 reply_sz = sizeof(reply);
2863 memset(preply, 0, reply_sz);
2865 prequest->ImageType = MPI_FW_UPLOAD_ITYPE_FW_IOC_MEM;
2866 prequest->Function = MPI_FUNCTION_FW_UPLOAD;
2868 ptcsge = (FWUploadTCSGE_t *) &prequest->SGL;
2869 ptcsge->DetailsLength = 12;
2870 ptcsge->Flags = MPI_SGE_FLAGS_TRANSACTION_ELEMENT;
2871 ptcsge->ImageSize = cpu_to_le32(sz);
2873 sgeoffset = sizeof(FWUpload_t) - sizeof(SGE_MPI_UNION) + sizeof(FWUploadTCSGE_t);
2875 flagsLength = MPT_SGE_FLAGS_SSIMPLE_READ | sz;
2876 mpt_add_sge(&request[sgeoffset], flagsLength, ioc->cached_fw_dma);
2878 sgeoffset += sizeof(u32) + sizeof(dma_addr_t);
2879 dinitprintk((KERN_INFO MYNAM ": Sending FW Upload (req @ %p) sgeoffset=%d \n",
2880 prequest, sgeoffset));
2881 DBG_DUMP_FW_REQUEST_FRAME(prequest)
2883 ii = mpt_handshake_req_reply_wait(ioc, sgeoffset, (u32*)prequest,
2884 reply_sz, (u16*)preply, 65 /*seconds*/, sleepFlag);
2886 dinitprintk((KERN_INFO MYNAM ": FW Upload completed rc=%x \n", ii));
2888 cmdStatus = -EFAULT;
2890 /* Handshake transfer was complete and successful.
2891 * Check the Reply Frame.
2893 int status, transfer_sz;
2894 status = le16_to_cpu(preply->IOCStatus);
2895 if (status == MPI_IOCSTATUS_SUCCESS) {
2896 transfer_sz = le32_to_cpu(preply->ActualImageSize);
2897 if (transfer_sz == sz)
2901 dinitprintk((MYIOC_s_INFO_FMT ": do_upload cmdStatus=%d \n",
2902 ioc->name, cmdStatus));
2907 ddlprintk((MYIOC_s_INFO_FMT ": fw upload failed, freeing image \n",
2909 mpt_free_fw_memory(ioc);
2915 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
2917 * mpt_downloadboot - DownloadBoot code
2918 * @ioc: Pointer to MPT_ADAPTER structure
2919 * @flag: Specify which part of IOC memory is to be uploaded.
2920 * @sleepFlag: Specifies whether the process can sleep
2922 * FwDownloadBoot requires Programmed IO access.
2924 * Returns 0 for success
2925 * -1 FW Image size is 0
2926 * -2 No valid cached_fw Pointer
2927 * <0 for fw upload failure.
2930 mpt_downloadboot(MPT_ADAPTER *ioc, MpiFwHeader_t *pFwHeader, int sleepFlag)
2932 MpiExtImageHeader_t *pExtImage;
2942 ddlprintk((MYIOC_s_INFO_FMT "downloadboot: fw size 0x%x (%d), FW Ptr %p\n",
2943 ioc->name, pFwHeader->ImageSize, pFwHeader->ImageSize, pFwHeader));
2945 CHIPREG_WRITE32(&ioc->chip->WriteSequence, 0xFF);
2946 CHIPREG_WRITE32(&ioc->chip->WriteSequence, MPI_WRSEQ_1ST_KEY_VALUE);
2947 CHIPREG_WRITE32(&ioc->chip->WriteSequence, MPI_WRSEQ_2ND_KEY_VALUE);
2948 CHIPREG_WRITE32(&ioc->chip->WriteSequence, MPI_WRSEQ_3RD_KEY_VALUE);
2949 CHIPREG_WRITE32(&ioc->chip->WriteSequence, MPI_WRSEQ_4TH_KEY_VALUE);
2950 CHIPREG_WRITE32(&ioc->chip->WriteSequence, MPI_WRSEQ_5TH_KEY_VALUE);
2952 CHIPREG_WRITE32(&ioc->chip->Diagnostic, (MPI_DIAG_PREVENT_IOC_BOOT | MPI_DIAG_DISABLE_ARM));
2955 if (sleepFlag == CAN_SLEEP) {
2956 msleep_interruptible(1);
2961 diag0val = CHIPREG_READ32(&ioc->chip->Diagnostic);
2962 CHIPREG_WRITE32(&ioc->chip->Diagnostic, diag0val | MPI_DIAG_RESET_ADAPTER);
2964 for (count = 0; count < 30; count ++) {
2965 diag0val = CHIPREG_READ32(&ioc->chip->Diagnostic);
2966 if (!(diag0val & MPI_DIAG_RESET_ADAPTER)) {
2967 ddlprintk((MYIOC_s_INFO_FMT "RESET_ADAPTER cleared, count=%d\n",
2972 if (sleepFlag == CAN_SLEEP) {
2973 msleep_interruptible (100);
2979 if ( count == 30 ) {
2980 ddlprintk((MYIOC_s_INFO_FMT "downloadboot failed! "
2981 "Unable to get MPI_DIAG_DRWE mode, diag0val=%x\n",
2982 ioc->name, diag0val));
2986 CHIPREG_WRITE32(&ioc->chip->WriteSequence, 0xFF);
2987 CHIPREG_WRITE32(&ioc->chip->WriteSequence, MPI_WRSEQ_1ST_KEY_VALUE);
2988 CHIPREG_WRITE32(&ioc->chip->WriteSequence, MPI_WRSEQ_2ND_KEY_VALUE);
2989 CHIPREG_WRITE32(&ioc->chip->WriteSequence, MPI_WRSEQ_3RD_KEY_VALUE);
2990 CHIPREG_WRITE32(&ioc->chip->WriteSequence, MPI_WRSEQ_4TH_KEY_VALUE);
2991 CHIPREG_WRITE32(&ioc->chip->WriteSequence, MPI_WRSEQ_5TH_KEY_VALUE);
2993 /* Set the DiagRwEn and Disable ARM bits */
2994 CHIPREG_WRITE32(&ioc->chip->Diagnostic, (MPI_DIAG_RW_ENABLE | MPI_DIAG_DISABLE_ARM));
2996 fwSize = (pFwHeader->ImageSize + 3)/4;
2997 ptrFw = (u32 *) pFwHeader;
2999 /* Write the LoadStartAddress to the DiagRw Address Register
3000 * using Programmed IO
3002 if (ioc->errata_flag_1064)
3003 pci_enable_io_access(ioc->pcidev);
3005 CHIPREG_PIO_WRITE32(&ioc->pio_chip->DiagRwAddress, pFwHeader->LoadStartAddress);
3006 ddlprintk((MYIOC_s_INFO_FMT "LoadStart addr written 0x%x \n",
3007 ioc->name, pFwHeader->LoadStartAddress));
3009 ddlprintk((MYIOC_s_INFO_FMT "Write FW Image: 0x%x bytes @ %p\n",
3010 ioc->name, fwSize*4, ptrFw));
3012 CHIPREG_PIO_WRITE32(&ioc->pio_chip->DiagRwData, *ptrFw++);
3015 nextImage = pFwHeader->NextImageHeaderOffset;
3017 pExtImage = (MpiExtImageHeader_t *) ((char *)pFwHeader + nextImage);
3019 load_addr = pExtImage->LoadStartAddress;
3021 fwSize = (pExtImage->ImageSize + 3) >> 2;
3022 ptrFw = (u32 *)pExtImage;
3024 ddlprintk((MYIOC_s_INFO_FMT "Write Ext Image: 0x%x (%d) bytes @ %p load_addr=%x\n",
3025 ioc->name, fwSize*4, fwSize*4, ptrFw, load_addr));
3026 CHIPREG_PIO_WRITE32(&ioc->pio_chip->DiagRwAddress, load_addr);
3029 CHIPREG_PIO_WRITE32(&ioc->pio_chip->DiagRwData, *ptrFw++);
3031 nextImage = pExtImage->NextImageHeaderOffset;
3034 /* Write the IopResetVectorRegAddr */
3035 ddlprintk((MYIOC_s_INFO_FMT "Write IopResetVector Addr=%x! \n", ioc->name, pFwHeader->IopResetRegAddr));
3036 CHIPREG_PIO_WRITE32(&ioc->pio_chip->DiagRwAddress, pFwHeader->IopResetRegAddr);
3038 /* Write the IopResetVectorValue */
3039 ddlprintk((MYIOC_s_INFO_FMT "Write IopResetVector Value=%x! \n", ioc->name, pFwHeader->IopResetVectorValue));
3040 CHIPREG_PIO_WRITE32(&ioc->pio_chip->DiagRwData, pFwHeader->IopResetVectorValue);
3042 /* Clear the internal flash bad bit - autoincrementing register,
3043 * so must do two writes.
3045 if (ioc->bus_type == SPI) {
3047 * 1030 and 1035 H/W errata, workaround to access
3048 * the ClearFlashBadSignatureBit
3050 CHIPREG_PIO_WRITE32(&ioc->pio_chip->DiagRwAddress, 0x3F000000);
3051 diagRwData = CHIPREG_PIO_READ32(&ioc->pio_chip->DiagRwData);
3052 diagRwData |= 0x40000000;
3053 CHIPREG_PIO_WRITE32(&ioc->pio_chip->DiagRwAddress, 0x3F000000);
3054 CHIPREG_PIO_WRITE32(&ioc->pio_chip->DiagRwData, diagRwData);
3056 } else /* if((ioc->bus_type == SAS) || (ioc->bus_type == FC)) */ {
3057 diag0val = CHIPREG_READ32(&ioc->chip->Diagnostic);
3058 CHIPREG_WRITE32(&ioc->chip->Diagnostic, diag0val |
3059 MPI_DIAG_CLEAR_FLASH_BAD_SIG);
3062 if (sleepFlag == CAN_SLEEP) {
3063 msleep_interruptible (1);
3069 if (ioc->errata_flag_1064)
3070 pci_disable_io_access(ioc->pcidev);
3072 diag0val = CHIPREG_READ32(&ioc->chip->Diagnostic);
3073 ddlprintk((MYIOC_s_INFO_FMT "downloadboot diag0val=%x, "
3074 "turning off PREVENT_IOC_BOOT, DISABLE_ARM, RW_ENABLE\n",
3075 ioc->name, diag0val));
3076 diag0val &= ~(MPI_DIAG_PREVENT_IOC_BOOT | MPI_DIAG_DISABLE_ARM | MPI_DIAG_RW_ENABLE);
3077 ddlprintk((MYIOC_s_INFO_FMT "downloadboot now diag0val=%x\n",
3078 ioc->name, diag0val));
3079 CHIPREG_WRITE32(&ioc->chip->Diagnostic, diag0val);
3081 /* Write 0xFF to reset the sequencer */
3082 CHIPREG_WRITE32(&ioc->chip->WriteSequence, 0xFF);
3084 if (ioc->bus_type == SAS) {
3085 ioc_state = mpt_GetIocState(ioc, 0);
3086 if ( (GetIocFacts(ioc, sleepFlag,
3087 MPT_HOSTEVENT_IOC_BRINGUP)) != 0 ) {
3088 ddlprintk((MYIOC_s_INFO_FMT "GetIocFacts failed: IocState=%x\n",
3089 ioc->name, ioc_state));
3094 for (count=0; count<HZ*20; count++) {
3095 if ((ioc_state = mpt_GetIocState(ioc, 0)) & MPI_IOC_STATE_READY) {
3096 ddlprintk((MYIOC_s_INFO_FMT "downloadboot successful! (count=%d) IocState=%x\n",
3097 ioc->name, count, ioc_state));
3098 if (ioc->bus_type == SAS) {
3101 if ((SendIocInit(ioc, sleepFlag)) != 0) {
3102 ddlprintk((MYIOC_s_INFO_FMT "downloadboot: SendIocInit failed\n",
3106 ddlprintk((MYIOC_s_INFO_FMT "downloadboot: SendIocInit successful\n",
3110 if (sleepFlag == CAN_SLEEP) {
3111 msleep_interruptible (10);
3116 ddlprintk((MYIOC_s_INFO_FMT "downloadboot failed! IocState=%x\n",
3117 ioc->name, ioc_state));
3121 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
3123 * KickStart - Perform hard reset of MPT adapter.
3124 * @ioc: Pointer to MPT_ADAPTER structure
3125 * @force: Force hard reset
3126 * @sleepFlag: Specifies whether the process can sleep