vpo.c revision 315813
1/*- 2 * Copyright (c) 1997, 1998, 1999 Nicolas Souchu 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 */ 27 28#include <sys/cdefs.h> 29__FBSDID("$FreeBSD: stable/10/sys/dev/ppbus/vpo.c 315813 2017-03-23 06:41:13Z mav $"); 30 31#include <sys/param.h> 32#include <sys/systm.h> 33#include <sys/module.h> 34#include <sys/bus.h> 35#include <sys/lock.h> 36#include <sys/mutex.h> 37#include <sys/malloc.h> 38 39#include <cam/cam.h> 40#include <cam/cam_ccb.h> 41#include <cam/cam_sim.h> 42#include <cam/cam_xpt_sim.h> 43#include <cam/cam_debug.h> 44#include <cam/cam_periph.h> 45 46#include <cam/scsi/scsi_all.h> 47#include <cam/scsi/scsi_message.h> 48#include <cam/scsi/scsi_da.h> 49 50#include <sys/kernel.h> 51 52#include "opt_vpo.h" 53 54#include <dev/ppbus/ppbconf.h> 55#include <dev/ppbus/vpoio.h> 56 57#include "ppbus_if.h" 58 59struct vpo_sense { 60 struct scsi_sense cmd; 61 unsigned int stat; 62 unsigned int count; 63}; 64 65struct vpo_data { 66 device_t vpo_dev; 67 int vpo_stat; 68 int vpo_count; 69 int vpo_error; 70 71 int vpo_isplus; 72 73 struct cam_sim *sim; 74 75 struct vpo_sense vpo_sense; 76 77 struct vpoio_data vpo_io; /* interface to low level functions */ 78}; 79 80#define DEVTOSOFTC(dev) \ 81 ((struct vpo_data *)device_get_softc(dev)) 82 83/* cam related functions */ 84static void vpo_action(struct cam_sim *sim, union ccb *ccb); 85static void vpo_poll(struct cam_sim *sim); 86 87static void 88vpo_identify(driver_t *driver, device_t parent) 89{ 90 91 device_t dev; 92 93 dev = device_find_child(parent, "vpo", -1); 94 if (!dev) 95 BUS_ADD_CHILD(parent, 0, "vpo", -1); 96} 97 98/* 99 * vpo_probe() 100 */ 101static int 102vpo_probe(device_t dev) 103{ 104 device_t ppbus = device_get_parent(dev); 105 struct vpo_data *vpo; 106 int error; 107 108 vpo = DEVTOSOFTC(dev); 109 vpo->vpo_dev = dev; 110 111 /* check ZIP before ZIP+ or imm_probe() will send controls to 112 * the printer or whatelse connected to the port */ 113 ppb_lock(ppbus); 114 if ((error = vpoio_probe(dev, &vpo->vpo_io)) == 0) { 115 vpo->vpo_isplus = 0; 116 device_set_desc(dev, 117 "Iomega VPI0 Parallel to SCSI interface"); 118 } else if ((error = imm_probe(dev, &vpo->vpo_io)) == 0) { 119 vpo->vpo_isplus = 1; 120 device_set_desc(dev, 121 "Iomega Matchmaker Parallel to SCSI interface"); 122 } else { 123 ppb_unlock(ppbus); 124 return (error); 125 } 126 ppb_unlock(ppbus); 127 128 return (0); 129} 130 131/* 132 * vpo_attach() 133 */ 134static int 135vpo_attach(device_t dev) 136{ 137 struct vpo_data *vpo = DEVTOSOFTC(dev); 138 device_t ppbus = device_get_parent(dev); 139 struct ppb_data *ppb = device_get_softc(ppbus); /* XXX: layering */ 140 struct cam_devq *devq; 141 int error; 142 143 /* low level attachment */ 144 if (vpo->vpo_isplus) { 145 if ((error = imm_attach(&vpo->vpo_io))) 146 return (error); 147 } else { 148 if ((error = vpoio_attach(&vpo->vpo_io))) 149 return (error); 150 } 151 152 /* 153 ** Now tell the generic SCSI layer 154 ** about our bus. 155 */ 156 devq = cam_simq_alloc(/*maxopenings*/1); 157 /* XXX What about low-level detach on error? */ 158 if (devq == NULL) 159 return (ENXIO); 160 161 vpo->sim = cam_sim_alloc(vpo_action, vpo_poll, "vpo", vpo, 162 device_get_unit(dev), ppb->ppc_lock, 163 /*untagged*/1, /*tagged*/0, devq); 164 if (vpo->sim == NULL) { 165 cam_simq_free(devq); 166 return (ENXIO); 167 } 168 169 ppb_lock(ppbus); 170 if (xpt_bus_register(vpo->sim, dev, /*bus*/0) != CAM_SUCCESS) { 171 cam_sim_free(vpo->sim, /*free_devq*/TRUE); 172 ppb_unlock(ppbus); 173 return (ENXIO); 174 } 175 ppb_unlock(ppbus); 176 177 return (0); 178} 179 180/* 181 * vpo_intr() 182 */ 183static void 184vpo_intr(struct vpo_data *vpo, struct ccb_scsiio *csio) 185{ 186 int errno; /* error in errno.h */ 187#ifdef VP0_DEBUG 188 int i; 189#endif 190 uint8_t *ptr; 191 192 ptr = scsiio_cdb_ptr(csio); 193 if (vpo->vpo_isplus) { 194 errno = imm_do_scsi(&vpo->vpo_io, VP0_INITIATOR, 195 csio->ccb_h.target_id, 196 ptr, csio->cdb_len, 197 (char *)csio->data_ptr, csio->dxfer_len, 198 &vpo->vpo_stat, &vpo->vpo_count, &vpo->vpo_error); 199 } else { 200 errno = vpoio_do_scsi(&vpo->vpo_io, VP0_INITIATOR, 201 csio->ccb_h.target_id, 202 ptr, csio->cdb_len, 203 (char *)csio->data_ptr, csio->dxfer_len, 204 &vpo->vpo_stat, &vpo->vpo_count, &vpo->vpo_error); 205 } 206 207#ifdef VP0_DEBUG 208 printf("vpo_do_scsi = %d, status = 0x%x, count = %d, vpo_error = %d\n", 209 errno, vpo->vpo_stat, vpo->vpo_count, vpo->vpo_error); 210 211 /* dump of command */ 212 for (i=0; i<csio->cdb_len; i++) 213 printf("%x ", ((char *)ptr)[i]); 214 215 printf("\n"); 216#endif 217 218 if (errno) { 219 /* connection to ppbus interrupted */ 220 csio->ccb_h.status = CAM_CMD_TIMEOUT; 221 return; 222 } 223 224 /* if a timeout occured, no sense */ 225 if (vpo->vpo_error) { 226 if (vpo->vpo_error != VP0_ESELECT_TIMEOUT) 227 device_printf(vpo->vpo_dev, "VP0 error/timeout (%d)\n", 228 vpo->vpo_error); 229 230 csio->ccb_h.status = CAM_CMD_TIMEOUT; 231 return; 232 } 233 234 /* check scsi status */ 235 if (vpo->vpo_stat != SCSI_STATUS_OK) { 236 csio->scsi_status = vpo->vpo_stat; 237 238 /* check if we have to sense the drive */ 239 if ((vpo->vpo_stat & SCSI_STATUS_CHECK_COND) != 0) { 240 241 vpo->vpo_sense.cmd.opcode = REQUEST_SENSE; 242 vpo->vpo_sense.cmd.length = csio->sense_len; 243 vpo->vpo_sense.cmd.control = 0; 244 245 if (vpo->vpo_isplus) { 246 errno = imm_do_scsi(&vpo->vpo_io, VP0_INITIATOR, 247 csio->ccb_h.target_id, 248 (char *)&vpo->vpo_sense.cmd, 249 sizeof(vpo->vpo_sense.cmd), 250 (char *)&csio->sense_data, csio->sense_len, 251 &vpo->vpo_sense.stat, &vpo->vpo_sense.count, 252 &vpo->vpo_error); 253 } else { 254 errno = vpoio_do_scsi(&vpo->vpo_io, VP0_INITIATOR, 255 csio->ccb_h.target_id, 256 (char *)&vpo->vpo_sense.cmd, 257 sizeof(vpo->vpo_sense.cmd), 258 (char *)&csio->sense_data, csio->sense_len, 259 &vpo->vpo_sense.stat, &vpo->vpo_sense.count, 260 &vpo->vpo_error); 261 } 262 263 264#ifdef VP0_DEBUG 265 printf("(sense) vpo_do_scsi = %d, status = 0x%x, count = %d, vpo_error = %d\n", 266 errno, vpo->vpo_sense.stat, vpo->vpo_sense.count, vpo->vpo_error); 267#endif 268 269 /* check sense return status */ 270 if (errno == 0 && vpo->vpo_sense.stat == SCSI_STATUS_OK) { 271 /* sense ok */ 272 csio->ccb_h.status = CAM_AUTOSNS_VALID | CAM_SCSI_STATUS_ERROR; 273 csio->sense_resid = csio->sense_len - vpo->vpo_sense.count; 274 275#ifdef VP0_DEBUG 276 /* dump of sense info */ 277 printf("(sense) "); 278 for (i=0; i<vpo->vpo_sense.count; i++) 279 printf("%x ", ((char *)&csio->sense_data)[i]); 280 printf("\n"); 281#endif 282 283 } else { 284 /* sense failed */ 285 csio->ccb_h.status = CAM_AUTOSENSE_FAIL; 286 } 287 } else { 288 /* no sense */ 289 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR; 290 } 291 292 return; 293 } 294 295 csio->resid = csio->dxfer_len - vpo->vpo_count; 296 csio->ccb_h.status = CAM_REQ_CMP; 297} 298 299static void 300vpo_action(struct cam_sim *sim, union ccb *ccb) 301{ 302 struct vpo_data *vpo = (struct vpo_data *)sim->softc; 303 304 ppb_assert_locked(device_get_parent(vpo->vpo_dev)); 305 switch (ccb->ccb_h.func_code) { 306 case XPT_SCSI_IO: 307 { 308 struct ccb_scsiio *csio; 309 310 csio = &ccb->csio; 311 312 if (ccb->ccb_h.flags & CAM_CDB_PHYS) { 313 ccb->ccb_h.status = CAM_REQ_INVALID; 314 xpt_done(ccb); 315 break; 316 } 317#ifdef VP0_DEBUG 318 device_printf(vpo->vpo_dev, "XPT_SCSI_IO (0x%x) request\n", 319 *scsiio_cdb_ptr(csio)); 320#endif 321 vpo_intr(vpo, csio); 322 323 xpt_done(ccb); 324 325 break; 326 } 327 case XPT_CALC_GEOMETRY: 328 { 329 struct ccb_calc_geometry *ccg; 330 331 ccg = &ccb->ccg; 332 333#ifdef VP0_DEBUG 334 device_printf(vpo->vpo_dev, "XPT_CALC_GEOMETRY (bs=%d,vs=%jd,c=%d,h=%d,spt=%d) request\n", 335 ccg->block_size, 336 (intmax_t)ccg->volume_size, 337 ccg->cylinders, 338 ccg->heads, 339 ccg->secs_per_track); 340#endif 341 342 ccg->heads = 64; 343 ccg->secs_per_track = 32; 344 ccg->cylinders = ccg->volume_size / 345 (ccg->heads * ccg->secs_per_track); 346 347 ccb->ccb_h.status = CAM_REQ_CMP; 348 xpt_done(ccb); 349 break; 350 } 351 case XPT_RESET_BUS: /* Reset the specified SCSI bus */ 352 { 353 354#ifdef VP0_DEBUG 355 device_printf(vpo->vpo_dev, "XPT_RESET_BUS request\n"); 356#endif 357 358 if (vpo->vpo_isplus) { 359 if (imm_reset_bus(&vpo->vpo_io)) { 360 ccb->ccb_h.status = CAM_REQ_CMP_ERR; 361 xpt_done(ccb); 362 return; 363 } 364 } else { 365 if (vpoio_reset_bus(&vpo->vpo_io)) { 366 ccb->ccb_h.status = CAM_REQ_CMP_ERR; 367 xpt_done(ccb); 368 return; 369 } 370 } 371 372 ccb->ccb_h.status = CAM_REQ_CMP; 373 xpt_done(ccb); 374 break; 375 } 376 case XPT_PATH_INQ: /* Path routing inquiry */ 377 { 378 struct ccb_pathinq *cpi = &ccb->cpi; 379 380#ifdef VP0_DEBUG 381 device_printf(vpo->vpo_dev, "XPT_PATH_INQ request\n"); 382#endif 383 cpi->version_num = 1; /* XXX??? */ 384 cpi->hba_inquiry = 0; 385 cpi->target_sprt = 0; 386 cpi->hba_misc = 0; 387 cpi->hba_eng_cnt = 0; 388 cpi->max_target = 7; 389 cpi->max_lun = 0; 390 cpi->initiator_id = VP0_INITIATOR; 391 cpi->bus_id = sim->bus_id; 392 cpi->base_transfer_speed = 93; 393 strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN); 394 strlcpy(cpi->hba_vid, "Iomega", HBA_IDLEN); 395 strlcpy(cpi->dev_name, sim->sim_name, DEV_IDLEN); 396 cpi->unit_number = sim->unit_number; 397 cpi->transport = XPORT_PPB; 398 cpi->transport_version = 0; 399 400 cpi->ccb_h.status = CAM_REQ_CMP; 401 xpt_done(ccb); 402 break; 403 } 404 default: 405 ccb->ccb_h.status = CAM_REQ_INVALID; 406 xpt_done(ccb); 407 break; 408 } 409 410 return; 411} 412 413static void 414vpo_poll(struct cam_sim *sim) 415{ 416 417 /* The ZIP is actually always polled throw vpo_action(). */ 418} 419 420static devclass_t vpo_devclass; 421 422static device_method_t vpo_methods[] = { 423 /* device interface */ 424 DEVMETHOD(device_identify, vpo_identify), 425 DEVMETHOD(device_probe, vpo_probe), 426 DEVMETHOD(device_attach, vpo_attach), 427 428 { 0, 0 } 429}; 430 431static driver_t vpo_driver = { 432 "vpo", 433 vpo_methods, 434 sizeof(struct vpo_data), 435}; 436DRIVER_MODULE(vpo, ppbus, vpo_driver, vpo_devclass, 0, 0); 437MODULE_DEPEND(vpo, ppbus, 1, 1, 1); 438MODULE_DEPEND(vpo, cam, 1, 1, 1); 439