cam_compat.c

Go to the documentation of this file.

/*-
 * CAM ioctl compatibility shims
 *
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
 * Copyright (c) 2013 Scott Long
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification, immediately at the beginning of the file.
 * 2. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 */
 
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
 
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/types.h>
#include <sys/kernel.h>
#include <sys/conf.h>
#include <sys/fcntl.h>
 
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/sysctl.h>
#include <sys/kthread.h>
 
#include <cam/cam.h>
#include <cam/cam_ccb.h>
#include <cam/cam_xpt.h>
#include <cam/cam_compat.h>
#include <cam/cam_periph.h>
 
#include <cam/scsi/scsi_pass.h>
 
#include "opt_cam.h"
 
static int cam_compat_handle_0x17(struct cdev *dev, u_long cmd, caddr_t addr,
    int flag, struct thread *td, d_ioctl_t *cbfnp);
static int cam_compat_handle_0x18(struct cdev *dev, u_long cmd, caddr_t addr,
    int flag, struct thread *td, d_ioctl_t *cbfnp);
static int cam_compat_handle_0x19(struct cdev *dev, u_long cmd, caddr_t addr,
    int flag, struct thread *td, d_ioctl_t *cbfnp);
static int cam_compat_translate_dev_match_0x18(union ccb *ccb);
 
int
cam_compat_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
    struct thread *td, d_ioctl_t *cbfnp)
{
        int error;
 
        switch (cmd) {
        case CAMIOCOMMAND_0x16:
        {
                struct ccb_hdr_0x17 *hdr17;
 
                hdr17 = (struct ccb_hdr_0x17 *)addr;
                if (hdr17->flags & CAM_SG_LIST_PHYS_0x16) {
                        hdr17->flags &= ~CAM_SG_LIST_PHYS_0x16;
                        hdr17->flags |= CAM_DATA_SG_PADDR;
                }
                if (hdr17->flags & CAM_DATA_PHYS_0x16) {
                        hdr17->flags &= ~CAM_DATA_PHYS_0x16;
                        hdr17->flags |= CAM_DATA_PADDR;
                }
                if (hdr17->flags & CAM_SCATTER_VALID_0x16) {
                        hdr17->flags &= CAM_SCATTER_VALID_0x16;
                        hdr17->flags |= CAM_DATA_SG;
                }
                cmd = CAMIOCOMMAND;
                error = cam_compat_handle_0x17(dev, cmd, addr, flag, td, cbfnp);
                break;
        }
        case CAMGETPASSTHRU_0x16:
                cmd = CAMGETPASSTHRU;
                error = cam_compat_handle_0x17(dev, cmd, addr, flag, td, cbfnp);
                break;
        case CAMIOCOMMAND_0x17:
                cmd = CAMIOCOMMAND;
                error = cam_compat_handle_0x17(dev, cmd, addr, flag, td, cbfnp);
                break;
        case CAMGETPASSTHRU_0x17:
                cmd = CAMGETPASSTHRU;
                error = cam_compat_handle_0x17(dev, cmd, addr, flag, td, cbfnp);
                break;
        case CAMIOCOMMAND_0x18:
                cmd = CAMIOCOMMAND;
                error = cam_compat_handle_0x18(dev, cmd, addr, flag, td, cbfnp);
                break;
        case CAMGETPASSTHRU_0x18:
                cmd = CAMGETPASSTHRU;
                error = cam_compat_handle_0x18(dev, cmd, addr, flag, td, cbfnp);
                break;
        case CAMIOCOMMAND_0x19:
                cmd = CAMIOCOMMAND;
                error = cam_compat_handle_0x19(dev, cmd, addr, flag, td, cbfnp);
                break;
        case CAMGETPASSTHRU_0x19:
                cmd = CAMGETPASSTHRU;
                error = cam_compat_handle_0x19(dev, cmd, addr, flag, td, cbfnp);
                break;
        case CAMIOQUEUE_0x19:
                cmd = CAMIOQUEUE;
                error = cam_compat_handle_0x19(dev, cmd, addr, flag, td, cbfnp);
                break;
        case CAMIOGET_0x19:
                cmd = CAMIOGET;
                error = cam_compat_handle_0x19(dev, cmd, addr, flag, td, cbfnp);
                break;
        default:
                error = ENOTTY;
        }
 
