linux/drivers/usb/gadget/legacy/nokia.c
<<
>>
Prefs
   1/*
   2 * nokia.c -- Nokia Composite Gadget Driver
   3 *
   4 * Copyright (C) 2008-2010 Nokia Corporation
   5 * Contact: Felipe Balbi <felipe.balbi@nokia.com>
   6 *
   7 * This gadget driver borrows from serial.c which is:
   8 *
   9 * Copyright (C) 2003 Al Borchers (alborchers@steinerpoint.com)
  10 * Copyright (C) 2008 by David Brownell
  11 * Copyright (C) 2008 by Nokia Corporation
  12 *
  13 * This software is distributed under the terms of the GNU General
  14 * Public License ("GPL") as published by the Free Software Foundation,
  15 * version 2 of that License.
  16 */
  17
  18#include <linux/kernel.h>
  19#include <linux/module.h>
  20#include <linux/device.h>
  21
  22#include "u_serial.h"
  23#include "u_ether.h"
  24#include "u_phonet.h"
  25#include "u_ecm.h"
  26#include "f_mass_storage.h"
  27
  28/* Defines */
  29
  30#define NOKIA_VERSION_NUM               0x0211
  31#define NOKIA_LONG_NAME                 "N900 (PC-Suite Mode)"
  32
  33USB_GADGET_COMPOSITE_OPTIONS();
  34
  35USB_ETHERNET_MODULE_PARAMETERS();
  36
  37static struct fsg_module_parameters fsg_mod_data = {
  38        .stall = 0,
  39        .luns = 2,
  40        .removable_count = 2,
  41        .removable = { 1, 1, },
  42};
  43
  44#ifdef CONFIG_USB_GADGET_DEBUG_FILES
  45
  46static unsigned int fsg_num_buffers = CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS;
  47
  48#else
  49
  50/*
  51 * Number of buffers we will use.
  52 * 2 is usually enough for good buffering pipeline
  53 */
  54#define fsg_num_buffers CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS
  55
  56#endif /* CONFIG_USB_DEBUG */
  57
  58FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
  59
  60#define NOKIA_VENDOR_ID                 0x0421  /* Nokia */
  61#define NOKIA_PRODUCT_ID                0x01c8  /* Nokia Gadget */
  62
  63/* string IDs are assigned dynamically */
  64
  65#define STRING_DESCRIPTION_IDX          USB_GADGET_FIRST_AVAIL_IDX
  66
  67static char manufacturer_nokia[] = "Nokia";
  68static const char product_nokia[] = NOKIA_LONG_NAME;
  69static const char description_nokia[] = "PC-Suite Configuration";
  70
  71static struct usb_string strings_dev[] = {
  72        [USB_GADGET_MANUFACTURER_IDX].s = manufacturer_nokia,
  73        [USB_GADGET_PRODUCT_IDX].s = NOKIA_LONG_NAME,
  74        [USB_GADGET_SERIAL_IDX].s = "",
  75        [STRING_DESCRIPTION_IDX].s = description_nokia,
  76        {  } /* end of list */
  77};
  78
  79static struct usb_gadget_strings stringtab_dev = {
  80        .language       = 0x0409,       /* en-us */
  81        .strings        = strings_dev,
  82};
  83
  84static struct usb_gadget_strings *dev_strings[] = {
  85        &stringtab_dev,
  86        NULL,
  87};
  88
  89static struct usb_device_descriptor device_desc = {
  90        .bLength                = USB_DT_DEVICE_SIZE,
  91        .bDescriptorType        = USB_DT_DEVICE,
  92        /* .bcdUSB = DYNAMIC */
  93        .bDeviceClass           = USB_CLASS_COMM,
  94        .idVendor               = cpu_to_le16(NOKIA_VENDOR_ID),
  95        .idProduct              = cpu_to_le16(NOKIA_PRODUCT_ID),
  96        .bcdDevice              = cpu_to_le16(NOKIA_VERSION_NUM),
  97        /* .iManufacturer = DYNAMIC */
  98        /* .iProduct = DYNAMIC */
  99        .bNumConfigurations =   1,
 100};
 101
 102/*-------------------------------------------------------------------------*/
 103
 104/* Module */
 105MODULE_DESCRIPTION("Nokia composite gadget driver for N900");
 106MODULE_AUTHOR("Felipe Balbi");
 107MODULE_LICENSE("GPL");
 108
 109/*-------------------------------------------------------------------------*/
 110static struct usb_function *f_acm_cfg1;
 111static struct usb_function *f_acm_cfg2;
 112static struct usb_function *f_ecm_cfg1;
 113static struct usb_function *f_ecm_cfg2;
 114static struct usb_function *f_obex1_cfg1;
 115static struct usb_function *f_obex2_cfg1;
 116static struct usb_function *f_obex1_cfg2;
 117static struct usb_function *f_obex2_cfg2;
 118static struct usb_function *f_phonet_cfg1;
 119static struct usb_function *f_phonet_cfg2;
 120static struct usb_function *f_msg_cfg1;
 121static struct usb_function *f_msg_cfg2;
 122
 123
 124static struct usb_configuration nokia_config_500ma_driver = {
 125        .label          = "Bus Powered",
 126        .bConfigurationValue = 1,
 127        /* .iConfiguration = DYNAMIC */
 128        .bmAttributes   = USB_CONFIG_ATT_ONE,
 129        .MaxPower       = 500,
 130};
 131
 132static struct usb_configuration nokia_config_100ma_driver = {
 133        .label          = "Self Powered",
 134        .bConfigurationValue = 2,
 135        /* .iConfiguration = DYNAMIC */
 136        .bmAttributes   = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
 137        .MaxPower       = 100,
 138};
 139
 140static struct usb_function_instance *fi_acm;
 141static struct usb_function_instance *fi_ecm;
 142static struct usb_function_instance *fi_obex1;
 143static struct usb_function_instance *fi_obex2;
 144static struct usb_function_instance *fi_phonet;
 145static struct usb_function_instance *fi_msg;
 146
 147static int nokia_bind_config(struct usb_configuration *c)
 148{
 149        struct usb_function *f_acm;
 150        struct usb_function *f_phonet = NULL;
 151        struct usb_function *f_obex1 = NULL;
 152        struct usb_function *f_ecm;
 153        struct usb_function *f_obex2 = NULL;
 154        struct usb_function *f_msg;
 155        int status = 0;
 156        int obex1_stat = -1;
 157        int obex2_stat = -1;
 158        int phonet_stat = -1;
 159
 160        if (!IS_ERR(fi_phonet)) {
 161                f_phonet = usb_get_function(fi_phonet);
 162                if (IS_ERR(f_phonet))
 163                        pr_debug("could not get phonet function\n");
 164        }
 165
 166        if (!IS_ERR(fi_obex1)) {
 167                f_obex1 = usb_get_function(fi_obex1);
 168                if (IS_ERR(f_obex1))
 169                        pr_debug("could not get obex function 0\n");
 170        }
 171
 172        if (!IS_ERR(fi_obex2)) {
 173                f_obex2 = usb_get_function(fi_obex2);
 174                if (IS_ERR(f_obex2))
 175                        pr_debug("could not get obex function 1\n");
 176        }
 177
 178        f_acm = usb_get_function(fi_acm);
 179        if (IS_ERR(f_acm)) {
 180                status = PTR_ERR(f_acm);
 181                goto err_get_acm;
 182        }
 183
 184        f_ecm = usb_get_function(fi_ecm);
 185        if (IS_ERR(f_ecm)) {
 186                status = PTR_ERR(f_ecm);
 187                goto err_get_ecm;
 188        }
 189
 190        f_msg = usb_get_function(fi_msg);
 191        if (IS_ERR(f_msg)) {
 192                status = PTR_ERR(f_msg);
 193                goto err_get_msg;
 194        }
 195
 196        if (!IS_ERR_OR_NULL(f_phonet)) {
 197                phonet_stat = usb_add_function(c, f_phonet);
 198                if (phonet_stat)
 199                        pr_debug("could not add phonet function\n");
 200        }
 201
 202        if (!IS_ERR_OR_NULL(f_obex1)) {
 203                obex1_stat = usb_add_function(c, f_obex1);
 204                if (obex1_stat)
 205                        pr_debug("could not add obex function 0\n");
 206        }
 207
 208        if (!IS_ERR_OR_NULL(f_obex2)) {
 209                obex2_stat = usb_add_function(c, f_obex2);
 210                if (obex2_stat)
 211                        pr_debug("could not add obex function 1\n");
 212        }
 213
 214        status = usb_add_function(c, f_acm);
 215        if (status)
 216                goto err_conf;
 217
 218        status = usb_add_function(c, f_ecm);
 219        if (status) {
 220                pr_debug("could not bind ecm config %d\n", status);
 221                goto err_ecm;
 222        }
 223
 224        status = usb_add_function(c, f_msg);
 225        if (status)
 226                goto err_msg;
 227
 228        if (c == &nokia_config_500ma_driver) {
 229                f_acm_cfg1 = f_acm;
 230                f_ecm_cfg1 = f_ecm;
 231                f_phonet_cfg1 = f_phonet;
 232                f_obex1_cfg1 = f_obex1;
 233                f_obex2_cfg1 = f_obex2;
 234                f_msg_cfg1 = f_msg;
 235        } else {
 236                f_acm_cfg2 = f_acm;
 237                f_ecm_cfg2 = f_ecm;
 238                f_phonet_cfg2 = f_phonet;
 239                f_obex1_cfg2 = f_obex1;
 240                f_obex2_cfg2 = f_obex2;
 241                f_msg_cfg2 = f_msg;
 242        }
 243
 244        return status;
 245err_msg:
 246        usb_remove_function(c, f_ecm);
 247err_ecm:
 248        usb_remove_function(c, f_acm);
 249err_conf:
 250        if (!obex2_stat)
 251                usb_remove_function(c, f_obex2);
 252        if (!obex1_stat)
 253                usb_remove_function(c, f_obex1);
 254        if (!phonet_stat)
 255                usb_remove_function(c, f_phonet);
 256        usb_put_function(f_msg);
 257err_get_msg:
 258        usb_put_function(f_ecm);
 259err_get_ecm:
 260        usb_put_function(f_acm);
 261err_get_acm:
 262        if (!IS_ERR_OR_NULL(f_obex2))
 263                usb_put_function(f_obex2);
 264        if (!IS_ERR_OR_NULL(f_obex1))
 265                usb_put_function(f_obex1);
 266        if (!IS_ERR_OR_NULL(f_phonet))
 267                usb_put_function(f_phonet);
 268        return status;
 269}
 270
 271static int nokia_bind(struct usb_composite_dev *cdev)
 272{
 273        struct usb_gadget       *gadget = cdev->gadget;
 274        struct fsg_opts         *fsg_opts;
 275        struct fsg_config       fsg_config;
 276        int                     status;
 277
 278        status = usb_string_ids_tab(cdev, strings_dev);
 279        if (status < 0)
 280                goto err_usb;
 281        device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
 282        device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
 283        status = strings_dev[STRING_DESCRIPTION_IDX].id;
 284        nokia_config_500ma_driver.iConfiguration = status;
 285        nokia_config_100ma_driver.iConfiguration = status;
 286
 287        if (!gadget_is_altset_supported(gadget)) {
 288                status = -ENODEV;
 289                goto err_usb;
 290        }
 291
 292        fi_phonet = usb_get_function_instance("phonet");
 293        if (IS_ERR(fi_phonet))
 294                pr_debug("could not find phonet function\n");
 295
 296        fi_obex1 = usb_get_function_instance("obex");
 297        if (IS_ERR(fi_obex1))
 298                pr_debug("could not find obex function 1\n");
 299
 300        fi_obex2 = usb_get_function_instance("obex");
 301        if (IS_ERR(fi_obex2))
 302                pr_debug("could not find obex function 2\n");
 303
 304        fi_acm = usb_get_function_instance("acm");
 305        if (IS_ERR(fi_acm)) {
 306                status = PTR_ERR(fi_acm);
 307                goto err_obex2_inst;
 308        }
 309
 310        fi_ecm = usb_get_function_instance("ecm");
 311        if (IS_ERR(fi_ecm)) {
 312                status = PTR_ERR(fi_ecm);
 313                goto err_acm_inst;
 314        }
 315
 316        fi_msg = usb_get_function_instance("mass_storage");
 317        if (IS_ERR(fi_msg)) {
 318                status = PTR_ERR(fi_msg);
 319                goto err_ecm_inst;
 320        }
 321
 322        /* set up mass storage function */
 323        fsg_config_from_params(&fsg_config, &fsg_mod_data, fsg_num_buffers);
 324        fsg_config.vendor_name = "Nokia";
 325        fsg_config.product_name = "N900";
 326
 327        fsg_opts = fsg_opts_from_func_inst(fi_msg);
 328        fsg_opts->no_configfs = true;
 329
 330        status = fsg_common_set_num_buffers(fsg_opts->common, fsg_num_buffers);
 331        if (status)
 332                goto err_msg_inst;
 333
 334        status = fsg_common_set_cdev(fsg_opts->common, cdev, fsg_config.can_stall);
 335        if (status)
 336                goto err_msg_buf;
 337
 338        fsg_common_set_sysfs(fsg_opts->common, true);
 339
 340        status = fsg_common_create_luns(fsg_opts->common, &fsg_config);
 341        if (status)
 342                goto err_msg_buf;
 343
 344        fsg_common_set_inquiry_string(fsg_opts->common, fsg_config.vendor_name,
 345                                      fsg_config.product_name);
 346
 347        /* finally register the configuration */
 348        status = usb_add_config(cdev, &nokia_config_500ma_driver,
 349                        nokia_bind_config);
 350        if (status < 0)
 351                goto err_msg_luns;
 352
 353        status = usb_add_config(cdev, &nokia_config_100ma_driver,
 354                        nokia_bind_config);
 355        if (status < 0)
 356                goto err_put_cfg1;
 357
 358        usb_composite_overwrite_options(cdev, &coverwrite);
 359        dev_info(&gadget->dev, "%s\n", NOKIA_LONG_NAME);
 360
 361        return 0;
 362
 363err_put_cfg1:
 364        usb_put_function(f_acm_cfg1);
 365        if (!IS_ERR_OR_NULL(f_obex1_cfg1))
 366                usb_put_function(f_obex1_cfg1);
 367        if (!IS_ERR_OR_NULL(f_obex2_cfg1))
 368                usb_put_function(f_obex2_cfg1);
 369        if (!IS_ERR_OR_NULL(f_phonet_cfg1))
 370                usb_put_function(f_phonet_cfg1);
 371        usb_put_function(f_ecm_cfg1);
 372err_msg_luns:
 373        fsg_common_remove_luns(fsg_opts->common);
 374err_msg_buf:
 375        fsg_common_free_buffers(fsg_opts->common);
 376err_msg_inst:
 377        usb_put_function_instance(fi_msg);
 378err_ecm_inst:
 379        usb_put_function_instance(fi_ecm);
 380err_acm_inst:
 381        usb_put_function_instance(fi_acm);
 382err_obex2_inst:
 383        if (!IS_ERR(fi_obex2))
 384                usb_put_function_instance(fi_obex2);
 385        if (!IS_ERR(fi_obex1))
 386                usb_put_function_instance(fi_obex1);
 387        if (!IS_ERR(fi_phonet))
 388                usb_put_function_instance(fi_phonet);
 389err_usb:
 390        return status;
 391}
 392
 393static int nokia_unbind(struct usb_composite_dev *cdev)
 394{
 395        if (!IS_ERR_OR_NULL(f_obex1_cfg2))
 396                usb_put_function(f_obex1_cfg2);
 397        if (!IS_ERR_OR_NULL(f_obex2_cfg2))
 398                usb_put_function(f_obex2_cfg2);
 399        if (!IS_ERR_OR_NULL(f_obex1_cfg1))
 400                usb_put_function(f_obex1_cfg1);
 401        if (!IS_ERR_OR_NULL(f_obex2_cfg1))
 402                usb_put_function(f_obex2_cfg1);
 403        if (!IS_ERR_OR_NULL(f_phonet_cfg1))
 404                usb_put_function(f_phonet_cfg1);
 405        if (!IS_ERR_OR_NULL(f_phonet_cfg2))
 406                usb_put_function(f_phonet_cfg2);
 407        usb_put_function(f_acm_cfg1);
 408        usb_put_function(f_acm_cfg2);
 409        usb_put_function(f_ecm_cfg1);
 410        usb_put_function(f_ecm_cfg2);
 411        usb_put_function(f_msg_cfg1);
 412        usb_put_function(f_msg_cfg2);
 413
 414        usb_put_function_instance(fi_msg);
 415        usb_put_function_instance(fi_ecm);
 416        if (!IS_ERR(fi_obex2))
 417                usb_put_function_instance(fi_obex2);
 418        if (!IS_ERR(fi_obex1))
 419                usb_put_function_instance(fi_obex1);
 420        if (!IS_ERR(fi_phonet))
 421                usb_put_function_instance(fi_phonet);
 422        usb_put_function_instance(fi_acm);
 423
 424        return 0;
 425}
 426
 427static struct usb_composite_driver nokia_driver = {
 428        .name           = "g_nokia",
 429        .dev            = &device_desc,
 430        .strings        = dev_strings,
 431        .max_speed      = USB_SPEED_HIGH,
 432        .bind           = nokia_bind,
 433        .unbind         = nokia_unbind,
 434};
 435
 436module_usb_composite_driver(nokia_driver);
 437