drivers/media/dvb/siano/smsusb.c

   1 /*
   2  *  Driver for the Siano SMS10xx USB dongle
   3  *
   4  *  author: Anatoly Greenblat
   5  *
   6  *  Copyright (c), 2005-2008 Siano Mobile Silicon, Inc.
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License version 3 as
  10  *  published by the Free Software Foundation;
  11  *
  12  *  Software distributed under the License is distributed on an "AS IS"
  13  *  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
  14  *
  15  *  See the GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program; if not, write to the Free Software
  19  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22 #include <linux/kernel.h>
  23 #include <linux/init.h>
  24 #include <linux/usb.h>
  25 #include <linux/firmware.h>
  26
  27 #include "smscoreapi.h"
  28 #include "sms-cards.h"
  29
  30 #define USB1_BUFFER_SIZE                0x1000
  31 #define USB2_BUFFER_SIZE                0x4000
  32
  33 #define MAX_BUFFERS             50
  34 #define MAX_URBS                10
  35
  36 struct smsusb_device_t;
  37
  38 struct smsusb_urb_t {
  39         struct smscore_buffer_t *cb;
  40         struct smsusb_device_t  *dev;
  41
  42         struct urb urb;
  43 };
  44
  45 struct smsusb_device_t {
  46         struct usb_device *udev;
  47         struct smscore_device_t *coredev;
  48
  49         struct smsusb_urb_t     surbs[MAX_URBS];
  50
  51         int             response_alignment;
  52         int             buffer_size;
  53 };
  54
  55 static int smsusb_submit_urb(struct smsusb_device_t *dev,
  56                              struct smsusb_urb_t *surb);
  57
  58 static void smsusb_onresponse(struct urb *urb)
  59 {
  60         struct smsusb_urb_t *surb = (struct smsusb_urb_t *) urb->context;
  61         struct smsusb_device_t *dev = surb->dev;
  62
  63         if (urb->status < 0) {
  64                 sms_err("error, urb status %d, %d bytes",
  65                         urb->status, urb->actual_length);
  66                 return;
  67         }
  68
  69         if (urb->actual_length > 0) {
  70                 struct SmsMsgHdr_ST *phdr = (struct SmsMsgHdr_ST *) surb->cb->p;
  71
  72                 if (urb->actual_length >= phdr->msgLength) {
  73                         surb->cb->size = phdr->msgLength;
  74
  75                         if (dev->response_alignment &&
  76                             (phdr->msgFlags & MSG_HDR_FLAG_SPLIT_MSG)) {
  77
  78                                 surb->cb->offset =
  79                                         dev->response_alignment +
  80                                         ((phdr->msgFlags >> 8) & 3);
  81
  82                                 /* sanity check */
  83                                 if (((int) phdr->msgLength +
  84                                      surb->cb->offset) > urb->actual_length) {
  85                                         sms_err("invalid response "
  86                                                 "msglen %d offset %d "
  87                                                 "size %d",
  88                                                 phdr->msgLength,
  89                                                 surb->cb->offset,
  90                                                 urb->actual_length);
  91                                         goto exit_and_resubmit;
  92                                 }
  93
  94                                 /* move buffer pointer and
  95                                  * copy header to its new location */
  96                                 memcpy((char *) phdr + surb->cb->offset,
  97                                        phdr, sizeof(struct SmsMsgHdr_ST));
  98                         } else
  99                                 surb->cb->offset = 0;
 100
 101                         smscore_onresponse(dev->coredev, surb->cb);
 102                         surb->cb = NULL;
 103                 } else {
 104                         sms_err("invalid response "
 105                                 "msglen %d actual %d",
 106                                 phdr->msgLength, urb->actual_length);
 107                 }
 108         }
 109
 110 exit_and_resubmit:
 111         smsusb_submit_urb(dev, surb);
 112 }
 113
 114 static int smsusb_submit_urb(struct smsusb_device_t *dev,
 115                              struct smsusb_urb_t *surb)
 116 {
 117         if (!surb->cb) {
 118                 surb->cb = smscore_getbuffer(dev->coredev);
 119                 if (!surb->cb) {
 120                         sms_err("smscore_getbuffer(...) returned NULL");
 121                         return -ENOMEM;
 122                 }
 123         }
 124
 125         usb_fill_bulk_urb(
 126                 &surb->urb,
 127                 dev->udev,
 128                 usb_rcvbulkpipe(dev->udev, 0x81),
 129                 surb->cb->p,
 130                 dev->buffer_size,
 131                 smsusb_onresponse,
 132                 surb
 133         );
 134         surb->urb.transfer_dma = surb->cb->phys;
 135         surb->urb.transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 136
 137         return usb_submit_urb(&surb->urb, GFP_ATOMIC);
 138 }
 139
 140 static void smsusb_stop_streaming(struct smsusb_device_t *dev)
 141 {
 142         int i;
 143
 144         for (i = 0; i < MAX_URBS; i++) {
 145                 usb_kill_urb(&dev->surbs[i].urb);
 146
 147                 if (dev->surbs[i].cb) {
 148                         smscore_putbuffer(dev->coredev, dev->surbs[i].cb);
 149                         dev->surbs[i].cb = NULL;
 150                 }
 151         }
 152 }
 153
 154 static int smsusb_start_streaming(struct smsusb_device_t *dev)
 155 {
 156         int i, rc;
 157
 158         for (i = 0; i < MAX_URBS; i++) {
 159                 rc = smsusb_submit_urb(dev, &dev->surbs[i]);
 160                 if (rc < 0) {
 161                         sms_err("smsusb_submit_urb(...) failed");
 162                         smsusb_stop_streaming(dev);
 163                         break;
 164                 }
 165         }
 166
 167         return rc;
 168 }
 169
 170 static int smsusb_sendrequest(void *context, void *buffer, size_t size)
 171 {
 172         struct smsusb_device_t *dev = (struct smsusb_device_t *) context;
 173         int dummy;
 174
 175         return usb_bulk_msg(dev->udev, usb_sndbulkpipe(dev->udev, 2),
 176                             buffer, size, &dummy, 1000);
 177 }
 178
 179 static char *smsusb1_fw_lkup[] = {
 180         "dvbt_stellar_usb.inp",
 181         "dvbh_stellar_usb.inp",
 182         "tdmb_stellar_usb.inp",
 183         "none",
 184         "dvbt_bda_stellar_usb.inp",
 185 };
 186
 187 static int smsusb1_load_firmware(struct usb_device *udev, int id)
 188 {
 189         const struct firmware *fw;
 190         u8 *fw_buffer;
 191         int rc, dummy;
 192
 193         if (id < DEVICE_MODE_DVBT || id > DEVICE_MODE_DVBT_BDA) {
 194                 sms_err("invalid firmware id specified %d", id);
 195                 return -EINVAL;
 196         }
 197
 198         rc = request_firmware(&fw, smsusb1_fw_lkup[id], &udev->dev);
 199         if (rc < 0) {
 200                 sms_err("failed to open \"%s\" mode %d",
 201                         smsusb1_fw_lkup[id], id);
 202                 return rc;
 203         }
 204
 205         fw_buffer = kmalloc(fw->size, GFP_KERNEL);
 206         if (fw_buffer) {
 207                 memcpy(fw_buffer, fw->data, fw->size);
 208
 209                 rc = usb_bulk_msg(udev, usb_sndbulkpipe(udev, 2),
 210                                   fw_buffer, fw->size, &dummy, 1000);
 211
 212                 sms_info("sent %d(%d) bytes, rc %d", fw->size, dummy, rc);
 213
 214                 kfree(fw_buffer);
 215         } else {
 216                 sms_err("failed to allocate firmware buffer");
 217                 rc = -ENOMEM;
 218         }
 219         sms_info("read FW %s, size=%d", smsusb1_fw_lkup[id], fw->size);
 220
 221         release_firmware(fw);
 222
 223         return rc;
 224 }
 225
 226 static void smsusb1_detectmode(void *context, int *mode)
 227 {
 228         char *product_string =
 229                 ((struct smsusb_device_t *) context)->udev->product;
 230
 231         *mode = DEVICE_MODE_NONE;
 232
 233         if (!product_string) {
 234                 product_string = "none";
 235                 sms_err("product string not found");
 236         } else if (strstr(product_string, "DVBH"))
 237                 *mode = 1;
 238         else if (strstr(product_string, "BDA"))
 239                 *mode = 4;
 240         else if (strstr(product_string, "DVBT"))
 241                 *mode = 0;
 242         else if (strstr(product_string, "TDMB"))
 243                 *mode = 2;
 244
 245         sms_info("%d \"%s\"", *mode, product_string);
 246 }
 247
 248 static int smsusb1_setmode(void *context, int mode)
 249 {
 250         struct SmsMsgHdr_ST Msg = { MSG_SW_RELOAD_REQ, 0, HIF_TASK,
 251                              sizeof(struct SmsMsgHdr_ST), 0 };
 252
 253         if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_DVBT_BDA) {
 254                 sms_err("invalid firmware id specified %d", mode);
 255                 return -EINVAL;
 256         }
 257
 258         return smsusb_sendrequest(context, &Msg, sizeof(Msg));
 259 }
 260
 261 static void smsusb_term_device(struct usb_interface *intf)
 262 {
 263         struct smsusb_device_t *dev =
 264                 (struct smsusb_device_t *) usb_get_intfdata(intf);
 265
 266         if (dev) {
 267                 smsusb_stop_streaming(dev);
 268
 269                 /* unregister from smscore */
 270                 if (dev->coredev)
 271                         smscore_unregister_device(dev->coredev);
 272
 273                 kfree(dev);
 274
 275                 sms_info("device %p destroyed", dev);
 276         }
 277
 278         usb_set_intfdata(intf, NULL);
 279 }
 280
 281 static int smsusb_init_device(struct usb_interface *intf, int board_id)
 282 {
 283         struct smsdevice_params_t params;
 284         struct smsusb_device_t *dev;
 285         int i, rc;
 286
 287         /* create device object */
 288         dev = kzalloc(sizeof(struct smsusb_device_t), GFP_KERNEL);
 289         if (!dev) {
 290                 sms_err("kzalloc(sizeof(struct smsusb_device_t) failed");
 291                 return -ENOMEM;
 292         }
 293
 294         memset(&params, 0, sizeof(params));
 295         usb_set_intfdata(intf, dev);
 296         dev->udev = interface_to_usbdev(intf);
 297
 298         params.device_type = sms_get_board(board_id)->type;
 299
 300         switch (params.device_type) {
 301         case SMS_STELLAR:
 302                 dev->buffer_size = USB1_BUFFER_SIZE;
 303
 304                 params.setmode_handler = smsusb1_setmode;
 305                 params.detectmode_handler = smsusb1_detectmode;
 306                 break;
 307         default:
 308                 sms_err("Unspecified sms device type!");
 309                 /* fall-thru */
 310         case SMS_NOVA_A0:
 311         case SMS_NOVA_B0:
 312         case SMS_VEGA:
 313                 dev->buffer_size = USB2_BUFFER_SIZE;
 314                 dev->response_alignment =
 315                         dev->udev->ep_in[1]->desc.wMaxPacketSize -
 316                         sizeof(struct SmsMsgHdr_ST);
 317
 318                 params.flags |= SMS_DEVICE_FAMILY2;
 319                 break;
 320         }
 321
 322         params.device = &dev->udev->dev;
 323         params.buffer_size = dev->buffer_size;
 324         params.num_buffers = MAX_BUFFERS;
 325         params.sendrequest_handler = smsusb_sendrequest;
 326         params.context = dev;
 327         snprintf(params.devpath, sizeof(params.devpath),
 328                  "usb\\%d-%s", dev->udev->bus->busnum, dev->udev->devpath);
 329
 330         /* register in smscore */
 331         rc = smscore_register_device(&params, &dev->coredev);
 332         if (rc < 0) {
 333                 sms_err("smscore_register_device(...) failed, rc %d", rc);
 334                 smsusb_term_device(intf);
 335                 return rc;
 336         }
 337
 338         smscore_set_board_id(dev->coredev, board_id);
 339
 340         /* initialize urbs */
 341         for (i = 0; i < MAX_URBS; i++) {
 342                 dev->surbs[i].dev = dev;
 343                 usb_init_urb(&dev->surbs[i].urb);
 344         }
 345
 346         sms_info("smsusb_start_streaming(...).");
 347         rc = smsusb_start_streaming(dev);
 348         if (rc < 0) {
 349                 sms_err("smsusb_start_streaming(...) failed");
 350                 smsusb_term_device(intf);
 351                 return rc;
 352         }
 353
 354         rc = smscore_start_device(dev->coredev);
 355         if (rc < 0) {
 356                 sms_err("smscore_start_device(...) failed");
 357                 smsusb_term_device(intf);
 358                 return rc;
 359         }
 360
 361         sms_info("device %p created", dev);
 362
 363         return rc;
 364 }
 365
 366 static int smsusb_probe(struct usb_interface *intf,
 367                         const struct usb_device_id *id)
 368 {
 369         struct usb_device *udev = interface_to_usbdev(intf);
 370         char devpath[32];
 371         int i, rc;
 372
 373         rc = usb_clear_halt(udev, usb_rcvbulkpipe(udev, 0x81));
 374         rc = usb_clear_halt(udev, usb_rcvbulkpipe(udev, 0x02));
 375
 376         if (intf->num_altsetting > 0) {
 377                 rc = usb_set_interface(
 378                         udev, intf->cur_altsetting->desc.bInterfaceNumber, 0);
 379                 if (rc < 0) {
 380                         sms_err("usb_set_interface failed, rc %d", rc);
 381                         return rc;
 382                 }
 383         }
 384
 385         sms_info("smsusb_probe %d",
 386                intf->cur_altsetting->desc.bInterfaceNumber);
 387         for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++)
 388                 sms_info("endpoint %d %02x %02x %d", i,
 389                        intf->cur_altsetting->endpoint[i].desc.bEndpointAddress,
 390                        intf->cur_altsetting->endpoint[i].desc.bmAttributes,
 391                        intf->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
 392
 393         if ((udev->actconfig->desc.bNumInterfaces == 2) &&
 394             (intf->cur_altsetting->desc.bInterfaceNumber == 0)) {
 395                 sms_err("rom interface 0 is not used");
 396                 return -ENODEV;
 397         }
 398
 399         if (intf->cur_altsetting->desc.bInterfaceNumber == 1) {
 400                 snprintf(devpath, sizeof(devpath), "usb\\%d-%s",
 401                          udev->bus->busnum, udev->devpath);
 402                 sms_info("stellar device was found.");
 403                 return smsusb1_load_firmware(
 404                                 udev, smscore_registry_getmode(devpath));
 405         }
 406
 407         rc = smsusb_init_device(intf, id->driver_info);
 408         sms_info("rc %d", rc);
 409         return rc;
 410 }
 411
 412 static void smsusb_disconnect(struct usb_interface *intf)
 413 {
 414         smsusb_term_device(intf);
 415 }
 416
 417 static struct usb_driver smsusb_driver = {
 418         .name                   = "smsusb",
 419         .probe                  = smsusb_probe,
 420         .disconnect             = smsusb_disconnect,
 421         .id_table               = smsusb_id_table,
 422 };
 423
 424 int smsusb_register(void)
 425 {
 426         int rc = usb_register(&smsusb_driver);
 427         if (rc)
 428                 sms_err("usb_register failed. Error number %d", rc);
 429
 430         sms_debug("");
 431
 432         return rc;
 433 }
 434
 435 void smsusb_unregister(void)
 436 {
 437         sms_debug("");
 438         /* Regular USB Cleanup */
 439         usb_deregister(&smsusb_driver);
 440 }
 441