[PATCH v2 1/2] file_list: implement file_list_add_cdev_entry

[PATCH v2 1/2] file_list: implement file_list_add_cdev_entry

[Ahmad Fatoum]

Follow-up commit will add a first user that wants to add a cdev
and more may follow, so let's provide a common
file_list_add_cdev_entry they can call.

The benefit of doing that in common/file-list.c is that we can avoid
an extra allocation for prefixing /dev.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
v1 -> 2:
  - slightly reworded commit message to align it with 2nd commit
---
 common/file-list.c  | 21 +++++++++++++++++----
 include/file-list.h |  5 +++++
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/common/file-list.c b/common/file-list.c
index 1dc7cd8266b1..5c7020111145 100644
--- a/common/file-list.c
+++ b/common/file-list.c
@@ -26,8 +26,8 @@ struct file_list_entry *file_list_entry_by_name(struct file_list *files, const c
 	return NULL;
 }
 
-int file_list_add_entry(struct file_list *files, const char *name, const char *filename,
-			unsigned long flags)
+static int __file_list_add_entry(struct file_list *files, char *name, char *filename,
+				 unsigned long flags)
 {
 	struct file_list_entry *entry;
 
@@ -37,8 +37,8 @@ int file_list_add_entry(struct file_list *files, const char *name, const char *f
 
 	entry = xzalloc(sizeof(*entry));
 
-	entry->name = xstrdup(name);
-	entry->filename = xstrdup(filename);
+	entry->name = name;
+	entry->filename = filename;
 	entry->flags = flags;
 
 	list_add_tail(&entry->list, &files->list);
@@ -46,6 +46,19 @@ int file_list_add_entry(struct file_list *files, const char *name, const char *f
 	return 0;
 }
 
+int file_list_add_entry(struct file_list *files, const char *name, const char *filename,
+			unsigned long flags)
+{
+	return __file_list_add_entry(files, xstrdup(name), xstrdup(filename), flags);
+}
+
+int file_list_add_cdev_entry(struct file_list *files, struct cdev *cdev,
+			     unsigned long flags)
+{
+	return __file_list_add_entry(files, xstrdup(cdev->name),
+				     xasprintf("/dev/%s", cdev->name), flags);
+}
+
 static int file_list_parse_one(struct file_list *files, const char *partstr, const char **endstr)
 {
 	int i = 0, state = PARSE_DEVICE;
diff --git a/include/file-list.h b/include/file-list.h
index 2b2003971f32..79190b0f191d 100644
--- a/include/file-list.h
+++ b/include/file-list.h
@@ -4,6 +4,8 @@
 
 #include <linux/list.h>
 
+struct cdev;
+
 #define FILE_LIST_FLAG_SAFE	(1 << 0)
 #define FILE_LIST_FLAG_READBACK	(1 << 1)
 #define FILE_LIST_FLAG_CREATE	(1 << 2)
@@ -30,6 +32,9 @@ void file_list_free(struct file_list *);
 int file_list_add_entry(struct file_list *files, const char *name, const char *filename,
 			unsigned long flags);
 
+int file_list_add_cdev_entry(struct file_list *files, struct cdev *cdev,
+			     unsigned long flags);
+
 struct file_list *file_list_new(void);
 struct file_list *file_list_dup(struct file_list *old);
 
-- 
2.39.2

[PATCH v2 2/2] file-list: support special 'auto', 'block' specifiers

[Ahmad Fatoum]

Best practice is for each board to populate $global.system.partitions
or $global.fastboot.partitions with a string exporting its flashable
devices in a descriptive manner, e.g. "/dev/mmc0(eMMC),/dev/mmc1(SD)".

This often goes into BSPs though, so upstream boards are left without
default partitions, making use a bit cumbersome. Make this easier
by providing three new magic specifiers:

  - block: exports all registered block devices (e.g. eMMC and SD)
  - auto:  currently equivalent to "block". May be extended
           to EEPROMs, raw MTD and UBI in future

This makes it easy to export devices on any board:

  usbgadget -A auto -b

or

  usbgadget -S auto,/tmp/fitimage(fitimage)c

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
v1 -> 2:
  - dropped nvmem specifier (Sascha). Can add it back later
    limited to only EEPROMs
  - reordered code in file_list_handle_spec to make future extension
    easier (Sascha)
---
 Documentation/user/usb.rst | 16 ++++++++++++++++
 common/block.c             | 16 ++++++++++++++++
 common/file-list.c         | 24 ++++++++++++++++++++++--
 include/block.h            |  6 ++++++
 4 files changed, 60 insertions(+), 2 deletions(-)

diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
index f2f57ead98d4..eaee342956f9 100644
--- a/Documentation/user/usb.rst
+++ b/Documentation/user/usb.rst
@@ -73,6 +73,22 @@ Example:
 
   /dev/nand0.barebox.bb(barebox)sr,/kernel(kernel)rc
 
+Board code authors are encouraged to provide a default environment containing
+partitions with descriptive names. For boards where this is not specified,
+there exist a number of **partition** specifiers for automatically generating entries:
+
+* ``block`` exports all registered block devices (e.g. eMMC and SD)
+* ``auto``  currently equivalent to ``block``. May be extended to other flashable
+            devices, like EEPROMs, MTD or UBI volumes in future
+
+Example usage of exporting registered block devices, barebox update
+handlers and a single file that is created on flashing:
+
+.. code-block:: sh
+
+     detect -a # optional. Detects everything, so auto can register it
+     usbgadget -A auto,/tmp/fitimage(fitimage)c -b
+
 DFU
 ^^^
 
diff --git a/common/block.c b/common/block.c
index f6eeb7f9c85f..3a4a9fb73149 100644
--- a/common/block.c
+++ b/common/block.c
@@ -11,6 +11,7 @@
 #include <linux/err.h>
 #include <linux/list.h>
 #include <dma.h>
+#include <file-list.h>
 
 #define BLOCKSIZE(blk)	(1 << blk->blockbits)
 
@@ -458,3 +459,18 @@ int block_write(struct block_device *blk, void *buf, sector_t block, blkcnt_t nu
 
 	return ret < 0 ? ret : 0;
 }
+
+unsigned file_list_add_blockdevs(struct file_list *files)
+{
+	struct block_device *blk;
+	unsigned count = 0;
+	int err;
+
+	list_for_each_entry(blk, &block_device_list, list) {
+		err = file_list_add_cdev_entry(files, &blk->cdev, 0);
+		if (!err)
+			count++;
+	}
+
+	return count;
+}
diff --git a/common/file-list.c b/common/file-list.c
index 5c7020111145..7ecc8d00bb9e 100644
--- a/common/file-list.c
+++ b/common/file-list.c
@@ -9,6 +9,7 @@
 #include <stringlist.h>
 #include <linux/err.h>
 #include <driver.h>
+#include <block.h>
 
 #define PARSE_DEVICE	0
 #define PARSE_NAME	1
@@ -59,12 +60,28 @@ int file_list_add_cdev_entry(struct file_list *files, struct cdev *cdev,
 				     xasprintf("/dev/%s", cdev->name), flags);
 }
 
+static bool file_list_handle_spec(struct file_list *files, const char *spec)
+{
+	unsigned count = 0;
+	bool autoadd;
+
+	autoadd = !strcmp(spec, "auto");
+	if (autoadd || !strcmp(spec, "block"))
+		count += file_list_add_blockdevs(files);
+	else
+		return false;
+
+	pr_debug("'%s' spcifier resulted in %u entries\n", spec, count);
+	return true;
+}
+
 static int file_list_parse_one(struct file_list *files, const char *partstr, const char **endstr)
 {
 	int i = 0, state = PARSE_DEVICE;
 	char filename[PATH_MAX];
 	char name[PATH_MAX];
 	unsigned long flags = 0;
+	bool special = false;
 
 	memset(filename, 0, sizeof(filename));
 	memset(name, 0, sizeof(name));
@@ -115,7 +132,10 @@ static int file_list_parse_one(struct file_list *files, const char *partstr, con
 		partstr++;
 	}
 
-	if (state != PARSE_FLAGS) {
+	if (state == PARSE_DEVICE)
+		special = file_list_handle_spec(files, filename);
+
+	if (!special && state != PARSE_FLAGS) {
 		pr_err("Missing ')'\n");
 		return -EINVAL;
 	}
@@ -124,7 +144,7 @@ static int file_list_parse_one(struct file_list *files, const char *partstr, con
 		partstr++;
 	*endstr = partstr;
 
-	return file_list_add_entry(files, name, filename, flags);
+	return special ? 0 : file_list_add_entry(files, name, filename, flags);
 }
 
 static const char *flags_to_str(int flags)
diff --git a/include/block.h b/include/block.h
index da258f509b41..44037bd74c61 100644
--- a/include/block.h
+++ b/include/block.h
@@ -7,6 +7,7 @@
 #include <linux/types.h>
 
 struct block_device;
+struct file_list;
 
 struct block_device_ops {
 	int (*read)(struct block_device *, void *buf, sector_t block, blkcnt_t num_blocks);
@@ -51,11 +52,16 @@ static inline int block_flush(struct block_device *blk)
 
 #ifdef CONFIG_BLOCK
 struct block_device *cdev_get_block_device(const struct cdev *cdev);
+unsigned file_list_add_blockdevs(struct file_list *files);
 #else
 static inline struct block_device *cdev_get_block_device(const struct cdev *cdev)
 {
 	return NULL;
 }
+static inline unsigned file_list_add_blockdevs(struct file_list *files)
+{
+	return 0;
+}
 #endif
 
 static inline bool cdev_is_block_device(const struct cdev *cdev)
-- 
2.39.2

Re: [PATCH v2 2/2] file-list: support special 'auto', 'block' specifiers

[Ahmad Fatoum]

On 09.06.23 09:52, Ahmad Fatoum wrote:
> Best practice is for each board to populate $global.system.partitions
> or $global.fastboot.partitions with a string exporting its flashable
> devices in a descriptive manner, e.g. "/dev/mmc0(eMMC),/dev/mmc1(SD)".
> 
> This often goes into BSPs though, so upstream boards are left without
> default partitions, making use a bit cumbersome. Make this easier
> by providing three new magic specifiers:

Typo: s/three/two/

> 
>   - block: exports all registered block devices (e.g. eMMC and SD)
>   - auto:  currently equivalent to "block". May be extended
>            to EEPROMs, raw MTD and UBI in future
> 
> This makes it easy to export devices on any board:
> 
>   usbgadget -A auto -b
> 
> or
> 
>   usbgadget -S auto,/tmp/fitimage(fitimage)c
> 
> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
> ---
> v1 -> 2:
>   - dropped nvmem specifier (Sascha). Can add it back later
>     limited to only EEPROMs
>   - reordered code in file_list_handle_spec to make future extension
>     easier (Sascha)
> ---
>  Documentation/user/usb.rst | 16 ++++++++++++++++
>  common/block.c             | 16 ++++++++++++++++
>  common/file-list.c         | 24 ++++++++++++++++++++++--
>  include/block.h            |  6 ++++++
>  4 files changed, 60 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
> index f2f57ead98d4..eaee342956f9 100644
> --- a/Documentation/user/usb.rst
> +++ b/Documentation/user/usb.rst
> @@ -73,6 +73,22 @@ Example:
>  
>    /dev/nand0.barebox.bb(barebox)sr,/kernel(kernel)rc
>  
> +Board code authors are encouraged to provide a default environment containing
> +partitions with descriptive names. For boards where this is not specified,
> +there exist a number of **partition** specifiers for automatically generating entries:
> +
> +* ``block`` exports all registered block devices (e.g. eMMC and SD)
> +* ``auto``  currently equivalent to ``block``. May be extended to other flashable
> +            devices, like EEPROMs, MTD or UBI volumes in future
> +
> +Example usage of exporting registered block devices, barebox update
> +handlers and a single file that is created on flashing:
> +
> +.. code-block:: sh
> +
> +     detect -a # optional. Detects everything, so auto can register it
> +     usbgadget -A auto,/tmp/fitimage(fitimage)c -b
> +
>  DFU
>  ^^^
>  
> diff --git a/common/block.c b/common/block.c
> index f6eeb7f9c85f..3a4a9fb73149 100644
> --- a/common/block.c
> +++ b/common/block.c
> @@ -11,6 +11,7 @@
>  #include <linux/err.h>
>  #include <linux/list.h>
>  #include <dma.h>
> +#include <file-list.h>
>  
>  #define BLOCKSIZE(blk)	(1 << blk->blockbits)
>  
> @@ -458,3 +459,18 @@ int block_write(struct block_device *blk, void *buf, sector_t block, blkcnt_t nu
>  
>  	return ret < 0 ? ret : 0;
>  }
> +
> +unsigned file_list_add_blockdevs(struct file_list *files)
> +{
> +	struct block_device *blk;
> +	unsigned count = 0;
> +	int err;
> +
> +	list_for_each_entry(blk, &block_device_list, list) {
> +		err = file_list_add_cdev_entry(files, &blk->cdev, 0);
> +		if (!err)
> +			count++;
> +	}
> +
> +	return count;
> +}
> diff --git a/common/file-list.c b/common/file-list.c
> index 5c7020111145..7ecc8d00bb9e 100644
> --- a/common/file-list.c
> +++ b/common/file-list.c
> @@ -9,6 +9,7 @@
>  #include <stringlist.h>
>  #include <linux/err.h>
>  #include <driver.h>
> +#include <block.h>
>  
>  #define PARSE_DEVICE	0
>  #define PARSE_NAME	1
> @@ -59,12 +60,28 @@ int file_list_add_cdev_entry(struct file_list *files, struct cdev *cdev,
>  				     xasprintf("/dev/%s", cdev->name), flags);
>  }
>  
> +static bool file_list_handle_spec(struct file_list *files, const char *spec)
> +{
> +	unsigned count = 0;
> +	bool autoadd;
> +
> +	autoadd = !strcmp(spec, "auto");
> +	if (autoadd || !strcmp(spec, "block"))
> +		count += file_list_add_blockdevs(files);
> +	else
> +		return false;
> +
> +	pr_debug("'%s' spcifier resulted in %u entries\n", spec, count);
> +	return true;
> +}
> +
>  static int file_list_parse_one(struct file_list *files, const char *partstr, const char **endstr)
>  {
>  	int i = 0, state = PARSE_DEVICE;
>  	char filename[PATH_MAX];
>  	char name[PATH_MAX];
>  	unsigned long flags = 0;
> +	bool special = false;
>  
>  	memset(filename, 0, sizeof(filename));
>  	memset(name, 0, sizeof(name));
> @@ -115,7 +132,10 @@ static int file_list_parse_one(struct file_list *files, const char *partstr, con
>  		partstr++;
>  	}
>  
> -	if (state != PARSE_FLAGS) {
> +	if (state == PARSE_DEVICE)
> +		special = file_list_handle_spec(files, filename);
> +
> +	if (!special && state != PARSE_FLAGS) {
>  		pr_err("Missing ')'\n");
>  		return -EINVAL;
>  	}
> @@ -124,7 +144,7 @@ static int file_list_parse_one(struct file_list *files, const char *partstr, con
>  		partstr++;
>  	*endstr = partstr;
>  
> -	return file_list_add_entry(files, name, filename, flags);
> +	return special ? 0 : file_list_add_entry(files, name, filename, flags);
>  }
>  
>  static const char *flags_to_str(int flags)
> diff --git a/include/block.h b/include/block.h
> index da258f509b41..44037bd74c61 100644
> --- a/include/block.h
> +++ b/include/block.h
> @@ -7,6 +7,7 @@
>  #include <linux/types.h>
>  
>  struct block_device;
> +struct file_list;
>  
>  struct block_device_ops {
>  	int (*read)(struct block_device *, void *buf, sector_t block, blkcnt_t num_blocks);
> @@ -51,11 +52,16 @@ static inline int block_flush(struct block_device *blk)
>  
>  #ifdef CONFIG_BLOCK
>  struct block_device *cdev_get_block_device(const struct cdev *cdev);
> +unsigned file_list_add_blockdevs(struct file_list *files);
>  #else
>  static inline struct block_device *cdev_get_block_device(const struct cdev *cdev)
>  {
>  	return NULL;
>  }
> +static inline unsigned file_list_add_blockdevs(struct file_list *files)
> +{
> +	return 0;
> +}
>  #endif
>  
>  static inline bool cdev_is_block_device(const struct cdev *cdev)

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |