arch: Remove default value for BOARD_LOOPSPERMSEC

[linguini1]

Summary

Removes the default value for CONFIG_BOARD_LOOPSPERMSEC. All boards that forget to configure this value will encounter a build error, enforcing that configurations upstreamed to NuttX have calibrated values for correct delay timings.

Boards which implement ALARM_ARCH or TIMER_ARCH do not rely on the busy-loop delay implementation and thus only have a run-time check to ensure proper delay-timings (in the case where delays are used before the alarm/timer driver is registered).

Some boards already in the NuttX upstream do not have calibrated values, but there are no users who currently own the board to submit a calibrated value for the configurations to use. In this scenario, the value is temporarily set to 0 and a warning is displayed so that users of these boards are informed of the calibration process.

Closes #17004.

Impact

Users will no longer waste time debugging issues that result from having an incorrect value of this configuration option, causing delay/timing issues.

This will affect any user-created defconfig (or NuttX provided defconfig)
without a value set for CONFIG_BOARD_LOOPSPERMSEC by preventing them from
compiling. It causes files that use CONFIG_BOARD_LOOPSPERMSEC while it is
undefined to fail compilation.

Testing

On a board where CONFIG_BOARD_LOOPSPERMSEC=0 but the timer/alarm driver is not enabled, delays will not be reliable. This warning message is shown at compile time to tell the user how to calibrate the value:

$ ./tools/configure.sh nucleo-wl55jc:nsh
$ make -j
Create version.h
CC:  group/group_join.c clock/delay.c:63:2: warning: #warning "CONFIG_BOARD_LOOPSPERMSEC is set to 0 even though this architecture does" "not rely on timer or alarm drivers for correct timings. up_udelay() and " "similar delay functions will not work correctly. Please determine an " "appropriate value for CONFIG_BOARD_LOOPSPERMSEC using the calib_udelay " "application in nuttx-apps. If this configuration is a NuttX provided " "configuration, it would be appreciated if you submit a patch with the " "new value to apache/nuttx." [-Wcpp]
   63 | #warning                                                                     \
      |  ^~~~~~~
LD: nuttx
Memory region         Used Size  Region Size  %age Used
           flash:       63192 B       256 KB     24.11%
            sram:        5648 B        32 KB     17.24%
CP: nuttx.bin

On a board where ARCH_ALARM is used, no issues occur during compilation:

$ ./tools/configure.sh sim:nsh
$ make -j
LD:  nuttx
Pac SIM with dynamic libs..
'/usr/lib/libm.so.6' -> 'sim-pac/libs/libm.so.6'
'/usr/lib/libz.so.1' -> 'sim-pac/libs/libz.so.1'
'/usr/lib/libc.so.6' -> 'sim-pac/libs/libc.so.6'
'/usr/lib64/ld-linux-x86-64.so.2' -> 'sim-pac/libs/ld-linux-x86-64.so.2'
'/lib64/ld-linux-x86-64.so.2' -> 'sim-pac/ld-linux-x86-64.so.2'
SIM elf with dynamic libs archive in nuttx.tgz

On a board where CONFIG_BOARD_LOOPSPERMSEC is undefined, this is the compilation error:

$ ./tools/configure.sh nucleo-wl55jc:nsh
$ make -j
Create version.h
LN: platform/board to /home/linguini/coding/nuttx-space/apps/platform/dummy
Register: sh
Register: nsh
Register: dd
CC:  group/group_join.c clock/delay.c:59:6: warning: "CONFIG_BOARD_LOOPSPERMSEC" is not defined, evaluates to 0 [-Wundef]
   59 | #if (CONFIG_BOARD_LOOPSPERMSEC == 0) &&                                      \
      |      ^~~~~~~~~~~~~~~~~~~~~~~~~
clock/delay.c:63:2: warning: #warning "CONFIG_BOARD_LOOPSPERMSEC is set to 0 even though this architecture does" "not rely on timer or alarm drivers for correct timings. up_udelay() and " "similar delay functions will not work correctly. Please determine an " "appropriate value for CONFIG_BOARD_LOOPSPERMSEC using the calib_udelay " "application in nuttx-apps. If this configuration is a NuttX provided " "configuration, it would be appreciated if you submit a patch with the " "new value to apache/nuttx." [-Wcpp]
   63 | #warning                                                                     \
      |  ^~~~~~~
