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 int smsusb_submit_urb(struct smsusb_device_t *dev, struct smsusb_urb_t *surb);
  56
  57 void smsusb_onresponse(struct urb *urb)
  58 {
  59         struct smsusb_urb_t *surb = (struct smsusb_urb_t *) urb->context;
  60         struct smsusb_device_t *dev = surb->dev;
  61
  62         if (urb->status < 0) {
  63                 sms_info("error, urb status %d, %d bytes",
  64                          urb->status, urb->actual_length);
  65                 return;
  66         }
  67
  68         if (urb->actual_length > 0) {
  69                 struct SmsMsgHdr_ST *phdr = (struct SmsMsgHdr_ST *) surb->cb->p;
  70
  71                 if (urb->actual_length >= phdr->msgLength) {
  72                         surb->cb->size = phdr->msgLength;
  73
  74                         if (dev->response_alignment &&
  75                             (phdr->msgFlags & MSG_HDR_FLAG_SPLIT_MSG)) {
  76
  77                                 surb->cb->offset =
  78                                         dev->response_alignment +
  79                                         ((phdr->msgFlags >> 8) & 3);
  80
  81                                 /* sanity check */
  82                                 if (((int) phdr->msgLength +
  83                                      surb->cb->offset) > urb->actual_length) {
  84                                         sms_info("invalid response "
  85                                                  "msglen %d offset %d "
  86                                                  "size %d",
  87                                                  phdr->msgLength,
  88                                                  surb->cb->offset,
  89                                                  urb->actual_length);
  90                                         goto exit_and_resubmit;
  91                                 }
  92
  93                                 /* move buffer pointer and
  94                                  * copy header to its new location */
  95                                 memcpy((char *) phdr + surb->cb->offset,
  96                                        phdr, sizeof(struct SmsMsgHdr_ST));
  97                         } else
  98                                 surb->cb->offset = 0;
  99
 100                         smscore_onresponse(dev->coredev, surb->cb);
 101                         surb->cb = NULL;
 102                 } else {
 103                         sms_info("invalid response "
 104                                  "msglen %d actual %d",
 105                                  phdr->msgLength, urb->actual_length);
 106                 }
 107         }
 108
 109 exit_and_resubmit:
 110         smsusb_submit_urb(dev, surb);
 111 }
 112
 113 int smsusb_submit_urb(struct smsusb_device_t *dev, struct smsusb_urb_t *surb)
 114 {
 115         if (!surb->cb) {
 116                 surb->cb = smscore_getbuffer(dev->coredev);
 117                 if (!surb->cb) {
 118                         sms_info("smscore_getbuffer(...) "
 119                                  "returned NULL");
 120                         return -ENOMEM;
 121                 }
 122         }
 123
 124         usb_fill_bulk_urb(
 125                 &surb->urb,
 126                 dev->udev,
 127                 usb_rcvbulkpipe(dev->udev, 0x81),
 128                 surb->cb->p,
 129                 dev->buffer_size,
 130                 smsusb_onresponse,
 131                 surb
 132         );
 133         surb->urb.transfer_dma = surb->cb->phys;
 134         surb->urb.transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 135
 136         return usb_submit_urb(&surb->urb, GFP_ATOMIC);
 137 }
 138
 139 void smsusb_stop_streaming(struct smsusb_device_t *dev)
 140 {
 141         int i;
 142
 143         for (i = 0; i < MAX_URBS; i++) {
 144                 usb_kill_urb(&dev->surbs[i].urb);
 145
 146                 if (dev->surbs[i].cb) {
 147                         smscore_putbuffer(dev->coredev, dev->surbs[i].cb);
 148                         dev->surbs[i].cb = NULL;
 149                 }
 150         }
 151 }
 152
 153 int smsusb_start_streaming(struct smsusb_device_t *dev)
 154 {
 155         int i, rc;
 156
 157         for (i = 0; i < MAX_URBS; i++) {
 158                 rc = smsusb_submit_urb(dev, &dev->surbs[i]);
 159                 if (rc < 0) {
 160                         sms_info("smsusb_submit_urb(...) "
 161                                  "failed");
 162                         smsusb_stop_streaming(dev);
 163                         break;
 164                 }
 165         }
 166
 167         return rc;
 168 }
 169
 170 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 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 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_info("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_info("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_info("failed to allocate firmware buffer");
 217                 rc = -ENOMEM;
 218         }
 219
 220         release_firmware(fw);
 221
 222         return rc;
 223 }
 224
 225 void smsusb1_detectmode(void *context, int *mode)
 226 {
 227         char *product_string =
 228                 ((struct smsusb_device_t *) context)->udev->product;
 229
 230         *mode = DEVICE_MODE_NONE;
 231
 232         if (!product_string) {
 233                 product_string = "none";
 234                 sms_err("product string not found");
 235         } else if (strstr(product_string, "DVBH"))
 236                 *mode = 1;
 237         else if (strstr(product_string, "BDA"))
 238                 *mode = 4;
 239         else if (strstr(product_string, "DVBT"))
 240                 *mode = 0;
 241         else if (strstr(product_string, "TDMB"))
 242                 *mode = 2;
 243
 244         sms_info("%d \"%s\"", *mode, product_string);
 245 }
 246
 247 int smsusb1_setmode(void *context, int mode)
 248 {
 249         struct SmsMsgHdr_ST Msg = { MSG_SW_RELOAD_REQ, 0, HIF_TASK,
 250                              sizeof(struct SmsMsgHdr_ST), 0 };
 251
 252         if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_DVBT_BDA) {
 253                 sms_info("invalid firmware id specified %d", mode);
 254                 return -EINVAL;
 255         }
 256
 257         return smsusb_sendrequest(context, &Msg, sizeof(Msg));
 258 }
 259
 260 void smsusb_term_device(struct usb_interface *intf)
 261 {
 262         struct smsusb_device_t *dev =
 263                 (struct smsusb_device_t *) usb_get_intfdata(intf);
 264
 265         if (dev) {
 266                 smsusb_stop_streaming(dev);
 267
 268                 /* unregister from smscore */
 269                 if (dev->coredev)
 270                         smscore_unregister_device(dev->coredev);
 271
 272                 kfree(dev);
 273
 274                 sms_info("device %p destroyed", dev);
 275         }
 276
 277         usb_set_intfdata(intf, NULL);
 278 }
 279
 280 int smsusb_init_device(struct usb_interface *intf, int board_id)
 281 {
 282         struct smsdevice_params_t params;
 283         struct smsusb_device_t *dev;
 284         struct sms_board *board;
 285         int i, rc;
 286
 287         /* create device object */
 288         dev = kzalloc(sizeof(struct smsusb_device_t), GFP_KERNEL);
 289         if (!dev) {
 290                 sms_info("kzalloc(sizeof(struct smsusb_device_t) "
 291                          "failed");
 292                 return -ENOMEM;
 293         }
 294
 295         memset(&params, 0, sizeof(params));
 296         usb_set_intfdata(intf, dev);
 297         dev->udev = interface_to_usbdev(intf);
 298
 299         board = sms_get_board(board_id);
 300
 301         switch (board->type) {
 302
 303         case SMS_STELLAR:
 304                 dev->buffer_size = USB1_BUFFER_SIZE;
 305
 306                 params.setmode_handler = smsusb1_setmode;
 307                 params.detectmode_handler = smsusb1_detectmode;
 308                 params.device_type = SMS_STELLAR;
 309                 sms_info("stellar device found");
 310                 break;
 311         default:
 312                 switch (board->type) {
 313                 case SMS_NOVA_A0:
 314                         params.device_type = SMS_NOVA_A0;
 315                         sms_info("nova A0 found");
 316                         break;
 317                 case SMS_NOVA_B0:
 318                         params.device_type = SMS_NOVA_B0;
 319                         sms_info("nova B0 found");
 320                         break;
 321                 case SMS_VEGA:
 322                         params.device_type = SMS_VEGA;
 323                         sms_info("Vega found");
 324                         break;
 325                 default:
 326                         sms_err("Unspecified sms device type!");
 327                 }
 328
 329                 dev->buffer_size = USB2_BUFFER_SIZE;
 330                 dev->response_alignment =
 331                         dev->udev->ep_in[1]->desc.wMaxPacketSize -
 332                         sizeof(struct SmsMsgHdr_ST);
 333
 334                 params.flags |= SMS_DEVICE_FAMILY2;
 335                 break;
 336         }
 337
 338         params.device = &dev->udev->dev;
 339         params.buffer_size = dev->buffer_size;
 340         params.num_buffers = MAX_BUFFERS;
 341         params.sendrequest_handler = smsusb_sendrequest;
 342         params.context = dev;
 343         snprintf(params.devpath, sizeof(params.devpath),
 344                  "usb\\%d-%s", dev->udev->bus->busnum, dev->udev->devpath);
 345
 346         /* register in smscore */
 347         rc = smscore_register_device(&params, &dev->coredev);
 348         if (rc < 0) {
 349                 sms_info("smscore_register_device(...) failed, "
 350                          "rc %d", rc);
 351                 smsusb_term_device(intf);
 352                 return rc;
 353         }
 354
 355         smscore_set_board_id(dev->coredev, board_id);
 356
 357         /* initialize urbs */
 358         for (i = 0; i < MAX_URBS; i++) {
 359                 dev->surbs[i].dev = dev;
 360                 usb_init_urb(&dev->surbs[i].urb);
 361         }
 362
 363         sms_info("smsusb_start_streaming(...).");
 364         rc = smsusb_start_streaming(dev);
 365         if (rc < 0) {
 366                 sms_info("smsusb_start_streaming(...) failed");
 367                 smsusb_term_device(intf);
 368                 return rc;
 369         }
 370
 371         rc = smscore_start_device(dev->coredev);
 372         if (rc < 0) {
 373                 sms_info("smscore_start_device(...) failed");
 374                 smsusb_term_device(intf);
 375                 return rc;
 376         }
 377
 378         sms_info("device %p created", dev);
 379
 380         return rc;
 381 }
 382
 383 int smsusb_probe(struct usb_interface *intf, const struct usb_device_id *id)
 384 {
 385         struct usb_device *udev = interface_to_usbdev(intf);
 386         char devpath[32];
 387         int i, rc;
 388
 389         rc = usb_clear_halt(udev, usb_rcvbulkpipe(udev, 0x81));
 390         rc = usb_clear_halt(udev, usb_rcvbulkpipe(udev, 0x02));
 391
 392         if (intf->num_altsetting > 0) {
 393                 rc = usb_set_interface(
 394                         udev, intf->cur_altsetting->desc.bInterfaceNumber, 0);
 395                 if (rc < 0) {
 396                         sms_info("usb_set_interface failed, "
 397                                  "rc %d", rc);
 398                         return rc;
 399                 }
 400         }
 401
 402         sms_info("smsusb_probe %d",
 403                intf->cur_altsetting->desc.bInterfaceNumber);
 404         for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++)
 405                 sms_info("endpoint %d %02x %02x %d", i,
 406                        intf->cur_altsetting->endpoint[i].desc.bEndpointAddress,
 407                        intf->cur_altsetting->endpoint[i].desc.bmAttributes,
 408                        intf->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
 409
 410         if ((udev->actconfig->desc.bNumInterfaces == 2) &&
 411             (intf->cur_altsetting->desc.bInterfaceNumber == 0)) {
 412                 sms_info("rom interface 0 is not used");
 413                 return -ENODEV;
 414         }
 415
 416         if (intf->cur_altsetting->desc.bInterfaceNumber == 1) {
 417                 snprintf(devpath, sizeof(devpath), "usb\\%d-%s",
 418                          udev->bus->busnum, udev->devpath);
 419                 sms_info("stellar device was found.");
 420                 return smsusb1_load_firmware(
 421                                 udev, smscore_registry_getmode(devpath));
 422         }
 423
 424         rc = smsusb_init_device(intf, id->driver_info);
 425         sms_info("rc %d", rc);
 426         return rc;
 427 }
 428
 429 void smsusb_disconnect(struct usb_interface *intf)
 430 {
 431         smsusb_term_device(intf);
 432 }
 433
 434 static struct usb_driver smsusb_driver = {
 435         .name                   = "smsusb",
 436         .probe                  = smsusb_probe,
 437         .disconnect             = smsusb_disconnect,
 438         .id_table               = smsusb_id_table,
 439 };
 440
 441 int smsusb_register(void)
 442 {
 443         int rc = usb_register(&smsusb_driver);
 444         if (rc)
 445                 sms_info("usb_register failed. Error number %d", rc);
 446
 447         sms_debug("");
 448
 449         return rc;
 450 }
 451
 452 void smsusb_unregister(void)
 453 {
 454         sms_debug("");
 455         /* Regular USB Cleanup */
 456         usb_deregister(&smsusb_driver);
 457 }
 458