/*      $OpenBSD: umass_quirks.c,v 1.35 2024/05/23 03:21:09 jsg Exp $   */
/*      $NetBSD: umass_quirks.c,v 1.67 2004/06/28 07:49:16 mycroft Exp $        */

/*
 * Copyright (c) 2001 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by MAEKAWA Masahide (gehenna@NetBSD.org).
 *
 * 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.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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/param.h>
#include <sys/systm.h>
#include <sys/device.h>

#include <scsi/scsi_all.h>
#include <scsi/scsiconf.h>

#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usbdevs.h>

#include <dev/usb/umassvar.h>
#include <dev/usb/umass_quirks.h>

usbd_status umass_init_insystem(struct umass_softc *);
usbd_status umass_init_shuttle(struct umass_softc *);

void umass_fixup_sony(struct umass_softc *);
void umass_fixup_yedata(struct umass_softc *);

const struct umass_quirk umass_quirks[] = {
        { { USB_VENDOR_ATI, USB_PRODUCT_ATI2_205 },
          UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_DMI, USB_PRODUCT_DMI_SA2_0 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_DOMAIN, USB_PRODUCT_DOMAIN_ROCKCHIP },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          UMASS_QUIRK_WRONG_CSWTAG,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_EASYDISK, USB_PRODUCT_EASYDISK_EASYDISK },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_FUJIPHOTO, USB_PRODUCT_FUJIPHOTO_MASS0100 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          ADEV_NOSENSE,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_GENESYS, USB_PRODUCT_GENESYS_GL641USB },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_HP, USB_PRODUCT_HP_CDWRITERPLUS },
          UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
          0,
          ADEV_NOSENSE,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_IMATION, USB_PRODUCT_IMATION_FLASHGO },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ADAPTERV2 },
          UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },
        { { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ATAPI },
          UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },
        { { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_DRIVEV2_5 },
          UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_IDEUSB2 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_USBCABLE },
          UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          umass_init_insystem, NULL
        },

        { { USB_VENDOR_IODATA2, USB_PRODUCT_IODATA2_USB2SC },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP100 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP250 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP250_2 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_IRIVER, USB_PRODUCT_IRIVER_IFP_1XX },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_IRIVER, USB_PRODUCT_IRIVER_IFP_3XX },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_MELCO, USB_PRODUCT_MELCO_DUBPXXG },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_MICROTECH, USB_PRODUCT_MICROTECH_DPCM },
          UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_S304 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_X },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_DIMAGEA1 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY2 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_ATAPI,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_NEODIO, USB_PRODUCT_NEODIO_ND3050 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_NEODIO, USB_PRODUCT_NEODIO_ND5010 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_OLYMPUS, USB_PRODUCT_OLYMPUS_C1 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          UMASS_QUIRK_WRONG_CSWSIG,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_OLYMPUS, USB_PRODUCT_OLYMPUS_C700 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          SDEV_NOSYNCCACHE,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MD1II },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MD2 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_OTI, USB_PRODUCT_OTI_SOLID },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_PEN, USB_PRODUCT_PEN_MOBILEDRIVE },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_PEN, USB_PRODUCT_PEN_USBDISK },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_PEN, USB_PRODUCT_PEN_USBREADER },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_PILOTECH, USB_PRODUCT_PILOTECH_CRW600 },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_PQI, USB_PRODUCT_PQI_TRAVELFLASH },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_SL11R },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          UMASS_QUIRK_WRONG_CSWTAG,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSB },
          UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
          0,
          ADEV_NOSENSE,
          UMATCH_VENDOR_PRODUCT,
          umass_init_shuttle, NULL
        },

        { { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_ZIOMMC },
          UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_SIIG, USB_PRODUCT_SIIG_MULTICARDREADER },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL,NULL
        },

        { { USB_VENDOR_SONY, USB_PRODUCT_SONY_DRIVEV2 },
          UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_SONY, USB_PRODUCT_SONY_DSC },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, umass_fixup_sony
        },

        { { USB_VENDOR_SONY, USB_PRODUCT_SONY_MSC },
          UMASS_WPROTO_CBI, UMASS_CPROTO_UFI,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_TEAC, USB_PRODUCT_TEAC_FD05PUB },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_TREK, USB_PRODUCT_TREK_THUMBDRIVE_8MB },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
          0,
          0,
          UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
          NULL, NULL
        },

        { { USB_VENDOR_TRUMPION, USB_PRODUCT_TRUMPION_XXX1100 },
          UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_YANO, USB_PRODUCT_YANO_U640MO },
          UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
          0,
          0,
          UMATCH_VENDOR_PRODUCT,
          NULL, NULL
        },

        { { USB_VENDOR_YEDATA, USB_PRODUCT_YEDATA_FLASHBUSTERU },
          UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UFI,
          0,
          0,
          UMATCH_VENDOR_PRODUCT_REV,
          NULL, umass_fixup_yedata
        },

        { { USB_VENDOR_SIGMATEL, USB_PRODUCT_SIGMATEL_DNSSF7X},
         UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
         0,
         SDEV_NOSYNCCACHE,
         UMATCH_VENDOR_PRODUCT,
         NULL, NULL
        },

        { { USB_VENDOR_CREATIVE, USB_PRODUCT_CREATIVE_NOMAD},
         UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
         0,
         SDEV_NOSYNCCACHE,
         UMATCH_VENDOR_PRODUCT,
         NULL, NULL
        },

        { { USB_VENDOR_SUPERTOP, USB_PRODUCT_SUPERTOP_IDEBRIDGE },
         UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
         0,
         ADEV_NOSENSE,
         UMATCH_VENDOR_PRODUCT,
         NULL, NULL
        },

        { { USB_VENDOR_ERICSSON, USB_PRODUCT_ERICSSON_F5521GW },
         UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
         0,
         0,
         UMATCH_NONE,
         NULL, NULL
        },
};

const struct umass_quirk *
umass_lookup(u_int16_t vendor, u_int16_t product)
{
        return ((const struct umass_quirk *)
                usb_lookup(umass_quirks, vendor, product));
}

usbd_status
umass_init_insystem(struct umass_softc *sc)
{
        usbd_status err;

        err = usbd_set_interface(sc->sc_iface, 1);
        if (err) {
                DPRINTF(UDMASS_USB,
                        ("%s: could not switch to Alt Interface 1\n",
                        sc->sc_dev.dv_xname));
                return (err);
        }

        return (USBD_NORMAL_COMPLETION);
}

usbd_status
umass_init_shuttle(struct umass_softc *sc)
{
        usb_device_request_t req;
        u_int8_t status[2];

        /* The Linux driver does this */
        req.bmRequestType = UT_READ_VENDOR_DEVICE;
        req.bRequest = 1;
        USETW(req.wValue, 0);
        USETW(req.wIndex, sc->sc_ifaceno);
        USETW(req.wLength, sizeof(status));

        return (usbd_do_request(sc->sc_udev, &req, &status));
}

