2010-06-02 12:47:21

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 00/11] USB improvements and cleanpus, g_multi install mode

Hello again,

It's me again with a bunch of patches but this time I bring some new
functionality! Install mode! If you are interested only in this jump
near the end of the mail.


The first 7 patches are what I've posted previously. I'm resending it
again since those are required for later patches plus there were some
minor fixes. The patches are:

USB: gadget: g_mass_storage: static data instead of dynamic
allocation

A micro optimisation preventing a kmalloc call() which would
otherwise be always called at the very beginning for the same area
size.

This was submitted previously but Greg did not included it in his
quilt tree (unless I overlooked something) so I'll posting it
again for completeness. Sorry if that creates confusion.

In my opinion this is worth including as it simplifies the code
a bit and removes the call to kmalloc/kfree (hidden in
fsg_common_init) which in my opinion is a good thing as well.

USB: gadget: f_mass_storage: fsg_add() renamed to fsg_bind_config()
USB: gadget: f_fs: functionfs_add() renamed to
functionfs_bind_config()

All other USB composite functions use foo_bind_config() to add
function to USB configuration so changed the names for mass
storage and FunctionFS as well.

The inconstancy apparent in multifunction gadgets stroke me for
quite some time now. I was always reluctant to submit patch
thinking that it would be just stupid name change but finally
couldn't stand it. ;)

In case of mass storage the old (fsg_add()) function is still
available but marked deprecated. In case of FFS the old
(functionfs_add()) function has been removed.

USB: gadget: composite: usb_string_ids_*() functions added
USB: gadget: f_fs: use usb_string_ids_n()

usb_string_ids_n() and usb_string_ids_tab() functions added for batch
sting IDs requests.

This simplifies the code where one would call usb_string_id()
several times and each time has to check for error codes. With
usb_string_ids_n() one can get a whole bunch of IDs with one call
and with usb_string_ids_tab() fill an array full of usb_string
structures.

USB: gadget: g_multi: code clean up and refactoring
USB: gadget: g_multi: added documentation and INF files

g_multi clean up, fixes, etc. Also a bit of documentation for
g_multi and an INF file tested with Windows XP SP3. Hopefully,
someone will find it useful.


Then, there is this patch David didn't seem impressed with:

USB: gadget: g_multi: more configurable

Adds a Kconfig option for each function provided by the g_multi.
This may look like making g_multi complex but I see it more as
creating an gadget that can be used to test various functionality
as well as show that adding new functions is not so hard even in
a complex gadget since the code adds a clear separation of each
function so that one may easily see which parts are for each
function.


And, finally 3 new patches with the advertised install mode
functionality:

USB: gadget: composite: addad disconnect callback

Adds an disconnect callback to the composite framework which is
called whenever composite receives disconnect from the hardware
driver.

USB: gadget: f_mass_storage: added eject callback

Adds a pre- and post-eject callbacks. The first may prevent
eject from really happen even though no error is reported to the
host so host things it succeeded. The second is called after the
file is closed so one may use it for some funky stuff which is
otherwise impossible while mass storage function holds the file or
mounting another file.

USB: gadget: g_multi: Install Mode added

This adds the install mode to the g_multi. Not to repeat myself,
quote from documentation:

* Install mode

The install mode makes the gadget appear as a plain mass storage
device the first time it is connected (and after each
disconnect). This lets one develop an "autorun" CD-ROM image
with drivers and put it as the first logical unit.

** Workings of the install mode

As you may know, mass storage gadget may provide several logical
units and its easier to think of them as separate drives. When
install mode is enabled, g_multi forces the first logical unit
to be a read-only CD-ROM. When install mode is enabled but mass
storage itself is not then exactly one logical unit is set.

When an eject request is made on that logical unit, the file is
not really closed but the gadget switches it's mode to the full
flagged gadget with all the other functions. If mass storage is
among them, the firs logical unit will be the CD-ROM image with
drivers (which may be seen as a bad thing).

When gadget is disconnected and connected afterwards it will
work again in install mode. Some heuristics are used here -- if
disconnection (or suspend) happens no longer then 10 seconds
after last eject on the first logical unit then on next
enumeration gadget will claim to be full flagged otherwise it'll
stick to install mode.

** Interoperability with host

As said, the idea behind install mode is that hosts that require
drivers will be able to get them without the need for additional
CD-ROM or another medium provided with the device.

CD-ROM image should provide an "autorun" functionality witch
will install drivers and eject the emulated CD-ROM to switch
gadget into the other mode which will be handled by newly
installed drivers. If drivers are installed already, they
should "catch" the install mode device by product and vendor IDs
and issue an eject.

This mode is not very Linux-friendly though since Linux and
Linux based systems have no notion of autorun (which from
security point of view is a good thing) and there's no way of
adding some file on the image which will make gadget eject the
device.

Fortunately, there's USB_ModeSwitch and/or udev which should
handle it just fine. A single rule need to be added and
everything should work fine.

Documentation/usb/gadget_multi.txt | 221 +++++++++
Documentation/usb/gadget_multi_rndis.inf | 200 ++++++++
Documentation/usb/gadget_multi_serial.inf | 44 ++
drivers/usb/gadget/Kconfig | 88 +++-
drivers/usb/gadget/composite.c | 73 +++-
drivers/usb/gadget/f_fs.c | 36 +-
drivers/usb/gadget/f_mass_storage.c | 122 +++--
drivers/usb/gadget/g_ffs.c | 2 +-
drivers/usb/gadget/mass_storage.c | 17 +-
drivers/usb/gadget/multi.c | 744 ++++++++++++++++++++++-------
include/linux/usb/composite.h | 6 +
include/linux/usb/functionfs.h | 6 +-
12 files changed, 1278 insertions(+), 281 deletions(-)
create mode 100644 Documentation/usb/gadget_multi.txt
create mode 100644 Documentation/usb/gadget_multi_rndis.inf
create mode 100644 Documentation/usb/gadget_multi_serial.inf

--
Best regards, _ _
| Humble Liege of Serenely Enlightened Majesty of o' \,=./ `o
| Computer Science, Michał "mina86" Nazarewicz (o o)
+----[mina86*mina86.com]---[mina86*jabber.org]----ooO--(_)--Ooo--


2010-06-02 12:45:00

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 01/11] USB: gadget: g_mass_storage: static data instead of dynamic allocation

This patch changes msg_do_config() function so that it uses
a static object for a fsg_common structure instead of dynamically
allocated. This is a micro-optimisation.

Signed-off-by: Michal Nazarewicz <[email protected]>
Signed-off-by: Kyungmin Park <[email protected]>
---
drivers/usb/gadget/mass_storage.c | 13 +++++++------
1 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/drivers/usb/gadget/mass_storage.c b/drivers/usb/gadget/mass_storage.c
index 705cc1f..a3349f2 100644
--- a/drivers/usb/gadget/mass_storage.c
+++ b/drivers/usb/gadget/mass_storage.c
@@ -143,7 +143,7 @@ static int msg_thread_exits(struct fsg_common *common)

static int __init msg_do_config(struct usb_configuration *c)
{
- struct fsg_common *common;
+ static struct fsg_common common, *retp;
struct fsg_config config;
int ret;

@@ -154,12 +154,13 @@ static int __init msg_do_config(struct usb_configuration *c)

fsg_config_from_params(&config, &mod_data);
config.thread_exits = msg_thread_exits;
- common = fsg_common_init(0, c->cdev, &config);
- if (IS_ERR(common))
- return PTR_ERR(common);

- ret = fsg_add(c->cdev, c, common);
- fsg_common_put(common);
+ retp = fsg_common_init(&common, c->cdev, &config);
+ if (IS_ERR(retp))
+ return PTR_ERR(retp);
+
+ ret = fsg_add(c->cdev, c, &common);
+ fsg_common_put(&common);
return ret;
}

--
1.7.1

2010-06-02 12:45:16

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 10/11] USB: gadget: f_mass_storage: added eject callback

Added pre_eject() and post_eject() callbacks which are
called befor and after removable logical unit is ejected.
The first can prevent logical unit from being ejected.

This commit also changes the way callbacks are passed to
the function from gadget. A fsg_operations structure has
been created which lists all callbacks -- this is passed
to the fsg_config.

This is important because it changes the way thread_exits()
callback is passed.

Signed-off-by: Michal Nazarewicz <[email protected]>
Signed-off-by: Kyungmin Park <[email protected]>
---
drivers/usb/gadget/f_mass_storage.c | 109 ++++++++++++++++++++++------------
drivers/usb/gadget/mass_storage.c | 4 +-
2 files changed, 73 insertions(+), 40 deletions(-)

diff --git a/drivers/usb/gadget/f_mass_storage.c b/drivers/usb/gadget/f_mass_storage.c
index 072cbf9..e9e45ba 100644
--- a/drivers/usb/gadget/f_mass_storage.c
+++ b/drivers/usb/gadget/f_mass_storage.c
@@ -316,6 +316,27 @@ static const char fsg_string_interface[] = "Mass Storage";
/*-------------------------------------------------------------------------*/

struct fsg_dev;
+struct fsg_common;
+
+/* FSF callback functions */
+struct fsg_operations {
+ /* Callback function to call when thread exits. If no
+ * callback is set or it returns value lower then zero MSF
+ * will force eject all LUNs it operates on (including those
+ * marked as non-removable or with prevent_medium_removal flag
+ * set). */
+ int (*thread_exits)(struct fsg_common *common);
+
+ /* Called prior to ejection. Negative return means error,
+ * zero means to continue with ejection, positive means not to
+ * eject. */
+ int (*pre_eject)(struct fsg_common *common,
+ struct fsg_lun *lun, int num);
+ /* Called after ejection. Negative return means error, zero
+ * or positive is just a success. */
+ int (*post_eject)(struct fsg_common *common,
+ struct fsg_lun *lun, int num);
+};


