freebsd-nq/sys/dev/mpt/mpt.c
Matt Jacob 9b63136347 Add support for the LSI-Logic Fusion/MP architecture.
This is an architecture that present a thing message passing interface
to the OS. You can query as to how many ports and what kind are attached
and enable them and so on.

A less grand view is that this is just another way to package SCSI (SPI or
FC) and FC-IP into a one-driver interface set.

This driver support the following hardware:

LSI FC909:	Single channel, 1Gbps, Fibre Channel (FC-SCSI only)
LSI FC929:	Dual Channel, 1-2Gbps, Fibre Channel (FC-SCSI only)
LSI 53c1020:	Single Channel, Ultra4 (320M) (Untested)
LSI 53c1030:	Dual Channel, Ultra4 (320M)

Currently it's in fair shape, but expect a lot of changes over the
next few weeks as it stabilizes.

Credits:

The driver is mostly from some folks from Jeff Roberson's company- I've
been slowly migrating it to broader support that I it came to me as.

The hardware used in developing support came from:

	FC909: LSI-Logic, Advansys (now Connetix)
	FC929: LSI-Logic
	53c1030: Antares Microsystems (they make a very fine board!)

MFC after:	3 weeks
2002-08-11 23:34:20 +00:00

695 lines
18 KiB
C

