[U-Boot,3/4] usb:gadget: USB Mass Storage Gadget support

From: Lukasz Majewski <l.majewski@samsung.com>

This patch adds the USB Mass Storage Gadget to u-boot
New command called "ums" is implemented to provide access
to on-device embedded persistent memory.

USB Mass Storage is supposed to work on top of the USB
Gadget framework

Signed-off-by: Lukasz Majewski <l.majewski@samsung.com>
Signed-off-by: Piotr Wilczek <p.wilczek@samsung.com>
Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com>
CC: Marek Vasut <marek.vasut@gmail.com>
---
 common/Makefile               |    1 +
 common/cmd_usb_mass_storage.c |   85 +++++++++++++++++++++++++++++++++++++++++
 drivers/usb/gadget/g_dnl.c    |    6 +++
 include/usb_mass_storage.h    |   59 ++++++++++++++++++++++++++++
 4 files changed, 151 insertions(+)
 create mode 100644 common/cmd_usb_mass_storage.c
 create mode 100644 include/usb_mass_storage.h

Dear Piotr Wilczek,

> From: Lukasz Majewski <l.majewski@samsung.com>
> 
> This patch adds the USB Mass Storage Gadget to u-boot
> New command called "ums" is implemented to provide access
> to on-device embedded persistent memory.
> 
> USB Mass Storage is supposed to work on top of the USB
> Gadget framework
> 
> Signed-off-by: Lukasz Majewski <l.majewski@samsung.com>
> Signed-off-by: Piotr Wilczek <p.wilczek@samsung.com>
> Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com>
> CC: Marek Vasut <marek.vasut@gmail.com>
> ---
>  common/Makefile               |    1 +
>  common/cmd_usb_mass_storage.c |   85
> +++++++++++++++++++++++++++++++++++++++++ drivers/usb/gadget/g_dnl.c    | 
>   6 +++
>  include/usb_mass_storage.h    |   59 ++++++++++++++++++++++++++++
>  4 files changed, 151 insertions(+)
>  create mode 100644 common/cmd_usb_mass_storage.c
>  create mode 100644 include/usb_mass_storage.h
> 
> diff --git a/common/Makefile b/common/Makefile
> index 54fcc81..8ec95d2 100644
> --- a/common/Makefile
> +++ b/common/Makefile
> @@ -174,6 +174,7 @@ COBJS-y += cmd_usb.o
>  COBJS-y += usb.o usb_hub.o
>  COBJS-$(CONFIG_USB_STORAGE) += usb_storage.o
>  endif
> +COBJS-$(CONFIG_CMD_USB_MASS_STORAGE) += cmd_usb_mass_storage.o
>  COBJS-$(CONFIG_CMD_XIMG) += cmd_ximg.o
>  COBJS-$(CONFIG_YAFFS2) += cmd_yaffs2.o
>  COBJS-$(CONFIG_CMD_SPL) += cmd_spl.o
> diff --git a/common/cmd_usb_mass_storage.c b/common/cmd_usb_mass_storage.c
> new file mode 100644
> index 0000000..bc5b239
> --- /dev/null
> +++ b/common/cmd_usb_mass_storage.c
> @@ -0,0 +1,85 @@
> +/*
> + * Copyright (C) 2011 Samsung Electronics
> + * Lukasz Majewski <l.majewski@samsung.com>
> + *
> + * This program is free software; you can redistribute it and/or
> + * modify it under the terms of the GNU General Public License as
> + * published by the Free Software Foundation; either version 2 of
> + * the License, or (at your option) any later version.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> + * GNU General Public License for more details.
> + *
> + * You should have received a copy of the GNU General Public License
> + * along with this program; if not, write to the Free Software
> + * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> + * MA 02111-1307 USA
> + */
> +
> +#include <errno.h>
> +#include <common.h>
> +#include <command.h>
> +#include <g_dnl.h>
> +#include <usb_mass_storage.h>
> +
> +int do_usb_mass_storage(cmd_tbl_t *cmdtp, int flag,
> +			       int argc, char * const argv[])
> +{
> +	char *ep;
> +	unsigned int dev_num = 0, offset = 0, part_size = 0;
> +	int rc;
> +
> +	struct ums_board_info *ums_info;
> +	static char *s = "ums";
> +
> +	if (argc < 2) {
> +		printf("usage: ums <dev> - e.g. ums 0\n");
> +		return 0;
> +	}
> +
> +	dev_num = (int)simple_strtoul(argv[1], &ep, 16);
> +
> +	if (dev_num) {
> +		puts("\nSet eMMC device to 0! - e.g. ums 0\n");
> +		goto fail;
> +	}
> +
> +	board_usb_init();
> +	ums_info = board_ums_init(dev_num, offset, part_size);
> +
> +	if (!ums_info) {
> +		printf("MMC: %d -> NOT available\n", dev_num);
> +		goto fail;
> +	}
> +	rc = fsg_init(ums_info);
> +	if (rc) {
> +		printf("cmd ums: fsg_init failed\n");
> +		goto fail;
> +	}
> +
> +	g_dnl_register(s);
> +
> +	while (1) {
> +		/* Handle control-c and timeouts */
> +		if (ctrlc()) {
> +			printf("The remote end did not respond in time.\n");
> +			goto exit;
> +		}
> +		usb_gadget_handle_interrupts();
> +		/* Check if USB cable has been detached */
> +		if (fsg_main_thread(NULL) == EIO)
> +			goto exit;
> +	}
> +exit:
> +	g_dnl_unregister();
> +
> +fail:
> +	return -1;
> +}
> +
> +U_BOOT_CMD(ums, CONFIG_SYS_MAXARGS, 1, do_usb_mass_storage,
> +	"Use the UMS [User Mass Storage]",
> +	"ums - User Mass Storage Gadget"
> +);
> diff --git a/drivers/usb/gadget/g_dnl.c b/drivers/usb/gadget/g_dnl.c
> index a5a4c1f..cc3f344 100644
> --- a/drivers/usb/gadget/g_dnl.c
> +++ b/drivers/usb/gadget/g_dnl.c
> @@ -31,6 +31,7 @@
> 
>  #include "gadget_chips.h"
>  #include "composite.c"
> +#include "f_mass_storage.c"
> 
>  /*
>   * One needs to define the following:
> @@ -104,6 +105,8 @@ static int g_dnl_do_config(struct usb_configuration *c)
>  	printf("GADGET DRIVER: %s\n", s);
>  	if (!strcmp(s, "usb_dnl_dfu"))
>  		ret = dfu_add(c);
> +	else if (!strcmp(s, "usb_dnl_ums"))
> +		ret = fsg_add(c);
> 
>  	return ret;
>  }
> @@ -188,6 +191,9 @@ int g_dnl_register(const char *type)
>  	if (!strcmp(type, "dfu")) {
>  		strcpy(name, shortname);
>  		strcat(name, type);
> +	} else if (!strcmp(type, "ums")) {
> +		strcpy(name, shortname);
> +		strcat(name, type);
>  	} else {
>  		printf("%s: unknown command: %s\n", __func__, type);
>  		return -EINVAL;
> diff --git a/include/usb_mass_storage.h b/include/usb_mass_storage.h
> new file mode 100644
> index 0000000..00c893c
> --- /dev/null
> +++ b/include/usb_mass_storage.h
> @@ -0,0 +1,59 @@
> +/*
> + * Copyright (C) 2011 Samsung Electrnoics
> + * Lukasz Majewski <l.majewski@samsung.com>
> + *
> + * This program is free software; you can redistribute it and/or
> + * modify it under the terms of the GNU General Public License as
> + * published by the Free Software Foundation; either version 2 of
> + * the License, or (at your option) any later version.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> + * GNU General Public License for more details.
> + *
> + * You should have received a copy of the GNU General Public License
> + * aloong with this program; if not, write to the Free Software
> + * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> + * MA 02111-1307 USA
> + */
> +
> +#ifndef __USB_MASS_STORAGE_H__
> +#define __USB_MASS_STORAGE_H__
> +
> +#define SECTOR_SIZE		0x200
> +
> +#include <mmc.h>
> +
> +struct ums_device {
> +	struct mmc *mmc;
> +	int dev_num;
> +	int offset;
> +	int part_size;
> +};
> +
> +struct ums_board_info {
> +	int (*read_sector)(struct ums_device *ums_dev,
> +			   ulong start, lbaint_t blkcnt, void *buf);
> +	int (*write_sector)(struct ums_device *ums_dev,
> +			    ulong start, lbaint_t blkcnt, const void *buf);
> +	void (*get_capacity)(struct ums_device *ums_dev,
> +			     long long int *capacity);
> +	const char *name;
> +	struct ums_device ums_dev;
> +};
> +
> +extern void board_usb_init(void);
> +
> +extern int fsg_init(struct ums_board_info *);
> +extern void fsg_cleanup(void);
> +extern struct ums_board_info *board_ums_init(unsigned int,
> +					     unsigned int, unsigned int);
> +extern int usb_gadget_handle_interrupts(void);
> +extern int fsg_main_thread(void *);
> +
> +/* USB Attach/Detach */
> +extern int micro_usb_attached(void);
> +extern int micro_usb_detach(void);