void
umass_fixup_sony(struct umass_softc *sc)
{
        usb_interface_descriptor_t *id;
        usb_device_descriptor_t *dd;

        id = usbd_get_interface_descriptor(sc->sc_iface);
        if (id->bInterfaceSubClass == 0xff) {
                dd = usbd_get_device_descriptor(sc->sc_udev);
                /*
                 * Many Sony DSC cameras share the same product ID, so the
                 * revision number is used to distinguish between them.
                 */
                switch (UGETW(dd->bcdDevice)) {
                case 0x611: /* Sony DSC-T10, rev 6.11 */
                case 0x600: /* Sony DSC-W50, rev 6.00 */
                case 0x500: /* Sony DSC-P41, rev 5.00 */
                        sc->sc_cmd = UMASS_CPROTO_UFI;
                        break;
                default:
                        sc->sc_cmd = UMASS_CPROTO_SCSI;
                }
        }
}

void
umass_fixup_yedata(struct umass_softc *sc)
{
        usb_device_descriptor_t *dd;

        dd = usbd_get_device_descriptor(sc->sc_udev);

        /*
         * Revisions < 1.28 do not handle the interrupt endpoint very well.
         */
        if (UGETW(dd->bcdDevice) < 0x128)
                sc->sc_wire = UMASS_WPROTO_CBI;
        else
                sc->sc_wire = UMASS_WPROTO_CBI_I;
}