        return (error);
}
 
static int
cam_compat_handle_0x17(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
    struct thread *td, d_ioctl_t *cbfnp)
{
        union ccb               *ccb;
        struct ccb_hdr          *hdr;
        struct ccb_hdr_0x17     *hdr17;
        uint8_t                 *ccbb, *ccbb17;
        u_int                   error;
 
        hdr17 = (struct ccb_hdr_0x17 *)addr;
        ccb = xpt_alloc_ccb();
        hdr = &ccb->ccb_h;
 
        hdr->pinfo = hdr17->pinfo;
        hdr->xpt_links = hdr17->xpt_links;
        hdr->sim_links = hdr17->sim_links;
        hdr->periph_links = hdr17->periph_links;
        hdr->retry_count = hdr17->retry_count;
        hdr->cbfcnp = hdr17->cbfcnp;
        hdr->func_code = hdr17->func_code;
        hdr->status = hdr17->status;
        hdr->path = hdr17->path;
        hdr->path_id = hdr17->path_id;
        hdr->target_id = hdr17->target_id;
        hdr->target_lun = hdr17->target_lun;
        hdr->flags = hdr17->flags;
        hdr->xflags = 0;
        hdr->periph_priv = hdr17->periph_priv;
        hdr->sim_priv = hdr17->sim_priv;
        hdr->timeout = hdr17->timeout;
        hdr->softtimeout.tv_sec = 0;
        hdr->softtimeout.tv_usec = 0;
 
        ccbb = (uint8_t *)&hdr[1];
        ccbb17 = (uint8_t *)&hdr17[1];
        if (ccb->ccb_h.func_code == XPT_SET_TRAN_SETTINGS) {
                struct ccb_trans_settings *cts;
                struct ccb_trans_settings_0x17 *cts17;
 
                cts = &ccb->cts;
                cts17 = (struct ccb_trans_settings_0x17 *)hdr17;
                cts->type = cts17->type;
                cts->protocol = cts17->protocol;
                cts->protocol_version = cts17->protocol_version;
                cts->transport = cts17->transport;
                cts->transport_version = cts17->transport_version;
                bcopy(&cts17->proto_specific, &cts->proto_specific,
                    sizeof(cts17->proto_specific));
                bcopy(&cts17->xport_specific, &cts->xport_specific,
                    sizeof(cts17->xport_specific));
        } else {
                bcopy(ccbb17, ccbb, CAM_0X17_DATA_LEN);
        }
 
        error = cam_compat_handle_0x19(dev, cmd, (caddr_t)ccb, flag, td, cbfnp);
 
        hdr17->pinfo = hdr->pinfo;
        hdr17->xpt_links = hdr->xpt_links;
        hdr17->sim_links = hdr->sim_links;
        hdr17->periph_links = hdr->periph_links;
        hdr17->retry_count = hdr->retry_count;
        hdr17->cbfcnp = hdr->cbfcnp;
        hdr17->func_code = hdr->func_code;
        hdr17->status = hdr->status;
        hdr17->path = hdr->path;
        hdr17->path_id = hdr->path_id;
        hdr17->target_id = hdr->target_id;
        hdr17->target_lun = hdr->target_lun;
        hdr17->flags = hdr->flags;
        hdr17->periph_priv = hdr->periph_priv;
        hdr17->sim_priv = hdr->sim_priv;
        hdr17->timeout = hdr->timeout;
 