Does this "extern" in header file have any impact?

> +#endif /* __USB_MASS_STORAGE_H__ */

Dear Marek Vasut,


> -----Original Message-----
> From: Marek Vasut [mailto:marex@denx.de]
> Sent: Thursday, January 24, 2013 1:35 PM
> To: Piotr Wilczek
> Cc: u-boot@lists.denx.de; Minkyu Kang; Kyungmin Park; Lukasz Majewski;
> Tom Rini
> Subject: Re: [PATCH 3/4] usb:gadget: USB Mass Storage Gadget support
> 
> Dear Piotr Wilczek,
> 
> > From: Lukasz Majewski <l.majewski@samsung.com>
> >
> > This patch adds the USB Mass Storage Gadget to u-boot New command
> > called "ums" is implemented to provide access to on-device embedded
> > persistent memory.
> >
> > USB Mass Storage is supposed to work on top of the USB Gadget
> > framework
> >
> > Signed-off-by: Lukasz Majewski <l.majewski@samsung.com>
> > Signed-off-by: Piotr Wilczek <p.wilczek@samsung.com>
> > Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com>
> > CC: Marek Vasut <marek.vasut@gmail.com>
> > ---
> >  common/Makefile               |    1 +
> >  common/cmd_usb_mass_storage.c |   85
> > +++++++++++++++++++++++++++++++++++++++++ drivers/usb/gadget/g_dnl.c
> |
> >   6 +++
> >  include/usb_mass_storage.h    |   59 ++++++++++++++++++++++++++++
> >  4 files changed, 151 insertions(+)
> >  create mode 100644 common/cmd_usb_mass_storage.c  create mode 100644
> > include/usb_mass_storage.h
> >
> > diff --git a/common/Makefile b/common/Makefile index 54fcc81..8ec95d2
> > 100644
> > --- a/common/Makefile
> > +++ b/common/Makefile
> > @@ -174,6 +174,7 @@ COBJS-y += cmd_usb.o  COBJS-y += usb.o usb_hub.o
> >  COBJS-$(CONFIG_USB_STORAGE) += usb_storage.o  endif
> > +COBJS-$(CONFIG_CMD_USB_MASS_STORAGE) += cmd_usb_mass_storage.o
> >  COBJS-$(CONFIG_CMD_XIMG) += cmd_ximg.o
> >  COBJS-$(CONFIG_YAFFS2) += cmd_yaffs2.o
> >  COBJS-$(CONFIG_CMD_SPL) += cmd_spl.o
> > diff --git a/common/cmd_usb_mass_storage.c
> > b/common/cmd_usb_mass_storage.c new file mode 100644 index
> > 0000000..bc5b239
> > --- /dev/null
> > +++ b/common/cmd_usb_mass_storage.c
> > @@ -0,0 +1,85 @@
> > +/*
> > + * Copyright (C) 2011 Samsung Electronics
> > + * Lukasz Majewski <l.majewski@samsung.com>
> > + *
> > + * This program is free software; you can redistribute it and/or
> > + * modify it under the terms of the GNU General Public License as
> > + * published by the Free Software Foundation; either version 2 of
> > + * the License, or (at your option) any later version.
> > + *
> > + * This program is distributed in the hope that it will be useful,
> > + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> > + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> > + * GNU General Public License for more details.
> > + *
> > + * You should have received a copy of the GNU General Public License
> > + * along with this program; if not, write to the Free Software
> > + * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> > + * MA 02111-1307 USA
> > + */
> > +
> > +#include <errno.h>
> > +#include <common.h>
> > +#include <command.h>
> > +#include <g_dnl.h>
> > +#include <usb_mass_storage.h>
> > +
> > +int do_usb_mass_storage(cmd_tbl_t *cmdtp, int flag,
> > +			       int argc, char * const argv[]) {
> > +	char *ep;
> > +	unsigned int dev_num = 0, offset = 0, part_size = 0;
> > +	int rc;
> > +
> > +	struct ums_board_info *ums_info;
> > +	static char *s = "ums";
> > +
> > +	if (argc < 2) {
> > +		printf("usage: ums <dev> - e.g. ums 0\n");
> > +		return 0;
> > +	}
> > +
> > +	dev_num = (int)simple_strtoul(argv[1], &ep, 16);
> > +
> > +	if (dev_num) {
> > +		puts("\nSet eMMC device to 0! - e.g. ums 0\n");
> > +		goto fail;
> > +	}
> > +
> > +	board_usb_init();
> > +	ums_info = board_ums_init(dev_num, offset, part_size);
> > +
> > +	if (!ums_info) {
> > +		printf("MMC: %d -> NOT available\n", dev_num);
> > +		goto fail;
> > +	}
> > +	rc = fsg_init(ums_info);
> > +	if (rc) {
> > +		printf("cmd ums: fsg_init failed\n");
> > +		goto fail;
> > +	}
> > +
> > +	g_dnl_register(s);
> > +
> > +	while (1) {
> > +		/* Handle control-c and timeouts */
> > +		if (ctrlc()) {
> > +			printf("The remote end did not respond in time.\n");
> > +			goto exit;
> > +		}
> > +		usb_gadget_handle_interrupts();
> > +		/* Check if USB cable has been detached */
> > +		if (fsg_main_thread(NULL) == EIO)
> > +			goto exit;
> > +	}
> > +exit:
> > +	g_dnl_unregister();
> > +
> > +fail:
> > +	return -1;
> > +}
> > +
> > +U_BOOT_CMD(ums, CONFIG_SYS_MAXARGS, 1, do_usb_mass_storage,
> > +	"Use the UMS [User Mass Storage]",
> > +	"ums - User Mass Storage Gadget"
> > +);
> > diff --git a/drivers/usb/gadget/g_dnl.c b/drivers/usb/gadget/g_dnl.c
> > index a5a4c1f..cc3f344 100644
> > --- a/drivers/usb/gadget/g_dnl.c
> > +++ b/drivers/usb/gadget/g_dnl.c
> > @@ -31,6 +31,7 @@
> >
> >  #include "gadget_chips.h"
> >  #include "composite.c"
> > +#include "f_mass_storage.c"
> >
> >  /*
> >   * One needs to define the following:
> > @@ -104,6 +105,8 @@ static int g_dnl_do_config(struct
> usb_configuration *c)
> >  	printf("GADGET DRIVER: %s\n", s);
> >  	if (!strcmp(s, "usb_dnl_dfu"))
> >  		ret = dfu_add(c);
> > +	else if (!strcmp(s, "usb_dnl_ums"))
> > +		ret = fsg_add(c);
> >
> >  	return ret;
> >  }
> > @@ -188,6 +191,9 @@ int g_dnl_register(const char *type)
> >  	if (!strcmp(type, "dfu")) {
> >  		strcpy(name, shortname);
> >  		strcat(name, type);
> > +	} else if (!strcmp(type, "ums")) {
> > +		strcpy(name, shortname);
> > +		strcat(name, type);
> >  	} else {
> >  		printf("%s: unknown command: %s\n", __func__, type);
> >  		return -EINVAL;
> > diff --git a/include/usb_mass_storage.h b/include/usb_mass_storage.h
> > new file mode 100644 index 0000000..00c893c
> > --- /dev/null
> > +++ b/include/usb_mass_storage.h
> > @@ -0,0 +1,59 @@
> > +/*
> > + * Copyright (C) 2011 Samsung Electrnoics
> > + * Lukasz Majewski <l.majewski@samsung.com>
> > + *
> > + * This program is free software; you can redistribute it and/or
> > + * modify it under the terms of the GNU General Public License as
> > + * published by the Free Software Foundation; either version 2 of
> > + * the License, or (at your option) any later version.
> > + *
> > + * This program is distributed in the hope that it will be useful,
> > + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> > + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> > + * GNU General Public License for more details.
> > + *
> > + * You should have received a copy of the GNU General Public License
> > + * aloong with this program; if not, write to the Free Software
> > + * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> > + * MA 02111-1307 USA
> > + */
> > +
> > +#ifndef __USB_MASS_STORAGE_H__
> > +#define __USB_MASS_STORAGE_H__
> > +
> > +#define SECTOR_SIZE		0x200
> > +
> > +#include <mmc.h>
> > +
> > +struct ums_device {
> > +	struct mmc *mmc;
> > +	int dev_num;
> > +	int offset;
> > +	int part_size;
> > +};
> > +
> > +struct ums_board_info {
> > +	int (*read_sector)(struct ums_device *ums_dev,
> > +			   ulong start, lbaint_t blkcnt, void *buf);
> > +	int (*write_sector)(struct ums_device *ums_dev,
> > +			    ulong start, lbaint_t blkcnt, const void *buf);
> > +	void (*get_capacity)(struct ums_device *ums_dev,
> > +			     long long int *capacity);
> > +	const char *name;
> > +	struct ums_device ums_dev;
> > +};
> > +
> > +extern void board_usb_init(void);
> > +
> > +extern int fsg_init(struct ums_board_info *); extern void
> > +fsg_cleanup(void); extern struct ums_board_info
> > +*board_ums_init(unsigned int,
> > +					     unsigned int, unsigned int);
extern
> int
> > +usb_gadget_handle_interrupts(void);
> > +extern int fsg_main_thread(void *);
> > +
> > +/* USB Attach/Detach */
> > +extern int micro_usb_attached(void);
> > +extern int micro_usb_detach(void);
> 
> Does this "extern" in header file have any impact?
> 
Both externs should be removed.

> > +#endif /* __USB_MASS_STORAGE_H__ */

Best Regards,
Piotr Wilczek

---
Samsung R&D Poland (SRPOL) | Linux Platform Group