/* Data shared by all the FSG instances. */
@@ -370,8 +391,8 @@ struct fsg_common {
struct completion thread_notifier;
struct task_struct *thread_task;

- /* Callback function to call when thread exits. */
- int (*thread_exits)(struct fsg_common *common);
+ /* Callback functions. */
+ const struct fsg_operations *ops;
/* Gadget's private data. */
void *private_data;

@@ -395,12 +416,8 @@ struct fsg_config {
const char *lun_name_format;
const char *thread_name;

- /* Callback function to call when thread exits. If no
- * callback is set or it returns value lower then zero MSF
- * will force eject all LUNs it operates on (including those
- * marked as non-removable or with prevent_medium_removal flag
- * set). */
- int (*thread_exits)(struct fsg_common *common);
+ /* Callback functions. */
+ const struct fsg_operations *ops;
/* Gadget's private data. */
void *private_data;

@@ -436,6 +453,7 @@ static inline int __fsg_is_set(struct fsg_common *common,
if (common->fsg)
return 1;
ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
+ WARN_ON(1);
return 0;
}

@@ -1396,43 +1414,55 @@ static int do_start_stop(struct fsg_common *common)
} else if (!curlun->removable) {
curlun->sense_data = SS_INVALID_COMMAND;
return -EINVAL;
- }
-
- loej = common->cmnd[4] & 0x02;
- start = common->cmnd[4] & 0x01;
-
- /* eject code from file_storage.c:do_start_stop() */
-
- if ((common->cmnd[1] & ~0x01) != 0 || /* Mask away Immed */
- (common->cmnd[4] & ~0x03) != 0) { /* Mask LoEj, Start */
+ } else if ((common->cmnd[1] & ~0x01) != 0 || /* Mask away Immed */
+ (common->cmnd[4] & ~0x03) != 0) { /* Mask LoEj, Start */
curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
return -EINVAL;
}

- if (!start) {
- /* Are we allowed to unload the media? */
- if (curlun->prevent_medium_removal) {
- LDBG(curlun, "unload attempt prevented\n");
- curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
- return -EINVAL;
- }
- if (loej) { /* Simulate an unload/eject */
- up_read(&common->filesem);
- down_write(&common->filesem);
- fsg_lun_close(curlun);
- up_write(&common->filesem);
- down_read(&common->filesem);
- }
- } else {
+ loej = common->cmnd[4] & 0x02;
+ start = common->cmnd[4] & 0x01;

- /* Our emulation doesn't support mounting; the medium is
- * available for use as soon as it is loaded. */
+ /* Our emulation doesn't support mounting; the medium is
+ * available for use as soon as it is loaded. */
+ if (start) {
if (!fsg_lun_is_open(curlun)) {
curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
return -EINVAL;
}
+ return 0;
}
- return 0;
+
+ /* Are we allowed to unload the media? */
+ if (curlun->prevent_medium_removal) {
+ LDBG(curlun, "unload attempt prevented\n");
+ curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
+ return -EINVAL;
+ }
+
+ if (!loej)
+ return 0;
+
+ /* Simulate an unload/eject */
+ if (common->ops && common->ops->pre_eject) {
+ int r = common->ops->pre_eject(common, curlun,
+ curlun - common->luns);
+ if (unlikely(r < 0))
+ return r;
+ else if (r)
+ return 0;
+ }
+
+ up_read(&common->filesem);
+ down_write(&common->filesem);
+ fsg_lun_close(curlun);
+ up_write(&common->filesem);
+ down_read(&common->filesem);
+
+ return common->ops && common->ops->post_eject
+ ? min(0, common->ops->post_eject(common, curlun,
+ curlun - common->luns))
+ : 0;
}


@@ -2657,7 +2687,8 @@ static int fsg_main_thread(void *common_)
common->thread_task = NULL;
spin_unlock_irq(&common->lock);

- if (!common->thread_exits || common->thread_exits(common) < 0) {
+ if (!common->ops || !common->ops->thread_exits
+ || common->ops->thread_exits(common) < 0) {
struct fsg_lun *curlun = common->luns;
unsigned i = common->nluns;

@@ -2733,6 +2764,7 @@ static struct fsg_common *fsg_common_init(struct fsg_common *common,
common->free_storage_on_release = 0;
}

+ common->ops = cfg->ops;
common->private_data = cfg->private_data;

common->gadget = gadget;
@@ -2854,7 +2886,6 @@ buffhds_first_it:


/* Tell the thread to start working */
- common->thread_exits = cfg->thread_exits;
common->thread_task =
kthread_create(fsg_main_thread, common,
OR(cfg->thread_name, "file-storage"));
@@ -3151,8 +3182,8 @@ fsg_config_from_params(struct fsg_config *cfg,
cfg->product_name = 0;
cfg->release = 0xffff;

- cfg->thread_exits = 0;
- cfg->private_data = 0;
+ cfg->ops = NULL;
+ cfg->private_data = NULL;

/* Finalise */
cfg->can_stall = params->stall;
diff --git a/drivers/usb/gadget/mass_storage.c b/drivers/usb/gadget/mass_storage.c
index d6975f4..cd94703 100644
--- a/drivers/usb/gadget/mass_storage.c
+++ b/drivers/usb/gadget/mass_storage.c
@@ -153,7 +153,9 @@ static int __init msg_do_config(struct usb_configuration *c)
}

fsg_config_from_params(&config, &mod_data);
- config.thread_exits = msg_thread_exits;
+ config.ops = &(const struct fsg_operations){
+ .thread_exits = msg_thread_exits,
+ };

retp = fsg_common_init(&common, c->cdev, &config);
if (IS_ERR(retp))
--
1.7.1

2010-06-02 12:45:14

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 09/11] USB: gadget: composite: addad disconnect callback

Added a disconnect() callback to compasite devices which
is called by composite glue when its disconnect callback
is called by gadget.

Signed-off-by: Michal Nazarewicz <[email protected]>
Signed-off-by: Kyungmin Park <[email protected]>
---
drivers/usb/gadget/composite.c | 2 ++
include/linux/usb/composite.h | 2 ++
2 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/drivers/usb/gadget/composite.c b/drivers/usb/gadget/composite.c
index 125167e..e483f80 100644
--- a/drivers/usb/gadget/composite.c
+++ b/drivers/usb/gadget/composite.c
@@ -956,6 +956,8 @@ static void composite_disconnect(struct usb_gadget *gadget)
spin_lock_irqsave(&cdev->lock, flags);
if (cdev->config)
reset_config(cdev);
+ if (composite->disconnect)
+ composite->disconnect(cdev);
spin_unlock_irqrestore(&cdev->lock, flags);
}

diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h
index f378075..890bc14 100644
--- a/include/linux/usb/composite.h
+++ b/include/linux/usb/composite.h
@@ -276,6 +276,8 @@ struct usb_composite_driver {
int (*bind)(struct usb_composite_dev *);
int (*unbind)(struct usb_composite_dev *);

+ void (*disconnect)(struct usb_composite_dev *);
+
/* global suspend hooks */
void (*suspend)(struct usb_composite_dev *);
void (*resume)(struct usb_composite_dev *);
--
1.7.1

2010-06-02 12:45:09

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 07/11] USB: gadget: g_multi: added documentation and INF files

A short documentation of the g_multi driver along with INF
files for Windows XP SP3 are provided.

Signed-off-by: Michal Nazarewicz <[email protected]>
Signed-off-by: Kyungmin Park <[email protected]>
---
Documentation/usb/gadget_multi.txt | 159 +++++++++++++++++++++++
Documentation/usb/gadget_multi_rndis.inf | 200 +++++++++++++++++++++++++++++
Documentation/usb/gadget_multi_serial.inf | 44 +++++++
3 files changed, 403 insertions(+), 0 deletions(-)
create mode 100644 Documentation/usb/gadget_multi.txt
create mode 100644 Documentation/usb/gadget_multi_rndis.inf
create mode 100644 Documentation/usb/gadget_multi_serial.inf

diff --git a/Documentation/usb/gadget_multi.txt b/Documentation/usb/gadget_multi.txt
new file mode 100644
index 0000000..bd53a9f
--- /dev/null
+++ b/Documentation/usb/gadget_multi.txt
@@ -0,0 +1,159 @@
+ -*- org -*-
+
+* Overview
+
+The Multifunction Composite Gadget (or g_multi) is a composite gadget
+that makes extensive use of the composite framework to provide
+a... multifunction gadget.
+
+In it's standard configuration it provides a single USB configuration
+with RNDIS[1] (that is Ethernet), USB CDC[2] ACM (that is serial) and
+USB Mass Storage functions.
+
+A CDC ECM (Ethernet) function may be turned on via a Kconfig option
+and RNDIS can be turned off. If they are both enabled the gadget will
+have two configurations -- one with RNDIS and another with CDC ECM[3].
+
+Please not that if you use non-standard configuration (that is enable
+CDC ECM) you may need to change vendor and/or product ID.
+
+* Host drivers
+
+To make use of the gadget one needs to make it work on host side --
+without that there's no hope of achieving anything with the gadget.
+As one might expect, things one need to do very from system to system.
+
+** Linux host drivers
+
+Since the gadget uses standard composite framework and appears as such
+to Linux host it does not need any additional drivers on Linux host
+side. All the functions are handled by respective drivers developed
+for them.
+
+This is also true for two configuration set-up with RNDIS
+configuration being the first one. Linux host will use the second
+configuration with CDC ECM which should work better under Linux.
+
+** Windows host drivers
+
+For the gadget two work under Windown two conditions have to be met:
+
+*** Detecting as composite gadget
+
+First of all, Windows need to detect the gadget as an USB composite
+gadget which on its own have some conditions[4]. If they are met,
+Windows lets USB Generic Parent Driver[5] handle the device which then
+tries to much drivers for each individual interface (sort of, don't
+get into too many details).
+
+The good news is, you do not have to worry about most of conditions!
+
+The only thing to worry is that the gadget has to have a single
+configuration so a dual RNDIS and CDC ECM gadget won't work unless you
+create a proper INF -- and of course, if you do submit it!
+
+*** Attaching drivers for each function
+
+The other, trickier thing is making Windows attach drivers to each
+individual function.
+
+For mass storage it is trivial since Windows detect it's an interface
+implementing USB Mass Storage class and selects appropriate driver.
+
+Things are harder with RDNIS and CDC ACM.
+
+**** RNDIS
+
+To make Windows select RNDIS drivers for the first function in the
+gadget, one needs to use the [[file:gadget_multi_rndis.inf]] file
+provided with this document. It "attaches" Window's RNDIS driver to
+the first interface of the gadget.
+
+Please note, that while testing we encountered some issues[6] when
+RNDIS was not the first interface. You do not need to worry abut it
+unless you are trying to develop your own gadget in which case watch
+out for this bug.
+
+**** CDC ACM
+
+Similarly, [[file:gadget_multi_serial.inf]] is provided for CDC ACM.
+Note, however that it also requires an usbser.sys file which can be
+extracted form Windows XP SP3 cab files.
+
+There is another usbser.sys file floating around the Internet but as
+we were testing the gadget it failed to work. It is very likely that
+one needs usbser.sys in version intended for one's version of Windows.
+
+We do net claim to be experts as far as INF files are considered so we
+think that there should be a better way of defining files in the
+[[file:gadget_multi_serial.inf]] so that it will work regardless of SP
+version installed. Again, if you happen to hack a better INF do not
+hesitate submitting it!
+
+**** Customising the gadget
+
+If you intend to hack the g_multi gadget be advised that rearranging
+functions will obviously change interface numbers for each of the
+functionality. As an effect provided INFs won't work since they have
+interface numbers hard-coded in them (it's not hard to change those
+though).
+
+This also means, that after experimenting with g_multi and changing
+provided functions one should change gadget's vendor and/or product ID
+so there will be no collision with other customised gadgets or the
+original gadget.
+
+Failing to comply may cause brain damage after wondering for hours why
+things don't work as intended before realising Windows have cached
+some drivers information (changing USB port may sometimes help).
+
+**** Improvements in INF files
+
+It needs to be noted that we are not Windows driver experts and as
+such we do not claim that provided INF files are flawless or that they
+will work on each and every Windows versions (they were tested on
+Windows XP SP3 only).
+
+The bottom line is, if you can improve the INF files, please do and
+share the results[7]. :)
+
+** Other systems
+
+At this moment, drivers for any other systems have not been tested.
+Knowing how MacOS is based on BSD and BSD is an Open Source it is
+believed that it should (read: "I have no idea whether it will") work
+out-of-the-box.
+
+For more exotic systems I have even less to say...
+
+Any testing and drivers *are* *welcome*!
+
+* Authors
+
+This document has been written by Michal Nazarewicz
+([[mailto:[email protected]]]) and the INF files have been hacked by
+Marek Szyprowski ([[mailto:[email protected]]]) basing on the
+[[file:linux.inf]] file provided for Ethernet gadget and description
+from [[file:gadget_serial.txt]].
+
+* Footnotes
+
+[1] Remote Network Driver Interface Specification,
+[[http://msdn.microsoft.com/en-us/library/ee484414.aspx]].
+
+[2] Communications Device Class Abstract Control Model, spec for this
+and other USB classes can be found at
+[[http://www.usb.org/developers/devclass_docs/]].
+
+[3] CDC Ethernet Control Model.
+
+[4] [[http://msdn.microsoft.com/en-us/library/ff537109(v=VS.85).aspx]].
+
+[5] [[http://msdn.microsoft.com/en-us/library/ff539234(v=VS.85).aspx]].
+
+[6] To put it in some other nice words, Windows failed to respond to
+any user input.
+
+[7] Possibility to say `git rev-list --author='Your Name'
+linus/master|wc -l` returns non-zero -- priceless. :]
+
diff --git a/Documentation/usb/gadget_multi_rndis.inf b/Documentation/usb/gadget_multi_rndis.inf
new file mode 100644
index 0000000..2222fd0
--- /dev/null
+++ b/Documentation/usb/gadget_multi_rndis.inf
@@ -0,0 +1,200 @@
+; MS-Windows driver config matching some basic modes of the
+; Linux-USB Ethernet/RNDIS gadget firmware:
+;
+; - RNDIS plus CDC Ethernet ... this may be familiar as a DOCSIS
+; cable modem profile, and supports most non-Microsoft USB hosts
+;
+; - RNDIS plus CDC Subset ... used by hardware that incapable of
+; full CDC Ethernet support.
+;
+; Microsoft only directly supports RNDIS drivers, and bundled them into XP.
+; The Microsoft "Remote NDIS USB Driver Kit" is currently found at:
+; http://www.microsoft.com/whdc/hwdev/resources/HWservices/rndis.mspx
+
+
+[Version]
+Signature = "$CHICAGO$"
+Class = Net
+ClassGUID = {4d36e972-e325-11ce-bfc1-08002be10318}
+Provider = %Linux%
+Compatible = 1
+MillenniumPreferred = .ME
+DriverVer = 03/30/2004,0.0.0.0
+; catalog file would be used by WHQL
+;CatalogFile = Linux.cat
+
+[Manufacturer]
+%Linux% = LinuxDevices,NT.5.1
+
+[LinuxDevices]
+; NetChip IDs, used by both firmware modes
+%LinuxDevice% = RNDIS, USB\VID_0525&PID_a4ab&MI_00
+
+[LinuxDevices.NT.5.1]
+%LinuxDevice% = RNDIS.NT.5.1, USB\VID_0525&PID_a4ab&MI_00
+
+[ControlFlags]
+ExcludeFromSelect=*
+
+; Windows 98, Windows 98 Second Edition specific sections --------
+
+[RNDIS]
+DeviceID = usb8023
+MaxInstance = 512
+DriverVer = 03/30/2004,0.0.0.0
+AddReg = RNDIS_AddReg_98, RNDIS_AddReg_Common
+
+[RNDIS_AddReg_98]
+HKR, , DevLoader, 0, *ndis
+HKR, , DeviceVxDs, 0, usb8023.sys
+HKR, NDIS, LogDriverName, 0, "usb8023"
+HKR, NDIS, MajorNdisVersion, 1, 5
+HKR, NDIS, MinorNdisVersion, 1, 0
+HKR, Ndi\Interfaces, DefUpper, 0, "ndis3,ndis4,ndis5"
+HKR, Ndi\Interfaces, DefLower, 0, "ethernet"
+HKR, Ndi\Interfaces, UpperRange, 0, "ndis3,ndis4,ndis5"
+HKR, Ndi\Interfaces, LowerRange, 0, "ethernet"
+HKR, Ndi\Install, ndis3, 0, "RNDIS_Install_98"
+HKR, Ndi\Install, ndis4, 0, "RNDIS_Install_98"
+HKR, Ndi\Install, ndis5, 0, "RNDIS_Install_98"
+HKR, Ndi, DeviceId, 0, "USB\VID_0525&PID_a4ab&MI_00"
+
+[RNDIS_Install_98]
+CopyFiles=RNDIS_CopyFiles_98
+
+[RNDIS_CopyFiles_98]
+usb8023.sys, usb8023w.sys, , 0
+rndismp.sys, rndismpw.sys, , 0
+
+; Windows Millennium Edition specific sections --------------------
+
+[RNDIS.ME]
+DeviceID = usb8023
+MaxInstance = 512
+DriverVer = 03/30/2004,0.0.0.0
+AddReg = RNDIS_AddReg_ME, RNDIS_AddReg_Common
+Characteristics = 0x84 ; NCF_PHYSICAL + NCF_HAS_UI
+BusType = 15
+
+[RNDIS_AddReg_ME]
+HKR, , DevLoader, 0, *ndis
+HKR, , DeviceVxDs, 0, usb8023.sys
+HKR, NDIS, LogDriverName, 0, "usb8023"
+HKR, NDIS, MajorNdisVersion, 1, 5
+HKR, NDIS, MinorNdisVersion, 1, 0
+HKR, Ndi\Interfaces, DefUpper, 0, "ndis3,ndis4,ndis5"
+HKR, Ndi\Interfaces, DefLower, 0, "ethernet"
+HKR, Ndi\Interfaces, UpperRange, 0, "ndis3,ndis4,ndis5"
+HKR, Ndi\Interfaces, LowerRange, 0, "ethernet"
+HKR, Ndi\Install, ndis3, 0, "RNDIS_Install_ME"
+HKR, Ndi\Install, ndis4, 0, "RNDIS_Install_ME"
+HKR, Ndi\Install, ndis5, 0, "RNDIS_Install_ME"
+HKR, Ndi, DeviceId, 0, "USB\VID_0525&PID_a4ab&MI_00"
+
+[RNDIS_Install_ME]
+CopyFiles=RNDIS_CopyFiles_ME
+
+[RNDIS_CopyFiles_ME]
+usb8023.sys, usb8023m.sys, , 0
+rndismp.sys, rndismpm.sys, , 0
+
+; Windows 2000 specific sections ---------------------------------
+
+[RNDIS.NT]
+Characteristics = 0x84 ; NCF_PHYSICAL + NCF_HAS_UI
+BusType = 15
+DriverVer = 03/30/2004,0.0.0.0
+AddReg = RNDIS_AddReg_NT, RNDIS_AddReg_Common
+CopyFiles = RNDIS_CopyFiles_NT
+
+[RNDIS.NT.Services]
+AddService = USB_RNDIS, 2, RNDIS_ServiceInst_NT, RNDIS_EventLog
+
+[RNDIS_CopyFiles_NT]
+; no rename of files on Windows 2000, use the 'k' names as is
+usb8023k.sys, , , 0
+rndismpk.sys, , , 0
+
+[RNDIS_ServiceInst_NT]
+DisplayName = %ServiceDisplayName%
+ServiceType = 1
+StartType = 3
+ErrorControl = 1
+ServiceBinary = %12%\usb8023k.sys
+LoadOrderGroup = NDIS
+AddReg = RNDIS_WMI_AddReg_NT
+
+[RNDIS_WMI_AddReg_NT]
+HKR, , MofImagePath, 0x00020000, "System32\drivers\rndismpk.sys"
+
+; Windows XP specific sections -----------------------------------
+
+[RNDIS.NT.5.1]
+Characteristics = 0x84 ; NCF_PHYSICAL + NCF_HAS_UI
+BusType = 15
+DriverVer = 03/30/2004,0.0.0.0
+AddReg = RNDIS_AddReg_NT, RNDIS_AddReg_Common
+; no copyfiles - the files are already in place
+
+[RNDIS.NT.5.1.Services]
+AddService = USB_RNDIS, 2, RNDIS_ServiceInst_51, RNDIS_EventLog
+
+[RNDIS_ServiceInst_51]
+DisplayName = %ServiceDisplayName%
+ServiceType = 1
+StartType = 3
+ErrorControl = 1
+ServiceBinary = %12%\usb8023.sys
+LoadOrderGroup = NDIS
+AddReg = RNDIS_WMI_AddReg_51
+
+[RNDIS_WMI_AddReg_51]
+HKR, , MofImagePath, 0x00020000, "System32\drivers\rndismp.sys"
+
+; Windows 2000 and Windows XP common sections --------------------
+
+[RNDIS_AddReg_NT]
+HKR, Ndi, Service, 0, "USB_RNDIS"
+HKR, Ndi\Interfaces, UpperRange, 0, "ndis5"
+HKR, Ndi\Interfaces, LowerRange, 0, "ethernet"
+
+[RNDIS_EventLog]
+AddReg = RNDIS_EventLog_AddReg
+
+[RNDIS_EventLog_AddReg]
+HKR, , EventMessageFile, 0x00020000, "%%SystemRoot%%\System32\netevent.dll"
+HKR, , TypesSupported, 0x00010001, 7
+
+; Common Sections -------------------------------------------------
+
+[RNDIS_AddReg_Common]
+HKR, NDI\params\NetworkAddress, ParamDesc, 0, %NetworkAddress%
+HKR, NDI\params\NetworkAddress, type, 0, "edit"
+HKR, NDI\params\NetworkAddress, LimitText, 0, "12"
+HKR, NDI\params\NetworkAddress, UpperCase, 0, "1"
+HKR, NDI\params\NetworkAddress, default, 0, " "
+HKR, NDI\params\NetworkAddress, optional, 0, "1"
+
+[SourceDisksNames]
+1=%SourceDisk%,,1
+
+[SourceDisksFiles]
+usb8023m.sys=1
+rndismpm.sys=1
+usb8023w.sys=1
+rndismpw.sys=1
+usb8023k.sys=1
+rndismpk.sys=1
+
+[DestinationDirs]
+RNDIS_CopyFiles_98 = 10, system32/drivers
+RNDIS_CopyFiles_ME = 10, system32/drivers
+RNDIS_CopyFiles_NT = 12
+
+[Strings]
+ServiceDisplayName = "USB Remote NDIS Network Device Driver"
+NetworkAddress = "Network Address"
+Linux = "Linux Developer Community"
+LinuxDevice = "RNDIS Gadget/Linux Multifunction Gadget"
+SourceDisk = "Linux RNDIS Gadget Driver Install Disk"
+
diff --git a/Documentation/usb/gadget_multi_serial.inf b/Documentation/usb/gadget_multi_serial.inf
new file mode 100644
index 0000000..b04ace1
--- /dev/null
+++ b/Documentation/usb/gadget_multi_serial.inf
@@ -0,0 +1,44 @@
+[Version]
+Signature="$Windows NT$"
+Class=Ports
+ClassGuid={4D36E978-E325-11CE-BFC1-08002BE10318}
+Provider=%LINUX%
+DriverVer=08/17/2004,0.0.2.1
+; Copyright (C) 2004 Al Borchers ([email protected])
+
+[Manufacturer]
+%LINUX%=GSerialDeviceList
+
+[GSerialDeviceList]
+%GSERIAL%=GSerialInstall, USB\VID_0525&PID_A4AB&MI_02
+
+[DestinationDirs]
+DefaultDestDir=10,System32\Drivers
+
+[GSerialInstall]
+CopyFiles=GSerialCopyFiles
+AddReg=GSerialAddReg
+
+[GSerialCopyFiles]
+usbser.sys
+
+[GSerialAddReg]
+HKR,,DevLoader,,*ntkern
+HKR,,NTMPDriver,,usbser.sys
+HKR,,EnumPropPages32,,"MsPorts.dll,SerialPortPropPageProvider"
+
+[GSerialInstall.Services]
+AddService = usbser,0x0002,GSerialService
+
+[GSerialService]
+DisplayName = %GSERIAL_DISPLAY_NAME%
+ServiceType = 1 ; SERVICE_KERNEL_DRIVER
+StartType = 3 ; SERVICE_DEMAND_START
+ErrorControl = 1 ; SERVICE_ERROR_NORMAL
+ServiceBinary = %10%\System32\Drivers\usbser.sys
+LoadOrderGroup = Base
+
+[Strings]
+LINUX = "Linux"
+GSERIAL = "Serial Gadget/Linux Multifunction Gadget"
+GSERIAL_DISPLAY_NAME = "Serial Gadget/Linux Multifunction Gadget"
--
1.7.1

2010-06-02 12:45:11

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 05/11] USB: gadget: f_fs: use usb_string_ids_n()

Use usb_string_ids_n() function to simplify string ids
registeration.

Signed-off-by: Michal Nazarewicz <[email protected]>
Signed-off-by: Kyungmin Park <[email protected]>
---
drivers/usb/gadget/f_fs.c | 30 ++++++++++++------------------
1 files changed, 12 insertions(+), 18 deletions(-)

diff --git a/drivers/usb/gadget/f_fs.c b/drivers/usb/gadget/f_fs.c
index 3fe120f..97c2ac2 100644
--- a/drivers/usb/gadget/f_fs.c
+++ b/drivers/usb/gadget/f_fs.c
@@ -1377,7 +1377,8 @@ static void ffs_data_reset(struct ffs_data *ffs)

static int functionfs_bind(struct ffs_data *ffs, struct usb_composite_dev *cdev)
{
- unsigned i, count;
+ struct usb_gadget_strings **lang;
+ int first_id;

ENTER();

@@ -1385,7 +1386,9 @@ static int functionfs_bind(struct ffs_data *ffs, struct usb_composite_dev *cdev)
|| test_and_set_bit(FFS_FL_BOUND, &ffs->flags)))
return -EBADFD;

- ffs_data_get(ffs);
+ first_id = usb_string_ids_n(cdev, ffs->strings_count);
+ if (unlikely(first_id < 0))
+ return first_id;

ffs->ep0req = usb_ep_alloc_request(cdev->gadget->ep0, GFP_KERNEL);
if (unlikely(!ffs->ep0req))
@@ -1393,25 +1396,16 @@ static int functionfs_bind(struct ffs_data *ffs, struct usb_composite_dev *cdev)
ffs->ep0req->complete = ffs_ep0_complete;
ffs->ep0req->context = ffs;

- /* Get strings identifiers */
- for (count = ffs->strings_count, i = 0; i < count; ++i) {
- struct usb_gadget_strings **lang;
-
- int id = usb_string_id(cdev);
- if (unlikely(id < 0)) {
- usb_ep_free_request(cdev->gadget->ep0, ffs->ep0req);
- ffs->ep0req = NULL;
- return id;
- }
-
- lang = ffs->stringtabs;
- do {
- (*lang)->strings[i].id = id;
- ++lang;
- } while (*lang);
+ lang = ffs->stringtabs;
+ for (lang = ffs->stringtabs; *lang; ++lang) {
+ struct usb_string *str = (*lang)->strings;
+ int id = first_id;
+ for (; str->s; ++id, ++str)
+ str->id = id;
}

ffs->gadget = cdev->gadget;
+ ffs_data_get(ffs);
return 0;
}

--
1.7.1

2010-06-02 12:45:06

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 08/11] USB: gadget: g_multi: more configurable

Added Kconfig options for each function used by g_multi so that
one can customize the gadget to a greater extend.

Note that it will be wise to change vendor and product ID when
customising the gadget.

Signed-off-by: Michal Nazarewicz <[email protected]>
Signed-off-by: Kyungmin Park <[email protected]>
---
Documentation/usb/gadget_multi.txt | 27 +++---
drivers/usb/gadget/Kconfig | 67 +++++++++-----
drivers/usb/gadget/multi.c | 166 ++++++++++++++++--------------------
3 files changed, 130 insertions(+), 130 deletions(-)

diff --git a/Documentation/usb/gadget_multi.txt b/Documentation/usb/gadget_multi.txt
index bd53a9f..65bccd8 100644
--- a/Documentation/usb/gadget_multi.txt
+++ b/Documentation/usb/gadget_multi.txt
@@ -2,20 +2,21 @@

* Overview

-The Multifunction Composite Gadget (or g_multi) is a composite gadget
-that makes extensive use of the composite framework to provide
-a... multifunction gadget.
+The Multifunction Composite Gadget (or g_multi) is a customisable
+composite gadget that makes extensive use of the composite framework
+to provide a... multifunction gadget.

In it's standard configuration it provides a single USB configuration
with RNDIS[1] (that is Ethernet), USB CDC[2] ACM (that is serial) and
USB Mass Storage functions.

-A CDC ECM (Ethernet) function may be turned on via a Kconfig option
-and RNDIS can be turned off. If they are both enabled the gadget will
-have two configurations -- one with RNDIS and another with CDC ECM[3].
+Each function can be disabled via a Kconfig option. There's also
+a CDC ECM (Ethernet) function which can be turned on. If CDC ECM and
+RNDIS are enabled the gadget will have two configurations -- one with
+RNDIS and another with CDC ECM[3].

-Please not that if you use non-standard configuration (that is enable
-CDC ECM) you may need to change vendor and/or product ID.
+Please not that if you use non-standard configuration you may need to
+change vendor and/or product ID.

* Host drivers

@@ -92,11 +93,11 @@ hesitate submitting it!

**** Customising the gadget

-If you intend to hack the g_multi gadget be advised that rearranging
-functions will obviously change interface numbers for each of the
-functionality. As an effect provided INFs won't work since they have
-interface numbers hard-coded in them (it's not hard to change those
-though).
+If you intend to customise (via Kconfig) or hack the g_multi gadget be
+advised that rearranging functions will obviously change interface
+numbers for each of the functionality. As an effect provided INFs
+won't work since they have interface numbers hard-coded in them (it's
+not hard to change those though).

This also means, that after experimenting with g_multi and changing
provided functions one should change gadget's vendor and/or product ID
diff --git a/drivers/usb/gadget/Kconfig b/drivers/usb/gadget/Kconfig
index c97f021..8052643 100644
--- a/drivers/usb/gadget/Kconfig
+++ b/drivers/usb/gadget/Kconfig
@@ -861,43 +861,62 @@ config USB_G_NOKIA

config USB_G_MULTI
tristate "Multifunction Composite Gadget (EXPERIMENTAL)"
- depends on BLOCK && NET
- select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
+ select USB_G_MULTI_ACM if !USB_G_MULTI_ANYTHING
help
- The Multifunction Composite Gadget provides Ethernet (RNDIS
- and/or CDC Ethernet), mass storage and ACM serial link
- interfaces.
-
- You will be asked to choose which of the two configurations is
- to be available in the gadget. At least one configuration must
- be chosen to make the gadget usable. Selecting more than one
- configuration will prevent Windows from automatically detecting
- the gadget as a composite gadget, so an INF file will be needed to
- use the gadget.
+ The Multifunction Composite Gadget provides several different
+ configurations and functions. Which interfaces are provided can
+ be configured at build time. If you choose this gadget additional
+ options will appear.

Say "y" to link the driver statically, or "m" to build a
dynamically linked module called "g_multi".

-config USB_G_MULTI_RNDIS
- bool "RNDIS + CDC Serial + Storage configuration"
+config USB_G_MULTI_ANYTHING
+ bool
depends on USB_G_MULTI
+
+config USB_G_MULTI_RNDIS
+ bool "Include RNDIS function"
+ depends on USB_G_MULTI && NET
+ select USB_G_MULTI_ANYTHING
default y
help
- This option enables a configuration with RNDIS, CDC Serial and
- Mass Storage functions available in the Multifunction Composite
- Gadget. This is the configuration dedicated for Windows since RNDIS
- is Microsoft's protocol.
+ This option enables the RNDIS (Ethernet) function. It is
+ protocol dedicated for Windows since it's Microsoft's invention.
+
+ If you select also CDC ECM function gadget will have two
+ configurations one with RNDIS and another with CDC ECM.
+
+ If unsure, say "y".
+
+config USB_G_MULTI_ECM
+ bool "Include CDC ECM function"
+ depends on USB_G_MULTI && NET
+ select USB_G_MULTI_ANYTHING
+ help
+ This option enables the CDC ECM (Ethernet) function.
+
+ If you select also RNDIS function gadget will have two
+ configurations one with RNDIS and another with CDC ECM.

If unsure, say "y".

-config USB_G_MULTI_CDC
- bool "CDC Ethernet + CDC Serial + Storage configuration"
+config USB_G_MULTI_ACM
+ bool "Include CDC ACM function"
depends on USB_G_MULTI
- default n
+ default y
+ help
+ This option enables the CDC ACM (serial) function.
+
+ If unsure, say "y".
+
+config USB_G_MULTI_MSF
+ bool "Include mass storage function"
+ depends on USB_G_MULTI && BLOCK
+ select USB_G_MULTI_ANYTHING
+ default y
help
- This option enables a configuration with CDC Ethernet (ECM), CDC
- Serial and Mass Storage functions available in the Multifunction
- Composite Gadget.
+ This option enables the mass storage (or UMS) function.

If unsure, say "y".

diff --git a/drivers/usb/gadget/multi.c b/drivers/usb/gadget/multi.c
index c7a5b58..6f6fd3e 100644
--- a/drivers/usb/gadget/multi.c
+++ b/drivers/usb/gadget/multi.c
@@ -57,19 +57,57 @@ MODULE_LICENSE("GPL");
#include "config.c"
#include "epautoconf.c"

-#include "f_mass_storage.c"
+/* Mass storage */
+#ifdef CONFIG_USB_G_MULTI_MSF
+# include "f_mass_storage.c"

-#include "u_serial.c"
-#include "f_acm.c"
+static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
+FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
+
+static struct fsg_common fsg_common;
+#else
+# define fsg_common_from_params(common, cdev, data) NULL
+# define fsg_bind_config(cdev, conf, common) ((int)0)
+# define fsg_common_put(common) do { } while (0)
+#endif

-#include "f_ecm.c"
-#include "f_subset.c"
-#ifdef USB_ETH_RNDIS
+/* CDC ACM */
+#ifdef CONFIG_USB_G_MULTI_ACM
+# include "u_serial.c"
+# include "f_acm.c"
+#else
+# define gserial_setup(conf, ports) ((int)0)
+# define gserial_cleanup() do { } while (0)
+# define acm_bind_config(conf, ports) ((int)0)
+#endif
+
+/* Ethernet */
+#ifdef CONFIG_USB_G_MULTI_ECM
+# include "f_ecm.c"
+# include "f_subset.c"
+#endif
+
+#ifdef CONFIG_USB_G_MULTI_RNDIS
# include "f_rndis.c"
# include "rndis.c"
#endif
-#include "u_ether.c"

+#if defined CONFIG_USB_G_MULTI_ECM || defined CONFIG_USB_G_MULTI_RNDIS
+# include "u_ether.c"
+static u8 hostaddr[ETH_ALEN];
+#else
+# define gether_setup(cdev, hostaddr) ((int)0)
+# define gether_cleanup() do { } while (0)
+#endif
+
+#ifndef CONFIG_USB_G_MULTI_ECM
+# define can_support_ecm(gadget) true
+# define ecm_bind_config(conf, ethaddr) ((int)0)
+#endif
+
+#ifndef CONFIG_USB_G_MULTI_RNDIS
+# define rndis_bind_config(conf, ethaddr) ((int)0)
+#endif


/***************************** Device Descriptor ****************************/
@@ -78,19 +116,6 @@ MODULE_LICENSE("GPL");
#define MULTI_PRODUCT_NUM 0xa4ab /* XXX */


-enum {
- __MULTI_NO_CONFIG,
-#ifdef CONFIG_USB_G_MULTI_RNDIS
- MULTI_RNDIS_CONFIG_NUM,
-#endif
-#ifdef CONFIG_USB_G_MULTI_CDC
- MULTI_CDC_CONFIG_NUM,
-#endif
- __MULTI_NUM_CONFIGS_HELPER,
- MULTI_NUM_CONFIGS = __MULTI_NUM_CONFIGS_HELPER - 1
-};
-
-
static struct usb_device_descriptor device_desc = {
.bLength = sizeof device_desc,
.bDescriptorType = USB_DT_DEVICE,
@@ -104,7 +129,11 @@ static struct usb_device_descriptor device_desc = {
/* Vendor and product id can be overridden by module parameters. */
.idVendor = cpu_to_le16(MULTI_VENDOR_NUM),
.idProduct = cpu_to_le16(MULTI_PRODUCT_NUM),
- .bNumConfigurations = MULTI_NUM_CONFIGS,
+#if defined CONFIG_USB_G_MULTI_RNDIS && defined CONFIG_USB_G_MULTI_ECM
+ .bNumConfigurations = 2,
+#else
+ .bNumConfigurations = 1,
+#endif
};


@@ -124,12 +153,6 @@ static const struct usb_descriptor_header *otg_desc[] = {
enum {
MULTI_STRING_MANUFACTURER_IDX,
MULTI_STRING_PRODUCT_IDX,
-#ifdef CONFIG_USB_G_MULTI_RNDIS
- MULTI_STRING_RNDIS_CONFIG_IDX,
-#endif
-#ifdef CONFIG_USB_G_MULTI_CDC
- MULTI_STRING_CDC_CONFIG_IDX,
-#endif
};

static char manufacturer[50];
@@ -137,12 +160,6 @@ static char manufacturer[50];
static struct usb_string strings_dev[] = {
[MULTI_STRING_MANUFACTURER_IDX].s = manufacturer,
[MULTI_STRING_PRODUCT_IDX].s = DRIVER_DESC,
-#ifdef CONFIG_USB_G_MULTI_RNDIS
- [MULTI_STRING_RNDIS_CONFIG_IDX].s = "Multifunction with RNDIS",
-#endif
-#ifdef CONFIG_USB_G_MULTI_CDC
- [MULTI_STRING_CDC_CONFIG_IDX].s = "Multifunction with CDC ECM",
-#endif
{ } /* end of list */
};

@@ -159,19 +176,8 @@ static struct usb_gadget_strings *dev_strings[] = {

/****************************** Configurations ******************************/

-static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
-FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);

-static struct fsg_common fsg_common;
-
-static u8 hostaddr[ETH_ALEN];
-
-
-/********** RNDIS **********/
-
-#ifdef USB_ETH_RNDIS
-
-static __ref int rndis_do_config(struct usb_configuration *c)
+static __ref int first_do_config(struct usb_configuration *c)
{
int ret;

@@ -180,7 +186,11 @@ static __ref int rndis_do_config(struct usb_configuration *c)
c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
}

+#ifdef CONFIG_USB_G_MULTI_RNDIS
ret = rndis_bind_config(c, hostaddr);
+#else
+ ret = ecm_bind_config(c, hostaddr);
+#endif
if (ret < 0)
return ret;

@@ -195,35 +205,17 @@ static __ref int rndis_do_config(struct usb_configuration *c)
return 0;
}

-static int rndis_config_register(struct usb_composite_dev *cdev)
-{
- static struct usb_configuration config = {
- .bind = rndis_do_config,
- .bConfigurationValue = MULTI_RNDIS_CONFIG_NUM,
- .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
- };
-
- config.label = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].s;
- config.iConfiguration = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].id;
-
- return usb_add_config(cdev, &config);
-}
-
-#else
-
-static int rndis_config_register(struct usb_composite_dev *cdev)
-{
- return 0;
-}
-
-#endif
-
+static struct usb_configuration first_config_driver = {
+ .label = "First Configuration",
+ .bind = first_do_config,
+ .bConfigurationValue = 1,
+ .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
+};

-/********** CDC ECM **********/

-#ifdef CONFIG_USB_G_MULTI_CDC
+#if defined CONFIG_USB_G_MULTI_RNDIS && defined CONFIG_USB_G_MULTI_ECM

-static __ref int cdc_do_config(struct usb_configuration *c)
+static __ref int second_do_config(struct usb_configuration *c)
{
int ret;

@@ -247,26 +239,12 @@ static __ref int cdc_do_config(struct usb_configuration *c)
return 0;
}

-static int cdc_config_register(struct usb_composite_dev *cdev)
-{
- static struct usb_configuration config = {
- .bind = cdc_do_config,
- .bConfigurationValue = MULTI_CDC_CONFIG_NUM,
- .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
- };
-
- config.label = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].s;
- config.iConfiguration = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].id;
-
- return usb_add_config(cdev, &config);
-}
-
-#else
-
-static int cdc_config_register(struct usb_composite_dev *cdev)
-{
- return 0;
-}
+static struct usb_configuration second_config_driver = {
+ .label = "Second Configuration",
+ .bind = second_do_config,
+ .bConfigurationValue = 2,
+ .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
+};

