sys/bus/u4b/template/usb_template_mtp.c

   1 #include <sys/cdefs.h>
   2 __FBSDID("$FreeBSD$");
   3
   4 /*-
   5  * Copyright (c) 2008 Hans Petter Selasky <hselasky@FreeBSD.org>
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  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 the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 /*
  31  * This file contains the USB templates for an USB Message Transfer
  32  * Protocol device.
  33  *
  34  * NOTE: It is common practice that MTP devices use some dummy
  35  * descriptor cludges to be automatically detected by the host
  36  * operating system. These descriptors are documented in the LibMTP
  37  * library at sourceforge.net. The alternative is to supply the host
  38  * operating system the VID and PID of your device.
  39  */
  40
  41 #include <sys/stdint.h>
  42 #include <sys/stddef.h>
  43 #include <sys/param.h>
  44 #include <sys/queue.h>
  45 #include <sys/types.h>
  46 #include <sys/systm.h>
  47 #include <sys/kernel.h>
  48 #include <sys/bus.h>
  49 #include <sys/module.h>
  50 #include <sys/lock.h>
  51 #include <sys/mutex.h>
  52 #include <sys/condvar.h>
  53 #include <sys/sysctl.h>
  54 #include <sys/sx.h>
  55 #include <sys/unistd.h>
  56 #include <sys/callout.h>
  57 #include <sys/malloc.h>
  58 #include <sys/priv.h>
  59
  60 #include <dev/usb/usb.h>
  61 #include <dev/usb/usbdi.h>
  62 #include <dev/usb/template/usb_template.h>
  63
  64 #define MTP_BREQUEST 0x08
  65
  66 enum {
  67         STRING_LANG_INDEX,
  68         STRING_MTP_DATA_INDEX,
  69         STRING_MTP_CONFIG_INDEX,
  70         STRING_MTP_VENDOR_INDEX,
  71         STRING_MTP_PRODUCT_INDEX,
  72         STRING_MTP_SERIAL_INDEX,
  73         STRING_MTP_MAX,
  74 };
  75
  76 #define STRING_LANG \
  77   0x09, 0x04,                           /* American English */
  78
  79 #define STRING_MTP_DATA \
  80   'U', 0, 'S', 0, 'B', 0, ' ', 0, \
  81   'M', 0, 'T', 0, 'P', 0, \
  82   ' ', 0, 'I', 0, 'n', 0, 't', 0, \
  83   'e', 0, 'r', 0, 'f', 0, 'a', 0, \
  84   'c', 0, 'e', 0,
  85
  86 #define STRING_MTP_CONFIG \
  87   'D', 0, 'e', 0, 'f', 0, 'a', 0, \
  88   'u', 0, 'l', 0, 't', 0, ' ', 0, \
  89   'c', 0, 'o', 0, 'n', 0, 'f', 0, \
  90   'i', 0, 'g', 0,
  91
  92 #define STRING_MTP_VENDOR \
  93   'F', 0, 'r', 0, 'e', 0, 'e', 0, \
  94   'B', 0, 'S', 0, 'D', 0, ' ', 0, \
  95   'f', 0, 'o', 0, 'u', 0, 'n', 0, \
  96   'd', 0, 'a', 0, 't', 0, 'i', 0, \
  97   'o', 0, 'n', 0,
  98
  99 #define STRING_MTP_PRODUCT \
 100   'U', 0, 'S', 0, 'B', 0, ' ', 0, \
 101   'M', 0, 'T', 0, 'P', 0,
 102
 103 #define STRING_MTP_SERIAL \
 104   'J', 0, 'u', 0, 'n', 0, 'e', 0, \
 105   ' ', 0, '2', 0, '0', 0, '0', 0, \
 106   '8', 0,
 107
 108 /* make the real string descriptors */
 109
 110 USB_MAKE_STRING_DESC(STRING_LANG, string_lang);
 111 USB_MAKE_STRING_DESC(STRING_MTP_DATA, string_mtp_data);
 112 USB_MAKE_STRING_DESC(STRING_MTP_CONFIG, string_mtp_config);
 113 USB_MAKE_STRING_DESC(STRING_MTP_VENDOR, string_mtp_vendor);
 114 USB_MAKE_STRING_DESC(STRING_MTP_PRODUCT, string_mtp_product);
 115 USB_MAKE_STRING_DESC(STRING_MTP_SERIAL, string_mtp_serial);
 116
 117 /* prototypes */
 118
 119 static usb_temp_get_string_desc_t mtp_get_string_desc;
 120 static usb_temp_get_vendor_desc_t mtp_get_vendor_desc;
 121
 122 static const struct usb_temp_packet_size bulk_mps = {
 123         .mps[USB_SPEED_FULL] = 64,
 124         .mps[USB_SPEED_HIGH] = 512,
 125 };
 126
 127 static const struct usb_temp_packet_size intr_mps = {
 128         .mps[USB_SPEED_FULL] = 64,
 129         .mps[USB_SPEED_HIGH] = 64,
 130 };
 131
 132 static const struct usb_temp_endpoint_desc bulk_out_ep = {
 133         .pPacketSize = &bulk_mps,
 134 #ifdef USB_HIP_OUT_EP_0
 135         .bEndpointAddress = USB_HIP_OUT_EP_0,
 136 #else
 137         .bEndpointAddress = UE_DIR_OUT,
 138 #endif
 139         .bmAttributes = UE_BULK,
 140 };
 141
 142 static const struct usb_temp_endpoint_desc intr_in_ep = {
 143         .pPacketSize = &intr_mps,
 144         .bEndpointAddress = UE_DIR_IN,
 145         .bmAttributes = UE_INTERRUPT,
 146 };
 147
 148 static const struct usb_temp_endpoint_desc bulk_in_ep = {
 149         .pPacketSize = &bulk_mps,
 150 #ifdef USB_HIP_IN_EP_0
 151         .bEndpointAddress = USB_HIP_IN_EP_0,
 152 #else
 153         .bEndpointAddress = UE_DIR_IN,
 154 #endif
 155         .bmAttributes = UE_BULK,
 156 };
 157
 158 static const struct usb_temp_endpoint_desc *mtp_data_endpoints[] = {
 159         &bulk_in_ep,
 160         &bulk_out_ep,
 161         &intr_in_ep,
 162         NULL,
 163 };
 164
 165 static const struct usb_temp_interface_desc mtp_data_interface = {
 166         .ppEndpoints = mtp_data_endpoints,
 167         .bInterfaceClass = UICLASS_IMAGE,
 168         .bInterfaceSubClass = UISUBCLASS_SIC,   /* Still Image Class */
 169         .bInterfaceProtocol = 1,        /* PIMA 15740 */
 170         .iInterface = STRING_MTP_DATA_INDEX,
 171 };
 172
 173 static const struct usb_temp_interface_desc *mtp_interfaces[] = {
 174         &mtp_data_interface,
 175         NULL,
 176 };
 177
 178 static const struct usb_temp_config_desc mtp_config_desc = {
 179         .ppIfaceDesc = mtp_interfaces,
 180         .bmAttributes = UC_BUS_POWERED,
 181         .bMaxPower = 25,                /* 50 mA */
 182         .iConfiguration = STRING_MTP_CONFIG_INDEX,
 183 };
 184
 185 static const struct usb_temp_config_desc *mtp_configs[] = {
 186         &mtp_config_desc,
 187         NULL,
 188 };
 189
 190 const struct usb_temp_device_desc usb_template_mtp = {
 191         .getStringDesc = &mtp_get_string_desc,
 192         .getVendorDesc = &mtp_get_vendor_desc,
 193         .ppConfigDesc = mtp_configs,
 194         .idVendor = USB_TEMPLATE_VENDOR,
 195         .idProduct = 0x0011,
 196         .bcdDevice = 0x0100,
 197         .bDeviceClass = 0,
 198         .bDeviceSubClass = 0,
 199         .bDeviceProtocol = 0,
 200         .iManufacturer = STRING_MTP_VENDOR_INDEX,
 201         .iProduct = STRING_MTP_PRODUCT_INDEX,
 202         .iSerialNumber = STRING_MTP_SERIAL_INDEX,
 203 };
 204
 205 /*------------------------------------------------------------------------*
 206  *      mtp_get_vendor_desc
 207  *
 208  * Return values:
 209  * NULL: Failure. No such vendor descriptor.
 210  * Else: Success. Pointer to vendor descriptor is returned.
 211  *------------------------------------------------------------------------*/
 212 static const void *
 213 mtp_get_vendor_desc(const struct usb_device_request *req, uint16_t *plen)
 214 {
 215         static const uint8_t dummy_desc[0x28] = {
 216                 0x28, 0, 0, 0, 0, 1, 4, 0,
 217                 1, 0, 0, 0, 0, 0, 0, 0,
 218                 0, 1, 0x4D, 0x54, 0x50, 0, 0, 0,
 219                 0, 0, 0, 0, 0, 0, 0, 0,
 220                 0, 0, 0, 0, 0, 0, 0, 0,
 221         };
 222
 223         if ((req->bmRequestType == UT_READ_VENDOR_DEVICE) &&
 224             (req->bRequest == MTP_BREQUEST) && (req->wValue[0] == 0) &&
 225             (req->wValue[1] == 0) && (req->wIndex[1] == 0) &&
 226             ((req->wIndex[0] == 4) || (req->wIndex[0] == 5))) {
 227                 /*
 228                  * By returning this descriptor LibMTP will
 229                  * automatically pickup our device.
 230                  */
 231                 return (dummy_desc);
 232         }
 233         return (NULL);
 234 }
 235
 236 /*------------------------------------------------------------------------*
 237  *      mtp_get_string_desc
 238  *
 239  * Return values:
 240  * NULL: Failure. No such string.
 241  * Else: Success. Pointer to string descriptor is returned.
 242  *------------------------------------------------------------------------*/
 243 static const void *
 244 mtp_get_string_desc(uint16_t lang_id, uint8_t string_index)
 245 {
 246         static const void *ptr[STRING_MTP_MAX] = {
 247                 [STRING_LANG_INDEX] = &string_lang,
 248                 [STRING_MTP_DATA_INDEX] = &string_mtp_data,
 249                 [STRING_MTP_CONFIG_INDEX] = &string_mtp_config,
 250                 [STRING_MTP_VENDOR_INDEX] = &string_mtp_vendor,
 251                 [STRING_MTP_PRODUCT_INDEX] = &string_mtp_product,
 252                 [STRING_MTP_SERIAL_INDEX] = &string_mtp_serial,
 253         };
 254
 255         static const uint8_t dummy_desc[0x12] = {
 256                 0x12, 0x03, 0x4D, 0x00, 0x53, 0x00, 0x46, 0x00,
 257                 0x54, 0x00, 0x31, 0x00, 0x30, 0x00, 0x30, 0x00,
 258                 MTP_BREQUEST, 0x00,
 259         };
 260
 261         if (string_index == 0xEE) {
 262                 /*
 263                  * By returning this string LibMTP will automatically
 264                  * pickup our device.
 265                  */
 266                 return (dummy_desc);
 267         }
 268         if (string_index == 0) {
 269                 return (&string_lang);
 270         }
 271         if (lang_id != 0x0409) {
 272                 return (NULL);
 273         }
 274         if (string_index < STRING_MTP_MAX) {
 275                 return (ptr[string_index]);
 276         }
 277         return (NULL);
 278 }