michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/drivers/console/winstream_console.c

90 lines
2 KiB
C
Raw Permalink Normal View History

console: move winstream console to drivers/ This was all done as part of the soc and called from the soc. Define this type of console under drivers/console and use it in the SoCs supporting that via SYS_INIT instead of calling the console code directly. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 22:12:28 +02:00
/*
* Copyright (c) 2022 Intel Corporation
soc/xtensa/intel_adsp: Add arch_printk_char_out hook Add a printk default hook that works in very early boot and doesn't depend on the logging subsystem (which can still be used if desired, of course). It speaks the same protocol, is somewhat smaller (MUCH smaller if the app doesn't otherwise need the logging and ring buffer dependencies), and more efficiently uses the output slot space by doing line buffering and flushing only when needed. Most importantly this one is MP-safe via both locking and cache coherence management, and can work reliably when SMP is enabled. (Note that "reliable" means that all output appears without corruption -- simulateous logging by two CPUs can still interleave bytes, of course). Longer term, if we keep this protocol it would be good to unify the two backends to reduce duplicated code. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-05-01 18:21:09 +02:00
* SPDX-License-Identifier: Apache-2.0
*/
console: move winstream console to drivers/ This was all done as part of the soc and called from the soc. Define this type of console under drivers/console and use it in the SoCs supporting that via SYS_INIT instead of calling the console code directly. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 22:12:28 +02:00
#include <zephyr/device.h>
#include <zephyr/init.h>
includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>. This patch proposes to then include <zephyr/kernel.h> instead of <zephyr/zephyr.h> since it is more clear that you are including the Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a catch-all header that may be confusing. Most applications need to include a bunch of other things to compile, e.g. driver headers or subsystem headers like BT, logging, etc. The idea of a catch-all header in Zephyr is probably not feasible anyway. Reason is that Zephyr is not a library, like it could be for example `libpython`. Zephyr provides many utilities nowadays: a kernel, drivers, subsystems, etc and things will likely grow. A catch-all header would be massive, difficult to keep up-to-date. It is also likely that an application will only build a small subset. Note that subsystem-level headers may use a catch-all approach to make things easier, though. NOTE: This patch is **NOT** removing the header, just removing its usage in-tree. I'd advocate for its deprecation (add a #warning on it), but I understand many people will have concerns. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-08-25 09:58:46 +02:00
#include <zephyr/kernel.h>
intel_adsp: move memory windows to DTS proper Instead of just declaring the memory window register in DTS and have everything else all over the place (headers, Kconfig, etc.) this change defines the memory window instances in DTS and uses the device model to initialize the windows. Code is still part of the SoC, given that we do not have a driver subsystem suitable for this type of device yet. Move FW status to own workflow and separate from window setup. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 02:31:37 +02:00
#include <zephyr/sys/winstream.h>
console: move winstream console to drivers/ This was all done as part of the soc and called from the soc. Define this type of console under drivers/console and use it in the SoCs supporting that via SYS_INIT instead of calling the console code directly. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 22:12:28 +02:00
#include <zephyr/devicetree.h>
xtensa: move to use system cache API support for coherency Remove custom implementation and use system cache interface instead. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-01-25 03:20:26 +01:00
#include <zephyr/cache.h>
console: move winstream console to drivers/ This was all done as part of the soc and called from the soc. Define this type of console under drivers/console and use it in the SoCs supporting that via SYS_INIT instead of calling the console code directly. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 22:12:28 +02:00
intel-adsp: migrate cavs-mem.h to adsp_memory.h Move header and make it soc specific. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-07-14 16:59:07 +02:00
#include <adsp_memory.h>
intel_adsp: move memory windows to DTS proper Instead of just declaring the memory window register in DTS and have everything else all over the place (headers, Kconfig, etc.) this change defines the memory window instances in DTS and uses the device model to initialize the windows. Code is still part of the SoC, given that we do not have a driver subsystem suitable for this type of device yet. Move FW status to own workflow and separate from window setup. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 02:31:37 +02:00
#include <mem_window.h>
soc/xtensa/intel_adsp: Add arch_printk_char_out hook Add a printk default hook that works in very early boot and doesn't depend on the logging subsystem (which can still be used if desired, of course). It speaks the same protocol, is somewhat smaller (MUCH smaller if the app doesn't otherwise need the logging and ring buffer dependencies), and more efficiently uses the output slot space by doing line buffering and flushing only when needed. Most importantly this one is MP-safe via both locking and cache coherence management, and can work reliably when SMP is enabled. (Note that "reliable" means that all output appears without corruption -- simulateous logging by two CPUs can still interleave bytes, of course). Longer term, if we keep this protocol it would be good to unify the two backends to reduce duplicated code. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-05-01 18:21:09 +02:00
soc/intel_adsp: Replace trace_out code with a sys_winstream The newer sys_winstream utility is considerably simpler and much faster for the reader. Use that instead. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2021-12-31 04:48:34 +01:00
struct k_spinlock trace_lock;
soc/xtensa/intel_adsp: Add arch_printk_char_out hook Add a printk default hook that works in very early boot and doesn't depend on the logging subsystem (which can still be used if desired, of course). It speaks the same protocol, is somewhat smaller (MUCH smaller if the app doesn't otherwise need the logging and ring buffer dependencies), and more efficiently uses the output slot space by doing line buffering and flushing only when needed. Most importantly this one is MP-safe via both locking and cache coherence management, and can work reliably when SMP is enabled. (Note that "reliable" means that all output appears without corruption -- simulateous logging by two CPUs can still interleave bytes, of course). Longer term, if we keep this protocol it would be good to unify the two backends to reduce duplicated code. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-05-01 18:21:09 +02:00
soc/intel_adsp: Replace trace_out code with a sys_winstream The newer sys_winstream utility is considerably simpler and much faster for the reader. Use that instead. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2021-12-31 04:48:34 +01:00
static struct sys_winstream *winstream;
soc/intel_adsp: Robustify logging code The existing implementation of the adsplog.py script worked fine for individual runs (e.g. when running specific code) but had no support for detecting system reset events and thus could not be used for monitoring applications like test automation. It also could not handle the case where a rapid log burst would overflow the buffer before being noticed at the client. Also, the protocol here was also rife with opportunities for race conditions. Fix all that up via what is mostly a rewrite of the script. The protocol itself hasn't changed, just the handling. Also includes some changes to the trace_out.c code on the device side. These are required to get ordering correct to make race conditions tractably handleable on the reader side. Some of the specific cases that are managed: * There is a 0.4s backoff when a reset is detected. Continuing to poll the buffer has been observed to hang the device (I'm fairly sure this is actually a hardware bug, reads aren't visible to the DSP software). * The "no magic number" case needs to be reserved for detecting system reset. * Slot data must be read BETWEEN two reads of the ID value to detect the case where the slot gets clobbered while being read. * The "currently being filled" slot needs to always have an ID value that does not appear in sequence from the prior slot. * We need to check the full history in the buffer at each poll to detect resets, which opens up a race between the read of the "next slot" (which is absent) and the full history retrieval (when it can now be present!). Detect that. * A null termination bug in the current output slot got fixed. Broadly: this was a huge bear to make work. It sounds like this should be a simple protocol, but it's not in practice. Also: clean up the error reporting in the script so it can handle new PCI IDs being added, and reports permissions failures on the required sysfs file as a human-readable error. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-12-16 21:47:02 +01:00
console: move winstream console to drivers/ This was all done as part of the soc and called from the soc. Define this type of console under drivers/console and use it in the SoCs supporting that via SYS_INIT instead of calling the console code directly. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 22:12:28 +02:00
void winstream_console_trace_out(int8_t *str, size_t len)
soc/xtensa/intel_adsp: Add arch_printk_char_out hook Add a printk default hook that works in very early boot and doesn't depend on the logging subsystem (which can still be used if desired, of course). It speaks the same protocol, is somewhat smaller (MUCH smaller if the app doesn't otherwise need the logging and ring buffer dependencies), and more efficiently uses the output slot space by doing line buffering and flushing only when needed. Most importantly this one is MP-safe via both locking and cache coherence management, and can work reliably when SMP is enabled. (Note that "reliable" means that all output appears without corruption -- simulateous logging by two CPUs can still interleave bytes, of course). Longer term, if we keep this protocol it would be good to unify the two backends to reduce duplicated code. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-05-01 18:21:09 +02:00
{
soc/intel_adsp: Robustify logging code The existing implementation of the adsplog.py script worked fine for individual runs (e.g. when running specific code) but had no support for detecting system reset events and thus could not be used for monitoring applications like test automation. It also could not handle the case where a rapid log burst would overflow the buffer before being noticed at the client. Also, the protocol here was also rife with opportunities for race conditions. Fix all that up via what is mostly a rewrite of the script. The protocol itself hasn't changed, just the handling. Also includes some changes to the trace_out.c code on the device side. These are required to get ordering correct to make race conditions tractably handleable on the reader side. Some of the specific cases that are managed: * There is a 0.4s backoff when a reset is detected. Continuing to poll the buffer has been observed to hang the device (I'm fairly sure this is actually a hardware bug, reads aren't visible to the DSP software). * The "no magic number" case needs to be reserved for detecting system reset. * Slot data must be read BETWEEN two reads of the ID value to detect the case where the slot gets clobbered while being read. * The "currently being filled" slot needs to always have an ID value that does not appear in sequence from the prior slot. * We need to check the full history in the buffer at each poll to detect resets, which opens up a race between the read of the "next slot" (which is absent) and the full history retrieval (when it can now be present!). Detect that. * A null termination bug in the current output slot got fixed. Broadly: this was a huge bear to make work. It sounds like this should be a simple protocol, but it's not in practice. Also: clean up the error reporting in the script so it can handle new PCI IDs being added, and reports permissions failures on the required sysfs file as a human-readable error. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-12-16 21:47:02 +01:00
if (len == 0) {
return;
}
soc/intel_adsp: Add SIMCALL output to the trace_out driver When running under a simulator, it's difficult to extract output from the window (it's difficult with hardware too!). Add "SIMCALL" output to stderr (it's literally just 3 extra instructions) as an optional feature so this subsystem itself can be debugged without herculean effort. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2021-12-15 05:28:30 +01:00
#ifdef CONFIG_ADSP_TRACE_SIMCALL
register int a2 __asm__("a2") = 4; /* SYS_write */
register int a3 __asm__("a3") = 1; /* fd 1 == stdout */
register int a4 __asm__("a4") = (int)str;
register int a5 __asm__("a5") = len;
console: move winstream console to drivers/ This was all done as part of the soc and called from the soc. Define this type of console under drivers/console and use it in the SoCs supporting that via SYS_INIT instead of calling the console code directly. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 22:12:28 +02:00
__asm__ volatile("simcall" : "+r"(a2), "+r"(a3) : "r"(a4), "r"(a5) : "memory");
soc/intel_adsp: Add SIMCALL output to the trace_out driver When running under a simulator, it's difficult to extract output from the window (it's difficult with hardware too!). Add "SIMCALL" output to stderr (it's literally just 3 extra instructions) as an optional feature so this subsystem itself can be debugged without herculean effort. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2021-12-15 05:28:30 +01:00
#endif
soc/intel_adsp: Replace trace_out code with a sys_winstream The newer sys_winstream utility is considerably simpler and much faster for the reader. Use that instead. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2021-12-31 04:48:34 +01:00
k_spinlock_key_t key = k_spin_lock(&trace_lock);
soc/xtensa/intel_adsp: Add arch_printk_char_out hook Add a printk default hook that works in very early boot and doesn't depend on the logging subsystem (which can still be used if desired, of course). It speaks the same protocol, is somewhat smaller (MUCH smaller if the app doesn't otherwise need the logging and ring buffer dependencies), and more efficiently uses the output slot space by doing line buffering and flushing only when needed. Most importantly this one is MP-safe via both locking and cache coherence management, and can work reliably when SMP is enabled. (Note that "reliable" means that all output appears without corruption -- simulateous logging by two CPUs can still interleave bytes, of course). Longer term, if we keep this protocol it would be good to unify the two backends to reduce duplicated code. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-05-01 18:21:09 +02:00
soc/intel_adsp: Replace trace_out code with a sys_winstream The newer sys_winstream utility is considerably simpler and much faster for the reader. Use that instead. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2021-12-31 04:48:34 +01:00
sys_winstream_write(winstream, str, len);
k_spin_unlock(&trace_lock, key);
soc/intel_adsp: Unify trace backends This platform had separate backends for the log subsystem and printk handler, which was silly. Unify them to use the same backend so they don't clobber each other. This patch appears to be a lot of lines, but it's really mostly code motion and renaming. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-10-29 21:07:50 +01:00
}
int arch_printk_char_out(int c)
{
int8_t s = c;
console: move winstream console to drivers/ This was all done as part of the soc and called from the soc. Define this type of console under drivers/console and use it in the SoCs supporting that via SYS_INIT instead of calling the console code directly. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 22:12:28 +02:00
winstream_console_trace_out(&s, 1);
soc/xtensa/intel_adsp: Add arch_printk_char_out hook Add a printk default hook that works in very early boot and doesn't depend on the logging subsystem (which can still be used if desired, of course). It speaks the same protocol, is somewhat smaller (MUCH smaller if the app doesn't otherwise need the logging and ring buffer dependencies), and more efficiently uses the output slot space by doing line buffering and flushing only when needed. Most importantly this one is MP-safe via both locking and cache coherence management, and can work reliably when SMP is enabled. (Note that "reliable" means that all output appears without corruption -- simulateous logging by two CPUs can still interleave bytes, of course). Longer term, if we keep this protocol it would be good to unify the two backends to reduce duplicated code. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-05-01 18:21:09 +02:00
return 0;
}
soc/intel_adsp: Replace trace_out code with a sys_winstream The newer sys_winstream utility is considerably simpler and much faster for the reader. Use that instead. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2021-12-31 04:48:34 +01:00
console: winstream: define as a proper console eb2e5de01c2 made this a console driver but without adding the needed hooks. This adds the hooks to support the console interface. Fixes #65987 Fixes #66264 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-01-29 18:54:42 +01:00
#if defined(CONFIG_STDOUT_CONSOLE)
extern void __stdout_hook_install(int (*hook)(int));
#else
#define __stdout_hook_install(x) \
do {/* nothing */ \
} while ((0))
#endif
#if defined(CONFIG_PRINTK)
extern void __printk_hook_install(int (*fn)(int));
#else
#define __printk_hook_install(x) \
do {/* nothing */ \
} while ((0))
#endif
static void winstream_console_hook_install(void)
{
__stdout_hook_install(arch_printk_char_out);
__printk_hook_install(arch_printk_char_out);
}
init: remove the need for a dummy device pointer in SYS_INIT functions The init infrastructure, found in `init.h`, is currently used by: - `SYS_INIT`: to call functions before `main` - `DEVICE_*`: to initialize devices They are all sorted according to an initialization level + a priority. `SYS_INIT` calls are really orthogonal to devices, however, the required function signature requires a `const struct device *dev` as a first argument. The only reason for that is because the same init machinery is used by devices, so we have something like: ```c struct init_entry { int (*init)(const struct device *dev); /* only set by DEVICE_*, otherwise NULL */ const struct device *dev; } ``` As a result, we end up with such weird/ugly pattern: ```c static int my_init(const struct device *dev) { /* always NULL! add ARG_UNUSED to avoid compiler warning */ ARG_UNUSED(dev); ... } ``` This is really a result of poor internals isolation. This patch proposes a to make init entries more flexible so that they can accept sytem initialization calls like this: ```c static int my_init(void) { ... } ``` This is achieved using a union: ```c union init_function { /* for SYS_INIT, used when init_entry.dev == NULL */ int (*sys)(void); /* for DEVICE*, used when init_entry.dev != NULL */ int (*dev)(const struct device *dev); }; struct init_entry { /* stores init function (either for SYS_INIT or DEVICE*) union init_function init_fn; /* stores device pointer for DEVICE*, NULL for SYS_INIT. Allows * to know which union entry to call. */ const struct device *dev; } ``` This solution **does not increase ROM usage**, and allows to offer clean public APIs for both SYS_INIT and DEVICE*. Note that however, init machinery keeps a coupling with devices. **NOTE**: This is a breaking change! All `SYS_INIT` functions will need to be converted to the new signature. See the script offered in the following commit. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> init: convert SYS_INIT functions to the new signature Conversion scripted using scripts/utils/migrate_sys_init.py. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> manifest: update projects for SYS_INIT changes Update modules with updated SYS_INIT calls: - hal_ti - lvgl - sof - TraceRecorderSource Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> tests: devicetree: devices: adjust test Adjust test according to the recently introduced SYS_INIT infrastructure. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> tests: kernel: threads: adjust SYS_INIT call Adjust to the new signature: int (*init_fn)(void); Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-10-19 09:33:44 +02:00
static int winstream_console_init(void)
soc/intel_adsp: Replace trace_out code with a sys_winstream The newer sys_winstream utility is considerably simpler and much faster for the reader. Use that instead. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2021-12-31 04:48:34 +01:00
{
intel_adsp: move memory windows to DTS proper Instead of just declaring the memory window register in DTS and have everything else all over the place (headers, Kconfig, etc.) this change defines the memory window instances in DTS and uses the device model to initialize the windows. Code is still part of the SoC, given that we do not have a driver subsystem suitable for this type of device yet. Move FW status to own workflow and separate from window setup. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 02:31:37 +02:00
const struct device *dev = DEVICE_DT_GET(DT_CHOSEN(zephyr_console));
soc/intel_adsp: Replace trace_out code with a sys_winstream The newer sys_winstream utility is considerably simpler and much faster for the reader. Use that instead. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2021-12-31 04:48:34 +01:00
intel_adsp: move memory windows to DTS proper Instead of just declaring the memory window register in DTS and have everything else all over the place (headers, Kconfig, etc.) this change defines the memory window instances in DTS and uses the device model to initialize the windows. Code is still part of the SoC, given that we do not have a driver subsystem suitable for this type of device yet. Move FW status to own workflow and separate from window setup. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 02:31:37 +02:00
if (!device_is_ready(dev)) {
return -ENODEV;
}
const struct mem_win_config *config = dev->config;
sparse: fix sparse warnings found in sof compilation Add proper sparse_force cast to assigments into sparse_cache pointers. Signed-off-by: Jaska Uimonen <jaska.uimonen@linux.intel.com>
2022-11-02 12:21:19 +01:00
void *buf =
xtensa: move to use system cache API support for coherency Remove custom implementation and use system cache interface instead. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-01-25 03:20:26 +01:00
sys_cache_uncached_ptr_get((__sparse_force void __sparse_cache *)config->mem_base);
intel_adsp: move memory windows to DTS proper Instead of just declaring the memory window register in DTS and have everything else all over the place (headers, Kconfig, etc.) this change defines the memory window instances in DTS and uses the device model to initialize the windows. Code is still part of the SoC, given that we do not have a driver subsystem suitable for this type of device yet. Move FW status to own workflow and separate from window setup. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 02:31:37 +02:00
winstream = sys_winstream_init(buf, config->size);
console: winstream: define as a proper console eb2e5de01c2 made this a console driver but without adding the needed hooks. This adds the hooks to support the console interface. Fixes #65987 Fixes #66264 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-01-29 18:54:42 +01:00
winstream_console_hook_install();
console: move winstream console to drivers/ This was all done as part of the soc and called from the soc. Define this type of console under drivers/console and use it in the SoCs supporting that via SYS_INIT instead of calling the console code directly. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 22:12:28 +02:00
intel_adsp: move memory windows to DTS proper Instead of just declaring the memory window register in DTS and have everything else all over the place (headers, Kconfig, etc.) this change defines the memory window instances in DTS and uses the device model to initialize the windows. Code is still part of the SoC, given that we do not have a driver subsystem suitable for this type of device yet. Move FW status to own workflow and separate from window setup. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 02:31:37 +02:00
return 0;
soc/intel_adsp: Replace trace_out code with a sys_winstream The newer sys_winstream utility is considerably simpler and much faster for the reader. Use that instead. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2021-12-31 04:48:34 +01:00
}
console: move winstream console to drivers/ This was all done as part of the soc and called from the soc. Define this type of console under drivers/console and use it in the SoCs supporting that via SYS_INIT instead of calling the console code directly. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-10 22:12:28 +02:00
intel_adsp: move memory window setup to PRE_KERNEL_1 PRE_KERNEL_1 is more suited for dealing with devices, so move out of EARLY. Verified on hardware and things seem to behave the same. Something was changed since this was first introduced as this was not possible for some reason. Fixes #62627 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-09-20 03:32:18 +02:00
SYS_INIT(winstream_console_init, PRE_KERNEL_1, CONFIG_CONSOLE_INIT_PRIORITY);
Copy permalink