        if (ccb->ccb_h.func_code == XPT_PATH_INQ) {
                struct ccb_pathinq      *cpi;
                struct ccb_pathinq_0x17 *cpi17;
 
                /* The PATH_INQ only needs special handling on the way out */
                cpi = &ccb->cpi;
                cpi17 = (struct ccb_pathinq_0x17 *)hdr17;
                cpi17->version_num = cpi->version_num;
                cpi17->hba_inquiry = cpi->hba_inquiry;
                cpi17->target_sprt = (u_int8_t)cpi->target_sprt;
                cpi17->hba_misc = (u_int8_t)cpi->hba_misc;
                cpi17->hba_eng_cnt = cpi->hba_eng_cnt;
                bcopy(&cpi->vuhba_flags[0], &cpi17->vuhba_flags[0], VUHBALEN);
                cpi17->max_target = cpi->max_target;
                cpi17->max_lun = cpi->max_lun;
                cpi17->async_flags = cpi->async_flags;
                cpi17->hpath_id = cpi->hpath_id;
                cpi17->initiator_id = cpi->initiator_id;
                bcopy(&cpi->sim_vid[0], &cpi17->sim_vid[0], SIM_IDLEN);
                bcopy(&cpi->hba_vid[0], &cpi17->hba_vid[0], HBA_IDLEN);
                bcopy(&cpi->dev_name[0], &cpi17->dev_name[0], DEV_IDLEN);
                cpi17->unit_number = cpi->unit_number;
                cpi17->bus_id = cpi->bus_id;
                cpi17->base_transfer_speed = cpi->base_transfer_speed;
                cpi17->protocol = cpi->protocol;
                cpi17->protocol_version = cpi->protocol_version;
                cpi17->transport = cpi->transport;
                cpi17->transport_version = cpi->transport_version;
                bcopy(&cpi->xport_specific, &cpi17->xport_specific,
                    PATHINQ_SETTINGS_SIZE);
                cpi17->maxio = cpi->maxio;
                cpi17->hba_vendor = cpi->hba_vendor;
                cpi17->hba_device = cpi->hba_device;
                cpi17->hba_subvendor = cpi->hba_subvendor;
                cpi17->hba_subdevice = cpi->hba_subdevice;
        } else if (ccb->ccb_h.func_code == XPT_GET_TRAN_SETTINGS) {
                struct ccb_trans_settings *cts;
                struct ccb_trans_settings_0x17 *cts17;
 
                cts = &ccb->cts;
                cts17 = (struct ccb_trans_settings_0x17 *)hdr17;
                cts17->type = cts->type;
                cts17->protocol = cts->protocol;
                cts17->protocol_version = cts->protocol_version;
                cts17->transport = cts->transport;
                cts17->transport_version = cts->transport_version;
                bcopy(&cts->proto_specific, &cts17->proto_specific,
                    sizeof(cts17->proto_specific));
                bcopy(&cts->xport_specific, &cts17->xport_specific,
                    sizeof(cts17->xport_specific));
        } else if (ccb->ccb_h.func_code == XPT_DEV_MATCH) {
                /* Copy the rest of the header over */
                bcopy(ccbb, ccbb17, CAM_0X17_DATA_LEN);
 
                cam_compat_translate_dev_match_0x18(ccb);
        } else {
                bcopy(ccbb, ccbb17, CAM_0X17_DATA_LEN);
        }
 
        xpt_free_ccb(ccb);
 
        return (error);
}
 
static int
cam_compat_handle_0x18(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
    struct thread *td, d_ioctl_t *cbfnp)
{
        union ccb               *ccb;
        struct ccb_hdr          *hdr;
        struct ccb_hdr_0x18     *hdr18;
        uint8_t                 *ccbb, *ccbb18;
        u_int                   error;
 
        hdr18 = (struct ccb_hdr_0x18 *)addr;
        ccb = xpt_alloc_ccb();
        hdr = &ccb->ccb_h;
 
