Skip to contentSkip to conversation

SB16 build error.

DISCUSSION Ralf Baechle 5 participants 12 messages Jun 30, 2011 – Jul 1, 2011

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

Found on a MIPS build but certain other architectures will have the same issue:

CC sound/isa/sb/sb16_csp.o
sound/isa/sb/sb16_csp.c: In function ‘snd_sb_csp_ioctl’:
sound/isa/sb/sb16_csp.c:228: error: case label does not reduce to an integer constant make[1]: *** [sound/isa/sb/sb16_csp.o] Error 1
make: *** [sound/isa/sb/sb16_csp.o] Error 2

This error message is caused by the _IOC_TYPECHECK() error check triggering due to excessive ioctl size on Alpha, PowerPC, MIPS and SPARC which define _IOC_SIZEBITS as 13. On all other architectures define it as 14 so struct snd_sb_csp_microcode with it's little over 12kB will just about fit into the 16kB limit.

Ralf
_______________________________________________
Alsa-devel mailing list
[email protected]
http://mailman.alsa-project.org/mailman/listinfo/alsa-devel

#1 lore raw

At Thu, 30 Jun 2011 10:17:54 +0100,

Quoted 10 lines · Ralf Baechle

Found on a MIPS build but certain other architectures will have the same issue:

CC sound/isa/sb/sb16_csp.o
sound/isa/sb/sb16_csp.c: In function ‘snd_sb_csp_ioctl’:
sound/isa/sb/sb16_csp.c:228: error: case label does not reduce to an integer constant make[1]: *** [sound/isa/sb/sb16_csp.o] Error 1
make: *** [sound/isa/sb/sb16_csp.o] Error 2

Quoted 5 lines

This error message is caused by the _IOC_TYPECHECK() error check triggering due to excessive ioctl size on Alpha, PowerPC, MIPS and SPARC which define _IOC_SIZEBITS as 13. On all other architectures define it as 14 so struct snd_sb_csp_microcode with it's little over 12kB will just about fit into the 16kB limit.

What about the patch below?
This is an old ISA driver, so the impact must be very low.

thanks,

Takashi

---

include/sound/sb16_csp.h +5 -0
index 736eac7..2806586 100644
@@ -60,7 +60,12 @@
 #define SNDRV_SB_CSP_QSOUND_MAX_RIGHT	0x20
 
 /* maximum microcode RIFF file size */
+#if _IOC_SIZEBITS < 14
+/* reduced the size to fit with ioctl size limit */
+#define SNDRV_SB_CSP_MAX_MICROCODE_FILE_SIZE	0x1f00
+#else
 #define SNDRV_SB_CSP_MAX_MICROCODE_FILE_SIZE	0x3000
+#endif
 
 /* microcode header */
 struct snd_sb_csp_mc_header {
#2 lore raw
Quoted 12 lines · Takashi Iwai

At Thu, 30 Jun 2011 10:17:54 +0100,

Quoted 10 lines · Ralf Baechle

Found on a MIPS build but certain other architectures will have the same issue:

CC sound/isa/sb/sb16_csp.o
sound/isa/sb/sb16_csp.c: In function ‘snd_sb_csp_ioctl’:
sound/isa/sb/sb16_csp.c:228: error: case label does not reduce to an integer constant make[1]: *** [sound/isa/sb/sb16_csp.o] Error 1
make: *** [sound/isa/sb/sb16_csp.o] Error 2

Quoted 7 lines
Quoted 5 lines

This error message is caused by the _IOC_TYPECHECK() error check triggering due to excessive ioctl size on Alpha, PowerPC, MIPS and SPARC which define _IOC_SIZEBITS as 13. On all other architectures define it as 14 so struct snd_sb_csp_microcode with it's little over 12kB will just about fit into the 16kB limit.

What about the patch below?

I have no idea how big the soundblaster microcode being loaded actually is, that is if the reduced size of 0x1f00 will be sufficient. Aside of that I don't see a problem - I don't see how the old ioctl can possibly have been used before so there isn't a compatibility problem.

Or you could entirely sidestep the problem and use request_firmware() but I guess that's more effort than you want to invest.

Quoted 1 line

This is an old ISA driver, so the impact must be very low.

True. I notice that sort of stuff in automated mass builds - not necessarily the sort of kernels one would actually use. Still build errors are annoying :)

Ralf
_______________________________________________
Alsa-devel mailing list
[email protected]
http://mailman.alsa-project.org/mailman/listinfo/alsa-devel

#3 lore raw

At Thu, 30 Jun 2011 11:52:54 +0100,

Quoted 21 lines · Ralf Baechle
Quoted 18 lines · Takashi Iwai

At Thu, 30 Jun 2011 10:17:54 +0100,

Quoted 15 lines · Ralf Baechle

Found on a MIPS build but certain other architectures will have the same issue:

CC sound/isa/sb/sb16_csp.o
sound/isa/sb/sb16_csp.c: In function ‘snd_sb_csp_ioctl’:
sound/isa/sb/sb16_csp.c:228: error: case label does not reduce to an integer constant make[1]: *** [sound/isa/sb/sb16_csp.o] Error 1
make: *** [sound/isa/sb/sb16_csp.o] Error 2

This error message is caused by the _IOC_TYPECHECK() error check triggering due to excessive ioctl size on Alpha, PowerPC, MIPS and SPARC which define _IOC_SIZEBITS as 13. On all other architectures define it as 14 so struct snd_sb_csp_microcode with it's little over 12kB will just about fit into the 16kB limit.

Quoted 4 lines
Quoted 1 line

What about the patch below?

I have no idea how big the soundblaster microcode being loaded actually is, that is if the reduced size of 0x1f00 will be sufficient.

The files found in /lib/firmware/sb16 are all under 2kB, thus likely sufficient.

Quoted 6 lines

Aside of that I
don't see a problem - I don't see how the old ioctl can possibly have been used before so there isn't a compatibility problem.

Or you could entirely sidestep the problem and use request_firmware() but I guess that's more effort than you want to invest.

Yeah, that's another option I thought of. But it's too intrusive for 3.0-rc6, so I'd like waive it for 3.1.

Quoted 5 lines
Quoted 1 line

This is an old ISA driver, so the impact must be very low.

True. I notice that sort of stuff in automated mass builds - not necessarily the sort of kernels one would actually use. Still build errors are annoying :)

Right, better to fix it up quickly.

thanks,

Takashi

#4 lore raw

At Thu, 30 Jun 2011 13:05:54 +0200,

Quoted 24 lines · Takashi Iwai

At Thu, 30 Jun 2011 11:52:54 +0100,

Quoted 21 lines · Ralf Baechle
Quoted 18 lines · Takashi Iwai

At Thu, 30 Jun 2011 10:17:54 +0100,

Quoted 15 lines · Ralf Baechle

Found on a MIPS build but certain other architectures will have the same issue:

CC sound/isa/sb/sb16_csp.o
sound/isa/sb/sb16_csp.c: In function ‘snd_sb_csp_ioctl’:
sound/isa/sb/sb16_csp.c:228: error: case label does not reduce to an integer constant make[1]: *** [sound/isa/sb/sb16_csp.o] Error 1
make: *** [sound/isa/sb/sb16_csp.o] Error 2

This error message is caused by the _IOC_TYPECHECK() error check triggering due to excessive ioctl size on Alpha, PowerPC, MIPS and SPARC which define _IOC_SIZEBITS as 13. On all other architectures define it as 14 so struct snd_sb_csp_microcode with it's little over 12kB will just about fit into the 16kB limit.

Quoted 7 lines
Quoted 4 lines
Quoted 1 line

What about the patch below?

I have no idea how big the soundblaster microcode being loaded actually is, that is if the reduced size of 0x1f00 will be sufficient.

The files found in /lib/firmware/sb16 are all under 2kB, thus likely sufficient.

Too shortly answered. It turned out that some CSP codes (like Qsound) can be above that size, it's almost 12kB. So the size in the original code is really the necessary requirement, and the patch breaks for such a case.

An ugly workaround would be to fake the ioctl size. But this is certainly to be avoided, since it has been broken on the specific platforms for ages, thus breaking for them would be mostly harmless, too.

Quoted 9 lines
Quoted 6 lines

Aside of that I
don't see a problem - I don't see how the old ioctl can possibly have been used before so there isn't a compatibility problem.

Or you could entirely sidestep the problem and use request_firmware() but I guess that's more effort than you want to invest.

Yeah, that's another option I thought of. But it's too intrusive for 3.0-rc6, so I'd like waive it for 3.1.

Actually the request_firmware() was implemented for some auto-loadable CSP codes. Others need the manual loading, so it is via ioctl. It can be converted, but I don't think it makes sense for such old stuff. After all, it still works with x86-ISA as is.

thanks,

Takashi

#5 lore raw
Quoted 23 lines · Takashi Iwai
Quoted 5 lines
Quoted 2 lines

I have no idea how big the soundblaster microcode being loaded actually is, that is if the reduced size of 0x1f00 will be sufficient.

The files found in /lib/firmware/sb16 are all under 2kB, thus likely sufficient.