#endif

@@ -331,13 +309,15 @@ static int __ref multi_bind(struct usb_composite_dev *cdev)
strings_dev[MULTI_STRING_PRODUCT_IDX].id;

/* register configurations */
- status = rndis_config_register(cdev);
+ status = usb_add_config(cdev, &first_config_driver);
if (unlikely(status < 0))
goto fail2;

- status = cdc_config_register(cdev);
+#if defined CONFIG_USB_G_MULTI_RNDIS && defined CONFIG_USB_G_MULTI_ECM
+ status = usb_add_config(cdev, &second_config_driver);
if (unlikely(status < 0))
goto fail2;
+#endif

/* we're done */
dev_info(&gadget->dev, DRIVER_DESC "\n");
--
1.7.1

2010-06-02 12:44:59

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 02/11] USB: gadget: f_mass_storage: fsg_add() renamed to fsg_bind_config()

Mass Storage Function had a bit unique name for function
used to add it to USB configuration. Renamed as to match
naming convention of other functions.

Signed-off-by: Michal Nazarewicz <[email protected]>
Signed-off-by: Kyungmin Park <[email protected]>
---
drivers/usb/gadget/f_mass_storage.c | 13 ++++++++++---
drivers/usb/gadget/mass_storage.c | 2 +-
drivers/usb/gadget/multi.c | 4 ++--
3 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/drivers/usb/gadget/f_mass_storage.c b/drivers/usb/gadget/f_mass_storage.c
index 7d05a0b..072cbf9 100644
--- a/drivers/usb/gadget/f_mass_storage.c
+++ b/drivers/usb/gadget/f_mass_storage.c
@@ -3023,9 +3023,9 @@ static struct usb_gadget_strings *fsg_strings_array[] = {
NULL,
};

