Skip to contentSkip to conversation

fs: configfs: make qw_sign attribute symmetric

PATCH In review Stefan Agner 3 participants 13 messages Feb 1, 2017 – Feb 13, 2017 USB

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 fs: configfs: make qw_sign attribute symmetric

Currently qw_sign requires UTF-8 character to set, but returns UTF-16 when read. This isn't obvious when simply using cat since the null characters are not visible, but hexdump unveils the true string:

  # echo MSFT100 > os_desc/qw_sign
  # hexdump -C os_desc/qw_sign
  00000000  4d 00 53 00 46 00 54 00  31 00 30 00 30 00        |M.S.F.T.1.0.0.|

Make qw_sign symmetric by returning an UTF-8 string too. Also follow common convention and add a new line at the end.

---
 drivers/usb/gadget/configfs.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
drivers/usb/gadget/configfs.c +6 -2
index 78c44979dde3..ea1a40f5b23d 100644
@@ -786,9 +786,13 @@ static ssize_t os_desc_b_vendor_code_store(struct config_item *item,
 static ssize_t os_desc_qw_sign_show(struct config_item *item, char *page)
 {
 	struct gadget_info *gi = os_desc_item_to_gadget_info(item);
+	int res;
 
-	memcpy(page, gi->qw_sign, OS_STRING_QW_SIGN_LEN);
-	return OS_STRING_QW_SIGN_LEN;
+	res = utf16s_to_utf8s((wchar_t *) gi->qw_sign, OS_STRING_QW_SIGN_LEN,
+			      UTF16_LITTLE_ENDIAN, page, PAGE_SIZE - 1);
+	page[res++] = '\n';
+
+	return res;
 }
 
 static ssize_t os_desc_qw_sign_store(struct config_item *item, const char *page,
Signature · 1 line
2.11.0
#1 lore raw

PATCH 2/2 fs: configfs: use hexadecimal values and new line

Other unsigned properties return hexadecimal values, follow this convention when printing b_vendor_code too. Also add newlines to the OS Descriptor support related properties, like other sysfs files use.

---
 drivers/usb/gadget/configfs.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/usb/gadget/configfs.c +3 -3
index ea1a40f5b23d..8e9adcfff748 100644
@@ -737,7 +737,7 @@ static inline struct gadget_info *os_desc_item_to_gadget_info(
 
 static ssize_t os_desc_use_show(struct config_item *item, char *page)
 {
-	return sprintf(page, "%d",
+	return sprintf(page, "%d\n",
 			os_desc_item_to_gadget_info(item)->use_os_desc);
 }
 
@@ -761,7 +761,7 @@ static ssize_t os_desc_use_store(struct config_item *item, const char *page,
 
 static ssize_t os_desc_b_vendor_code_show(struct config_item *item, char *page)
 {
-	return sprintf(page, "%d",
+	return sprintf(page, "0x%02x\n",
 			os_desc_item_to_gadget_info(item)->b_vendor_code);
 }
 
@@ -903,7 +903,7 @@ static inline struct usb_os_desc_ext_prop
 
 static ssize_t ext_prop_type_show(struct config_item *item, char *page)
 {
-	return sprintf(page, "%d", to_usb_os_desc_ext_prop(item)->type);
+	return sprintf(page, "%d\n", to_usb_os_desc_ext_prop(item)->type);
 }
 
 static ssize_t ext_prop_type_store(struct config_item *item,
Signature · 1 line
2.11.0
maintainer
#2 lore raw

Re: [PATCH 2/2] fs: configfs: use hexadecimal values and new line

Quoted 4 lines · Stefan Agner

Other unsigned properties return hexadecimal values, follow this convention when printing b_vendor_code too. Also add newlines to the OS Descriptor support related properties, like other sysfs files use.

configfs is not sysfs, so watch out, you might not need/want those new lines as tools read the values and are not expecting them.

Have you verified that nothing will break with this? How have you tested it?

thanks,

greg k-h

#3 lore raw

Re: [PATCH 2/2] fs: configfs: use hexadecimal values and new line

Hi,

Quoted 11 lines · Greg KH
Quoted 4 lines · Stefan Agner

Other unsigned properties return hexadecimal values, follow this convention when printing b_vendor_code too. Also add newlines to the OS Descriptor support related properties, like other sysfs files use.

configfs is not sysfs, so watch out, you might not need/want those new lines as tools read the values and are not expecting them.

Have you verified that nothing will break with this? How have you tested it?

I would rather not change things like that, specially since Android guys are alreadying using configfs.

Signature · 1 line
balbi
#4 lore raw

Re: [PATCH 2/2] fs: configfs: use hexadecimal values and new line

Quoted 14 lines · Felipe Balbi

Hi,

Quoted 11 lines · Greg KH
Quoted 4 lines · Stefan Agner

Other unsigned properties return hexadecimal values, follow this convention when printing b_vendor_code too. Also add newlines to the OS Descriptor support related properties, like other sysfs files use.

configfs is not sysfs, so watch out, you might not need/want those new lines as tools read the values and are not expecting them.

Have you verified that nothing will break with this? How have you tested it?

I am actually writing OS Descriptor support for libusbgx (fork of libusbg) when I stumbled upon this. The helper function there do not care about the new line, but I just thought we should fix it for the sake of coherency to the other properties. I am also fine dropping this patch.

Quoted 3 lines

I would rather not change things like that, specially since Android guys are alreadying using configfs.

Do you happen to know where the source of that part is? So we could check if they make use of any OS Descriptor support yet...

--
Stefan

maintainer
#5 lore raw
In reply to Stefan Agner
Quoted 10 lines · Stefan Agner

Currently qw_sign requires UTF-8 character to set, but returns UTF-16 when read. This isn't obvious when simply using cat since the null characters are not visible, but hexdump unveils the true string:

  # echo MSFT100 > os_desc/qw_sign
  # hexdump -C os_desc/qw_sign
  00000000  4d 00 53 00 46 00 54 00  31 00 30 00 30 00        |M.S.F.T.1.0.0.|

Make qw_sign symmetric by returning an UTF-8 string too. Also follow common convention and add a new line at the end.

Doesn't USB require that strings be in UTF-16? So why have the kernel convert them?

thanks,

greg k-h

#6 lore raw
Quoted 9 lines · Greg KH
Quoted 8 lines · Stefan Agner

Currently qw_sign requires UTF-8 character to set, but returns UTF-16 when read. This isn't obvious when simply using cat since the null characters are not visible, but hexdump unveils the true string:

  # echo MSFT100 > os_desc/qw_sign
  # hexdump -C os_desc/qw_sign
  00000000  4d 00 53 00 46 00 54 00  31 00 30 00 30 00        |M.S.F.T.1.0.0.|
Quoted 5 lines
Quoted 2 lines

Make qw_sign symmetric by returning an UTF-8 string too. Also follow common convention and add a new line at the end.

Doesn't USB require that strings be in UTF-16? So why have the kernel convert them?

That is a discussion we should have had when the write side of this has been added:

static ssize_t os_desc_qw_sign_store(struct config_item *item, const char *page,
size_t len)

{
	struct gadget_info *gi = os_desc_item_to_gadget_info(item);
	int res, l;

	l = min((int)len, OS_STRING_QW_SIGN_LEN >> 1);
	if (page[l - 1] == '\n')
		--l;

	mutex_lock(&gi->lock);
	res = utf8s_to_utf16s(page, l,
			      UTF16_LITTLE_ENDIAN, (wchar_t *) gi->qw_sign,
			      OS_STRING_QW_SIGN_LEN);
	if (res > 0)
		res = len;
	mutex_unlock(&gi->lock);

	return res;
}

The store function is definitely already in use today, e.g. this script used for ev3dev:
https://github.com/ev3dev/ev3-systemd/blob/ev3dev-jessie/scripts/ev3-usb.sh

Changing it to UTF-16 would break that script... So changing the store part is the lesser of two evils.

Regarding new line: Just following what other attributes are doing by using the GS_STRINGS_R macro.

--
Stefan

#7 lore raw
Quoted 46 lines · Stefan Agner
Quoted 9 lines · Greg KH
Quoted 8 lines · Stefan Agner

Currently qw_sign requires UTF-8 character to set, but returns UTF-16 when read. This isn't obvious when simply using cat since the null characters are not visible, but hexdump unveils the true string:

  # echo MSFT100 > os_desc/qw_sign
  # hexdump -C os_desc/qw_sign
  00000000  4d 00 53 00 46 00 54 00  31 00 30 00 30 00        |M.S.F.T.1.0.0.|
Quoted 5 lines
Quoted 2 lines

Make qw_sign symmetric by returning an UTF-8 string too. Also follow common convention and add a new line at the end.

Doesn't USB require that strings be in UTF-16? So why have the kernel convert them?

That is a discussion we should have had when the write side of this has been added:

static ssize_t os_desc_qw_sign_store(struct config_item *item, const char *page,
size_t len)

{
	struct gadget_info *gi = os_desc_item_to_gadget_info(item);
	int res, l;

	l = min((int)len, OS_STRING_QW_SIGN_LEN >> 1);
	if (page[l - 1] == '\n')
		--l;

	mutex_lock(&gi->lock);
	res = utf8s_to_utf16s(page, l,
			      UTF16_LITTLE_ENDIAN, (wchar_t *) gi->qw_sign,
			      OS_STRING_QW_SIGN_LEN);
	if (res > 0)
		res = len;
	mutex_unlock(&gi->lock);

	return res;
}

The store function is definitely already in use today, e.g. this script used for ev3dev:
https://github.com/ev3dev/ev3-systemd/blob/ev3dev-jessie/scripts/ev3-usb.sh

Quoted 5 lines

Changing it to UTF-16 would break that script... So changing the store part is the lesser of two evils.

Regarding new line: Just following what other attributes are doing by using the GS_STRINGS_R macro.

Any comment on this? In my opinion especially this first patch really fixes a bug and should get applied... I can remove the newline if preferred.

--
Stefan

maintainer
#8 lore raw
Quoted 50 lines · Stefan Agner
Quoted 49 lines · Stefan Agner
Quoted 9 lines · Greg KH
Quoted 8 lines · Stefan Agner

Currently qw_sign requires UTF-8 character to set, but returns UTF-16 when read. This isn't obvious when simply using cat since the null characters are not visible, but hexdump unveils the true string:

  # echo MSFT100 > os_desc/qw_sign
  # hexdump -C os_desc/qw_sign
  00000000  4d 00 53 00 46 00 54 00  31 00 30 00 30 00        |M.S.F.T.1.0.0.|
Quoted 5 lines
Quoted 2 lines

Make qw_sign symmetric by returning an UTF-8 string too. Also follow common convention and add a new line at the end.

Doesn't USB require that strings be in UTF-16? So why have the kernel convert them?

That is a discussion we should have had when the write side of this has been added:

static ssize_t os_desc_qw_sign_store(struct config_item *item, const char *page,
size_t len)

{
	struct gadget_info *gi = os_desc_item_to_gadget_info(item);
	int res, l;

	l = min((int)len, OS_STRING_QW_SIGN_LEN >> 1);
	if (page[l - 1] == '\n')
		--l;

	mutex_lock(&gi->lock);
	res = utf8s_to_utf16s(page, l,
			      UTF16_LITTLE_ENDIAN, (wchar_t *) gi->qw_sign,
			      OS_STRING_QW_SIGN_LEN);
	if (res > 0)
		res = len;
	mutex_unlock(&gi->lock);

	return res;
}

The store function is definitely already in use today, e.g. this script used for ev3dev:
https://github.com/ev3dev/ev3-systemd/blob/ev3dev-jessie/scripts/ev3-usb.sh

Changing it to UTF-16 would break that script... So changing the store part is the lesser of two evils.

Quoted 6 lines
Quoted 2 lines

Regarding new line: Just following what other attributes are doing by using the GS_STRINGS_R macro.

Any comment on this? In my opinion especially this first patch really fixes a bug and should get applied... I can remove the newline if preferred.

It's up to Felipe, give him a chance to catch up on patches...

thanks,

greg k-h

#9 lore raw

Hi,

Quoted 51 lines · Greg KH
Quoted 50 lines · Stefan Agner
Quoted 49 lines · Stefan Agner
Quoted 9 lines · Greg KH
Quoted 8 lines · Stefan Agner

Currently qw_sign requires UTF-8 character to set, but returns UTF-16 when read. This isn't obvious when simply using cat since the null characters are not visible, but hexdump unveils the true string:

  # echo MSFT100 > os_desc/qw_sign
  # hexdump -C os_desc/qw_sign
  00000000  4d 00 53 00 46 00 54 00  31 00 30 00 30 00        |M.S.F.T.1.0.0.|
Quoted 5 lines
Quoted 2 lines

Make qw_sign symmetric by returning an UTF-8 string too. Also follow common convention and add a new line at the end.

Doesn't USB require that strings be in UTF-16? So why have the kernel convert them?

That is a discussion we should have had when the write side of this has been added:

static ssize_t os_desc_qw_sign_store(struct config_item *item, const char *page,
size_t len)

{
	struct gadget_info *gi = os_desc_item_to_gadget_info(item);
	int res, l;

	l = min((int)len, OS_STRING_QW_SIGN_LEN >> 1);
	if (page[l - 1] == '\n')
		--l;

	mutex_lock(&gi->lock);
	res = utf8s_to_utf16s(page, l,
			      UTF16_LITTLE_ENDIAN, (wchar_t *) gi->qw_sign,
			      OS_STRING_QW_SIGN_LEN);
	if (res > 0)
		res = len;
	mutex_unlock(&gi->lock);

	return res;
}

The store function is definitely already in use today, e.g. this script used for ev3dev:
https://github.com/ev3dev/ev3-systemd/blob/ev3dev-jessie/scripts/ev3-usb.sh

Changing it to UTF-16 would break that script... So changing the store part is the lesser of two evils.

Quoted 8 lines
Quoted 6 lines
Quoted 2 lines

Regarding new line: Just following what other attributes are doing by using the GS_STRINGS_R macro.

Any comment on this? In my opinion especially this first patch really fixes a bug and should get applied... I can remove the newline if preferred.

It's up to Felipe, give him a chance to catch up on patches...

I really don't know what to do here :-) Either way have the potential of breaking userspace. Maybe returning UTF8 as in write is the lesser of two evils.

Signature · 1 line
balbi
#10 lore raw
Quoted 61 lines · Felipe Balbi

Hi,

Quoted 58 lines · Greg KH
Quoted 56 lines · Stefan Agner
Quoted 46 lines · Stefan Agner
Quoted 9 lines · Greg KH
Quoted 8 lines · Stefan Agner

Currently qw_sign requires UTF-8 character to set, but returns UTF-16 when read. This isn't obvious when simply using cat since the null characters are not visible, but hexdump unveils the true string:

  # echo MSFT100 > os_desc/qw_sign
  # hexdump -C os_desc/qw_sign
  00000000  4d 00 53 00 46 00 54 00  31 00 30 00 30 00        |M.S.F.T.1.0.0.|
Quoted 5 lines
Quoted 2 lines

Make qw_sign symmetric by returning an UTF-8 string too. Also follow common convention and add a new line at the end.

Doesn't USB require that strings be in UTF-16? So why have the kernel convert them?

That is a discussion we should have had when the write side of this has been added:

static ssize_t os_desc_qw_sign_store(struct config_item *item, const char *page,
size_t len)

{
	struct gadget_info *gi = os_desc_item_to_gadget_info(item);
	int res, l;

	l = min((int)len, OS_STRING_QW_SIGN_LEN >> 1);
	if (page[l - 1] == '\n')
		--l;

	mutex_lock(&gi->lock);
	res = utf8s_to_utf16s(page, l,
			      UTF16_LITTLE_ENDIAN, (wchar_t *) gi->qw_sign,
			      OS_STRING_QW_SIGN_LEN);
	if (res > 0)
		res = len;
	mutex_unlock(&gi->lock);

	return res;
}

The store function is definitely already in use today, e.g. this script used for ev3dev:
https://github.com/ev3dev/ev3-systemd/blob/ev3dev-jessie/scripts/ev3-usb.sh

Quoted 5 lines

Changing it to UTF-16 would break that script... So changing the store part is the lesser of two evils.

Regarding new line: Just following what other attributes are doing by using the GS_STRINGS_R macro.

Any comment on this? In my opinion especially this first patch really fixes a bug and should get applied... I can remove the newline if preferred.

Quoted 5 lines
Quoted 1 line

It's up to Felipe, give him a chance to catch up on patches...

I really don't know what to do here :-) Either way have the potential of breaking userspace. Maybe returning UTF8 as in write is the lesser of two evils.

So far libusbg and libusbgx do not have support for OS Descriptors.

I came across the issue while writing support for libusbgx (not upstream yet). And it is rather ugly to have to do it on the read side and not to do on the write side. It would also extend the dependencies of the library (I implemented a prototype using iconv).

Also reading the old interface with UTF-8 does not crash the library, it just return only the first character (since the second character is \0...).

--
Stefan

#11 lore raw

Hi,

Quoted 66 lines · Stefan Agner
Quoted 58 lines
Quoted 58 lines · Stefan Agner
Quoted 56 lines · Stefan Agner
Quoted 46 lines · Greg KH
Quoted 9 lines · Stefan Agner
Quoted 8 lines

Currently qw_sign requires UTF-8 character to set, but returns UTF-16 when read. This isn't obvious when simply using cat since the null characters are not visible, but hexdump unveils the true string:

  # echo MSFT100 > os_desc/qw_sign
  # hexdump -C os_desc/qw_sign
  00000000  4d 00 53 00 46 00 54 00  31 00 30 00 30 00        |M.S.F.T.1.0.0.|
Quoted 5 lines
Quoted 2 lines

Make qw_sign symmetric by returning an UTF-8 string too. Also follow common convention and add a new line at the end.

Doesn't USB require that strings be in UTF-16? So why have the kernel convert them?

That is a discussion we should have had when the write side of this has been added:

static ssize_t os_desc_qw_sign_store(struct config_item *item, const char *page,
size_t len)

{
	struct gadget_info *gi = os_desc_item_to_gadget_info(item);
	int res, l;

	l = min((int)len, OS_STRING_QW_SIGN_LEN >> 1);
	if (page[l - 1] == '\n')
		--l;

	mutex_lock(&gi->lock);
	res = utf8s_to_utf16s(page, l,
			      UTF16_LITTLE_ENDIAN, (wchar_t *) gi->qw_sign,
			      OS_STRING_QW_SIGN_LEN);
	if (res > 0)
		res = len;
	mutex_unlock(&gi->lock);

	return res;
}

The store function is definitely already in use today, e.g. this script used for ev3dev:
https://github.com/ev3dev/ev3-systemd/blob/ev3dev-jessie/scripts/ev3-usb.sh

Quoted 5 lines

Changing it to UTF-16 would break that script... So changing the store part is the lesser of two evils.

Regarding new line: Just following what other attributes are doing by using the GS_STRINGS_R macro.

Any comment on this? In my opinion especially this first patch really fixes a bug and should get applied... I can remove the newline if preferred.

Quoted 5 lines
Quoted 1 line

It's up to Felipe, give him a chance to catch up on patches...

I really don't know what to do here :-) Either way have the potential of breaking userspace. Maybe returning UTF8 as in write is the lesser of two evils.

So far libusbg and libusbgx do not have support for OS Descriptors.

Quoted 8 lines

I came across the issue while writing support for libusbgx (not upstream yet). And it is rather ugly to have to do it on the read side and not to do on the write side. It would also extend the dependencies of the library (I implemented a prototype using iconv).

Also reading the old interface with UTF-8 does not crash the library, it just return only the first character (since the second character is \0...).

Okay, then let's go with your original patch. Can you resend once -rc1 is out?

Signature · 1 line
balbi
maintainer
#12 lore raw
In reply to Stefan Agner
Quoted 10 lines · Stefan Agner

Currently qw_sign requires UTF-8 character to set, but returns UTF-16 when read. This isn't obvious when simply using cat since the null characters are not visible, but hexdump unveils the true string:

  # echo MSFT100 > os_desc/qw_sign
  # hexdump -C os_desc/qw_sign
  00000000  4d 00 53 00 46 00 54 00  31 00 30 00 30 00        |M.S.F.T.1.0.0.|

Make qw_sign symmetric by returning an UTF-8 string too. Also follow common convention and add a new line at the end.

The newline is not part of the descriptor, so why add it?

thanks,

greg k-h