Too shortly answered. It turned out that some CSP codes (like Qsound) can be above that size, it's almost 12kB. So the size in the original code is really the necessary requirement, and the patch breaks for such a case.

An ugly workaround would be to fake the ioctl size. But this is certainly to be avoided, since it has been broken on the specific platforms for ages, thus breaking for them would be mostly harmless, too.

Quoted 7 lines
Quoted 6 lines

Aside of that I
don't see a problem - I don't see how the old ioctl can possibly have been used before so there isn't a compatibility problem.

Or you could entirely sidestep the problem and use request_firmware() but I guess that's more effort than you want to invest.

Quoted 7 lines
Quoted 2 lines

Yeah, that's another option I thought of. But it's too intrusive for 3.0-rc6, so I'd like waive it for 3.1.

Actually the request_firmware() was implemented for some auto-loadable CSP codes. Others need the manual loading, so it is via ioctl. It can be converted, but I don't think it makes sense for such old stuff. After all, it still works with x86-ISA as is.

In userland an empty definition will be used for _IOC_TYPECHECK so there won't be an error. So userland already is already using the existing value for SNDRV_SB_CSP_IOCTL_LOAD_CODE ...

With a crude hack like

#define SNDRV_SB_CSP_IOCTL_LOAD_CODE				\
	_IOC(_IOC_WRITE,'H', 0x11, sizeof(struct snd_sb_csp_microcode))

error checking can be bypassed and all will be fine as long as the resulting value doesn't result in in a a duplicate case value - which it doesn't, at least not in my testing.

Should work but isn't nice.

Ralf

#6 lore raw

At Thu, 30 Jun 2011 13:32:12 +0100,

Quoted 29 lines · Ralf Baechle
Quoted 26 lines · Takashi Iwai
Quoted 5 lines
Quoted 2 lines

I have no idea how big the soundblaster microcode being loaded actually is, that is if the reduced size of 0x1f00 will be sufficient.

The files found in /lib/firmware/sb16 are all under 2kB, thus likely sufficient.

Too shortly answered. It turned out that some CSP codes (like Qsound) can be above that size, it's almost 12kB. So the size in the original code is really the necessary requirement, and the patch breaks for such a case.

An ugly workaround would be to fake the ioctl size. But this is certainly to be avoided, since it has been broken on the specific platforms for ages, thus breaking for them would be mostly harmless, too.

Quoted 9 lines
Quoted 6 lines

Aside of that I
don't see a problem - I don't see how the old ioctl can possibly have been used before so there isn't a compatibility problem.

Or you could entirely sidestep the problem and use request_firmware() but I guess that's more effort than you want to invest.

Yeah, that's another option I thought of. But it's too intrusive for 3.0-rc6, so I'd like waive it for 3.1.

Quoted 8 lines
Quoted 4 lines

Actually the request_firmware() was implemented for some auto-loadable CSP codes. Others need the manual loading, so it is via ioctl. It can be converted, but I don't think it makes sense for such old stuff. After all, it still works with x86-ISA as is.

In userland an empty definition will be used for _IOC_TYPECHECK so there won't be an error. So userland already is already using the existing value for SNDRV_SB_CSP_IOCTL_LOAD_CODE ...

Right. It has an invalid direction (3), but apps won't care such details anyway.

Quoted 10 lines

With a crude hack like

#define SNDRV_SB_CSP_IOCTL_LOAD_CODE				\
	_IOC(_IOC_WRITE,'H', 0x11, sizeof(struct snd_sb_csp_microcode))

error checking can be bypassed and all will be fine as long as the resulting value doesn't result in in a a duplicate case value - which it doesn't, at least not in my testing.

Should work but isn't nice.

Indeed. But which is uglier is hard to answer :)

If you are fine with the hacked ioctl number above, I can put it with some comments. This won't break anything, at least.

thanks,

Takashi

#7 lore raw
Quoted 16 lines · Takashi Iwai
Quoted 3 lines

In userland an empty definition will be used for _IOC_TYPECHECK so there won't be an error. So userland already is already using the existing value for SNDRV_SB_CSP_IOCTL_LOAD_CODE ...

Right. It has an invalid direction (3), but apps won't care such details anyway.

Quoted 9 lines

With a crude hack like

#define SNDRV_SB_CSP_IOCTL_LOAD_CODE				\
	_IOC(_IOC_WRITE,'H', 0x11, sizeof(struct snd_sb_csp_microcode))

error checking can be bypassed and all will be fine as long as the resulting value doesn't result in in a a duplicate case value - which it doesn't, at least not in my testing.

Quoted 6 lines
Quoted 1 line

Should work but isn't nice.

Indeed. But which is uglier is hard to answer :)