-static int fsg_add(struct usb_composite_dev *cdev,
- struct usb_configuration *c,
- struct fsg_common *common)
+static int fsg_bind_config(struct usb_composite_dev *cdev,
+ struct usb_configuration *c,
+ struct fsg_common *common)
{
struct fsg_dev *fsg;
int rc;
@@ -3072,6 +3072,13 @@ error_free_fsg:
return rc;
}

+static inline int __deprecated __maybe_unused
+fsg_add(struct usb_composite_dev *cdev,
+ struct usb_configuration *c,
+ struct fsg_common *common)
+{
+ return fsg_bind_config(cdev, c, common);
+}


/************************* Module parameters *************************/
diff --git a/drivers/usb/gadget/mass_storage.c b/drivers/usb/gadget/mass_storage.c
index a3349f2..d6975f4 100644
--- a/drivers/usb/gadget/mass_storage.c
+++ b/drivers/usb/gadget/mass_storage.c
@@ -159,7 +159,7 @@ static int __init msg_do_config(struct usb_configuration *c)
if (IS_ERR(retp))
return PTR_ERR(retp);

- ret = fsg_add(c->cdev, c, &common);
+ ret = fsg_bind_config(c->cdev, c, &common);
fsg_common_put(&common);
return ret;
}
diff --git a/drivers/usb/gadget/multi.c b/drivers/usb/gadget/multi.c
index a930d7f..d3d3140 100644
--- a/drivers/usb/gadget/multi.c
+++ b/drivers/usb/gadget/multi.c
@@ -172,7 +172,7 @@ static int __init rndis_do_config(struct usb_configuration *c)
if (ret < 0)
return ret;

- ret = fsg_add(c->cdev, c, fsg_common);
+ ret = fsg_bind_config(c->cdev, c, fsg_common);
if (ret < 0)
return ret;

@@ -208,7 +208,7 @@ static int __init cdc_do_config(struct usb_configuration *c)
if (ret < 0)
return ret;

- ret = fsg_add(c->cdev, c, fsg_common);
+ ret = fsg_bind_config(c->cdev, c, fsg_common);
if (ret < 0)
return ret;

--
1.7.1

2010-06-02 12:47:24

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 04/11] USB: gadget: composite: usb_string_ids_*() functions added

usb_string_ids_tab() and usb_string_ids_n() functions added to
the composite framework. The first accepts an array of
usb_string object and for each registeres a string id and the
second registeres a given number of ids and returns the first.

This may simplify string ids registration since gadgets and
composite functions won't have to call usb_string_id() several
times and each time check for errer status -- all this will be
done with a single call.

Signed-off-by: Michal Nazarewicz <[email protected]>
Signed-off-by: Kyungmin Park <[email protected]>
---
drivers/usb/gadget/composite.c | 71 +++++++++++++++++++++++++++++++++++++--
include/linux/usb/composite.h | 4 ++
2 files changed, 71 insertions(+), 4 deletions(-)

diff --git a/drivers/usb/gadget/composite.c b/drivers/usb/gadget/composite.c
index 391d169..125167e 100644
--- a/drivers/usb/gadget/composite.c
+++ b/drivers/usb/gadget/composite.c
@@ -673,20 +673,83 @@ static int get_string(struct usb_composite_dev *cdev,
* string IDs. Drivers for functions, configurations, or gadgets will
* then store that ID in the appropriate descriptors and string table.
*
- * All string identifier should be allocated using this routine, to
- * ensure that for example different functions don't wrongly assign
- * different meanings to the same identifier.
+ * All string identifier should be allocated using this,
+ * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure
+ * that for example different functions don't wrongly assign different
+ * meanings to the same identifier.
*/
int usb_string_id(struct usb_composite_dev *cdev)
{
if (cdev->next_string_id < 254) {
- /* string id 0 is reserved */
+ /* string id 0 is reserved by USB spec for list of
+ * supported languages */
+ /* 255 reserved as well? -- mina86 */
cdev->next_string_id++;
return cdev->next_string_id;
}
return -ENODEV;
}

+/**
+ * usb_string_ids() - allocate unused string IDs in batch
+ * @cdev: the device whose string descriptor IDs are being allocated
+ * @str: an array of usb_string objects to assign numbers to
+ * Context: single threaded during gadget setup
+ *
+ * @usb_string_ids() is called from bind() callbacks to allocate
+ * string IDs. Drivers for functions, configurations, or gadgets will
+ * then copy IDs from the string table to the appropriate descriptors
+ * and string table for other languages.
+ *
+ * All string identifier should be allocated using this,
+ * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
+ * example different functions don't wrongly assign different meanings
+ * to the same identifier.
+ */
+int usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string *str)
+{
+ int next = cdev->next_string_id;
+
+ for (; str->s; ++str) {
+ if (unlikely(next >= 254))
+ return -ENODEV;
+ str->id = ++next;
+ }
+
+ cdev->next_string_id = next;
+
+ return 0;
+}
+
+/**
+ * usb_string_ids_n() - allocate unused string IDs in batch
+ * @cdev: the device whose string descriptor IDs are being allocated
+ * @n: number of string IDs to allocate
+ * Context: single threaded during gadget setup
+ *
+ * Returns the first requested ID. This ID and next @n-1 IDs are now
+ * valid IDs. At least providind that @n is non zore because if it
+ * is, returns last requested ID which is now very useful information.
+ *
+ * @usb_string_ids_n() is called from bind() callbacks to allocate
+ * string IDs. Drivers for functions, configurations, or gadgets will
+ * then store that ID in the appropriate descriptors and string table.
+ *
+ * All string identifier should be allocated using this,
+ * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
+ * example different functions don't wrongly assign different meanings
+ * to the same identifier.
+ */
+int usb_string_ids_n(struct usb_composite_dev *c, unsigned n)
+{
+ unsigned next = c->next_string_id;
+ if (unlikely(n > 254 || (unsigned)next + n > 254))
+ return -ENODEV;
+ c->next_string_id += n;
+ return next + 1;
+}
+
+
/*-------------------------------------------------------------------------*/

static void composite_setup_complete(struct usb_ep *ep, struct usb_request *req)
diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h
index 139353e..f378075 100644
--- a/include/linux/usb/composite.h
+++ b/include/linux/usb/composite.h
@@ -342,6 +342,10 @@ struct usb_composite_dev {
};

extern int usb_string_id(struct usb_composite_dev *c);
+extern int usb_string_ids_tab(struct usb_composite_dev *c,
+ struct usb_string *str);
+extern int usb_string_ids_n(struct usb_composite_dev *c, unsigned n);
+

/* messaging utils */
#define DBG(d, fmt, args...) \
--
1.7.1

2010-06-02 12:46:49

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 06/11] USB: gadget: g_multi: code clean up and refactoring

The Multifunction Compasite Gadget have been cleaned up
and refactored so hopefully it looks prettier and works
at least as good as before changes.

Signed-off-by: Michal Nazarewicz <[email protected]>
Signed-off-by: Kyungmin Park <[email protected]>
---
drivers/usb/gadget/Kconfig | 1 +
drivers/usb/gadget/multi.c | 262 +++++++++++++++++++++++++-------------------
2 files changed, 148 insertions(+), 115 deletions(-)

diff --git a/drivers/usb/gadget/Kconfig b/drivers/usb/gadget/Kconfig
index 649c0c5..c97f021 100644
--- a/drivers/usb/gadget/Kconfig
+++ b/drivers/usb/gadget/Kconfig
@@ -862,6 +862,7 @@ config USB_G_NOKIA
config USB_G_MULTI
tristate "Multifunction Composite Gadget (EXPERIMENTAL)"
depends on BLOCK && NET
+ select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
help
The Multifunction Composite Gadget provides Ethernet (RNDIS
and/or CDC Ethernet), mass storage and ACM serial link
diff --git a/drivers/usb/gadget/multi.c b/drivers/usb/gadget/multi.c
index d3d3140..c7a5b58 100644
--- a/drivers/usb/gadget/multi.c
+++ b/drivers/usb/gadget/multi.c
@@ -24,6 +24,7 @@

#include <linux/kernel.h>
#include <linux/utsname.h>
+#include <linux/module.h>


#if defined USB_ETH_RNDIS
@@ -35,14 +36,13 @@


#define DRIVER_DESC "Multifunction Composite Gadget"
-#define DRIVER_VERSION "2009/07/21"

-/*-------------------------------------------------------------------------*/
+MODULE_DESCRIPTION(DRIVER_DESC);
+MODULE_AUTHOR("Michal Nazarewicz");
+MODULE_LICENSE("GPL");

-#define MULTI_VENDOR_NUM 0x0525 /* XXX NetChip */
-#define MULTI_PRODUCT_NUM 0xa4ab /* XXX */

-/*-------------------------------------------------------------------------*/
+/***************************** All the files... *****************************/

/*
* kbuild is not very cooperative with respect to linking separately
@@ -57,6 +57,8 @@
#include "config.c"
#include "epautoconf.c"

+#include "f_mass_storage.c"
+
#include "u_serial.c"
#include "f_acm.c"

@@ -68,13 +70,26 @@
#endif
#include "u_ether.c"

-#undef DBG /* u_ether.c has broken idea about macros */
-#undef VDBG /* so clean up after it */
-#undef ERROR
-#undef INFO
-#include "f_mass_storage.c"

-/*-------------------------------------------------------------------------*/
+
+/***************************** Device Descriptor ****************************/
+
+#define MULTI_VENDOR_NUM 0x0525 /* XXX NetChip */
+#define MULTI_PRODUCT_NUM 0xa4ab /* XXX */
+
+
+enum {
+ __MULTI_NO_CONFIG,
+#ifdef CONFIG_USB_G_MULTI_RNDIS
+ MULTI_RNDIS_CONFIG_NUM,
+#endif
+#ifdef CONFIG_USB_G_MULTI_CDC
+ MULTI_CDC_CONFIG_NUM,
+#endif
+ __MULTI_NUM_CONFIGS_HELPER,
+ MULTI_NUM_CONFIGS = __MULTI_NUM_CONFIGS_HELPER - 1
+};
+