CC:  group/group_setupidlefiles.c clock/delay.c: In function 'udelay_coarse':
clock/delay.c:92:23: error: 'CONFIG_BOARD_LOOPSPERMSEC' undeclared (first use in this function); did you mean 'CONFIG_BOARD_LOOPSPERUSEC'?
   92 |       for (i = 0; i < CONFIG_BOARD_LOOPSPERMSEC; i++)
      |                       ^~~~~~~~~~~~~~~~~~~~~~~~~
      |                       CONFIG_BOARD_LOOPSPERUSEC
clock/delay.c:92:23: note: each undeclared identifier is reported only once for each function it appears in
CC:  group/group_setuptaskfiles.c make[1]: *** [Makefile:65: delay.o] Error 1
make[1]: *** Waiting for unfinished jobs....
CC:  syslog/syslog_initialize.c make: *** [tools/LibTargets.mk:71: sched/libsched.a] Error 2
make: *** Waiting for unfinished jobs....
[linguini@pastabox nuttx]$ 

[linguini1]

Looks like there are some defconfigs using the default value. Good to catch.

[cederom]

Looks like we need to fix the boards where -1 / default is used, just to pass build here and have correct timings on these boards, then update the res of the boards depending on what we have at hand? :-)

On the other hand we may keep this default and put some pressure / attention to the proper timings calibration when using different boards. I am wondering what impacts the value and if the differences are big - is it build specific? For instance when using different compiler, specific optimization level, many irqs, threads, etc :-)

I mean this 5000 default was set because any default may be wrong when this value is not calibrated on a final firmware build? People just did not know that? In that case we may leave as-is and just add Pre-Flight-Check-List to the documentation with list of important things to know / check / verify when creating / building NuttX based projects? :-)

[acassis]

@linguini1 instead of suggesting searching for CONFIG_BOARD_LOOPSPERMSEC I suggest search for calib_udelay because there is not a page dedicated to CONFIG_BOARD_LOOPSPERMSEC and when searching for it returns many pages.

Searching for calib_udelay returned two pages, but I think we need to move calib_udelay from apps/examples/ to apps/system/ because it is a system tool used to help the system to work correctly. And it also will avoid calib_udelay returning in the apps examples pages. What do you think?

[linguini1]

@linguini1 instead of suggesting searching for CONFIG_BOARD_LOOPSPERMSEC I suggest search for calib_udelay because there is not a page dedicated to CONFIG_BOARD_LOOPSPERMSEC and when searching for it returns many pages.

That's fine, I plan to make one for BOARD_LOOPSPERMSEC but it's better to redirect to calib_udelay for now, I agree.

Searching for calib_udelay returned two pages, but I think we need to move calib_udelay from apps/examples/ to apps/system/ because it is a system tool used to help the system to work correctly. And it also will avoid calib_udelay returning in the apps examples pages. What do you think?

I don't mind moving it to the system directory but that's outside the scope of this PR. I agree it makes more sense, but I might do it later. Right now I just want to prevent users from making a frustrating mistake.

[linguini1]

MSVC failure appears unrelated.

[acassis]

MSVC failure appears unrelated.

@simbit18 you are the MS guy, any idea?

[linguini1]

@acassis @jerpelea do you think this change would be considered a "breaking change"?

[acassis]

@acassis @jerpelea do you think this change would be considered a "breaking change"?

No, it is not.

[cederom]

Thank you @linguini1!! :-)

[linguini1]

@xiaoxiang781216 please let me know what you think of the current solution! If you think it's alright, I'll run the build checks once our usage has cooled down (as mentioned in #17914) to make sure everything is ready for merge.

Thank you for your patch in #17923. In this PR, you'll see I modified it slightly so that CONFIG_BOARD_LOOPSPERMSEC=0 by default when ALARM_ARCH/TIMER_ARCH are set in Kconfig instead of doing #ifdef -> #define in the C files. This should prevent build errors for other C files that use LOOPSPERMSEC too.