128219Smsmith/*- 255939Snsouch * Copyright (c) 1997, 1998, 1999 Nicolas Souchu 328219Smsmith * All rights reserved. 428219Smsmith * 528219Smsmith * Redistribution and use in source and binary forms, with or without 628219Smsmith * modification, are permitted provided that the following conditions 728219Smsmith * are met: 828219Smsmith * 1. Redistributions of source code must retain the above copyright 928219Smsmith * notice, this list of conditions and the following disclaimer. 1028219Smsmith * 2. Redistributions in binary form must reproduce the above copyright 1128219Smsmith * notice, this list of conditions and the following disclaimer in the 1228219Smsmith * documentation and/or other materials provided with the distribution. 1328219Smsmith * 1428219Smsmith * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1528219Smsmith * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1628219Smsmith * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1728219Smsmith * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1828219Smsmith * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1928219Smsmith * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2028219Smsmith * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2128219Smsmith * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2228219Smsmith * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2328219Smsmith * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2428219Smsmith * SUCH DAMAGE. 2528219Smsmith * 2628219Smsmith */ 2728219Smsmith 28119418Sobrien#include <sys/cdefs.h> 29119418Sobrien__FBSDID("$FreeBSD: stable/10/sys/dev/ppbus/vpo.c 315813 2017-03-23 06:41:13Z mav $"); 30119418Sobrien 3128219Smsmith#include <sys/param.h> 3228219Smsmith#include <sys/systm.h> 3355939Snsouch#include <sys/module.h> 3455939Snsouch#include <sys/bus.h> 35168752Sscottl#include <sys/lock.h> 36168752Sscottl#include <sys/mutex.h> 3759018Sn_hibma#include <sys/malloc.h> 3828219Smsmith 3939520Snsouch#include <cam/cam.h> 4039520Snsouch#include <cam/cam_ccb.h> 4139520Snsouch#include <cam/cam_sim.h> 4239520Snsouch#include <cam/cam_xpt_sim.h> 4339520Snsouch#include <cam/cam_debug.h> 4459018Sn_hibma#include <cam/cam_periph.h> 4539520Snsouch 4639520Snsouch#include <cam/scsi/scsi_all.h> 4739520Snsouch#include <cam/scsi/scsi_message.h> 4839520Snsouch#include <cam/scsi/scsi_da.h> 4939520Snsouch 5028219Smsmith#include <sys/kernel.h> 5128219Smsmith 5242475Snsouch#include "opt_vpo.h" 5342475Snsouch 5428219Smsmith#include <dev/ppbus/ppbconf.h> 5538061Smsmith#include <dev/ppbus/vpoio.h> 5628219Smsmith 5755939Snsouch#include "ppbus_if.h" 5855939Snsouch 5938061Smsmithstruct vpo_sense { 6038061Smsmith struct scsi_sense cmd; 6138061Smsmith unsigned int stat; 6238061Smsmith unsigned int count; 6338061Smsmith}; 6428219Smsmith 6538061Smsmithstruct vpo_data { 66184130Sjhb device_t vpo_dev; 6738061Smsmith int vpo_stat; 6838061Smsmith int vpo_count; 6938061Smsmith int vpo_error; 7028219Smsmith 7139134Snsouch int vpo_isplus; 7239134Snsouch 7339520Snsouch struct cam_sim *sim; 7439520Snsouch 7538061Smsmith struct vpo_sense vpo_sense; 7638061Smsmith 7738061Smsmith struct vpoio_data vpo_io; /* interface to low level functions */ 7838061Smsmith}; 7938061Smsmith 8055939Snsouch#define DEVTOSOFTC(dev) \ 8155939Snsouch ((struct vpo_data *)device_get_softc(dev)) 8228219Smsmith 8355939Snsouch/* cam related functions */ 8455939Snsouchstatic void vpo_action(struct cam_sim *sim, union ccb *ccb); 8555939Snsouchstatic void vpo_poll(struct cam_sim *sim); 8655939Snsouch 8756455Speterstatic void 8856455Spetervpo_identify(driver_t *driver, device_t parent) 8956455Speter{ 9056455Speter 91127189Sguido device_t dev; 92127189Sguido 93184130Sjhb dev = device_find_child(parent, "vpo", -1); 94127189Sguido if (!dev) 95127189Sguido BUS_ADD_CHILD(parent, 0, "vpo", -1); 9656455Speter} 9756455Speter 9828219Smsmith/* 9955939Snsouch * vpo_probe() 10028219Smsmith */ 10155939Snsouchstatic int 10255939Snsouchvpo_probe(device_t dev) 10328219Smsmith{ 104187576Sjhb device_t ppbus = device_get_parent(dev); 10528219Smsmith struct vpo_data *vpo; 10655939Snsouch int error; 10728219Smsmith 10855939Snsouch vpo = DEVTOSOFTC(dev); 109184130Sjhb vpo->vpo_dev = dev; 11028219Smsmith 11139520Snsouch /* check ZIP before ZIP+ or imm_probe() will send controls to 11239520Snsouch * the printer or whatelse connected to the port */ 113187576Sjhb ppb_lock(ppbus); 11455939Snsouch if ((error = vpoio_probe(dev, &vpo->vpo_io)) == 0) { 11539520Snsouch vpo->vpo_isplus = 0; 11655939Snsouch device_set_desc(dev, 11755939Snsouch "Iomega VPI0 Parallel to SCSI interface"); 11855939Snsouch } else if ((error = imm_probe(dev, &vpo->vpo_io)) == 0) { 11939134Snsouch vpo->vpo_isplus = 1; 12055939Snsouch device_set_desc(dev, 12155939Snsouch "Iomega Matchmaker Parallel to SCSI interface"); 12239520Snsouch } else { 123187576Sjhb ppb_unlock(ppbus); 12455939Snsouch return (error); 12528219Smsmith } 126187576Sjhb ppb_unlock(ppbus); 12728219Smsmith 12855939Snsouch return (0); 12928219Smsmith} 13028219Smsmith 13128219Smsmith/* 13255939Snsouch * vpo_attach() 13328219Smsmith */ 13428219Smsmithstatic int 13555939Snsouchvpo_attach(device_t dev) 13628219Smsmith{ 13755939Snsouch struct vpo_data *vpo = DEVTOSOFTC(dev); 138187576Sjhb device_t ppbus = device_get_parent(dev); 139187576Sjhb struct ppb_data *ppb = device_get_softc(ppbus); /* XXX: layering */ 14039520Snsouch struct cam_devq *devq; 14155939Snsouch int error; 14228219Smsmith 14338061Smsmith /* low level attachment */ 14439134Snsouch if (vpo->vpo_isplus) { 14555939Snsouch if ((error = imm_attach(&vpo->vpo_io))) 14655939Snsouch return (error); 14739134Snsouch } else { 14855939Snsouch if ((error = vpoio_attach(&vpo->vpo_io))) 14955939Snsouch return (error); 15039134Snsouch } 15138061Smsmith 15228219Smsmith /* 15339520Snsouch ** Now tell the generic SCSI layer 15439520Snsouch ** about our bus. 15539520Snsouch */ 15639520Snsouch devq = cam_simq_alloc(/*maxopenings*/1); 15739520Snsouch /* XXX What about low-level detach on error? */ 15839520Snsouch if (devq == NULL) 15955939Snsouch return (ENXIO); 16028219Smsmith 16155939Snsouch vpo->sim = cam_sim_alloc(vpo_action, vpo_poll, "vpo", vpo, 162187576Sjhb device_get_unit(dev), ppb->ppc_lock, 16339520Snsouch /*untagged*/1, /*tagged*/0, devq); 16439520Snsouch if (vpo->sim == NULL) { 16539520Snsouch cam_simq_free(devq); 16655939Snsouch return (ENXIO); 16739520Snsouch } 16838061Smsmith 169187576Sjhb ppb_lock(ppbus); 170170872Sscottl if (xpt_bus_register(vpo->sim, dev, /*bus*/0) != CAM_SUCCESS) { 17139520Snsouch cam_sim_free(vpo->sim, /*free_devq*/TRUE); 172187576Sjhb ppb_unlock(ppbus); 17355939Snsouch return (ENXIO); 17439520Snsouch } 175187576Sjhb ppb_unlock(ppbus); 17659018Sn_hibma 17755939Snsouch return (0); 17828219Smsmith} 17928219Smsmith 18028219Smsmith/* 18138061Smsmith * vpo_intr() 18228219Smsmith */ 18338061Smsmithstatic void 18439520Snsouchvpo_intr(struct vpo_data *vpo, struct ccb_scsiio *csio) 18528219Smsmith{ 18641591Sarchie int errno; /* error in errno.h */ 18741591Sarchie#ifdef VP0_DEBUG 18841591Sarchie int i; 18941591Sarchie#endif 190312850Smav uint8_t *ptr; 19128219Smsmith 192312850Smav ptr = scsiio_cdb_ptr(csio); 19339134Snsouch if (vpo->vpo_isplus) { 19439134Snsouch errno = imm_do_scsi(&vpo->vpo_io, VP0_INITIATOR, 19539520Snsouch csio->ccb_h.target_id, 196312850Smav ptr, csio->cdb_len, 19739520Snsouch (char *)csio->data_ptr, csio->dxfer_len, 19839520Snsouch &vpo->vpo_stat, &vpo->vpo_count, &vpo->vpo_error); 19939134Snsouch } else { 20039134Snsouch errno = vpoio_do_scsi(&vpo->vpo_io, VP0_INITIATOR, 20139520Snsouch csio->ccb_h.target_id, 202312850Smav ptr, csio->cdb_len, 20339520Snsouch (char *)csio->data_ptr, csio->dxfer_len, 20439520Snsouch &vpo->vpo_stat, &vpo->vpo_count, &vpo->vpo_error); 20539134Snsouch } 20628219Smsmith 20728257Smsmith#ifdef VP0_DEBUG 208185003Sjhb printf("vpo_do_scsi = %d, status = 0x%x, count = %d, vpo_error = %d\n", 20928257Smsmith errno, vpo->vpo_stat, vpo->vpo_count, vpo->vpo_error); 21039520Snsouch 21139520Snsouch /* dump of command */ 21239520Snsouch for (i=0; i<csio->cdb_len; i++) 213312850Smav printf("%x ", ((char *)ptr)[i]); 21439520Snsouch 21539520Snsouch printf("\n"); 21628257Smsmith#endif 21728257Smsmith 21828257Smsmith if (errno) { 21928257Smsmith /* connection to ppbus interrupted */ 22039520Snsouch csio->ccb_h.status = CAM_CMD_TIMEOUT; 221187576Sjhb return; 22228257Smsmith } 22328219Smsmith 22428257Smsmith /* if a timeout occured, no sense */ 22528257Smsmith if (vpo->vpo_error) { 22639520Snsouch if (vpo->vpo_error != VP0_ESELECT_TIMEOUT) 227184130Sjhb device_printf(vpo->vpo_dev, "VP0 error/timeout (%d)\n", 228184130Sjhb vpo->vpo_error); 22939520Snsouch 23039520Snsouch csio->ccb_h.status = CAM_CMD_TIMEOUT; 231187576Sjhb return; 23228257Smsmith } 23328219Smsmith 23439520Snsouch /* check scsi status */ 23539520Snsouch if (vpo->vpo_stat != SCSI_STATUS_OK) { 23639520Snsouch csio->scsi_status = vpo->vpo_stat; 23728219Smsmith 23839520Snsouch /* check if we have to sense the drive */ 23939520Snsouch if ((vpo->vpo_stat & SCSI_STATUS_CHECK_COND) != 0) { 24028219Smsmith 24139520Snsouch vpo->vpo_sense.cmd.opcode = REQUEST_SENSE; 24239520Snsouch vpo->vpo_sense.cmd.length = csio->sense_len; 24328219Smsmith vpo->vpo_sense.cmd.control = 0; 24428219Smsmith 24539134Snsouch if (vpo->vpo_isplus) { 24639134Snsouch errno = imm_do_scsi(&vpo->vpo_io, VP0_INITIATOR, 24739520Snsouch csio->ccb_h.target_id, 24839134Snsouch (char *)&vpo->vpo_sense.cmd, 24939134Snsouch sizeof(vpo->vpo_sense.cmd), 25039520Snsouch (char *)&csio->sense_data, csio->sense_len, 25139134Snsouch &vpo->vpo_sense.stat, &vpo->vpo_sense.count, 25239134Snsouch &vpo->vpo_error); 25339134Snsouch } else { 25439134Snsouch errno = vpoio_do_scsi(&vpo->vpo_io, VP0_INITIATOR, 25539520Snsouch csio->ccb_h.target_id, 25639134Snsouch (char *)&vpo->vpo_sense.cmd, 25739134Snsouch sizeof(vpo->vpo_sense.cmd), 25839520Snsouch (char *)&csio->sense_data, csio->sense_len, 25939134Snsouch &vpo->vpo_sense.stat, &vpo->vpo_sense.count, 26039134Snsouch &vpo->vpo_error); 26139134Snsouch } 26228219Smsmith 263185003Sjhb 26439520Snsouch#ifdef VP0_DEBUG 265185003Sjhb printf("(sense) vpo_do_scsi = %d, status = 0x%x, count = %d, vpo_error = %d\n", 26639520Snsouch errno, vpo->vpo_sense.stat, vpo->vpo_sense.count, vpo->vpo_error); 26739520Snsouch#endif 26828257Smsmith 26939520Snsouch /* check sense return status */ 27039520Snsouch if (errno == 0 && vpo->vpo_sense.stat == SCSI_STATUS_OK) { 27139520Snsouch /* sense ok */ 27239520Snsouch csio->ccb_h.status = CAM_AUTOSNS_VALID | CAM_SCSI_STATUS_ERROR; 27339520Snsouch csio->sense_resid = csio->sense_len - vpo->vpo_sense.count; 27428219Smsmith 27539520Snsouch#ifdef VP0_DEBUG 27639520Snsouch /* dump of sense info */ 27739520Snsouch printf("(sense) "); 27839520Snsouch for (i=0; i<vpo->vpo_sense.count; i++) 27939520Snsouch printf("%x ", ((char *)&csio->sense_data)[i]); 28039520Snsouch printf("\n"); 28139520Snsouch#endif 28239520Snsouch 28339520Snsouch } else { 28439520Snsouch /* sense failed */ 28539520Snsouch csio->ccb_h.status = CAM_AUTOSENSE_FAIL; 28639520Snsouch } 28739520Snsouch } else { 28839520Snsouch /* no sense */ 289185003Sjhb csio->ccb_h.status = CAM_SCSI_STATUS_ERROR; 29039520Snsouch } 29139520Snsouch 292187576Sjhb return; 29328219Smsmith } 29428219Smsmith 29539520Snsouch csio->resid = csio->dxfer_len - vpo->vpo_count; 29639520Snsouch csio->ccb_h.status = CAM_REQ_CMP; 29728219Smsmith} 29828219Smsmith 29939520Snsouchstatic void 30039520Snsouchvpo_action(struct cam_sim *sim, union ccb *ccb) 30128219Smsmith{ 30239520Snsouch struct vpo_data *vpo = (struct vpo_data *)sim->softc; 30328219Smsmith 304227814Sattilio ppb_assert_locked(device_get_parent(vpo->vpo_dev)); 30539520Snsouch switch (ccb->ccb_h.func_code) { 30639520Snsouch case XPT_SCSI_IO: 30739520Snsouch { 30839520Snsouch struct ccb_scsiio *csio; 30939520Snsouch 31039520Snsouch csio = &ccb->csio; 31139520Snsouch 312312850Smav if (ccb->ccb_h.flags & CAM_CDB_PHYS) { 313312850Smav ccb->ccb_h.status = CAM_REQ_INVALID; 314312850Smav xpt_done(ccb); 315312850Smav break; 316312850Smav } 31739520Snsouch#ifdef VP0_DEBUG 318184130Sjhb device_printf(vpo->vpo_dev, "XPT_SCSI_IO (0x%x) request\n", 319313526Sngie *scsiio_cdb_ptr(csio)); 32039520Snsouch#endif 32139520Snsouch vpo_intr(vpo, csio); 32239520Snsouch 32339520Snsouch xpt_done(ccb); 32439520Snsouch 32539520Snsouch break; 32628219Smsmith } 32739520Snsouch case XPT_CALC_GEOMETRY: 32839520Snsouch { 32939520Snsouch struct ccb_calc_geometry *ccg; 33028219Smsmith 33139520Snsouch ccg = &ccb->ccg; 33239520Snsouch 33339520Snsouch#ifdef VP0_DEBUG 334184130Sjhb device_printf(vpo->vpo_dev, "XPT_CALC_GEOMETRY (bs=%d,vs=%jd,c=%d,h=%d,spt=%d) request\n", 33551952Sn_hibma ccg->block_size, 336114451Sjhb (intmax_t)ccg->volume_size, 33751952Sn_hibma ccg->cylinders, 33851952Sn_hibma ccg->heads, 33951952Sn_hibma ccg->secs_per_track); 34039520Snsouch#endif 34151952Sn_hibma 34239520Snsouch ccg->heads = 64; 34339520Snsouch ccg->secs_per_track = 32; 34451952Sn_hibma ccg->cylinders = ccg->volume_size / 34551952Sn_hibma (ccg->heads * ccg->secs_per_track); 34639520Snsouch 34739520Snsouch ccb->ccb_h.status = CAM_REQ_CMP; 34839520Snsouch xpt_done(ccb); 34939520Snsouch break; 35028219Smsmith } 35139520Snsouch case XPT_RESET_BUS: /* Reset the specified SCSI bus */ 35239520Snsouch { 35328219Smsmith 35428257Smsmith#ifdef VP0_DEBUG 355184130Sjhb device_printf(vpo->vpo_dev, "XPT_RESET_BUS request\n"); 35628219Smsmith#endif 35728219Smsmith 35839520Snsouch if (vpo->vpo_isplus) { 35939520Snsouch if (imm_reset_bus(&vpo->vpo_io)) { 36039520Snsouch ccb->ccb_h.status = CAM_REQ_CMP_ERR; 36139520Snsouch xpt_done(ccb); 36239520Snsouch return; 36339520Snsouch } 36439520Snsouch } else { 36539520Snsouch if (vpoio_reset_bus(&vpo->vpo_io)) { 36639520Snsouch ccb->ccb_h.status = CAM_REQ_CMP_ERR; 36739520Snsouch xpt_done(ccb); 36839520Snsouch return; 36939520Snsouch } 37039520Snsouch } 37139520Snsouch 37239520Snsouch ccb->ccb_h.status = CAM_REQ_CMP; 37339520Snsouch xpt_done(ccb); 37439520Snsouch break; 37528219Smsmith } 37639520Snsouch case XPT_PATH_INQ: /* Path routing inquiry */ 37739520Snsouch { 37839520Snsouch struct ccb_pathinq *cpi = &ccb->cpi; 379185003Sjhb 38039520Snsouch#ifdef VP0_DEBUG 381184130Sjhb device_printf(vpo->vpo_dev, "XPT_PATH_INQ request\n"); 38239520Snsouch#endif 38339520Snsouch cpi->version_num = 1; /* XXX??? */ 38442441Snsouch cpi->hba_inquiry = 0; 38542441Snsouch cpi->target_sprt = 0; 38642441Snsouch cpi->hba_misc = 0; 38742441Snsouch cpi->hba_eng_cnt = 0; 38839520Snsouch cpi->max_target = 7; 38939520Snsouch cpi->max_lun = 0; 39039520Snsouch cpi->initiator_id = VP0_INITIATOR; 39139520Snsouch cpi->bus_id = sim->bus_id; 39246586Sken cpi->base_transfer_speed = 93; 393315813Smav strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN); 394315813Smav strlcpy(cpi->hba_vid, "Iomega", HBA_IDLEN); 395315813Smav strlcpy(cpi->dev_name, sim->sim_name, DEV_IDLEN); 39639520Snsouch cpi->unit_number = sim->unit_number; 397196352Smav cpi->transport = XPORT_PPB; 398196352Smav cpi->transport_version = 0; 39928219Smsmith 40039520Snsouch cpi->ccb_h.status = CAM_REQ_CMP; 40139520Snsouch xpt_done(ccb); 40239520Snsouch break; 40339520Snsouch } 40439520Snsouch default: 40539520Snsouch ccb->ccb_h.status = CAM_REQ_INVALID; 40639520Snsouch xpt_done(ccb); 40739520Snsouch break; 40839520Snsouch } 40928219Smsmith 41039520Snsouch return; 41139520Snsouch} 41228219Smsmith 41339520Snsouchstatic void 41439520Snsouchvpo_poll(struct cam_sim *sim) 415185003Sjhb{ 416185003Sjhb 417185003Sjhb /* The ZIP is actually always polled throw vpo_action(). */ 41828219Smsmith} 41955939Snsouch 42056455Speterstatic devclass_t vpo_devclass; 42156455Speter 42256455Speterstatic device_method_t vpo_methods[] = { 42356455Speter /* device interface */ 42456455Speter DEVMETHOD(device_identify, vpo_identify), 42556455Speter DEVMETHOD(device_probe, vpo_probe), 42656455Speter DEVMETHOD(device_attach, vpo_attach), 42756455Speter 42856455Speter { 0, 0 } 42956455Speter}; 43056455Speter 43156455Speterstatic driver_t vpo_driver = { 43256455Speter "vpo", 43356455Speter vpo_methods, 43456455Speter sizeof(struct vpo_data), 43556455Speter}; 43655939SnsouchDRIVER_MODULE(vpo, ppbus, vpo_driver, vpo_devclass, 0, 0); 437165102SmjacobMODULE_DEPEND(vpo, ppbus, 1, 1, 1); 438165102SmjacobMODULE_DEPEND(vpo, cam, 1, 1, 1); 439