sys: device_mmio.h remove #include <toolchain/common.h>

[marc-hb]

v1: re-order #include <toolchain/common.h>

v2: remove #include <toolchain/common.h>

v3: replace #include <toolchain/common.h> with #include <toolchain.h>

Any version fixes the following warning:

$ west build -b qemu_x86  tests/arch/x86/static_idt/

In file included from zephyr/include/toolchain.h:50,
             from zephyr/include/linker/section_tags.h:12,
             from zephyr/include/linker/sections.h:132,
             from zephyr/include/sys/device_mmio.h:19,
             from zephyr/include/drivers/interrupt_controller/loapic.h:14,
             from zephyr/include/drivers/interrupt_controller/sysapic.h:10,
             from zephyr/include/arch/x86/arch.h:231,
             from zephyr/include/arch/cpu.h:15,
             from zephyr/tests/arch/x86/static_idt/src/test_stubs.S:17:
zephyr/include/toolchain/gcc.h:61: error: BUILD_ASSERT redefined [-Werror]
   61 | #define BUILD_ASSERT(EXPR, MSG...) _Static_assert(EXPR, "" MSG)
      |
In file included from zephyr/include/sys/device_mmio.h:18,
             from zephyr/include/drivers/interrupt_controller/loapic.h:14,
             from zephyr/include/drivers/interrupt_controller/sysapic.h:10,
             from zephyr/include/arch/x86/arch.h:231,
             from zephyr/include/arch/cpu.h:15,
             from zephyr/tests/arch/x86/static_idt/src/test_stubs.S:17:
zephyr/include/toolchain/common.h:165: note: this is the location of the
  previous definition
  165 | #define BUILD_ASSERT(EXPR, MSG...) \

Thanks to Gerard Marull-Paretas for recommending v3

Related to commit af20208 ("devices: mark device MMIO declarations to
boot/pinned sections") that added #include <linker/sections.h>

#include <toolchain/common.h> was here since the dawn of time (= commit db0ca08)

Signed-off-by: Marc Herbert marc.herbert@intel.com

[marc-hb]

Warning found in unrelated https://github.com/zephyrproject-rtos/zephyr/runs/4697416054 / #41553

[gmarull]

IMO, this change doesn't really resolve the original problem. First, <sys/device_mmio.h> seems to be a header that is not self-contained (e.g., relies on DT API but doesn't include <devicetree.h>). Second, is <toolchain/common.h> really needed? Removing it seems to resolve the issue, too. Related issue: #41543

[gmarull]

The file seems to make use of ARG_UNUSED, <toolchain.h> is probably the right header then?

[marc-hb]

As mentioned in the commit message, this #include <linker/sections.h> was added by commit af20208 for __pinned_rodata and __pinned_bss (not for ARG_UNUSED which sounds like another, different problem). These __pinned_* are defined in include/linker/section_tags.h which is part of include/linker/sections.h which is part of the "everything bagel" kernel_includes.h which is why they're always found.

In this particular test tests/arch/x86/static_idt/, sys/device_mmio.h is never included directly. It's always included through kernel_includes.h:

In [sys/device_mmio.h] file included
                 from zephyr/include/drivers/interrupt_controller/loapic.h:14,
                 from zephyr/include/drivers/interrupt_controller/sysapic.h:10,
                 from zephyr/include/arch/x86/arch.h:231,
                 from zephyr/include/arch/cpu.h:15,
                 from zephyr/include/kernel_includes.h:33

Related issue: #41543

Yes that's why I copied you :-)

[marc-hb]

Slightly different and interesting warning reproduction when removing #include <linker/sections.h> and keeping #include <toolchain/common.h>

Just another datapoint / faint glow in the big and scary #include darkness #41543

$ west build -b qemu_x86 -d b0 tests/arch/x86/static_idt/

[5/100] Building ASM object CMakeFiles/app.dir/src/test_stubs.S.obj
In file included from zephyr/include/toolchain.h:50,
                 from zephyr/include/arch/x86/ia32/asm.h:12,
                 from zephyr/tests/arch/x86/static_idt/src/test_stubs.S:19:
zephyr/include/toolchain/gcc.h:61: warning: "BUILD_ASSERT" redefined
   61 | #define BUILD_ASSERT(EXPR, MSG...) _Static_assert(EXPR, "" MSG)
      | 
In file included from zephyr/include/sys/device_mmio.h:18,
                 from zephyr/include/drivers/interrupt_controller/loapic.h:14,
                 from zephyr/include/drivers/interrupt_controller/sysapic.h:10,
                 from zephyr/include/arch/x86/arch.h:231,
                 from zephyr/include/arch/cpu.h:15,
                 from zephyr/tests/arch/x86/static_idt/src/test_stubs.S:17:
zephyr/include/toolchain/common.h:165: note: this is the location of the previous definition
  165 | #define BUILD_ASSERT(EXPR, MSG...) \
      | 

[marc-hb]

Twister fix that would have caught this earlier: twister: add -Werror to CMAKE_AFLAGS #41706