        hdr->pinfo = hdr18->pinfo;
        hdr->xpt_links = hdr18->xpt_links;
        hdr->sim_links = hdr18->sim_links;
        hdr->periph_links = hdr18->periph_links;
        hdr->retry_count = hdr18->retry_count;
        hdr->cbfcnp = hdr18->cbfcnp;
        hdr->func_code = hdr18->func_code;
        hdr->status = hdr18->status;
        hdr->path = hdr18->path;
        hdr->path_id = hdr18->path_id;
        hdr->target_id = hdr18->target_id;
        hdr->target_lun = hdr18->target_lun;
        if (hdr18->xflags & CAM_EXTLUN_VALID_0x18)
                hdr->target_lun = hdr18->ext_lun;
        hdr->flags = hdr18->flags;
        hdr->xflags = hdr18->xflags;
        hdr->periph_priv = hdr18->periph_priv;
        hdr->sim_priv = hdr18->sim_priv;
        hdr->timeout = hdr18->timeout;
        hdr->softtimeout.tv_sec = 0;
        hdr->softtimeout.tv_usec = 0;
 
        ccbb = (uint8_t *)&hdr[1];
        ccbb18 = (uint8_t *)&hdr18[1];
        if (ccb->ccb_h.func_code == XPT_SET_TRAN_SETTINGS) {
                struct ccb_trans_settings *cts;
                struct ccb_trans_settings_0x18 *cts18;
 
                cts = &ccb->cts;
                cts18 = (struct ccb_trans_settings_0x18 *)hdr18;
                cts->type = cts18->type;
                cts->protocol = cts18->protocol;
                cts->protocol_version = cts18->protocol_version;
                cts->transport = cts18->transport;
                cts->transport_version = cts18->transport_version;
                bcopy(&cts18->proto_specific, &cts->proto_specific,
                    sizeof(cts18->proto_specific));
                bcopy(&cts18->xport_specific, &cts->xport_specific,
                    sizeof(cts18->xport_specific));
        } else {
                bcopy(ccbb18, ccbb, CAM_0X18_DATA_LEN);
        }
 
        error = cam_compat_handle_0x19(dev, cmd, (caddr_t)ccb, flag, td, cbfnp);
 
        hdr18->pinfo = hdr->pinfo;
        hdr18->xpt_links = hdr->xpt_links;
        hdr18->sim_links = hdr->sim_links;
        hdr18->periph_links = hdr->periph_links;
        hdr18->retry_count = hdr->retry_count;
        hdr18->cbfcnp = hdr->cbfcnp;
        hdr18->func_code = hdr->func_code;
        hdr18->status = hdr->status;
        hdr18->path = hdr->path;
        hdr18->path_id = hdr->path_id;
        hdr18->target_id = hdr->target_id;
        hdr18->target_lun = hdr->target_lun;
        hdr18->ext_lun = hdr->target_lun;
        hdr18->flags = hdr->flags;
        hdr18->xflags = hdr->xflags | CAM_EXTLUN_VALID_0x18;
        hdr18->periph_priv = hdr->periph_priv;
        hdr18->sim_priv = hdr->sim_priv;
        hdr18->timeout = hdr->timeout;
 
        if (ccb->ccb_h.func_code == XPT_GET_TRAN_SETTINGS) {
                struct ccb_trans_settings *cts;
                struct ccb_trans_settings_0x18 *cts18;
 
                cts = &ccb->cts;
                cts18 = (struct ccb_trans_settings_0x18 *)hdr18;
                cts18->type = cts->type;
                cts18->protocol = cts->protocol;
                cts18->protocol_version = cts->protocol_version;
                cts18->transport = cts->transport;
                cts18->transport_version = cts->transport_version;
                bcopy(&cts->proto_specific, &cts18->proto_specific,
                    sizeof(cts18->proto_specific));
                bcopy(&cts->xport_specific, &cts18->xport_specific,
                    sizeof(cts18->xport_specific));
        } else if (ccb->ccb_h.func_code == XPT_DEV_MATCH) {
                bcopy(ccbb, ccbb18, CAM_0X18_DATA_LEN);
                cam_compat_translate_dev_match_0x18(ccb);
        } else {
                bcopy(ccbb, ccbb18, CAM_0X18_DATA_LEN);
        }
 