/* $FreeBSD$ */
/*
* Generic routines for LSI '909 FC adapters.
* FreeBSD Version.
*
* Copyright (c) 2000, 2001 by Greg Ansley
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice immediately at the beginning of the file, without modification,
* this list of conditions, and the following disclaimer.
* 2. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* Additional Copyright (c) 2002 by Matthew Jacob under same license.
*/
#include <dev/mpt/mpt_freebsd.h>
#include <dev/mpt/mpt.h>
#define MPT_MAX_TRYS 3
#define MPT_MAX_WAIT 300000
static int maxwait_ack = 0;
static int maxwait_int = 0;
static int maxwait_state = 0;
static __inline u_int32_t mpt_rd_db(struct mpt_softc *mpt);
static __inline u_int32_t mpt_rd_intr(struct mpt_softc *mpt);
static __inline u_int32_t
mpt_rd_db(struct mpt_softc *mpt)
{
return mpt_read(mpt, MPT_OFFSET_DOORBELL);
}
static __inline u_int32_t
mpt_rd_intr(struct mpt_softc *mpt)
{
return mpt_read(mpt, MPT_OFFSET_INTR_STATUS);
}
/* Busy wait for a door bell to be read by IOC */
static int
mpt_wait_db_ack(struct mpt_softc *mpt)
{
int i;
for (i=0; i < MPT_MAX_WAIT; i++) {
if (!MPT_DB_IS_BUSY(mpt_rd_intr(mpt))) {
maxwait_ack = i > maxwait_ack ? i : maxwait_ack;
return MPT_OK;
}
DELAY(100);
}
return MPT_FAIL;
}
/* Busy wait for a door bell interrupt */
static int
mpt_wait_db_int(struct mpt_softc *mpt)
{
int i;
for (i=0; i < MPT_MAX_WAIT; i++) {
if (MPT_DB_INTR(mpt_rd_intr(mpt))) {
maxwait_int = i > maxwait_int ? i : maxwait_int;
return MPT_OK;
}
DELAY(100);
}
return MPT_FAIL;
}
/* Wait for IOC to transition to a give state */
void
mpt_check_doorbell(struct mpt_softc *mpt)
{
u_int32_t db = mpt_rd_db(mpt);
if (MPT_STATE(db) != MPT_DB_STATE_RUNNING) {
device_printf(mpt->dev, "Device not running!\n");
mpt_print_db(db);
}
}
/* Wait for IOC to transition to a give state */
static int
mpt_wait_state(struct mpt_softc *mpt, enum DB_STATE_BITS state)
{
int i;
for (i = 0; i < MPT_MAX_WAIT; i++) {
u_int32_t db = mpt_rd_db(mpt);
if (MPT_STATE(db) == state) {
maxwait_state = i > maxwait_state ? i : maxwait_state;
return (MPT_OK);
}
DELAY(100);
}
return (MPT_FAIL);
}
/* Issue the reset COMMAND to the IOC */
int
mpt_soft_reset(struct mpt_softc *mpt)
{
if (mpt->verbose) {
device_printf(mpt->dev,"soft reset\n");
}
/* Have to use hard reset if we are not in Running state */
if (MPT_STATE(mpt_rd_db(mpt)) != MPT_DB_STATE_RUNNING) {
device_printf(mpt->dev,
"soft reset failed: device not running\n");
return MPT_FAIL;
}
/* If door bell is in use we don't have a chance of getting
* a word in since the IOC probably crashed in message
* processing. So don't waste our time.
*/
if (MPT_DB_IS_IN_USE(mpt_rd_db(mpt))) {
device_printf(mpt->dev, "soft reset failed: doorbell wedged\n");
return MPT_FAIL;
}
/* Send the reset request to the IOC */
mpt_write(mpt, MPT_OFFSET_DOORBELL,
MPI_FUNCTION_IOC_MESSAGE_UNIT_RESET << MPI_DOORBELL_FUNCTION_SHIFT);
if (mpt_wait_db_ack(mpt) != MPT_OK) {
device_printf(mpt->dev, "soft reset failed: ack timeout\n");
return MPT_FAIL;
}
/* Wait for the IOC to reload and come out of reset state */
if (mpt_wait_state(mpt, MPT_DB_STATE_READY) != MPT_OK) {
device_printf(mpt->dev,
"soft reset failed: device did not start running\n");
return MPT_FAIL;
}
return MPT_OK;
}
/* This is a magic diagnostic reset that resets all the ARM
* processors in the chip.
*/
void
mpt_hard_reset(struct mpt_softc *mpt)
{
/* This extra read comes for the Linux source
* released by LSI. It's function is undocumented!
*/
if (mpt->verbose) {
device_printf(mpt->dev, "hard reset\n");
}
mpt_read(mpt, MPT_OFFSET_FUBAR);
/* Enable diagnostic registers */
mpt_write(mpt, MPT_OFFSET_SEQUENCE, MPT_DIAG_SEQUENCE_1);
mpt_write(mpt, MPT_OFFSET_SEQUENCE, MPT_DIAG_SEQUENCE_2);
mpt_write(mpt, MPT_OFFSET_SEQUENCE, MPT_DIAG_SEQUENCE_3);
mpt_write(mpt, MPT_OFFSET_SEQUENCE, MPT_DIAG_SEQUENCE_4);
mpt_write(mpt, MPT_OFFSET_SEQUENCE, MPT_DIAG_SEQUENCE_5);
/* Diag. port is now active so we can now hit the reset bit */
mpt_write(mpt, MPT_OFFSET_DIAGNOSTIC, MPT_DIAG_RESET_IOC);
DELAY(10000);
/* Disable Diagnostic Register */
mpt_write(mpt, MPT_OFFSET_SEQUENCE, 0xFF);
/* Restore the config register values */
/* Hard resets are known to screw up the BAR for diagnostic
memory accesses (Mem1). */
mpt_set_config_regs(mpt);
if (mpt->mpt2 != NULL) {
mpt_set_config_regs(mpt->mpt2);
}
/* Note that if there is no valid firmware to run, the doorbell will
remain in the reset state (0x00000000) */
}
/*
* Reset the IOC when needed. Try software command first then if needed
* poke at the magic diagnostic reset. Note that a hard reset resets
* *both* IOCs on dual function chips (FC929 && LSI1030) as well as
* fouls up the PCI configuration registers.
*/
int
mpt_reset(struct mpt_softc *mpt)
{
int ret;
/* Try a soft reset */
if ((ret = mpt_soft_reset(mpt)) != MPT_OK) {
/* Failed; do a hard reset */
mpt_hard_reset(mpt);
/* Wait for the IOC to reload and come out of reset state */
ret = mpt_wait_state(mpt, MPT_DB_STATE_READY);
if (ret != MPT_OK) {
device_printf(mpt->dev, "failed to reset device\n");
}
}
return ret;
}
/* Return a command buffer to the free queue */
void
mpt_free_request(struct mpt_softc *mpt, request_t *req)
{
if (req == NULL || req != &mpt->requests[req->index]) {
panic("mpt_free_request bad req ptr\n");
return;
}
req->ccb = NULL;
req->debug = REQ_FREE;
SLIST_INSERT_HEAD(&mpt->request_free_list, req, link);
}
/* Get a command buffer from the free queue */
request_t *
mpt_get_request(struct mpt_softc *mpt)
{
request_t *req;
req = SLIST_FIRST(&mpt->request_free_list);
if (req != NULL) {
if (req != &mpt->requests[req->index]) {
panic("mpt_get_request: corrupted request free list\n");
}
if (req->ccb != NULL) {
panic("mpt_get_request: corrupted request free list (ccb)\n");
}
SLIST_REMOVE_HEAD(&mpt->request_free_list, link);
req->debug = REQ_IN_PROGRESS;
}
return req;
}
/* Pass the command to the IOC */
void
mpt_send_cmd(struct mpt_softc *mpt, request_t *req)
{
req->sequence = mpt->sequence++;
if (mpt->verbose > 1) {
u_int32_t *pReq;
pReq = req->req_vbuf;
device_printf(mpt->dev, "Send Request %d (0x%x):\n",
req->index, req->req_pbuf);
device_printf(mpt->dev, "%08X %08X %08X %08X\n",
pReq[0], pReq[1], pReq[2], pReq[3]);
device_printf(mpt->dev, "%08X %08X %08X %08X\n",
pReq[4], pReq[5], pReq[6], pReq[7]);
device_printf(mpt->dev, "%08X %08X %08X %08X\n",
pReq[8], pReq[9], pReq[10], pReq[11]);
device_printf(mpt->dev, "%08X %08X %08X %08X\n",
pReq[12], pReq[13], pReq[14], pReq[15]);
}
bus_dmamap_sync(mpt->request_dmat, mpt->request_dmap,
BUS_DMASYNC_PREWRITE);
req->debug = REQ_ON_CHIP;
mpt_write(mpt, MPT_OFFSET_REQUEST_Q, (u_int32_t) req->req_pbuf);
}
/*
* Give the reply buffer back to the IOC after we have
* finished processing it.
*/
void
mpt_free_reply(struct mpt_softc *mpt, u_int32_t ptr)
{
mpt_write(mpt, MPT_OFFSET_REPLY_Q, ptr);
}
/* Get a reply from the IOC */
u_int32_t
mpt_pop_reply_queue(struct mpt_softc *mpt)
{
return mpt_read(mpt, MPT_OFFSET_REPLY_Q);
}
/*
* Send a command to the IOC via the handshake register.
*
* Only done at initialization time and for certain unusual
* commands such as device/bus reset as specified by LSI.
*/
int
mpt_send_handshake_cmd(struct mpt_softc *mpt, size_t len, void *cmd)
{
int i;
u_int32_t data, *data32;
/* Check condition of the IOC */
data = mpt_rd_db(mpt);
if (((MPT_STATE(data) != MPT_DB_STATE_READY) &&
(MPT_STATE(data) != MPT_DB_STATE_RUNNING) &&
(MPT_STATE(data) != MPT_DB_STATE_FAULT)) ||
( MPT_DB_IS_IN_USE(data) )) {
device_printf(mpt->dev,
"handshake aborted due to invalid doorbell state\n");
mpt_print_db(data);
return(EBUSY);
}
/* We move things in 32 bit chunks */
len = (len + 3) >> 2;
data32 = cmd;
/* Clear any left over pending doorbell interupts */
if (MPT_DB_INTR(mpt_rd_intr(mpt)))
mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
/*
* Tell the handshake reg. we are going to send a command
* and how long it is going to be.
*/
data = (MPI_FUNCTION_HANDSHAKE << MPI_DOORBELL_FUNCTION_SHIFT) |
(len << MPI_DOORBELL_ADD_DWORDS_SHIFT);
mpt_write(mpt, MPT_OFFSET_DOORBELL, data);
/* Wait for the chip to notice */
if (mpt_wait_db_int(mpt) != MPT_OK) {
device_printf(mpt->dev, "mpt_send_handshake_cmd timeout1!\n");
return ETIMEDOUT;
}
/* Clear the interrupt */
mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
if (mpt_wait_db_ack(mpt) != MPT_OK) {
device_printf(mpt->dev, "mpt_send_handshake_cmd timeout2!\n");
return ETIMEDOUT;
}
/* Send the command */
for (i = 0; i < len; i++) {
mpt_write(mpt, MPT_OFFSET_DOORBELL, *data32++);
if (mpt_wait_db_ack(mpt) != MPT_OK) {
device_printf(mpt->dev,
"mpt_send_handshake_cmd timeout! index = %d\n", i);
return ETIMEDOUT;
}
}
return MPT_OK;
}
/* Get the response from the handshake register */
int
mpt_recv_handshake_reply(struct mpt_softc *mpt, size_t reply_len, void *reply)
{
int left, reply_left;
u_int16_t *data16;
MSG_DEFAULT_REPLY *hdr;
/* We move things out in 16 bit chunks */
reply_len >>= 1;
data16 = (u_int16_t *)reply;
hdr = (MSG_DEFAULT_REPLY *)reply;
/* Get first word */
if (mpt_wait_db_int(mpt) != MPT_OK) {
device_printf(mpt->dev, "mpt_recv_handshake_cmd timeout1!\n");
return ETIMEDOUT;
}
*data16++ = mpt_read(mpt, MPT_OFFSET_DOORBELL) & MPT_DB_DATA_MASK;
mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
/* Get Second Word */
if (mpt_wait_db_int(mpt) != MPT_OK) {
device_printf(mpt->dev, "mpt_recv_handshake_cmd timeout2!\n");
return ETIMEDOUT;
}
*data16++ = mpt_read(mpt, MPT_OFFSET_DOORBELL) & MPT_DB_DATA_MASK;
mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
/* With the second word, we can now look at the length */
if (mpt->verbose > 1 && ((reply_len >> 1) != hdr->MsgLength)) {
device_printf(mpt->dev,
"reply length does not match message length: "
"got 0x%02x, expected 0x%02x\n",
hdr->MsgLength << 2, reply_len << 1);
}
/* Get rest of the reply; but don't overflow the provided buffer */
left = (hdr->MsgLength << 1) - 2;
reply_left = reply_len - 2;
while (left--) {
u_int16_t datum;
if (mpt_wait_db_int(mpt) != MPT_OK) {
device_printf(mpt->dev,
"mpt_recv_handshake_cmd timeout3!\n");
return ETIMEDOUT;
}
datum = mpt_read(mpt, MPT_OFFSET_DOORBELL);
if (reply_left-- > 0)
*data16++ = datum & MPT_DB_DATA_MASK;
mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
}
/* One more wait & clear at the end */
if (mpt_wait_db_int(mpt) != MPT_OK) {
device_printf(mpt->dev, "mpt_recv_handshake_cmd timeout4!\n");
return ETIMEDOUT;
}
mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
if ((hdr->IOCStatus & MPI_IOCSTATUS_MASK) != MPI_IOCSTATUS_SUCCESS) {
if (mpt->verbose > 1)
mpt_print_reply(hdr);
return (MPT_FAIL | hdr->IOCStatus);
}
return (0);
}
/* Get API statistics from the chip */
static int
mpt_get_iocfacts(struct mpt_softc *mpt, MSG_IOC_FACTS_REPLY *freplp)
{
MSG_IOC_FACTS f_req;
int error;
bzero(&f_req, sizeof f_req);
f_req.Function = MPI_FUNCTION_IOC_FACTS;
f_req.MsgContext = 0x12071942;
error = mpt_send_handshake_cmd(mpt, sizeof f_req, &f_req);
if (error)
return(error);
error = mpt_recv_handshake_reply(mpt, sizeof (*freplp), freplp);
return (error);
}
/*
* Send the initialization request. This is where we specify how many
* SCSI busses and how many devices per bus we wish to emulate.
* This is also the command that specifies the max size of the reply
* frames from the IOC that we will be allocating.
*/
static int
mpt_send_ioc_init(struct mpt_softc *mpt, u_int32_t who)
{
int error = 0;
MSG_IOC_INIT init;
MSG_IOC_INIT_REPLY reply;
bzero(&init, sizeof init);
init.WhoInit = who;
init.Function = MPI_FUNCTION_IOC_INIT;
if (mpt->is_fc) {
init.MaxDevices = 255;
} else {
init.MaxDevices = 16;
}
init.MaxBuses = 1;
init.ReplyFrameSize = MPT_REPLY_SIZE;
init.MsgContext = 0x12071941;
if ((error = mpt_send_handshake_cmd(mpt, sizeof init, &init)) != 0) {
return(error);
}
error = mpt_recv_handshake_reply(mpt, sizeof reply, &reply);
return (error);
}
/* Send the port enable to allow the IOC to join the FC loop */
static int
mpt_send_port_enable(struct mpt_softc *mpt, int port)
{
int count;
request_t *req;
MSG_PORT_ENABLE *enable_req;
req = mpt_get_request(mpt);
enable_req = req->req_vbuf;
bzero(enable_req, sizeof *enable_req);
enable_req->Function = MPI_FUNCTION_PORT_ENABLE;
enable_req->MsgContext = req->index | 0x80000000;
enable_req->PortNumber = port;
mpt_check_doorbell(mpt);
if (mpt->verbose > 1) {
device_printf(mpt->dev, "enabling port %d\n", port);
}
mpt_send_cmd(mpt, req);
count = 0;
do {
DELAY(500);
mpt_intr(mpt);
if (++count == 1000) {
device_printf(mpt->dev, "port enable timed out\n");
return (-1);
}
} while (req->debug == REQ_ON_CHIP);
mpt_free_request(mpt, req);
return (0);
}
/*
* Enable/Disable asynchronous event reporting.
*
* NB: this is the first command we send via shared memory
* instead of the handshake register.
*/
static int
mpt_send_event_request(struct mpt_softc *mpt, int onoff)
{
request_t *req;
MSG_EVENT_NOTIFY *enable_req;
req = mpt_get_request(mpt);
enable_req = req->req_vbuf;
bzero(enable_req, sizeof *enable_req);
enable_req->Function = MPI_FUNCTION_EVENT_NOTIFICATION;
enable_req->MsgContext = req->index | 0x80000000;
enable_req->Switch = onoff;
mpt_check_doorbell(mpt);
if (mpt->verbose > 1) {
device_printf(mpt->dev, "%sabling async events\n",
onoff? "en" : "dis");
}
mpt_send_cmd(mpt, req);
return (0);
}
/*
* Un-mask the interupts on the chip.
*/
void
mpt_enable_ints(struct mpt_softc *mpt)
{
/* Unmask every thing except door bell int */
mpt_write(mpt, MPT_OFFSET_INTR_MASK, MPT_INTR_DB_MASK);
}
/*
* Mask the interupts on the chip.
*/
void
mpt_disable_ints(struct mpt_softc *mpt)
{
/* Mask all interrupts */
mpt_write(mpt, MPT_OFFSET_INTR_MASK,
MPT_INTR_REPLY_MASK | MPT_INTR_DB_MASK);
}
/* (Re)Initialize the chip for use */
int
mpt_init(struct mpt_softc *mpt, u_int32_t who)
{
int try;
MSG_IOC_FACTS_REPLY facts;
u_int32_t pptr;
int val;
/* Put all request buffers (back) on the free list */
SLIST_INIT(&mpt->request_free_list);
for (val = 0; val < MPT_MAX_REQUESTS; val++) {
mpt_free_request(mpt, &mpt->requests[val]);
}
if (mpt->verbose > 1) {
device_printf(mpt->dev, "doorbell req = %s\n",
mpt_ioc_diag(mpt_read(mpt, MPT_OFFSET_DOORBELL)));
}
/*
* Start by making sure we're not at FAULT or RESET state
*/
switch (mpt_rd_db(mpt) & MPT_DB_STATE_MASK) {
case MPT_DB_STATE_RESET:
case MPT_DB_STATE_FAULT:
if (mpt_reset(mpt) != MPT_OK) {
return (EIO);
}
default:
break;
}
for (try = 0; try < MPT_MAX_TRYS; try++) {
/*
* No need to reset if the IOC is already in the READY state.
*
* Force reset if initialization failed previously.
* Note that a hard_reset of the second channel of a '929
* will stop operation of the first channel. Hopefully, if the
* first channel is ok, the second will not require a hard
* reset.
*/
if ((mpt_rd_db(mpt) & MPT_DB_STATE_MASK) !=
MPT_DB_STATE_READY) {
if (mpt_reset(mpt) != MPT_OK) {
DELAY(10000);
continue;
}
}
if (mpt_get_iocfacts(mpt, &facts) != MPT_OK) {
device_printf(mpt->dev, "mpt_get_iocfacts failed\n");
continue;
} else if (mpt->verbose > 1) {
device_printf(mpt->dev,
"mpt_get_iocfacts: GlobalCredits=%d BlockSize=%u "
"Request Frame Size %u\n", facts.GlobalCredits,
facts.BlockSize, facts.RequestFrameSize);
}
mpt->mpt_global_credits = facts.GlobalCredits;
mpt->blk_size = facts.BlockSize;
mpt->request_frame_size = facts.RequestFrameSize;
if (mpt_send_ioc_init(mpt, who) != MPT_OK) {
device_printf(mpt->dev, "mpt_send_ioc_init failed\n");
continue;
} else if (mpt->verbose > 1) {
device_printf(mpt->dev, "mpt_send_ioc_init ok\n");
}
if (mpt_wait_state(mpt, MPT_DB_STATE_RUNNING) != MPT_OK) {
device_printf(mpt->dev,
"IOC failed to go to run state\n");
continue;
} else if (mpt->verbose > 1) {
device_printf(mpt->dev, "IOC now at RUNSTATE\n");
}
/*
* Give it reply buffers
*
* Do *not* except global credits.
*/
for (val = 0, pptr = mpt->reply_phys;
(pptr + MPT_REPLY_SIZE) < (mpt->reply_phys + PAGE_SIZE);
pptr += MPT_REPLY_SIZE) {
mpt_free_reply(mpt, pptr);
if (++val == mpt->mpt_global_credits - 1)
break;
}
mpt_send_event_request(mpt, 1);
if (mpt_send_port_enable(mpt, 0) != MPT_OK) {
device_printf(mpt->dev, "failed to enable port 0\n");
continue;
} else if (mpt->verbose > 1) {
device_printf(mpt->dev, "enabled port 0\n");
}
/* Everything worked */
break;
}
if (try >= MPT_MAX_TRYS) {
device_printf(mpt->dev, "failed to initialize IOC\n");
return (EIO);
}
if (mpt->verbose > 1) {
device_printf(mpt->dev, "enabling interrupts\n");
}
mpt_enable_ints(mpt);
return (0);
}