static struct usb_device_descriptor device_desc = {
.bLength = sizeof device_desc,
@@ -82,80 +97,81 @@ static struct usb_device_descriptor device_desc = {

.bcdUSB = cpu_to_le16(0x0200),

- /* .bDeviceClass = USB_CLASS_COMM, */
- /* .bDeviceSubClass = 0, */
- /* .bDeviceProtocol = 0, */
- .bDeviceClass = 0xEF,
+ .bDeviceClass = USB_CLASS_MISC /* 0xEF */,
.bDeviceSubClass = 2,
.bDeviceProtocol = 1,
- /* .bMaxPacketSize0 = f(hardware) */

/* Vendor and product id can be overridden by module parameters. */
.idVendor = cpu_to_le16(MULTI_VENDOR_NUM),
.idProduct = cpu_to_le16(MULTI_PRODUCT_NUM),
- /* .bcdDevice = f(hardware) */
- /* .iManufacturer = DYNAMIC */
- /* .iProduct = DYNAMIC */
- /* NO SERIAL NUMBER */
- .bNumConfigurations = 1,
+ .bNumConfigurations = MULTI_NUM_CONFIGS,
};

-static struct usb_otg_descriptor otg_descriptor = {
- .bLength = sizeof otg_descriptor,
- .bDescriptorType = USB_DT_OTG,
-
- /* REVISIT SRP-only hardware is possible, although
- * it would not be called "OTG" ...
- */
- .bmAttributes = USB_OTG_SRP | USB_OTG_HNP,
-};

static const struct usb_descriptor_header *otg_desc[] = {
- (struct usb_descriptor_header *) &otg_descriptor,
+ (struct usb_descriptor_header *) &(struct usb_otg_descriptor){
+ .bLength = sizeof(struct usb_otg_descriptor),
+ .bDescriptorType = USB_DT_OTG,
+
+ /* REVISIT SRP-only hardware is possible, although
+ * it would not be called "OTG" ... */
+ .bmAttributes = USB_OTG_SRP | USB_OTG_HNP,
+ },
NULL,
};


-/* string IDs are assigned dynamically */
-
-#define STRING_MANUFACTURER_IDX 0
-#define STRING_PRODUCT_IDX 1
+enum {
+ MULTI_STRING_MANUFACTURER_IDX,
+ MULTI_STRING_PRODUCT_IDX,
+#ifdef CONFIG_USB_G_MULTI_RNDIS
+ MULTI_STRING_RNDIS_CONFIG_IDX,
+#endif
+#ifdef CONFIG_USB_G_MULTI_CDC
+ MULTI_STRING_CDC_CONFIG_IDX,
+#endif
+};

static char manufacturer[50];

static struct usb_string strings_dev[] = {
- [STRING_MANUFACTURER_IDX].s = manufacturer,
- [STRING_PRODUCT_IDX].s = DRIVER_DESC,
+ [MULTI_STRING_MANUFACTURER_IDX].s = manufacturer,
+ [MULTI_STRING_PRODUCT_IDX].s = DRIVER_DESC,
+#ifdef CONFIG_USB_G_MULTI_RNDIS
+ [MULTI_STRING_RNDIS_CONFIG_IDX].s = "Multifunction with RNDIS",
+#endif
+#ifdef CONFIG_USB_G_MULTI_CDC
+ [MULTI_STRING_CDC_CONFIG_IDX].s = "Multifunction with CDC ECM",
+#endif
{ } /* end of list */
};

-static struct usb_gadget_strings stringtab_dev = {
- .language = 0x0409, /* en-us */
- .strings = strings_dev,
-};
-
static struct usb_gadget_strings *dev_strings[] = {
- &stringtab_dev,
+ &(struct usb_gadget_strings){
+ .language = 0x0409, /* en-us */
+ .strings = strings_dev,
+ },
NULL,
};

-static u8 hostaddr[ETH_ALEN];



/****************************** Configurations ******************************/

-static struct fsg_module_parameters mod_data = {
- .stall = 1
-};
-FSG_MODULE_PARAMETERS(/* no prefix */, mod_data);
+static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
+FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
+
+static struct fsg_common fsg_common;
+
+static u8 hostaddr[ETH_ALEN];

-static struct fsg_common *fsg_common;

+/********** RNDIS **********/

#ifdef USB_ETH_RNDIS

-static int __init rndis_do_config(struct usb_configuration *c)
+static __ref int rndis_do_config(struct usb_configuration *c)
{
int ret;

@@ -172,26 +188,42 @@ static int __init rndis_do_config(struct usb_configuration *c)
if (ret < 0)
return ret;

- ret = fsg_bind_config(c->cdev, c, fsg_common);
+ ret = fsg_bind_config(c->cdev, c, &fsg_common);
if (ret < 0)
return ret;

return 0;
}

-static struct usb_configuration rndis_config_driver = {
- .label = "Multifunction Composite (RNDIS + MS + ACM)",
- .bind = rndis_do_config,
- .bConfigurationValue = 2,
- /* .iConfiguration = DYNAMIC */
- .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
-};
+static int rndis_config_register(struct usb_composite_dev *cdev)
+{
+ static struct usb_configuration config = {
+ .bind = rndis_do_config,
+ .bConfigurationValue = MULTI_RNDIS_CONFIG_NUM,
+ .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
+ };
+
+ config.label = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].s;
+ config.iConfiguration = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].id;
+
+ return usb_add_config(cdev, &config);
+}
+
+#else
+
+static int rndis_config_register(struct usb_composite_dev *cdev)
+{
+ return 0;
+}

#endif

+
+/********** CDC ECM **********/
+
#ifdef CONFIG_USB_G_MULTI_CDC

-static int __init cdc_do_config(struct usb_configuration *c)
+static __ref int cdc_do_config(struct usb_configuration *c)
{
int ret;

@@ -208,20 +240,33 @@ static int __init cdc_do_config(struct usb_configuration *c)
if (ret < 0)
return ret;

- ret = fsg_bind_config(c->cdev, c, fsg_common);
+ ret = fsg_bind_config(c->cdev, c, &fsg_common);
if (ret < 0)
return ret;

return 0;
}

-static struct usb_configuration cdc_config_driver = {
- .label = "Multifunction Composite (CDC + MS + ACM)",
- .bind = cdc_do_config,
- .bConfigurationValue = 1,
- /* .iConfiguration = DYNAMIC */
- .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
-};
+static int cdc_config_register(struct usb_composite_dev *cdev)
+{
+ static struct usb_configuration config = {
+ .bind = cdc_do_config,
+ .bConfigurationValue = MULTI_CDC_CONFIG_NUM,
+ .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
+ };
+
+ config.label = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].s;
+ config.iConfiguration = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].id;
+
+ return usb_add_config(cdev, &config);
+}
+
+#else
+
+static int cdc_config_register(struct usb_composite_dev *cdev)
+{
+ return 0;
+}

#endif

