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
 220         release_firmware(fw);
 221
 222         return rc;
 223 }
 224
 225 static 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 static 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_err("invalid firmware id specified %d", mode);
 254                 return -EINVAL;
 255         }
 256
 257         return smsusb_sendrequest(context, &Msg, sizeof(Msg));
 258 }
 259
 260 static 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 static 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         int i, rc;
 285
 286         /* create device object */
 287         dev = kzalloc(sizeof(struct smsusb_device_t), GFP_KERNEL);
 288         if (!dev) {
 289                 sms_err("kzalloc(sizeof(struct smsusb_device_t) failed");
 290                 return -ENOMEM;
 291         }
 292
 293         memset(&params, 0, sizeof(params));
 294         usb_set_intfdata(intf, dev);
 295         dev->udev = interface_to_usbdev(intf);
 296
 297         params.device_type = sms_get_board(board_id)->type;
 298
 299         switch (params.device_type) {
 300         case SMS_STELLAR:
 301                 dev->buffer_size = USB1_BUFFER_SIZE;
 302
 303                 params.setmode_handler = smsusb1_setmode;
 304                 params.detectmode_handler = smsusb1_detectmode;
 305                 break;
 306         default:
 307                 sms_err("Unspecified sms device type!");
 308                 /* fall-thru */
 309         case SMS_NOVA_A0:
 310         case SMS_NOVA_B0:
 311         case SMS_VEGA:
 312                 dev->buffer_size = USB2_BUFFER_SIZE;
 313                 dev->response_alignment =
 314                         dev->udev->ep_in[1]->desc.wMaxPacketSize -
 315                         sizeof(struct SmsMsgHdr_ST);
 316
 317                 params.flags |= SMS_DEVICE_FAMILY2;
 318                 break;
 319         }
 320
 321         params.device = &dev->udev->dev;
 322         params.buffer_size = dev->buffer_size;
 323         params.num_buffers = MAX_BUFFERS;
 324         params.sendrequest_handler = smsusb_sendrequest;
 325         params.context = dev;
 326         snprintf(params.devpath, sizeof(params.devpath),
 327                  "usb\\%d-%s", dev->udev->bus->busnum, dev->udev->devpath);
 328
 329         /* register in smscore */
 330         rc = smscore_register_device(&params, &dev->coredev);
 331         if (rc < 0) {
 332                 sms_err("smscore_register_device(...) failed, rc %d", rc);
 333                 smsusb_term_device(intf);
 334                 return rc;
 335         }
 336
 337         smscore_set_board_id(dev->coredev, board_id);
 338
 339         /* initialize urbs */
 340         for (i = 0; i < MAX_URBS; i++) {
 341                 dev->surbs[i].dev = dev;
 342                 usb_init_urb(&dev->surbs[i].urb);
 343         }
 344
 345         sms_info("smsusb_start_streaming(...).");
 346         rc = smsusb_start_streaming(dev);
 347         if (rc < 0) {
 348                 sms_err("smsusb_start_streaming(...) failed");
 349                 smsusb_term_device(intf);
 350                 return rc;
 351         }
 352
 353         rc = smscore_start_device(dev->coredev);
 354         if (rc < 0) {
 355                 sms_err("smscore_start_device(...) failed");
 356                 smsusb_term_device(intf);
 357                 return rc;
 358         }
 359
 360         sms_info("device %p created", dev);
 361
 362         return rc;
 363 }
 364
 365 static int smsusb_probe(struct usb_interface *intf,
 366                         const struct usb_device_id *id)
 367 {
 368         struct usb_device *udev = interface_to_usbdev(intf);
 369         char devpath[32];
 370         int i, rc;
 371
 372         rc = usb_clear_halt(udev, usb_rcvbulkpipe(udev, 0x81));
 373         rc = usb_clear_halt(udev, usb_rcvbulkpipe(udev, 0x02));
 374
 375         if (intf->num_altsetting > 0) {
 376                 rc = usb_set_interface(
 377                         udev, intf->cur_altsetting->desc.bInterfaceNumber, 0);
 378                 if (rc < 0) {
 379                         sms_err("usb_set_interface failed, rc %d", rc);
 380                         return rc;
 381                 }
 382         }
 383
 384         sms_info("smsusb_probe %d",
 385                intf->cur_altsetting->desc.bInterfaceNumber);
 386         for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++)
 387                 sms_info("endpoint %d %02x %02x %d", i,
 388                        intf->cur_altsetting->endpoint[i].desc.bEndpointAddress,
 389                        intf->cur_altsetting->endpoint[i].desc.bmAttributes,
 390                        intf->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
 391
 392         if ((udev->actconfig->desc.bNumInterfaces == 2) &&
 393             (intf->cur_altsetting->desc.bInterfaceNumber == 0)) {
 394                 sms_err("rom interface 0 is not used");
 395                 return -ENODEV;
 396         }
 397
 398         if (intf->cur_altsetting->desc.bInterfaceNumber == 1) {
 399                 snprintf(devpath, sizeof(devpath), "usb\\%d-%s",
 400                          udev->bus->busnum, udev->devpath);
 401                 sms_info("stellar device was found.");
 402                 return smsusb1_load_firmware(
 403                                 udev, smscore_registry_getmode(devpath));
 404         }
 405
 406         rc = smsusb_init_device(intf, id->driver_info);
 407         sms_info("rc %d", rc);
 408         return rc;
 409 }
 410
 411 static void smsusb_disconnect(struct usb_interface *intf)
 412 {
 413         smsusb_term_device(intf);
 414 }
 415
 416 static struct usb_driver smsusb_driver = {
 417         .name                   = "smsusb",
 418         .probe                  = smsusb_probe,
 419         .disconnect             = smsusb_disconnect,
 420         .id_table               = smsusb_id_table,
 421 };
 422
 423 int smsusb_register(void)
 424 {
 425         int rc = usb_register(&smsusb_driver);
 426         if (rc)
 427                 sms_err("usb_register failed. Error number %d", rc);
 428
 429         sms_debug("");
 430
 431         return rc;
 432 }
 433
 434 void smsusb_unregister(void)
 435 {
 436         sms_debug("");
 437         /* Regular USB Cleanup */
 438         usb_deregister(&smsusb_driver);
 439 }
 440