        xpt_free_ccb(ccb);
 
        return (error);
}
 
static int
cam_compat_translate_dev_match_0x18(union ccb *ccb)
{
        struct dev_match_result         *dm;
        struct dev_match_result_0x18    *dm18;
        struct cam_periph_map_info      mapinfo;
        int i;
 
        /* Remap the CCB into kernel address space */
        bzero(&mapinfo, sizeof(mapinfo));
        cam_periph_mapmem(ccb, &mapinfo, maxphys);
 
        dm = ccb->cdm.matches;
        /* Translate in-place: old fields are smaller */
        dm18 = (struct dev_match_result_0x18 *)(dm);
 
        for (i = 0; i < ccb->cdm.num_matches; i++) {
                dm18[i].type = dm[i].type;
                switch (dm[i].type) {
                case DEV_MATCH_PERIPH:
                        memcpy(&dm18[i].result.periph_result.periph_name, 
                            &dm[i].result.periph_result.periph_name,
                            DEV_IDLEN);
                        dm18[i].result.periph_result.unit_number =
                           dm[i].result.periph_result.unit_number;
                        dm18[i].result.periph_result.path_id =
                           dm[i].result.periph_result.path_id;
                        dm18[i].result.periph_result.target_id =
                           dm[i].result.periph_result.target_id;
                        dm18[i].result.periph_result.target_lun =
                           dm[i].result.periph_result.target_lun;
                        break;
                case DEV_MATCH_DEVICE:
                        dm18[i].result.device_result.path_id =
                           dm[i].result.device_result.path_id;
                        dm18[i].result.device_result.target_id =
                           dm[i].result.device_result.target_id;
                        dm18[i].result.device_result.target_lun =
                           dm[i].result.device_result.target_lun;
                        dm18[i].result.device_result.protocol =
                           dm[i].result.device_result.protocol;
                        memcpy(&dm18[i].result.device_result.inq_data, 
                            &dm[i].result.device_result.inq_data,
                            sizeof(struct scsi_inquiry_data));
                        memcpy(&dm18[i].result.device_result.ident_data,
                            &dm[i].result.device_result.ident_data,
                            sizeof(struct ata_params));
                        dm18[i].result.device_result.flags =
                           dm[i].result.device_result.flags;
                        break;
                case DEV_MATCH_BUS:
                        memcpy(&dm18[i].result.bus_result, 
                            &dm[i].result.bus_result,
                            sizeof(struct bus_match_result));
                        break;
                }
        }
 
        cam_periph_unmapmem(ccb, &mapinfo);
 
        return (0);
}
 
static int
cam_compat_handle_0x19(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
    struct thread *td, d_ioctl_t *cbfnp)
{
        union ccb *ccb = (union ccb *)addr;
        struct cam_periph_map_info      mapinfo;
 
        if (cmd == CAMIOCOMMAND && ccb->ccb_h.func_code == XPT_DEV_MATCH) {
                bzero(&mapinfo, sizeof(mapinfo));
                cam_periph_mapmem(ccb, &mapinfo, maxphys);
                for (int i = 0; i < ccb->cdm.num_patterns; i++) {
                        struct dev_match_pattern *p = &ccb->cdm.patterns[i];
 
                        if (p->type == DEV_MATCH_BUS &&
                            p->pattern.bus_pattern.flags == 0x00f)
                                p->pattern.bus_pattern.flags = BUS_MATCH_ANY;
                        if (p->type == DEV_MATCH_DEVICE &&
                            p->pattern.device_pattern.flags == 0x00f)
                                p->pattern.device_pattern.flags = DEV_MATCH_ANY;
                        if (p->type == DEV_MATCH_PERIPH &&
                            p->pattern.periph_pattern.flags == 0x01f)
                                p->pattern.periph_pattern.flags = PERIPH_MATCH_ANY;
                }
                cam_periph_unmapmem(ccb, &mapinfo);
        }
        return ((cbfnp)(dev, cmd, addr, flag, td));
}