@@ -230,7 +275,7 @@ static struct usb_configuration cdc_config_driver = {
/****************************** Gadget Bind ******************************/


-static int __init multi_bind(struct usb_composite_dev *cdev)
+static int __ref multi_bind(struct usb_composite_dev *cdev)
{
struct usb_gadget *gadget = cdev->gadget;
int status, gcnum;
@@ -252,67 +297,57 @@ static int __init multi_bind(struct usb_composite_dev *cdev)
goto fail0;

/* set up mass storage function */
- fsg_common = fsg_common_from_params(0, cdev, &mod_data);
- if (IS_ERR(fsg_common)) {
- status = PTR_ERR(fsg_common);
- goto fail1;
+ {
+ void *retp;
+ retp = fsg_common_from_params(&fsg_common, cdev, &fsg_mod_data);
+ if (IS_ERR(retp)) {
+ status = PTR_ERR(retp);
+ goto fail1;
+ }
}

-
+ /* set bcdDevice */
gcnum = usb_gadget_controller_number(gadget);
- if (gcnum >= 0)
+ if (gcnum >= 0) {
device_desc.bcdDevice = cpu_to_le16(0x0300 | gcnum);
- else {
- /* We assume that can_support_ecm() tells the truth;
- * but if the controller isn't recognized at all then
- * that assumption is a bit more likely to be wrong.
- */
- WARNING(cdev, "controller '%s' not recognized\n",
- gadget->name);
+ } else {
+ WARNING(cdev, "controller '%s' not recognized\n", gadget->name);
device_desc.bcdDevice = cpu_to_le16(0x0300 | 0x0099);
}

+ /* allocate string descriptor numbers */

- /* Allocate string descriptor numbers ... note that string
- * contents can be overridden by the composite_dev glue.
- */
-
- /* device descriptor strings: manufacturer, product */
snprintf(manufacturer, sizeof manufacturer, "%s %s with %s",
init_utsname()->sysname, init_utsname()->release,
gadget->name);
- status = usb_string_id(cdev);
- if (status < 0)
- goto fail2;
- strings_dev[STRING_MANUFACTURER_IDX].id = status;
- device_desc.iManufacturer = status;

- status = usb_string_id(cdev);
- if (status < 0)
+ status = usb_string_ids_tab(cdev, strings_dev);
+ if (unlikely(status < 0))
goto fail2;
- strings_dev[STRING_PRODUCT_IDX].id = status;
- device_desc.iProduct = status;

-#ifdef USB_ETH_RNDIS
- /* register our first configuration */
- status = usb_add_config(cdev, &rndis_config_driver);
- if (status < 0)
+ device_desc.iManufacturer =
+ strings_dev[MULTI_STRING_MANUFACTURER_IDX].id;
+ device_desc.iProduct =
+ strings_dev[MULTI_STRING_PRODUCT_IDX].id;
+
+ /* register configurations */
+ status = rndis_config_register(cdev);
+ if (unlikely(status < 0))
goto fail2;
-#endif

-#ifdef CONFIG_USB_G_MULTI_CDC
- /* register our second configuration */
- status = usb_add_config(cdev, &cdc_config_driver);
- if (status < 0)
+ status = cdc_config_register(cdev);
+ if (unlikely(status < 0))
goto fail2;
-#endif

- dev_info(&gadget->dev, DRIVER_DESC ", version: " DRIVER_VERSION "\n");
- fsg_common_put(fsg_common);
+ /* we're done */
+ dev_info(&gadget->dev, DRIVER_DESC "\n");
+ fsg_common_put(&fsg_common);
return 0;

+
+ /* error recovery */
fail2:
- fsg_common_put(fsg_common);
+ fsg_common_put(&fsg_common);
fail1:
gserial_cleanup();
fail0:
@@ -339,18 +374,15 @@ static struct usb_composite_driver multi_driver = {
.unbind = __exit_p(multi_unbind),
};

-MODULE_DESCRIPTION(DRIVER_DESC);
-MODULE_AUTHOR("Michal Nazarewicz");
-MODULE_LICENSE("GPL");

-static int __init g_multi_init(void)
+static int __init multi_init(void)
{
return usb_composite_register(&multi_driver);
}
-module_init(g_multi_init);
+module_init(multi_init);

-static void __exit g_multi_cleanup(void)
+static void __exit multi_exit(void)
{
usb_composite_unregister(&multi_driver);
}
-module_exit(g_multi_cleanup);
+module_exit(multi_exit);
--
1.7.1

2010-06-02 12:46:47

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 03/11] USB: gadget: f_fs: functionfs_add() renamed to functionfs_bind_config()

FunctionFS had a bit unique name for function used to add it
to USB configuration. Renamed as to match naming convention
of other functions.

Signed-off-by: Michal Nazarewicz <[email protected]>
Signed-off-by: Kyungmin Park <[email protected]>
---
drivers/usb/gadget/f_fs.c | 6 +++---
drivers/usb/gadget/g_ffs.c | 2 +-
include/linux/usb/functionfs.h | 6 +++---
3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/drivers/usb/gadget/f_fs.c b/drivers/usb/gadget/f_fs.c
index d69eccf..3fe120f 100644
--- a/drivers/usb/gadget/f_fs.c
+++ b/drivers/usb/gadget/f_fs.c
@@ -1480,9 +1480,9 @@ static void ffs_epfiles_destroy(struct ffs_epfile *epfiles, unsigned count)
}


-static int functionfs_add(struct usb_composite_dev *cdev,
- struct usb_configuration *c,
- struct ffs_data *ffs)
+static int functionfs_bind_config(struct usb_composite_dev *cdev,
+ struct usb_configuration *c,
+ struct ffs_data *ffs)
{
struct ffs_function *func;
int ret;
diff --git a/drivers/usb/gadget/g_ffs.c b/drivers/usb/gadget/g_ffs.c
index 4b0e4a0..2f26470 100644
--- a/drivers/usb/gadget/g_ffs.c
+++ b/drivers/usb/gadget/g_ffs.c
@@ -388,7 +388,7 @@ static int __gfs_do_config(struct usb_configuration *c,
return ret;
}

- ret = functionfs_add(c->cdev, c, gfs_ffs_data);
+ ret = functionfs_bind_config(c->cdev, c, gfs_ffs_data);
if (unlikely(ret < 0))
return ret;

diff --git a/include/linux/usb/functionfs.h b/include/linux/usb/functionfs.h
index a34a2a0..6f649c1 100644
--- a/include/linux/usb/functionfs.h
+++ b/include/linux/usb/functionfs.h
@@ -180,9 +180,9 @@ static int functionfs_bind(struct ffs_data *ffs, struct usb_composite_dev *cdev)
static void functionfs_unbind(struct ffs_data *ffs)
__attribute__((nonnull));

-static int functionfs_add(struct usb_composite_dev *cdev,
- struct usb_configuration *c,
- struct ffs_data *ffs)
+static int functionfs_bind_config(struct usb_composite_dev *cdev,
+ struct usb_configuration *c,
+ struct ffs_data *ffs)
__attribute__((warn_unused_result, nonnull));


--
1.7.1

2010-06-02 12:46:29

by Michal Nazarewicz

[permalink] [raw]
Subject: [PATCHv3 11/11] USB: gadget: g_multi: Install Mode added

Added an Install Mode to the Multifunction Composite Gadget. This
mode makes the gadget appear as a mass storage device with first
logical unit simulating CD-ROM until an eject on that logical unit
is requested because then gadget switches to the "full flagged"
gadget.

The intend is that in Install Mode the gadget will provide only
a CD-ROM with drivers for host platform. After the drivers are
intstalled the gadget will switch to the proper gadget and the
newly installed drivers will handle it.

When the device is disconnected form the host machine (or host
reboots or whatever that couses suspend or disconnect) the gadget
will switch to Install Mode again.

Because disconnect is a normal situation on re-enumeration gadget
"ignores" all disconnects and suspends during the first 10 seconds
after an eject.

Signed-off-by: Michal Nazarewicz <[email protected]>
Signed-off-by: Kyungmin Park <[email protected]>
---
Documentation/usb/gadget_multi.txt | 61 ++++
drivers/usb/gadget/Kconfig | 22 ++
drivers/usb/gadget/multi.c | 596 +++++++++++++++++++++++++++++-------
3 files changed, 567 insertions(+), 112 deletions(-)

diff --git a/Documentation/usb/gadget_multi.txt b/Documentation/usb/gadget_multi.txt
index 65bccd8..9319f1d 100644
--- a/Documentation/usb/gadget_multi.txt
+++ b/Documentation/usb/gadget_multi.txt
@@ -18,6 +18,11 @@ RNDIS and another with CDC ECM[3].
Please not that if you use non-standard configuration you may need to
change vendor and/or product ID.

+The driver provides also an "install mode" which you may also call
+NoCD ore ZereCD (expect the later is a trademark) which lets one
+develop an image with drivers which install automatically on systems
+like Windows.
+
* Host drivers

To make use of the gadget one needs to make it work on host side --
@@ -35,6 +40,10 @@ This is also true for two configuration set-up with RNDIS
configuration being the first one. Linux host will use the second
configuration with CDC ECM which should work better under Linux.

+The only exception is when install mode is enabled in which case the
+gadget will appear as a plain mass storage device unless it is
+ejected. Read appropriate section of this document to find out more.
+
** Windows host drivers

For the gadget two work under Windown two conditions have to be met:
@@ -129,6 +138,54 @@ For more exotic systems I have even less to say...

Any testing and drivers *are* *welcome*!

+* Install mode
+
+The install mode makes the gadget appear as a plain mass storage
+device the first time it is connected (and after each disconnect).
+This lets one develop an "autorun" CD-ROM image with drivers and put
+it as the first logical unit.
+
+** Workings of the install mode
+
+As you may know, mass storage gadget may provide several logical units
+and its easier to think of them as separate drives. When install mode
+is enabled, g_multi forces the first logical unit to be a read-only
+CD-ROM. When install mode is enabled but mass storage itself is not
+then exactly one logical unit is set.
+
+When an eject request is made on that logical unit, the file is not
+really closed but the gadget switches it's mode to the full flagged
+gadget with all the other functions. If mass storage is among them,
+the firs logical unit will be the CD-ROM image with drivers (which may
+be seen as a bad thing).
+
+When gadget is disconnected and connected afterwards it will work
+again in install mode. Some heuristics are used here -- if
+disconnection (or suspend) happens no longer then 10 seconds after
+last eject on the first logical unit then on next enumeration gadget
+will claim to be full flagged otherwise it'll stick to install mode.
+
+** Interoperability with host
+
+As said, the idea behind install mode is that hosts that require
+drivers will be able to get them without the need for additional
+CD-ROM or another medium provided with the device.
+
+CD-ROM image should provide an "autorun" functionality witch will
+install drivers and eject the emulated CD-ROM to switch gadget into
+the other mode which will be handled by newly installed drivers. If
+drivers are installed already, they should "catch" the install mode
+device by product and vendor IDs and issue an eject.
+
+This mode is not very Linux-friendly though since Linux and Linux
+based systems have no notion of autorun (which from security point of
+view is a good thing) and there's no way of adding some file on the
+image which will make gadget eject the device.
+
+Fortunately, there's USB_ModeSwitch[8] and/or udev[9] which
+should handle it just fine. A single rule need to be added and
+everything should work fine.
+
* Authors

This document has been written by Michal Nazarewicz
@@ -158,3 +215,7 @@ any user input.
[7] Possibility to say `git rev-list --author='Your Name'
linus/master|wc -l` returns non-zero -- priceless. :]

+[8] [[http://www.draisberghof.de/usb_modeswitch/]]
+
+[9] [[http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev.html]]
+
diff --git a/drivers/usb/gadget/Kconfig b/drivers/usb/gadget/Kconfig
index 8052643..21500eb 100644
--- a/drivers/usb/gadget/Kconfig
+++ b/drivers/usb/gadget/Kconfig
@@ -920,6 +920,28 @@ config USB_G_MULTI_MSF

If unsure, say "y".

+config USB_G_MULTI_INSTALL
+ bool "Install Mode"
+ depends on USB_G_MULTI && BLOCK
+ default n
+ help
+ This option enables an "Install Mode" configuration. You may
+ also refer to in as NoCD or ZeroCD (although the later is
+ a trademark).
+
+ This mode makes gadget appear as an USB Mass Storage device
+ emulating a CD-ROM the first time it is connected. The intend
+ is that you can put drivers for your gadget on the disk image.
+
+ When eject request is sent to the logical translation unit
+ gadget switches its mode to the full flagged gadget with all the
+ other functions.
+
+ When device is disconnected, gadget once again switches to the
+ Install Mode configuration.
+
+ If unsure, say "n".
+
config USB_G_HID
tristate "HID Gadget"
help
diff --git a/drivers/usb/gadget/multi.c b/drivers/usb/gadget/multi.c
index 6f6fd3e..4aab815 100644
--- a/drivers/usb/gadget/multi.c
+++ b/drivers/usb/gadget/multi.c
@@ -25,6 +25,8 @@
#include <linux/kernel.h>
#include <linux/utsname.h>
#include <linux/module.h>
+#include <linux/workqueue.h>
+#include <linux/jiffies.h>


#if defined USB_ETH_RNDIS
@@ -57,18 +59,27 @@ MODULE_LICENSE("GPL");
#include "config.c"
#include "epautoconf.c"

-/* Mass storage */
-#ifdef CONFIG_USB_G_MULTI_MSF
+/* Mass storage & Install Mode */
+#if defined CONFIG_USB_G_MULTI_MSF || defined CONFIG_USB_G_MULTI_INSTALL
# include "f_mass_storage.c"
-
static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
-
static struct fsg_common fsg_common;
#else
-# define fsg_common_from_params(common, cdev, data) NULL
# define fsg_bind_config(cdev, conf, common) ((int)0)
-# define fsg_common_put(common) do { } while (0)
+#endif
+
+#ifdef CONFIG_USB_G_MULTI_INSTALL
+static unsigned install_mode = 1, next_install_mode = 1;
+#else
+# define install_mode false
+# define next_install_mode false
+#endif
+
+#ifdef CONFIG_USB_G_MULTI_MSF
+# define have_fsg true
+#else
+# define have_fsg false
#endif

/* CDC ACM */
@@ -76,8 +87,6 @@ static struct fsg_common fsg_common;
# include "u_serial.c"
# include "f_acm.c"
#else
-# define gserial_setup(conf, ports) ((int)0)
-# define gserial_cleanup() do { } while (0)
# define acm_bind_config(conf, ports) ((int)0)
#endif

@@ -95,9 +104,6 @@ static struct fsg_common fsg_common;
#if defined CONFIG_USB_G_MULTI_ECM || defined CONFIG_USB_G_MULTI_RNDIS
# include "u_ether.c"
static u8 hostaddr[ETH_ALEN];
-#else
-# define gether_setup(cdev, hostaddr) ((int)0)
-# define gether_cleanup() do { } while (0)
#endif

#ifndef CONFIG_USB_G_MULTI_ECM
@@ -110,14 +116,34 @@ static u8 hostaddr[ETH_ALEN];
#endif


+/******************************** Prototypes ********************************/
+
+static unsigned long multi_initialised;
+
+static int multi_setup(struct usb_composite_dev *cdev);
+static void multi_cleanup(void);
+static int multi_bind(struct usb_composite_dev *cdev);
+static int multi_register(void);
+static void multi_unregister(void);
+
+#ifdef CONFIG_USB_G_MULTI_INSTALL
+static int multi_eject(struct fsg_common *common,
+ struct fsg_lun *lun, int num);
+static void multi_disconnect(struct usb_composite_dev *cdev);
+#else
+# define multi_disconnect NULL
+#endif
+
+
+
/***************************** Device Descriptor ****************************/

+/* Main device */
#define MULTI_VENDOR_NUM 0x0525 /* XXX NetChip */
#define MULTI_PRODUCT_NUM 0xa4ab /* XXX */

-
-static struct usb_device_descriptor device_desc = {
- .bLength = sizeof device_desc,
+static struct usb_device_descriptor multi_device_desc = {
+ .bLength = sizeof multi_device_desc,
.bDescriptorType = USB_DT_DEVICE,

.bcdUSB = cpu_to_le16(0x0200),
@@ -136,7 +162,31 @@ static struct usb_device_descriptor device_desc = {
#endif
};

+/* Install mode */
+#ifdef CONFIG_USB_G_MULTI_INSTALL
+
+#define MULTI_INSTALL_VENDOR_NUM 0x0525 /* XXX NetChip */
+#define MULTI_INSTALL_PRODUCT_NUM 0xa4ad /* XXX */
+
+static struct usb_device_descriptor install_mode_device_desc = {
+ .bLength = sizeof install_mode_device_desc,
+ .bDescriptorType = USB_DT_DEVICE,
+
+ .bcdUSB = cpu_to_le16(0x0200),
+
+ .bDeviceClass = USB_CLASS_MASS_STORAGE,
+ .bDeviceSubClass = USB_SC_SCSI,
+ .bDeviceProtocol = USB_PR_BULK,

+ /* Vendor and product id can be overridden by module parameters. */
+ .idVendor = cpu_to_le16(MULTI_INSTALL_VENDOR_NUM),
+ .idProduct = cpu_to_le16(MULTI_INSTALL_PRODUCT_NUM),
+ .bNumConfigurations = 1,
+};
+
+#endif
+
+/* Other descs */
static const struct usb_descriptor_header *otg_desc[] = {
(struct usb_descriptor_header *) &(struct usb_otg_descriptor){
.bLength = sizeof(struct usb_otg_descriptor),
@@ -150,9 +200,17 @@ static const struct usb_descriptor_header *otg_desc[] = {
};


+/* Strings */
enum {
MULTI_STRING_MANUFACTURER_IDX,
MULTI_STRING_PRODUCT_IDX,
+ MULTI_STRING_FIRST_CFG_IDX,
+#if defined CONFIG_USB_G_MULTI_RNDIS && defined CONFIG_USB_G_MULTI_ECM
+ MULTI_STRING_SECOND_CFG_IDX,
+#endif
+#ifdef CONFIG_USB_G_MULTI_INSTALL
+ MULTI_STRING_INSTALL_MODE_IDX,
+#endif
};

static char manufacturer[50];
@@ -160,24 +218,42 @@ static char manufacturer[50];
static struct usb_string strings_dev[] = {
[MULTI_STRING_MANUFACTURER_IDX].s = manufacturer,
[MULTI_STRING_PRODUCT_IDX].s = DRIVER_DESC,
+ [MULTI_STRING_FIRST_CFG_IDX].s = "First Configuration",
+#if defined CONFIG_USB_G_MULTI_RNDIS && defined CONFIG_USB_G_MULTI_ECM
+ [MULTI_STRING_SECOND_CFG_IDX].s = "Second Configuration",
+#endif
+#ifdef CONFIG_USB_G_MULTI_INSTALL
+ [MULTI_STRING_INSTALL_MODE_IDX].s = "Install Mode [NoCD]",
+#endif
{ } /* end of list */
};

-static struct usb_gadget_strings *dev_strings[] = {
- &(struct usb_gadget_strings){
- .language = 0x0409, /* en-us */
- .strings = strings_dev,
+/* The driver */
+static struct usb_composite_driver multi_driver = {
+ .name = "g_multi",
+ .dev = &multi_device_desc,
+ .strings = (struct usb_gadget_strings *[]) {
+ &(struct usb_gadget_strings) {
+ .language = 0x0409, /* en-us */
+ .strings = strings_dev,
+ },
+ NULL,
},
- NULL,
+ .bind = multi_bind,
+ .disconnect = multi_disconnect,
+ .suspend = multi_disconnect,
};

-
+#ifdef CONFIG_USB_G_MULTI_INSTALL
+# define device_desc (*(struct usb_device_descriptor *)multi_driver.dev)
+#else
+# define device_desc multi_device_desc
+#endif


/****************************** Configurations ******************************/

-
-static __ref int first_do_config(struct usb_configuration *c)
+static int first_do_config(struct usb_configuration *c)
{
int ret;

@@ -186,36 +262,51 @@ static __ref int first_do_config(struct usb_configuration *c)
c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
}

+ /* First configuration can have either RNDIS or ECM. This
+ * depends on wthether RNDIS is turned on. If it is then
+ * first config is always RNDIS because even if ECM is on as
+ * well it is the second config. */
#ifdef CONFIG_USB_G_MULTI_RNDIS
ret = rndis_bind_config(c, hostaddr);
#else
ret = ecm_bind_config(c, hostaddr);
#endif
- if (ret < 0)
+ if (unlikely(ret < 0))
return ret;

ret = acm_bind_config(c, 0);
- if (ret < 0)
+ if (unlikely(ret < 0))
return ret;

- ret = fsg_bind_config(c->cdev, c, &fsg_common);
- if (ret < 0)
- return ret;
+ if (have_fsg) {
+ /* We need to check if we want mass storage since it
+ * may have been forced on by the install mode even
+ * though user does not want it in the proper USB
+ * configurations. */
+ ret = fsg_bind_config(c->cdev, c, &fsg_common);
+ if (unlikely(ret < 0))
+ return ret;
+ }

return 0;
}

-static struct usb_configuration first_config_driver = {
- .label = "First Configuration",
- .bind = first_do_config,
- .bConfigurationValue = 1,
- .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
-};
-
+static int add_first_config(struct usb_composite_dev *cdev)
+{
+ static struct usb_configuration driver = {
+ .bind = first_do_config,
+ .bConfigurationValue = 1,
+ .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
+ };
+
+ driver.iConfiguration = strings_dev[MULTI_STRING_FIRST_CFG_IDX].id;
+ driver.label = strings_dev[MULTI_STRING_FIRST_CFG_IDX].s;
+ return usb_add_config(cdev, &driver);
+}

#if defined CONFIG_USB_G_MULTI_RNDIS && defined CONFIG_USB_G_MULTI_ECM

-static __ref int second_do_config(struct usb_configuration *c)
+static int second_do_config(struct usb_configuration *c)
{
int ret;

@@ -225,144 +316,425 @@ static __ref int second_do_config(struct usb_configuration *c)
}

ret = ecm_bind_config(c, hostaddr);
- if (ret < 0)
+ if (unlikely(ret < 0))
return ret;

ret = acm_bind_config(c, 0);
- if (ret < 0)
+ if (unlikely(ret < 0))
return ret;

- ret = fsg_bind_config(c->cdev, c, &fsg_common);
- if (ret < 0)
- return ret;
+ if (have_fsg) {
+ /* We need to check if we want mass storage since it
+ * may have been forced on by the install mode even
+ * though user does not want it in the proper USB
+ * configurations. */
+ ret = fsg_bind_config(c->cdev, c, &fsg_common);
+ if (unlikely(ret < 0))
+ return ret;
+ }

return 0;
}

-static struct usb_configuration second_config_driver = {
- .label = "Second Configuration",
- .bind = second_do_config,
- .bConfigurationValue = 2,
- .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
-};
+static int add_second_config(struct usb_composite_dev *cdev)
+{
+ static struct usb_configuration driver = {
+ .bind = second_do_config,
+ .bConfigurationValue = 2,
+ .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
+ };
+
+ driver.iConfiguration = strings_dev[MULTI_STRING_FIRST_CFG_IDX].id;
+ driver.label = strings_dev[MULTI_STRING_FIRST_CFG_IDX].s;
+ return usb_add_config(cdev, &driver);
+}
+
+#else
+
+static int add_second_config(struct usb_composite_dev *cdev)
+{
+ return 0;
+}
+
+#endif
+
+
+/********************************* Worker ********************************/
+
+#if defined CONFIG_USB_G_MULTI_INSTALL
+
+#ifdef MODULE
+static unsigned multi_exiting;
+#else
+# define multi_exiting false
+#endif
+
+
+static void multi_worker_func(struct work_struct *work)
+{
+ /* Make sure, the next state is read corretly. */
+ smp_rmb();
+
+ /* multi_exit() has been called -- no need to do anything. */
+ if (multi_exiting)
+ return;
+
+ /* Switch only if anything actually changes. */
+ if (!test_bit(0, &multi_initialised))
+ goto unregistered;

+ if (install_mode != next_install_mode)
+ goto registered;
+
+ /* Ther's no reason to re-enumerate. */
+ return;
+
+
+registered:
+ /* Unregister the driver to force re-enumeration. */
+ multi_unregister();
+ msleep(5);
+
+unregistered:
+ /* While we were waiting the next state could change, so make
+ * sure we are reading the changed state. This is not critical
+ * since another worker will be scheduled anyways (see
+ * multi_worker_schedule()) but we could avoid unnecesary
+ * switch. On the other hand this barier is critical for
+ * cheking multi_exiting, read further. */
+ smp_rmb();
+
+ /* As we were waiting, multi_exit() has been called. */
+ if (multi_exiting)
+ return;
+
+#ifdef CONFIG_USB_G_MULTI_INSTALL
+ install_mode = next_install_mode;
#endif

+ multi_register();
+}
+
+/* Configuration switching can be requested from different contexts so
+ * to avoid any troubles which may arrise from the fact that IRQs are
+ * disabled, USB functions are in unknown state, etc. we introduce
+ * a worker which does all that. It also allows the job to be done
+ * after some delay. For instance after eject let the mass storage
+ * function settle down. */
+static DECLARE_DELAYED_WORK(multi_worker, multi_worker_func);
+
+static void multi_worker_exit(void)
+{
+ multi_exiting = 1;
+ /* See description of the usage of smp_rmb() in
+ * multi_worker_func(). */
+ smp_wmb();
+ cancel_delayed_work_sync(&multi_worker);
+}
+
+static void multi_worker_schedule(void)
+{
+ /* Make sure the new stats is written before worker starts. */
+ smp_wmb();
+ /* Cancel or wait for completion if worker is scheduled. */
+ cancel_delayed_work(&multi_worker);
+ /* Run the worker with a 1/64 of a second (~15 ms) delay to
+ * let everything settle up. */
+ schedule_delayed_work(&multi_worker, HZ >> 6);
+}
+
+# define __dyn_init
+# define __dyn_ref
+# define __dyn_exit
+#else
+# define __dyn_init __init
+# define __dyn_ref __ref
+# define __dyn_exit __exit
+# define multi_worker_exit() do { } while (0)
+#endif
+
+
+/****************************** Install Mode *****************************/
+
+#ifdef CONFIG_USB_G_MULTI_INSTALL
+
+static int install_mode_do_config(struct usb_configuration *c)
+{
+ if (gadget_is_otg(c->cdev->gadget)) {
+ c->descriptors = otg_desc;
+ c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
+ }
+
+ return fsg_bind_config(c->cdev, c, &fsg_common);
+}
+
+static int add_install_mode_config(struct usb_composite_dev *cdev)
+{
+ static struct usb_configuration driver = {
+ .bind = install_mode_do_config,
+ .bConfigurationValue = 1,
+ .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
+ };
+
+ driver.iConfiguration = strings_dev[MULTI_STRING_INSTALL_MODE_IDX].id;
+ driver.label = strings_dev[MULTI_STRING_INSTALL_MODE_IDX].s;
+ return usb_add_config(cdev, &driver);
+}
+
+
+/* Jiffies of the last eject request on LUN 0. */
+static unsigned long multi_eject_jiffies;
+
+static int multi_eject(struct fsg_common *common,
+ struct fsg_lun *lun, int num)
+{
+ if (num)
+ return 0;
+
+ multi_eject_jiffies = jiffies;
+ next_install_mode = 0;
+ multi_worker_schedule();
+
+ return 1; /* Prevent realy unmounting the device */
+}
+
+static void multi_disconnect(struct usb_composite_dev *cdev)
+{
+ printk(KERN_INFO "multi_disconnect()\n");
+
+ /* Change back to install mode only if there was an eject
+ * (this is checked by looking if multi_eject_jiffies is
+ * non-zero), we are not switching to install mode already (no
+ * point in doing anything if next_install_mode is aleady one)
+ * and at least 10 seconds passed since last eject. */
+ /* Funky stuff may happen when jiffies wrap but we do not
+ * care. */
+ if (multi_eject_jiffies && !next_install_mode &&
+ jiffies >= multi_eject_jiffies + 10 * HZ) {
+ next_install_mode = 1;
+ multi_worker_schedule();
+ }
+}
+
+#else
+
+static int add_install_mode_config(struct usb_composite_dev *cdev)
+{
+ return 0;
+}
+
+#endif


/****************************** Gadget Bind ******************************/

+#if defined CONFIG_USB_G_MULTI_MSF || defined CONFIG_USB_G_MULTI_INSTALL

-static int __ref multi_bind(struct usb_composite_dev *cdev)
+static int __dyn_init multi_fsg_setup(struct usb_composite_dev *cdev)
{
- struct usb_gadget *gadget = cdev->gadget;
- int status, gcnum;
+ struct fsg_config cfg;
+ void *ret;
+
+#ifdef CONFIG_USB_G_MULTI_INSTALL
+ /* In install mode, make the first logical unit a read
+ * only removable CD-ROM. In addition if mass storage
+ * is used only for install mode, sot number of
+ * logical units to 1. */
+ if (!have_fsg)
+ fsg_mod_data.luns = 1;
+ fsg_mod_data.ro[0] = 1;
+ fsg_mod_data.removable[0] = 1;
+ fsg_mod_data.cdrom[0] = 1;
+ fsg_mod_data.removable_count =
+ max(fsg_mod_data.removable_count, 1u);
+#endif

- if (!can_support_ecm(cdev->gadget)) {
- dev_err(&gadget->dev, "controller '%s' not usable\n",
- gadget->name);
- return -EINVAL;
+ fsg_config_from_params(&cfg, &fsg_mod_data);
+
+#ifdef CONFIG_USB_G_MULTI_INSTALL
+ {
+ static const struct fsg_operations ops = {
+ .pre_eject = multi_eject,
+ };
+ cfg.ops = &ops;
}
+#endif
+
+ ret = fsg_common_init(&fsg_common, cdev, &cfg);
+ return unlikely(IS_ERR(ret)) ? PTR_ERR(ret) : 0;
+}
+
+#endif
+

+static int __dyn_init multi_setup(struct usb_composite_dev *cdev)
+{
+ int ret;
+
+#if defined CONFIG_USB_G_MULTI_RNDIS || defined CONFIG_USB_G_MULTI_ECM
/* set up network link layer */
- status = gether_setup(cdev->gadget, hostaddr);
- if (status < 0)
- return status;
+ if (!test_and_set_bit(1, &multi_initialised)) {
+ ret = gether_setup(cdev->gadget, hostaddr);
+ if (unlikely(ret < 0)) {
+ clear_bit(1, &multi_initialised);
+ goto fail;
+ }
+ }
+#endif

+#if defined CONFIG_USB_G_MULTI_ACM
/* set up serial link layer */
- status = gserial_setup(cdev->gadget, 1);
- if (status < 0)
- goto fail0;
+ if (!test_and_set_bit(2, &multi_initialised)) {
+ ret = gserial_setup(cdev->gadget, 1);
+ if (unlikely(ret < 0)) {
+ clear_bit(2, &multi_initialised);
+ goto fail;
+ }
+ }
+#endif

- /* set up mass storage function */
- {
- void *retp;
- retp = fsg_common_from_params(&fsg_common, cdev, &fsg_mod_data);
- if (IS_ERR(retp)) {
- status = PTR_ERR(retp);
- goto fail1;
+#if defined CONFIG_USB_G_MULTI_MSF || defined CONFIG_USB_G_MULTI_INSTALL
+ /* set up mass storage */
+ if (!test_and_set_bit(3, &multi_initialised)) {
+ ret = multi_fsg_setup(cdev);
+ if (unlikely(ret < 0)) {
+ clear_bit(3, &multi_initialised);
+ goto fail;
}
}
+#endif

- /* set bcdDevice */
- gcnum = usb_gadget_controller_number(gadget);
- if (gcnum >= 0) {
- device_desc.bcdDevice = cpu_to_le16(0x0300 | gcnum);
- } else {
- WARNING(cdev, "controller '%s' not recognized\n", gadget->name);
- device_desc.bcdDevice = cpu_to_le16(0x0300 | 0x0099);
+ return 0;
+
+fail:
+ multi_cleanup();
+ return ret;
+}
+
+static void multi_cleanup(void)
+{
+#if defined CONFIG_USB_G_MULTI_MSF || defined CONFIG_USB_G_MULTI_INSTALL
+ if (test_and_clear_bit(3, &multi_initialised))
+ fsg_common_put(&fsg_common);
+#endif
+
+#if defined CONFIG_USB_G_MULTI_ACM
+ if (test_and_clear_bit(2, &multi_initialised))
+ gserial_cleanup();
+#endif
+
+#if defined CONFIG_USB_G_MULTI_RNDIS || defined CONFIG_USB_G_MULTI_ECM
+ if (test_and_clear_bit(1, &multi_initialised))
+ gether_cleanup();
+#endif
+}
+
+
+static int __dyn_ref multi_bind(struct usb_composite_dev *cdev)
+{
+ struct usb_gadget *gadget = cdev->gadget;
+ int status;
+
+ if (!can_support_ecm(cdev->gadget)) {
+ dev_err(&gadget->dev, "controller '%s' not usable\n",
+ gadget->name);
+ return -EINVAL;
}

- /* allocate string descriptor numbers */
+ /* Set up functions */
+ status = multi_setup(cdev);
+ if (unlikely(status < 0))
+ return status;

- snprintf(manufacturer, sizeof manufacturer, "%s %s with %s",
- init_utsname()->sysname, init_utsname()->release,
- gadget->name);
+ /* allocate string descriptor numbers */
+ if (!*manufacturer)
+ snprintf(manufacturer, sizeof manufacturer, "%s %s with %s",
+ init_utsname()->sysname, init_utsname()->release,
+ gadget->name);

status = usb_string_ids_tab(cdev, strings_dev);
if (unlikely(status < 0))
- goto fail2;
+ goto fail;
+
+ printk(KERN_INFO "install_mode = %d\n", install_mode);

+ /* register configurations */
+ if (install_mode) {
+ status = add_install_mode_config(cdev);
+ } else {
+ status = add_first_config(cdev);
+ if (unlikely(status < 0))
+ goto fail;
+
+ status = add_second_config(cdev);
+ if (unlikely(status < 0))
+ goto fail;
+ }
+
+ /* Fill the rest of the device descriptor */
device_desc.iManufacturer =
strings_dev[MULTI_STRING_MANUFACTURER_IDX].id;
device_desc.iProduct =
strings_dev[MULTI_STRING_PRODUCT_IDX].id;

- /* register configurations */
- status = usb_add_config(cdev, &first_config_driver);
- if (unlikely(status < 0))
- goto fail2;
-
-#if defined CONFIG_USB_G_MULTI_RNDIS && defined CONFIG_USB_G_MULTI_ECM
- status = usb_add_config(cdev, &second_config_driver);
- if (unlikely(status < 0))
- goto fail2;
-#endif
+ status = usb_gadget_controller_number(cdev->gadget);
+ device_desc.bcdDevice =
+ cpu_to_le16(0x300 | (status < 0 ? 0x99 : status));

/* we're done */
dev_info(&gadget->dev, DRIVER_DESC "\n");
- fsg_common_put(&fsg_common);
return 0;


/* error recovery */
-fail2:
- fsg_common_put(&fsg_common);
-fail1:
- gserial_cleanup();
-fail0:
- gether_cleanup();
+fail:
+ multi_cleanup();
return status;
}

-static int __exit multi_unbind(struct usb_composite_dev *cdev)
+
+/*************************** Other init/exit ****************************/
+
+static int __dyn_init multi_register(void)
{
- gserial_cleanup();
- gether_cleanup();
- return 0;
-}
+ int ret = 0;

+ if (!test_and_set_bit(0, &multi_initialised)) {
+#ifdef CONFIG_USB_G_MULTI_INSTALL
+ multi_driver.dev = install_mode
+ ? &install_mode_device_desc
+ : &multi_device_desc;
+#endif

-/****************************** Some noise ******************************/
+ ret = usb_composite_register(&multi_driver);
+ if (unlikely(ret)) {
+ clear_bit(0, &multi_initialised);
+ printk(KERN_ERR
+ "g_multi: failed registering the driver: %d\n",
+ ret);
+ }
+ }

+ return ret;
+}

-static struct usb_composite_driver multi_driver = {
- .name = "g_multi",
- .dev = &device_desc,
- .strings = dev_strings,
- .bind = multi_bind,
- .unbind = __exit_p(multi_unbind),
-};
+static void __dyn_exit multi_unregister(void)
+{
+ if (test_and_clear_bit(0, &multi_initialised))
+ usb_composite_unregister(&multi_driver);
+}


-static int __init multi_init(void)
+static __init int multi_init(void)
{
- return usb_composite_register(&multi_driver);
+ return multi_register();
}
module_init(multi_init);

-static void __exit multi_exit(void)
+static __exit void multi_exit(void)
{
- usb_composite_unregister(&multi_driver);
+ multi_worker_exit();
+ multi_unregister();
+ multi_cleanup();
}
module_exit(multi_exit);
--
1.7.1

2010-06-02 13:02:58

by Xiaofan Chen

[permalink] [raw]
Subject: Re: [PATCHv3 07/11] USB: gadget: g_multi: added documentation and INF files

On Wed, Jun 2, 2010 at 8:45 PM, Michal Nazarewicz
<[email protected]> wrote:

> +**** Improvements in INF files
> +
> +It needs to be noted that we are not Windows driver experts and as
> +such we do not claim that provided INF files are flawless or that they
> +will work on each and every Windows versions (they were tested on
> +Windows XP SP3 only).
> +
> +The bottom line is, if you can improve the INF files, please do and
> +share the results[7]. :)

Seems to be very true. I think both INF files are very outdated. But
I am not familiar with RNDIS to comment on that one.

But the following INF file for serial is really outdated. For example,
it probably does not work under Vista/Win7. It also do not
support 64bit OS.

> diff --git a/Documentation/usb/gadget_multi_serial.inf b/Documentation/usb/gadget_multi_serial.inf
> new file mode 100644
> index 0000000..b04ace1
> --- /dev/null
> +++ b/Documentation/usb/gadget_multi_serial.inf
> @@ -0,0 +1,44 @@
> +[Version]
> +Signature="$Windows NT$"
> +Class=Ports
> +ClassGuid={4D36E978-E325-11CE-BFC1-08002BE10318}
> +Provider=%LINUX%
> +DriverVer=08/17/2004,0.0.2.1
> +; Copyright (C) 2004 Al Borchers ([email protected])
> +
> +[Manufacturer]
> +%LINUX%=GSerialDeviceList
> +
> +[GSerialDeviceList]
> +%GSERIAL%=GSerialInstall, USB\VID_0525&PID_A4AB&MI_02
> +
> +[DestinationDirs]
> +DefaultDestDir=10,System32\Drivers
> +
> +[GSerialInstall]
> +CopyFiles=GSerialCopyFiles
> +AddReg=GSerialAddReg
> +
> +[GSerialCopyFiles]
> +usbser.sys
> +
> +[GSerialAddReg]
> +HKR,,DevLoader,,*ntkern
> +HKR,,NTMPDriver,,usbser.sys
> +HKR,,EnumPropPages32,,"MsPorts.dll,SerialPortPropPageProvider"
> +
> +[GSerialInstall.Services]
> +AddService = usbser,0x0002,GSerialService
> +
> +[GSerialService]
> +DisplayName = %GSERIAL_DISPLAY_NAME%
> +ServiceType = 1 ? ? ? ? ? ? ? ? ?; SERVICE_KERNEL_DRIVER
> +StartType = 3 ? ? ? ? ? ? ? ? ? ?; SERVICE_DEMAND_START
> +ErrorControl = 1 ? ? ? ? ? ? ? ? ; SERVICE_ERROR_NORMAL
> +ServiceBinary = %10%\System32\Drivers\usbser.sys
> +LoadOrderGroup = Base
> +
> +[Strings]
> +LINUX = "Linux"
> +GSERIAL = "Serial Gadget/Linux Multifunction Gadget"
> +GSERIAL_DISPLAY_NAME = "Serial Gadget/Linux Multifunction Gadget"
> --

A proper example from Microchip (USB Stack V2.7).


; Windows USB CDC ACM Setup File
; Copyright (c) 2000 Microsoft Corporation
; Copyright (C) 2007 Microchip Technology Inc.

[Version]
Signature="$Windows NT$"
Class=Ports
ClassGuid={4D36E978-E325-11CE-BFC1-08002BE10318}
Provider=%MFGNAME%
LayoutFile=layout.inf
CatalogFile=%MFGFILENAME%.cat
DriverVer=11/15/2007,5.1.2600.0

[Manufacturer]
%MFGNAME%=DeviceList, NTamd64

[DestinationDirs]
DefaultDestDir=12


;------------------------------------------------------------------------------
; Windows 2000/XP/Vista-32bit Sections
;------------------------------------------------------------------------------

[DriverInstall.nt]
include=mdmcpq.inf
CopyFiles=DriverCopyFiles.nt
AddReg=DriverInstall.nt.AddReg

[DriverCopyFiles.nt]
usbser.sys,,,0x20

[DriverInstall.nt.AddReg]
HKR,,DevLoader,,*ntkern
HKR,,NTMPDriver,,%DRIVERFILENAME%.sys
HKR,,EnumPropPages32,,"MsPorts.dll,SerialPortPropPageProvider"

[DriverInstall.nt.Services]
AddService=usbser, 0x00000002, DriverService.nt

[DriverService.nt]
DisplayName=%SERVICE%
ServiceType=1
StartType=3
ErrorControl=1
ServiceBinary=%12%\%DRIVERFILENAME%.sys

;------------------------------------------------------------------------------
; Vista-64bit Sections
;------------------------------------------------------------------------------

[DriverInstall.NTamd64]
include=mdmcpq.inf
CopyFiles=DriverCopyFiles.NTamd64
AddReg=DriverInstall.NTamd64.AddReg

[DriverCopyFiles.NTamd64]
%DRIVERFILENAME%.sys,,,0x20

[DriverInstall.NTamd64.AddReg]
HKR,,DevLoader,,*ntkern
HKR,,NTMPDriver,,%DRIVERFILENAME%.sys
HKR,,EnumPropPages32,,"MsPorts.dll,SerialPortPropPageProvider"

[DriverInstall.NTamd64.Services]
AddService=usbser, 0x00000002, DriverService.NTamd64

[DriverService.NTamd64]
DisplayName=%SERVICE%
ServiceType=1
StartType=3
ErrorControl=1
ServiceBinary=%12%\%DRIVERFILENAME%.sys


;------------------------------------------------------------------------------
; Vendor and Product ID Definitions
;------------------------------------------------------------------------------
; When developing your USB device, the VID and PID used in the PC side
; application program and the firmware on the microcontroller must match.
; Modify the below line to use your VID and PID. Use the format as shown below.
; Note: One INF file can be used for multiple devices with different
VID and PIDs.
; For each supported device, append ",USB\VID_xxxx&PID_yyyy" to the
end of the line.
;------------------------------------------------------------------------------
[SourceDisksFiles]
[SourceDisksNames]
[DeviceList]
%DESCRIPTION%=DriverInstall, USB\VID_04D8&PID_000A

[DeviceList.NTamd64]
%DESCRIPTION%=DriverInstall, USB\VID_04D8&PID_000A


;------------------------------------------------------------------------------
; String Definitions
;------------------------------------------------------------------------------
;Modify these strings to customize your device
;------------------------------------------------------------------------------
[Strings]
MFGFILENAME="mchpcdc"
DRIVERFILENAME ="usbser"
MFGNAME="Microchip Technology, Inc."
INSTDISK="Microchip Technology, Inc. Installation Disc"
DESCRIPTION="Communications Port"
SERVICE="USB RS-232 Emulation Driver"




--
Xiaofan http://mcuee.blogspot.com

2010-06-02 13:15:38

by Xiaofan Chen

[permalink] [raw]
Subject: Re: [PATCHv3 07/11] USB: gadget: g_multi: added documentation and INF files

On Wed, Jun 2, 2010 at 9:02 PM, Xiaofan Chen <[email protected]> wrote:
> On Wed, Jun 2, 2010 at 8:45 PM, Michal Nazarewicz
> <[email protected]> wrote:
>
>> +**** Improvements in INF files
>> +
>> +It needs to be noted that we are not Windows driver experts and as
>> +such we do not claim that provided INF files are flawless or that they
>> +will work on each and every Windows versions (they were tested on
>> +Windows XP SP3 only).
>> +
>> +The bottom line is, if you can improve the INF files, please do and
>> +share the results[7]. :)
>
> Seems to be very true. I think both INF files are very outdated. But
> I am not familiar with RNDIS to comment on that one.
>

I can see that the INF file for the USB RNDIS still contains the
Win98SE/ME section, not so sure if you want to support them.

For later versions (XP and later), Microsoft has publish the
proper template.
http://msdn.microsoft.com/en-us/library/ff570620.aspx

--
Xiaofan http://mcuee.blogspot.com

2010-06-02 13:22:21

by Michal Nazarewicz

[permalink] [raw]
Subject: Re: [PATCHv3 07/11] USB: gadget: g_multi: added documentation and INF files

On Wed, 02 Jun 2010 15:02:54 +0200, Xiaofan Chen <[email protected]> wrote:
> Seems to be very true. I think both INF files are very outdated. But
> I am not familiar with RNDIS to comment on that one.
>
> But the following INF file for serial is really outdated. For example,
> it probably does not work under Vista/Win7. It also do not
> support 64bit OS.

Thanks for the comments, we're try to check those INFs as soon as possible.

--
Best regards, _ _
| Humble Liege of Serenely Enlightened Majesty of o' \,=./ `o
| Computer Science, Michał "mina86" Nazarewicz (o o)
+----[mina86*mina86.com]---[mina86*jabber.org]----ooO--(_)--Ooo--

2010-06-02 14:06:35

by Xiaofan Chen

[permalink] [raw]
Subject: Re: [PATCHv3 07/11] USB: gadget: g_multi: added documentation and INF files

On Wed, Jun 2, 2010 at 8:45 PM, Michal Nazarewicz
<[email protected]> wrote:

> +**** Customising the gadget
> +
> +If you intend to hack the g_multi gadget be advised that rearranging
> +functions will obviously change interface numbers for each of the
> +functionality. ?As an effect provided INFs won't work since they have
> +interface numbers hard-coded in them (it's not hard to change those
> +though).

Probably you can show an example of how to add the "&MI_mm"
to the VID/PID.

A good reference here:
http://www.cygnal.org/ubb/Forum9/HTML/001050.html

> +This also means, that after experimenting with g_multi and changing
> +provided functions one should change gadget's vendor and/or product ID
> +so there will be no collision with other customised gadgets or the
> +original gadget.
> +
> +Failing to comply may cause brain damage after wondering for hours why
> +things don't work as intended before realising Windows have cached
> +some drivers information (changing USB port may sometimes help).
> +

This is indeed quite true. However, you may not need to really change
the VID/PID (it will work but not necessary) if you use the nice
usbdeview utility to remove the phantom USB device.
http://www.nirsoft.net/utils/usb_devices_view.html



--
Xiaofan http://mcuee.blogspot.com

2010-06-02 15:45:44

by Michal Nazarewicz

[permalink] [raw]
Subject: Re: [PATCHv3 07/11] USB: gadget: g_multi: added documentation and INF files

On Wed, 02 Jun 2010 15:02:54 +0200, Xiaofan Chen <[email protected]> wrote:
> [Version]
> Signature="$Windows NT$"
> Class=Ports
> ClassGuid={4D36E978-E325-11CE-BFC1-08002BE10318}
> Provider=%MFGNAME%
> LayoutFile=layout.inf
> CatalogFile=%MFGFILENAME%.cat

So, what is this cat file for? I changed the IDs and the INF file started
working even though I expected that this file will be required. I'm wondering
is it because I have something installed on my Windows box that others may
miss?

And what's with the layout.inf.

--
Best regards, _ _
| Humble Liege of Serenely Enlightened Majesty of o' \,=./ `o
| Computer Science, Michał "mina86" Nazarewicz (o o)
+----[mina86*mina86.com]---[mina86*jabber.org]----ooO--(_)--Ooo--

2010-06-03 05:03:23

by Xiaofan Chen

[permalink] [raw]
Subject: Re: [PATCHv3 07/11] USB: gadget: g_multi: added documentation and INF files

2010/6/2 Michał Nazarewicz <[email protected]>:
> On Wed, 02 Jun 2010 15:02:54 +0200, Xiaofan Chen <[email protected]> wrote:
>>
>> [Version]
>> Signature="$Windows NT$"
>> Class=Ports
>> ClassGuid={4D36E978-E325-11CE-BFC1-08002BE10318}
>> Provider=%MFGNAME%
>> LayoutFile=layout.inf
>> CatalogFile=%MFGFILENAME%.cat
>
> So, what is this cat file for?  I changed the IDs and the INF file started
> working even though I expected that this file will be required.  I'm
> wondering is it because I have something installed on my Windows
> box that others may miss?

You do not need the cat file in this case. Microchip's Driver Package is
WHQLed, in that case, the cat file will have the necessary
digital certificate (Verisign Class 3 code signing certificate for WHQL).
You can also sign your driver package with other valid certificates
(GlobalSign) for KMCS requirement. In this case, the kernel driver
is already signed by Microsoft, you do not need the signed driver
package (cat file) to load the driver in 64bit Vista/Win7. But there
will be a warning (for 32bit/64bit XP/Vista/Win7). Once you pay
money and go through WHQL process, the warning will not be there.

In a word, that line can be deleted.

> And what's with the layout.inf.
Ah, I think that should not be there now. Only system provided
INF file should have that line (eg: mdmcpq.inf which is included
in the Microchip INF file). You can remove that line.

More information:
http://support.microsoft.com/kb/837637



--
Xiaofan http://mcuee.blogspot.com

2010-06-03 05:16:29

by Xiaofan Chen

[permalink] [raw]
Subject: Re: [PATCHv3 07/11] USB: gadget: g_multi: added documentation and INF files

2010/6/3 Xiaofan Chen <[email protected]>:
> 2010/6/2 Michał Nazarewicz <[email protected]>:
>> On Wed, 02 Jun 2010 15:02:54 +0200, Xiaofan Chen <[email protected]> wrote:
>>>
>>> [Version]
>>> Signature="$Windows NT$"
>>> Class=Ports
>>> ClassGuid={4D36E978-E325-11CE-BFC1-08002BE10318}
>>> Provider=%MFGNAME%
>>> LayoutFile=layout.inf
>>> CatalogFile=%MFGFILENAME%.cat
>>
>> So, what is this cat file for?  I changed the IDs and the INF file started
>> working even though I expected that this file will be required.  I'm
>> wondering is it because I have something installed on my Windows
>> box that others may miss?
>
> You do not need the cat file in this case. Microchip's Driver Package is
> WHQLed, in that case, the cat file will have the necessary
> digital certificate (Verisign Class 3 code signing certificate for WHQL).
> You can also sign your driver package with other valid certificates
> (GlobalSign) for KMCS requirement. In this case, the kernel driver
> is already signed by Microsoft, you do not need the signed driver
> package (cat file) to load the driver in 64bit Vista/Win7. But there
> will be a warning (for 32bit/64bit XP/Vista/Win7). Once you pay
> money and go through WHQL process, the warning will not be there.
>
> In a word, that line can be deleted.

Just hope the Linux USB developers will not be bored by this kind
of Windows specific information.

Here is the nice writeup by Microsoft about KMCS.
http://www.microsoft.com/whdc/driver/install/drvsign/kmcs-walkthrough.mspx

So if your employer (Samsung) or others is quite nice and submit the
driver package (the inf and cat file for CDC-ACM) for WHQL and got
approved, in the future, uses of the inf file will not see the red color
warning. This might be desired for corporate customers.

BTW, I am one of the admins of the open source libusb-win32 project.
Actually we want to get some donations to sign the kernel libusb0.sys
driver so that it can work under 64bit Vista/Win7. Therefore I came
to know a bit of the things.

>> And what's with the layout.inf.
> Ah, I think that should not be there now. Only system provided
> INF file should have that line (eg: mdmcpq.inf which is included
> in the INF file). You can remove that line.
>
> More information:
> http://support.microsoft.com/kb/837637
>



--
Xiaofan http://mcuee.blogspot.com

2010-06-03 09:02:45

by Michal Nazarewicz

[permalink] [raw]
Subject: Re: [PATCHv3 07/11] USB: gadget: g_multi: added documentation and INF files

>>> On Wed, 02 Jun 2010 15:02:54 +0200, Xiaofan Chen <[email protected]> wrote:
>>>> LayoutFile=layout.inf
>>>> CatalogFile=%MFGFILENAME%.cat

>> 2010/6/2 Michał Nazarewicz <[email protected]>:
>>> So, what is this cat file for?

> 2010/6/3 Xiaofan Chen <[email protected]>:
>> In a word, that line can be deleted.

In that case, I'll try to test the new INF files on various Windows
versions and will probably send updated patchset to the list.

Xiaofan Chen <[email protected]> writes:
> Just hope the Linux USB developers will not be bored by this kind
> of Windows specific information.

Someone has to do that. If there's someone who knows that stuff it'll
be a sin not to use his expertise. :)

> Here is the nice writeup by Microsoft about KMCS.
> http://www.microsoft.com/whdc/driver/install/drvsign/kmcs-walkthrough.mspx

Wow... Honestly, 56 pages? They sure know how to make "openssl dgst
-sign" complicated...

I'll have to put that on my TODO list thought it may take some time till
I get to singing drivers.

> So if your employer (Samsung) or others is quite nice and submit the
> driver package (the inf and cat file for CDC-ACM) for WHQL and got
> approved, in the future, uses of the inf file will not see the red color
> warning. This might be desired for corporate customers.

I *personally* see how it may be a problem for _any_ corporation since
singing is like saying "yes, we guarantee it won't destroy your computer
nor it will summon demons" and by releasing signed driver you in effect
loose control over it. Again, further signature investigations are on
my TODO list.

--
Best regards, _ _
.o. | Liege of Serenly Enlightened Majesty of o' \,=./ `o
..o | Computer Science, Michal "mina86" Nazarewicz (o o)
ooo +--<mina86-tlen.pl>--<jid:mina86-jabber.org>--ooO--(_)--Ooo--


Attachments:
(No filename) (197.00 B)

2010-06-03 10:32:13

by Xiaofan Chen

[permalink] [raw]
Subject: Re: [PATCHv3 07/11] USB: gadget: g_multi: added documentation and INF files

On Thu, Jun 3, 2010 at 5:02 PM, Michal Nazarewicz <[email protected]> wrote:
>> So if your employer (Samsung) or others is quite nice and submit the
>> driver package (the inf and cat file for CDC-ACM) for WHQL and got
>> approved, in the future, users of the inf file will not see the red color
>> warning. This might be desired for corporate customers.
>
> I *personally* see how it may be a problem for _any_ corporation since
> singing is like saying "yes, we guarantee it won't destroy your computer
> nor it will summon demons" and by releasing signed driver you in effect
> loose control over it. ?Again, further signature investigations are on
> my TODO list.
>

As I mentioned before, WHQL submission is not necessary for
drivers using usbser.sys. It will work under 32bit/64bit Windows.
The warning just scares some innocent customers.

You do not need the catalog file here. Those vendors who likes to get
the WHQL can pay the money to get it (for their particular VID/PID).

For drivers like libusb-win32 (libusb0.sys), it is a big problem since
you can not load it under 64bit Vista/Win7. libusb-win32 is quite
nice project to port Linux libusb based application to Windows.
So we in the libusb-win32 project plan to get the money through
donation to buy the digital certificate so that it can work under
64bit Vista/Win7 and users can load it (with the red warning
since the driver package are not signed with the digital
certificate, inf file is part of the driver package). Corporate
users of libusb-win32 (eg: Atmel) can choose to go for WHQL so that
their users will not see the red warning.
(ref: http://sourceforge.net/news/?group_id=78138 )

usbser.sys is already signed by Microsoft, so you will not
face such issue. Same thing for the drivers of USB RNDIS.

--
Xiaofan http://mcuee.blogspot.com