sys/dev/tws/tws_user.c

   1 /*
   2  * Copyright (c) 2010, LSI Corp.
   3  * All rights reserved.
   4  * Author : Manjunath Ranganathaiah
   5  * Support: freebsdraid@lsi.com
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of the <ORGANIZATION> nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32  * POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  * $FreeBSD$
  35  */
  36
  37 #include <dev/tws/tws.h>
  38 #include <dev/tws/tws_services.h>
  39 #include <dev/tws/tws_hdm.h>
  40 #include <dev/tws/tws_user.h>
  41
  42
  43 int tws_ioctl(struct cdev *dev, long unsigned int cmd, caddr_t buf, int flags,
  44                                                     d_thread_t *proc);
  45 void tws_passthru_complete(struct tws_request *req);
  46 extern void tws_circular_aenq_insert(struct tws_softc *sc,
  47                     struct tws_circular_q *cq, struct tws_event_packet *aen);
  48
  49
  50 static int tws_passthru(struct tws_softc *sc, void *buf);
  51 static int tws_ioctl_aen(struct tws_softc *sc, u_long cmd, void *buf);
  52
  53 extern int tws_bus_scan(struct tws_softc *sc);
  54 extern struct tws_request *tws_get_request(struct tws_softc *sc,
  55                                            u_int16_t type);
  56 extern int32_t tws_map_request(struct tws_softc *sc, struct tws_request *req);
  57 extern void tws_unmap_request(struct tws_softc *sc, struct tws_request *req);
  58 extern uint8_t tws_get_state(struct tws_softc *sc);
  59 extern void tws_timeout(void *arg);
  60
  61 int
  62 tws_ioctl(struct cdev *dev, u_long cmd, caddr_t buf, int flags,
  63                                                     d_thread_t *proc)
  64 {
  65     struct tws_softc *sc = (struct tws_softc *)(dev->si_drv1);
  66     int error;
  67
  68     TWS_TRACE_DEBUG(sc, "entry", sc, cmd);
  69     sc->stats.ioctls++;
  70     switch(cmd) {
  71         case TWS_IOCTL_FIRMWARE_PASS_THROUGH :
  72             error = tws_passthru(sc, (void *)buf);
  73             break;
  74         case TWS_IOCTL_SCAN_BUS :
  75             TWS_TRACE_DEBUG(sc, "scan-bus", 0, 0);
  76             error = tws_bus_scan(sc);
  77             break;
  78         default :
  79             TWS_TRACE_DEBUG(sc, "ioctl-aen", cmd, buf);
  80             error = tws_ioctl_aen(sc, cmd, (void *)buf);
  81             break;
  82
  83     }
  84     return(error);
  85 }
  86
  87 static int
  88 tws_passthru(struct tws_softc *sc, void *buf)
  89 {
  90     struct tws_request *req;
  91     struct tws_ioctl_no_data_buf *ubuf = (struct tws_ioctl_no_data_buf *)buf;
  92     int error;
  93     u_int16_t lun4;
  94
  95
  96     if ( tws_get_state(sc) != TWS_ONLINE) {
  97         return(EBUSY);
  98     }
  99
 100     //==============================================================================================
 101     // Get a command
 102     //
 103     do {
 104         req = tws_get_request(sc, TWS_REQ_TYPE_PASSTHRU);
 105         if ( !req ) {
 106             sc->chan = (void *)sc;
 107             error = tsleep(sc->chan,  0, "tws_sleep", TWS_IOCTL_TIMEOUT*hz);
 108             if ( error == EWOULDBLOCK ) {
 109                 return(ETIMEDOUT);
 110             }
 111         } else {
 112             // Make sure we are still ready for new commands...
 113             if ( tws_get_state(sc) != TWS_ONLINE) {
 114                 return(EBUSY);
 115             }
 116             break;
 117         }
 118     } while(1);
 119
 120     req->length = (ubuf->driver_pkt.buffer_length + 511) & ~511;
 121     TWS_TRACE_DEBUG(sc, "datal,rid", req->length, req->request_id);
 122     if ( req->length ) {
 123         req->data = sc->ioctl_data_mem;
 124         req->dma_map = sc->ioctl_data_map;
 125
 126         //==========================================================================================
 127         // Copy data in from user space
 128         //
 129         error = copyin(ubuf->pdata, req->data, req->length);
 130     }
 131
 132     //==============================================================================================
 133     // Set command fields
 134     //
 135     req->flags = TWS_DIR_IN | TWS_DIR_OUT;
 136     req->cb = tws_passthru_complete;
 137
 138     memcpy(&req->cmd_pkt->cmd, &ubuf->cmd_pkt.cmd,
 139                               sizeof(struct tws_command_apache));
 140
 141     if ( GET_OPCODE(req->cmd_pkt->cmd.pkt_a.res__opcode) ==
 142                                                TWS_FW_CMD_EXECUTE_SCSI ) {
 143         lun4 = req->cmd_pkt->cmd.pkt_a.lun_l4__req_id & 0xF000;
 144         req->cmd_pkt->cmd.pkt_a.lun_l4__req_id = lun4 | req->request_id;
 145     } else {
 146         req->cmd_pkt->cmd.pkt_g.generic.request_id = (u_int8_t) req->request_id;
 147     }
 148
 149     //==============================================================================================
 150     // Send command to controller
 151     //
 152     error = tws_map_request(sc, req);
 153     if (error) {
 154         ubuf->driver_pkt.os_status = error;
 155         goto out_data;
 156     }
 157
 158     if ( req->state == TWS_REQ_STATE_COMPLETE ) {
 159         ubuf->driver_pkt.os_status = req->error_code;
 160         goto out_unmap;
 161     }
 162
 163     mtx_lock(&sc->gen_lock);
 164     error = mtx_sleep(req, &sc->gen_lock, 0, "tws_passthru", TWS_IOCTL_TIMEOUT*hz);
 165     mtx_unlock(&sc->gen_lock);
 166     if (( req->state != TWS_REQ_STATE_COMPLETE ) && ( error == EWOULDBLOCK )) {
 167             TWS_TRACE_DEBUG(sc, "msleep timeout", error, req->request_id);
 168             tws_timeout((void*) req);
 169     }
 170
 171 out_unmap:
 172     if ( req->error_code == TWS_REQ_RET_RESET ) {
 173         error = EBUSY;
 174         req->error_code = EBUSY;
 175         TWS_TRACE_DEBUG(sc, "ioctl reset", error, req->request_id);
 176     }
 177
 178     tws_unmap_request(sc, req);
 179
 180     //==============================================================================================
 181     // Return command status to user space
 182     //
 183     memcpy(&ubuf->cmd_pkt.hdr, &req->cmd_pkt->hdr, sizeof(struct tws_command_apache));
 184     memcpy(&ubuf->cmd_pkt.cmd, &req->cmd_pkt->cmd, sizeof(struct tws_command_apache));
 185
 186 out_data:
 187     if ( req->length ) {
 188         //==========================================================================================
 189         // Copy data out to user space
 190         //
 191         if ( !error )
 192             error = copyout(req->data, ubuf->pdata, ubuf->driver_pkt.buffer_length);
 193     }
 194
 195     if ( error )
 196         TWS_TRACE_DEBUG(sc, "errored", error, 0);
 197
 198     if ( req->error_code != TWS_REQ_RET_SUBMIT_SUCCESS )
 199         ubuf->driver_pkt.os_status = error;
 200
 201     //==============================================================================================
 202     // Free command
 203     //
 204     req->state = TWS_REQ_STATE_FREE;
 205
 206     wakeup_one(sc->chan);
 207
 208     return(error);
 209 }
 210
 211 void
 212 tws_passthru_complete(struct tws_request *req)
 213 {
 214     req->state = TWS_REQ_STATE_COMPLETE;
 215     wakeup_one(req);
 216
 217 }
 218
 219 static void
 220 tws_retrive_aen(struct tws_softc *sc, u_long cmd,
 221                             struct tws_ioctl_packet *ubuf)
 222 {
 223     u_int16_t index=0;
 224     struct tws_event_packet eventp, *qp;
 225
 226     if ( sc->aen_q.head == sc->aen_q.tail ) {
 227         ubuf->driver_pkt.status = TWS_AEN_NO_EVENTS;
 228         return;
 229     }
 230
 231     ubuf->driver_pkt.status = 0;
 232
 233     /*
 234      * once this flag is set cli will not display alarms
 235      * needs a revisit from tools?
 236      */
 237     if ( sc->aen_q.overflow ) {
 238         ubuf->driver_pkt.status = TWS_AEN_OVERFLOW;
 239         sc->aen_q.overflow = 0; /* reset */
 240     }
 241
 242     qp = (struct tws_event_packet *)sc->aen_q.q;
 243
 244     switch (cmd) {
 245         case TWS_IOCTL_GET_FIRST_EVENT :
 246             index = sc->aen_q.head;
 247             break;
 248         case TWS_IOCTL_GET_LAST_EVENT :
 249             /* index = tail-1 */
 250             index = (sc->aen_q.depth + sc->aen_q.tail - 1) % sc->aen_q.depth;
 251             break;
 252         case TWS_IOCTL_GET_NEXT_EVENT :
 253             memcpy(&eventp, ubuf->data_buf, sizeof(struct tws_event_packet));
 254             index = sc->aen_q.head;
 255             do {
 256                 if ( qp[index].sequence_id ==
 257                            (eventp.sequence_id + 1) )
 258                     break;
 259                 index  = (index+1) % sc->aen_q.depth;
 260             }while ( index != sc->aen_q.tail );
 261             if ( index == sc->aen_q.tail ) {
 262                 ubuf->driver_pkt.status = TWS_AEN_NO_EVENTS;
 263                 return;
 264             }
 265             break;
 266         case TWS_IOCTL_GET_PREVIOUS_EVENT :
 267             memcpy(&eventp, ubuf->data_buf, sizeof(struct tws_event_packet));
 268             index = sc->aen_q.head;
 269             do {
 270                 if ( qp[index].sequence_id ==
 271                            (eventp.sequence_id - 1) )
 272                     break;
 273                 index  = (index+1) % sc->aen_q.depth;
 274             }while ( index != sc->aen_q.tail );
 275             if ( index == sc->aen_q.tail ) {
 276                 ubuf->driver_pkt.status = TWS_AEN_NO_EVENTS;
 277                 return;
 278             }
 279             break;
 280         default :
 281             TWS_TRACE_DEBUG(sc, "not a valid event", sc, cmd);
 282             ubuf->driver_pkt.status = TWS_AEN_NO_EVENTS;
 283             return;
 284     }
 285
 286     memcpy(ubuf->data_buf, &qp[index],
 287                            sizeof(struct tws_event_packet));
 288     qp[index].retrieved = TWS_AEN_RETRIEVED;
 289
 290     return;
 291
 292 }
 293
 294 static int
 295 tws_ioctl_aen(struct tws_softc *sc, u_long cmd, void *buf)
 296 {
 297
 298     struct tws_ioctl_packet *ubuf = (struct tws_ioctl_packet *)buf;
 299     struct tws_compatibility_packet cpkt;
 300     struct tws_lock_packet lpkt;
 301     time_t ctime;
 302
 303     mtx_lock(&sc->gen_lock);
 304     ubuf->driver_pkt.status = 0;
 305     switch(cmd) {
 306         case TWS_IOCTL_GET_FIRST_EVENT :
 307         case TWS_IOCTL_GET_LAST_EVENT :
 308         case TWS_IOCTL_GET_NEXT_EVENT :
 309         case TWS_IOCTL_GET_PREVIOUS_EVENT :
 310             tws_retrive_aen(sc,cmd,ubuf);
 311             break;
 312         case TWS_IOCTL_GET_LOCK :
 313             ctime = TWS_LOCAL_TIME;
 314             memcpy(&lpkt, ubuf->data_buf, sizeof(struct tws_lock_packet));
 315             if ( (sc->ioctl_lock.lock == TWS_IOCTL_LOCK_FREE) ||
 316                  (lpkt.force_flag) ||
 317                  (ctime >= sc->ioctl_lock.timeout) ) {
 318                 sc->ioctl_lock.lock = TWS_IOCTL_LOCK_HELD;
 319                 sc->ioctl_lock.timeout = ctime + (lpkt.timeout_msec / 1000);
 320                 lpkt.time_remaining_msec = lpkt.timeout_msec;
 321             }  else {
 322                 lpkt.time_remaining_msec = (u_int32_t)
 323                           ((sc->ioctl_lock.timeout - ctime) * 1000);
 324                 ubuf->driver_pkt.status = TWS_IOCTL_LOCK_ALREADY_HELD;
 325
 326             }
 327             break;
 328         case TWS_IOCTL_RELEASE_LOCK :
 329             if (sc->ioctl_lock.lock == TWS_IOCTL_LOCK_FREE) {
 330                 ubuf->driver_pkt.status = TWS_IOCTL_LOCK_NOT_HELD;
 331             } else {
 332                 sc->ioctl_lock.lock = TWS_IOCTL_LOCK_FREE;
 333                 ubuf->driver_pkt.status = 0;
 334             }
 335             break;
 336         case TWS_IOCTL_GET_COMPATIBILITY_INFO :
 337             TWS_TRACE_DEBUG(sc, "get comp info", sc, cmd);
 338
 339             memcpy( cpkt.driver_version, TWS_DRIVER_VERSION_STRING,
 340                                          sizeof(TWS_DRIVER_VERSION_STRING));
 341             cpkt.working_srl = sc->cinfo.working_srl;
 342             cpkt.working_branch = sc->cinfo.working_branch;
 343             cpkt.working_build = sc->cinfo.working_build;
 344             cpkt.driver_srl_high = TWS_CURRENT_FW_SRL;
 345             cpkt.driver_branch_high = TWS_CURRENT_FW_BRANCH;
 346             cpkt.driver_build_high = TWS_CURRENT_FW_BUILD;
 347             cpkt.driver_srl_low = TWS_BASE_FW_SRL;
 348             cpkt.driver_branch_low = TWS_BASE_FW_BRANCH;
 349             cpkt.driver_build_low = TWS_BASE_FW_BUILD;
 350             cpkt.fw_on_ctlr_srl = sc->cinfo.fw_on_ctlr_srl;
 351             cpkt.fw_on_ctlr_branch = sc->cinfo.fw_on_ctlr_branch;
 352             cpkt.fw_on_ctlr_build = sc->cinfo.fw_on_ctlr_build;
 353             ubuf->driver_pkt.status = 0;
 354             int len = sizeof(struct tws_compatibility_packet);
 355             if ( ubuf->driver_pkt.buffer_length < len )
 356                 len = ubuf->driver_pkt.buffer_length;
 357             memcpy(ubuf->data_buf, &cpkt, len);
 358
 359             break;
 360         default :
 361             TWS_TRACE_DEBUG(sc, "not valid cmd", cmd,
 362                            TWS_IOCTL_GET_COMPATIBILITY_INFO);
 363             break;
 364
 365     }
 366     mtx_unlock(&sc->gen_lock);
 367     return(SUCCESS);
 368
 369 }
 370
 371 void
 372 tws_circular_aenq_insert(struct tws_softc *sc, struct tws_circular_q *cq,
 373 struct tws_event_packet *aen)
 374 {
 375
 376     struct tws_event_packet *q = (struct tws_event_packet *)cq->q;
 377     volatile u_int16_t head, tail;
 378     u_int8_t retr;
 379     mtx_assert(&sc->gen_lock, MA_OWNED);
 380
 381     head = cq->head;
 382     tail = cq->tail;
 383     retr = q[tail].retrieved;
 384
 385     memcpy(&q[tail], aen, sizeof(struct tws_event_packet));
 386     tail = (tail+1) % cq->depth;
 387
 388     if ( head == tail ) { /* q is full */
 389         if ( retr != TWS_AEN_RETRIEVED )
 390             cq->overflow = 1;
 391         cq->head = (head+1) % cq->depth;
 392     }
 393     cq->tail = tail;
 394
 395 }