mps/mps_user.c

   1 /*-
   2  * Copyright (c) 2008 Yahoo!, Inc.
   3  * All rights reserved.
   4  * Written by: John Baldwin <jhb@FreeBSD.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. Neither the name of the author nor the names of any co-contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD userland interface
  31  */
  32 /*-
  33  * Copyright (c) 2011-2015 LSI Corp.
  34  * Copyright (c) 2013-2015 Avago Technologies
  35  * All rights reserved.
  36  *
  37  * Redistribution and use in source and binary forms, with or without
  38  * modification, are permitted provided that the following conditions
  39  * are met:
  40  * 1. Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  * 2. Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in the
  44  *    documentation and/or other materials provided with the distribution.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  49  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  50  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  56  * SUCH DAMAGE.
  57  *
  58  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
  59  *
  60  * $FreeBSD$
  61  */
  62
  63 #include <sys/cdefs.h>
  64 __FBSDID("$FreeBSD$");
  65
  66 #include "opt_compat.h"
  67
  68 /* TODO Move headers to mpsvar */
  69 #include <sys/types.h>
  70 #include <sys/param.h>
  71 #include <sys/systm.h>
  72 #include <sys/kernel.h>
  73 #include <sys/selinfo.h>
  74 #include <sys/module.h>
  75 #include <sys/bus.h>
  76 #include <sys/conf.h>
  77 #include <sys/bio.h>
  78 #include <sys/malloc.h>
  79 #include <sys/uio.h>
  80 #include <sys/sysctl.h>
  81 #include <sys/ioccom.h>
  82 #include <sys/endian.h>
  83 #include <sys/queue.h>
  84 #include <sys/kthread.h>
  85 #include <sys/taskqueue.h>
  86 #include <sys/proc.h>
  87 #include <sys/sysent.h>
  88
  89 #include <machine/bus.h>
  90 #include <machine/resource.h>
  91 #include <sys/rman.h>
  92
  93 #include <cam/cam.h>
  94 #include <cam/cam_ccb.h>
  95 #include <cam/scsi/scsi_all.h>
  96
  97 #include <dev/mps/mpi/mpi2_type.h>
  98 #include <dev/mps/mpi/mpi2.h>
  99 #include <dev/mps/mpi/mpi2_ioc.h>
 100 #include <dev/mps/mpi/mpi2_cnfg.h>
 101 #include <dev/mps/mpi/mpi2_init.h>
 102 #include <dev/mps/mpi/mpi2_tool.h>
 103 #include <dev/mps/mps_ioctl.h>
 104 #include <dev/mps/mpsvar.h>
 105 #include <dev/mps/mps_table.h>
 106 #include <dev/mps/mps_sas.h>
 107 #include <dev/pci/pcivar.h>
 108 #include <dev/pci/pcireg.h>
 109
 110 static d_open_t         mps_open;
 111 static d_close_t        mps_close;
 112 static d_ioctl_t        mps_ioctl_devsw;
 113
 114 static struct cdevsw mps_cdevsw = {
 115         .d_version =    D_VERSION,
 116         .d_flags =      0,
 117         .d_open =       mps_open,
 118         .d_close =      mps_close,
 119         .d_ioctl =      mps_ioctl_devsw,
 120         .d_name =       "mps",
 121 };
 122
 123 typedef int (mps_user_f)(struct mps_command *, struct mps_usr_command *);
 124 static mps_user_f       mpi_pre_ioc_facts;
 125 static mps_user_f       mpi_pre_port_facts;
 126 static mps_user_f       mpi_pre_fw_download;
 127 static mps_user_f       mpi_pre_fw_upload;
 128 static mps_user_f       mpi_pre_sata_passthrough;
 129 static mps_user_f       mpi_pre_smp_passthrough;
 130 static mps_user_f       mpi_pre_config;
 131 static mps_user_f       mpi_pre_sas_io_unit_control;
 132
 133 static int mps_user_read_cfg_header(struct mps_softc *,
 134                                     struct mps_cfg_page_req *);
 135 static int mps_user_read_cfg_page(struct mps_softc *,
 136                                   struct mps_cfg_page_req *, void *);
 137 static int mps_user_read_extcfg_header(struct mps_softc *,
 138                                      struct mps_ext_cfg_page_req *);
 139 static int mps_user_read_extcfg_page(struct mps_softc *,
 140                                      struct mps_ext_cfg_page_req *, void *);
 141 static int mps_user_write_cfg_page(struct mps_softc *,
 142                                    struct mps_cfg_page_req *, void *);
 143 static int mps_user_setup_request(struct mps_command *,
 144                                   struct mps_usr_command *);
 145 static int mps_user_command(struct mps_softc *, struct mps_usr_command *);
 146
 147 static int mps_user_pass_thru(struct mps_softc *sc, mps_pass_thru_t *data);
 148 static void mps_user_get_adapter_data(struct mps_softc *sc,
 149     mps_adapter_data_t *data);
 150 static void mps_user_read_pci_info(struct mps_softc *sc,
 151     mps_pci_info_t *data);
 152 static uint8_t mps_get_fw_diag_buffer_number(struct mps_softc *sc,
 153     uint32_t unique_id);
 154 static int mps_post_fw_diag_buffer(struct mps_softc *sc,
 155     mps_fw_diagnostic_buffer_t *pBuffer, uint32_t *return_code);
 156 static int mps_release_fw_diag_buffer(struct mps_softc *sc,
 157     mps_fw_diagnostic_buffer_t *pBuffer, uint32_t *return_code,
 158     uint32_t diag_type);
 159 static int mps_diag_register(struct mps_softc *sc,
 160     mps_fw_diag_register_t *diag_register, uint32_t *return_code);
 161 static int mps_diag_unregister(struct mps_softc *sc,
 162     mps_fw_diag_unregister_t *diag_unregister, uint32_t *return_code);
 163 static int mps_diag_query(struct mps_softc *sc, mps_fw_diag_query_t *diag_query,
 164     uint32_t *return_code);
 165 static int mps_diag_read_buffer(struct mps_softc *sc,
 166     mps_diag_read_buffer_t *diag_read_buffer, uint8_t *ioctl_buf,
 167     uint32_t *return_code);
 168 static int mps_diag_release(struct mps_softc *sc,
 169     mps_fw_diag_release_t *diag_release, uint32_t *return_code);
 170 static int mps_do_diag_action(struct mps_softc *sc, uint32_t action,
 171     uint8_t *diag_action, uint32_t length, uint32_t *return_code);
 172 static int mps_user_diag_action(struct mps_softc *sc, mps_diag_action_t *data);
 173 static void mps_user_event_query(struct mps_softc *sc, mps_event_query_t *data);
 174 static void mps_user_event_enable(struct mps_softc *sc,
 175     mps_event_enable_t *data);
 176 static int mps_user_event_report(struct mps_softc *sc,
 177     mps_event_report_t *data);
 178 static int mps_user_reg_access(struct mps_softc *sc, mps_reg_access_t *data);
 179 static int mps_user_btdh(struct mps_softc *sc, mps_btdh_mapping_t *data);
 180
 181 static MALLOC_DEFINE(M_MPSUSER, "mps_user", "Buffers for mps(4) ioctls");
 182
 183 /* Macros from compat/freebsd32/freebsd32.h */
 184 #define PTRIN(v)        (void *)(uintptr_t)(v)
 185 #define PTROUT(v)       (uint32_t)(uintptr_t)(v)
 186
 187 #define CP(src,dst,fld) do { (dst).fld = (src).fld; } while (0)
 188 #define PTRIN_CP(src,dst,fld)                           \
 189         do { (dst).fld = PTRIN((src).fld); } while (0)
 190 #define PTROUT_CP(src,dst,fld) \
 191         do { (dst).fld = PTROUT((src).fld); } while (0)
 192
 193 int
 194 mps_attach_user(struct mps_softc *sc)
 195 {
 196         int unit;
 197
 198         unit = device_get_unit(sc->mps_dev);
 199         sc->mps_cdev = make_dev(&mps_cdevsw, unit, UID_ROOT, GID_OPERATOR, 0640,
 200             "mps%d", unit);
 201         if (sc->mps_cdev == NULL) {
 202                 return (ENOMEM);
 203         }
 204         sc->mps_cdev->si_drv1 = sc;
 205         return (0);
 206 }
 207
 208 void
 209 mps_detach_user(struct mps_softc *sc)
 210 {
 211
 212         /* XXX: do a purge of pending requests? */
 213         if (sc->mps_cdev != NULL)
 214                 destroy_dev(sc->mps_cdev);
 215 }
 216
 217 static int
 218 mps_open(struct cdev *dev, int flags, int fmt, struct thread *td)
 219 {
 220
 221         return (0);
 222 }
 223
 224 static int
 225 mps_close(struct cdev *dev, int flags, int fmt, struct thread *td)
 226 {
 227
 228         return (0);
 229 }
 230
 231 static int
 232 mps_user_read_cfg_header(struct mps_softc *sc,
 233     struct mps_cfg_page_req *page_req)
 234 {
 235         MPI2_CONFIG_PAGE_HEADER *hdr;
 236         struct mps_config_params params;
 237         int         error;
 238
 239         hdr = &params.hdr.Struct;
 240         params.action = MPI2_CONFIG_ACTION_PAGE_HEADER;
 241         params.page_address = le32toh(page_req->page_address);
 242         hdr->PageVersion = 0;
 243         hdr->PageLength = 0;
 244         hdr->PageNumber = page_req->header.PageNumber;
 245         hdr->PageType = page_req->header.PageType;
 246         params.buffer = NULL;
 247         params.length = 0;
 248         params.callback = NULL;
 249
 250         if ((error = mps_read_config_page(sc, &params)) != 0) {
 251                 /*
 252                  * Leave the request. Without resetting the chip, it's
 253                  * still owned by it and we'll just get into trouble
 254                  * freeing it now. Mark it as abandoned so that if it
 255                  * shows up later it can be freed.
 256                  */
 257                 mps_printf(sc, "read_cfg_header timed out\n");
 258                 return (ETIMEDOUT);
 259         }
 260
 261         page_req->ioc_status = htole16(params.status);
 262         if ((page_req->ioc_status & MPI2_IOCSTATUS_MASK) ==
 263             MPI2_IOCSTATUS_SUCCESS) {
 264                 bcopy(hdr, &page_req->header, sizeof(page_req->header));
 265         }
 266
 267         return (0);
 268 }
 269
 270 static int
 271 mps_user_read_cfg_page(struct mps_softc *sc, struct mps_cfg_page_req *page_req,
 272     void *buf)
 273 {
 274         MPI2_CONFIG_PAGE_HEADER *reqhdr, *hdr;
 275         struct mps_config_params params;
 276         int           error;
 277
 278         reqhdr = buf;
 279         hdr = &params.hdr.Struct;
 280         hdr->PageVersion = reqhdr->PageVersion;
 281         hdr->PageLength = reqhdr->PageLength;
 282         hdr->PageNumber = reqhdr->PageNumber;
 283         hdr->PageType = reqhdr->PageType & MPI2_CONFIG_PAGETYPE_MASK;
 284         params.action = MPI2_CONFIG_ACTION_PAGE_READ_CURRENT;
 285         params.page_address = le32toh(page_req->page_address);
 286         params.buffer = buf;
 287         params.length = le32toh(page_req->len);
 288         params.callback = NULL;
 289
 290         if ((error = mps_read_config_page(sc, &params)) != 0) {
 291                 mps_printf(sc, "mps_user_read_cfg_page timed out\n");
 292                 return (ETIMEDOUT);
 293         }
 294
 295         page_req->ioc_status = htole16(params.status);
 296         return (0);
 297 }
 298
 299 static int
 300 mps_user_read_extcfg_header(struct mps_softc *sc,
 301     struct mps_ext_cfg_page_req *ext_page_req)
 302 {
 303         MPI2_CONFIG_EXTENDED_PAGE_HEADER *hdr;
 304         struct mps_config_params params;
 305         int         error;
 306
 307         hdr = &params.hdr.Ext;
 308         params.action = MPI2_CONFIG_ACTION_PAGE_HEADER;
 309         hdr->PageVersion = ext_page_req->header.PageVersion;
 310         hdr->PageType = MPI2_CONFIG_PAGETYPE_EXTENDED;
 311         hdr->ExtPageLength = 0;
 312         hdr->PageNumber = ext_page_req->header.PageNumber;
 313         hdr->ExtPageType = ext_page_req->header.ExtPageType;
 314         params.page_address = le32toh(ext_page_req->page_address);
 315         params.buffer = NULL;
 316         params.length = 0;
 317         params.callback = NULL;
 318
 319         if ((error = mps_read_config_page(sc, &params)) != 0) {
 320                 /*
 321                  * Leave the request. Without resetting the chip, it's
 322                  * still owned by it and we'll just get into trouble
 323                  * freeing it now. Mark it as abandoned so that if it
 324                  * shows up later it can be freed.
 325                  */
 326                 mps_printf(sc, "mps_user_read_extcfg_header timed out\n");
 327                 return (ETIMEDOUT);
 328         }
 329
 330         ext_page_req->ioc_status = htole16(params.status);
 331         if ((ext_page_req->ioc_status & MPI2_IOCSTATUS_MASK) ==
 332             MPI2_IOCSTATUS_SUCCESS) {
 333                 ext_page_req->header.PageVersion = hdr->PageVersion;
 334                 ext_page_req->header.PageNumber = hdr->PageNumber;
 335                 ext_page_req->header.PageType = hdr->PageType;
 336                 ext_page_req->header.ExtPageLength = hdr->ExtPageLength;
 337                 ext_page_req->header.ExtPageType = hdr->ExtPageType;
 338         }
 339
 340         return (0);
 341 }
 342
 343 static int
 344 mps_user_read_extcfg_page(struct mps_softc *sc,
 345     struct mps_ext_cfg_page_req *ext_page_req, void *buf)
 346 {
 347         MPI2_CONFIG_EXTENDED_PAGE_HEADER *reqhdr, *hdr;
 348         struct mps_config_params params;
 349         int error;
 350
 351         reqhdr = buf;
 352         hdr = &params.hdr.Ext;
 353         params.action = MPI2_CONFIG_ACTION_PAGE_READ_CURRENT;
 354         params.page_address = le32toh(ext_page_req->page_address);
 355         hdr->PageVersion = reqhdr->PageVersion;
 356         hdr->PageType = MPI2_CONFIG_PAGETYPE_EXTENDED;
 357         hdr->PageNumber = reqhdr->PageNumber;
 358         hdr->ExtPageType = reqhdr->ExtPageType;
 359         hdr->ExtPageLength = reqhdr->ExtPageLength;
 360         params.buffer = buf;
 361         params.length = le32toh(ext_page_req->len);
 362         params.callback = NULL;
 363
 364         if ((error = mps_read_config_page(sc, &params)) != 0) {
 365                 mps_printf(sc, "mps_user_read_extcfg_page timed out\n");
 366                 return (ETIMEDOUT);
 367         }
 368
 369         ext_page_req->ioc_status = htole16(params.status);
 370         return (0);
 371 }
 372
 373 static int
 374 mps_user_write_cfg_page(struct mps_softc *sc,
 375     struct mps_cfg_page_req *page_req, void *buf)
 376 {
 377         MPI2_CONFIG_PAGE_HEADER *reqhdr, *hdr;
 378         struct mps_config_params params;
 379         u_int         hdr_attr;
 380         int           error;
 381
 382         reqhdr = buf;
 383         hdr = &params.hdr.Struct;
 384         hdr_attr = reqhdr->PageType & MPI2_CONFIG_PAGEATTR_MASK;
 385         if (hdr_attr != MPI2_CONFIG_PAGEATTR_CHANGEABLE &&
 386             hdr_attr != MPI2_CONFIG_PAGEATTR_PERSISTENT) {
 387                 mps_printf(sc, "page type 0x%x not changeable\n",
 388                         reqhdr->PageType & MPI2_CONFIG_PAGETYPE_MASK);
 389                 return (EINVAL);
 390         }
 391
 392         /*
 393          * There isn't any point in restoring stripped out attributes
 394          * if you then mask them going down to issue the request.
 395          */
 396
 397         hdr->PageVersion = reqhdr->PageVersion;
 398         hdr->PageLength = reqhdr->PageLength;
 399         hdr->PageNumber = reqhdr->PageNumber;
 400         hdr->PageType = reqhdr->PageType;
 401         params.action = MPI2_CONFIG_ACTION_PAGE_WRITE_CURRENT;
 402         params.page_address = le32toh(page_req->page_address);
 403         params.buffer = buf;
 404         params.length = le32toh(page_req->len);
 405         params.callback = NULL;
 406
 407         if ((error = mps_write_config_page(sc, &params)) != 0) {
 408                 mps_printf(sc, "mps_write_cfg_page timed out\n");
 409                 return (ETIMEDOUT);
 410         }
 411
 412         page_req->ioc_status = htole16(params.status);
 413         return (0);
 414 }
 415
 416 void
 417 mpi_init_sge(struct mps_command *cm, void *req, void *sge)
 418 {
 419         int off, space;
 420
 421         space = (int)cm->cm_sc->facts->IOCRequestFrameSize * 4;
 422         off = (uintptr_t)sge - (uintptr_t)req;
 423
 424         KASSERT(off < space, ("bad pointers %p %p, off %d, space %d",
 425             req, sge, off, space));
 426
 427         cm->cm_sge = sge;
 428         cm->cm_sglsize = space - off;
 429 }
 430
 431 /*
 432  * Prepare the mps_command for an IOC_FACTS request.
 433  */
 434 static int
 435 mpi_pre_ioc_facts(struct mps_command *cm, struct mps_usr_command *cmd)
 436 {
 437         MPI2_IOC_FACTS_REQUEST *req = (void *)cm->cm_req;
 438         MPI2_IOC_FACTS_REPLY *rpl;
 439
 440         if (cmd->req_len != sizeof *req)
 441                 return (EINVAL);
 442         if (cmd->rpl_len != sizeof *rpl)
 443                 return (EINVAL);
 444
 445         cm->cm_sge = NULL;
 446         cm->cm_sglsize = 0;
 447         return (0);
 448 }
 449
 450 /*
 451  * Prepare the mps_command for a PORT_FACTS request.
 452  */
 453 static int
 454 mpi_pre_port_facts(struct mps_command *cm, struct mps_usr_command *cmd)
 455 {
 456         MPI2_PORT_FACTS_REQUEST *req = (void *)cm->cm_req;
 457         MPI2_PORT_FACTS_REPLY *rpl;
 458
 459         if (cmd->req_len != sizeof *req)
 460                 return (EINVAL);
 461         if (cmd->rpl_len != sizeof *rpl)
 462                 return (EINVAL);
 463
 464         cm->cm_sge = NULL;
 465         cm->cm_sglsize = 0;
 466         return (0);
 467 }
 468
 469 /*
 470  * Prepare the mps_command for a FW_DOWNLOAD request.
 471  */
 472 static int
 473 mpi_pre_fw_download(struct mps_command *cm, struct mps_usr_command *cmd)
 474 {
 475         MPI2_FW_DOWNLOAD_REQUEST *req = (void *)cm->cm_req;
 476         MPI2_FW_DOWNLOAD_REPLY *rpl;
 477         MPI2_FW_DOWNLOAD_TCSGE tc;
 478         int error;
 479
 480         /*
 481          * This code assumes there is room in the request's SGL for
 482          * the TransactionContext plus at least a SGL chain element.
 483          */
 484         CTASSERT(sizeof req->SGL >= sizeof tc + MPS_SGC_SIZE);
 485
 486         if (cmd->req_len != sizeof *req)
 487                 return (EINVAL);
 488         if (cmd->rpl_len != sizeof *rpl)
 489                 return (EINVAL);
 490
 491         if (cmd->len == 0)
 492                 return (EINVAL);
 493
 494         error = copyin(cmd->buf, cm->cm_data, cmd->len);
 495         if (error != 0)
 496                 return (error);
 497
 498         mpi_init_sge(cm, req, &req->SGL);
 499         bzero(&tc, sizeof tc);
 500
 501         /*
 502          * For now, the F/W image must be provided in a single request.
 503          */
 504         if ((req->MsgFlags & MPI2_FW_DOWNLOAD_MSGFLGS_LAST_SEGMENT) == 0)
 505                 return (EINVAL);
 506         if (req->TotalImageSize != cmd->len)
 507                 return (EINVAL);
 508
 509         /*
 510          * The value of the first two elements is specified in the
 511          * Fusion-MPT Message Passing Interface document.
 512          */
 513         tc.ContextSize = 0;
 514         tc.DetailsLength = 12;
 515         tc.ImageOffset = 0;
 516         tc.ImageSize = cmd->len;
 517
 518         cm->cm_flags |= MPS_CM_FLAGS_DATAOUT;
 519
 520         return (mps_push_sge(cm, &tc, sizeof tc, 0));
 521 }
 522
 523 /*
 524  * Prepare the mps_command for a FW_UPLOAD request.
 525  */
 526 static int
 527 mpi_pre_fw_upload(struct mps_command *cm, struct mps_usr_command *cmd)
 528 {
 529         MPI2_FW_UPLOAD_REQUEST *req = (void *)cm->cm_req;
 530         MPI2_FW_UPLOAD_REPLY *rpl;
 531         MPI2_FW_UPLOAD_TCSGE tc;
 532
 533         /*
 534          * This code assumes there is room in the request's SGL for
 535          * the TransactionContext plus at least a SGL chain element.
 536          */
 537         CTASSERT(sizeof req->SGL >= sizeof tc + MPS_SGC_SIZE);
 538
 539         if (cmd->req_len != sizeof *req)
 540                 return (EINVAL);
 541         if (cmd->rpl_len != sizeof *rpl)
 542                 return (EINVAL);
 543
 544         mpi_init_sge(cm, req, &req->SGL);
 545         bzero(&tc, sizeof tc);
 546
 547         /*
 548          * The value of the first two elements is specified in the
 549          * Fusion-MPT Message Passing Interface document.
 550          */
 551         tc.ContextSize = 0;
 552         tc.DetailsLength = 12;
 553         /*
 554          * XXX Is there any reason to fetch a partial image?  I.e. to
 555          * set ImageOffset to something other than 0?
 556          */
 557         tc.ImageOffset = 0;
 558         tc.ImageSize = cmd->len;
 559
 560         cm->cm_flags |= MPS_CM_FLAGS_DATAIN;
 561
 562         return (mps_push_sge(cm, &tc, sizeof tc, 0));
 563 }
 564
 565 /*
 566  * Prepare the mps_command for a SATA_PASSTHROUGH request.
 567  */
 568 static int
 569 mpi_pre_sata_passthrough(struct mps_command *cm, struct mps_usr_command *cmd)
 570 {
 571         MPI2_SATA_PASSTHROUGH_REQUEST *req = (void *)cm->cm_req;
 572         MPI2_SATA_PASSTHROUGH_REPLY *rpl;
 573
 574         if (cmd->req_len != sizeof *req)
 575                 return (EINVAL);
 576         if (cmd->rpl_len != sizeof *rpl)
 577                 return (EINVAL);
 578
 579         mpi_init_sge(cm, req, &req->SGL);
 580         return (0);
 581 }
 582
 583 /*
 584  * Prepare the mps_command for a SMP_PASSTHROUGH request.
 585  */
 586 static int
 587 mpi_pre_smp_passthrough(struct mps_command *cm, struct mps_usr_command *cmd)
 588 {
 589         MPI2_SMP_PASSTHROUGH_REQUEST *req = (void *)cm->cm_req;
 590         MPI2_SMP_PASSTHROUGH_REPLY *rpl;
 591
 592         if (cmd->req_len != sizeof *req)
 593                 return (EINVAL);
 594         if (cmd->rpl_len != sizeof *rpl)
 595                 return (EINVAL);
 596
 597         mpi_init_sge(cm, req, &req->SGL);
 598         return (0);
 599 }
 600
 601 /*
 602  * Prepare the mps_command for a CONFIG request.
 603  */
 604 static int
 605 mpi_pre_config(struct mps_command *cm, struct mps_usr_command *cmd)
 606 {
 607         MPI2_CONFIG_REQUEST *req = (void *)cm->cm_req;
 608         MPI2_CONFIG_REPLY *rpl;
 609
 610         if (cmd->req_len != sizeof *req)
 611                 return (EINVAL);
 612         if (cmd->rpl_len != sizeof *rpl)
 613                 return (EINVAL);
 614
 615         mpi_init_sge(cm, req, &req->PageBufferSGE);
 616         return (0);
 617 }
 618
 619 /*
 620  * Prepare the mps_command for a SAS_IO_UNIT_CONTROL request.
 621  */
 622 static int
 623 mpi_pre_sas_io_unit_control(struct mps_command *cm,
 624                              struct mps_usr_command *cmd)
 625 {
 626
 627         cm->cm_sge = NULL;
 628         cm->cm_sglsize = 0;
 629         return (0);
 630 }
 631
 632 /*
 633  * A set of functions to prepare an mps_command for the various
 634  * supported requests.
 635  */
 636 struct mps_user_func {
 637         U8              Function;
 638         mps_user_f      *f_pre;
 639 } mps_user_func_list[] = {
 640         { MPI2_FUNCTION_IOC_FACTS,              mpi_pre_ioc_facts },
 641         { MPI2_FUNCTION_PORT_FACTS,             mpi_pre_port_facts },
 642         { MPI2_FUNCTION_FW_DOWNLOAD,            mpi_pre_fw_download },
 643         { MPI2_FUNCTION_FW_UPLOAD,              mpi_pre_fw_upload },
 644         { MPI2_FUNCTION_SATA_PASSTHROUGH,       mpi_pre_sata_passthrough },
 645         { MPI2_FUNCTION_SMP_PASSTHROUGH,        mpi_pre_smp_passthrough},
 646         { MPI2_FUNCTION_CONFIG,                 mpi_pre_config},
 647         { MPI2_FUNCTION_SAS_IO_UNIT_CONTROL,    mpi_pre_sas_io_unit_control },
 648         { 0xFF,                                 NULL } /* list end */
 649 };
 650
 651 static int
 652 mps_user_setup_request(struct mps_command *cm, struct mps_usr_command *cmd)
 653 {
 654         MPI2_REQUEST_HEADER *hdr = (MPI2_REQUEST_HEADER *)cm->cm_req;
 655         struct mps_user_func *f;
 656
 657         for (f = mps_user_func_list; f->f_pre != NULL; f++) {
 658                 if (hdr->Function == f->Function)
 659                         return (f->f_pre(cm, cmd));
 660         }
 661         return (EINVAL);
 662 }
 663
 664 static int
 665 mps_user_command(struct mps_softc *sc, struct mps_usr_command *cmd)
 666 {
 667         MPI2_REQUEST_HEADER *hdr;
 668         MPI2_DEFAULT_REPLY *rpl;
 669         void *buf = NULL;
 670         struct mps_command *cm = NULL;
 671         int err = 0;
 672         int sz;
 673
 674         mps_lock(sc);
 675         cm = mps_alloc_command(sc);
 676
 677         if (cm == NULL) {
 678                 mps_printf(sc, "%s: no mps requests\n", __func__);
 679                 err = ENOMEM;
 680                 goto Ret;
 681         }
 682         mps_unlock(sc);
 683
 684         hdr = (MPI2_REQUEST_HEADER *)cm->cm_req;
 685
 686         mps_dprint(sc, MPS_USER, "%s: req %p %d  rpl %p %d\n", __func__,
 687             cmd->req, cmd->req_len, cmd->rpl, cmd->rpl_len);
 688
 689         if (cmd->req_len > (int)sc->facts->IOCRequestFrameSize * 4) {
 690                 err = EINVAL;
 691                 goto RetFreeUnlocked;
 692         }
 693         err = copyin(cmd->req, hdr, cmd->req_len);
 694         if (err != 0)
 695                 goto RetFreeUnlocked;
 696
 697         mps_dprint(sc, MPS_USER, "%s: Function %02X MsgFlags %02X\n", __func__,
 698             hdr->Function, hdr->MsgFlags);
 699
 700         if (cmd->len > 0) {
 701                 buf = malloc(cmd->len, M_MPSUSER, M_WAITOK|M_ZERO);
 702                 if(!buf) {
 703                         mps_printf(sc, "Cannot allocate memory %s %d\n",
 704                          __func__, __LINE__);
 705                         return (ENOMEM);
 706                 }
 707                 cm->cm_data = buf;
 708                 cm->cm_length = cmd->len;
 709         } else {
 710                 cm->cm_data = NULL;
 711                 cm->cm_length = 0;
 712         }
 713
 714         cm->cm_flags = MPS_CM_FLAGS_SGE_SIMPLE;
 715         cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
 716
 717         err = mps_user_setup_request(cm, cmd);
 718         if (err == EINVAL) {
 719                 mps_printf(sc, "%s: unsupported parameter or unsupported "
 720                     "function in request (function = 0x%X)\n", __func__,
 721                     hdr->Function);
 722         }
 723         if (err != 0)
 724                 goto RetFreeUnlocked;
 725
 726         mps_lock(sc);
 727         err = mps_wait_command(sc, cm, 60, CAN_SLEEP);
 728
 729         if (err) {
 730                 mps_printf(sc, "%s: invalid request: error %d\n",
 731                     __func__, err);
 732                 goto Ret;
 733         }
 734
 735         rpl = (MPI2_DEFAULT_REPLY *)cm->cm_reply;
 736         if (rpl != NULL)
 737                 sz = rpl->MsgLength * 4;
 738         else
 739                 sz = 0;
 740
 741         if (sz > cmd->rpl_len) {
 742                 mps_printf(sc, "%s: user reply buffer (%d) smaller than "
 743                     "returned buffer (%d)\n", __func__, cmd->rpl_len, sz);
 744                 sz = cmd->rpl_len;
 745         }
 746
 747         mps_unlock(sc);
 748         copyout(rpl, cmd->rpl, sz);
 749         if (buf != NULL)
 750                 copyout(buf, cmd->buf, cmd->len);
 751         mps_dprint(sc, MPS_USER, "%s: reply size %d\n", __func__, sz);
 752
 753 RetFreeUnlocked:
 754         mps_lock(sc);
 755         if (cm != NULL)
 756                 mps_free_command(sc, cm);
 757 Ret:
 758         mps_unlock(sc);
 759         if (buf != NULL)
 760                 free(buf, M_MPSUSER);
 761         return (err);
 762 }
 763
 764 static int
 765 mps_user_pass_thru(struct mps_softc *sc, mps_pass_thru_t *data)
 766 {
 767         MPI2_REQUEST_HEADER     *hdr, tmphdr;
 768         MPI2_DEFAULT_REPLY      *rpl;
 769         struct mps_command      *cm = NULL;
 770         int                     err = 0, dir = 0, sz;
 771         uint8_t                 function = 0;
 772         u_int                   sense_len;
 773         struct mpssas_target    *targ = NULL;
 774
 775         /*
 776          * Only allow one passthru command at a time.  Use the MPS_FLAGS_BUSY
 777          * bit to denote that a passthru is being processed.
 778          */
 779         mps_lock(sc);
 780         if (sc->mps_flags & MPS_FLAGS_BUSY) {
 781                 mps_dprint(sc, MPS_USER, "%s: Only one passthru command "
 782                     "allowed at a single time.", __func__);
 783                 mps_unlock(sc);
 784                 return (EBUSY);
 785         }
 786         sc->mps_flags |= MPS_FLAGS_BUSY;
 787         mps_unlock(sc);
 788
 789         /*
 790          * Do some validation on data direction.  Valid cases are:
 791          *    1) DataSize is 0 and direction is NONE
 792          *    2) DataSize is non-zero and one of:
 793          *        a) direction is READ or
 794          *        b) direction is WRITE or
 795          *        c) direction is BOTH and DataOutSize is non-zero
 796          * If valid and the direction is BOTH, change the direction to READ.
 797          * if valid and the direction is not BOTH, make sure DataOutSize is 0.
 798          */
 799         if (((data->DataSize == 0) &&
 800             (data->DataDirection == MPS_PASS_THRU_DIRECTION_NONE)) ||
 801             ((data->DataSize != 0) &&
 802             ((data->DataDirection == MPS_PASS_THRU_DIRECTION_READ) ||
 803             (data->DataDirection == MPS_PASS_THRU_DIRECTION_WRITE) ||
 804             ((data->DataDirection == MPS_PASS_THRU_DIRECTION_BOTH) &&
 805             (data->DataOutSize != 0))))) {
 806                 if (data->DataDirection == MPS_PASS_THRU_DIRECTION_BOTH)
 807                         data->DataDirection = MPS_PASS_THRU_DIRECTION_READ;
 808                 else
 809                         data->DataOutSize = 0;
 810         } else
 811                 return (EINVAL);
 812
 813         mps_dprint(sc, MPS_USER, "%s: req 0x%jx %d  rpl 0x%jx %d "
 814             "data in 0x%jx %d data out 0x%jx %d data dir %d\n", __func__,
 815             data->PtrRequest, data->RequestSize, data->PtrReply,
 816             data->ReplySize, data->PtrData, data->DataSize,
 817             data->PtrDataOut, data->DataOutSize, data->DataDirection);
 818
 819         /*
 820          * copy in the header so we know what we're dealing with before we
 821          * commit to allocating a command for it.
 822          */
 823         err = copyin(PTRIN(data->PtrRequest), &tmphdr, data->RequestSize);
 824         if (err != 0)
 825                 goto RetFreeUnlocked;
 826
 827         if (data->RequestSize > (int)sc->facts->IOCRequestFrameSize * 4) {
 828                 err = EINVAL;
 829                 goto RetFreeUnlocked;
 830         }
 831
 832         function = tmphdr.Function;
 833         mps_dprint(sc, MPS_USER, "%s: Function %02X MsgFlags %02X\n", __func__,
 834             function, tmphdr.MsgFlags);
 835
 836         /*
 837          * Handle a passthru TM request.
 838          */
 839         if (function == MPI2_FUNCTION_SCSI_TASK_MGMT) {
 840                 MPI2_SCSI_TASK_MANAGE_REQUEST   *task;
 841
 842                 mps_lock(sc);
 843                 cm = mpssas_alloc_tm(sc);
 844                 if (cm == NULL) {
 845                         err = EINVAL;
 846                         goto Ret;
 847                 }
 848
 849                 /* Copy the header in.  Only a small fixup is needed. */
 850                 task = (MPI2_SCSI_TASK_MANAGE_REQUEST *)cm->cm_req;
 851                 bcopy(&tmphdr, task, data->RequestSize);
 852                 task->TaskMID = cm->cm_desc.Default.SMID;
 853
 854                 cm->cm_data = NULL;
 855                 cm->cm_desc.HighPriority.RequestFlags =
 856                     MPI2_REQ_DESCRIPT_FLAGS_HIGH_PRIORITY;
 857                 cm->cm_complete = NULL;
 858                 cm->cm_complete_data = NULL;
 859
 860                 targ = mpssas_find_target_by_handle(sc->sassc, 0,
 861                     task->DevHandle);
 862                 if (targ == NULL) {
 863                         mps_dprint(sc, MPS_INFO,
 864                            "%s %d : invalid handle for requested TM 0x%x \n",
 865                            __func__, __LINE__, task->DevHandle);
 866                         err = 1;
 867                 } else {
 868                         mpssas_prepare_for_tm(sc, cm, targ, CAM_LUN_WILDCARD);
 869                         err = mps_wait_command(sc, cm, 30, CAN_SLEEP);
 870                 }
 871
 872                 if (err != 0) {
 873                         err = EIO;
 874                         mps_dprint(sc, MPS_FAULT, "%s: task management failed",
 875                             __func__);
 876                 }
 877                 /*
 878                  * Copy the reply data and sense data to user space.
 879                  */
 880                 if (cm->cm_reply != NULL) {
 881                         rpl = (MPI2_DEFAULT_REPLY *)cm->cm_reply;
 882                         sz = rpl->MsgLength * 4;
 883
 884                         if (sz > data->ReplySize) {
 885                                 mps_printf(sc, "%s: user reply buffer (%d) "
 886                                     "smaller than returned buffer (%d)\n",
 887                                     __func__, data->ReplySize, sz);
 888                         }
 889                         mps_unlock(sc);
 890                         copyout(cm->cm_reply, PTRIN(data->PtrReply),
 891                             data->ReplySize);
 892                         mps_lock(sc);
 893                 }
 894                 mpssas_free_tm(sc, cm);
 895                 goto Ret;
 896         }
 897
 898         mps_lock(sc);
 899         cm = mps_alloc_command(sc);
 900
 901         if (cm == NULL) {
 902                 mps_printf(sc, "%s: no mps requests\n", __func__);
 903                 err = ENOMEM;
 904                 goto Ret;
 905         }
 906         mps_unlock(sc);
 907
 908         hdr = (MPI2_REQUEST_HEADER *)cm->cm_req;
 909         bcopy(&tmphdr, hdr, data->RequestSize);
 910
 911         /*
 912          * Do some checking to make sure the IOCTL request contains a valid
 913          * request.  Then set the SGL info.
 914          */
 915         mpi_init_sge(cm, hdr, (void *)((uint8_t *)hdr + data->RequestSize));
 916
 917         /*
 918          * Set up for read, write or both.  From check above, DataOutSize will
 919          * be 0 if direction is READ or WRITE, but it will have some non-zero
 920          * value if the direction is BOTH.  So, just use the biggest size to get
 921          * the cm_data buffer size.  If direction is BOTH, 2 SGLs need to be set
 922          * up; the first is for the request and the second will contain the
 923          * response data. cm_out_len needs to be set here and this will be used
 924          * when the SGLs are set up.
 925          */
 926         cm->cm_data = NULL;
 927         cm->cm_length = MAX(data->DataSize, data->DataOutSize);
 928         cm->cm_out_len = data->DataOutSize;
 929         cm->cm_flags = 0;
 930         if (cm->cm_length != 0) {
 931                 cm->cm_data = malloc(cm->cm_length, M_MPSUSER, M_WAITOK |
 932                     M_ZERO);
 933                 if (cm->cm_data == NULL) {
 934                         mps_dprint(sc, MPS_FAULT, "%s: alloc failed for IOCTL "
 935                             "passthru length %d\n", __func__, cm->cm_length);
 936                 } else {
 937                         cm->cm_flags = MPS_CM_FLAGS_DATAIN;
 938                         if (data->DataOutSize) {
 939                                 cm->cm_flags |= MPS_CM_FLAGS_DATAOUT;
 940                                 err = copyin(PTRIN(data->PtrDataOut),
 941                                     cm->cm_data, data->DataOutSize);
 942                         } else if (data->DataDirection ==
 943                             MPS_PASS_THRU_DIRECTION_WRITE) {
 944                                 cm->cm_flags = MPS_CM_FLAGS_DATAOUT;
 945                                 err = copyin(PTRIN(data->PtrData),
 946                                     cm->cm_data, data->DataSize);
 947                         }
 948                         if (err != 0)
 949                                 mps_dprint(sc, MPS_FAULT, "%s: failed to copy "
 950                                     "IOCTL data from user space\n", __func__);
 951                 }
 952         }
 953         cm->cm_flags |= MPS_CM_FLAGS_SGE_SIMPLE;
 954         cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
 955
 956         /*
 957          * Set up Sense buffer and SGL offset for IO passthru.  SCSI IO request
 958          * uses SCSI IO descriptor.
 959          */
 960         if ((function == MPI2_FUNCTION_SCSI_IO_REQUEST) ||
 961             (function == MPI2_FUNCTION_RAID_SCSI_IO_PASSTHROUGH)) {
 962                 MPI2_SCSI_IO_REQUEST    *scsi_io_req;
 963
 964                 scsi_io_req = (MPI2_SCSI_IO_REQUEST *)hdr;
 965                 /*
 966                  * Put SGE for data and data_out buffer at the end of
 967                  * scsi_io_request message header (64 bytes in total).
 968                  * Following above SGEs, the residual space will be used by
 969                  * sense data.
 970                  */
 971                 scsi_io_req->SenseBufferLength = (uint8_t)(data->RequestSize -
 972                     64);
 973                 scsi_io_req->SenseBufferLowAddress = htole32(cm->cm_sense_busaddr);
 974
 975                 /*
 976                  * Set SGLOffset0 value.  This is the number of dwords that SGL
 977                  * is offset from the beginning of MPI2_SCSI_IO_REQUEST struct.
 978                  */
 979                 scsi_io_req->SGLOffset0 = 24;
 980
 981                 /*
 982                  * Setup descriptor info.  RAID passthrough must use the
 983                  * default request descriptor which is already set, so if this
 984                  * is a SCSI IO request, change the descriptor to SCSI IO.
 985                  * Also, if this is a SCSI IO request, handle the reply in the
 986                  * mpssas_scsio_complete function.
 987                  */
 988                 if (function == MPI2_FUNCTION_SCSI_IO_REQUEST) {
 989                         cm->cm_desc.SCSIIO.RequestFlags =
 990                             MPI2_REQ_DESCRIPT_FLAGS_SCSI_IO;
 991                         cm->cm_desc.SCSIIO.DevHandle = scsi_io_req->DevHandle;
 992
 993                         /*
 994                          * Make sure the DevHandle is not 0 because this is a
 995                          * likely error.
 996                          */
 997                         if (scsi_io_req->DevHandle == 0) {
 998                                 err = EINVAL;
 999                                 goto RetFreeUnlocked;
1000                         }
1001                 }
1002         }
1003
1004         mps_lock(sc);
1005
1006         err = mps_wait_command(sc, cm, 30, CAN_SLEEP);
1007
1008         if (err) {
1009                 mps_printf(sc, "%s: invalid request: error %d\n", __func__,
1010                     err);
1011                 mps_unlock(sc);
1012                 goto RetFreeUnlocked;
1013         }
1014
1015         /*
1016          * Sync the DMA data, if any.  Then copy the data to user space.
1017          */
1018         if (cm->cm_data != NULL) {
1019                 if (cm->cm_flags & MPS_CM_FLAGS_DATAIN)
1020                         dir = BUS_DMASYNC_POSTREAD;
1021                 else if (cm->cm_flags & MPS_CM_FLAGS_DATAOUT)
1022                         dir = BUS_DMASYNC_POSTWRITE;
1023                 bus_dmamap_sync(sc->buffer_dmat, cm->cm_dmamap, dir);
1024                 bus_dmamap_unload(sc->buffer_dmat, cm->cm_dmamap);
1025
1026                 if (cm->cm_flags & MPS_CM_FLAGS_DATAIN) {
1027                         mps_unlock(sc);
1028                         err = copyout(cm->cm_data,
1029                             PTRIN(data->PtrData), data->DataSize);
1030                         mps_lock(sc);
1031                         if (err != 0)
1032                                 mps_dprint(sc, MPS_FAULT, "%s: failed to copy "
1033                                     "IOCTL data to user space\n", __func__);
1034                 }
1035         }
1036
1037         /*
1038          * Copy the reply data and sense data to user space.
1039          */
1040         if (cm->cm_reply != NULL) {
1041                 rpl = (MPI2_DEFAULT_REPLY *)cm->cm_reply;
1042                 sz = rpl->MsgLength * 4;
1043
1044                 if (sz > data->ReplySize) {
1045                         mps_printf(sc, "%s: user reply buffer (%d) smaller "
1046                             "than returned buffer (%d)\n", __func__,
1047                             data->ReplySize, sz);
1048                 }
1049                 mps_unlock(sc);
1050                 copyout(cm->cm_reply, PTRIN(data->PtrReply), data->ReplySize);
1051                 mps_lock(sc);
1052
1053                 if ((function == MPI2_FUNCTION_SCSI_IO_REQUEST) ||
1054                     (function == MPI2_FUNCTION_RAID_SCSI_IO_PASSTHROUGH)) {
1055                         if (((MPI2_SCSI_IO_REPLY *)rpl)->SCSIState &
1056                             MPI2_SCSI_STATE_AUTOSENSE_VALID) {
1057                                 sense_len =
1058                                     MIN((le32toh(((MPI2_SCSI_IO_REPLY *)rpl)->SenseCount)),
1059                                     sizeof(struct scsi_sense_data));
1060                                 mps_unlock(sc);
1061                                 copyout(cm->cm_sense, cm->cm_req + 64, sense_len);
1062                                 mps_lock(sc);
1063                         }
1064                 }
1065         }
1066         mps_unlock(sc);
1067
1068 RetFreeUnlocked:
1069         mps_lock(sc);
1070
1071         if (cm != NULL) {
1072                 if (cm->cm_data)
1073                         free(cm->cm_data, M_MPSUSER);
1074                 mps_free_command(sc, cm);
1075         }
1076 Ret:
1077         sc->mps_flags &= ~MPS_FLAGS_BUSY;
1078         mps_unlock(sc);
1079
1080         return (err);
1081 }
1082
1083 static void
1084 mps_user_get_adapter_data(struct mps_softc *sc, mps_adapter_data_t *data)
1085 {
1086         Mpi2ConfigReply_t       mpi_reply;
1087         Mpi2BiosPage3_t         config_page;
1088
1089         /*
1090          * Use the PCI interface functions to get the Bus, Device, and Function
1091          * information.
1092          */
1093         data->PciInformation.u.bits.BusNumber = pci_get_bus(sc->mps_dev);
1094         data->PciInformation.u.bits.DeviceNumber = pci_get_slot(sc->mps_dev);
1095         data->PciInformation.u.bits.FunctionNumber =
1096             pci_get_function(sc->mps_dev);
1097
1098         /*
1099          * Get the FW version that should already be saved in IOC Facts.
1100          */
1101         data->MpiFirmwareVersion = sc->facts->FWVersion.Word;
1102
1103         /*
1104          * General device info.
1105          */
1106         data->AdapterType = MPSIOCTL_ADAPTER_TYPE_SAS2;
1107         if (sc->mps_flags & MPS_FLAGS_WD_AVAILABLE)
1108                 data->AdapterType = MPSIOCTL_ADAPTER_TYPE_SAS2_SSS6200;
1109         data->PCIDeviceHwId = pci_get_device(sc->mps_dev);
1110         data->PCIDeviceHwRev = pci_read_config(sc->mps_dev, PCIR_REVID, 1);
1111         data->SubSystemId = pci_get_subdevice(sc->mps_dev);
1112         data->SubsystemVendorId = pci_get_subvendor(sc->mps_dev);
1113
1114         /*
1115          * Get the driver version.
1116          */
1117         strcpy((char *)&data->DriverVersion[0], MPS_DRIVER_VERSION);
1118
1119         /*
1120          * Need to get BIOS Config Page 3 for the BIOS Version.
1121          */
1122         data->BiosVersion = 0;
1123         mps_lock(sc);
1124         if (mps_config_get_bios_pg3(sc, &mpi_reply, &config_page))
1125                 printf("%s: Error while retrieving BIOS Version\n", __func__);
1126         else
1127                 data->BiosVersion = config_page.BiosVersion;
1128         mps_unlock(sc);
1129 }
1130
1131 static void
1132 mps_user_read_pci_info(struct mps_softc *sc, mps_pci_info_t *data)
1133 {
1134         int     i;
1135
1136         /*
1137          * Use the PCI interface functions to get the Bus, Device, and Function
1138          * information.
1139          */
1140         data->BusNumber = pci_get_bus(sc->mps_dev);
1141         data->DeviceNumber = pci_get_slot(sc->mps_dev);
1142         data->FunctionNumber = pci_get_function(sc->mps_dev);
1143
1144         /*
1145          * Now get the interrupt vector and the pci header.  The vector can
1146          * only be 0 right now.  The header is the first 256 bytes of config
1147          * space.
1148          */
1149         data->InterruptVector = 0;
1150         for (i = 0; i < sizeof (data->PciHeader); i++) {
1151                 data->PciHeader[i] = pci_read_config(sc->mps_dev, i, 1);
1152         }
1153 }
1154
1155 static uint8_t
1156 mps_get_fw_diag_buffer_number(struct mps_softc *sc, uint32_t unique_id)
1157 {
1158         uint8_t index;
1159
1160         for (index = 0; index < MPI2_DIAG_BUF_TYPE_COUNT; index++) {
1161                 if (sc->fw_diag_buffer_list[index].unique_id == unique_id) {
1162                         return (index);
1163                 }
1164         }
1165
1166         return (MPS_FW_DIAGNOSTIC_UID_NOT_FOUND);
1167 }
1168
1169 static int
1170 mps_post_fw_diag_buffer(struct mps_softc *sc,
1171     mps_fw_diagnostic_buffer_t *pBuffer, uint32_t *return_code)
1172 {
1173         MPI2_DIAG_BUFFER_POST_REQUEST   *req;
1174         MPI2_DIAG_BUFFER_POST_REPLY     *reply;
1175         struct mps_command              *cm = NULL;
1176         int                             i, status;
1177
1178         /*
1179          * If buffer is not enabled, just leave.
1180          */
1181         *return_code = MPS_FW_DIAG_ERROR_POST_FAILED;
1182         if (!pBuffer->enabled) {
1183                 return (MPS_DIAG_FAILURE);
1184         }
1185
1186         /*
1187          * Clear some flags initially.
1188          */
1189         pBuffer->force_release = FALSE;
1190         pBuffer->valid_data = FALSE;
1191         pBuffer->owned_by_firmware = FALSE;
1192
1193         /*
1194          * Get a command.
1195          */
1196         cm = mps_alloc_command(sc);
1197         if (cm == NULL) {
1198                 mps_printf(sc, "%s: no mps requests\n", __func__);
1199                 return (MPS_DIAG_FAILURE);
1200         }
1201
1202         /*
1203          * Build the request for releasing the FW Diag Buffer and send it.
1204          */
1205         req = (MPI2_DIAG_BUFFER_POST_REQUEST *)cm->cm_req;
1206         req->Function = MPI2_FUNCTION_DIAG_BUFFER_POST;
1207         req->BufferType = pBuffer->buffer_type;
1208         req->ExtendedType = pBuffer->extended_type;
1209         req->BufferLength = pBuffer->size;
1210         for (i = 0; i < (sizeof(req->ProductSpecific) / 4); i++)
1211                 req->ProductSpecific[i] = pBuffer->product_specific[i];
1212         mps_from_u64(sc->fw_diag_busaddr, &req->BufferAddress);
1213         cm->cm_data = NULL;
1214         cm->cm_length = 0;
1215         cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
1216         cm->cm_complete_data = NULL;
1217
1218         /*
1219          * Send command synchronously.
1220          */
1221         status = mps_wait_command(sc, cm, 30, CAN_SLEEP);
1222         if (status) {
1223                 mps_printf(sc, "%s: invalid request: error %d\n", __func__,
1224                     status);
1225                 status = MPS_DIAG_FAILURE;
1226                 goto done;
1227         }
1228
1229         /*
1230          * Process POST reply.
1231          */
1232         reply = (MPI2_DIAG_BUFFER_POST_REPLY *)cm->cm_reply;
1233         if ((le16toh(reply->IOCStatus) & MPI2_IOCSTATUS_MASK) !=
1234             MPI2_IOCSTATUS_SUCCESS) {
1235                 status = MPS_DIAG_FAILURE;
1236                 mps_dprint(sc, MPS_FAULT, "%s: post of FW  Diag Buffer failed "
1237                     "with IOCStatus = 0x%x, IOCLogInfo = 0x%x and "
1238                     "TransferLength = 0x%x\n", __func__,
1239                     le16toh(reply->IOCStatus), le32toh(reply->IOCLogInfo),
1240                     le32toh(reply->TransferLength));
1241                 goto done;
1242         }
1243
1244         /*
1245          * Post was successful.
1246          */
1247         pBuffer->valid_data = TRUE;
1248         pBuffer->owned_by_firmware = TRUE;
1249         *return_code = MPS_FW_DIAG_ERROR_SUCCESS;
1250         status = MPS_DIAG_SUCCESS;
1251
1252 done:
1253         mps_free_command(sc, cm);
1254         return (status);
1255 }
1256
1257 static int
1258 mps_release_fw_diag_buffer(struct mps_softc *sc,
1259     mps_fw_diagnostic_buffer_t *pBuffer, uint32_t *return_code,
1260     uint32_t diag_type)
1261 {
1262         MPI2_DIAG_RELEASE_REQUEST       *req;
1263         MPI2_DIAG_RELEASE_REPLY         *reply;
1264         struct mps_command              *cm = NULL;
1265         int                             status;
1266
1267         /*
1268          * If buffer is not enabled, just leave.
1269          */
1270         *return_code = MPS_FW_DIAG_ERROR_RELEASE_FAILED;
1271         if (!pBuffer->enabled) {
1272                 mps_dprint(sc, MPS_USER, "%s: This buffer type is not "
1273                     "supported by the IOC", __func__);
1274                 return (MPS_DIAG_FAILURE);
1275         }
1276
1277         /*
1278          * Clear some flags initially.
1279          */
1280         pBuffer->force_release = FALSE;
1281         pBuffer->valid_data = FALSE;
1282         pBuffer->owned_by_firmware = FALSE;
1283
1284         /*
1285          * Get a command.
1286          */
1287         cm = mps_alloc_command(sc);
1288         if (cm == NULL) {
1289                 mps_printf(sc, "%s: no mps requests\n", __func__);
1290                 return (MPS_DIAG_FAILURE);
1291         }
1292
1293         /*
1294          * Build the request for releasing the FW Diag Buffer and send it.
1295          */
1296         req = (MPI2_DIAG_RELEASE_REQUEST *)cm->cm_req;
1297         req->Function = MPI2_FUNCTION_DIAG_RELEASE;
1298         req->BufferType = pBuffer->buffer_type;
1299         cm->cm_data = NULL;
1300         cm->cm_length = 0;
1301         cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
1302         cm->cm_complete_data = NULL;
1303
1304         /*
1305          * Send command synchronously.
1306          */
1307         status = mps_wait_command(sc, cm, 30, CAN_SLEEP);
1308         if (status) {
1309                 mps_printf(sc, "%s: invalid request: error %d\n", __func__,
1310                     status);
1311                 status = MPS_DIAG_FAILURE;
1312                 goto done;
1313         }
1314
1315         /*
1316          * Process RELEASE reply.
1317          */
1318         reply = (MPI2_DIAG_RELEASE_REPLY *)cm->cm_reply;
1319         if (((le16toh(reply->IOCStatus) & MPI2_IOCSTATUS_MASK) !=
1320             MPI2_IOCSTATUS_SUCCESS) || pBuffer->owned_by_firmware) {
1321                 status = MPS_DIAG_FAILURE;
1322                 mps_dprint(sc, MPS_FAULT, "%s: release of FW Diag Buffer "
1323                     "failed with IOCStatus = 0x%x and IOCLogInfo = 0x%x\n",
1324                     __func__, le16toh(reply->IOCStatus),
1325                     le32toh(reply->IOCLogInfo));
1326                 goto done;
1327         }
1328
1329         /*
1330          * Release was successful.
1331          */
1332         *return_code = MPS_FW_DIAG_ERROR_SUCCESS;
1333         status = MPS_DIAG_SUCCESS;
1334
1335         /*
1336          * If this was for an UNREGISTER diag type command, clear the unique ID.
1337          */
1338         if (diag_type == MPS_FW_DIAG_TYPE_UNREGISTER) {
1339                 pBuffer->unique_id = MPS_FW_DIAG_INVALID_UID;
1340         }
1341
1342 done:
1343         return (status);
1344 }
1345
1346 static int
1347 mps_diag_register(struct mps_softc *sc, mps_fw_diag_register_t *diag_register,
1348     uint32_t *return_code)
1349 {
1350         mps_fw_diagnostic_buffer_t      *pBuffer;
1351         uint8_t                         extended_type, buffer_type, i;
1352         uint32_t                        buffer_size;
1353         uint32_t                        unique_id;
1354         int                             status;
1355
1356         extended_type = diag_register->ExtendedType;
1357         buffer_type = diag_register->BufferType;
1358         buffer_size = diag_register->RequestedBufferSize;
1359         unique_id = diag_register->UniqueId;
1360
1361         /*
1362          * Check for valid buffer type
1363          */
1364         if (buffer_type >= MPI2_DIAG_BUF_TYPE_COUNT) {
1365                 *return_code = MPS_FW_DIAG_ERROR_INVALID_PARAMETER;
1366                 return (MPS_DIAG_FAILURE);
1367         }
1368
1369         /*
1370          * Get the current buffer and look up the unique ID.  The unique ID
1371          * should not be found.  If it is, the ID is already in use.
1372          */
1373         i = mps_get_fw_diag_buffer_number(sc, unique_id);
1374         pBuffer = &sc->fw_diag_buffer_list[buffer_type];
1375         if (i != MPS_FW_DIAGNOSTIC_UID_NOT_FOUND) {
1376                 *return_code = MPS_FW_DIAG_ERROR_INVALID_UID;
1377                 return (MPS_DIAG_FAILURE);
1378         }
1379
1380         /*
1381          * The buffer's unique ID should not be registered yet, and the given
1382          * unique ID cannot be 0.
1383          */
1384         if ((pBuffer->unique_id != MPS_FW_DIAG_INVALID_UID) ||
1385             (unique_id == MPS_FW_DIAG_INVALID_UID)) {
1386                 *return_code = MPS_FW_DIAG_ERROR_INVALID_UID;
1387                 return (MPS_DIAG_FAILURE);
1388         }
1389
1390         /*
1391          * If this buffer is already posted as immediate, just change owner.
1392          */
1393         if (pBuffer->immediate && pBuffer->owned_by_firmware &&
1394             (pBuffer->unique_id == MPS_FW_DIAG_INVALID_UID)) {
1395                 pBuffer->immediate = FALSE;
1396                 pBuffer->unique_id = unique_id;
1397                 return (MPS_DIAG_SUCCESS);
1398         }
1399
1400         /*
1401          * Post a new buffer after checking if it's enabled.  The DMA buffer
1402          * that is allocated will be contiguous (nsegments = 1).
1403          */
1404         if (!pBuffer->enabled) {
1405                 *return_code = MPS_FW_DIAG_ERROR_NO_BUFFER;
1406                 return (MPS_DIAG_FAILURE);
1407         }
1408         if (bus_dma_tag_create( sc->mps_parent_dmat,    /* parent */
1409                                 1, 0,                   /* algnmnt, boundary */
1410                                 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1411                                 BUS_SPACE_MAXADDR,      /* highaddr */
1412                                 NULL, NULL,             /* filter, filterarg */
1413                                 buffer_size,            /* maxsize */
1414                                 1,                      /* nsegments */
1415                                 buffer_size,            /* maxsegsize */
1416                                 0,                      /* flags */
1417                                 NULL, NULL,             /* lockfunc, lockarg */
1418                                 &sc->fw_diag_dmat)) {
1419                 device_printf(sc->mps_dev, "Cannot allocate FW diag buffer DMA "
1420                     "tag\n");
1421                 return (ENOMEM);
1422         }
1423         if (bus_dmamem_alloc(sc->fw_diag_dmat, (void **)&sc->fw_diag_buffer,
1424             BUS_DMA_NOWAIT, &sc->fw_diag_map)) {
1425                 device_printf(sc->mps_dev, "Cannot allocate FW diag buffer "
1426                     "memory\n");
1427                 return (ENOMEM);
1428         }
1429         bzero(sc->fw_diag_buffer, buffer_size);
1430         bus_dmamap_load(sc->fw_diag_dmat, sc->fw_diag_map, sc->fw_diag_buffer,
1431             buffer_size, mps_memaddr_cb, &sc->fw_diag_busaddr, 0);
1432         pBuffer->size = buffer_size;
1433
1434         /*
1435          * Copy the given info to the diag buffer and post the buffer.
1436          */
1437         pBuffer->buffer_type = buffer_type;
1438         pBuffer->immediate = FALSE;
1439         if (buffer_type == MPI2_DIAG_BUF_TYPE_TRACE) {
1440                 for (i = 0; i < (sizeof (pBuffer->product_specific) / 4);
1441                     i++) {
1442                         pBuffer->product_specific[i] =
1443                             diag_register->ProductSpecific[i];
1444                 }
1445         }
1446         pBuffer->extended_type = extended_type;
1447         pBuffer->unique_id = unique_id;
1448         status = mps_post_fw_diag_buffer(sc, pBuffer, return_code);
1449
1450         /*
1451          * In case there was a failure, free the DMA buffer.
1452          */
1453         if (status == MPS_DIAG_FAILURE) {
1454                 if (sc->fw_diag_busaddr != 0)
1455                         bus_dmamap_unload(sc->fw_diag_dmat, sc->fw_diag_map);
1456                 if (sc->fw_diag_buffer != NULL)
1457                         bus_dmamem_free(sc->fw_diag_dmat, sc->fw_diag_buffer,
1458                             sc->fw_diag_map);
1459                 if (sc->fw_diag_dmat != NULL)
1460                         bus_dma_tag_destroy(sc->fw_diag_dmat);
1461         }
1462
1463         return (status);
1464 }
1465
1466 static int
1467 mps_diag_unregister(struct mps_softc *sc,
1468     mps_fw_diag_unregister_t *diag_unregister, uint32_t *return_code)
1469 {
1470         mps_fw_diagnostic_buffer_t      *pBuffer;
1471         uint8_t                         i;
1472         uint32_t                        unique_id;
1473         int                             status;
1474
1475         unique_id = diag_unregister->UniqueId;
1476
1477         /*
1478          * Get the current buffer and look up the unique ID.  The unique ID
1479          * should be there.
1480          */
1481         i = mps_get_fw_diag_buffer_number(sc, unique_id);
1482         if (i == MPS_FW_DIAGNOSTIC_UID_NOT_FOUND) {
1483                 *return_code = MPS_FW_DIAG_ERROR_INVALID_UID;
1484                 return (MPS_DIAG_FAILURE);
1485         }
1486
1487         pBuffer = &sc->fw_diag_buffer_list[i];
1488
1489         /*
1490          * Try to release the buffer from FW before freeing it.  If release
1491          * fails, don't free the DMA buffer in case FW tries to access it
1492          * later.  If buffer is not owned by firmware, can't release it.
1493          */
1494         if (!pBuffer->owned_by_firmware) {
1495                 status = MPS_DIAG_SUCCESS;
1496         } else {
1497                 status = mps_release_fw_diag_buffer(sc, pBuffer, return_code,
1498                     MPS_FW_DIAG_TYPE_UNREGISTER);
1499         }
1500
1501         /*
1502          * At this point, return the current status no matter what happens with
1503          * the DMA buffer.
1504          */
1505         pBuffer->unique_id = MPS_FW_DIAG_INVALID_UID;
1506         if (status == MPS_DIAG_SUCCESS) {
1507                 if (sc->fw_diag_busaddr != 0)
1508                         bus_dmamap_unload(sc->fw_diag_dmat, sc->fw_diag_map);
1509                 if (sc->fw_diag_buffer != NULL)
1510                         bus_dmamem_free(sc->fw_diag_dmat, sc->fw_diag_buffer,
1511                             sc->fw_diag_map);
1512                 if (sc->fw_diag_dmat != NULL)
1513                         bus_dma_tag_destroy(sc->fw_diag_dmat);
1514         }
1515
1516         return (status);
1517 }
1518
1519 static int
1520 mps_diag_query(struct mps_softc *sc, mps_fw_diag_query_t *diag_query,
1521     uint32_t *return_code)
1522 {
1523         mps_fw_diagnostic_buffer_t      *pBuffer;
1524         uint8_t                         i;
1525         uint32_t                        unique_id;
1526
1527         unique_id = diag_query->UniqueId;
1528
1529         /*
1530          * If ID is valid, query on ID.
1531          * If ID is invalid, query on buffer type.
1532          */
1533         if (unique_id == MPS_FW_DIAG_INVALID_UID) {
1534                 i = diag_query->BufferType;
1535                 if (i >= MPI2_DIAG_BUF_TYPE_COUNT) {
1536                         *return_code = MPS_FW_DIAG_ERROR_INVALID_UID;
1537                         return (MPS_DIAG_FAILURE);
1538                 }
1539         } else {
1540                 i = mps_get_fw_diag_buffer_number(sc, unique_id);
1541                 if (i == MPS_FW_DIAGNOSTIC_UID_NOT_FOUND) {
1542                         *return_code = MPS_FW_DIAG_ERROR_INVALID_UID;
1543                         return (MPS_DIAG_FAILURE);
1544                 }
1545         }
1546
1547         /*
1548          * Fill query structure with the diag buffer info.
1549          */
1550         pBuffer = &sc->fw_diag_buffer_list[i];
1551         diag_query->BufferType = pBuffer->buffer_type;
1552         diag_query->ExtendedType = pBuffer->extended_type;
1553         if (diag_query->BufferType == MPI2_DIAG_BUF_TYPE_TRACE) {
1554                 for (i = 0; i < (sizeof(diag_query->ProductSpecific) / 4);
1555                     i++) {
1556                         diag_query->ProductSpecific[i] =
1557                             pBuffer->product_specific[i];
1558                 }
1559         }
1560         diag_query->TotalBufferSize = pBuffer->size;
1561         diag_query->DriverAddedBufferSize = 0;
1562         diag_query->UniqueId = pBuffer->unique_id;
1563         diag_query->ApplicationFlags = 0;
1564         diag_query->DiagnosticFlags = 0;
1565
1566         /*
1567          * Set/Clear application flags
1568          */
1569         if (pBuffer->immediate) {
1570                 diag_query->ApplicationFlags &= ~MPS_FW_DIAG_FLAG_APP_OWNED;
1571         } else {
1572                 diag_query->ApplicationFlags |= MPS_FW_DIAG_FLAG_APP_OWNED;
1573         }
1574         if (pBuffer->valid_data || pBuffer->owned_by_firmware) {
1575                 diag_query->ApplicationFlags |= MPS_FW_DIAG_FLAG_BUFFER_VALID;
1576         } else {
1577                 diag_query->ApplicationFlags &= ~MPS_FW_DIAG_FLAG_BUFFER_VALID;
1578         }
1579         if (pBuffer->owned_by_firmware) {
1580                 diag_query->ApplicationFlags |=
1581                     MPS_FW_DIAG_FLAG_FW_BUFFER_ACCESS;
1582         } else {
1583                 diag_query->ApplicationFlags &=
1584                     ~MPS_FW_DIAG_FLAG_FW_BUFFER_ACCESS;
1585         }
1586
1587         return (MPS_DIAG_SUCCESS);
1588 }
1589
1590 static int
1591 mps_diag_read_buffer(struct mps_softc *sc,
1592     mps_diag_read_buffer_t *diag_read_buffer, uint8_t *ioctl_buf,
1593     uint32_t *return_code)
1594 {
1595         mps_fw_diagnostic_buffer_t      *pBuffer;
1596         uint8_t                         i, *pData;
1597         uint32_t                        unique_id;
1598         int                             status;
1599
1600         unique_id = diag_read_buffer->UniqueId;
1601
1602         /*
1603          * Get the current buffer and look up the unique ID.  The unique ID
1604          * should be there.
1605          */
1606         i = mps_get_fw_diag_buffer_number(sc, unique_id);
1607         if (i == MPS_FW_DIAGNOSTIC_UID_NOT_FOUND) {
1608                 *return_code = MPS_FW_DIAG_ERROR_INVALID_UID;
1609                 return (MPS_DIAG_FAILURE);
1610         }
1611
1612         pBuffer = &sc->fw_diag_buffer_list[i];
1613
1614         /*
1615          * Make sure requested read is within limits
1616          */
1617         if (diag_read_buffer->StartingOffset + diag_read_buffer->BytesToRead >
1618             pBuffer->size) {
1619                 *return_code = MPS_FW_DIAG_ERROR_INVALID_PARAMETER;
1620                 return (MPS_DIAG_FAILURE);
1621         }
1622
1623         /*
1624          * Copy the requested data from DMA to the diag_read_buffer.  The DMA
1625          * buffer that was allocated is one contiguous buffer.
1626          */
1627         pData = (uint8_t *)(sc->fw_diag_buffer +
1628             diag_read_buffer->StartingOffset);
1629         if (copyout(pData, ioctl_buf, diag_read_buffer->BytesToRead) != 0)
1630                 return (MPS_DIAG_FAILURE);
1631         diag_read_buffer->Status = 0;
1632
1633         /*
1634          * Set or clear the Force Release flag.
1635          */
1636         if (pBuffer->force_release) {
1637                 diag_read_buffer->Flags |= MPS_FW_DIAG_FLAG_FORCE_RELEASE;
1638         } else {
1639                 diag_read_buffer->Flags &= ~MPS_FW_DIAG_FLAG_FORCE_RELEASE;
1640         }
1641
1642         /*
1643          * If buffer is to be reregistered, make sure it's not already owned by
1644          * firmware first.
1645          */
1646         status = MPS_DIAG_SUCCESS;
1647         if (!pBuffer->owned_by_firmware) {
1648                 if (diag_read_buffer->Flags & MPS_FW_DIAG_FLAG_REREGISTER) {
1649                         status = mps_post_fw_diag_buffer(sc, pBuffer,
1650                             return_code);
1651                 }
1652         }
1653
1654         return (status);
1655 }
1656
1657 static int
1658 mps_diag_release(struct mps_softc *sc, mps_fw_diag_release_t *diag_release,
1659     uint32_t *return_code)
1660 {
1661         mps_fw_diagnostic_buffer_t      *pBuffer;
1662         uint8_t                         i;
1663         uint32_t                        unique_id;
1664         int                             status;
1665
1666         unique_id = diag_release->UniqueId;
1667
1668         /*
1669          * Get the current buffer and look up the unique ID.  The unique ID
1670          * should be there.
1671          */
1672         i = mps_get_fw_diag_buffer_number(sc, unique_id);
1673         if (i == MPS_FW_DIAGNOSTIC_UID_NOT_FOUND) {
1674                 *return_code = MPS_FW_DIAG_ERROR_INVALID_UID;
1675                 return (MPS_DIAG_FAILURE);
1676         }
1677
1678         pBuffer = &sc->fw_diag_buffer_list[i];
1679
1680         /*
1681          * If buffer is not owned by firmware, it's already been released.
1682          */
1683         if (!pBuffer->owned_by_firmware) {
1684                 *return_code = MPS_FW_DIAG_ERROR_ALREADY_RELEASED;
1685                 return (MPS_DIAG_FAILURE);
1686         }
1687
1688         /*
1689          * Release the buffer.
1690          */
1691         status = mps_release_fw_diag_buffer(sc, pBuffer, return_code,
1692             MPS_FW_DIAG_TYPE_RELEASE);
1693         return (status);
1694 }
1695
1696 static int
1697 mps_do_diag_action(struct mps_softc *sc, uint32_t action, uint8_t *diag_action,
1698     uint32_t length, uint32_t *return_code)
1699 {
1700         mps_fw_diag_register_t          diag_register;
1701         mps_fw_diag_unregister_t        diag_unregister;
1702         mps_fw_diag_query_t             diag_query;
1703         mps_diag_read_buffer_t          diag_read_buffer;
1704         mps_fw_diag_release_t           diag_release;
1705         int                             status = MPS_DIAG_SUCCESS;
1706         uint32_t                        original_return_code;
1707
1708         original_return_code = *return_code;
1709         *return_code = MPS_FW_DIAG_ERROR_SUCCESS;
1710
1711         switch (action) {
1712                 case MPS_FW_DIAG_TYPE_REGISTER:
1713                         if (!length) {
1714                                 *return_code =
1715                                     MPS_FW_DIAG_ERROR_INVALID_PARAMETER;
1716                                 status = MPS_DIAG_FAILURE;
1717                                 break;
1718                         }
1719                         if (copyin(diag_action, &diag_register,
1720                             sizeof(diag_register)) != 0)
1721                                 return (MPS_DIAG_FAILURE);
1722                         status = mps_diag_register(sc, &diag_register,
1723                             return_code);
1724                         break;
1725
1726                 case MPS_FW_DIAG_TYPE_UNREGISTER:
1727                         if (length < sizeof(diag_unregister)) {
1728                                 *return_code =
1729                                     MPS_FW_DIAG_ERROR_INVALID_PARAMETER;
1730                                 status = MPS_DIAG_FAILURE;
1731                                 break;
1732                         }
1733                         if (copyin(diag_action, &diag_unregister,
1734                             sizeof(diag_unregister)) != 0)
1735                                 return (MPS_DIAG_FAILURE);
1736                         status = mps_diag_unregister(sc, &diag_unregister,
1737                             return_code);
1738                         break;
1739
1740                 case MPS_FW_DIAG_TYPE_QUERY:
1741                         if (length < sizeof (diag_query)) {
1742                                 *return_code =
1743                                     MPS_FW_DIAG_ERROR_INVALID_PARAMETER;
1744                                 status = MPS_DIAG_FAILURE;
1745                                 break;
1746                         }
1747                         if (copyin(diag_action, &diag_query, sizeof(diag_query))
1748                             != 0)
1749                                 return (MPS_DIAG_FAILURE);
1750                         status = mps_diag_query(sc, &diag_query, return_code);
1751                         if (status == MPS_DIAG_SUCCESS)
1752                                 if (copyout(&diag_query, diag_action,
1753                                     sizeof (diag_query)) != 0)
1754                                         return (MPS_DIAG_FAILURE);
1755                         break;
1756
1757                 case MPS_FW_DIAG_TYPE_READ_BUFFER:
1758                         if (copyin(diag_action, &diag_read_buffer,
1759                             sizeof(diag_read_buffer)) != 0)
1760                                 return (MPS_DIAG_FAILURE);
1761                         if (length < diag_read_buffer.BytesToRead) {
1762                                 *return_code =
1763                                     MPS_FW_DIAG_ERROR_INVALID_PARAMETER;
1764                                 status = MPS_DIAG_FAILURE;
1765                                 break;
1766                         }
1767                         status = mps_diag_read_buffer(sc, &diag_read_buffer,
1768                             PTRIN(diag_read_buffer.PtrDataBuffer),
1769                             return_code);
1770                         if (status == MPS_DIAG_SUCCESS) {
1771                                 if (copyout(&diag_read_buffer, diag_action,
1772                                     sizeof(diag_read_buffer) -
1773                                     sizeof(diag_read_buffer.PtrDataBuffer)) !=
1774                                     0)
1775                                         return (MPS_DIAG_FAILURE);
1776                         }
1777                         break;
1778
1779                 case MPS_FW_DIAG_TYPE_RELEASE:
1780                         if (length < sizeof(diag_release)) {
1781                                 *return_code =
1782                                     MPS_FW_DIAG_ERROR_INVALID_PARAMETER;
1783                                 status = MPS_DIAG_FAILURE;
1784                                 break;
1785                         }
1786                         if (copyin(diag_action, &diag_release,
1787                             sizeof(diag_release)) != 0)
1788                                 return (MPS_DIAG_FAILURE);
1789                         status = mps_diag_release(sc, &diag_release,
1790                             return_code);
1791                         break;
1792
1793                 default:
1794                         *return_code = MPS_FW_DIAG_ERROR_INVALID_PARAMETER;
1795                         status = MPS_DIAG_FAILURE;
1796                         break;
1797         }
1798
1799         if ((status == MPS_DIAG_FAILURE) &&
1800             (original_return_code == MPS_FW_DIAG_NEW) &&
1801             (*return_code != MPS_FW_DIAG_ERROR_SUCCESS))
1802                 status = MPS_DIAG_SUCCESS;
1803
1804         return (status);
1805 }
1806
1807 static int
1808 mps_user_diag_action(struct mps_softc *sc, mps_diag_action_t *data)
1809 {
1810         int                     status;
1811
1812         /*
1813          * Only allow one diag action at one time.
1814          */
1815         if (sc->mps_flags & MPS_FLAGS_BUSY) {
1816                 mps_dprint(sc, MPS_USER, "%s: Only one FW diag command "
1817                     "allowed at a single time.", __func__);
1818                 return (EBUSY);
1819         }
1820         sc->mps_flags |= MPS_FLAGS_BUSY;
1821
1822         /*
1823          * Send diag action request
1824          */
1825         if (data->Action == MPS_FW_DIAG_TYPE_REGISTER ||
1826             data->Action == MPS_FW_DIAG_TYPE_UNREGISTER ||
1827             data->Action == MPS_FW_DIAG_TYPE_QUERY ||
1828             data->Action == MPS_FW_DIAG_TYPE_READ_BUFFER ||
1829             data->Action == MPS_FW_DIAG_TYPE_RELEASE) {
1830                 status = mps_do_diag_action(sc, data->Action,
1831                     PTRIN(data->PtrDiagAction), data->Length,
1832                     &data->ReturnCode);
1833         } else
1834                 status = EINVAL;
1835
1836         sc->mps_flags &= ~MPS_FLAGS_BUSY;
1837         return (status);
1838 }
1839
1840 /*
1841  * Copy the event recording mask and the event queue size out.  For
1842  * clarification, the event recording mask (events_to_record) is not the same
1843  * thing as the event mask (event_mask).  events_to_record has a bit set for
1844  * every event type that is to be recorded by the driver, and event_mask has a
1845  * bit cleared for every event that is allowed into the driver from the IOC.
1846  * They really have nothing to do with each other.
1847  */
1848 static void
1849 mps_user_event_query(struct mps_softc *sc, mps_event_query_t *data)
1850 {
1851         uint8_t i;
1852
1853         mps_lock(sc);
1854         data->Entries = MPS_EVENT_QUEUE_SIZE;
1855
1856         for (i = 0; i < 4; i++) {
1857                 data->Types[i] = sc->events_to_record[i];
1858         }
1859         mps_unlock(sc);
1860 }
1861
1862 /*
1863  * Set the driver's event mask according to what's been given.  See
1864  * mps_user_event_query for explanation of the event recording mask and the IOC
1865  * event mask.  It's the app's responsibility to enable event logging by setting
1866  * the bits in events_to_record.  Initially, no events will be logged.
1867  */
1868 static void
1869 mps_user_event_enable(struct mps_softc *sc, mps_event_enable_t *data)
1870 {
1871         uint8_t i;
1872
1873         mps_lock(sc);
1874         for (i = 0; i < 4; i++) {
1875                 sc->events_to_record[i] = data->Types[i];
1876         }
1877         mps_unlock(sc);
1878 }
1879
1880 /*
1881  * Copy out the events that have been recorded, up to the max events allowed.
1882  */
1883 static int
1884 mps_user_event_report(struct mps_softc *sc, mps_event_report_t *data)
1885 {
1886         int             status = 0;
1887         uint32_t        size;
1888
1889         mps_lock(sc);
1890         size = data->Size;
1891         if ((size >= sizeof(sc->recorded_events)) && (status == 0)) {
1892                 mps_unlock(sc);
1893                 if (copyout((void *)sc->recorded_events,
1894                     PTRIN(data->PtrEvents), size) != 0)
1895                         status = EFAULT;
1896                 mps_lock(sc);
1897         } else {
1898                 /*
1899                  * data->Size value is not large enough to copy event data.
1900                  */
1901                 status = EFAULT;
1902         }
1903
1904         /*
1905          * Change size value to match the number of bytes that were copied.
1906          */
1907         if (status == 0)
1908                 data->Size = sizeof(sc->recorded_events);
1909         mps_unlock(sc);
1910
1911         return (status);
1912 }
1913
1914 /*
1915  * Record events into the driver from the IOC if they are not masked.
1916  */
1917 void
1918 mpssas_record_event(struct mps_softc *sc,
1919     MPI2_EVENT_NOTIFICATION_REPLY *event_reply)
1920 {
1921         uint32_t        event;
1922         int             i, j;
1923         uint16_t        event_data_len;
1924         boolean_t       sendAEN = FALSE;
1925
1926         event = event_reply->Event;
1927
1928         /*
1929          * Generate a system event to let anyone who cares know that a
1930          * LOG_ENTRY_ADDED event has occurred.  This is sent no matter what the
1931          * event mask is set to.
1932          */
1933         if (event == MPI2_EVENT_LOG_ENTRY_ADDED) {
1934                 sendAEN = TRUE;
1935         }
1936
1937         /*
1938          * Record the event only if its corresponding bit is set in
1939          * events_to_record.  event_index is the index into recorded_events and
1940          * event_number is the overall number of an event being recorded since
1941          * start-of-day.  event_index will roll over; event_number will never
1942          * roll over.
1943          */
1944         i = (uint8_t)(event / 32);
1945         j = (uint8_t)(event % 32);
1946         if ((i < 4) && ((1 << j) & sc->events_to_record[i])) {
1947                 i = sc->event_index;
1948                 sc->recorded_events[i].Type = event;
1949                 sc->recorded_events[i].Number = ++sc->event_number;
1950                 bzero(sc->recorded_events[i].Data, MPS_MAX_EVENT_DATA_LENGTH *
1951                     4);
1952                 event_data_len = event_reply->EventDataLength;
1953
1954                 if (event_data_len > 0) {
1955                         /*
1956                          * Limit data to size in m_event entry
1957                          */
1958                         if (event_data_len > MPS_MAX_EVENT_DATA_LENGTH) {
1959                                 event_data_len = MPS_MAX_EVENT_DATA_LENGTH;
1960                         }
1961                         for (j = 0; j < event_data_len; j++) {
1962                                 sc->recorded_events[i].Data[j] =
1963                                     event_reply->EventData[j];
1964                         }
1965
1966                         /*
1967                          * check for index wrap-around
1968                          */
1969                         if (++i == MPS_EVENT_QUEUE_SIZE) {
1970                                 i = 0;
1971                         }
1972                         sc->event_index = (uint8_t)i;
1973
1974                         /*
1975                          * Set flag to send the event.
1976                          */
1977                         sendAEN = TRUE;
1978                 }
1979         }
1980
1981         /*
1982          * Generate a system event if flag is set to let anyone who cares know
1983          * that an event has occurred.
1984          */
1985         if (sendAEN) {
1986 //SLM-how to send a system event (see kqueue, kevent)
1987 //              (void) ddi_log_sysevent(mpt->m_dip, DDI_VENDOR_LSI, "MPT_SAS",
1988 //                  "SAS", NULL, NULL, DDI_NOSLEEP);
1989         }
1990 }
1991
1992 static int
1993 mps_user_reg_access(struct mps_softc *sc, mps_reg_access_t *data)
1994 {
1995         int     status = 0;
1996
1997         switch (data->Command) {
1998                 /*
1999                  * IO access is not supported.
2000                  */
2001                 case REG_IO_READ:
2002                 case REG_IO_WRITE:
2003                         mps_dprint(sc, MPS_USER, "IO access is not supported. "
2004                             "Use memory access.");
2005                         status = EINVAL;
2006                         break;
2007
2008                 case REG_MEM_READ:
2009                         data->RegData = mps_regread(sc, data->RegOffset);
2010                         break;
2011
2012                 case REG_MEM_WRITE:
2013                         mps_regwrite(sc, data->RegOffset, data->RegData);
2014                         break;
2015
2016                 default:
2017                         status = EINVAL;
2018                         break;
2019         }
2020
2021         return (status);
2022 }
2023
2024 static int
2025 mps_user_btdh(struct mps_softc *sc, mps_btdh_mapping_t *data)
2026 {
2027         uint8_t         bt2dh = FALSE;
2028         uint8_t         dh2bt = FALSE;
2029         uint16_t        dev_handle, bus, target;
2030
2031         bus = data->Bus;
2032         target = data->TargetID;
2033         dev_handle = data->DevHandle;
2034
2035         /*
2036          * When DevHandle is 0xFFFF and Bus/Target are not 0xFFFF, use Bus/
2037          * Target to get DevHandle.  When Bus/Target are 0xFFFF and DevHandle is
2038          * not 0xFFFF, use DevHandle to get Bus/Target.  Anything else is
2039          * invalid.
2040          */
2041         if ((bus == 0xFFFF) && (target == 0xFFFF) && (dev_handle != 0xFFFF))
2042                 dh2bt = TRUE;
2043         if ((dev_handle == 0xFFFF) && (bus != 0xFFFF) && (target != 0xFFFF))
2044                 bt2dh = TRUE;
2045         if (!dh2bt && !bt2dh)
2046                 return (EINVAL);
2047
2048         /*
2049          * Only handle bus of 0.  Make sure target is within range.
2050          */
2051         if (bt2dh) {
2052                 if (bus != 0)
2053                         return (EINVAL);
2054
2055                 if (target > sc->max_devices) {
2056                         mps_dprint(sc, MPS_FAULT, "Target ID is out of range "
2057                            "for Bus/Target to DevHandle mapping.");
2058                         return (EINVAL);
2059                 }
2060                 dev_handle = sc->mapping_table[target].dev_handle;
2061                 if (dev_handle)
2062                         data->DevHandle = dev_handle;
2063         } else {
2064                 bus = 0;
2065                 target = mps_mapping_get_sas_id_from_handle(sc, dev_handle);
2066                 data->Bus = bus;
2067                 data->TargetID = target;
2068         }
2069
2070         return (0);
2071 }
2072
2073 static int
2074 mps_ioctl(struct cdev *dev, u_long cmd, void *arg, int flag,
2075     struct thread *td)
2076 {
2077         struct mps_softc *sc;
2078         struct mps_cfg_page_req *page_req;
2079         struct mps_ext_cfg_page_req *ext_page_req;
2080         void *mps_page;
2081         int error, msleep_ret;
2082
2083         mps_page = NULL;
2084         sc = dev->si_drv1;
2085         page_req = (void *)arg;
2086         ext_page_req = (void *)arg;
2087
2088         switch (cmd) {
2089         case MPSIO_READ_CFG_HEADER:
2090                 mps_lock(sc);
2091                 error = mps_user_read_cfg_header(sc, page_req);
2092                 mps_unlock(sc);
2093                 break;
2094         case MPSIO_READ_CFG_PAGE:
2095                 mps_page = malloc(page_req->len, M_MPSUSER, M_WAITOK | M_ZERO);
2096                 if(!mps_page) {
2097                         mps_printf(sc, "Cannot allocate memory %s %d\n",
2098                          __func__, __LINE__);
2099                         return (ENOMEM);
2100         }
2101                 error = copyin(page_req->buf, mps_page,
2102                     sizeof(MPI2_CONFIG_PAGE_HEADER));
2103                 if (error)
2104                         break;
2105                 mps_lock(sc);
2106                 error = mps_user_read_cfg_page(sc, page_req, mps_page);
2107                 mps_unlock(sc);
2108                 if (error)
2109                         break;
2110                 error = copyout(mps_page, page_req->buf, page_req->len);
2111                 break;
2112         case MPSIO_READ_EXT_CFG_HEADER:
2113                 mps_lock(sc);
2114                 error = mps_user_read_extcfg_header(sc, ext_page_req);
2115                 mps_unlock(sc);
2116                 break;
2117         case MPSIO_READ_EXT_CFG_PAGE:
2118                 mps_page = malloc(ext_page_req->len, M_MPSUSER, M_WAITOK|M_ZERO);
2119                 if(!mps_page) {
2120                         mps_printf(sc, "Cannot allocate memory %s %d\n",
2121                          __func__, __LINE__);
2122                         return (ENOMEM);
2123         }
2124                 error = copyin(ext_page_req->buf, mps_page,
2125                     sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
2126                 if (error)
2127                         break;
2128                 mps_lock(sc);
2129                 error = mps_user_read_extcfg_page(sc, ext_page_req, mps_page);
2130                 mps_unlock(sc);
2131                 if (error)
2132                         break;
2133                 error = copyout(mps_page, ext_page_req->buf, ext_page_req->len);
2134                 break;
2135         case MPSIO_WRITE_CFG_PAGE:
2136                 mps_page = malloc(page_req->len, M_MPSUSER, M_WAITOK|M_ZERO);
2137                 if(!mps_page) {
2138                         mps_printf(sc, "Cannot allocate memory %s %d\n",
2139                          __func__, __LINE__);
2140                         return (ENOMEM);
2141         }
2142                 error = copyin(page_req->buf, mps_page, page_req->len);
2143                 if (error)
2144                         break;
2145                 mps_lock(sc);
2146                 error = mps_user_write_cfg_page(sc, page_req, mps_page);
2147                 mps_unlock(sc);
2148                 break;
2149         case MPSIO_MPS_COMMAND:
2150                 error = mps_user_command(sc, (struct mps_usr_command *)arg);
2151                 break;
2152         case MPTIOCTL_PASS_THRU:
2153                 /*
2154                  * The user has requested to pass through a command to be
2155                  * executed by the MPT firmware.  Call our routine which does
2156                  * this.  Only allow one passthru IOCTL at one time.
2157                  */
2158                 error = mps_user_pass_thru(sc, (mps_pass_thru_t *)arg);
2159                 break;
2160         case MPTIOCTL_GET_ADAPTER_DATA:
2161                 /*
2162                  * The user has requested to read adapter data.  Call our
2163                  * routine which does this.
2164                  */
2165                 error = 0;
2166                 mps_user_get_adapter_data(sc, (mps_adapter_data_t *)arg);
2167                 break;
2168         case MPTIOCTL_GET_PCI_INFO:
2169                 /*
2170                  * The user has requested to read pci info.  Call
2171                  * our routine which does this.
2172                  */
2173                 mps_lock(sc);
2174                 error = 0;
2175                 mps_user_read_pci_info(sc, (mps_pci_info_t *)arg);
2176                 mps_unlock(sc);
2177                 break;
2178         case MPTIOCTL_RESET_ADAPTER:
2179                 mps_lock(sc);
2180                 sc->port_enable_complete = 0;
2181                 uint32_t reinit_start = time_uptime;
2182                 error = mps_reinit(sc);
2183                 /* Sleep for 300 second. */
2184                 msleep_ret = msleep(&sc->port_enable_complete, &sc->mps_mtx, PRIBIO,
2185                        "mps_porten", 300 * hz);
2186                 mps_unlock(sc);
2187                 if (msleep_ret)
2188                         printf("Port Enable did not complete after Diag "
2189                             "Reset msleep error %d.\n", msleep_ret);
2190                 else
2191                         mps_dprint(sc, MPS_USER,
2192                                 "Hard Reset with Port Enable completed in %d seconds.\n",
2193                                  (uint32_t) (time_uptime - reinit_start));
2194                 break;
2195         case MPTIOCTL_DIAG_ACTION:
2196                 /*
2197                  * The user has done a diag buffer action.  Call our routine
2198                  * which does this.  Only allow one diag action at one time.
2199                  */
2200                 mps_lock(sc);
2201                 error = mps_user_diag_action(sc, (mps_diag_action_t *)arg);
2202                 mps_unlock(sc);
2203                 break;
2204         case MPTIOCTL_EVENT_QUERY:
2205                 /*
2206                  * The user has done an event query. Call our routine which does
2207                  * this.
2208                  */
2209                 error = 0;
2210                 mps_user_event_query(sc, (mps_event_query_t *)arg);
2211                 break;
2212         case MPTIOCTL_EVENT_ENABLE:
2213                 /*
2214                  * The user has done an event enable. Call our routine which
2215                  * does this.
2216                  */
2217                 error = 0;
2218                 mps_user_event_enable(sc, (mps_event_enable_t *)arg);
2219                 break;
2220         case MPTIOCTL_EVENT_REPORT:
2221                 /*
2222                  * The user has done an event report. Call our routine which
2223                  * does this.
2224                  */
2225                 error = mps_user_event_report(sc, (mps_event_report_t *)arg);
2226                 break;
2227         case MPTIOCTL_REG_ACCESS:
2228                 /*
2229                  * The user has requested register access.  Call our routine
2230                  * which does this.
2231                  */
2232                 mps_lock(sc);
2233                 error = mps_user_reg_access(sc, (mps_reg_access_t *)arg);
2234                 mps_unlock(sc);
2235                 break;
2236         case MPTIOCTL_BTDH_MAPPING:
2237                 /*
2238                  * The user has requested to translate a bus/target to a
2239                  * DevHandle or a DevHandle to a bus/target.  Call our routine
2240                  * which does this.
2241                  */
2242                 error = mps_user_btdh(sc, (mps_btdh_mapping_t *)arg);
2243                 break;
2244         default:
2245                 error = ENOIOCTL;
2246                 break;
2247         }
2248
2249         if (mps_page != NULL)
2250                 free(mps_page, M_MPSUSER);
2251
2252         return (error);
2253 }
2254
2255 #ifdef COMPAT_FREEBSD32
2256
2257 struct mps_cfg_page_req32 {
2258         MPI2_CONFIG_PAGE_HEADER header;
2259         uint32_t page_address;
2260         uint32_t buf;
2261         int     len;
2262         uint16_t ioc_status;
2263 };
2264
2265 struct mps_ext_cfg_page_req32 {
2266         MPI2_CONFIG_EXTENDED_PAGE_HEADER header;
2267         uint32_t page_address;
2268         uint32_t buf;
2269         int     len;
2270         uint16_t ioc_status;
2271 };
2272
2273 struct mps_raid_action32 {
2274         uint8_t action;
2275         uint8_t volume_bus;
2276         uint8_t volume_id;
2277         uint8_t phys_disk_num;
2278         uint32_t action_data_word;
2279         uint32_t buf;
2280         int len;
2281         uint32_t volume_status;
2282         uint32_t action_data[4];
2283         uint16_t action_status;
2284         uint16_t ioc_status;
2285         uint8_t write;
2286 };
2287
2288 struct mps_usr_command32 {
2289         uint32_t req;
2290         uint32_t req_len;
2291         uint32_t rpl;
2292         uint32_t rpl_len;
2293         uint32_t buf;
2294         int len;
2295         uint32_t flags;
2296 };
2297
2298 #define MPSIO_READ_CFG_HEADER32 _IOWR('M', 200, struct mps_cfg_page_req32)
2299 #define MPSIO_READ_CFG_PAGE32   _IOWR('M', 201, struct mps_cfg_page_req32)
2300 #define MPSIO_READ_EXT_CFG_HEADER32 _IOWR('M', 202, struct mps_ext_cfg_page_req32)
2301 #define MPSIO_READ_EXT_CFG_PAGE32 _IOWR('M', 203, struct mps_ext_cfg_page_req32)
2302 #define MPSIO_WRITE_CFG_PAGE32  _IOWR('M', 204, struct mps_cfg_page_req32)
2303 #define MPSIO_RAID_ACTION32     _IOWR('M', 205, struct mps_raid_action32)
2304 #define MPSIO_MPS_COMMAND32     _IOWR('M', 210, struct mps_usr_command32)
2305
2306 static int
2307 mps_ioctl32(struct cdev *dev, u_long cmd32, void *_arg, int flag,
2308     struct thread *td)
2309 {
2310         struct mps_cfg_page_req32 *page32 = _arg;
2311         struct mps_ext_cfg_page_req32 *ext32 = _arg;
2312         struct mps_raid_action32 *raid32 = _arg;
2313         struct mps_usr_command32 *user32 = _arg;
2314         union {
2315                 struct mps_cfg_page_req page;
2316                 struct mps_ext_cfg_page_req ext;
2317                 struct mps_raid_action raid;
2318                 struct mps_usr_command user;
2319         } arg;
2320         u_long cmd;
2321         int error;
2322
2323         switch (cmd32) {
2324         case MPSIO_READ_CFG_HEADER32:
2325         case MPSIO_READ_CFG_PAGE32:
2326         case MPSIO_WRITE_CFG_PAGE32:
2327                 if (cmd32 == MPSIO_READ_CFG_HEADER32)
2328                         cmd = MPSIO_READ_CFG_HEADER;
2329                 else if (cmd32 == MPSIO_READ_CFG_PAGE32)
2330                         cmd = MPSIO_READ_CFG_PAGE;
2331                 else
2332                         cmd = MPSIO_WRITE_CFG_PAGE;
2333                 CP(*page32, arg.page, header);
2334                 CP(*page32, arg.page, page_address);
2335                 PTRIN_CP(*page32, arg.page, buf);
2336                 CP(*page32, arg.page, len);
2337                 CP(*page32, arg.page, ioc_status);
2338                 break;
2339
2340         case MPSIO_READ_EXT_CFG_HEADER32:
2341         case MPSIO_READ_EXT_CFG_PAGE32:
2342                 if (cmd32 == MPSIO_READ_EXT_CFG_HEADER32)
2343                         cmd = MPSIO_READ_EXT_CFG_HEADER;
2344                 else
2345                         cmd = MPSIO_READ_EXT_CFG_PAGE;
2346                 CP(*ext32, arg.ext, header);
2347                 CP(*ext32, arg.ext, page_address);
2348                 PTRIN_CP(*ext32, arg.ext, buf);
2349                 CP(*ext32, arg.ext, len);
2350                 CP(*ext32, arg.ext, ioc_status);
2351                 break;
2352
2353         case MPSIO_RAID_ACTION32:
2354                 cmd = MPSIO_RAID_ACTION;
2355                 CP(*raid32, arg.raid, action);
2356                 CP(*raid32, arg.raid, volume_bus);
2357                 CP(*raid32, arg.raid, volume_id);
2358                 CP(*raid32, arg.raid, phys_disk_num);
2359                 CP(*raid32, arg.raid, action_data_word);
2360                 PTRIN_CP(*raid32, arg.raid, buf);
2361                 CP(*raid32, arg.raid, len);
2362                 CP(*raid32, arg.raid, volume_status);
2363                 bcopy(raid32->action_data, arg.raid.action_data,
2364                     sizeof arg.raid.action_data);
2365                 CP(*raid32, arg.raid, ioc_status);
2366                 CP(*raid32, arg.raid, write);
2367                 break;
2368
2369         case MPSIO_MPS_COMMAND32:
2370                 cmd = MPSIO_MPS_COMMAND;
2371                 PTRIN_CP(*user32, arg.user, req);
2372                 CP(*user32, arg.user, req_len);
2373                 PTRIN_CP(*user32, arg.user, rpl);
2374                 CP(*user32, arg.user, rpl_len);
2375                 PTRIN_CP(*user32, arg.user, buf);
2376                 CP(*user32, arg.user, len);
2377                 CP(*user32, arg.user, flags);
2378                 break;
2379         default:
2380                 return (ENOIOCTL);
2381         }
2382
2383         error = mps_ioctl(dev, cmd, &arg, flag, td);
2384         if (error == 0 && (cmd32 & IOC_OUT) != 0) {
2385                 switch (cmd32) {
2386                 case MPSIO_READ_CFG_HEADER32:
2387                 case MPSIO_READ_CFG_PAGE32:
2388                 case MPSIO_WRITE_CFG_PAGE32:
2389                         CP(arg.page, *page32, header);
2390                         CP(arg.page, *page32, page_address);
2391                         PTROUT_CP(arg.page, *page32, buf);
2392                         CP(arg.page, *page32, len);
2393                         CP(arg.page, *page32, ioc_status);
2394                         break;
2395
2396                 case MPSIO_READ_EXT_CFG_HEADER32:
2397                 case MPSIO_READ_EXT_CFG_PAGE32:
2398                         CP(arg.ext, *ext32, header);
2399                         CP(arg.ext, *ext32, page_address);
2400                         PTROUT_CP(arg.ext, *ext32, buf);
2401                         CP(arg.ext, *ext32, len);
2402                         CP(arg.ext, *ext32, ioc_status);
2403                         break;
2404
2405                 case MPSIO_RAID_ACTION32:
2406                         CP(arg.raid, *raid32, action);
2407                         CP(arg.raid, *raid32, volume_bus);
2408                         CP(arg.raid, *raid32, volume_id);
2409                         CP(arg.raid, *raid32, phys_disk_num);
2410                         CP(arg.raid, *raid32, action_data_word);
2411                         PTROUT_CP(arg.raid, *raid32, buf);
2412                         CP(arg.raid, *raid32, len);
2413                         CP(arg.raid, *raid32, volume_status);
2414                         bcopy(arg.raid.action_data, raid32->action_data,
2415                             sizeof arg.raid.action_data);
2416                         CP(arg.raid, *raid32, ioc_status);
2417                         CP(arg.raid, *raid32, write);
2418                         break;
2419
2420                 case MPSIO_MPS_COMMAND32:
2421                         PTROUT_CP(arg.user, *user32, req);
2422                         CP(arg.user, *user32, req_len);
2423                         PTROUT_CP(arg.user, *user32, rpl);
2424                         CP(arg.user, *user32, rpl_len);
2425                         PTROUT_CP(arg.user, *user32, buf);
2426                         CP(arg.user, *user32, len);
2427                         CP(arg.user, *user32, flags);
2428                         break;
2429                 }
2430         }
2431
2432         return (error);
2433 }
2434 #endif /* COMPAT_FREEBSD32 */
2435
2436 static int
2437 mps_ioctl_devsw(struct cdev *dev, u_long com, caddr_t arg, int flag,
2438     struct thread *td)
2439 {
2440 #ifdef COMPAT_FREEBSD32
2441         if (SV_CURPROC_FLAG(SV_ILP32))
2442                 return (mps_ioctl32(dev, com, arg, flag, td));
2443 #endif
2444         return (mps_ioctl(dev, com, arg, flag, td));
2445 }