If you are fine with the hacked ioctl number above, I can put it with some comments. This won't break anything, at least.

Go ahead then and yes, this really deserves a comment.

Ralf

maintainer
#10 lore raw
In reply to Ralf Baechle
Quoted 8 lines · Ralf Baechle
#define SNDRV_SB_CSP_IOCTL_LOAD_CODE                            \
        _IOC(_IOC_WRITE,'H', 0x11, sizeof(struct snd_sb_csp_microcode))

error checking can be bypassed and all will be fine as long as the resulting value doesn't result in in a a duplicate case value - which it doesn't, at least not in my testing.

Should work but isn't nice.

Right. It's probably the best we can do. I think we added a few similar definitions when we originally introduce _IOC_TYPECHECK. The idea was never to break existing code, but rather to avoid merging new drivers that use inconsistent ioctl command numbers.

Arnd

#11 lore raw
In reply to Ralf Baechle
Quoted 2 lines · Ralf Baechle

I have no idea how big the soundblaster microcode being loaded actually is, that is if the reduced size of 0x1f00 will be sufficient.

The biggest file is WFM0001A.CSP with 0x2df0 bytes.

Quoted 2 lines

I don't see how the old ioctl can possibly have been used before so there isn't a compatibility problem.

The code uses SNDRV_SB_CSP_MAX_MICROCODE_FILE_SIZE but doesn't care what the size field of the ioctl code is, so we could use any random value on those architectures.

Quoted 2 lines

Or you could entirely sidestep the problem and use request_firmware() but I guess that's more effort than you want to invest.

The driver already implements this for a bunch of predefined CSP code blobs. I'm not sure whether anybody has ever loaded additional .csp files.

Regards,
Clemens

#8 lore raw
In reply to Ralf Baechle

At Thu, 30 Jun 2011 13:43:33 +0100,

Quoted 19 lines · Ralf Baechle
Quoted 16 lines · Takashi Iwai
Quoted 3 lines

In userland an empty definition will be used for _IOC_TYPECHECK so there won't be an error. So userland already is already using the existing value for SNDRV_SB_CSP_IOCTL_LOAD_CODE ...

Right. It has an invalid direction (3), but apps won't care such details anyway.

Quoted 9 lines

With a crude hack like

#define SNDRV_SB_CSP_IOCTL_LOAD_CODE				\
	_IOC(_IOC_WRITE,'H', 0x11, sizeof(struct snd_sb_csp_microcode))

error checking can be bypassed and all will be fine as long as the resulting value doesn't result in in a a duplicate case value - which it doesn't, at least not in my testing.

Quoted 8 lines
Quoted 6 lines
Quoted 1 line

Should work but isn't nice.

Indeed. But which is uglier is hard to answer :)

If you are fine with the hacked ioctl number above, I can put it with some comments. This won't break anything, at least.

Go ahead then and yes, this really deserves a comment.

OK, here is the patch.

Takashi

===
From: Takashi Iwai <[email protected]>
Subject: [PATCH] ALSA: sb16 - Fix build errors on MIPS and others with 13bit
ioctl size

One of ioctl definition in sound/sb16_csp.h contains the data size over 8kB, and this causes build errors on architectures like MIPS, which define _IOC_SIZEBITS=13.

For avoiding this build errors but keeping the compatibility, manually exapnd with _IOC() instead of using _IOW() for the problematic ioctl.

---
 include/sound/sb16_csp.h |    9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)
include/sound/sb16_csp.h +8 -1
index 736eac7..af1b49e 100644
@@ -99,7 +99,14 @@ struct snd_sb_csp_info {
 /* get CSP information */
 #define SNDRV_SB_CSP_IOCTL_INFO		_IOR('H', 0x10, struct snd_sb_csp_info)
 /* load microcode to CSP */
-#define SNDRV_SB_CSP_IOCTL_LOAD_CODE	_IOW('H', 0x11, struct snd_sb_csp_microcode)
+/* NOTE: struct snd_sb_csp_microcode overflows the max size (13 bits)
+ * defined for some architectures like MIPS, and it leads to build errors.
+ * (x86 and co have 14-bit size, thus it's valid, though.)
+ * As a workaround for skipping the size-limit check, here we don't use the
+ * normal _IOW() macro but _IOC() with the manual argument.
+ */
+#define SNDRV_SB_CSP_IOCTL_LOAD_CODE	\
+	_IOC(_IOC_WRITE, 'H', 0x11, sizeof(struct snd_sb_csp_microcode))
 /* unload microcode from CSP */
 #define SNDRV_SB_CSP_IOCTL_UNLOAD_CODE	_IO('H', 0x12)
 /* start CSP */
Signature · 1 line
1.7.6